| 1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "Pod::PlainText 3" |
| 132 | .TH Pod::PlainText 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" |
| 133 | .SH "NAME" |
| 134 | Pod::PlainText \- Convert POD data to formatted ASCII text |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 2 |
| 138 | \& use Pod::PlainText; |
| 139 | \& my $parser = Pod::PlainText->new (sentence => 0, width => 78); |
| 140 | .Ve |
| 141 | .PP |
| 142 | .Vb 2 |
| 143 | \& # Read POD from STDIN and write to STDOUT. |
| 144 | \& $parser->parse_from_filehandle; |
| 145 | .Ve |
| 146 | .PP |
| 147 | .Vb 2 |
| 148 | \& # Read POD from file.pod and write to file.txt. |
| 149 | \& $parser->parse_from_file ('file.pod', 'file.txt'); |
| 150 | .Ve |
| 151 | .SH "DESCRIPTION" |
| 152 | .IX Header "DESCRIPTION" |
| 153 | Pod::PlainText is a module that can convert documentation in the \s-1POD\s0 format (the |
| 154 | preferred language for documenting Perl) into formatted \s-1ASCII\s0. It uses no |
| 155 | special formatting controls or codes whatsoever, and its output is therefore |
| 156 | suitable for nearly any device. |
| 157 | .PP |
| 158 | As a derived class from Pod::Parser, Pod::PlainText supports the same methods and |
| 159 | interfaces. See Pod::Parser for all the details; briefly, one creates a |
| 160 | new parser with \f(CW\*(C`Pod::PlainText\->new()\*(C'\fR and then calls either |
| 161 | \&\fIparse_from_filehandle()\fR or \fIparse_from_file()\fR. |
| 162 | .PP |
| 163 | \&\fInew()\fR can take options, in the form of key/value pairs, that control the |
| 164 | behavior of the parser. The currently recognized options are: |
| 165 | .IP "alt" 4 |
| 166 | .IX Item "alt" |
| 167 | If set to a true value, selects an alternate output format that, among other |
| 168 | things, uses a different heading style and marks \f(CW\*(C`=item\*(C'\fR entries with a |
| 169 | colon in the left margin. Defaults to false. |
| 170 | .IP "indent" 4 |
| 171 | .IX Item "indent" |
| 172 | The number of spaces to indent regular text, and the default indentation for |
| 173 | \&\f(CW\*(C`=over\*(C'\fR blocks. Defaults to 4. |
| 174 | .IP "loose" 4 |
| 175 | .IX Item "loose" |
| 176 | If set to a true value, a blank line is printed after a \f(CW\*(C`=head1\*(C'\fR heading. |
| 177 | If set to false (the default), no blank line is printed after \f(CW\*(C`=head1\*(C'\fR, |
| 178 | although one is still printed after \f(CW\*(C`=head2\*(C'\fR. This is the default because |
| 179 | it's the expected formatting for manual pages; if you're formatting |
| 180 | arbitrary text documents, setting this to true may result in more pleasing |
| 181 | output. |
| 182 | .IP "sentence" 4 |
| 183 | .IX Item "sentence" |
| 184 | If set to a true value, Pod::PlainText will assume that each sentence ends in two |
| 185 | spaces, and will try to preserve that spacing. If set to false, all |
| 186 | consecutive whitespace in non-verbatim paragraphs is compressed into a |
| 187 | single space. Defaults to true. |
| 188 | .IP "width" 4 |
| 189 | .IX Item "width" |
| 190 | The column at which to wrap text on the right-hand side. Defaults to 76. |
| 191 | .PP |
| 192 | The standard Pod::Parser method \fIparse_from_filehandle()\fR takes up to two |
| 193 | arguments, the first being the file handle to read \s-1POD\s0 from and the second |
| 194 | being the file handle to write the formatted output to. The first defaults |
| 195 | to \s-1STDIN\s0 if not given, and the second defaults to \s-1STDOUT\s0. The method |
| 196 | \&\fIparse_from_file()\fR is almost identical, except that its two arguments are the |
| 197 | input and output disk files instead. See Pod::Parser for the specific |
| 198 | details. |
| 199 | .SH "DIAGNOSTICS" |
| 200 | .IX Header "DIAGNOSTICS" |
| 201 | .IP "Bizarre space in item" 4 |
| 202 | .IX Item "Bizarre space in item" |
| 203 | (W) Something has gone wrong in internal \f(CW\*(C`=item\*(C'\fR processing. This message |
| 204 | indicates a bug in Pod::PlainText; you should never see it. |
| 205 | .ie n .IP "Can't open %s\fR for reading: \f(CW%s" 4 |
| 206 | .el .IP "Can't open \f(CW%s\fR for reading: \f(CW%s\fR" 4 |
| 207 | .IX Item "Can't open %s for reading: %s" |
| 208 | (F) Pod::PlainText was invoked via the compatibility mode \fIpod2text()\fR interface |
| 209 | and the input file it was given could not be opened. |
| 210 | .ie n .IP "Unknown escape: %s" 4 |
| 211 | .el .IP "Unknown escape: \f(CW%s\fR" 4 |
| 212 | .IX Item "Unknown escape: %s" |
| 213 | (W) The \s-1POD\s0 source contained an \f(CW\*(C`E<>\*(C'\fR escape that Pod::PlainText didn't |
| 214 | know about. |
| 215 | .ie n .IP "Unknown sequence: %s" 4 |
| 216 | .el .IP "Unknown sequence: \f(CW%s\fR" 4 |
| 217 | .IX Item "Unknown sequence: %s" |
| 218 | (W) The \s-1POD\s0 source contained a non-standard internal sequence (something of |
| 219 | the form \f(CW\*(C`X<>\*(C'\fR) that Pod::PlainText didn't know about. |
| 220 | .IP "Unmatched =back" 4 |
| 221 | .IX Item "Unmatched =back" |
| 222 | (W) Pod::PlainText encountered a \f(CW\*(C`=back\*(C'\fR command that didn't correspond to an |
| 223 | \&\f(CW\*(C`=over\*(C'\fR command. |
| 224 | .SH "RESTRICTIONS" |
| 225 | .IX Header "RESTRICTIONS" |
| 226 | Embedded Ctrl-As (octal 001) in the input will be mapped to spaces on |
| 227 | output, due to an internal implementation detail. |
| 228 | .SH "NOTES" |
| 229 | .IX Header "NOTES" |
| 230 | This is a replacement for an earlier Pod::Text module written by Tom |
| 231 | Christiansen. It has a revamped interface, since it now uses Pod::Parser, |
| 232 | but an interface roughly compatible with the old \fIPod::Text::pod2text()\fR |
| 233 | function is still available. Please change to the new calling convention, |
| 234 | though. |
| 235 | .PP |
| 236 | The original Pod::Text contained code to do formatting via termcap |
| 237 | sequences, although it wasn't turned on by default and it was problematic to |
| 238 | get it to work at all. This rewrite doesn't even try to do that, but a |
| 239 | subclass of it does. Look for Pod::Text::Termcap. |
| 240 | .SH "SEE ALSO" |
| 241 | .IX Header "SEE ALSO" |
| 242 | Pod::Parser, Pod::Text::Termcap, |
| 243 | \&\fIpod2text\fR\|(1) |
| 244 | .SH "AUTHOR" |
| 245 | .IX Header "AUTHOR" |
| 246 | Please report bugs using <http://rt.cpan.org>. |
| 247 | .PP |
| 248 | Russ Allbery <rra@stanford.edu>, based \fIvery\fR heavily on the |
| 249 | original Pod::Text by Tom Christiansen <tchrist@mox.perl.com> and |
| 250 | its conversion to Pod::Parser by Brad Appleton |
| 251 | <bradapp@enteract.com>. |