Man vs TLDR: TLDR コマンドの利点と実用的な使用のヒント

明確にするために、この記事では Linux 環境内の コマンドmanとtldrコマンドについて説明します。man ページは詳細ですが、初心者にとっては圧倒されるかもしれません。代わりに、tldr コマンドを使用すると、Linux コマンドの簡潔でわかりやすい概要が提供されます。

tldrこのガイドでは、それが何であるか、それをどのように利用するか、そしてそれが従来のコマンドに比べてよりユーザーフレンドリーなオプションである理由について説明しますman。

マンコマンドを理解する

このmanコマンドは manual の略で、Unix 系システムでコマンドのドキュメントにアクセスするための標準的な方法です。manに続けてコマンド名を実行すると、そのコマンドに関連付けられたマニュアル ページが取得され、その機能、オプション、例に関する詳細な情報が得られます。

たとえば、次のコマンドを入力すると、lsコマンドの包括的な概要が表示されます。

このアクションにより、 NAME、SYNOPSIS、DESCRIPTION、OPTIONS、およびExamplesなどのさまざまなセクションに整理された、使用可能なすべてのオプションを表示する長いマニュアル ページが開きます。この構造はナビゲーションに役立ちますが、内容が広範囲にわたるため、混乱する可能性があります。

このmanコマンドは経験豊富なユーザーにとっては貴重な情報を提供しますが、表示される情報量が多いため、初心者や中級ユーザーにとっては圧倒される可能性があります。

Tldr とは何でしょうか?

tldrは「長すぎて読めない」という意味で、長い文章を要約するときに使われるインターネットの俗語です。従来の man ページとは異なり、tldr ページでは最も実用的なオプションを強調し、わかりやすい実際の例を添えています。

たとえば、ターミナルで にtldr続いて を実行すると、tldr コマンドは、最も頻繁に使用されるオプションを含むコマンドの簡単な概要を表示します。lsls

図に示すように、tldr ページは簡潔で焦点が絞られているため、新しいユーザーがコマンドを理解して効果的に使用しやすくなります。

Tldrを使い始める

tldr ページに簡単にアクセスするには、互換性のあるクライアントをインストールする必要があります。tldr の主なクライアントは Node.js で、これは tldr イニシアチブのオリジナル クライアントです。さまざまなプラットフォームでの追加のクライアント オプションについては、TLDR クライアントの wiki ページを参照してください。

Node.js は、Linux ディストリビューションに適したパッケージ マネージャーを使用してインストールできます。たとえば、Linux Mint や Ubuntu などの Debian ベースのシステムでは、次のコマンドを使用します。

Node.js とそのパッケージ マネージャー npm がインストールされたら、次のコマンドを使用して tldr クライアントをグローバルに設定できます。

Snap パッケージを希望する場合は、次のコマンドを実行して tldr をインストールできます。

インストール後、tldr クライアントを使用すると、簡略化され、理解しやすいコマンドライン マニュアル ページを表示できます。たとえば、tarコマンドの簡単な概要にアクセスするには、次のように入力します。

キーワードオプションを使用してコマンドを検索することもできます--search。

さらに、利用可能なすべてのコマンドを一覧表示するには、次のオプションを使用します-l。

tldrターミナルに入力するだけで、tldr コマンドで使用可能なすべてのオプションを調べることができます。

Web ベースのオプションの方が適している場合は、公式の tldr Web サイトで、閲覧用にフォーマットされた同様のコンテンツが提供されています。自動提案機能付きの検索バーや、コマンドが Linux 固有か macOS 固有かを示すラベルなどの機能が含まれています。

さらに、各ヘルプ ページは GitHub のソースにリンクされており、GitHub の組み込みツールを使用して変更や機能拡張を提案できます。Git に関する詳細な知識は必要ありません。

Tldrが人間より優れている点

Tldr ページは、簡単に読んで理解できるように作成されています。不要な複雑さを排除し、コマンドを効果的に使用するために必要な重要な情報のみに焦点を当てています。

考えられるすべてのオプションと詳細を詳しく説明することが多いマニュアル ページとは対照的に、tldr ページでは実用的な使用例が強調されています。これらの実用的な例は、実際の状況でコマンドを実装する方法を示しており、提示された概念を理解しやすくしています。

Tldr はプラットフォームに依存せず、Windows、macOS、Linux と互換性があり、さまざまな環境でその有用性を高めます。

結論

すぐに始めたい初心者でも、簡単に要約を知りたい専門家でも、tldr はツールキットに追加する価値のあるリソースです。

ただし、tldr コマンドはマニュアル ページを完全に置き換えるものではないことに注意してください。包括的かつ技術的な理解のために、従来のマニュアル ページは引き続き重要な参考資料として機能します。

画像クレジット: Unsplash。すべての変更とスクリーンショットはHaroon Javedによるものです。