rusty-man

$ rusty-man rusty-man | head -5
rusty-man                       Module rusty-man                       rusty-man

DESCRIPTION
      rusty-man is a command-line viewer for documentation generated by
      `rustdoc`.

使用示例

在运行 rusty-man 之前，请确保您已使用 cargo doc 生成文档

$ cd rusty-man && cargo doc

然后您可以打开某个项目的文档

$ rusty-man kuchiki::NodeRef

您不必指定完整的项目名称

$ rusty-man NodeRef

如果文档未放置在 ./target/doc 或 Rust 安装目录中，您必须使用 -s/--source 选项手动设置源路径

$ rusty-man --source my/other/crate/target/doc io::Error

如果存在多个与关键字匹配的项，rusty-man 将显示所有匹配项的列表

$ rusty-man --source my/other/crate/target/doc u8
Found mulitple matches for u8 – select one of:

[ 0 ] core::u8: The 8-bit unsigned integer type.
[ 1 ] std::u8: The 8-bit unsigned integer type.

> 1

有关更多信息，请运行 rusty-man --help。

查看器

rusty-man 有三个查看器（使用 --viewer 选项选择一个）以确定输出格式

• plain 将文档打印到标准输出而不进行格式化。这是非交互式使用的默认值。
• rich 以格式化和可选语法高亮的方式将文档打印到标准输出。这是交互式使用的默认值。
• tui 是一个交互式终端界面。您可以阅读文档并跟随链接。

安装

要从源代码安装 rusty-man，克隆此仓库并使用 cargo 构建项目，或使用 cargo install。有关更多信息，请参阅 INSTALL.md 文件。 rusty-man 也可以作为以下发行版的软件包使用

• Arch Linux: rusty-man 在 Arch 用户仓库中

rusty-man 为 Unix-like 系统开发。它也应该在其他平台上运行，但有一些限制： rich 和 tui 查看器使用 ANSI 转义码，这些转义码在较老的 Windows 版本上不受支持。如果您在您的平台上运行 rusty-man 时遇到问题，或者您想帮助将 rusty-man 移植到其他平台，请告诉我。

集成

vim

您可以将 "rusty-man" 设置为关键字程序，使用以下命令：set keywordprg=rusty-man 然后使用 K 打开光标下项目的文档。如果您想将此设置应用于所有 Rust 文件，请将其添加到您 vim 运行时目录中的 ftplugin/rust.vim 文件中（例如 ~/.vim）。

贡献

我们非常欢迎对这个项目的贡献！您可以通过编写代码、文档或进行测试来做出贡献。有关更多信息，请参阅 CONTRIBUTING.md 文件。

如果您正在寻找一个好的起点，请查看 rusty-man 问题跟踪器中带有“good first issue”标签的 问题。

最低支持的 Rust 版本

此 crate 支持 Rust 1.45.0 或更高版本。

联系方式

有关错误报告、补丁、功能请求或其他消息，请将邮件发送至邮件列表 ~ireas/[email protected] (公开存档) 或 直接联系我。您还可以使用 rusty-man 的 问题跟踪器 来报告错误或请求功能。

许可协议

本项目采用 MIT 许可协议。有关测试套件使用的数据的许可信息，请参阅 .reuse/dep5 文件。

rusty-man 符合 REUSE 规范的 3.0 版本。