The Regents of the University of California. All rights reserved.
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.
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.2 (Berkeley) 12/30/93
$FreeBSD: head/usr.bin/mail/mail.1 70197 2000-12-19 16:00:12Z ru $
.Dd December 30, 1993 .Dt MAIL 1 .Os BSD 4 .Sh NAME .Nm mail .Nd send and receive mail .Sh SYNOPSIS .Nm .Op Fl iInv .Op Fl s Ar subject .Op Fl c Ar cc-addr .Op Fl b Ar bcc-addr .Ar to-addr ... .Op - Ar sendmail-option ... .Nm .Op Fl iInNv .Fl f .Op Ar name .Nm .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 .Xr ed 1 with lines replaced by messages.
p l -tag -width flag t Fl v Verbose mode. The details of delivery are displayed on the user's terminal. t Fl i Ignore tty interrupt signals. This is particularly useful when using .Nm on noisy phone lines. t 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. t Fl n Inhibits reading the system-wide
a mail.rc files upon startup. t Fl N Inhibits the initial display of message headers when reading mail or editing a mail folder. t 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.) t Fl c Send carbon copies to .Ar list of users. t Fl b Send blind carbon copies to .Ar list . List should be a comma-separated list of names. t Fl f Read in the contents of your .Ar mbox (or the specified file) for processing; when you .Ar quit , .Nm writes undeleted messages back to this file. t Fl u Is equivalent to:
p .Dl mail -f /var/mail/user .El .Ss Startup actions At startup time .Nm will execute commands in the system command files
a /etc/mail.rc in order, unless explicitly told not to by the use of the .Fl n option. Next, the commands in the user's personal command file
a ~/.mailrc are executed. .Nm then examines its command line options to determine whether a new message is to be sent, or whether an existing mailbox is to be read. .Ss Sending mail To send a message to one or more people, .Nm 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 a .Sq Li control-D at the beginning of a line. The section below .Ar Replying to or originating mail , describes some features of .Nm available to help you compose your letter.
p .Ss Reading mail In normal usage .Nm is given no arguments and checks your mail out of the post office, then 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 c print command (which can be abbreviated .Ql Ic p ) . You can move among the messages much as you move between lines in .Xr ed 1 , with the commands .Ql Ic + and .Ql Ic \- moving backwards and forwards, and simple numbers.
p .Ss Disposing of mail. After examining a message you can c delete
q Ic d the message or c reply
q Ic r to it. Deletion causes the .Nm program to forget about the message. This is not irreversible; the message can be c undeleted
q Ic u by giving its number, or the .Nm session can be aborted by giving the c exit
q Ic x command. Deleted messages will, however, usually disappear never to be seen again.
p .Ss Specifying messages Commands such as c print and c delete can be given a list of message numbers as arguments to apply to a number of messages at once. 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 .Ql Li * addresses all messages, and .Ql Li $ addresses the last message; thus the command c top which prints the first few lines of a message could be used in .Dq Li top * to print the first few lines of all messages.
p .Ss Replying to or originating mail. You can use the c 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, .Nm 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 are given in the summary below.)
p .Ss Ending a mail processing session. You can end a .Nm session with the c quit
q Ic q command. Messages which have been examined go to your .Ar mbox 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).
p .Ss Personal and system wide distribution lists. It is also possible to create a personal distribution lists so that, 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
p .Dl alias cohorts bill ozalp jkf mark kridle@ucbcory
p in the file
a .mailrc in your home directory. The current list of such aliases can be displayed with the c alias command in .Nm . System wide distribution lists can be created by editing
a /etc/mail/aliases , see .Xr aliases 5 and .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 c reply to the recipients. System wide c 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 .Xr sendmail .
p .Ss Network mail (ARPA, UUCP, Berknet) See .Xr mailaddr 7 for a description of network addresses.
p .Nm Mail has a number of options which can be set in the
a .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')
p 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 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 the current message, the search proceeds backwards, and if there are no good messages at all, .Nm types .Dq Li No applicable messages and aborts the command. l -tag -width delete t Ic \- Print out the preceding message. If given a numeric argument .Ar n , goes to the .Ar n Ns 'th previous message and prints it. t Ic # ignore the remainder of the line as a comment. t Ic ? Prints a brief summary of commands. t Ic ! Executes the shell (see .Xr sh 1 and .Xr csh 1 ) command which follows. t Ic Print
q Ic P Like c print but also prints out ignored header fields. See also c print , c ignore and c retain . t Ic Reply
q Ic R Reply to originator. Does not reply to other recipients of the original message. t Ic Type
q Ic T Identical to the c Print command. t Ic alias
q 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. t Ic alternates
q Ic alt The c alternates command is useful if you have accounts on several machines. It can be used to inform .Nm that the listed addresses are really you. When you c reply to messages, .Nm will not send a copy of the message to any of the addresses listed on the c alternates list. If the c alternates command is given with no argument, the current set of alternate names is displayed. t Ic chdir
q 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. t Ic copy
q Ic co The c copy command does the same thing that c save does, except that it does not mark the messages it is used on for deletion when you quit. t Ic delete
q Ic d Takes a list of messages as argument and marks them all as deleted. Deleted messages will not be saved in .Ar mbox , nor will they be available for most other commands. t Ic dp (also c dt ) Deletes the current message and prints the next message. If there is no next message, .Nm says .Dq Li "at EOF" . t Ic edit
q 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. t Ic exit
f ( Ic ex or c x ) Effects an immediate return to the Shell without modifying the user's system mailbox, his .Ar mbox file, or his edit file in .Fl f . t Ic file
q Ic fi The same as c folder . t Ic folders List the names of the folders in your folder directory. t Ic folder
q Ic fo The c 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 mailbox, %user means user's system mailbox, & means your .Ar mbox file, and +folder means a file in your folder directory. t Ic from
q Ic f Takes a list of messages and prints their message headers. t Ic headers
q 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. t Ic help A synonym for c ? t Ic hold
f ( Ic ho , also c preserve ) Takes a message list and marks each message therein to be saved in the user's system mailbox instead of in .Ar mbox . Does not override the c delete command. t Ic ignore Add the list of header fields named to the .Ar ignored list . Header fields in the ignore list are not printed on your terminal when you print a message. This command is very handy for suppression of certain machine-generated header fields. The c Type and c Print commands can be used to print a message in its entirety, including ignored fields. If c ignore is executed with no arguments, it lists the current set of ignored fields. t Ic mail
q Ic m Takes as argument login names and distribution group names and sends mail to those people. t Ic more
q Ic mo Takes a list of messages and invokes the pager on that list. t Ic mbox Indicate that a list of messages be sent to c mbox in your home directory when you quit. This is the default action for messages if you do .Em not have the c hold option set. t Ic next
q Ic n like ( c + or .Tn CR ) Goes to the next message in sequence and types it. With an argument list, types the next matching message. t Ic preserve
q Ic pre A synonym for c hold . t Ic print
q Ic p Takes a message list and types out each message on the user's terminal. t Ic quit
q Ic q Terminates the session, saving all undeleted, unsaved messages in the user's .Ar mbox file in his login directory, preserving all messages marked with c hold or c 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 .Dq Li "You have new mail" is given. If given while editing a mailbox file with the .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 c exit command. t Ic reply
q 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. t Ic respond A synonym for c reply . t Ic retain Add the list of header fields named to the .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 c Type and c Print commands can be used to print a message in its entirety. If c retain is executed with no arguments, it lists the current set of retained fields. t Ic save
q 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. t Ic set
q 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. .Dq Li "set indentprefix=\*q->\*q" t Ic saveignore c Saveignore is to c save what c ignore is to c print and c type . Header fields thus marked are filtered out when saving a message by c save or when automatically saving to .Ar mbox . t Ic saveretain c Saveretain is to c save what c retain is to c print and c type . Header fields thus marked are the only ones saved with a message when saving by c save or when automatically saving to .Ar mbox . c Saveretain overrides c saveignore . t Ic shell
q Ic sh Invokes an interactive version of the shell. t Ic size Takes a message list and prints out the size in characters of each message. t Ic source The c source command reads commands from a file. t Ic top Takes a message list and prints the top few lines of each. The number of lines printed is controlled by the variable c toplines and defaults to five. t Ic type
q Ic t A synonym for c print . t Ic unalias Takes a list of names defined by c alias commands and discards the remembered groups of users. The group names no longer have any significance. t Ic undelete
q Ic u Takes a message list and marks each message as c not being deleted. t Ic unread
q Ic U Takes a message list and marks each message as c not having been read. t Ic unset Takes a list of option names and discards their remembered values; the inverse of c set . t Ic visual
q Ic v Takes a message list and invokes the display editor on each message. t Ic write
q Ic w Similar to c save , except that c only the message body
q Ar without the header) is saved. Extremely useful for such tasks as sending and receiving source program text over the message system. t Ic xit
q Ic x A synonym for c exit . t Ic z .Nm Mail presents message headers in windowfuls as described under the c headers command. You can move .Nm Ns 's attention forward to the next window with the c z command. Also, you can move to the previous window by using c z\- . .El .Ss Tilde/Escapes
p 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 .Dq Em tilde escape is somewhat of a misnomer since the actual escape character can be set by the option c escape . l -tag -width Ds t Ic ~! Ns Ar command Execute the indicated shell command, then return to the message. t 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). t Ic ~c Ns Ar name ... Add the given names to the list of carbon copy recipients. t Ic ~d Read the file .Dq Pa dead.letter from your home directory into the message. t 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. t Ic ~f Ns Ar messages Read the named messages into the message being sent. If no messages are specified, read in the current message. Message headers currently being ignored (by the c ignore or c retain command) are not included. t Ic ~F Ns Ar messages Identical to c ~f , except all message headers are included. t 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. t 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 c ignore or c retain command) are not included. t Ic ~M Ns Ar messages Identical to c ~m , except all message headers are included. t Ic ~p Print out the message collected so far, prefaced by the message header fields. t Ic ~q Abort the message being sent, copying the message to .Dq Pa dead.letter in your home directory if c save is set. t Ic ~r Ns Ar filename Read the named file into the message. t Ic ~R Ns Ar string Use .Ar string as the Reply-To field. t Ic ~s Ns Ar string Cause the named string to become the current subject field. t Ic ~t Ns Ar name ... Add the given names to the direct recipient list. t 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. t Ic ~w Ns Ar filename Write the message onto the named file. t 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 .Xr fmt 1 is often used as c command to rejustify the message. t Ic ~: Ns Ar mail-command Execute the given mail command. Not all commands, however, are allowed. t 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. .El .Ss Mail Options Options are controlled via c set and c 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: l -tag -width append t Ar append Causes messages saved in .Ar mbox to be appended to the end rather than prepended. This should always be set (preferably in one of the system-wide
a mail.rc files). t Ar ask Causes .Nm to prompt you for the subject of each message you send. If you respond with simply a newline, no subject field will be sent. t Ar askcc Causes you to be prompted for additional carbon copy recipients at the end of each message. Responding with a newline indicates your satisfaction with the current list. t Ar autoprint Causes the c delete command to behave like c dp - thus, after deleting a message, the next one will be typed automatically. t Ar debug Setting the binary option .Ar debug is the same as specifying .Fl d on the command line and causes .Nm to output all sorts of information useful for debugging .Nm . t Ar dot The binary option .Ar dot causes .Nm to interpret a period alone on a line as the terminator of a message you are sending. t Ar hold This option is used to hold messages in the system mailbox by default. t Ar ignore Causes interrupt signals from your terminal to be ignored and echoed as @'s. t Ar ignoreeof An option related to .Ar dot is .Ar ignoreeof which makes .Nm refuse to accept a control-d as the end of a message. .Ar Ignoreeof also applies to .Nm command mode. t 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 to be included in the group. t Ar noheader Setting the option .Ar noheader is the same as giving the .Fl N flag on the command line. t Ar nosave Normally, when you abort a message with two .Tn RUBOUT (erase or delete) .Nm copies the partial letter to the file .Dq Pa dead.letter in your home directory. Setting the binary option .Ar nosave prevents this. t Ar Replyall Reverses the sense of c reply and c Reply commands. t Ar quiet Suppresses the printing of the version when first invoked. t 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. t Ar verbose Setting the option .Ar verbose is the same as using the .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. .El .Ss Option String Values l -tag -width Va t Ev EDITOR Pathname of the text editor to use in the c edit command and c ~e escape. If not defined, then a default editor is used. t Ev LISTER Pathname of the directory lister to use in the c folders command. Default is
a /bin/ls . t Ev PAGER Pathname of the program to use in the c more command or when c crt variable is set. The default paginator .Xr more 1 is used if this option is not defined. t Ev REPLYTO If set, will be used to initialize the Reply-To field for outgoing messages. t Ev SHELL Pathname of the shell to use in the c ! command and the c ~! escape. A default shell is used if this option is not defined. t Ev VISUAL Pathname of the text editor to use in the c visual command and c ~v escape. t Va crt The valued option .Va crt is used as a threshold to determine how long a message must be before .Ev PAGER is used to read it. 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 ) . t Ar escape If defined, the first character of this option gives the character to use in the place of ~ to denote escapes. t Ar folder The name of the directory to use for storing folders of messages. If this name begins with a `/', .Nm considers it to be an absolute pathname; otherwise, the folder directory is found relative to your home directory. t 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. t 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. t 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. t Ar toplines If defined, gives the number of lines of a message to be printed out with the c top command; normally, the first five lines are printed. .El .Sh ENVIRONMENT .Nm Mail utilizes the .Ev HOME and .Ev USER environment variables. Also, if the .Ev MAIL environment variable is set, it is used as the location of the user's mailbox instead of the default in /var/mail. .Sh FILES l -tag -width /usr/share/misc/mail.*help -compact t Pa /var/mail/* Post office. t ~/mbox User's old mail. t ~/.mailrc File giving initial mail commands. t Pa /tmp/R* Temporary files. t Pa /usr/share/misc/mail.*help Help files.
p t Pa /usr/share/misc/mail.rc t Pa /usr/local/etc/mail.rc t Pa /etc/mail.rc System-wide initialization files. Each file will be sourced, in order, if it exists. .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 command appeared in .At v1 . 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.
p Usually, .Nm is just a link to .Nm Mail , which can be confusing.