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