X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/5dd6771b28c257af405d7248639ed0e3bcdce38b..c576ad2674c37a1c63f004c71049998f38854c64:/man/comp.man diff --git a/man/comp.man b/man/comp.man index bfb78b3c..0e9348ac 100644 --- a/man/comp.man +++ b/man/comp.man @@ -1,15 +1,17 @@ -.\" +.TH COMP %manext1% 2013-10-18 "%nmhversion%" +. .\" %nmhwarning% -.\" -.TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +. .SH NAME -comp \- compose a message +comp \- compose an nmh message .SH SYNOPSIS .HP 5 .na -.B comp +.B comp +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] -.RI [ msgs ] +.RI [ msg ] .RB [ \-form .IR formfile ] .RB [ \-use " | " \-nouse ] @@ -23,25 +25,43 @@ comp \- compose a message .RB [ \-editor .IR editor ] .RB [ \-noedit ] +.RB [ \-width +.IR columns ] +.RB [ \-from +.IR address ] +.RB [ \-to +.IR address ] +.RB [ \-cc +.IR address ] +.RB [ \-fcc +.IR +folder ] +.RB [ \-subject +.IR text ] .RB [ \-whatnowproc .IR program ] .RB [ \-nowhatnowproc ] -.RB [ \-version ] -.RB [ \-help ] +.RB [ \-build ] .ad .SH DESCRIPTION -.B Comp +.B comp is used to create a new message to be mailed. It copies a message form to the draft being composed and then invokes an editor on the draft (unless .B \-noedit is given, in which case the initial edit is suppressed). .PP -The default message form contains the following elements: +The default message template \*(lqcomponents\*(rq will direct +.B comp +to construct the message draft as follows: .PP .RS 5 .nf -%components% +From: {from switch} or or +To: {to switch} or blank +cc: {cc switch} or blank +Fcc: {fcc switch} or +outbox +Subject: {subject switch} or blank +-------- .fi .RE .PP @@ -72,7 +92,7 @@ argument. The line of dashes or a blank line must be left between the header and the body of the message for the message to be identified properly when it is sent (see -.BR send (1)). +.IR send (1)). .PP The switch .B \-use @@ -96,6 +116,66 @@ The .I file switch says to use the named file as the message draft. .PP +Forms that are selected via the +.B \-form +switch are processed via the +.B nmh +template system; see +.IR mh\-format (5) +for details. Drafts constructed from another message or with the +.B \-use +or +.B \-file +switches will +.I not +be processed with +.IR mh\-format (5). +.PP +In addition to the standard +.IR mh\-format (5) +escapes, +the following +.I component +escapes are either new or have an alternate meaning: +.PP +.RS 5 +.nf +.ta \w'Escape 'u +\w'Returns 'u +.I "Escape Returns Description" +fcc string Any folders specified with `\-fcc\ folder' +from string Any addresses specified with `\-from\ address' +to string Any addresses specified with `\-to\ address' +cc string Any addresses specified with `\-cc\ address' +subject string Any text specified with `\-subject\ text' +.fi +.RE +.PP +By default the \*(lqTo:\*(rq and \*(lqcc:\*(rq fields are empty. You may +add addresses to these fields with the +.B \-to +.I address +and +.B \-cc +.I address +switches. You may give these switches multiple times to add multiple +addresses. +.PP +By default the \*(lqFrom:\*(rq field has either the value of the +.B Local\-Mailbox +profile entry or a system default email address. This default can be +overridden by using the +.B \-from +.I address +switch. The default mailbox in the \*(lqFcc:\*(rq field is +.IR +outbox . +This can be overridden by the +.B \-fcc +switch. +.PP +Any text you give to the +.B \-subject +switch will be placed in the \*(lqSubject:\*(rq field in the draft. +.PP If the draft already exists, .B comp will ask you as to the disposition @@ -129,9 +209,9 @@ and switches invoke the .B nmh draft folder facility. This is an advanced (and highly -useful) feature. Consult the -.BR mh-draft (5) -man page for more information. +useful) feature. Consult +.IR mh-draft (5) +for more information. .PP The .B \-editor @@ -141,56 +221,82 @@ initial edit. Upon exiting from the editor, .B comp will invoke the .B whatnow -program. See -.BR whatnow (1) +program (see +.IR whatnow (1) for a discussion of -available options. The invocation of this program can be inhibited +available options). The invocation of this program can be inhibited by using the .B \-nowhatnowproc -switch. (In truth of fact, it is -the +switch. (In fact, it is the .I whatnow program which starts the initial edit. Hence, .B \-nowhatnowproc will prevent any edit from occurring.) - +.PP +The +.B \-build +switch is intended to be used by the Emacs mh-e interface to +.BR nmh . +It implies +.BR \-nowhatnowproc . +It causes a file /draft to be created, containing the draft message that +would normally be presented to the user for editing. +No mail is actually sent. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^%etcdir%/components~^The standard message skeleton -^or /components~^Rather than the standard skeleton -^$HOME/\&.mh\(ruprofile~^The user profile -^/draft~^The draft file -.fi - +.PD 0 +.TP 20 +%nmhetcdir%/components +The default message skeleton. +.TP +/components +The user's message skeleton. +.TP +$HOME/.mh_profile +The user's profile. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Draft\-Folder:~^To find the default draft\-folder -^Editor:~^To override the default editor -^Msg\-Protect:~^To set mode when creating a new message (draft) -^fileproc:~^Program to refile the message -^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions -.fi - +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Draft\-Folder: +To find the default draft-folder. +.TP +Editor: +To override the default editor. +.TP +Msg\-Protect: +To set mode when creating a new message (draft). +.TP +fileproc: +Program to refile the message. +.TP +whatnowproc: +Program to ask the \*(lqWhat now?\*(rq questions +.PD .SH "SEE ALSO" -dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5) - +.IR dist (1), +.IR forw (1), +.IR repl (1), +.IR send (1), +.IR whatnow (1), +.IR mh-profile (5) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msg "' defaults to the current message" -.RB ` \-nodraftfolder ' -.RB ` \-nouse ' -.fi - +.PD 0 +.TP 20 ++folder +The current folder. +.TP +msg +The current message. +.TP +\-nodraftfolder +.TP +\-nouse +.PD .SH CONTEXT None - .SH BUGS If .I whatnowproc @@ -198,7 +304,7 @@ is .BR whatnow , then .B comp -uses a built\-in +uses a built-in .BR whatnow , it does not actually run the .B whatnow