usr.bin/mail/USD.doc/mail9.nr

   1 .\" Copyright (c) 1980, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mail9.nr    8.1 (Berkeley) 6/8/93
  29 .\"
  30 .bp
  31 .sh 1 "Summary of commands, options, and escapes"
  32 .pp
  33 This section gives a quick summary of the
  34 .i Mail
  35 commands, binary and valued options, and tilde escapes.
  36 .pp
  37 The following table describes the commands:
  38 .TS
  39 center ;
  40 c ci
  41 lb l.
  42 Command Description
  43 _
  44 +       Same as \fBnext\fP
  45 -       Back up to previous message
  46 ?       Print brief summary of \fIMail\fP commands
  47 !       Single command escape to shell
  48 Print   Type message with ignored fields
  49 Reply   Reply to author of message only
  50 Respond Same as \fBReply\fP
  51 Type    Type message with ignored fields
  52 alias   Define an alias as a set of user names
  53 alternates      List other names you are known by
  54 chdir   Change working directory, home by default
  55 copy    Copy a message to a file or folder
  56 delete  Delete a list of messages
  57 dp      Same as \fBdt\fP
  58 dt      Delete current message, type next message
  59 edit    Edit a list of messages
  60 else    Start of else part of conditional; see \fBif\fP
  61 endif   End of conditional statement; see \fBif\fP
  62 exit    Leave mail without changing anything
  63 file    Interrogate/change current mail file
  64 folder  Same as \fBfile\fP
  65 folders List the folders in your folder directory
  66 from    List headers of a list of messages
  67 headers List current window of messages
  68 help    Same as \fB?\fP
  69 hold    Same as \fBpreserve\fP
  70 if      Conditional execution of \fIMail\fP commands
  71 ignore  Set/examine list of ignored header fields
  72 list    List valid \fIMail\fP commands
  73 local   List other names for the local host
  74 mail    Send mail to specified names
  75 mbox    Arrange to save a list of messages in \fImbox\fP
  76 next    Go to next message and type it
  77 preserve        Arrange to leave list of messages in system mailbox
  78 print   Print messages
  79 quit    Leave \fIMail\fP; update system mailbox, \fImbox\fP as appropriate
  80 reply   Compose a reply to a message
  81 respond Same as \fBreply\fP
  82 retain  Supersedes \fBignore\fP
  83 save    Append messages, headers included, on a file
  84 set     Set binary or valued options
  85 shell   Invoke an interactive shell
  86 size    Prints out size of message list
  87 source  Read \fImail\fP commands from a file
  88 top     Print first so many (5 by default) lines of list of messages
  89 type    Same as \fBprint\fP
  90 undelete        Undelete list of messages
  91 unread  Marks list of messages as not been read
  92 unset   Undo the operation of a \fBset\fP
  93 visual  Invoke visual editor on a list of messages
  94 write   Append messages to a file, don't include headers
  95 xit     Same as \fBexit\fP
  96 z       Scroll to next/previous screenful of headers
  97 .TE
  98 .bp
  99 .(b
 100 .pp
 101 The following table describes the options.  Each option is
 102 shown as being either a binary or valued option.
 103 .TS
 104 center;
 105 c ci ci
 106 l ci l.
 107 Option  Type    Description
 108 _
 109 EDITOR  valued  Pathname of editor for ~e and \fBedit\fP
 110 PAGER   valued  Pathname of paginator for \fBPrint\fP, \fBprint\fP, \fBType\fP and \fBtype\fP
 111 SHELL   valued  Pathname of shell for \fBshell\fP, ~! and \fB!\fP
 112 VISUAL  valued  Pathname of screen editor for ~v, \fBvisual\fP
 113 append  binary  Always append messages to end of \fImbox\fP
 114 ask     binary  Prompt user for Subject: field when sending
 115 askcc   binary  Prompt user for additional Cc's at end of message
 116 autoprint       binary  Print next message after \fBdelete\fP
 117 crt     valued  Minimum number of lines before using \fBPAGER\fP
 118 debug   binary  Print out debugging information
 119 dot     binary  Accept . alone on line to terminate message input
 120 escape  valued  Escape character to be used instead of\ \ ~
 121 folder  valued  Directory to store folders in
 122 hold    binary  Hold messages in system mailbox by default
 123 ignore  binary  Ignore \s-2RUBOUT\s0 while sending mail
 124 ignoreeof       binary  Don't terminate letters/command input with \fB\(uaD\fP
 125 keep    binary  Don't unlink system mailbox when empty
 126 keepsave        binary  Don't delete \fBsave\fPd messages by default
 127 metoo   binary  Include sending user in aliases
 128 noheader        binary  Suppress initial printing of version and headers
 129 nosave  binary  Don't save partial letter in \fIdead.letter\fP
 130 quiet   binary  Suppress printing of \fIMail\fP version and message numbers
 131 record  valued  File to save all outgoing mail in
 132 screen  valued  Size of window of message headers for \fBz\fP, etc.
 133 sendmail        valued  Choose alternate mail delivery system
 134 toplines        valued  Number of lines to print in \fBtop\fP
 135 verbose binary  Invoke sendmail with the \fB\-v\fP flag
 136 .TE
 137 .)b
 138 .(b
 139 .pp
 140 The following table summarizes the tilde escapes available
 141 while sending mail.
 142 .TS
 143 center;
 144 c ci ci
 145 l li l.
 146 Escape  Arguments       Description
 147 _
 148 ~!      command Execute shell command
 149 ~b      name ...        Add names to "blind" Cc: list
 150 ~c      name ...        Add names to Cc: field
 151 ~d              Read \fIdead.letter\fP into message
 152 ~e              Invoke text editor on partial message
 153 ~f      messages        Read named messages
 154 ~h              Edit the header fields
 155 ~m      messages        Read named messages, right shift by tab
 156 ~p              Print message entered so far
 157 ~q              Abort entry of letter; like \s-2RUBOUT\s0
 158 ~r      filename        Read file into message
 159 ~s      string  Set Subject: field to \fIstring\fP
 160 ~t      name ...        Add names to To: field
 161 ~v              Invoke screen editor on message
 162 ~w      filename        Write message on file
 163 ~|      command Pipe message through \fIcommand\fP
 164 ~:      Mail command    Execute a \fIMail\fP command
 165 ~~      string  Quote a ~ in front of \fIstring\fP
 166 .TE
 167 .)b
 168 .(b
 169 .pp
 170 The following table shows the command line flags that
 171 .i Mail
 172 accepts:
 173 .TS
 174 center;
 175 c c
 176 l a.
 177 Flag    Description
 178 _
 179 \-N     Suppress the initial printing of headers
 180 \-T \fIfile\fP  Article-id's of read/deleted messages to \fIfile\fP
 181 \-d     Turn on debugging
 182 \-f \fIfile\fP  Show messages in \fIfile\fP or \fI~/mbox\fP
 183 \-h \fInumber\fP        Pass on hop count for mail forwarding
 184 \-i     Ignore tty interrupt signals
 185 \-n     Inhibit reading of /etc/mail.rc
 186 \-r \fIname\fP  Pass on \fIname\fP for mail forwarding
 187 \-s \fIstring\fP        Use \fIstring\fP as subject in outgoing mail
 188 \-u \fIname\fP  Read \fIname's\fP mail instead of your own
 189 \-v     Invoke sendmail with the \fB\-v\fP flag
 190 .TE
 191 .)b
 192 .lp
 193 Notes:
 194 .b \-T ,
 195 .b \-d ,
 196 .b \-h ,
 197 and
 198 .b \-r
 199 are not for human use.