xref: /openbsd/usr.bin/mail/USD.doc/mail9.nr (revision d89ec533)
$OpenBSD: mail9.nr,v 1.8 2009/07/29 18:15:38 martynas Exp $

Copyright (c) 1980, 1993
The Regents of the University of California. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

@(#)mail9.nr 8.2 (Berkeley) 5/16/94

.sh 1 "Summary of commands, options, and escapes" .pp This section gives a quick summary of the .i Mail commands, binary and valued options, and tilde escapes. .pp The following table describes the commands:
Command Description
+ Same as next
- Back up to previous message
? Print brief summary of Mail commands
! Single command escape to shell
Print Type message with ignored fields
Reply Reply to author of message only
Respond Same as Reply
Type Type message with ignored fields
alias Define an alias as a set of user names
alternates List other names you are known by
chdir Change working directory, home by default
copy Copy a message to a file or folder
delete Delete a list of messages
dp Same as dt
dt Delete current message, type next message
edit Edit a list of messages
else Start of else part of conditional; see if
endif End of conditional statement; see if
exit Leave mail without changing anything
file Interrogate/change current mail file
folder Same as file
folders List the folders in your folder directory
from List headers of a list of messages
headers List current window of messages
help Same as ?
hold Same as preserve
if Conditional execution of Mail commands
ignore Set/examine list of ignored header fields
inc Incorporate new messages
list List valid Mail commands
mail Send mail to specified names
mbox Arrange to save a list of messages in mbox
more Invoke pager on message list
next Go to next message and type it
preserve Arrange to leave list of messages in system mailbox
print Print messages
quit Leave Mail; update system mailbox, mbox as appropriate
reply Compose a reply to a message
respond Same as reply
retain Supersedes ignore
save Append messages, headers included, on a file
saveignore List of headers to ignore when using the save command
saveretain List of headers to retain when using the save command
set Set binary or valued options
shell Invoke an interactive shell
size Prints out size of message list
source Read mail commands from a file
top Print first so many (5 by default) lines of list of messages
type Same as print
unalias Remove alias
undelete Undelete list of messages
unread Marks list of messages as not been read
unset Undo the operation of a set
visual Invoke visual editor on a list of messages
write Append messages to a file, don't include headers
xit Same as exit
z Scroll to next/previous screenful of headers
.(b .pp The following table describes the options. Each option is shown as being either a binary or valued option.
Option Type Description
EDITOR valued Pathname of editor for ~e and edit
LISTER valued Pathname of directory lister
MBOX valued Pathname of the mbox file
PAGER valued Pathname of pager for Print, print, Type and type
SHELL valued Pathname of shell for shell, ~! and !
VISUAL valued Pathname of screen editor for ~v, visual
append binary Always append messages to end of mbox
ask binary Prompt user for Subject: field when sending
askbcc binary Prompt user for additional BCc's at end of message
askcc binary Prompt user for additional Cc's at end of message
autoinc binary Automatically incorporate new mail
autoprint binary Print next message after delete
crt valued Minimum number of lines before using PAGER
debug binary Print out debugging information
dot binary Accept . alone on line to terminate message input
escape valued Escape character to be used instead of ~
folder valued Directory to store folders in
hold binary Hold messages in system mailbox by default
ignore binary Ignore <Control-C> while sending mail
ignoreeof binary Don't terminate letters/command input with ^D
indentprefix valued String used for indenting messages
keep binary Don't unlink system mailbox when empty
keepsave binary Don't delete saved messages by default
metoo binary Include sending user in aliases
noheader binary Suppress initial printing of version and headers
nosave binary Don't save partial letter in dead.letter
Replyall binary Reverses the sense of the [Rr]eply commands
quiet binary Suppress printing of Mail version/message numbers
record valued File to save all outgoing mail in
screen valued Size of window of message headers for z, etc.
searchheaders binary Search string for message headers
sendmail valued Choose alternate mail delivery system
toplines valued Number of lines to print in top
verbose binary Invoke sendmail with the -v flag
.)b .(b .pp The following table summarizes the tilde escapes available while sending mail.
Escape Arguments Description
~b name ... Add names to "blind" Cc: list.
~c name ... Add names to Cc: field.
~d Read dead.letter into message.
~e Invoke text editor on partial message.
~F messages Same as ~f, but includes all headers.
~f messages Read in messages.
~h Edit the header fields.
~M messages Same as ~m, but includes all headers.
~m messages Read in messages, right shifted by a tab.
~p Print (show) the message buffer.
~q Abort message; optionally save copy to ~/dead.letter.
~r file | ~< file Read a file into the message buffer.
~s string Set Subject: field to string.
~t name ... Add names to To: field.
~v Invoke display editor on message.
~w filename Write message to file.
~x Abort message; no copy is saved.
~? Print a brief summary of tilde escapes.
~!command Execute shell command.
~|command Pipe message through command.
~:command | ~_command Execute a Mail command.
~~string Quote a single tilde.
~. Simulate end of file on input.
.)b .(b .pp The following table shows the command line flags that .i Mail accepts:
Flag Description
-b list Send blind carbon copies to list.
-c list Send carbon copies to list
-d Turn on debugging
-f [name] Show messages in name or ~/mbox
-I Force Mail to run in interactive mode
-i Ignore tty interrupt signals
-N Suppress the initial printing of headers
-n Inhibit reading of /etc/mail.rc
-s subject Use subject as subject in outgoing mail
-T file Article-id's of read/deleted messages to file
-u user Read user's mail instead of your own
-v Invoke sendmail with the -v flag
.)b .lp Notes: .b -d and .b -T are not for human use.