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

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