ウェブサイト検索

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

Unix 系システムでヘルプを得るために最も一般的に使用され信頼できる方法の 1 つはマニュアル ページ を経由することです。マニュアル ページはすべての Unix 系システムの標準ドキュメントであり、プログラムや関数のオンライン マニュアルに相当します。 、ライブラリ、システムコール、正式な標準と規約、ファイル形式など。

ただし、man ページには多くの欠点があります。その 1 つは、長すぎることです。また、画面上であまりにも多くのテキストを読むことを好まない人もいます。

TLDR (「長すぎる; 読んでいません」の略) は、さまざまな Linux コマンドに関する簡潔で簡素化されたドキュメントを提供するコミュニティ主導のプロジェクトです。

TLDR は、コマンドの使用例を素早く提供し、ユーザーが広範なマニュアルや長い説明を読み解かなくてもコマンドを理解し、利用できるようにすることを目的としています。

TLDR には通常、「tldr」コマンドを使用し、その後に知りたいコマンドの名前を続けてコマンド ラインからアクセスします。

tldr ls

TLDR はインターネット スラングで、投稿、記事、コメント、またはマニュアル ページなどのあらゆるものが長すぎて、このフレーズを使用した人がその理由でそれを読んでいないことを意味します。 TLDR ページのコンテンツは、寛容な MIT ライセンスの下でオープンに利用できます。

この短い記事では、Linux にTLDR ページをインストールして使用する方法を説明します。

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

TLDR ページに簡単にアクセスするには、Node.js と呼ばれるサポートされているクライアントの 1 つをインストールする必要があります。これは、tldr-pages プロジェクトの元のクライアントです。

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"

カラーテーマ (シンプル、base16、オーシャン) を変更するには、-t フラグを使用します。

tldr -t ocean

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

tldr -r

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

tldr -h

さまざまなプラットフォームでサポートされているすべての専用クライアント アプリケーションのリストは、TLDR クライアント Wiki ページで見つけることができます。

それは今のところすべてです！ TLDR ページには、コミュニティが提供するコマンドの実用的な例がまとめられています。この短い記事では、Linux に TLDR ページをインストールして使用する方法を説明しました。

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