diplodocus.org Git - nmh/blob - man/install-mh.man

   1 .TH INSTALL-MH %manext1% 2002-11-18 "%nmhversion%"
   2 .
   3 .\" %nmhwarning%
   4 .
   5 .SH NAME
   6 install-mh \- initialize the nmh environment
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B %nmhlibexecdir%/install\-mh
  11 .RB [ \-help ]
  12 .RB [ \-version ]
  13 .RB [ \-auto ]
  14 .RB [ \-check ]
  15 .ad
  16 .SH DESCRIPTION
  17 .B install\-mh
  18 creates the initial setup for a first-time
  19 .B nmh
  20 user.
  21 .B install\-mh
  22 is installed in two locations for historical reasons.
  23 .PP
  24 The \fB\-auto\fP switch does things as automatically as possible and
  25 makes \fBinstall\-mh\fP less chatty.
  26 .PP
  27 The user is prompted for the name of the directory to be
  28 designated as the user's
  29 .B nmh
  30 directory.  If this directory does not exist, the user is asked if
  31 it should be created.  Normally, this directory should be under
  32 the user's home directory, and has the default name of
  33 \fI`Mail'\fP.
  34 .B install\-mh
  35 writes an initial
  36 .I \&.mh_profile
  37 for the user.
  38 .PP
  39 As with all
  40 .B nmh
  41 commands,
  42 .B install\-mh
  43 first checks for the existence of the \fB$MH\fP environment variable,
  44 since that, if set, gives the profile path.
  45 If it isn't set, the
  46 .B $HOME
  47 environment variable is consulted to determine the user's home directory.
  48 If
  49 .B $HOME
  50 is not set, then the
  51 .I /etc/passwd
  52 file is consulted.
  53 .PP
  54 When creating the user's
  55 .IR \&.mh_profile ,
  56 .B install\-mh
  57 will check for the existence of a global profile at
  58 .IR %nmhetcdir%/mh.profile .
  59 If found, this will be used to initialize the new
  60 .IR \&.mh_profile .
  61 .PP
  62 The \fB\-check\fP switch checks if
  63 .B nmh
  64 is installed.
  65 (This can be used by other programs to determine if
  66 .B nmh
  67 has been installed.)
  68 .SH FILES
  69 .PD 0
  70 .TP 20
  71 $HOME/.mh_profile
  72 The user's profile.
  73 .TP
  74 %nmhetcdir%/mh.profile
  75 Used to initialize user's profile.
  76 .PD
  77 .SH "PROFILE COMPONENTS"
  78 .TP 20
  79 Path:
  80 To set the user's nmh directory.
  81 .SH CONTEXT
  82 With
  83 .BR \-auto ,
  84 the current folder is changed to
  85 .RI \*(lq inbox \*(rq.