new.c: Order two return statements to match comment.

[nmh] / man / install-mh.man

diff --git a/man/install-mh.man b/man/install-mh.man
index 72c62757cdf75f4fb204c7a1819fd843eacb3ddf..41e9ae48a10e45986dc70469961f29039f7b143d 100644 (file)
--- a/man/install-mh.man
+++ b/man/install-mh.man
@@ -1,49 +1,85 @@
-.\"
+.TH INSTALL-MH %manext1% 2002-11-18 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH INSTALL-MH %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 install-mh \- initialize the nmh environment
 .SH SYNOPSIS
 .SH NAME
 install-mh \- initialize the nmh environment
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-%libdir%/install\-mh
-\%[\-auto]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B %nmhlibexecdir%/install\-mh
+.RB [ \-help ]
+.RB [ \-version ]
+.RB [ \-auto ]
+.RB [ \-check ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fIInstall\-mh\fR is the \fInmh\fR program to create the initial setup
-for a first\-time \fInmh\fR user.  It is typically invoked by other
-\fInmh\fR commands, and should NOT be directly invoked by the user.
-
-When a user runs any \fInmh\fR program for the first time, the program
-will invoke \fIinstall\-mh\fR (with the `\-auto' switch) to query
-the user for the initial \fInmh\fR environment.  The user is asked
-for the name of the directory that will be designated as the user's
-\fInmh\fR directory.  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, and has the default name of Mail/.
-After \fIinstall\-mh\fR has written the initial \&.mh\(ruprofile for
-the user, control returns to the original \fInmh\fR program.
-
-As with all \fInmh\fR commands, \fIinstall\-mh\fR first consults the
-\fB$HOME\fR environment variable to determine the user's home directory.
-If \fB$HOME\fR is not set, then the \fI/etc/passwd\fR file is consulted.
-
-When creating the users initial \&.mh\(ruprofile, \fIinstall\-mh\fR will
-check for the existence of a global profile %etcdir%/mh.profile.  If
-found, this will be used to initialize the new \&.mh\(ruprofile.
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-^%etcdir%/mh.profile~^Used to initialize user profile
-.Pr
-^Path:~^To set the user's nmh directory
-.Co
-With `\-auto', the current folder is changed to \*(lqinbox\*(rq.
-.En
+.B install\-mh
+creates the initial setup for a first-time
+.B nmh
+user.
+.B install\-mh
+is installed in two locations for historical reasons.
+.PP
+The \fB\-auto\fP switch does things as automatically as possible and
+makes \fBinstall\-mh\fP less chatty.
+.PP
+The user is prompted for the name of the directory to be
+designated as the user's
+.B nmh
+directory.  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, and has the default name of
+\fI`Mail'\fP.
+.B install\-mh
+writes an initial
+.I \&.mh_profile
+for the user.
+.PP
+As with all
+.B nmh
+commands,
+.B install\-mh
+first checks for the existence of the \fB$MH\fP environment variable,
+since that, if set, gives the profile path.
+If it isn't set, the
+.B $HOME
+environment variable is consulted to determine the user's home directory.
+If
+.B $HOME
+is not set, then the
+.I /etc/passwd
+file is consulted.
+.PP
+When creating the user's
+.IR \&.mh_profile ,
+.B install\-mh
+will check for the existence of a global profile at
+.IR %nmhetcdir%/mh.profile .
+If found, this will be used to initialize the new
+.IR \&.mh_profile .
+.PP
+The \fB\-check\fP switch checks if
+.B nmh
+is installed.
+(This can be used by other programs to determine if
+.B nmh
+has been installed.)
+.SH FILES
+.PD 0
+.TP 20
+$HOME/.mh_profile
+The user's profile.
+.TP
+%nmhetcdir%/mh.profile
+Used to initialize user's profile.
+.PD
+.SH "PROFILE COMPONENTS"
+.TP 20
+Path:
+To set the user's nmh directory.
+.SH CONTEXT
+With
+.BR \-auto ,
+the current folder is changed to
+.RI \*(lq inbox \*(rq.