NAME

grok - Perl 6 documentation reader

SYNOPSIS

grok <options> <target>

Options:
  -F FILE, --file=FILE         A file to read Pod 6 from
  -f FORMAT, --format=FORMAT   The output format, ansi(default) or text
  -h, --help                   Print this help message
  -l, --only                   Only print the path to the target file
  -T, --no-pager               Send output to STDOUT without any pager
  -v, --version                Print version information

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

  * A synopsis (e.g. 's02', 's02-bits', 's32-rules')
  * A path to a file containing Pod 6

DESCRIPTION

This little application is intended to 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. 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.