386BSD 0.1 development
[unix-history] / usr / src / usr.bin / pr / pr.1
CommitLineData
3fdfb211
WJ
1.TH PR 1L \" -*- nroff -*-
2.SH NAME
3pr \- convert text files for printing
4.SH SYNOPSIS
5.B pr
6[+PAGE] [\-COLUMN] [\-abcdfFmrtv] [\-e[in-tab-char[in-tab-width]]]
7[\-h header] [\-i[out-tab-char[out-tab-width]]] [\-l page-length]
8[\-n[number-separator[digits]]] [\-o left-margin]
9[\-s[column-separator]] [\-w page-width] [file...]
10.SH DESCRIPTION
11This manual page
12documents the GNU version of
13.BR pr .
14.B pr
15prints on the standard output a paginated and optionally multicolumn
16copy of the text files given on the command line, or of the standard
17input if no files are given or when the file name `\-' is encountered.
18Form feeds in the input cause page breaks in the output.
19.SS OPTIONS
20.TP
21.I \+PAGE
22Begin printing with page \fIPAGE\fP.
23.TP
24.I \-COLUMN
25Produce \fICOLUMN\fP-column output and print columns down. The column
26width is automatically decreased as \fICOLUMN\fP increases; unless you
27use the \fI\-w\fP option to increase the page width as well, this
28option might cause some columns to be truncated.
29.TP
30.I \-a
31Print columns across rather than down.
32.TP
33.I \-b
34Balance columns on the last page.
35.TP
36.I \-c
37Print control characters using hat notation (e.g., `^G'); print other
38unprintable characters in octal backslash notation.
39.TP
40.I \-d
41Double space the output.
42.TP
43.I "\-e[in-tab-char[in-tab-width]]"
44Expand tabs to spaces on input. Optional argument \fIin-tab-char\fP
45is the input tab character, default tab. Optional argument
46\fIin-tab-width\fP is the input tab character's width, default 8.
47.TP
48.I "\-F, \-f"
49Use a formfeed instead of newlines to separate output pages.
50.TP
51.I "\-h header"
52Replace the filename in the header with the string \fIheader\fP.
53.TP
54.I "\-i[out-tab-char[out-tab-width]]"
55Replace spaces with tabs on output. Optional argument
56\fIout-tab-char\fP is the output tab character, default tab.
57Optional argument \fIout-tab-width\fP is the output tab character's
58width, default 8.
59.TP
60.I "\-l page-length"
61Set the page length to \fIpage-length\fP lines. The default is 66.
62If \fIpage-length\fP is less than 10, the headers and footers are
63omitted, as if the \fI\-t\fP option had been given.
64.TP
65.I \-m
66Print all files in parallel, one in each column.
67.TP
68.I "\-n[number-separator[digits]]"
69Precede each column with a line number; with parallel files, precede
70each line with a line number. Optional argument
71\fInumber-separator\fP is the character to print after each number,
72default tab. Optional argument \fIdigits\fP is the number of digits
73per line number, default 5.
74.TP
75.I "\-o left-margin"
76Offset each line with a margin \fIleft-margin\fP spaces wide. The
77total page width is this offset plus the width set with the \fI\-w\fP
78option.
79.TP
80.I \-r
81Do not print a warning message when an argument file cannot be opened.
82Failure to open a file still makes the exit status nonzero, however.
83.TP
84.I "\-s[column-separator]"
85Separate columns by the single character \fIcolumn-separator\fP,
86default tab, instead of spaces.
87.TP
88.I \-t
89Do not print the 5-line header and the 5-line trailer that are
90normally on each page, and do not fill out the bottoms of pages (with
91blank lines or formfeeds).
92.TP
93.I \-v
94Print unprintable characters in octal backslash notation.
95.TP
96.I "\-w page-width"
97Set the page width to \fIpage-width\fP columns. The default is 72.