h/prototypes.h: Remove mhlsbr() prototype; no such function.

[nmh] / man / refile.man

diff --git a/man/refile.man b/man/refile.man
index c83da66eff597a973103a0b5ce233d7d2df27276..56f1dfad869bb608e0641a59826352fde635d6aa 100644 (file)
--- a/man/refile.man
+++ b/man/refile.man
@@ -1,18 +1,20 @@
-.\"
+.TH REFILE %manext1% 2013-03-19 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\" $Id$
-.\"
-.TH REFILE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-refile \- file message in other folders
+refile \- file message in nmh folders

 .SH SYNOPSIS
 .HP 5
 .na
 .SH SYNOPSIS
 .HP 5
 .na

-.B refile 
+.B refile
+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ msgs ]
 .RB [ \-draft ]
 .RB [ \-link " | " \-nolink ]
 .RB [ \-preserve " | " \-nopreserve ]
 .RI [ msgs ]
 .RB [ \-draft ]
 .RB [ \-link " | " \-nolink ]
 .RB [ \-preserve " | " \-nopreserve ]

+.RB [ \-retainsequences " | " \-noretainsequences ]

 .RB [ \-unlink " | " \-nounlink ]
 .RB [ \-src
 .IR +folder ]
 .RB [ \-unlink " | " \-nounlink ]
 .RB [ \-src
 .IR +folder ]


@@ -23,25 +25,22 @@ refile \- file message in other folders
 .RB [ \-normmproc ]
 .I +folder1
 \&...
 .RB [ \-normmproc ]
 .I +folder1
 \&...

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Refile
+.B refile

 moves (see
 moves (see

-.BR mv (1))
+.IR mv (1))

 or links (see
 or links (see

-.BR ln (1))
-messages
-from a source folder into one or more destination folders.
+.IR ln (1))
+messages from a source folder into one or more destination folders.

 .PP
 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
 .PP
 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
+storage overhead.  This facility provides a good way to cross-file or
+multiple-index messages.  For example, if a message is received from

 Jones about the ARPA Map Project, the command
 .PP
 .RS 5
 Jones about the ARPA Map Project, the command
 .PP
 .RS 5


