Skip to content

Automatically open embed documentation when a specific program argument is detected.

License

Notifications You must be signed in to change notification settings

tessarin/p5-POD-Auto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

POD::Auto - Automatic launch of manual pages

The POD::Auto Perl module looks for the correct flag in the program arguments and (when found) opens the embed POD. Searches for any given flag (short, long or both) or --help by default.

After installing, check perldoc POD::Auto for a complete description of the available functionality.

Installation

Install with cpanm:

$ cpanm git://github.com/tessarin/p5-POD-Auto.git

Examples

Simply use'ing the module in a program will make it detect --help:

use POD::Auto;
# code and POD

$ prg           # execute normally
$ prg --help    # call perldoc, opening man page

Custom flags

use POD::Auto "h";      # search for `-h`
use POD::Auto "h|help"; # search for `-h` or `--help`

About

Automatically open embed documentation when a specific program argument is detected.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages