Annotation of 43BSDReno/usr.sbin/sendmail/src/sendmail.8, revision 1.1.1.1

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

unix.superglobalmegacorp.com

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