Provided by: man-db_2.8.3-2_amd64 bug

名前

       man - オンラインマニュアルのインターフェース

書式

       man   [-C   file]   [-d]  [-D]  [--warnings[=warnings]]  [-R  encoding]  [-L  locale]  [-m
       system[,...]]  [-M  path]  [-S   list]   [-e   extension]   [-i|-I]   [--regex|--wildcard]
       [--names-only]  [-a]  [-u]  [--no-subpages]  [-P  pager]  [-r  prompt]  [-7] [-E encoding]
       [--no-hyphenation]  [--no-justification]  [-p  string]  [-t]  [-T[device]]   [-H[browser]]
       [-X[dpi]] [-Z] [[section] page[.section] ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man  -l  [-C  file] [-d] [-D] [--warnings[=warnings]] [-R encoding] [-L locale] [-P pager]
       [-r prompt] [-7] [-E encoding] [-p string] [-t] [-T[device]] [-H[browser]] [-X[dpi]]  [-Z]
       file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-?V]

説明

       man is the system's manual pager.  Each page argument given to man is normally the name of
       a program, utility or function.  The manual page associated with each of  these  arguments
       is then found and displayed.  A section, if provided, will direct man to look only in that
       section of the manual.  The default action is to search in all of the  available  sections
       following  a  pre-defined  order ("1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7" by default,
       unless overridden by the SECTION directive in /etc/manpath.config), and to show  only  the
       first page found, even if page exists in several sections.

       次の表はマニュアルの section 番号およびその section に含まれるページの種類を示します。

       1   実行プログラムまたはシェルコマンド
       2   システムコール (カーネルが提供する関数)
       3   ライブラリー呼び出し (プログラムライブラリーに含まれる関数)
       4   Special files (usually found in /dev)
       5   ファイルの書式と慣習 (例: /etc/passwd)
       6   ゲーム
       7   Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7)
       8   システム管理コマンド (通常は root 用)
       9   カーネルルーチン [非標準]

       マニュアルページ page は複数の節で構成されます。

       慣習として、  説明  (NAME)書式 (SYNOPSIS)設定 (CONFIGURATION)説明 (DESCRIPTION)オプション  (OPTIONS)終了ステータス  (EXIT STATUS)戻り値  (RETURN VALUE)エラー
       (ERRORS)環境変数  (ENVIRONMENT)ファイル  (FILES)バージョン  (VERSIONS)準拠
       (CONFORMING TO)備考 (NOTES)バグ (BUGS) (EXAMPLE)著者 (AUTHORS)、および 関連項
        (SEE ALSO)という名前の節が含まれます。

       書式 の節では次の表記が使用されます。他の節でも同様にすることを推奨します。

       太字 (bold)                  表示されている通りに入力します。
       イタリック体・斜体(italic)   適切な引数に置換します。
       [-abc]                       [ ] 内の引数はオプションです。
       -a|-b                        | で区切られたオプションは同時に指定できません。
       argument ...                 argument は繰り返し指定できます。
       [expression] ...             [ ] 内の expression 全体は繰り返し指定できます。

       厳密な印字は出力デバイスに依存して変わります。例えば、端末内で  man を実行した時はイタリッ
       ク体が使用出来ないため、下線または色が付けられたテキストを代わりに使用します。

       コマンドまたは関数の書式はすべての利用可能なパターンを網羅しているべきです。排他的な起動方
       法に関しては、このマニュアルページの 書式 節のように、分けて表示することを推奨します。

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

       man man.7
           Display the manual page for macro package man from section 7.

       man -a intro
           マニュアル内に含まれるすべての利用可能な    intro   マニュアルページを連続して表示しま
           す。連続表示の途中でやめたり、スキップすることもできます。

       man -t alias | lpr -Pps
           `alias' で参照できるマニュアルページ  (通常はシェルのマニュアルページ)  をデフォルトの
           troff  または groff 形式に整形し、 ps という名前のプリンターにパイプを通して渡します。
           groff のデフォルト出力形式は通常 PostScript です。 man --help-t オプションに割り当
           てられている処理系 (プログラム) が分かります。

       man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
           このコマンドは  nroff  形式のマニュアルページのソース  ./foo.1x.gz  を伸長し、  device
           independent (dvi) ファイルに整形します。 -T フラグはページャーを使用せずに 標準出力 に
           出力するため、リダイレクトが必要です。出力は   xdvi   のようなプログラムで閲覧するか、
           dvips のようなプログラムで更に Postscript に変換します。

       man -k printf
           キーワード printf をマニュアルページ名と要約文の中から正規表現として検索します。一致す
           るすべてのマニュアルページが表示されます。 apropos printf と同様です。

       man -f smail
           smail によって参照されるマニュアルページを検索し、見つかったページの要約を表示します。
           whatis smail と同様です。

概要

       利用者が可能な限り柔軟に利用できるようにするため、 man  には多数のオプションがあります。検
       索パス、セクションの順番、出力処理系、および他の動作を変更することができます。操作方法につ
       いては次で説明します。

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

       man-db  パッケージのマニュアルページャーユーティリティーはインデックス型データベースキャッ
       シュを広範囲で使用しています。これらのキャッシュには各マニュアルページがファイルシステム上
       のどこに位置しているか、および whatis (一行で書かれているマニュアルページの短い要約文)  が
       何であるか、等の情報が含まれます。これにより、  man は、適切なマニュアルページを毎回探さな
       ければいけなかった時よりも、素早く動作します。 -u オプションを指定した場合、 man  はキャッ
       シュの一貫性を確実なものとします。よって、伝統的な whatis テキスト型データベースでは手動で
       実行する必要があった更新処理が不要になります。

       ある特定のマニュアルページ階層にインデックス型データベースである  mandb  が無い場合、  man
       は、階層内すべてを検索する必要があったとしても、要求されたマニュアルページを探します。
       whatis または  aproposインデックス型データベースの検索に失敗した場合、代わりに伝統的な
       whatis データベースから情報を抽出しようとします。

       マニュアルユーティリティーは圧縮された  nroff ソースファイルをサポートします。デフォルトで
       は .Z.z、および  .gz  接尾辞をサポートします。どのような圧縮形式の接尾辞も取り扱えます
       が、情報はコンパイル時に指定しなければいけません。デフォルトでは生成された整形済みページも
       gzip で圧縮されます。 /usr/share/man または /usr/X11R6/man  のような「大域」マニュアルペー
       ジ階層には、それぞれ整形済みページ階層があるかもしれません。伝統的には整形済みページはマ
       ニュアルページと同じ階層下に保存されていました。しかしファイルシステム階層標準       (File
       Hierarchy  Standard, FHS) の指定などの理由で、それ以外の場所に保存する方が良いです。この詳
       細に関しては manpath(5) を参照してください。なぜこのようなことを行うかに関しては、標準を参
       照してください。

       このパッケージでは国際化サポートが使用できます。locale  関数を使用して、 (システム上で利用
       できれば)   母語のマニュアルページにアクセス可能です。国際化サポートを有効にするためには、
       $LC_MESSAGES、   $LANG  または他のシステム依存環境変数に言語ロケールを設定する必要がありま
       す。通常は POSIX 1003.1 で規定されている次の書式です。

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

       設定しているロケールで目的のページが利用可能な場合は、標準 (通常はアメリカ英語) ページの代
       わりに表示されます。

       国際化メッセージカタログ機能もこのパッケージではサポートされいます。メッセージカタログが利
       用可能な場合は、マニュアルページと同じ方法で有効にすることができます。利用している母語のマ
       ニュアルページやメッセージカタログがこのパッケージで利用できず、翻訳を提供しようと考えてい
       る場合、翻訳を調整している管理者に連絡してください。

       このマニュアルページャーで利用可能な機能および拡張の情報に関しては、パッケージで提供されて
       いる文書を参照してください。

デフォルトの値と動作

       man は目的のマニュアルページをインデックス型データベース内で検索します。 -u オプションが指
       定されている場合、データベースがファイルシステムの状態を正しく反映していることを確実にする
       ための一貫性検査が行われます。このオプションが常に指定されている場合、一般的には、一度
       キャッシュを作成した後は、キャッシュが破損しない限り mandb  を実行する必要はありません。し
       かしながら、キャッシュ一貫性検査を行うと、多数のマニュアルページがインストールされている場
       合にはシステムが遅くなるため、デフォルトでは無効になっています。このため、システム管理者は
       データベースキャッシュを最新状態に保つために毎週  mandb を実行しているかもしれません。古い
       キャッシュによって発生する問題を防止するため、 man  はキャッシュの検索に失敗した場合、まる
       でキャッシュが存在しなかったかのように、ファイル全体を検索します。

       一度マニュアルページの位置が確定すると、対応する「整形済み」マニュアルページが存在するかど
       うか、および、それが nroff  ファイルより新しいかどうかの確認が行われます。新しい整形済みマ
       ニュアルページが存在した場合、整形済みマニュアルページを、 (通常は) 伸長して、ページャーを
       使用して表示します。ページャーは多くの方法で指定できますが、指定が無い場合はデフォルト (詳
       細は  -P  オプションを参照) のものが使用されます。整形済みマニュアルページが無いか、 nroff
       ファイルより古い場合、 nroff  ファイルがさまざまなフィルタープログラムを通してすぐに表示さ
       れます。

       整形済みファイルを作成した場合、 (対応する整形済みマニュアルページ用ディレクトリーが存在し
       て適切なアクセス権限があれば) man は整形済ファイルをバックグラウンドで圧縮して保存します。

       The filters are deciphered by a number of means.  Firstly, the command line option  -p  or
       the  environment  variable  $MANROFFSEQ  is  interrogated.   If  -p  was  not used and the
       environment variable was not set, the initial line of the  nroff  file  is  parsed  for  a
       preprocessor string.  To contain a valid preprocessor string, the first line must resemble

       '\" <string>

       string は後で説明しているオプション -p の文字の組み合わせです。

       フィルター情報としてこれらの方法のいずれも使用されていない場合、デフォルト値が使用されま
       す。

       整形パイプラインはフィルターとメインの整形ツール (nroff 、または [tg]roff-t オプション
       を指定したもの) で構成され、実行されます。他のものとしてマニュアルページ階層のルートに実行
       ファイル mandb_nfmt (または mandb_tfmt) が存在した場合、mandb_nfmt (または mandb_tfmt-t
       オプション指定で) 実行されます。これには、マニュアルのソースファイル、前処理文字列およびオ
       プションのデバイス指定が -T または -E と併せて引数として渡されます。

オプション

       引数をとらないオプションは、コマンドライン、 $MANOPT  、またはその両方で重複して指定可能で
       す。引数が必要なオプションが重複して指定された場合、後に指定された値が前に指定された値を上
       書きします。

   一般的なオプション
       -C file, --config-file=file
              デフォルトの ~/.manpath ではなく指定したユーザ設定ファイルを使用します。

       -d, --debug
              デバッグ情報を表示します。

       -D, --default
              通常はこのオプションを一番最初に指定し、 man の動作をデフォルトにリセットします。こ
              れを使用すると、 $MANOPT で設定されているオプションをリセットできます。 -D の後に続
              くオプションは通常通りの効果があります。

       --warnings[=warnings]
              groff  からの警告を有効にします。このオプションはマニュアルページのソーステキストの
              整合性検査を行うために使用されます。    warnings   はコンマ区切りの警告名のリストで
              す。指定されていない場合はデフォルト値として "mac" が使用されます。使用可能な警告名
              に関しては info groff の “Warnings” ノードを参照してください。

   操作のメインモード
       -f, --whatis
              Equivalent  to  whatis.   Display  a  short  description  from  the manual page, if
              available.  See whatis(1)  for details.

       -k, --apropos
              apropos と同様です。キーワード (keywords)  に一致するマニュアルページの短い要約文を
              検索し、それを表示します。詳細は apropos(1) を参照してください。

       -K, --global-apropos
              すべてのマニュアルページのテキストを検索します。全数検索を行うため、長い時間がかか
              ります。検索するページ数を減らすために、可能であればセクションを指定するべきで
              す。検索する語はデフォルトでは単純な文字列です。 --regex オプションを指定した場合は
              正規表現になります。

              Note that this searches the sources of the manual pages, not the rendered text, and
              so  may  include  false  positives  due  to  things  like comments in source files.
              Searching the rendered text would be much slower.

       -l, --local-file
              Activate `local' mode.  Format and display local manual files instead of  searching
              through  the  system's  manual  collection.   Each  manual  page  argument  will be
              interpreted as an nroff source  file  in  the  correct  format.   No  cat  file  is
              produced.   If  '-'  is  listed  as  one of the arguments, input will be taken from
              stdin.  When this option is not used, and man fails  to  find  the  page  required,
              before  displaying  the  error  message,  it  attempts to act as if this option was
              supplied, using the name as a filename and looking for an exact match.

       -w, --where, --path, --location
              実際にマニュアルページを表示せず、整形する nroff ソースファイルの位置を表示します。

       -W, --where-cat, --location-cat
              実際にマニュアルページを表示せず、整形済みマニュアルページの位置を表示します。   -w
              と -W が同時に指定された場合、両方がスペースで区切られて表示されます。

       -c, --catman
              このオプションは一般的には使用しません。 catman プログラムのみが使用します。

       -R encoding, --recode=encoding
              マニュアルページを通常の方法で整形する代わりに、  encoding で指定したエンコーディン
              グに変換して出力します。ソースファイルのエンコーディングを知っている場合は、
              manconv(1) を直接使用することもできます。しかしながら、このオプションにより、マニュ
              アルページ階層と同様の構造でインストールされた形で提供されている、複数のマニュアル
              ページのエンコーディングを明示的に意識することなく単一のエンコーディングに変換して
              出力できます。

   マニュアルページの検索方法
       -L locale, --locale=locale
              man は通常、現在のロケールを C の関数  setlocale(3)  を呼び出すことによって決定しま
              す。これはおそらく  $LC_MESSAGES  や  $LANG  などを含むさまざまな環境変数を使用しま
              す。一時的にこの値を上書きしたい場合には、このオプションを使用して    man    に直接
              locale 文字列を渡します。これはページの検索が実際に開始されるまでは効果が無いことに
              注意してください。ヘルプメッセージなどは常に初期に決定されたロケールによって表示さ
              れます。

       -m system[,...], --systems=system[,...]
              システム上で他のシステムのマニュアルページにアクセス可能な場合、このオプションを指
              定してアクセスします。 NewOS のマニュアルページを参照する場合はオプション -m  NewOS
              を使用します。

              system はコンマ区切りのオペレーティングシステム名で指定します。現在使用しているオペ
              レーティングシステムのマニュアルページを含める場合には、システム名の引数に man を含
              めます。このオプションは $SYSTEM 環境変数を上書きします。

       -M path, --manpath=path
              代替のマニュアルページ検索パスを指定します。デフォルトでは  manmanpath で取得で
              きるコードを使用してから検索するパスを決定します。このオプションは $MANPATH  環境変
              数を上書きし、 -m オプションは無視されます。

              A  path  specified  as  a  manpath  must  be  the  root  of a manual page hierarchy
              structured into sections as described in the man-db manual (under "The manual  page
              system").  To view manual pages outside such hierarchies, see the -l option.

       -S list, -s list, --sections=list
              list はコロンまたはコンマで区切った検索するマニュアルのセクションリストです。このオ
              プションは $MANSECT 環境変数を上書きします。 (-s 表記は System V との互換性のために
              存在します。)

       -e sub-extension, --extension=sub-extension
              Some  systems  incorporate  large  packages  of  manual  pages,  such as those that
              accompany the Tcl package, into the main manual page hierarchy.  To get around  the
              problem  of  having  two  manual  pages with the same name such as exit(3), the Tcl
              pages were usually all assigned to section l.  As this is unfortunate,  it  is  now
              possible  to  put  the  pages  in  the  correct  section,  and to assign a specific
              `extension' to them, in this case, exit(3tcl).  Under normal  operation,  man  will
              display  exit(3)   in preference to exit(3tcl).  To negotiate this situation and to
              avoid having to know which section the page you  require  resides  in,  it  is  now
              possible  to give man a sub-extension string indicating which package the page must
              belong to.  Using the above example,  supplying  the  option  -e tcl  to  man  will
              restrict the search to pages having an extension of *tcl.

       -i, --ignore-case
              マニュアルページを検索する時に大文字と小文字の区別をしません。これはデフォルトの動
              作です。

       -I, --match-case
              マニュアルページを検索する時に大文字と小文字を区別します。

       --regex
              Show all pages with any part of either their names or their  descriptions  matching
              each  page  argument  as  a regular expression, as with apropos(1).  Since there is
              usually no reasonable way to pick a  "best"  page  when  searching  for  a  regular
              expression, this option implies -a.

       --wildcard
              Show  all  pages with any part of either their names or their descriptions matching
              each page argument using shell-style wildcards,  as  with  apropos(1)   --wildcard.
              The  page  argument  must  match  the  entire name or description, or match on word
              boundaries in the description.  Since there is usually no reasonable way to pick  a
              "best" page when searching for a wildcard, this option implies -a.

       --names-only
              --regex  または --wildcard オプションと併せて使用した場合、一致処理を要約文に対して
              行わず、ページ名のみに一致処理を行います。 whatis(1) で使用した時も同様です。その他
              の場合は何も効果を及ぼしません。

       -a, --all
              デフォルトでは、 man は最適なマニュアルページを表示した後に終了します。このオプショ
              ンを使用すると、検索条件に一致したすべてのマニュアルページを順番に表示します。

       -u, --update
              This option causes man to  perform  an  `inode  level'  consistency  check  on  its
              database  caches  to  ensure  that  they  are  an  accurate  representation  of the
              filesystem.  It will only have a useful effect if man is installed with the  setuid
              bit set.

       --no-subpages
              By  default,  man  will  try  to  interpret pairs of manual page names given on the
              command line as equivalent to a single manual page name containing a hyphen  or  an
              underscore.   This  supports the common pattern of programs that implement a number
              of subcommands, allowing them to provide manual pages for each that can be accessed
              using  similar  syntax  as would be used to invoke the subcommands themselves.  For
              example:

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

              To disable this behaviour, use the --no-subpages option.

                $ 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
              Specify which output pager to use.  By default, man uses pager, falling back to cat
              if  pager  is  not found or is not executable.  This option overrides the $MANPAGER
              environment variable, which in turn overrides the $PAGER environment variable.   It
              is not used in conjunction with -f or -k.

              この値は、単純なコマンド名か引数付きのコマンドで、シェルのエスケープ文字  (バックス
              ラッシュ、シングルクォート、ダブルクォート)  を使用している場合があります。パイプを
              使用して複数のコマンドをつなげることはできません。そのような必要性がある場合、表示
              するファイルを、単一の引数または標準入力として受け取るラッパースクリプトを使用しま
              す。

       -r prompt, --prompt=prompt
              less  の最近のバージョンをページャーと指定使用している場合、 man はプロンプトに有意
              義な情報を表示するための設定をします。デフォルトのプロンプトは次の通りです。

               Manual page name(sec) line x

              name はマニュアルページの名前です。 sec  はマニュアルページが見つかったセクション名
              です。そして x は現在の行番号です。これは $LESS 環境変数を使用して行われています。

              -r オプションに文字列を引数として渡すとデフォルトの動作を上書きします。この文字列に
              は文字列 $MAN_PN を含めることができます。 $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(1)  のマ
              ニュアルページを参照してください。プロンプトの文字列は最初にシェルによって解釈され
              ます。プロンプト内のすべてのダブルクォート、バッククォート、およびバックスラッシュ
              は前にバックスラッシュを配置してエスケープしなければいけません。プロンプト文字列は
              エスケープされた $ で終了し、その後に  less  用のオプションが続いている場合がありま
              す。デフォルトでは、 man-ix8 オプションを設定します。

              The  $MANLESS  environment  variable  described  below may be used to set a default
              prompt string if none is supplied on the command line.

       -7, --ascii
              純粋な ascii(7) マニュアルページを、 7 ビット端末または端末エミュレーターで参照する
              場合、  latin1(7) デバイス設定と GNU nroff を併せて使用した時に、いくつかの文字は正
              しく表示されません。このオプションを使用すると、純粋な ascii マニュアルページを表示
              時に latin1 デバイス設定を使用して ascii で表示することができます。これは latin1 テ
              キストは全く変換しません。次の表は実行される変換を表します。これらのうちのいくつか
              は GNU nrofflatin1(7) デバイス設定を使用した場合にのみ正しく表示されます。

              説明                  八進数   latin1   ascii
              ──────────────────────────────────────────────
              continuation hyphen    255       ‐        -
              bullet (中点)          267       ·        o
              acute アクセント       264       ´        '
              乗算記号               327       ×        x

              latin1 列が正しく表示される場合は、端末は latin1 文字を扱えるように設定されているた
              めこのオプションは不要です。 latin1 列と ascii 列が同一の場合、このオプションを使用
              してこのページを見ているか、  manlatin1 デバイス設定を使用していません。 latin1
              列が欠けているか表示がおかしい場合、マニュアルページを参照する時にこのオプションを
              使用する必要があります。

              -t-H-T、 または -Z オプションを使用している場合、および GNU groff 以外を使用
              している場合は意味がありません。

       -E encoding, --encoding=encoding
              デフォルト以外の文字エンコーディングで出力を生成します。過去の互換性のために、
              encoding  には、UTF-8 のような実際のエンコーディングに加えて asciilatin1、または
              utf8 のような nroff デバイス設定も使用できます。

       --no-hyphenation, --nh
              通常、 nroff は、単語内にハイフンが無かったとしても、改行部分でテキストに自動的にハ
              イフンを付加します。これにより、行内の単語間に過剰なスペースが配置されることを防ぎ
              ます。このオプションは自動的なハイフン付加を無効にします。よって、ハイフンが含まれ
              ている単語のみハイフン区切りが行われます。

              マニュアルページを書いていて、 nroff が単語内の誤った場所にハイフンを付加するのを防
              止したい場合、このオプションを使用しないでください。代わりに nroff の文書を参照して
              ください。例えば、  "\%" を単語内に含めると、その場所にハイフンを付加することが可能
              であることを示します。また、 "\%"  を単語の最初に付加すると、その単語にはハイフンは
              付加されません。

       --no-justification, --nj
              通常、 nroff は自動的に左右余白に対してテキストを均等割り付けします。このオプション
              は左右余白の均等割り付けを抑止し、左側余白のみ整列します。これは     "ragged-right"
              text と呼ばれます。

              マニュアルページを書いていて、 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.17  を使用した
              時) dvilatin1psutf8X75 および X100 です。

       -H[browser], --html[=browser]
              このオプションを指定した場合、  groff  は HTML 出力を生成し、その出力をウェブブラウ
              ザーで表示します。ブラウザーはオプション引数の    browser    (指定されている場合)、
              $BROWSER 環境変数が使用されます。それらが設定されていない場合はコンパイル時のデフォ
              ルト (通常は  lynx)  が使用されます。このオプションにより暗黙的に  -t  が指定されま
              す。そして、 GNU troff を使用している時のみ有効です。

       -X[dpi], --gxditview[=dpi]
              このオプションを指定した場合、  gxditview  プログラムを使用して、groff の出力をグラ
              フィカルウィンドウに表示します。 dpi (ドット/インチ) は 75、 75-12、  100、  または
              100-12  であり、デフォルトは  75  です。  -12  では 12 ポイントのフォントを使用しま
              す。このオプションにより  -T  オプションと、その引数としてそれぞれ  X75、  X75-12、
              X100、または X100-12 デバイス設定が暗黙的に指定されます。

       -Z, --ditroff
              grofftroff を実行した後、適切な後処理系を使用して、選択したデバイス設定に適した
              出力を生成します。 groff -mandocgroff  の場合、このオプションは  groff  に渡さ
              れ、後処理系の使用が抑止されます。このオプションにより -t が暗黙的に指定されます。

   ヘルプの取得
       -?, --help
              ヘルプメッセージを表示して終了します。

       --usage
              Print a short usage message and exit.

       -V, --version
              バージョン情報を表示します。

