什么是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)頁版。在上方的搜索框中找到你想查看的命令窥翩。例如:
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)潔的介紹啦扒怖!