]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
docs: bring a few more man pages closer to standard formatting
authorBenno Schulenberg <bensberg@justemail.net>
Tue, 15 Jul 2014 21:07:37 +0000 (23:07 +0200)
committerKarel Zak <kzak@redhat.com>
Wed, 16 Jul 2014 10:03:25 +0000 (12:03 +0200)
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
term-utils/mesg.1
term-utils/reset.1
term-utils/script.1
term-utils/scriptreplay.1
term-utils/setterm.1
term-utils/wall.1
term-utils/write.1

index f7ebf4195d4bc36025d8460294725e316b1bad39..9bdc6d5664a98b8a5d71ab87f36b03699b9da1aa 100644 (file)
 .\"
 .\"    @(#)mesg.1      8.1 (Berkeley) 6/6/93
 .\"
-.\" Fri Mar 10 20:31:02 1995, modified for standard man macros,
-.\" faith@cs.unc.edu
-.\"
-.\"
-.\" "
-.TH MESG 1 "April 2011" "util-linux" "User Commands"
+.TH MESG 1 "July 2014" "util-linux" "User Commands"
 .SH NAME
-mesg \- display (do not display) messages from other users
+mesg \- display (or do not display) messages from other users
 .SH SYNOPSIS
 .B mesg
-.RB [options]
+[option]
 .RB [ n | y ]
 .SH DESCRIPTION
 The
 .B mesg
-utility is invoked by a users to control write access others have to the
-terminal device associated with the standard error output.  If write access
+utility is invoked by a user to control write access others have to the
+terminal device associated with standard error output.  If write access
 is allowed, then programs such as
 .BR talk (1)
 and
@@ -63,37 +58,39 @@ should be executed in your login scripts.
 .SH ARGUMENTS
 .TP
 .B n
-Disallows messages.
+Disallow messages.
 .TP
 .B y
-Permits messages to be displayed.
+Allow messages to be displayed.
+.PP
+If no arguments are given,
+.B mesg
+shows the current message status on standard error output.
 .SH OPTIONS
 .TP
-.B \-v, \-\-verbose
+.BR \-v , " \-\-verbose"
 Explain what is being done.
 .TP
-.B \-V, \-\-verbose
+.BR \-V , " \-\-version"
 Display version information and exit.
 .TP
-.B \-h, \-\-help
+.BR \-h , " \-\-help"
 Display help text and exit.
-.PP
-If no arguments are given,
-.B mesg
-displays the present message status to the standard error output.
-.PP
+.SH EXIT STATUS
 The
 .B mesg
 utility exits with one of the following values:
+.RS 4
 .TP
-.I "\ 0"
+.B "\ 0"
 Messages are allowed.
 .TP
-.I "\ 1"
+.B "\ 1"
 Messages are not allowed.
 .TP
-.I ">1"
+.B ">1"
 An error has occurred.
+.RE
 .SH FILES
 .I /dev/[pt]ty[pq]?
 .SH "SEE ALSO"
index fdf67e24e24f8fda5e01311201aa1f47487871e6..f8c3df7838f5ad8afe7bc77e90f398b750f51c8c 100644 (file)
@@ -28,8 +28,8 @@ or in the terminfo database
 (for the
 .B ncurses
 .BR tput ).
-This sequence seems to be sufficient to reset the Linux VC's when they
-start printing "funny-looking" characters.  For good measure,
+This sequence seems to be sufficient to reset a Linux VC when it
+starts printing "funny-looking" characters.  For good measure,
 .BR stty (1)
 is called with the
 .I sane
index 67e1066880ac5918b959f16c5f9e3eb3ab90a9b0..4573f07359a0c2d570fe6e7fd94d0a2a2093e427 100644 (file)
 .\"
 .\"    @(#)script.1    6.5 (Berkeley) 7/27/91
 .\"
-.TH SCRIPT "1" "September 2011" "util-linux" "User Commands"
+.TH SCRIPT "1" "June 2014" "util-linux" "User Commands"
 .SH NAME
 script \- make typescript of terminal session
 .SH SYNOPSIS
 .B script
-[options] [file]
+[options]
+.RI [ file ]
 .SH DESCRIPTION
 .B script
-makes a typescript of everything printed on your terminal.  It is useful for
+makes a typescript of everything displayed on your terminal.  It is useful for
 students who need a hardcopy record of an interactive session as proof of an
 assignment, as the typescript file can be printed out later with
 .BR lpr (1).
@@ -48,17 +49,17 @@ If the argument
 .I file
 is given,
 .B script
-saves all dialogue in
+saves the dialogue in this
 .IR file .
-If no file name is given, the typescript is saved in the file
-.IR typescript .
+If no filename is given, the dialogue is saved in the file
+.BR typescript .
 .SH OPTIONS
 .TP
 \fB\-a\fR, \fB\-\-append\fR
 Append the output to
 .I file
-or
-.IR typescript ,
+or to
+.BR typescript ,
 retaining the prior contents.
 .TP
 \fB\-c\fR, \fB\-\-command\fR \fIcommand\fR
