Makes files and comments refering to install or configure variables up to date

[netatalk.git] / man / man8 / papstatus.8.tmpl

diff --git a/man/man8/papstatus.8.tmpl b/man/man8/papstatus.8.tmpl
new file mode 100644 (file)
index 0000000..8d8ab00
--- /dev/null
+++ b/man/man8/papstatus.8.tmpl
@@ -0,0 +1,84 @@
+.TH PAPSTATUS 8 "17 Dec 1991"
+.SH NAME
+papstatus \- get the status of an AppleTalk-connected printer
+.SH SYNOPSIS
+.B :SBINDIR:/papstatus
+[
+.BI -d
+] [
+.B -p
+.I printer
+] [
+.I retrytime
+]
+.SH DESCRIPTION
+.B papstatus
+is used to obtain the current status message from an AppleTalk connected
+printer.  It uses the Printer Access Protocol (PAP) to obtain the
+status information.
+.LP
+If no printer is specified on the command line,
+.B papstatus
+looks for a file called
+.B .paprc
+in the current directory and reads it to obtain the name of a printer.  The
+.B .paprc
+file should contain a single line of the form
+.IB object : \c
+.IB type @ \c
+.I zone
+where each of
+.IR object ,
+.BI : type ,
+and
+.BI @ zone
+are optional.
+.I type
+and
+.I zone
+must be proceeded by
+.RB ` : '
+and
+.RB ` @ '
+respectively.  Blank lines and lines the begin with a
+.RB ` # '
+are ignored.
+.I type
+and
+.I zone
+default to
+.B LaserWriter
+and the zone of the local host, respectively.
+.SH OPTIONS
+.TP
+.B -d
+Turns on a debugging mode that prints some extra information to standard error.
+.HP
+.B -p
+.I printer
+.br
+Get status from
+.I printer
+(do not consult any
+.B .paprc
+files to find a printer name).  The syntax for
+.I printer
+is the same as discussed above for the
+.B .paprc
+file.
+.TP
+.I retrytime
+Normally,
+.B papstatus
+only gets the status from the printer once.  If
+.I retrytime
+is specified, the status is obtained repeatedly, with a sleep of
+.I retrytime
+seconds between inquiring the printer.
+.SH FILES
+.TP 20
+.B .paprc
+file that contains printer name
+.SH SEE ALSO
+.BR nbp (1),
+.BR pap (8)