Fix a segfault that happens when using the -file option.

[nmh] / man / mh-format.man

diff --git a/man/mh-format.man b/man/mh-format.man
index 57cf7713ed012f4d27724930f239365548ae6d95..2d1c69e49bd193d7eb89af25e3b80dcd2cd342d9 100644 (file)
--- a/man/mh-format.man
+++ b/man/mh-format.man
@@ -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)
 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
 eq     literal boolean \fInum\fR == \fIarg\fR
 ne     literal boolean \fInum\fR != \fIarg\fR
 gt     literal boolean \fInum\fR > \fIarg\fR


@@ -323,7 +324,17 @@ 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
 .B SIGNATURE
 environment variable if set, otherwise will return the passwd GECOS field for

-the current user.
+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
 .PP
 The following functions require a date component as an argument:
 .PP


@@ -453,7 +464,7 @@ generated will be something like:
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-My From User <from@user.com>To: My From User <from@user.com>
+My From User <from@example.com>To: My From User <from@example.com>

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP