git.marmaro.de Git - mmh/blob - man/install-mh.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH INSTALL-MH %manext8% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 install-mh \- initialize the nmh environment
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 %libdir%/install\-mh
  15 \%[\-auto]
  16 .br
  17 \%[\-version]
  18 \%[\-help]
  19 .in -.5i
  20 .SH DESCRIPTION
  21 \fIInstall\-mh\fR is the \fInmh\fR program to create the initial setup
  22 for a first\-time \fInmh\fR user.  It is typically invoked by other
  23 \fInmh\fR commands, and should NOT be directly invoked by the user.
  24
  25 When a user runs any \fInmh\fR program for the first time, the program
  26 will invoke \fIinstall\-mh\fR (with the `\-auto' switch) to query
  27 the user for the initial \fInmh\fR environment.  The user is asked
  28 for the name of the directory that will be designated as the user's
  29 \fInmh\fR directory.  If this directory does not exist, the user is
  30 asked if it should be created.  Normally, this directory should be
  31 under the user's home directory, and has the default name of Mail/.
  32 After \fIinstall\-mh\fR has written the initial \&.mh\(ruprofile for
  33 the user, control returns to the original \fInmh\fR program.
  34
  35 As with all \fInmh\fR commands, \fIinstall\-mh\fR first consults the
  36 \fB$HOME\fR environment variable to determine the user's home directory.
  37 If \fB$HOME\fR is not set, then the \fI/etc/passwd\fR file is consulted.
  38
  39 When creating the users initial \&.mh\(ruprofile, \fIinstall\-mh\fR will
  40 check for the existence of a global profile %etcdir%/mh.profile.  If
  41 found, this will be used to initialize the new \&.mh\(ruprofile.
  42 .Fi
  43 ^$HOME/\&.mh\(ruprofile~^The user profile
  44 ^%etcdir%/mh.profile~^Used to initialize user profile
  45 .Pr
  46 ^Path:~^To set the user's nmh directory
  47 .Co
  48 With `\-auto', the current folder is changed to \*(lqinbox\*(rq.
  49 .En