TLDRとは何ですか？その使用方法の説明

Linuxコマンドラインユーザーは、「man」コマンドに精通している必要があります。 これはマニュアルページの略で、すべてのLinuxコマンドまたはユーティリティに一連の命令またはコマンドの可能な使用法が付属していることを意味します。 マニュアルページは、コマンドラインでの作業中に非常に役立ちますが、多くの場合、マニュアルページから入手できるドキュメントは長すぎるか、混乱しすぎて学習できません。 また、実際の例も提供していません。 含まれているのは、その特定のコマンドが実行する内容の詳細と、使用可能なスイッチ（オプションとも呼ばれます）です。

TLDR（Too Long Did n’t Read）は、デフォルトのLinuxマニュアルページを改善するためのコミュニティ主導の取り組みであり、すべてのコマンドまたはユーティリティのドキュメントを簡単に入手でき、コマンドの使用法を非常に簡単な例で示しています。 この記事では、TLDRをインストールするプロセスと、それを使用してLinux端末でより適切に機能する方法を学習します。

UbuntuおよびCentOSシステムにTLDRをインストールする方法

TLDRをインストールする最も簡単な方法は、NPMとNodejsを使用することです。 したがって、最初にこれら2つのコンポーネントをシステムにインストールする必要があります。 Ubuntuシステムのユーザーは、次のコマンドを使用してNPMとNodejsをインストールできます。

sudo apt-get install nodejs npm

CentOSユーザーは、最初にYumのEPELリポジトリを有効にする必要があります。 次のコマンドを実行してEpelリポジトリをインストールします。アクティブになると、YUMを使用してnodejsとnpmをインストールできるようになります。

yum install epel-release -y

CentOSシステムで次のコマンドを実行して、ノードとNPMをインストールします。

sudo yum install nodejs npm

了解しました。システムで次のコマンドを実行して、インストールプロセスを完了します。

sudo npm install -g tldr

おめでとうございます。これで、Linuxシステムにわかりやすいコマンドマニュアルが正常に装備されました。

TLDRの例

TLDRを使用してヘルプを取得するための構文は非常に単純です。次の形式を使用してください。

tldr Command

「コマンド」を、ドキュメントを取得しようとしている実際のユーティリティまたはコマンド名に置き換えます。

「ls」コマンドのドキュメントは次のようになります。

# tldr ls

ls
List directory contents.

- List files one per line:
ls -1

- List all files, including hidden files:
ls -a

- Long format list (permissions, ownership, size and modification date) of all files:
ls -la

- Long format list with size displayed using human readable units (KB, MB, GB):
ls -lh

- Long format list sorted by size (descending):
ls -lS

それは非常に簡単で説明的な方法ではありませんか？ tarコマンドのドキュメントは次のようになります。

# tldr tar

tar
Archiving utility.
Optional compression with gzip / bzip.

- Create an archive from files:
tar cf target.tar file1 file2 file3

- Create a gzipped archive:
tar czf target.tar.gz file1 file2 file3

- Extract an archive in a target folder:
tar xf source.tar -C folder

- Extract a gzipped archive in the current directory:
tar xzf source.tar.gz

- Extract a bzipped archive in the current directory:
tar xjf source.tar.bz2

- Create a compressed archive, using archive suffix to determine the compression program:
tar caf target.tar.xz file1 file2 file3

ご覧のとおり、コマンドに関する情報を検索するための非常に直感的な方法を提供します。 すべてのコマンドのさまざまな使用法の例が示されているため、非常に理解しやすくなっています。

次のように入力して、リポジトリで使用可能なすべてのコマンドを一覧表示することもできます。

$ tldr -l

貢献

コマンドが見つからない場合、または既存のコマンドの例が他にもある場合は、プロジェクトに貢献してください。

まず、非常に重要なことですが、これらすべての項目を尊重するようにしてください。

ガイドライン

  1. ページを約5つの例に保つのが最善です。 本当に必要な場合は、ページを長くすることができますが、8つの例を超えることはできません。 ページはすべてをカバーする必要はありません、それは何です 男 です。
  2. 何か疑問がある場合は、常に機能することがわかっている安全な方法を選択してください。 にとって example：必要なコマンド sudo 例に直接含める必要があります。
  3. 1文字のオプションに加えて、スペルアウトされたオプションを含めます。 これにより、ユーザーは自分が何をしているかを理解することができます。
  4. 例では、簡単なオプションから始めて、より複雑なオプションを続けます。
  5. 一般的なUNIXの概念を説明するのではなく、コマンドの特定の詳細にのみ焦点を当ててください。

