Remove advertising header from man pages.
[dragonfly.git] / usr.sbin / lpr / lpr / lpr.1
1 .\" Copyright (c) 1980, 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 .\" 4. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     From @(#)lpr.1  8.1 (Berkeley) 6/6/93
29 .\" $FreeBSD: src/usr.sbin/lpr/lpr/lpr.1,v 1.11.2.6 2002/06/21 16:40:52 charnier Exp $
30 .\" $DragonFly: src/usr.sbin/lpr/lpr/lpr.1,v 1.4 2006/02/17 19:40:17 swildner Exp $
31 .\" "
32 .Dd June 6, 1993
33 .Dt LPR 1
34 .Os
35 .Sh NAME
36 .Nm lpr
37 .Nd off line print
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl P Ns Ar printer
41 .Op Fl \&# Ns Ar num
42 .Op Fl C Ar class
43 .Op Fl J Ar job
44 .Op Fl L Ar locale
45 .Op Fl T Ar title
46 .Op Fl U Ar user
47 .Op Fl Z Ar daemon-options
48 .Op Fl i Ar numcols
49 .Op Fl 1234 Ar font
50 .Op Fl w Ar num
51 .Op Fl cdfghlnmprstv
52 .Op Ar name ...
53 .Sh DESCRIPTION
54 The
55 .Nm
56 utility uses a spooling daemon to print the named files when facilities
57 become available.  If no names appear, the standard input is assumed.
58 .Pp
59 The following single letter options are used to notify the line printer
60 spooler that the files are not standard text files.
61 The spooling daemon will
62 use the appropriate filters to print the data accordingly.
63 Note that not all spoolers implement filters for all data types,
64 and some sites may use these types for other purposes than the ones
65 described here.
66 .Bl -tag -width indent
67 .It Fl d
68 The files are assumed to contain data in
69 .Tn DVI
70 format from the
71 .Tn TeX
72 typesetting system.
73 .It Fl f
74 Use a filter which interprets the first character of each line as a
75 standard
76 .Tn FORTRAN
77 carriage control character.
78 .It Fl l
79 Use a filter which allows control characters to be printed and suppresses
80 page breaks.
81 .It Fl p
82 Use
83 .Xr pr 1
84 to format the files.
85 .El
86 .Pp
87 The following options are historical and not directly supported by any
88 software included in
89 .Dx .
90 .Bl -tag -width indent
91 .It Fl c
92 The files are assumed to contain data produced by
93 .Xr cifplot 1 .
94 .It Fl g
95 The files are assumed to contain standard plot data as produced by the
96 .Ux
97 .Xr plot 3
98 routines.
99 .It Fl n
100 The files are assumed to contain data from
101 .Em ditroff
102 (device independent troff).
103 .It Fl t
104 The files are assumed to contain
105 .Tn C/A/T
106 phototypesetter commands from ancient versions of
107 .Ux
108 .Xr troff 1 .
109 .It Fl v
110 The files are assumed to contain a raster image for devices like the
111 Benson Varian.
112 .El
113 .Pp
114 These options apply to the handling of
115 the print job:
116 .Bl -tag -width indent
117 .It Fl P
118 Force output to a specific printer.  Normally,
119 the default printer is used (site dependent), or the value of the
120 environment variable
121 .Ev PRINTER
122 is used.
123 .It Fl h
124 Suppress the printing of the burst page.
125 .It Fl m
126 Send mail upon completion.
127 .It Fl r
128 Remove the file upon completion of spooling or upon completion of
129 printing (with the
130 .Fl s
131 option).
132 .It Fl s
133 Use symbolic links.  Usually files are copied to the spool directory.
134 The
135 .Fl s
136 option will use
137 .Xr symlink  2
138 to link data files rather than trying to copy them so large files can be
139 printed.  This means the files should
140 not be modified or removed until they have been printed.
141 .El
142 .Pp
143 The remaining options apply to copies, the page display, and headers:
144 .Bl -tag -width indent
145 .It Fl \&# Ns Ar num
146 The quantity
147 .Ar num
148 is the number of copies desired of each file named.  For example,
149 .Bd -literal -offset indent
150 lpr \-#3 foo.c bar.c more.c
151 .Ed
152 would result in 3 copies of the file foo.c, followed by 3 copies
153 of the file bar.c, etc.  On the other hand,
154 .Bd -literal -offset indent
155 cat foo.c bar.c more.c \&| lpr \-#3
156 .Ed
157 .Pp
158 will give three copies of the concatenation of the files.
159 Often
160 a site will disable this feature to encourage use of a photocopier
161 instead.
162 .It Xo
163 .Fl Ns Op Cm 1234
164 .Ar font
165 .Xc
166 Specifies a
167 .Ar font
168 to be mounted on font position
169 .Ar i  .
170 The daemon
171 will construct a
172 .Li .railmag
173 file referencing
174 the font pathname.
175 .It Fl C Ar class
176 Job classification
177 to use on the burst page.  For example,
178 .Bd -literal -offset indent
179 lpr \-C EECS foo.c
180 .Ed
181 .Pp
182 causes the system name (the name returned by
183 .Xr hostname  1  )
184 to be replaced on the burst page by
185 .Tn EECS ,
186 and the file foo.c to be printed.
187 .It Fl J Ar job
188 Job name to print on the burst page.
189 Normally, the first file's name is used.
190 .It Fl L Ar locale
191 Use
192 .Ar locale
193 specified as argument instead of one found in environment.
194 (Only effective when filtering through
195 .Xr pr 1
196 is requested using the
197 .Fl p
198 option.)
199 .It Fl T Ar title
200 Title name for
201 .Xr pr 1 ,
202 instead of the file name.
203 .It Fl U Ar user
204 User name to print on the burst page,
205 also for accounting purposes.
206 This option is only honored if the real user-id is daemon
207 (or that specified in the printcap file instead of daemon),
208 and is intended for those instances where print filters wish to requeue jobs.
209 .It Fl Z Ar daemon-options
210 Some spoolers, such as
211 .Tn LPRng ,
212 accept additional per-job options using a
213 .Ql Z
214 control line.
215 When
216 .Fl Z
217 is specified, and
218 .Fl p
219 .Pq Xr pr 1
220 is not requested, the specified
221 .Ar daemon-options
222 will be passed to the remote
223 .Tn LPRng
224 spooler.
225 .It Fl i Ar numcols
226 The output is indented by
227 .Pq Ar numcols .
228 .It Fl w Ar num
229 Uses
230 .Ar num
231 as the page width for
232 .Xr pr 1 .
233 .El
234 .Sh ENVIRONMENT
235 If the following environment variable exists, it is used by
236 .Nm :
237 .Bl -tag -width PRINTER
238 .It Ev PRINTER
239 Specifies an alternate default printer.
240 .El
241 .Sh FILES
242 .Bl -tag -width /var/spool/output/*/tf* -compact
243 .It Pa /etc/passwd
244 Personal identification.
245 .It Pa /etc/printcap
246 Printer capabilities data base.
247 .It Pa /usr/sbin/lpd
248 Line printer daemons.
249 .It Pa /var/spool/output/*
250 Directories used for spooling.
251 .It Pa /var/spool/output/*/cf*
252 Daemon control files.
253 .It Pa /var/spool/output/*/df*
254 Data files specified in "cf" files.
255 .It Pa /var/spool/output/*/tf*
256 Temporary copies of "cf" files.
257 .El
258 .Sh DIAGNOSTICS
259 If you try to spool too large a file, it will be truncated.
260 The
261 .Nm
262 utility will object to printing binary files.
263 If a user other than root prints a file and spooling is disabled,
264 .Nm
265 will print a message saying so and will not put jobs in the queue.
266 If a connection to
267 .Xr lpd 8
268 on the local machine cannot be made,
269 .Nm
270 will say that the daemon cannot be started.
271 Diagnostics may be printed in the daemon's log file
272 regarding missing spool files by
273 .Xr lpd 8 .
274 .Sh SEE ALSO
275 .Xr lpq 1 ,
276 .Xr lprm 1 ,
277 .Xr pr 1 ,
278 .Xr symlink 2 ,
279 .Xr printcap 5 ,
280 .Xr lpc 8 ,
281 .Xr lpd 8
282 .Sh HISTORY
283 The
284 .Nm
285 command appeared in
286 .Bx 3 .
287 .Sh BUGS
288 Fonts for
289 .Xr troff 1
290 and
291 .Tn TeX
292 reside on the host with the printer.
293 It is currently not possible to
294 use local font libraries.
295 .Pp
296 The
297 .Ql Z
298 control file line is used for two different purposes; for
299 standard
300 .Dx
301 .Xr lpd 8 ,
302 it specifies a locale to be passed to
303 .Xr pr 1 .
304 For
305 .Tn LPRng
306 .Xr lpd 8 ,
307 it specifies additional options to be interpreted by the spooler's
308 input and output filters.
309 When submitting jobs via
310 .Nm ,
311 .Fl p
312 .Fl L Ar locale
313 is used in the former context, and
314 .Fl Z Ar daemon-options
315 is used in the latter.