Manpages

名 前

man - an interface to the system reference manuals

書 式

man [man options] [[section] page ...] ...
man -k [apropos options] regexp ...
man -K [man options] [section] term ...
man -f [whatis options] page ...
man -l [man options] file ...
man -w|-W [man options] page ...

説 明

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 (see DEFAULTS), and to show only the first page found, even if page exists in several sections. 次 の 表 は マ ニ ュ ア ル の section 番 号 お よ び そ の section に 含 ま れ る ペ ー ジ の 種 類 を 示 し ま す 。

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

Conventional section names include NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONMENT, FILES, VERSIONS, STANDARDS, NOTES, BUGS, EXAMPLE, AUTHORS, and SEE ALSO. 書 式 の 節 で は 次 の 表 記 が 使 用 さ れ ま す 。 他 の 節 で も 同 様 に す る こ と を 推 奨 し ま す 。

    厳 密 な 印 字 は 出 力 デ バ イ ス に 依 存 し て 変 わ り ま す 。 例 え ば 、 端 末 内 で man を 実 行 し た 時 は イ タ リ ッ ク 体 が 使 用 出 来 な い た め 、 下 線 ま た は 色 が 付 け ら れ た テ キ ス ト を 代 わ り に 使 用 し ま す 。 コ マ ン ド ま た は 関 数 の 書 式 は す べ て の 利 用 可 能 な パ タ ー ン を 網 羅 し て い る べ き で す 。 排 他 的 な 起 動 方 法 に 関 し て は 、 こ の マ ニ ュ ア ル ペ ー ジ の 書 式 節 の よ う に 、 分 け て 表 示 す る こ と を 推 奨 し ま す 。

例

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

Display the manual page for macro package man from section 7. (This is an alternative spelling of "man 7 man".)

man ’man(7)’

Display the manual page for macro package man from section 7. (This is another alternative spelling of "man 7 man". It may be more convenient when copying and pasting cross-references to manual pages. Note that the parentheses must normally be quoted to protect them from the shell.)

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

Format the manual page for bash into the default troff or groff format and pipe it to the printer named ps. The default output for groff is usually PostScript. man --help should advise as to which processor is bound to the -t option.

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

This command will decompress and format the nroff source manual page ./foo.1x.gz into a device independent (dvi) file. The redirection is necessary as the -T flag causes output to be directed to stdout with no pager. The output could be viewed with a program such as xdvi or further processed into PostScript using a program such as dvips.

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

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

概 要

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

If set, various environment variables are interrogated to determine the operation of man. It is possible to set the "catch-all" variable $MANOPT to any string in command line format, with the exception that any spaces used as part of an option’s argument must be escaped (preceded by a backslash). man will parse $MANOPT prior to parsing its own command line. Those options requiring an argument will be overridden by the same options found on the command line. To reset all of the options set in $MANOPT, -D can be specified as the initial command line option. This will allow man to "forget" about the options specified in $MANOPT, although they must still have been valid.

Manual pages are normally stored in nroff(1) format under a directory such as /usr/share/man. In some installations, there may also be preformatted cat pages to improve performance. See manpath(5) for details of where these files are stored.

This package supports manual pages in multiple languages, controlled by your locale. If your system did not set this up for you automatically, then you may need to set $LC_MESSAGES, $LANG, or another system-dependent environment variable to indicate your preferred locale, usually specified in the POSIX format:

<language>[_<territory>[.<character-set>[,<version>]]] 設 定 し て い る ロ ケ ー ル で 目 的 の ペ ー ジ が 利 用 可 能 な 場 合 は 、 標 準 (通 常 は ア メ リ カ 英 語 ) ペ ー ジ の 代 わ り に 表 示 さ れ ま す 。

If you find that the translations supplied with this package are not available in your native language and you would like to supply them, please contact the maintainer who will be coordinating such activity.

Individual manual pages are normally written and maintained by the maintainers of the program, function, or other topic that they document, and are not included with this package. If you find that a manual page is missing or inadequate, please report that to the maintainers of the package in question. こ の マ ニ ュ ア ル ペ ー ジ ャ ー で 利 用 可 能 な 機 能 お よ び 拡 張 の 情 報 に 関 し て は 、 パ ッ ケ ー ジ で 提 供 さ れ て い る 文 書 を 参 照 し て く だ さ い 。

デ フ ォ ル ト の 値 と 動 作

The order of sections to search may be overridden by the environment variable $MANSECT or by the SECTION directive in /etc/manpath.config. By default it is as follows:

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

The formatted manual page is displayed using a pager. This can be specified in a number of ways, or else will fall back to a default (see option -P for details).

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 と 併 せ て 引 数 と し て 渡 さ れ ま す 。

オ プ シ ョ ン

Non-argument options that are duplicated either on the command line, in $MANOPT, or both, are not harmful. For options that require an argument, each duplication will override the previous argument value. 一 般 的 な オ プ シ ョ ン
-C file, --config-file=file

Use this user configuration file rather than the default of ~/.manpath.

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

Enable warnings from groff. This may be used to perform sanity checks on the source text of manual pages. warnings is a comma-separated list of warning names; if it is not supplied, the default is "mac". To disable a groff warning, prefix it with "!": for example, --warnings=mac,!break enables warnings in the "mac" category and disables warnings in the "break" category. See the “Warnings” node in info groff for a list of available warning names. 操 作 の メ イ ン モ ー ド

