Mac - 安裝與使用 tldr ( Install and use tldr on Mac OS X )

tldr 簡單的說它算是精簡版的 man pages，與 man pages 不同在於 tldr 簡化了文件內容，並把指令的實際用法列舉出來讓使用者一目了然。它目前支援多個平台，如: Unix-like 系統、Android、iOS 與 Windows。本篇文章將記錄如何安裝與使用 tldr 於 Mac OS X 中。( 其他 Mac 相關教學可以參考本篇整理。If you want to read this article in English, you can visit here )



安裝 tldr：
我們將透過 Homebrew 來安裝 tldr。指令如下：

brew tap tldr-pages/tldr
brew install tldr

---

使用 tldr：
使用 tldr 方式與 man 相同：

# 查詢目前版本
tldr -v

# 更新 tldr
tldr --update

# 查詢指令資訊: tldr <command-name>
tldr docker

輸出訊息如下：

docker

Manage Docker containers and images.

- List of running docker containers:
    docker ps

- List all docker containers (running and stopped):
    docker ps -a

- Start a container:
    docker start container

- Stop a container:
    docker stop container

- Start a container from an image and get a shell inside of it:
    docker run -it image bash

- Run a command inside of an already running container:
    docker exec container command

你可以看到它將 Docker 指令基本用法都列了出來，但熟知 Docker 的人就會了解以上內容明顯不足夠。因此要更深入了解的話，還是需要多多參考官方文件。tldr 是 Open Source 專案，因此你也可以幫忙提升 tldr。

---

Environment :
  ・ Mac OS X
Reference :
  ・ TLDR