From: Ralph Corderoy Date: Tue, 18 Apr 2017 00:14:57 +0000 (+0100) Subject: man/*.man: Use italic for emphasis, not bold or SHOUTING. X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/39a9d9d85d0f2289d8c1257251311b7cf959c700?hp=1580ba033034910bb17eeea9d1814a5bb478ff15 man/*.man: Use italic for emphasis, not bold or SHOUTING. When reading a body of text, italic is sufficient to add emphasis to what's already being read. Bold draws the eye to the word on the page and is more useful for keywords, concepts, etc. Some `.B' remain that should probably be `.I', but they looked to have other problems so I left them out of this pass. --- diff --git a/man/comp.man b/man/comp.man index 3ba1b0a1..0b3fb0ae 100644 --- a/man/comp.man +++ b/man/comp.man @@ -126,7 +126,9 @@ for details. Drafts constructed from another message or with the .B \-use or .B \-file -switches will NOT be processed with +switches will +.I not +be processed with .IR mh\-format (5). .PP In addition to the standard diff --git a/man/inc.man b/man/inc.man index fa853368..787588b5 100644 --- a/man/inc.man +++ b/man/inc.man @@ -153,7 +153,9 @@ By using the switch, one can direct .B inc to incorporate messages from a file other than the user's mail drop. -Note that the named file will NOT be zeroed, unless the +Note that the named file will +.I not +be zeroed, unless the .B \-truncate switch is given. .PP diff --git a/man/mh-draft.man b/man/mh-draft.man index 8f8558d3..456247db 100644 --- a/man/mh-draft.man +++ b/man/mh-draft.man @@ -210,7 +210,9 @@ et al, invoke .B send directly, they supply .B send -with the Unix pathname of the message draft; NOT a +with the Unix pathname of the message draft; +.I not +a .B \-draftmessage .I msg argument. As far as diff --git a/man/mh-folders.man b/man/mh-folders.man index 3433d9f2..348e4ec3 100644 --- a/man/mh-folders.man +++ b/man/mh-folders.man @@ -22,7 +22,7 @@ names beyond those of the host filesystem. The file name is a positive integer. Other files containing metadata or arbitrary names can exist in a folder; while the preference is that non-message files begin with \*(lq.\*(rq, all files that are not positive integers -.B must +.I must be ignored by an .BR MH \-compatible implementation. However, implementations are free to indicate to the user @@ -35,7 +35,7 @@ message in the folder; its full path can be accessed by the pseudo-sequence .B mhpath .IR new ). New messages are -.B only +.I only permitted to be added to a folder at the end of the message number range. .PP To add a new message to a folder, the recommended sequence is: diff --git a/man/mh-format.man b/man/mh-format.man index 59d55d60..c2176532 100644 --- a/man/mh-format.man +++ b/man/mh-format.man @@ -474,7 +474,9 @@ an internal cache and will use this cache to suppress duplicate addresses. If you need to create an address list that includes previously-seen addresses you may use the (\fIconcataddr\fR\^) function, which is identical to (\fIformataddr\fR\^) in all other respects. Note that (\fIconcataddr\fR\^) -does NOT add addresses to the duplicate-suppression cache. +does +.I not +add addresses to the duplicate-suppression cache. .SS Other Hints and Tips Sometimes, the writer of a format function is confused because output is duplicated. The general rule to remember is simple: If a function or @@ -490,7 +492,9 @@ the From: and Reply-To: headers: .fi .RE .PP -Unfortunately, if the Reply-to: header is NOT present, the output line +Unfortunately, if the Reply-to: header is +.I not +present, the output line will be something like: .PP .RS 5 @@ -507,7 +511,9 @@ argument to the statement (so the rule about not starting with % applies). But the component escape in our .B else -statement (everything after the `%|') is NOT an argument to anything; +statement (everything after the `%|') is +.I not +an argument to anything; it begins with a %, and thus the value of that component is output. This also has the side effect of setting the .I str diff --git a/man/mh-mail.man b/man/mh-mail.man index ec2fedb5..e358ce64 100644 --- a/man/mh-mail.man +++ b/man/mh-mail.man @@ -54,7 +54,9 @@ are indicated by leading spaces or tabs. .PP Each header item is called a component and is composed of a keyword or name, along with associated text. The keyword begins at the left margin, -may NOT contain spaces or tabs, may not exceed 63 characters (as specified +may +.I not +contain spaces or tabs, may not exceed 63 characters (as specified by RFC 822), and is terminated by a colon (`:'). Certain components (as identified by their keywords) must follow rigidly defined formats in their text portions. diff --git a/man/mh-profile.man b/man/mh-profile.man index 6ccf2052..edbd8aad 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -273,7 +273,9 @@ to construct your default \*(lqFrom:\*(rq header. The text used here will be copied exactly to your \*(lqFrom:\*(rq header, so it should already be RFC 822 compliant. If this is set, the .B Signature -profile entry is NOT used, so it should include a signature as well. (profile, +profile entry is +.I not +used, so it should include a signature as well. (profile, default: userid@local.hostname) .RE .PP @@ -751,7 +753,9 @@ The .I \&.mh\-profile contains only static information, which .B nmh -programs will NOT update. Changes in context are made to the +programs will +.I not +update. Changes in context are made to the .I context file kept in the users .B nmh diff --git a/man/mh-sequence.man b/man/mh-sequence.man index 6dd9cbec..dd14973a 100644 --- a/man/mh-sequence.man +++ b/man/mh-sequence.man @@ -257,7 +257,7 @@ directs to add new messages to the sequence \*(lqunseen\*(rq. Unlike the behavior of the \*(lqPrevious\-Sequence\*(rq entry in the profile, however, the sequence(s) will -.B not +.I not be zeroed by .BR inc . .PP @@ -313,7 +313,7 @@ will release the sequence lock during the bulk of their runtime and reread the sequence file after their processing is complete to reduce lock contention time. .PP -.B Note: +Note: Currently transactional locks are only supported for public sequences; private sequences will not get corrupted, but the possibility exists that two .B nmh diff --git a/man/mhl.man b/man/mhl.man index 3910026c..6a9a322e 100644 --- a/man/mhl.man +++ b/man/mhl.man @@ -279,7 +279,9 @@ message which were not matched by explicit components, or included in the ignore list. If this component is not specified, an ignore list is not needed since all non-specified components will be ignored. .PP -If \*(lqnocomponent\*(rq is NOT specified, then the component name will +If \*(lqnocomponent\*(rq is +.I not +specified, then the component name will be output as it appears in the format file. .PP The default format file is: diff --git a/man/mhlist.man b/man/mhlist.man index 4c201f84..021d5d84 100644 --- a/man/mhlist.man +++ b/man/mhlist.man @@ -81,7 +81,9 @@ will accept the source message on the standard input. Note that the file, or input from standard input should be a validly formatted message, just like any other .B nmh -message. It should NOT be in mail drop format (to convert a file in +message. It should +.I not +be in mail drop format (to convert a file in mail drop format to a folder of .B nmh messages, see diff --git a/man/mhshow.man b/man/mhshow.man index 3ad02bd4..6d8f9cd9 100644 --- a/man/mhshow.man +++ b/man/mhshow.man @@ -108,7 +108,9 @@ will accept the source message on the standard input. Note that the file, or input from standard input, should be a validly formatted message, just like any other .B nmh -message. It should NOT be in mail drop format (to convert a file in +message. It should +.I not +be in mail drop format (to convert a file in mail drop format to a folder of .B nmh messages, see diff --git a/man/mhstore.man b/man/mhstore.man index f40571fd..9c99f515 100644 --- a/man/mhstore.man +++ b/man/mhstore.man @@ -68,7 +68,9 @@ will accept the source message on the standard input. Note that the file, or input from standard input, should be a validly formatted message, just like any other .B nmh -message. It should NOT be in mail drop format (to convert a file in +message. It should +.I not +be in mail drop format (to convert a file in mail drop format to a folder of .B nmh messages, see diff --git a/man/msgchk.man b/man/msgchk.man index 0ebdd1a1..f94f4d66 100644 --- a/man/msgchk.man +++ b/man/msgchk.man @@ -69,7 +69,7 @@ to never report the status of mail drops. This is useful if the user wishes to check .BR msgchk 's exit status. A non-zero exit status indicates that mail was -.B not +.I not waiting for at least one of the indicated users. .PP If diff --git a/man/pick.man b/man/pick.man index 4bb9a53c..c631c784 100644 --- a/man/pick.man +++ b/man/pick.man @@ -225,7 +225,7 @@ Once the search has been performed, if the .B \-list switch is given, the message numbers of the selected messages are written to the standard output separated by newlines. This is -.B extremely +.I extremely useful for quickly generating arguments for other .B nmh programs by using the \*(lqbackquoting\*(rq syntax of the shell. diff --git a/man/post.man b/man/post.man index 22d86e7a..58d66aaa 100644 --- a/man/post.man +++ b/man/post.man @@ -288,7 +288,7 @@ use. .SH "PROFILE COMPONENTS" .B post does -.B NOT +.I not consult the user's .I \&.mh_profile .SH "SEE ALSO" diff --git a/man/prompter.man b/man/prompter.man index e49c7ae2..58372987 100644 --- a/man/prompter.man +++ b/man/prompter.man @@ -67,7 +67,7 @@ A will cause the whole component to be left out. Otherwise, a `\\' preceding a will continue the response on the next line, allowing for multiline components. Continuation lines -.B must +.I must begin with a space or tab. .PP Each non-empty component is copied to the draft and displayed on the diff --git a/man/refile.man b/man/refile.man index 4ffa217d..cffeab85 100644 --- a/man/refile.man +++ b/man/refile.man @@ -66,7 +66,9 @@ than a message from a folder. Note that the file should be a validly formatted message, just like any other .B nmh -message. It should NOT be in mail drop format (to convert a file in +message. It should +.I not +be in mail drop format (to convert a file in mail drop format to a folder of .B nmh messages, @@ -80,7 +82,7 @@ A negative response will abort the file operation. If the standard input for .B refile is -.B not +.I not a tty, then .B refile will not ask any questions and will proceed as if the user answered @@ -222,7 +224,9 @@ use your .I rmmproc to delete the message, the .I rmmproc -must NOT call +must +.I not +call .B refile or .B rmm diff --git a/man/rmf.man b/man/rmf.man index 443c35bc..4aa15b28 100644 --- a/man/rmf.man +++ b/man/rmf.man @@ -21,7 +21,7 @@ folder, and then removes the folder (directory) itself. If there are any files within the folder which are not a part of .BR nmh , they will -.B not +.I not be removed, and an error will be produced. If the folder is given explicitly, or the .B \-nointeractive diff --git a/man/rmm.man b/man/rmm.man index 5192d903..2a352e0f 100644 --- a/man/rmm.man +++ b/man/rmm.man @@ -121,7 +121,9 @@ use your .I rmmproc to delete the message, the .I rmmproc -must NOT call +must +.I not +call .B rmm or .B refile diff --git a/man/send.man b/man/send.man index 123f648f..3089f727 100644 --- a/man/send.man +++ b/man/send.man @@ -328,7 +328,7 @@ is optional. .PP If a message with multiple \*(lqFrom:\*(rq addresses does -.B NOT +.I not include a \*(lqSender:\*(rq field but does include an \*(lqEnvelope\-From:\*(rq field, the \*(lqEnvelope\-From:\*(rq field will be used to construct a \*(lqSender:\*(rq field. diff --git a/man/slocal.man b/man/slocal.man index 66ad08a7..54a8aedf 100644 --- a/man/slocal.man +++ b/man/slocal.man @@ -168,7 +168,7 @@ the address that was used to cause delivery to the recipient .TP \w'defaultrrr'u .I default this matches -.B only +.I only if the message hasn't been delivered yet .TP \w'defaultrrr'u .I * diff --git a/man/sortm.man b/man/sortm.man index bdf8c889..9c556417 100644 --- a/man/sortm.man +++ b/man/sortm.man @@ -165,7 +165,7 @@ When .B sortm complains about a message which it can't temporally order, it complains about the message number -.B prior +.I prior to sorting. It should indicate what the message number will be .B after