xref: /freebsd/usr.bin/pr/pr.1 (revision e627b39baccd1ec9129690167cf5e6d860509655)
1.\" Copyright (c) 1991 Keith Muller.
2.\" Copyright (c) 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\"
5.\" This code is derived from software contributed to Berkeley by
6.\" Keith Muller of the University of California, San Diego.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)pr.1	8.3 (Berkeley) 4/18/94
37.\"	$Id$
38.\"
39.Dd April 18, 1994
40.Dt PR 1
41.Os BSD 4.4
42.Sh NAME
43.Nm pr
44.Nd print files
45.Sh SYNOPSIS
46.Nm pr
47.Bk -words
48.Op Ar \&+page
49.Ek
50.Bk -words
51.Op Fl Ar column
52.Ek
53.Op Fl adFmrt
54.Bk -words
55.Oo
56.Op Fl e
57.Op Ar char
58.Op Ar gap
59.Oc
60.Ek
61.Bk -words
62.Op Fl h Ar header
63.Ek
64.Bk -words
65.Oo
66.Op Fl i
67.Op Ar char
68.Op Ar gap
69.Oc
70.Ek
71.Bk -words
72.Op Fl l Ar lines
73.Ek
74.Bk -words
75.Op Fl o Ar offset
76.Ek
77.Bk -words
78.Oo
79.Op Fl s
80.Op Ar char
81.Oc
82.Ek
83.Bk -words
84.Oo
85.Op Fl n
86.Op Ar char
87.Op Ar width
88.Oc
89.Ek
90.Bk -words
91.Op Fl w Ar width
92.Ek
93.Op -
94.Op Ar file ...
95.Sh DESCRIPTION
96The
97.Nm pr
98utility is a printing and pagination filter for text files.
99When multiple input files are specified, each is read, formatted,
100and written to standard output.
101By default, the input is separated into 66-line pages, each with
102.sp
103.in +2
104.ti -2
105\(bu A 5-line header with the page number, date, time, and
106the pathname of the file.
107.sp
108.ti -2
109\(bu A 5-line trailer consisting of blank lines.
110.in -2
111.Pp
112If standard output is associated with a terminal,
113diagnostic messages are suppressed until the
114.Nm pr
115utility has completed processing.
116.Pp
117When multiple column output is specified,
118text columns are of equal width.
119By default text columns are separated by at least one
120.Em <blank>.
121Input lines that do not fit into a text column are truncated.
122Lines are not truncated under single column output.
123.Sh OPTIONS
124.Pp
125In the following option descriptions, column, lines, offset, page, and
126width are positive decimal integers and gap is a nonnegative decimal integer.
127.Bl -tag -width 4n
128.It Ar \&+page
129Begin output at page number
130.Ar page
131of the formatted input.
132.It Fl Ar column
133Produce output that is
134.Ar columns
135wide (default is 1) that is written vertically
136down each column in the order in which the text
137is received from the input file.
138The options
139.Fl e
140and
141.Fl i
142are assumed.
143This option should not be used with
144.Fl m .
145When used with
146.Fl t ,
147the minimum number of lines is used to display the output.
148.It Fl a
149Modify the effect of the
150.Fl column
151option so that the columns are filled across the page in a round-robin order
152(e.g., when column is 2, the first input line heads column
1531, the second heads column 2, the third is the second line
154in column 1, etc.).
155This option requires the use of the
156.Fl column
157option.
158.It Fl d
159Produce output that is double spaced. An extra
160.Em <newline>
161character is output following every <newline> found in the input.
162.It Fl e Ar \&[char\&]\&[gap\&]
163Expand each input <tab> to the next greater column
164position specified by the formula
165.Ar n*gap+1 ,
166where
167.Em n
168is an integer > 0.
169If
170.Ar gap
171is zero or is omitted the default is 8.
172All
173.Em <tab>
174characters in the input are expanded into the appropriate
175number of
176.Em <space>s .
177If any nondigit character,
178.Ar char ,
179is specified, it is used as the input tab character.
180.It Fl F
181Use a
182.Em <form-feed>
183character for new pages,
184instead of the default behavior that uses a
185sequence o
186.Em <newline>
187characters.
188.It Fl h Ar header
189.Ar header
190Use the string
191.Ar header
192to replace the
193.Ar file name
194in the header line.
195.It Fl i Ar \&[char\&]\&[gap\&]
196In output, replace multiple <space>s with <tab>s whenever two or more
197adjacent <space>s reach column positions
198.Ar gap+1 ,
199.Ar 2*gap+1 ,
200etc.
201If
202.Ar gap
203is zero or omitted, default
204.Em <tab>
205settings at every eighth column position
206is used.
207If any nondigit character,
208.Ar char ,
209is specified, it is used as the output
210.Em <tab>
211character.
212.It Fl l Ar lines
213Override the 66 line default and reset the page length to
214.Ar lines.
215If
216.Ar lines
217is not greater than the sum of both the header and trailer
218depths (in lines), the
219.Nm pr
220utility suppresses output of both the header and trailer, as if the
221.Fl t
222option were in effect.
223.It Fl m
224Merge the contents of multiple files.
225One line from each file specified by a file operand is
226written side by side into text columns of equal fixed widths, in
227terms of the number of column positions.
228The number of text columns depends on the number of
229file operands successfully opened.
230The maximum number of files merged depends on page width and the
231per process open file limit.
232The options
233.Fl e
234and
235.Fl i
236are assumed.
237.It Fl n Ar \&[char\&]\&[width\&]
238Provide
239.Ar width
240digit line numbering.
241The default for
242.Ar width ,
243if not specified, is 5.
244The number occupies the first
245.Ar width
246column positions of each text column or each line of
247.Fl m
248output.
249If
250.Ar char
251(any nondigit character) is given, it is appended to the line number to
252separate it from whatever follows. The default for
253.Ar char
254is a
255.Em <tab> .
256Line numbers longer than
257.Ar width
258columns are truncated.
259.It Fl o Ar offset
260Each line of output is preceded by
261.Ar offset
262.Em <spaces>s .
263If the
264.FL o
265option is not specified, the default is zero.
266The space taken is in addition to the output line width.
267.It Fl r
268Write no diagnostic reports on failure to open a file.
269.It Fl s Ar char
270Separate text columns by the single character
271.Ar char
272instead of by the appropriate number of
273.Em <space>s
274(default for
275.Ar char
276is the
277.Em <tab>
278character).
279.It Fl t
280Print neither the five-line identifying
281header nor the five-line trailer usually supplied for each page.
282Quit printing after the last line of each file without spacing to the
283end of the page.
284.It Fl w Ar width
285Set the width of the line to
286.Ar width
287column positions for multiple text-column output only.
288If the
289.Fl w
290option is not specified and the
291.Fl s
292option is not specified, the default width is 72.
293If the
294.Fl w
295option is not specified and the
296.Fl s
297option is specified, the default width is 512.
298.It Ar file
299A pathname of a file to be printed.
300If no
301.Ar file
302operands are specified, or if a
303.Ar file
304operand is
305.Sq Fl ,
306the standard input is used.
307The standard input is used only if no
308.Ar file
309operands are specified, or if a
310.Ar file
311operand is
312.Sq Fl .
313.El
314.Pp
315The
316.Fl s
317option does not allow the option letter to be separated from its
318argument, and the options
319.Fl e ,
320.Fl i ,
321and
322.Fl n
323require that both arguments, if present, not be separated from the option
324letter.
325.Sh ERRORS
326.Pp
327If
328.Nm pr
329receives an interrupt while printing to a terminal, it
330flushes all accumulated error messages to the screen before
331terminating.
332.Pp
333The
334.Nm pr
335utility exits 0 on success, and 1 if an error occurs.
336.Pp
337Error messages are written to standard error during the printing
338process (if output is redirected) or after all successful
339file printing is complete (when printing to a terminal).
340.Sh SEE ALSO
341.Xr cat 1 ,
342.Xr more 1
343.Sh STANDARDS
344The
345.Nm pr
346utility is
347.St -p1003.2
348compatible.
349.Sh HISTORY
350A
351.Nm
352command appeared in
353.At v1 .
354