New function `pquis'.

[mLib] / man / quis.3

diff --git a/man/quis.3 b/man/quis.3
index 3b2cce8..30e95ca 100644 (file)
--- a/man/quis.3
+++ b/man/quis.3
@@ -1,7 +1,11 @@
 .\" -*-nroff-*-
 .\" -*-nroff-*-

-.TH quis 3mLib "22 May 1999" mLib
+.TH quis 3 "22 May 1999" mLib

 .SH NAME
 quis \- remember the program's name for use in messages
 .SH NAME
 quis \- remember the program's name for use in messages

+.\" @quis
+.\" @ego
+.\" @QUIS
+.\" @pquis

 .SH SYNOPSIS
 .nf
 .B "#include <mLib/quis.h>"
 .SH SYNOPSIS
 .nf
 .B "#include <mLib/quis.h>"


@@ -9,6 +13,7 @@ quis \- remember the program's name for use in messages
 .BI "void ego(const char *" p );
 .B "const char *quis(void);"
 .B "const char *QUIS;"
 .BI "void ego(const char *" p );
 .B "const char *quis(void);"
 .B "const char *QUIS;"

+.BI "int pquis(FILE *" fp ", const char *" p );

 .fi
 .SH DESCRIPTION
 The
 .fi
 .SH DESCRIPTION
 The


@@ -31,10 +36,29 @@ returned by
 Don't ask why it's done this way.  There are raisins, but they're mostly
 hysterical.
 .PP
 Don't ask why it's done this way.  There are raisins, but they're mostly
 hysterical.
 .PP

+The function
+.B pquis
+is passed a file pointer
+.I fp
+and a string
+.IR p :
+it writes the string to the file, replacing every lone occurrence of the
+character
+.RB ` $ '
+by the program name.  Pairs
+.RB (` $$ ')
+are written as single dollar signs.  The return value is zero if
+everything went OK, or the constant
+.B EOF
+if there was an error.
+.PP

 The program name is used in the messages produced by the
 The program name is used in the messages produced by the

-.BR die (3mLib)
+.BR die (3)

 and
 and

-.BR moan (3mLib)
+.BR moan (3)

 functions.
 functions.

+.SH "SEE ALSO"
+.BR report (3),
+.BR mLib (3).

 .SH AUTHOR
 Mark Wooding, <mdw@nsict.org>
 .SH AUTHOR
 Mark Wooding, <mdw@nsict.org>