https://github.com/raku/rakudoc

A tool for reading Raku documentation
https://github.com/raku/rakudoc

cli documentation pod raku

Last synced: about 1 month ago
JSON representation

A tool for reading Raku documentation

• Host: GitHub
• URL: https://github.com/raku/rakudoc
• Owner: Raku
• License: artistic-2.0
• Created: 2020-06-09T18:00:43.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-30T16:38:40.000Z (about 1 year ago)
• Last Synced: 2024-10-07T12:41:28.044Z (about 1 month ago)
• Topics: cli, documentation, pod, raku
• Language: Raku
• Homepage: https://docs.raku.org/
• Size: 1.19 MB
• Stars: 6
• Watchers: 3
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/Raku/rakudoc.svg?branch=master)](https://travis-ci.com/Raku/rakudoc)

NAME

====

rakudoc - A tool for reading Raku documentation

SYNOPSIS

========

    rakudoc [-d|--doc-sources=] [-D|--no-default-docs] 

    rakudoc -b|--build-index [-d|--doc-sources=] [-D|--no-default-docs]

    rakudoc -V|--version

    rakudoc -h|--help 

                               Example: 'Map', 'IO::Path.add', '.add'

    -d|--doc-sources=    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

===========

  * `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](https://www.perlfoundation.org/artistic-license-20.html).