git.marmaro.de Git - mmh/blob - man/comp.man

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