Linuxコマンドの使い方を調べる場合、インターネットで検索したり、Linuxのmanコマンドでマニュアルページ(manコマンド)を読んで使い方を調べている方をよく目にします。しかしインターネットで調べた方法は、探している情報がシンプルに説明されていなかったり、manコマンドでマニュアルページを見ても長くて全部読んでいる方は少ないと思います。とにかく目的を達成するために、サクッと使い方を調べたいという場合に使える方法を説明します。
非常にありがたいことに、「TL;DR」というソフトウェアが存在し、tldrというコマンドを使うと非常に簡単に実践に即したLinuxコマンドの使い方を調べることが出来ます。「TL;DR」は、有志が集まるコミュニティで蓄積された膨大な情報を集めたパッケージです。「TL;DR」というのは「”Too Long; Didn’t Read”」という言葉の頭文字を取ったもので、「長すぎて読まなかった」という意味です。つまりLinuxのマニュアルページの説明が長すぎて読まなかったという意味で、それをシンプルに読めるようにしたというのが「TL;DR」というソフトウェアの目的です。「TL;DR」パッケージを使うためのコマンド名は「tldr」となっています。
では早速「TL;DR」を使ってコマンドをサクッと調べる方法を見ていきましょう。
TL;DRパッケージをインストールする
Ubuntuを使っている方であれば、以下のようにして「TL;DR」コマンドをインストールすることが出来ます。
$ sudo apt-get install tldr
MacOSでは次のようにしてインストールすることが出来ます。
brew install tlrc
これで「tldr」というコマンドが使えるようになります。
tldrコマンドの使い方
では早速tldrコマンドの使い方を見てみましょう。Linuxのtarコマンドの使い方を調べるには、次のように「tldr tar」コマンドを実行します。「tldr」コマンドの後に、調べたいLinuxコマンドを入力します。すると次のようにtarコマンドの様々な使い方が表示されます。
$ tldr tar
Archiving utility.
Often combined with a compression method, such as `gzip` or `bzip2`.
More information: <https://www.gnu.org/software/tar>.
[c]reate an archive and write it to a [f]ile:
tar cf path/to/target.tar path/to/file1 path/to/file2 ...
[c]reate a g[z]ipped archive and write it to a [f]ile:
tar czf path/to/target.tar.gz path/to/file1 path/to/file2 ...
[c]reate a g[z]ipped (compressed) archive from a directory using relative paths:
tar czf path/to/target.tar.gz --directory=path/to/directory .
E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:
tar xvf path/to/source.tar[.gz|.bz2|.xz]
E[x]tract a (compressed) archive [f]ile into the target directory:
tar xf path/to/source.tar[.gz|.bz2|.xz] --directory=path/to/directory
[c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program:
tar caf path/to/target.tar.xz path/to/file1 path/to/file2 ...
Lis[t] the contents of a tar [f]ile [v]erbosely:
tar tvf path/to/source.tar
E[x]tract files matching a pattern from an archive [f]ile:
tar xf path/to/source.tar --wildcards "*.html"
tldrコマンドの結果を日本語表示に変更する
デフォルトでは英語でLinuxコマンドの使い方が表示されますので、日本語で表示するようにするには次のように「-L ja」オプションで日本語で表示されるようにします。すると次のように日本語でコマンドの使い方が表示されるようになります。
$ tldr -L ja tar
アーカイブ(複数のファイルやフォルダを 1 つのファイルに纏める)の為のユーティリティー。
gzip や bzip2 などの圧縮方法と組み合わせることが多いです。
詳しくはこちら: <https://www.gnu.org/software/tar>
アーカイブを作成し、それをファイルに書き込む:
tar cf 出力ファイル名.tar ファイル1 ファイル2 ...
gzip 形式で圧縮されたアーカイブを作成し、それをファイルに書き込む:
tar czf 出力ファイル名.tar.gz ファイル1 ファイル2 ...
相対パスを用いてディレクトリから gzip 形式のアーカイブを作成する:
tar czf 出力ファイル名.tar.gz --directory=ディレクトリへの相対パス .
(圧縮された)アーカイブファイルを、カレントディレクトリに過程を詳細表示しながら展開する:
tar xvf 入力ファイル名.tar[.gz|.bz2|.xz]
(圧縮された)アーカイブファイルを、指定のディレクトリに展開する:
tar xf 入力ファイル名.tar[.gz|.bz2|.xz] --directory=ディレクトリ
圧縮されたアーカイブを作成し、それにファイルを書き込む。なお、接尾辞で圧縮プログラムを指定する:
tar caf 出力ファイル名.tar.xz ファイル1 ファイル2 ...
tar ファイルの内容を詳細に表示する:
tar tvf 入力ファイル名.tar
アーカイブファイルからパターンに合致するファイルを抽出する:
tar xf 入力ファイル名.tar --wildcards "*.html"
tldrコマンドでサポートされているコマンドを調べる
tldrコマンドでサポートされているLinuxコマンド一覧は次のように見ることが出来ます。かなり多くのLinuxコマンドがサポートされています。
$ tldr --list
!
$
%
2to3
7z
7za
7zr
[
[[
^
a2disconf
a2dismod
a2dissite
a2enconf
a2enmod
a2ensite
a2ping
a2query
aa-complain
aa-disable
aa-enforce
aa-status
aapt
ab
abbr
abduco
(一部省略)
zrun
zsh
zstd
zstdcat
zstdless
zstdmt
zsteg
zypper
{
~
Linux/MacOS/Windows固有のコマンドの使い方を調べる方法
tldrコマンドを使うと、OS固有のコマンドの使い方も調べることが出来ます。例えばMacOSのbrewコマンドの使い方を調べるには、tldrコマンドのオプションに「-p osx」と入力し、調べたいコマンドを入力します。
$ tldr -p osx brew
Homebrew - a package manager for macOS and Linux.
Some subcommands such as `install` have their own usage documentation.
More information: <https://docs.brew.sh/Manpage>.
Install the latest stable version of a formula or cask (use `--devel` for development versions):
brew install formula
List all installed formulae and casks:
brew list
Upgrade an installed formula or cask (if none is given, all installed formulae/casks are upgraded):
brew upgrade formula
Fetch the newest version of Homebrew and of all formulae and casks from the Homebrew source repository:
brew update
Show formulae and casks that have a more recent version available:
brew outdated
Search for available formulae (i.e. packages) and casks (i.e. native macOS `.app` packages):
brew search text
Display information about a formula or a cask (version, installation path, dependencies, etc.):
brew info formula
Check the local Homebrew installation for potential problems:
brew doctor
Windowsの「ipconfig」コマンドの使い方を調べたい場合には、「-p windows」オプションを付けてコマンドを実行します。
$ tldr -p windows ipconfig
Display and manage the network configuration of Windows.
More information: <https://learn.microsoft.com/windows-server/administration/windows-commands/ipconfig>.
List all network adapters:
ipconfig
Show a detailed list of network adapters:
ipconfig /all
Renew the IP addresses for a network adapter:
ipconfig /renew adapter
Free up the IP addresses for a network adapter:
ipconfig /release adapter
Show the local DNS cache:
ipconfig /displaydns
Remove all data from the local DNS cache:
ipconfig /flushdns
このようにして、各OS固有のコマンドの使い方も非常に簡単に調べることが出来ます。
tldrコマンドのデータを最新化する
TL;DRの情報は常に更新され続けていますので、最新データを使えるようにしましょう。データを最新化するには、次のように「tldr –update」コマンドを実行しましょう。
$ tldr --update
Successfully updated cache.
これによってローカルのキャッシュデータが最新化されます。
TL;DRパッケージをインストールせずに使う
TD;DRパッケージをインストールしなくても、ブラウザでTL;DRを利用することが出来ます。下記URLにアクセスしてみましょう。
すると次のようなページが開きますので、「Search」ボックスに調べたいLinuxコマンドを入力してエンターキーを押します。
例えばtarコマンドの使い方を調べてみると、次のように結果が表示されます。結果は全て英語で表示されますが、様々な状況に応じたtarコマンドの使い方が表示されます。わざわざLinuxのmanページを読まなくても、とても簡単にコマンドの使い方を調べることが出来て時短に繋がります。
こちらの結果もデフォルトでは英語で表示されますので、日本語に変更するには検索ボックスの右側の歯車ボタンを押してオプションを表示して日本語を追加します。「English」と書かれている場所をクリックすると言語選択が表示されますので、この中から「日本語」を選択しましょう。
そしてtarコマンドの使い方を検索すると、今度は以下のように日本語で結果が表示されるようになります。
まとめ
TL;DRパッケージのtldrコマンドを使うと、すぐにLinuxコマンドの様々な使い方が表示されます。毎回インターネットで調べたり、Linuxのmanページを読むよりも素早く使い方を把握でき、解決したことをすぐに調べることが出来ます。紹介したようにWebブラウザでも調べることが出来ますので、TL;DRを活用してみましょう。