tldr

什么是 tldr 页面？

tldr-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 命令行工具示例集合。

我该如何使用它？

提示

如需在计算机上不安装客户端的情况下进行浏览，请参阅 https://tldr.inbrowser.app 上的 Web 客户端（使用 PWA 提供离线支持）。

在计算机上访问这些页面的一种流行且便捷的方法是安装官方 Node.js 客户端：

npm install -g tldr

或者，您也可以使用官方 Python 客户端，可以通过 pip3（或其他包管理器）安装：

pip3 install tldr

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

brew install tlrc

然后，您可以直接访问简化的、易于阅读的命令帮助，例如tar ，可以通过键入tldr tar而不是标准的man tar来访问。

如果您不想安装任何软件，请查看 PDF 版本。

笔记

大多数语言都提供 PDF 翻译。您可以在最新版本的发布资产中找到它们。

社区还提供了各种其他客户端，包括命令行和其他平台。如需完整的客户列表，请访问我们的 Wiki。

我如何为 tldr 页面做出贡献？

欢迎所有贡献！

一些贡献方式包括：

• 添加您最喜欢的未涵盖的命令。
• 添加示例或改进现有页面的内容。
• 使用“需要帮助”标签添加我们问题中请求的页面。
• 将页面翻译成不同的语言。

所有tldr页面都是用 Markdown 编写的，因此可以非常轻松地编辑它们，并且可以在此处使用命令行上的 Git 或使用 GitHub Web 界面在拉取请求中提交更改。

我们努力维持一个热情和协作的社区。如果这是您第一次贡献，请查看贡献指南，然后继续！

如果您想为翻译做出贡献，可以访问 https://lukwebsforge.github.io/tldri18n/ 查看所有翻译的总体进度，以及哪些翻译缺失或过时。

也欢迎您加入我们的矩阵聊天室！

类似项目

• 命令行界面页面允许您为 CLI、目录和配置编写标准化帮助页面。

• Cheat 允许您在命令行上创建和查看交互式备忘单。它旨在帮助提醒 Unix 系统管理员他们经常使用但不够频繁而难以记住的命令选项。

• cheat.sh 将多个来源（包括 tldr-pages）的备忘单聚合到 1 个统一的界面中。

• devhints Rico 的备忘单不仅仅关注命令行，还包括大量与编程相关的其他备忘单。

• 例如提供了详细的示例以及命令行上的解释。示例来自存储库，但eg支持在默认值旁边显示自定义示例和命令。

• kb 是一个极简的命令行知识库管理器。 kb 可用于以简约且干净的方式组织您的笔记和备忘单。它还支持非文本文件。

• navi 是一个交互式备忘单工具，它允许您即时浏览特定示例或完整命令。

• bropages（已弃用）是对手册页的高度可读的补充。它显示了 Unix 命令的简洁、常见的示例。示例由用户群提交，可以投票赞成或反对；最好的条目是人们在查找命令时首先看到的条目。

“tldr” 是什么意思？

TL;DR 代表“太长；没有读”。它起源于互联网俚语，用于表示长文本（或其中的一部分）因太长而被跳过。请阅读 How-To Geek 的文章了解更多信息。