markdown-to-pod - Convert Markdown to POD
This document describes version 0.02 of markdown-to-pod (from Perl distribution App-MarkdownUtils), released on 2016-01-31.
% markdown-to-pod [options] <markdown>
Currently using Markdown::To::POD perl module.
* marks required options.
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C markdown-to-pod markdown-to-pod
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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.
To activate tcsh completion for this script, put:
complete markdown-to-pod 'p/*/`markdown-to-pod`/'
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).
For fish and zsh, install shcompgen as described above.
This script can read configuration file, which by default is searched at ~/.config/markdown-to-pod.conf, ~/markdown-to-pod.conf or /etc/markdown-to-pod.conf (can be changed by specifying --config-path). All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
Configuration file is in the format of IOD, which is basically INI with some extra features.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] (filter by profile). Those sections will only be read if you specify the matching --config-profile SOMENAME.
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=foo ...]. The section will then only be used when the reading program matches.
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
List of available configuration parameters:
format (see --format)
markdown (see --markdown)
naked_res (see --naked-res)
Specify additional command-line options
Please visit the project's homepage at https://metacpan.org/release/App-MarkdownUtils.
Source repository is at https://github.com/perlancar/perl-App-MarkdownToPODUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-MarkdownUtils
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.
This software is copyright (c) 2016 by firstname.lastname@example.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.
To install App::MarkdownUtils, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.