X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/1b5a1bd2244d3e1c12b7c9e1f48e445de5ad2ea2..6fd1d18f:/man/install-mh.man?ds=sidebyside diff --git a/man/install-mh.man b/man/install-mh.man index 97e0ff7b..41e9ae48 100644 --- a/man/install-mh.man +++ b/man/install-mh.man @@ -1,87 +1,83 @@ -.\" +.TH INSTALL-MH %manext1% 2002-11-18 "%nmhversion%" +. .\" %nmhwarning% -.\" $Id$ -.\" -.TH INSTALL-MH %manext8% "%nmhdate%" MH.6.8 [%nmhversion%] +. .SH NAME install-mh \- initialize the nmh environment .SH SYNOPSIS .HP 5 .na -.B %libdir%/install\-mh -.RB [ \-auto ] -.RB [ \-version ] +.B %nmhlibexecdir%/install\-mh .RB [ \-help ] +.RB [ \-version ] +.RB [ \-auto ] +.RB [ \-check ] .ad .SH DESCRIPTION -.B Install\-mh -is the -.B nmh -program to create the initial setup -for a first\-time -.B nmh -user. It is typically invoked by other -.B nmh -commands, and should NOT be directly invoked by the user. -.PP -When a user runs any -.B nmh -program for the first time, the program will invoke .B install\-mh -(with the `\-auto' switch) to query the user for the initial -.B nmh -environment. The user is asked -for the name of the directory that will be designated as the user's +creates the initial setup for a first-time .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 -.RI \*(lq Mail/ \*(rq. -After +user. .B install\-mh -has written the initial -.I \&.mh\(ruprofile -for the user, control returns to the original +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 -program. +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 consults the +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 to determine the user's home directory. +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 users initial -.IR \&.mh\(ruprofile , +When creating the user's +.IR \&.mh_profile , .B install\-mh -will check for the existence of a global profile -.IR %etcdir%/mh.profile . +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\(ruprofile . - +.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 -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^%etcdir%/mh.profile~^Used to initialize user profile -.fi - +.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" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To set the user's nmh directory -.fi - +.TP 20 +Path: +To set the user's nmh directory. .SH CONTEXT With .BR \-auto ,