add irc channel to README
[mmh] / man / mmh.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH MMH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 mmh \- initialize the mmh environment
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B mmh
11 .RB [ \-check ]
12 .RB [ \-Version ]
13 .RB [ \-help ]
14 .ad
15 .SH DESCRIPTION
16 .PP
17 The command
18 .B mmh
19 creates the initial setup for a first\-time
20 .B mmh
21 user.
22 .PP
23 .B (For an introduction to the mmh system, see mmh\-intro(7).)
24 .PP
25 First, the mmh directory
26 .I $HOME/.mmh
27 is created.
28 .PP
29 Then the user is asked to name a directory that will be designated
30 as the user's mail storage.
31 If this directory does not exist, the user is
32 asked if it should be created.  Normally, this directory should be
33 under the user's home directory. The default is \fI$HOME/Mail\fP.
34 .PP
35 Afterwards,
36 .B mmh
37 writes an initial
38 .I $HOME/.mmh/profile
39 for the user, containing only the path to the mail storage.
40 If the profile is already present, the user is asked to edit it.
41 .PP
42 The \fB\-c\fP option can be used to check whether or not mmh has
43 been installed.  This can be used by other programs
44 without having knowledge about the internals of mmh.
45
46 .SH "ENVIRONMENT VARIABLES"
47 .fc ^ ~
48 .nf
49 .ta \w'VeryLongName  'u
50 ^$MMH~^Overrides the user's mmh directory path
51 ^$MMHP~^Overrides the user's profile path
52 .fi
53
54 .SH FILES
55 .fc ^ ~
56 .nf
57 .ta \w'%etcdir%/ExtraBigFileName  'u
58 ^$HOME/.mmh~^The user's mmh directory
59 ^$HOME/.mmh/profile~^The user's profile
60 ^$HOME/.mmh/context~^The user's context
61 ^$HOME/Mail~^The user's mail storage
62 .fi
63
64 .SH "PROFILE COMPONENTS"
65 .fc ^ ~
66 .nf
67 .ta 2.4i
68 .ta \w'ExtraBigProfileName  'u
69 ^Path:~^To set the user's mail storage
70 .fi
71
72 .SH CONTEXT
73 None
74
75 .SH "SEE ALSO"
76 mmh\-intro(7)