@@ -54,37 +53,36 @@ or `Map'.
 You may specify the source folder using
 .B \-src
 .IR +folder .
 You may specify the source folder using
 .B \-src
 .IR +folder .

-If this is
-not given, the current folder is used by default.  If no message is
-specified, then `cur' is used by default.
+If this is not given, the current folder is used by default.
+If no message is specified, then `cur' is used by default.

 .PP
 The option
 .B \-file
 .I file
 directs
 .B refile
 .PP
 The option
 .B \-file
 .I file
 directs
 .B refile

-to use the specified file
-as the source message to be filed, rather than a message from a folder.
+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
 .B nmh
 message.  It should
 Note that the file should be a validly formatted message, just like
 any other
 .B nmh
 message.  It should

-.B NOT
-be in mail drop format
-(to convert a file in mail drop format to a folder of
+.I not
+be in mail drop format (to convert a file in
+mail drop format to a folder of

 .B nmh
 messages,
 see
 .B nmh
 messages,
 see

-.BR inc (1)).
+.IR inc (1)).

 .PP
 If a destination folder doesn't exist,
 .B refile
 .PP
 If a destination folder doesn't exist,
 .B refile

-will ask if you want
-to create it.  A negative response will abort the file operation.  If the
-standard input for
+will ask if you want to create it.
+A negative response will abort the file operation.
+If the standard input for

 .B refile
 is
 .B refile
 is

-.B not
+.I not

 a tty, then
 .B refile
 will not ask any questions and will proceed as if the user answered
 a tty, then
 .B refile
 will not ask any questions and will proceed as if the user answered


@@ -92,11 +90,10 @@ will not ask any questions and will proceed as if the user answered
 .PP
 The option
 .B \-link
 .PP
 The option
 .B \-link

-preserves the source folder copy of the message (i.e.,
-it does a
-.BR ln (1)
+preserves the source folder copy of the message (i.e., it does an
+.IR ln (1)

 rather than a
 rather than a

-.BR mv (1)),
+.IR mv (1)),

 whereas,
 .B \-nolink
 (the default) deletes the filed messages from the source folder.
 whereas,
 .B \-nolink
 (the default) deletes the filed messages from the source folder.


@@ -104,47 +101,51 @@ whereas,
 Normally when a message is refiled, for each destination folder it
 is assigned the number which is one above the current highest message
 number in that folder.  Use of the
 Normally when a message is refiled, for each destination folder it
 is assigned the number which is one above the current highest message
 number in that folder.  Use of the

-.B \-preserv
+.B \-preserve

 switch will override
 this message renaming, and try to preserve the number of the message.
 If a conflict for a particular folder occurs when using the
 .B \-preserve
 switch, then
 .B refile
 switch will override
 this message renaming, and try to preserve the number of the message.
 If a conflict for a particular folder occurs when using the
 .B \-preserve
 switch, then
 .B refile

-will use the next available message number
-which is above the message number you wish to preserve.
+will use the next available message number which is above the message
+number you wish to preserve.
+.PP
+As message sequences are folder-specific, moving the message from
+the source folder removes it from all its sequences in that folder.
+.B \-retainsequences
+adds it to those same sequences in the destination folder,
+creating any that don't exist.
+This adding does not apply for the \*(lqcur\*(rq sequence.

 .PP
 If
 .B \-link
 is not specified (or
 .B \-nolink
 .PP
 If
 .B \-link
 is not specified (or
 .B \-nolink

-is specified), the filed
-messages will be removed from the source folder.  The default is to
-remove these messages by renaming them with a site-dependent prefix
-(usually a comma).  Such files will then need to be removed in some
-manner after a certain amount of time.  Many sites arrange for
+is specified), the filed messages will be removed from the source
+folder.  The default is to remove these messages by renaming them
+with a site-dependent prefix (usually a comma).
+Such files will then need to be removed in some manner after a
+certain amount of time.  Many sites arrange for

 .B cron
 .B cron

-to remove these files once a day, so check with your
-system administrator.
+to remove these files once a day, so check with your system administrator.

 .PP
 Alternately, if you wish for
 .B refile
 .PP
 Alternately, if you wish for
 .B refile

-to really remove the files
-representing these messages from the source folder, you can use the
-.B -unlink
+to really remove the files representing these messages from the source
+folder, you can use the
+.B \-unlink

 switch (not to be confused with the
 .B \-link
 switch (not to be confused with the
 .B \-link

-switch).  But
-messages removed by this method cannot be later recovered.
+switch).  But messages removed by this method cannot be later recovered.

 .PP
 If you prefer a more sophisticated method of `removing' the messages
 from the source folder, you can define the
 .B rmmproc
 .PP
 If you prefer a more sophisticated method of `removing' the messages
 from the source folder, you can define the
 .B rmmproc

-profile
-component.  For example, you can add a profile component such as
+profile component.  For example, you can add a profile component such as

 .PP
 .RS 5
 .PP
 .RS 5

-rmmproc:       /home/coleman/bin/rmm_msgs
+rmmproc:    /home/coleman/bin/rmm_msgs

 .RE
 .PP
 then
 .RE
 .PP
 then


@@ -155,26 +156,23 @@ handle the message files.
 The user may specify
 .B \-rmmproc
 .I program
 The user may specify
 .B \-rmmproc
 .I program

-on the command line to
-override this profile specification.  The
+on the command line to override this profile specification.
+The

 .B \-normmproc
 .B \-normmproc

-option forces
-the message files to be deleted by renaming or unlinking them as
-described above.
+option forces the message files to be deleted by renaming or
+unlinking them as described above.

 .PP
 The
 .B \-draft
 switch tells
 .B refile
 .PP
 The
 .B \-draft
 switch tells
 .B refile

-to file the <mh\-dir>/draft.
-
+to file the <mh-dir>/draft.

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile

 .fi
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -185,10 +183,11 @@ to file the <mh\-dir>/draft.
 ^Folder\-Protect:~^To set mode when creating a new folder
 ^rmmproc:~^Program to delete the message
 .fi
 ^Folder\-Protect:~^To set mode when creating a new folder
 ^rmmproc:~^Program to delete the message
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-folder(1), rmf(1), rmm(1)
-
+.IR folder (1),
+.IR mh-sequence (5),
+.IR rmf (1),
+.IR rmm (1)

 .SH DEFAULTS
 .nf
 .RB ` "\-src\ +folder" "' defaults to the current folder"
 .SH DEFAULTS
 .nf
 .RB ` "\-src\ +folder" "' defaults to the current folder"


@@ -196,8 +195,8 @@ folder(1), rmf(1), rmm(1)
 .RB ` \-nolink '
 .RB ` \-nounlink '
 .RB ` \-nopreserve '
 .RB ` \-nolink '
 .RB ` \-nounlink '
 .RB ` \-nopreserve '

+.RB ` \-noretainsequences '

 .fi
 .fi

-

 .SH CONTEXT
 If
 .B \-src
 .SH CONTEXT
 If
 .B \-src


@@ -206,29 +205,31 @@ is given, it will become the current folder.
 If neither
 .B \-link
 nor `all' is specified, the current message in the
 If neither
 .B \-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.
+source folder will be set to the last message specified; otherwise,
+the current message won't be changed.

 .PP
 .PP

-If the \*(lqPrevious\-Sequence\*(rq profile entry is set, in addition to defining
-the named sequences from the source folder,
+If the \*(lqPrevious\-Sequence\*(rq profile entry is set, in addition
+to defining the named sequences from the source folder,

 .B refile
 .B refile

-will also define
-those sequences for the destination folders.  See
-.B mh\-sequence (5)
+will also define those sequences for the destination folders.
+See
+.IR mh\-sequence (5)

 for information concerning the previous sequence.
 for information concerning the previous sequence.

-

 .SH BUGS
 Since
 .B refile
 .SH BUGS
 Since
 .B refile

-uses your
+and
+.B rmm
+use your

 .I rmmproc
 .I rmmproc

-to delete the message,
-the
+to delete the message, the

 .I rmmproc
 must
 .I rmmproc
 must

-.B NOT
+.I not

 call
 .B refile
 call
 .B refile

+or
+.B rmm

 without specifying
 .BR \-normmproc ,
 or you will create an infinite loop.
 without specifying
 .BR \-normmproc ,
 or you will create an infinite loop.