peri-doc - Display text/POD documentation of Riap function or package
This document describes version 0.58 of peri-doc (from Perl distribution Perinci-To-Doc), released on 2014-12-11.
From command-line:
% peri-doc /Some/Module/ % peri-doc --format=text https://example.com/api/some_func % peri-doc --help
This script will generate text/POD documentation for a Riap function or package.
Support more pod2html options
Support other entity types in the future.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C peri-doc peri-doc
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.
~/.bashrc
You can also install App::BashCompletionProg which makes it easy to add completion for Getopt::Long::Complete-based scripts. After you install the module and put . ~/.bash-complete-prog (or . /etc/bash-complete-prog), you can just run bash-completion-prog and the complete command will be added to your ~/.bash-completion-prog. Your next shell session will then recognize tab completion for the command.
. ~/.bash-complete-prog
. /etc/bash-complete-prog
bash-completion-prog
complete
~/.bash-completion-prog
To activate fish completion for this script, execute:
begin; set -lx COMP_SHELL fish; set -lx COMP_MODE gen_command; peri-doc; end > $HOME/.config/fish/completions/peri-doc.fish
Or if you want to install globally, you can instead write the generated script to /etc/fish/completions/peri-doc.fish or /usr/share/fish/completions/peri-doc.fish. The exact path might be different on your system. Please check your fish_complete_path variable.
/etc/fish/completions/peri-doc.fish
/usr/share/fish/completions/peri-doc.fish
fish_complete_path
To activate tcsh completion for this script, put:
complete peri-doc 'p/*/`peri-doc`/'
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.
~/.tcshrc
To activate zsh completion for this script, put:
_peri_doc() { read -l; local cl="$REPLY"; read -ln; local cp="$REPLY"; reply=(`COMP_SHELL=zsh COMP_LINE="$cl" COMP_POINT="$cp" peri-doc`) } compctl -K _peri_doc peri-doc
in your zsh startup (e.g. ~/.zshrc). 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.
~/.zshrc
Please visit the project's homepage at https://metacpan.org/release/Perinci-To-Doc.
Source repository is at https://github.com/perlancar/perl-Perinci-To-Doc.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-To-Doc
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2014 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.
To install Perinci::To::Doc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::To::Doc
CPAN shell
perl -MCPAN -e shell install Perinci::To::Doc
For more information on module installation, please visit the detailed CPAN module installation guide.