使用 -l 标志将仅显示本地文档集，而 -n 将将每个文档集打印到单独的一行。

下载文档

$ dedoc download rust
Downloading `rust`...
Received 46313067 bytes, file 1 of 2...
Received 3319078 bytes, file 2 of 2...
Extracting to `/home/user/.dedoc/docsets/rust`...
Unpacked 1899 files...
Install has successfully finished.

这将使文档以一系列 HTML 页面的形式本地可用。

您也可以在这里使用 -f 标志强制覆盖文档。

例如，要搜索 BufReader 来自 rust，运行

$ dedoc search rust bufreader
Searching for `bufreader`...
Exact matches in `rust`:
   1  std/io/struct.bufreader
         2  #method.borrow
         3  #method.borrow_mut
         4  #method.buffer
         5  #method.by_ref
         ...

您将得到与您的查询匹配的页面搜索结果。

以 # 开头的结果显示为片段。打开它们将仅输出该特定片段。同样，打开一个页面将显示整个页面。如果您想强制打印整个页面而不是仅打印片段，请使用 -f 标志。

要执行更详细的搜索，请使用 -p 标志。这会使搜索行为类似于 grep 命令，并将在所有文件中查找所有匹配项，并在找到的节附近显示一些上下文。

使用 -i 进行不区分大小写的搜索，并使用 -w 搜索整个句子。

最后，要查看页面，您可以运行 open 并带有可选片段的路径

$ dedoc open rust "std/io/struct.bufreader#method.borrow"
...
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source
...

使用 -h 与 open 一起使用，使 dedoc 将提供的参数解释为 HTML 文件的路径，并像 HTML 到 Markdown 转换器一样操作。要使输出更宽或更窄，可以使用带有列数的 -c 标志。

您可以直接将 -o 标志附加到先前的 search 命令，这将打开第 n 个匹配的页面或片段

$ dedoc search rust bufreader -o 2

由于搜索缓存，这将以与 open 相同的速度运行。-c 标志在这里的工作方式与在 open 中相同。

您可能想使用 ss 而不是 search，将输出传递给分页器或 Markdown 阅读器，如 less，并使用 -c 强制启用颜色，将最终命令转换为

$ dedoc -c ss rust bufreader -o 2 | less -r

编码愉快！