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