/share/doc/usd/07.mail/mail9.nr

  1.\" Copyright (c) 1980, 1993
  2.\"	The Regents of the University of California.  All rights reserved.
  3.\"
  4.\" Redistribution and use in source and binary forms, with or without
  5.\" modification, are permitted provided that the following conditions
  6.\" are met:
  7.\" 1. Redistributions of source code must retain the above copyright
  8.\"    notice, this list of conditions and the following disclaimer.
  9.\" 2. Redistributions in binary form must reproduce the above copyright
 10.\"    notice, this list of conditions and the following disclaimer in the
 11.\"    documentation and/or other materials provided with the distribution.
 12.\" 3. All advertising materials mentioning features or use of this software
 13.\"    must display the following acknowledgement:
 14.\"	This product includes software developed by the University of
 15.\"	California, Berkeley and its contributors.
 16.\" 4. Neither the name of the University nor the names of its contributors
 17.\"    may be used to endorse or promote products derived from this software
 18.\"    without specific prior written permission.
 19.\"
 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 30.\" SUCH DAMAGE.
 31.\"
 32.\"	@(#)mail9.nr	8.1 (Berkeley) 6/8/93
 33.\"
 34.bp
 35.sh 1 "Summary of commands, options, and escapes"
 36.pp
 37This section gives a quick summary of the
 38.i Mail
 39commands, binary and valued options, and tilde escapes.
 40.pp
 41The following table describes the commands:
 42.TS
 43center ;
 44c ci
 45lb l.
 46Command	Description
 47_
 48+	Same as \fBnext\fP
 49-	Back up to previous message
 50?	Print brief summary of \fIMail\fP commands
 51!	Single command escape to shell
 52Print	Type message with ignored fields
 53Reply	Reply to author of message only
 54Respond	Same as \fBReply\fP
 55Type	Type message with ignored fields
 56alias	Define an alias as a set of user names
 57alternates	List other names you are known by
 58chdir	Change working directory, home by default
 59copy	Copy a message to a file or folder
 60delete	Delete a list of messages
 61dp	Same as \fBdt\fP
 62dt	Delete current message, type next message
 63edit	Edit a list of messages
 64else	Start of else part of conditional; see \fBif\fP
 65endif	End of conditional statement; see \fBif\fP
 66exit	Leave mail without changing anything
 67file	Interrogate/change current mail file
 68folder	Same as \fBfile\fP
 69folders	List the folders in your folder directory
 70from	List headers of a list of messages
 71headers	List current window of messages
 72help	Same as \fB?\fP
 73hold	Same as \fBpreserve\fP
 74if	Conditional execution of \fIMail\fP commands
 75ignore	Set/examine list of ignored header fields
 76list	List valid \fIMail\fP commands
 77local	List other names for the local host
 78mail	Send mail to specified names
 79mbox	Arrange to save a list of messages in \fImbox\fP
 80next	Go to next message and type it
 81preserve	Arrange to leave list of messages in system mailbox
 82print	Print messages
 83quit	Leave \fIMail\fP; update system mailbox, \fImbox\fP as appropriate
 84reply	Compose a reply to a message
 85respond	Same as \fBreply\fP
 86retain	Supersedes \fBignore\fP
 87save	Append messages, headers included, on a file
 88set	Set binary or valued options
 89shell	Invoke an interactive shell
 90size	Prints out size of message list
 91source	Read \fImail\fP commands from a file
 92top	Print first so many (5 by default) lines of list of messages
 93type	Same as \fBprint\fP
 94undelete	Undelete list of messages
 95unread	Marks list of messages as not been read
 96unset	Undo the operation of a \fBset\fP
 97visual	Invoke visual editor on a list of messages
 98write	Append messages to a file, don't include headers
 99xit	Same as \fBexit\fP
