Update the manpage authors guide, primarily for .TP, but also fixes
[mmh] / docs / README-components
1 As of the 1.5 release, nmh has made significant changes to the way most of
2 the message composition utilites work, specifically with the way
3 the components templates are handled.  If you use the default
4 components templates that come with nmh then everything should work
5 with only minor changes, but if you have custom component templates
6 you should read this information carefully to understand how you
7 might need to adapt your component templates.
8
9 - "post" now requires a From: header in all drafts that it processes
10   for sending (a "Resent-From" header is accepted for use with "dist").
11
12 - You should now use %(localmbox) instead of %(me) especially in replcomps
13   and replgroupcomps.
14
15 - The nmh programs "comp", "forw", and "dist" now process all component
16   template files using the format routines in mh-format(5).  The default
17   templates are configured to place an appropriate From: header in them.
18   Any custom templates you use will either have to be adapter to add an
19   appropriate From: header or you will have to manually put one in
20   the draft.
21
22 - "comp", "forw", and "dist" all have new switches "-from", "-to", "-cc",
23   "-fcc", and "-subject" that can be used to adjust the headers that
24   appear in the draft.  See the default component files and the program
25   man pages to see exactly how this works with mh-format.
26
27 - The default From: header is constructed based on the Unix username and
28   the local hostname.  This can be overridden using the Local-Mailbox
29   profile entry.
30
31 - A number of new format instructions are available:
32
33   %(myhost)     - The local hostname
34   %(myname)     - The local user's name (GECOS field)
35   %(localmbox)  - The local mailbox (either Local-Mailbox or user@host).
36                   This should now be used instead of %(me) in nearly all
37                   cases (%(me) only outputs the local Unix username).
38   %(putlit)     - Out the contents of the str register without space
39                   compression.
40   %(concataddr) - Construct an address list like %(formataddr), except that
41                   it will NOT perform duplicate supression (currently
42                   duplicate supression only happens inside of
43                   "repl").  One possible use of this function is to
44                   construct an address list and use %(match) to decide
45                   which "From:" address to use.