X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/fbcd71b31868c9969836b00a90a0bf32b13111ef..07661005b9a36338ab158bcbe7762788a1df4030:/man/mh-format.man

diff --git a/man/mh-format.man b/man/mh-format.man
index 83de220b..38d31389 100644
--- a/man/mh-format.man
+++ b/man/mh-format.man
@@ -298,6 +298,13 @@ putnumf	expr		print \fInum\fR in a fixed width
 putlit	expr		print \fIstr\fR without space compression
 zputlit	expr		print \fIstr\fR without space compression;
 			\fIstr\fR must occupy no width on display
+bold		string	set terminal bold mode
+underline		string	set terminal underlined mode
+standout		string	set terminal standout mode
+resetterm		string	reset all terminal attributes
+hascolor		boolean	terminal supports color
+fgcolor	literal	string	set terminal foreground color
+bgcolor	literal	string	set terminal background color
 formataddr	expr		append \fIarg\fR to \fIstr\fR as a
 			(comma separated) address list
 concataddr	expr		append \fIarg\fR to \fIstr\fR as a
@@ -365,6 +372,7 @@ clock	date	integer	seconds since the UNIX epoch
 rclock	date	integer	seconds prior to current time
 tws	date	string	official RFC 822 rendering
 pretty	date	string	user-friendly rendering
+nodate	date	integer	returns 1 if date is invalid
 .fi
 .RE
 .PP
@@ -432,8 +440,29 @@ the str register, but requires that those contents not occupy any
 output width.  It can therefore be used for outputting terminal escape
 sequences.
 .PP
+There are a limited number of function escapes to output terminal escape
+sequences. These sequences are retrieved from the
+.IR terminfo (5)
+database according to the current terminal setting.  The (\fIbold\fR\^),
+(\fIunderline\fR\^), and (\fIstandout\fR\^) escapes set bold mode,
+underline mode, and standout mode respectively.
+.PP
+(\fIhascolor\fR\^)
+can be used to determine if the current terminal supports color.
+(\fIfgcolor\fR\^) and (\fIbgcolor\fR\^) set the foreground and
+background colors respectively.  Both of these escapes take one literal
+argument, the color name, which can be one of: black, red, green, yellow,
+blue, magenta, cyan, white.  (\fIresetterm\fR\^) resets all terminal
+attributes back to their default setting.
+.PP
+All of these terminal escape should be used in conjunction with
+(\fIzputlit\fR\^) (preferred) or (\fIputlit\fR\^), as the normal
+(\fputstr\fR\^) function will strip out control characters.
+.PP
 The available output width is kept in an internal register; any output
-past this width will be truncated.
+past this width will be truncated.  The one exception to this is
+(\fIzputlit\fR\^) functions will still be executed in case a terminal reset
+code is being placed at the end of the line.
 .SS Special Handling
 A few functions have different behavior depending on what command they are
 being invoked from.
@@ -510,16 +539,14 @@ clause sets the
 register.
 .PP
 As an additional note, the (\fIformataddr\fR\^) and (\fIconcataddr\fR\^)
-functions have some behavior when it comes to the
+functions have special behavior when it comes to the
 .I str
 register.  The starting point of the register is saved and is used to
 build up entries in the address list.
 .PP
 You will find the
-.B ap
-and
-.B fmtdump
-utilities invaluable in debugging problems with format strings.
+.B fmttest
+utility invaluable when debugging problems with format strings.
 .SS Examples
 With all this in mind,
 here's the default format string for
@@ -749,7 +776,6 @@ at 4 digits.
 .SH "SEE ALSO"
 .IR scan (1),
 .IR repl (1),
-.IR ap (8),
-.IR dp (8)
+.IR fmttest (1),
 .SH CONTEXT
 None