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 的文章以了解更多資訊。