マークダウン形式

各ページの形式は次のようになります。

# command-name

> Short, snappy description.
> Preferably one line; two are acceptable if necessary.

- Example description:

`command -opt1 -opt2 -arg1 {{arg_value}}`

- Example description:

`command -opt1 -opt2`

上記のフォーマットを強制するフォーマッターがあります。 すべてのプルリクエストで自動的に実行されますが、インストールして、投稿がどのように表示されるかを確認できます。

$ sudo npm install tldr-lint
$ tldrl -f {{page.md}}

あなたはより多くの使用法をチェックすることができますまたは tldrl 次のように入力します。

$ tldr tldrl

トークン構文

つかいます {{トークン}} tldrクライアントがそれらを強調表示できるようにするためのユーザー提供値の構文。 マルチワードトークンは使用する必要があります snake_case。

トークン名を選択するためのガイドライン：

  1. トークン値は短く、説明的である必要があります。 にとって example： {{file_route}} また {{home / user / .bashrc}}
  2. の場合 example 入力変数やパラメータ名などを書き込むよりも、実際の値を使用する方が明確です。実際の値を使用します。 にとって example： つかいます シャットダウン-h {{5}} それよりも シャットダウン-h {{time_in_HHmm}}
  3. ファイルまたはフォルダへのパスへの参照については、次の形式を使用してください {{path / to / <プレースホルダー>}}。 にとって example、 ln -s {{path / to / file}} {{path / to / symlink}}。 ファイルまたはフォルダの両方への参照の可能性がある場合は、 {{path / to / file_or_folder}}
  4. フォローする {{path / to / <プレースホルダー>}} ファイルの場所が暗黙的である場合を除いて、パス関連のコマンドがある場合の規則。
  5. ファイルに特定の拡張子が付いていることを期待するコマンドがある場合は、それを表示します。 例： unrar x {{compressed_file.rar}}。 ジェネリック拡張が必要な​​場合は、 {{.ext}}

これは単なるガイドラインであり、厳密なルールではありません。それらに従い、例を可能な限り直感的にするようにしてください。

プルリクエストの送信

お好みの方法を使用できます。

Githubのウェブインターフェース

最も簡単な方法は、GithubUIから直接ページを編集することです。 あなたは上にいくつかの指示を見ることができます ここ。

コマンドライン

  1. GithubUIからリポジトリをフォークします
  2. フォークをローカルコンピューターに複製する
    https://help.github.com/articles/editing-files-in-another-user-s-repository/
  3. 機能ブランチを作成する
    git checkout -b {{branch_name}}
  4. 変更を加える
  5. 変更をコミットする
     git commit --all -m "{{commit_message}}"</>
  6. フォークにプッシュ
     git push origin {{branch_name}}</>
  7. フォークのgithubページに移動し、緑色のプルリクエストボタンをクリックします。

同じリクエストで関連する変更のみを送信します。

コミットメッセージの場合は、次のコマンドを使用します。

<command>: type of change

例：ls：ページを追加

を参照することもできます 公式リポジトリ その他のドキュメントを検索します。

TLDRの更新

最新の情報を入手できるように、TLDRを最新の状態に保つことが重要です。 継続的にドキュメントが追加されており、次のコマンドを使用して更新できます。

tldr --update

オンラインの使用（Webベース）

Linuxコマンドのドキュメント/ヘルプは、 オンライン版。 開発者は、ドキュメントの検索やLinuxユーティリティ/コマンドのヘルプに使用できるWebURLを持っています。 次のURLにアクセスし、目的のコマンド/ユーティリティ名を入力して、[Enter”、検索されたコマンドのコミュニティドキュメントが表示され、それはかなり目を見張るようなインターフェイスです。

この記事を楽しんでいただければ幸いです。このチュートリアルでは、TLDRコマンドのインストールと使用プロセスについて説明しました。 このユーティリティのオンラインバージョンを使用して、毎日のLinuxコマンドラインの作業生産性を向上させることもできます。 それはあなたに多くの時間を節約し、可能な限り非常に簡単で詳細な方法であなたに非常に必要な情報を提供します。 今日それを試してみてください！ このユーティリティの使用経験については、コメントセクションでお知らせください。


Related Posts