終了ステータス

       0      プログラムが正常に実行されました。

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

       2      操作のエラーです。

       3      子プロセスが 0 でない終了ステータスを返しました。

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

環境変数

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

       MANROFFOPT
              $MANROFFOPT の内容は man が整形プログラム (nrofftroff、または groff)  を実行する
              たびに、コマンドラインに渡されます。

       MANROFFSEQ
              $MANROFFSEQ  が設定されている場合、その値は各マニュアルページに対して使用する前処理
              系の集合として使用されます。デフォルトの前処理系はシステム依存です。

       MANSECT
              If $MANSECT is set, its value is a colon-delimited list of sections and it is  used
              to  determine which manual sections to search and in what order.  The default is "1
              n l 8 3 2 3posix 3pm 3perl 3am 5 4  9  6  7",  unless  overridden  by  the  SECTION
              directive in /etc/manpath.config.

       MANPAGER, PAGER
              If  $MANPAGER or $PAGER is set ($MANPAGER is used in preference), its value is used
              as the name of the program used to display the manual page.  By default,  pager  is
              used, falling back to cat if pager is not found or is not executable.

              この値は、単純なコマンド名か引数付きのコマンドで、シェルのエスケープ文字  (バックス
              ラッシュ、シングルクォート、ダブルクォート)  を使用している場合があります。パイプを
              使用して複数のコマンドをつなげることはできません。そのような必要性がある場合、表示
              するファイルを、単一の引数または標準入力として受け取るラッパースクリプトを使用しま
              す。

       MANLESS
              If  $MANLESS  is  set,  its value will be used as the default prompt string for the
              less pager, as if it had been passed using the -r option (so any occurrences of the
              text  $MAN_PN  will  be expanded in the same way).  For example, if you want to set
              the  prompt  string  unconditionally  to  “my  prompt  string”,  set  $MANLESS   to
              ‘-Psmy prompt string’.  Using the -r option overrides this environment variable.

       BROWSER
              $BROWSER が設定さている場合、この値はコロンで区切られたコマンドのリストとして、 man
              --html 用のウェブブラウザーとして順番に試されます。それぞれのコマンドでは、  %sgroff の出力を保存したファイル名に、 %% は単一のパーセント記号 (%) に、 %c はコロン
              (:) にそれぞれ置換されます。

       SYSTEM $SYSTEM が設定されている場合、 -m オプションで指定した引数と同様の効果があります。

       MANOPT If $MANOPT is set, it will be parsed prior to man's command line and is expected to
              be in a similar format.  As all of the other man specific environment variables can
              be expressed as command line options, and are thus candidates for being included in
              $MANOPT  it  is  expected  that  they  will become obsolete.  N.B.  All spaces that
              should be interpreted as part of an option's argument must be escaped.

       MANWIDTH
              If $MANWIDTH is set, its value is used as the line length for  which  manual  pages
              should  be formatted.  If it is not set, manual pages will be formatted with a line
              length appropriate to the  current  terminal  (using  the  value  of  $COLUMNS,  an
              ioctl(2)   if available, or falling back to 80 characters if neither is available).
              Cat pages will only be saved when the default formatting can be used, that is  when
              the terminal line length is between 66 and 80 characters.

       MAN_KEEP_FORMATTING
              通常、端末以外  (ファイルやパイプなど) に出力する場合、特別なツールが使用しなくても
              結果を読みやすくするために書式文字は破棄されます。しかしながら、
              $MAN_KEEP_FORMATTING  を空以外に設定した場合、書式文字が残されます。これにより  man
              と併せて使用するラッパーに書式文字を解釈させることができます。

       MAN_KEEP_STDERR
              通常、端末 (通常はページャー)  に出力する時、ページャーの表示と干渉するのを避けるた
              め、マニュアルページを整形するコマンドのエラー出力は破棄されます。 groff のようなプ
              ログラムは、整列がうまくできないなどの、印字問題に関する比較的軽微なエラーメッセー
              ジをしばしば出力します。これは、マニュアルページと併せて表示すると、見苦しく、混乱
              の原因となります。しかしながら、エラーメッセージを見る必要がある場合、
              $MAN_KEEP_STDERR を空以外に設定すると、エラー出力は通常通り表示されます。

       LANG, LC_MESSAGES
              システムの実装に依存して、 $LANG および $LC_MESSAGES は、現在のメッセージのロケール
              を決めるために使用されます。 man は (使用可能であれば、) メッセージをそのロケールで
              出力します。詳細に関しては setlocale(3) を参照してください。

