Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / mail / USD.doc / mail6.nr
blob950fac59b6c35f9a074f6bc247a452ef5e9aa71f
1 .\"     $NetBSD: mail6.nr,v 1.5 2000/03/13 23:22:52 soren Exp $
2 .\"
3 .\" Copyright (c) 1980, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)mail6.nr    8.2 (Berkeley) 5/16/94
31 .\"
32 .sh 1 "Command line options"
33 .pp
34 This section describes command line options for
35 .i Mail
36 and what they are used for.
37 .ip \-N
38 Suppress the initial printing of headers.
39 .ip \-d
40 Turn on debugging information.  Not of general interest.
41 .ip "\-f file\ \ "
42 Show the messages in
43 .i file
44 instead of your system mailbox.  If
45 .i file
46 is omitted,
47 .i Mail
48 reads
49 .i mbox
50 in your home directory.
51 .ip \-i
52 Ignore tty interrupt signals.  Useful on noisy phone lines, which
53 generate spurious RUBOUT or DELETE characters.  It's usually
54 more effective to change your interrupt character to control\-c,
55 for which see the
56 .i stty
57 shell command.
58 .ip \-n
59 Inhibit reading of /usr/lib/Mail.rc.  Not generally useful, since
60 /usr/lib/Mail.rc is usually empty.
61 .ip "\-s string"
62 Used for sending mail.
63 .i String
64 is used as the subject of the message being composed.  If
65 .i string
66 contains blanks, you must surround it with quote marks.
67 .ip "\-u name"
68 Read
69 .i names's
70 mail instead of your own.  Unwitting others often neglect to protect
71 their mailboxes, but discretion is advised. Essentially,
72 .b "\-u user"
73 is a shorthand way of doing
74 .b "\-f /var/mail/user".
75 .ip "\-v"
76 Use the
77 .b \-v
78 flag when invoking sendmail. This feature may also be enabled
79 by setting the option "verbose".
80 .pp
81 The following command line flags are also recognized, but are
82 intended for use by programs invoking
83 .i Mail
84 and not for people.
85 .ip "\-T file"
86 Arrange to print on
87 .i file
88 the contents of the
89 .i article-id
90 fields of all messages that were either read or deleted.
91 .b \-T
92 is for the
93 .i readnews
94 program and should NOT be used for reading your mail.
95 .ip "\-h number"
96 Pass on hop count information.
97 .i Mail
98 will take the number, increment it, and pass it with
99 .b \-h
100 to the mail delivery system.
101 .b \-h
102 only has effect when sending mail and is used for network mail
103 forwarding.
104 .ip "\-r name"
105 Used for network mail forwarding:  interpret
106 .i name
107 as the sender of the message.  The
108 .i name
110 .b \-r
111 are simply sent along to the mail delivery system.  Also,
112 .i Mail
113 will wait for the message to be sent and return the exit status.
114 Also restricts formatting of message.
116 Note that
117 .b \-h
119 .b \-r ,
120 which are for network mail forwarding, are not used in practice
121 since mail forwarding is now handled separately.  They may
122 disappear soon.