git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/repl.rf

   1 .\"     @(MHWARNING)
   2 .\" @(#)$Id: repl.rf,v 1.14 1996/02/09 00:25:00 jromine Exp $
   3 .SC REPL 1
   4 .NA
   5 repl \- reply to a message
   6 .SY
   7 repl
   8 \%[+folder] \%[msg]
   9 \%[\-annotate] \%[\-noannotate]
  10 \%[\-cc\ all/to/cc/me] \%[\-nocc\ all/to/cc/me]
  11 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
  12 \%[\-editor\ editor] \%[\-noedit]
  13 \%[\-fcc\ +folder]
  14 \%[\-filter\ filterfile]
  15 \%[\-form\ formfile]
  16 .\" \%[\-format] \%[\-noformat]
  17 \%[\-inplace] \%[\-noinplace]
  18 @BEGIN: MIME
  19 \%[\-mime] \%[\-nomime]
  20 @END: MIME
  21 \%[\-query] \%[\-noquery]
  22 \%[\-width\ columns]
  23 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
  24 \%[\-help]
  25 .DE
  26 \fIRepl\fR aids a user in producing a reply to an existing
  27 message.
  28 \fIRepl\fR uses a reply template to guide its actions when constructing
  29 the message draft of the reply.
  30 In its simplest form (with no arguments),
  31 it will set up
  32 a message\-form skeleton in reply to the current message in the
  33 current folder, and invoke the whatnow shell.
  34 The default reply template will direct \fIrepl\fR to construct
  35 the composed message as follows:
  36
  37 .nf
  38 .in 1i
  39 To: <Reply\-To> or <From>
  40 cc: <cc>, <To>, and yourself
  41 Subject: Re: <Subject>
  42 In\-reply\-to: Your message of <Date>.
  43 .ti +\w'In\-reply\-to: 'u
  44 <Message\-Id>
  45 .in .5i
  46 .fi
  47
  48 where field names enclosed in angle brackets (<\ >) indicate the
  49 contents of the named field from the message to which the reply
  50 is being made.  A reply template is simply a format file.
  51 See \fImh\-format\fR\0(5) for the details.
  52
  53 The `\-cc\ type' switch takes an argument which specifies
  54 who gets placed on the \*(lqcc:\*(rq list of the reply.
  55 The `\-query' switch modifies the action of `\-cc\ type' switch by
  56 interactively asking you if each address that normally would be placed
  57 in the \*(lqTo:\*(rq and \*(lqcc:\*(rq list should actually be sent a copy.
  58 (This is useful for special\-purpose replies.)
  59 Note that the position of the `\-cc' and `\-nocc' switches,
  60 like all other switches which take a positive and negative form,
  61 is important.
  62
  63 .\" --this seems to not be used anymore. /JLR
  64 .\" With the `\-format' switch one can indicate if Internet\-style
  65 .\" formatting should be used (or not be used with `\-noformat').
  66 .\" If present (the default), then
  67 Lines beginning with the fields
  68 \*(lqTo:\*(rq, \*(lqcc:\*(rq, and \*(rqBcc:\*(rq
  69 will be standardized and have duplicate addresses removed.
  70 In addition, the `\-width\ columns' switch will guide \fIrepl\fR's formatting
  71 of these fields.
  72
  73 If the file named \*(lqreplcomps\*(rq exists in the user's MH directory,
  74 it will be used instead of the default form.
  75 In either case, the file specified by `\-form\ formfile' will be used
  76 if given.
  77
  78 If the draft already exists,
  79 \fIrepl\fR will ask you as to the disposition of the draft.
  80 A reply of \fBquit\fR will abort \fIrepl\fR, leaving the draft intact;
  81 \fBreplace\fR will replace the existing draft with a blank skeleton;
  82 and \fBlist\fR will display the draft.
  83
  84 See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
  85 switches.
  86 Note that while in the editor,
  87 the message being replied to is available through a link named \*(lq@\*(rq
  88 (assuming the default \fIwhatnowproc\fR\0).
  89 In addition, the actual pathname of the message is stored in the envariable
  90 \fB$editalt\fR,
  91 and the pathname of the folder containing the message is stored in the
  92 envariable \fB$mhfolder\fR.
  93
  94 Although \fIrepl\fR uses the `\-form\ formfile' switch to direct it how
  95 to construct the beginning of the draft, the `\-filter\ filterfile'
  96 switch directs \fIrepl\fR as to how the message being replied\-to
  97 should be formatted in the body of the draft.
  98 If `\-filter' is not specified,
  99 then the message being replied\-to is not included in the body of the
 100 draft.
 101 If `\-filter\ filterfile' is specified,
 102 then the message being replied\-to is filtered (re\-formatted) prior to
 103 being output to the body of the draft.
 104 The filter file for \fIrepl\fR should be a standard form file for
 105 \fImhl\fR, as \fIrepl\fR will invoke \fImhl\fR to format the message
 106 being replied\-to.
 107 There is no default message filter (`\-filter' must be followed by a
 108 file name).
 109 A filter file that is commonly used is:
 110
 111 .nf
 112 .in +.5i
 113 :
 114 body:nocomponent,compwidth=9,offset=9
 115 .in -.5i
 116 .fi
 117
 118 which says to output a blank line and then the body of the message
 119 being replied\-to, indented by one tab\-stop.
 120 Another format popular on USENET is:
 121
 122 .nf
 123 .in +.5i
 124 .ie n \{
 125 message-id:nocomponent,\|nonewline,\\
 126 formatfield=\*(lqIn message %{text},\ \*(rq \}
 127 .el message-id:nocomponent,\|nonewline,\|formatfield=\*(lqIn message %{text},\ \*(rq
 128 from:nocomponent,\|formatfield=\*(lq%(friendly{text}) writes:\*(rq
 129 body:component=\*(lq>\*(rq,\|overflowtext=\*(lq>\*(rq,\|overflowoffset=0
 130 .in -.5i
 131 .fi
 132
 133 Which cites the Message-ID and author
 134 of the message being replied\-to,
 135 and then outputs each line of the body prefaced
 136 with the \*(lq>\*(rq character.
 137
 138 @BEGIN: MIME
 139 To use the MIME rules for encapsulation,
 140 specify the `\-mime' switch.
 141 This directs \fIrepl\fR to generate an \fImhn\fR composition file.
 142 Note that MH will not invoke \fImhn\fR automatically,
 143 unless you  add this line to your \&.mh\(ruprofile file:
 144 .sp
 145 .in +.5i
 146 automhnproc: mhn
 147 .in -.5i
 148 .sp
 149 Otherwise,
 150 you must specifically give the command
 151 .sp
 152 .in +.5i
 153 What now? edit mhn
 154 .in -.5i
 155 .sp
 156 prior to sending the draft.
 157
 158 If you don't want to use this feature,
 159 the manual page for \fIforw\fR contains another idea on how you can
 160 automate this somewhat.
 161
 162 @END: MIME
 163 If the `\-annotate' switch is given,
 164 the message being replied\-to will be annotated with the lines
 165
 166      Replied:\ date
 167      Replied:\ addrs
 168
 169 where the address list contains one line for each addressee.
 170 The annotation
 171 will be done only if the message is sent directly from \fIrepl\fR.
 172 If the message is not sent immediately from \fIrepl\fR,
 173 \*(lqcomp\ \-use\*(rq may be used to re\-edit and send the constructed message,
 174 but the annotations won't take place.
 175 The `\-inplace' switch causes annotation to
 176 be done in place in order to preserve links to the annotated message.
 177
 178 The `\-fcc\ +folder' switch can be used to automatically specify a folder to
 179 receive Fcc:s.
 180 More than one folder, each preceeded by `\-fcc' can be named.
 181
 182 In addition to the standard \fImh\-format\fR\0(5) escapes,
 183 \fIrepl\fR also recognizes the following additional
 184 \fIcomponent\fR escape:
 185 .sp 1
 186 .nf
 187 .ta \w'Escape  'u +\w'Returns  'u
 188 \fIEscape\fR    \fIReturns\fR   \fIDescription\fR
 189 \fIfcc\fR       string  Any folders specified with `\-fcc\ folder'
 190 .re
 191 .fi
 192
 193 To avoid reiteration,
 194 \fIrepl\fR strips any leading `Re: ' strings from
 195 the \fIsubject\fR component.
 196
 197 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
 198 \fIMH\fR draft folder facility.
 199 This is an advanced (and highly useful) feature.
 200 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
 201 information.
 202
 203 Upon exiting from the editor,
 204 \fIrepl\fR will invoke the \fIwhatnow\fR program.
 205 See \fIwhatnow\fR\0(1) for a discussion of available options.
 206 The invocation of this program can be inhibited by using the `\-nowhatnowproc'
 207 switch.
 208 (In truth of fact,
 209 it is the \fIwhatnow\fR program which starts the initial edit.
 210 Hence, `\-nowhatnowproc' will prevent any edit from occurring.)
 211 .Fi
 212 ^@(MHETCPATH)/replcomps~^The reply template
 213 ^or <mh\-dir>/replcomps~^Rather than the standard template
 214 ^$HOME/\&.mh\(ruprofile~^The user profile
 215 ^<mh\-dir>/draft~^The draft file
 216 .Pr
 217 ^Path:~^To determine the user's MH directory
 218 .Ps
 219 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 220 .Ps
 221 ^Current\-Folder:~^To find the default current folder
 222 .Ps
 223 ^Draft\-Folder:~^To find the default draft\-folder
 224 .Ps
 225 ^Editor:~^To override the default editor
 226 .Ps
 227 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 228 .Ps
 229 ^fileproc:~^Program to refile the message
 230 .Ps
 231 ^mhlproc:~^Program to filter message being replied\-to
 232 .Ps
 233 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 234 .Sa
 235 comp(1), dist(1), forw(1), send(1), whatnow(1), mh\-format(5)
 236 .De
 237 `+folder' defaults to the current folder
 238 .Ds
 239 `msg' defaults to cur
 240 .Ds
 241 `\-nocc\ all' at ATHENA sites, `\-cc\ all' otherwise
 242 .Ds
 243 `\-noannotate'
 244 .Ds
 245 `\-nodraftfolder'
 246 .Ds
 247 `\-noinplace'
 248 @BEGIN: MIME
 249 .Ds
 250 `\-nomime'
 251 @END: MIME
 252 .Ds
 253 `\-noquery'
 254 .Ds
 255 `\-width\ 72'
 256 .Co
 257 If a folder is given, it will become the current folder.
 258 The message replied\-to will become the current message.
 259 .Hi
 260 Prior to using the format string mechanism,
 261 `\-noformat' used to cause address headers to be output as\-is.
 262 Now all address fields are formatted using Internet standard guidelines.
 263 .Bu
 264 If any addresses occur in the reply template,
 265 addresses in the template that do not contain hosts are defaulted incorrectly.
 266 Instead of using the localhost for the default,
 267 \fIrepl\fR uses the sender's host.
 268 Moral of the story: if you're going to include addresses in a reply template,
 269 include the host portion of the address.
 270
 271 The `\-width columns' switch is only used
 272 to do address-folding; other headers are not line\-wrapped.
 273
 274 If \fIwhatnowproc\fR is \fIwhatnow\fR,
 275 then \fIrepl\fR uses a built\-in \fIwhatnow\fR,
 276 it does not actually run the \fIwhatnow\fR program.
 277 Hence, if you define your own \fIwhatnowproc\fR,
 278 don't call it \fIwhatnow\fR since \fIrepl\fR won't run it.
 279
 280 If your current working directory is not writable,
 281 the link named \*(lq@\*(rq is not available.
 282 .En