Commit | Line | Data |
---|---|---|
63a97d5d KS |
1 | .de SF \" Give short form of a command (from $1) |
2 | [\\$1] | |
3 | .. | |
4 | .sh 1 "Summary of commands, escapes, and options" | |
5 | .pp | |
6 | This sections describes tersely all of the Mail commands, | |
7 | escapes, and options. | |
8 | For each command, | |
9 | its most abbreviated form (in brackets) and a | |
10 | short description of the command is given below. | |
11 | .pp | |
12 | First, message lists are computed by determining the set M which | |
13 | consists of all message referenced explicitly or through ranges. | |
14 | Then, the set U is computed, which consists of all messages sent by | |
15 | .i any | |
16 | of the user names specified. Finally, the message list is calculated | |
17 | by finding the intersection of sets M and U. | |
18 | .pp | |
19 | Each Mail command is typed on a line by itself, and may take arguments | |
20 | following the command word. The command need not be typed in its | |
21 | entirety \*- the first command which matches the typed prefix is used. | |
22 | If the argument begins with a digit or special character, then | |
23 | no space is required following the command letter, but otherwise the space | |
24 | is required. If a Mail command does not take arguments, they may be | |
25 | specified, even though they are ignored. For the commands which take | |
26 | message lists as arguments, if no message list is given, then the | |
27 | next message forward which satisfies the command's requirements is | |
28 | used. If there are no messages forward of the current message, | |
29 | the search proceeds backwards, and if there are no good messages | |
30 | at all, Mail types \*(lqNo applicable messages\*(rq and aborts the | |
31 | command. | |
32 | .nr ii 12n | |
33 | .ip \- | |
34 | .SF \- | |
35 | Goes to the previous message and prints it out. If given | |
36 | a numeric argument | |
37 | .i n , | |
38 | goes to the | |
39 | .i n th | |
40 | previous message and prints it. If there is no previous | |
41 | message, it prints | |
42 | .q "Nonzero address required." | |
43 | .ip = | |
44 | .SF = | |
45 | Prints out the current message number. Takes no arguments. | |
46 | .ip ? | |
47 | .SF ? | |
48 | Prints out the file /usr/lib/Mail.help, which contains a brief summary | |
49 | of the commands. Takes no arguments. | |
50 | .ip ! | |
51 | .SF ! | |
52 | Executes the \s-2UNIX\s0 Shell command which follows. Unlike other commands, | |
53 | there does not need to be a space after the exclamation point. | |
54 | .ip alias | |
55 | .SF a | |
56 | With no arguments, prints out all currently-defined aliases. With one | |
57 | argument, prints out that alias. With more than one argument, adds the | |
58 | users named in the second and later arguments to the alias named in | |
59 | the first argument. | |
60 | .ip chdir | |
61 | .SF c | |
62 | Changes the user's working directory to that specified, if given. If | |
63 | no directory is given, then changes to the user's login directory. | |
64 | .ip delete | |
65 | .SF d | |
66 | Takes a list of messages as argument and marks them all as deleted. | |
67 | Deleted messages will not be saved in | |
68 | .i mbox , | |
69 | nor will they be available for most other commands. Default messages may | |
70 | not be deleted already. | |
71 | .ip dp | |
72 | .SF dp | |
73 | Deletes the current message and prints the next message. If there is no | |
74 | next message, types out | |
75 | .q "At EOF." | |
76 | .ip dt | |
77 | .SF dt | |
78 | Same as | |
79 | .b dp . | |
80 | .ip edit | |
81 | .SF e | |
82 | Takes a list of messages and points the text editor at each one in | |
83 | turn. On return from the editor, the message is read back in. The default | |
84 | message for | |
85 | .b edit | |
86 | may not be saved or deleted. | |
87 | .ip exit | |
88 | .SF ex | |
89 | Effects an immediate return to the Shell without modifying | |
90 | the user's system mailbox, his | |
91 | .i mbox | |
92 | file, or his edit file in | |
93 | .b \-f . | |
94 | .ip from | |
95 | .SF f | |
96 | Takes a list of messages and prints their message headers. The default | |
97 | message is neither saved nor deleted. | |
98 | .ip headers | |
99 | .SF h | |
100 | Lists the current range of headers, which is an 18 message group. If | |
101 | the | |
102 | .q + | |
103 | argument is given, then the next 18 message group is printed, and | |
104 | if the | |
105 | .q \- | |
106 | argument is given, the previous 18 message group is printed. | |
107 | .ip help | |
108 | .SF hel | |
109 | A synonym for ? | |
110 | .ip hold | |
111 | .SF ho | |
112 | Takes a message list and marks each message therein to be saved in the | |
113 | user's system mailbox instead of in | |
114 | .i mbox. | |
115 | Does not override the | |
116 | .b delete | |
117 | command. The default message must not be deleted. | |
118 | .ip list | |
119 | .SF l | |
120 | The | |
121 | .b list | |
122 | command lists all of the available user commands in the order | |
123 | that the command processor sees them. It takes no arguments. | |
124 | .ip mail | |
125 | .SF m | |
126 | Takes as argument login names and distribution group names | |
127 | and sends mail to those people. Tilde escapes work in | |
128 | .b mail. | |
129 | .ip next | |
130 | .SF n | |
131 | Goes to the next message in sequence and types it. If a message | |
132 | list is given, then | |
133 | .b next | |
134 | goes to the first message in the message list. | |
135 | .ip preserve | |
136 | .SF pre | |
137 | A synonym for | |
138 | .b hold. | |
139 | .ip print | |
140 | .SF p | |
141 | Takes a message list and types out each message on the user's terminal. | |
142 | The default message must not be deleted. | |
143 | .ip quit | |
144 | .SF q | |
145 | Terminates the Mail session, saving all undeleted, unsaved messages | |
146 | in the user's | |
147 | .i mbox | |
148 | file in his login directory, preserving all messages marked with | |
149 | .b hold | |
150 | or | |
151 | .b preserve | |
152 | in his system mailbox, and removing all other messages from his | |
153 | system mailbox. If mail has arrived during the Mail session, | |
154 | the message \*(lqYou have new mail\*(rq is typed. If executing | |
155 | while editing a mailbox file with the | |
156 | .b \-f | |
157 | flag, then the edit file is rewritten. A return to the Shell is | |
158 | effected, unless the rewrite of edit file fails, in which case | |
159 | the user can escape with the | |
160 | .b exit | |
161 | command. | |
162 | .ip reply | |
163 | .SF r | |
164 | Takes a message list and sends mail to each message author | |
165 | just like the | |
166 | .b mail | |
167 | command. The default message must not be deleted. | |
168 | .ip respond | |
169 | .SF r | |
170 | A synonym for | |
171 | .b reply . | |
172 | .ip save | |
173 | .SF s | |
174 | Takes a message list and a filename and appends each message in turn to | |
175 | the end of the file. The filename in quotes, followed by the line count | |
176 | and character count is echoed on the user's terminal. The default message | |
177 | for | |
178 | .b save | |
179 | may not be saved or deleted. | |
180 | .ip set | |
181 | .SF se | |
182 | With no arguments, prints all variable values. Otherwise, sets option. | |
183 | Arguments are of the form | |
184 | .q "option=value" | |
185 | or | |
186 | .q option. | |
187 | .ip shell | |
188 | .SF sh | |
189 | Invokes an interactive version of the shell. | |
190 | .ip size | |
191 | .SF si | |
192 | Takes a message list and prints out the size in characters of | |
193 | each message. The default message for | |
194 | .b size | |
195 | must not be deleted. | |
196 | .ip top | |
197 | .SF to | |
198 | Takes a message list and prints the top so many lines. The number of lines | |
199 | printed is controlled by the variable | |
200 | .q toplines | |
201 | and defaults to five. | |
202 | .ip type | |
203 | .SF t | |
204 | A synonym for | |
205 | .b print . | |
206 | .ip unalias | |
207 | .SF una | |
208 | Takes a list of names defined by | |
209 | .b alias | |
210 | commands and discards the remembered groups of users. The group names | |
211 | no longer have any significance. | |
212 | .ip undelete | |
213 | .SF u | |
214 | Takes a message list and marks each one as | |
215 | .i not | |
216 | being deleted. Each message | |
217 | in the list must already be deleted. The default message must be deleted. | |
218 | .ip unset | |
219 | .SF uns | |
220 | Takes a list of option names and discards their remembered values; | |
221 | opposite of | |
222 | .b set . | |
223 | .ip visual | |
224 | .SF v | |
225 | Takes a message list and invokes the display editor on each one. | |
226 | .ip write | |
227 | .SF w | |
228 | A synonym for | |
229 | .b save . | |
230 | .ip xit | |
231 | .SF x | |
232 | A synonym for | |
233 | .b exit . | |
234 | .pp | |
235 | Recall that tilde escapes are used when composing messages to perform | |
236 | special functions. Tilde escapes are only recognized at the beginning | |
237 | of lines. The name | |
238 | .q tilde\ escape | |
239 | is somewhat of a misnomer since the actual escape character can be set | |
240 | by the option | |
241 | .q escape. | |
242 | .pp | |
243 | Here is a summary of the tilde escapes: | |
244 | .nr ii 16n | |
245 | .ip ~!command | |
246 | Execute the indicated shell command, then return to the message. | |
247 | .ip "~c name ..." | |
248 | Add the given names to the list of carbon copy recipients. | |
249 | .ip ~d | |
250 | Read the file | |
251 | .q dead.letter | |
252 | from your home directory into the message. | |
253 | .ip ~e | |
254 | Invoke the text editor on the message collected so far. After the | |
255 | editing session is finished, you may continue appending text to the | |
256 | message. | |
257 | .ip ~h | |
258 | Edit the message header fields by typing each one in turn and allowing the | |
259 | user to append text to the end or modify the field by using the current | |
260 | terminal erase and kill characters. | |
261 | .ip "~m messages" | |
262 | Read the named messages into the message being sent, shifted right one | |
263 | tab. If no messages are specified, read the current message. | |
264 | .ip ~p | |
265 | Print out the message collected so far, prefaced by the message header | |
266 | fields. | |
267 | .ip ~q | |
268 | Abort the message being sent, copying the message to | |
269 | .q "dead.letter" | |
270 | in your home directory if | |
271 | .q save | |
272 | is set. | |
273 | .ip "~r filename" | |
274 | Read the named file into the message. | |
275 | .ip "~s string" | |
276 | Cause the named string to become the current subject field. | |
277 | .ip "~t name ..." | |
278 | Add the given names to the direct recipient list. | |
279 | .ip "~v" | |
280 | Invoke an alternate editor (defined by the VISUAL option) | |
281 | on the message collected so far. Usually, the alternate editor will be a | |
282 | visual editor. After you quit the editor, you may resume appending | |
283 | text to the end of your message. | |
284 | .ip "~w filename" | |
285 | Write the message onto the named file. | |
286 | .ip "~|command" | |
287 | Pipe the message through the command as a filter. If the command | |
288 | gives no output or terminates abnormally, retain the original text | |
289 | of the message. | |
290 | .ip "~~string" | |
291 | Insert the string of text in the message prefaced by a single ~. | |
292 | If you have changed the escape character, then you should double | |
293 | .i that | |
294 | character in order to send it. | |
295 | .pp | |
296 | Options are controlled via the | |
297 | .b set | |
298 | and | |
299 | .b unset | |
300 | commands. Options may be either binary, in which case it is only | |
301 | significant to see whether they are set or not, or string, in which | |
302 | case it's actual value is of interest. | |
303 | .pp | |
304 | The binary options include the following: | |
305 | .ip append | |
306 | Causes messages saved in | |
307 | .i mbox | |
308 | to be appended to the end rather than prepended. | |
309 | .ip ask | |
310 | Causes Mail to prompt you for the subject of each message you send. | |
311 | If you respond with simply a newline, no subject field will be sent. | |
312 | .ip askcc | |
313 | Causes you to be prompted for additional carbon copy recipients at the | |
314 | end of each message. Responding with a newline indicates your | |
315 | satisfaction with the current list. | |
316 | .ip autoprint | |
317 | Causes the | |
318 | .b delete | |
319 | command to behave like | |
320 | .b dp | |
321 | \*- thus, after deleting a message, the next one will be typed | |
322 | automatically. | |
323 | .ip ignore | |
324 | Causes interrupt signals from your terminal to be ignored and echoed | |
325 | as @'s. | |
326 | .ip metoo | |
327 | Usually, when a group is expanded that contains the sender, | |
328 | the sender is removed from the expansion. Setting this option causes | |
329 | the sender to be included in the group. | |
330 | .ip quiet | |
331 | Suppresses the printing of the version when Mail is first invoked. | |
332 | .ip save | |
333 | Causes the message collected prior to a \s-2RUBOUT\s0 to be saved | |
334 | on the file | |
335 | .q dead.letter | |
336 | in your home directory on receipt of the \s-2RUBOUT\s0. Also causes | |
337 | the message to be so saved in the same fashion for ~q. | |
338 | .pp | |
339 | The following options have string values: | |
340 | .ip EDITOR | |
341 | Pathname of the text editor to use in the | |
342 | .b edit | |
343 | command and ~e escape. If not defined, then a default editor is used. | |
344 | .ip SHELL | |
345 | Pathname of the shell to use in the | |
346 | .rb ! | |
347 | command and the ~! escape. A default shell is used if this option | |
348 | is not defined. | |
349 | .ip VISUAL | |
350 | Pathname of the text editor to use in the | |
351 | .b visual | |
352 | command | |
353 | and ~v escape. | |
354 | .ip escape | |
355 | If defined, the first character of this option gives the character to | |
356 | use in the place of ~ to denote escapes. | |
357 | .ip record | |
358 | If defined, gives the pathname of the file used to record all outgoing | |
359 | mail. If not defined, then outgoing mail is not so saved. | |
360 | .ip toplines | |
361 | If defined, gives the number of lines of a message to be printed out | |
362 | with the | |
363 | .b top | |
364 | command; normally, the first five lines are printed. |