File: Getting-Started.html

package info (click to toggle)
mh-e 8.0.3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 8,976 kB
  • ctags: 4,351
  • sloc: lisp: 18,183; makefile: 459; sh: 97
file content (176 lines) | stat: -rw-r--r-- 11,023 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<html lang="en">
<head>
<title>Getting Started - The MH-E Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="The MH-E Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Conventions.html#Conventions" title="Conventions">
<link rel="next" href="Tour-Through-MH_002dE.html#Tour-Through-MH_002dE" title="Tour Through MH-E">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This is version 8.0.3 of `The MH-E
Manual', last updated 2006-11-12.

Copyright (C) 1995, 2001, 2002, 2003, 2005, 2006 Free
Software Foundation, Inc.

     The MH-E manual is free documentation; you can redistribute it
     and/or modify it under the terms of either:

       a. the GNU Free Documentation License, Version 1.2 or any later
          version published by the Free Software Foundation; with no
          Invariant Sections, no Front-Cover Texts, and no Back-Cover
          Texts.

       b. the GNU General Public License as published by the Free
          Software Foundation; either version 2, or (at your option)
          any later version.
     The MH-E manual is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     General Public License or GNU Free Documentation License for more
     details.

     The GNU General Public License and the GNU Free Documentation
     License appear as appendices to this document. You may also
     request copies by writing to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
   -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Getting-Started"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Tour-Through-MH_002dE.html#Tour-Through-MH_002dE">Tour Through MH-E</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Conventions.html#Conventions">Conventions</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>

<h2 class="chapter">2 Getting Started</h2>

<p><a name="index-MH_002dE_002c-versions-76"></a><a name="index-history-77"></a><a name="index-versions-of-MH_002dE-78"></a>
Because there are many old versions of MH-E out there, it is important
to know which version you have. I'll be talking about Version&nbsp;8<!-- /@w -->
which is pretty close to Version&nbsp;6<!-- /@w --> and Version&nbsp;7<!-- /@w -->. It differs
from Version&nbsp;4<!-- /@w --> and Version&nbsp;5<!-- /@w --> and is vastly different from
Version&nbsp;3<!-- /@w -->. See <a href="History.html#History">History</a>.

   <p><a name="index-mh_002dversion-79"></a>
To determine which version of MH-E that you have, enter <kbd>M-x
mh-version &lt;RET&gt;</kbd>. Hopefully it says that you're running
Version&nbsp;8.0.3<!-- /@w --> which is the latest version as of this
printing.

   <p>If your version is much older than this, please consider upgrading. 
You can have your system administrator upgrade the system-wide
version, or you can install your own personal version. It's really
quite easy. See <a href="Getting-MH_002dE.html#Getting-MH_002dE">Getting MH-E</a>, for instructions for getting and
installing MH-E.

   <p>If the <code>mh-version</code> command displays `<samp><span class="samp">No MH variant
detected</span></samp>'<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>, then you need
to install MH or tell MH-E where to find MH.

   <p><a name="index-Debian-80"></a><a name="index-nmh-81"></a><a name="index-GNU-mailutils-82"></a>
If you don't have MH on your system already, you must install a
variant of MH. The Debian mh-e package does this for you automatically
(see <a href="Getting-MH_002dE.html#Getting-MH_002dE">Getting MH-E</a>). Most people use
<a href="http://www.nongnu.org/nmh/">nmh</a>, but you may be interested in
trying out <a href="http://www.gnu.org/software/mailutils/">GNU mailutils</a>, which supports IMAP. Your GNU/Linux distribution probably
has packages for both of these.

   <p><a name="index-g_t_0040command_007binstall_002dmh_007d-83"></a><a name="index-MH-commands_002c-_0040command_007binstall_002dmh_007d-84"></a><a name="index-MH-book-85"></a>
If you've never run MH before, you need to run <samp><span class="command">install-mh</span></samp>
from the shell before you continue. This sets up your personal MH
environment<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a>. If you don't, you'll be greeted with the error message:
`<samp><span class="samp">Install MH and run install-mh before running MH-E</span></samp>'. This is all
you need to know about MH to use MH-E, but the more you know about MH,
the more you can leverage its power. See the
<a href="http://rand-mh.sourceforge.net/book/mh/../">MH book</a> to learn more about MH.

   <p><a name="index-g_t_0040samp_007bPath_003a_007d-MH-profile-component-86"></a><a name="index-MH-profile-87"></a><a name="index-MH-profile-component-88"></a><a name="index-MH-profile-component_002c-_0040samp_007bPath_003a_007d-89"></a>
Your MH environment includes your <dfn>MH profile</dfn> which is found in
the file <samp><span class="file">~/.mh_profile</span></samp>. This file contains a number of <dfn>MH
profile components</dfn>. For example, the `<samp><span class="samp">Path:</span></samp>' MH profile
component contains the path to your mail directory, which is
<samp><span class="file">~/Mail</span></samp> by default.

   <p><a name="index-g_t_0040command_007bmhparam_007d-90"></a><a name="index-MH-commands_002c-_0040command_007bmhparam_007d-91"></a><a name="index-exec_002dpath-92"></a><a name="index-mh_002dpath-93"></a><a name="index-mh_002dsys_002dpath-94"></a><a name="index-mh_002dvariant-95"></a><a name="index-mh_002dvariant_002din_002duse-96"></a>
