annotate conf/doc/comp.rf @ 12:441a2190cfae

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