Annotation of 43BSD/usr.lib/sendmail/doc/sendmail.8, revision 1.1.1.1

1.1       root        1: .TH SENDMAIL 8
                      2: .\"    @(#)sendmail.8  4.3             12/27/83
                      3: .UC 4
                      4: .SH NAME
                      5: sendmail \- send mail over the internet
                      6: .SH SYNOPSIS
                      7: .B /usr/lib/sendmail
                      8: [
                      9: flags
                     10: ] [
                     11: address ...
                     12: ]
                     13: .PP
                     14: .B newaliases
                     15: .PP
                     16: .B mailq
                     17: .SH DESCRIPTION
                     18: .I Sendmail
                     19: sends a message to one or more people,
                     20: routing the message over whatever networks
                     21: are necessary.
                     22: .I Sendmail
                     23: does internetwork forwarding as necessary
                     24: to deliver the message to the correct place.
                     25: .PP
                     26: .I Sendmail
                     27: is not intended as a user interface routine;
                     28: other programs provide user-friendly
                     29: front ends;
                     30: .I sendmail
                     31: is used only to deliver pre-formatted messages.
                     32: .PP
                     33: With no flags,
                     34: .I sendmail
                     35: reads its standard input
                     36: up to a control-D
                     37: or a line with a single dot
                     38: and sends a copy of the letter found there
                     39: to all of the addresses listed.
                     40: It determines the network to use
                     41: based on the syntax and contents of the addresses.
                     42: .PP
                     43: Local addresses are looked up in a file
                     44: and aliased appropriately.
                     45: Aliasing can be prevented by preceding the address
                     46: with a backslash.
                     47: Normally the sender is not included in any alias
                     48: expansions, e.g.,
                     49: if `john' sends to `group',
                     50: and `group' includes `john' in the expansion,
                     51: then the letter will not be delivered to `john'.
                     52: .PP
                     53: Flags are:
                     54: .TP 1.2i
                     55: .B \-ba
                     56: Go into \s-1ARPANET\s0 mode.
                     57: All input lines must end with a CR-LF,
                     58: and all messages will be generated with a CR-LF at the end.
                     59: Also,
                     60: the ``From:'' and ``Sender:''
                     61: fields are examined for the name of the sender.
                     62: .TP 1.2i
                     63: .B \-bd
                     64: Run as a daemon.  This requires Berkeley IPC.
                     65: .TP 1.2i
                     66: .B \-bi
                     67: Initialize the alias database.
                     68: .TP 1.2i
                     69: .B \-bm
                     70: Deliver mail in the usual way (default).
                     71: .TP 1.2i
                     72: .B \-bp
                     73: Print a listing of the queue.
                     74: .TP 1.2i
                     75: .B \-bs
                     76: Use the \s-2SMTP\s0 protocol as described in RFC821.
                     77: This flag implies all the operations of the
                     78: .B \-ba
                     79: flag that are compatible with \s-2SMTP\s0.
                     80: .TP 1.2i
                     81: .B \-bt
                     82: Run in address test mode.
                     83: This mode reads addresses and shows the steps in parsing;
                     84: it is used for debugging configuration tables.
                     85: .TP 1.2i
                     86: .B \-bv
                     87: Verify names only \- do not try to collect or deliver a message.
                     88: Verify mode is normally used for validating
                     89: users or mailing lists.
                     90: .TP 1.2i
                     91: .B \-bz
                     92: Create the configuration freeze file.
                     93: .TP 1.2i
                     94: .BI \-C file
                     95: Use alternate configuration file.
                     96: .TP 1.2i
                     97: .BI \-d X
                     98: Set debugging value to
                     99: .I X.
                    100: .TP 1.2i
                    101: .BI \-F fullname
                    102: Set the full name of the sender.
                    103: .TP 1.2i
                    104: .BI \-f name
                    105: Sets the name of the ``from'' person
                    106: (i.e., the sender of the mail).
                    107: .B \-f
                    108: can only be used
                    109: by the special users
                    110: .I root,
                    111: .I daemon,
                    112: and
                    113: .I network,
                    114: or if the person you are trying to become
                    115: is the same as the person you are.
                    116: .TP 1.2i
                    117: .BI \-h N
                    118: Set the hop count to
                    119: .I N.
                    120: The hop count is incremented every time the mail is
                    121: processed.
                    122: When it reaches a limit,
                    123: the mail is returned with an error message,
                    124: the victim of an aliasing loop.
                    125: .TP 1.2i
                    126: .B \-n
                    127: Don't do aliasing.
                    128: .TP 1.2i
                    129: .BI \-o x\|value
                    130: Set option
                    131: .I x
                    132: to the specified
                    133: .I value.
                    134: Options are described below.
                    135: .TP 1.2i
                    136: .BI \-q[ time ]
                    137: Processed saved messages in the queue at given intervals.
                    138: If
                    139: .IT time
                    140: is omitted,
                    141: process the queue once.
                    142: .IT Time
                    143: is given as a tagged number,
                    144: with `s' being seconds,
                    145: `m' being minutes,
                    146: `h' being hours,
                    147: `d' being days,
                    148: and
                    149: `w' being weeks.
                    150: For example,
                    151: ``\-q1h30m'' or ``\-q90m''
                    152: would both set the timeout to one hour thirty minutes.
                    153: .TP 1.2i
                    154: .BI \-r name
                    155: An alternate and obsolete form of the
                    156: .B \-f
                    157: flag.
                    158: .TP 1.2i
                    159: .B \-t
                    160: Read message for recipients.
                    161: To:, Cc:, and Bcc: lines will be scanned for people to send to.
                    162: The Bcc: line will be deleted before transmission.
                    163: Any addresses in the argument list will be suppressed.
                    164: .TP 1.2i
                    165: .B \-v
                    166: Go into verbose mode.
                    167: Alias expansions will be announced, etc.
                    168: .PP
                    169: There are also a number of processing options that may be set.
                    170: Normally these will only be used by a system administrator.
                    171: Options may be set either on the command line
                    172: using the
                    173: .B \-o
                    174: flag
                    175: or in the configuration file.
                    176: These are described in detail in the
                    177: .ul
                    178: Installation and Operation Guide.
                    179: The options are:
                    180: .TP 1.2i
                    181: .RI A file
                    182: Use alternate alias file.
                    183: .TP 1.2i
                    184: c
                    185: On mailers that are considered ``expensive'' to connect to,
                    186: don't initiate immediate connection.
                    187: This requires queueing.
                    188: .TP 1.2i
                    189: .RI d x
                    190: Set the delivery mode to
                    191: .I x.
                    192: Delivery modes are
                    193: `i' for interactive (synchronous) delivery,
                    194: `b' for background (asynchronous) delivery,
                    195: and
                    196: `q' for queue only \- i.e.,
                    197: actual delivery is done the next time the queue is run.
                    198: .TP 1.2i
                    199: D
                    200: Try to automatically rebuild the alias database
                    201: if necessary.
                    202: .TP 1.2i
                    203: .RI e x
                    204: Set error processing to mode
                    205: .I x.
                    206: Valid modes are
                    207: `m' to mail back the error message,
                    208: `w' to ``write'' back the error message
                    209: (or mail it back if the sender is not logged in),
                    210: `p' to print the errors on the terminal
                    211: (default),
                    212: `q' to throw away error messages
                    213: (only exit status is returned),
                    214: and `e'
                    215: to do special processing for the BerkNet.
                    216: If the text of the message is not mailed back
                    217: by
                    218: modes `m' or `w'
                    219: and if the sender is local to this machine,
                    220: a copy of the message is appended to the file
                    221: ``dead.letter''
                    222: in the sender's home directory.
                    223: .TP 1.2i
                    224: .RI F mode
                    225: The mode to use when creating temporary files.
                    226: .TP 1.2i
                    227: f
                    228: Save UNIX-style From lines at the front of messages.
                    229: .TP 1.2i
                    230: .RI g N
                    231: The default group id to use when calling mailers.
                    232: .TP 1.2i
                    233: .RI H file
                    234: The SMTP help file.
                    235: .TP 1.2i
                    236: i
                    237: Do not take dots on a line by themselves
                    238: as a message terminator.
                    239: .TP 1.2i
                    240: .RI L n
                    241: The log level.
                    242: .TP 1.2i
                    243: m
                    244: Send to ``me'' (the sender) also if I am in an alias expansion.
                    245: .TP 1.2i
                    246: o
                    247: If set, this message may have
                    248: old style headers.
                    249: If not set,
                    250: this message is guaranteed to have new style headers
                    251: (i.e., commas instead of spaces between addresses).
                    252: If set, an adaptive algorithm is used that will correctly
                    253: determine the header format in most cases.
                    254: .TP 1.2i
                    255: .RI Q queuedir
                    256: Select the directory in which to queue messages.
                    257: .TP 1.2i
                    258: .RI r timeout
                    259: The timeout on reads;
                    260: if none is set,
                    261: .I sendmail
                    262: will wait forever for a mailer.
                    263: .TP 1.2i
                    264: .RI S file
                    265: Save statistics in the named file.
                    266: .TP 1.2i
                    267: s
                    268: Always instantiate the queue file,
                    269: even under circumstances where it is not strictly necessary.
                    270: .TP 1.2i
                    271: .RI T time
                    272: Set the timeout on messages in the queue to the specified time.
                    273: After sitting in the queue for this amount of time,
                    274: they will be returned to the sender.
                    275: The default is three days.
                    276: .TP 1.2i
                    277: .RI t stz,dtz
                    278: Set the name of the time zone.
                    279: .TP 1.2i
                    280: .RI u N
                    281: Set the default user id for mailers.
                    282: .PP
                    283: If the first character of the user name
                    284: is a vertical bar,
                    285: the rest of the user name is used as the name of a program
                    286: to pipe the mail to.
                    287: It may be necessary to quote the name of the user
                    288: to keep
                    289: .I sendmail
                    290: from suppressing the blanks from between arguments.
                    291: .PP
                    292: .I Sendmail
                    293: returns an exit status
                    294: describing what it did.
                    295: The codes are defined in
                    296: .RI < sysexits.h >
                    297: .ta 3n +\w'EX_UNAVAILABLE'u+3n
                    298: .de XX
                    299: .ti \n(.iu
                    300: ..
                    301: .in +\w'EX_UNAVAILABLE'u+6n
                    302: .XX
                    303:        EX_OK   Successful completion on all addresses.
                    304: .XX
                    305:        EX_NOUSER       User name not recognized.
                    306: .XX
                    307:        EX_UNAVAILABLE  Catchall meaning necessary resources
                    308: were not available.
                    309: .XX
                    310:        EX_SYNTAX       Syntax error in address.
                    311: .XX
                    312:        EX_SOFTWARE     Internal software error,
                    313: including bad arguments.
                    314: .XX
                    315:        EX_OSERR        Temporary operating system error,
                    316: such as \*(lqcannot fork\*(rq.
                    317: .XX
                    318:        EX_NOHOST       Host name not recognized.
                    319: .XX
                    320:        EX_TEMPFAIL     Message could not be sent immediately,
                    321: but was queued.
                    322: .PP
                    323: If invoked as
                    324: .I newaliases,
                    325: .I sendmail
                    326: will rebuild the alias database.
                    327: If invoked as
                    328: .I mailq,
                    329: .I sendmail
                    330: will print the contents of the mail queue.
                    331: .SH FILES
                    332: Except for
                    333: /usr/lib/sendmail.cf,
                    334: these pathnames are all specified in
                    335: /usr/lib/sendmail.cf.
                    336: Thus,
                    337: these values are only approximations.
                    338: .PP
                    339: .if t .ta 2i
                    340: .if n .ta 3i
                    341: /usr/lib/aliases       raw data for alias names
                    342: .br
                    343: /usr/lib/aliases.pag
                    344: .br
                    345: /usr/lib/aliases.dir   data base of alias names
                    346: .br
                    347: /usr/lib/sendmail.cf   configuration file
                    348: .br
                    349: /usr/lib/sendmail.fc   frozen configuration
                    350: .br
                    351: /usr/lib/sendmail.hf   help file
                    352: .br
                    353: /usr/lib/sendmail.st   collected statistics
                    354: .br
                    355: /usr/bin/uux   to deliver uucp mail
                    356: .br
                    357: /usr/net/bin/v6mail    to deliver local mail
                    358: .br
                    359: /usr/net/bin/sendberkmail      to deliver Berknet mail
                    360: .br
                    361: /usr/lib/mailers/arpa  to deliver ARPANET mail
                    362: .br
                    363: /usr/spool/mqueue/*    temp files
                    364: .br
                    365: .SH SEE ALSO
                    366: biff(1),
                    367: binmail(1),
                    368: mail(1),
                    369: rmail(1),
                    370: aliases(5),
                    371: mailaddr(7);
                    372: .br
                    373: DARPA Internet Request For Comments
                    374: RFC819, RFC821, RFC822;
                    375: .br
                    376: .ul
                    377: Sendmail \- An Internetwork Mail Router;
                    378: .br
                    379: .ul
                    380: Sendmail Installation and Operation Guide.
                    381: .SH BUGS
                    382: .I Sendmail
                    383: converts blanks in addresses to dots.
                    384: This is incorrect according to the
                    385: old
                    386: .SM ARPANET
                    387: mail protocol RFC733 (NIC 41952),
                    388: but is consistent with the
                    389: new protocols
                    390: (RFC822).

unix.superglobalmegacorp.com

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