什麼是 TLDR 並解釋瞭如何使用它

Linux 命令行用戶必須熟悉“man”命令。 它代表手冊頁，這意味著每個 Linux 命令或實用程序都帶有一組指令或命令的可能用法。 在命令行上工作時，手冊頁有很大幫助，但通常，通過手冊頁提供的文檔太長或太混亂而無法學習。 它也沒有提供任何現實生活中的例子。 它所包含的只是該特定命令的作用的詳細信息，以及它的可用開關（也稱為 options ）的詳細信息。

TLDR（太長時間沒讀）是社區驅動的改進默認 Linux 手冊頁的努力，它為每個命令或實用程序提供了一個易於理解的文檔，它還通過非常簡單的示例演示了命令的用法。 在本文中，我們將學習安裝 TLDR 的過程以及如何使用它在 Linux 終端上更好地工作。

如何在 Ubuntu 和 CentOS 系統上安裝 TLDR

安裝 TLDR 的最簡單方法是使用 NPM 和 Nodejs。 所以我們需要先在我們的系統上安裝這兩個組件。 Ubuntu 系統用戶可以使用以下命令安裝 NPM 和 Nodejs。

sudo apt-get install nodejs npm

CentOS 用戶需要首先啟用 Yum 的 EPEL 存儲庫。 運行以下命令安裝 Epel 存儲庫，一旦它處於活動狀態，我們就可以使用 YUM 安裝 nodejs 和 npm。

yum install epel-release -y

在 CentOS 系統上運行以下命令安裝 Node 和 NPM。

sudo yum install nodejs npm

好的，現在在您的系統上運行以下命令以完成安裝過程。

sudo npm install -g tldr

恭喜，您已經成功地為您的 Linux 系統配備了易於理解的命令手冊。

TLDR 示例

使用 TLDR 獲得幫助的語法非常簡單，使用以下格式。

tldr Command

用實際的實用程序或命令名稱替換“命令”，您正在嘗試獲取其文檔。

“ls”命令的文檔如下所示。

# tldr ls

ls
List directory contents.

- List files one per line:
ls -1

- List all files, including hidden files:
ls -a

- Long format list (permissions, ownership, size and modification date) of all files:
ls -la

- Long format list with size displayed using human readable units (KB, MB, GB):
ls -lh

- Long format list sorted by size (descending):
ls -lS

這不是非常簡單和描述性的方式嗎？ 這是 tar 命令的文檔的樣子：

# tldr tar

tar
Archiving utility.
Optional compression with gzip / bzip.

- Create an archive from files:
tar cf target.tar file1 file2 file3

- Create a gzipped archive:
tar czf target.tar.gz file1 file2 file3

- Extract an archive in a target folder:
tar xf source.tar -C folder

- Extract a gzipped archive in the current directory:
tar xzf source.tar.gz

- Extract a bzipped archive in the current directory:
tar xjf source.tar.bz2

- Create a compressed archive, using archive suffix to determine the compression program:
tar caf target.tar.xz file1 file2 file3

如您所見，它提供了一種非常直觀的方式來搜索有關命令的信息。 它顯示了每個命令的不同用法的示例，這使得它們非常容易理解。

您還可以通過鍵入以下內容列出存儲庫中的所有可用命令：

$ tldr -l

貢獻

如果您沒有找到命令或者您有更多現有命令的示例，歡迎您為該項目做出貢獻！

首先，非常重要的是，請確保您尊重所有這些項目：

指南

  1. 最好將頁面保持在 5 個示例左右。 如果確實需要，頁面可以更長，但不能超過8個示例。 該頁面不必涵蓋所有內容，這就是 男子 是為了。
  2. 當您對某事有疑問時，請選擇您知道它始終有效的安全方法。 為了 example: 需要的命令 sudo 應該直接將其包含在示例中。
  3. 除了單字母選項外，還包括拼寫選項。 這使用戶有可能了解他/她在做什麼。
  4. 在示例中，從更簡單的選項開始，然後繼續更複雜的選項。
  5. 避免解釋一般的 UNIX 概念，只關注命令的具體細節。

