From 5aaedc4256d58afe2481d667afdcb5162a914ba9 Mon Sep 17 00:00:00 2001 From: markus schnalke Date: Fri, 23 Dec 2011 12:09:55 +0100 Subject: [PATCH] Reworked the man page system and some man page contents (mmh-intro). Now it's possible to have two equally named pages in two different sections. This appeared to be interesting for mmh(X), but I don't use it now. Let's see if we keep the new system or even rework it to become simpler. --- .gitignore | 1 + man/Makefile.in | 59 ++++++++---- man/{ali.man => ali.man1} | 0 man/{anno.man => anno.man1} | 0 man/{ap.man => ap.man8} | 0 man/{burst.man => burst.man1} | 0 man/{comp.man => comp.man1} | 2 +- man/{conflict.man => conflict.man8} | 0 man/{dist.man => dist.man1} | 2 +- man/{dp.man => dp.man8} | 0 man/{flist.man => flist.man1} | 6 +- man/{flists.man => flists.man1} | 0 man/{fmtdump.man => fmtdump.man8} | 2 +- man/{fnext.man => fnext.man1} | 0 man/{folder.man => folder.man1} | 0 man/{folders.man => folders.man1} | 0 man/{forw.man => forw.man1} | 2 +- man/{fprev.man => fprev.man1} | 0 man/{inc.man => inc.man1} | 0 man/{mark.man => mark.man1} | 4 +- man/{mh-alias.man => mh-alias.man5} | 0 man/{mh-chart.man => mh-chart.man1} | 0 man/{mh-draft.man => mh-draft.man7} | 2 +- man/{mh-format.man => mh-format.man5} | 0 man/{mh-mail.man => mh-mail.man5} | 0 man/{mh-profile.man => mh-profile.man5} | 14 +-- man/{mh-sequence.man => mh-sequence.man7} | 2 +- man/{mh-tailor.man => mh-tailor.man5} | 0 man/{mhbuild.man => mhbuild.man1} | 0 man/{mhl.man => mhl.man1} | 0 man/{mhlist.man => mhlist.man1} | 0 man/{mhmail.man => mhmail.man1} | 0 man/{mhparam.man => mhparam.man1} | 0 man/{mhpath.man => mhpath.man1} | 0 man/{mhshow.man => mhshow.man1} | 0 man/{mhstore.man => mhstore.man1} | 0 man/{nmh.man => mmh-intro.man7} | 150 ++++++++++++++--------------- man/{mmh.man => mmh.man1} | 10 +- man/{msgchk.man => msgchk.man1} | 0 man/{mts.conf.man => mts.conf.man5} | 0 man/{new.man => new.man1} | 0 man/{next.man => next.man1} | 0 man/{packf.man => packf.man1} | 0 man/{pick.man => pick.man1} | 0 man/{post.man => post.man8} | 0 man/{prev.man => prev.man1} | 0 man/{prompter.man => prompter.man1} | 0 man/{rcvdist.man => rcvdist.man1} | 0 man/{rcvpack.man => rcvpack.man1} | 0 man/{rcvstore.man => rcvstore.man1} | 2 +- man/{rcvtty.man => rcvtty.man1} | 0 man/{refile.man => refile.man1} | 2 +- man/{repl.man => repl.man1} | 2 +- man/{rmf.man => rmf.man1} | 0 man/{rmm.man => rmm.man1} | 0 man/{scan.man => scan.man1} | 0 man/{send.man => send.man1} | 2 +- man/{sendfiles.man => sendfiles.man1} | 0 man/{show.man => show.man1} | 0 man/{slocal.man => slocal.man1} | 0 man/{sortm.man => sortm.man1} | 0 man/{unseen.man => unseen.man1} | 0 man/{whatnow.man => whatnow.man1} | 2 +- man/whom.man | 2 +- 64 files changed, 141 insertions(+), 127 deletions(-) rename man/{ali.man => ali.man1} (100%) rename man/{anno.man => anno.man1} (100%) rename man/{ap.man => ap.man8} (100%) rename man/{burst.man => burst.man1} (100%) rename man/{comp.man => comp.man1} (99%) rename man/{conflict.man => conflict.man8} (100%) rename man/{dist.man => dist.man1} (99%) rename man/{dp.man => dp.man8} (100%) rename man/{flist.man => flist.man1} (98%) rename man/{flists.man => flists.man1} (100%) rename man/{fmtdump.man => fmtdump.man8} (97%) rename man/{fnext.man => fnext.man1} (100%) rename man/{folder.man => folder.man1} (100%) rename man/{folders.man => folders.man1} (100%) rename man/{forw.man => forw.man1} (99%) rename man/{fprev.man => fprev.man1} (100%) rename man/{inc.man => inc.man1} (100%) rename man/{mark.man => mark.man1} (99%) rename man/{mh-alias.man => mh-alias.man5} (100%) rename man/{mh-chart.man => mh-chart.man1} (100%) rename man/{mh-draft.man => mh-draft.man7} (97%) rename man/{mh-format.man => mh-format.man5} (100%) rename man/{mh-mail.man => mh-mail.man5} (100%) rename man/{mh-profile.man => mh-profile.man5} (99%) rename man/{mh-sequence.man => mh-sequence.man7} (99%) rename man/{mh-tailor.man => mh-tailor.man5} (100%) rename man/{mhbuild.man => mhbuild.man1} (100%) rename man/{mhl.man => mhl.man1} (100%) rename man/{mhlist.man => mhlist.man1} (100%) rename man/{mhmail.man => mhmail.man1} (100%) rename man/{mhparam.man => mhparam.man1} (100%) rename man/{mhpath.man => mhpath.man1} (100%) rename man/{mhshow.man => mhshow.man1} (100%) rename man/{mhstore.man => mhstore.man1} (100%) rename man/{nmh.man => mmh-intro.man7} (71%) rename man/{mmh.man => mmh.man1} (90%) rename man/{msgchk.man => msgchk.man1} (100%) rename man/{mts.conf.man => mts.conf.man5} (100%) rename man/{new.man => new.man1} (100%) rename man/{next.man => next.man1} (100%) rename man/{packf.man => packf.man1} (100%) rename man/{pick.man => pick.man1} (100%) rename man/{post.man => post.man8} (100%) rename man/{prev.man => prev.man1} (100%) rename man/{prompter.man => prompter.man1} (100%) rename man/{rcvdist.man => rcvdist.man1} (100%) rename man/{rcvpack.man => rcvpack.man1} (100%) rename man/{rcvstore.man => rcvstore.man1} (98%) rename man/{rcvtty.man => rcvtty.man1} (100%) rename man/{refile.man => refile.man1} (99%) rename man/{repl.man => repl.man1} (99%) rename man/{rmf.man => rmf.man1} (100%) rename man/{rmm.man => rmm.man1} (100%) rename man/{scan.man => scan.man1} (100%) rename man/{send.man => send.man1} (99%) rename man/{sendfiles.man => sendfiles.man1} (100%) rename man/{show.man => show.man1} (100%) rename man/{slocal.man => slocal.man1} (100%) rename man/{sortm.man => sortm.man1} (100%) rename man/{unseen.man => unseen.man1} (100%) rename man/{whatnow.man => whatnow.man1} (99%) diff --git a/.gitignore b/.gitignore index 6cdc7b6..15199ba 100644 --- a/.gitignore +++ b/.gitignore @@ -78,4 +78,5 @@ *.o *.1 *.5 +*.7 *.8 diff --git a/man/Makefile.in b/man/Makefile.in index e4add41..de3c254 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -19,6 +19,7 @@ etcdir = @sysconfdir@ mandir = @mandir@ manext1 = 1 manext5 = 5 +manext7 = 7 manext8 = 8 mailspool = @mailspool@ @@ -31,54 +32,62 @@ SED = sed SEDMAN = $(SED) -f man.sed $< > $@ .SUFFIXES: -.SUFFIXES: .man .$(manext1) .$(manext5) .$(manext8) +.SUFFIXES: .man1 .man5 .man7 .man8 \ + .$(manext1) .$(manext5) .$(manext7) .$(manext8) -.man.$(manext1): +.man1.$(manext1): $(SEDMAN) -.man.$(manext5): +.man5.$(manext5): $(SEDMAN) -.man.$(manext8): +.man7.$(manext7): + $(SEDMAN) + +.man8.$(manext8): $(SEDMAN) # man pages to install in $(mandir)/$(manext1) MAN1SRC = ali. anno. burst. comp. dist. flist. flists. folder. folders. \ - forw. inc. mark. mh-chart. nmh. mhbuild. mhl. mhlist. \ + forw. inc. mark. mh-chart. mhbuild. mhl. mhlist. mmh. \ mhmail. mhparam. mhpath. mhshow. mhstore. msgchk. new. fnext. \ fprev. unseen. next. packf. pick. prev. prompter. rcvdist. rcvpack. \ rcvstore. rcvtty. refile. repl. rmf. rmm. scan. send. sendfiles. \ show. slocal. sortm. whatnow. -MAN5SRC = mh-alias. mh-draft. mh-format. mh-mail. mh-profile. mh-sequence. \ - mh-tailor. mts.conf. +MAN5SRC = mh-alias. mh-format. mh-mail. mh-profile. mh-tailor. mts.conf. -MAN8SRC = ap. conflict. dp. fmtdump. mmh. post. +MAN7SRC = mmh-intro. mh-draft. mh-sequence. + +MAN8SRC = ap. conflict. dp. fmtdump. post. MAN1 = $(MAN1SRC:.=.$(manext1)) MAN5 = $(MAN5SRC:.=.$(manext5)) +MAN7 = $(MAN7SRC:.=.$(manext7)) MAN8 = $(MAN8SRC:.=.$(manext8)) # source for man pages -DIST_MANSRC = $(MAN1SRC) $(MAN5SRC) $(MAN8SRC) -DIST_MAN = $(DIST_MANSRC:.=.man) +DIST_MAN1 = $(MAN1SRC:.=.man1) +DIST_MAN5 = $(MAN5SRC:.=.man5) +DIST_MAN7 = $(MAN7SRC:.=.man7) +DIST_MAN8 = $(MAN8SRC:.=.man8) # auxiliary files AUX = Makefile.in # all files in this directory included in the distribution -DIST = $(DIST_MAN) $(AUX) +DIST = $(DIST_MAN1) $(DIST_MAN5) $(DIST_MAN7) $(DIST_MAN8) $(AUX) # ========= DEFAULT TARGET ========== -all: $(MAN1) $(MAN5) $(MAN8) +all: $(MAN1) $(MAN5) $(MAN7) $(MAN8) -$(MAN1) $(MAN5) $(MAN8): man.sed +$(MAN1) $(MAN5) $(MAN7) $(MAN8): man.sed # create the sed file for building man pages man.sed: Makefile echo 's,%nmhwarning%,THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.,g' > $@ - echo 's,%nmhversion%,nmh-$(VERSION),g' >> $@ + echo 's,%nmhversion%,mmh-$(VERSION),g' >> $@ echo 's,%nmhdate%,$(DATE),g' >> $@ echo 's,%bindir%,$(bindir),g' >> $@ echo 's,%etcdir%,$(etcdir),g' >> $@ @@ -88,6 +97,7 @@ man.sed: Makefile echo 's,%sendmailpath%,$(sendmailpath),g' >> $@ echo 's,%manext1%,$(manext1),g' >> $@ echo 's,%manext5%,$(manext5),g' >> $@ + echo 's,%manext7%,$(manext7),g' >> $@ echo 's,%manext8%,$(manext8),g' >> $@ echo '/%components%/r $(top_srcdir)/etc/components' >> $@ echo ' s,%components%,,g' >> $@ @@ -104,7 +114,7 @@ man.sed: Makefile # ========= INSTALL TARGETS ========= -install: install-man1 install-man5 install-man8 +install: install-man1 install-man5 install-man7 install-man8 # install the man pages in man1 install-man1: @@ -119,10 +129,13 @@ install-man5: for file in $(MAN5); do \ $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)/man$(manext5) ; \ done - if [ ! -f $(DESTDIR)$(mandir)/man$(manext5)/mh_profile.$(manext5) ] ; then \ - ( cd $(DESTDIR)$(mandir)/man$(manext5) ; ln mh-profile.$(manext5) \ - mh_profile.$(manext5) ) \ - fi + +# install the man pages in man7 +install-man7: + $(top_srcdir)/mkinstalldirs $(DESTDIR)$(mandir)/man$(manext7) + for file in $(MAN7); do \ + $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)/man$(manext7) ; \ + done # install the man pages in man8 install-man8: @@ -147,6 +160,12 @@ uninstall-man5: rm -f $(DESTDIR)$(mandir)/man$(manext5)/$$file; \ done +# uninstall the man pages in man7 +uninstall-man7: + for file in $(MAN7); do \ + rm -f $(DESTDIR)$(mandir)/man$(manext7)/$$file; \ + done + # uninstall the man pages in man8 uninstall-man8: for file in $(MAN8); do \ @@ -159,7 +178,7 @@ mostlyclean: rm -f *~ clean: mostlyclean - rm -f man.sed *.$(manext1) *.$(manext5) *.$(manext8) + rm -f man.sed *.$(manext1) *.$(manext5) *.$(manext7) *.$(manext8) distclean: clean rm -f Makefile diff --git a/man/ali.man b/man/ali.man1 similarity index 100% rename from man/ali.man rename to man/ali.man1 diff --git a/man/anno.man b/man/anno.man1 similarity index 100% rename from man/anno.man rename to man/anno.man1 diff --git a/man/ap.man b/man/ap.man8 similarity index 100% rename from man/ap.man rename to man/ap.man8 diff --git a/man/burst.man b/man/burst.man1 similarity index 100% rename from man/burst.man rename to man/burst.man1 diff --git a/man/comp.man b/man/comp.man1 similarity index 99% rename from man/comp.man rename to man/comp.man1 index 0b080ed..a9e75da 100644 --- a/man/comp.man +++ b/man/comp.man1 @@ -116,7 +116,7 @@ argument to is required.) .PP Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. .PP The diff --git a/man/conflict.man b/man/conflict.man8 similarity index 100% rename from man/conflict.man rename to man/conflict.man8 diff --git a/man/dist.man b/man/dist.man1 similarity index 99% rename from man/dist.man rename to man/dist.man1 index 89b8537..7b46eaa 100644 --- a/man/dist.man +++ b/man/dist.man1 @@ -104,7 +104,7 @@ the folder containing the message is stored in the environment variable .BR $mhfolder . .PP Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. .PP Upon exiting from the editor, diff --git a/man/dp.man b/man/dp.man8 similarity index 100% rename from man/dp.man rename to man/dp.man8 diff --git a/man/flist.man b/man/flist.man1 similarity index 98% rename from man/flist.man rename to man/flist.man1 index def7b90..f505ba8 100644 --- a/man/flist.man +++ b/man/flist.man1 @@ -64,7 +64,7 @@ multiple sequences. If this is not given, then the default is to search for all the sequences specified by the .RI \*(lq Unseen-Sequence \*(rq profile component. For more details about sequences, read the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page. .PP Typically, @@ -131,7 +131,7 @@ indicates that it is the current folder. .PP The \*(lqprivate\*(rq flag indicates that the given sequence for that folder is private. See the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page for details about private sequences. .PP If the option @@ -195,7 +195,7 @@ puts everything else in the middle in alphabetical order. .fi .SH "SEE ALSO" -folder(1), rcvstore(1), slocal(1), mh\-sequence(5) +folder(1), rcvstore(1), slocal(1), mh\-sequence(7) .SH DEFAULTS .nf diff --git a/man/flists.man b/man/flists.man1 similarity index 100% rename from man/flists.man rename to man/flists.man1 diff --git a/man/fmtdump.man b/man/fmtdump.man8 similarity index 97% rename from man/fmtdump.man rename to man/fmtdump.man8 index d8e5a68..55f9b99 100644 --- a/man/fmtdump.man +++ b/man/fmtdump.man8 @@ -53,7 +53,7 @@ for the details. .fi .SH "SEE ALSO" -mh-format(5), mh-sequences(8) +mh-format(5), mh-sequence(7) .SH CONTEXT None diff --git a/man/fnext.man b/man/fnext.man1 similarity index 100% rename from man/fnext.man rename to man/fnext.man1 diff --git a/man/folder.man b/man/folder.man1 similarity index 100% rename from man/folder.man rename to man/folder.man1 diff --git a/man/folders.man b/man/folders.man1 similarity index 100% rename from man/folders.man rename to man/folders.man1 diff --git a/man/forw.man b/man/forw.man1 similarity index 99% rename from man/forw.man rename to man/forw.man1 index 0e79cfe..46dd70b 100644 --- a/man/forw.man +++ b/man/forw.man1 @@ -211,7 +211,7 @@ What now? mime prior to sending the draft. .PP Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. .PP The diff --git a/man/fprev.man b/man/fprev.man1 similarity index 100% rename from man/fprev.man rename to man/fprev.man1 diff --git a/man/inc.man b/man/inc.man1 similarity index 100% rename from man/inc.man rename to man/inc.man1 diff --git a/man/mark.man b/man/mark.man1 similarity index 99% rename from man/mark.man rename to man/mark.man1 index 71b24f6..24d84ff 100644 --- a/man/mark.man +++ b/man/mark.man1 @@ -119,7 +119,7 @@ you. If neither of these switches is specified, then existing sequences will maintain their current status, and new sequences will default to \*(lqpublic\*(rq if you have write permission for the relevant folder. Check the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page for more details about the difference between \*(lqpublic\*(rq and \*(lqprivate\*(rq sequences. .PP @@ -179,7 +179,7 @@ defined sequences. .fi .SH "SEE ALSO" -flist(1), pick(1), mh-sequence(5) +flist(1), pick(1), mh-sequence(7) .SH DEFAULTS .nf diff --git a/man/mh-alias.man b/man/mh-alias.man5 similarity index 100% rename from man/mh-alias.man rename to man/mh-alias.man5 diff --git a/man/mh-chart.man b/man/mh-chart.man1 similarity index 100% rename from man/mh-chart.man rename to man/mh-chart.man1 diff --git a/man/mh-draft.man b/man/mh-draft.man7 similarity index 97% rename from man/mh-draft.man rename to man/mh-draft.man7 index 70e988f..eebae88 100644 --- a/man/mh-draft.man +++ b/man/mh-draft.man7 @@ -1,7 +1,7 @@ .\" .\" %nmhwarning% .\" -.TH MH-DRAFT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH MH-DRAFT %manext7% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mh-draft \- draft folder facility for nmh message system .SH SYNOPSIS diff --git a/man/mh-format.man b/man/mh-format.man5 similarity index 100% rename from man/mh-format.man rename to man/mh-format.man5 diff --git a/man/mh-mail.man b/man/mh-mail.man5 similarity index 100% rename from man/mh-mail.man rename to man/mh-mail.man5 diff --git a/man/mh-profile.man b/man/mh-profile.man5 similarity index 99% rename from man/mh-profile.man rename to man/mh-profile.man5 index 43c3f2e..63633fd 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man5 @@ -79,7 +79,7 @@ command. If not present or empty, no such sequences are defined. Otherwise, for each name given, the sequence is first zero'd and then each message is added to the sequence. Read the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page for the details about this sequence. (profile, no default) .RE .PP @@ -89,7 +89,7 @@ not Defines the string which, when prefixed to a sequence name, negates that sequence. Hence, \*(lqnotseen\*(rq means all those messages that are not a member of the sequence \*(lqseen\*(rq. Read the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page for the details. (profile, no default) .RE .PP @@ -107,7 +107,7 @@ will add or remove messages from these sequences when they are incorporated or read. If not present or empty, no such sequences are defined. Otherwise, each message is added to, or removed from, each sequence name given. Read the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page for the details about this sequence. (profile, no default) .RE @@ -126,7 +126,7 @@ entry blank. (profile, default: \&.mh_sequences) Keeps track of the private sequence called \*(lqseq\*(rq in the specified folder. Private sequences are generally used for read\-only folders. See the -.BR mh\-sequence (5) +.BR mh\-sequence (7) man page for details about private sequences. (context, no default) .RE @@ -298,7 +298,7 @@ switch. (profile, no default) drafts .RS 5 Changes the default draft folder. Read the -.BR mh\-draft (5) +.BR mh\-draft (7) man page for details. (profile, default: +drafts) .RE .PP @@ -597,7 +597,7 @@ or .BR show are not given any `msgs' arguments, then they will default to using the file indicated by -.BR mh\-draft (5). +.BR mh\-draft (7). This is useful for getting the default behavior supplied by the default .IR whatnowproc . @@ -879,7 +879,7 @@ for use by .fi .SH "SEE ALSO" -nmh(1), environ(5), mh-sequence(5) +nmh(1), environ(5), mh-sequence(7) .SH HISTORY The diff --git a/man/mh-sequence.man b/man/mh-sequence.man7 similarity index 99% rename from man/mh-sequence.man rename to man/mh-sequence.man7 index ecb6502..0cfb552 100644 --- a/man/mh-sequence.man +++ b/man/mh-sequence.man7 @@ -1,7 +1,7 @@ .\" .\" %nmhwarning% .\" -.TH MH-SEQUENCE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH MH-SEQUENCE %manext7% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mh-sequence \- sequence specification for nmh message system .SH SYNOPSIS diff --git a/man/mh-tailor.man b/man/mh-tailor.man5 similarity index 100% rename from man/mh-tailor.man rename to man/mh-tailor.man5 diff --git a/man/mhbuild.man b/man/mhbuild.man1 similarity index 100% rename from man/mhbuild.man rename to man/mhbuild.man1 diff --git a/man/mhl.man b/man/mhl.man1 similarity index 100% rename from man/mhl.man rename to man/mhl.man1 diff --git a/man/mhlist.man b/man/mhlist.man1 similarity index 100% rename from man/mhlist.man rename to man/mhlist.man1 diff --git a/man/mhmail.man b/man/mhmail.man1 similarity index 100% rename from man/mhmail.man rename to man/mhmail.man1 diff --git a/man/mhparam.man b/man/mhparam.man1 similarity index 100% rename from man/mhparam.man rename to man/mhparam.man1 diff --git a/man/mhpath.man b/man/mhpath.man1 similarity index 100% rename from man/mhpath.man rename to man/mhpath.man1 diff --git a/man/mhshow.man b/man/mhshow.man1 similarity index 100% rename from man/mhshow.man rename to man/mhshow.man1 diff --git a/man/mhstore.man b/man/mhstore.man1 similarity index 100% rename from man/mhstore.man rename to man/mhstore.man1 diff --git a/man/nmh.man b/man/mmh-intro.man7 similarity index 71% rename from man/nmh.man rename to man/mmh-intro.man7 index 2006cf2..bddbda9 100644 --- a/man/nmh.man +++ b/man/mmh-intro.man7 @@ -1,41 +1,41 @@ .\" .\" %nmhwarning% .\" -.TH NMH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH NMH %manext7% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME -nmh \- new MH message system -.SH SYNOPSIS -any -.B nmh -command +mmh \- Introduction to the Modern MH message system .SH DESCRIPTION -.B nmh -is the name of a powerful message handling system. Rather than +.B mmh +is a powerful message handling system, based on +.BR nmh , +which in turn bases on MH, the Rand Corporation's Message Handler. +.PP +Rather than being a single comprehensive program, -.B nmh +.B mmh consists of a collection -of fairly simple single-purpose programs to send, retrieve, save, +of fairly simple single-purpose programs to send, retrieve, organize, and manipulate messages. .PP -Unlike most mail clients in UNIX, -.B nmh +Unlike most other mail clients, +.B mmh is not a closed system which must be explicitly run, then exited when you wish to return to the shell. -You may freely intersperse -.B nmh +Instead, you may freely intersperse +.B mmh commands with other shell commands, -allowing you to read and answer your mail while you have (for example) -a compilation running, or search for a file or run programs as needed +allowing you to read and answer your mail while you +search for a file or run programs as needed to find the answer to someone's question before answering their mail. .PP The rest of this manual entry is a quick tutorial which will teach you the basics of -.BR nmh . +.BR mmh . You should read the manual entries for the individual programs for complete documentation. .PP To get started using -.BR nmh , +.BR mmh , put the directory .I %bindir% on your @@ -51,28 +51,25 @@ manual entry for the shell you use, in case you don't know how to do this.) Run the .B mmh command. If you've never used -.B nmh +.B mmh before, it will create the necessary default files and directories after asking you if you wish it to do so. .PP .B inc moves mail from your system maildrop into your -.B nmh -`+inbox' folder, breaking it up into separate files and converting it -to -.B nmh -format as it goes. It prints one line for each message it -processes, containing the from field, the subject field and as much of -the first line of the message as will fit. It leaves the first message -it processes as your current message. You'll need to run +.B mmh +`+inbox' folder, converting it to the MH format (one file per message). +It prints one line for each message it +processes, containing the date, from and subject fields. +It leaves the first message it processes as your current message. +You'll need to run .B inc -each -time you wish to incorporate new mail into your -.B nmh -file. +each time you wish to incorporate new mail into your +.B mmh +mail storage. .PP .B scan -.B prints a list of the messages in your current folder. +prints a list of the messages in your current folder. .PP The commands: .BR show , @@ -124,20 +121,12 @@ allows you to compose a message by putting you in the editor on a prototype message form, and then lets you send it. .PP All the -.B nmh +.B mmh commands may be run with the single argument: .BR \-help , which causes them to print a list of the arguments they may be invoked with and then exit. .PP -All the -.B nmh -commands may be run with the single argument: -.BR \-version , -which cause them to print the version number of the -.B nmh -distribution, and then exit. -.PP Commands which take a message number as an argument ( .BR scan , .BR show , @@ -184,7 +173,7 @@ subject, source, destination, or content. These are beyond the scope of this manual entry. .PP Following is a list of all the -.B nmh +.B mmh commands: .PP .RS 5 @@ -204,13 +193,14 @@ commands: ^inc(1)~^\- incorporate new mail ^mark(1)~^\- mark messages ^mhbuild(1)~^\- translate MIME composition draft -^mhl(1)~^\- produce formatted listings of nmh messages +^mhl(1)~^\- produce formatted listings of mmh messages ^mhlist(1)~^\- list information about content of MIME messages ^mhmail(1)~^\- send or read mail -^mhparam(1)~^\- print nmh profile components -^mhpath(1)~^\- print full pathnames of nmh messages and folders +^mhparam(1)~^\- print mmh profile components +^mhpath(1)~^\- print full pathnames of mmh messages and folders ^mhshow(1)~^\- display MIME messages ^mhstore(1)~^\- store contents of MIME messages into files +^mmh(1)~^\- initialize the mmh environment ^msgchk(1)~^\- check for messages ^next(1)~^\- show the next message ^packf(1)~^\- compress a folder into a single file @@ -233,30 +223,38 @@ commands: ^sortm(1)~^\- sort messages ^whatnow(1)~^\- prompting front\-end for send .sp -^mh\-alias(5)~^\- alias file for nmh message system -^mh\-draft(5)~^\- draft folder facility -^mh\-format(5)~^\- format file for nmh message system -^mh\-mail(5)~^\- message format for nmh message system -^mh\-profile(5)~^\- user customization for nmh message system -^mh\-sequence(5)~^\- sequence specification for nmh message system -^mh\-tailor(5)~^\- mail transport customization for nmh message system -.sp ^ap(8)~^\- parse addresses 822\-style ^conflict(8)~^\- search for alias/password conflicts ^dp(8)~^\- parse dates 822\-style -^fmtdump(8)~^\- decode \fInmh\fP format files -^mmh(8)~^\- initialize the mmh environment +^fmtdump(8)~^\- decode \fImmh\fP format files ^post(8)~^\- deliver a message .fi .RE +.PP +Theses are descriptions of files and concepts: +.PP +.RS 5 +.fc ^ ~ +.nf +.ta 1.5i +^mh\-alias(5)~^\- alias file for mmh message system +^mh\-format(5)~^\- format file for mmh message system +^mh\-mail(5)~^\- message format for mmh message system +^mh\-profile(5)~^\- user customization for mmh message system +^mh\-tailor(5)~^\- mail transport customization for mmh message system +.sp +^mmh(7)~^\- introduction to the mmh message system +^mh\-draft(7)~^\- draft folder facility +^mh\-sequence(7)~^\- sequence specification for mmh message system +.RE .SH FILES .fc ^ ~ .nf .ta \w'%etcdir%/ExtraBigFileName 'u -^%bindir%~^contains \fInmh\fR commands -^%etcdir%~^contains \fInmh\fR format files -^%libdir%~^contains \fInmh\fR library commands +^%bindir%~^contains \fImmh\fR commands +^%etcdir%~^contains \fImmh\fR format files +^%libdir%~^contains \fImmh\fR library commands ^$HOME/.mmh~^The user's mmh directory ^$HOME/.mmh/profile~^The user's profile ^$HOME/.mmh/context~^The user's context @@ -267,32 +265,30 @@ commands: .fc ^ ~ .nf .ta 2.4i -.ta \w'ExtraBigProfileName 'u +.ta \w'LongName 'u ^Path:~^To determine the user's mail storage .fi +.SH HISTORY +.B mmh +is an experimental version of +.BR nmh , +the New Mail Handler. +Its name ``mmh'' stands primarily for ``meillo's MH'', +but also for modern, minimalistic, and non-compatible Mail Handler. + .SH BUGS -If problems are encountered with an -.B nmh -program, the problems should -be reported to the local maintainers of -.BR nmh . -When doing this, the -name of the program should be reported, along with the version information -for the program. -.br -To find out what version of an -.B nmh -program is being run, invoke -the program with the +If you encounter problems with an +.B mmh +program, please report them. +When doing this, include the version information, which you can obtain +by invoking the program with the .B \-version -switch. This information includes -the version of -.BR nmh , -the host it was generated on, and the date the -program was loaded. +switch. .PP Send bug reports and suggestions to +.IR "markus schnalke " , +or (as a fall-back) to .IR nmh-workers@nongnu.org . .SH "SEE ALSO" mh-chart(1) diff --git a/man/mmh.man b/man/mmh.man1 similarity index 90% rename from man/mmh.man rename to man/mmh.man1 index c8d7632..82117de 100644 --- a/man/mmh.man +++ b/man/mmh.man1 @@ -1,7 +1,7 @@ .\" .\" %nmhwarning% .\" -.TH MMH %manext8% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH MMH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mmh \- initialize the mmh environment .SH SYNOPSIS @@ -20,6 +20,8 @@ creates the initial setup for a first\-time .B mmh user. .PP +.B (For an introduction to the mmh system, see mmh\-intro(7).) +.PP First, the mmh directory .I $HOME/.mmh is created. @@ -40,10 +42,6 @@ If the profile is already present, the user is asked to edit it. The \fB\-c\fP option can be used to check whether or not mmh has been installed. This can be used by other programs without having knowledge about the internals of mmh. -.PP -.ft B -Note: This man page describes the command mmh; -for information about the mmh system, see mmh(7). .SH "ENVIRONMENT VARIABLES" .fc ^ ~ @@ -75,4 +73,4 @@ for information about the mmh system, see mmh(7). None .SH "SEE ALSO" -mmh(7) +mmh\-intro(7) diff --git a/man/msgchk.man b/man/msgchk.man1 similarity index 100% rename from man/msgchk.man rename to man/msgchk.man1 diff --git a/man/mts.conf.man b/man/mts.conf.man5 similarity index 100% rename from man/mts.conf.man rename to man/mts.conf.man5 diff --git a/man/new.man b/man/new.man1 similarity index 100% rename from man/new.man rename to man/new.man1 diff --git a/man/next.man b/man/next.man1 similarity index 100% rename from man/next.man rename to man/next.man1 diff --git a/man/packf.man b/man/packf.man1 similarity index 100% rename from man/packf.man rename to man/packf.man1 diff --git a/man/pick.man b/man/pick.man1 similarity index 100% rename from man/pick.man rename to man/pick.man1 diff --git a/man/post.man b/man/post.man8 similarity index 100% rename from man/post.man rename to man/post.man8 diff --git a/man/prev.man b/man/prev.man1 similarity index 100% rename from man/prev.man rename to man/prev.man1 diff --git a/man/prompter.man b/man/prompter.man1 similarity index 100% rename from man/prompter.man rename to man/prompter.man1 diff --git a/man/rcvdist.man b/man/rcvdist.man1 similarity index 100% rename from man/rcvdist.man rename to man/rcvdist.man1 diff --git a/man/rcvpack.man b/man/rcvpack.man1 similarity index 100% rename from man/rcvpack.man rename to man/rcvpack.man1 diff --git a/man/rcvstore.man b/man/rcvstore.man1 similarity index 98% rename from man/rcvstore.man rename to man/rcvstore.man1 index a14b5ab..cbc2127 100644 --- a/man/rcvstore.man +++ b/man/rcvstore.man1 @@ -117,7 +117,7 @@ to force these sequences to be public or private sequences. .fi .SH "SEE ALSO" -rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5) +rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(7) .SH DEFAULTS .nf diff --git a/man/rcvtty.man b/man/rcvtty.man1 similarity index 100% rename from man/rcvtty.man rename to man/rcvtty.man1 diff --git a/man/refile.man b/man/refile.man1 similarity index 99% rename from man/refile.man rename to man/refile.man1 index f50eacd..036baab 100644 --- a/man/refile.man +++ b/man/refile.man1 @@ -206,7 +206,7 @@ the named sequences from the source folder, .B refile will also define those sequences for the destination folders. See -.B mh\-sequence (5) +.B mh\-sequence (7) for information concerning the previous sequence. .SH BUGS diff --git a/man/repl.man b/man/repl.man1 similarity index 99% rename from man/repl.man rename to man/repl.man1 index 9aa9fd4..3f52d6c 100644 --- a/man/repl.man +++ b/man/repl.man1 @@ -369,7 +369,7 @@ the component. .PP Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. .PP diff --git a/man/rmf.man b/man/rmf.man1 similarity index 100% rename from man/rmf.man rename to man/rmf.man1 diff --git a/man/rmm.man b/man/rmm.man1 similarity index 100% rename from man/rmm.man rename to man/rmm.man1 diff --git a/man/scan.man b/man/scan.man1 similarity index 100% rename from man/scan.man rename to man/scan.man1 diff --git a/man/send.man b/man/send.man1 similarity index 99% rename from man/send.man rename to man/send.man1 index b27ecc0..c5bec46 100644 --- a/man/send.man +++ b/man/send.man1 @@ -176,7 +176,7 @@ always takes messages from the draft folder. .I +folder argument might be added in the future.) Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. .PP Once the transport system has successfully accepted custody of the diff --git a/man/sendfiles.man b/man/sendfiles.man1 similarity index 100% rename from man/sendfiles.man rename to man/sendfiles.man1 diff --git a/man/show.man b/man/show.man1 similarity index 100% rename from man/show.man rename to man/show.man1 diff --git a/man/slocal.man b/man/slocal.man1 similarity index 100% rename from man/slocal.man rename to man/slocal.man1 diff --git a/man/sortm.man b/man/sortm.man1 similarity index 100% rename from man/sortm.man rename to man/sortm.man1 diff --git a/man/unseen.man b/man/unseen.man1 similarity index 100% rename from man/unseen.man rename to man/unseen.man1 diff --git a/man/whatnow.man b/man/whatnow.man1 similarity index 99% rename from man/whatnow.man rename to man/whatnow.man1 index 7e2020e..d1c5846 100644 --- a/man/whatnow.man +++ b/man/whatnow.man1 @@ -164,7 +164,7 @@ switch sets the prompting string for .BR whatnow . .PP Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. diff --git a/man/whom.man b/man/whom.man index 9315b12..27aa597 100644 --- a/man/whom.man +++ b/man/whom.man @@ -40,7 +40,7 @@ the .B nmh draft folder facility. This is an advanced (and highly useful) feature. Consult the -.BR mh-draft (5) +.BR mh-draft (7) man page for more information. .PP The files specified by the profile entry \*(lqAliasfile:\*(rq and any -- 1.7.10.4