sync w/ usd docs;

ok millert@

1 files changed, 80 insertions, 53 deletions

diff --git a/usr.bin/mail/mail.1 b/usr.bin/mail/mail.1
index 15d9f0831cf..34bd168eccc 100644
--- a/usr.bin/mail/mail.1
+++ b/usr.bin/mail/mail.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: mail.1,v 1.44 2004/04/30 06:52:48 jmc Exp $
+.\"	$OpenBSD: mail.1,v 1.45 2004/06/04 00:07:12 jmc Exp $
 .\"
 .\" Copyright (c) 1980, 1990, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@@ -106,7 +106,7 @@ Specify subject on command line
 flag is used as a subject; be careful to quote subjects
 containing spaces).
 .It Fl u Ar user
-Is equivalent to:
+Equivalent to:
 .Pp
 .Dl $ mail -f /var/mail/user
 .Pp
@@ -228,11 +228,11 @@ For instance, typing
 .Ic ~m
 (alone on a line) will place a copy
 of the current message into the response, right shifting it by a single
-tab-stop (see
+tab-stop (see the
 .Va indentprefix
 variable, below).
 Other escapes will set up subject fields, add and delete recipients
-to the message and allow you to escape to an editor to revise the
+to the message, and allow you to escape to an editor to revise the
 message or to a shell to run some commands.
 (These options
 are given in the summary below.)
@@ -245,7 +245,7 @@ session with the
 command.
 Messages which have been examined go to your
 .Ar mbox
-file unless they have been deleted in which case they are discarded.
+file unless they have been deleted, in which case they are discarded.
 Unexamined messages go back to the post office (see the
 .Fl f
 option above).
@@ -340,7 +340,7 @@ Like
 but also prints out ignored header fields.
 See also
 .Ic print ,
-.Ic ignore
+.Ic ignore ,
 and
 .Ic retain .
 .It Ic Reply
@@ -406,7 +406,7 @@ Deletes the current message and prints the next message.
 If there is no next message,
 .Nm mail
 says
-.Dq Li "at EOF" .
+.Dq Li "\&No more messages."
 .It Ic edit
 .Pq Ic e
 Takes a list of messages and points the text editor at each one in
@@ -451,14 +451,10 @@ directory.
 Takes a list of messages and prints their message headers.
 .It Ic headers
 .Pq Ic h
-Lists the current range of headers, which is an 18\-message group.
-If
-a
-.Ql +
-argument is given, the next 18\-message group is printed; if
-a
-.Ql -
-argument is given, the previous 18\-message group is printed.
+Lists the current windowful of headers.
+To view the next or previous group of headers, see the
+.Ic z
+command.
 .It Ic help
 A synonym for
 .Ic \&? .
@@ -498,13 +494,18 @@ The new messages are added to the end of the message list,
 and the current message is reset to be the first new mail message.
 This does not renumber the existing message list, nor
 does it cause any changes made so far to be saved.
+.It Ic list
+.Pq Ic l
+List the valid
+.Nm
+commands.
 .It Ic mail
 .Pq Ic m
 Takes as argument login names and distribution group names and sends
 mail to those people.
 .It Ic mbox
 Indicate that a list of messages be sent to
-.Ic mbox
+.Ar mbox
 in your home directory when you quit.
 This is the default
 action for messages if you do
@@ -583,18 +584,6 @@ Takes a message list and a filename and appends each message in
 turn to the end of the file.
 The filename in quotes, followed by the line
 count and character count is echoed on the user's terminal.
-.It Ic set
-.Pq Ic se
-With no arguments, prints all variable values.
-Otherwise, sets
-option.
-Arguments are of the form
-.Ar option=value
-(no space before or after =) or
-.Ar option .
-Quotation marks may be placed around any part of the assignment statement to
-quote blanks or tabs, i.e.,
-.Ic set indentprefix="->" .
 .It Ic saveignore
 .Ic saveignore
 is to
@@ -628,6 +617,18 @@ or when automatically saving to
 .Ic saveretain
 overrides
 .Ic saveignore .
+.It Ic set
+.Pq Ic se
+With no arguments, prints all variable values.
+Otherwise, sets
+option.
+Arguments are of the form
+.Ar option=value
+(no space before or after =) or
+.Ar option .
+Quotation marks may be placed around any part of the assignment statement to
+quote blanks or tabs, i.e.,
+.Ic set indentprefix="->" .
 .It Ic shell
 .Pq Ic sh
 Invokes an interactive version of the shell.
@@ -828,6 +829,11 @@ Causes
 to prompt you for the subject of each message you send.
 If
 you respond with simply a newline, no subject field will be sent.
+.It Ar askbcc
+Causes you to be prompted for additional blind carbon copy recipients at the
+end of each message.
+Responding with a newline indicates your
+satisfaction with the current list.
 .It Ar askcc
 Causes you to be prompted for additional carbon copy recipients at the
 end of each message.
@@ -839,11 +845,6 @@ Setting this is similar to issuing the
 .Ic inc
 command at each prompt, except that the current message is not
 reset when new mail arrives.
-.It Ar askbcc
-Causes you to be prompted for additional blind carbon copy recipients at the
-end of each message.
-Responding with a newline indicates your
-satisfaction with the current list.
 .It Ar autoprint
 Causes the
 .Ic delete
@@ -885,6 +886,18 @@ refuse to accept a control-D as the end of a message.
 also applies to
 .Nm mail
 command mode.
+.It Ar keep
+Setting this option causes
+.Nm
+to truncate your system mailbox instead of deleting it
+when it's empty.
+.It Ar keepsave
+Messages saved with the
+.Ic save
+command are not normally saved in
+.Ar mbox
+at quit time.
+Use this option to retain those messages.
 .It Ar metoo
 Usually, when a group is expanded that contains the sender, the sender
 is removed from the expansion.
@@ -918,13 +931,13 @@ Suppresses the printing of the version when first invoked.
 If this option is set, then a message-list specifier in the form
 .Dq /x:y
 will expand to all messages containing the substring
-.Dq y
+.Sq y
 in the header
 field
-.Dq x .
+.Sq x .
 The string search is case insensitive.
 If
-.Dq x
+.Sq x
 is omitted, it will default to the
 .Dq Subject
 header field.
@@ -932,7 +945,7 @@ The form
 .Dq /to:y
 is a special case, and will expand
 to all messages containing the substring
-.Dq y
+.Sq y
 in the
 .Dq To ,
 .Dq Cc
@@ -944,7 +957,7 @@ The check for
 is case sensitive, so that
 .Dq /To:y
 can be used to limit the search for
-.Dq y
+.Sq y
 to just the
 .Dq To:
 field.
@@ -954,7 +967,9 @@ Setting the option
 is the same as using the
 .Fl v
 flag on the command line.
-When mail runs in verbose mode,
+When
+.Nm
+runs in verbose mode,
 the actual delivery of messages is displayed on the user's
 terminal.
 .El
@@ -966,17 +981,27 @@ Pathname of the text editor to use in the
 command and
 .Ic ~e
 escape.
-If not defined, then a default editor is used.
+If not defined,
+.Pa /usr/bin/ex
+is used.
 .It Ev LISTER
 Pathname of the directory lister to use in the
 .Ic folders
 command.
 Default is
 .Pa /bin/ls .
+.It Ev MBOX
+The name of the
+.Ar mbox
+file.
+It can be the name of a folder.
+The default is
+.Dq Li mbox
+in the user's home directory.
 .It Ev PAGER
 Pathname of the program to use in the
 .Ic more
-command or when
+command or when the
 .Ic crt
 variable is set.
 The default paginator
@@ -996,6 +1021,9 @@ Pathname of the text editor to use in the
 command and
 .Ic ~v
 escape.
+If not defined,
+.Pa /usr/bin/vi
+is used.
 .It Va crt
 The valued option
 .Va crt
@@ -1020,18 +1048,6 @@ If this name begins with a
 .Nm mail
 considers it to be an absolute pathname; otherwise, the
 folder directory is found relative to your home directory.
-.It Ev MBOX
-The name of the
-.Ar mbox
-file.
-It can be the name of a folder.
-The default is
-.Dq Li mbox
-in the user's home directory.
-.It Ar record
-If defined, gives the pathname of the file used to record all outgoing
-mail.
-If not defined, then outgoing mail is not so saved.
 .It Ar indentprefix
 String used by the
 .Ic ~m
@@ -1039,6 +1055,15 @@ tilde escape for indenting messages, in place of the normal tab character
 .Pq Sq ^I .
 Be sure to quote the value if it contains
 spaces or tabs.
+.It Ar record
+If defined, gives the pathname of the file used to record all outgoing
+mail.
+If not defined, then outgoing mail is not so saved.
+.It Ar screen
+Size of window of message headers for
+.Ic z .
+.It Ar sendmail
+Pathname to an alternative mail delivery system.
 .It Ar toplines
 If defined, gives the number of lines of a message to be printed out
 with the
@@ -1050,6 +1075,8 @@ command; normally, the first five lines are printed.
 utilizes the
 .Ev HOME ,
 .Ev LOGNAME ,
+.Ev MAIL ,
+.Ev MAILRC ,
 and
 .Ev USER
 environment variables.