-f, --whatis

Approximately equivalent to whatis. Display a short description from the manual page, if available. See whatis(1) for details.

-k, --apropos

Approximately equivalent to apropos. Search the short manual page descriptions for keywords and display any matches. See apropos(1) for details.

-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, or false negatives due to things like hyphens being written as "\-" 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.

If this option is not used, then man will also fall back to interpreting manual page arguments as local file names if the argument contains a "/" character, since that is a good indication that the argument refers to a path on the file system.

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

Don’t actually display the manual page, but do print the location of the source nroff file that would be formatted. If the -a option is also used, then print the locations of all source files that match the search criteria.

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

Don’t actually display the manual page, but do print the location of the preformatted cat file that would be displayed. If the -a option is also used, then print the locations of all preformatted cat files that match the search criteria.

If -w and -W are both used, then print both source file and cat file separated by a space. If all of -w, -W, and -a are used, then do this for each possible match.

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

Consider using man-recode(1) instead for converting multiple manual pages, since it has an interface designed for bulk conversion and so can be much faster. マ ニ ュ ア ル ペ ー ジ の 検 索 方 法

-L locale, --locale=locale

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

-m system[,...], --systems=system[,...]

If this system has access to other operating systems’ manual pages, they can be accessed using this option. To search for a manual page from NewOS’s manual page collection, use the option -m NewOS.

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

-M path, --manpath=path 代 替 の マ ニ ュ ア ル ペ ー ジ 検 索 パ ス を 指 定 し ま す 。 デ フ ォ ル ト で は man は manpath で 取 得 で き る コ ー ド を 使 用 し て か ら 検 索 す る パ ス を 決 定 し ま す 。 こ の オ プ シ ョ ン は $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

The given list is a colon- or comma-separated list of sections, used to determine which manual sections to search and in what order. This option overrides the $MANSECT environment variable. (The -s spelling is for compatibility with 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 update its database caches of installed manual pages. This is only needed in rare situations, and it is normally better to run mandb(8) instead.

--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 環 境 変 数 を 使 用 し て 行 わ れ て い ま す 。

Supplying -r with a string will override this default. The string may contain the text $MAN_PN which will be expanded to the name of the current manual page and its section name surrounded by "(" and ")". The string used to produce the default could be expressed as

\ 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 nroff の latin1(7) デ バ イ ス 設 定 を 使 用 し た 場 合 に の み 正 し く 表 示 さ れ ま す 。

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

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

-E encoding, --encoding=encoding デ フ ォ ル ト 以 外 の 文 字 エ ン コ ー デ ィ ン グ で 出 力 を 生 成 し ま す 。 過 去 の 互 換 性 の た め に 、 encoding に は 、 UTF-8 の よ う な 実 際 の エ ン コ ー デ ィ ン グ に 加 え て ascii、 latin1、 ま た は 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 を 使 用 し た 時 ) dvi、 latin1、 ps、 utf8、 X75 お よ び 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

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

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

Print a short usage message and exit.

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

終 了 ス テ ー タ ス

0 で な い 終 了 ス テ ー タ ス を 返 し ま し た 。

環 境 変 数

MANPATH

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

See the SEARCH PATH section of manpath(5) for the default behaviour and details of how this environment variable is handled.

MANROFFOPT

Every time man invokes the formatter (nroff, troff, or groff), it adds the contents of $MANROFFOPT to the formatter’s command line.

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 0 2 3type 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 用 の ウ ェ ブ ブ ラ ウ ザ ー と し て 順 番 に 試 さ れ ま す 。 そ れ ぞ れ の コ マ ン ド で は 、 %s は groff の 出 力 を 保 存 し た フ ァ イ ル 名 に 、 %% は 単 一 の パ ー セ ン ト 記 号 (%) に 、 %c は コ ロ ン (:) に そ れ ぞ れ 置 換 さ れ ま す 。

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, and 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 を 空 以 外 に 設 定 す る と 、 エ ラ ー 出 力 は 通 常 通 り 表 示 さ れ ま す 。
MAN_DISABLE_SECCOMP

On Linux, man normally confines subprocesses that handle untrusted data using a seccomp(2) sandbox. This makes it safer to run complex parsing code over arbitrary manual pages. If this goes wrong for some reason unrelated to the content of the page being displayed, you can set $MAN_DISABLE_SECCOMP to any non-empty value to disable the sandbox.

PIPELINE_DEBUG

If the $PIPELINE_DEBUG environment variable is set to "1", then man will print debugging messages to standard error describing each subprocess it runs.

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

フ ァ イ ル

/etc/manpath.config

man-db 設 定 フ ァ イ ル で す 。

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

STANDARDS

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)

Documentation for some packages may be available in other formats, such as info(1) or HTML.

歴 史

1990, 1991 – Originally written by John W. Eaton (jwe [AT] che.edu).

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

30th April 1994 – 23rd February 2000: Wilf. (G.Wilford [AT] ee.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 [AT] 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 [AT] debian.org> is now developing and maintaining man-db.

バ グ

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