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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   6 .SH NAME
   7 comp \- compose a message
   8 .SH SYNOPSIS
   9 .HP 5
  10 .B comp
  11 .RI [ +folder ]
  12 .RI [ msgs ]
  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 [ \-whatnowproc
  27 .IR program ]
  28 .RB [ \-nowhatnowproc ]
  29 .RB [ \-version ]
  30 .RB [ \-help ]
  31 .SH DESCRIPTION
  32 .B Comp
  33 is used to create a new message to be mailed.  It copies a
  34 message form to the draft being composed and then invokes an editor on
  35 the draft (unless
  36 .B \-noedit
  37 is given, in which case the initial edit is suppressed).
  38 .PP
  39 The default message form contains the following elements:
  40 .PP
  41 .RS 5
  42 .nf
  43 %components%
  44 .fi
  45 .RE
  46 .PP
  47 If a file named
  48 .RI \*(lq components \*(rq
  49 exists in the user's nmh directory,
  50 it will be used instead of this form.  You may specify an alternate
  51 forms file with the switch
  52 .B \-form
  53 .IR formfile .
  54 .PP
  55 You may also start
  56 .B comp
  57 using the contents of an existing message
  58 as the form.  If you supply either a
  59 .I +folder
  60 or
  61 .I msg
  62 argument, that
  63 message will be used as the message form.  You may not supply both a
  64 .B \-form
  65 .I formfile
  66 and a
  67 .I +folder
  68 or
  69 .I msg
  70 argument.  The line of
  71 dashes or a blank line must be left between the header and the body of
  72 the message for the message to be identified properly when it is sent
  73 (see
  74 .BR send (1)).
  75 .PP
  76 The switch
  77 .B \-use
  78 directs
  79 .B comp
  80 to continue editing an already
  81 started message.  That is, if a
  82 .B comp
  83 (or
  84 .BR dist ,
  85 .BR repl ,
  86 or
  87 .BR forw )
  88 is terminated without sending the draft, the draft can
  89 be edited again via
  90 .RB \*(lq comp
  91 .BR \-use \*(rq.
  92 .PP
  93 The
  94 .B \-file
  95 .I file
  96 switch says to use the named file as the message draft.
  97 .PP
  98 If the draft already exists,
  99 .B comp
 100 will ask you as to the disposition
 101 of the draft.  A reply of
 102 .B quit
 103 will abort
 104 .BR comp ,
 105 leaving the draft intact;
 106 .B replace
 107 will replace the existing draft with
 108 the appropriate form;
 109 .B list
 110 will display the draft;
 111 .B use
 112 will use the draft for further composition; and
 113 .B refile
 114 .I +folder
 115 will file the draft in the given folder, and give you a new draft with the
 116 appropriate form.  (The
 117 .I +folder
 118 argument to
 119 .B refile
 120 is required.)
 121 .PP
 122 The
 123 .B \-draftfolder
 124 .I +folder
 125 and
 126 .B \-draftmessage
 127 .I msg
 128 switches invoke the
 129 .B nmh
 130 draft folder facility.  This is an advanced (and highly
 131 useful) feature.  Consult the
 132 .BR mh-draft (5)
 133 man page for more information.
 134 .PP
 135 The
 136 .B \-editor
 137 .I editor
 138 switch indicates the editor to use for the
 139 initial edit.  Upon exiting from the editor,
 140 .B comp
 141 will invoke the
 142 .B whatnow
 143 program.  See
 144 .BR whatnow (1)
 145 for a discussion of
 146 available options.  The invocation of this program can be inhibited
 147 by using the
 148 .B \-nowhatnowproc
 149 switch.  (In truth of fact, it is
 150 the
 151 .I whatnow
 152 program which starts the initial edit.  Hence,
 153 .B \-nowhatnowproc
 154 will prevent any edit from occurring.)
 155
 156 .SH FILES
 157 .fc ^ ~
 158 .nf
 159 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
 160 ^%etcdir%/components~^The standard message skeleton
 161 ^or <mh\-dir>/components~^Rather than the standard skeleton
 162 ^$HOME/\&.mh\(ruprofile~^The user profile
 163 ^<mh\-dir>/draft~^The draft file
 164 .fi
 165
 166 .SH "PROFILE COMPONENTS"
 167 .fc ^ ~
 168 .nf
 169 .ta 2.4i
 170 .ta \w'ExtraBigProfileName  'u
 171 ^Path:~^To determine the user's nmh directory
 172 ^Draft\-Folder:~^To find the default draft\-folder
 173 ^Editor:~^To override the default editor
 174 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 175 ^fileproc:~^Program to refile the message
 176 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 177 .fi
 178
 179 .SH "SEE ALSO"
 180 dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
 181
 182 .SH DEFAULTS
 183 .nf
 184 .RB ` +folder "' defaults to the current folder"
 185 .RB ` msg "' defaults to the current message"
 186 .RB ` \-nodraftfolder '
 187 .RB ` \-nouse '
 188 .fi
 189
 190 .SH CONTEXT
 191 None
 192
 193 .SH BUGS
 194 If
 195 .I whatnowproc
 196 is
 197 .BR whatnow ,
 198 then
 199 .B comp
 200 uses a built\-in
 201 .BR whatnow ,
 202 it does not actually run the
 203 .B whatnow
 204 program.
 205 Hence, if you define your own
 206 .IR whatnowproc ,
 207 don't call it
 208 .B whatnow
 209 since
 210 .B comp
 211 won't run it.