TLDR pages:簡(jiǎn)易版的 man pages

什么是TLDR螟加?

TLDR 它本身

tl;dr 是一個(gè)網(wǎng)絡(luò)詞匯吞琐,和十動(dòng)然拒這類差不多站粟,是個(gè)縮寫。它的全稱是「Too Long; Don't Read」助被,翻譯成中文的話就叫「太長(zhǎng)不看」。它興起于一些論壇搔弄,為了說明「樓主你的破文章又臭又長(zhǎng)」丰滑,不過后來有許多文章的開頭也用

這個(gè)東西為啥叫太長(zhǎng)不看?

一個(gè)叫「太長(zhǎng)不看」的命令行工具顯然是解決一些令程序員一個(gè)腦袋兩個(gè)大的太長(zhǎng)的東西炫刷,而這個(gè)東西就是 Linux man pages浑玛。它到底有多長(zhǎng)呢圃庭,man pages的官方壓縮包是 2M 多的大小,解壓后是 16M拘央。 16M 確實(shí)不算大了灰伟,然而這 16M 可是純文本啊儒旬。用來做類比的話,一本50萬字的中文小說變成純文本文件之后也就那么 1M 多挡爵,可想而知這甚至是全英文 man pages 有多長(zhǎng)了。

我們卻需要它

作為程序員有時(shí)又十分需要 man pages甚垦。 雖然它長(zhǎng)茶鹃,你又不得不去讀它:比如說,你知道 ssh 的基本用法是

ssh username@remote_host

然而當(dāng)你想換個(gè)端口或是利用私鑰登入服務(wù)器的時(shí)候就傻眼了艰亮,不得不打開 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

以下省略一萬字……

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

所以就有了 TLDR

tldr 很好地解決了這個(gè)問題迄埃,把 man pages 中最常用的選項(xiàng)用更簡(jiǎn)單的方式敘述了出來:

$ 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 就這么長(zhǎng),而且你幾乎還能一下就找到怎么使用私鑰登錄蕉汪。雖然它確實(shí)非常不全流译,但是它可以解決你絕大部分想查 man 的問題。

而且它是社區(qū)驅(qū)動(dòng)的呀肤无!

它是一個(gè)開源的項(xiàng)目先蒋,每個(gè)人都可以為它貢獻(xiàn)或修改其中的 page。如果你想去圍觀這個(gè)作品宛渐,可以到 tldr 這個(gè) GitHub 代碼倉(cāng)庫去做出一些自己的貢獻(xiàn)竞漾。

安裝和使用

網(wǎng)頁版

最簡(jiǎn)單的使用方法是打開網(wǎng)頁版。在上方的搜索框中找到你想查看的命令窥翩。例如:

網(wǎng)頁版的 tldr

Node.js 版本

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

npm install -g tldr

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

其他版本

TLDR 的官網(wǎng)也給除了其他一些安裝方式:

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

使用方法

簡(jiǎn)單而言仗岸,你只要在命令行輸入 tldr 加上任何命令即可允耿,例如 tldr ssh 或是 tldr tar,你就可以獲得在第一節(jié)中所見的簡(jiǎn)潔的介紹啦扒怖!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末较锡,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子盗痒,更是在濱河造成了極大的恐慌蚂蕴,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,591評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件俯邓,死亡現(xiàn)場(chǎng)離奇詭異骡楼,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)稽鞭,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門鸟整,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人朦蕴,你說我怎么就攤上這事吃嘿。” “怎么了梦重?”我有些...
    開封第一講書人閱讀 162,823評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)亮瓷。 經(jīng)常有香客問我琴拧,道長(zhǎng),這世上最難降的妖魔是什么嘱支? 我笑而不...
    開封第一講書人閱讀 58,204評(píng)論 1 292
  • 正文 為了忘掉前任蚓胸,我火速辦了婚禮挣饥,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘沛膳。我一直安慰自己扔枫,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,228評(píng)論 6 388
  • 文/花漫 我一把揭開白布锹安。 她就那樣靜靜地躺著短荐,像睡著了一般。 火紅的嫁衣襯著肌膚如雪叹哭。 梳的紋絲不亂的頭發(fā)上忍宋,一...
    開封第一講書人閱讀 51,190評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音风罩,去河邊找鬼糠排。 笑死,一個(gè)胖子當(dāng)著我的面吹牛超升,可吹牛的內(nèi)容都是我干的入宦。 我是一名探鬼主播,決...
    沈念sama閱讀 40,078評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼室琢,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼乾闰!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起研乒,我...
    開封第一講書人閱讀 38,923評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤汹忠,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后雹熬,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體宽菜,經(jīng)...
    沈念sama閱讀 45,334評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,550評(píng)論 2 333
  • 正文 我和宋清朗相戀三年竿报,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了铅乡。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,727評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡烈菌,死狀恐怖阵幸,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情芽世,我是刑警寧澤挚赊,帶...
    沈念sama閱讀 35,428評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站济瓢,受9級(jí)特大地震影響荠割,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,022評(píng)論 3 326
  • 文/蒙蒙 一蔑鹦、第九天 我趴在偏房一處隱蔽的房頂上張望夺克。 院中可真熱鬧,春花似錦嚎朽、人聲如沸铺纽。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,672評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽狡门。三九已至,卻和暖如春魁索,著一層夾襖步出監(jiān)牢的瞬間融撞,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,826評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工粗蔚, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留尝偎,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,734評(píng)論 2 368
  • 正文 我出身青樓鹏控,卻偏偏與公主長(zhǎng)得像致扯,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子当辐,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,619評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容