~ubuntu-branches/ubuntu/gutsy/mh-book/gutsy

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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<!-- $Id: to-do.html 600 2006-05-31 22:13:43Z wohler $ -->
<html>

  <head>
    <meta name="Author" content="Jerry Peek">
    <title>Ideas for Revising This Book: MH &amp; nmh: Email for Users & Programmers</title>
    <?$book = '.'?>
    <link rel="stylesheet" href="<?=$book?>/mh.css" type="text/css">
  </head>

  <body>
    <?
      include "$book/mh.php";
      includeHeader('browhelp.html', 'overall/ch-p.html');
    ?>

    <h1>Ideas for Revising This Book</h1>

    <p>This book doesn't cover all of MH &amp; nmh, and what it does
    cover can always be improved. You can help!

    <p>
    If you have suggestions, please join <a
    href="https://lists.sourceforge.net/lists/listinfo/rand-mh-devel">
    <i>rand-mh-devel at lists.sourceforge.net</i></a>, send a note,
    and propose your
    changes. <a
    href="http://sourceforge.net/tracker/?group_id=143658&atid=756145">Submit
    a patch</a>. Ask to become a developer on the mailing list and
    check the files in yourself. You can also contact the original
    authors
    directly: <a href="http://www.jpeek.com/contact.html">Jerry
    Peek</a>, <a href="http://www.newt.com/wohler/">Bill Wohler</a>
    (MH-E) and <a href="mailto:welch at acm.org">Brent Welch</a>
    (<i>exmh</i>).

    <p>
    Here's a list of some ideas that we've had along the way. The
    numbers in the list do NOT indicate priority. They just make items
    easier to identify.

    <ol>

      <li>
      Convert to a wiki?

      <li>
      Document GNU mailutils.

      <li>
      Document nmh installation. Make a starting-place document; get
      people to add to it via this to-do list and/or posting to
      mailing list.

      <li>
      Watch for nmh changes, update book.

      <li>
      Fix scripts:

      <ul>

        <li>
        Downcase comments in scripts to make them easier to read.

        <li>
        Don't hardcode paths like /bin/find! Set a global PATH.

        <li>
        Don't assume "rm -f" will be quiet if no files named (because
        variable expanded to nothing). Redirect output and error to
        /dev/null or add a test to see if variable set.

        <li>
        Make all (?) scripts use two traps -- 0 and interrupt --
        instead of a single trap which can get executed twice on
        interrupt.

        <li>
        Watch out for [OVERHEAD] config option messing up scripts that
        use file descriptors 3 and above.

        <li>
        Update "rmmer" to work around MHCONTEXT problem I found
        05/25/97: refile gets current folder based on context instead
        of on rmm's command-line argument

        <li>
        Try to finish mrepl script (reply to MIME messages, include
        decoded content) and/or include the Perl version.

        <li>
        Fix rfl to use last message date as header date, instead of
        current date... otheriwse, sortm can put old messages in
        really wrong place. (Add switch to do that?) Also make it use
        a numeric timezone?

      </ul>

      <li>
      Read through index in book, notice places that obviously need
      fixing, make fix in online files. I did Preface thru Chapter 4,
      also lightly over chapters 5-9. Add more index entries,
      especially to the sections that were new in the third edition.
      Maybe use "grep -c" (or uniq) to count number of entries for
      each file in the indexes; use "join" to merge with number of
      lines in each file... long files should have lots of index
      entries. Here are files I've noticed that need more entries:

      <ul>

        <li>
        mh/pccewca.html

        <li>
        The r-*.html reference guide files: index the options that
        aren't covered anywhere else (that don't have links from an
        r-*.html file to some other .html file)
      </ul>

      <li>
      Add more indexing by concept. Example: pick does searching, so
      there should be entries like "search (see pick)". Maybe be more
      detailed and use subentries "search, by sender (see pick
      -from)". Be sure these "see"s point to useful entries.

      <li>
      Replace <i>index-raw</i> files by inserting content of index
      entry in an attribute where the anchor is defined. For example,

      <pre>
        &lt;a name="index0" text="MH	downloading source code"&gt;&lt;/a&gt;
      </pre>

      Update <i>index-make.pl</i> accordingly.

      <li>
      Expand browhelp.html file into an online help-and-tips file (in
      a subdirectory?). Then add a [help] link to all pages?

      <li>
      Search all files for XXX, &lt;!--, (and ***?): there are things
      to fix.

      <li>
      Explain how mhn-show-multipart/report (etc) gives multiple
      arguments to the command named, so you usually shouldn't quote
      the %F or %f.

      <li>
      Explain problem with mhn handling of unknown multipart content
      types, show workaround like my multipart/report fix of letting
      "less" show each part (with a shell script to handle the
      parts?). This has been fixed in nmh.

      <li>
      Make link to each section's table of contents in the complete
      TOC? Now have the only links to lists of tables, sidebars, etc.

      <li>
      Document BBoards, at least the basics? nmh may delete them.

      <li>
      The book doesn't seem to explain stuff like picked:first or
      next:10, except a brief mention in Chapter 5.7. (shomes.html has
      examples, and so does my next section on pick2me.) Figure out
      where to put it, and add xrefs from above sections to it.

      <li>
      Put back old appendices that I deleted from third edition? (Some
      of those scripts are buggy...)

      <li>
      Move figures close to the text that describes them (in book,
      they were placed to print well). Watch for links that say "the
      Figure above/below"; be sure they're right.

      <li>
      Make a PostScript version in Times and Courier fonts? Does ORA
      have any macros to do that? Or save browser pages as PostScript
      (can I automate netscape to do that? Check release notes).
      Eventually re-code the whole book in SGML, or Docbook.

      <li>
      Add more troubleshooting info.

      <li>
      Add a shell functions file to the <i>examples/mh/misc</i> directory;
      make it like aliases.csh. Also add pointer to it from
      mhanthsh.html.

      <li>
      Update replbcomps, when MH fixes its replcomps file, to conform
      to new DRUMS replacement for RFC822.

      <li>
      Explain contination lines in replcomps, other undocumented
      related stuff. My guess now is:

      <ul>

        <li>
        Any line that ends without a backslash will be output on a new
        line

        <li>
        Every control escape that makes a line which maybe shouldn't
        appear should end with "\n%>\". The backslash at the end is
        important because it prevents a blank line if the control
        escape doesn't output anything?? (check)

        <li>
        Watch whitespace before backslashes and leading whitespace on
        continued lines: it's output just like any other text!
      </ul>

      <li>
      Show how to reorganize a folder by moving msgs to end with
      "refile @."

      <li>
      Document the *procs (showproc, etc.); see nmh mh-profile manpage
      for details
    </ol>

    <?
      includeFooter('$Date: 2006-05-31 15:13:43 -0700 (Wed, 31 May 2006) $',
        'Jerry: 1997; Bill: 2006');
    ?>
  </body>
</html>