X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmh-format.man;h=1063b0d2a6426c97da57356512d9bf344e5af70f;hb=7946a8c713bd43a52229345ad0289aaa461acfb3;hp=57cf7713ed012f4d27724930f239365548ae6d95;hpb=dd0acb9f9e2206182c738c2fa5e1d9775b7fda48;p=mmh diff --git a/man/mh-format.man b/man/mh-format.man index 57cf771..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) @@ -261,8 +261,9 @@ width integer output buffer size in bytes charleft integer bytes left in output buffer 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 +myhost string the user's local hostname +myname string the user's name +localmbox string the complete local mailbox eq literal boolean \fInum\fR == \fIarg\fR ne literal boolean \fInum\fR != \fIarg\fR gt literal boolean \fInum\fR > \fIarg\fR @@ -322,15 +323,26 @@ 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 -the current user. +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 +.RI \*(lq Local-Mailbox \*(rq +profile entry if it is set; if it is not, it will be equivalent to: +.PP +.RS 5 +.nf +%(myname) <%(me)@%(myhost)> +.fi +.RE .PP The following functions require a date component as an argument: .PP .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) @@ -366,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* @@ -453,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