X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmh-format.man5;h=e86e9ce61b3e8c17b738d298b062bd58b92861a4;hp=ca07c5129d64cb29de998941495b925f8601a726;hb=5c43bb739797c078c3fd6aa982183e15af456d31;hpb=bb9360ead7eb7a3fedcce2eeedfc660014e41dbe diff --git a/man/mh-format.man5 b/man/mh-format.man5 index ca07c51..e86e9ce 100644 --- a/man/mh-format.man5 +++ b/man/mh-format.man5 @@ -68,7 +68,7 @@ escape is specified as and exists for each header found in the message being processed. For example .RI `%{ date }' -refers to the \*(lqDate:\*(rq field of the appropriate message. +refers to the `Date:' field of the appropriate message. All component escapes have a string value. Normally, component values are compressed by converting any control characters (tab and newline included) to spaces, then eliding any leading or multiple spaces. However, commands @@ -185,7 +185,7 @@ For example, .fi .RE .PP -writes the value of the header component \*(lqFrom:\*(rq to the +writes the value of the header component `From:' to the internal register named str; then (\fImymbox\fR\^) reads str and writes its result to the internal register named .IR num ; @@ -194,8 +194,8 @@ then the control escape evaluates If .IR num is non-zero, the -string \*(lqTo:\*(rq is printed followed by the value of the -header component \*(lqTo:\*(rq. +string `To:' is printed followed by the value of the +header component `To:'. .SS Evaluation The evaluation of format strings is performed by a small virtual machine. @@ -276,7 +276,7 @@ null expr boolean \fIstr\fR is empty nonnull expr boolean \fIstr\fR is non-empty void expr Set \fIstr\fR or \fInum\fR comp comp string Set \fIstr\fR to component text -compval comp integer Set \fInum\fR to \*(lq\fBatoi\fR(\fIcomp\fR\^)\*(rq +compval comp integer Set \fInum\fR to `\fBatoi\fR(\fIcomp\fR\^)' .\" compflag comp integer Set \fInum\fR to component flags bits (internal) .\" decodecomp comp string Set \fIstr\fR to RFC-2047 decoded component text decode expr string decode \fIstr\fR as RFC-2047 (MIME-encoded) @@ -357,10 +357,10 @@ gname addr string name of group* .PP (A clarification on (\fImymbox\fR\^{\fIcomp\fR\^}) is in order. This function checks each of the addresses in the header component -\*(lq\fIcomp\fR\*(rq against the user's mailbox name and any -.RI \*(lq Alternate-Mailboxes \*(rq. +`\fIcomp\fR' against the user's mailbox name and any +.RI ` Alternate-Mailboxes '. It returns true if any address matches, -however, it also returns true if the \*(lq\fIcomp\fR\*(rq header is not +however, it also returns true if the `\fIcomp\fR' header is not present in the message. If needed, the (\fInull\fR\^) function can be used to explicitly test for this case.) .SS Formatting @@ -379,7 +379,7 @@ print their result in exactly the number of characters specified by their leading field width argument. For example, %06(\fIputnumf\fR\^(\fIsize\fR\^)) will print the message size in a field six characters wide filled with leading zeros; -%14(\fIputstrf\^\fR{\fIfrom\^\fR}) will print the \*(lqFrom:\*(rq header +%14(\fIputstrf\^\fR{\fIfrom\^\fR}) will print the `From:' header component in fourteen characters with trailing spaces added as needed. For \fIputstrf\fR, using a negative value for the field width causes right-justification of the string within the field, with padding on @@ -405,7 +405,7 @@ The first part is: .PP which says that the message number should be printed in four digits. If the message is the current message then a `+' else a space should -be printed; if a \*(lqReplied:\*(rq field is present then a `\-' +be printed; if a `Replied:' field is present then a `\-' else a space should be printed. Next: .PP .RS @@ -423,7 +423,7 @@ a slash. Next, .fi .RE .PP -If a \*(lqDate:\*(rq field was present, +If a `Date:' field was present, then a space is printed, otherwise a `*'. Next, .PP @@ -433,9 +433,9 @@ Next, .fi .RE .PP -if the message is from me, and there is a \*(lqTo:\*(rq header, -print \*(lqTo:\*(rq followed by a \*(lquser-friendly\*(rq rendering of the -first address in the \*(lqTo:\*(rq field; any MIME-encoded +if the message is from me, and there is a `To:' header, +print `To:' followed by a `user-friendly' rendering of the +first address in the `To:' field; any MIME-encoded characters are decoded into the actual characters. Continuing, .PP @@ -446,8 +446,8 @@ Continuing, .RE .PP if either of the above two tests failed, -then the \*(lqFrom:\*(rq address is printed -in a mime-decoded, \*(lquser-friendly\*(rq format. +then the `From:' address is printed +in a mime-decoded, `user-friendly' format. And finally, .PP .RS 5 @@ -471,7 +471,7 @@ format file. .PP This clears .I str -and formats the \*(lqReply-To:\*(rq header +and formats the `Reply-To:' header if present. If not present, the else-if clause is executed. .PP .RS 5 @@ -481,7 +481,7 @@ if present. If not present, the else-if clause is executed. .RE .PP This formats the -\*(lqFrom:\*(rq, \*(lqSender:\*(rq and \*(lqReturn-Path:\*(rq +`From:', `Sender:' and `Return-Path:' headers, stopping as soon as one of them is present. Next: .PP .RS 5 @@ -492,7 +492,7 @@ headers, stopping as soon as one of them is present. Next: .PP If the \fIformataddr\fR result is non-null, it is printed as an address (with line folding if needed) in a field \fIwidth\fR -wide with a leading label of \*(lqTo:\*(rq. +wide with a leading label of `To:'. .PP .RS 5 .nf @@ -501,9 +501,9 @@ wide with a leading label of \*(lqTo:\*(rq. .RE .PP .I str -is cleared, and the \*(lqTo:\*(rq and \*(lqCc:\*(rq headers, along with the user's +is cleared, and the `To:' and `Cc:' headers, along with the user's address (depending on what was specified with -the \*(lq\-cc\*(rq switch to \fIrepl\fR\^) are formatted. +the `\-cc' switch to \fIrepl\fR\^) are formatted. .PP .RS 5 .nf @@ -512,7 +512,7 @@ the \*(lq\-cc\*(rq switch to \fIrepl\fR\^) are formatted. .RE .PP If the result is non-null, it is printed as above with a -leading label of \*(lqCc:\*(rq. +leading label of `Cc:'. .PP .RS 5 .nf @@ -532,8 +532,8 @@ a suitable reply subject is output. .fi .RE .PP -If a message-id component was present, an \*(lqIn-Reply-To:\*(rq header is -output including the message-id, followed by a \*(lqReferences:\*(rq +If a message-id component was present, an `In-Reply-To:' header is +output including the message-id, followed by a `References:' header with references, if present, and the message-id. As with all plain-text, the row of dashes are output as-is. @@ -545,17 +545,17 @@ Here's that part again in pseudo-code: .nf .ta .5i 1i 1.5i 2i if (comp_exists(message-id)) then - print (\*(lqIn-reply-to: \*(rq) + print (`In-reply-to: ') print (message-id.value) - print (\*(lq\\n\*(rq) + print (`\\n') endif if (comp_exists(message-id)) then - print (\*(lqReferences: \*(rq) + print (`References: ') if (comp_exists(references)) then print(references.value); endif print (message-id.value) - print (\*(lq\\n\*(rq) + print (`\\n') endif .fi .RE