Use the same mh_hostname() function from test/common.h in mhsign(1)
[mmh] / man / mmh-intro.man7
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH NMH %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 mmh \- Introduction to the Modern MH message system
7 .SH DESCRIPTION
8 .B mmh
9 is a powerful message handling system, based on
10 .BR nmh ,
11 which in turn bases on MH, the Rand Corporation's Message Handler.
12 .PP
13 Rather than
14 being a single comprehensive program,
15 .B mmh
16 consists of a collection
17 of fairly simple single-purpose programs to send, retrieve, organize,
18 and manipulate messages.
19 .PP
20 Unlike most other mail clients,
21 .B mmh
22 is not a closed system which
23 must be explicitly run, then exited when you wish to return to the shell.
24 Instead, you may freely intersperse
25 .B mmh
26 commands with other shell commands,
27 allowing you to read and answer your mail while you
28 search for a file or run programs as needed
29 to find the answer to someone's question before answering their mail.
30 .PP
31 The rest of this manual entry is a quick tutorial which will teach you
32 the basics of
33 .BR mmh .
34 You should read the manual entries for the
35 individual programs for complete documentation.
36 .PP
37 To get started using
38 .BR mmh ,
39 put the directory
40 .I %bindir%
41 on your
42 .BR $PATH .
43 This is best done in one of the files:
44 .IR \&.profile ,
45 .IR \&.login ,
46 .IR \&.bashrc ,
47 or
48 .I \&.cshrc
49 in your home directory.  (Check the
50 manual entry for the shell you use, in case you don't know how to
51 do this.) Then run the
52 .B mmh
53 command.  If you've never used
54 .B mmh
55 before, it will create the necessary default files and directories after
56 asking you if you wish it to do so.
57 .PP
58 .B inc
59 moves mail from your system maildrop into your
60 .B mmh
61 `+inbox' folder, converting it to the MH format (one file per message). 
62 It prints one line for each message it
63 processes, containing the date, from and subject fields.
64 It leaves the first message it processes as your current message.
65 You'll need to run
66 .B inc
67 each time you wish to incorporate new mail into your
68 .B mmh
69 mail storage.
70 .PP
71 .B scan
72 prints a list of the messages in your current folder.
73 .PP
74 The commands:
75 .BR show ,
76 .BR next ,
77 and
78 .B prev
79 are used to read
80 specific messages from the current folder.
81 .B show
82 displays the
83 current message, or a specific message, which may be specified by its
84 number, which you pass as an argument to
85 .BR show .
86 .B next
87 and
88 .B prev
89 display, respectively, the message numerically after or before
90 the current message.  In all cases, the message displayed becomes the
91 current message.  If there is no current message,
92 .B show
93 may be
94 called with an argument, or
95 .B next
96 may be used to advance to the
97 first message.
98 .PP
99 .B rmm
100 (remove message) deletes the current message.  It may be called
101 with message numbers passed as arguments, to delete specific messages.
102 .PP
103 .B repl
104 is used to respond to the current message (by default).
105 It places you in the editor with a prototype response form.
106 After completing your response, type
107 .B li
108 to
109 .B list
110 (review) it, or
111 .B s
112 to
113 .B send
114 it.
115 .PP
116 .B comp
117 allows you to compose a fresh message by putting you in the editor
118 on a prototype message form, and then lets you send it.
119 .PP
120 All the
121 .B mmh
122 commands may be run with the single argument:
123 .BR \-help ,
124 which causes them to print a list of the arguments they may be invoked
125 with and then exit.
126 .PP
127 Commands which take a message number as an argument
128 .RB ( scan ,
129 .BR show ,
130 .BR repl ,
131 \&...)  also take one of the letters: `f',
132 `p', `c', `n', or `l' to indicate
133 (respectively) the first, previous, current, next, or last message in
134 the current folder (assuming they are defined).
135
136 Commands which take a range of message numbers
137 .RB ( rmm ,
138 .BR scan ,
139 .BR show ,
140 \&...)  also take any of the abbreviations:
141 .PP
142 .RS 5
143 .IP \fI<num1>\fR\-\fI<num2>\fR 15
144 Indicates all messages in the range <num1> to <num2>, inclusive.
145 The range must be nonempty.
146 .IP \fI<num>\fR:+\fIN\fR 15
147 .IP \fI<num>\fR:\-\fIN\fR 15
148 Up to
149 .I N
150 messages beginning with (or ending with) message
151 .IR num .
152 .I Num
153 may be any of the pre-defined symbols:
154 .IR f ,
155 .IR p ,
156 .IR c ,
157 .I n
158 or
159 .IR l .
160 .IP f:\fIN\fR 15
161 .IP p:\fIN\fR 15
162 .IP n:\fIN\fR 15
163 .IP l:\fIN\fR 15
164 The first, previous, next or last
165 messages, if they exist.
166 .RE
167 .PP
168 There are many other possibilities such as creating multiple folders
169 for different topics, and automatically refiling messages according to
170 subject, source, destination, or content.  These are beyond the scope
171 of this manual entry.
172 .PP
173 Following is a list of all the
174 .B mmh
175 commands:
176 .PP
177 .RS 5
178 .fc ^ ~
179 .nf
180 .ta 1.7i
181 %titles1%
182 .sp
183 %titles8%
184 .fi
185 .RE
186 .PP
187 The following man pages describe file formats and concepts:
188 .PP
189 .RS 5
190 .fc ^ ~
191 .nf
192 .ta 1.7i
193 %titles5%
194 .sp
195 %titles7%
196 .RE
197
198 .SH FILES
199 .fc ^ ~
200 .nf
201 .ta \w'%etcdir%/FileName  'u
202 ^%bindir%~^contains \fImmh\fR commands
203 ^%etcdir%~^contains \fImmh\fR format files
204 ^%libdir%~^contains \fImmh\fR library commands
205 ^$HOME/.mmh~^The user's mmh directory
206 ^$HOME/.mmh/profile~^The user's profile
207 ^$HOME/.mmh/context~^The user's context
208 ^$HOME/Mail~^Default location of the user's mail storage
209 .fi
210
211 .SH "PROFILE COMPONENTS"
212 .fc ^ ~
213 .nf
214 .ta 2.4i
215 .ta \w'LongName  'u
216 ^Path:~^Location of the user's mail storage
217 .fi
218
219 .SH HISTORY
220 .B mmh
221 is an experimental version of
222 .BR nmh ,
223 the New Mail Handler.
224 Its name ``mmh'' stands for ``meillo's mail handler''.
225
226 .SH BUGS
227 If you encounter problems with an
228 .B mmh
229 program, please report them.
230 When doing this, include the version information, which you can obtain
231 by invoking the program with the
232 .B \-Version
233 switch.
234 .PP
235 Send bug reports, comments, and suggestions to
236 .I <mmh@marmaro.de>
237 or to
238 .IR "markus schnalke <meillo@marmaro.de>" .
239
240 .SH "SEE ALSO"
241 mmh(1)
242 mh-chart(1)