Factor trim format function out

[mmh] / man / refile.man1

diff --git a/man/refile.man1 b/man/refile.man1
index 036baab..2909230 100644 (file)
--- a/man/refile.man1
+++ b/man/refile.man1
@@ -3,25 +3,20 @@
 .\"
 .TH REFILE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 .\"
 .TH REFILE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME

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

 .SH SYNOPSIS
 .HP 5
 .na
 .B refile
 .RI [ msgs ]
 .RB [ \-link " | " \-nolink ]
 .SH SYNOPSIS
 .HP 5
 .na
 .B refile
 .RI [ msgs ]
 .RB [ \-link " | " \-nolink ]

-.RB [ \-preserve " | " \-nopreserve ]
-.RB [ \-unlink " | " \-nounlink ]

 .RB [ \-src
 .IR +folder ]
 .RB [ \-file
 .IR file ]
 .RB [ \-src
 .IR +folder ]
 .RB [ \-file
 .IR file ]

-.RB [ \-rmmproc
-.IR program ]
-.RB [ \-normmproc ]

 .I +folder1
 \&...
 .I +folder1
 \&...

-.RB [ \-version ]
+.RB [ \-Version ]

 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION

@@ -43,7 +38,7 @@ multiply\-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

-refile\0cur\0+jones\0+Map
+refile\0c\0+jones\0+Map

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

@@ -54,7 +49,7 @@ You may specify the source folder using
 .IR +folder .
 If this is
 not given, the current folder is used by default.  If no message is
 .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.
+specified, then the current message is used by default.

 .PP
 The option
 .B \-file
 .PP
 The option
 .B \-file

@@ -65,12 +60,12 @@ 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
 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
+.B mh

 message.  It should
 .B NOT
 be in mail drop format
 (to convert a file in mail drop format to a folder of
 message.  It should
 .B NOT
 be in mail drop format
 (to convert a file in mail drop format to a folder of

-.B nmh
+.B mh

 messages,
 see
 .BR inc (1)).
 messages,
 see
 .BR inc (1)).

@@ -86,7 +81,7 @@ is
 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

-\*(lqyes\*(rq to all questions.
+`yes' to all questions.

 .PP
 The option
 .B \-link
 .PP
 The option
 .B \-link

@@ -98,67 +93,9 @@ rather than a
 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.

-.PP
-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
-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.
-.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
-.B cron
-to remove these files once a day, so check with your
-system administrator.
-.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
-switch (not to be confused with the
-.B \-link
-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
-profile
-component.  For example, you can add a profile component such as
-.PP
-.RS 5
-rmmproc:       /home/coleman/bin/rmm_msgs
-.RE
-.PP
-then
-.B refile
-will instead call the named program or script to
-handle the message files.
-.PP
-The user may specify
-.B \-rmmproc
-.I program
-on the command line to
-override this profile specification.  The
-.B \-normmproc
-option forces
-the message files to be deleted by renaming or unlinking them as
-described above.
+No backups are kept, because the contents don't vanish.
+They are only moved to a new location.
+To restore: refile the other way.

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

@@ -175,7 +112,6 @@ described above.
 ^Path:~^To determine the user's mail storage
 ^Current\-Folder:~^To find the default current folder
 ^Folder\-Protect:~^To set mode when creating a new folder
 ^Path:~^To determine the user's mail storage
 ^Current\-Folder:~^To find the default current folder
 ^Folder\-Protect:~^To set mode when creating a new folder

-^rmmproc:~^Program to delete the message

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

@@ -183,25 +119,19 @@ folder(1), rmf(1), rmm(1)
 
 .SH DEFAULTS
 .nf
 
 .SH DEFAULTS
 .nf

-.RB ` "\-src\ +folder" "' defaults to the current folder"
-.RB ` msgs "' defaults to cur"
+.RB ` "\-src\ \fI+folder\fP" "' defaults to the current folder"
+.RB ` msgs "' defaults to the current message"

 .RB ` \-nolink '
 .RB ` \-nolink '

-.RB ` \-nounlink '
-.RB ` \-nopreserve '

 .fi
 
 .SH CONTEXT
 If
 .fi
 
 .SH CONTEXT
 If

-.B \-src
-.I +folder
-is given, it will become the current folder.
-If neither

 .B \-link
 .B \-link

-nor `all' is specified, the current message in the
+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.
 .PP
 source folder will be set to the last message specified; otherwise, the
 current message won't be changed.
 .PP

-If the \*(lqPrevious\-Sequence\*(rq profile entry is set, in addition to defining
+If the `Previous\-Sequence' profile entry is set, in addition to defining

 the named sequences from the source folder,
 .B refile
 will also define
 the named sequences from the source folder,
 .B refile
 will also define

@@ -209,18 +139,10 @@ those sequences for the destination folders.  See
 .B mh\-sequence (7)
 for information concerning the previous sequence.
 
 .B mh\-sequence (7)
 for information concerning the previous sequence.
 

-.SH BUGS
-Since
-.B refile
-uses your
-.I rmmproc
-to delete the message,
-the
-.I rmmproc
-must
-.B NOT
-call
+.SH HISTORY
+Since mmh-0.3,

 .B refile
 .B refile

-without specifying
-.BR \-normmproc ,
-or you will create an infinite loop.
+does never change the current folder.
+(It used to change it when
+.BI \-src\  +folder
+was given, but this behavior had usability disadvantages.)