TLDR pages:簡易版的 man pages

什么是TLDR?

TLDR 它本身

tl;dr 是一個網絡詞匯,和十動然拒這類差不多,是個縮寫。它的全稱是「Too Long; Don't Read」,翻譯成中文的話就叫「太長不看」。它興起于一些論壇,為了說明「樓主你的破文章又臭又長」,不過后來有許多文章的開頭也用

這個東西為啥叫太長不看?

一個叫「太長不看」的命令行工具顯然是解決一些令程序員一個腦袋兩個大的太長的東西,而這個東西就是 Linux man pages。它到底有多長呢,man pages的官方壓縮包是 2M 多的大小,解壓后是 16M。 16M 確實不算大了,然而這 16M 可是純文本啊。用來做類比的話,一本50萬字的中文小說變成純文本文件之后也就那么 1M 多,可想而知這甚至是全英文 man pages 有多長了。

我們卻需要它

作為程序員有時又十分需要 man pages。 雖然它長,你又不得不去讀它:比如說,你知道 ssh 的基本用法是

ssh username@remote_host

然而當你想換個端口或是利用私鑰登入服務器的時候就傻眼了,不得不打開 man pages:

SH(1)                    BSD General Commands Manual                   SSH(1)

NAME
     ssh -- OpenSSH SSH client (remote login program)

SYNOPSIS
     ssh [-1246AaCfGgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec]
         [-D [bind_address:]port] [-E log_file] [-e escape_char]
         [-F configfile] [-I pkcs11] [-i identity_file]
         [-J [user@]host[:port]] [-L address] [-l login_name] [-m mac_spec]
         [-O ctl_cmd] [-o option] [-p port] [-Q query_option] [-R address]
         [-S ctl_path] [-W host:port] [-w local_tun[:remote_tun]]
         [user@]hostname [command]

DESCRIPTION

以下省略一萬字……

于是想找如何使用私鑰登錄的你感到了一陣絕望……(雖然它確實存在于[-i identity_file]這里,你找到了嗎?)

所以就有了 TLDR

tldr 很好地解決了這個問題,把 man pages 中最常用的選項用更簡單的方式敘述了出來:

$ tldr ssh

  ssh

  Secure Shell is a protocol used to securely log onto remote systems.
  It can be used for logging or executing commands on a remote server.

  - Connect to a remote server:
    ssh username@remote_host

  - Connect to a remote server with a specific identity (private key):
    ssh -i path/to/key_file username@remote_host

  - Connect to a remote server using a specific port:
    ssh username@remote_host -p 2222

  - Run a command on a remote server:
    ssh remote_host command -with -flags

  - SSH tunneling: Dynamic port forwarding (SOCKS proxy on localhost:9999):
    ssh -D 9999 -C username@remote_host

  - SSH tunneling: Forward a specific port (localhost:9999 to slashdot.org:80):
    ssh -L 9999:slashdot.org:80 username@remote_host

  - Enable the option to forward the authentication information to the remote machine (see man ssh_config for available options):
    ssh -o "ForwardAgent=yes" username@remote_host

是的,tldr 的 ssh page 就這么長,而且你幾乎還能一下就找到怎么使用私鑰登錄。雖然它確實非常不全,但是它可以解決你絕大部分想查 man 的問題。

而且它是社區驅動的呀!

它是一個開源的項目,每個人都可以為它貢獻或修改其中的 page。如果你想去圍觀這個作品,可以到 tldr 這個 GitHub 代碼倉庫去做出一些自己的貢獻。

安裝和使用

網頁版

最簡單的使用方法是打開網頁版。在上方的搜索框中找到你想查看的命令。例如:

網頁版的 tldr

Node.js 版本

TLDR 最初的版本用 Node.js 寫成,所以官方最為推薦的安裝方法是:

npm install -g tldr

如果你不了解以下一接中提到的任何一種編程語言/包管理器(當然我覺得這種情況也不需要這個破軟件就是了),我們也在這里推薦使用 npm 安裝。如果你還沒有 npm, 可以到這里下載。

其他版本

TLDR 的官網也給除了其他一些安裝方式:

Client Installation instructions
Ruby client gem install tldrb
Haskell client stack install tldr
Python client pip install tldr.py
C++ client brew install tldr
Android client tldr-viewer on Google Play
iOS client TLDR Man Page in App Store
Dash for OSX open Preferences > Downloads > User Contributed and find tldr pages in the list
Bash client bpkg install pepa65/tldr

使用方法

簡單而言,你只要在命令行輸入 tldr 加上任何命令即可,例如 tldr ssh 或是 tldr tar,你就可以獲得在第一節中所見的簡潔的介紹啦!

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內容