Added all of the MH sources, including RCS files, in

[mmh] / docs / historical / mh-6.8.5 / conf / doc / RCS / refile.rf,v

head    1.12;
access;
symbols;
locks; strict;


1.12
date    92.12.19.00.20.58;      author jromine; state Exp;
branches;
next    1.11;

1.11
date    92.02.10.20.27.30;      author jromine; state Exp;
branches;
next    1.10;

1.10
date    92.02.06.00.50.51;      author jromine; state Exp;
branches;
next    1.9;

1.9
date    92.02.05.20.36.53;      author jromine; state Exp;
branches;
next    1.8;

1.8
date    91.01.14.16.43.06;      author mh;      state Exp;
branches;
next    1.7;

1.7
date    90.12.18.15.46.28;      author mh;      state Exp;
branches;
next    1.6;

1.6
date    90.12.18.15.27.36;      author mh;      state Exp;
branches;
next    1.5;

1.5
date    90.04.05.15.14.54;      author sources; state Exp;
branches;
next    1.4;

1.4
date    90.03.22.11.31.45;      author sources; state Exp;
branches;
next    1.3;

1.3
date    90.03.20.19.42.26;      author sources; state Exp;
branches;
next    1.2;

1.2
date    90.03.20.17.36.41;      author sources; state Exp;
branches;
next    1.1;

1.1
date    90.03.20.17.21.25;      author sources; state Exp;
branches;
next    ;


desc
@@


1.12
log
@fixup grammar
@
text
@.\"    @@(MHWARNING)
.\" @@(#)$Id: refile.rf,v 1.11 1992/02/10 20:27:30 jromine Exp jromine $
.SC REFILE 1
.NA
refile \- file message in other folders
.SY
refile 
\%[msgs] 
\%[\-draft]
\%[\-link] \%[\-nolink] 
\%[\-preserve] \%[\-nopreserve]
\%[\-src\ +folder] 
\%[\-file\ file] 
\%[\-rmmproc program] \%[\-normmproc]
+folder ...
\%[\-help]
.DE
\fIRefile\fR moves (\fImv\fR\0(1)) or links (\fIln\fR\0(1)) messages from a
source folder into one or more destination folders.
If you think
of a message as a sheet of paper, this operation is not
unlike filing the sheet of paper (or copies) in file cabinet
folders.
When a message is filed, it is linked into the
destination folder(s) if possible, and is copied otherwise.
As long
as the destination folders are all on the same file system, multiple filing
causes little storage overhead.
This facility provides a good way to cross\-file or multiply\-index
messages.
For example, if a message is received from Jones about
the ARPA Map Project, the command

     refile\0cur\0+jones\0+Map

would allow the message to be found in either of the two
folders `jones' or `Map'.

The option `\-file\ file' directs \fIrefile\fR to use the specified
file as the source message to be filed, rather than a message from
a folder.
Note that the file should be a validly formatted message,
just like any other \fIMH\fR message.
It should \fBNOT\fR be in mail drop format
(to convert a file in mail drop format to a folder of \fIMH\fR messages,
see \fIinc\fR\0(1)).

If a destination folder doesn't exist, \fIrefile\fR will ask if you
want to create it.
A negative response will abort the file operation.
If the standard input for \fIrefile\fR is \fInot\fR a tty,
then \fIrefile\fR will not ask any questions and will proceed as if
the user answered \*(lqyes\*(rq to all questions.

The option `\-link' preserves the source folder copy of the message
(i.e., it does a \fIln\fR(1) rather than a \fImv\fR(1)), whereas,
`\-nolink' deletes the filed messages from the source
folder.
Normally, when a message is filed, it is assigned the
next highest number available in each of the destination folders.
Use of the `\-preserve' switch will override this message
renaming, but name conflicts may occur, so
use this switch cautiously.

If `\-link' is not specified (or `\-nolink' is specified),
the filed messages will be removed from the
source folder, by renaming them with a site-dependent prefix (usually 
a comma).

.ne 4
If the user has a profile component such as

        rmmproc:        /bin/rm

