什么是 tldr-pages？

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

也许你是命令行世界的新手。也许你只是有点生疏，或者总是记不清像 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 和 DOS 命令行工具。

我该如何使用它？

[!TIP] 若要在不安装客户端的情况下浏览， 请访问 https://tldr.inbrowser.app 处的 Web 客户端（支持使用 PWA 离线访问）。

有多个官方客户端可用。

Python 客户端

官方 Python 客户端 可通过 PyPI 使用 pipx（或 其他包管理器）安装：

pipx install tldr

Rust 客户端

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

brew install tlrc

cargo install tlrc --locked

Windows 用户也可以使用 Winget（或其他操作系统上的 其他包管理器）安装官方 Rust Client：

winget install tldr-pages.tlrc

Node.js 客户端

或者，您也可以使用官方的 Node.js 客户端，尽管其更新已落后：

npm install -g tldr

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

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

[!NOTE] 大多数语言的翻译 PDF 均可用。你可以在 最新版本的发布资源 中找到它们。

社区还提供了各种其他客户端， 既适用于命令行，也适用于其他平台。 要获取客户端的完整列表，请访问我们的 Wiki。

我如何为 tldr-pages 做出贡献？

欢迎所有贡献！

一些贡献方式包括：

• 添加未被覆盖的您喜欢的命令。
• 为现有页面添加示例或改进内容。
• 添加带有 help wanted 标签的 issues 中请求的页面。
• 将页面翻译成不同的语言。

所有 tldr 页面均以 Markdown 编写，因此可以轻松地编辑，并且可以使用 Git 在命令行上 或 使用 GitHub 网页界面在此处通过 pull request 提交更改。

我们致力于维护一个友好且协作的社区。 如果是你第一次贡献，请查看贡献指南，然后开始吧！

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

你也欢迎加入我们的 matrix 聊天室 和包含所有 tldr 相关聊天室的 matrix 空间！

类似项目

• cheat.sh 从多个来源（包括 tldr-pages）聚合速查表 到一个统一的界面中。

• devhints Rico 的速查表不仅专注于命令行， 还包含大量与编程相关的其他速查表。

• eg 在命令行上提供带有解释的详细示例。 示例来自仓库，但 eg 支持在默认内容旁边显示 自定义示例和命令。

• kb 是一个极简主义的命令行知识库管理器。 kb 可用于以极简且整洁的方式组织你的笔记和速查表。它还支持非文本文件。

• navi 是一个交互式速查表工具，允许你即时浏览 特定示例或完整命令。

• Cheat 允许你在命令行上创建和查看交互式速查表。 它旨在帮助 Unix 系统管理员记住他们经常使用但不足以记住其选项的命令。

• Command Line Interface Pages 允许你为 CLI、目录和配置编写标准化的帮助页面。

• bropages (deprecated) 是 man 页面的高可读性补充。 它展示了 Unix 命令的简洁、常见用例示例。 这些示例由用户提交，并可以投票支持或反对； 最佳条目是人们在查找命令时首先看到的内容。

"tldr" 是什么意思？

TL;DR 是 "Too Long; Didn't Read" 的缩写。 它起源于网络俚语，用于表示一段长文本 （或其部分）因过长而被跳过。 在 How-To Geek 的 文章 中阅读更多。