freebsd-skq/usr.sbin/lpr/lprm/lprm.1

.\" Copyright (c) 1983, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)lprm.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd June 6, 1993
.Dt LPRM 1
.Os
.Sh NAME
.Nm lprm
.Nd remove jobs from the line printer spooling queue
.Sh SYNOPSIS
.Nm
.Op Fl P Ns Ar printer
.Op Fl
.Op job # ...\&
.Op Ar user ...\&
.Sh DESCRIPTION
The
.Nm
utility will remove a job, or jobs, from a printer's spool queue.
Since the spooling directory is protected from users, using
.Nm
is normally the only method by which a user may remove a job.
The owner of a job is determined by the user's login name
and host name on the machine where the
.Xr lpr 1
command was invoked.
.Pp
Options and arguments:
.Bl -tag -width indent
.It Fl P Ns Ar printer
Specify the queue associated with a specific
.Ar printer
(otherwise the default printer is used).
.It Fl
If a single
.Sq Fl
is given,
.Nm
will remove all jobs which a user
owns.  If the super-user employs this flag, the spool queue will
be emptied entirely.
.It Ar user
Cause
.Nm
to attempt to remove any jobs queued belonging to that user
(or users).  This form of invoking
.Nm
is useful only to the super-user.
.It Ar job\ \&#
A user may dequeue an individual job by specifying its job number.
This number may be obtained from the
.Xr lpq  1
program, e.g.\&
.Pp
.Bd -literal -offset indent
\&% lpq \-l

1st:ken				[job #013ucbarpa]
	(standard input)	100 bytes
% lprm 13
.Ed
.El
.Pp
If neither arguments or options are given,
.Nm
will delete the currently active job if it is
owned by the user who invoked
.Nm .
.Pp
The
.Nm
utility announces the names of any files it removes and is silent if
there are no jobs in the queue which match the request list.
.Pp
The
.Nm
utility will kill off an active daemon, if necessary, before removing
any spooling files.  If a daemon is killed, a new one is
automatically restarted upon completion of file removals.
.Sh ENVIRONMENT
If the following environment variable exists, it is utilized by
.Nm .
.Bl -tag -width PRINTER
.It Ev PRINTER
If the environment variable
.Ev PRINTER
exists,
and a printer has not been specified with the
.Fl P
option,
the default printer is assumed from
.Ev PRINTER .
.El
.Sh FILES
.Bl -tag -width /var/spool/*/lock/ -compact
.It Pa /etc/printcap
Printer characteristics file.
.It Pa /var/spool/*
Spooling directories.
.It Pa /var/spool/*/lock
Lock file used to obtain the pid of the current
daemon and the job number of the currently active job.
.El
.Sh SEE ALSO
.Xr lpq 1 ,
.Xr lpr 1 ,
.Xr lpd 8
.Sh DIAGNOSTICS
``Permission denied" if the user tries to remove files other than his
own.
.Sh BUGS
Since there are race conditions possible in the update of the lock file,
the currently active job may be incorrectly identified.
.Sh HISTORY
The
.Nm
command appeared in
.Bx 3.0 .
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" Copyright (c) 1983, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)lprm.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\"`
			`.Dd June 6, 1993`
			`.Dt LPRM 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:12:08 +00:00			`.Os`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh NAME`
			`.Nm lprm`
			`.Nd remove jobs from the line printer spooling queue`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Op Fl P Ns Ar printer`
			`.Op Fl`
Prepare for mdoc(7)NG. 2000-12-27 15:30:30 +00:00			`.Op job # ...\&`
			`.Op Ar user ...\&`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:27:18 +00:00			`The`
			`.Nm`
			`utility will remove a job, or jobs, from a printer's spool queue.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`Since the spooling directory is protected from users, using`
Use err(3). Add usage(). Various fixes in man pages. 1997-09-24 06:48:24 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`is normally the only method by which a user may remove a job.`
			`The owner of a job is determined by the user's login name`
			`and host name on the machine where the`
			`.Xr lpr 1`
			`command was invoked.`
			`.Pp`
			`Options and arguments:`
			`.Bl -tag -width indent`
			`.It Fl P Ns Ar printer`
			`Specify the queue associated with a specific`
			`.Ar printer`
			`(otherwise the default printer is used).`
			`.It Fl`
			`If a single`
			`.Sq Fl`
			`is given,`
Use err(3). Add usage(). Various fixes in man pages. 1997-09-24 06:48:24 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`will remove all jobs which a user`
			`owns. If the super-user employs this flag, the spool queue will`
			`be emptied entirely.`
			`.It Ar user`
Use err(3). Add usage(). Various fixes in man pages. 1997-09-24 06:48:24 +00:00			`Cause`
			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`to attempt to remove any jobs queued belonging to that user`
			`(or users). This form of invoking`
Use err(3). Add usage(). Various fixes in man pages. 1997-09-24 06:48:24 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`is useful only to the super-user.`
			`.It Ar job\ \&#`
			`A user may dequeue an individual job by specifying its job number.`
			`This number may be obtained from the`
			`.Xr lpq 1`
mdoc(7) police: protect trailing full stops of abbreviations with a trailing zero-width space: `e.g.\&'. 2001-08-10 13:45:36 +00:00			`program, e.g.\&`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Pp`
			`.Bd -literal -offset indent`
			`\&% lpq \-l`

			`1st:ken [job #013ucbarpa]`
			`(standard input) 100 bytes`
			`% lprm 13`
			`.Ed`
			`.El`
			`.Pp`
			`If neither arguments or options are given,`
Use err(3). Add usage(). Various fixes in man pages. 1997-09-24 06:48:24 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`will delete the currently active job if it is`
			`owned by the user who invoked`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm .`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Pp`
Use `The .Nm utility' 2002-04-20 12:27:18 +00:00			`The`
			`.Nm`
			`utility announces the names of any files it removes and is silent if`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`there are no jobs in the queue which match the request list.`
			`.Pp`
Use `The .Nm utility' 2002-04-20 12:27:18 +00:00			`The`
			`.Nm`
			`utility will kill off an active daemon, if necessary, before removing`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`any spooling files. If a daemon is killed, a new one is`
			`automatically restarted upon completion of file removals.`
			`.Sh ENVIRONMENT`
			`If the following environment variable exists, it is utilized by`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm .`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Bl -tag -width PRINTER`
			`.It Ev PRINTER`
			`If the environment variable`
			`.Ev PRINTER`
			`exists,`
			`and a printer has not been specified with the`
			`.Fl P`
			`option,`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`the default printer is assumed from`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ev PRINTER .`
			`.El`
			`.Sh FILES`
			`.Bl -tag -width /var/spool/*/lock/ -compact`
			`.It Pa /etc/printcap`
			`Printer characteristics file.`
			`.It Pa /var/spool/*`
			`Spooling directories.`
			`.It Pa /var/spool/*/lock`
			`Lock file used to obtain the pid of the current`
			`daemon and the job number of the currently active job.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr lpq 1 ,`
Sort cross references. 1997-01-20 00:03:00 +00:00			`.Xr lpr 1 ,`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Xr lpd 8`
			`.Sh DIAGNOSTICS`
			``Permission denied" if the user tries to remove files other than his
			`own.`
			`.Sh BUGS`
			`Since there are race conditions possible in the update of the lock file,`
			`the currently active job may be incorrectly identified.`
			`.Sh HISTORY`
			`The`
Use err(3). Add usage(). Various fixes in man pages. 1997-09-24 06:48:24 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`command appeared in`
			`.Bx 3.0 .`