Skip to content

skaji/Pod-Perl6doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NAME

Pod::Perl6doc - perldoc for Perl6

SYNOPSIS

> perl6doc [OPTIONS] MODULE

OPTIONS:
-l  Display the module's file name
-m  Display module's file in its entirety
-h  Show this help

EXAMPLES:
> perl6doc File::Find
> perl6doc -m Panda::Builder
> perl6doc -l Pod::To::Text

# for perl6/doc content
> perl6doc Proc::Async
> perl6doc 5to6-perlfunc

> perl6doc Str.chars  # you can see a document for a specified method.

INSTALL

> panda install git://github.com/shoichikaji/Pod-Perl6doc.git

DESCRIPTION

Pod::Perl6doc is perldoc for Perl6.

We already have p6doc command in perl6. Why do you use perl6doc?

  • perl6doc renders documentation in colors.

  • perl6doc caches rendered documentations in ~/.perl6doc , because perl6's parsing pods is too slow.

SEE ALSO

Perl5 perldoc: https://metacpan.org/release/Pod-Perldoc

COPYRIGHT AND LICENSE

Copyright 2015 Shoichi Kaji skaji@cpan.org

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.

BUNDLED MODULE LICENSES

This module bundles a tweak version of Pod::To::Text which is a part of rakudo. rakudo license is the Artistic License 2.0. See https://github.com/rakudo/rakudo for further information.

This module bundles a tweak version of Pod::To::SectionFilter which is a part of perl6/doc. perl6/doc license is the Artistic License 2.0. See https://github.com/perl6/doc for further information.

Releases

No releases published

Packages

No packages published

Languages

  • Other 100.0%