BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / lpr / lpd / lpd.8

diff --git a/usr/src/usr.sbin/lpr/lpd/lpd.8 b/usr/src/usr.sbin/lpr/lpd/lpd.8
index e143d86..e4a96dd 100644 (file)
--- a/usr/src/usr.sbin/lpr/lpd/lpd.8
+++ b/usr/src/usr.sbin/lpr/lpd/lpd.8
@@ -1,219 +1,249 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"    @(#)lpd.8       6.5 (Berkeley) 6/24/90
+.\" 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.

 .\"
 .\"

-.TH LPD 8 "June 24, 1990"
-.UC 5
-.ad
-.SH NAME
-lpd \- line printer daemon
-.SH SYNOPSIS
-.B lpd
-[
-.B \-l
-] [ port # ]
-.SH DESCRIPTION
-.I Lpd
+.\"     @(#)lpd.8      6.6 (Berkeley) 3/16/91
+.\"
+.Dd March 16, 1991
+.Dt LPD 8
+.Os BSD 4.2
+.Sh NAME
+.Nm lpd
+.Nd line printer spooler daemon
+.Sh SYNOPSIS
+.Nm lpd
+.Op Fl l
+.Op Ar port#
+.Sh DESCRIPTION
+.Nm Lpd

 is the line printer daemon (spool area handler) and is normally invoked
 at boot time from the
 is the line printer daemon (spool area handler) and is normally invoked
 at boot time from the

-.IR rc (8)
+.Xr rc 8

 file.  It makes a single pass through the
 file.  It makes a single pass through the

-.IR printcap (5)
+.Xr printcap 5

 file to find out about the existing printers and
 prints any files left after a crash. It then uses the system calls
 file to find out about the existing printers and
 prints any files left after a crash. It then uses the system calls

-.IR listen (2)
+.Xr listen 2

 and
 and

-.IR accept (2)
+.Xr accept 2

 to receive requests to print files in the queue,
 transfer files to the spooling area, display the queue,
 or remove jobs from the queue.  In each case, it forks a child to handle
 the request so the parent can continue to listen for more requests.
 to receive requests to print files in the queue,
 transfer files to the spooling area, display the queue,
 or remove jobs from the queue.  In each case, it forks a child to handle
 the request so the parent can continue to listen for more requests.

-The Internet port number used to rendezvous
-with other processes is normally obtained with
-.IR getservbyname (3)
-but can be changed with the
-.IR port #
-argument.
+.Pp
+Available options:
+.Bl -tag -width Ds
+.It Fl l

 The
 The

-.B \-l
+.Fl l

 flag causes
 flag causes

-.I lpd
+.Nm lpd

 to log valid requests received from the network. This can be useful
 for debugging purposes.
 to log valid requests received from the network. This can be useful
 for debugging purposes.

-.PP
-Access control is provided by two means. First, All requests must come from
+.It Ar "port#"
+The Internet port number used to rendezvous
+with other processes is normally obtained with
+.Xr getservbyname 3
+but can be changed with the
+.Ar port#
+argument.
+.El
+.Pp
+Access control is provided by two means. First, all requests must come from

 one of the machines listed in the file
 one of the machines listed in the file

-.I /etc/hosts.equiv
+.Pa /etc/hosts.equiv

 or
 or

-.IR /etc/hosts.lpd .
-Second, if the ``rs'' capability is specified in the
-.I printcap
+.Pa /etc/hosts.lpd .
+Second, if the
+.Li rs
+capability is specified in the
+.Xr printcap

 entry for the printer being accessed,
 entry for the printer being accessed,

-.I lpr
+.Em lpr

 requests will only be honored for those users with accounts on the
 machine with the printer.
 requests will only be honored for those users with accounts on the
 machine with the printer.

-.PP
+.Pp

 The file
 The file

-.I minfree
+.Em minfree

 in each spool directory contains the number of disk blocks to leave free
 so that the line printer queue won't completely fill the disk.
 The
 in each spool directory contains the number of disk blocks to leave free
 so that the line printer queue won't completely fill the disk.
 The

-.I minfree
+.Em minfree

 file can be edited with your favorite text editor.
 file can be edited with your favorite text editor.

-.PP
-The file
-.I lock
-in each spool directory is used to prevent multiple daemons from
-becoming active simultaneously, and to store information
-about the daemon process for
-.IR lpr (1),
-.IR lpq (1),
-and
-.IR lprm (1).
-After the daemon has successfully set the lock, it scans the directory
+.Pp
+The daemon begins processing files
+after it has successfully set the lock for exclusive
+access (descibed a bit later),
+and scans the spool directory

 for files beginning with 
 for files beginning with 

-.IR cf .
+.Em cf .

 Lines in each
 Lines in each

-.I cf
+.Em cf

 file specify files to be printed or non-printing actions to be
 performed.  Each such line begins with a key character
 to specify what to do with the remainder of the line.
 file specify files to be printed or non-printing actions to be
 performed.  Each such line begins with a key character
 to specify what to do with the remainder of the line.

-.in +3
-.IP J
+.Bl -tag -width Ds
+.It J

 Job Name.  String to be used for the job name on the burst page.
 Job Name.  String to be used for the job name on the burst page.

-.IP C
+.It C

 Classification.  String to be used for the classification line
 on the burst page.
 Classification.  String to be used for the classification line
 on the burst page.

-.IP L
+.It L

 Literal.  The line contains identification info from
 the password file and causes the banner page to be printed.
 Literal.  The line contains identification info from
 the password file and causes the banner page to be printed.

-.IP T
+.It T

 Title.  String to be used as the title for
 Title.  String to be used as the title for

-.IR pr (1).
-.IP H
+.Xr pr 1 .
+.It H

 Host Name.  Name of the machine where
 Host Name.  Name of the machine where

-.I lpr
+.Xr lpr

 was invoked.
 was invoked.

-.IP P
+.It P

 Person.  Login name of the person who invoked
 Person.  Login name of the person who invoked

-.IR lpr .
+.Xr lpr .

 This is used to verify ownership by
 This is used to verify ownership by

-.IR lprm .
-.IP M
+.Xr lprm .
+.It M

 Send mail to the specified user when the current print job completes.
 Send mail to the specified user when the current print job completes.

-.IP f
+.It f

 Formatted File.  Name of a file to print which is already formatted.
 Formatted File.  Name of a file to print which is already formatted.

-.IP l
+.It l

 Like ``f'' but passes control characters and does not make page breaks.
 Like ``f'' but passes control characters and does not make page breaks.

-.IP p
+.It p

 Name of a file to print using
 Name of a file to print using

-.IR pr (1)
+.Xr pr 1

 as a filter.
 as a filter.

-.IP t
+.It t

 Troff File.  The file contains
 Troff File.  The file contains

-.IR troff (1)
+.Xr troff 1

 output (cat phototypesetter commands).
 output (cat phototypesetter commands).

-.IP n
+.It n

 Ditroff File.  The file contains device independent troff
 output.
 Ditroff File.  The file contains device independent troff
 output.

-.IP d
+.It r

 DVI File.  The file contains
 DVI File.  The file contains

-.IR Tex (l)
-output (DVI format from Standford).
-.IP g
+.Tn Tex l
+output
+DVI format from Standford).
+.It g

 Graph File.  The file contains data produced by
 Graph File.  The file contains data produced by

