コマンドラインのマニュアル

Man » man マニュアルオンライン - man man ページの詳しいオンラインドキュメント

🌍
man - システムのリファレンスマニュアルへのインターフェース

概要

man [man オプション] [[セクション] ページ ...] ...
man -k [apropos オプション] 正規表現 ...
man -K [man オプション] [セクション] ターム ...
man -f [whatis オプション] ページ ...
man -l [man オプション] ファイル ...
man -w|-W [man オプション] ページ ...

説明

man は、システムの標準的なページャーです。man に与えられた各ページ引数は、通常、プログラム、ユーティリティ、または関数の名前です。これらの引数のそれぞれに関連付けられたマニュアルページが検索され、表示されます。セクションが指定されている場合、man はマニュアルのそのセクションのみを検索します。デフォルトのアクションは、利用可能なすべてのセクションを、定義された順序に従って検索し、ページが複数のセクションに存在する場合でも、最初に見つかったページのみを表示することです(「デフォルト」を参照)。

以下の表は、マニュアルのセクション番号と、それらに含まれるページの種類を示しています。

1   実行可能プログラムまたはシェルコマンド
2   システムコール(カーネルによって提供される関数)
3   ライブラリコール(プログラムライブラリ内の関数)
4   特殊ファイル(通常は /dev にあります)
5   ファイル形式と慣例(例:/etc/passwd)
6   ゲーム
7   その他(マクロパッケージと慣例を含む)、例:man(7)、[groff]({filename}../../groff)(7)、man-pages(7)
8   システム管理コマンド(通常は root ユーザーのみ)
9   カーネルルーチン [非標準]

マニュアルページは、いくつかのセクションで構成されています。

一般的なセクション名には、NAME、SYNOPSIS、CONFIGURATION、DESCRIPTION、OPTIONS、EXIT STATUS、RETURN VALUE、ERRORS、ENVIRONMENT、FILES、VERSIONS、STANDARDS、NOTES、BUGS、EXAMPLE、AUTHORS、および SEE ALSO が含まれます。

以下の規則は、SYNOPSIS セクションに適用され、他のセクションのガイドとして使用できます。

太字のテキスト 表示されているとおりに正確に入力します。
イタリック体のテキスト 適切な引数に置き換えます。
[-abc]  [ ] 内の引数のいずれかまたはすべてがオプションです。
-a|-b   | で区切られたオプションは、一緒に使用できません。
引数 ...  引数は繰り返すことができます。
[式] ... [ ] 内の式全体を繰り返すことができます。

正確なレンダリングは、出力デバイスによって異なる場合があります。たとえば、man はターミナルでイタリック体を表示できないことが多く、通常は下線付きまたは色付きのテキストを使用します。

コマンドまたは関数の例は、すべての可能な呼び出しに一致するパターンです。場合によっては、SYNOPSIS セクションのこのマニュアルページに示されているように、いくつかの排他的な呼び出しを例として示すことが推奨されます。

man ls
項目(プログラム)ls のマニュアルページを表示します。

man man.7

マクロパッケージ man のセクション 7 のマニュアルページを表示します。(これは "man 7 man" の別の表記です。)

man 'man(7)'

マクロパッケージ man のセクション 7 のマニュアルページを表示します。(これは "man 7 man" の別の表記です。クロスリファレンスをコピー&ペーストする場合、より便利かもしれません。ただし、通常は括弧を引用符で囲んでシェルから保護する必要があります。)

man -a intro

利用可能なすべての intro マニュアルページを順番に表示します。各ページの表示の途中で終了したり、スキップしたりできます。

man -t bash | lpr -Pps

bash のマニュアルページをデフォルトの troff または groff 形式にフォーマットし、プリンター "ps" にパイプします。groff のデフォルト出力は通常、PostScript です。man --help は、-t オプションにどのプロセッサがバインドされているかを指示します。

man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi

