Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / mail / USD.doc / mail3.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 .\"     @(#)mail3.nr    8.1 (Berkeley) 6/8/93
33 .\"
34 .sh 1 "Maintaining folders"
35 .pp
36 .i Mail
37 includes a simple facility for maintaining groups of messages together
38 in folders.  This section describes this facility.
39 .pp
40 To use the folder facility, you must tell
41 .i Mail
42 where you wish to keep your folders.  Each folder of messages will
43 be a single file.  For convenience, all of your folders are kept in
44 a single directory of your choosing.  To tell
45 .i Mail
46 where your folder directory is, put a line of the form
47 .(l
48 set folder=letters
49 .)l
50 in your
51 .i .mailrc
52 file.  If, as in the example above, your folder directory does not
53 begin with a `/,'
54 .i Mail
55 will assume that your folder directory is to be found starting from
56 your home directory.  Thus, if your home directory is
57 .b /home/person
58 the above example told
59 .i Mail
60 to find your folder directory in
61 .b /home/person/letters .
62 .pp
63 Anywhere a file name is expected, you can use a folder name, preceded
64 with `+.'  For example, to put a message into a folder with the
65 .b save
66 command, you can use:
67 .(l
68 save +classwork
69 .)l
70 to save the current message in the
71 .i classwork
72 folder.  If the
73 .i classwork
74 folder does not yet exist, it will be created.  Note that messages
75 which are saved with the
76 .b save
77 command are automatically removed from your system mailbox.
78 .pp
79 In order to make a copy of a message in a folder without causing
80 that message to be removed from your system mailbox, use the
81 .b copy
82 command, which is identical in all other respects to the
83 .b save
84 command.  For example,
85 .(l
86 copy +classwork
87 .)l
88 copies the current message into the
89 .i classwork
90 folder and leaves a copy in your system mailbox.
91 .pp
92 The
93 .b folder
94 command
95 can be used to direct
96 .i Mail
97 to the contents of a different folder.
98 For example,
99 .(l
100 folder +classwork
101 .)l
102 directs
103 .i Mail
104 to read the contents of the
105 .i classwork
106 folder.  All of the commands that you can use on your system
107 mailbox are also applicable to folders, including
108 .b type ,
109 .b delete ,
110 and
111 .b reply .
112 To inquire which folder you are currently editing, use simply:
113 .(l
114 folder
115 .)l
116 .pp
117 To list your current set of folders, use the
118 .b folders
119 command.
120 .pp
121 To start
122 .i Mail
123 reading one of your folders, you can use the
124 .b \-f
125 option described in section 2.  For example:
126 .(l
127 % Mail \-f +classwork
128 .)l
129 will cause
130 .i Mail
131 to read your
132 .i classwork
133 folder without looking at your system mailbox.