tldr-pagesプロジェクトは、コミュニティによって管理されているコマンドライン ツール用のヘルプ ページのコレクションであり、従来のマニュアル ページをよりシンプルで親しみやすいものに補完することを目的としています。
もしかしたら、あなたはコマンドラインの世界に慣れていないかもしれません。おそらくあなたは少し慣れていないだけで、 lsof
やtar
などのコマンドの引数を常に思い出せていないのではないでしょうか?
過去にman tar
で説明されていた最初のオプションが次のようなものだったということは確かに役に立ちません。
$ man tar
...
-b blocksize
Specify the block size, in 512-byte records, for tape drive I/O.
As a rule, this argument is only needed when reading from or writing to tape drives,
and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...
実用的な例に焦点を当てた、よりシンプルなヘルプ ページの余地があります。どうでしょうか:
このリポジトリはまさにそのようなものです。最も一般的な UNIX、Linux、macOS、FreeBSD、NetBSD、OpenBSD、SunOS、Android、および Windows コマンド ライン ツールのサンプルのコレクションが増え続けています。
ヒント
コンピューターにクライアントをインストールせずに閲覧するには、https://tldr.inbrowser.app の Web クライアントを参照してください (PWA を使用したオフライン サポートあり)。
コンピューター上でこれらのページにアクセスする一般的で便利な方法は、公式の Node.js クライアントをインストールすることです。
npm install -g tldr
あるいは、pip3 (または他のパッケージ マネージャー) 経由でインストールできる公式 Python クライアントを使用することもできます。
pip3 install tldr
Linux および Mac ユーザーは、Homebrew (または他のオペレーティング システム上の他のパッケージ マネージャー) を使用して公式 Rust クライアントをインストールすることもできます。
brew install tlrc
これにより、標準のman tar
の代わりにtldr tar
と入力してアクセスできる、 tar
などのコマンドの簡略化された読みやすいヘルプに直接アクセスできるようになります。
ソフトウェアをインストールしたくない場合は、代わりに PDF バージョンをチェックしてください。
注記
翻訳用の PDF はほとんどの言語で利用できます。これらは、最新リリースのリリース アセットで見つけることができます。
コマンドラインと他のプラットフォームの両方に対して、コミュニティによって提供される他のさまざまなクライアントもあります。クライアントの包括的なリストについては、Wiki をご覧ください。
すべての貢献を歓迎します!
貢献するには次のような方法があります。
すべてのtldr
ページは Markdown で記述されているため、非常に簡単に編集でき、コマンドラインで Git を使用するか、GitHub Web インターフェイスを使用してプル リクエストで変更を送信できます。
私たちは、歓迎的で協力的なコミュニティを維持するよう努めています。初めて貢献する場合は、貢献ガイドラインを読んで、先に進んでください。
翻訳に貢献したい場合は、https://lukwebsforge.github.io/tldri18n/ にアクセスして、すべての翻訳の全体的な進捗状況と、どの翻訳が欠落しているか古いかを確認できます。
マトリックス チャットルームにもぜひご参加ください。
コマンド ライン インターフェイス ページを使用すると、CLI、ディレクトリ、および構成用の標準化されたヘルプ ページを作成できます。
Cheat を使用すると、コマンドラインで対話型のチートシートを作成および表示できます。これは、Unix システム管理者が頻繁に使用するものの、覚えておくほど頻繁ではないコマンドのオプションを思い出させるのに役立つように設計されました。
cheat.sh 複数のソース (tldr ページを含む) からのチート シートを 1 つの統一インターフェイスに集約します。
devhints Rico のチートシートはコマンドラインに焦点を当てているだけではなく、プログラミングに関連する他のチートシートも多数含まれています。
たとえば、コマンドラインでの説明付きの詳細な例が提供されます。例はリポジトリから取得されますが、 eg
カスタムの例とコマンドをデフォルトと並べて表示することをサポートしています。
kb は、最小限のコマンドライン ナレッジ ベース マネージャーです。 kb を使用すると、メモやチートシートを最小限かつクリーンな方法で整理できます。テキスト以外のファイルもサポートします。
navi は対話型のチートシート ツールで、特定の例を参照したり、その場でコマンドを完了したりできます。
bropages (非推奨) は、man ページの可読性の高い補足です。 Unix コマンドの一般的な例を簡潔に示します。例はユーザーベースによって提出され、賛成または反対の投票が可能です。最良のエントリは、ユーザーがコマンドを検索するときに最初に目にするものです。
TL;DR は「長すぎる、読んでいない」の略です。これはインターネット スラングとして起源があり、長いテキスト (またはその一部) が長すぎるとしてスキップされたことを示すために使用されます。詳細については、How-To Geek の記事をご覧ください。