BSD 4_3_Net_2 release
[unix-history] / usr / src / share / man / man5 / printcap.5
index 69d0196..93374a3 100644 (file)
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991 Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.\"    @(#)printcap.5  6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.TH PRINTCAP 5 ""
-.UC 5
-.ad
-.SH NAME
-printcap \- printer capability data base
-.SH SYNOPSIS
-/etc/printcap
-.SH DESCRIPTION
-.I Printcap
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)printcap.5 6.6 (Berkeley) 5/10/91
+.\"
+.Dd May 10, 1991
+.Dt PRINTCAP 5
+.Os BSD 4.2
+.Sh NAME
+.Nm printcap
+.Nd printer capability data base
+.Sh SYNOPSIS
+.Nm printcap
+.Sh DESCRIPTION
+The
+.Nm Printcap
+function
 is a simplified version of the
 is a simplified version of the
-.IR termcap (5)
+.Xr termcap 5
 data base
 used to describe line printers.  The spooling system accesses the
 data base
 used to describe line printers.  The spooling system accesses the
-.I printcap
+.Nm printcap
 file every time it is used, allowing dynamic
 addition and deletion of printers.  Each entry in the data base
 is used to describe one printer.  This data base may not be
 substituted for, as is possible for 
 file every time it is used, allowing dynamic
 addition and deletion of printers.  Each entry in the data base
 is used to describe one printer.  This data base may not be
 substituted for, as is possible for 
-.IR termcap ,
+.Xr termcap ,
 because it may allow accounting to be bypassed.
 because it may allow accounting to be bypassed.
-.PP
+.Pp
 The default printer is normally 
 The default printer is normally 
-.IR lp ,
-though the environment variable PRINTER
+.Em lp ,
+though the environment variable
+.Ev PRINTER
 may be used to override this.  Each spooling utility supports an option,
 may be used to override this.  Each spooling utility supports an option,
-.BI \-P printer,
+.Fl P Ar printer ,
 to allow explicit naming of a destination printer.
 to allow explicit naming of a destination printer.
-.PP
+.Pp
 Refer to the
 Refer to the
-.ul
-4.2BSD Line Printer Spooler Manual
+.%T "4.3 BSD Line Printer Spooler Manual"
 for a complete discussion on how setup the database for a given printer.
 for a complete discussion on how setup the database for a given printer.
-.SH CAPABILITIES
+.Sh CAPABILITIES
 Refer to
 Refer to
-.I termcap
+.Xr termcap 5
 for a description of the file layout.
 for a description of the file layout.
