tldr 使用指南

什么是 tldr-pages？

tldr-pages 项目是一个由社区维护的命令行工具帮助页面合集，旨在作为传统 man pages 的一个更简单、更易懂的补充。

也许你是命令行新手，又或者你只是有些生疏，记不住像 lsof 或 tar 这样的命令参数？

毕竟过去我们查 man tar，看到的第一个选项就是这样的：

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

这就说明我们确实需要一些更简洁、注重实用示例的帮助页面。

比如这个页面：

这个仓库正是这样一个项目：为最常用的 UNIX、Linux、macOS、FreeBSD、NetBSD、OpenBSD、SunOS、Android、Windows 和 Cisco IOS 命令行工具，提供不断扩展的示例合集。

我该如何使用？

💡 小贴士 如果你不想在电脑上安装客户端，可以直接使用网页版：https://tldr.inbrowser.app（支持离线使用，通过 PWA 实现）。

一个流行且方便的使用方式，是在你的电脑上安装官方的 Python 客户端，可以通过 pip3 安装（或者用 其他包管理器）：

pip3 install tldr

Linux 和 Mac 用户也可以使用 Homebrew 安装官方的 Rust 客户端（或者在其他系统上使用 其他包管理器）：

brew install tlrc

你也可以选择官方的 Node.js 客户端，不过它的更新频率已经落后：

npm install -g tldr

这样你就可以直接使用更简洁易懂的命令帮助，比如输入 tldr tar，代替传统的 man tar。

如果你完全不想安装任何软件，也可以查看这个 PDF 版本。

📌 注意 大多数语言的翻译版本也提供 PDF，你可以在 最新版本 的 release 附件中找到它们。

社区还提供了 各种其他客户端，包括命令行工具和其他平台版本。完整客户端列表请查看 Wiki 页面。

我如何为 tldr-pages 做贡献？

所有贡献都欢迎参与！

你可以通过以下方式参与：

• 添加你喜欢但尚未收录的命令；
• 为已有页面补充示例或优化内容；
• 响应 issue 中带有 help wanted 标签 的页面请求；
• 翻译页面到其他语言。

所有的 tldr 页面都采用 Markdown 格式编写，因此很容易编辑，并可以通过命令行使用 Git 或 GitHub 网页界面提交 Pull Request。

我们致力于维护一个 友好协作 的社区。

如果你是第一次贡献，请阅读我们的 贡献指南，然后放心动手吧！

如果你想参与翻译，可以访问 https://lukwebsforge.github.io/tldri18n/ 查看所有语言的整体进度，以及哪些翻译缺失或需要更新。

你也可以加入我们的 Matrix 聊天室，欢迎交流讨论！