降價格式

每個頁面的格式應該是這樣的：

# command-name

> Short, snappy description.
> Preferably one line; two are acceptable if necessary.

- Example description:

`command -opt1 -opt2 -arg1 {{arg_value}}`

- Example description:

`command -opt1 -opt2`

有一個格式化程序可以強制執行上述格式。 它在每個拉取請求中自動運行，但您可以安裝它以查看您的貢獻將是什麼樣子：

$ sudo npm install tldr-lint
$ tldrl -f {{page.md}}

您可以查看更多用途或 域名 通過鍵入：

$ tldr tldrl

令牌語法

利用 {{令牌}} 用戶提供的值的語法以允許 tldr 客戶端突出顯示它們。 應使用多詞標記 蛇案例.

選擇令牌名稱的準則：

  1. 令牌值必須簡短且具有描述性。 為了 example： {{file_route}} 或者 {{home/user/.bashrc}}
  2. 如果 example 使用實際值比編寫輸入變量、參數名稱或其他任何內容更清晰，使用實際值。 為了 example： 利用 關機 -h {{5}} 而不是 關機 -h {{time_in_HHmm}}
  3. 對於文件或文件夾路徑的任何引用，請使用格式 {{path/to/}}. 為了 example, ln -s {{path/to/file}} {{path/to/symlink}}. 如果可能引用文件或文件夾，請使用 {{path/to/file_or_folder}}
  4. 跟著 {{path/to/}} 存在路徑相關命令時的約定，除非文件位置是隱式的。
  5. 如果有一個命令要求文件具有特定的擴展名，請顯示它。 例子： unrar x {{compressed_file.rar}}. 如果需要通用擴展，請使用 {{.ext}}

這只是指導方針，沒有嚴格的規則，只是嘗試遵循它們並使示例盡可能直觀。

提交拉取請求

您可以使用您喜歡的方法：

Github 的網頁界面

最簡單的方法是直接從 Github UI 編輯頁面。 你可以看到一些說明 這裡.

命令行

  1. 從 Github UI 分叉存儲庫
  2. 將您的 fork 克隆到本地計算機
    https://help.github.com/articles/editing-files-in-another-user-s-repository/
  3. 創建功能分支
    git checkout -b {{branch_name}}
  4. 進行更改
  5. 提交更改
     git commit --all -m "{{commit_message}}"</>
  6. 推到你的叉子
     git push origin {{branch_name}}</>
  7. 轉到 fork 的 github 頁面，然後單擊綠色的拉取請求按鈕。

在同一請求中僅發送相關更改。

對於提交消息，請使用以下命令：

<command>: type of change

示例：ls：添加頁面

你也可以參考 官方倉庫 查找更多文檔。

更新 TLDR

保持 TLDR 更新很重要，這樣您就可以獲得最新的信息。 它不斷向其添加越來越多的文檔，您可以使用以下命令對其進行更新。

tldr --update

使用在線（基於 Web）

您還可以使用以下命令查看 Linux 命令的文檔/幫助 網絡版. 開發人員有一個 Web URL，您可以使用它來搜索任何 Linux 實用程序/命令的文檔或幫助。 前往以下 URL，只需鍵入所需的命令/實用程序名稱，然後按“Enter”，您將看到搜索命令的社區文檔，它是一個非常吸引人的界面。

希望你喜歡這篇文章，我們在本教程中討論了 TLDR 命令的安裝和使用過程。 您還可以使用此實用程序的在線版本來提高您的日常 Linux 命令行工作效率。 它可以為您節省大量時間，並以極其簡單和詳細的方式為您提供急需的信息。 今天就試試吧！ 請在評論部分告訴我們您使用此實用程序的體驗。


Related Posts