使用 tldr 命令显示更加用户友好的 Linux 手册页
Linux 手册页是一个很棒的资源。它们包含命令的详细用法,包括所有选项和用法。手册页的问题在于它们可能提供太多信息。如果您已经熟悉某个命令,只是想要记住完成特定任务需要哪个选项,该怎么办?
这时就tldr
派上用场了。此工具的名称来自首字母缩略词TL ;DR,代表“太长;没读”。这是互联网俚语,指的是长文本的摘要。本着同样的精神,tldr
命令行工具总结了冗长的手册页,主要由示例组成。
tldr 命令是什么?
命令tldr
行工具是社区tldr pages 项目的客户端。您无需翻阅一页又一页的信息,直到找到所需的选项并阅读其使用方法,只需键入tldr {command}
即可获得该命令最常见用途的简短列表。很有可能,您会得到所需的信息。
例如,该find
命令的手册页有 1,100 多行。fortldr
命令find
只有 30 行,其中包括 8 个实际示例:
$ tldr find
find
Find files or directories under the given directory tree, recursively.
More information: https://manned.org/find.
- Find files by extension:
find root_path -name '*.ext'
- Find files matching multiple path/name patterns:
find root_path -path '**/path/**/*.ext' -or -name '*pattern*'
- Find directories matching a given name, in case-insensitive mode:
find root_path -type d -iname '*lib*'
- Find files matching a given pattern, excluding specific paths:
find root_path -name '*.py' -not -path '*/site-packages/*'
- Find files matching a given size range:
find root_path -size +500k -size -10M
- Run a command for each file (use `{}` within the command to access the filename):
find root_path -name '*.ext' -exec wc -l {} \;
- Find files modified in the last 7 days and delete them:
find root_path -daystart -mtime -7 -delete
- Find empty (0 byte) files and delete them:
find root_path -type f -empty -delete
此工具不能替代命令 man
。手册页仍然是 Linux 命令的规范和完整信息来源。tldr
是一个很好的补充,它一目了然地提供重点详细信息,帮助您快速完成某项工作。
安装 tldr
tldr 项目提供了两个版本的客户端:Node.js 和 Python。Fedora Linux 将 Python 客户端打包在官方存储库中,因此您可以使用以下命令安装它dnf
:
$ sudo dnf -y install tldr
npm
使用或在其他 Linux 发行版上安装pip3
。有关更多信息,请查阅项目存储库。
离线使用 tldr
该tldr
工具通常需要互联网访问才能查阅 tldr 页面。Fedora 中提供的 Python 客户端支持下载和缓存这些页面以供离线访问。为此,请tldr
使用以下-u
选项运行:
$ tldr -u
Updated cache for 3239 entries
现在您可以tldr
在断开互联网连接时使用它。
下一步是什么?
tldr 页面是社区努力的成果。并非所有命令都可用,但会定期添加更多命令。您可以帮助改进现有示例或向项目添加缺少的命令。有关更多信息,请参阅项目的贡献指南。
如需更多信息tldr
,您可以随时使用tldr tldr
。