Daftar Isi

• NAME
• SYNOPSIS
• DESCRIPTION
• OPTIONS
• DIAGNOSTICS
• ENVIRONMENT
• SEE ALSO
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

pod2text - Convert POD data to formatted ASCII text

SYNOPSIS

pod2text [-aclostu] [--code] [-i indent] [-q quotes] [--stderr] [-w width] [input [output ...]]

pod2text -h

DESCRIPTION

pod2text is a front-end for Pod::Text and its subclasses. It uses themto generate formatted ASCII text from POD source. It can optionally useeither 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 incode). If input isn't given, it defaults to STDIN. output, ifgiven, is the file to which to write the formatted output. If outputisn't given, the formatted output is written to STDOUT. Several PODfiles can be processed in the same pod2text invocation (saving moduleload and compile times) by providing multiple pairs of input andoutput files on the command line.

OPTIONS

• -a, --alt

  Use an alternate output format that, among other things, uses a differentheading style and marks =item entries with a colon in the left margin.

• --code

  Include any non-POD text from the input file in the output as well. Usefulfor viewing code documented with POD blocks with the POD rendered and thecode left intact.

• -c, --color

  Format the output with ANSI color escape sequences. Using this optionrequires that Term::ANSIColor be installed on your system.

• -i indent, --indent=indent

  Set the number of spaces to indent regular text, and the default indentationfor =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 isprinted after =head1, although one is still printed after =head2,because this is the expected formatting for manual pages; if you'reformatting arbitrary text documents, using this option is recommended.

• -m width, --left-margin=width, --margin=width

  The width of the left margin in spaces. Defaults to 0. This is the marginfor all text, including headings, not the amount by which regular text isindented; for the latter, see -i option.

• -o, --overstrike

  Format the output with overstrike printing. Bold text is rendered ascharacter, backspace, character. Italics and file names are rendered asunderscore, backspace, character. Many pagers, such as less, know howto convert this to bold or underlined text.

• -q quotes, --quotes=quotes

  Sets the quote marks used to surround C<> text to quotes. Ifquotes is a single character, it is used as both the left and rightquote; if quotes is two characters, the first character is used as theleft quote and the second as the right quoted; and if quotes is fourcharacters, the first two are used as the left quote and the second two asthe right quote.

  quotes may also be set to the special value none, in which case noquote marks are added around C<> text.

• -s, --sentence

  Assume each sentence ends with two spaces and try to preserve that spacing.Without this option, all consecutive whitespace in non-verbatim paragraphsis compressed into a single space.

• --stderr

  By default, pod2text puts any errors detected in the POD input in a PODERRORS section in the output manual page. If --stderr is given, errorsare sent to standard error instead and the POD ERRORS section issuppressed.

• -t, --termcap

  Try to determine the width of the screen and the bold and underlinesequences for the terminal from termcap, and use that information informatting the output. Output will be wrapped at two columns less than thewidth of your terminal device. Using this option requires that your systemhave a termcap file somewhere where Term::Cap can find it and requires thatyour system support termios. With this option, the output of pod2textwill contain terminal control sequences for your current terminal type.

• -u, --utf8

  By default, pod2text tries to use the same output encoding as its inputencoding (to be backward-compatible with older versions). This optionsays to instead force the output encoding to UTF-8.

  Be aware that, when using this option, the input encoding of your PODsource must be properly declared unless it is US-ASCII or Latin-1. PODinput without an =encoding command will be assumed to be in Latin-1,and if it's actually in UTF-8, the output will be double-encoded. Seeperlpod(1) for more information on the =encoding command.

• -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 ofyour terminal device.

DIAGNOSTICS

If pod2text fails with errors, see Pod::Text and Pod::Simple forinformation about what those errors might mean. Internally, it can alsoproduce the following diagnostics:

• -c (--color) requires Term::ANSIColor be installed

  (F) -c or --color were given, but Term::ANSIColor could not beloaded.

• Unknown option: %s

  (F) An unknown command line option was given.

In addition, other Getopt::Long error messages may result from invalidcommand-line options.

ENVIRONMENT

• COLUMNS

  If -t is given, pod2text will take the current width of your screenfrom this environment variable, if available. It overrides terminal widthinformation in TERMCAP.

• TERMCAP

  If -t is given, pod2text will use the contents of this environmentvariable if available to determine the correct formatting sequences for yourcurrent terminal device.

SEE ALSO

Pod::Text, Pod::Text::Color, Pod::Text::Overstrike,Pod::Text::Termcap, Pod::Simple, perlpod(1)

The current version of this script is always available from its web site athttp://www.eyrie.org/~eagle/software/podlators/. It is also part of thePerl core distribution as of 5.6.0.

AUTHOR

Russ Allbery <[email protected]>.

COPYRIGHT AND LICENSE

Copyright 1999, 2000, 2001, 2004, 2006, 2008, 2010 Russ Allbery<[email protected]>.

This program is free software; you may redistribute it and/or modify itunder the same terms as Perl itself.