このコマンドは、nroff ソースマニュアルページ ./foo.1x.gz を解凍およびフォーマットして、デバイスに依存しない (dvi) ファイルにします。リダイレクトは、-T フラグが出力を stdout に向け、ページャーを使用しないようにするため、必要です。出力は、xdvi などのプログラムで表示したり、dvips などのプログラムを使用して PostScript にさらに処理したりできます。

man -k printf

キーワード printf を正規表現として、短い説明とマニュアルページ名から検索します。一致するものをすべて表示します。apropos printf と同等です。

man -f smail

smail によって参照されるマニュアルページを検索し、見つかったマニュアルページの短い説明を表示します。whatis smail と同等です。

概要

man には、ユーザーにできるだけ多くの柔軟性を提供するために、多くのオプションが用意されています。検索パス、セクションの順序、出力プロセッサ、および以下に詳細に説明するその他の動作や操作を変更できます。

設定されている場合、さまざまな環境変数がクエリされ、man の動作を決定します。コマンドライン形式の任意の文字列を $MANOPT に設定できます。ただし、オプションの引数として使用されるスペースは、エスケープ(バックスラッシュを前に付ける)する必要があります。man は、独自のコマンドラインを解析する前に、$MANOPT を解析します。引数を必要とするオプションは、コマンドラインで見つかった同じオプションによって上書きされます。$MANOPT に設定されているすべてのオプションをリセットするには、初期のコマンドラインオプションとして -D を指定します。これにより、man は $MANOPT で指定されたオプションを「忘れる」ことができますが、それらは有効である必要もあります。

マニュアルページは通常、/usr/share/man などのディレクトリに nroff(1) 形式で保存されます。一部のインストールでは、パフォーマンスを向上させるために、事前にフォーマットされた cat ページも存在する場合があります。これらのファイルが保存されている場所の詳細については、manpath(5) を参照してください。

このパッケージは、ロケールによって制御される複数の言語のマニュアルページをサポートしています。システムが自動的に設定していない場合は、$LC_MESSAGES、$LANG、または他のシステムに依存する環境変数を設定して、好みのロケールを指定する必要がある場合があります。通常は、POSIX 形式で指定されます。


<language>[_<territory>[.<character-set>[,<version>]]]

目的のページがローカルで使用できる場合、標準のページ(通常はアメリカ英語)の代わりに表示されます。

このパッケージに付属する翻訳がネイティブ言語で利用できない場合は、メンテナーに連絡して、翻訳を提供してください。メンテナーがその活動を調整します。

個々のマニュアルページは通常、そのプログラム、関数、またはドキュメント化されたトピックのメンテナーによって作成および管理され、このパッケージには含まれていません。マニュアルページが見つからない、または不十分な場合は、関連するパッケージのメンテナーに報告してください。

このマニュアルページャで使用できる他の機能と拡張機能については、パッケージに付属するドキュメントを参照してください。

デフォルト

セクションの検索順序は、環境変数 $MANSECT または /etc/manpath.configSECTION ディレクティブによってオーバーライドできます。デフォルトでは、次のようになります。

1n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7

書式設定されたマニュアルページは、ページャを使用して表示されます。これは、いくつかの方法で指定できます。指定しない場合は、デフォルトが使用されます(詳細については、オプション -P を参照してください)。

フィルタは、いくつかの方法で解釈されます。まず、コマンドラインオプション -p または環境変数 $MANROFFSEQ が調べられます。-p が使用されず、環境変数が設定されていない場合、nroff ファイルの最初の行が解析され、プリプロセッサ文字列が抽出されます。有効なプリプロセッサ文字列は、最初の行が次の形式である必要があります。

'\" <string>

ここで、`<string>` は、オプション `-p` で説明されている文字の任意の組み合わせにすることができます。

上記のいずれかの方法でフィルタ情報が得られない場合、デフォルトのセットが使用されます。

