Mercurial > hg > Applications > mh

comparison doc/comp.me @ 0:bce86c4163a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:bce86c4163a3
1 .\" This file is automatically generated. Do not edit!
2 .\" @(#)$Id$
3 .SC COMP 1
4 .NA
5 comp \- compose a message
6 .SY
7 comp
8 \%[+folder] \%[msg]
9 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
10 \%[\-editor\ editor] \%[\-noedit]
11 \%[\-file\ file]
12 \%[\-form\ formfile]
13 \%[\-use] \%[\-nouse]
14 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
15 \%[\-help]
16 .DE
17 \fIComp\fR is used to create a new message to be mailed.
18 It copies a message form to
19 the draft being composed and then invokes an editor on the draft
20 (unless `\-noedit' is given, in which case the initial edit is suppressed).
21
22 The default message form contains the following elements:
23
24 .nf
25 .in +.5i
26 .ne 10
27 .eo
28 .so /usr/local/mh/lib/components
29 .ec
30 .in -.5i
31 .fi
32
33 If the file named \*(lqcomponents\*(rq exists in the user's MH directory,
34 it will be used instead of this form.
35 The file specified by `\-form\ formfile' will be used if given.
36 You may also start \fIcomp\fR using the contents of an existing
37 message as the form.
38 If you supply either a `+folder' or `msg' argument, that message will be used
39 as the form. You may not supply both a `\-form\ formfile' and a `+folder' or
40 \&`msg' argument.
41 The line of dashes
42 or a blank line must be left between the header and the
43 body of the message for the message to be identified properly when it is
44 sent (see \fIsend\fR\0(1)).
45 The switch `\-use' directs \fIcomp\fR to
46 continue editing an already started message.
47 That is, if a
48 \fIcomp\fR (or \fIdist\fR, \fIrepl\fR, or \fIforw\fR\0) is terminated without
49 sending the draft, the draft can be edited again via
50 \*(lqcomp\ \-use\*(rq.
51
52 If the draft already exists, \fIcomp\fR will ask
53 you as to the disposition of the draft.
54 A reply of \fBquit\fR will abort \fIcomp\fR, leaving the draft intact;
55 \fBreplace\fR will replace the existing draft with the appropriate form;
56 \fBlist\fR will display the draft;
57 \fBuse\fR will use the draft for further composition;
58 and \fBrefile\ +folder\fR will
59 file the draft in the given folder, and give you a new draft with the
60 appropriate form.
61 (The `+folder' argument to \fBrefile\fR is required.)
62
63 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
64 \fIMH\fR draft folder facility.
65 This is an advanced (and highly useful) feature.
66 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
67 information.
68
69 The `\-file\ file' switch says to use the named file as the message draft.
70
71 The `\-editor\ editor' switch indicates the editor to
72 use for the initial edit.
73 Upon exiting from the editor,
74 \fIcomp\fR will invoke the \fIwhatnow\fR program.
75 See \fIwhatnow\fR\0(1) for a discussion of available options.
76 The invocation of this program can be inhibited by using the `\-nowhatnowproc'
77 switch.
78 (In truth of fact,
79 it is the \fIwhatnow\fR program which starts the initial edit.
80 Hence, `\-nowhatnowproc' will prevent any edit from occurring.)
81 .Fi
82 ^/usr/local/mh/lib/components~^The message skeleton
83 ^or <mh\-dir>/components~^Rather than the standard skeleton
84 ^$HOME/\&.mh\(ruprofile~^The user profile
85 ^<mh\-dir>/draft~^The draft file
86 .Pr
87 ^Path:~^To determine the user's MH directory
88 .Ps
89 ^Draft\-Folder:~^To find the default draft\-folder
90 .Ps
91 ^Editor:~^To override the default editor
92 .Ps
93 ^Msg\-Protect:~^To set mode when creating a new message (draft)
94 .Ps
95 ^fileproc:~^Program to refile the message
96 .Ps
97 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
98 .Sa
99 dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
100 .De
101 `+folder' defaults to the current folder
102 .Ds
103 `msg' defaults to the current message
104 .Ds
105 `\-nodraftfolder'
106 .Ds
107 `\-nouse'
108 .Co
109 None
110 .Bu
111 If \fIwhatnowproc\fR is \fIwhatnow\fR,
112 then \fIcomp\fR uses a built\-in \fIwhatnow\fR,
113 it does not actually run the \fIwhatnow\fR program.
114 Hence, if you define your own \fIwhatnowproc\fR,
115 don't call it \fIwhatnow\fR since \fIcomp\fR won't run it.
116 .En