-.IR plot (3X).
-.IP c
+.Xr plot 3 .
+.It c

 Cifplot File. The file contains data produced by
 Cifplot File. The file contains data produced by

-.IR cifplot .
-.IP v
+.Em cifplot .
+.It v

 The file contains a raster image.
 The file contains a raster image.

-.IP r
-The file contains text data with FORTRAN carriage control characters.
-.IP 1
+.It r
+The file contains text data with
+FORTRAN carriage control characters.
+.It \&1

 Troff Font R. Name of the font file to use instead of the default.
 Troff Font R. Name of the font file to use instead of the default.

-.IP 2
+.It \&2

 Troff Font I. Name of the font file to use instead of the default.
 Troff Font I. Name of the font file to use instead of the default.

-.IP 3
+.It \&3

 Troff Font B. Name of the font file to use instead of the default.
 Troff Font B. Name of the font file to use instead of the default.

-.IP 4
+.It \&4

 Troff Font S. Name of the font file to use instead of the default.
 Troff Font S. Name of the font file to use instead of the default.

-.IP W
+.It W

 Width. Changes the page width (in characters) used by
 Width. Changes the page width (in characters) used by

-.IR pr (1)
+.Xr pr 1

 and the text filters.
 and the text filters.

-.IP I
+.It I

 Indent.  The number of characters to indent the output by (in ascii).
 Indent.  The number of characters to indent the output by (in ascii).