フィルタ、および主要なフォーマッタ(nroff または -t を使用した [tg]roff)からフォーマットパイプラインが作成され、実行されます。または、man ツリーのルートに実行可能プログラム mandb_nfmt(または -t を使用した mandb_tfmt)が存在する場合、代わりにそれが実行されます。これには、マニュアルソースファイル、プリプロセッサ文字列、およびオプションで -T または -E で指定されたデバイスが引数として渡されます。

オプション

コマンドライン、$MANOPT、またはその両方で重複する引数なしのオプションは、問題ありません。引数が必要なオプションの場合、各重複は、前の引数の値をオーバーライドします。

一般オプション

-C file, --config-file=file
このユーザー構成ファイルを使用して、デフォルトの `~/.manpath` ではなく使用します。

-d, --debug
デバッグ情報を出力します。

-D, --default
このオプションは、通常、最初のオプションとして発行され、man の動作をデフォルトにリセットします。これは、`$MANOPT` に設定されている可能性のあるオプションをリセットするために使用されます。それに続くすべてのオプションは、通常どおりの効果を持ちます。

--warnings[=warnings]

groffからの警告を有効にします。これは、マニュアルページのソーステキストの整合性をチェックするために使用できます。warningsは、コンマで区切られた警告名のリストです。指定しない場合は、デフォルトはmacです。groffの警告を無効にするには、警告名の前に!を付けます。例:--warnings=mac,!breakは、「mac」カテゴリの警告を有効にし、「break」カテゴリの警告を無効にします。利用可能な警告名のリストについては、info groffの「Warnings」ノードを参照してください。

主要な動作モード

-f, --whatis

^ hatisとほぼ同等です。マニュアルページから短い説明を表示します(利用可能な場合)。詳細はwhatis(1)を参照してください。

-k, --apropos

^ proposとほぼ同等です。マニュアルページの短い説明を検索し、キーワードに一致するものを表示します。詳細はapropos(1)を参照してください。

-K, --global-apropos

すべてのマニュアルページでテキストを検索します。これは、強制的な検索であり、時間がかかる可能性があります。可能な場合は、検索するページの数を減らすために、セクションを指定する必要があります。検索語は、単純な文字列(デフォルト)または、--regexオプションが使用されている場合は正規表現にすることができます。

