ウェブサイト検索

TLDR - Linuxコマンドのためのわかりやすいマニュアルページ

Unix系システムで一般的に使用され、信頼性の高いサポートを得る方法の一つは、manページを通じて行うことです。manページはすべてのUnix系システムの標準的なドキュメントであり、プログラム、関数、ライブラリ、システムコール、正式な標準や慣習、ファイル形式などのオンラインマニュアルに対応しています。

しかし、マニュアルページには多くの欠点があり、その一つは長すぎることであり、ある人々は画面上の長いテキストを読むのが好きではありません。

TLDR（「長すぎて読まなかった」の略）は、さまざまなLinuxコマンドに関する簡潔で分かりやすいドキュメントを提供する、コミュニティ主導のプロジェクトです。

TLDRは、ユーザーが広範なマニュアルや長い説明に深入りせずにコマンドを理解し、活用できるように、コマンドの使用例を迅速かつ実用的に提供することを目的としています。

TLDRは通常、コマンドラインを介して「tldr」コマンドを使用してアクセスされ、その後、学びたいコマンドの名前が続きます。

$ tldr ls

TLDRはインターネットスラングで、投稿、記事、コメント、あるいはマニュアルページなどが長すぎて、そのためにそのフレーズを使った人は読まなかったことを意味します。TLDRページの内容は、緩やかなMITライセンスの下で公開されています。

この記事では、LinuxにおけるTLDRページのインストールと使用方法を紹介します。

LinuxシステムにTLDRページをインストールする方法

TLDRページに便利にアクセスするには、tldr-pagesプロジェクトのオリジナルクライアントであるNode.jsというサポートされているクライアントの1つをインストールする必要があります。

Node.jsをインストールするには、お使いのディストリビューションに特化したパッケージマネージャーを使用できます。

$ sudo apt install nodejs npm         [On Debian, Ubuntu and Mint]
sudo yum install nodejs npm         [On RHEL/CentOS/Fedora and Rocky/AlmaLinux]
sudo emerge -a sys-apps/nodejs npm  [On Gentoo Linux]
sudo apk add nodejs npm             [On Alpine Linux]
sudo pacman -S nodejs npm           [On Arch Linux]
sudo zypper install nodejs npm      [On OpenSUSE]

一度Node.jsとnpmがインストールされると、以下のようにnpmコマンドを使用してTLDRのインストールに進むことができます。

$ sudo npm install -g tldr

TLDRはSnapパッケージとしても利用可能で、インストールして実行できます。

$ sudo snap install tldr

TLDRクライアントをインストールした後、任意のコマンドのマニュアルページを表示できます。例えば、ここでtarコマンドを表示できます（ここでは他のコマンドを使うこともできます）:

$ tldr tar

ここにlsコマンドの要約されたマニュアルページにアクセスする別の例があります。

$ tldr ls

選択したプラットフォームのすべてのコマンドをキャッシュにリストするには、-lフラグを使用します。

$ tldr -l

キャッシュ内のすべてのサポートされているコマンドをリストするには、-aフラグを使用してください。

$ tldr -a

ローカルキャッシュを更新またはクリアするには、実行してください。

$ tldr -u	#update local cache 
OR
tldr -c 	#clear local cache

キーワードを使ってページを検索するには、-sオプションを使用します。例えば。

$ tldr -s  "list of all files, sorted by modification date"

色のテーマを変更するには（シンプル、ベース16、オーシャン）、-t フラグを使用します。

$ tldr -t ocean

ランダムなコマンドを表示することもできます。-rフラグを使用してください。

$ tldr -r

サポートされているオプションの完全なリストは、次のコマンドを実行することで確認できます。

$ tldr -h

異なるプラットフォーム向けのすべてのサポートされたおよび専用のクライアントアプリケーションのリストは、TLDRクライアントのウィキページで見つけることができます。

それでは、今回はこれで終わりです！TLDRページは、コミュニティが提供するコマンドの実用的な例をまとめたものです。この短い記事では、LinuxでのTLDRページのインストールと使用方法を示しました。

フィードバックフォームを使用して、TLDRについてのあなたの意見を共有するか、同様のプログラムがあれば教えてください。

関連記事: