NAME

podtohtml - Convert POD to HTML

VERSION

This document describes version 0.010 of podtohtml (from Perl distribution App-podtohtml), released on 2022-05-14.

SYNOPSIS

% podtohtml [--browser|-b] [--format=name|--json] [--list-templates|-l] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--template=str] [--metacpan|-t=str] -- [infile] [outfile]

See examples in the "EXAMPLES" section.

DESCRIPTION

This is a thin wrapper for Pod::Html and an alternative CLI to pod2html to remove some annoyances that I experience with pod2html, e.g. the default cache directory being . (so it leaves .tmp files around). This CLI also offers templates and tab completion.

It does not yet offer as many options as pod2html.

OPTIONS

* marks required options.

Main options

--browser, -b

Instead of outputing HTML to STDOUT/file, view it in browser.

--infile=s, -i

Input file (POD).

Default value:

 "-"

If not found, will search in for .pod or .pm files in `@INC`.

Can also be specified as the 1st command-line argument.

--outfile=s, -o

Can also be specified as the 2nd command-line argument.

Action options

--list-templates, -l

List available templates.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Template options

--list-templates, -l

List available templates.

--metacpan

Shortcut for --template metacpan-20180911 --browser.

See --template.

--template=s, -t

Pick a template to use, only relevant with --browser.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C podtohtml podtohtml

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete podtohtml 'p/*/`podtohtml`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

EXAMPLES

Convert POD file to HTML, print result to STDOUT:

 % podtohtml some.pod

Convert POD file to HTML, show result in browser:

 % podtohtml some.pod -b

Convert POD file to HTML, show result in browser using the MetaCPAN template to give an idea how it will look on MetaCPAN:

 % podtohtml some.pod -b -t metacpan-20180911

Convert POD file to HTML, show result in browser using the sco template to give an idea how it will look on (now-dead) search.cpan.org:

 % podtohtml some.pod -b -t sco-20180123

Convert POD file to HTML, show result in browser using the perldoc.perl.org template to give an idea how it will look on perldoc.perl.org:

 % podtohtml some.pod -b -t perldoc_perl_org-20180911

List which templates are available:

 % podtohtml -l

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-podtohtml.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-podtohtml.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021, 2019, 2018, 2017 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-podtohtml

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

cpanm App::podtohtml

perl -MCPAN -e shell
install App::podtohtml