これは、マニュアルページのレンダリングされたテキストではなく、ソースを検索するため、コメントやソースファイル内のハイフン(\-"として記述されている)などの理由により、誤検出や検出漏れが発生する可能性があります。レンダリングされたテキストを検索すると、はるかに時間がかかります。

-l, --local-file

「ローカル」モードをアクティブにします。システムのマニュアルコレクションを検索する代わりに、ローカルのマニュアルファイルをフォーマットして表示します。各マニュアルページ引数は、適切な形式のnroffソースファイルとして解釈されます。catファイルは生成されません。引数として-がリストされている場合、入力はstdinから取得されます。

このオプションが使用されていない場合、manはまた、引数に/文字が含まれている場合、マニュアルページ引数をローカルファイル名として解釈し、これはファイルシステムのパスを参照している良い指標です。

-w, --where, --path, --location

マニュアルページを実際に表示するのではなく、フォーマットされるnroffソースファイルの場所を出力します。-aオプションも使用されている場合、検索条件に一致するすべてのソースファイルの場所を出力します。

-W, --where-cat, --location-cat

マニュアルページを実際に表示するのではなく、表示される事前フォーマットされたcatファイルの場所を出力します。-aオプションも使用されている場合、検索条件に一致するすべての事前フォーマットされたcatファイルの場所を出力します。

^ w-Wの両方が使用されている場合、ソースファイルとcatファイルをスペースで区切って出力します。-w-W、および-aのすべてが使用されている場合、これはすべての可能な一致に対して実行されます。

-c, --catman

このオプションは、一般の使用を目的としておらず、catmanプログラムでのみ使用する必要があります。

-R encoding, --recode=encoding

通常どおりマニュアルページをフォーマットするのではなく、ソースを指定されたエンコーディングに変換して出力します。ソースファイルのエンコーディングがわかっている場合は、manconv(1)を直接使用することもできます。ただし、このオプションを使用すると、各ファイルのエンコーディングを明示的に指定しなくても、複数のマニュアルページを単一のエンコーディングに変換できます。ただし、マニュアルページ階層に類似した構造でインストールされている必要があります。


複数のマニュアルページを変換する場合は、man-recode(1) の使用を検討してください。これは、一括変換用に設計されたインターフェースを備えているため、はるかに高速に処理できます。

マニュアルページの検索

-L locale, --locale=locale
`man` は通常、`setlocale(3)` C関数を呼び出して現在のロケールを決定し、この関数は `$LC_MESSAGES` や `$LANG` などのさまざまな環境変数を照会します。決定された値を一時的にオーバーライドするには、このオプションを使用して、ロケール文字列を直接 `man` に渡します。ただし、このオプションは、ページの検索が実際に開始されるまで有効になりません。ヘルプメッセージなどの出力は、常に最初に決定されたロケールで表示されます。

-m system[,...], --systems=system[,...]
このシステムが他のオペレーティングシステムのマニュアルページにアクセスできる場合、このオプションを使用してアクセスできます。NewOS のマニュアルページコレクションからマニュアルページを検索するには、`-m NewOS` オプションを使用します。

指定できるシステムは、カンマで区切られたオペレーティングシステム名の組み合わせです。ネイティブオペレーティングシステムのマニュアルページも検索に含める場合は、引数文字列に `man` システム名を含めます。このオプションは、`$SYSTEM` 環境変数をオーバーライドします。

-M path, --manpath=path
代替の `manpath` を指定します。デフォルトでは、`man` は `manpath` に基づくコードを使用して、検索するパスを決定します。このオプションは、`$MANPATH` 環境変数をオーバーライドし、`-m` オプションを無視させます。

`manpath` として指定されたパスは、`man-db` マニュアル(「マニュアルページシステム」のセクション)で説明されているように、セクションに構造化されたマニュアルページ階層のルートである必要があります。そのような階層外にあるマニュアルページを表示するには、`-l` オプションを参照してください。

-S list, -s list, --sections=list
指定されたリストは、コロンまたはカンマで区切られたセクションのリストであり、検索するマニュアルセクションと、その順序を決定するために使用されます。このオプションは、`$MANSECT` 環境変数をオーバーライドします。(`-s` のスペルは、System Vとの互換性のために使用されます。)

-e sub-extension, --extension=sub-extension
一部のシステムは、Tclパッケージに付属するパッケージなど、大規模なマニュアルページをメインのマニュアルページ階層に組み込んでいます。`exit(3)` のように、同じ名前のマニュアルページが2つ存在するという問題を回避するために、Tclページは通常すべてセクション l に割り当てられていました。現在では、ページを適切なセクションに配置し、特定の「拡張子」を割り当てることが可能です。この場合、`exit(3tcl)` となります。通常、`man` は `exit(3tcl)` よりも `exit(3)` を優先して表示します。この状況に対処し、必要なページがどのセクションにあるかを把握する必要がないようにするために、`man` にサブ拡張子文字列を渡して、ページが属するパッケージを指定できるようになりました。上記の例では、`-e tcl` オプションを `man` に渡すと、検索は拡張子が `*tcl` であるページに制限されます。

-i, --ignore-case

マニュアルページを検索するときに大文字と小文字を区別しません。これがデフォルトです。

-I, --match-case

マニュアルページを大文字と小文字を区別して検索します。

--regex

名前または説明のいずれかに、指定されたページ引数のいずれかが正規表現として一致するすべてのページを表示します。これは apropos(1) と同様です。通常、正規表現を検索する場合に「最適な」ページを選択する方法がないため、このオプションでは -a が暗示されます。

--wildcard

名前または説明のいずれかに、指定されたページ引数のいずれかがシェルスタイルのワイルドカードとして一致するすべてのページを表示します。これは apropos(1) --wildcard と同様です。ページ引数は、名前全体または説明全体と一致するか、説明内の単語の境界で一致する必要があります。通常、ワイルドカードを検索する場合に「最適な」ページを選択する方法がないため、このオプションでは -a が暗示されます。

--names-only

--regex または --wildcard オプションが使用されている場合、ページの説明ではなくページ名のみを一致させます。これは whatis(1) と同様です。それ以外の場合は、効果がありません。

-a, --all

デフォルトでは、man は最も適切なマニュアルページを1つ表示すると終了します。このオプションを使用すると、検索条件に一致するすべてのマニュアルページが表示されます。

-u, --update

このオプションにより、man はインストールされているマニュアルページのキャッシュデータベースを更新します。これはまれな場合にのみ必要であり、通常は mandb(8) を実行する方が適切です。

--no-subpages

デフォルトでは、man はコマンドラインで指定された一連のマニュアルページ名を、ハイフンまたはアンダースコアを含む単一のマニュアルページ名と同等として解釈しようとします。これにより、プログラムが多数のサブコマンドを実装し、各サブコマンドに同様の構文でアクセスできるマニュアルページを提供できる一般的なパターンがサポートされます。例:

$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz

この動作を無効にするには、--no-subpages オプションを使用します。

$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz

形式化された出力の制御

-P pager, --pager=pager

使用する出力ページャを指定します。デフォルトでは、man は pager を使用し、pager が見つからないか実行可能でない場合は cat にフォールバックします。このオプションは、$MANPAGER 環境変数、さらに $PAGER 環境変数をオーバーライドします。-f または -k と組み合わせて使用​​することはできません。

値は、単純なコマンド名または引数を含むコマンドにすることができます。また、シェル引用符 (バックスラッシュ、一重引用符、または二重引用符) を使用できます。パイプを使用して複数のコマンドを接続することはできません。必要な場合は、ファイルを表示する引数として、または標準入力としてファイルを受け取るラッパー スクリプトを使用できます。


-r prompt, --prompt=prompt
最近のバージョンの less がページャとして使用されている場合、man はそのプロンプトといくつかの適切なオプションを設定しようとします。デフォルトのプロンプトは次のようになります。

Manual page name(sec) line x

ここで、name はマニュアルページの名称、sec はそれが含まれるセクション、x は現在の行番号を示します。これは、$LESS 環境変数を使用して実現されます。

-r に文字列を渡すと、このデフォルトが上書きされます。文字列には、$MAN_PN というテキストを含めることができ、これは現在のマニュアルページの名称とそのセクション名に展開され、括弧で囲まれます。デフォルトのプロンプトを生成するために使用される文字列は、次のように表現できます。

\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(press h for help or q to quit)

これは、読みやすくするために 3 行に分割されています。その意味については、[less]({filename}../../less)(1) のマニュアルページを参照してください。プロンプト文字列は最初にシェルによって評価されます。プロンプト内のすべての二重引用符、バッククォート、およびバックスラッシュは、先行するバックスラッシュでエスケープする必要があります。プロンプト文字列は、エスケープされた $ で終わることができ、その後に less の追加オプションが続く場合があります。デフォルトでは、man は -ix8 オプションを設定します。

$MANLESS 環境変数(以下で説明)を使用して、コマンドラインで指定されていない場合に、デフォルトのプロンプト文字列を設定できます。

-7, --ascii
7 ビット端末または端末エミュレータで、純粋な ASCII(7) マニュアルページを表示する場合、GNU nroff を使用して latin1(7) デバイス記述を使用すると、一部の文字が正しく表示されない場合があります。このオプションを使用すると、純粋な ASCII マニュアルページを ASCII で latin1 デバイスを使用して表示できます。latin1 テキストは翻訳されません。次の表は、実行される翻訳を示しています。一部は、GNU nroff の latin1(7) デバイスを使用した場合にのみ、正しく表示される場合があります。

Description           Octal   latin1   ascii

継続ハイフン    255      ‐        中黒    267      •        o
鋭アクセント    264      ´        '
乗算記号    327      ×        x

latin1 列が正しく表示される場合は、端末が latin1 文字用に設定されており、このオプションは必要ありません。latin1 列と ASCII 列が同じ場合は、このページをこのオプションを使用して読み込むか、man がこのページを latin1 デバイス記述を使用してフォーマットしていません。latin1 列が存在しないか破損している場合は、マニュアルページをこのオプションを使用して表示する必要がある場合があります。

このオプションは、-t、-H、-T、または -Z オプションを使用している場合は無視され、GNU 以外の nroff の場合は役に立たない場合があります。

-E encoding, --encoding=encoding
デフォルト以外の文字エンコーディングの出力を生成します。後方互換性のために、エンコーディングは、ASCII、latin1、または UTF-8 のような真の文字エンコーディングに加えて、nroff デバイスにすることもできます。

--no-hyphenation, --nh

通常、nroffは、単語にハイフンが含まれていない場合でも、テキストを改行するときに自動的にハイフンを入れます。これは、単語を適切な間隔で1行に配置するために必要となる場合があります。このオプションは自動ハイフンを無効にするため、ハイフンが含まれている単語のみがハイフンで区切られます。

マニュアルページを作成していて、nroffが単語を不適切な場所でハイフンで区切るのを防ぎたい場合は、このオプションを使用するのではなく、nroffのドキュメントを参照してください。たとえば、単語内に"\%"を配置して、その場所でハイフンを入れられるようにしたり、単語の先頭に"\%"を配置して、ハイフンが入らないようにすることができます。

--no-justification, --nj

通常、nroffはテキストを両方の余白に合わせて自動的に調整します。このオプションは完全な調整を無効にし、左余白のみに合わせて調整します。これは「左寄せ」テキストと呼ばれることもあります。

マニュアルページを作成していて、nroffが特定の段落を調整するのを防ぎたい場合は、このオプションを使用するのではなく、nroffのドキュメントを参照してください。たとえば、".na"、".nf"、".fi"、および".ad"リクエストを使用して、調整と充填を一時的に無効にすることができます。

-p string, --preprocessor=string

nroffまたはtroff/groffを実行する前に実行するプリプロセッサのシーケンスを指定します。すべてのインストールに完全なセットのプリプロセッサが用意されているわけではありません。いくつかのプリプロセッサと、それらを識別するために使用される文字は次のとおりです。eqn (e)、grap (g)、pic (p)、tbl (t)、vgrind (v)、refer (r)。 このオプションは、$MANROFFSEQ環境変数を上書きします。zsoelimは常に最初のプリプロセッサとして実行されます。

-t, --troff

groff -mandocを使用して、マニュアルページを標準出力にフォーマットします。このオプションは、-H、-T、または-Zと組み合わせて使用する必要はありません。

-T[device], --troff-device[=device]

このオプションは、groff(またはおそらくtroff)の出力を、デフォルト以外のデバイスに適したものに変更するために使用されます。-tを意味します。例(groff 1.23.0の場合)には、dvi、latin1、pdf、ps、utf8、X75、およびX100などがあります。

-H[browser], --html[=browser]

このオプションを使用すると、groffはHTML出力を生成し、その出力をWebブラウザに表示します。ブラウザの選択は、オプションのブラウザ引数が提供されている場合はそれによって、または$BROWSER環境変数によって、または両方が設定されていない場合はコンパイル時のデフォルトによって決定されます(通常はlynx)。このオプションは-tを意味し、GNU troffでのみ機能します。

-X[dpi], --gxditview[=dpi]

このオプションは、groffの出力をグラフィカルウィンドウでgxditviewプログラムを使用して表示します。dpi(1インチあたりのドット数)は、75、75-12、100、または100-12のいずれかになり、デフォルトは75です。-12バリアントは12ポイントの基本フォントを使用します。このオプションは、X75、X75-12、X100、またはX100-12デバイスで-Tを意味します。

-Z, --ditroff

groffはtroffを実行し、次に適切な後処理プログラムを使用して、選択したデバイスに適した出力を生成します。groff -mandocがgroffの場合、このオプションはgroffに渡され、後処理プログラムの使用を抑制します。-tを意味します。


ヘルプの取得

-?, --help

ヘルプメッセージを表示して終了します。

--usage

短い使用方法メッセージを表示して終了します。

-V, --version

バージョン情報を表示します。

終了ステータス

0     プログラムの実行が成功しました。

1     使用法、構文、または設定ファイルのエラー。

2     運用エラー。

3     子プロセスがゼロ以外の終了ステータスを返しました。

16    ページのいずれか、またはファイル、キーワードが存在しないか、一致しませんでした。

環境

MANPATH

$MANPATHが設定されている場合、その値はマニュアルページを検索するパスとして使用されます。

デフォルトの動作と、この環境変数がどのように処理されるかについては、manpath(5)の「検索パス」セクションを参照してください。

MANROFFOPT

manがフォーマッタ(nroff、troff、またはgroff)を呼び出すたびに、その値はフォーマッタのコマンドラインに追加されます。

たとえば、MANROFFOPT=-P-iは、一部のターミナルでのみサポートされている斜体ではなく、下線付きテキストを使用するようにフォーマッタに指示します。

MANROFFSEQ

$MANROFFSEQが設定されている場合、その値は、各マニュアルページに渡すプリプロセッサのセットを決定するために使用されます。デフォルトのプリプロセッサのリストはシステムによって異なります。

MANSECT

$MANSECTが設定されている場合、その値はコロンで区切られたセクションのリストであり、検索するマニュアルセクションと、その順序を決定するために使用されます。デフォルトは、"/etc/manpath.config"のSECTIONディレクティブによってオーバーライドされない限り、"1 n l 8 3 0 2 3ype 3posix 3pm 3perl 3am 5 4 9 6 7"です。

MANPAGER, PAGER

$MANPAGERまたは$PAGERが設定されている場合($MANPAGERが優先されます)、その値はマニュアルページを表示するために使用されるプログラムの名前として使用されます。デフォルトでは、pagerが使用され、pagerが見つからないか実行可能でない場合は、catにフォールバックします。

値は、単純なコマンド名または引数を含むコマンドにすることができます。シェル引用符(バックスラッシュ、一重引用符、または二重引用符)を使用できます。パイプを使用して複数のコマンドを接続することはできません。必要な場合は、ファイルを表示する引数として、または標準入力として受け入れることができるラッパースクリプトを使用します。

MANLESS

$MANLESSが設定されている場合、その値は、lessページャーのデフォルトのプロンプト文字列として使用されます。-rオプションを使用して渡された場合と同じように(したがって、テキスト"$MAN_PN"のすべての出現箇所は同じように展開されます)。たとえば、プロンプト文字列を常に「my prompt string」に設定する場合は、$MANLESSを「-Psmy prompt string」に設定します。-rオプションを使用すると、この環境変数はオーバーライドされます。

BROWSER

$BROWSERが設定されている場合、その値はコロンで区切られたコマンドのリストであり、それぞれがman --htmlでWebブラウザを起動しようとします。各コマンドでは、%sはgroffからのHTML出力を含むファイル名に置き換えられ、%%は単一のパーセント記号(%)に置き換えられ、%cはコロン(:)に置き換えられます。


SYSTEM:$SYSTEM が設定されている場合、-m オプションに指定された場合と同じ効果があります。

MANOPT:$MANOPT が設定されている場合、コマンドラインの前に解析され、$MANOPT に含まれる他の man 固有の環境変数と同様に、コマンドラインオプションとして表現できるため、これらは将来的に廃止される可能性があります。N.B. オプションの引数として解釈されるべきすべてのスペースはエスケープする必要があります。

MANWIDTH:$MANWIDTH が設定されている場合、その値がマニュアルページのフォーマットに使用される行の長さとして使用されます。設定されていない場合、マニュアルページは現在のターミナルに適した行の長さでフォーマットされます($COLUMNS の値と ioctl(2) を使用し、どちらも利用できない場合は 80 文字にフォールバックします)。Cat ページは、ターミナルの行の長さが 66 文字と 80 文字の間にある場合にのみ、デフォルトのフォーマットを使用して保存されます。

MAN_KEEP_FORMATTING:通常、出力がターミナルに送信されない場合(ファイルまたはパイプなど)、フォーマット文字は削除され、特別なツールなしで結果を読みやすくします。ただし、$MAN_KEEP_FORMATTING が空でない値に設定されている場合、これらのフォーマット文字は保持されます。これは、フォーマット文字を解釈できる man のラッパーに役立つ場合があります。

MAN_KEEP_STDERR:通常、出力がターミナルに送信される場合(通常はページャに送信される場合)、フォーマットされたマニュアルページを生成するために使用されるコマンドからのエラー出力は、ページャの表示を妨げる可能性があるため破棄されます。groff などのプログラムは、配置の悪いなど、比較的軽微なタイポグラフィの問題に関するエラーメッセージを生成することがあり、ターミナルに表示すると見栄えが悪く、一般的に混乱を招きます。ただし、一部のユーザーはそれらを表示したいと考えているため、$MAN_KEEP_STDERR が空でない値に設定されている場合、エラー出力は通常どおり表示されます。

MAN_DISABLE_SECCOMP:Linux では、man は通常、信頼できないデータを処理するサブプロセスを seccomp(2) サンドボックスで制限します。これにより、任意のマニュアルページ上で複雑な解析コードを実行することがより安全になります。何らかの理由で、表示されているページのコンテンツに関係のない問題が発生した場合、$MAN_DISABLE_SECCOMP を空でない値に設定してサンドボックスを無効にすることができます。

PIPELINE_DEBUG:$PIPELINE_DEBUG 環境変数が "1" に設定されている場合、man は実行する各サブプロセスに関するデバッグメッセージを標準エラーに出力します。

LANG, LC_MESSAGES:システムと実装によって、$LANG または $LC_MESSAGES のいずれかまたは両方が、現在のメッセージロケールを調べるために使用されます。man は、そのロケールでメッセージを表示します(利用可能な場合)。詳細は setlocale(3) を参照してください。

ファイル

/etc/manpath.config
man-db 構成ファイル。

/usr/share/man
グローバルマニュアルページ階層。

標準

POSIX.1-2001、POSIX.1-2008、POSIX.1-2017。

関連項目

apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)

一部のパッケージのドキュメントは、info(1)またはHTMLなどの他の形式でも利用できる場合があります。

歴史

1990 1991 – ジョン・W・イートン(_ )が最初に作成。

1992年12月23日:リク・フェイス(_ )が、ウィレム・カスドープ(_ )が提供したバグ修正を適用。

1994年4月30日~2000年2月23日:ウィルフ(_ )が、いくつかの献身的な人々の助けを借りて、このパッケージを開発および保守。

1996年10月30日~2001年3月30日:ファブリツィオ・ポラッコ<_>が、コミュニティ全体の助けを借りて、このパッケージをDebianプロジェクトのために保守および拡張。

2001年3月31日~現在:コリン・ワトソン<_>が、man-dbを開発および保守。

バグ

https://gitlab.com/man-db/man-db/-/issues\ https://savannah.nongnu.org/bugs/?group=man-db