組み込み組合ぺんぺん草

technical notes...だったらいいな

コマンド「tldr」

Twitter経由にて、manの簡易版tldr(Too Long; Didn't Read)を知りました。

github.com

また、以下が参考になります。

man は長すぎるので「tldr」

 

頻繁に使用するコマンドはさておき、たまにしか使用しないコマンドやオプションについて、よくmanを引きます。しかしこれがまた丁寧に解説しているので長い。そして具体性に欠けるため、結局はGoogle先生のお世話になることがあります。

例えば、あるユーザの所属するグループを追加したい時、usermodコマンドに-aGオプションを使用します。あるあるなミスとしては、-a オプションを忘れて所属グループを上書きしてしまう!といったものでしょうか(gpasswdを使えって?)。

流石に一度やってしまえば次回の時には「やらかした記憶」があるので、全く同じことはしませんが、さてどうやれば正解だ?というところまでは覚えていないことが往々にしてあります。

その度にGoogle先生にお世話になるのはあまりエレガントではない。そんな時にtldrです。tldrでは、トリッキーなオプションまでは網羅していませんが、よくはまるオプションについては親切です。また、オプションのオプションが大事なコマンドについても、gitやsvn程度であれば既に対応済みです。助かるー!

% tldr git commit

 

 git commit

Commit staged files to the repository

 

 Commit staged files to the repository with comment

   git commit -m MESSAGE

 

 Replace the last commit with currently staged changes

   git commit --amend

 

とはいえ、まだまだ説明を追加する余地はあります。今気づいたのですが、usermod、gpasswdは本記事作成時点では未対応でした。上記プロジェクトでは、Contributionを募っています。各説明文自体はMarkdown記法で記載されているので、気軽に参加できます。私も時々使うけれども未対応のものについて、参加してみようかな。