From: Ralph Corderoy Date: Sun, 23 Oct 2016 00:10:58 +0000 (+0100) Subject: man: Use lowercase for command name at start of sentence. X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/f14e2d4d32d2c01cb39a59dc8aa577e26a9990ca?ds=sidebyside;hp=e7bb87866c9b91fc983693a4c1150b58dfe93d0a man: Use lowercase for command name at start of sentence. `Inc' is a different command to `inc'. --- diff --git a/man/ali.man b/man/ali.man index 3ad80f14..9399871b 100644 --- a/man/ali.man +++ b/man/ali.man @@ -17,7 +17,7 @@ ali \- list mail aliases .RI [ aliases " ...]" .ad .SH DESCRIPTION -.B Ali +.B ali searches the named mail alias files for each of the given .IR aliases . It creates a list of addresses for those diff --git a/man/anno.man b/man/anno.man index baad1039..c35b82e4 100644 --- a/man/anno.man +++ b/man/anno.man @@ -27,7 +27,7 @@ anno \- annotate messages .IR body ] .ad .SH DESCRIPTION -.B Anno +.B anno manipulates header fields or .I annotations in messages. @@ -142,7 +142,7 @@ By default, .B anno changes the last-accessed and last-modified times on annotate messages to the time at which the annotation occurs. -.B Anno +.B anno preserves the original times if the .B -preserve option is used. diff --git a/man/ap.man b/man/ap.man index e3449592..936da3b9 100644 --- a/man/ap.man +++ b/man/ap.man @@ -20,7 +20,7 @@ ap \- parse addresses RFC 822-style \&... .ad .SH DESCRIPTION -.B Ap +.B ap is a program that parses addresses according to the ARPA Internet standard. It also understands many non\-standard formats. It is useful for seeing how diff --git a/man/burst.man b/man/burst.man index 678e5547..88bd2d18 100644 --- a/man/burst.man +++ b/man/burst.man @@ -19,7 +19,7 @@ burst \- explode digests into messages .RB [ \-verbose " | " \-noverbose ] .ad .SH DESCRIPTION -.B Burst +.B burst considers the specified messages in the named folder to be Internet digests, and explodes them in that folder. .PP @@ -27,7 +27,7 @@ If .B \-inplace is given, each digest is replaced by the \*(lqtable of contents\*(rq for the digest (the original digest is removed). -.B Burst +.B burst then renumbers all of the messages following the digest in the folder to make room for each of the messages contained within the digest. These messages are placed immediately after the digest. diff --git a/man/comp.man b/man/comp.man index 468b5c71..0149ee7b 100644 --- a/man/comp.man +++ b/man/comp.man @@ -43,7 +43,7 @@ comp \- compose a message .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 diff --git a/man/dist.man b/man/dist.man index 2acf29a1..ad6f97a9 100644 --- a/man/dist.man +++ b/man/dist.man @@ -41,7 +41,7 @@ dist \- redistribute a message to additional addresses .RB [ \-noatfile ] .ad .SH DESCRIPTION -.B Dist +.B dist is similar to .BR forw . It prepares the specified message @@ -271,7 +271,7 @@ The current message. If a folder is given, it will become the current folder. The message distributed will become the current message. .SH HISTORY -.B Dist +.B dist originally used headers of the form .RI \*(lq Distribute\-xxx: \*(rq instead of @@ -279,13 +279,13 @@ instead of In order to conform with the ARPA Internet standard, RFC 822, the .RI \*(lq Resent\-xxx: \*(rq form is now used. -.B Dist +.B dist will recognize .RI \*(lq Distribute\-xxx: \*(rq type headers and automatically convert them to .RI \*(lq Resent\-xxx: \*(rq. .SH BUGS -.B Dist +.B dist does not rigorously check the message being distributed for adherence to the transport standard, but .B post diff --git a/man/dp.man b/man/dp.man index 828ba36a..217cda2e 100644 --- a/man/dp.man +++ b/man/dp.man @@ -20,7 +20,7 @@ dp \- parse dates RFC 822-style \&... .ad .SH DESCRIPTION -.B Dp +.B dp is a program that parses dates according to the ARPA Internet standard. It also understands many non\-standard formats, such as those produced by TOPS\-20 sites and some UNIX sites using diff --git a/man/flist.man b/man/flist.man index a66d8edb..3d2c3dec 100644 --- a/man/flist.man +++ b/man/flist.man @@ -31,7 +31,7 @@ is equivalent to .B \-all .ad .SH DESCRIPTION -.B Flist +.B flist is used to search a list of folders and display the number of messages in these folders that are in a given sequence or set of sequences (for example the @@ -52,7 +52,7 @@ will search the current folder for the given sequence or sequences (usually If (possibly multiple) folders are specified on the command line with .IR +folder , then all these folders are searched for the given sequence(s). -.B Flist +.B flist will display for each folder searched, the number of messages in each of the specified sequences, and the total number of messages. .PP diff --git a/man/fmtdump.man b/man/fmtdump.man index 6cb24ebb..39196969 100644 --- a/man/fmtdump.man +++ b/man/fmtdump.man @@ -16,7 +16,7 @@ fmtdump \- decode nmh format files .IR string ] .ad .SH DESCRIPTION -.B Fmtdump +.B fmtdump is a program that parses an .B nmh format file and produces a pseudo-language listing of the how diff --git a/man/fmttest.man b/man/fmttest.man index 0debf9b4..6c375c3a 100644 --- a/man/fmttest.man +++ b/man/fmttest.man @@ -40,7 +40,7 @@ language .RI [ msgs " | " strings ] .ad .SH DESCRIPTION -.B Fmttest +.B fmttest is used to test programs written for the .B nmh format language as specified by @@ -74,7 +74,7 @@ directory as specified in their profile. If not found there, the directory .RI \*(lq %nmhetcdir% \*(rq is checked. .SS MODE SELECTION AND COMPONENT SPECIFICATION -.B Fmttest +.B fmttest has four operating modes: address mode, raw mode, date mode, and message mode. These modes are selected by the .BR \-address , @@ -131,7 +131,7 @@ Date mode is equivalent to In message mode the arguments to .B fmttest are interpreted as an optional folder and messages. -.B Fmttest +.B fmttest will read each specified message and make all of the components in the message available to the format program. Also, the appropriate information for the diff --git a/man/forw.man b/man/forw.man index 6534f050..22fc038a 100644 --- a/man/forw.man +++ b/man/forw.man @@ -64,7 +64,7 @@ forw \- forward messages .BR forw ] .ad .SH DESCRIPTION -.B Forw +.B forw may be used to prepare a message containing other messages. .PP It constructs the new message from a forms (components) file, with a diff --git a/man/inc.man b/man/inc.man index 0d680ea8..51cea503 100644 --- a/man/inc.man +++ b/man/inc.man @@ -46,7 +46,7 @@ inc \- incorporate new mail .RB [ \-snoop ] .ad .SH DESCRIPTION -.B Inc +.B inc incorporates mail from the user's incoming mail drop into an .B nmh @@ -118,7 +118,7 @@ history. .RI \*(lq Audit\-file \*(rq will be in the user's nmh directory unless a full path is specified. .PP -.B Inc +.B inc will incorporate even improperly formatted messages into the user's nmh folder, inserting a blank line prior to the offending component and printing a comment identifying the bad message. @@ -133,7 +133,7 @@ is present and non\-empty, then .B inc will add each of the newly incorporated messages to each sequence named by the profile entry. -.B Inc +.B inc will not zero each sequence prior to adding messages. .PP The interpretation of the diff --git a/man/mark.man b/man/mark.man index 92fe28d8..fcbc2ef7 100644 --- a/man/mark.man +++ b/man/mark.man @@ -129,7 +129,7 @@ switch tells .B mark to list both the sequences defined for the folder and the messages associated with those sequences. -.B Mark +.B mark will list the name of each sequence given by .B \-sequence .I name diff --git a/man/mhl.man b/man/mhl.man index 603c5841..01a1e641 100644 --- a/man/mhl.man +++ b/man/mhl.man @@ -30,7 +30,7 @@ mhl \- produce formatted listings of nmh messages .IR \&... ] .ad .SH DESCRIPTION -.B Mhl +.B mhl is an .B nmh command for filtering and/or displaying text @@ -153,7 +153,7 @@ and .B prev initialize appropriately. .PP -.B Mhl +.B mhl operates in two phases: 1) read and parse the format file, and 2) process each message (file). During phase 1, an internal description of the format is produced as a structured list. In phase 2, this list diff --git a/man/mhlogin.man b/man/mhlogin.man index 11434000..e9a81aec 100644 --- a/man/mhlogin.man +++ b/man/mhlogin.man @@ -21,7 +21,7 @@ mhlogin \- login to external (OAuth) services .RB [ \-snoop ] .ad .SH DESCRIPTION -.B Mhlogin +.B mhlogin currently only supports OAuth for Gmail. Run .B mhlogin .B \-user diff --git a/man/mhn.man b/man/mhn.man index d23fe9b5..5982f35b 100644 --- a/man/mhn.man +++ b/man/mhn.man @@ -44,8 +44,7 @@ mhn \- display/list/store/cache MIME messages .RB [ \-rfc934mode " | " \-norfc934mode ] .ad .SH DESCRIPTION -.B -Mhn +.B mhn is deprecated. It is retained only for backwards compatibility. .PP diff --git a/man/mhshow.man b/man/mhshow.man index c3f942c7..9d258f5f 100644 --- a/man/mhshow.man +++ b/man/mhshow.man @@ -350,7 +350,7 @@ The display string may contain the following escapes: .fi .RE .PP -.B Mhshow +.B mhshow will execute at most one display string at any given time, and wait for the current display string to finish execution before executing the next diff --git a/man/new.man b/man/new.man index b5c41b43..f9b4c22d 100644 --- a/man/new.man +++ b/man/new.man @@ -38,7 +38,7 @@ is equivalent to .B new \-mode unseen .ad .SH DESCRIPTION -.B New +.B new in its default mode produces a one\-line\-per\-folder listing of all folders containing messages in the listed .IR sequences @@ -58,7 +58,7 @@ bar 380. 760\-772 824\-828 The `*' on foo indicates that it is the current folder. The last line shows the total number of messages in the desired sequences. .PP -.B New +.B new crawls the folder hierarchy recursively to find all folders, and prints them in lexicographic order. Override this behavior by providing .IR foldersfile diff --git a/man/next.man b/man/next.man index fb9e0b07..2876d18e 100644 --- a/man/next.man +++ b/man/next.man @@ -23,7 +23,7 @@ or .IR showmimeproc ] .ad .SH DESCRIPTION -.B Next +.B next performs a .B show on the next message in the specified diff --git a/man/packf.man b/man/packf.man index 597c91b3..12dc79d5 100644 --- a/man/packf.man +++ b/man/packf.man @@ -18,7 +18,7 @@ packf \- pack messages in nmh folder into a single file .RB [ \-mmdf ] .ad .SH DESCRIPTION -.B Packf +.B packf will pack copies of messages from a folder, into a single file. .PP diff --git a/man/pick.man b/man/pick.man index 106df2fa..dbed194a 100644 --- a/man/pick.man +++ b/man/pick.man @@ -63,7 +63,7 @@ show\0`pick\0\-before\0friday` .RE .ad .SH DESCRIPTION -.B Pick +.B pick searches within a folder for messages with the specified contents, and then identifies those messages. Two types of search primitives are available: pattern matching and date constraint @@ -156,7 +156,7 @@ and .B \-before switches take legal RFC 822\-style date specifications as arguments. -.B Pick +.B pick will default certain missing fields so that the entire date need not be specified. These fields are (in order of defaulting): timezone, time and timezone, date, date @@ -193,7 +193,7 @@ pick\0\-reverse\0\-from\0frated\0|\0xargs\0\-n1\0scan .fi .RE .PP -.B Pick +.B pick supports complex boolean operations on the searching primitives with the .BR \-and , diff --git a/man/post.man b/man/post.man index 372108fe..ba48f866 100644 --- a/man/post.man +++ b/man/post.man @@ -44,7 +44,7 @@ post \- deliver a message .I file .ad .SH DESCRIPTION -.B Post +.B post is the default program called by .B send to deliver @@ -71,7 +71,7 @@ profile component that will have as its final argument. See the mh-profile(5) man page for more information on postproc. .PP -.B Post +.B post searches the \*(lqTo:\*(rq, \*(lqcc:\*(rq, \*(lqBcc:\*(rq, \*(lqFcc:\*(rq, and \*(lqResent\-xxx:\*(rq header lines of the specified message for destination addresses, checks these addresses for validity, diff --git a/man/prev.man b/man/prev.man index 50439a07..6a2e7e87 100644 --- a/man/prev.man +++ b/man/prev.man @@ -23,7 +23,7 @@ or .IR showmimeproc ] .ad .SH DESCRIPTION -.B Prev +.B prev performs a .B show on the previous message in the specified diff --git a/man/prompter.man b/man/prompter.man index 2f2f4346..8ea7bedf 100644 --- a/man/prompter.man +++ b/man/prompter.man @@ -20,7 +20,7 @@ prompter \- prompting editor front-end for nmh .I file .ad .SH DESCRIPTION -.B Prompter +.B prompter is an editor front\-end for .B nmh which allows rapid @@ -37,7 +37,7 @@ commands or .BR repl . .PP -.B Prompter +.B prompter is particularly useful when composing messages over slow network or modem lines. It is an .B nmh program in that it can have @@ -186,7 +186,7 @@ invoking prompter differently for different commands (e.g., \*(lqforw: -editor rapid\*(rq). .SH BUGS -.B Prompter +.B prompter uses .IR stdio (3), so it will lose if you edit files with nulls in them. diff --git a/man/rcvstore.man b/man/rcvstore.man index 4dde79ef..e1f23dec 100644 --- a/man/rcvstore.man +++ b/man/rcvstore.man @@ -20,7 +20,7 @@ rcvstore \- asynchronously incorporate mail into a folder .RB [ \-public " | " \-nopublic ] .ad .SH DESCRIPTION -.B Rcvstore +.B rcvstore incorporates a message from the standard input into an .B nmh folder. This command is typically used in conjunction with @@ -51,7 +51,7 @@ will exit if the specified folder does not exist. When the new message is incorporated into the folder, it is assigned the next highest number for that folder. .PP -.B Rcvstore +.B rcvstore will incorporate anything except zero length messages into the user's .B nmh diff --git a/man/refile.man b/man/refile.man index c006c763..b6b1fb39 100644 --- a/man/refile.man +++ b/man/refile.man @@ -27,7 +27,7 @@ refile \- file message in other folders \&... .ad .SH DESCRIPTION -.B Refile +.B refile moves (see .IR mv (1)) or links (see diff --git a/man/repl.man b/man/repl.man index b764e673..1049dd3f 100644 --- a/man/repl.man +++ b/man/repl.man @@ -53,7 +53,7 @@ all/to/cc/me] .IR msgfile ] .ad .SH DESCRIPTION -.B Repl +.B repl may be used to produce a reply to an existing message. .PP In its simplest form (with no arguments), diff --git a/man/rmf.man b/man/rmf.man index 5e826c94..86ae58fc 100644 --- a/man/rmf.man +++ b/man/rmf.man @@ -14,7 +14,7 @@ rmf \- remove an nmh folder .RB [ \-interactive " | " \-nointeractive ] .ad .SH DESCRIPTION -.B Rmf +.B rmf removes all of the messages (files) within the specified (or default) folder, and then removes the folder (directory) itself. .PP @@ -51,7 +51,7 @@ private sequences entries) for this folder from your context without affecting the folder itself. .PP -.B Rmf +.B rmf irreversibly deletes messages that don't have other links, so use it with caution. .SH FILES @@ -78,7 +78,7 @@ use it with caution. .RB ` \-interactive "' if +folder' not given, `\-nointeractive' otherwise" .fi .SH CONTEXT -.B Rmf +.B rmf will set the current folder to the parent folder if a subfolder is removed; or if the current folder is removed, it will make \*(lqinbox\*(rq current. Otherwise, it doesn't change the current folder diff --git a/man/scan.man b/man/scan.man index 7cf3a353..8d53e30a 100644 --- a/man/scan.man +++ b/man/scan.man @@ -25,7 +25,7 @@ scan \- produce a one line per message scan listing .IR filename ] .ad .SH DESCRIPTION -.B Scan +.B scan produces a one\-line\-per\-message listing of the specified folder or messages. Each .B scan @@ -61,7 +61,7 @@ If there is sufficient room left on the line after the subject, the line will be filled with text from the body, preceded by \*(lq<<\*(rq, and terminated by \*(lq>>\*(rq if the body is sufficiently short. -.B Scan +.B scan actually reads each of the specified messages and parses them to extract the desired fields. During parsing, appropriate error messages will be produced if there are format errors in any of the messages. @@ -70,7 +70,7 @@ By default, .B scan will decode RFC 2047 (MIME) encoding in these scan listings. -.B Scan +.B scan will only decode these fields if your terminal can natively display the character set used in the encoding. You should set the appropriate diff --git a/man/send.man b/man/send.man index 757eaced..a3003709 100644 --- a/man/send.man +++ b/man/send.man @@ -58,7 +58,7 @@ send \- send a message \&...] .ad .SH DESCRIPTION -.B Send +.B send will cause each of the specified files to be delivered to each of the destinations in the \*(lqTo:\*(rq, \*(lqcc:\*(rq, \*(lqBcc:\*(rq, \*(lqDcc:\*(rq, and \*(lqFcc:\*(rq fields of the message. If @@ -236,7 +236,7 @@ lot of partial messages. The argument to tells it how long to pause between postings. .PP -.B Send +.B send with no .I file argument will query whether the draft diff --git a/man/show.man b/man/show.man index 1d6eb366..89a5719e 100644 --- a/man/show.man +++ b/man/show.man @@ -26,7 +26,7 @@ or .IR showmimeproc ] .ad .SH DESCRIPTION -.B Show +.B show lists each of the specified messages to the standard output (typically, the terminal). .PP @@ -221,7 +221,7 @@ be circumvented by referencing the \*(lqmessagename\*(rq field in the .B mhl format file. .PP -.B Show +.B show updates the user's context before showing the message. Hence .B show diff --git a/man/slocal.man b/man/slocal.man index 1d8abf89..302dfd28 100644 --- a/man/slocal.man +++ b/man/slocal.man @@ -30,7 +30,7 @@ slocal \- asynchronously filter and deliver new mail .RB [ \-debug ] .ad .SH DESCRIPTION -.B Slocal +.B slocal is a program designed to allow you to have your inbound mail processed according to a complex set of selection criteria. You do not normally invoke @@ -394,7 +394,7 @@ will be set the the user part of the Local-Mailbox profile entry, if set. .SH CONTEXT None .SH HISTORY -.B Slocal +.B slocal was originally designed to be backward-compatible with the .B maildelivery @@ -424,7 +424,7 @@ value .SH BUGS Only two return codes are meaningful, others should be. .PP -.B Slocal +.B slocal was originally designed to be backwards-compatible with the .B maildelivery functionality provided by diff --git a/man/sortm.man b/man/sortm.man index 7e0c2dfd..a74ef785 100644 --- a/man/sortm.man +++ b/man/sortm.man @@ -25,7 +25,7 @@ sortm \- sort messages .RB [ \-verbose " | " \-noverbose ] .ad .SH DESCRIPTION -.B Sortm +.B sortm sorts the specified messages in the named folder according to the chronological order of the \*(lqDate:\*(rq field of each message. .PP @@ -153,7 +153,7 @@ Timezones used to be ignored when comparing dates: they aren't any more. Messages which were in the folder, but not specified by `msgs', used to be moved to the end of the folder; now such messages are left untouched. .PP -.B Sortm +.B sortm sometimes did not preserve the message numbering in a folder (e.g., messages 1, 3, and 5, might have been renumbered to 1, 2, 3 after sorting). This was a bug, and has been fixed. To compress the message diff --git a/man/whatnow.man b/man/whatnow.man index b80031e8..819bf4cd 100644 --- a/man/whatnow.man +++ b/man/whatnow.man @@ -23,7 +23,7 @@ whatnow \- prompting front-end for sending messages .RI [ file ] .ad .SH DESCRIPTION -.B Whatnow +.B whatnow is the default program that queries the user about the disposition of a composed draft. It is normally automatically invoked by one of the diff --git a/man/whom.man b/man/whom.man index c3c1fe5e..7b321f1c 100644 --- a/man/whom.man +++ b/man/whom.man @@ -37,7 +37,7 @@ whom \- report to whom a message would go .RB [ \-draft ] .ad .SH DESCRIPTION -.B Whom +.B whom is used to expand the headers of a message into a set of addresses and optionally verify that those addresses are deliverable at that time (if