| blob | a710fd32fdff6e2a71704aed9ff0dbd071b18c1a |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45 .\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved
46 .\"
47 .TH MAILX 1 "Dec 18, 2014"
48 .SH NAME
49 mailx \- interactive message processing system
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fBmailx\fR [\fB-BdeHiInNURvV~\fR] [\fB-f\fR [\fIfile\fR | \fI+folder\fR]] [\fB-T\fR \fIfile\fR]
54 [\fB-u\fR \fIuser\fR]
55 .fi
57 .LP
58 .nf
59 \fBmailx\fR [\fB-BdFintUv~\fR] [\fB-b\fR \fIbcc\fR] [\fB-c\fR \fIcc\fR] [\fB-h\fR \fInumber\fR]
60 [\fB-r\fR \fIaddress\fR] [\fB-s\fR \fIsubject\fR] \fIrecipient\fR...
61 .fi
63 .LP
64 .nf
65 \fB/usr/ucb/mail\fR ...
66 .fi
68 .LP
69 .nf
70 \fB/usr/ucb/Mail\fR ...
71 .fi
73 .SH DESCRIPTION
74 .LP
75 The mail utilities listed above provide a comfortable, flexible environment for
76 sending and receiving mail messages electronically.
77 .sp
78 .LP
79 When reading mail, the mail utilities provide commands to facilitate saving,
80 deleting, and responding to messages. When sending mail, the mail utilities
81 allow editing, reviewing and other modification of the message as it is
82 entered.
83 .sp
84 .LP
85 Incoming mail is stored in a standard file for each user, called the
86 \fBmailbox\fR for that user. When the mail utilities are called to read
87 messages, the \fBmailbox\fR is the default place to find them. As messages are
88 read, they are marked to be moved to a secondary file for storage, unless
89 specific action is taken, so that the messages need not be seen again.This
90 secondary file is called the \fBmbox\fR and is normally located in the user's
91 \fBHOME\fR directory (see \fBMBOX\fR in ENVIRONMENT VARIABLES for a description
92 of this file). Messages can be saved in other secondary files named by the
93 user. Messages remain in a secondary file until forcibly removed.
94 .sp
95 .LP
96 The user can access a secondary file by using the \fB-f\fR option. Messages in
97 the secondary file can then be read or otherwise processed using the same
98 \fBCommands\fR as in the primary \fBmailbox\fR. This gives rise within these
99 pages to the notion of a current \fBmailbox\fR.
100 .SH OPTIONS
101 .LP
102 On the command line options start with a dash (\(mi). Any other arguments are
103 taken to be destinations (recipients). If no recipients are specified,
104 \fBmailx\fR attempts to read messages from the \fBmailbox\fR.
105 .sp
106 .ne 2
107 .na
108 \fB\fB-B\fR\fR
109 .ad
110 .RS 17n
111 Do not buffer standard input or standard output.
112 .RE
114 .sp
115 .ne 2
116 .na
117 \fB\fB-b\fR \fIbcc\fR\fR
118 .ad
119 .RS 17n
120 Set the blind carbon copy list to \fIbcc\fR. \fIbcc\fR should be enclosed in
121 quotes if it contains more than one name.
122 .RE
124 .sp
125 .ne 2
126 .na
127 \fB\fB-c\fR \fIcc\fR\fR
128 .ad
129 .RS 17n
130 Set the carbon copy list to \fIcc\fR. \fIcc\fR should be enclosed in quotes if
131 it contains more than one name.
132 .RE
134 .sp
135 .ne 2
136 .na
137 \fB\fB-d\fR\fR
138 .ad
139 .RS 17n
140 Turn on debugging output. (Neither particularly interesting nor recommended.)
141 .RE
143 .sp
144 .ne 2
145 .na
146 \fB\fB-e\fR\fR
147 .ad
148 .RS 17n
149 Test for the presence of mail. \fBmailx\fR prints nothing and exits with a
150 successful return code if there is mail to read.
151 .RE
153 .sp
154 .ne 2
155 .na
156 \fB\fB-F\fR\fR
157 .ad
158 .RS 17n
159 Record the message in a file named after the first recipient. Overrides the
160 \fBrecord\fR variable, if set (see \fBInternal Variables\fR).
161 .RE
163 .sp
164 .ne 2
165 .na
166 \fB\fB\fR\fB-f\fR\fB [\fR\fIfile\fR\fB]\fR\fR
167 .ad
168 .RS 17n
169 Read messages from \fIfile\fR instead of \fBmailbox\fR. If no \fIfile\fR is
170 specified, the \fBmbox\fR is used.
171 .RE
173 .sp
174 .ne 2
175 .na
176 \fB\fB\fR\fB-f\fR\fB [ \fR\fB+\fR\fIfolder\fR\fB]\fR\fR
177 .ad
178 .RS 17n
179 Use the file \fIfolder\fR in the folder directory (same as the \fBfold\fRer
180 command). The name of this directory is listed in the \fBfolder\fR variable.
181 .RE
183 .sp
184 .ne 2
185 .na
186 \fB\fB-H\fR\fR
187 .ad
188 .RS 17n
189 Print header summary only.
190 .RE
192 .sp
193 .ne 2
194 .na
195 \fB\fB-h\fR \fInumber\fR\fR
196 .ad
197 .RS 17n
198 The number of network "hops" made so far. This is provided for network software
199 to avoid infinite delivery loops. This option and its argument are passed to
200 the delivery program.
201 .RE
203 .sp
204 .ne 2
205 .na
206 \fB\fB-I\fR\fR
207 .ad
208 .RS 17n
209 Include the newsgroup and article-id header lines when printing mail messages.
210 This option requires the \fB-f\fR option to be specified.
211 .RE
213 .sp
214 .ne 2
215 .na
216 \fB\fB-i\fR\fR
217 .ad
218 .RS 17n
219 Ignore interrupts. See also \fBignore\fR in \fBInternal Variables\fR.
220 .RE
222 .sp
223 .ne 2
224 .na
225 \fB\fB-N\fR\fR
226 .ad
227 .RS 17n
228 Do not print initial header summary.
229 .RE
231 .sp
232 .ne 2
233 .na
234 \fB\fB-n\fR\fR
235 .ad
236 .RS 17n
237 Do not initialize from the system default \fBmailx.rc\fR or \fBMail.rc\fR file.
238 See USAGE.
239 .RE
241 .sp
242 .ne 2
243 .na
244 \fB\fB-r\fR \fIaddress\fR\fR
245 .ad
246 .RS 17n
247 Use \fIaddress\fR as the return address when invoking the delivery program. All
248 tilde commands are disabled. This option and its argument is passed to the
249 delivery program.
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fB-s\fR \fIsubject\fR\fR
256 .ad
257 .RS 17n
258 Set the Subject header field to \fIsubject\fR. \fIsubject\fR should be enclosed
259 in quotes if it contains embedded white space.
260 .RE
262 .sp
263 .ne 2
264 .na
265 \fB\fB-T\fR \fIfile\fR\fR
266 .ad
267 .RS 17n
268 Message-id and article-id header lines are recorded in \fIfile\fR after the
269 message is read. This option also sets the \fB-I\fR option.
270 .RE
272 .sp
273 .ne 2
274 .na
275 \fB\fB-t\fR\fR
276 .ad
277 .RS 17n
278 Scan the input for \fBTo:\fR, \fBCc:\fR, and \fBBcc:\fR fields. Any recipients
279 on the command line will be ignored.
280 .RE
282 .sp
283 .ne 2
284 .na
285 \fB\fB-U\fR\fR
286 .ad
287 .RS 17n
288 Convert \fBUUCP-style\fR addresses to internet standards. Overrides the
289 \fBconv\fR environment variable.
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fB\fB-u\fR \fIuser\fR\fR
296 .ad
297 .RS 17n
298 Read \fIuser\fR's \fBmailbox\fR. This is only effective if \fIuser\fR's
299 \fBmailbox\fR is not read protected.
300 .RE
302 .sp
303 .ne 2
304 .na
305 \fB\fB-V\fR\fR
306 .ad
307 .RS 17n
308 Print the \fBmailx\fR version number and exit.
309 .RE
311 .sp
312 .ne 2
313 .na
314 \fB\fB-v\fR\fR
315 .ad
316 .RS 17n
317 Pass the \fB-v\fR flag to \fBsendmail\fR(1M).
318 .RE
320 .sp
321 .ne 2
322 .na
323 \fB\fB-~\fR\fR
324 .ad
325 .RS 17n
326 Interpret tilde escapes in the input even if not reading from a tty.
327 .RE
329 .SH OPERANDS
330 .LP
331 The following operands are supported:
332 .sp
333 .ne 2
334 .na
335 \fB\fIrecipient\fR\fR
336 .ad
337 .RS 13n
338 Addressee of message.
339 .RE
341 .SH USAGE
342 .SS "Starting Mail"
343 .LP
344 At startup time, \fBmailx\fR executes the system startup file
345 \fB/etc/mail/mailx.rc\fR. If invoked as \fBmail\fR or \fBMail\fR, the system
346 startup file \fB/etc/mail/Mail.rc\fR is used instead.
347 .sp
348 .LP
349 The system startup file sets up initial display options and alias lists and
350 assigns values to some internal variables. These variables are flags and valued
351 parameters which are set and cleared using the \fBse\fRt and \fBuns\fRet
352 commands. See \fBInternal Variables\fR.
353 .sp
354 .LP
355 With the following exceptions, regular commands are legal inside startup files:
356 \fB!\fR, \fBC\fRopy, \fBe\fRdit, \fBfo\fRllowup, \fBF\fRollowup, \fBho\fRld,
357 \fBm\fRail, \fBpre\fRserve, \fBr\fReply, \fBR\fReply, \fBsh\fRell, and
358 \fBv\fRisual. An error in the startup file causes the remaining lines in the
359 file to be ignored.
360 .sp
361 .LP
362 After executing the system startup file, the mail utilities execute the
363 optional personal startup file \fB$HOME/.mailrc\fR, wherein the user can
364 override the values of the internal variables as set by the system startup
365 file.
366 .sp
367 .LP
368 If the \fB-n\fR option is specified, however, the mail utilities do not execute
369 the system startup file.
370 .sp
371 .LP
372 Many system administrators include the commands
373 .sp
374 .in +2
375 .nf
376 set appenddeadletter
377 unset replyall
378 unset pipeignore
379 .fi
380 .in -2
381 .sp
383 .sp
384 .LP
385 in the system startup files (to be compatible with past Solaris behavior), but
386 this does not meet standards requirements for \fBmailx\fR. To get standard
387 behavior for \fBmailx\fR, users should use the \fB-n\fR option or include the
388 following commands in a personal startup file:
389 .sp
390 .in +2
391 .nf
392 unset appenddeadletter
393 set replyall
394 set pipeignore
395 .fi
396 .in -2
397 .sp
399 .sp
400 .LP
401 When reading mail, the mail utilities are in \fIcommand mode\fR. A header
402 summary of the first several messages is displayed, followed by a prompt
403 indicating the mail utilities can accept regular commands (see \fBCommands\fR
404 below). When sending mail, the mail utilities are in \fIinput mode\fR. If no
405 subject is specified on the command line, and the \fBasksub\fR variable is set,
406 a prompt for the subject is printed.
407 .sp
408 .LP
409 As the message is typed, the mail utilities read the message and store it in a
410 temporary file. Commands may be entered by beginning a line with the tilde (~)
411 escape character followed by a single command letter and optional arguments.
412 See \fBTilde Escapes\fR for a summary of these commands.
413 .SS "Reading Mail"
414 .LP
415 Each message is assigned a sequential number, and there is at any time the
416 notion of a current message, marked by a right angle bracket (>) in the header
417 summary. Many commands take an optional list of messages (\fImessage-list\fR)
418 to operate on. In most cases, the current message is set to the
419 highest-numbered message in the list after the command is finished executing.
420 .sp
421 .LP
422 The default for \fImessage-list\fR is the current message. A \fImessage-list\fR
423 is a list of message identifiers separated by spaces, which may include:
424 .sp
425 .ne 2
426 .na
427 \fB\fIn\fR\fR
428 .ad
429 .RS 11n
430 Message number \fIn\fR.
431 .RE
433 .sp
434 .ne 2
435 .na
436 \fB\fB\&.\fR\fR
437 .ad
438 .RS 11n
439 The current message.
440 .RE
442 .sp
443 .ne 2
444 .na
445 \fB\fB^\fR\fR
446 .ad
447 .RS 11n
448 The first undeleted message.
449 .RE
451 .sp
452 .ne 2
453 .na
454 \fB\fB$\fR\fR
455 .ad
456 .RS 11n
457 The last message.
458 .RE
460 .sp
461 .ne 2
462 .na
463 \fB\fB*\fR\fR
464 .ad
465 .RS 11n
466 All messages.
467 .RE
469 .sp
470 .ne 2
471 .na
472 \fB\fB+\fR\fR
473 .ad
474 .RS 11n
475 The next undeleted message.
476 .RE
478 .sp
479 .ne 2
480 .na
481 \fB\fB\(mi\fR\fR
482 .ad
483 .RS 11n
484 The previous undeleted message.
485 .RE
487 .sp
488 .ne 2
489 .na
490 \fB\fIn\fR\fB\(mi\fR\fIm\fR\fR
491 .ad
492 .RS 11n
493 An inclusive range of message numbers.
494 .RE
496 .sp
497 .ne 2
498 .na
499 \fB\fIuser\fR\fR
500 .ad
501 .RS 11n
502 All messages from \fIuser\fR.
503 .RE
505 .sp
506 .ne 2
507 .na
508 \fB\fI/string\fR\fR
509 .ad
510 .RS 11n
511 All messages with \fIstring\fR in the Subject line (case ignored).
512 .RE
514 .sp
515 .ne 2
516 .na
517 \fB\fB:\fR\fIc\fR\fR
518 .ad
519 .RS 11n
520 All messages of type \fIc\fR, where \fIc\fR is one of:
521 .sp
522 .ne 2
523 .na
524 \fB\fBd\fR\fR
525 .ad
526 .RS 5n
527 deleted messages
528 .RE
530 .sp
531 .ne 2
532 .na
533 \fB\fBn\fR\fR
534 .ad
535 .RS 5n
536 new messages
537 .RE
539 .sp
540 .ne 2
541 .na
542 \fB\fBo\fR\fR
543 .ad
544 .RS 5n
545 old messages
546 .RE
548 .sp
549 .ne 2
550 .na
551 \fB\fBr\fR\fR
552 .ad
553 .RS 5n
554 read messages
555 .RE
557 .sp
558 .ne 2
559 .na
560 \fB\fBu\fR\fR
561 .ad
562 .RS 5n
563 unread messages
564 .RE
566 Notice that the context of the command determines whether this type of message
567 specification makes sense.
568 .RE
570 .sp
571 .LP
572 Other arguments are usually arbitrary strings whose usage depends on the
573 command involved. Filenames, where expected, are expanded using the normal
574 shell conventions (see \fBsh\fR(1)). Special characters are recognized by
575 certain commands and are documented with the commands below.
576 .SS "Sending Mail"
577 .LP
578 Recipients listed on the command line may be of three types: login names, shell
579 commands, or alias groups. Login names may be any network address, including
580 mixed network addressing. If mail is found to be undeliverable, an attempt is
581 made to return it to the sender's \fBmailbox\fR. If the \fBexpandaddr\fR option
582 is not set (the default), then the following rules do not apply and the name of
583 the recipient must be a local mailbox or network address. If the recipient name
584 begins with a pipe symbol ( | ), the rest of the name is taken to be a shell
585 command to pipe the message through. This provides an automatic interface with
586 any program that reads the standard input, such as \fBlp\fR(1) for recording
587 outgoing mail on paper.
588 .sp
589 .LP
590 Alias groups are set by the \fBa\fRlias command (see \fBCommands\fR below) or in
591 a system startup file (for example, \fB$HOME/.mailrc\fR). Aliases are lists of
592 recipients of any type.
593 .SS "Forwarding Mail"
594 .LP
595 To forward a specific message, include it in a message to the desired
596 recipients with the \fB~f\fR or \fB~m\fR tilde escapes. See \fBTilde\fR
597 \fBEscapes\fR below. To forward mail automatically, add a comma-separated list
598 of addresses for additional recipients to the \fB\&.forward\fR file in your
599 home directory. This is different from the format of the \fBalias\fR command,
600 which takes a space-separated list instead. \fBNote:\fR Forwarding addresses
601 must be valid, or the messages will "bounce." You cannot, for instance, reroute
602 your mail to a new host by forwarding it to your new address if it is not yet
603 listed in the \fBNIS\fR aliases domain.
604 .SS "Commands"
605 .LP
606 Regular commands are of the form
607 .sp
608 .in +2
609 .nf
610 [ \fIcommand\fR ] [ \fImessage-list\fR ] [ \fIarguments\fR ]
611 .fi
612 .in -2
613 .sp
615 .sp
616 .LP
617 In \fIinput mode\fR, commands are recognized by the escape character,
618 \fBtilde(~)\fR, and lines not treated as commands are taken as input for the
619 message. If no command is specified in \fIcommand mode\fR, \fBn\fRext is
620 assumed. The following is a complete list of \fBmailx\fR commands:
621 .sp
622 .ne 2
623 .na
624 \fB\fB!\fR\fIshell-command\fR\fR
625 .ad
626 .sp .6
627 .RS 4n
628 Escape to the shell. See \fBSHELL\fR in ENVIRONMENT VARIABLES.
629 .RE
631 .sp
632 .ne 2
633 .na
634 \fB\fB#\fR \fIcomment\fR\fR
635 .ad
636 .sp .6
637 .RS 4n
638 \fINULL\fR command (comment). Useful in \fBmailrc\fR files.
639 .RE
641 .sp
642 .ne 2
643 .na
644 \fB\fB=\fR\fR
645 .ad
646 .sp .6
647 .RS 4n
648 Print the current message number.
649 .RE
651 .sp
652 .ne 2
653 .na
654 \fB\fB?\fR\fR
655 .ad
656 .sp .6
657 .RS 4n
658 Prints a summary of commands.
659 .RE
661 .sp
662 .ne 2
663 .na
664 \fB\fBa\fRlias \fIalias name\fR .\|.\|.\fR
665 .ad
666 .br
667 .na
668 \fB\fBg\fRroup \fIalias name\fR .\|.\|.\fR
669 .ad
670 .sp .6
671 .RS 4n
672 Declare an alias for the given names. The names are substituted when
673 \fBalias\fR is used as a recipient. Useful in the \fBmailrc\fR file. With no
674 arguments, the command displays the list of defined aliases.
675 .RE
677 .sp
678 .ne 2
679 .na
680 \fB\fBalt\fRernates \fIname .\|.\|.\fR\fR
681 .ad
682 .sp .6
683 .RS 4n
684 Declare a list of alternate names for your login. When responding to a message,
685 these names are removed from the list of recipients for the response. With no
686 arguments, print the current list of alternate names. See also \fBallnet\fR in
687 \fBInternal Variables\fR.
688 .RE
690 .sp
691 .ne 2
692 .na
693 \fB\fBcd\fR [\fIdirectory\fR]\fR
694 .ad
695 .br
696 .na
697 \fB\fBch\fRdir [\fIdirectory\fR]\fR
698 .ad
699 .sp .6
700 .RS 4n
701 Change directory. If \fIdirectory\fR is not specified, \fB$HOME\fR is used.
702 .RE
704 .sp
705 .ne 2
706 .na
707 \fB\fBc\fRopy [\fIfile\fR]\fR
708 .ad
709 .br
710 .na
711 \fB\fBc\fRopy [\fImessage-list\fR] \fIfile\fR\fR
712 .ad
713 .sp .6
714 .RS 4n
715 Copy messages to the file without marking the messages as saved. Otherwise
716 equivalent to the \fBs\fRave command.
717 .RE
719 .sp
720 .ne 2
721 .na
722 \fB\fBC\fRopy [\fImessage-list\fR]\fR
723 .ad
724 .sp .6
725 .RS 4n
726 Save the specified messages in a file whose name is derived from the author of
727 the message to be saved, without marking the messages as saved. Otherwise
728 equivalent to the \fBS\fRave command.
729 .RE
731 .sp
732 .ne 2
733 .na
734 \fB\fBd\fRelete [\fImessage-list\fR]\fR
735 .ad
736 .sp .6
737 .RS 4n
738 Delete messages from the \fBmailbox\fR. If \fBautoprint\fR is set, the next
739 message after the last one deleted is printed (see \fBInternal Variables\fR).
740 .RE
742 .sp
743 .ne 2
744 .na
745 \fB\fBdi\fRscard [\fIheader-field\fR.\|.\|.\|]\fR
746 .ad
747 .br
748 .na
749 \fB\fBig\fRnore [\fIheader-field\fR.\|.\|.\|]\fR
750 .ad
751 .sp .6
752 .RS 4n
753 Suppress printing of the specified header fields when displaying messages on
754 the screen. Examples of header fields to ignore are \fBStatus\fR and
755 \fBReceived\fR. The fields are included when the message is saved, unless the
756 \fBalwaysignore\fR variable is set. The \fBMo\fRre, \fBPa\fRge, \fBP\fRrint,
757 and \fBT\fRype commands override this command. If no header is specified, the
758 current list of header fields being ignored is printed. See also the
759 \fBundi\fRscard and \fBunig\fRnore commands.
760 .RE
762 .sp
763 .ne 2
764 .na
765 \fB\fBdp\fR [\fImessage-list\fR]\fR
766 .ad
767 .br
768 .na
769 \fB\fBdt \fR[\fImessage-list\fR]\fR
770 .ad
771 .sp .6
772 .RS 4n
773 Delete the specified messages from the \fBmailbox\fR and print the next message
774 after the last one deleted. Roughly equivalent to a \fBd\fRelete command
775 followed by a \fBp\fRrint command.
776 .RE
778 .sp
779 .ne 2
780 .na
781 \fB\fBec\fRho \fIstring \fR.\|.\|.\fR
782 .ad
783 .sp .6
784 .RS 4n
785 Echo the given strings (like \fBecho\fR(1)).
786 .RE
788 .sp
789 .ne 2
790 .na
791 \fB\fBe\fRdit [\fImessage-list\fR]\fR
792 .ad
793 .sp .6
794 .RS 4n
795 Edit the given messages. Each message is placed in a temporary file and the
796 program named by the \fBEDITOR\fR variable is invoked to edit it (see
797 ENVIRONMENT VARIABLES). Default editor is \fBed\fR(1).
798 .RE
800 .sp
801 .ne 2
802 .na
803 \fB\fBexpandaddr\fR\fR
804 .ad
805 .sp .6
806 .RS 4n
807 Causes recipient addresses to be expanded based on the discussion in the section
808 \fBSending Mail\fR. Note that enabling this option allows for addresses that can
809 cause arbitrary command execution by starting with the \fB|\fR character.
810 .RE
812 .sp
813 .ne 2
814 .na
815 \fB\fBex\fRit\fR
816 .ad
817 .br
818 .na
819 \fB\fBx\fRit\fR
820 .ad
821 .sp .6
822 .RS 4n
823 Exit from \fBmailx\fR, without changing the \fBmailbox\fR. No messages are
824 saved in the \fBmbox\fR (see also \fBq\fRuit).
825 .RE
827 .sp
828 .ne 2
829 .na
830 \fB\fBfie\fRld [\fImessage-list\fR] header-file\fR
831 .ad
832 .sp .6
833 .RS 4n
834 Display the value of the header field in the specified message.
835 .RE
837 .sp
838 .ne 2
839 .na
840 \fB\fBfi\fRle [\fIfile\fR]\fR
841 .ad
842 .br
843 .na
844 \fB\fBfold\fRer [\fIfile\fR]\fR
845 .ad
846 .sp .6
847 .RS 4n
848 Quit from the current file of messages and read in the specified file. Several
849 special characters are recognized when used as file names:
850 .sp
851 .ne 2
852 .na
853 \fB\fB%\fR\fR
854 .ad
855 .RS 9n
856 the current \fBmailbox\fR.
857 .RE
859 .sp
860 .ne 2
861 .na
862 \fB\fB%\fR\fIuser\fR\fR
863 .ad
864 .RS 9n
865 the \fBmailbox\fR for \fIuser\fR.
866 .RE
868 .sp
869 .ne 2
870 .na
871 \fB\fB#\fR\fR
872 .ad
873 .RS 9n
874 the previous mail file.
875 .RE
877 .sp
878 .ne 2
879 .na
880 \fB\fB&\fR\fR
881 .ad
882 .RS 9n
883 the current \fBmbox\fR.
884 .RE
886 .sp
887 .ne 2
888 .na
889 \fB\fB+\fR\fIfile\fR\fR
890 .ad
891 .RS 9n
892 The named file in the \fIfolder\fR directory (listed in the \fBfolder\fR
893 variable).
894 .RE
896 With no arguments, print the name of the current mail file, and the number of
897 messages and characters it contains.
898 .RE
900 .sp
901 .ne 2
902 .na
903 \fB\fBfolders\fR\fR
904 .ad
905 .sp .6
906 .RS 4n
907 Print the names of the files in the directory set by the \fBfolder\fR variable
908 (see \fBInternal Variables\fR).
909 .RE
911 .sp
912 .ne 2
913 .na
914 \fB\fBFo\fRllowup [\fImessage\fR]\fR
915 .ad
916 .sp .6
917 .RS 4n
918 Respond to a message, recording the response in a file whose name is derived
919 from the author of the message. Overrides the \fBrecord\fR variable, if set. If
920 the \fBreplyall\fR variable is set, the actions of \fBFo\fRllowup and
921 \fBfo\fRllowup are reversed. See also the \fBf\fRollowup, \fBS\fRave, and
922 \fBC\fRopy commands and \fBoutfolder\fR in \fBInternal Variables\fR, and the
923 \fBStarting Mail\fR section in USAGE above.
924 .RE
926 .sp
927 .ne 2
928 .na
929 \fB\fBf\fRollowup [\fImessage-list\fR]\fR
930 .ad
931 .sp .6
932 .RS 4n
933 Respond to the first message in the \fImessage-list\fR, sending the message to
934 the author of each message in the \fImessage-list\fR. The subject line is taken
935 from the first message and the response is recorded in a file whose name is
936 derived from the author of the first message. If the \fBreplyall\fR variable is
937 set, the actions of \fBfo\fRllowup and \fBFo\fRllowup are reversed. See also
938 the \fBFo\fRllowup, \fBS\fRave, and \fBC\fRopy commands and \fBoutfolder\fR in
939 \fBInternal Variables\fR, and the \fBStarting Mail\fR section in USAGE above.
940 .RE
942 .sp
943 .ne 2
944 .na
945 \fB\fBf\fRrom [\fImessage-list\fR]\fR
946 .ad
947 .sp .6
948 .RS 4n
949 Print the header summary for the specified messages. If no messages are
950 specified, print the header summary for the current message.
951 .RE
953 .sp
954 .ne 2
955 .na
956 \fB\fBg\fRroup \fIalias name \fR.\|.\|.\fR
957 .ad
958 .br
959 .na
960 \fB\fBa\fRlias \fIalias name \fR.\|.\|.\fR
961 .ad
962 .sp .6
963 .RS 4n
964 Declare an alias for the given names. The names are substituted when
965 \fBalias\fR is used as a recipient. Useful in the \fBmailrc\fR file.
966 .RE
968 .sp
969 .ne 2
970 .na
971 \fB\fBh\fReaders [\fImessage\fR]\fR
972 .ad
973 .sp .6
974 .RS 4n
975 Print the page of headers which includes the message specified. The
976 \fBscreen\fR variable sets the number of headers per page (see \fBInternal
977 Variables\fR). See also the \fBz\fR command.
978 .RE
980 .sp
981 .ne 2
982 .na
983 \fB\fBhel\fRp\fR
984 .ad
985 .sp .6
986 .RS 4n
987 Print a summary of commands.
988 .RE
990 .sp
991 .ne 2
992 .na
993 \fB\fBho\fRld [\fImessage-list\fR]\fR
994 .ad
995 .br
996 .na
997 \fB\fBpre\fRserve [\fImessage-list\fR]\fR
998 .ad
999 .sp .6
1000 .RS 4n
1001 Hold the specified messages in the \fBmailbox\fR.
1002 .RE
1004 .sp
1005 .ne 2
1006 .na
1007 \fB\fBi\fRf \fBs\fR | \fBr\fR | \fBt\fR\fR
1008 .ad
1009 .br
1010 .na
1011 \fB\fImail-commands\fR\fR
1012 .ad
1013 .br
1014 .na
1015 \fB\fR
1016 .ad
1017 .br
1018 .na
1019 \fB\fBel\fRse\fR
1020 .ad
1021 .br
1022 .na
1023 \fB\fImail-commands\fR\fR
1024 .ad
1025 .br
1026 .na
1027 \fB\fR
1028 .ad
1029 .br
1030 .na
1031 \fB\fBen\fRdif\fR
1032 .ad
1033 .sp .6
1034 .RS 4n
1035 Conditional execution, where \fIs\fR executes following \fImail-commands\fR, up
1036 to an \fBel\fRse or \fBen\fRdif, if the program is in \fIsend\fR mode, \fIr\fR
1037 causes the \fImail-commands\fR to be executed only in \fIreceive\fR mode, and
1038 \fBt\fR causes the \fImail-commands\fR to be executed only if \fBmailx\fR is
1039 being run from a terminal. Useful in the \fBmailrc\fR file.
1040 .RE
1042 .sp
1043 .ne 2
1044 .na
1045 \fB\fBinc\fR\fR
1046 .ad
1047 .sp .6
1048 .RS 4n
1049 Incorporate messages that arrive while you are reading the system mailbox. The
1050 new messages are added to the message list in the current \fBmail\fR session.
1051 This command does not commit changes made during the session, and prior
1052 messages are not renumbered.
1053 .RE
1055 .sp
1056 .ne 2
1057 .na
1058 \fB\fBig\fRnore [\fIheader-field \fR.\|.\|.\|]\fR
1059 .ad
1060 .br
1061 .na
1062 \fB\fBdi\fRscard [\fIheader-field \fR.\|.\|.\|]\fR
1063 .ad
1064 .sp .6
1065 .RS 4n
1066 Suppress printing of the specified header fields when displaying messages on
1067 the screen. Examples of header fields to ignore are \fBStatus\fR and \fBCc\fR.
1068 All fields are included when the message is saved. The \fBMo\fRre, \fBPa\fRge,
1069 \fBP\fRrint and \fBT\fRype commands override this command. If no header is
1070 specified, the current list of header fields being ignored is printed. See also
1071 the \fBundi\fRscard and \fBunig\fRnore commands.
1072 .RE
1074 .sp
1075 .ne 2
1076 .na
1077 \fB\fBl\fRist\fR
1078 .ad
1079 .sp .6
1080 .RS 4n
1081 Print all commands available. No explanation is given.
1082 .RE
1084 .sp
1085 .ne 2
1086 .na
1087 \fB\fBlo\fRad\fR
1088 .ad
1089 .sp .6
1090 .RS 4n
1091 [\fImessage\fR] \fBfile\fR The specified message is replaced by the message in
1092 the named file. \fBfile\fR should contain a single mail message including mail
1093 headers (as saved by the \fBs\fRave command).
1094 .RE
1096 .sp
1097 .ne 2
1098 .na
1099 \fB\fBm\fRail \fIrecipient \fR.\|.\|.\fR
1100 .ad
1101 .sp .6
1102 .RS 4n
1103 Mail a message to the specified recipients.
1104 .RE
1106 .sp
1107 .ne 2
1108 .na
1109 \fB\fBM\fRail \fIrecipient\fR\fR
1110 .ad
1111 .sp .6
1112 .RS 4n
1113 Mail a message to the specified recipients, and record it in a file whose name
1114 is derived from the author of the message. Overrides the \fBrecord\fR variable,
1115 if set. See also the \fBSave\fR and \fBCopy\fR commands and \fBoutfolder\fR in
1116 \fBInternal Variables\fR.
1117 .RE
1119 .sp
1120 .ne 2
1121 .na
1122 \fB\fBmb\fRox [\fImessage-list\fR]\fR
1123 .ad
1124 .sp .6
1125 .RS 4n
1126 Arrange for the given messages to end up in the standard \fBmbox\fR save file
1127 when \fBmailx\fR terminates normally. See \fBMBOX\fR in ENVIRONMENT VARIABLES
1128 for a description of this file. See also the \fBex\fRit and \fBq\fRuit
1129 commands.
1130 .RE
1132 .sp
1133 .ne 2
1134 .na
1135 \fB\fBmo\fRre [\fImessage-list\fR]\fR
1136 .ad
1137 .br
1138 .na
1139 \fB\fBpa\fRge [\fImessage-list\fR]\fR
1140 .ad
1141 .sp .6
1142 .RS 4n
1143 Print the specified messages. If \fBcrt\fR is set, the messages longer than the
1144 number of lines specified by the \fBcrt\fR variable are paged through the
1145 command specified by the \fBPAGER\fR variable. The default command is
1146 \fBpg\fR(1) or if the \fBbsdcompat\fR variable is set, the default is
1147 \fBmore\fR(1). See ENVIRONMENT VARIABLES. Same as the \fBp\fRrint and
1148 \fBt\fRype commands.
1149 .RE
1151 .sp
1152 .ne 2
1153 .na
1154 \fB\fBMo\fRre [\fImessage-list\fR]\fR
1155 .ad
1156 .br
1157 .na
1158 \fB\fBPa\fRge [\fImessage-list\fR]\fR
1159 .ad
1160 .sp .6
1161 .RS 4n
1162 Print the specified messages on the screen, including all header fields.
1163 Overrides suppression of fields by the \fBig\fRnore command. Same as the
1164 \fBP\fRrint and \fBT\fRype commands.
1165 .RE
1167 .sp
1168 .ne 2
1169 .na
1170 \fB\fBne\fRw [\fImessage-list\fR]\fR
1171 .ad
1172 .br
1173 .na
1174 \fB\fBN\fRew [\fImessage-list\fR]\fR
1175 .ad
1176 .br
1177 .na
1178 \fB\fBunr\fRead [\fImessage-list\fR]\fR
1179 .ad
1180 .br
1181 .na
1182 \fB\fBU\fRnread\fR
1183 .ad
1184 .sp .6
1185 .RS 4n
1186 [\fImessage-list\fR] Take a message list and mark each message as \fInot\fR
1187 having been read.
1188 .RE
1190 .sp
1191 .ne 2
1192 .na
1193 \fB\fBn\fRext [\fImessage\fR]\fR
1194 .ad
1195 .sp .6
1196 .RS 4n
1197 Go to the next message matching \fImessage\fR. If message is not supplied, this
1198 command finds the next message that was not deleted or saved. A
1199 \fImessage-list\fR may be specified, but in this case the first valid message
1200 in the list is the only one used. This is useful for jumping to the next
1201 message from a specific user, since the name would be taken as a command in the
1202 absence of a real command. See the discussion of \fImessage-list\fR above for a
1203 description of possible message specifications.
1204 .RE
1206 .sp
1207 .ne 2
1208 .na
1209 \fB\fBpi\fRpe [\fImessage-list\fR] [\fIshell-command\fR]\fR
1210 .ad
1211 .br
1212 .na
1213 \fB\fB|\fR [\fImessage-list\fR] [\fIshell-command\fR]\fR
1214 .ad
1215 .sp .6
1216 .RS 4n
1217 Pipe the message through the given \fIshell-command\fR. The message is treated
1218 as if it were read. If no arguments are given, the current message is piped
1219 through the command specified by the value of the \fBcmd\fR variable. If the
1220 \fBpage\fR variable is set, a form feed character is inserted after each
1221 message (see \fBInternal Variables\fR).
1222 .RE
1224 .sp
1225 .ne 2
1226 .na
1227 \fB\fBpre\fRserve [\fImessage-list\fR]\fR
1228 .ad
1229 .br
1230 .na
1231 \fB\fBho\fRld [\fImessage-list\fR]\fR
1232 .ad
1233 .sp .6
1234 .RS 4n
1235 Preserve the specified messages in the \fBmailbox\fR.
1236 .RE
1238 .sp
1239 .ne 2
1240 .na
1241 \fB\fBp\fRrint [\fImessage-list\fR]\fR
1242 .ad
1243 .br
1244 .na
1245 \fB\fBt\fRype [\fImessage-list\fR]\fR
1246 .ad
1247 .sp .6
1248 .RS 4n
1249 Print the specified messages. If \fBcrt\fR is set, the messages longer than the
1250 number of lines specified by the \fBcrt\fR variable are paged through the
1251 command specified by the \fBPAGER\fR variable. The default command is
1252 \fBpg\fR(1) or if the \fBbsdcompat\fR variable is set, the default is
1253 \fBmore\fR(1). See ENVIRONMENT VARIABLES. Same as the \fBmo\fRre and \fBpa\fRge
1254 commands.
1255 .RE
1257 .sp
1258 .ne 2
1259 .na
1260 \fB\fBP\fRrint [\fImessage-list\fR]\fR
1261 .ad
1262 .br
1263 .na
1264 \fB\fBT\fRype [\fImessage-list\fR]\fR
1265 .ad
1266 .sp .6
1267 .RS 4n
1268 Print the specified messages on the screen, including all header fields.
1269 Overrides suppression of fields by the \fBig\fRnore command. Same as the
1270 \fBMo\fRre and \fBPa\fRge commands.
1271 .RE
1273 .sp
1274 .ne 2
1275 .na
1276 \fB\fBpu\fRt [\fIfile\fR]\fR
1277 .ad
1278 .br
1279 .na
1280 \fB\fBpu\fRt [\fImessage-list\fR] \fIfile\fR\fR
1281 .ad
1282 .sp .6
1283 .RS 4n
1284 Save the specified message in the given file. Use the same conventions as the
1285 \fBp\fRrint command for which header fields are ignored.
1286 .RE
1288 .sp
1289 .ne 2
1290 .na
1291 \fB\fBPu\fRt [\fIfile\fR]\fR
1292 .ad
1293 .br
1294 .na
1295 \fB\fBPu\fRt [\fImessage-list\fR] \fIfile\fR\fR
1296 .ad
1297 .sp .6
1298 .RS 4n
1299 Save the specified message in the given file. Overrides suppression of fields
1300 by the \fBig\fRnore command.
1301 .RE
1303 .sp
1304 .ne 2
1305 .na
1306 \fB\fBq\fRuit\fR
1307 .ad
1308 .sp .6
1309 .RS 4n
1310 Exit from \fBmailx\fR, storing messages that were read in \fBmbox\fR and unread
1311 messages in the \fBmailbox\fR. Messages that have been explicitly saved in a
1312 file are deleted unless the \fBkeepsave\fR variable is set.
1313 .RE
1315 .sp
1316 .ne 2
1317 .na
1318 \fB\fBr\fReply [\fImessage-list\fR]\fR
1319 .ad
1320 .br
1321 .na
1322 \fB\fBr\fRespond [\fImessage-list\fR]\fR
1323 .ad
1324 .br
1325 .na
1326 \fB\fBreplys\fRender [\fImessage-list\fR]\fR
1327 .ad
1328 .sp .6
1329 .RS 4n
1330 Send a response to the author of each message in the \fImessage-list\fR. The
1331 subject line is taken from the first message. If \fBrecord\fR is set to a
1332 file, a copy of the reply is added to that file. If the \fBreplyall\fR variable
1333 is set, the actions of \fBR\fReply/\fBR\fRespond and \fBr\fReply/\fBr\fRespond
1334 are reversed. The \fBreplys\fRender command is not affected by the
1335 \fBreplyall\fR variable, but sends each reply only to the sender of each
1336 message. See the \fBStarting Mail\fR section in USAGE above.
1337 .RE
1339 .sp
1340 .ne 2
1341 .na
1342 \fB\fBR\fReply [\fImessage\fR]\fR
1343 .ad
1344 .br
1345 .na
1346 \fB\fBR\fRespond [\fImessage\fR]\fR
1347 .ad
1348 .br
1349 .na
1350 \fB\fBreplya\fRll [\fImessage\fR]\fR
1351 .ad
1352 .sp .6
1353 .RS 4n
1354 Reply to the specified message, including all other recipients of that message.
1355 If the variable \fBrecord\fR is set to a file, a copy of the reply added to
1356 that file. If the \fBreplyall\fR variable is set, the actions of
1357 \fBR\fReply/\fBR\fRespond and \fBr\fReply/\fBr\fRespond are reversed. The
1358 \fBreplya\fRll command is not affected by the \fBreplyall\fR variable, but
1359 always sends the reply to all recipients of the message. See the \fBStarting
1360 Mail\fR section in USAGE above.
1361 .RE
1363 .sp
1364 .ne 2
1365 .na
1366 \fB\fBret\fRain\fR
1367 .ad
1368 .sp .6
1369 .RS 4n
1370 Add the list of header fields named to the \fIretained list\fR. Only the header
1371 fields in the retain list are shown on your terminal when you print a message.
1372 All other header fields are suppressed. The set of retained fields specified
1373 by the \fBret\fRain command overrides any list of ignored fields specified by
1374 the \fBig\fRnore command. The \fBT\fRype and \fBP\fRrint commands can be used
1375 to print a message in its entirety. If \fBret\fRain is executed with no
1376 arguments, it lists the current set of retained fields.
1377 .RE
1379 .sp
1380 .ne 2
1381 .na
1382 \fB\fBS\fRave [\fImessage-list\fR]\fR
1383 .ad
1384 .sp .6
1385 .RS 4n
1386 Save the specified messages in a file whose name is derived from the author of
1387 the first message. The name of the file is taken to be the author's name with
1388 all network addressing stripped off. See also the \fBC\fRopy, \fBfo\fRllowup,
1389 and \fBF\fRollowup commands and \fBoutfolder\fR in \fBInternal Variables\fR.
1390 .RE
1392 .sp
1393 .ne 2
1394 .na
1395 \fB\fBs\fRave [\fIfile\fR]\fR
1396 .ad
1397 .br
1398 .na
1399 \fB\fBs\fRave [\fImessage-list\fR] \fIfile\fR\fR
1400 .ad
1401 .sp .6
1402 .RS 4n
1403 Save the specified messages in the given file. The file is created if it does
1404 not exist. The file defaults to \fBmbox\fR. The message is deleted from the
1405 \fBmailbox\fR when \fBmailx\fR terminates unless \fBkeepsave\fR is set (see
1406 also \fBInternal Variables\fR and the \fBex\fRit and \fBq\fRuit commands).
1407 .RE
1409 .sp
1410 .ne 2
1411 .na
1412 \fB\fBse\fRt\fR
1413 .ad
1414 .br
1415 .na
1416 \fB\fBse\fRt \fIvariable\fR\fR
1417 .ad
1418 .br
1419 .na
1420 \fB\fBse\fRt \fIvariable\fR\fB=\fR\fIstring\fR\fR
1421 .ad
1422 .br
1423 .na
1424 \fB\fBse\fRt \fIvariable\fR\fB=\fR\fInumber\fR\fR
1425 .ad
1426 .sp .6
1427 .RS 4n
1428 Define a \fIvariable\fR. To assign a \fIvalue\fR to \fIvariable\fR, separate
1429 the variable name from the value by an `\fB=\fR' (there must be no space before
1430 or after the `\fB=\fR'). A variable may be given a null, string, or numeric
1431 \fIvalue\fR. To embed SPACE characters within a \fIvalue\fR, enclose it in
1432 quotes.
1433 .sp
1434 With no arguments, \fBse\fRt displays all defined variables and any values they
1435 might have. See \fBInternal Variables\fR for a description of all predefined
1436 \fBmail\fR variables.
1437 .RE
1439 .sp
1440 .ne 2
1441 .na
1442 \fB\fBsh\fRell\fR
1443 .ad
1444 .sp .6
1445 .RS 4n
1446 Invoke an interactive shell. See also \fBSHELL\fR in ENVIRONMENT VARIABLES.
1447 .RE
1449 .sp
1450 .ne 2
1451 .na
1452 \fB\fBsi\fRze [\fImessage-list\fR]\fR
1453 .ad
1454 .sp .6
1455 .RS 4n
1456 Print the size in characters of the specified messages.
1457 .RE
1459 .sp
1460 .ne 2
1461 .na
1462 \fB\fBso\fRurce \fIfile\fR\fR
1463 .ad
1464 .sp .6
1465 .RS 4n
1466 Read commands from the given file and return to command mode.
1467 .RE
1469 .sp
1470 .ne 2
1471 .na
1472 \fB\fBto\fRp [\fImessage-list\fR]\fR
1473 .ad
1474 .sp .6
1475 .RS 4n
1476 Print the top few lines of the specified messages. If the \fBtoplines\fR
1477 variable is set, it is taken as the number of lines to print (see \fBInternal
1478 Variables\fR). The default is 5.
1479 .RE
1481 .sp
1482 .ne 2
1483 .na
1484 \fB\fBtou\fRch [\fImessage-list\fR]\fR
1485 .ad
1486 .sp .6
1487 .RS 4n
1488 Touch the specified messages. If any message in \fImessage-list\fR is not
1489 specifically saved in a file, it is placed in the \fBmbox\fR, or the file
1490 specified in the \fBMBOX\fR environment variable, upon normal termination. See
1491 \fBex\fRit and \fBq\fRuit.
1492 .RE
1494 .sp
1495 .ne 2
1496 .na
1497 \fB\fBT\fRype [\fImessage-list\fR]\fR
1498 .ad
1499 .br
1500 .na
1501 \fB\fBP\fRrint [\fImessage-list\fR]\fR
1502 .ad
1503 .sp .6
1504 .RS 4n
1505 Print the specified messages on the screen, including all header fields.
1506 Overrides suppression of fields by the \fBig\fRnore command.
1507 .RE
1509 .sp
1510 .ne 2
1511 .na
1512 \fB\fBt\fRype [\fImessage-list\fR]\fR
1513 .ad
1514 .br
1515 .na
1516 \fB\fBp\fRrint [\fImessage-list\fR]\fR
1517 .ad
1518 .sp .6
1519 .RS 4n
1520 Print the specified messages. If \fBcrt\fR is set, the messages longer than the
1521 number of lines specified by the \fBcrt\fR variable are paged through the
1522 command specified by the \fBPAGER\fR variable. The default command is
1523 \fBpg\fR(1). See ENVIRONMENT VARIABLES.
1524 .RE
1526 .sp
1527 .ne 2
1528 .na
1529 \fB\fBuna\fRlias [\fBalias\fR] .\|.\|.\fR
1530 .ad
1531 .br
1532 .na
1533 \fB\fBung\fRroup [\fBalias\fR] .\|.\|.\fR
1534 .ad
1535 .sp .6
1536 .RS 4n
1537 Remove the definitions of the specified aliases.
1538 .RE
1540 .sp
1541 .ne 2
1542 .na
1543 \fB\fBu\fRndelete [\fImessage-list\fR]\fR
1544 .ad
1545 .sp .6
1546 .RS 4n
1547 Restore the specified deleted messages. Will only restore messages deleted in
1548 the current mail session. If \fBautoprint\fR is set, the last message of those
1549 restored is printed (see \fBInternal Variables\fR).
1550 .RE
1552 .sp
1553 .ne 2
1554 .na
1555 \fB\fBundi\fRscard [\fIheader-field\fR\|.\|.\|.]\fR
1556 .ad
1557 .br
1558 .na
1559 \fB\fBunig\fRnore [\fIheader-field\fR\|.\|.\|.]\fR
1560 .ad
1561 .sp .6
1562 .RS 4n
1563 Remove the specified header fields from the list being ignored. If no header
1564 fields are specified, all header fields are removed from the list being
1565 ignored.
1566 .RE
1568 .sp
1569 .ne 2
1570 .na
1571 \fB\fBunret\fRain [\fIheader-field\fR\|.\|.\|.]\fR
1572 .ad
1573 .sp .6
1574 .RS 4n
1575 Remove the specified header fields from the list being retained. If no header
1576 fields are specified, all header fields are removed from the list being
1577 retained.
1578 .RE
1580 .sp
1581 .ne 2
1582 .na
1583 \fB\fBunr\fRead [\fImessage-list\fR]\fR
1584 .ad
1585 .br
1586 .na
1587 \fB\fBU\fRnread [\fImessage-list\fR] Same as the \fBne\fRw command.\fR
1588 .ad
1589 .sp .6
1590 .RS 4n
1592 .RE
1594 .sp
1595 .ne 2
1596 .na
1597 \fB\fBuns\fRet \fIvariable\fR\|.\|.\|.\fR
1598 .ad
1599 .sp .6
1600 .RS 4n
1601 Erase the specified variables. If the variable was imported from the
1602 environment (that is, an environment variable or exported shell variable), it
1603 cannot be unset from within \fBmailx\fR.
1604 .RE
1606 .sp
1607 .ne 2
1608 .na
1609 \fB\fBve\fRrsion\fR
1610 .ad
1611 .sp .6
1612 .RS 4n
1613 Print the current version and release date of the \fBmailx\fR utility.
1614 .RE
1616 .sp
1617 .ne 2
1618 .na
1619 \fB\fBv\fRisual [\fImessage-list\fR]\fR
1620 .ad
1621 .sp .6
1622 .RS 4n
1623 Edit the given messages with a screen editor. Each messages is placed in a
1624 temporary file and the program named by the \fBVISUAL\fR variable is invoked to
1625 edit it (see ENVIRONMENT VARIABLES). Notice that the default visual editor is
1626 \fBvi\fR.
1627 .RE
1629 .sp
1630 .ne 2
1631 .na
1632 \fB\fBw\fRrite [\fImessage-list\fR] \fBfile\fR\fR
1633 .ad
1634 .sp .6
1635 .RS 4n
1636 Write the given messages on the specified file, minus the header and trailing
1637 blank line. Otherwise equivalent to the \fBs\fRave command.
1638 .RE
1640 .sp
1641 .ne 2
1642 .na
1643 \fB\fBx\fRit\fR
1644 .ad
1645 .br
1646 .na
1647 \fB\fBex\fRit\fR
1648 .ad
1649 .sp .6
1650 .RS 4n
1651 Exit from \fBmailx\fR, without changing the \fBmailbox\fR. No messages are
1652 saved in the \fBmbox\fR (see also \fBq\fRuit).
1653 .RE
1655 .sp
1656 .ne 2
1657 .na
1658 \fB\fBz\fR[\fB+\fR\||\|\fB\(mi\fR]\fR
1659 .ad
1660 .sp .6
1661 .RS 4n
1662 Scroll the header display forward or backward one screen\(mifull. The number of
1663 headers displayed is set by the \fBscreen\fR variable (see \fBInternal
1664 Variables\fR).
1665 .RE
1667 .SS "Tilde Escapes"
1668 .LP
1669 The following tilde escape commands can be used when composing mail to send.
1670 These may be entered only from \fIinput mode\fR, by beginning a line with the
1671 tilde escape character (~). See \fBescape\fR in \fBInternal Variables\fR for
1672 changing this special character. The escape character can be entered as text by
1673 typing it twice.
1674 .sp
1675 .ne 2
1676 .na
1677 \fB\fB~\|!\fR\fIshell-command\fR\fR
1678 .ad
1679 .RS 23n
1680 Escape to the shell. If present, run \fIshell-command\fR.
1681 .RE
1683 .sp
1684 .ne 2
1685 .na
1686 \fB\fB~.\fR\fR
1687 .ad
1688 .RS 23n
1689 Simulate end of file (terminate message input).
1690 .RE
1692 .sp
1693 .ne 2
1694 .na
1695 \fB\fB~\|:\fR\fImail-command\fR\fR
1696 .ad
1697 .br
1698 .na
1699 \fB\fB~_\|\fR\fImail-command\fR\fR
1700 .ad
1701 .RS 23n
1702 Perform the command-level request. Valid only when sending a message while
1703 reading mail.
1704 .RE
1706 .sp
1707 .ne 2
1708 .na
1709 \fB\fB~?\fR\fR
1710 .ad
1711 .RS 23n
1712 Print a summary of tilde escapes.
1713 .RE
1715 .sp
1716 .ne 2
1717 .na
1718 \fB\fB~A\fR\fR
1719 .ad
1720 .RS 23n
1721 Insert the autograph string \fBSign\fR into the message (see \fBInternal
1722 Variables\fR).
1723 .RE
1725 .sp
1726 .ne 2
1727 .na
1728 \fB\fB~a\fR\fR
1729 .ad
1730 .RS 23n
1731 Insert the autograph string \fBsign\fR into the message (see \fBInternal
1732 Variables\fR).
1733 .RE
1735 .sp
1736 .ne 2
1737 .na
1738 \fB\fB~b\fR\fI name \|.\|.\|.\fR\fR
1739 .ad
1740 .RS 23n
1741 Add the \fIname\fRs to the blind carbon copy (\fBBcc\fR) list. This is like the
1742 carbon copy (\fBCc\fR) list, except that the names in the \fBBcc\fR list are
1743 not shown in the header of the mail message.
1744 .RE
1746 .sp
1747 .ne 2
1748 .na
1749 \fB\fB~c\fR\fI name \|.\|.\|.\fR\fR
1750 .ad
1751 .RS 23n
1752 Add the \fIname\fRs to the carbon copy (\fBCc\fR) list.
1753 .RE
1755 .sp
1756 .ne 2
1757 .na
1758 \fB\fB~d\fR\fR
1759 .ad
1760 .RS 23n
1761 Read in the \fBdead-letter\fR file. See \fBDEAD\fR in ENVIRONMENT VARIABLES for
1762 a description of this file.
1763 .RE
1765 .sp
1766 .ne 2
1767 .na
1768 \fB\fB~e\fR\fR
1769 .ad
1770 .RS 23n
1771 Invoke the editor on the partial message. See also \fBEDITOR\fR in ENVIRONMENT
1772 VARIABLES.
1773 .RE
1775 .sp
1776 .ne 2
1777 .na
1778 \fB\fB~f\fR [\fImessage-list\fR]\fR
1779 .ad
1780 .RS 23n
1781 Forward the specified message, or the current message being read. Valid only
1782 when sending a message while reading mail. The messages are inserted into the
1783 message without alteration (as opposed to the \fB~m\fR escape).
1784 .RE
1786 .sp
1787 .ne 2
1788 .na
1789 \fB\fB~F\fR [\fImessage-list\fR]\fR
1790 .ad
1791 .RS 23n
1792 Forward the specified message, or the current message being read, including all
1793 header fields. Overrides the suppression of fields by the \fBig\fRnore command.
1794 .RE
1796 .sp
1797 .ne 2
1798 .na
1799 \fB\fB~h\fR\fR
1800 .ad
1801 .RS 23n
1802 Prompt for \fBSubject\fR line and \fBTo\fR, \fBCc\fR, and \fBBcc\fR lists. If
1803 the field is displayed with an initial value, it may be edited as if you had
1804 just typed it.
1805 .RE
1807 .sp
1808 .ne 2
1809 .na
1810 \fB\fB~i\fR \fIvariable\fR\fR
1811 .ad
1812 .RS 23n
1813 Insert the value of the named variable into the text of the message. For
1814 example, \fB~A\fR is equivalent to `\fB~i Sign\fR.' Environment variables set
1815 and exported in the shell are also accessible by \fB~i\fR.
1816 .RE
1818 .sp
1819 .ne 2
1820 .na
1821 \fB\fB~m\fR [\fImessage-list\fR]\fR
1822 .ad
1823 .RS 23n
1824 Insert the listed messages, or the current message being read into the letter.
1825 Valid only when sending a message while reading mail. The text of the message
1826 is shifted to the right, and the string contained in the \fBindentprefix\fR
1827 variable is inserted as the leftmost characters of each line. If
1828 \fBindentprefix\fR is not set, a TAB character is inserted into each line.
1829 .RE
1831 .sp
1832 .ne 2
1833 .na
1834 \fB\fB~M\fR [\fImessage-list\fR]\fR
1835 .ad
1836 .RS 23n
1837 Insert the listed messages, or the current message being read, including the
1838 header fields, into the letter. Valid only when sending a message while reading
1839 mail. The text of the message is shifted to the right, and the string contained
1840 in the \fBindentprefix\fR variable is inserted as the leftmost characters of
1841 each line. If \fBindentprefix\fR is not set, a TAB character is inserted into
1842 each line. Overrides the suppression of fields by the \fBig\fRnore command.
1843 .RE
1845 .sp
1846 .ne 2
1847 .na
1848 \fB\fB~p\fR\fR
1849 .ad
1850 .RS 23n
1851 Print the message being entered.
1852 .RE
1854 .sp
1855 .ne 2
1856 .na
1857 \fB\fB~q\fR\fR
1858 .ad
1859 .RS 23n
1860 Quit from input mode by simulating an interrupt. If the body of the message is
1861 not null, the partial message is saved in \fBdead-letter\fR. See \fBDEAD\fR in
1862 ENVIRONMENT VARIABLES for a description of this file.
1863 .RE
1865 .sp
1866 .ne 2
1867 .na
1868 \fB\fB~R\fR\fR
1869 .ad
1870 .RS 23n
1871 Mark message for return receipt.
1872 .RE
1874 .sp
1875 .ne 2
1876 .na
1877 \fB\fB~r\fR \fIfile\fR\fR
1878 .ad
1879 .br
1880 .na
1881 \fB\fB~<\fR \fIfile\fR\fR
1882 .ad
1883 .br
1884 .na
1885 \fB\fB~< ! \fR\fIshell-command\fR\fR
1886 .ad
1887 .RS 23n
1888 Read in the specified file. If the argument begins with an exclamation point
1889 (!), the rest of the string is taken as an arbitrary shell command and is
1890 executed, with the standard output inserted into the message.
1891 .RE
1893 .sp
1894 .ne 2
1895 .na
1896 \fB\fB~s\fR \fIstring \|.\|.\|.\fR\fR
1897 .ad
1898 .RS 23n
1899 Set the subject line to \fIstring\fR.
1900 .RE
1902 .sp
1903 .ne 2
1904 .na
1905 \fB\fB~t\fR \fIname \|.\|.\|.\fR\fR
1906 .ad
1907 .RS 23n
1908 Add the given \fIname\fRs to the To list.
1909 .RE
1911 .sp
1912 .ne 2
1913 .na
1914 \fB\fB~v\fR\fR
1915 .ad
1916 .RS 23n
1917 Invoke a preferred screen editor on the partial message. The default visual
1918 editor is \fBvi\fR(1). See also \fBVISUAL\fR in ENVIRONMENT VARIABLES.
1919 .RE
1921 .sp
1922 .ne 2
1923 .na
1924 \fB\fB~w\fR \fIfile\fR\fR
1925 .ad
1926 .RS 23n
1927 Write the message into the given file, without the header.
1928 .RE
1930 .sp
1931 .ne 2
1932 .na
1933 \fB\fB~x\fR\fR
1934 .ad
1935 .RS 23n
1936 Exit as with \fB~q\fR except the message is not saved in \fBdead-letter\fR.
1937 .RE
1939 .sp
1940 .ne 2
1941 .na
1942 \fB\fB~|\fR \fIshell-command\fR\fR
1943 .ad
1944 .RS 23n
1945 Pipe the body of the message through the given \fIshell-command\fR. If the
1946 \fIshell-command\fR returns a successful exit status, the output of the command
1947 replaces the message.
1948 .RE
1950 .SS "Internal Variables"
1951 .LP
1952 The following variables are internal variables. They may be imported from the
1953 execution environment or set using the \fBse\fRt command at any time. The
1954 \fBuns\fRet command may be used to erase variables.
1955 .sp
1956 .ne 2
1957 .na
1958 \fB\fBallnet\fR\fR
1959 .ad
1960 .RS 26n
1961 All network names whose last component (login name) match are treated as
1962 identical. This causes the \fImessage-list\fR message specifications to behave
1963 similarly. Disabled by default. See also the \fBalt\fRernates command and the
1964 \fBmetoo\fR and \fBfuzzymatch\fR variables.
1965 .RE
1967 .sp
1968 .ne 2
1969 .na
1970 \fB\fBalwaysignore\fR\fR
1971 .ad
1972 .RS 26n
1973 Ignore header fields with \fBig\fRnore everywhere, not just during \fBp\fRrint
1974 or \fBt\fRype. Affects the \fBs\fRave, \fBS\fRave, \fBc\fRopy, \fBC\fRopy,
1975 \fBto\fRp, \fBpi\fRpe, and \fBw\fRrite commands, and the \fB~m\fR and \fB~f\fR
1976 tilde escapes. Enabled by default.
1977 .RE
1979 .sp
1980 .ne 2
1981 .na
1982 \fB\fBappend\fR\fR
1983 .ad
1984 .RS 26n
1985 Upon termination, append messages to the end of the \fBmbox\fR file instead of
1986 prepending them. Although disabled by default, \fBappend\fR is set in the
1987 system startup file (which can be suppressed with the \fB-n\fR command line
1988 option).
1989 .RE
1991 .sp
1992 .ne 2
1993 .na
1994 \fB\fBappenddeadletter\fR\fR
1995 .ad
1996 .RS 26n
1997 Append to the deadletter file rather than overwrite it. Although disabled by
1998 default, \fBappenddeadletter\fR is frequently set in the system startup file.
1999 See \fBStarting Mail\fR in USAGE above.
2000 .RE
2002 .sp
2003 .ne 2
2004 .na
2005 \fB\fBaskbcc\fR\fR
2006 .ad
2007 .RS 26n
2008 Prompt for the \fBBcc\fR list after the \fBSubject\fR is entered if it is not
2009 specified on the command line with the \fB-b\fR option. Disabled by default.
2010 .RE
2012 .sp
2013 .ne 2
2014 .na
2015 \fB\fBaskcc\fR\fR
2016 .ad
2017 .RS 26n
2018 Prompt for the \fBCc\fR list after the \fBSubject\fR is entered if it is not
2019 specified on the command line with the \fB-c\fR option. Disabled by default.
2020 .RE
2022 .sp
2023 .ne 2
2024 .na
2025 \fB\fBasksub\fR\fR
2026 .ad
2027 .RS 26n
2028 Prompt for subject if it is not specified on the command line with the \fB-s\fR
2029 option. Enabled by default.
2030 .RE
2032 .sp
2033 .ne 2
2034 .na
2035 \fB\fBautoinc\fR\fR
2036 .ad
2037 .RS 26n
2038 Automatically incorporate new messages into the current session as they arrive.
2039 This has an affect similar to issuing the \fBinc\fR command every time the
2040 command prompt is displayed. Disabled by default, but \fBautoinc\fR is set in
2041 the default system startup file for \fBmailx\fR; it is not set for
2042 \fB/usr/ucb/mail\fR or \fB/usr/ucb/Mail\fR.
2043 .RE
2045 .sp
2046 .ne 2
2047 .na
2048 \fB\fBautoprint\fR\fR
2049 .ad
2050 .RS 26n
2051 Enable automatic printing of messages after \fBd\fRelete and \fBu\fRndelete
2052 commands. Disabled by default.
2053 .RE
2055 .sp
2056 .ne 2
2057 .na
2058 \fB\fBbang\fR\fR
2059 .ad
2060 .RS 26n
2061 Enable the special-casing of exclamation points (!) in shell escape command
2062 lines as in \fBvi\fR(1). Disabled by default.
2063 .RE
2065 .sp
2066 .ne 2
2067 .na
2068 \fB\fBbsdcompat\fR\fR
2069 .ad
2070 .RS 26n
2071 Set automatically if \fBmailx\fR is invoked as \fBmail\fR or \fBMail\fR. Causes
2072 \fBmailx\fR to use \fB/etc/mail/Mail.rc\fR as the system startup file. Changes
2073 the default pager to \fBmore\fR(1).
2074 .RE
2076 .sp
2077 .ne 2
2078 .na
2079 \fB\fBcmd=\fR\fIshell-command\fR\fR
2080 .ad
2081 .RS 26n
2082 Set the default command for the \fBpi\fRpe command. No default value.
2083 .RE
2085 .sp
2086 .ne 2
2087 .na
2088 \fB\fBconv=\fR\fIconversion\fR\fR
2089 .ad
2090 .RS 26n
2091 Convert \fBuucp\fR addresses to the specified address style, which can be
2092 either:
2093 .sp
2094 .ne 2
2095 .na
2096 \fB\fBinternet\fR\fR
2097 .ad
2098 .RS 12n
2099 This requires a mail delivery program conforming to the \fBRFC822\fR standard
2100 for electronic mail addressing.
2101 .RE
2103 .sp
2104 .ne 2
2105 .na
2106 \fB\fBoptimize\fR\fR
2107 .ad
2108 .RS 12n
2109 Remove loops in \fBuucp\fR(1C) address paths (typically generated by the
2110 \fBr\fReply command). No rerouting is performed; \fBmail\fR has no knowledge
2111 of \fBUUCP\fR routes or connections.
2112 .RE
2114 Conversion is disabled by default. See also \fBsendmail\fR(1M) and the \fB-U\fR
2115 command-line option.
2116 .RE
2118 .sp
2119 .ne 2
2120 .na
2121 \fB\fBcrt\fR[\fB=\fR\fInumber\fR]\fR
2122 .ad
2123 .RS 26n
2124 Pipe messages having more than \fInumber\fR lines through the command specified
2125 by the value of the \fBPAGER\fR variable ( \fBpg\fR(1) or \fBmore\fR(1) by
2126 default). If \fInumber\fR is not specified, the current window size is used.
2127 Disabled by default.
2128 .RE
2130 .sp
2131 .ne 2
2132 .na
2133 \fB\fBdebug\fR\fR
2134 .ad
2135 .RS 26n
2136 Enable verbose diagnostics for debugging. Messages are not delivered. Disabled
2137 by default.
2138 .RE
2140 .sp
2141 .ne 2
2142 .na
2143 \fB\fBdot\fR\fR
2144 .ad
2145 .RS 26n
2146 Take a period on a line by itself, or \fBEOF\fR during input from a terminal as
2147 end-of-file. Disabled by default, but \fBdot\fR is set in the system startup
2148 file (which can be suppressed with the \fB-n\fR command line option).
2149 .RE
2151 .sp
2152 .ne 2
2153 .na
2154 \fB\fBfcc\fR\fR
2155 .ad
2156 .RS 26n
2157 By default, \fBmailx\fR will treat any address containing a slash ("/")
2158 character as a local "send to file" address. By unsetting this option, this
2159 behavior is disabled. Enabled by default.
2160 .RE
2162 .sp
2163 .ne 2
2164 .na
2165 \fB\fBflipr\fR\fR
2166 .ad
2167 .RS 26n
2168 Reverse the effect of the \fBfo\fRllowup/\fBFo\fRllowup and
2169 \fBr\fReply/\fBR\fReply command pairs. If both \fBflipr\fR and \fBreplyall\fR
2170 are set, the effect is as if neither was set.
2171 .RE
2173 .sp
2174 .ne 2
2175 .na
2176 \fB\fBfrom\fR\fR
2177 .ad
2178 .RS 26n
2179 Extract the author listed in the header summary from the \fBFrom:\fR header
2180 instead of the UNIX \fBFrom\fR line. Enabled by default.
2181 .RE
2183 .sp
2184 .ne 2
2185 .na
2186 \fB\fBfuzzymatch\fR\fR
2187 .ad
2188 .RS 26n
2189 The \fBfrom\fR command searches for messages from the indicated sender. By
2190 default, the full sender address must be specified. By setting this option,
2191 only a sub-string of the sender address need be specified. Disabled by default.
2192 .RE
2194 .sp
2195 .ne 2
2196 .na
2197 \fB\fBescape=\fR\fIc\fR\fR
2198 .ad
2199 .RS 26n
2200 Substitute \fIc\fR for the ~ escape character. Takes effect with next message
2201 sent.
2202 .RE
2204 .sp
2205 .ne 2
2206 .na
2207 \fB\fBfolder=\fR\fIdirectory\fR\fR
2208 .ad
2209 .RS 26n
2210 The directory for saving standard mail files. User-specified file names
2211 beginning with a plus (+) are expanded by preceding the file name with this
2212 directory name to obtain the real file name. If \fIdirectory\fR does not start
2213 with a slash (/), \fB$HOME\fR is prepended to it. There is no default for the
2214 \fBfolder\fR variable. See also \fBoutfolder\fR below.
2215 .RE
2217 .sp
2218 .ne 2
2219 .na
2220 \fB\fBheader\fR\fR
2221 .ad
2222 .RS 26n
2223 Enable printing of the header summary when entering \fBmailx\fR. Enabled by
2224 default.
2225 .RE
2227 .sp
2228 .ne 2
2229 .na
2230 \fB\fBhold\fR\fR
2231 .ad
2232 .RS 26n
2233 Preserve all messages that are read in the \fBmailbox\fR instead of putting
2234 them in the standard \fBmbox\fR save file. Disabled by default.
2235 .RE
2237 .sp
2238 .ne 2
2239 .na
2240 \fB\fBignore\fR\fR
2241 .ad
2242 .RS 26n
2243 Ignore interrupts while entering messages. Handy for noisy dial-up lines.
2244 Disabled by default.
2245 .RE
2247 .sp
2248 .ne 2
2249 .na
2250 \fB\fBignoreeof\fR\fR
2251 .ad
2252 .RS 26n
2253 Ignore end-of-file during message input. Input must be terminated by a period
2254 (.) on a line by itself or by the \fB~.\fR command. See also \fBdot\fR above.
2255 Disabled by default.
2256 .RE
2258 .sp
2259 .ne 2
2260 .na
2261 \fB\fBindentprefix=\fR\fIstring\fR\fR
2262 .ad
2263 .RS 26n
2264 When \fBindentprefix\fR is set, \fIstring\fR is used to mark indented lines
2265 from messages included with \fB~m\fR. The default is a TAB character.
2266 .RE
2268 .sp
2269 .ne 2
2270 .na
2271 \fB\fBkeep\fR\fR
2272 .ad
2273 .RS 26n
2274 When the \fBmailbox\fR is empty, truncate it to zero length instead of removing
2275 it. Disabled by default.
2276 .RE
2278 .sp
2279 .ne 2
2280 .na
2281 \fB\fBiprompt=\fR\fIstring\fR\fR
2282 .ad
2283 .RS 26n
2284 The specified prompt string is displayed before each line on input is requested
2285 when sending a message.
2286 .RE
2288 .sp
2289 .ne 2
2290 .na
2291 \fB\fBkeepsave\fR\fR
2292 .ad
2293 .RS 26n
2294 Keep messages that have been saved in other files in the \fBmailbox\fR instead
2295 of deleting them. Disabled by default.
2296 .RE
2298 .sp
2299 .ne 2
2300 .na
2301 \fB\fBmakeremote\fR\fR
2302 .ad
2303 .RS 26n
2304 When replying to all recipients of a message, if an address does not include a
2305 machine name, it is assumed to be relative to the sender of the message.
2306 Normally not needed when dealing with hosts that support RFC822.
2307 .RE
2309 .sp
2310 .ne 2
2311 .na
2312 \fB\fBmetoo\fR\fR
2313 .ad
2314 .RS 26n
2315 If your login appears as a recipient, do not delete it from the list. Disabled
2316 by default.
2317 .RE
2319 .sp
2320 .ne 2
2321 .na
2322 \fB\fBmustbang\fR\fR
2323 .ad
2324 .RS 26n
2325 Force all mail addresses to be in bang format.
2326 .RE
2328 .sp
2329 .ne 2
2330 .na
2331 \fB\fBonehop\fR\fR
2332 .ad
2333 .RS 26n
2334 When responding to a message that was originally sent to several recipients,
2335 the other recipient addresses are normally forced to be relative to the
2336 originating author's machine for the response. This flag disables alteration of
2337 the recipients' addresses, improving efficiency in a network where all machines
2338 can send directly to all other machines (that is, one hop away). Disabled by
2339 default.
2340 .RE
2342 .sp
2343 .ne 2
2344 .na
2345 \fB\fBoutfolder\fR\fR
2346 .ad
2347 .RS 26n
2348 Locate the files used to record outgoing messages in the directory specified by
2349 the \fBfolder\fR variable unless the path name is absolute. Disabled by
2350 default. See \fBfolder\fR above and the \fBS\fRave, \fBC\fRopy, \fBfo\fRllowup,
2351 and \fBF\fRollowup commands.
2352 .RE
2354 .sp
2355 .ne 2
2356 .na
2357 \fB\fBpage\fR\fR
2358 .ad
2359 .RS 26n
2360 Used with the \fBpi\fRpe command to insert a form feed after each message sent
2361 through the pipe. Disabled by default.
2362 .RE
2364 .sp
2365 .ne 2
2366 .na
2367 \fB\fBpipeignore\fR\fR
2368 .ad
2369 .RS 26n
2370 Omit ignored header when outputting to the \fBpipe\fR command. Although
2371 disabled by default, \fBpipeignore\fR is frequently set in the system startup
2372 file. See \fBStarting Mail\fR in USAGE above.
2373 .RE
2375 .sp
2376 .ne 2
2377 .na
2378 \fB\fBpostmark\fR\fR
2379 .ad
2380 .RS 26n
2381 Your "real name" to be included in the From line of messages you send. By
2382 default this is derived from the comment field in your \fBpasswd\fR(4) file
2383 entry.
2384 .RE
2386 .sp
2387 .ne 2
2388 .na
2389 \fB\fBprompt=\fR\fIstring\fR\fR
2390 .ad
2391 .RS 26n
2392 Set the \fIcommand mode\fR prompt to \fIstring\fR. Default is "\fB? \fR",
2393 unless the \fBbsdcompat\fR variable is set, then the default is "\fB&\fR".
2394 .RE
2396 .sp
2397 .ne 2
2398 .na
2399 \fB\fBquiet\fR\fR
2400 .ad
2401 .RS 26n
2402 Refrain from printing the opening message and version when entering
2403 \fBmailx\fR. Disabled by default.
2404 .RE
2406 .sp
2407 .ne 2
2408 .na
2409 \fB\fBrecord=\fR\fIfile\fR\fR
2410 .ad
2411 .RS 26n
2412 Record all outgoing mail in \fIfile\fR. Disabled by default. See also
2413 \fBoutfolder\fR above.
2414 .RE
2416 .sp
2417 .ne 2
2418 .na
2419 \fB\fBreplyall\fR\fR
2420 .ad
2421 .RS 26n
2422 Reverse the effect of the \fBr\fReply and \fBR\fReply and \fBfo\fRllowup and
2423 \fBFo\fRllowup commands. Although set by default, \fBreplayall\fR is
2424 frequently unset in the system startup file. See \fBflipr\fR and \fBStarting
2425 Mail\fR in USAGE above.
2426 .RE
2428 .sp
2429 .ne 2
2430 .na
2431 \fB\fBreturnaddr=\fR\fIstring\fR\fR
2432 .ad
2433 .RS 26n
2434 The default sender address is that of the current user. This variable can be
2435 used to set the sender address to any arbitrary value. Set with caution.
2436 .RE
2438 .sp
2439 .ne 2
2440 .na
2441 \fB\fBsave\fR\fR
2442 .ad
2443 .RS 26n
2444 Enable saving of messages in \fBdead-letter\fR on interrupt or delivery error.
2445 See \fBDEAD\fR for a description of this file. Enabled by default.
2446 .RE
2448 .sp
2449 .ne 2
2450 .na
2451 \fB\fBscreen=\fR\fInumber\fR\fR
2452 .ad
2453 .RS 26n
2454 Sets the number of lines in a screen-full of headers for the \fBh\fReaders
2455 command. \fInumber\fR must be a positive number.
2456 .sp
2457 The default is set according to baud rate or window size. With a baud rate less
2458 than \fB1200\fR, \fInumber\fR defaults to \fB5\fR, if baud rate is exactly
2459 \fB1200\fR, it defaults to \fB10\fR. If you are in a window, \fInumber\fR
2460 defaults to the default window size minus 4. Otherwise, the default is
2461 \fB20\fR.
2462 .RE
2464 .sp
2465 .ne 2
2466 .na
2467 \fB\fBsendmail=\fR\fIshell-command\fR\fR
2468 .ad
2469 .RS 26n
2470 Alternate command for delivering messages. \fBNote:\fR In addition to the
2471 expected list of recipients, \fBmail\fR also passes the \fB-i\fR and \fB-m\fR,
2472 flags to the command. Since these flags are not appropriate to other commands,
2473 you may have to use a shell script that strips them from the arguments list
2474 before invoking the desired command. Default is \fB/usr/bin/rmail\fR.
2475 .RE
2477 .sp
2478 .ne 2
2479 .na
2480 \fB\fBsendwait\fR\fR
2481 .ad
2482 .RS 26n
2483 Wait for background mailer to finish before returning. Disabled by default.
2484 .RE
2486 .sp
2487 .ne 2
2488 .na
2489 \fB\fBshowname\fR\fR
2490 .ad
2491 .RS 26n
2492 Causes the message header display to show the sender's real name (if known)
2493 rather than their mail address. Disabled by default, but \fBshowname\fR is set
2494 in the \fB/etc/mail/mailx.rc\fR system startup file for \fBmailx\fR.
2495 .RE
2497 .sp
2498 .ne 2
2499 .na
2500 \fB\fBshowto\fR\fR
2501 .ad
2502 .RS 26n
2503 When displaying the header summary and the message is from you, print the
2504 recipient's name instead of the author's name.
2505 .RE
2507 .sp
2508 .ne 2
2509 .na
2510 \fB\fBsign=\fR\fIstring\fR\fR
2511 .ad
2512 .RS 26n
2513 The variable inserted into the text of a message when the \fB~a\fR (autograph)
2514 command is given. No default (see also \fB~i\fR in \fBTilde Escapes\fR).
2515 .sp
2516 `
2517 .RE
2519 .sp
2520 .ne 2
2521 .na
2522 \fB\fBSign=\fR\fIstring\fR\fR
2523 .ad
2524 .RS 26n
2525 The variable inserted into the text of a message when the \fB~A\fR command is
2526 given. No default (see also \fB~i\fR in \fBTilde Escapes\fR).
2527 .RE
2529 .sp
2530 .ne 2
2531 .na
2532 \fB\fBtoplines=\fR\fInumber\fR\fR
2533 .ad
2534 .RS 26n
2535 The number of lines of header to print with the \fBto\fRp command. Default is
2536 \fB5\fR.
2537 .RE
2539 .sp
2540 .ne 2
2541 .na
2542 \fB\fBverbose\fR\fR
2543 .ad
2544 .RS 26n
2545 Invoke \fBsendmail\fR(1M) with the \fB-v\fR flag.
2546 .RE
2548 .sp
2549 .ne 2
2550 .na
2551 \fB\fBtranslate\fR\fR
2552 .ad
2553 .RS 26n
2554 The name of a program to translate mail addresses. The program receives mail
2555 addresses as arguments. The program produces, on the standard output, lines
2556 containing the following data, in this order:
2557 .RS +4
2558 .TP
2559 .ie t \(bu
2560 .el o
2561 the postmark for the sender (see the postmark variable)
2562 .RE
2563 .RS +4
2564 .TP
2565 .ie t \(bu
2566 .el o
2567 translated mail addresses, one per line, corresponding to the program's
2568 arguments. Each translated address will replace the corresponding address in
2569 the mail message being sent.
2570 .RE
2571 .RS +4
2572 .TP
2573 .ie t \(bu
2574 .el o
2575 a line containing only "y" or "n". if the line contains "y" the user will be
2576 asked to confirm that the message should be sent.
2577 .RE
2578 The translate program will be invoked for each mail message to be sent. If the
2579 program exits with a non-zero exit status, or fails to produce enough output,
2580 the message is not sent.
2581 .RE
2583 .SS "Large File Behavior"
2584 .LP
2585 See \fBlargefile\fR(5) for the description of the behavior of \fBmailx\fR when
2586 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
2587 .SH ENVIRONMENT VARIABLES
2588 .LP
2589 See \fBenviron\fR(5) for descriptions of the following environment variables
2590 that affect the execution of \fBmailx\fR: \fBHOME\fR, \fBLANG\fR,
2591 \fBLC_CTYPE\fR, \fBLC_TIME\fR, \fBLC_MESSAGES\fR, \fBNLSPATH\fR, and
2592 \fBTERM\fR.
2593 .sp
2594 .ne 2
2595 .na
2596 \fB\fBDEAD\fR\fR
2597 .ad
2598 .RS 14n
2599 The name of the file in which to save partial letters in case of untimely
2600 interrupt. Default is \fB$HOME/dead.letter\fR.
2601 .RE
2603 .sp
2604 .ne 2
2605 .na
2606 \fB\fBEDITOR\fR\fR
2607 .ad
2608 .RS 14n
2609 The command to run when the \fBe\fRdit or \fB~e\fR command is used. Default is
2610 \fBed\fR(1).
2611 .RE
2613 .sp
2614 .ne 2
2615 .na
2616 \fB\fBLISTER\fR\fR
2617 .ad
2618 .RS 14n
2619 The command (and options) to use when listing the contents of the \fBfolder\fR
2620 directory. The default is \fBls\fR(1).
2621 .RE
2623 .sp
2624 .ne 2
2625 .na
2626 \fB\fBMAIL\fR\fR
2627 .ad
2628 .RS 14n
2629 The name of the initial mailbox file to read (in lieu of the standard system
2630 mailbox). The default is \fB/var/mail/\fIusername\fR .\fR
2631 .RE
2633 .sp
2634 .ne 2
2635 .na
2636 \fB\fBMAILRC\fR\fR
2637 .ad
2638 .RS 14n
2639 The name of the startup file. Default is \fB$HOME/.mailrc\fR.
2640 .RE
2642 .sp
2643 .ne 2
2644 .na
2645 \fB\fBMAILX_HEAD\fR\fR
2646 .ad
2647 .RS 14n
2648 The specified string is included at the beginning of the body of each message
2649 that is sent.
2650 .RE
2652 .sp
2653 .ne 2
2654 .na
2655 \fB\fBMAILX_TAIL\fR\fR
2656 .ad
2657 .RS 14n
2658 The specified string is included at the end of the body of each message that is
2659 sent.
2660 .RE
2662 .sp
2663 .ne 2
2664 .na
2665 \fB\fBMBOX\fR\fR
2666 .ad
2667 .RS 14n
2668 The name of the file to save messages which have been read. The \fBex\fRit
2669 command overrides this function, as does saving the message explicitly in
2670 another file. Default is \fB$HOME/mbox\fR.
2671 .RE
2673 .sp
2674 .ne 2
2675 .na
2676 \fB\fBPAGER\fR\fR
2677 .ad
2678 .RS 14n
2679 The command to use as a filter for paginating output. This can also be used to
2680 specify the options to be used. Default is \fBpg\fR(1), or if the
2681 \fBbsdcompat\fR variable is set, the default is \fBmore\fR(1). See \fBInternal
2682 Variables\fR.
2683 .RE
2685 .sp
2686 .ne 2
2687 .na
2688 \fB\fBSHELL\fR\fR
2689 .ad
2690 .RS 14n
2691 The name of a preferred command interpreter. Default is \fBsh\fR(1).
2692 .RE
2694 .sp
2695 .ne 2
2696 .na
2697 \fB\fBVISUAL\fR\fR
2698 .ad
2699 .RS 14n
2700 The name of a preferred screen editor. Default is \fBvi\fR(1).
2701 .RE
2703 .SH EXIT STATUS
2704 .LP
2705 When the \fB-e\fR option is specified, the following exit values are returned:
2706 .sp
2707 .ne 2
2708 .na
2709 \fB\fB0\fR\fR
2710 .ad
2711 .RS 6n
2712 Mail was found.
2713 .RE
2715 .sp
2716 .ne 2
2717 .na
2718 \fB\fB>0\fR\fR
2719 .ad
2720 .RS 6n
2721 Mail was not found or an error occurred.
2722 .RE
2724 .sp
2725 .LP
2726 Otherwise, the following exit values are returned:
2727 .sp
2728 .ne 2
2729 .na
2730 \fB\fB0\fR\fR
2731 .ad
2732 .RS 6n
2733 Successful completion. Notice that this status implies that all messages were
2734 \fBsent\fR, but it gives no assurances that any of them were actually
2735 \fBdelivered\fR.
2736 .RE
2738 .sp
2739 .ne 2
2740 .na
2741 \fB\fB>0\fR\fR
2742 .ad
2743 .RS 6n
2744 An error occurred
2745 .RE
2747 .SH FILES
2748 .ne 2
2749 .na
2750 \fB\fB$HOME/.mailrc\fR\fR
2751 .ad
2752 .sp .6
2753 .RS 4n
2754 personal startup file
2755 .RE
2757 .sp
2758 .ne 2
2759 .na
2760 \fB\fB$HOME/mbox\fR\fR
2761 .ad
2762 .sp .6
2763 .RS 4n
2764 secondary storage file
2765 .RE
2767 .sp
2768 .ne 2
2769 .na
2770 \fB\fB$HOME/.Maillock\fR\fR
2771 .ad
2772 .sp .6
2773 .RS 4n
2774 lock file to prevent multiple writers of system mailbox
2775 .RE
2777 .sp
2778 .ne 2
2779 .na
2780 \fB\fB/etc/mail/mailx.rc\fR\fR
2781 .ad
2782 .sp .6
2783 .RS 4n
2784 optional system startup file for \fBmailx\fR only
2785 .RE
2787 .sp
2788 .ne 2
2789 .na
2790 \fB\fB/etc/mail/Mail.rc\fR\fR
2791 .ad
2792 .sp .6
2793 .RS 4n
2794 BSD compatibility system-wide startup file for \fB/usr/ucb/mail\fR and
2795 \fB/usr/ucb/Mail\fR
2796 .RE
2798 .sp
2799 .ne 2
2800 .na
2801 \fB\fB/tmp/R[emqsx]*\fR\fR
2802 .ad
2803 .sp .6
2804 .RS 4n
2805 temporary files
2806 .RE
2808 .sp
2809 .ne 2
2810 .na
2811 \fB\fB/usr/share/lib/mailx/mailx.help*\fR\fR
2812 .ad
2813 .sp .6
2814 .RS 4n
2815 help message files
2816 .RE
2818 .sp
2819 .ne 2
2820 .na
2821 \fB\fB/var/mail/*\fR\fR
2822 .ad
2823 .sp .6
2824 .RS 4n
2825 post office directory
2826 .RE
2828 .SH ATTRIBUTES
2829 .LP
2830 See \fBattributes\fR(5) for descriptions of the following attributes:
2831 .sp
2833 .sp
2834 .TS
2835 box;
2836 c | c
2837 l | l .
2838 ATTRIBUTE TYPE ATTRIBUTE VALUE
2839 _
2840 Interface Stability Standard
2841 .TE
2843 .SH SEE ALSO
2844 .LP
2845 \fBbiff\fR(1B), \fBecho\fR(1), \fBed\fR(1), \fBex\fR(1), \fBfmt\fR(1),
2846 \fBlp\fR(1), \fBls\fR(1), \fBmail\fR(1), \fBmail\fR(1B), \fBmailcompat\fR(1),
2847 \fBmore\fR(1), \fBpg\fR(1), \fBsh\fR(1), \fBuucp\fR(1C), \fBvacation\fR(1),
2848 \fBvi\fR(1), \fBnewaliases\fR(1M), \fBsendmail\fR(1M), \fBaliases\fR(4),
2849 \fBpasswd\fR(4), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5),
2850 \fBstandards\fR(5)
2851 .SH NOTES
2852 .LP
2853 Where \fIshell-command\fR is shown as valid, arguments are not always allowed.
2854 Experimentation is recommended.
2855 .sp
2856 .LP
2857 Internal variables imported from the execution environment cannot be
2858 \fBuns\fRet.
2859 .sp
2860 .LP
2861 The full internet addressing is not fully supported by \fBmailx\fR. The new
2862 standards need some time to settle down.
2863 .sp
2864 .LP
2865 Replies do not always generate correct return addresses. Try resending the
2866 errant reply with \fBonehop\fR set.
2867 .sp
2868 .LP
2869 \fBmailx\fR does not lock your record file. So, if you use a record file and
2870 send two or more messages simultaneously, lines from the messages may be
2871 interleaved in the record file.
2872 .sp
2873 .LP
2874 The format for the \fBalias\fR command is a space-separated list of recipients,
2875 while the format for an alias in either the \fB\&.forward\fR or
2876 \fB/etc/aliases\fR is a comma-separated list.
2877 .sp
2878 .LP
2879 To read mail on a workstation running Solaris 1.\fIx\fR when your mail server
2880 is running Solaris 2.\fIx\fR, first execute the \fBmailcompat\fR(1) program.