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 .B %libdir%/install\-mh
  11 .RB [ \-auto ]
  12 .RB [ \-version ]
  13 .RB [ \-help ]
  14 .SH DESCRIPTION
  15 .B Install\-mh
  16 is the
  17 .B nmh
  18 program to create the initial setup
  19 for a first\-time
  20 .B nmh
  21 user.  It is typically invoked by other
  22 .B nmh
  23 commands, and should NOT be directly invoked by the user.
  24 .PP
  25 When a user runs any
  26 .B nmh
  27 program for the first time, the program will invoke
  28 .B install\-mh
  29 (with the `\-auto' switch) to query the user for the initial
  30 .B nmh
  31 environment.  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 .RI \*(lq Mail/ \*(rq.
  38 After
  39 .B install\-mh
  40 has written the initial
  41 .I \&.mh\(ruprofile
  42 for the user, control returns to the original
  43 .B nmh
  44 program.
  45 .PP
  46 As with all
  47 .B nmh
  48 commands,
  49 .B install\-mh
  50 first consults the
  51 .B $HOME
  52 environment variable to determine the user's home directory.
  53 If
  54 .B $HOME
  55 is not set, then the
  56 .I /etc/passwd
  57 file is consulted.
  58 .PP
  59 When creating the users initial
  60 .IR \&.mh\(ruprofile ,
  61 .B install\-mh
  62 will check for the existence of a global profile
  63 .IR %etcdir%/mh.profile .
  64 If found, this will be used to initialize the new
  65 .IR \&.mh\(ruprofile .
  66
  67 .SH FILES
  68 .fc ^ ~
  69 .nf
  70 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
  71 ^$HOME/\&.mh\(ruprofile~^The user profile
  72 ^%etcdir%/mh.profile~^Used to initialize user profile
  73 .fi
  74
  75 .SH "PROFILE COMPONENTS"
  76 .fc ^ ~
  77 .nf
  78 .ta 2.4i
  79 .ta \w'ExtraBigProfileName  'u
  80 ^Path:~^To set the user's nmh directory
  81 .fi
  82
  83 .SH CONTEXT
  84 With
  85 .BR \-auto ,
  86 the current folder is changed to
  87 .RI \*(lq inbox \*(rq.