xref: /dragonfly/usr.sbin/lpr/lprm/lprm.1 (revision a563ca70)
1.\" Copyright (c) 1983, 1990, 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.\"     @(#)lprm.1	8.1 (Berkeley) 6/6/93
33.\" $FreeBSD: src/usr.sbin/lpr/lprm/lprm.1,v 1.5.2.5 2002/06/21 16:40:54 charnier Exp $
34.\" $DragonFly: src/usr.sbin/lpr/lprm/lprm.1,v 1.4 2008/05/02 02:05:08 swildner Exp $
35.\"
36.Dd June 6, 1993
37.Dt LPRM 1
38.Os
39.Sh NAME
40.Nm lprm
41.Nd remove jobs from the line printer spooling queue
42.Sh SYNOPSIS
43.Nm
44.Op Fl P Ns Ar printer
45.Op Fl
46.Op job # ...\&
47.Op Ar user ...\&
48.Sh DESCRIPTION
49The
50.Nm
51utility will remove a job, or jobs, from a printer's spool queue.
52Since the spooling directory is protected from users, using
53.Nm
54is normally the only method by which a user may remove a job.
55The owner of a job is determined by the user's login name
56and host name on the machine where the
57.Xr lpr 1
58command was invoked.
59.Pp
60Options and arguments:
61.Bl -tag -width indent
62.It Fl P Ns Ar printer
63Specify the queue associated with a specific
64.Ar printer
65(otherwise the default printer is used).
66.It Fl
67If a single
68.Sq Fl
69is given,
70.Nm
71will remove all jobs which a user
72owns.  If the super-user employs this flag, the spool queue will
73be emptied entirely.
74.It Ar user
75Cause
76.Nm
77to attempt to remove any jobs queued belonging to that user
78(or users).  This form of invoking
79.Nm
80is useful only to the super-user.
81.It Ar job\ \&#
82A user may dequeue an individual job by specifying its job number.
83This number may be obtained from the
84.Xr lpq  1
85program, e.g.\&
86.Bd -literal -offset indent
87\&% lpq \-l
88
891st:ken				[job #013ucbarpa]
90	(standard input)	100 bytes
91% lprm 13
92.Ed
93.El
94.Pp
95If neither arguments or options are given,
96.Nm
97will delete the currently active job if it is
98owned by the user who invoked
99.Nm .
100.Pp
101The
102.Nm
103utility announces the names of any files it removes and is silent if
104there are no jobs in the queue which match the request list.
105.Pp
106The
107.Nm
108utility will kill off an active daemon, if necessary, before removing
109any spooling files.  If a daemon is killed, a new one is
110automatically restarted upon completion of file removals.
111.Sh ENVIRONMENT
112If the following environment variable exists, it is utilized by
113.Nm .
114.Bl -tag -width PRINTER
115.It Ev PRINTER
116If the environment variable
117.Ev PRINTER
118exists,
119and a printer has not been specified with the
120.Fl P
121option,
122the default printer is assumed from
123.Ev PRINTER .
124.El
125.Sh FILES
126.Bl -tag -width /var/spool/*/lock/ -compact
127.It Pa /etc/printcap
128Printer characteristics file.
129.It Pa /var/spool/*
130Spooling directories.
131.It Pa /var/spool/*/lock
132Lock file used to obtain the pid of the current
133daemon and the job number of the currently active job.
134.El
135.Sh DIAGNOSTICS
136``Permission denied" if the user tries to remove files other than his
137own.
138.Sh SEE ALSO
139.Xr lpq 1 ,
140.Xr lpr 1 ,
141.Xr lpd 8
142.Sh HISTORY
143The
144.Nm
145command appeared in
146.Bx 3.0 .
147.Sh BUGS
148Since there are race conditions possible in the update of the lock file,
149the currently active job may be incorrectly identified.
150