マニュアルページ

マニュアルページ( man pageの略) は、 UnixおよびUnix 系オペレーティング システムにあるソフトウェア ドキュメントの形式です。扱われるトピックには、プログラム、システム ライブラリ、システム コール、および場合によってはローカル システムの詳細が含まれます。ローカル ホストの管理者は、特定のホストに関連付けられたマニュアル ページを作成してインストールできます。エンド ユーザーは、コマンドに続いて必要な特定の詳細を発行することで、ドキュメント ページを呼び出すことができます。これらのマニュアル ページは通常、リアルタイムで作業するエンド ユーザー、プログラマー、および管理者によって要求されますが、印刷用にフォーマットすることもできます。 man

デフォルトでは、manマクロを使用した nroff などの書式設定プログラムと、またはなどの端末ページャプログラムを使用してmore、lessその出力をユーザーの画面に表示します。

マニュアルページは、インターネットアクセスを必要としないコマンドであるにもかかわらず、ソフトウェアドキュメントのオンライン形式と呼ばれることがよくあります^[1]man。環境変数 MANPATH は、さまざまなドキュメントページを検索するためのディレクトリパスのリストを指定することがよくあります。マニュアルページの歴史は、印刷されたドキュメントが標準であった時代にまで遡ります。

Unix 以前 ( GCOSなど) では、ドキュメントは印刷されたページで、ユーザー (スタッフ、学生など) が施設内で利用でき、スチール製のバインダーにまとめられ、1 つのモノリシックなスチール製の読書ラックにまとめてロックされ、テーブルやカウンターにボルトで固定され、ページはモジュール情報の更新、置き換え、正誤表、および補遺用に整理されていました。^{[引用が必要]}

Unix の歴史の最初の 2 年間は、ドキュメントは存在しなかった。^[2] Unix Programmer's Manual は1971 年 11 月 3 日に初めて出版された。最初の実際の man ページは、 1971 年にマネージャのDoug McIlroyの強い要望により、Dennis RitchieとKen Thompsonによって書かれた^[要出典]。man ページとは別に、Programmer's Manual には一連の短い論文も蓄積されており、その中にはチュートリアル(Unix の一般的な使用方法、Cプログラミング言語、Yaccなどのツールなど) や、オペレーティングシステムの機能のより詳細な説明などがあった。マニュアルの印刷版は当初 1 冊のバインダーに収まっていたが、 PWB/UNIXおよびResearch Unixの第 7 版の時点で2 巻に分割され、印刷された man ページが第 1 巻となった。^[3]

ドキュメントの後のバージョンは、最初のマニュアルページの簡潔さを模倣しました。リッチーは第3版の序文に「始め方」のセクションを追加し、ロリンダ・チェリーは第6版と第7版に「パープルカード」ポケットリファレンスを提供しました。^[2]ソフトウェアのバージョンはマニュアルの改訂版にちなんで名付けられました。たとえば、Unixプログラマーズマニュアルの第7版は、Unixの第7版またはバージョン7に付属していました。 ^[4]

第4版では、マニュアル ページはtroff タイプセッティング パッケージ^[2]とそのマクロ セット(マニュアル-manの第 6 版と第 7 版の間で完全に改訂されましたが^[3]、それ以降は大幅に変更されていません) を使用してフォーマットされました。当時、マニュアル ページ システムを通じてオンライン ドキュメントを利用できることは大きな進歩と見なされていました。今日でも、事実上すべての Unix コマンドライン アプリケーションにはマニュアル ページが付属しており、多くの Unix ユーザーは、プログラムにマニュアル ページがないことを低品質または不完全さの兆候と認識しています。実際、Debianなどの一部のプロジェクトでは、マニュアル ページがないプログラムのためにわざわざマニュアル ページを作成しています。4.4BSD の最近の後継システムも、システム ドキュメントの主要な形式の 1 つとしてマニュアル ページを配布しています (古いマクロを新しい に置き換えています)。 -man-mdoc

manコマンドのman-db版には隠されたイースターエッグがあり、00:30に実行するとコマンドが「gimme gimme gimme」を返す（ ABBAの曲「Gimme! Gimme! Gimme! (A Man After Midnight)」への言及）。これは2011年に導入されたが^[5]、最初は制限され^[6] 、最終的に発見されて2017年に削除された^{[7] 。 [8]}

マニュアル ページのデフォルトの形式はtroffで、マクロ パッケージman (外観重視) または mdoc (意味重視) のいずれかを使用します。これにより、マニュアル ページをPostScript、PDF、およびその他のさまざまな形式でタイプセットして表示または印刷 できるようになります。

