diplodocus.org Git - nmh/blob - man/whatnow.man

   1 .TH WHATNOW %manext1% "December 13, 2013" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 whatnow \- prompting front-end for sending messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B whatnow
  11 .RB [ \-draftfolder
  12 .IR +folder ]
  13 .RB [ \-draftmessage
  14 .IR msg ]
  15 .RB [ \-nodraftfolder ]
  16 .RB [ \-editor
  17 .IR editor ]
  18 .RB [ \-noedit ]
  19 .RB [ \-prompt
  20 .IR string ]
  21 .RI [ file ]
  22 .RB [ \-version ]
  23 .RB [ \-help ]
  24 .RB [ \-attach
  25 .IR header-field-name ]
  26 .RB [ \-noattach ]
  27 .ad
  28 .SH DESCRIPTION
  29 .B Whatnow
  30 is the default program that queries the user about
  31 the disposition of a composed draft.  It is normally automatically
  32 invoked by one of the
  33 .B nmh
  34 commands
  35 .BR comp ,
  36 .BR dist ,
  37 .BR forw ,
  38 or
  39 .B repl
  40 after the initial edit.
  41 .PP
  42 When started, the editor is started on the draft (unless
  43 .B \-noedit
  44 is given, in which case the initial edit is suppressed).  Then,
  45 .B whatnow
  46 repetitively prompts the user with \*(lqWhat now?\*(rq
  47 and awaits a response.  The valid responses are:
  48 .PP
  49 .RS 5
  50 .TP \w'refilezzzzfolderz'u
  51 .B edit
  52 re\-edit using the same editor that was used on the
  53 preceding round unless a profile entry
  54 \*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
  55 .TP \w'refilezzzzfolderz'u
  56 .B edit <editor>
  57 invoke <editor> for further editing
  58 .TP \w'refilezzzzfolderz'u
  59 .B refile +folder
  60 refile the draft into the given folder
  61 .TP \w'refilezzzzfolderz'u
  62 .B mime
  63 process the draft as MIME composition file using
  64 the
  65 .I buildmimeproc
  66 command
  67 .RB ( mhbuild
  68 by default)
  69 .TP \w'refilezzzzfolderz'u
  70 .B display
  71 list the message being distributed/replied\-to
  72 on the terminal
  73 .TP \w'refilezzzzfolderz'u
  74 .B list
  75 list the draft on the terminal
  76 .TP \w'refilezzzzfolderz'u
  77 .B send
  78 send the message
  79 .TP \w'refilezzzzfolderz'u
  80 .B send \-watch
  81 send the message and monitor the delivery process
  82 .TP \w'refilezzzzfolderz'u
  83 .B push
  84 send the message in the background
  85 .TP \w'refilezzzzfolderz'u
  86 .B whom
  87 list the addresses that the message will go to
  88 .TP \w'refilezzzzfolderz'u
  89 .B whom \-check
  90 list the addresses and verify that they are
  91 acceptable to the transport service
  92 .TP \w'refilezzzzfolderz'u
  93 .B quit
  94 preserve the draft and exit
  95 .TP \w'refilezzzzfolderz'u
  96 .B quit \-delete
  97 delete the draft and exit
  98 .TP \w'refilezzzzfolderz'u
  99 .B delete
 100 delete the draft and exit
 101 .TP \w'refilezzzzfolderz'u
 102 .B cd directory
 103 use the directory when interpreting attachment file names
 104 .TP \w'refilezzzzfolderz'u
 105 .B pwd
 106 print the working directory for attachment files
 107 .TP \w'refilezzzzfolderz'u
 108 .B ls [ls-options]
 109 list files in the attachment working directory using the ls command
 110 .TP \w'refilezzzzfolderz'u
 111 .B attach files
 112 add the named files to the draft as MIME attachments
 113 .TP \w'refilezzzzfolderz'u
 114 .B alist [-ln]
 115 list the MIME attachments, either short, long [-l] or numbered [-n]
 116 .TP \w'refilezzzzfolderz'u
 117 .B detach [-n] files-or-numbers
 118 remove MIME attachments, either by file name or by number with -n
 119 .RE
 120 .PP
 121 When entering your response, you need only type enough characters
 122 to uniquely identify the response.
 123 .PP
 124 For the
 125 .B edit
 126 response, any valid switch to the editor is valid.
 127 .PP
 128 For the
 129 .B send
 130 and
 131 .B push
 132 responses, any valid switch to
 133 .IR send (1)
 134 is valid (as
 135 .B push
 136 merely invokes
 137 .B send
 138 with the
 139 .B \-push
 140 option).
 141 .PP
 142 For the
 143 .B whom
 144 response, any valid switch to
 145 .IR whom (1)
 146 is valid.
 147 .PP
 148 For the
 149 .B refile
 150 response, any valid switch to the
 151 .I fileproc
 152 is valid.
 153 .PP
 154 For the
 155 .B display
 156 and
 157 .B list
 158 responses, any valid argument to
 159 the
 160 .I lproc
 161 is valid.  If any non\-switch arguments are present, then
 162 the pathname of the draft will be excluded from the argument list given
 163 to the
 164 .I lproc
 165 (this is useful for listing another
 166 .B nmh
 167 message).
 168 .PP
 169 See
 170 .IR mh\-profile (5)
 171 for further information about how editors
 172 are used by
 173 .BR nmh .
 174 It also discusses how environment variables can be
 175 used to direct
 176 .BR whatnow 's
 177 actions in complex ways.
 178 .PP
 179 The
 180 .B \-prompt
 181 .I string
 182 switch sets the prompting string for
 183 .BR whatnow .
 184 .PP
 185 The
 186 .B \-draftfolder
 187 .I +folder
 188 and
 189 .B \-draftmessage
 190 .I msg
 191 switches invoke
 192 the
 193 .B nmh
 194 draft folder facility.  This is an advanced (and highly
 195 useful) feature.  Consult the
 196 .IR mh-draft (5)
 197 man page for more
 198 information.
 199 .PP
 200 If your
 201 .B nmh
 202 was configured with readline enabled, you'll be able to use filename
 203 completion and other readline features at the prompt.  These are
 204 particularly useful with the
 205 .BR cd ,
 206 .BR ls ,
 207 .BR attach ,
 208 and
 209 .B detach
 210 commands for managing MIME attachments.
 211 .SH FILES
 212 .fc ^ ~
 213 .nf
 214 .ta \w'%etcdir%/ExtraBigFileName  'u
 215 ^$HOME/\&.mh\(ruprofile~^The user profile
 216 ^<mh\-dir>/draft~^The draft file
 217 .fi
 218 .SH "PROFILE COMPONENTS"
 219 .fc ^ ~
 220 .nf
 221 .ta 2.4i
 222 .ta \w'ExtraBigProfileName  'u
 223 ^Path:~^To determine the user's nmh directory
 224 ^Draft\-Folder:~^To find the default draft\-folder
 225 ^Editor:~^To override the default editor
 226 ^<lasteditor>\-next:~^To name an editor to be used after exit
 227 ^~^from <lasteditor>
 228 ^automimeproc:~^If value is 1, and the draft is a MIME
 229 ^~^composition file, then automatically call
 230 ^~^buildmimeproc prior to sending.
 231 ^buildmimeproc:~^Program to translate MIME composition files
 232 ^fileproc:~^Program to refile the message
 233 ^lproc:~^Program to list the contents of a message
 234 ^sendproc:~^Program to use to send the message
 235 ^whomproc:~^Program to determine who a message would go to
 236 .fi
 237 .SH "SEE ALSO"
 238 .IR send (1),
 239 .IR whom (1)
 240 .SH DEFAULTS
 241 .nf
 242 .RB ` \-prompt "' defaults to \*(lqWhat\ Now?\ \*(rq"
 243 .RB ` \-attach "' defaults to \*(lqNmh-Attachment\*(rq"
 244 .fi
 245 .SH BUGS
 246 If the initial edit fails,
 247 .B whatnow
 248 deletes your draft (by renaming
 249 it with a site-dependent prefix (usually a comma);
 250 failure of a later edit preserves the draft.
 251 .PP
 252 If the
 253 .I buildmimeproc
 254 fails (returns a nonzero status),
 255 .B whatnow
 256 simply prints a \*(lqWhat now?\*(rq prompt.
 257 .B whatnow
 258 depends on the
 259 .I buildmimeproc
 260 to tell the user that something went wrong.
 261 .PP
 262 If
 263 .I whatnowproc
 264 is
 265 .BR whatnow ,
 266 then
 267 .BR comp ,
 268 .BR dist ,
 269 .BR forw ,
 270 and
 271 .B repl
 272 use a built\-in
 273 .BR whatnow ,
 274 and do not actually run the
 275 .B whatnow
 276 program.  Hence, if you define your own
 277 .IR whatnowproc ,
 278 don't call it
 279 .B whatnow
 280 since it won't be run.
 281 .PP
 282 If
 283 .I sendproc
 284 is
 285 .BR send ,
 286 then
 287 .B whatnow
 288 uses a built\-in
 289 .BR send ,
 290 it does not actually run the
 291 .B send
 292 program.  Hence, if
 293 you define your own
 294 .IR sendproc ,
 295 don't call it
 296 .B send
 297 since
 298 .B whatnow
 299 won't run it.