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