X-Git-Url: https://git.subgeniuskitty.com/unix-history/.git/blobdiff_plain/b3f2d7910e5c386474daaf357955ac0dd6d4c9b2..fd88f5c5678c80ff5e338adc372d28a52ad20530:/usr/src/usr.bin/mail/mail.1?ds=inline diff --git a/usr/src/usr.bin/mail/mail.1 b/usr/src/usr.bin/mail/mail.1 index 94d344f096..c928843a5e 100644 --- a/usr/src/usr.bin/mail/mail.1 +++ b/usr/src/usr.bin/mail/mail.1 @@ -1,816 +1,1058 @@ -.\" Copyright (c) 1980 Regents of the University of California. -.\" All rights reserved. The Berkeley software License Agreement -.\" specifies the terms and conditions for redistribution. +.\" Copyright (c) 1980, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. .\" -.\" @(#)mail.1 6.2 (Berkeley) %G% +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. .\" -.TH MAIL 1 "" -.UC 4 -.SH NAME -mail \- send and receive mail -.SH SYNOPSIS -.B mail -[ -.B \-v -] -[ -.B \-i -] -[ -.B \-n -] -[ -.B \-s -subject -] -[ -user ... -] -.br -.B mail -[ -.B \-v -] -[ -.B \-i -] -[ -.B \-n -] -.B \-f -[ -name -] -.br -.B mail -[ -.B \-v -] -[ -.B \-i -] -[ -.B \-n -] -.B \-u -user -.SH INTRODUCTION -.I Mail -is a intelligent mail processing system, which has +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)mail.1 8.8 (Berkeley) 4/28/95 +.\" +.Dd April 28, 1995 +.Dt MAIL 1 +.Os BSD 4 +.Sh NAME +.Nm mail +.Nd send and receive mail +.Sh SYNOPSIS +.Nm mail +.Op Fl iInv +.Op Fl s Ar subject +.Op Fl c Ar cc-addr +.Op Fl b Ar bcc-addr +.Ar to-addr... +.Nm mail +.Op Fl iInNv +.Fl f +.Op Ar name +.Nm mail +.Op Fl iInNv +.Op Fl u Ar user +.Sh INTRODUCTION +.Nm Mail +is an intelligent mail processing system, which has a command syntax reminiscent of -.I ed +.Xr \&ed 1 with lines replaced by messages. -.PP -The -.B \-v -flag puts mail into verbose mode; the details of -delivery are displayed on the users terminal. -The -.B \-i -flag causes tty interrupt signals to be ignored. This is +.Pp +.Bl -tag -width flag +.It Fl v +Verbose mode. +The details of +delivery are displayed on the user's terminal. +.It Fl i +Ignore tty interrupt signals. +This is particularly useful when using -.I mail +.Nm mail on noisy phone lines. -The -.B \-n -flag inhibits the reading of /usr/lib/Mail.rc. -.PP -.I "Sending mail.\ " -To send a message to one or more other people, -.I mail -can be invoked with arguments which are the names of people to -send to. You are then expected to type in your message, followed -by an \s-2EOT\s0 (control\-D) at the beginning of a line. -A subject may be specified on the command line by using the -.B \-s -flag. (Only the first argument after the -.B \-s +.It Fl I +Forces mail to run in interactive mode even when +input isn't a terminal. +In particular, the +.Sq Ic \&~ +special +character when sending mail is only active in interactive mode. +.It Fl n +Inhibits reading +.Pa /etc/mail.rc +upon startup. +.It Fl N +Inhibits the initial display of message headers +when reading mail or editing a mail folder. +.It Fl s +Specify subject on command line +(only the first argument after the +.Fl s flag is used as a subject; be careful to quote subjects containing spaces.) -The section below, labeled -.I "Replying to or originating mail," +.It Fl c +Send carbon copies to +.Ar list +of users. +.It Fl b +Send blind carbon copies to +.Ar list . +List should be a comma-separated list of names. +.It Fl f +Read in the contents of your +.Ar mbox +(or the specified file) +for processing; when you +.Ar quit , +.Nm mail +writes undeleted messages back to this file. +.It Fl u +Is equivalent to: +.Pp +.Dl mail -f /var/mail/user +.El +.Ss Sending mail +To send a message to one or more people, +.Nm mail +can be invoked with arguments which are the names of people to +whom the mail will be sent. +You are then expected to type in +your message, followed +by an +.Sq Li control\-D +at the beginning of a line. +The section below +.Ar Replying to or originating mail , describes some features of -.I mail +.Nm mail available to help you compose your letter. -.PP -.I "Reading mail.\ " +.Pp +.Ss Reading mail In normal usage -.I mail +.Nm mail is given no arguments and checks your mail out of the post office, then -prints out a one line header of each message there. +prints out a one line header of each message found. The current message is initially the first message (numbered 1) and can be printed using the -.B print -command (which can be abbreviated \fBp\fR). +.Ic print +command (which can be abbreviated +.Ql Ic p ) . You can move among the messages much as you move between lines in -.IR ed , -with the commands `+' and `\-' moving backwards and forwards, and +.Xr \&ed 1 , +with the commands +.Ql Ic \&+ +and +.Ql Ic \&\- +moving backwards and forwards, and simple numbers. -.PP -.I "Disposing of mail.\ " +.Pp +.Ss Disposing of mail. After examining a message you can -.B delete -(\fBd\fR) +.Ic delete +.Ql Ic d ) the message or -.B reply -(\fBr\fR) +.Ic reply +.Ql Ic r ) to it. Deletion causes the -.I mail +.Nm mail program to forget about the message. This is not irreversible; the message can be -.B undeleted -(\fBu\fR) +.Ic undeleted +.Ql Ic u ) by giving its number, or the -.I mail +.Nm mail session can be aborted by giving the -.B exit -(\fBx\fR) +.Ic exit +.Ql Ic x ) command. Deleted messages will, however, usually disappear never to be seen again. -.PP -.I "Specifying messages.\ " +.Pp +.Ss Specifying messages Commands such as -.B print +.Ic print and -.B delete +.Ic delete can be given a list of message numbers as arguments to apply to a number of messages at once. -Thus ``delete 1 2'' deletes messages 1 and 2, while ``delete 1\-5'' +Thus +.Dq Li delete 1 2 +deletes messages 1 and 2, while +.Dq Li delete 1\-5 deletes messages 1 through 5. -The special name ``*'' addresses all messages, and ``$'' addresses +The special name +.Ql Li \&* +addresses all messages, and +.Ql Li \&$ +addresses the last message; thus the command -.B top +.Ic top which prints the first few lines of a message could be used in -``top *'' to print the first few lines of all messages. -.PP -.I "Replying to or originating mail.\ " +.Dq Li top \&* +to print the first few lines of all messages. +.Pp +.Ss Replying to or originating mail. You can use the -.B reply +.Ic reply command to set up a response to a message, sending it back to the person who it was from. Text you then type in, up to an end-of-file, defines the contents of the message. While you are composing a message, -.I mail -treats lines beginning with the character `~' specially. -For instance, typing ``~m'' (alone on a line) will place a copy -of the current message into the response right shifting it by a tabstop. +.Nm mail +treats lines beginning with the character +.Ql Ic \&~ +specially. +For instance, typing +.Ql Ic \&~m +(alone on a line) will place a copy +of the current message into the response right shifting it by a tabstop +(see +.Em 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 -message or to a shell to run some commands. (These options +message or to a shell to run some commands. +(These options are given in the summary below.) -.PP -.I "Ending a mail processing session.\ " +.Pp +.Ss Ending a mail processing session. You can end a -.I mail +.Nm mail session with the -.B quit -(\fBq\fR) +.Ic quit +.Ql Ic q ) command. Messages which have been examined go to your -.I mbox +.Ar mbox file unless they have been deleted in which case they are discarded. Unexamined messages go back to the post office. -The -.B \-f -option causes -.I mail -to read in the contents of your -.I mbox -(or the specified file) -for processing; when you -.BR quit , -.I mail -writes undeleted messages back to this file. -The -.B \-u -flag is a short way of doing -"mail -.B \-f -/usr/spool/mail/user". -.PP -.I "Personal and systemwide distribution lists.\ " +(See the +.Fl f +option above). +.Pp +.Ss Personal and systemwide distribution lists. It is also possible to create a personal distribution lists so that, -for instance, you can send mail to ``cohorts'' and have it go +for instance, you can send mail to +.Dq Li cohorts +and have it go to a group of people. Such lists can be defined by placing a line like -.IP -alias cohorts bill ozalp jkf mark kridle@ucbcory -.PP -in the file \&.mailrc in your home directory. +.Pp +.Dl alias cohorts bill ozalp jkf mark kridle@ucbcory +.Pp +in the file +.Pa \&.mailrc +in your home directory. The current list of such aliases can be displayed with the -.B alias -.B (a) +.Ic alias command in -.IR mail . +.Nm mail . System wide distribution lists can be created by editing -/usr/lib/aliases, see -.IR aliases (5) +.Pa /etc/aliases , +see +.Xr aliases 5 and -.IR sendmail (8); +.Xr sendmail 8 ; these are kept in a different syntax. In mail you send, personal aliases will be expanded in mail sent -to others so that they will be able to \fBreply\fR to the recipients. -System wide \fIaliases\fR are not expanded when the mail is sent, +to others so that they will be able to +.Ic reply +to the recipients. +System wide +.Ic aliases +are not expanded when the mail is sent, but any reply returned to the machine will have the system wide alias expanded as all mail goes through -.IR sendmail . -.PP -.I "Network mail (ARPA, UUCP, Berknet)\ " +.Xr sendmail . +.Pp +.Ss Network mail (ARPA, UUCP, Berknet) See -.IR mailaddr(7) +.Xr mailaddr 7 for a description of network addresses. -.PP -.I Mail +.Pp +.Nm Mail has a number of options which can be set in the -.I \&.mailrc -file to alter its behavior; thus ``set askcc'' enables the ``askcc'' -feature. (These options are summarized below.) -.SH SUMMARY +.Pa .mailrc +file to alter its behavior; thus +.Dq Li set askcc +enables the +.Ar askcc +feature. +(These options are summarized below.) +.Sh SUMMARY (Adapted from the `Mail Reference Manual') -.PP +.Pp Each command is typed on a line by itself, and may take arguments -following the command word. The command need not be typed in its +following the command word. +The command need not be typed in its entirety \- the first command which matches the typed prefix is used. For commands which take message lists as arguments, if no message list is given, then the next message forward which satisfies the -command's requirements is used. If there are no messages forward of +command's requirements is used. +If there are no messages forward of the current message, the search proceeds backwards, and if there are no good messages at all, -.I mail -types ``No applicable messages'' and +.Nm mail +types +.Dq Li No applicable messages +and aborts the command. -.TP 12n -.B \- -Goes to the previous message and prints it out. If given a numeric +.Bl -tag -width delete +.It Ic \&\- +Print out the preceding message. +If given a numeric argument -.IR n , +.Ar n , goes to the -.IR n -th +.Ar n Ns 'th previous message and prints it. -.TP -.B ? +.It Ic \&? Prints a brief summary of commands. -.TP -.B ! -Executes the \s-2UNIX\s0 shell command which follows. -.TP -.B Print -(\fBP\fR) +.It Ic \&! +Executes the shell +(see +.Xr sh 1 +and +.Xr csh 1 ) +command which follows. +.It Ic Print +.Pq Ic P Like -.B print -but also prints out ignored header fields. See also -.B print -, -.B ignore +.Ic print +but also prints out ignored header fields. +See also +.Ic print , +.Ic ignore and -.B retain. -.TP -.B Reply -(\fRR\fR) -Reply to originator. Does not reply to other +.Ic retain . +.It Ic Reply +.Pq Ic R +Reply to originator. +Does not reply to other recipients of the original message. -.TP -.B Type -(\fTT\fR) +.It Ic Type +.Pq Ic T Identical to the -.B Print +.Ic Print command. -.TP -.B alias -(\fBa\fR) With no arguments, prints out all currently-defined aliases. With one -argument, prints out that alias. With more than one argument, creates -an new or changes an on old alias. -.TP -.B alternates -(\fBalt\fR) +.It Ic alias +.Pq Ic a +With no arguments, prints out all currently-defined aliases. +With one +argument, prints out that alias. +With more than one argument, creates +a new alias or changes an old one. +.It Ic alternates +.Pq Ic alt The -.B alternates +.Ic alternates command is useful if you have accounts on several machines. It can be used to inform -.I mail -that the listed addresses are really you. When you -.B reply +.Nm mail +that the listed addresses are really you. +When you +.Ic reply to messages, -.I mail +.Nm mail will not send a copy of the message to any of the addresses listed on the -.I alternates -list. If the -.B alternates +.Ic alternates +list. +If the +.Ic alternates command is given with no argument, the current set of alternate names is displayed. -.TP -.B chdir -(\fBc\fR) Changes the user's working directory to that specified, if given. If +.It Ic chdir +.Pq Ic c +Changes the user's working directory to that specified, if given. +If no directory is given, then changes to the user's login directory. -.TP -.B copy -(\fBco\fR) +.It Ic copy +.Pq Ic co The -.B copy +.Ic copy command does the same thing that -.B save +.Ic save does, except that it does not mark the messages it is used on for deletion when you quit. -.TP -.B delete -(\fBd\fR) Takes a list of messages as argument and marks them all as deleted. +.It Ic delete +.Pq Ic d +Takes a list of messages as argument and marks them all as deleted. Deleted messages will not be saved in -.IR mbox , -nor will they be available for most other commands. -.TP -.B dp -(also \fBdt\fR) Deletes the current message and prints the next message. -If there is no next message, -.I mail -says ``at EOF.'' -.TP -.B edit -(\fBe\fR) Takes a list of messages and points the text editor at each one in -turn. On return from the editor, the message is read back in. -.TP -.B exit -(\fBex\fR or \fBx\fR) Effects an immediate return to the Shell without +.Ar mbox , +nor will they be available for most other commands. +.It Ic dp +(also +.Ic dt ) +Deletes the current message and prints the next message. +If there is no next message, +.Nm mail +says +.Dq Li "at EOF" . +.It Ic edit +.Pq Ic e +Takes a list of messages and points the text editor at each one in +turn. +On return from the editor, the message is read back in. +.It Ic exit +.Pf ( Ic ex +or +.Ic x ) +Effects an immediate return to the Shell without modifying the user's system mailbox, his -.I mbox +.Ar mbox file, or his edit file in -.BR \-f . -.TP -.B file -(\fBfi\fR) +.Fl f . +.It Ic file +.Pq Ic fi The same as -.BR folder . -.TP -.B folders +.Ic folder . +.It Ic folders List the names of the folders in your folder directory. -.TP -.B folder -(\fBfo\fR) +.It Ic folder +.Pq Ic fo The -.B folder -command switches to a new mail file or folder. With no +.Ic folder +command switches to a new mail file or folder. +With no arguments, it tells you which file you are currently reading. If you give it an argument, it will write out changes (such as deletions) you have made in the current file and read in -the new file. Some special conventions are recognized for -the name. # means the previous file, % means your system +the new file. +Some special conventions are recognized for +the name. +# means the previous file, % means your system mailbox, %user means user's system mailbox, & means -your \~/mbox file, and +folder means a file in your folder +your +.Ar mbox +file, and +\&+\&folder means a file in your folder directory. -.TP -.B from -(\fBf\fR) Takes a list of messages and prints their message headers. -.TP -.B headers -(\fBh\fR) Lists the current range of headers, which is an 18 message group. If -a ``+'' argument is given, then the next 18 message group is printed, and if -a ``\-'' argument is given, the previous 18 message group is printed. -.TP -.B help -A synonym for ? -.TP -.B hold -(\fBho\fR, also \fBpreserve\fR) Takes a message list and marks each +.It Ic from +.Pq Ic f +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, then the next 18\-message group is printed, and if +a +.Ql \&\- +argument is given, the previous 18\-message group is printed. +.It Ic help +A synonym for +.Ic \&? +.ne 1i +.It Ic hold +.Pf ( Ic ho , +also +.Ic preserve ) +Takes a message list and marks each message therein to be saved in the user's system mailbox instead of in -.IR mbox . +.Ar mbox . Does not override the -.B delete +.Ic delete command. -.TP -.B ignore -.B N.B.: -.I Ignore -has been superseded by -.I retain. -.br +.It Ic ignore Add the list of header fields named to the -.IR "ignored list" . +.Ar ignored list . Header fields in the ignore list are not printed -on your terminal when you print a message. This +on your terminal when you print a message. +This command is very handy for suppression of certain machine-generated -header fields. The -.B Type +header fields. +The +.Ic Type and -.B Print +.Ic Print commands can be used to print a message in its entirety, including -ignored fields. If -.B ignore +ignored fields. +If +.Ic ignore is executed with no arguments, it lists the current set of ignored fields. -.TP -.B mail -(\fBm\fR) Takes as argument login names and distribution group names and sends +.It Ic inc +Incorporate any new messages that have arrived while mail +is being read. +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 +does it cause any changes made so far to be saved. +.It Ic mail +.Pq Ic m +Takes as argument login names and distribution group names and sends mail to those people. -.TP -.B mbox +.It Ic mbox Indicate that a list of messages be sent to -.I mbox -in your home directory when you quit. This is the default +.Ic mbox +in your home directory when you quit. +This is the default action for messages if you do -.I not +.Em not have the -.I hold +.Ic hold option set. -.TP -.B next -(\fBn\fR like \fB+\fR or CR) Goes to the next message in sequence and types it. +.It Ic next +.Pq Ic n +like +.Ic \&+ +or +.Tn CR ) +Goes to the next message in sequence and types it. With an argument list, types the next matching message. -.TP -.B preserve -(\fBpre\fR) +.It Ic preserve +.Pq Ic pre A synonym for -.BR hold . -.TP -.B print -(\fBp\fR) +.Ic hold . +.It Ic print +.Pq Ic p Takes a message list and types out each message on the user's terminal. -.TP -.B quit -(\fBq\fR) Terminates the session, saving all undeleted, unsaved messages in +.It Ic quit +.Pq Ic q +Terminates the session, saving all undeleted, unsaved messages in the user's -.I mbox +.Ar mbox file in his login directory, preserving all messages marked with -.B hold +.Ic hold or -.B preserve +.Ic preserve or never referenced in his system mailbox, and removing all other messages from his system -mailbox. If new mail has arrived during the session, the message -``You have new mail'' is given. If given while editing a +mailbox. +If new mail has arrived during the session, the message +.Dq Li "You have new mail" +is given. +If given while editing a mailbox file with the -.B \-f -flag, then the edit file is rewritten. A return to the Shell is +.Fl f +flag, then the edit file is rewritten. +A return to the Shell is effected, unless the rewrite of edit file fails, in which case the user can escape with the -.B exit +.Ic exit command. -.TP -.B reply -(\fBr\fR) +.It Ic reply +.Pq Ic r Takes a message list and sends mail to the sender and all recipients of the specified message. The default message must not be deleted. -.TP -.B respond +.It Ic respond A synonym for -.BR reply . -.TP -.B retain +.Ic reply . +.It Ic retain Add the list of header fields named to the -.IR "retained list" . +.Ar retained list Only the header fields in the retain list are shown on your terminal when you print a message. All other header fields are suppressed. The -.B Type +.Ic Type and -.B Print +.Ic Print commands can be used to print a message in its entirety. If -.B retain +.Ic retain is executed with no arguments, it lists the current set of retained fields. -.TP -.B save -(\fBs\fR) 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. -.TP -.B set -(\fBse\fR) With no arguments, prints all variable values. Otherwise, sets -option. Arguments are of the form -``option=value'' +.It Ic save +.Pq Ic s +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 -``option.'' -.TP -.B shell -(\fBsh\fR) Invokes an interactive version of the shell. -.TP -.B size +.Ar option . +Quotation marks may be placed around any part of the assignment statement to +quote blanks or tabs, i.e. +.Dq Li "set indentprefix=\*q->\*q" +.It Ic saveignore +.Ic Saveignore +is to +.Ic save +what +.Ic ignore +is to +.Ic print +and +.Ic type . +Header fields thus marked are filtered out when +saving a message by +.Ic save +or when automatically saving to +.Ar mbox . +.pl +1 +.It Ic saveretain +.Ic Saveretain +is to +.Ic save +what +.Ic retain +is to +.Ic print +and +.Ic type . +Header fields thus marked are the only ones saved +with a message when saving by +.Ic save +or when automatically saving to +.Ar mbox . +.Ic Saveretain +overrides +.Ic saveignore . +.It Ic shell +.Pq Ic sh +Invokes an interactive version of the shell. +.It Ic size Takes a message list and prints out the size in characters of each message. -.TP -.B source -(\fBso\fR) +.It Ic source The -.B source +.Ic source command reads -.I mail commands from a file. -.TP -.B top -Takes a message list and prints the top few lines of each. The number of +.It Ic top +Takes a message list and prints the top few lines of each. +The number of lines printed is controlled by the variable -.B toplines +.Ic toplines and defaults to five. -.TP -.B type -(\fBt\fR) A synonym for -.BR print . -.TP -.B unalias +.It Ic type +.Pq Ic t +A synonym for +.Ic print . +.It Ic unalias Takes a list of names defined by -.B alias -commands and discards the remembered groups of users. The group names +.Ic alias +commands and discards the remembered groups of users. +The group names no longer have any significance. -.TP -.B undelete -(\fBu\fR) Takes a message list and marks each one as -.I not +.It Ic undelete +.Pq Ic u +Takes a message list and marks each message as +.Ic not being deleted. -.TP -.B unset +.It Ic unread +.Pq Ic U +Takes a message list and marks each message as +.Ic not +having been read. +.It Ic unset Takes a list of option names and discards their remembered values; the inverse of -.BR set . -.TP -.B visual -(\fBv\fR) Takes a message list and invokes the display editor on each message. -.TP -.B write -(\fBw\fR) Similar to -.BR save , +.Ic set . +.It Ic visual +.Pq Ic v +Takes a message list and invokes the display editor on each message. +.It Ic write +.Pq Ic w +Similar to +.Ic save , except that -.I only -the message body (\fIwithout\fP the header) is saved. +.Ic only +the message body +.Pq Ar without +the header) is saved. Extremely useful for such tasks as sending and receiving source program text over the message system. -.TP -.B xit -(\fBx\fR) A synonym for -.BR exit . -.TP -.B z -.I Mail +.It Ic xit +.Pq Ic x +A synonym for +.Ic exit . +.It Ic z +.Nm Mail presents message headers in windowfuls as described under the -.B headers -command. You can move -.IR mail 's +.Ic headers +command. +You can move +.Nm mail Ns 's attention forward to the next window with the -.B z -command. Also, you can move to the previous window by using -.BR z\- . -.PP +.Ic \&z +command. +Also, you can move to the previous window by using +.Ic \&z\&\- . +.El +.Ss Tilde/Escapes +.Pp Here is a summary of the tilde escapes, which are used when composing messages to perform -special functions. Tilde escapes are only recognized at the beginning -of lines. The name -``tilde\ escape'' +special functions. +Tilde escapes are only recognized at the beginning +of lines. +The name +.Dq Em tilde\ escape is somewhat of a misnomer since the actual escape character can be set by the option -.B escape. -.TP 12n -.BR ~! command +.Ic escape . +.Bl -tag -width Ds +.It Ic \&~! Ns Ar command Execute the indicated shell command, then return to the message. -.TP -\fB~c\fR name ... +.It Ic \&~b Ns Ar name ... +Add the given names to the list of carbon copy recipients but do not make +the names visible in the Cc: line ("blind" carbon copy). +.It Ic \&~c Ns Ar name ... Add the given names to the list of carbon copy recipients. -.TP -.B ~d -Read the file ``dead.letter'' from your home directory into the message. -.TP -.B ~e -Invoke the text editor on the message collected so far. After the +.It Ic \&~d +Read the file +.Dq Pa dead.letter +from your home directory into the message. +.It Ic \&~e +Invoke the text editor on the message collected so far. +After the editing session is finished, you may continue appending text to the message. -.TP -\fB~f\fR messages +.It Ic \&~f Ns Ar messages Read the named messages into the message being sent. If no messages are specified, read in the current message. -.TP -.B ~h +Message headers currently being ignored (by the +.Ic ignore +or +.Ic retain +command) are not included. +.ne 1i +.It Ic \&~F Ns Ar messages +Identical to +.Ic \&~f , +except all message headers are included. +.It Ic \&~h Edit the message header fields by typing each one in turn and allowing the user to append text to the end or modify the field by using the current terminal erase and kill characters. -.TP -\fB~m\fR messages -Read the named messages into the message being sent, shifted right one -tab. If no messages are specified, read the current message. -.TP -.B ~p +.It Ic \&~m Ns Ar messages +Read the named messages into the message being sent, indented by a +tab or by the value of +.Ar indentprefix . +If no messages are specified, +read the current message. +Message headers currently being ignored (by the +.Ic ignore +or +.Ic retain +command) are not included. +.It Ic \&~M Ns Ar messages +Identical to +.Ic \&~m , +except all message headers are included. +.It Ic \&~p Print out the message collected so far, prefaced by the message header fields. -.TP -.B ~q +.It Ic \&~q Abort the message being sent, copying the message to -``dead.letter'' +.Dq Pa dead.letter in your home directory if -.B save +.Ic save is set. -.TP -\fB~r\fR filename +.It Ic \&~r Ns Ar filename Read the named file into the message. -.TP -\fB~s\fR string +.It Ic \&~s Ns Ar string Cause the named string to become the current subject field. -.TP -\fB~t\fR name ... +.It Ic \&~\&t Ns Ar name ... Add the given names to the direct recipient list. -.TP -.B ~v -Invoke an alternate editor (defined by the VISUAL option) on the -message collected so far. Usually, the alternate editor will be a -screen editor. After you quit the editor, you may resume appending +.It Ic \&~\&v +Invoke an alternate editor (defined by the +.Ev VISUAL +option) on the +message collected so far. +Usually, the alternate editor will be a +screen editor. +After you quit the editor, you may resume appending text to the end of your message. -.TP -\fB~w\fR filename +.It Ic \&~w Ns Ar filename Write the message onto the named file. -.TP -\fB~\||\|\fRcommand -Pipe the message through the command as a filter. If the command gives +.It Ic \&~\&| Ns Ar command +Pipe the message through the command as a filter. +If the command gives no output or terminates abnormally, retain the original text of the -message. The command -.IR fmt (1) +message. +The command +.Xr fmt 1 is often used as -.I command +.Ic command to rejustify the message. -.TP -.BR ~~ string -Insert the string of text in the message prefaced by a single ~. If +.It Ic \&~: Ns Ar mail-command +Execute the given mail command. +Not all commands, however, are allowed. +.It Ic \&~~ Ns Ar string +Insert the string of text in the message prefaced by a single ~. +If you have changed the escape character, then you should double that character in order to send it. -.PP -Options are controlled via the -.B set +.El +.Ss Mail Options +Options are controlled via +.Ic set and -.B unset -commands. Options may be either binary, in which case it is only -significant to see whether they are set or not, or string, in which +.Ic unset +commands. +Options may be either binary, in which case it is only +significant to see whether they are set or not; or string, in which case the actual value is of interest. The binary options include the following: -.TP 15n -.B append +.Bl -tag -width append +.It Ar append Causes messages saved in -.I mbox +.Ar mbox to be appended to the end rather than prepended. -(This is set in -/usr/lib/Mail.rc -on version 7 systems.) -.TP -.B ask +This should always be set (perhaps in +.Pa /etc/mail.rc ) . +.It Ar ask Causes -.I mail -to prompt you for the subject of each message you send. If +.Nm mail +to prompt you for the subject of each message you send. +If you respond with simply a newline, no subject field will be sent. -.TP -.B askcc +.ne 1i +.It Ar askcc Causes you to be prompted for additional carbon copy recipients at the -end of each message. Responding with a newline indicates your +end of each message. +Responding with a newline indicates your satisfaction with the current list. -.TP -.B autoprint +.It Ar autoinc +Causes new mail to be automatically incorporated when it arrives. +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 autoprint Causes the -.B delete +.Ic delete command to behave like -.B dp +.Ic dp \- thus, after deleting a message, the next one will be typed automatically. -.TP -.B debug +.It Ar debug Setting the binary option -.I debug +.Ar debug is the same as specifying -.B \-d +.Fl d on the command line and causes -.I mail +.Nm mail to output all sorts of information useful for debugging -.IR mail . -.TP -.B dot +.Nm mail . +.It Ar dot The binary option -.I dot +.Ar dot causes -.I mail +.Nm mail to interpret a period alone on a line as the terminator of a message you are sending. -.TP -.B hold +.It Ar hold This option is used to hold messages in the system mailbox by default. -.TP -.B ignore +.It Ar ignore Causes interrupt signals from your terminal to be ignored and echoed as @'s. -.TP -.B ignoreeof +.It Ar ignoreeof An option related to -.I dot +.Ar dot is -.I ignoreeof +.Ar ignoreeof which makes -.I mail +.Nm mail refuse to accept a control-d as the end of a message. -.I Ignoreeof +.Ar Ignoreeof also applies to -.I mail +.Nm mail command mode. -.TP -.B metoo +.It Ar metoo Usually, when a group is expanded that contains the sender, the sender -is removed from the expansion. Setting this option causes the sender +is removed from the expansion. +Setting this option causes the sender to be included in the group. -.TP -.B nosave -Normally, when you abort a message with two \s-2RUBOUT\s0, -.I mail -copies the partial letter to the file ``dead.letter'' -in your home directory. Setting the binary option -.I nosave +.It Ar noheader +Setting the option +.Ar noheader +is the same as giving the +.Fl N +flag on the command line. +.It Ar nosave +Normally, when you abort a message with two +.Tn RUBOUT +(erase or delete) +.Nm mail +copies the partial letter to the file +.Dq Pa dead.letter +in your home directory. +Setting the binary option +.Ar nosave prevents this. -.TP -.B quiet +.It Ar Replyall +Reverses the sense of +.Ic reply +and +.Ic Reply +commands. +.It Ar quiet Suppresses the printing of the version when first invoked. -.TP -.B verbose +.It Ar searchheaders +If this option is set, then a message-list specifier in the form ``/x:y'' +will expand to all messages containing the substring ``y'' in the header +field ``x''. The string search is case insensitive. +If ``x'' is ommitted, it will default to the ``Subject'' header field. +The form ``/to:y'' is a special case, and will expand +to all messages containing the substring ``y'' in the ``To'', ``Cc'' +or ``Bcc'' header fields. +The check for "to" is case sensitive, so that +``/To:y'' can be used to limit the search for ``y'' to just +the ``To:'' field. +.It Ar verbose Setting the option -.I verbose +.Ar verbose is the same as using the -.B \-v -flag on the command line. When mail runs in verbose mode, -the actual delivery of messages is displayed on he users +.Fl v +flag on the command line. +When mail runs in verbose mode, +the actual delivery of messages is displayed on the user's terminal. -.PP -The following options have string values: -.TP 15n -EDITOR +.El +.Ss Option String Values +.Bl -tag -width Va +.It Ev EDITOR Pathname of the text editor to use in the -.B edit -command and ~e escape. If not defined, then a default editor is used. -.TP -SHELL +.Ic edit +command and +.Ic \&~e +escape. +If not defined, then a default editor is used. +.It Ev LISTER +Pathname of the directory lister to use in the +.Ic folders +command. +Default is +.Pa /bin/ls . +.It Ev PAGER +Pathname of the program to use in the +.Ic more +command or when +.Ic crt +variable is set. +The default paginator +.Xr more 1 +is used if this option is not defined. +.It Ev SHELL Pathname of the shell to use in the -.B ! -command and the ~! escape. A default shell is used if this option is +.Ic \&! +command and the +.Ic \&~! +escape. +A default shell is used if this option is not defined. -.TP -VISUAL +.It Ev VISUAL Pathname of the text editor to use in the -.B visual -command and ~v escape. -.TP -.B crt +.Ic visual +command and +.Ic \&~v +escape. +.ne 1i +.It Va crt The valued option -.I crt +.Va crt is used as a threshold to determine how long a message must be before -.I more +.Ev PAGER is used to read it. -.TP -.B escape +If +.Va crt +is set without a value, +then the height of the terminal screen stored in the system +is used to compute the threshold (see +.Xr stty 1 ) . +.It Ar escape If defined, the first character of this option gives the character to use in the place of ~ to denote escapes. -.TP -.B folder +.It Ar folder The name of the directory to use for storing folders of -messages. If this name begins with a `/', -.I mail +messages. +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. -.TP -.B record +.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. -.TP -.B toplines +mail. +If not defined, then outgoing mail is not so saved. +.It Ar indentprefix +String used by the ``~m'' tilde escape for indenting messages, in place of +the normal tab character (^I). +Be sure to quote the value if it contains +spaces or tabs. +.It Ar toplines If defined, gives the number of lines of a message to be printed out with the -.B top +.Ic top command; normally, the first five lines are printed. -.SH FILES -.if n .ta 2.5i -.if t .ta 1.8i -/usr/spool/mail/* post office -.br -~/mbox your old mail -.br -~/.mailrc file giving initial mail commands -.br -/tmp/R# temporary for editor escape -.br -/usr/lib/Mail.help* help files -.br -/usr/lib/Mail.rc system initialization file -.br -Message* temporary for editing messages -.SH "SEE ALSO" -binmail(1), fmt(1), newaliases(1), aliases(5), -.br -mailaddr(7), sendmail(8) -.br -`The Mail Reference Manual' -.SH BUGS -There are many flags that are not documented here. Most are +.El +.Sh ENVIRONMENT +.Nm Mail +utilizes the +.Ev HOME +and +.Ev USER +environment variables. +.Sh FILES +.Bl -tag -width /usr/share/misc/Mail.help* -compact +.It Pa /var/mail/* +Post office. +.It ~/mbox +User's old mail. +.It ~/.mailrc +File giving initial mail commands. +This can be overridden by setting the +.Ev MAILRC +environment variable. +.It Pa /tmp/R* +Temporary files. +.It Pa /usr/share/misc/Mail.help* +Help files. +.It Pa /etc/mail.rc +System initialization file. +.El +.Sh SEE ALSO +.Xr fmt 1 , +.Xr newaliases 1 , +.Xr vacation 1 , +.Xr aliases 5 , +.Xr mailaddr 7 , +.Xr sendmail 8 +and +.Rs +.%T "The Mail Reference Manual" . +.Re +.Sh HISTORY +A +.Nm mail +command +appeared in +.At v6 . +This man page is derived from +.%T "The Mail Reference Manual" +originally written by Kurt Shoens. +.Sh BUGS +There are some flags that are not documented here. +Most are not useful to the general user. -.br +.Pp Usually, -.I mail +.Nm mail is just a link to -.IR Mail , +.Nm Mail , which can be confusing. -.SH AUTHOR -Kurt Shoens