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

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