この記事は検証可能な参考文献や出典が全く示されていないか、不十分です。出典を追加して記事の信頼性向上にご協力ください。(このテンプレートの使い方)
出典検索?: "Manページ"
manページ(マンページ)とは、UNIXおよびUnix系オペレーティングシステムの man システムのコンテンツであり、電子化されたドキュメントのこと。各ページは独立した文書として構成されている。ライブラリやシステムコールなどのコンピュータプログラム、標準や慣例、抽象的概念などに関するページがある。man コマンドを実行することでmanページを閲覧することができる。 マニュアル内のあるページを閲覧するには、以下のようなコマンドを使用する。% man [<章番号>] <ページ名>% man [-s <章番号>] <ページ名> シェルのプロンプトで、たとえば "man ftp" と入力する(章番号は通常省略可能)。見やすくするため、ページャとして一般にlessをman内部で用いている。 ページを文章内で指す場合 "ページ名(章番号)" という書き方をする(たとえば、ftp(1)
使い方
多くの man のバージョンでは最近閲覧した数ページのフォーマットされた内容をキャッシュとして保存している。マニュアルファイルのパス設定は環境変数MANPATHにて定義・指定する。このパスの通っていない場所にあるマニュアルは表示されない。また、言語設定が “ja” または “japanese” になっていない場合に、日本語と英語両方のマニュアルが存在する場合は、日本語で表示されない可能性があるので注意が必要。
manコマンドのその他のオプションを知るには、% man man% man 5 man
というコマンドラインを入力・実行する。 ⇒UNIX Programmer's Manual は1971年11月3日に最初に出版された[1]。オンラインのmanページは1971年、ダグ・マキルロイの命令でデニス・リッチーとケン・トンプソンが書いた。後にUNIX System IIIのマニュアルの主執筆者となったTed Dolottaが汎用的なtroff(en:troff
歴史
しかし、各アプリケーションについてひとつのページという形態は複雑で大きなアプリケーションやユーザとやりとりを行うアプリケーションには合わず、グラフィックスなども使えないフォーマット機能も時代遅れになりつつある。アプリケーションが複雑化し、ユーザーが文書がないことに文句を言わないことから、manページシステムは廃れつつあり、後継のシステムが開発されつつある。
基本的には全てのUnix系システムはmanページをサポートし続けているが、多くの場合それ以外のオンライン文書やヘルプを提供している。初期の後継システムのプロジェクトとしては、GNUプロジェクトの "info" システムがあり、これは素朴なハイパーテキストシステムであった。多くのUNIXのGUIアプリケーション(特にGNOMEやKDEの開発環境を使って作られたもの)は、ユーザー向け文書としてHTMLを採用し、yelpなどのHTMLビューアーをアプリケーションに内蔵することが多い。
manページのデフォルトのフォーマットはtroff (en:troff)で あり、troffマクロのman(見た目重視)またはシステムによってはmdoc(意味論重視)を使っている。これによりmanページはPostScriptやPDFに変換でき、様々なフォーマットで表示・印刷可能となっている。
最近のLinuxディストリビューションのmanパッケージには man2html というコマンドがあり、manページをHTMLブラウザで閲覧することも可能である。
2010年、OpenBSDはtroffの代わりにmandoc(英語版)をmanページのフォーマットに採用した。mandocはmanページ専用のコンパイラ/フォーマッタで、PostScript、HTML、XHTML、端末向けの出力を自前で行える。 マニュアルは一般に8つの章に分かれており、以下のように構成されている(BSD系とLinuxでの章立て)。 章内容 UNIX System Vでは章立てが少し異なっている。 章内容 いくつかのシステムではマニュアルに以下のような章もある。 章内容 章は後ろに文字を付与することでさらに分割されている。例えば、3CはCライブラリ、3Mは数学ライブラリなどといった具合である。これに関連して、8章のシステム管理コマンドを 1章の一部として1Mで表すこともある。以下のような文字は章を横断して同じ意味で使われる。 付与文字説明 manページのレイアウトは、単純なテキストとして表示するのに最適化され、何らかの強調やフォント制御も可能ならば行われる。1つのmanページ内の節構成は以下の通りで、常に以下の順序で配置される。 他にも節はあるが、あらゆるマニュアルで共通化されているわけではない。例えば、OPTIONS、EXIT STATUS、ENVIRONMENT、KNOWN BUGS、FILES、AUTHOR、REPORTING BUGS、HISTORY、COPYRIGHTなどがある。 macOSやLinuxでは、manとmdocという2つのgroffマクロのパッケージがmanページ執筆に使える。manの方が古く、UNIXの従来からのフォーマットのmanページを書くことができる。一方mdocは新しく、文書の意味論的構造をよくサポートしている。macOSおよびLinuxでこれらの使い方を知るには、man groff_manおよびman groff_mdocというコマンドを実行すればよい。 あるいは、システム内にある個々のmanページのソースコードを見て真似をすればmanページを書ける。
マニュアルの章立て
1汎用コマンド
2システムコール
3ライブラリ関数、特に標準Cライブラリ関数
4特殊なファイル(主に/devにあるデバイス)とドライバ
5ファイル形式とその使用法
6ゲームとスクリーンセーバー
7その他
8システム管理コマンドとデーモン
1汎用コマンド
1Mシステム管理コマンドとデーモン
2システムコール
3標準Cライブラリ関数
4ファイル形式とその使用法
5その他
6ゲームとスクリーンセーバー
7特殊なファイル(主に/devにあるデバイス)とドライバ
0標準Cライブラリのヘッダファイル
9カーネル ルーチン
nTcl/Tk キーワード
xX Window System
pPOSIX仕様
xX Window System文書
レイアウト
NAME(名前) - コマンドや関数の名前とその機能を一行で説明する文。
SYNOPSIS(書式) - コマンドの場合、コマンド行のオプションを含めた形式定義。関数の場合、定義のあるヘッダファイルの指定とプロトタイプ宣言形式の定義。
DESCRIPTION(説明) - コマンドや関数についての具体的な説明。
EXAMPLES(例) - 使用法の具体例。
SEE ALSO(関連項目) - 関連するコマンドや関数のリスト。
manページの書き方
Size:24 KB
出典: フリー百科事典『ウィキペディア(Wikipedia)』
担当:undef