一部のUnixシステムにはman2htmlコマンドのパッケージがあり、これを使用すると HTML ブラウザを使用してマニュアル ページを参照できます。groff と man-db を備えたシステムでは、代わりに高品質のネイティブ HTML 出力 ( man --html ) を使用する必要があります。GNU EmacsプログラムWoMan ("WithOut man" から) を使用すると、エディターからマニュアル ページを参照できます。^[9]

2010 年に、OpenBSD はマニュアル ページのフォーマットにtroff を廃止し、代わりにPostScript、HTML、XHTML 、および端末での出力をネイティブにサポートするマニュアル ページ専用のコンパイラ/フォーマッタであるmandocを導入しました。これはマニュアル ページで使用される troff のサブセット、具体的には mdoc マクロを使用するもののみをサポートすることを目的としています。

さまざまな Unix 系システムのマニュアル ページへのオンライン アクセスを提供する Web サイトは数多くあります。

2013年2月、BSDコミュニティは新しいオープンソースのmdoc.suサービスを立ち上げました。これは、*BSDマニュアルページ用の独自のnginxベースの決定論的URL短縮サービスを通じて、主要な現代のBSDプロジェクトのman.cgiスクリプトへのアクセスを統合し短縮するものでした。 ^{[10] [11] [12]}

Linuxでは、システム固有のマニュアルを提供するman7.orgサービスが設立されました。^[13] ManKierサービスはより幅広い選択肢を提供し、TLDRページも統合しています。^[14]

Unix コマンドのマニュアル ページを読むには、次のように入力します。

man  <コマンド名>

ページは、伝統的に「名前(セクション)」という表記法を使用して参照されます。たとえば、ftp(1)。セクションは、トピックが参照されるさまざまな方法、たとえばシステム コール、シェル (コマンド ライン) コマンドまたはパッケージ、パッケージの構成ファイル、コーディング構造 / ヘッダーなどを指します。

システム コール、ユーザーコマンド、またはマクロ パッケージの名前が一致する場合など、同じページ名がマニュアルの複数のセクションに表示されることがあります。例としては、man(1)およびman(7)、またはexit(2)およびがありexit(3)ます。デフォルト以外のマニュアル セクションにアクセスするための構文は、man の実装によって異なります。

たとえば、Solaris および illumos では、読み取りの構文は次printf(3C)のようになります。

man  -s  3cプリントf 

Linux および BSD 派生システムでは、同じ呼び出しは次のようになります。

男3 printf  

これは、マニュアル ページのセクション 3 でprintfを検索します。実際のファイル名には、おそらくセクションが含まれます。この例を続けると、 printf.3.gz は、セクション 3 のprintfの圧縮されたマニュアル ページ ファイルになります。

マニュアルは一般的に8つのセクションに分かれています。今日のほとんどのシステム（BSD、^[15] macOS、Linux、^[16]およびSolaris 11.4など）は、 Research Unix ^[17]で使用されている番号体系を継承しています。^[18] System Vでは異なる順序が使用されています：^[19]

POSIX API はセクション 2 と 3 の両方に存在し、セクション 2 にはシステム コールとして実装される API が含まれ、セクション 3 にはライブラリ ルーチンとして実装される API が含まれます。

一部のシステムでは、次のような追加のセクションが含まれる場合があります。

一部のセクションは接尾辞によってさらに細分化されます。たとえば、一部のシステムでは、セクション 3C は C ライブラリ呼び出し用、3M は数学ライブラリ用などです。この結果、セクション 8 (システム管理コマンド) は、メイン コマンド セクションの 1M サブセクションに格下げされることがあります。一部のサブセクション接尾辞は、セクション間で一般的な意味を持ちます。

(セクション 3 は、さまざまな言語の接尾辞が多数あるため、例外となる傾向があります。)

のいくつかのバージョンは、man最後に表示した数ページのフォーマットされたバージョンをキャッシュします。 1 つの形式は、単にページャーにパイプされて表示される cat pageです。

すべてのマニュアルページは、単純なASCIIテキストディスプレイでの表示​​に最適化された共通のレイアウトに従っており、ハイライトやフォント制御は一切行われない可能性があります。セクションには次のものが含まれます。^{[21] : マニュアルの構造}

名前

コマンドまたは関数の名前と、その機能の 1 行の説明が続きます。

概要

コマンドの場合は、その実行方法と使用するコマンドライン オプションの正式な説明。プログラム関数の場合は、関数が使用するパラメータのリストと、その宣言が含まれるヘッダー ファイル。

説明

