X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmh-format.man;h=7d417aa445ceb713a60ba5511412fb72b71bb310;hb=0f0af4e32a4d734209c16282b63f7cb1094e2699;hp=2d1c69e49bd193d7eb89af25e3b80dcd2cd342d9;hpb=58e2db8c886765caf1ce294ba8336fe683bcd888;p=mmh diff --git a/man/mh-format.man b/man/mh-format.man index 2d1c69e..7d417aa 100644 --- a/man/mh-format.man +++ b/man/mh-format.man @@ -1,7 +1,7 @@ +.TH MH-FORMAT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] .\" .\" %nmhwarning% .\" -.TH MH-FORMAT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mh-format \- format file for nmh message system .SH DESCRIPTION @@ -46,7 +46,6 @@ escape sequences which begin with `%'. When specifying a format string, the usual C backslash characters are honored: `\\b', `\\f', `\\n', `\\r', and `\\t'. Continuation lines in format files end with `\\' followed by the newline character. - .\" TALK ABOUT SYNTAX FIRST, THEN SEMANTICS .SS SYNTAX Format strings are built around @@ -100,7 +99,6 @@ or a control escape. When the argument is a function or a component, they are listed without a leading `%'. When control escapes are used as function arguments, they written as normally, with a leading `%'; - .SS "Control escapes" .PP A @@ -137,13 +135,11 @@ if the function return or component value is non-zero, and false if zero. For string valued functions or components, the condition is true if the function return or component value is a non-empty string, and false for an empty string. - .PP The `%?' control escape is optional, and may there may be more than one `%?' control escape in a conditional block. The `%|' control escape is also optional, but may be included at most once. - .SS "Function escapes" Functions expecting an argument generally require an argument of a particular type. @@ -153,7 +149,7 @@ these include: .RS 5 .nf .ta +\w'Argument 'u +\w'An optional component, 'u -.I Argument Description Example Syntax +.I "Argument Description Example Syntax" literal A literal number %(\fIfunc\fR 1234) or string %(\fIfunc\fR text string) comp Any component %(\fIfunc\fR\^{\fIin-reply-to\fR\^}) @@ -251,7 +247,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 Result Description" msg integer message number cur integer message is current (0 or 1) unseen integer message is unseen (0 or 1) @@ -323,7 +319,8 @@ or the local hostname if is not configured. The (\fImyname\fR\^) function will return the value of the .B SIGNATURE -environment variable if set, otherwise will return the passwd GECOS field for +environment variable if set, otherwise will return the passwd GECOS field +(truncated at the first comma if it contains one) for the current user. The (\fIlocalmbox\fR\^) function will return the complete form of the local mailbox, suitable for use in a \*(lqFrom\*(rq header. It will return the @@ -341,7 +338,7 @@ The following functions require a date component as an argument: .RS 5 .nf .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u -.I Function Argument Return Description +.I "Function Argument Return Description" sec date integer seconds of the minute min date integer minutes of the hour hour date integer hours of the day (0-23) @@ -377,7 +374,7 @@ the first address present in the header component. .RS 5 .nf .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u -.I Function Argument Return Description +.I "Function Argument Return Description" proper addr string official 822 rendering friendly addr string user-friendly rendering addr addr string mbox@host or host!mbox rendering* @@ -655,7 +652,7 @@ If a switch was given to .B repl (see -.BR repl (1) +.IR repl (1) for more details about %{\fIfcc\fR\^}), an \*(lqFcc:\*(rq header is output. .PP @@ -742,10 +739,12 @@ conditional is used to test whether the message number has 5 or more digits. -If so, it is printed at full width: otherwise +If so, it is printed at full width, otherwise at 4 digits. .SH "SEE ALSO" -scan(1), repl(1), ap(8), dp(8) - +.IR scan (1), +.IR repl (1), +.IR ap (8), +.IR dp (8) .SH CONTEXT None