Annotation of researchv10no/lbin/mailx/man/mailx.1, revision 1.1.1.1

1.1       root        1: '\"macro stdmacro
                      2: .if n .pH g1.mailx %W% of %G%
                      3: .nr X
                      4: .if \nX=0 .ds x} mailx 1 "Essential Utilities" "\&"
                      5: .if \nX=1 .ds x} mailx 1 "Essential Utilities"
                      6: .if \nX=2 .ds x} mailx 1 "" "\&"
                      7: .if \nX=3 .ds x} mailx "" "" "\&"
                      8: .TH \*(x}
                      9: .\" mailx command (in COMMAND section)
                     10: .de Cm
                     11: .PD
                     12: .\"sp
                     13: .ne 3
                     14: .TP
                     15: \\f4\\$1\\f1\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
                     16: .\"br
                     17: ..
                     18: .\" lines two through n of mailx command (.Cm)
                     19: .de C
                     20: .PD 0
                     21: .ne 2
                     22: .TP
                     23: \\f4\\$1\\f1\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
                     24: .\"br
                     25: ..
                     26: .\" mailx tilde escape (in TILDE ESCAPE section)
                     27: .de Ti
                     28: .\"sp
                     29: .ne 2
                     30: .TP
                     31: \\f4~\\^\\$1\\f1 \\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
                     32: .\"br
                     33: ..
                     34: .\" mailx environment variable that takes an arg (in ENVIRONMENT VARIABLE section)
                     35: .de Va
                     36: .\"sp
                     37: .ne 2
                     38: .TP
                     39: \\f4\\$1\\f1=\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
                     40: .\"br
                     41: ..
                     42: .\" mailx environment variable that does not take an arg (in ENVIRONMENT VARIABLE section)
                     43: .de V
                     44: .\"sp
                     45: .ne 2
                     46: .TP
                     47: \\f4\\$1\\f1
                     48: .\"br
                     49: ..
                     50: .\"  mailx environment variable in running text
                     51: .de Ev
                     52: \f4\\$1\f1\\$2
                     53: ..
                     54: .ds Ma \\f4mailx\\f1
                     55: .ds EV "\s-1ENVIRONMENT VARIABLES\s+1
                     56: .ds CM "\s-1COMMANDS\s+1
                     57: .ds TX "\s-1TILDE ESCAPES\s+1
                     58: .ds WA "\s-1WARNINGS\s+1
                     59: .ds al \\f2alias\\f1
                     60: .ds nu \\f2number\\f1
                     61: .ds ms \\f2message\f1
                     62: .ds sh \\f2shell-command\\f1
                     63: .ds mC \\f2mail-command\\f1
                     64: .ds dl \\f4dead.letter\\f1
                     65: .ds mr \\f4.mailrc\\f1
                     66: .ds mb \\f4mbox\\f1
                     67: .ds mx \\f4mailbox\\f1
                     68: .ds ml \\f2msglist\\f1
                     69: .ds om [\\f2msglist\\f1]
                     70: .ds hf \\f2header-field\\f1
                     71: .ds fn \\f2filename\\f1
                     72: .ds st \\f2string\\f1
                     73: .ds dr \\f2directory\\f1
                     74: .ds nm \\f2name\\f1
                     75: .SH NAME
                     76: \f4mailx\f1 \- interactive message processing system
                     77: .SH SYNOPSIS
                     78: \f4mailx\f1
                     79: [
                     80: .I options
                     81: ] [
                     82: .IR name \|.\|.\|.\|
                     83: ]
                     84: .SH DESCRIPTION
                     85: The command
                     86: \f4mailx\fP provides a comfortable, flexible environment for sending and
                     87: receiving messages electronically.
                     88: When reading mail,
                     89: \*(Ma provides commands to facilitate saving, deleting, and responding to
                     90: messages.
                     91: When sending mail,
                     92: \*(Ma allows editing, reviewing and other modification of the message
                     93: as it is entered.
                     94: .PP
                     95: Many of the remote features of \f4mailx\fP
                     96: work only if the Basic Networking Utilities are installed on your system.
                     97: .PP
                     98: Incoming mail is stored in a standard file for each user,
                     99: called the \*(mx for that user.
                    100: When \*(Ma is called to read messages,
                    101: the \*(mx is the default place to find them.
                    102: As messages are read,
                    103: they are marked to be moved to a secondary file for storage,
                    104: unless specific action is taken,
                    105: so that the messages need not be seen again.
                    106: This secondary file is called the \*(mb
                    107: and is normally located in the user's
                    108: \f4HOME\f1
                    109: directory
                    110: [see 
                    111: .Ev MBOX
                    112: (\*(EV) for a description of this file].
                    113: Messages can be saved in other secondary files named by the user.
                    114: Messages remain in a secondary file until forcibly removed.
                    115: .PP
                    116: The user can access a secondary file by using the 
                    117: \f4\-f\f1 option of the \*(Ma command.
                    118: Messages in the secondary file can then be read or otherwise
                    119: processed using the same \*(CM as in the primary \*(mx.
                    120: This gives rise within these pages to the notion of a current \*(mx.
                    121: .PP
                    122: On the command line,
                    123: .I options
                    124: start with a dash (\-) and any other arguments are taken to be
                    125: destinations (recipients).
                    126: If no recipients are specified,
                    127: \*(Ma attempts to read messages from the \*(mx.
                    128: Command-line options are:
                    129: .PP
                    130: .RS
                    131: .TP 14
                    132: \f4\-d\f1
                    133: Turn on debugging output.
                    134: .TP
                    135: \f4\-e\f1
                    136: Test for presence of mail.
                    137: \f4mailx\fP prints nothing and exits with a successful return code if there is
                    138: mail to read.
                    139: .TP
                    140: \f4\-f\f1 [\*(fn]
                    141: Read messages from \*(fn instead of \*(mx.
                    142: If no \*(fn is specified,
                    143: the \*(mb is used.
                    144: .TP
                    145: \f4\-F\f1
                    146: Record the message in a file named after the first recipient.
                    147: Overrides the
                    148: .Ev record
                    149: variable, if set (see \*(EV).
                    150: .TP
                    151: \f4\-h\f1 \*(nu
                    152: The number of network ``hops'' made so far.
                    153: This is provided for network
                    154: software to avoid infinite delivery loops.
                    155: This option and its argument is passed to the delivery program.
                    156: .TP
                    157: \f4\-H\f1
                    158: Print header summary only.
                    159: .TP
                    160: \f4\-i\f1
                    161: Ignore interrupts.
                    162: See also
                    163: .Ev ignore
                    164: (\*(EV).
                    165: .TP
                    166: \f4\-I\f1
                    167: Include the newsgroup and article-id header lines when printing mail
                    168: messages.
                    169: This option requires the \f4\-f\f1 option to be specified.
                    170: .TP
                    171: \f4\-n\f1
                    172: Do not initialize from the system default
                    173: .I mailx.rc
                    174: file.
                    175: .TP
                    176: \f4\-N\f1
                    177: Do not print initial header summary.
                    178: .TP
                    179: \f4\-r\f2 address\f1
                    180: Use
                    181: .I address
                    182: as the return address when invoking the delivery program.
                    183: All tilde commands are disabled.
                    184: This option and its argument is passed to the delivery program.
                    185: .TP
                    186: \f4\-s\f2 subject\f1
                    187: Set the Subject header field to
                    188: .IR subject .
                    189: .TP
                    190: \f4\-T\f2 file\f1
                    191: Message-id and article-id header lines are recorded in \f2file\f1 after the
                    192: message is read.
                    193: This option will also set the \f4\-I\f1 option.
                    194: .TP
                    195: \f4\-u\f2 user\f1
                    196: Read
                    197: .IR user 's
                    198: \*(mx.
                    199: This is only effective if
                    200: .IR user 's
                    201: \*(mx is not read protected.
                    202: .TP
                    203: \f4\-U\f1
                    204: Convert \f4uucp\fP style addresses to internet standards.
                    205: Overrides the
                    206: .Ev conv
                    207: environment variable.
                    208: .TP
                    209: \f4\-V\f1
                    210: Print the \*(Ma version number and exit.
                    211: .RE
                    212: .PP
                    213: When reading mail,
                    214: \*(Ma is in
                    215: \f2command mode\f1.
                    216: A header summary of the first several messages is displayed,
                    217: followed by a prompt indicating \*(Ma can accept regular commands
                    218: (see \*(CM below).
                    219: When sending mail,
                    220: \*(Ma is in
                    221: \f2input mode\f1.
                    222: If no subject is specified on the command line,
                    223: a prompt for the subject is printed.
                    224: (A subject longer than 1024 characters causes \*(Ma to print the
                    225: message \f2mail: ERROR signal 10\fP; the mail will not be delivered.)
                    226: As the message is typed,
                    227: \*(Ma reads the message and store it in a temporary
                    228: file.
                    229: Commands may be entered by beginning a line with the tilde (~) escape
                    230: character followed by a single command letter and optional arguments.
                    231: See \*(TX for a summary of these commands.
                    232: .PP
                    233: At any time,
                    234: the behavior of \*(Ma is governed by a set of
                    235: \f2environment variables\f1.
                    236: These are flags and valued parameters which are set and cleared via the
                    237: \f4se\f1t
                    238: and
                    239: \f4uns\f1et
                    240: commands.
                    241: See \*(EV below for a summary of these parameters.
                    242: .PP
                    243: Recipients listed on the command line may be of three types:
                    244: login names,
                    245: shell commands,
                    246: or
                    247: alias groups.
                    248: Login names may be any network address,
                    249: including mixed network addressing.
                    250: If mail is found to be undeliverable, an attempt is
                    251: made to return it to the sender's \f2mailbox\f1.
                    252: If the recipient name begins with a pipe symbol ( | ),
                    253: the rest of the name is taken to be a shell command to pipe the
                    254: message through.
                    255: This provides an automatic interface with any program that reads the standard
                    256: input, such as
                    257: \f4lp\fP(1)
                    258: for recording outgoing mail on paper.
                    259: Alias groups are set by the
                    260: \f4a\f1lias
                    261: command (see \*(CM below)
                    262: and are lists of recipients of any type.
                    263: .PP
                    264: Regular commands are of the form
                    265: .PP
                    266: .RS
                    267: [
                    268: .I command
                    269: ] [
                    270: .I msglist
                    271: ] [
                    272: .I arguments
                    273: ]
                    274: .RE
                    275: .PP
                    276: If no command is specified in \f2command mode\f1,
                    277: \f4p\f1rint
                    278: is assumed.
                    279: In \f2input mode\f1,
                    280: commands are recognized by the escape character,
                    281: and lines not treated as commands are taken as input for the message.
                    282: .PP
                    283: Each message is assigned a sequential number,
                    284: and there is at any time the notion of a current message,
                    285: marked by a right angle bracket (>) in the header summary.
                    286: Many commands take an optional list of messages
                    287: (\*(ml) to operate on. 
                    288: The default for \f2msglist\f1 is the current message.
                    289: A \*(ml is a list of message identifiers separated by spaces,
                    290: which may include:
                    291: .PP
                    292: .RS
                    293: .TP 8
                    294: \f4n\f1
                    295: Message number
                    296: \f4n\f1.
                    297: .TP
                    298: \f4\&.\f1
                    299: The current message.
                    300: .TP
                    301: \f4^\f1
                    302: The first undeleted message.
                    303: .TP
                    304: \f4$\f1
                    305: The last message.
                    306: .TP
                    307: \f4*\f1
                    308: All messages.
                    309: .TP
                    310: \f4n\-m\f1
                    311: An inclusive range of message numbers.
                    312: .TP
                    313: \f4user\f1
                    314: All messages from
                    315: \f4user\f1.
                    316: .TP
                    317: \f4/string\f1
                    318: All messages with
                    319: \f4string\f1
                    320: in the subject line (case ignored).
                    321: .TP
                    322: \f4:\f2c\f1
                    323: All messages of type
                    324: .IR c ,
                    325: where
                    326: .I c
                    327: is one of:
                    328: .RS 13
                    329: .TP
                    330: \f4d\f1
                    331: deleted messages
                    332: .TP
                    333: \f4n\f1
                    334: new messages
                    335: .TP
                    336: \f4o\f1
                    337: old messages
                    338: .TP
                    339: \f4r\f1
                    340: read messages
                    341: .TP
                    342: \f4u\f1
                    343: unread messages
                    344: .RE 0
                    345: .RS 13
                    346: Note that the context of the command determines whether this type of
                    347: message specification makes sense.
                    348: .RE
                    349: .PP
                    350: Other arguments are usually arbitrary strings whose usage
                    351: depends on the command involved.
                    352: File names,
                    353: where expected,
                    354: are expanded via the normal shell conventions [see
                    355: \f4sh\fP(1)].
                    356: Special characters are recognized by certain commands and are
                    357: documented with the commands below.
                    358: .PP
                    359: At start-up time,
                    360: \*(Ma tries to execute commands from the optional system-wide file
                    361: (\f4/etc/mail/mailx.rc\f1) to initialize
                    362: certain parameters,
                    363: then from a private start-up file
                    364: \f1(\f4$HOME/.mailrc\f1)
                    365: for personalized variables.
                    366: With the exceptions noted below, 
                    367: regular commands are legal inside start-up files.
                    368: The most common use of a start-up file is 
                    369: to set up initial display options and alias lists.
                    370: The following commands are not legal in the start-up file:
                    371: \f4!\f1,
                    372: \f4C\f1opy,
                    373: \f4e\f1dit,
                    374: \f4fo\f1llowup,
                    375: \f4F\f1ollowup,
                    376: \f4ho\f1ld,
                    377: \f4m\f1ail,
                    378: \f4pre\f1serve,
                    379: \f4r\f1eply,
                    380: \f4R\f1eply,
                    381: \f4sh\f1ell,
                    382: and
                    383: \f4v\f1isual.
                    384: An error in the start-up file causes the remaining lines in the file to
                    385: be ignored.
                    386: The \*(mr file is optional, and must be constructed locally.
                    387: .SS \*(CM
                    388: The following is a complete list of \*(Ma commands:
                    389: .PP
                    390: .Cm ! \*(sh
                    391: Escape to the shell.
                    392: See
                    393: .Ev SHELL
                    394: (\*(EV).
                    395: .Cm # "" \f2comment\f1
                    396: Null command (comment).
                    397: This may be useful in \*(mr files.
                    398: .Cm =
                    399: Print the current message number.
                    400: .Cm ?
                    401: Prints a summary of commands.
                    402: .Cm a lias \*(al \*(nm ...
                    403: .C g roup \*(al \*(nm ...
                    404: Declare an alias for the given names.
                    405: The names are substituted
                    406: when
                    407: \*(al is used as a recipient.
                    408: Useful in the \*(mr file.
                    409: .Cm alt ernates \*(nm ...
                    410: Declares a list of alternate names for your login.
                    411: When responding to a message,
                    412: these names are removed from the list of recipients for the response.
                    413: With no arguments,
                    414: \f4alt\f1ernates
                    415: prints the current list of alternate names.
                    416: See also
                    417: .Ev allnet
                    418: (\*(EV).
                    419: .Cm cd "" [\*(dr]
                    420: .C ch dir [\*(dr]
                    421: Change directory.
                    422: If \*(dr is not specified,
                    423: \f4$HOME\f1
                    424: is used.
                    425: .Cm c opy [\*(fn]
                    426: .C c opy \*(om \*(fn
                    427: Copy messages to the file without marking the messages as saved.
                    428: Otherwise equivalent to the
                    429: \f4s\f1ave
                    430: command.
                    431: .Cm C opy \*(om
                    432: Save the specified messages in a file whose name is derived from the
                    433: author of the
                    434: message to be saved, without marking the messages as saved.
                    435: Otherwise equivalent to the
                    436: \f4S\f1ave
                    437: command.
                    438: .Cm d elete \*(om
                    439: Delete messages from the \*(mx.
                    440: If
                    441: .Ev autoprint
                    442: is set,
                    443: the next message after the last one deleted is printed
                    444: (see \*(EV).
                    445: .Cm di scard [\*(hf ...]
                    446: .C ig nore [\*(hf ...]
                    447: Suppresses printing of the specified header fields when displaying messages
                    448: on the screen.
                    449: Examples of header fields to ignore are
                    450: \f4status\f1
                    451: and
                    452: \f4cc\f1.
                    453: The fields are included when the message is saved.
                    454: The
                    455: \f4P\f1rint
                    456: and
                    457: \f4T\f1ype
                    458: commands override this command.
                    459: If no header is specified, the current list of header fields being ignored
                    460: will be printed.
                    461: See also the \f4undi\f1scard and \f4unig\f1nore commands.
                    462: .Cm dp "" \*(om
                    463: .C dt "" \*(om
                    464: Delete the specified messages from the \*(mx and print the next message
                    465: after the last one deleted.
                    466: Roughly equivalent to a
                    467: \f4d\f1elete
                    468: command followed by a
                    469: \f4p\f1rint
                    470: command.
                    471: .Cm ec ho \*(st ...
                    472: Echo the given strings [like
                    473: \f4echo\fP(1)].
                    474: .Cm e dit \*(om
                    475: Edit the given messages.
                    476: The messages are placed in a temporary file and the
                    477: .Ev EDITOR
                    478: variable
                    479: is used to get the name of the editor
                    480: (see \*(EV).
                    481: Default editor is
                    482: \f4ed\fP(1).
                    483: .Cm ex it
                    484: .C x it
                    485: Exit from \*(Ma,
                    486: without changing the \*(mx.
                    487: No messages are saved in the \*(mb (see also
                    488: \f4q\f1uit).
                    489: .Cm fi le [\*(fn]
                    490: .C fold er [\*(fn]
                    491: Quit from the current file of messages and read in the specified file.
                    492: Several special characters are recognized when used as file names,
                    493: with the following substitutions:
                    494: .RS 10
                    495: .TP 10
                    496: \f4%\f1
                    497: the current \*(mx.
                    498: .TP
                    499: \f4%\f2user\f1
                    500: the \*(mx for
                    501: .IR user .
                    502: .TP
                    503: \f4#\f1
                    504: the previous file.
                    505: .TP
                    506: \f4&\f1
                    507: the current \*(mb.
                    508: .RE
                    509: .RS 5
                    510: Default file is the current \*(mx.
                    511: .RE
                    512: .Cm folders
                    513: Print the names of the files in the
                    514: directory set by the
                    515: .Ev folder
                    516: variable
                    517: (see \*(EV).
                    518: .Cm fo llowup [\*(ms]
                    519: Respond to a message,
                    520: recording the response in a file whose name is derived from the
                    521: author of the message.
                    522: Overrides the
                    523: .Ev record
                    524: variable, if set.
                    525: See also the
                    526: \f4F\f1ollowup,
                    527: \f4S\f1ave,
                    528: and
                    529: \f4C\f1opy
                    530: commands and
                    531: .Ev outfolder
                    532: (\*(EV).
                    533: .Cm F ollowup \*(om
                    534: Respond to the first message in the \*(ml,
                    535: sending the message to the author of each message in the \*(ml.
                    536: The subject line is taken from the first message
                    537: and the response is recorded in a file whose name is derived
                    538: from the author of the first message.
                    539: See also the
                    540: \f4fo\f1llowup,
                    541: \f4S\f1ave,
                    542: and
                    543: \f4C\f1opy
                    544: commands
                    545: and
                    546: .Ev outfolder
                    547: (\*(EV).
                    548: .Cm f rom \*(om
                    549: Prints the header summary for the specified messages.
                    550: .Cm g roup \*(al \*(nm ...
                    551: .C a lias \*(al \*(nm ...
                    552: Declare an alias for the given names.
                    553: The names are substituted
                    554: when
                    555: \*(al is used as a recipient.
                    556: Useful in the \*(mr file.
                    557: .Cm h eaders [\*(ms]
                    558: Prints the page of headers which includes the message specified.
                    559: The
                    560: .Ev screen
                    561: variable sets the number of headers per page
                    562: (see \*(EV).
                    563: See also the
                    564: \f4z\f1
                    565: command.
                    566: .Cm hel p
                    567: Prints a summary of commands.
                    568: .Cm ho ld \*(om
                    569: .C pre serve \*(om
                    570: Holds the specified messages in the \*(mx.
                    571: .Cm i f \f2s\f1 | \f2r\f1
                    572: .C "" \*(mCs
                    573: .C el se
                    574: .C "" \*(mCs
                    575: .C en dif
                    576: Conditional execution, where
                    577: .I s
                    578: executes following \*(mCs, up to an
                    579: \f4el\f1se
                    580: or
                    581: \f4en\f1dif,
                    582: if the program is in
                    583: .I send
                    584: mode, and
                    585: .I r
                    586: causes the \*(mCs to be executed only in
                    587: .I receive
                    588: mode.
                    589: Useful in the \*(mr file.
                    590: .Cm ig nore [\*(hf ...]
                    591: .C di scard [\*(hf ...]
                    592: Suppresses printing of the specified header fields when displaying messages
                    593: on the screen.
                    594: Examples of header fields to ignore are
                    595: \f4status\f1
                    596: and
                    597: \f4cc\f1.
                    598: All fields are included when the message is saved.
                    599: The
                    600: \f4P\f1rint
                    601: and
                    602: \f4T\f1ype
                    603: commands override this command.
                    604: If no header is specified, the current list of header fields being ignored
                    605: will be printed.
                    606: See also the \f4undi\f1scard and \f4unig\f1nore commands.
                    607: .Cm l ist
                    608: Prints all commands available.
                    609: No explanation is given.
                    610: .Cm m ail \*(nm ...
                    611: Mail a message to the specified users.
                    612: .Cm M ail \*(nm
                    613: Mail a message to the specified user and record a copy of it
                    614: in a file named after that user.
                    615: .Cm mb ox \*(om
                    616: Arrange for the given messages to end up in the standard \*(mb save file
                    617: when \*(Ma terminates normally.
                    618: See
                    619: .Ev MBOX
                    620: (\*(EV) for a description of this file.
                    621: See also the
                    622: \f4ex\f1it
                    623: and
                    624: \f4q\f1uit
                    625: commands.
                    626: .Cm n ext [\*(ms]
                    627: Go to next message matching \*(ms.
                    628: A \*(ml may be specified,
                    629: but in this case the first valid message in the list is the only one used.
                    630: This is useful for jumping to the next message from a specific user,
                    631: since the name would be taken as a command in the absence of a real command.
                    632: See the discussion of \*(mls above for a description of
                    633: possible message specifications.
                    634: .Cm pi pe \*(om [\*(sh]
                    635: .C | "" \*(om [\*(sh]
                    636: Pipe the message through the given \*(sh.
                    637: The message is treated as if it were read.
                    638: If no arguments are given,
                    639: the current message is piped through the command specified by the
                    640: value of the
                    641: .Ev cmd
                    642: variable.
                    643: If the
                    644: .Ev page
                    645: variable is set,
                    646: a form feed character is inserted after each message
                    647: (see \*(EV).
                    648: .Cm pre serve \*(om
                    649: .C ho ld \*(om
                    650: Preserve the specified messages in the \*(mx.
                    651: .Cm P rint \*(om
                    652: .C T ype \*(om
                    653: Print the specified messages on the screen,
                    654: including all header fields.
                    655: Overrides suppression of fields by the
                    656: \f4ig\f1nore
                    657: command.
                    658: .Cm p rint \*(om
                    659: .C t ype \*(om
                    660: Print the specified messages.
                    661: If
                    662: .Ev crt
                    663: is set,
                    664: the messages longer than the number of lines specified by the
                    665: .Ev crt
                    666: variable are paged through the command specified by the
                    667: .Ev PAGER
                    668: variable.
                    669: The default command is
                    670: \f4pg\fP(1)
                    671: (see \*(EV).
                    672: .Cm q uit
                    673: Exit from \*(Ma,
                    674: storing messages that were read in \*(mb and unread messages in the \*(mx.
                    675: Messages that have been explicitly saved in a file are deleted.
                    676: .Cm R eply \*(om
                    677: .C R espond \*(om
                    678: Send a response to the author of each message in the \*(ml.
                    679: The subject line is taken from the first message.
                    680: If
                    681: .Ev record
                    682: is set to a file name,
                    683: the response is saved at the end of that file (see \*(EV).
                    684: .Cm r eply [\*(ms]
                    685: .C r espond [\*(ms]
                    686: Reply to the specified message,
                    687: including all other recipients of the message.
                    688: If
                    689: .Ev record
                    690: is set to a file name,
                    691: the response is saved at the end of that file (see \*(EV).
                    692: .Cm S ave \*(om
                    693: Save the specified messages in a file whose name is derived from
                    694: the author of the first message.
                    695: The name of the file is taken to be the author's name with all
                    696: network addressing stripped off.
                    697: See also the
                    698: \f4C\f1opy,
                    699: \f4fo\f1llowup,
                    700: and
                    701: \f4F\f1ollowup
                    702: commands and
                    703: .Ev outfolder
                    704: (\*(EV).
                    705: .Cm s ave [\*(fn]
                    706: .C s ave \*(om \*(fn
                    707: Save the specified messages in the given file.
                    708: The file is created if it does not exist.
                    709: THe file defaults to \*(mb.
                    710: The message is deleted from the \*(mx when
                    711: \*(Ma terminates unless
                    712: .Ev keepsave
                    713: is set
                    714: (see also \*(EV and the
                    715: \f4ex\f1it
                    716: and
                    717: \f4q\f1uit
                    718: commands).
                    719: .Cm se t
                    720: .C se t \*(nm
                    721: .C se t \*(nm=\*(st
                    722: .C se t \*(nm=\*(nu
                    723: Define a variable called \*(nm.
                    724: The variable may be given a null, string, or numeric value.
                    725: \f4Se\f1t
                    726: by itself prints all defined variables and their values.
                    727: See \*(EV for detailed descriptions of the \*(Ma variables.
                    728: .Cm sh ell
                    729: Invoke an interactive shell [see also
                    730: .Ev SHELL
                    731: (\*(EV)].
                    732: .Cm si ze \*(om
                    733: Print the size in characters of the specified messages.
                    734: .Cm so urce \*(fn
                    735: Read commands from the given file and return to command mode.
                    736: .Cm to p \*(om
                    737: Print the top few lines of the specified messages.
                    738: If the
                    739: .Ev toplines
                    740: variable is set,
                    741: it is taken as the number of lines to print
                    742: (see \*(EV).
                    743: The default is 5.
                    744: .Cm tou ch \*(om
                    745: Touch the specified messages.
                    746: If any message in \*(ml is not specifically saved in a file,
                    747: it is placed in the \*(mb,
                    748: or the file specified in the
                    749: .Ev MBOX
                    750: environment variable, upon normal termination.
                    751: See
                    752: \f4ex\f1it
                    753: and
                    754: \f4q\f1uit.
                    755: .Cm T ype \*(om
                    756: .C P rint \*(om
                    757: Print the specified messages on the screen,
                    758: including all header fields.
                    759: Overrides suppression of fields by the
                    760: \f4ig\f1nore
                    761: command.
                    762: .Cm t ype \*(om
                    763: .C p rint \*(om
                    764: Print the specified messages.
                    765: If
                    766: .Ev crt
                    767: is set,
                    768: the messages longer than the number of lines specified by the
                    769: .Ev crt
                    770: variable are paged through the command specified by the
                    771: .Ev PAGER
                    772: variable.
                    773: The default command is
                    774: \f4pg\fP(1)
                    775: (see \*(EV).
                    776: .Cm u ndelete \*(om
                    777: Restore the specified deleted messages.
                    778: Will only restore messages deleted in the current mail session.
                    779: If
                    780: .Ev autoprint
                    781: is set, the last message of those restored is printed
                    782: (see \*(EV).
                    783: .Cm undi scard \*(hf ...
                    784: .C unig nore \*(hf ...
                    785: Remove the specified header fields from the list being ignored.
                    786: .Cm uns et \*(nm ...
                    787: Causes the specified variables to be erased.
                    788: If the variable was imported from the execution environment (i.e., a
                    789: shell variable) then it cannot be erased.
                    790: .Cm ve rsion
                    791: Prints the current version.
                    792: .Cm v isual \*(om
                    793: Edit the given messages with a screen editor.
                    794: The messages are placed in a temporary file and the
                    795: .Ev VISUAL
                    796: variable
                    797: is used to get the name of the editor
                    798: (see \*(EV).
                    799: .Cm w rite \*(om \*(fn
                    800: Write the given messages on the specified file,
                    801: minus the header and trailing blank line.
                    802: Otherwise equivalent to the
                    803: \f4s\f1ave
                    804: command.
                    805: .Cm x it
                    806: .C ex it
                    807: Exit from \*(Ma,
                    808: without changing the \*(mx.
                    809: No messages are saved in the \*(mb (see also
                    810: \f4q\f1uit).
                    811: .Cm z [+ | \-]
                    812: Scroll the header display forward or backward one screen\-full.
                    813: The number of headers displayed is set by the
                    814: .Ev screen
                    815: variable
                    816: (see \*(EV).
                    817: .SS \*(TX
                    818: The following commands may be entered only from
                    819: \f2input mode\f1,
                    820: by beginning a line with the tilde escape character (~).
                    821: See
                    822: .Ev escape
                    823: (\*(EV)
                    824: for changing this special character.
                    825: .PP
                    826: .Ti ! \*(sh
                    827: Escape to the shell.
                    828: .Ti .
                    829: Simulate end of file (terminate message input).
                    830: .Ti : \*(mC
                    831: .PD 0
                    832: .Ti _\  \*(mC
                    833: .PD
                    834: Perform the command-level request.
                    835: Valid only when sending a message while reading mail.
                    836: .Ti ?
                    837: Print a summary of tilde escapes.
                    838: .Ti A
                    839: Insert the autograph string
                    840: .Ev Sign
                    841: into the message
                    842: (see \*(EV).
                    843: .Ti a
                    844: Insert the autograph string
                    845: .Ev sign
                    846: into the message
                    847: (see \*(EV).
                    848: .Ti b \*(nms ...
                    849: Add the \*(nms to the blind carbon copy (Bcc) list.
                    850: .Ti c \*(nms ...
                    851: Add the \*(nms to the carbon copy (Cc) list.
                    852: .Ti d
                    853: Read in the \*(dl file.
                    854: See
                    855: .Ev DEAD
                    856: (\*(EV) for a description of this file.
                    857: .Ti e
                    858: Invoke the editor on the partial message.
                    859: See also
                    860: .Ev EDITOR
                    861: (\*(EV).
                    862: .Ti f \*(om
                    863: Forward the specified messages.
                    864: The messages are inserted into the message
                    865: without alteration.
                    866: .Ti h
                    867: Prompt for Subject line and To, Cc, and Bcc lists.
                    868: If the field is displayed with an initial value,
                    869: it may be edited as if you had just typed it.
                    870: .Ti i \*(st
                    871: Insert the value of the named variable into the text of the message.
                    872: For example,
                    873: \f4~A\f1
                    874: is equivalent to
                    875: \f1'\f4~i\f1\\f4Sign.'\f1
                    876: Environment variables set and exported in the shell are also
                    877: accessible by ~i.
                    878: .Ti m \*(om
                    879: Insert the specified messages into the letter,
                    880: shifting the new text to the right one tab stop.
                    881: Valid only when sending a message while reading mail.
                    882: .Ti p
                    883: Print the message being entered.
                    884: .Ti q
                    885: Quit from input mode by simulating an interrupt.
                    886: If the body of the message is not null,
                    887: the partial message is saved in \*(dl.
                    888: See
                    889: .Ev DEAD
                    890: (\*(EV) for a description of this file.
                    891: .Ti r \*(fn
                    892: .PD 0
                    893: .Ti <\  \*(fn
                    894: .Ti <\  !\*(sh
                    895: .PD
                    896: Read in the specified file.
                    897: If the argument begins with an exclamation point (!),
                    898: the rest of the string is taken as an arbitrary shell command
                    899: and is executed,
                    900: with the standard output inserted into the message.
                    901: .Ti s \*(st ...
                    902: Set the subject line to \*(st.
                    903: .Ti t \*(nms ...
                    904: Add the given \*(nms to the To list.
                    905: .Ti v
                    906: Invoke a preferred screen editor on the partial message.
                    907: See also
                    908: .Ev VISUAL
                    909: (\*(EV).
                    910: .Ti w \*(fn
                    911: Write the message into the given file,
                    912: without the header.
                    913: .Ti x
                    914: Exit as with
                    915: \f4~q\f1
                    916: except the message is not saved in \*(dl.
                    917: .Ti | \*(sh
                    918: Pipe the body of the message through the given \*(sh.
                    919: If the \*(sh returns a successful exit status,
                    920: the output of the command replaces the message.
                    921: .SS \*(EV
                    922: The following are environment variables taken from the execution environment and
                    923: are not alterable within \*(Ma.
                    924: .Va \s-1HOME\s+1 \*(dr
                    925: The user's base of operations.
                    926: .Va \s-1MAILRC\s+1 \*(fn
                    927: The name of the start-up file.
                    928: Default is
                    929: \f4$HOME/.mailrc\f1.
                    930: .PP
                    931: The following variables are internal \*(Ma variables.
                    932: They may be imported from the execution environment or
                    933: set via the
                    934: \f4se\f1t
                    935: command at any time.
                    936: The
                    937: \f4uns\f1et
                    938: command may be used to erase variables.
                    939: .PP
                    940: .V allnet
                    941: All network names whose last component (login name) match are treated as
                    942: identical.
                    943: This causes the \*(ml message specifications to behave similarly.
                    944: Default is
                    945: \f4noallnet\f1.
                    946: See also the
                    947: \f4alt\f1ernates
                    948: command and the
                    949: .Ev metoo
                    950: variable.
                    951: .V append
                    952: Upon termination, append messages to the end of the \*(mb file instead of prepending them.
                    953: Default is
                    954: \f4noappend.\f1
                    955: .V askcc
                    956: Prompt for the Cc list after the Subject is entered.
                    957: Default is
                    958: \f4noaskcc\f1.
                    959: .V askbcc
                    960: Prompt for the Bcc list after the Subject is entered.
                    961: Default is
                    962: \f4noaskbcc\f1.
                    963: .V asksub
                    964: Prompt for subject if it is not specified on the command line
                    965: with the
                    966: \f4\-s\f1
                    967: option.
                    968: Enabled by default.
                    969: .V autoprint
                    970: Enable automatic printing of messages after
                    971: \f4d\f1elete
                    972: and
                    973: \f4u\f1ndelete
                    974: commands.
                    975: Default is
                    976: \f4noautoprint\f1.
                    977: .V bang
                    978: Enable the special-casing of exclamation points (!) in shell escape
                    979: command lines
                    980: as in
                    981: \f4vi\fP(1).
                    982: Default is
                    983: \f4nobang\f1.
                    984: .Va cmd \*(sh
                    985: Set the default command for the
                    986: \f4pi\f1pe
                    987: command.
                    988: No default value.
                    989: .Va conv \f2conversion\f1
                    990: Convert uucp addresses to the specified
                    991: address style.
                    992: The only valid conversion now is
                    993: \f4internet\f1,
                    994: which uses domain-style addressing.
                    995: Conversion is disabled by default.
                    996: See also the
                    997: \f4\-U\f1
                    998: command-line option.
                    999: .Va crt \*(nu
                   1000: Pipe messages having more than \f2number\f1 lines
                   1001: through the command specified by the value of the
                   1002: .Ev PAGER
                   1003: variable
                   1004: .RI 
                   1005: [\f4pg\f1(1) by default].
                   1006: Disabled by default.
                   1007: .Va DEAD \*(fn
                   1008: The name of the file in which to save partial letters
                   1009: in case of untimely interrupt. 
                   1010: Default is
                   1011: \f4$HOME/dead.letter\f1.
                   1012: .V debug
                   1013: Enable verbose diagnostics for debugging.
                   1014: Messages are not delivered.
                   1015: Default is
                   1016: \f4nodebug\f1.
                   1017: .V dot
                   1018: Take a period on a line by itself during input from a terminal as end-of-file.
                   1019: Default is
                   1020: \f4nodot\f1.
                   1021: .Va EDITOR \*(sh
                   1022: The command to run when the
                   1023: \f4e\f1dit
                   1024: or
                   1025: \f4~e\f1
                   1026: command is used.
                   1027: Default is
                   1028: \f4ed\fP(1).
                   1029: .Va escape \f2c\f1
                   1030: Substitute
                   1031: .I c
                   1032: for the ~ escape character.
                   1033: Takes effect with next message sent.
                   1034: .Va folder \*(dr
                   1035: The directory for saving standard mail files.
                   1036: User-specified file names beginning with a plus (+)
                   1037: are expanded by preceding the file name with
                   1038: this directory name to obtain the real file name.
                   1039: If \*(dr does not start with a slash (/),
                   1040: \f4$HOME\f1
                   1041: is prepended to it.
                   1042: In order to use the plus (+) construct on a
                   1043: \*(Ma command line,
                   1044: .Ev folder
                   1045: must be an exported
                   1046: \f4sh\fP
                   1047: environment variable.
                   1048: There is no default for the
                   1049: .Ev folder
                   1050: variable.
                   1051: See also
                   1052: .Ev outfolder
                   1053: below.
                   1054: .V header
                   1055: Enable printing of the header summary when entering \*(Ma.
                   1056: Enabled by default.
                   1057: .V hold
                   1058: Preserve all messages that are read in the \*(mx instead of putting them
                   1059: in the standard \*(mb save file.
                   1060: Default is
                   1061: \f4nohold\f1.
                   1062: .V ignore
                   1063: Ignore interrupts while entering messages.
                   1064: Handy for noisy dial-up lines.
                   1065: Default is
                   1066: \f4noignore\f1.
                   1067: .V ignoreeof
                   1068: Ignore end-of-file during message input.
                   1069: Input must be terminated by a period (.) on a line by itself
                   1070: or by the
                   1071: \f4~.\f1
                   1072: command.
                   1073: Default is
                   1074: \f4noignoreeof\f1.
                   1075: See also
                   1076: .Ev dot
                   1077: above.
                   1078: .V keep
                   1079: When the \*(mx is empty,
                   1080: truncate it to zero length instead of removing it.
                   1081: Disabled by default.
                   1082: .V keepsave
                   1083: Keep messages that have been saved in other files in the \*(mx
                   1084: instead of deleting them.
                   1085: Default is
                   1086: \f4nokeepsave\f1.
                   1087: .Va \s-1MBOX\s+1 \*(fn
                   1088: The name of the file to save messages which have been read.
                   1089: The
                   1090: \f4x\f1it
                   1091: command overrides this function,
                   1092: as does saving the message explicitly in another file.
                   1093: Default is
                   1094: \f4$HOME/mbox\f1.
                   1095: .V metoo
                   1096: If your login appears as a recipient,
                   1097: do not delete it from the list.
                   1098: Default is
                   1099: \f4nometoo\f1.
                   1100: .Va \s-1LISTER\s+1 \*(sh
                   1101: The command (and options) to use when listing the contents of the
                   1102: .Ev folder
                   1103: directory.
                   1104: The default is
                   1105: \f4ls\fP(1).
                   1106: .V onehop
                   1107: When responding to a message that was originally sent to several
                   1108: recipients,
                   1109: the other recipient addresses are normally forced to be relative to the
                   1110: originating author's machine for the response.
                   1111: This flag disables alteration of the recipients' addresses,
                   1112: improving efficiency in a network where all machines can send directly
                   1113: to all other machines (i.e., one hop away).
                   1114: .V outfolder
                   1115: Causes the files used to record outgoing messages to be located
                   1116: in the directory specified by the
                   1117: .Ev folder
                   1118: variable unless the
                   1119: path name is absolute.
                   1120: Default is
                   1121: \f4nooutfolder\f1.
                   1122: See
                   1123: .Ev folder
                   1124: above and the
                   1125: \f4S\f1ave,
                   1126: \f4C\f1opy,
                   1127: \f4fo\f1llowup,
                   1128: and
                   1129: \f4F\f1ollowup
                   1130: commands.
                   1131: .V page
                   1132: Used with the
                   1133: \f4pi\f1pe
                   1134: command to insert a form feed after each message sent through the pipe.
                   1135: Default is
                   1136: \f4nopage\f1.
                   1137: .Va \s-1PAGER\s+1 \*(sh
                   1138: The command to use as a filter for paginating output.
                   1139: This can also be used to specify the options to be used.
                   1140: Default is
                   1141: \f4pg\fP(1).
                   1142: .Va prompt \*(st
                   1143: Set the \f2command mode\f1 prompt to \*(st.
                   1144: Default is
                   1145: \f1``\f4?\ \f1''.
                   1146: .V quiet
                   1147: Refrain from printing the opening message and version when entering \*(Ma.
                   1148: Default is
                   1149: \f4noquiet\f1.
                   1150: .Va record \*(fn
                   1151: Record all outgoing mail in \*(fn.
                   1152: Disabled by default.
                   1153: See also
                   1154: .Ev outfolder
                   1155: above.
                   1156: If you have the
                   1157: .Ev record
                   1158: and
                   1159: .Ev outfolder
                   1160: variables set but the
                   1161: .Ev folder
                   1162: variable not set, messages are saved in
                   1163: \f4+\f1\*(fn instead of \*(fn.
                   1164: .V save
                   1165: Enable saving of messages in \*(dl on interrupt or delivery error.
                   1166: See
                   1167: .Ev DEAD
                   1168: for a description of this file.
                   1169: Enabled by default.
                   1170: .Va screen \*(nu
                   1171: Sets the number of lines in a screen\-full of headers for the
                   1172: \f4h\f1eaders
                   1173: command.
                   1174: It must be a positive number.
                   1175: .Va sendmail \*(sh
                   1176: Alternate command for delivering messages.
                   1177: Default is
                   1178: \f4/usr/bin/rmail\f1.
                   1179: .V sendwait
                   1180: Wait for background mailer to finish before returning.
                   1181: Default is
                   1182: \f4nosendwait\f1.
                   1183: .Va SHELL \*(sh
                   1184: The name of a preferred command interpreter.
                   1185: Default is
                   1186: \f4sh\fP(1).
                   1187: .V showto
                   1188: When displaying the header summary and the message is from you,
                   1189: print the recipient's name instead of the author's name.
                   1190: .Va sign \*(st
                   1191: The variable inserted into the text of a message when the
                   1192: \f4~a\f1
                   1193: (autograph) command is given.
                   1194: No default
                   1195: [see also
                   1196: \f4~i\f1
                   1197: (\*(TX)].
                   1198: .Va Sign \*(st
                   1199: The variable inserted into the text of a message when the
                   1200: \f4~A\f1
                   1201: command is given.
                   1202: No default
                   1203: [see also
                   1204: \f4~i\f1
                   1205: (\*(TX)].
                   1206: .Va toplines \*(nu
                   1207: The number of lines of header to print with the
                   1208: \f4to\f1p
                   1209: command.
                   1210: Default is 5.
                   1211: .Va \s-1VISUAL\s+1 \*(sh
                   1212: The name of a preferred screen editor.
                   1213: Default is
                   1214: \f4vi\fP(1).
                   1215: .SH FILES
                   1216: .TS
                   1217: l l.
                   1218: \f4$HOME/.mailrc\f1    personal start-up file
                   1219: \f4$HOME/mbox\f1       secondary storage file
                   1220: \f4/var/mail/*\f1      post office directory
                   1221: \f4/usr/share/lib/mailx/mailx.help*\f1 help message files
                   1222: \f4/etc/mail/mailx.rc\f1       optional global start-up file
                   1223: \f4/tmp/R[emqsx]*\f1   temporary files
                   1224: .TE
                   1225: .SH SEE ALSO
                   1226: \f4ls\fP(1),
                   1227: \f4mail\fP(1),
                   1228: \f4pg\fP(1).
                   1229: .SH NOTES
                   1230: The \f4\-h\f1 and \f4\-r\f1 options can be used only
                   1231: if \*(Ma is using a delivery program other than
                   1232: \f4/usr/bin/rmail\f1.
                   1233: .PP
                   1234: Where \*(sh
                   1235: is shown as valid,
                   1236: arguments are not always allowed.
                   1237: Experimentation is recommended.
                   1238: .PP
                   1239: Internal variables imported from the execution environment cannot be
                   1240: \f4uns\f1et.
                   1241: .PP
                   1242: The full internet addressing is not fully supported by \*(Ma.
                   1243: The new standards need some time to settle down.
                   1244: .PP
                   1245: Attempts to send a message having a line consisting only of a ``.''
                   1246: are treated as the end of the message by \f4mail\fP(1) (the standard
                   1247: mail delivery program).
                   1248: .\"    @(#)mailx.1     6.2 of 9/2/83
                   1249: .Ee

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.