-.IP U
+.It U

 Unlink.  Name of file to remove upon completion of printing.
 Unlink.  Name of file to remove upon completion of printing.

-.IP N
+.It N

 File name.  The name of the file which is being printed, or a blank
 for the standard input (when 
 File name.  The name of the file which is being printed, or a blank
 for the standard input (when 

-.I lpr
+.Xr lpr

 is invoked in a pipeline).
 is invoked in a pipeline).

-.in -5
-.PP
+.El
+.Pp

 If a file can not be opened, a message will be logged via
 If a file can not be opened, a message will be logged via

-.IR syslog (3)
+.Xr syslog 3

 using the
 using the

-.I LOG_LPR
+.Em LOG_LPR

 facility.
 facility.

-.I Lpd
+.Nm Lpd

 will try up to 20 times
 to reopen a file it expects to be there, after which it will
 skip the file to be printed.
 will try up to 20 times
 to reopen a file it expects to be there, after which it will
 skip the file to be printed.

-.PP
-.I Lpd
+.Pp
+.Nm Lpd

 uses
 uses

-.IR flock (2)
+.Xr flock 2

 to provide exclusive access to the lock file and to prevent multiple
 deamons from becoming active simultaneously.  If the daemon should be killed
 or die unexpectedly, the lock file need not be removed.
 to provide exclusive access to the lock file and to prevent multiple
 deamons from becoming active simultaneously.  If the daemon should be killed
 or die unexpectedly, the lock file need not be removed.

-The lock file is kept in a readable ASCII form
+The lock file is kept in a readable
+.Tn ASCII
+form

 and contains two lines.
 The first is the process id of the daemon and the second is the control
 file name of the current job being printed.  The second line is updated to
 reflect the current status of
 and contains two lines.
 The first is the process id of the daemon and the second is the control
 file name of the current job being printed.  The second line is updated to
 reflect the current status of

-.I lpd
+.Nm lpd

 for the programs
 for the programs

-.IR lpq (1)
+.Xr lpq 1

 and
 and

-.IR lprm (1).
-.SH FILES
-.nf
-.ta \w'/etc/printcap           'u
-/etc/printcap  printer description file
-/var/spool/*   spool directories
-/var/spool/*/minfree   minimum free space to leave
-/dev/lp*       line printer devices
-/dev/printer   socket for local requests
-/etc/hosts.equiv       lists machine names allowed printer access
-/etc/hosts.lpd lists machine names allowed printer access,
-               but not under same administrative control.
-.fi
-.SH "SEE ALSO"
-lpc(8),
-pac(1),
-lpr(1),
-lpq(1),
-lprm(1),
-syslog(3),
-printcap(5)
-.br
-.ul
-4.2BSD Line Printer Spooler Manual
+.Xr lprm 1 .
+.Sh FILES
+.Bl -tag -width "/var/spool/*/minfree" -compact
+.It Pa /etc/printcap
+printer description file
+.It Pa /var/spool/*
+spool directories
+.It Pa /var/spool/*/minfree
+minimum free space to leave
+.It Pa /dev/lp*
+line printer devices
+.It Pa /dev/printer
+socket for local requests
+.It Pa /etc/hosts.equiv
+lists machine names allowed printer access
+.It Pa /etc/hosts.lpd
+lists machine names allowed printer access,
+but not under same administrative control.
+.El
+.Sh SEE ALSO
+.Xr lpc 8 ,
+.Xr pac 1 ,
+.Xr lpr 1 ,
+.Xr lpq 1 ,
+.Xr lprm 1 ,
+.Xr syslog 3 ,
+.Xr printcap 5
+.Rs
+.%T "4.2 BSD Line Printer Spooler Manual"
+.Re
+.Sh HISTORY
+An
+.Nm
+daemon appeared in Version 6 AT&T UNIX.