1.\" Copyright (c) 1983, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)lpc.8 8.5 (Berkeley) 4/28/95 33.\" $FreeBSD$ 34.\" 35.Dd July 16, 2002 36.Dt LPC 8 37.Os 38.Sh NAME 39.Nm lpc 40.Nd line printer control program 41.Sh SYNOPSIS 42.Nm 43.Op Ar command Op Ar argument ... 44.Sh DESCRIPTION 45The 46.Nm 47utility is used by the system administrator to control the 48operation of the line printer system. 49For each line printer configured in 50.Pa /etc/printcap , 51.Nm 52may be used to: 53.Bl -bullet -offset indent 54.It 55disable or enable a printer, 56.It 57disable or enable a printer's spooling queue, 58.It 59rearrange the order of jobs in a spooling queue, 60.It 61find the status of printers, and their associated 62spooling queues and printer daemons, 63.It 64change the status message for printer queues (the status message 65may be seen by users as part of the output of the 66.Xr lpq 1 utility). 67.El 68.Pp 69Without any arguments, 70.Nm 71will prompt for commands from the standard input. 72If arguments are supplied, 73.Nm 74interprets the first argument as a command and the remaining 75arguments as parameters to the command. 76The standard input 77may be redirected causing 78.Nm 79to read commands from file. 80Commands may be abbreviated; 81the following is the list of recognized commands. 82.Pp 83.Bl -tag -width indent -compact 84.It Ic \&? Op Ar command ... 85.It Ic help Op Ar command ... 86Print a short description of each command specified in the argument list, 87or, if no argument is given, a list of the recognized commands. 88.Pp 89.It Ic abort Brq Cm all | Ar printer 90Terminate an active spooling daemon on the local host immediately and 91then disable printing (preventing new daemons from being started by 92.Xr lpr 1 ) 93for the specified printers. 94.Pp 95.It Ic bottomq Ar printer Xo 96.Op Ar jobspec ... 97.Xc 98Take the specified jobs in the order specified and move them to the 99bottom of the printer queue. 100Each 101.Ar jobspec 102can match multiple print jobs. 103The full description of a 104.Ar jobspec 105is given below. 106.Pp 107.It Ic clean Brq Cm all | Ar printer 108Remove any temporary files, data files, and control files that cannot 109be printed (i.e., do not form a complete printer job) 110from the specified printer queue(s) on the local machine. 111This command will also look for 112.Pa core 113files in spool directory 114for each printer queue, and list any that are found. 115It will not remove any 116.Pa core 117files. 118See also the 119.Ic tclean 120command. 121.Pp 122.It Ic disable Brq Cm all | Ar printer 123Turn the specified printer queues off. 124This prevents new 125printer jobs from being entered into the queue by 126.Xr lpr 1 . 127.Pp 128.It Ic down Bro Cm all | Ar printer ... Brc Cm -msg Ar message ... 129.It Ic down Bro Cm all | Ar printer Brc Ar message ... 130Turn the specified printer queue off, disable printing and put 131.Ar message 132in the printer status file. 133When specifying more than one printer queue, the 134.Ic -msg 135argument is required to separate the list of printers from the text 136that will be the new status message. 137The message doesn't need to be quoted, the 138remaining arguments are treated like 139.Xr echo 1 . 140This is normally used to take a printer down, and let other users 141find out why it is down (the 142.Xr lpq 1 143utility will indicate that the printer is down and will print the 144status message). 145.Pp 146.It Ic enable Brq Cm all | Ar printer 147Enable spooling on the local queue for the listed printers. 148This will allow 149.Xr lpr 1 150to put new jobs in the spool queue. 151.Pp 152.It Ic exit 153.It Ic quit 154Exit from 155.Nm . 156.Pp 157.It Ic restart Brq Cm all | Ar printer 158Attempt to start a new printer daemon. 159This is useful when some abnormal condition causes the daemon to 160die unexpectedly, leaving jobs in the queue. 161.Xr lpq 1 162will report that there is no daemon present when this condition occurs. 163If the user is the super-user, 164try to abort the current daemon first (i.e., kill and restart a stuck daemon). 165.Pp 166.It Ic setstatus Bro Cm all | Ar printer Brc Cm -msg Ar message ... 167Set the status message for the specified printers. 168The 169.Ic -msg 170argument is required to separate the list of printers from the text 171that will be the new status message. 172This is normally used to change the status message when the printer 173queue is no longer active after printing has been disabled, and you 174want to change what users will see in the output of the 175.Xr lpq 1 utility. 176.Pp 177.It Ic start Brq Cm all | Ar printer 178Enable printing and start a spooling daemon for the listed printers. 179.Pp 180.It Ic status Brq Cm all | Ar printer 181Display the status of daemons and queues on the local machine. 182.Pp 183.It Ic stop Brq Cm all | Ar printer 184Stop a spooling daemon after the current job completes and disable 185printing. 186.Pp 187.It Ic tclean Brq Cm all | Ar printer 188This will do a test-run of the 189.Ic clean 190command. 191All the same checking is done, but the command will only print out 192messages saying what a similar 193.Ic clean 194command would do if the user typed it in. 195It will not remove any files. 196Note that the 197.Ic clean 198command is a privileged command, while the 199.Ic tclean 200command is not restricted. 201.Pp 202.It Ic topq Ar printer Xo 203.Op Ar jobspec ... 204.Xc 205Take the specified jobs in the order specified and move them to the 206top of the printer queue. 207Each 208.Ar jobspec 209can match multiple print jobs. 210The full description of a 211.Ar jobspec 212is given below. 213.Pp 214.It Ic up Brq Cm all | Ar printer 215Enable everything and start a new printer daemon. 216Undoes the effects of 217.Ic down . 218.El 219.Pp 220Commands such as 221.Ic topq 222and 223.Ic bottomq 224can take one or more 225.Ar jobspec 226to specify which jobs the command should operate on. 227A 228.Ar jobspec 229can be: 230.Bl -bullet 231.It 232a single job number, which will match all jobs in the printer's queue 233which have the same job number. Eg: 234.Ar 17 , 235.It 236a range of job numbers, which will match all jobs with a number between 237the starting and ending job numbers, inclusive. Eg: 238.Ar 21-32 , 239.It 240a specific userid, which will match all jobs which were sent by that 241user. Eg: 242.Ar jones , 243.It 244a host name, when prefixed by an `@', which will match all jobs in 245the queue which were sent from the given host. Eg: 246.Ar @freebsd.org , 247.It 248a job range and a userid, separated by a `:', which will match all jobs 249which both match the job range and were sent by the specified user. Eg: 250.Ar jones:17 251or 252.Ar 21-32:jones , 253.It 254a job range and/or a userid, followed by a host name, which will match 255all jobs which match all the specified criteria. Eg: 256.Ar jones@freebsd.org 257or 258.Ar 21-32@freebsd.org 259or 260.Ar jones:17@freebsd.org . 261.El 262.Pp 263The values for userid and host name can also include pattern-matching 264characters, similar to the pattern matching done for filenames in 265most command shells. 266Note that if you enter a 267.Ic topq 268or 269.Ic bottomq 270command as parameters on the initial 271.Nm 272command, then the shell will expand any pattern-matching characters 273that it can (based on what files in finds in the current directory) 274before 275.Nm 276processes the command. 277In that case, any parameters which include pattern-matching characters 278should be enclosed in quotes, so that the shell will not try to 279expand them. 280.Sh FILES 281.Bl -tag -width /var/spool/*/lockx -compact 282.It Pa /etc/printcap 283printer description file 284.It Pa /var/spool/* 285spool directories 286.It Pa /var/spool/*/lock 287lock file for queue control 288.El 289.Sh SEE ALSO 290.Xr lpq 1 , 291.Xr lpr 1 , 292.Xr lprm 1 , 293.Xr printcap 5 , 294.Xr chkprintcap 8 , 295.Xr lpd 8 296.Sh DIAGNOSTICS 297.Bl -diag 298.It "?Ambiguous command" 299abbreviation matches more than one command 300.It "?Invalid command" 301no match was found 302.It "?Privileged command" 303you must be a member of group "operator" or root to execute this command 304.El 305.Sh HISTORY 306The 307.Nm 308utility appeared in 309.Bx 4.2 . 310