Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / mail / USD.doc / mail9.nr
blobb37313afad39720fa556a5b317eb267b858719a0
1 .\"     $NetBSD: mail9.nr,v 1.3 1998/01/09 08:06:01 perry Exp $
2 .\"
3 .\" Copyright (c) 1980, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)mail9.nr    8.2 (Berkeley) 5/16/94
31 .\"
32 .sh 1 "Summary of commands, options, and escapes"
33 .pp
34 This section gives a quick summary of the
35 .i Mail
36 commands, binary and valued options, and tilde escapes.
37 .pp
38 The following table describes the commands:
39 .TS
40 center ;
41 c ci
42 lb l.
43 Command Description
45 +       Same as \fBnext\fP
46 -       Back up to previous message
47 ?       Print brief summary of \fIMail\fP commands
48 !       Single command escape to shell
49 Print   Type message with ignored fields
50 Reply   Reply to author of message only
51 Respond Same as \fBReply\fP
52 Type    Type message with ignored fields
53 alias   Define an alias as a set of user names
54 alternates      List other names you are known by
55 chdir   Change working directory, home by default
56 copy    Copy a message to a file or folder
57 delete  Delete a list of messages
58 dp      Same as \fBdt\fP
59 dt      Delete current message, type next message
60 edit    Edit a list of messages
61 else    Start of else part of conditional; see \fBif\fP
62 endif   End of conditional statement; see \fBif\fP
63 exit    Leave mail without changing anything
64 file    Interrogate/change current mail file
65 folder  Same as \fBfile\fP
66 folders List the folders in your folder directory
67 from    List headers of a list of messages
68 headers List current window of messages
69 help    Same as \fB?\fP
70 hold    Same as \fBpreserve\fP
71 if      Conditional execution of \fIMail\fP commands
72 ignore  Set/examine list of ignored header fields
73 list    List valid \fIMail\fP commands
74 local   List other names for the local host
75 mail    Send mail to specified names
76 mbox    Arrange to save a list of messages in \fImbox\fP
77 next    Go to next message and type it
78 preserve        Arrange to leave list of messages in system mailbox
79 print   Print messages
80 quit    Leave \fIMail\fP; update system mailbox, \fImbox\fP as appropriate
81 reply   Compose a reply to a message
82 respond Same as \fBreply\fP
83 retain  Supersedes \fBignore\fP
84 save    Append messages, headers included, on a file
85 set     Set binary or valued options
86 shell   Invoke an interactive shell
87 size    Prints out size of message list
88 source  Read \fImail\fP commands from a file
89 top     Print first so many (5 by default) lines of list of messages
90 type    Same as \fBprint\fP
91 undelete        Undelete list of messages
92 unread  Marks list of messages as not been read
93 unset   Undo the operation of a \fBset\fP
94 visual  Invoke visual editor on a list of messages
95 write   Append messages to a file, don't include headers
96 xit     Same as \fBexit\fP
97 z       Scroll to next/previous screenful of headers
98 .TE
99 .(b
101 The following table describes the options.  Each option is
102 shown as being either a binary or valued option.
104 center;
105 c ci ci
106 l ci l.
107 Option  Type    Description
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
140 The following table summarizes the tilde escapes available
141 while sending mail.
143 center;
144 c ci ci
145 l li l.
146 Escape  Arguments       Description
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
170 The following table shows the command line flags that
171 .i Mail
172 accepts:
174 center;
175 c c
176 l a.
177 Flag    Description
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 /usr/lib/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
193 Notes:
194 .b \-T ,
195 .b \-d ,
196 .b \-h ,
198 .b \-r
199 are not for human use.