UNIXマニュアル

Article on other languages:

del.icio.us del.icio.us
Digg Digg
Furl Furl
Reddit Reddit
Rojo Rojo
Add to OnlyWire
manコマンドのmanページ

UNIXマニュアル(ゆにっくすマニュアル)とは、全てのUNIXオペレーティングシステムmanページUNIXマニュアルのページ)として知られる大量の電子化されたドキュメントのこと。各ページは独立した文書として構成されている。

目次

解説

マニュアル内のあるページを閲覧するには、以下のようなコマンドを使用する(Linuxシステムなどでの先頭は“$”)。

% man [<章番号>] <ページ名>
% man [-s <章番号>] <ページ名>

シェルのプロンプトで、たとえば“% man ftp”と入力する(章番号は通常省略可能)。ページを文章内で指す場合 “ページ名(章番号)" という書き方をする(たとえば、ftp(1))。

章番号は、同じ名前のページが複数の章に存在する場合、特定のページを指定するために使う。これはたとえば、システムコールの名前とコマンドの名前などが衝突する場合に必要となる。たとえば、man(1)man(7)exit(1)exit(3) などがある。

UNIX Programmer's Manual1971年11月3日に最初に出版された。しかし、オンラインの man ページが利用可能となったのは1979年の 7th Edition のリリース時である。当時、マニュアルページシステムによる文書のオンライン化は大きな特長と考えられていた。今日では、UNIX上のコマンド行アプリケーションには必ずその man ページが付属しており、逆に man ページがないアプリケーションは品質が悪いと思われるようになった。実際、Debian プロジェクトなどでは、未だ書かれていないプログラムの man ページまで作っていた。

しかし、各アプリケーションについてひとつのページという形態は複雑で大きなアプリケーションやユーザとやりとりを行うアプリケーションには合わず、グラフィックスなども使えないフォーマット機能も時代遅れになりつつある。アプリケーションが複雑化し、ユーザーが文書がないことに文句を言わないことから、manページシステムは廃れつつあり、後継のシステムが開発されつつある。

基本的には全てのUNIX系システムはmanページをサポートし続けているが、多くの場合それ以外のオンライン文書やヘルプを提供している。初期の後継システムのプロジェクトとしては、GNUプロジェクトの "info" システムがあり、これは素朴なハイパーテキストシステムであった。多くのUNIXのGUIアプリケーション(特にGNOMEKDEの開発環境を使って作られたもの)は、ユーザー向け文書としてHTMLを採用し、HTMLビューアーをアプリケーションに内蔵することが多い。

マニュアルページはnroffのソースファイルとして格納されている。多くの man のバージョンでは最近閲覧した数ページのフォーマットされた内容をキャッシュとして保存している。マニュアルファイルのパス設定は環境変数MANPATHにて定義・指定する。このパスの通っていない場所にあるマニュアルは表示されない。また、言語設定が“ja”または“japanese”になっていない場合、日本語と英語両方のマニュアルが存在する場合に、日本語でされない可能性があるので注意が必要。

manコマンドのその他のオプションを知るには、

% man man
% man 5 man

というコマンドラインを入力・実行することで表示される。

マニュアルの章立て

マニュアルは一般に 8つの章に分かれており、以下のように構成されている(BSD系とLinuxでの章立て)。

内容
1 汎用コマンド
2 システムコール
3 Cライブラリ 関数
4 特殊なファイル(主に /dev にあるデバイス)
5 ファイル形式とその使用法
6 ゲーム
7 その他
8 システム管理コマンドとデーモン

UNIX System Vでは章番号は少し異なっている。4章がファイル形式、5章がその他、7章が特殊なファイル、となっている。

いくつかのシステムでは以下のような章のマニュアルもある。

内容
0 標準Cライブラリヘッダファイル
9 カーネル ルーチン
n Tcl/Tk キーワード
x X Window System

章は後ろに文字を付与することでさらに分割されている。例えば、3C は Cライブラリ、3M は数学ライブラリなどといった具合である。これに関連して、8章のシステム管理コマンドを 1章の一部として 1M で表すこともある。以下のような文字は章を横断して同じ意味で使われる。

付与文字 説明
p POSIX 仕様
x X Window System 文書

レイアウト

manページのレイアウトは、単純なテキストとして表示するのに最適化され、何らかの強調やフォント制御も可能ならば行われる。1つの man ページ内の節構成は以下の通りで、常に以下の順序で配置される。

  • NAME(名前) - コマンドや関数の名前とその機能を一行で説明する文。
  • SYNOPSIS(書式) - コマンドの場合、コマンド行のオプションを含めた形式定義。関数の場合、定義のあるヘッダファイルの指定とプロトタイプ宣言形式の定義。
  • DESCRIPTION(説明) - コマンドや関数についての具体的な説明。
  • EXAMPLES(例) - 使用法の具体例。
  • SEE ALSO(関連項目) - 関連するコマンドや関数のリスト。

他にも節はあるが、あらゆるマニュアルで共通化されているわけではない。例えば、OPTIONS、EXIT STATUS、ENVIRONMENT、KNOWN BUGS、FILES、AUTHOR、REPORTING BUGS、COPYRIGHT などがある。

外部リンク

日本語:

英語:

This article is from Wikipedia. All text is available under the terms of the GNU Free Documentation License.


Giant Panda

Mercedes Car
James Bond Guide
This site monitored by SitePinger.net