then \fIrefile\fR
will instead call the named program to delete the message files.
The user may specify `\-rmmproc program' on the command line
to override this profile specification.
The \`-normmproc' option forces 
the message files to be deleted
by renaming them as described above.

The `\-draft' switch tells \fIrefile\fR to file the <mh\-dir>/draft.
.Fi
^$HOME/\&.mh\(ruprofile~^The user profile
.Pr
^Path:~^To determine the user's MH directory
.Ps
^Current\-Folder:~^To find the default current folder
.Ps
^Folder\-Protect:~^To set mode when creating a new folder
.Ps
^rmmproc:~^Program to delete the message
.Sa
folder(1)
.De
`\-src\ +folder' defaults to the current folder
.Ds
`msgs' defaults to cur
.Ds
`\-nolink'
.Ds
`\-nopreserve'
.Co
If `\-src\ +folder' is given, it will become the
current folder.
If neither `\-link' nor `all' is specified,
the current message in the source
folder will be set to the last message specified; otherwise, the
current message won't be changed.

If the Previous\-Sequence profile entry is set,
in addition to defining the named sequences from the source folder,
\fIrefile\fR will also define those sequences for the destination folders.
See \fImh\-sequence\fR\0(5) for information concerning the previous sequence.
.Bu
Since \fIrefile\fR uses your \fIrmmproc\fP to delete the message,
the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP without 
specifying `\-normmproc',
or you will create an infinte loop.
.En
@


1.11
log
@previous-sequence docs in mh-sequence
@
text
@d2 1
a2 1
.\" @@(#)$Id: refile.rf,v 1.10 1992/02/06 00:50:51 jromine Exp jromine $
d53 1
a53 1
the user's answer was \*(lqyes\*(rq for all questions.
@


1.10
log
@document no prompting when stdin is not a tty
@
text
@d2 1
a2 1
.\" @@(#)$Id: refile.rf,v 1.9 1992/02/05 20:36:53 jromine Exp jromine $
d115 1
a115 1
See \fImh\-profile\fR\0(5) for information concerning the previous sequence.
@


1.9
log
@typo
@
text
@d2 1
a2 1
.\" @@(#)$Id: refile.rf,v 1.8 1991/01/14 16:43:06 mh Exp jromine $
d51 3
@


1.8
log
@document refile -[no]rmmproc
jlr
@
text
@d2 1
a2 1
.\" @@(#)$Id: refile.rf,v 1.7 90/12/18 15:46:28 mh Exp Locker: mh $
d112 1
a112 1
See \fImh\-profile\fR\0(1) for information concerning the previous sequence.
@


1.7
log
@jlr
@
text
@d2 1
a2 1
.\" @@(#)$Id: refile.rf,v 1.6 90/12/18 15:27:36 mh Exp Locker: mh $
d14 1
d63 3
a65 3
the filed messages will be removed (\fIunlink\fR\0(2)) from the
source folder,
similar to the way \fImv\fR\0(1) works.
d67 1
d72 7
a78 3
then instead of simply renaming the message file,
\fIrefile\fR
will call the named program to delete the file.
d115 2
a116 1
the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP,
@


1.6
log
@mention not calling refile as rmmproc.
jlr
@
text
@d2 1
a2 1
.\" @@(#)$Id: refile.rf,v 1.5 90/04/05 15:14:54 sources Exp Locker: mh $
d108 2
a109 2
Since \fIrefile\fR uses your \*(lqrmmproc\*(rq to delete the message,
the \*(lqrmmproc\*(rq must \fBNOT\fP call \fIrefile\fP,
@


1.5
log
@add ID
@
text
@d2 1
a2 1
.\" @@(#)$Id:$
d107 4
@


1.4
log
@put things back, do .NA stuff another way
@
text
@d2 1
@


1.3
log
@typo
@
text
@d2 2
a3 2
.TH REFILE 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
.SH .NA
d5 1
a5 1
.SH .SY
@


1.2
log
@fixup for makewhatis
@
text
@d2 1
a2 1
.TH REFILE 1 [mh.6] MH
@


1.1
log
@Initial revision
@
text
@d2 2
a3 2
.SC REFILE 1
.NA
d5 1
a5 1
.SY
@