| blob | 5d871aaa601f5cbacbf5762f46ef2f3ae06e1062 |
1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
3 .\" Copyright 1989 AT&T
4 .\" Portions Copyright (c) 1995, Sun Microsystems, Inc. All Rights Reserved
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
6 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
8 .\" This notice shall appear on any product containing this material.
9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
12 .TH PR 1 "Mar 18, 1997"
13 .SH NAME
14 pr \- print files
15 .SH SYNOPSIS
16 .LP
17 .nf
18 \fB/usr/bin/pr\fR [+ \fIpage\fR] [\fB-column\fR] [\fB-adFmrt\fR] [\fB-e\fR [\fIchar\fR] [\fIgap\fR]]
19 [\fB-h\fR \fIheader\fR] [\fB-i\fR [\fIchar\fR] [\fIgap\fR]] [\fB-l\fR \fIlines\fR]
20 [\fB-n\fR [\fIchar\fR] [\fIwidth\fR]] [\fB-o\fR \fIoffset\fR] [\fB-s\fR [\fIchar\fR]]
21 [\fB-w\fR \fIwidth\fR] [\fB-fp\fR] [\fIfile\fR]...
22 .fi
24 .LP
25 .nf
26 \fB/usr/xpg4/bin/pr\fR [+ \fIpage\fR] [\fB-column\fR | \fB-c\fR \fIcolumn\fR] [\fB-adFmrt\fR]
27 [\fB-e\fR [\fIchar\fR] [\fIgap\fR]] [\fB-h\fR \fIheader\fR] [\fB-i\fR [\fIchar\fR] [\fIgap\fR]]
28 [\fB-l\fR \fIlines\fR] [\fB-n\fR [\fIchar\fR] [\fIwidth\fR]] [\fB-o\fR \fIoffset\fR]
29 [\fB-s\fR [\fIchar\fR]] [\fB-w\fR \fIwidth\fR] [\fB-fp\fR] [\fIfile\fR]...
30 .fi
32 .SH DESCRIPTION
33 .sp
34 .LP
35 The \fBpr\fR utility is a printing and pagination filter. If multiple input
36 files are specified, each is read, formatted, and written to standard output.
37 By default, the input is separated into 66-line pages, each with:
38 .RS +4
39 .TP
40 .ie t \(bu
41 .el o
42 a 5-line header that includes the page number, date, time and the path name of
43 the file
44 .RE
45 .RS +4
46 .TP
47 .ie t \(bu
48 .el o
49 a 5-line trailer consisting of blank lines
50 .RE
51 .sp
52 .LP
53 If standard output is associated with a terminal, diagnostic messages will be
54 deferred until the \fBpr\fR utility has completed processing.
55 .sp
56 .LP
57 When options specifying multi-column output are specified, output text columns
58 will be of equal width; input lines that do not fit into a text column will be
59 truncated. By default, text columns are separated with at least one blank
60 character.
61 .SH OPTIONS
62 .sp
63 .LP
64 The following options are supported. In the following option descriptions,
65 \fIcolumn\fR, \fIlines\fR, \fIoffset\fR, \fIpage\fR, and \fIwidth\fR are
66 positive decimal integers; \fIgap\fR is a non-negative decimal integer. Some of
67 the option-arguments are optional, and some of the option-arguments cannot be
68 specified as separate arguments from the preceding option letter. In
69 particular, the \fB-s\fR option does not allow the option letter to be
70 separated from its argument, and the options \fB-e\fR, \fB-i\fR, and \fB-n\fR
71 require that both arguments, if present, not be separated from the option
72 letter.
73 .sp
74 .LP
75 The following options are supported for both \fB/usr/bin/pr\fR and
76 \fB/usr/xpg4/bin/pr\fR:
77 .sp
78 .ne 2
79 .na
80 \fB\fB+\fR\fIpage\fR\fR
81 .ad
82 .RS 29n
83 Begins output at page number \fIpage\fR of the formatted input.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB-\fR\fIcolumn\fR\fR
90 .ad
91 .RS 29n
92 Produces multi-column output that is arranged in \fIcolumn\fR columns (default
93 is \fB1\fR) and is written down each column in the order in which the text is
94 received from the input file. This option should not be used with \fB-m\fR. The
95 \fB-e\fR and \fB-i\fR options will be assumed for multiple text-column output.
96 Whether or not text columns are produced with identical vertical lengths is
97 unspecified, but a text column will never exceed the length of the page (see
98 the \fB-l\fR option). When used with \fB-t\fR, use the minimum number of lines
99 to write the output.
100 .RE
102 .sp
103 .ne 2
104 .na
105 \fB\fB-a\fR\fR
106 .ad
107 .RS 29n
108 Modifies the effect of the \fB-\fR\fIcolumn\fR option so that the columns are
109 filled across the page in a round-robin order (for example, when \fIcolumn\fR
110 is 2, the first input line heads column 1, the second heads column 2, the third
111 is the second line in column 1, and so forth).
112 .RE
114 .sp
115 .ne 2
116 .na
117 \fB\fB-d\fR\fR
118 .ad
119 .RS 29n
120 Produces output that is double-spaced; append an extra \fBNEWLINE\fR character
121 following every \fBNEWLINE\fR character found in the input.
122 .RE
124 .sp
125 .ne 2
126 .na
127 \fB\fB\fR\fB-e\fR\fB\|[\|\fR\fIchar\fR\fB\|][\|\fR\fIgap\fR\fB\|]\fR\fR
128 .ad
129 .RS 29n
130 Expands each input \fBTAB\fR character to the next greater column position
131 specified by the formula \fIn\fR \fI*gap+1\fR, where \fIn\fR is an integer
132 \fB>0\fR. If \fIgap\fR is \fB0\fR or is omitted, it defaults to \fB8\fR. All
133 \fBTAB\fR characters in the input will be expanded into the appropriate number
134 of \fBSPACE\fR characters. If any non-digit character, \fIchar\fR, is
135 specified, it will be used as the input tab character.
136 .RE
138 .sp
139 .ne 2
140 .na
141 \fB\fB-f\fR\fR
142 .ad
143 .RS 29n
144 Uses a \fBFORMFEED\fR character for new pages, instead of the default behavior
145 that uses a sequence of \fBNEWLINE\fR characters. Pauses before beginning the
146 first page if the standard output is associated with a terminal.
147 .RE
149 .sp
150 .ne 2
151 .na
152 \fB\fB-h\fR \fIheader\fR\fR
153 .ad
154 .RS 29n
155 Uses the string \fIheader\fR to replace the contents of the \fIfile\fR operand
156 in the page header.
157 .RE
159 .sp
160 .ne 2
161 .na
162 \fB\fB-l\fR \fIlines\fR\fR
163 .ad
164 .RS 29n
165 Overrides the 66-line default and reset the page length to \fIlines\fR. If
166 \fIlines\fR is not greater than the sum of both the header and trailer depths
167 (in lines), \fBpr\fR will suppress both the header and trailer, as if the
168 \fB-t\fR option were in effect.
169 .RE
171 .sp
172 .ne 2
173 .na
174 \fB\fB-m\fR\fR
175 .ad
176 .RS 29n
177 Merges files. Standard output will be formatted so \fBpr\fR writes one line
178 from each file specified by \fIfile\fR, side by side into text columns of equal
179 fixed widths, in terms of the number of column positions. Implementations
180 support merging of at least nine \fIfile\fRs.
181 .RE
183 .sp
184 .ne 2
185 .na
186 \fB\fB-n\|[\|\fR\fIchar\fR\fB\|][\|\fR\fIwidth\fR\fB\|]\fR\fR
187 .ad
188 .RS 29n
189 Provides \fIwidth\fR-digit line numbering (default for \fIwidth\fR is \fB5\fR).
190 The number will occupy the first \fIwidth\fR column positions of each text
191 column of default output or each line of \fB-m\fR output. If \fIchar\fR (any
192 non-digit character) is given, it will be appended to the line number to
193 separate it from whatever follows (default for \fIchar\fR is a \fBTAB\fR
194 character).
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fB-o\fR \fIoffset\fR\fR
201 .ad
202 .RS 29n
203 Each line of output will be preceded by offset <space>s. If the \fB-o\fR option
204 is not specified, the default offset is \fB0\fR. The space taken will be in
205 addition to the output line width (see \fB-w\fR option below).
206 .RE
208 .sp
209 .ne 2
210 .na
211 \fB\fB-p\fR\fR
212 .ad
213 .RS 29n
214 Pauses before beginning each page if the standard output is directed to a
215 terminal (\fBpr\fR will write an \fBALERT\fR character to standard error and
216 wait for a carriage-return character to be read on \fB/dev/tty\fR).
217 .RE
219 .sp
220 .ne 2
221 .na
222 \fB\fB-r\fR\fR
223 .ad
224 .RS 29n
225 Writes no diagnostic reports on failure to open files.
226 .RE
228 .sp
229 .ne 2
230 .na
231 \fB\fB-s\fR \fB[\fR\fIchar\fR\fB]\fR\fR
232 .ad
233 .RS 29n
234 Separates text columns by the single character \fIchar\fR instead of by the
235 appropriate number of \fBSPACE\fR characters (default for \fIchar\fR is the
236 \fBTAB\fR character).
237 .RE
239 .sp
240 .ne 2
241 .na
242 \fB\fB-t\fR\fR
243 .ad
244 .RS 29n
245 Writes neither the five-line identifying header nor the five-line trailer
246 usually supplied for each page. Quits writing after the last line of each file
247 without spacing to the end of the page.
248 .RE
250 .sp
251 .ne 2
252 .na
253 \fB\fB-w\fR \fIwidth\fR\fR
254 .ad
255 .RS 29n
256 Sets the width of the line to \fIwidth\fR column positions for multiple
257 text-column output only. If the \fB-w\fR option is not specified and the
258 \fB-s\fR option is not specified, the default width is \fB72\fR. If the
259 \fB-w\fR option is not specified and the \fB-s\fR option is specified, the
260 default width is \fB512\fR.
261 .sp
262 For single column output, input lines will not be truncated.
263 .RE
265 .SS "/usr/bin/pr"
266 .sp
267 .LP
268 The following options are supported for \fB/usr/bin/pr\fR only:
269 .sp
270 .ne 2
271 .na
272 \fB\fB-F\fR\fR
273 .ad
274 .RS 27n
275 Folds the lines of the input file. When used in multi-column mode (with the
276 \fB-a\fR or \fB-m\fR options), lines will be folded to fit the current column's
277 width. Otherwise, they will be folded to fit the current line width (80
278 columns).
279 .RE
281 .sp
282 .ne 2
283 .na
284 \fB\fB\fR\fB-i\fR\fB\|[\|\fR\fIchar\fR\fB\|][\|\fR\fIgap\fR\fB\|]\fR\fR
285 .ad
286 .RS 27n
287 In output, replaces \fBSPACE\fR characters with \fBTAB\fR characters wherever
288 one or more adjacent \fBSPACE\fR characters reach column positions \fIgap+1\fR,
289 \fI2*gap+1\fR, \fI3*gap+1\fR, and so forth. If \fIgap\fR is \fB0\fR or is
290 omitted, default \fBTAB\fR settings at every eighth column position are
291 assumed. If any non-digit character, \fIchar\fR, is specified, it will be used
292 as the output \fBTAB\fR character.
293 .RE
295 .SS "/usr/xpg4/bin/pr"
296 .sp
297 .LP
298 The following options are supported for \fB/usr/xpg4/bin/pr\fR only:
299 .sp
300 .ne 2
301 .na
302 \fB\fB-F\fR\fR
303 .ad
304 .RS 27n
305 Uses a \fBFORMFEED\fR character for new pages, instead of the default behavior
306 that uses a sequence of \fBNEWLINE\fR characters.
307 .RE
309 .sp
310 .ne 2
311 .na
312 \fB\fB\fR\fB-i\fR\fB\|[\|\fR\fIchar\fR\fB\|][\|\fR\fIgap\fR\fB\|]\fR\fR
313 .ad
314 .RS 27n
315 In output, replaces multiple \fBSPACE\fR characters with \fBTAB\fR characters
316 wherever two or more adjacent \fBSPACE\fR characters reach column positions
317 \fIgap+1\fR, \fI2*gap+1\fR, \fI3*gap+1\fR, and so forth. If \fIgap\fR is
318 \fB0\fR or is omitted, default \fBTAB\fR settings at every eighth column
319 position are assumed. If any non-digit character, \fIchar\fR, is specified, it
320 will be used as the output \fBTAB\fR character.
321 .RE
323 .SH OPERANDS
324 .sp
325 .LP
326 The following operand is supported:
327 .sp
328 .ne 2
329 .na
330 \fB\fIfile\fR\fR
331 .ad
332 .RS 8n
333 A path name of a file to be written. If no \fIfile\fR operands are specified,
334 or if a \fIfile\fR operand is \fB\(mi\fR, the standard input will be used.
335 .RE
337 .SH EXAMPLES
338 .LP
339 \fBExample 1 \fRPrinting a numbered list of all files in the current directory
340 .sp
341 .in +2
342 .nf
343 example% \fBls -a | pr -n -h "Files in $(pwd)."\fR
344 .fi
345 .in -2
346 .sp
348 .LP
349 \fBExample 2 \fRPrinting files in columns
350 .sp
351 .LP
352 This example prints \fBfile1\fR and \fBfile2\fR as a double-spaced,
353 three-column listing headed by \fBfile list\fR:
355 .sp
356 .in +2
357 .nf
358 example% \fBpr -3d -h "file list" file1 file2\fR
359 .fi
360 .in -2
361 .sp
363 .LP
364 \fBExample 3 \fRWriting files with expanded column tabs
365 .sp
366 .LP
367 The following example writes \fBfile1\fR on \fBfile2\fR, expanding tabs to
368 columns \fB10\fR, \fB19\fR, \fB28\fR, ...
370 .sp
371 .in +2
372 .nf
373 example% \fBpr -e9 -t <file1 >file2\fR
374 .fi
375 .in -2
376 .sp
378 .SH ENVIRONMENT VARIABLES
379 .sp
380 .LP
381 See \fBenviron\fR(5) for descriptions of the following environment variables
382 that affect the execution of \fBpr\fR: \fBLANG\fR, \fBLC_ALL\fR,
383 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_TIME\fR, \fBTZ\fR, and \fBNLSPATH\fR.
384 .SH EXIT STATUS
385 .sp
386 .LP
387 The following exit values are returned:
388 .sp
389 .ne 2
390 .na
391 \fB\fB0\fR\fR
392 .ad
393 .RS 6n
394 Successful completion.
395 .RE
397 .sp
398 .ne 2
399 .na
400 \fB\fB>0\fR\fR
401 .ad
402 .RS 6n
403 An error occurred.
404 .RE
406 .SH ATTRIBUTES
407 .sp
408 .LP
409 See \fBattributes\fR(5) for descriptions of the following attributes:
410 .SS "/usr/bin/pr"
411 .sp
413 .sp
414 .TS
415 box;
416 c | c
417 l | l .
418 ATTRIBUTE TYPE ATTRIBUTE VALUE
419 _
420 CSI Enabled
421 .TE
423 .SS "/usr/xpg4/bin/pr"
424 .sp
426 .sp
427 .TS
428 box;
429 c | c
430 l | l .
431 ATTRIBUTE TYPE ATTRIBUTE VALUE
432 _
433 CSI Enabled
434 _
435 Interface Stability Committed
436 _
437 Standard See \fBstandards\fR(5).
438 .TE
440 .SH SEE ALSO
441 .sp
442 .LP
443 \fBexpand\fR(1), \fBlp\fR(1), \fBattributes\fR(5), \fBenviron\fR(5),
444 \fBstandards\fR(5)