\r\n\r\n

linuxとmacosでマニュアルのページを読みやすい説明に短縮する方法

macosにもlinuxにも、ターミナルコマンドのマニュアル的な解釈を表示する便利なコマンド「man」があります。長文になりがちなので、tldrツールで読みやすい長さに短縮してはどうでしょうか...。

LinuxやMacのコマンドラインユーザーは、"man "とタイプしてからコマンド名を入力すると、そのコマンドの詳細な説明を見ることができることを知っています。これらのマニュアルページは便利ですが、長文になります。時には、記憶を呼び覚ますために、コマンドの簡単な説明だけが必要なこともあります。

ここでは、LinuxやMacのコマンドラインで使用するコマンドを簡潔かつ実用的に解説しています。tldr」というコマンドラインアプリケーションで、「too long; not readable」の略称である。長すぎて読めない、DRという略語を使って文章を書いたり、略語を依頼する、それがTLDRコマンドです。

ubuntuにtldrをインストールする

Ubuntuのtldrコマンドはどのリポジトリにもないので、インストールするのは少し遠回りですが、それほど難しいことではありません。

まず、NodeJSとnodeパッケージマネージャ(nodepackagemanager、npm)をインストールする必要があります。Ctrl+Alt+Tキーを押してターミナルを開き、以下のコマンドを入力します。

sudo apt install nodejs npm

次に、npmを使用してtldrをインストールします。

sudo npm install -g tldr

これでtldrが使えるようになるはずですが、試行錯誤していると「No such file or directory」というエラーが表示されることがあります。

以下のコマンドを入力してシンボリックリンクを作成することで、このエラーを修正することができます。

sudo ln -s /usr/bin/nodejs /usr/bin/node

macosへのtldrのインストール

macOSでは、Homebrew(macOSのパッケージマネージャ)を使ってtldrをインストールします。Homebrewを使えば、どんなコマンドラインユーティリティも数回のキー操作でインストールすることができます。homebrewにCaskを追加することで、FirefoxやGIMPなどのデスクトップアプリケーションもインストールできます。コマンドラインユーティリティやデスクトップアプリケーションは、homebrewとCaskを使って簡単に更新することができます。

デフォルトではhomebrewはインストールされていません。homebrewのサイトに行って、そこからインストールコマンドをコピーしてください。

自作ソフトをインストールするには、アプリケーションフォルダ内のユーティリティフォルダから「Terminal」を開いてください。コマンドラインプロンプトで右クリックし、「貼り付け」を選択して、コピーしたhomebrewインストールコマンドを入力します。Enterキーを押しながら、表示される指示に従ってください。

自作ソフトのインストール後、以下のコマンドを入力して、tldrコマンドをインストールしてください。

brew install tldr

これで、tldrコマンドで簡単な説明ができるようになりました。

tldrを使ったコマンドの使い方を短時間で習得できる

ここでは、lsコマンドを使って、manとtldrの使い分けを説明します。スクリーンショットはLinuxのものですが、macOSでも利用可能です。

プロンプトで次のコマンドを入力します。

man ls

lsコマンドの詳細な説明が記載されています。lsコマンドのマニュアルページを移動するには、矢印キーとページアップ、ページダウンキーを使用します。

ここで、以下のコマンドを入力します。

tldr ls

lsコマンドの最も一般的な使用方法について、簡単な説明があります。なお、少なくともスクロールして結果を見る必要はあまりありません。端末のウィンドウを少し大きくして、すべての結果が一度に表示されるようにしています。

ウェブ版tldrを使用する

tldrをインストールしたくない、またはtldrのインストールに問題がある場合は、以下のtldrユーティリティの良いウェブバージョンがあります。https://tldr.ostera.io/。ウェブサイトの使い方の簡単な説明も記載されています。また、すでにブラウザーを使っていて、ターミナルウィンドウを開かずに素早くコマンドを探したい場合にも便利です。

例えば、ページ上部の検索ボックスに「ls」と入力します。結果はすぐに表示されます。コマンドラインでtldrコマンドを実行した結果よりも、こちらの方が読みやすいと感じるかもしれません。

また、各コマンドのページ下部には、Edit this page on Githubというリンクが用意されており、万が一、エラーが発生しても安心です。

また、TLDR Pagesのウェブサイト上でも注文を作成・編集することができます。

オフラインのコピーが必要ですか?後で使用するために、tldrページのPDF版をダウンロードする。Android [no longer available]またはiOSデバイスにtldrアプリをインストールすることも可能です。

まだまだ使えるパンフレットページ

tldrコマンドは、コマンドの基本を学ぶのに非常に便利です。しかし、いくつかのコマンドパラメータが省かれているため、有用と思われるものもあります。そのため、tldrのページでコマンドが見つからない場合は、(コマンドがある場合は)マニュアルのページを確認してください。

例えば、lsコマンドのtldrページでは、以下の有用なパラメータが省略されており、大文字と小文字が区別されます。

  • -R: サブディレクトリの一覧を再帰的に表示します。
  • -X:ファイル拡張子のアルファベット順でソートされます。
  • -d: 目次だけをリストアップし、目次の内容をリストアップしない。

もう一つの例は、ファイルやディレクトリを削除するrmコマンドです。あるパラメータを指定すると、指定したディレクトリの内容を丸ごと消去することができます。このコマンドは、間違って使用すると重要なシステムファイルを削除してしまう可能性がありますので、注意して使用してください。

  • -I: 3つ以上のファイルを削除する前、または再帰的にファイルを削除するときに一度だけプロンプトが表示されます。このパラメータは -i よりも侵襲性が低いですが、削除したくないファイルを誤って削除してしまうことを防げます。
  • -d:空のディレクトリを削除します。

rmコマンドのtldrページには、ディレクトリとそのサブディレクトリを再帰的に削除するための-r引数が記載されていますが、rmがデフォルトで空でないディレクトリを削除しないことについては説明されていません。空でないディレクトリを再帰的に削除するには、-r または -r を使用する必要があります。

tldrコマンドで時間短縮

tldrコマンドは、bashshellコマンドの短い説明と実用的な例で説明されています。cdコマンドのような、もはやmanの項目として利用できない組み込みコマンドの簡単な説明もあります。

bashshellで利用可能なすべての組み込みコマンドは、コマンドラインで次のコマンドを入力することで見つけることができます。

man bash-builtins

また、自動提案、VGAカラー、PythonやRubyといった現代のプログラミング言語にヒントを得たスクリプト言語などの追加機能を持つfishshellも試してみてはいかがでしょうか?

tldrの説明の方がわかりやすいですか?それとも、マニュアルページでの詳細な解説がお好みですか?あなたの感想や経験を、ぜひ下のコメント欄で教えてください。

  • 2021-03-14 01:21 に公開
  • 閲覧 ( 23 )
  • 分類:IT

あなたが興味を持っているかもしれない記事

匿名者
匿名者

0 件の投稿

作家リスト

  1. admin 0 投稿
  2. 匿名者 0 投稿

おすすめ