annotate conf/doc/refile.rf @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children 441a2190cfae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" @(MHWARNING)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC REFILE 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 refile \- file message in other folders
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 refile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[msgs]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-draft]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-link] \%[\-nolink]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-preserve] \%[\-nopreserve]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-src\ +folder]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-file\ file]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \%[\-rmmproc program] \%[\-normmproc]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 +folder ...
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 \fIRefile\fR moves (\fImv\fR\0(1)) or links (\fIln\fR\0(1)) messages from a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 source folder into one or more destination folders.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 If you think
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 of a message as a sheet of paper, this operation is not
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 unlike filing the sheet of paper (or copies) in file cabinet
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 folders.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 When a message is filed, it is linked into the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 destination folder(s) if possible, and is copied otherwise.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 As long
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 as the destination folders are all on the same file system, multiple filing
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 causes little storage overhead.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 This facility provides a good way to cross\-file or multiply\-index
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 For example, if a message is received from Jones about
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 the ARPA Map Project, the command
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 refile\0cur\0+jones\0+Map
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 would allow the message to be found in either of the two
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 folders `jones' or `Map'.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 The option `\-file\ file' directs \fIrefile\fR to use the specified
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 file as the source message to be filed, rather than a message from
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 a folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 Note that the file should be a validly formatted message,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 just like any other \fIMH\fR message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 It should \fBNOT\fR be in mail drop format
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 (to convert a file in mail drop format to a folder of \fIMH\fR messages,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 see \fIinc\fR\0(1)).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 If a destination folder doesn't exist, \fIrefile\fR will ask if you
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 want to create it.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 A negative response will abort the file operation.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 If the standard input for \fIrefile\fR is \fInot\fR a tty,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 then \fIrefile\fR will not ask any questions and will proceed as if
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 the user answered \*(lqyes\*(rq to all questions.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 The option `\-link' preserves the source folder copy of the message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 (i.e., it does a \fIln\fR(1) rather than a \fImv\fR(1)), whereas,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 `\-nolink' deletes the filed messages from the source
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 Normally, when a message is filed, it is assigned the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 next highest number available in each of the destination folders.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 Use of the `\-preserve' switch will override this message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 renaming, but name conflicts may occur, so
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 use this switch cautiously.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 If `\-link' is not specified (or `\-nolink' is specified),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 the filed messages will be removed from the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 source folder, by renaming them with a site-dependent prefix (usually
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 a comma).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 .ne 4
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 If the user has a profile component such as
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 rmmproc: /bin/rm
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 then \fIrefile\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 will instead call the named program to delete the message files.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 The user may specify `\-rmmproc program' on the command line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 to override this profile specification.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 The \`-normmproc' option forces
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 the message files to be deleted
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 by renaming them as described above.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 The `\-draft' switch tells \fIrefile\fR to file the <mh\-dir>/draft.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 ^Current\-Folder:~^To find the default current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 ^Folder\-Protect:~^To set mode when creating a new folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 ^rmmproc:~^Program to delete the message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 folder(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 `\-src\ +folder' defaults to the current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 `msgs' defaults to cur
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 `\-nolink'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 `\-nopreserve'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 If `\-src\ +folder' is given, it will become the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106 current folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 If neither `\-link' nor `all' is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 the current message in the source
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 folder will be set to the last message specified; otherwise, the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 current message won't be changed.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 If the Previous\-Sequence profile entry is set,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 in addition to defining the named sequences from the source folder,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 \fIrefile\fR will also define those sequences for the destination folders.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 See \fImh\-sequence\fR\0(5) for information concerning the previous sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117 Since \fIrefile\fR uses your \fIrmmproc\fP to delete the message,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118 the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP without
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 specifying `\-normmproc',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 or you will create an infinte loop.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121 .En