NAME¶

pod2thread - Convert POD data to the HTML macro language thread.

SYNOPSIS¶

pod2thread [-chn] [-s style] [-t title]
[input [output]]

DESCRIPTION¶

pod2thread is a front-end for Pod::Thread. It uses that module to generate thread source from POD source.

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 thread output. If output isn't given, the output is written to STDOUT.

OPTIONS¶

-c, --contents

Generate a table of contents as the first section of the resulting threadfile, with links to each top-level heading.

-n, --navbar

Generate a navigation bar at the top of the resulting thread file, withlinks to each top-level heading.

-h, --help

Print out usage information and exit.

-s style, --style=style

In the generated thread source, include a reference to the style sheetstyle. If this option is not given, no style sheet reference will be included.

-t title, --title=title

Use title as the title of the page rather than looking for a NAME section in the POD document.

DIAGNOSTICS¶

If pod2thread fails with errors, see Pod::Thread and Pod::Simple for information about what those errors might mean. Internally, it can also produce the following diagnostic:

Unknown option: %s

(F) An unknown command line option was given.

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

AUTHOR¶

Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE¶

Copyright 2002, 2013, 2021 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.

SEE ALSO¶

Pod::Simple, Pod::Thread

This program is part of the Pod-Thread distribution. The current version ofPod-Thread is available from CPAN, or directly from its web site at<https://www.eyrie.org/~eagle/software/pod-thread/>.