Reworked the man page system and some man page contents (mmh-intro).

[mmh] / man / rmm.man1

diff --git a/man/rmm.man1 b/man/rmm.man1
new file mode 100644 (file)
index 0000000..0cf138f
--- /dev/null
+++ b/man/rmm.man1
@@ -0,0 +1,119 @@
+.\"
+.\" %nmhwarning%
+.\"
+.TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+rmm \- remove messages
+.SH SYNOPSIS
+.HP 5
+.na
+.B rmm
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-unlink " | " \-nounlink ]
+.RB [ \-version ]
+.RB [ \-help ]
+.ad
+.SH DESCRIPTION
+By default,
+.B rmm
+will remove the specified messages by renaming
+the message files with preceding commas.  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 rmm
+to really remove the files
+representing these messages, you can use the
+.B \-unlink
+switch.  But
+messages removed by this method cannot be later recovered.
+.PP
+If you prefer a more sophisticated method of `removing' messages, you
+can define the
+.I rmmproc
+profile component.  For example, you can
+add a profile component such as
+.PP
+.RS 5
+rmmproc:       /home/foouser/bin/rmm_msgs
+.RE
+.PP
+then instead of simply renaming the message file,
+.B rmm
+will call
+the named program or script to handle the files that represent the
+messages to be deleted.
+.PP
+Some users of
+.B csh
+prefer the following:
+.PP
+.RS 5
+alias rmm 'refile +d'
+.RE
+.PP
+where folder `+d' is a folder for deleted messages, and
+.PP
+.RS 5
+alias mexp 'rm `mhpath +d all`'
+.RE
+.PP
+is used to \*(lqexpunge\*(rq deleted messages.
+.PP
+The current message is not changed by
+.BR rmm ,
+so a
+.B next
+ will
+advance to the next message in the folder as expected.
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^$HOME/.mmh/profile~^The user profile
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^Path:~^To determine the user's mail storage
+^Current\-Folder:~^To find the default current folder
+^rmmproc:~^Program to delete the message
+.fi
+
+.SH "SEE ALSO"
+refile(1), rmf(1)
+
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs "' defaults to cur"
+.RB ` -nounlink '
+.fi
+
+.SH CONTEXT
+If a folder is given, it will become the current folder.
+
+.SH BUGS
+Since
+.B refile
+uses your
+.I rmmproc
+to delete the message,
+the
+.I rmmproc
+must
+.B NOT
+call
+.B refile
+without specifying
+.BR \-normmproc ,
+or you will create an infinte loop.