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

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