git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/RCS/comp.rf,v

   1 head    1.6;
   2 access;
   3 symbols;
   4 locks; strict;
   5
   6
   7 1.6
   8 date    90.12.17.16.29.30;      author mh;      state Exp;
   9 branches;
  10 next    1.5;
  11
  12 1.5
  13 date    90.04.05.15.12.17;      author sources; state Exp;
  14 branches;
  15 next    1.4;
  16
  17 1.4
  18 date    90.03.22.11.31.01;      author sources; state Exp;
  19 branches;
  20 next    1.3;
  21
  22 1.3
  23 date    90.03.20.19.41.37;      author sources; state Exp;
  24 branches;
  25 next    1.2;
  26
  27 1.2
  28 date    90.03.20.17.35.56;      author sources; state Exp;
  29 branches;
  30 next    1.1;
  31
  32 1.1
  33 date    90.03.20.17.20.44;      author sources; state Exp;
  34 branches;
  35 next    ;
  36
  37
  38 desc
  39 @@
  40
  41
  42 1.6
  43 log
  44 @document "-editor" better
  45 jlr
  46 @
  47 text
  48 @.\"    @@(MHWARNING)
  49 .\" @@(#)$Id: comp.rf,v 1.5 90/04/05 15:12:17 sources Exp Locker: mh $
  50 .SC COMP 1
  51 .NA
  52 comp \- compose a message
  53 .SY
  54 comp
  55 \%[+folder] \%[msg]
  56 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
  57 \%[\-editor\ editor] \%[\-noedit]
  58 \%[\-file\ file]
  59 \%[\-form\ formfile]
  60 \%[\-use] \%[\-nouse]
  61 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
  62 \%[\-help]
  63 .DE
  64 \fIComp\fR is used to create a new message to be mailed.
  65 It copies a message form to
  66 the draft being composed and then invokes an editor on the draft
  67 (unless `\-noedit' is given, in which case the initial edit is suppressed).
  68
  69 The default message form contains the following elements:
  70
  71 .nf
  72 .in +.5i
  73 .ne 10
  74 .eo
  75 .so @@(MHETCPATH)/components
  76 .ec
  77 .in -.5i
  78 .fi
  79
  80 If the file named \*(lqcomponents\*(rq exists in the user's MH directory,
  81 it will be used instead of this form.
  82 The file specified by `\-form\ formfile' will be used if given.
  83 You may also start \fIcomp\fR using the contents of an existing
  84 message as the form.
  85 If you supply either a `+folder' or `msg' argument, that message will be used
  86 as the form.  You may not supply both a `\-form\ formfile' and a `+folder' or
  87 \&`msg' argument.
  88 The line of dashes
  89 or a blank line must be left between the header and the
  90 body of the message for the message to be identified properly when it is
  91 sent (see \fIsend\fR\0(1)).
  92 The switch `\-use' directs \fIcomp\fR to
  93 continue editing an already started message.
  94 That is, if a
  95 \fIcomp\fR (or \fIdist\fR, \fIrepl\fR, or \fIforw\fR\0) is terminated without
  96 sending the draft, the draft can be edited again via
  97 \*(lqcomp\ \-use\*(rq.
  98
  99 If the draft already exists, \fIcomp\fR will ask
 100 you as to the disposition of the draft.
 101 A reply of \fBquit\fR will abort \fIcomp\fR, leaving the draft intact;
 102 \fBreplace\fR will replace the existing draft with the appropriate form;
 103 \fBlist\fR will display the draft;
 104 \fBuse\fR will use the draft for further composition;
 105 and \fBrefile\ +folder\fR will
 106 file the draft in the given folder, and give you a new draft with the
 107 appropriate form.
 108 (The `+folder' argument to \fBrefile\fR is required.)
 109
 110 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
 111 \fIMH\fR draft folder facility.
 112 This is an advanced (and highly useful) feature.
 113 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
 114 information.
 115
 116 The `\-file\ file' switch says to use the named file as the message draft.
 117
 118 The `\-editor\ editor' switch indicates the editor to
 119 use for the initial edit.
 120 Upon exiting from the editor,
 121 \fIcomp\fR will invoke the \fIwhatnow\fR program.
 122 See \fIwhatnow\fR\0(1) for a discussion of available options.
 123 The invocation of this program can be inhibited by using the `\-nowhatnowproc'
 124 switch.
 125 (In truth of fact,
 126 it is the \fIwhatnow\fR program which starts the initial edit.
 127 Hence, `\-nowhatnowproc' will prevent any edit from occurring.)
 128 .Fi
 129 ^@@(MHETCPATH)/components~^The message skeleton
 130 ^or <mh\-dir>/components~^Rather than the standard skeleton
 131 ^$HOME/\&.mh\(ruprofile~^The user profile
 132 ^<mh\-dir>/draft~^The draft file
 133 .Pr
 134 ^Path:~^To determine the user's MH directory
 135 .Ps
 136 ^Draft\-Folder:~^To find the default draft\-folder
 137 .Ps
 138 ^Editor:~^To override the default editor
 139 .Ps
 140 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 141 .Ps
 142 ^fileproc:~^Program to refile the message
 143 .Ps
 144 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 145 .Sa
 146 dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
 147 .De
 148 `+folder' defaults to the current folder
 149 .Ds
 150 `msg' defaults to the current message
 151 .Ds
 152 `\-nodraftfolder'
 153 .Ds
 154 `\-nouse'
 155 .Co
 156 None
 157 .Bu
 158 If \fIwhatnowproc\fR is \fIwhatnow\fR,
 159 then \fIcomp\fR uses a built\-in \fIwhatnow\fR,
 160 it does not actually run the \fIwhatnow\fR program.
 161 Hence, if you define your own \fIwhatnowproc\fR,
 162 don't call it \fIwhatnow\fR since \fIcomp\fR won't run it.
 163 .En
 164 @
 165
 166
 167 1.5
 168 log
 169 @add ID
 170 @
 171 text
 172 @d2 1
 173 a2 1
 174 .\" @@(#)$Id:$
 175 d71 2
 176 d99 1
 177 a99 1
 178 dist(1), forw(1), repl(1), send(1), whatnow(1)
 179 @
 180
 181
 182 1.4
 183 log
 184 @put things back, do .NA stuff another way
 185 @
 186 text
 187 @d2 1
 188 @
 189
 190
 191 1.3
 192 log
 193 @typo
 194 @
 195 text
 196 @d2 2
 197 a3 2
 198 .TH COMP 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
 199 .SH .NA
 200 d5 1
 201 a5 1
 202 .SH .SY
 203 @
 204
 205
 206 1.2
 207 log
 208 @fixup for makewhatis
 209 @
 210 text
 211 @d2 1
 212 a2 1
 213 .TH COMP 1 [mh.6] MH
 214 @
 215
 216
 217 1.1
 218 log
 219 @Initial revision
 220 @
 221 text
 222 @d2 2
 223 a3 2
 224 .SC COMP 1
 225 .NA
 226 d5 1
 227 a5 1
 228 .SY
 229 @