diplodocus.org Git - nmh/blob - man/comp.man

   1 .TH COMP %manext1% "May 21, 2012" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 comp \- compose a message
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B comp
  11 .RI [ +folder ]
  12 .RI [ msg ]
  13 .RB [ \-form
  14 .IR formfile ]
  15 .RB [ \-use " | " \-nouse ]
  16 .RB [ \-file
  17 .IR file ]
  18 .RB [ \-draftfolder
  19 .IR +folder ]
  20 .RB [ \-draftmessage
  21 .IR msg ]
  22 .RB [ \-nodraftfolder ]
  23 .RB [ \-editor
  24 .IR editor ]
  25 .RB [ \-noedit ]
  26 .RB [ \-width
  27 .IR columns ]
  28 .RB [ \-from
  29 .IR address ]
  30 .RB [ \-to
  31 .IR address ]
  32 .RB [ \-cc
  33 .IR address ]
  34 .RB [ \-fcc
  35 .IR +folder ]
  36 .RB [ \-subject
  37 .IR text ]
  38 .RB [ \-whatnowproc
  39 .IR program ]
  40 .RB [ \-nowhatnowproc ]
  41 .RB [ \-build ]
  42 .RB [ \-version ]
  43 .RB [ \-help ]
  44 .ad
  45 .SH DESCRIPTION
  46 .B Comp
  47 is used to create a new message to be mailed.  It copies a
  48 message form to the draft being composed and then invokes an editor on
  49 the draft (unless
  50 .B \-noedit
  51 is given, in which case the initial edit is suppressed).
  52 .PP
  53 The default message template \*(lqcomponents\*(rq will direct
  54 .B comp
  55 to construct the message draft as follows:
  56 .PP
  57 .RS 5
  58 .nf
  59 From: {from switch} or <Local-Mailbox> or <username@hostname>
  60 To: {to switch} or blank
  61 cc: {cc switch} or blank
  62 Fcc: {fcc switch} or +outbox
  63 Subject: {subject switch} or blank
  64 --------
  65 .fi
  66 .RE
  67 .PP
  68 If a file named
  69 .RI \*(lq components \*(rq
  70 exists in the user's nmh directory,
  71 it will be used instead of this form.  You may specify an alternate
  72 forms file with the switch
  73 .B \-form
  74 .IR formfile .
  75 .PP
  76 You may also start
  77 .B comp
  78 using the contents of an existing message
  79 as the form.  If you supply either a
  80 .I +folder
  81 or
  82 .I msg
  83 argument, that
  84 message will be used as the message form.  You may not supply both a
  85 .B \-form
  86 .I formfile
  87 and a
  88 .I +folder
  89 or
  90 .I msg
  91 argument.  The line of
  92 dashes or a blank line must be left between the header and the body of
  93 the message for the message to be identified properly when it is sent
  94 (see
  95 .IR send (1)).
  96 .PP
  97 The switch
  98 .B \-use
  99 directs
 100 .B comp
 101 to continue editing an already
 102 started message.  That is, if a
 103 .B comp
 104 (or
 105 .BR dist ,
 106 .BR repl ,
 107 or
 108 .BR forw )
 109 is terminated without sending the draft, the draft can
 110 be edited again via
 111 .RB \*(lq comp
 112 .BR \-use \*(rq.
 113 .PP
 114 The
 115 .B \-file
 116 .I file
 117 switch says to use the named file as the message draft.
 118 .PP
 119 Forms that are selected via the
 120 .B \-form
 121 switch are processed via the
 122 .B nmh
 123 template system; see
 124 .IR mh\-format (5)
 125 for details.  Drafts constructed from another message or with the
 126 .B \-use
 127 or
 128 .B \-file
 129 switchs will NOT be processed with
 130 .IR mh\-format (5).
 131 .PP
 132 In addition to the standard
 133 .IR mh\-format (5)
 134 escapes,
 135 the following
 136 .I component
 137 escapes are either new or have an alternate meaning:
 138 .PP
 139 .RS 5
 140 .nf
 141 .ta \w'Escape  'u +\w'Returns  'u
 142 .I "Escape      Returns Description"
 143 fcc     string  Any folders specified with `\-fcc\ folder'
 144 from    string  Any addresses specified with `\-from\ address'
 145 to      string  Any addresses specified with `\-to\ address'
 146 cc      string  Any addresses specified with `\-cc\ address'
 147 subject string  Any text specified with `\-subject\ text'
 148 .fi
 149 .RE
 150 .PP
 151 By default the \*(lqTo:\*(rq and \*(lqcc:\*(rq fields are empty.  You may
 152 add addresses to these fields with the
 153 .B \-to
 154 .I address
 155 and
 156 .B \-cc
 157 .I address
 158 switches.  You may give these switches multiple times to add multiple
 159 addresses.
 160 .PP
 161 By default the \*(lqFrom:\*(rq field has either the value of the
 162 .B Local\-Mailbox
 163 profile entry or a system default email address.  This default can be
 164 overridden by using the
 165 .B \-from
 166 .I address
 167 switch.  The default mailbox in the \*(lqFcc:\*(rq field is
 168 .IR +outbox .
 169 This can be overridden by the
 170 .B \-fcc
 171 switch.
 172 .PP
 173 Any text you give to the
 174 .B \-subject
 175 switch will be placed in the \*(lqSubject:\*(rq field in the draft.
 176 .PP
 177 If the draft already exists,
 178 .B comp
 179 will ask you as to the disposition
 180 of the draft.  A reply of
 181 .B quit
 182 will abort
 183 .BR comp ,
 184 leaving the draft intact;
 185 .B replace
 186 will replace the existing draft with
 187 the appropriate form;
 188 .B list
 189 will display the draft;
 190 .B use
 191 will use the draft for further composition; and
 192 .B refile
 193 .I +folder
 194 will file the draft in the given folder, and give you a new draft with the
 195 appropriate form.  (The
 196 .I +folder
 197 argument to
 198 .B refile
 199 is required.)
 200 .PP
 201 The
 202 .B \-draftfolder
 203 .I +folder
 204 and
 205 .B \-draftmessage
 206 .I msg
 207 switches invoke the
 208 .B nmh
 209 draft folder facility.  This is an advanced (and highly
 210 useful) feature.  Consult the
 211 .IR mh-draft (5)
 212 man page for more information.
 213 .PP
 214 The
 215 .B \-editor
 216 .I editor
 217 switch indicates the editor to use for the
 218 initial edit.  Upon exiting from the editor,
 219 .B comp
 220 will invoke the
 221 .B whatnow
 222 program.  See
 223 .IR whatnow (1)
 224 for a discussion of
 225 available options.  The invocation of this program can be inhibited
 226 by using the
 227 .B \-nowhatnowproc
 228 switch.  (In truth of fact, it is
 229 the
 230 .I whatnow
 231 program which starts the initial edit.  Hence,
 232 .B \-nowhatnowproc
 233 will prevent any edit from occurring.)
 234 .PP
 235 The
 236 .B \-build
 237 switch is intended to be used by the Emacs mh-e interface to
 238 .BR nmh .
 239 It implies
 240 .BR \-nowhatnowproc .
 241 It causes a file <mh\-dir>/draft to be created, containing the draft message that
 242 would normally be presented to the user for editing.
 243 No mail is actually sent.
 244 .SH FILES
 245 .PD 0
 246 .TP 20
 247 %etcdir%/components
 248 The standard message skeleton.
 249 .TP
 250 <mh\-dir>/components
 251 An alternative to the standard skeleton.
 252 .TP
 253 $HOME/.mh\-profile
 254 The user's profile.
 255 .PD
 256 .SH "PROFILE COMPONENTS"
 257 .PD 0
 258 .TP 20
 259 Path:
 260 To determine the user's nmh directory.
 261 .TP
 262 Draft\-Folder:
 263 To find the default draft\-folder.
 264 .TP
 265 Editor:
 266 To override the default editor.
 267 .TP
 268 Msg\-Protect:
 269 To set mode when creating a new message (draft).
 270 .TP
 271 fileproc:
 272 Program to refile the message.
 273 .TP
 274 whatnowproc:
 275 Program to ask the \*(lqWhat now?\*(rq questions
 276 .PD
 277 .SH "SEE ALSO"
 278 .IR dist (1),
 279 .IR forw (1),
 280 .IR repl (1),
 281 .IR send (1),
 282 .IR whatnow (1),
 283 .IR mh-profile (5)
 284 .SH DEFAULTS
 285 .PD 0
 286 .TP 20
 287 +folder
 288 The current folder.
 289 .TP
 290 msg
 291 The current message.
 292 .TP
 293 \-nodraftfolder
 294 .TP
 295 \-nouse
 296 .PD
 297 .SH CONTEXT
 298 None
 299 .SH BUGS
 300 If
 301 .I whatnowproc
 302 is
 303 .BR whatnow ,
 304 then
 305 .B comp
 306 uses a built\-in
 307 .BR whatnow ,
 308 it does not actually run the
 309 .B whatnow
 310 program.
 311 Hence, if you define your own
 312 .IR whatnowproc ,
 313 don't call it
 314 .B whatnow
 315 since
 316 .B comp
 317 won't run it.