Infra Engineer

マニュアル
2022.10.31
Lv1

マニュアル

 この記事を読んでほしいひと

LPIC level1習得を目ざす、初学者のかたへ。
コマンドの基本的な使い方について、解説をします。


今回の内容

今回は、コマンドのマニュアルについて解説します。
コマンドの使い方を調べる方法として、–helpオプションを指定する方法や、manコマンドを使用した方法があります。manコマンドは–helpオプションより詳細であり、各コマンドを理解するためには必須のコマンドとなります。それでは解説をはじめていきましょう。

・manコマンド
・セクション
・まとめ
・確認問題

manコマンド

manコマンドとは、マニュアルページ(manページ)を表示するコマンドです。マニュアルページにはコマンドだけでなく、設定ファイルなども含まれています。

manコマンドの書式
 man  <オプション>  <セクション>  <コマンド名またはキーワード>

manコマンドで用いられる主なオプションには以下のものがあります。セクションについては後述します。

オプション 意味
-f キーワード(完全一致)を含むドキュメントを表示する。
-k キーワード(部分一致)を含むドキュメントを表示する。

それでは実際にmanコマンドを使用してみましょう。初学者がよく使うコマンドにcatコマンドがありますが、catコマンドのマニュアルを参照してみましょう。

[root@localhost Documents]# man cat

NAME(名前)にはコマンドの名前と簡単な説明が書かれてあり、SYNOPSIS(書式)にはオプションや引数などの書式が書かれてあります。マニュアルページによると、catコマンドは「ファイルを連結して標準出力に表示する」とあります。なので私たちが普段「cat sak1.txt」と表示していたのはファイルを連結せずに標準出力に表示していたとわかりますね。そして「cat sak1.txt sak2.txt」というような使い方ができることが学べます。そして「マニュアルページには標準出力に表示するとあるから、リダイレクトを使えば1つのファイルにまとめることができるのか」と発想することもできます。

[root@localhost Documents]# cat sak1.txt
hoge
[root@localhost Documents]# cat sak1.txt sak2.txt
hoge
fuga
[root@localhost Documents]# cat sak1.txt sak2.txt > sak3.txt
[root@localhost Documents]# cat sak3.txt
hoge
fuga
見出し 説明
NAME(名前) コマンドの名前と簡単な説明
SYNOPSIS(書式) 書式(オプションや引数)
DESCRIPTION(説明) コマンドの詳細な説明
OPTION(オプション) 利用可能なオプションの説明
EXAMPLE(例) 具体例
SEE ALSO(関連項目) 関連項目
AUTHOR(著者) プログラム、ドキュメントの著者

セクション

catコマンドのマニュアルを表示したさいに、マニュアルの冒頭にCAT(1)と表記されていました。この数字はマニュアルのセクション番号を表わしています。セクションとはドキュメントを内容によって分類したもので、次のように分類されます。

セクション 説明
1 コマンド
2 システムコール
3 ライブラリ関数
4 デバイスファイル
5 設定ファイル
6 ゲーム
7 その他
8 システム管理コマンド
9 カーネルルーチン

このセクションを使うことで、次のような問題が解決します。たとえば/etc/passwdファイルについて調べたい場合、「man passwd」と入力するとpasswdコマンドのマニュアルが表示されてしまいます。/etc/passwdはセクション5に属している一方、passwdコマンドのマニュアルはセクション1に属しているため、セクションが早いpasswdコマンドのマニュアルが表示されました。そこでセクションに5と指定すると/etc/passwdのマニュアルが表示されます。。
セクションによって区別するために、passwd(1)やpasswd(5)のような形で表すのが一般的です。passwd(1)ならばpasswdコマンドを表わし、passwd(5)ならば/etc/passwdを表わしています。


まとめ

今回は、コマンドのマニュアルについて解説しました。新たにコマンドを学ぶさいは、コマンドのマニュアルを確認するようにすると知識が定着しやすくまた正確な知識が身につけられますね。
最後に確認問題で、今回の記事の知識を復習してみましょう。


確認問題

問題

manの第1セクションのマニュアルを表示するコマンドとして適切なものはどれか?
①man 1 man ②man -section 1 man ③man -s 1 man ④man -k man

解答
答え:①