projects / OpenSPARC-T2-SAM / blame
| Commit | Line | Data |
|---|---|---|
| 920dae64 AT |
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 "POD2TEXT 1" | |
| 132 | .TH POD2TEXT 1 "2007-06-19" "perl v5.8.8" "Perl Programmers Reference Guide" | |
| 133 | .SH "NAME" | |
| 134 | pod2text \- Convert POD data to formatted ASCII text | |
| 135 | .SH "SYNOPSIS" | |
| 136 | .IX Header "SYNOPSIS" | |
| 137 | pod2text [\fB\-aclost\fR] [\fB\-\-code\fR] [\fB\-i\fR \fIindent\fR] [\fB\-q\fR\ \fIquotes\fR] | |
| 138 | [\fB\-w\fR\ \fIwidth\fR] [\fIinput\fR [\fIoutput\fR]] | |
| 139 | .PP | |
| 140 | pod2text \fB\-h\fR | |
| 141 | .SH "DESCRIPTION" | |
| 142 | .IX Header "DESCRIPTION" | |
| 143 | \&\fBpod2text\fR is a front-end for Pod::Text and its subclasses. It uses them | |
| 144 | to generate formatted \s-1ASCII\s0 text from \s-1POD\s0 source. It can optionally use | |
| 145 | either termcap sequences or \s-1ANSI\s0 color escape sequences to format the text. | |
| 146 | .PP | |
| 147 | \&\fIinput\fR is the file to read for \s-1POD\s0 source (the \s-1POD\s0 can be embedded in | |
| 148 | code). If \fIinput\fR isn't given, it defaults to \s-1STDIN\s0. \fIoutput\fR, if given, | |
| 149 | is the file to which to write the formatted output. If \fIoutput\fR isn't | |
| 150 | given, the formatted output is written to \s-1STDOUT\s0. | |
| 151 | .SH "OPTIONS" | |
| 152 | .IX Header "OPTIONS" | |
| 153 | .IP "\fB\-a\fR, \fB\-\-alt\fR" 4 | |
| 154 | .IX Item "-a, --alt" | |
| 155 | Use an alternate output format that, among other things, uses a different | |
| 156 | heading style and marks \f(CW\*(C`=item\*(C'\fR entries with a colon in the left margin. | |
| 157 | .IP "\fB\-\-code\fR" 4 | |
| 158 | .IX Item "--code" | |
| 159 | Include any non-POD text from the input file in the output as well. Useful | |
| 160 | for viewing code documented with \s-1POD\s0 blocks with the \s-1POD\s0 rendered and the | |
| 161 | code left intact. | |
| 162 | .IP "\fB\-c\fR, \fB\-\-color\fR" 4 | |
| 163 | .IX Item "-c, --color" | |
| 164 | Format the output with \s-1ANSI\s0 color escape sequences. Using this option | |
| 165 | requires that Term::ANSIColor be installed on your system. | |
| 166 | .IP "\fB\-i\fR \fIindent\fR, \fB\-\-indent=\fR\fIindent\fR" 4 | |
| 167 | .IX Item "-i indent, --indent=indent" | |
| 168 | Set the number of spaces to indent regular text, and the default indentation | |
| 169 | for \f(CW\*(C`=over\*(C'\fR blocks. Defaults to 4 spaces if this option isn't given. | |
| 170 | .IP "\fB\-h\fR, \fB\-\-help\fR" 4 | |
| 171 | .IX Item "-h, --help" | |
| 172 | Print out usage information and exit. | |
| 173 | .IP "\fB\-l\fR, \fB\-\-loose\fR" 4 | |
| 174 | .IX Item "-l, --loose" | |
| 175 | Print a blank line after a \f(CW\*(C`=head1\*(C'\fR heading. Normally, no blank line is | |
| 176 | printed after \f(CW\*(C`=head1\*(C'\fR, although one is still printed after \f(CW\*(C`=head2\*(C'\fR, | |
| 177 | because this is the expected formatting for manual pages; if you're | |
| 178 | formatting arbitrary text documents, using this option is recommended. | |
| 179 | .IP "\fB\-m\fR \fIwidth\fR, \fB\-\-left\-margin\fR=\fIwidth\fR, \fB\-\-margin\fR=\fIwidth\fR" 4 | |
| 180 | .IX Item "-m width, --left-margin=width, --margin=width" | |
| 181 | The width of the left margin in spaces. Defaults to 0. This is the margin | |
| 182 | for all text, including headings, not the amount by which regular text is | |
| 183 | indented; for the latter, see \fB\-i\fR option. | |
| 184 | .IP "\fB\-o\fR, \fB\-\-overstrike\fR" 4 | |
| 185 | .IX Item "-o, --overstrike" | |
| 186 | Format the output with overstruck printing. Bold text is rendered as | |
| 187 | character, backspace, character. Italics and file names are rendered as | |
| 188 | underscore, backspace, character. Many pagers, such as \fBless\fR, know how | |
| 189 | to convert this to bold or underlined text. | |
| 190 | .IP "\fB\-q\fR \fIquotes\fR, \fB\-\-quotes\fR=\fIquotes\fR" 4 | |
| 191 | .IX Item "-q quotes, --quotes=quotes" | |
| 192 | Sets the quote marks used to surround C<> text to \fIquotes\fR. If | |
| 193 | \&\fIquotes\fR is a single character, it is used as both the left and right | |
| 194 | quote; if \fIquotes\fR is two characters, the first character is used as the | |
| 195 | left quote and the second as the right quoted; and if \fIquotes\fR is four | |
| 196 | characters, the first two are used as the left quote and the second two as | |
| 197 | the right quote. | |
| 198 | .Sp | |
| 199 | \&\fIquotes\fR may also be set to the special value \f(CW\*(C`none\*(C'\fR, in which case no | |
| 200 | quote marks are added around C<> text. | |
| 201 | .IP "\fB\-s\fR, \fB\-\-sentence\fR" 4 | |
| 202 | .IX Item "-s, --sentence" | |
| 203 | Assume each sentence ends with two spaces and try to preserve that spacing. | |
| 204 | Without this option, all consecutive whitespace in non-verbatim paragraphs | |
| 205 | is compressed into a single space. | |
| 206 | .IP "\fB\-t\fR, \fB\-\-termcap\fR" 4 | |
| 207 | .IX Item "-t, --termcap" | |
| 208 | Try to determine the width of the screen and the bold and underline | |
| 209 | sequences for the terminal from termcap, and use that information in | |
| 210 | formatting the output. Output will be wrapped at two columns less than the | |
| 211 | width of your terminal device. Using this option requires that your system | |
| 212 | have a termcap file somewhere where Term::Cap can find it and requires that | |
| 213 | your system support termios. With this option, the output of \fBpod2text\fR | |
| 214 | will contain terminal control sequences for your current terminal type. | |
| 215 | .IP "\fB\-w\fR, \fB\-\-width=\fR\fIwidth\fR, \fB\-\fR\fIwidth\fR" 4 | |
| 216 | .IX Item "-w, --width=width, -width" | |
| 217 | The column at which to wrap text on the right-hand side. Defaults to 76, | |
| 218 | unless \fB\-t\fR is given, in which case it's two columns less than the width of | |
| 219 | your terminal device. | |
| 220 | .SH "DIAGNOSTICS" | |
| 221 | .IX Header "DIAGNOSTICS" | |
| 222 | If \fBpod2text\fR fails with errors, see Pod::Text and Pod::Parser for | |
| 223 | information about what those errors might mean. Internally, it can also | |
| 224 | produce the following diagnostics: | |
| 225 | .IP "\-c (\-\-color) requires Term::ANSIColor be installed" 4 | |
| 226 | .IX Item "-c (--color) requires Term::ANSIColor be installed" | |
| 227 | (F) \fB\-c\fR or \fB\-\-color\fR were given, but Term::ANSIColor could not be | |
| 228 | loaded. | |
| 229 | .ie n .IP "Unknown option: %s" 4 | |
| 230 | .el .IP "Unknown option: \f(CW%s\fR" 4 | |
| 231 | .IX Item "Unknown option: %s" | |
| 232 | (F) An unknown command line option was given. | |
| 233 | .PP | |
| 234 | In addition, other Getopt::Long error messages may result | |
| 235 | from invalid command-line options. | |
| 236 | .SH "ENVIRONMENT" | |
| 237 | .IX Header "ENVIRONMENT" | |
| 238 | .IP "\s-1COLUMNS\s0" 4 | |
| 239 | .IX Item "COLUMNS" | |
| 240 | If \fB\-t\fR is given, \fBpod2text\fR will take the current width of your screen | |
| 241 | from this environment variable, if available. It overrides terminal width | |
| 242 | information in \s-1TERMCAP\s0. | |
| 243 | .IP "\s-1TERMCAP\s0" 4 | |
| 244 | .IX Item "TERMCAP" | |
| 245 | If \fB\-t\fR is given, \fBpod2text\fR will use the contents of this environment | |
| 246 | variable if available to determine the correct formatting sequences for your | |
| 247 | current terminal device. | |
| 248 | .SH "SEE ALSO" | |
| 249 | .IX Header "SEE ALSO" | |
| 250 | Pod::Text, Pod::Text::Color, Pod::Text::Overstrike, | |
| 251 | Pod::Text::Termcap, Pod::Parser | |
| 252 | .PP | |
| 253 | The current version of this script is always available from its web site at | |
| 254 | <http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the | |
| 255 | Perl core distribution as of 5.6.0. | |
| 256 | .SH "AUTHOR" | |
| 257 | .IX Header "AUTHOR" | |
| 258 | Russ Allbery <rra@stanford.edu>. | |
| 259 | .SH "COPYRIGHT AND LICENSE" | |
| 260 | .IX Header "COPYRIGHT AND LICENSE" | |
| 261 | Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>. | |
| 262 | .PP | |
| 263 | This program is free software; you may redistribute it and/or modify it | |
| 264 | under the same terms as Perl itself. |