Mercurial > hg > Applications > mh

comparison doc/refile.me @ 0:bce86c4163a3

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