X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d1cb667bddf8d1c5c0721fc7ab642c22946baf1f..3441b5648a0c21e067c05f428a51bf96352735e7:/man/mh-format.man

diff --git a/man/mh-format.man b/man/mh-format.man
index 7aad129b..83de220b 100644
--- a/man/mh-format.man
+++ b/man/mh-format.man
@@ -1,4 +1,4 @@
-.TH MH-FORMAT %manext5% "March 24, 2012" "%nmhversion%"
+.TH MH-FORMAT %manext5% "November 4, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -253,7 +253,7 @@ cur		integer	message is current (0 or 1)
 unseen		integer	message is unseen (0 or 1)
 size		integer	size of message
 strlen		integer	length of \fIstr\fR
-width		integer	output buffer size in bytes
+width		integer	column width of terminal
 charleft		integer	bytes left in output buffer
 timenow		integer	seconds since the UNIX epoch
 me		string	the user's mailbox (username)
@@ -285,18 +285,19 @@ void	expr		Set \fIstr\fR or \fInum\fR
 comp	comp	string	Set \fIstr\fR to component text
 compval	comp	integer	Set \fInum\fR to \*(lq\fBatoi\fR(\fIcomp\fR\^)\*(rq
 .\" compflag	comp	integer	Set \fInum\fR to component flags bits (internal)
-.\" decodecomp	comp	string	Set \fIstr\fR to RFC-2047 decoded component text
-decode	expr	string	decode \fIstr\fR as RFC-2047 (MIME-encoded) 
+.\" decodecomp	comp	string	Set \fIstr\fR to RFC 2047 decoded component text
+decode	expr	string	decode \fIstr\fR as RFC 2047 (MIME-encoded) 
 			component
-unquote	expr	string	remove RFC-2822 quotes from \fIstr\fR
-trim	expr		trim trailing white-space from \fIstr\fR
+unquote	expr	string	remove RFC 2822 quotes from \fIstr\fR
+trim	expr		trim trailing whitespace from \fIstr\fR
 putstr	expr		print \fIstr\fR
 putstrf	expr		print \fIstr\fR in a fixed width
 putnum	expr		print \fInum\fR
 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
-nodate	string	integer	Argument not a date string (0 or 1)
+zputlit	expr		print \fIstr\fR without space compression;
+			\fIstr\fR must occupy no width on display
 formataddr	expr		append \fIarg\fR to \fIstr\fR as a
 			(comma separated) address list
 concataddr	expr		append \fIarg\fR to \fIstr\fR as a
@@ -362,7 +363,7 @@ date2gmt	date		coerce date to GMT
 dst	date	integer	daylight savings in effect? (0 or 1)
 clock	date	integer	seconds since the UNIX epoch
 rclock	date	integer	seconds prior to current time
-tws	date	string	official 822 rendering
+tws	date	string	official RFC 822 rendering
 pretty	date	string	user-friendly rendering
 .fi
 .RE
@@ -375,7 +376,7 @@ the first address present in the header component.
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u
 .I "Function	Argument	Return	Description"
-proper	addr	string	official 822 rendering
+proper	addr	string	official RFC 822 rendering
 friendly	addr	string	user-friendly rendering
 addr	addr	string	mbox@host or host!mbox rendering*
 pers	addr	string	the personal name*
@@ -424,8 +425,12 @@ the left up to the field width.
 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\^)
-function outputs the exact contents of str register without any changes
+function outputs the exact contents of the str register without any changes
 such as duplicate space removal or control character conversion.
+The (\fIzputlit\fR\^) function similarly outputs the exact contents of
+the str register, but requires that those contents not occupy any
+output width.  It can therefore be used for outputting terminal escape
+sequences.
 .PP
 The available output width is kept in an internal register; any output
 past this width will be truncated.