xref: /titanic_50/usr/src/cmd/sendmail/lib/helpfile (revision 4aac33d31b41cc7e3ac6fb66747ff2cae63d08cf)
17c478bd9Sstevel@tonic-gate#vers	2
27c478bd9Sstevel@tonic-gatecpyr
3*4aac33d3Sjbeckcpyr	Copyright (c) 1998-2000, 2002, 2004-2007 Sendmail, Inc. and its suppliers.
47c478bd9Sstevel@tonic-gatecpyr	    All rights reserved.
57c478bd9Sstevel@tonic-gatecpyr	Copyright (c) 1983, 1995-1997 Eric P. Allman.  All rights reserved.
67c478bd9Sstevel@tonic-gatecpyr	Copyright (c) 1988, 1993
77c478bd9Sstevel@tonic-gatecpyr	    The Regents of the University of California.  All rights reserved.
8*4aac33d3Sjbeckcpyr	Copyright 1994-2007 Sun Microsystems, Inc.  All rights reserved.
97c478bd9Sstevel@tonic-gatecpyr	Use is subject to license terms.
107c478bd9Sstevel@tonic-gatecpyr
117c478bd9Sstevel@tonic-gatecpyr
127c478bd9Sstevel@tonic-gatecpyr	ident	"%Z%%M%	%I%	%E% SMI"
13*4aac33d3Sjbeckcpyr	$$Id: helpfile,v 8.48 2007/02/01 18:29:44 ca Exp $$
147c478bd9Sstevel@tonic-gatecpyr
157c478bd9Sstevel@tonic-gatesmtp	This is sendmail version $v
167c478bd9Sstevel@tonic-gatesmtp	Topics:
177c478bd9Sstevel@tonic-gatesmtp		HELO	EHLO	MAIL	RCPT	DATA
187c478bd9Sstevel@tonic-gatesmtp		RSET	NOOP	QUIT	HELP	VRFY
1949218d4fSjbecksmtp		EXPN	VERB	ETRN	DSN	STARTTLS
207c478bd9Sstevel@tonic-gatesmtp	For more info use "HELP <topic>".
217c478bd9Sstevel@tonic-gatesmtp	To report bugs in the implementation contact Sun Microsystems
227c478bd9Sstevel@tonic-gatesmtp	Technical Support.
237c478bd9Sstevel@tonic-gatesmtp	For local information send email to Postmaster at your site.
247c478bd9Sstevel@tonic-gatehelp	HELP [ <topic> ]
257c478bd9Sstevel@tonic-gatehelp		The HELP command gives help info.
267c478bd9Sstevel@tonic-gatehelo	HELO <hostname>
277c478bd9Sstevel@tonic-gatehelo		Introduce yourself.
287c478bd9Sstevel@tonic-gateehlo	EHLO <hostname>
297c478bd9Sstevel@tonic-gateehlo		Introduce yourself, and request extended SMTP mode.
307c478bd9Sstevel@tonic-gateehlo	Possible replies include:
317c478bd9Sstevel@tonic-gateehlo		SEND		Send as mail			[RFC821]
327c478bd9Sstevel@tonic-gateehlo		SOML		Send as mail or terminal	[RFC821]
337c478bd9Sstevel@tonic-gateehlo		SAML		Send as mail and terminal	[RFC821]
347c478bd9Sstevel@tonic-gateehlo		EXPN		Expand the mailing list		[RFC821]
357c478bd9Sstevel@tonic-gateehlo		HELP		Supply helpful information	[RFC821]
367c478bd9Sstevel@tonic-gateehlo		TURN		Turn the operation around	[RFC821]
377c478bd9Sstevel@tonic-gateehlo		8BITMIME	Use 8-bit data			[RFC1652]
387c478bd9Sstevel@tonic-gateehlo		SIZE		Message size declaration	[RFC1870]
397c478bd9Sstevel@tonic-gateehlo		VERB		Verbose				[Allman]
407c478bd9Sstevel@tonic-gateehlo		CHUNKING	Chunking			[RFC1830]
417c478bd9Sstevel@tonic-gateehlo		BINARYMIME	Binary MIME			[RFC1830]
427c478bd9Sstevel@tonic-gateehlo		PIPELINING	Command Pipelining		[RFC1854]
437c478bd9Sstevel@tonic-gateehlo		DSN		Delivery Status Notification	[RFC1891]
447c478bd9Sstevel@tonic-gateehlo		ETRN		Remote Message Queue Starting	[RFC1985]
4549218d4fSjbeckehlo		STARTTLS	Secure SMTP			[RFC2487]
467c478bd9Sstevel@tonic-gateehlo		ENHANCEDSTATUSCODES	Enhanced status codes	[RFC2034]
477c478bd9Sstevel@tonic-gateehlo		DELIVERBY	Deliver By			[RFC2852]
4849218d4fSjbeckmail	MAIL From:<sender> [ <parameters> ]
497c478bd9Sstevel@tonic-gatemail		Specifies the sender.  Parameters are ESMTP extensions.
507c478bd9Sstevel@tonic-gatemail		See "HELP DSN" for details.
5149218d4fSjbeckrcpt	RCPT To:<recipient> [ <parameters> ]
527c478bd9Sstevel@tonic-gatercpt		Specifies the recipient.  Can be used any number of times.
537c478bd9Sstevel@tonic-gatercpt		Parameters are ESMTP extensions.  See "HELP DSN" for details.
547c478bd9Sstevel@tonic-gatedata	DATA
557c478bd9Sstevel@tonic-gatedata		Following text is collected as the message.
567c478bd9Sstevel@tonic-gatedata		End with a single dot.
577c478bd9Sstevel@tonic-gaterset	RSET
587c478bd9Sstevel@tonic-gaterset		Resets the system.
597c478bd9Sstevel@tonic-gatequit	QUIT
607c478bd9Sstevel@tonic-gatequit		Exit sendmail (SMTP).
6149218d4fSjbeckstarttls	STARTTLS
6249218d4fSjbeckstarttls		Start TLS negotiation.
637c478bd9Sstevel@tonic-gateverb	VERB
647c478bd9Sstevel@tonic-gateverb		Go into verbose mode.  This sends 0xy responses that are
657c478bd9Sstevel@tonic-gateverb		not RFC821 standard (but should be)  They are recognized
667c478bd9Sstevel@tonic-gateverb		by humans and other sendmail implementations.
677c478bd9Sstevel@tonic-gatevrfy	VRFY <recipient>
687c478bd9Sstevel@tonic-gatevrfy		Verify an address.  If you want to see what it aliases
697c478bd9Sstevel@tonic-gatevrfy		to, use EXPN instead.
707c478bd9Sstevel@tonic-gateexpn	EXPN <recipient>
717c478bd9Sstevel@tonic-gateexpn		Expand an address.  If the address indicates a mailing
727c478bd9Sstevel@tonic-gateexpn		list, return the contents of that list.
737c478bd9Sstevel@tonic-gatenoop	NOOP
747c478bd9Sstevel@tonic-gatenoop		Do nothing.
757c478bd9Sstevel@tonic-gatesend	SEND FROM:<sender>
767c478bd9Sstevel@tonic-gatesend		replaces the MAIL command, and can be used to send
777c478bd9Sstevel@tonic-gatesend		directly to a users terminal.  Not supported in this
787c478bd9Sstevel@tonic-gatesend		implementation.
797c478bd9Sstevel@tonic-gatesoml	SOML FROM:<sender>
807c478bd9Sstevel@tonic-gatesoml		Send or mail.  If the user is logged in, send directly,
817c478bd9Sstevel@tonic-gatesoml		otherwise mail.  Not supported in this implementation.
827c478bd9Sstevel@tonic-gatesaml	SAML FROM:<sender>
837c478bd9Sstevel@tonic-gatesaml		Send and mail.  Send directly to the user's terminal,
847c478bd9Sstevel@tonic-gatesaml		and also mail a letter.  Not supported in this
857c478bd9Sstevel@tonic-gatesaml		implementation.
867c478bd9Sstevel@tonic-gateturn	TURN
877c478bd9Sstevel@tonic-gateturn		Reverses the direction of the connection.  Not currently
887c478bd9Sstevel@tonic-gateturn		implemented.
8949218d4fSjbecketrn	ETRN [ <hostname> | @<domain> | \#<queuename> ]
907c478bd9Sstevel@tonic-gateetrn		Run the queue for the specified <hostname>, or
917c478bd9Sstevel@tonic-gateetrn		all hosts within a given <domain>, or a specially-named
927c478bd9Sstevel@tonic-gateetrn		<queuename> (implementation-specific).
933ee0e492Sjbeckdsn	MAIL From:<sender> [ RET={ FULL | HDRS} ] [ ENVID=<envid> ]
943ee0e492Sjbeckdsn	RCPT To:<recipient> [ NOTIFY={NEVER,SUCCESS,FAILURE,DELAY} ]
957c478bd9Sstevel@tonic-gatedsn			     [ ORCPT=<recipient> ]
967c478bd9Sstevel@tonic-gatedsn		SMTP Delivery Status Notifications.
977c478bd9Sstevel@tonic-gatedsn	Descriptions:
987c478bd9Sstevel@tonic-gatedsn		RET	Return either the full message or only headers.
997c478bd9Sstevel@tonic-gatedsn		ENVID	Sender's "envelope identifier" for tracking.
1007c478bd9Sstevel@tonic-gatedsn		NOTIFY	When to send a DSN. Multiple options are OK, comma-
1017c478bd9Sstevel@tonic-gatedsn			delimited. NEVER must appear by itself.
1027c478bd9Sstevel@tonic-gatedsn		ORCPT	Original recipient.
1037c478bd9Sstevel@tonic-gate-bt	Help for test mode:
1047c478bd9Sstevel@tonic-gate-bt	?		 :this help message.
1057c478bd9Sstevel@tonic-gate-bt	.Dmvalue	 :define macro `m' to `value'.
1067c478bd9Sstevel@tonic-gate-bt	.Ccvalue	 :add `value' to class `c'.
1077c478bd9Sstevel@tonic-gate-bt	=Sruleset	 :dump the contents of the indicated ruleset.
1087c478bd9Sstevel@tonic-gate-bt	=M		 :display the known mailers.
1097c478bd9Sstevel@tonic-gate-bt	-ddebug-spec	 :equivalent to the command-line -d debug flag.
1107c478bd9Sstevel@tonic-gate-bt	$$m		 :print the value of macro $$m.
1117c478bd9Sstevel@tonic-gate-bt	$$=c		 :print the contents of class $$=c.
1127c478bd9Sstevel@tonic-gate-bt	/mx host	 :returns the MX records for `host'.
1137c478bd9Sstevel@tonic-gate-bt	/parse address	 :parse address, returning the value of crackaddr, and
1147c478bd9Sstevel@tonic-gate-bt			  the parsed address.
1157c478bd9Sstevel@tonic-gate-bt	/try mailer addr :rewrite address into the form it will have when
1167c478bd9Sstevel@tonic-gate-bt			  presented to the indicated mailer.
1177c478bd9Sstevel@tonic-gate-bt	/tryflags flags	 :set flags used by parsing.  The flags can be `H' for
1187c478bd9Sstevel@tonic-gate-bt			  Header or `E' for Envelope, and `S' for Sender or `R'
1197c478bd9Sstevel@tonic-gate-bt			  for Recipient.  These can be combined, `HR' sets
1207c478bd9Sstevel@tonic-gate-bt			  flags for header recipients.
1217c478bd9Sstevel@tonic-gate-bt	/canon hostname	 :try to canonify hostname.
1227c478bd9Sstevel@tonic-gate-bt	/map mapname key :look up `key' in the indicated `mapname'.
1237c478bd9Sstevel@tonic-gate-bt	/quit		 :quit address test mode.
1247c478bd9Sstevel@tonic-gate-bt	rules addr	 :run the indicated address through the named rules.
1257c478bd9Sstevel@tonic-gate-bt			  Rules can be a comma separated list of rules.
1267c478bd9Sstevel@tonic-gatecontrol	Help for smcontrol:
1277c478bd9Sstevel@tonic-gatecontrol	help		This message.
1287c478bd9Sstevel@tonic-gatecontrol	restart		Restart sendmail.
1297c478bd9Sstevel@tonic-gatecontrol	shutdown	Shutdown sendmail.
1307c478bd9Sstevel@tonic-gatecontrol	status		Show sendmail status.
131*4aac33d3Sjbeckcontrol	mstat		Show sendmail status (machine readable format).
1327c478bd9Sstevel@tonic-gatecontrol	memdump		Dump allocated memory list (for debugging only).
133