BSD 4_1c_2 release
[unix-history] / usr / doc / Mail / mail9.nr
CommitLineData
57efb37a
C
1.bp
2.sh 1 "Summary of commands, options, and escapes"
3.pp
4This section gives a quick summary of the
5.i Mail
6commands, binary and valued options, and tilde escapes.
7.(b
8.pp
9The following table describes the commands:
10.TS
11center ;
12c ci
13lb l.
14Command Description
15_
16! Single command escape to shell
17- Back up to previous message
18Print Type message with ignored fields
19Reply Reply to author of message only
20Type Type message with ignored fields
21alias Define an alias as a set of user names
22alternates List other names you are known by
23chdir Change working directory, home by default
24copy Copy a message to a file or folder
25delete Delete a list of messages
26dt Delete current message, type next message
27endif End of conditional statement; see \fBif\fP
28edit Edit a list of messages
29else Start of else part of conditional; see \fBif\fP
30exit Leave mail without changing anything
31file Interrogate/change current mail file
32folder Same as \fBfile\fP
33folders List the folders in your folder directory
34from List headers of a list of messages
35headers List current window of messages
36help Print brief summary of \fIMail\fP commands
37hold Same as \fBpreserve\fP
38if Conditional execution of \fIMail\fP commands
39ignore Set/examine list of ignored header fields
40mail Send mail to specified names
41mbox Arrange to save a list of messages in \fImbox\fP
42next Go to next message and type it
43preserve Arrange to leave list of messages in system mailbox
44quit Leave \fIMail\fP; update system mailbox, \fImbox\fP as appropriate
45reply Compose a reply to a message
46save Append messages, headers included, on a file
47set Set binary or valued options
48shell Invoke an interactive shell
49top Print first so many (5 by default) lines of list of messages
50type Print messages
51undelete Undelete list of messages
52unset Undo the operation of a \fBset\fP
53visual Invoke visual editor on a list of messages
54write Append messages to a file, don't include headers
55z Scroll to next/previous screenful of headers
56.TE
57.)b
58.(b
59.pp
60The following table describes the options. Each option is
61shown as being either a binary or valued option.
62.TS
63center;
64c ci ci
65l ci l.
66Option Type Description
67_
68EDITOR valued Pathname of editor for ~e and \fBedit\fP
69SHELL valued Pathname of shell for \fBshell\fP, ~! and \fB!\fP
70VISUAL valued Pathname of screen editor for ~v, \fBvisual\fP
71append binary Always append messages to end of \fImbox\fP
72ask binary Prompt user for Subject: field when sending
73askcc binary Prompt user for additional Cc's at end of message
74autoprint binary Print next message after \fBdelete\fP
75crt valued Minimum number of lines before using \fImore\fP
76dot binary Accept . alone on line to terminate message input
77escape valued Escape character to be used instead of ~
78folder valued Directory to store folders in
79hold binary Hold messages in system mailbox by default
80ignore binary Ignore \s-2RUBOUT\s0 while sending mail
81ignoreeof binary Don't terminate letters/command input with \fB\(uaD\fP
82keep binary Don't unlink system mailbox when empty
83keepsave binary Don't delete \fBsave\fPd messages by default
84metoo binary Include sending user in aliases
85nosave binary Don't save partial letter in \fIdead.letter\fP
86quiet binary Suppress printing of \fIMail\fP version
87record valued File to save all outgoing mail in
88screen valued Size of window of message headers for \fBz\fP, etc.
89sendmail valued Choose alternate mail delivery system
90toplines valued Number of lines to print in \fBtop\fP
91.TE
92.)b
93.(b
94.pp
95The following table summarizes the tilde escapes available
96while sending mail.
97.TS
98center;
99c ci ci
100l li l.
101Escape Arguments Description
102_
103~! command Execute shell command
104~c name ... Add names to Cc: field
105~d Read \fIdead.letter\fP into message
106~e Invoke text editor on partial message
107~f messages Read named messages
108~h Edit the header fields
109~m messages Read named messages, right shift by tab
110~p Print message entered so far
111~q Abort entry of letter; like \s-2RUBOUT\s0
112~r filename Read file into message
113~s string Set Subject: field to \fIstring\fP
114~t name ... Add names to To: field
115~v Invoke screen editor on message
116~w filename Write message on file
117~| command Pipe message through \fIcommand\fP
118~~ string Quote a ~ in front of \fIstring\fP
119.TE
120.)b
121.(b
122.pp
123The following table shows the command line flags that
124.i Mail
125accepts:
126.TS
127center;
128c c
129l a.
130Flag Description
131_
132\-N Suppress the initial printing of headers
133\-T \fIfile\fP Article-id's of read/deleted messages to \fIfile\fP
134\-d Turn on debugging
135\-f \fIfile\fP Show messages in \fIfile\fP or \fI~/mbox\fP
136\-h \fInumber\fP Pass on hop count for mail forwarding
137\-i Ignore tty interrupt signals
138\-n Inhibit reading of /usr/lib/Mail.rc
139\-r \fIname\fP Pass on \fIname\fP for mail forwarding
140\-s \fIstring\fP Use \fIstring\fP as subject in outgoing mail
141\-u \fIname\fP Read \fIname's\fP mail instead of your own
142.TE
143.)b
144.lp
145Notes:
146.b \-T ,
147.b \-d ,
148.b \-h ,
149and
150.b \-r
151are not for human use.