Reworked the man page system and some man page contents (mmh-intro).
[mmh] / man / mmh-intro.man7
similarity index 71%
rename from man/nmh.man
rename to man/mmh-intro.man7
index 2006cf2..bddbda9 100644 (file)
@@ -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 <meillo@marmaro.de>" ,
+or (as a fall-back) to
 .IR nmh-workers@nongnu.org .
 .SH "SEE ALSO"
 mh-chart(1)