Sync usage with man page.
[netbsd-mini2440.git] / usr.sbin / lpr / SMM.doc / 2.t
blobabdbe7f70434df41ef6e0c70529c93f342e7d4c3
1 .\" $NetBSD: 2.t,v 1.3 1997/07/09 02:34:43 jtc Exp $
2 .\" Copyright (c) 1983, 1993
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of the University nor the names of its contributors
14 .\"    may be used to endorse or promote products derived from this software
15 .\"    without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" SUCH DAMAGE.
28 .\"
29 .\"     @(#)2.t 8.1 (Berkeley) 6/8/93
30 .\"
31 .NH 1
32 Commands
33 .NH 2
34 lpd \- line printer daemon
35 .PP
36 The program
37 .IR lpd (8),
38 usually invoked at boot time from the /etc/rc file, acts as
39 a master server for coordinating and controlling
40 the spooling queues configured in the printcap file.
41 When
42 .I lpd
43 is started it makes a single pass through the
44 .I printcap
45 database restarting any printers that have jobs.
46 In normal operation
47 .I lpd
48 listens for service requests on multiple sockets,
49 one in the UNIX domain (named ``/var/run/printer'') for
50 local requests, and one in the Internet domain
51 (under the ``printer'' service specification)
52 for requests for printer access from off machine;
53 see \fIsocket\fP\|(2) and \fIservices\fP\|(5)
54 for more information on sockets and service
55 specifications, respectively.
56 .I Lpd
57 spawns a copy of itself to process the request; the master daemon
58 continues to listen for new requests.
59 .PP
60 Clients communicate with 
61 .I lpd
62 using a simple transaction oriented protocol.
63 Authentication of remote clients is done based
64 on the ``privilege port'' scheme employed by
65 \fIrshd\fP\|(8C) and \fIrcmd\fP\|(3X).
66 The following table shows the requests 
67 understood by
68 .IR lpd .
69 In each request the first byte indicates the
70 ``meaning'' of the request, followed by the name
71 of the printer to which it should be applied.  Additional
72 qualifiers may follow, depending on the request.
73 .DS
74 .TS
75 l l.
76 Request Interpretation
78 ^Aprinter\en    check the queue for jobs and print any found
79 ^Bprinter\en    receive and queue a job from another machine
80 ^Cprinter [users ...] [jobs ...]\en     return short list of current queue state
81 ^Dprinter [users ...] [jobs ...]\en     return long list of current queue state
82 ^Eprinter person [users ...] [jobs ...]\en      remove jobs from a queue
83 .TE
84 .DE
85 .PP
86 The \fIlpr\fP\|(1) command
87 is used by users to enter a print job in a local queue and to notify
88 the local
89 .I lpd
90 that there are new jobs in the spooling area.
91 .I Lpd
92 either schedules the job to be printed locally, or if
93 printing remotely, attempts to forward
94 the job to the appropriate machine.
95 If the printer cannot be opened or the destination
96 machine is unreachable, the job will remain queued until it is
97 possible to complete the work.
98 .NH 2
99 lpq \- show line printer queue
101 The \fIlpq\fP\|(1)
102 program works recursively backwards displaying the queue of the machine with
103 the printer and then the queue(s) of the machine(s) that lead to it.
104 .I Lpq
105 has two forms of output: in the default, short, format it
106 gives a single line of output per queued job; in the long 
107 format it shows the list of files, and their sizes, that
108 comprise a job.
109 .NH 2
110 lprm \- remove jobs from a queue
112 The \fIlprm\fP\|(1) command deletes jobs from a spooling
113 queue.  If necessary, \fIlprm\fP will first kill off a
114 running daemon that is servicing the queue and restart
115 it after the required files are removed.  When removing
116 jobs destined for a remote printer, \fIlprm\fP acts
117 similarly to \fIlpq\fP except it first checks locally
118 for jobs to remove and then
119 tries to remove files in queues off-machine.
120 .NH 2
121 lpc \- line printer control program
124 .IR lpc (8)
125 program is used by the system administrator to control the
126 operation of the line printer system.  
127 For each line printer configured in /etc/printcap,
128 .I lpc
129 may be used to:
130 .IP \(bu
131 disable or enable a printer,
132 .IP \(bu
133 disable or enable a printer's spooling queue,
134 .IP \(bu
135 rearrange the order of jobs in a spooling queue,
136 .IP \(bu
137 find the status of printers, and their associated
138 spooling queues and printer daemons.