Penguin
Recent Changes
Annotated edit history of pod2text(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 POD2TEXT
2 !!!POD2TEXT
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 DIAGNOSTICS
8 ENVIRONMENT
9 SEE ALSO
10 AUTHOR
11 ----
12 !!NAME
13
14
15 pod2text - Convert POD data to formatted ASCII text
16 !!SYNOPSIS
17
18
19 pod2text [[__-aclost__] [[__-i__ ''indent'']
20 [[__-q__ ''quotes''] [[__-w__ ''width'']
21 [[''input'' [[''output'']]
22
23
24 pod2text __-h__
25 !!DESCRIPTION
26
27
28 __pod2text__ is a front-end for Pod::Text and its
29 subclasses. It uses them to generate formatted
30 ASCII text from POD source. It
31 can optionally use either termcap sequences or
32 ANSI color escape sequences to format the
33 text.
34
35
36 ''input'' is the file to read for POD
37 source (the POD can be embedded in code). If
38 ''input'' isn't given, it defaults to
39 STDIN . ''output'', if given, is the file
40 to which to write the formatted output. If ''output''
41 isn't given, the formatted output is written to
42 STDOUT .
43 !!OPTIONS
44
45
46 __-a__, __--alt__
47
48
49 Use an alternate output format that, among other things,
50 uses a different heading style and marks =item
51 entries with a colon in the left margin.
52
53
54 __-c__, __--color__
55
56
57 Format the output with ANSI color escape
58 sequences. Using this option requires that Term::ANSIColor
59 be installed on your system.
60
61
62 __-i__ ''indent'',
63 __--indent=__''indent''
64
65
66 Set the number of spaces to indent regular text, and the
67 default indentation for =over blocks. Defaults to 4
68 spaces if this option isn't given.
69
70
71 __-h__, __--help__
72
73
74 Print out usage information and exit.
75
76
77 __-l__, __--loose__
78
79
80 Print a blank line after a =head1 heading.
81 Normally, no blank line is printed after =head1,
82 although one is still printed after =head2, because
83 this is the expected formatting for manual pages; if you're
84 formatting arbitrary text documents, using this option is
85 recommended.
86
87
88 __-o__, __--overstrike__
89
90
91 Format the output with overstruck printing. Bold text is
92 rendered as character, backspace, character. Italics and
93 file names are rendered as underscore, backspace, character.
94 Many pagers, such as __less__, know how to convert this
95 to bold or underlined text.
96
97
98 __-q__ ''quotes'',
99 __--quotes__=''quotes''
100
101
102 Sets the quote marks used to surround C
103 quotes''. If ''quotes'' is a single character, it is
104 used as both the left and right quote; if ''quotes'' is
105 two characters, the first character is used as the left
106 quote and the second as the right quoted; and if
107 ''quotes'' is four characters, the first two are used as
108 the left quote and the second two as the right
109 quote.
110
111
112 ''quotes'' may also be set to the special value
113 none, in which case no quote marks are added around
114 C
115
116
117 __-s__, __--sentence__
118
119
120 Assume each sentence ends with two spaces and try to
121 preserve that spacing. Without this option, all consecutive
122 whitespace in non-verbatim paragraphs is compressed into a
123 single space.
124
125
126 __-t__, __--termcap__
127
128
129 Try to determine the width of the screen and the bold and
130 underline sequences for the terminal from termcap, and use
131 that information in formatting the output. Output will be
132 wrapped at two columns less than the width of your terminal
133 device. Using this option requires that your system have a
134 termcap file somewhere where Term::Cap can find it and
135 requires that your system support termios. With this option,
136 the output of __pod2text__ will contain terminal control
137 sequences for your current terminal type.
138
139
140 __-w__, __--width=__''width'',
141 __-__''width''
142
143
144 The column at which to wrap text on the right-hand side.
145 Defaults to 76, unless __-t__ is given, in which case
146 it's two columns less than the width of your terminal
147 device.
148 !!DIAGNOSTICS
149
150
151 If __pod2text__ fails with errors, see Pod::Text and
152 Pod::Parser for information about what those errors might
153 mean. Internally, it can also produce the following
154 diagnostics:
155
156
157 -c (--color) requires Term::ANSIColor be
158 installed
159
160
161 (F) __-c__ or __--color__ were given, but
162 Term::ANSIColor could not be loaded.
163
164
165 Unknown option: %s
166
167
168 (F) An unknown command line option was given.
169
170
171 In addition, other Getopt::Long error messages may result
172 from invalid command-line options.
173 !!ENVIRONMENT
174
175
176 COLUMNS
177
178
179 If __-t__ is given, __pod2text__ will take the current
180 width of your screen from this environment variable, if
181 available. It overrides terminal width information in
182 TERMCAP .
183
184
185 TERMCAP
186
187
188 If __-t__ is given, __pod2text__ will use the contents
189 of this environment variable if available to determine the
190 correct formatting sequences for your current terminal
191 device.
192 !!SEE ALSO
193
194
195 Pod::Text, Pod::Text::Color, Pod::Text::Termcap,
196 Pod::Parser
197 !!AUTHOR
198
199
200 Russ Allbery
201 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.