X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmh-format.man;h=1063b0d2a6426c97da57356512d9bf344e5af70f;hb=c897634e1c28697a6df572de00e66579567ad2a6;hp=d8a83b274916d92100bc9581ecbc8612b3e7f49e;hpb=ae773e71c0efe0a8a7bb2f243e784c576e72c9e4;p=mmh diff --git a/man/mh-format.man b/man/mh-format.man index d8a83b2..1063b0d 100644 --- a/man/mh-format.man +++ b/man/mh-format.man @@ -153,7 +153,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 +251,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 +323,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 +342,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 +378,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* @@ -464,7 +465,7 @@ generated will be something like: .PP .RS 5 .nf -My From User To: My From User +My From User To: My From User .fi .RE .PP