Updated all man pages and renamed install-mh.man to mmh.man.

[mmh] / man / mmh.man

diff --git a/man/mmh.man b/man/mmh.man
new file mode 100644 (file)
index 0000000..c8d7632
--- /dev/null
+++ b/man/mmh.man
@@ -0,0 +1,78 @@
+.\"
+.\" %nmhwarning%
+.\"
+.TH MMH %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+mmh \- initialize the mmh environment
+.SH SYNOPSIS
+.HP 5
+.na
+.B mmh
+.RB [ \-check ]
+.RB [ \-version ]
+.RB [ \-help ]
+.ad
+.SH DESCRIPTION
+.PP
+The command
+.B mmh
+creates the initial setup for a first\-time
+.B mmh
+user.
+.PP
+First, the mmh directory
+.I $HOME/.mmh
+is created.
+.PP
+Then the user is asked to name a directory that will be designated
+as the user's mail storage.
+If this directory does not exist, the user is
+asked if it should be created.  Normally, this directory should be
+under the user's home directory. The default is \fI$HOME/Mail\fP.
+.PP
+Afterwards,
+.B mmh
+writes an initial
+.I $HOME/.mmh/profile
+for the user, containing only the path to the mail storage.
+If the profile is already present, the user is asked to edit it.
+.PP
+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 ^ ~
+.nf
+.ta \w'VeryLongName  'u
+^$MMH~^Overrides the user's mmh directory path
+^$MMHP~^Overrides the user's profile path
+.fi
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^$HOME/.mmh~^The user's mmh directory
+^$HOME/.mmh/profile~^The user's profile
+^$HOME/.mmh/context~^The user's context
+^$HOME/Mail~^The user's mail storage
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^Path:~^To set the user's mail storage
+.fi
+
+.SH CONTEXT
+None
+
+.SH "SEE ALSO"
+mmh(7)