INTRODUCTION §

Program rakudoc is a command-line-interface (CLI) program that reads Raku pod from installed modules' source code, in contrast to running raku --doc=MODULE programfile which reads Raku pod from the named source file.

Note that rakudoc may not be installed automatically depending upon how you installed Rakudo Raku. To install it use zef:

zef install rakudoc

SYNOPSIS §

rakudoc [switches] [arguments]

DESCRIPTION §

With no switches or arguments, rakudoc lists its help to $*OUT (stdout):

You want to maintain the index?
To build the index for `rakudoc -r ...`:
          rakudoc -b

What documentation do you want to read?
Examples: rakudoc Str
          rakudoc Str.split
          rakudoc faq
          rakudoc path/to/file

You can also look up specific method/routine/sub definitions:
          rakudoc -r hyper
          rakudoc -r push

You can bypass the pager and print straight to stdout:
          rakudoc -n Str

The text output can be captured and converted to other forms if desired.

If you want to use ANSI escape sequences, which will apply boldface and other enhancements to the output, you will have to set POD_TO_TEXT_ANSI, which is unset by default

export POD_TO_TEXT_ANSI=1

LIMITATIONS §

Currently rakudoc can only extract embedded Raku pod from installed module source files (as listed in a distribution's META6.json file). It is planned to add a feature for rakudoc (in conjunction with META6.json changes) to extract all Raku pod in files included with the installed distribution.