1502 Remove conversion cruft from manpages
[unleashed.git] / usr / src / man / man1b / lpc.1b
blob6575ed13d98683e629649350aab20a0b8d59effd
1 '\" te
2 .\" Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution.
3 .\" Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
4 .TH LPC 1B "Jun 2, 2006"
5 .SH NAME
6 lpc \- line printer control program
7 .SH SYNOPSIS
8 .LP
9 .nf
10 \fB/usr/ucb/lpc\fR [\fIcommand\fR [\fIparameter\fR...]]
11 .fi
13 .SH DESCRIPTION
14 .sp
15 .LP
16 The \fBlpc\fR utility controls the operation of local printers.
17 .sp
18 .LP
19 Use \fBlpc\fR to perform the following functions:
20 .RS +4
21 .TP
22 .ie t \(bu
23 .el o
24 start or stop a printer,
25 .RE
26 .RS +4
27 .TP
28 .ie t \(bu
29 .el o
30 disable or enable a printer's spooling queue,
31 .RE
32 .RS +4
33 .TP
34 .ie t \(bu
35 .el o
36 rearrange the order of jobs in a print queue, or
37 .RE
38 .RS +4
39 .TP
40 .ie t \(bu
41 .el o
42 display the status of a printer print queue and printer daemon.
43 .RE
44 .sp
45 .LP
46 \fBlpc\fR can be run from the command line or interactively. Specifying
47 \fBlpc\fR with the optional \fIcommand\fR and\fIparameter\fR arguments causes
48 \fBlpc\fR to interpret the first argument as an \fBlpc\fR command, and all
49 other arguments as parameters to that command. Specifying \fBlpc\fR without
50 arguments causes it to run interactively, prompting the user for \fBlpc\fR
51 commands with \fBlpc>\fR. By redirecting the standard input, \fBlpc\fR can read
52 commands from a file.
53 .SH USAGE
54 .sp
55 .LP
56 \fBlpc\fR commands can be typed in their entirety or abbreviated to an
57 unambiguous substring. Some \fBlpc\fR commands are available to all users;
58 others are available only to super-users.
59 .sp
60 .LP
61 All users can execute the following \fBlpc\fR commands:
62 .sp
63 .ne 2
64 .na
65 \fB\fB?\fR [\fIcommand\fR \|.\|.\|.] | \fBhelp\fR [\fIcommand\fR \|.\|.\|.]\fR
66 .ad
67 .sp .6
68 .RS 4n
69 Displays a short description of \fIcommand\fR. \fIcommand\fR is an \fBlpc\fR
70 command. If \fIcommand\fR is not specified, displays a list of \fBlpc\fR
71 commands.
72 .RE
74 .sp
75 .ne 2
76 .na
77 \fB\fBexit\fR | \fBquit\fR\fR
78 .ad
79 .sp .6
80 .RS 4n
81 Exits from \fBlpc\fR.
82 .RE
84 .sp
85 .ne 2
86 .na
87 \fB\fBstatus\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
88 .ad
89 .sp .6
90 .RS 4n
91 Displays the status of print daemons and print queues. \fBall\fR specifies that
92 this command is performed on all locally attached printers. \fIprinter\fR
93 indicates this command is performed on specific printers. Specify \fIprinter\fR
94 as an atomic name. See \fBprinters.conf\fR(4) for information regarding naming
95 conventions for atomic names.
96 .RE
98 .sp
99 .LP
100 Only a super-user can execute the following \fBlpc\fR commands:
102 .ne 2
104 \fB\fBabort\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
106 .sp .6
107 .RS 4n
108 Terminates an active spooling daemon. Disables printing (by preventing new
109 daemons from being started by \fBlpr\fR(1B)) for \fIprinter\fR. \fBall\fR
110 specifies this command is performed on all locally attached printers.
111 \fIprinter\fR indicates this command is performed on specific printers. Specify
112 \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for information
113 regarding naming conventions for atomic names.
117 .ne 2
119 \fB\fBclean\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.\|]\fR
121 .sp .6
122 .RS 4n
123 Removes files created in the print spool directory by the print daemon from
124 \fIprinter\fR \fI\&'s\fR print queue. \fBall\fR specifies that this command is
125 performed on all locally attached printers.\fIprinter\fR indicates this command
126 is performed on specific printers. Specify \fIprinter\fR as an atomic name. See
127 \fBprinters.conf\fR(4) for information regarding naming conventions for atomic
128 names.
132 .ne 2
134 \fB\fBdisable\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.]\fR
136 .sp .6
137 .RS 4n
138 Turns off the print queue for \fIprinter\fR. Prevents new printer jobs from
139 being entered into the print queue for \fIprinter\fRby \fBlpr\fR(1B). \fBall\fR
140 specifies that this command is performed on all locally attached printers.
141 \fIprinter\fR indicates this command is performed on specific printers. Specify
142 \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for information
143 regarding naming conventions for atomic names.
147 .ne 2
149 \fB\fBdown\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.\|] [\fImessage\fR]\fR
151 .sp .6
152 .RS 4n
153 Turns the queue for \fIprinter\fR off and disables printing on \fIprinter\fR.
154 Inserts \fImessage\fR in the printer status file. \fImessage\fR does not need
155 to be quoted; multiple arguments to \fImessage\fR are treated as arguments are
156 to \fBecho\fR(1). Use \fBdown\fR to take a printer down and inform users.
157 \fBall\fR specifies that this command is performed on all locally attached
158 printers. \fIprinter\fR indicates this command is performed on specific
159 printers. Specify \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4)
160 for information regarding naming conventions for atomic names.
164 .ne 2
166 \fB\fBenable\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.]\fR
168 .sp .6
169 .RS 4n
170 Enables \fBlpr\fR(1B) to add new jobs in the spool queue. \fBall\fR specifies
171 that this command is performed on all locally attached printers. \fIprinter\fR
172 indicates this command is performed on specific printers. Specify \fIprinter\fR
173 as an atomic name. See \fBprinters.conf\fR(4) for information regarding naming
174 conventions for atomic names.
178 .ne 2
180 \fB\fBrestart\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
182 .sp .6
183 .RS 4n
184 Attempts to start a new printer daemon. \fBrestart\fR is useful when a print
185 daemon dies unexpectedly and leaves jobs in the print queue. \fBall\fR
186 specifies that this command is performed on all locally attached printers.
187 \fIprinter\fR indicates that this command is performed on specific printers.
188 Specify \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for
189 information regarding naming conventions for atomic names.
193 .ne 2
195 \fB\fBstart\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
197 .sp .6
198 .RS 4n
199 Enables printing. Starts a spooling daemon for the \fIprinter\fR. \fBall\fR
200 specifies that this command is performed on all locally attached printers.
201 \fIprinter\fR indicates the command is performed on specific printers. Specify
202 \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for information
203 regarding naming conventions for atomic names.
207 .ne 2
209 \fB\fBstop\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.\|]\fR
211 .sp .6
212 .RS 4n
213 Stops a spooling daemon after the current job is complete. Disables printing at
214 that time. \fBall\fR specifies that this command is performed on all locally
215 attached printers. \fIprinter\fR indicates this command is performed on
216 specific printers. Specify \fIprinter\fR as an atomic name. See
217 \fBprinters.conf\fR(4) for information regarding naming conventions for atomic
218 names.
222 .ne 2
224 \fB\fBtopq\fR \fIprinter\fR[\fIrequest-ID\fR\|.\|.\|.] [\fIuser\fR
225 \|.\|.\|.]\fR
227 .sp .6
228 .RS 4n
229 Moves \fIrequest-ID\fR or print jobs belonging to \fIuser\fR on \fIprinter\fR
230 to the beginning of the print queue. Specify \fIuser\fR as a user's login name.
231 Specify \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for
232 information regarding naming conventions for atomic names.
236 .ne 2
238 \fB\fBup\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.]\fR
240 .sp .6
241 .RS 4n
242 Turns the queue for \fIprinter\fR on and enables printing on \fIprinter\fR.
243 Deletes the message in the printer status file (inserted by \fBdown\fR). Use
244 \fBup\fR to undo the effects of \fBdown\fR. \fBall\fR specifies that this
245 command is performed on all locally attached printers. \fIprinter\fR indicates
246 this command is performed on specific printers. Specify \fIprinter\fR as an
247 atomic name. See \fBprinters.conf\fR(4) for information regarding naming
248 conventions for atomic names.
251 .SH EXIT STATUS
254 The following exit values are returned:
256 .ne 2
258 \fB\fB0\fR\fR
260 .RS 12n
261 Successful completion.
265 .ne 2
267 \fBnon-zero\fR
269 .RS 12n
270 An error occurred.
273 .SH FILES
275 .ne 2
277 \fB\fB/etc/printers.conf\fR\fR
279 .RS 24n
280  System printer configuration database
284 .ne 2
286 \fB\fB$HOME/.printers\fR\fR
288 .RS 24n
289 User-configurable printer database
293 .ne 2
295 \fB\fBprinters.conf.byname\fR\fR
297 .RS 24n
298 NIS version of \fB/etc/printers.conf\fR
302 .ne 2
304 \fB\fBprinters.org_dir\fR\fR
306 .RS 24n
307  NIS+ version of \fB/etc/printers.conf\fR
311 .ne 2
313 \fB\fBou=printers\fR\fR
315 .RS 24n
316 LDAP version of \fB/etc/printers.conf\fR
319 .SH ATTRIBUTES
322 See \fBattributes\fR(5) for descriptions of the following attributes:
327 box;
328 c | c
329 l | l .
330 ATTRIBUTE TYPE  ATTRIBUTE VALUE
332 Interface Stability     Standard
335 .SH SEE ALSO
338 \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B), \fBlpstat\fR(1),
339 \fBlpsched\fR(1M), \fBlpshut\fR(1M), \fBsvcadm\fR(1M), \fBprinters.conf\fR(4),
340 \fBattributes\fR(5)
341 .SH DIAGNOSTICS
344 Use the \fBsvcs\fR(1) utility to check if \fBsvc:/application/print/server\fR
345 is running. If it is not running, use \fBsvcadm enable
346 svc:/application/print/server\fR to start \fBlpsched\fR. See \fBsvcadm\fR(1M).
347 .SH NOTES
350 When IPP is in use, the user is prompted for a passphrase if the remote print
351 service is configured to require authentication.