Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / install-mh.rf
1 .\"     @(MHWARNING)
2 .\" @(#)$Id: install-mh.rf,v 1.6 1992/12/02 21:38:49 jromine Exp $
3 .SC INSTALL-MH 8
4 .NA
5 install-mh \- initialize the MH environment
6 .SY
7 @(MHETCPATH)/install\-mh
8 \%[\-auto]
9 \%[\-compat]
10 .DE
11 When a user runs any \fIMH\fR program for the first time,
12 the program will invoke \fIinstall\-mh\fR (with the `\-auto' switch)
13 to query the user for the initial \fIMH\fR environment.
14 The user does \fBNOT\fR invoke this program directly.
15 The user is asked for the name of the directory that will be designated
16 as the user's \fIMH\fR directory.
17 If this directory does not exist, the user is asked if it should be
18 created.
19 Normally, this directory should be under the user's home directory, 
20 and has the default name of Mail/.
21 After \fIinstall\-mh\fR has written the initial \&.mh\(ruprofile for
22 the user,
23 control returns to the original \fIMH\fR program.
24
25 As with all \fIMH\fR commands,
26 \fIinstall\-mh\fR first consults the \fB$HOME\fR envariable to
27 determine the user's home directory.
28 If \fB$HOME\fR is not set,
29 then the \fI/etc/passwd\fR file is consulted.
30
31 When converting from \fImh.3\fR to \fImh.4\fR,
32 \fIinstall\-mh\fR is automatically invoked with the `\-compat' switch.
33 .Fi
34 ^$HOME/\&.mh\(ruprofile~^The user profile
35 .Pr
36 ^Path:~^To set the user's MH directory
37 .Co
38 With `\-auto', the current folder is changed to \*(lqinbox\*(rq.
39 .En