8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / cmd / sendmail / lib / helpfile
bloba37203bfc7af91b2aac279fbc2e3844b9eede081
1 #vers   2
2 cpyr
3 cpyr    Copyright (c) 1998-2000, 2002, 2004-2007 Sendmail, Inc. and its suppliers.
4 cpyr        All rights reserved.
5 cpyr    Copyright (c) 1983, 1995-1997 Eric P. Allman.  All rights reserved.
6 cpyr    Copyright (c) 1988, 1993
7 cpyr        The Regents of the University of California.  All rights reserved.
8 cpyr    Copyright 1994-2007 Sun Microsystems, Inc.  All rights reserved.
9 cpyr    Use is subject to license terms.
10 cpyr
11 cpyr
12 cpyr    ident   "%Z%%M% %I%     %E% SMI"
13 cpyr    $$Id: helpfile,v 8.48 2007/02/01 18:29:44 ca Exp $$
14 cpyr
15 smtp    This is sendmail version $v
16 smtp    Topics:
17 smtp            HELO    EHLO    MAIL    RCPT    DATA
18 smtp            RSET    NOOP    QUIT    HELP    VRFY
19 smtp            EXPN    VERB    ETRN    DSN     STARTTLS
20 smtp    For more info use "HELP <topic>".
21 smtp    To report bugs in the implementation contact Sun Microsystems
22 smtp    Technical Support.
23 smtp    For local information send email to Postmaster at your site.
24 help    HELP [ <topic> ]
25 help            The HELP command gives help info.
26 helo    HELO <hostname>
27 helo            Introduce yourself.
28 ehlo    EHLO <hostname>
29 ehlo            Introduce yourself, and request extended SMTP mode.
30 ehlo    Possible replies include:
31 ehlo            SEND            Send as mail                    [RFC821]
32 ehlo            SOML            Send as mail or terminal        [RFC821]
33 ehlo            SAML            Send as mail and terminal       [RFC821]
34 ehlo            EXPN            Expand the mailing list         [RFC821]
35 ehlo            HELP            Supply helpful information      [RFC821]
36 ehlo            TURN            Turn the operation around       [RFC821]
37 ehlo            8BITMIME        Use 8-bit data                  [RFC1652]
38 ehlo            SIZE            Message size declaration        [RFC1870]
39 ehlo            VERB            Verbose                         [Allman]
40 ehlo            CHUNKING        Chunking                        [RFC1830]
41 ehlo            BINARYMIME      Binary MIME                     [RFC1830]
42 ehlo            PIPELINING      Command Pipelining              [RFC1854]
43 ehlo            DSN             Delivery Status Notification    [RFC1891]
44 ehlo            ETRN            Remote Message Queue Starting   [RFC1985]
45 ehlo            STARTTLS        Secure SMTP                     [RFC2487]
46 ehlo            ENHANCEDSTATUSCODES     Enhanced status codes   [RFC2034]
47 ehlo            DELIVERBY       Deliver By                      [RFC2852]
48 mail    MAIL From:<sender> [ <parameters> ]
49 mail            Specifies the sender.  Parameters are ESMTP extensions.
50 mail            See "HELP DSN" for details.
51 rcpt    RCPT To:<recipient> [ <parameters> ]
52 rcpt            Specifies the recipient.  Can be used any number of times.
53 rcpt            Parameters are ESMTP extensions.  See "HELP DSN" for details.
54 data    DATA
55 data            Following text is collected as the message.
56 data            End with a single dot.
57 rset    RSET
58 rset            Resets the system.
59 quit    QUIT
60 quit            Exit sendmail (SMTP).
61 starttls        STARTTLS
62 starttls                Start TLS negotiation.
63 verb    VERB
64 verb            Go into verbose mode.  This sends 0xy responses that are
65 verb            not RFC821 standard (but should be)  They are recognized
66 verb            by humans and other sendmail implementations.
67 vrfy    VRFY <recipient>
68 vrfy            Verify an address.  If you want to see what it aliases
69 vrfy            to, use EXPN instead.
70 expn    EXPN <recipient>
71 expn            Expand an address.  If the address indicates a mailing
72 expn            list, return the contents of that list.
73 noop    NOOP
74 noop            Do nothing.
75 send    SEND FROM:<sender>
76 send            replaces the MAIL command, and can be used to send
77 send            directly to a users terminal.  Not supported in this
78 send            implementation.
79 soml    SOML FROM:<sender>
80 soml            Send or mail.  If the user is logged in, send directly,
81 soml            otherwise mail.  Not supported in this implementation.
82 saml    SAML FROM:<sender>
83 saml            Send and mail.  Send directly to the user's terminal,
84 saml            and also mail a letter.  Not supported in this
85 saml            implementation.
86 turn    TURN
87 turn            Reverses the direction of the connection.  Not currently
88 turn            implemented.
89 etrn    ETRN [ <hostname> | @<domain> | \#<queuename> ]
90 etrn            Run the queue for the specified <hostname>, or
91 etrn            all hosts within a given <domain>, or a specially-named
92 etrn            <queuename> (implementation-specific).
93 dsn     MAIL From:<sender> [ RET={ FULL | HDRS} ] [ ENVID=<envid> ]
94 dsn     RCPT To:<recipient> [ NOTIFY={NEVER,SUCCESS,FAILURE,DELAY} ]
95 dsn                          [ ORCPT=<recipient> ]
96 dsn             SMTP Delivery Status Notifications.
97 dsn     Descriptions:
98 dsn             RET     Return either the full message or only headers.
99 dsn             ENVID   Sender's "envelope identifier" for tracking.
100 dsn             NOTIFY  When to send a DSN. Multiple options are OK, comma-
101 dsn                     delimited. NEVER must appear by itself.
102 dsn             ORCPT   Original recipient.
103 -bt     Help for test mode:
104 -bt     ?                :this help message.
105 -bt     .Dmvalue         :define macro `m' to `value'.
106 -bt     .Ccvalue         :add `value' to class `c'.
107 -bt     =Sruleset        :dump the contents of the indicated ruleset.
108 -bt     =M               :display the known mailers.
109 -bt     -ddebug-spec     :equivalent to the command-line -d debug flag.
110 -bt     $$m              :print the value of macro $$m.
111 -bt     $$=c             :print the contents of class $$=c.
112 -bt     /mx host         :returns the MX records for `host'.
113 -bt     /parse address   :parse address, returning the value of crackaddr, and
114 -bt                       the parsed address.
115 -bt     /try mailer addr :rewrite address into the form it will have when
116 -bt                       presented to the indicated mailer.
117 -bt     /tryflags flags  :set flags used by parsing.  The flags can be `H' for
118 -bt                       Header or `E' for Envelope, and `S' for Sender or `R'
119 -bt                       for Recipient.  These can be combined, `HR' sets
120 -bt                       flags for header recipients.
121 -bt     /canon hostname  :try to canonify hostname.
122 -bt     /map mapname key :look up `key' in the indicated `mapname'.
123 -bt     /quit            :quit address test mode.
124 -bt     rules addr       :run the indicated address through the named rules.
125 -bt                       Rules can be a comma separated list of rules.
126 control Help for smcontrol:
127 control help            This message.
128 control restart         Restart sendmail.
129 control shutdown        Shutdown sendmail.
130 control status          Show sendmail status.
131 control mstat           Show sendmail status (machine readable format).
132 control memdump         Dump allocated memory list (for debugging only).