コマンドまたは関数の機能に関するテキストによる説明。プログラムの場合、このセクションには使用可能なコマンド ライン オプションの説明が含まれることがよくあります。

例

一般的な使用例をいくつか示します。

参照

関連するコマンドまたは関数のリスト。

他のセクションが存在する場合もありますが、これらはマニュアル ページ間で十分に標準化されていません。一般的な例としては、オプション、終了ステータス、戻り値、環境、バグ、ファイル、著者、バグの報告、履歴、著作権などがあります。

manマニュアルページは、古いマクロ、新しいdocマクロ、またはその両方の組み合わせ ( )のいずれかで記述できますmandoc。^[22]マクロmanセットは、タイトル行、セクションヘッダー、(太字、小文字、斜体) フォント、段落、インデントの追加/削減に関する指示を含む、最小限のリッチテキスト機能を提供します。 ^[23]新しいmdoc言語はよりセマンティックな性質を持ち、プログラム名、概要、関数名、著者名など、ほとんどの標準セクションに特化したマクロが含まれています。 この情報を使用して、mandocなどのプログラムでマニュアルのセマンティック検索を実装できます。 スタイルを直接制御する指示も含まれていますが、特殊なマクロでほとんどのユースケースをカバーできると予想されます。^[21] mandoc プロジェクトと groff プロジェクトの両方で、新しいドキュメントの推奨形式が検討されています。^[24]mdoc

troff にとって、マニュアルページは 10 ポイントのRoman フォントでレイアウトされたテキストですが、この区別は通常意味がありません。マニュアルページは紙にレイアウトされるのではなく、端末 (TTY) で表示されるからです。その結果、「小さいフォント」マクロはほとんど使用されません。^[25]一方、太字と斜体のテキストはECMA-48を介して端末でサポートされており、groff はgrottyサポートしている端末を検出すると、要求どおりにそれらを出力します。ただし、BSD のマニュアルドキュメントは、タイプライターのバックスペースと上線シーケンスを介してのみ太字と下線 (斜体の代わり) のテキストをサポートしており、これは によって ECMA-48 に変換される必要がありますless。^{[26] [27]}

より簡単な形式の文書をマニュアルページに変換するツールがいくつか使われてきました。例としてはhelp2man、出力と追加のコンテンツを受け取り--help、マニュアルページを生成する GNU の があります。^[28]マニュアルは、前述の出力よりもほとんど役に立ちませんが、GNU プログラムでは、texinfo が主要なドキュメントシステムであるため、これは問題になりません。^[29] pandoc、ronn、md2manなど、いくつかのツールがMarkdownからマニュアルページへの変換をサポートしています。これらすべてのツールは 形式を出力します。これはman、Markdown が の意味内容に一致するほど表現力がないためですmdoc。DocBookには man(7) コンバータが組み込まれていますが、mandoc の作者^[30]によると、その品質はひどいとのことで、mandoc は別の mdoc(7) コンバータを書いています。

マニュアルページは通常英語で書かれていますが、システム上で他の言語への翻訳が利用できる場合があります。GNUman-dbとmandocはmanサブディレクトリの下でローカライズされたマニュアルページを検索することが知られています。^{[31] [16] : 概要 [15]}

GNUプロジェクトの「」システム（初期のシンプルなハイパーテキストmanシステム）を除けば、あまり人気がない代替手段はほとんどありません。また、チートシートに似た、一般的な使用例の簡単な例を提供するTLDRページ（ ）と呼ばれるサードパーティの取り組みもあります。^[32]infotldr

さらに、一部のUnix GUIアプリケーション（特にGNOMEおよびKDE開発環境を使用して構築されたもの）では、エンドユーザー向けのドキュメントをHTMLで提供し、yelpアプリケーション内でヘルプを読むための埋め込みHTMLビューアが含まれています。EmacsのHTMLシステムもtexinfoに代わる予定です。^[33]

• Unixコマンドのリスト
• プラン9のアプリケーションのリスト
• info
• apropos
• README
• RTFM
• ManOpen – NeXT / macOSグラフィカル man ユーティリティ

WikibookのUnixガイドには、コマンドに関するページがあります。

• UNIX マニュアル ページの一次資料の履歴については、「UNIX マニュアル ページの履歴」を参照してください。
• 約 300,000 個の適切にフォーマットされたマニュアル ページを含む UNIX および Linux マニュアル ページ リポジトリ。
• マニュアルページの数字は何を意味していますか?
• FreeBSD マニュアル ページ、freebsd.org – Darwin、Debian、HP-UX、IRIS、NetBSD、OpenBSD、NextSTEP、SunOS などのマニュアル ページもあります。