-.nf
-
-.ta \w'k0-k9  'u +\w'Type  'u +\w'``/usr/spool/lpd\'\'  'u
-\fBName        Type    Default Description\fR
-af     str     NULL    name of accounting file
-br     num     none    if lp is a tty, set the baud rate (ioctl call)
-cf     str     NULL    cifplot data filter
-df     str     NULL    tex data filter (DVI format)
-fc     num     0       if lp is a tty, clear flag bits (sgtty.h)
-ff     str     ``\ef'' string to send for a form feed
-fo     bool    false   print a form feed when device is opened
-fs     num     0       like `fc' but set bits
-gf     str     NULL    graph data filter (plot (3X) format)
-hl     bool    false   print the burst header page last
-ic     bool    false   driver supports (non standard) ioctl to indent printout
-if     str     NULL    name of text filter which does accounting
-lf     str     ``/dev/console''        error logging file name
-lo     str     ``lock''        name of lock file
-lp     str     ``/dev/lp''     device name to open for output
-mx     num     1000    maximum file size (in BUFSIZ blocks), zero = unlimited
-nd     str     NULL    next directory for list of queues (unimplemented)
-nf     str     NULL    ditroff data filter (device independent troff)
-of     str     NULL    name of output filtering program
-pl     num     66      page length (in lines)
-pw     num     132     page width (in characters)
-px     num     0       page width in pixels (horizontal)
-py     num     0       page length in pixels (vertical)
-rf     str     NULL    filter for printing FORTRAN style text files
-rg     str     NULL    restricted group. Only members of group allowed access
-rm     str     NULL    machine name for remote printer
-rp     str     ``lp''  remote printer name argument
-rs     bool    false   restrict remote users to those with local accounts
-rw     bool    false   open the printer device for reading and writing
-sb     bool    false   short banner (one line only)
-sc     bool    false   suppress multiple copies
-sd     str     ``/usr/spool/lpd''      spool directory
-sf     bool    false   suppress form feeds
-sh     bool    false   suppress printing of burst page header
-st     str     ``status''      status file name
-tf     str     NULL    troff data filter (cat phototypesetter)
-tr     str     NULL    trailer string to print when queue empties
-vf     str     NULL    raster image filter
-xc     num     0       if lp is a tty, clear local mode bits (tty (4))
-xs     num     0       like `xc' but set bits
-.fi
-.PP
-Error messages sent to the console have a carriage return and a line
-feed appended to them, rather than just a line feed.
-.PP
+.Bl -column Namexxx Typexx "/var/spool/lpdxxxxx"
+.Sy Name       Type    Description
+.It "af        str" Ta Dv NULL Ta No "name of accounting file"
+.It "br        num     none    if lp is a tty, set the baud rate"
+.Pf ( Xr ioctl 2
+call)
+.It "cf        str" Ta Dv NULL Ta No "cifplot data filter"
+.It "df        str" Ta Dv NULL Ta No "tex data filter"
+.Pf ( Tn DVI
+format)
+.It "fc        num     0       if lp is a tty, clear flag bits"
+.Pq Pa sgtty.h
+.It "ff        str" Ta So Li \ef Sc Ta No "string to send for a form feed"
+.It "fo        bool    false   print a form feed when device is opened"
+.It "fs        num     0       like `fc' but set bits"
+.It "gf        str" Ta Dv NULL Ta No "graph data filter"
+.Pf ( Xr plot 3
+format
+.It "hl        bool    false   print the burst header page last"
+.It "ic        bool    false   driver supports (non standard) ioctl to indent printout"
+.It "if        str" Ta Dv NULL Ta No "name of text filter which does accounting"
+.It "lf        str" Ta Pa /dev/console Ta No "error logging file name"
+.It "lo        str" Ta Pa lock Ta No "name of lock file"
+.It "lp        str" Ta Pa /dev/lp Ta No "device name to open for output"
+.It "mx        num     1000    maximum file size (in"
+.Dv BUFSIZ
+blocks), zero = unlimited
+.It "nd        str" Ta Dv NULL Ta No "next directory for list of queues (unimplemented)"
+.It "nf        str" Ta Dv NULL Ta No "ditroff data filter (device independent troff)"
+.It "of        str" Ta Dv NULL Ta No "name of output filtering program"
+.It "pc        num     200     price per foot or page in hundredths of cents"
+.It "pl        num     66      page length (in lines)"
+.It "pw        num     132     page width (in characters)"
+.It "px        num     0       page width in pixels (horizontal)"
+.It "py        num     0       page length in pixels (vertical)"
+.It "rf        str" Ta Dv NULL Ta No "filter for printing"
+.Tn FORTRAN
+style text files
+.It "rg        str" Ta Dv NULL Ta No "restricted group. Only members of group allowed access"
+.It "rm        str" Ta Dv NULL Ta No "machine name for remote printer"
+.It "rp        str     ``lp''  remote printer name argument"
+.It "rs        bool    false   restrict remote users to those with local accounts"
+.It "rw        bool    false   open the printer device for reading and writing"
+.It "sb        bool    false   short banner (one line only)"
+.It "sc        bool    false   suppress multiple copies"
+.It "sd        str" Ta Pa /var/spool/lpd Ta No "spool directory"
+.It "sf        bool    false   suppress form feeds"
+.It "sh        bool    false   suppress printing of burst page header"
+.It "st        str" Ta Pa status Ta No "status file name"
+.It "tf        str" Ta Dv NULL Ta No "troff data filter (cat phototypesetter)"
+.It "tr        str" Ta Dv NULL Ta No "trailer string to print when queue empties"
+.It "vf        str" Ta Dv NULL Ta No "raster image filter"
+.It "xc        num     0       if lp is a tty, clear local mode bits"
+.Pq Xr tty 4
+.It "xs        num     0       like `xc' but set bits"
+.El
+.Pp
 If the local line printer driver supports indentation, the daemon
 must understand how to invoke it.
 If the local line printer driver supports indentation, the daemon
 must understand how to invoke it.
