1PAPS(1) General Commands Manual PAPS(1)
2
6 paps - text to PostScript converter using Pango
7
10 paps [options] files...
11
14 paps reads an input file and writes a PostScript language or user spec‐
15 ified format rendering of the file to standard output. paps accepts in‐
16 ternational text in any locale and provides internationalized text lay‐
17 out including text shaping and bidirectional text rendering.
18 If no filename argument is provided, paps reads the standard input. If
20 the standard input is a terminal, input is terminated by an EOF signal,
21 usually Control-d.
22
25 paps follows the usual GNU command line syntax, with long options
26 starting with two dashes (`-'). A summary of options is included below.
27 -h, --help
29 Show summary of options.
30 --landscape
32 Landscape output. Default is portrait.
33 --columns=cl
35 Format output into cl columns. Default is 1.
36 Please notice this option isn't related to the terminal length
37 as in a "80 columns terminal".
38 --font=desc
40 Use font based on description desc. Default is "Monospace 12".
41 The format of the string representation is:
42 "[family-list] [style-options] [size]"
44 where family-list is a comma separated list of families option‐
46 ally terminated by a comma, style-options is a whitespace sepa‐
47 rated list of words where each word describes one of style,
48 variant, weight, or stretch, and size is a decimal number for
49 size in points, e.g. "Courier,Monospace Bold Italic 10".
50 -o, --output=file
52 Output file. Default is stdout. Output format is set based on
53 file's extension when --format is not provided.
54 --rtl Do right-to-left (RTL) text layout and align text to the right.
56 Text direction is detected automatically. Use this option for
57 explicit RTL layout and right alignment.
58 --justify
60 Justify the layout. Stretch complete lines to fill the entire
61 width.
62 --wrap=wm
64 Use line wrapping mode wm. Default is word-char.
65 word Wrap lines at word boundaries
67 char Wrap lines at character boundaries
69 word-char Wrap lines at word boundaries, but fall back to char‐
71 acter boundaries if there is not enough space for a
72 full word
73 --show-wrap
75 Mark wrapped lines with special characters.
76 --paper=ps
78 Choose paper size. Accepted paper sizes are 'legal', 'letter',
79 'A3' and 'A4'. Default is A4.
80 --gravity=gr
82 Set base glyph orientation. Default is auto.
83 south Glyphs stand upright
85 east Glyphs are rotated 90 degrees clockwise
87 north Glyphs are upside-down
89 west Glyphs are rotated 90 degrees counter-clockwise
91 auto Gravity is resolved from the context
93 --gravity-hint=gh
96 Set how horizontal scripts behave in a vertical context. Default
97 is natural.
98 natural Scripts will take their natural gravity based on the
100 base gravity and the script
101 strong Always use the base gravity, regardless of the script
103 line For scripts not in their natural direction (e.g.
105 Latin in East gravity), choose per-script gravity
106 such that every script respects the line progression.
107 This means, Latin and Arabic will take opposite grav‐
108 ities and both flow top-to-bottom for example.
109 --format=fmt
111 Choose output format. Default is ps.
112 ps PostScript
114 pdf Portable Document Format
116 svg Scalable Vector Graphics
118 Postscript points
120 Each postscript point equals to 1/72 of an inch. 36 points are
121 1/2 of an inch.
122 --bottom-margin=bm
124 Set bottom margin. Default is 36 postscript points.
125 --top-margin=tm
127 Set top margin. Default is 36 postscript points.
128 --left-margin=lm
130 Set left margin. Default is 36 postscript points.
131 --right-margin=rm
133 Set right margin. Default is 36 postscript points.
134 --gutter-width=gw
136 Set gutter width. Default is 40 postscript points.
137 --header
139 Draw page header with document name, date and page number for
140 each page. Header is not printed by default.
141 --header-left=fmt
143 Sets the formatting for the left side of the header. See FORMAT
144 for an explanation of the header and footer formatting. Default
145 is the current localized date.
146 --header-center=fmt
148 Sets the formatting for the center of the header. See FORMAT for
149 an explanation of the header and footer formatting. Default is
150 the filename.
151 --header-right=fmt
153 Sets the formatting for the center of the header. See FORMAT for
154 an explanation of the header and footer formatting. Default is
155 the Page number.
156 --footer
158 Draw page footer with document name, date and page number for
159 each page. Footer is not printed by default.
160 --footer-left=fmt
162 Sets the formatting for the left side of the footer. See FORMAT
163 for an explanation of the footer and footer formatting. The de‐
164 fault formatting is an empty string.
165 --footer-center=fmt
167 Sets the formatting for the center of the footer. See FORMAT for
168 an explanation of the footer and footer formatting. The default
169 formatting is an empty string.
170 --footer-right=fmt
172 Sets the formatting for the center of the footer. See FORMAT for
173 an explanation of the footer and footer formatting. The default
174 formatting is an empty string.
175 --title="text"
177 Use text as the title string for page header. By default the in‐
178 put filename or "stdin" is used.
179 --markup
181 Interpret input as pango markup. Pango Text Attribute Markup
182 Language allows marking parts of the text with tags defining ad‐
183 ditional attributes such as font face, size, weight, colors or
184 text decoration such as underline or strikethrough.
185 --encoding=enc
187 Assume encoding of the input text is enc. By default the encod‐
188 ing of the current locale is used (e.g. UTF-8).
189 --lpi=lines
191 Set number of lines per inch. This determines the line spacing.
192 --cpi=chars
194 Set number of characters per inch. This is an alternative method
195 of specifying the font size.
196 --g-fatal-warnings
198 Make all glib warnings fatal.
199
202 The following exit values are returned:
203 0 Successful completion.
205 1 An error occurred.
207
210 The header and footers may be formatted by a mini language based on the
211 python f-strings. Text outside of squiggly brackets are entered liter‐
212 ally in the output. Text inside squiggly brackets contain one of the
213 following predefined list of variables:
214 now The current time
217 mtime The modification time of the file being printed
219 page_idx The page index of the page
221 num_pages The total number of pages in the document
223 filename The filename (basename) of the document
225 path The full path of the document
227
230 Example 1 Printing UTF-8 text file
231 The following command can be used to print a file in any of the UTF-8
233 based locales if the file is in UTF-8 or compatible codeset.
234 $ paps en_US_UTF-8.txt
236 By default paps will print PostScript rendering to standard output.
238 Send the output to a printer using lp
239 $ paps en_US_UTF-8.txt | lp
241 or to a file using redirection or the -o option
243 $ paps en_US_UTF-8.txt > out.ps
245 $ paps -o out.ps en_US_UTF-8.txt
246 Example 2 Specify encoding
249 To print a file in specific encoding regardless of the current locale
251 setting use the --encoding option. An example for Japanese EUC encoded
252 input file:
253 $ paps --encoding eucjp ja_JP_eucjp.txt > out.ps
255 paps will still use current locale setting to prioritize the available
257 fonts for current language.
258 Example 3 Specify locale
261 Override the LC_ALL environment variable to run paps in a different lo‐
263 cale.
264 $ LC_ALL=ja_JP.eucjp paps ja_JP_eucjp.txt > out.ps
266 Here paps will assume the input is in Japanese EUC encoding and will
268 use Japanese eucjp locale to render the output. If --header is added,
269 the date is printed in Japanese.
270 Example 4 Change the header and footer
273 Override the header and the footer to show only the page in the middle
275 of the footer.
276 $ paps --separation-lines -o /tmp/foo.pdf --header --header-left='' \
278 --header-center='{path}' --header-right='' --footer \
279 --footer-left='Printed {now:%c}' \
280 --footer-right='Page {page_idx}/{num_pages}' \
281 `pwd`/paps.ccx
282 Here paps will assume the input is in Japanese EUC encoding and will
284 use Japanese eucjp locale to render the output. If --header is added,
285 the date is printed in Japanese.
286
289 paps uses locale environment variables to determine its behavior. The
290 following categories are used:
291 LC_CTYPE to assume the encoding of the input. This can be over‐
293 ridden by --encoding.
294 LC_TIME to format the date for header.
296 Font selection is also affected by current locale. Example 3 describes
298 how to run paps in a different locale.
299
302 fc-match(1), setlocale(3C)
303
306 paps was written by Dov Grobgeld <dov.grobgeld@gmail.com>.
307 This manual page was written by Lior Kaplan <kaplan@debian.org>, for
309 the Debian project (but may be used by others).
310 December 20, 2022 PAPS(1)