ファイル

       /etc/manpath.config
              man-db 設定ファイルです。

       /usr/share/man
              大域マニュアルページ階層です。

       /usr/share/man/index.(bt|db|dir|pag)
              伝統的な大域インデックス型データベースキャッシュです。

       /var/cache/man/index.(bt|db|dir|pag)
              FHS 準拠の大域インデックス型データベースキャッシュです。

関連項目

       apropos(1),  groff(1),  less(1),  manpath(1),  nroff(1),  troff(1), whatis(1), zsoelim(1),
       setlocale(3), manpath(5), ascii(7), latin1(7), man(7),  catman(8),  mandb(8),  the  man-db
       package manual, FSSTND

歴史

       1990, 1991 – Originally written by John W. Eaton (jwe@che.utexas.edu).

       1992年12月23日:  Rik  Faith (faith@cs.unc.edu) が Willem Kasdorp (wkasdo@nikhefk.nikef.nl)
       によって提供されたパッチを適用しました。

       30th  April  1994  –  23rd  February  2000:  Wilf.  (G.Wilford@ee.surrey.ac.uk)  has  been
       developing and maintaining this package with the help of a few dedicated people.

       30th October 1996 – 30th March 2001: Fabrizio Polacco <fpolacco@debian.org> maintained and
       enhanced this package for the Debian project, with the help of all the community.

       31st March 2001 – present day: Colin Watson <cjwatson@debian.org> is  now  developing  and
       maintaining man-db.