-.SH "SEE ALSO"
-termcap(5),
-lpc(8),
-lpd(8),
-pac(8),
-lpr(1),
-lpq(1),
-lprm(1)
-.br
-.ul
-4.2BSD Line Printer Spooler Manual
+.Sh FILTERS
+The
+.Xr lpd 8
+daemon creates a pipeline of
+.Em filters
+to process files for various printer types.
+The filters selected depend on the flags passed to
+.Xr lpr 1 .
+The pipeline set up is:
+.Bd -literal -offset indent
+p      pr | if regular text + pr(1)
+none   if      regular text
+c      cf      cifplot
+d      df      DVI (tex)
+g      gf      plot(3)
+n      nf      ditroff
+f      rf      Fortran
+t      tf      troff
+v      vf      raster image
+.Ed
+.Pp
+The
+.Sy if
+filter is invoked with arguments:
+.Bd -filled -offset indent
+.Cm if
+.Op Fl c
+.Fl w Ns Ar width
+.Fl l Ns Ar length
+.Fl i Ns Ar indent
+.Fl n Ar login
+.Fl h Ar host acct-file
+.Ed
+.Pp
+The
+.Fl c
+flag is passed only if the
+.Fl l
+flag (pass control characters literally)
+is specified to
+.Xr lpr .
+The
+.Ar Width
+function
+and
+.Ar length
+specify the page width and length
+(from
+.Cm pw
+and
+.Cm pl
+respectively) in characters.
+The
+.Fl n
+and
+.Fl h
+parameters specify the login name and host name of the owner
+of the job respectively.
+The
+.Ar Acct-file
+function
+is passed from the
+.Cm af
+.Nm printcap
+entry.
+.Pp
+If no
+.Cm if
+is specified,
+.Cm of
+is used instead,
+with the distinction that
+.Cm of
+is opened only once,
+while
+.Cm if
+is opened for every individual job.
+Thus,
+.Cm if
+is better suited to performing accounting.
+The
+.Cm of
+is only given the
+.Ar width
+and
+.Ar length
+flags.
+.Pp
+All other filters are called as:
+.Bd -filled -offset indent
+.Nm filter
+.Fl x Ns Ar width
+.Fl y Ns Ar length
+.Fl n Ar login
+.Fl h Ar host acct-file
+.Ed
+.Pp
+where
+.Ar width
+and
+.Ar length
+are represented in pixels,
+specified by the
+.Cm px
+and
+.Cm py
+entries respectively.
+.Pp
+All filters take
+.Em stdin
+as the file,
+.Em stdout
+as the printer,
+may log either to
+.Em stderr
+or using
+.Xr syslog 3 ,
+and must not ignore
+.Dv SIGINT . 
+.Sh LOGGING
+Error messages generated by the line printer programs themselves
+(that is, the
+.Xr lp Ns *
+programs)
+are logged by
+.Xr syslog 3
+using the
+.Dv LPR
+facility.
+Messages printed on
+.Em stderr
+of one of the filters
+are sent to the corresponding
+.Cm lf
+file.
+The filters may, of course, use
+.Xr syslog
+themselves.
+.Pp
+Error messages sent to the console have a carriage return and a line
+feed appended to them, rather than just a line feed.
+.Sh SEE ALSO
+.Xr termcap 5 ,
+.Xr lpc 8 ,
+.Xr lpd 8 ,
+.Xr pac 8 ,
+.Xr lpr 1 ,
+.Xr lpq 1 ,
+.Xr lprm 1
+.Rs
+.%T "4.3 BSD Line Printer Spooler Manual"
+.Re
+.Sh HISTORY
+The
+.Nm
+file format appeared in
+.Bx 4.2 ..