manpageは長いから読みたくない?そんなときはtldr-pages

macOSやLinuxなどのUNIX(ライク)なOSには、manというコマンドが用意されています。このコマンドはman lsのように使い、引数に指定されたコマンドのマニュアル(manual)を表示します。

すべてのコマンドがそうであるというわけではありませんが、bashや'ls', cpなどよく使うコマンドには大量のオプションが存在します。そういったオプションを使うときに、マニュアルを参照するわけですが、あまりに説明が長いと読む気が起きません。そういうニーズにtldr-pagesが応えてくれます。

前述したように、tldr-pagesmanの説明を簡素にしたものです。すべてのオプションを網羅することはせず、一般によく使われるオプションのみを(サンプルつきで)列挙しています。

READMEに書かれているように、tldr-pagesにはいろいろな言語でつくられたクライアントがあります。C++で書かれたWeb版もあります。ここでは、C++で書かれたクライアントをビルド・インストール・実行してみます。

ソースを引っ張ってきてビルド

Ubuntuでやってみることにします。

$ mkdir ~/build/tldr && cd ~/build/tldr //適当なディレクトリに移動
$ git clone https://github.com/tldr-pages/tldr-cpp-client.git tldr-c-client //gitでソースを引っ張ってくる
$ cd tldr-c-client 
$ sudo ./deps.sh //依存関係にあるパッケージを自動インストール
$ make //1秒もかからず終わります
$ make install //インストール

パッケージマネージャから引っ張ってくる

macOS(Homebrewは導入済みとします)の場合

tldr-pages
$ brew install tldr

これだけでOKです。

使ってみる

こんな感じになります。

$ tldr man
man

Format and display manual pages.

-Display man page for a command:
    man command

- Display path searched for manpages:
    man --path

- Display location of a manpage rather than manpage itself:
    man -w command

- Do a keyword search for manpages containing a search string:
    man -k keyword

Sign up for free and join this conversation.
Sign Up
If you already have a Qiita account log in.