Rand Stats

rakudoc

zef:coke

Build Status

NAME

rakudoc - A tool for reading Raku documentation

SYNOPSIS

rakudoc [-d|--doc-sources=<Directories>] [-D|--no-default-docs] <query>
rakudoc -b|--build-index [-d|--doc-sources=<Directories>] [-D|--no-default-docs]
rakudoc -V|--version
rakudoc -h|--help <ARGUMENTS>

<query>                           Example: 'Map', 'IO::Path.add', '.add'
-d|--doc-sources=<Directories>    Additional directories to search for documentation
-D|--no-default-docs              Use only directories in --doc / $RAKUDOC
-b|--build-index                  Index all documents found in doc source directories

DESCRIPTION

The rakudoc command displays Raku documentation for language features and installed modules.

ENVIRONMENT

LICENSE

Rakudoc is Copyright (C) 2019–2021, by Joel Schüller, Tim Siegel and others.

It is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.