(Translated by https://www.hiragana.jp/)
manページ - Wikipedia コンテンツにスキップ

manページ

出典しゅってん: フリー百科ひゃっか事典じてん『ウィキペディア（Wikipedia）』
（Manpageから転送てんそう）
manコマンドのmanページ

manページ（マンページ）とは、UNIXおよびUnix系けいオペレーティングシステムの man システムのコンテンツであり、電子でんし化かされたドキュメントのこと。各かくページは独立どくりつした文書ぶんしょとして構成こうせいされている。ライブラリやシステムコールなどのコンピュータプログラム、標準ひょうじゅんや慣例かんれい、抽象ちゅうしょう的てき概念がいねんなどに関かんするページがある。man コマンドを実行じっこうすることでmanページを閲覧えつらんすることができる。

使つかい方かた

[編集へんしゅう]

マニュアル内ないのあるページを閲覧えつらんするには、以下いかのようなコマンドを使用しようする。 

% man [<章あきら番号ばんごう>] <ページ名めい>
% man [-s <章あきら番号ばんごう>] <ページ名めい>

シェルのプロンプトで、たとえば "man ftp" と入力にゅうりょくする（章あきら番号ばんごうは通常つうじょう省略しょうりゃく可能かのう）。見みやすくするため、ページャとして一般いっぱんにlessをman内部ないぶで用もちいている。

ページを文章ぶんしょう内ないで指さす場合ばあい "ページ名めい（章あきら番号ばんごう）" という書かき方かたをする（たとえば、ftp(1)）。章あきら番号ばんごうは、同おなじ名前なまえのページが複数ふくすうの章しょうに存在そんざいする場合ばあい、特定とくていのページを指定していするために使つかう。これはたとえば、システムコールの名前なまえとコマンドの名前なまえなどが衝突しょうとつする場合ばあいに必要ひつようとなる。たとえば、man(1) と man(7)、exit(2) と exit(3) などがある。

多おおくの 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)マクロを書かき、それをマニュアル向むけに修正しゅうせいしたものを使つかっている。当時とうじ、マニュアルページシステムによる文書ぶんしょのオンライン化かは大おおきな特長とくちょうと考かんがえられていた。今日きょうでは、UNIX上じょうのコマンドライン・アプリケーションには必かならずそのmanページが付属ふぞくしており、逆ぎゃくにmanページがないアプリケーションは品質ひんしつが悪わるいと思おもわれるようになった。実際じっさい、Debianプロジェクトなどでは、未いまだ書かかれていないプログラムのmanページまで作つくっていた。

しかし、各かくアプリケーションについてひとつのページという形態けいたいは複雑ふくざつで大おおきなアプリケーションやユーザとやりとりを行おこなうアプリケーションには合あわず、グラフィックスなども使つかえないフォーマット機能きのうも時代遅じだいおくれになりつつある。アプリケーションが複雑ふくざつ化かし、ユーザーが文書ぶんしょがないことに文句もんくを言いわないことから、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での章しょう立だて）。

章あきら 内容ないよう
1 汎用はんようコマンド
2 システムコール
3 ライブラリ関数かんすう、特とくに標準ひょうじゅんCライブラリ関数かんすう
4 特殊とくしゅなファイル（主おもに/devにあるデバイス）とドライバ
5 ファイル形式けいしきとその使用しよう法ほう
6 ゲームとスクリーンセーバー
7 その他た
8 システム管理かんりコマンドとデーモン

UNIX System Vでは章あきら立だてが少すこし異ことなっている。

章あきら 内容ないよう
1 汎用はんようコマンド
1M システム管理かんりコマンドとデーモン
2 システムコール
3 標準ひょうじゅんCライブラリ関数かんすう
4 ファイル形式けいしきとその使用しよう法ほう
5 その他た
6 ゲームとスクリーンセーバー
7 特殊とくしゅなファイル（主おもに/devにあるデバイス）とドライバ

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

章あきら 内容ないよう
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、HISTORY、COPYRIGHTなどがある。

manページの書かき方かた

[編集へんしゅう]

macOSやLinuxでは、manとmdocという2つのgroffマクロのパッケージがmanページ執筆しっぴつに使つかえる。manの方ほうが古ふるく、UNIXの従来じゅうらいからのフォーマットのmanページを書かくことができる。一方いっぽうmdocは新あたらしく、文書ぶんしょの意味いみ論ろん的てき構造こうぞうをよくサポートしている。macOSおよびLinuxでこれらの使つかい方かたを知しるには、man groff_manおよびman groff_mdocというコマンドを実行じっこうすればよい。

あるいは、システム内ないにある個々ここのmanページのソースコードを見みて真似まねをすればmanページを書かける。macOSとLinuxの場合ばあい、通常つうじょう/usr/share/manにmanページのソースファイルがある。ソースファイルの場所ばしょは、例たとえばコマンド名めいがcommandならばman -w commandを実行じっこうすることで得えられる。

manページはDocBookやLinuxDoc（英語えいご版ばん）フォーマットで書かくこともでき、それをgroffにより変換へんかんすればよい。

manページの変換へんかん

[編集へんしゅう]

オンラインで（manコマンドを使つかって）manページを見みる以外いがいに、manページをPDFに変換へんかんして印刷いんさつすることもできる。macOSとLinuxでは次つぎのように入力にゅうりょくする（commandを適当てきとうなコマンド名めいに置おき換かえること）。 

 groff -mandoc command.1 >command.ps
 gs -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=command.pdf command.ps

1行ぎょう目めでmanページをPostScriptフォーマットでエクスポートし、2行ぎょう目めでPDFに変換へんかんしている。これはmanフォーマットでもmdocフォーマットでも機能きのうする。場合ばあいによっては、等とう幅はばフォントを使つかって印刷いんさつした方ほうが読よみやすい場合ばあいもある。その場合ばあいは上記じょうきのgroffコマンドの-mandocオプションの次つぎに-f Cオプションを追加ついかすればよい。

mandoc（英語えいご版ばん）フォーマッタは各種かくしゅファイルフォーマットで出力しゅつりょくでき、PDFフォーマットも直接ちょくせつサポートしている。 

 mandoc -Tpdf command.1 >command.1.pdf
 mandoc -Tps command.1 >command.1.ps
 mandoc -Txhtml command.1 >command.1.xhtml

脚注きゃくちゅう

[編集へんしゅう]
[脚注きゃくちゅうの使つかい方かた]
  1. ^ “Unix Manual, first edition”. www.bell-labs.com. 2022年ねん5月がつ30日にち閲覧えつらん。

外部がいぶリンク

[編集へんしゅう]
ファイルとファイルシステム管理かんり
プロセス管理かんり
ユーザ管理かんり/環境かんきょう
テキスト処理しょり
シェルビルトイン
通信つうしん
検索けんさく
マニュアル
ソフトウェア開発かいはつ
その他た

この記事きじは2008年ねん11月1日にち以前いぜんにFree On-line Dictionary of Computingから取得しゅとくした項目こうもくの資料しりょうを元もとに、GFDL バージョン1.3以降いこうの「RELICENSING」(再さいライセンス) 条件じょうけんに基もとづいて組くみ込こまれている。

「https://ja.wikipedia.org/w/index.php?title=Manページ&oldid=98174246」から取得しゅとく