docs: format, grammarize, and standardize the wall man page

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
This commit is contained in:
Benno Schulenberg 2013-10-14 20:48:22 +02:00 committed by Karel Zak
parent e009d80878
commit 4e36bc592d
1 changed files with 21 additions and 19 deletions

View File

@ -38,17 +38,20 @@
wall \- write a message to users wall \- write a message to users
.SH SYNOPSIS .SH SYNOPSIS
.B wall .B wall
[-n] [-t TIMEOUT] [file | message] .RB [ \-n ]
.RB [ \-t
.IR timeout ]
.RI [ message " | " file ]
.SH DESCRIPTION .SH DESCRIPTION
.B Wall .B wall
displays a displays a
.I message .I message
or contents of or the contents of a
.I file .I file
or, by default, its standard input, on the terminals of all currently logged or, by default, its standard input, on the terminals of all currently logged
in users. The command will cut over 79 character long lines to new lines. in users. The command will wrap lines that are longer than 79 characters.
Short lines are white space padded to have 79 characters. The command will Short lines are whitespace padded to have 79 characters. The command will
always put carriage return and new line at the end of each line. always put a carriage return and new line at the end of each line.
.PP .PP
Only the superuser can write on the terminals of users who have chosen to Only the superuser can write on the terminals of users who have chosen to
deny messages or are using a program which automatically denies messages. deny messages or are using a program which automatically denies messages.
@ -58,25 +61,24 @@ Reading from a
is refused when the invoker is not superuser and the program is suid or sgid. is refused when the invoker is not superuser and the program is suid or sgid.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-n\fR, \fB\-\-nobanner\fR .BR \-n , " \-\-nobanner"
Suppress banner Suppress the banner.
.TP .TP
\fB\-t\fR, \fB\-\-timeout\fR \fItimeout\fR .BR \-t , " \-\-timeout " \fItimeout\fR
Write Abandon the write attempt to the terminals after \fItimeout\fR seconds.
.I timeout This \fItimeout\fR must be a positive integer. The default value
to terminals in seconds. Argument must be positive integer. Default value is 300 seconds, which is a legacy from the time when people ran terminals over
is 300 seconds, which is a legacy from time when people ran terminals over
modem lines. modem lines.
.TP .TP
\fB\-V\fR, \fB\-\-version\fR .BR \-V , " \-\-version"
Output version and exit. Display version information and exit.
.TP .TP
\fB\-h\fR, \fB\-\-help\fR .BR \-h , " \-\-help"
Output help and exit. Display help text and exit.
.SH NOTES .SH NOTES
Some sessions, such as wdm, that has in beginning of Some sessions, such as wdm, that have in the beginning of
.BR utmp (5) .BR utmp (5)
ut_type data ':' character will not get message from ut_type data a ':' character will not get the message from
.BR wall . .BR wall .
This is done to avoid write errors. This is done to avoid write errors.
.SH SEE ALSO .SH SEE ALSO