100z	Scroll to next/previous screenful of headers
101.TE
102.bp
103.(b
104.pp
105The following table describes the options.  Each option is
106shown as being either a binary or valued option.
107.TS
108center;
109c ci ci
110l ci l.
111Option	Type	Description
112_
113EDITOR	valued	Pathname of editor for ~e and \fBedit\fP
114PAGER	valued	Pathname of paginator for \fBPrint\fP, \fBprint\fP, \fBType\fP and \fBtype\fP
115SHELL	valued	Pathname of shell for \fBshell\fP, ~! and \fB!\fP
116VISUAL	valued	Pathname of screen editor for ~v, \fBvisual\fP
117append	binary	Always append messages to end of \fImbox\fP
118ask	binary	Prompt user for Subject: field when sending
119askcc	binary	Prompt user for additional Cc's at end of message
120autoprint	binary	Print next message after \fBdelete\fP
121crt	valued	Minimum number of lines before using \fBPAGER\fP
122debug	binary	Print out debugging information
123dot	binary	Accept . alone on line to terminate message input
124escape	valued	Escape character to be used instead of\ \ ~
125folder	valued	Directory to store folders in
126hold	binary	Hold messages in system mailbox by default
127ignore	binary	Ignore \s-2RUBOUT\s0 while sending mail
128ignoreeof	binary	Don't terminate letters/command input with \fB\(uaD\fP
129keep	binary	Don't unlink system mailbox when empty
130keepsave	binary	Don't delete \fBsave\fPd messages by default
131metoo	binary	Include sending user in aliases
132noheader	binary	Suppress initial printing of version and headers
133nosave	binary	Don't save partial letter in \fIdead.letter\fP
134quiet	binary	Suppress printing of \fIMail\fP version and message numbers
135record	valued	File to save all outgoing mail in
136screen	valued	Size of window of message headers for \fBz\fP, etc.
137sendmail	valued	Choose alternate mail delivery system
138toplines	valued	Number of lines to print in \fBtop\fP
139verbose	binary	Invoke sendmail with the \fB\-v\fP flag
140.TE
141.)b
142.(b
143.pp
144The following table summarizes the tilde escapes available
145while sending mail.
146.TS
147center;
148c ci ci
149l li l.
150Escape	Arguments	Description
151_
152~!	command	Execute shell command
153~b	name ...	Add names to "blind" Cc: list
154~c	name ...	Add names to Cc: field
155~d		Read \fIdead.letter\fP into message
156~e		Invoke text editor on partial message
157~f	messages	Read named messages
158~h		Edit the header fields
159~m	messages	Read named messages, right shift by tab
160~p		Print message entered so far
161~q		Abort entry of letter; like \s-2RUBOUT\s0
162~r	filename	Read file into message
163~s	string	Set Subject: field to \fIstring\fP
164~t	name ...	Add names to To: field
165~v		Invoke screen editor on message
166~w	filename	Write message on file
167~|	command	Pipe message through \fIcommand\fP
168~:	Mail command	Execute a \fIMail\fP command
169~~	string	Quote a ~ in front of \fIstring\fP
170.TE
171.)b
172.(b
173.pp
174The following table shows the command line flags that
175.i Mail
176accepts:
177.TS
178center;
179c c
180l a.
181Flag	Description
182_
183\-N	Suppress the initial printing of headers
184\-T \fIfile\fP	Article-id's of read/deleted messages to \fIfile\fP
185\-d	Turn on debugging
186\-f \fIfile\fP	Show messages in \fIfile\fP or \fI~/mbox\fP
187\-h \fInumber\fP	Pass on hop count for mail forwarding
188\-i	Ignore tty interrupt signals
189\-n	Inhibit reading of /etc/mail.rc
190\-r \fIname\fP	Pass on \fIname\fP for mail forwarding
191\-s \fIstring\fP	Use \fIstring\fP as subject in outgoing mail
192\-u \fIname\fP	Read \fIname's\fP mail instead of your own
193\-v 	Invoke sendmail with the \fB\-v\fP flag
194.TE
195.)b
196.lp
197Notes:
198.b \-T ,
199.b \-d ,
200.b \-h ,
201and
202.b \-r
203are not for human use.