contrib/sendmail/src/helpfile

   1 #vers   2
   2 cpyr
   3 cpyr    Copyright (c) 1998-2000, 2002, 2004-2007 Proofpoint, 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
   9 cpyr
  10 cpyr    By using this file, you agree to the terms and conditions set
  11 cpyr    forth in the LICENSE file which can be found at the top level of
  12 cpyr    the sendmail distribution.
  13 cpyr
  14 smtp    This is sendmail version $v
  15 smtp    Topics:
  16 smtp            HELO    EHLO    MAIL    RCPT    DATA
  17 smtp            RSET    NOOP    QUIT    HELP    VRFY
  18 smtp            EXPN    VERB    ETRN    DSN     AUTH
  19 smtp            STARTTLS
  20 smtp    For more info use "HELP <topic>".
  21 smtp    To report bugs in the implementation see
  22 smtp            http://www.sendmail.org/email-addresses.html
  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            BINARYMIME      Binary MIME                     [RFC1830]
  41 ehlo            PIPELINING      Command Pipelining              [RFC1854]
  42 ehlo            DSN             Delivery Status Notification    [RFC1891]
  43 ehlo            ETRN            Remote Message Queue Starting   [RFC1985]
  44 ehlo            STARTTLS        Secure SMTP                     [RFC2487]
  45 ehlo            AUTH            Authentication                  [RFC2554]
  46 ehlo            ENHANCEDSTATUSCODES     Enhanced status codes   [RFC2034]
  47 ehlo            DELIVERBY       Deliver By                      [RFC2852]
  48 ehlo            SMTPUTF8        Internationalized Email         [RFC6530]
  49 mail    MAIL From:<sender> [ <parameters> ]
  50 mail            Specifies the sender.  Parameters are ESMTP extensions.
  51 mail            See "HELP DSN" for details.
  52 rcpt    RCPT To:<recipient> [ <parameters> ]
  53 rcpt            Specifies the recipient.  Can be used any number of times.
  54 rcpt            Parameters are ESMTP extensions.  See "HELP DSN" for details.
  55 data    DATA
  56 data            Following text is collected as the message.
  57 data            End with a single dot on a line by itself.
  58 rset    RSET
  59 rset            Resets the system.
  60 quit    QUIT
  61 quit            Exit sendmail (SMTP).
  62 auth    AUTH mechanism [initial-response]
  63 auth            Start authentication.
  64 starttls        STARTTLS
  65 starttls                Start TLS negotiation.
  66 verb    VERB
  67 verb            Go into verbose mode.  This sends 0xy responses that are
  68 verb            not RFC821 standard (but should be).  They are recognized
  69 verb            by humans and other sendmail implementations.
  70 vrfy    VRFY <recipient>
  71 vrfy            Verify an address.  If you want to see what it aliases
  72 vrfy            to, use EXPN instead.
  73 expn    EXPN <recipient>
  74 expn            Expand an address.  If the address indicates a mailing
  75 expn            list, return the contents of that list.
  76 noop    NOOP
  77 noop            Do nothing.
  78 send    SEND FROM:<sender>
  79 send            replaces the MAIL command, and can be used to send
  80 send            directly to a users terminal.  Not supported in this
  81 send            implementation.
  82 soml    SOML FROM:<sender>
  83 soml            Send or mail.  If the user is logged in, send directly,
  84 soml            otherwise mail.  Not supported in this implementation.
  85 saml    SAML FROM:<sender>
  86 saml            Send and mail.  Send directly to the user's terminal,
  87 saml            and also mail a letter.  Not supported in this
  88 saml            implementation.
  89 turn    TURN
  90 turn            Reverses the direction of the connection.  Not currently
  91 turn            implemented.
  92 etrn    ETRN [ <hostname> | @<domain> | \#<queuename> ]
  93 etrn            Run the queue for the specified <hostname>, or
  94 etrn            all hosts within a given <domain>, or a specially-named
  95 etrn            <queuename> (implementation-specific).
  96 dsn     MAIL From:<sender> [ RET={ FULL | HDRS} ] [ ENVID=<envid> ]
  97 dsn     RCPT To:<recipient> [ NOTIFY={NEVER,SUCCESS,FAILURE,DELAY} ]
  98 dsn                          [ ORCPT=<recipient> ]
  99 dsn             SMTP Delivery Status Notifications.
 100 dsn     Descriptions:
 101 dsn             RET     Return either the full message or only headers.
 102 dsn             ENVID   Sender's "envelope identifier" for tracking.
 103 dsn             NOTIFY  When to send a DSN. Multiple options are OK, comma-
 104 dsn                     delimited. NEVER must appear by itself.
 105 dsn             ORCPT   Original recipient.
 106 -bt     Help for test mode:
 107 -bt     ?                :this help message.
 108 -bt     .Dmvalue         :define macro `m' to `value'.
 109 -bt     .Ccvalue         :add `value' to class `c'.
 110 -bt     =Sruleset        :dump the contents of the indicated ruleset.
 111 -bt     =M               :display the known mailers.
 112 -bt     -ddebug-spec     :equivalent to the command-line -d debug flag.
 113 -bt     $$m              :print the value of macro $$m.
 114 -bt     $$=c             :print the contents of class $$=c.
 115 -bt     /mx host         :returns the MX records for `host'.
 116 -bt     /gethostbyname host [family]  :calls gethostbyname() for `host'.
 117 -bt     /dnslookup host [qtype] [flags]  :Does a qtype DNS lookup for `host'.
 118 -bt     /parse address   :parse address, returning the value of crackaddr, and
 119 -bt                       the parsed address.
 120 -bt     /sender address  :parse sender address, returning the value of
 121 -bt                       setsender.
 122 -bt     /expand string   :expands string, returning the value of expand.
 123 -bt     /try mailer addr :rewrite address into the form it will have when
 124 -bt                       presented to the indicated mailer.
 125 -bt     /tryflags flags  :set flags used by parsing.  The flags can be `H' for
 126 -bt                       Header or `E' for Envelope, and `S' for Sender or `R'
 127 -bt                       for Recipient.  These can be combined, `HR' sets
 128 -bt                       flags for header recipients.
 129 -bt     /canon hostname  :try to canonify hostname.
 130 -bt     /map mapname key :look up `key' in the indicated `mapname'.
 131 -bt     /header header   :parses header, returning header flags
 132 -bt     /quit            :quit address test mode.
 133 -bt     rules addr       :run the indicated address through the named rules.
 134 -bt                       Rules can be a comma separated list of rules.
 135 control Help for smcontrol:
 136 control help            This message.
 137 control restart         Restart sendmail.
 138 control shutdown        Shutdown sendmail.
 139 control status          Show sendmail status.
 140 control mstat           Show sendmail status (machine readable format).
 141 control memdump         Dump allocated memory list (for debugging only).