X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/42abd132e92e77b357fa2598ffcea862c4d003c6..94187a80bd60baab4b9c4b949ad820d730578123:/man/mh-format.man diff --git a/man/mh-format.man b/man/mh-format.man index 6356d68e..85604d75 100644 --- a/man/mh-format.man +++ b/man/mh-format.man @@ -1,9 +1,9 @@ -.TH MH-FORMAT %manext5% "December 18, 2016" "%nmhversion%" -.\" +.TH MH-FORMAT %manext5% 2015-01-10 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -mh-format \- format file for nmh message system +mh-format \- formatting language for nmh message system .SH DESCRIPTION Several .B nmh @@ -115,7 +115,7 @@ These are combined into the conditional execution construct: .nf .RI "%< " condition " " "format-text" .RI "%? " condition " " "format-text" - \&... + ... .RI "%| " "format-text" %> .fi @@ -123,7 +123,7 @@ These are combined into the conditional execution construct: .PP (Extra white space is shown here only for clarity.) These constructs, which may be nested without ambiguity, form a general -.B if\-elseif\-else\-endif +.B if-elseif-else-endif block where only one of the format-texts is interpreted. In other words, `%<' is like the "if", `%?' is like the "elseif", `%|' is like "else", and `%>' is like "endif". @@ -241,7 +241,7 @@ The function escapes may be roughly grouped into a few categories. .RS 5 .nf .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u -.I "Function Argument Result Description" +.I "Function Argument Return Description" msg integer message number cur integer message is current (0 or 1) unseen integer message is unseen (0 or 1) @@ -249,7 +249,7 @@ size integer size of message strlen integer length of \fIstr\fR width integer column width of terminal charleft integer bytes left in output buffer -timenow integer seconds since the UNIX epoch +timenow integer seconds since the Unix epoch me string the user's mailbox (username) myhost string the user's local hostname myname string the user's name @@ -366,7 +366,7 @@ szone date integer timezone explicit? date2local date coerce date to local timezone date2gmt date coerce date to GMT dst date integer daylight savings in effect? (0 or 1) -clock date integer seconds since the UNIX epoch +clock date integer seconds since the Unix epoch rclock date integer seconds prior to current time tws date string official RFC 822 rendering pretty date string user-friendly rendering @@ -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 @@ -532,7 +538,7 @@ register for the width) a better implementation would look like: .PP It should be noted here that the side effects of function and component escapes are still in force and, as a result, each component test in the -.B if\-elseif\-else\-endif +.B if-elseif-else-endif clause sets the .I str register. @@ -769,6 +775,6 @@ at 4 digits. .SH "SEE ALSO" .IR scan (1), .IR repl (1), -.IR fmttest (1), +.IR fmttest (1) .SH CONTEXT None