Linux Tips | |
独自のmanページを作成するには 北浦訓行 |
manコマンドで表示されるドキュメント(manページ)は、テキスト内に制御コマンドを挿入することによってボールドやインデントなどの書式を実現している。
制御コマンドは、使用例を参照すると分かりやすい。Fedora Core 4の場合、デフォルトの日本語manページが/usr/share/man/jaディレクトリ下にあるサブディレクトリ(man1〜man9)にセクション別に格納されている。ファイルはZIP形式で圧縮されているので、例えばmanコマンドのmanページをテキストファイルとして表示するには、zcatコマンドを使う。
$ zcat /usr/share/man/ja/man1/man.1.gz |
Linuxのmanページでは、以下のような制御コマンドがよく使われている。
制御コマンド |
意味 |
.B | 文字をボールド(太字)にする |
.br | 段落と段落の間で改行する |
.I | 文字をイタリックにする(GNOME端末などでは下線付きで表示される) |
.PP | 段落の内部で改行する |
.SH 段落名 | 段落を開始する |
.TH タイトル セクション番号 出自 タイトル | manコマンドの行頭に表示される情報。この行はmanページの先頭に配置する(コメント行は除く) |
.TP 文字数 | 文字数分だけ字下げする。コマンドのmanページでは、オプションパラメータの記述に用いられる |
\- | ハイフンを表示する |
.\" | コメントを記述する。コメントは表示されない |
manページの記述に使用可能なコマンドは、man(7)で詳しく説明されている。man(7)は以下のコマンドで表示可能だ。
$ man 7 man |
Linux Tips Index |
Linux Squareフォーラム Linux Tipsカテゴリ別インデックス |
|
Linux & OSS フォーラム 新着記事
- 【 pidof 】コマンド――コマンド名からプロセスIDを探す (2017/7/27)
本連載は、Linuxのコマンドについて、基本書式からオプション、具体的な実行例までを紹介していきます。今回は、コマンド名からプロセスIDを探す「pidof」コマンドです。 - Linuxの「ジョブコントロール」をマスターしよう (2017/7/21)
今回は、コマンドライン環境でのジョブコントロールを試してみましょう。X環境を持たないサーバ管理やリモート接続時に役立つ操作です - 【 pidstat 】コマンド――プロセスのリソース使用量を表示する (2017/7/21)
本連載は、Linuxのコマンドについて、基本書式からオプション、具体的な実行例までを紹介していきます。今回は、プロセスごとのCPUの使用率やI/Oデバイスの使用状況を表示する「pidstat」コマンドです。 - 【 iostat 】コマンド――I/Oデバイスの使用状況を表示する (2017/7/20)
本連載は、Linuxのコマンドについて、基本書式からオプション、具体的な実行例までを紹介していきます。今回は、I/Oデバイスの使用状況を表示する「iostat」コマンドです。
|
|