tldr

<div align="center"> <h1><a href="https://tldr.sh/"><img alt="tldr-pages" src="https://yellow-cdn.veclightyear.com/835a84d5/f05019d1-10a4-487d-af76-f7d60764e0da.png" width=600/></a></h1>

</div>

什么是tldr-pages？

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

也许你是命令行世界的新手？或者你可能只是有点生疏，或者无法总是记住像lsof或tar这样的命令的参数？

过去，man tar中解释的第一个选项是这样的，这确实无助于理解：

$ man tar
...
-b blocksize
   指定磁带驱动器I/O的块大小，以512字节记录为单位。
   通常，只有在从磁带驱动器读取或写入时才需要此参数，
   而且通常甚至不需要，因为20个记录（10240字节）的默认块大小非常常见。
...

似乎有必要提供更简单的帮助页面，专注于实际示例。比如：

这个仓库正是如此：一个不断增长的最常用UNIX、Linux、macOS、SunOS、Android和Windows命令行工具示例集合。

如何使用？

[!提示] 如果想在不安装客户端的情况下浏览，请访问网页客户端https://tldr.inbrowser.app（支持离线使用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-pages做贡献？

欢迎所有的贡献！

一些贡献方式包括：

添加你喜欢的尚未涵盖的命令。
为现有页面添加示例或改进内容。
添加我们问题列表中带有help wanted标签的请求页面。
将页面翻译成不同的语言。

所有tldr页面都是用markdown编写的，因此可以很容易地进行编辑，并可以使用命令行上的Git或GitHub网页界面在此处提交更改的拉取请求。

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

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

欢迎加入我们的matrix聊天室！

类似项目

命令行界面页面允许你为CLI、目录和配置文件编写标准化的帮助页面。
Cheat 允许你在命令行上创建和查看交互式备忘单。它旨在帮助Unix系统管理员记住他们经常使用但不够频繁以至于无法记住的命令选项。
cheat.sh 将多个来源（包括tldr-pages）的备忘单聚合到一个统一的界面中。
devhints Rico的备忘单不仅专注于命令行，还包括与编程相关的大量其他备忘单。
eg 在命令行上提供带有解释的详细示例。示例来自仓库，但eg支持在默认示例和命令旁边显示自定义示例和命令。
kb 是一个极简的命令行知识库管理器。 kb可以用来以极简和整洁的方式组织你的笔记和备忘单。它还支持非文本文件。
navi 是一个交互式备忘单工具，允许你浏览特定示例或即时完成命令。
bropages（已弃用）是man页面的高可读性补充。它显示Unix命令的简明、常见用例示例。这些示例由用户提交，可以被投票支持或反对；用户在查找命令时首先看到的是得票最高的条目。