Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Perl 6 documentation reader
Perl

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/App
p6
script
share/Spec
t
t_source
xt
.gitignore
Changes
LICENSE
MANIFEST
Makefile.PL
README
TODO

README

NAME
    grok - Perl 6 documentation reader

SYNOPSIS
    grok <options> <target>

     Options:
       -F FILE, --file=FILE         A file to read Pod from
       -h, --help                   Print this help message
       -i, --index                  Print index of things grok knows about
       -l, --only                   Only print the path to the target file
       -o FORMAT, --output=FORMAT   The output format, ansi/text/xhtml/pod
       -T, --no-pager               Send output to STDOUT without any pager
       -u, --unformatted            Print unformatted Pod output
       -V, --version                Print version information

     If you don't supply the -F or -i options, you need to supply a target.
     The following targets are recognized:

       * A synopsis name (e.g. 's02', 's02-bits', 's32-rules')
       * A path to a file containing Pod
       * A function name from Synopsis 29

DESCRIPTION
    This little application is intended to be a "perldoc" for Perl 6.

  Prior art and inspiration
    <Perl 5's "perldoc">
    <Python's "pydoc">
    <Ruby's "ri">
    <http://svn.pugscode.org/pugs/ext/Perldoc/>
    <http://svn.pugscode.org/pugs/examples/perldoc.pl>

CAVEATS
  Limitations of "Perl6::Perldoc"
    Long lines are not wrapped to fit your terminal.

    Extraneous whitespace in paragraphs is preserved, counter to the spec.

    Formatting codes using french quotes ("C«»") aren't parsed correctly, so
    they are rendered verbatim.

AUTHOR
    Hinrik Örn Sigurðsson, hinrik.sig@gmail.com

LICENSE AND COPYRIGHT
    Copyright 2009 Hinrik Örn Sigurðsson

    "grok" is distributed under the terms of the Artistic License 2.0. For
    more details, see the full text of the license in the file LICENSE that
    came with this distribution.

Something went wrong with that request. Please try again.