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.
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
.\" TALK ABOUT SYNTAX FIRST, THEN SEMANTICS
.SS SYNTAX
Format strings are built around
component, they are listed without a leading `%'. When control escapes
are used as function arguments, they written as normally, with
a leading `%';
component, they are listed without a leading `%'. When control escapes
are used as function arguments, they written as normally, with
a leading `%';
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.
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.
.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.
literal A literal number %(\fIfunc\fR 1234)
or string %(\fIfunc\fR text string)
comp Any component %(\fIfunc\fR\^{\fIin-reply-to\fR\^})
literal A literal number %(\fIfunc\fR 1234)
or string %(\fIfunc\fR text string)
comp Any component %(\fIfunc\fR\^{\fIin-reply-to\fR\^})
msg integer message number
cur integer message is current (0 or 1)
unseen integer message is unseen (0 or 1)
msg integer message number
cur integer message is current (0 or 1)
unseen integer message is unseen (0 or 1)
putnumf expr print \fInum\fR in a fixed width
.\" addtoseq literal add msg to sequence (LBL option)
putlit expr print \fIstr\fR without space compression
putnumf expr print \fInum\fR in a fixed width
.\" addtoseq literal add msg to sequence (LBL option)
putlit expr print \fIstr\fR without space compression
formataddr expr append \fIarg\fR to \fIstr\fR as a
(comma separated) address list
concataddr expr append \fIarg\fR to \fIstr\fR as a
formataddr expr append \fIarg\fR to \fIstr\fR as a
(comma separated) address list
concataddr expr append \fIarg\fR to \fIstr\fR as a
-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
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
sec date integer seconds of the minute
min date integer minutes of the hour
hour date integer hours of the day (0-23)
sec date integer seconds of the minute
min date integer minutes of the hour
hour date integer hours of the day (0-23)
proper addr string official 822 rendering
friendly addr string user-friendly rendering
addr addr string mbox@host or host!mbox rendering*
proper addr string official 822 rendering
friendly addr string user-friendly rendering
addr addr string mbox@host or host!mbox rendering*
The functions (\fIputnum\fR\^) and
(\fIputstr\fR\^) are somewhat special: they print their result in the minimum number of characters
required, and ignore any leading field width argument. The (\fIputlit\fR\^)
The functions (\fIputnum\fR\^) and
(\fIputstr\fR\^) are somewhat special: they print their result in the minimum number of characters
required, and ignore any leading field width argument. The (\fIputlit\fR\^)
.PP
The available output width is kept in an internal register; any output
past this width will be truncated.
.PP
The available output width is kept in an internal register; any output
past this width will be truncated.
for more details about %{\fIfcc\fR\^}),
an \*(lqFcc:\*(rq header is output.
.PP
for more details about %{\fIfcc\fR\^}),
an \*(lqFcc:\*(rq header is output.
.PP