X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d1cb667bddf8d1c5c0721fc7ab642c22946baf1f..06efa573c7894caa4e5aa1ac7c64bd10ea25928b:/man/comp.man diff --git a/man/comp.man b/man/comp.man index bd0a762e..0e9348ac 100644 --- a/man/comp.man +++ b/man/comp.man @@ -1,13 +1,15 @@ -.TH COMP %manext1% "May 21, 2012" "%nmhversion%" -.\" +.TH COMP %manext1% 2013-10-18 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .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 [ msg ] .RB [ \-form @@ -38,11 +40,10 @@ comp \- compose a message .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 @@ -119,13 +120,15 @@ Forms that are selected via the .B \-form switch are processed via the .B nmh -template system; see +template system; see .IR mh\-format (5) for details. Drafts constructed from another message or with the .B \-use or .B \-file -switchs will NOT be processed with +switches will +.I not +be processed with .IR mh\-format (5). .PP In addition to the standard @@ -206,9 +209,9 @@ and switches invoke the .B nmh draft folder facility. This is an advanced (and highly -useful) feature. Consult the +useful) feature. Consult .IR mh-draft (5) -man page for more information. +for more information. .PP The .B \-editor @@ -218,39 +221,60 @@ initial edit. Upon exiting from the editor, .B comp will invoke the .B whatnow -program. See +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" .IR dist (1), .IR forw (1), @@ -259,12 +283,18 @@ will prevent any edit from occurring.) .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 @@ -274,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