Migrated a couple more tests to use run_test() in common.sh.

[mmh] / man / mh-format.man

diff --git a/man/mh-format.man b/man/mh-format.man
index 57cf771..d8a83b2 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)
-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
@@ -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 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