rakudoc

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

ENVIRONMENT

  • RAKUDOC โ€” Comma-separated list of doc directories (e.g., ../doc/doc,./t/test-doc); ignored if --doc-sources option is given

  • RAKUDOC_DATA โ€” Path to directory where Rakudoc stores cache and index data

  • RAKUDOC_PAGER โ€” Pager program (default: $PAGER)

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.

rakudoc v0.2.6

A tool for reading Raku documentation

Authors

  • Joel D. S.
  • Tim Siegel
  • Will Coleda

License

Artistic-2.0

Dependencies

Pod::Utils:ver<0.0.2+>

Provides

  • Rakudoc
  • Rakudoc::CMD
  • Rakudoc::Documentable
  • Rakudoc::Pod::Cache

The Camelia image is copyright 2009 by Larry Wall. "Raku" is a trademark of the Yet Another Society. All rights reserved.

Built with Podlite โ€” the markup and publishing tools behind this site.