There are several options MH-E uses to interact with your MH
installation. The option <code>mh-variant</code> specifies the variant used
by MH-E (see <a href="Options.html#Options">Options</a>). The default setting of this option is
`<samp><span class="samp">Auto-detect</span></samp>' which means that MH-E will automatically choose the
first of nmh, MH, or GNU mailutils that it finds in the directories
listed in <code>mh-path</code> (which you can customize),
<code>mh-sys-path</code>, and <code>exec-path</code>. If MH-E can't find MH at
all, you may have to customize <code>mh-path</code> and add the directory in
which the command <samp><span class="command">mhparam</span></samp> is located. If, on the other hand,
you have both nmh and mailutils installed (for example) and
<code>mh-variant-in-use</code> was initialized to nmh but you want to use
mailutils, then you can set <code>mh-variant</code> to `<samp><span class="samp">mailutils</span></samp>'.

   <p><a name="index-mh_002dflists_002dpresent_002dflag-97"></a><a name="index-mh_002dlib-98"></a><a name="index-mh_002dlib_002dprogs-99"></a><a name="index-mh_002dprogs-100"></a>
When <code>mh-variant</code> is changed, MH-E resets <code>mh-progs</code>,
<code>mh-lib</code>, <code>mh-lib-progs</code>, <code>mh-flists-present-flag</code>, and
<code>mh-variant-in-use</code> accordingly.

   <p><a name="index-g_t_0040file_007b_002eemacs_007d-101"></a><a name="index-files_002c-_0040file_007b_002eemacs_007d-102"></a>
   <pre class="sp">

</pre>
<div align="center"><strong>NOTE</strong></div>

<blockquote>
Prior to version 8, it was often necessary to set some of these
variables in <samp><span class="file">~/.emacs</span></samp>; now it is no longer necessary and can
actually cause problems. 
</blockquote>

   <pre class="sp">

</pre>

<a name="index-MH-profile-component_002c-_0040samp_007bDraft_002dFolder_003a_007d-103"></a><a name="index-MH-profile-component_002c-_0040samp_007bPath_003a_007d-104"></a><a name="index-MH-profile-component_002c-_0040samp_007bPrevious_002dSequence_003a_007d-105"></a><a name="index-MH-profile-component_002c-_0040samp_007bUnseen_002dSequence_003a_007d-106"></a><a name="index-g_t_0040samp_007bDraft_002dFolder_003a_007d-MH-profile-component-107"></a><a name="index-g_t_0040samp_007bPath_003a_007d-MH-profile-component-108"></a><a name="index-g_t_0040samp_007bPrevious_002dSequence_003a_007d-MH-profile-component-109"></a><a name="index-g_t_0040samp_007bUnseen_002dSequence_003a_007d-MH-profile-component-110"></a><a name="index-mh_002dfind_002dpath-111"></a><a name="index-mh_002ddraft_002dfolder-112"></a><a name="index-mh_002dfind_002dpath_002dhook-113"></a><a name="index-mh_002dinbox-114"></a><a name="index-mh_002dprevious_002dseq-115"></a><a name="index-mh_002dunseen_002dseq-116"></a><a name="index-mh_002duser_002dpath-117"></a>
In addition to setting variables that point to MH itself, MH-E also
sets a handful of variables that point to where you keep your mail. 
During initialization, the function <code>mh-find-path</code> sets
<code>mh-user-path</code> from your `<samp><span class="samp">Path:</span></samp>' MH profile component (but
defaults to `<samp><span class="samp">Mail</span></samp>' if one isn't present), <code>mh-draft-folder</code>
from `<samp><span class="samp">Draft-Folder:</span></samp>', <code>mh-unseen-seq</code> from
`<samp><span class="samp">Unseen-Sequence:</span></samp>', <code>mh-previous-seq</code> from
`<samp><span class="samp">Previous-Sequence:</span></samp>', and <code>mh-inbox</code> from `<samp><span class="samp">Inbox:</span></samp>'
(defaults to `<samp><span class="samp">+inbox</span></samp>'). The hook <code>mh-find-path-hook</code> is run
after these variables have been set. This hook can be used the change
the value of these variables if you need to run with different values
between MH and MH-E.

   <div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> In very old versions of MH-E, you may get the error
message, `<samp><span class="samp">Cannot find the commands `inc' and `mhl' and the file
`components'</span></samp>' if MH-E can't find MH. In this case, you need to update
MH-E, and you may need to install MH too. However, newer versions of
MH-E are better at finding MH if it is on your system.</p>

   <p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> See the section
<a href="http://rand-mh.sourceforge.net/book/mh/../overall/setup.html">Setting Up MH</a> in the
MH book.</p>

   <p><hr></div>

   </body></html>