阅读文档

rakudoc - Raku pod 阅读器

简介§

程序 rakudoc 是一个命令行界面 (CLI) 程序，它从已安装模块的源代码中读取 Raku pod，与运行 raku --doc=MODULE programfile 从命名的源文件中读取 Raku pod 相反。

请注意，根据您安装 Rakudo Raku 的方式，rakudoc 可能不会自动安装。要安装它，请使用 zef

zef install 'rakudoc:auth<zef:coke>'

概要§

rakudoc [switches] [arguments]

描述§

没有开关或参数，rakudoc 将其帮助列表到 $*OUT (stdout)。对于 rakudoc:ver<0.2.5>，此输出为

Usage:
  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-sources / $RAKUDOC
    -b|--build-index                  Index all documents found in doc source directories

如果需要，可以捕获文本输出并将其转换为其他形式。

如果您想使用 ANSI 转义序列，这些序列在输出打印到终端时将应用粗体和其他增强功能，您将必须设置环境变量 POD_TO_TEXT_ANSI，该变量默认情况下未设置

export POD_TO_TEXT_ANSI=1

限制§

目前 rakudoc 只能从已安装的模块源文件（如分发版中的 META6.json 文件中列出）中提取嵌入的 Raku pod。计划为 rakudoc 添加一项功能（与 META6.json 更改结合使用）以提取已安装分发版中包含的所有文件中所有 Raku pod。