@@ -101,8 +102,7 @@ Display help text and exit.
 .SH NOTES
 The script ends when the forked shell exits (a
 .I control-D
-to exit
-the Bourne shell
+for the Bourne shell
 .RB ( sh (1)),
 and
 .IR exit ,
@@ -118,7 +118,7 @@ C-shell,
 Certain interactive commands, such as
 .BR vi (1),
 create garbage in the typescript file.
-.B Script
+.B script
 works best with commands that do not manipulate the screen, the results are
 meant to emulate a hardcopy terminal.
 .SH ENVIRONMENT
@@ -127,11 +127,11 @@ The following environment variable is utilized by
 .TP
 .B SHELL
 If the variable
-.I SHELL
+.B SHELL
 exists, the shell forked by
 .B script
-will be that shell. If
-.I SHELL
+will be that shell.  If
+.B SHELL
 is not set, the Bourne shell is assumed.  (Most shells set this variable
 automatically).
 .SH SEE ALSO
@@ -145,9 +145,9 @@ The
 .B script
 command appeared in 3.0BSD.
 .SH BUGS
-.B Script
+.B script
 places
-.B everything
+.I everything
 in the log file, including linefeeds and backspaces.  This is not what the
 naive user expects.
 .SH AVAILABILITY
index 329dbc9f8e336fafc3ec2e88437e7255e538749c..8c9053aed80fdff2ed85a10f35029245c8fd091c 100644 (file)
@@ -3,14 +3,14 @@
 scriptreplay \- play back typescripts, using timing information
 .SH "SYNOPSIS"
 .B scriptreplay
-.RI [ options ]
+[options]
 .RB [ \-t ]
 .I timingfile
 .RI [ typescript
 .RI [ divisor ]]
 .SH "DESCRIPTION"
 This program replays a typescript, using timing information to ensure that
-output happens at the same speed as it originally appeared when the script
+output happens in the same rhythm as it originally appeared when the script
 was recorded.
 .PP
 The replay simply displays the information again; the programs
@@ -45,10 +45,10 @@ than the original session.
 The first three options will overide old-style arguments.
 .TP
 .BR \-t , " \-\-timing " \fIfile\fR
-File containing script timing output.
+File containing \fBscript\fR's timing output.
 .TP
 .BR \-s , " \-\-typescript " \fIfile\fR
-File containing the script terminal output.
+File containing \fBscript\fR's terminal output.
 .TP
 .BR \-d , " \-\-divisor " \fInumber\fR
 Speed up the replay displaying this
@@ -57,9 +57,9 @@ of times.  The argument is a floating point number.  It's called divisor
 because it divides the timings by this factor.
 .TP
 .BR \-m , " \-\-maxdelay " \fInumber\fR
-Set the maximal delay between transcript updates to
+Set the maximum delay between transcript updates to
 .I number
-seconds.  The argument is a floating point number.  This can be used to
+of seconds.  The argument is a floating point number.  This can be used to
 avoid long pauses in the transcript replay.
 .TP
 .BR \-V , " \-\-version"
index bc11fdb9fbcd514b1b75ed52870877f8ab81ebba..a901e24c7c8844d992bbbb71cf712abc67292c65 100644 (file)
@@ -13,7 +13,7 @@
 setterm \- set terminal attributes
 .SH SYNOPSIS
 .B setterm
-.RI [ options ]
+[options]
 .SH DESCRIPTION
 .B setterm
 writes to standard output a character string that will invoke the specified
index 65f0ee8cec1fe7d5b65345b1ab38752bef3ccb7a..fd6c02967e4896ff719141d97320d907527479b8 100644 (file)
@@ -35,7 +35,7 @@
 .\"
 .TH WALL "1" "August 2013" "util-linux" "User Commands"
 .SH NAME
-wall \- write a message to users
+wall \- write a message to all users
 .SH SYNOPSIS
 .B wall
 .RB [ \-n ]
@@ -45,10 +45,10 @@ wall \- write a message to users
 .SH DESCRIPTION
 .B wall
 displays a
-.I message
+.IR message ,
 or the contents of a
-.I file
-or, by default, its standard input, on the terminals of all currently logged
+.IR file ,
+or otherwise its standard input, on the terminals of all currently logged
 in users.  The command will wrap lines that are longer than 79 characters.
 Short lines are whitespace padded to have 79 characters.  The command will
 always put a carriage return and new line at the end of each line.
index 33eb91408acd4796e1412a140fe7e3db6ee2a6af..ad321f4fa6a9384d3bbb40a8639c50148945d5c4 100644 (file)
@@ -44,7 +44,7 @@ write \- send a message to another user
 .I user
 .RI [ ttyname ]
 .SH DESCRIPTION
-.B Write
+.B write
 allows you to communicate with other users, by copying lines from
 your terminal to theirs.
 .PP
@@ -73,10 +73,11 @@ command.  Some commands, for example
 .BR nroff (1)
 and
 .BR pr (1),
-may disallow writing automatically, so that your output isn't overwritten.
+may automatically disallow writing, so that the output they produce
+isn't overwritten.
 .PP
 If the user you want to write to is logged in on more than one terminal,
-you can specify which terminal to write to by specifying the terminal
+you can specify which terminal to write to by giving the terminal
 name as the second operand to the
 .B write
 command.  Alternatively, you can let