#!perl

# Note: This script is a CLI for Riap function /App/podtohtml/podtohtml
# and generated automatically using Perinci::CmdLine::Gen version 0.498

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-02-26'; # DATE
our $DIST = 'App-podtohtml'; # DIST
our $VERSION = '0.009'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/podtohtml/podtohtml",
    program_name => "podtohtml",
    read_config => 0,
    read_env => 0,
);

$cmdline->run;

# ABSTRACT: Convert POD to HTML
# PODNAME: podtohtml

__END__

=pod

=encoding UTF-8

=head1 NAME

podtohtml - Convert POD to HTML

=head1 VERSION

This document describes version 0.009 of podtohtml (from Perl distribution App-podtohtml), released on 2021-02-26.

=head1 SYNOPSIS

Usage:

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

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

=head1 DESCRIPTION

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

It does not yet offer as many options as C<pod2html>.

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--browser>, B<-b>

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

=item B<--infile>=I<s>, B<-i>

Input file (POD).

Default value:

 "-"

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


=item B<--outfile>=I<s>, B<-o>

=back

=head2 Action options

=over

=item B<--list-templates>, B<-l>

List available templates.

=back

=head2 Output options

=over

=item B<--format>=I<s>

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

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--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]


=item B<--page-result>

Filter output through a pager.

=item B<--view-result>

View output using a viewer.

=back

=head2 Template options

=over

=item B<--list-templates>, B<-l>

List available templates.

=item B<--metacpan>

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

See C<--template>.

=item B<--template>=I<s>, B<-t>

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

=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

 complete -C podtohtml podtohtml

in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

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

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://github.com/perlancar/perl-App-podtohtml/issues>

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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2019, 2018, 2017 by 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.

=cut
