Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
pod2text(1)
Edit
PageHistory
Diff
Info
LikePages
POD2TEXT !!!POD2TEXT NAME SYNOPSIS DESCRIPTION OPTIONS DIAGNOSTICS ENVIRONMENT SEE ALSO AUTHOR ---- !!NAME pod2text - Convert POD data to formatted ASCII text !!SYNOPSIS pod2text [[__-aclost__] [[__-i__ ''indent''] [[__-q__ ''quotes''] [[__-w__ ''width''] [[''input'' [[''output'']] pod2text __-h__ !!DESCRIPTION __pod2text__ is a front-end for Pod::Text and its subclasses. It uses them to generate formatted ASCII text from POD source. It can optionally use either termcap sequences or ANSI color escape sequences to format the text. ''input'' is the file to read for POD source (the POD can be embedded in code). If ''input'' isn't given, it defaults to STDIN . ''output'', if given, is the file to which to write the formatted output. If ''output'' isn't given, the formatted output is written to STDOUT . !!OPTIONS __-a__, __--alt__ Use an alternate output format that, among other things, uses a different heading style and marks =item entries with a colon in the left margin. __-c__, __--color__ Format the output with ANSI color escape sequences. Using this option requires that Term::ANSIColor be installed on your system. __-i__ ''indent'', __--indent=__''indent'' Set the number of spaces to indent regular text, and the default indentation for =over blocks. Defaults to 4 spaces if this option isn't given. __-h__, __--help__ Print out usage information and exit. __-l__, __--loose__ Print a blank line after a =head1 heading. Normally, no blank line is printed after =head1, although one is still printed after =head2, because this is the expected formatting for manual pages; if you're formatting arbitrary text documents, using this option is recommended. __-o__, __--overstrike__ Format the output with overstruck printing. Bold text is rendered as character, backspace, character. Italics and file names are rendered as underscore, backspace, character. Many pagers, such as __less__, know how to convert this to bold or underlined text. __-q__ ''quotes'', __--quotes__=''quotes'' Sets the quote marks used to surround C quotes''. If ''quotes'' is a single character, it is used as both the left and right quote; if ''quotes'' is two characters, the first character is used as the left quote and the second as the right quoted; and if ''quotes'' is four characters, the first two are used as the left quote and the second two as the right quote. ''quotes'' may also be set to the special value none, in which case no quote marks are added around C __-s__, __--sentence__ Assume each sentence ends with two spaces and try to preserve that spacing. Without this option, all consecutive whitespace in non-verbatim paragraphs is compressed into a single space. __-t__, __--termcap__ Try to determine the width of the screen and the bold and underline sequences for the terminal from termcap, and use that information in formatting the output. Output will be wrapped at two columns less than the width of your terminal device. Using this option requires that your system have a termcap file somewhere where Term::Cap can find it and requires that your system support termios. With this option, the output of __pod2text__ will contain terminal control sequences for your current terminal type. __-w__, __--width=__''width'', __-__''width'' The column at which to wrap text on the right-hand side. Defaults to 76, unless __-t__ is given, in which case it's two columns less than the width of your terminal device. !!DIAGNOSTICS If __pod2text__ fails with errors, see Pod::Text and Pod::Parser for information about what those errors might mean. Internally, it can also produce the following diagnostics: -c (--color) requires Term::ANSIColor be installed (F) __-c__ or __--color__ were given, but Term::ANSIColor could not be loaded. Unknown option: %s (F) An unknown command line option was given. In addition, other Getopt::Long error messages may result from invalid command-line options. !!ENVIRONMENT COLUMNS If __-t__ is given, __pod2text__ will take the current width of your screen from this environment variable, if available. It overrides terminal width information in TERMCAP . TERMCAP If __-t__ is given, __pod2text__ will use the contents of this environment variable if available to determine the correct formatting sequences for your current terminal device. !!SEE ALSO Pod::Text, Pod::Text::Color, Pod::Text::Termcap, Pod::Parser !!AUTHOR Russ Allbery ----
One page links to
pod2text(1)
:
Man1p
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.