8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1b / lpc.1b
blob5f6a5700019a75d2f89e24e320215233b3224c2b
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 "Feb 25, 2017"
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 .LP
15 The \fBlpc\fR utility controls the operation of local printers.
16 .sp
17 .LP
18 Use \fBlpc\fR to perform the following functions:
19 .RS +4
20 .TP
21 .ie t \(bu
22 .el o
23 start or stop a printer,
24 .RE
25 .RS +4
26 .TP
27 .ie t \(bu
28 .el o
29 disable or enable a printer's spooling queue,
30 .RE
31 .RS +4
32 .TP
33 .ie t \(bu
34 .el o
35 rearrange the order of jobs in a print queue, or
36 .RE
37 .RS +4
38 .TP
39 .ie t \(bu
40 .el o
41 display the status of a printer print queue and printer daemon.
42 .RE
43 .sp
44 .LP
45 \fBlpc\fR can be run from the command line or interactively. Specifying
46 \fBlpc\fR with the optional \fIcommand\fR and\fIparameter\fR arguments causes
47 \fBlpc\fR to interpret the first argument as an \fBlpc\fR command, and all
48 other arguments as parameters to that command. Specifying \fBlpc\fR without
49 arguments causes it to run interactively, prompting the user for \fBlpc\fR
50 commands with \fBlpc>\fR. By redirecting the standard input, \fBlpc\fR can read
51 commands from a file.
52 .SH USAGE
53 .LP
54 \fBlpc\fR commands can be typed in their entirety or abbreviated to an
55 unambiguous substring. Some \fBlpc\fR commands are available to all users;
56 others are available only to super-users.
57 .sp
58 .LP
59 All users can execute the following \fBlpc\fR commands:
60 .sp
61 .ne 2
62 .na
63 \fB\fB?\fR [\fIcommand\fR \|.\|.\|.] | \fBhelp\fR [\fIcommand\fR \|.\|.\|.]\fR
64 .ad
65 .sp .6
66 .RS 4n
67 Displays a short description of \fIcommand\fR. \fIcommand\fR is an \fBlpc\fR
68 command. If \fIcommand\fR is not specified, displays a list of \fBlpc\fR
69 commands.
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fBexit\fR | \fBquit\fR\fR
76 .ad
77 .sp .6
78 .RS 4n
79 Exits from \fBlpc\fR.
80 .RE
82 .sp
83 .ne 2
84 .na
85 \fB\fBstatus\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
86 .ad
87 .sp .6
88 .RS 4n
89 Displays the status of print daemons and print queues. \fBall\fR specifies that
90 this command is performed on all locally attached printers. \fIprinter\fR
91 indicates this command is performed on specific printers. Specify \fIprinter\fR
92 as an atomic name. See \fBprinters.conf\fR(4) for information regarding naming
93 conventions for atomic names.
94 .RE
96 .sp
97 .LP
98 Only a super-user can execute the following \fBlpc\fR commands:
99 .sp
100 .ne 2
102 \fB\fBabort\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
104 .sp .6
105 .RS 4n
106 Terminates an active spooling daemon. Disables printing (by preventing new
107 daemons from being started by \fBlpr\fR(1B)) for \fIprinter\fR. \fBall\fR
108 specifies this command is performed on all locally attached printers.
109 \fIprinter\fR indicates this command is performed on specific printers. Specify
110 \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for information
111 regarding naming conventions for atomic names.
115 .ne 2
117 \fB\fBclean\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.\|]\fR
119 .sp .6
120 .RS 4n
121 Removes files created in the print spool directory by the print daemon from
122 \fIprinter\fR \fI\&'s\fR print queue. \fBall\fR specifies that this command is
123 performed on all locally attached printers.\fIprinter\fR indicates this command
124 is performed on specific printers. Specify \fIprinter\fR as an atomic name. See
125 \fBprinters.conf\fR(4) for information regarding naming conventions for atomic
126 names.
130 .ne 2
132 \fB\fBdisable\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.]\fR
134 .sp .6
135 .RS 4n
136 Turns off the print queue for \fIprinter\fR. Prevents new printer jobs from
137 being entered into the print queue for \fIprinter\fRby \fBlpr\fR(1B). \fBall\fR
138 specifies that this command is performed on all locally attached printers.
139 \fIprinter\fR indicates this command is performed on specific printers. Specify
140 \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for information
141 regarding naming conventions for atomic names.
145 .ne 2
147 \fB\fBdown\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.\|] [\fImessage\fR]\fR
149 .sp .6
150 .RS 4n
151 Turns the queue for \fIprinter\fR off and disables printing on \fIprinter\fR.
152 Inserts \fImessage\fR in the printer status file. \fImessage\fR does not need
153 to be quoted; multiple arguments to \fImessage\fR are treated as arguments are
154 to \fBecho\fR(1). Use \fBdown\fR to take a printer down and inform users.
155 \fBall\fR specifies that this command is performed on all locally attached
156 printers. \fIprinter\fR indicates this command is performed on specific
157 printers. Specify \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4)
158 for information regarding naming conventions for atomic names.
162 .ne 2
164 \fB\fBenable\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.]\fR
166 .sp .6
167 .RS 4n
168 Enables \fBlpr\fR(1B) to add new jobs in the spool queue. \fBall\fR specifies
169 that this command is performed on all locally attached printers. \fIprinter\fR
170 indicates this command is performed on specific printers. Specify \fIprinter\fR
171 as an atomic name. See \fBprinters.conf\fR(4) for information regarding naming
172 conventions for atomic names.
176 .ne 2
178 \fB\fBrestart\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
180 .sp .6
181 .RS 4n
182 Attempts to start a new printer daemon. \fBrestart\fR is useful when a print
183 daemon dies unexpectedly and leaves jobs in the print queue. \fBall\fR
184 specifies that this command is performed on all locally attached printers.
185 \fIprinter\fR indicates that this command is performed on specific printers.
186 Specify \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for
187 information regarding naming conventions for atomic names.
191 .ne 2
193 \fB\fBstart\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.]\fR
195 .sp .6
196 .RS 4n
197 Enables printing. Starts a spooling daemon for the \fIprinter\fR. \fBall\fR
198 specifies that this command is performed on all locally attached printers.
199 \fIprinter\fR indicates the command is performed on specific printers. Specify
200 \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for information
201 regarding naming conventions for atomic names.
205 .ne 2
207 \fB\fBstop\fR [\fBall\fR | \fIprinter\fR\|.\|.\|.\|]\fR
209 .sp .6
210 .RS 4n
211 Stops a spooling daemon after the current job is complete. Disables printing at
212 that time. \fBall\fR specifies that this command is performed on all locally
213 attached printers. \fIprinter\fR indicates this command is performed on
214 specific printers. Specify \fIprinter\fR as an atomic name. See
215 \fBprinters.conf\fR(4) for information regarding naming conventions for atomic
216 names.
220 .ne 2
222 \fB\fBtopq\fR \fIprinter\fR[\fIrequest-ID\fR\|.\|.\|.] [\fIuser\fR
223 \|.\|.\|.]\fR
225 .sp .6
226 .RS 4n
227 Moves \fIrequest-ID\fR or print jobs belonging to \fIuser\fR on \fIprinter\fR
228 to the beginning of the print queue. Specify \fIuser\fR as a user's login name.
229 Specify \fIprinter\fR as an atomic name. See \fBprinters.conf\fR(4) for
230 information regarding naming conventions for atomic names.
234 .ne 2
236 \fB\fBup\fR [\fBall\fR | \fIprinter\fR \|.\|.\|.]\fR
238 .sp .6
239 .RS 4n
240 Turns the queue for \fIprinter\fR on and enables printing on \fIprinter\fR.
241 Deletes the message in the printer status file (inserted by \fBdown\fR). Use
242 \fBup\fR to undo the effects of \fBdown\fR. \fBall\fR specifies that this
243 command is performed on all locally attached printers. \fIprinter\fR indicates
244 this command is performed on specific printers. Specify \fIprinter\fR as an
245 atomic name. See \fBprinters.conf\fR(4) for information regarding naming
246 conventions for atomic names.
249 .SH EXIT STATUS
251 The following exit values are returned:
253 .ne 2
255 \fB\fB0\fR\fR
257 .RS 12n
258 Successful completion.
262 .ne 2
264 \fBnon-zero\fR
266 .RS 12n
267 An error occurred.
270 .SH FILES
271 .ne 2
273 \fB\fB/etc/printers.conf\fR\fR
275 .RS 24n
276  System printer configuration database
280 .ne 2
282 \fB\fB$HOME/.printers\fR\fR
284 .RS 24n
285 User-configurable printer database
289 .ne 2
291 \fB\fBprinters.conf.byname\fR\fR
293 .RS 24n
294 NIS version of \fB/etc/printers.conf\fR
298 .ne 2
300 \fB\fBou=printers\fR\fR
302 .RS 24n
303 LDAP version of \fB/etc/printers.conf\fR
306 .SH ATTRIBUTES
308 See \fBattributes\fR(5) for descriptions of the following attributes:
313 box;
314 c | c
315 l | l .
316 ATTRIBUTE TYPE  ATTRIBUTE VALUE
318 Interface Stability     Standard
321 .SH SEE ALSO
323 \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B), \fBlpstat\fR(1),
324 \fBlpsched\fR(1M), \fBlpshut\fR(1M), \fBsvcadm\fR(1M), \fBprinters.conf\fR(4),
325 \fBattributes\fR(5)
326 .SH DIAGNOSTICS
328 Use the \fBsvcs\fR(1) utility to check if \fBsvc:/application/print/server\fR
329 is running. If it is not running, use \fBsvcadm enable
330 svc:/application/print/server\fR to start \fBlpsched\fR. See \fBsvcadm\fR(1M).
331 .SH NOTES
333 When IPP is in use, the user is prompted for a passphrase if the remote print
334 service is configured to require authentication.