0465a94135e97a5440d22d45ff409071067c39e7
[dragonfly.git] / usr.bin / mail / USD.doc / mail6.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 .\"     @(#)mail6.nr    8.1 (Berkeley) 6/8/93
33 .\"
34 .bp
35 .sh 1 "Command line options"
36 .pp
37 This section describes command line options for
38 .i Mail
39 and what they are used for.
40 .ip \-N
41 Suppress the initial printing of headers.
42 .ip \-d
43 Turn on debugging information.  Not of general interest.
44 .ip "\-f file\ \ "
45 Show the messages in
46 .i file
47 instead of your system mailbox.  If
48 .i file
49 is omitted,
50 .i Mail
51 reads
52 .i mbox
53 in your home directory.
54 .ip \-i
55 Ignore tty interrupt signals.  Useful on noisy phone lines, which
56 generate spurious RUBOUT or DELETE characters.  It's usually
57 more effective to change your interrupt character to control\-c,
58 for which see the
59 .i stty
60 shell command.
61 .ip \-n
62 Inhibit reading of /etc/mail.rc.  Not generally useful, since
63 /etc/mail.rc is usually empty.
64 .ip "\-s string"
65 Used for sending mail.
66 .i String
67 is used as the subject of the message being composed.  If
68 .i string
69 contains blanks, you must surround it with quote marks.
70 .ip "\-u name"
71 Read
72 .i names's
73 mail instead of your own.  Unwitting others often neglect to protect
74 their mailboxes, but discretion is advised. Essentially,
75 .b "\-u user"
76 is a shorthand way of doing
77 .b "\-f /var/mail/user".
78 .ip "\-v"
79 Use the
80 .b \-v
81 flag when invoking sendmail. This feature may also be enabled
82 by setting the the option "verbose".
83 .pp
84 The following command line flags are also recognized, but are
85 intended for use by programs invoking
86 .i Mail
87 and not for people.
88 .ip "\-T file"
89 Arrange to print on
90 .i file
91 the contents of the
92 .i article-id
93 fields of all messages that were either read or deleted.
94 .b \-T
95 is for the
96 .i readnews
97 program and should NOT be used for reading your mail.
98 .ip "\-h number"
99 Pass on hop count information.
100 .i Mail
101 will take the number, increment it, and pass it with
102 .b \-h
103 to the mail delivery system.
104 .b \-h
105 only has effect when sending mail and is used for network mail
106 forwarding.
107 .ip "\-r name"
108 Used for network mail forwarding:  interpret
109 .i name
110 as the sender of the message.  The
111 .i name
112 and
113 .b \-r
114 are simply sent along to the mail delivery system.  Also,
115 .i Mail
116 will wait for the message to be sent and return the exit status.
117 Also restricts formatting of message.
118 .pp
119 Note that
120 .b \-h
121 and
122 .b \-r ,
123 which are for network mail forwarding, are not used in practice
124 since mail forwarding is now handled separately.  They may
125 disappear soon.