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