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

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