功能简述
在线参考手册的界面
常用命令
显示项目（程序） ls 对应的手册页：
man ls
找到包含 vim 关键字的全部手册：
man -w -K 'vim'
从第7节中显示宏包man的手册页。
man man.7
正确执行时，显示包含在手册中所有可用的intro手册页。可以在连续显示过程中退出或跳过任一页。
man -a intro
将别名“alias”所引用的手册页(常为SHELL手册页)格式化为默认的troff或groff格式，并通过管道传送给名为ps的打印机。groff的默认输出通常为PostScript。man –help应该会提示哪个处理器程序与-t选项绑定。
man -t alias | lpr -Pps
此命令会将nroff源手册页./foo.1x.gz解压并格式化为设备无关(dvi)文件。重定向是必须的，因为-T标志会导致输出不经分页程序直接传送到stdout。应该使用xdvi这样的程序查看输出结果，或使用dvips这样的程序进一步处理为PostScript。
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
在手册的简短描述和手册页的名字中搜索做为正则表达式的printf关键字。打印出所有匹配的项。等价于apropos printf。
man -k printf
查找由smail引用的手册页面，然后打印所有已找到手册的间断描述。等价于whatis smail。
man -f smail
语法格式
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是系统手册的分页程序。指定给man的page选项通常是程序、工具、函数名。程序将显示每一个找到的相关手册页。如果指定了section，man将只在手册的指定章节进行搜索。默认将按预定的顺序查找所有可用的章节(默认是“1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7”，除非被/etc/manpath.config中的SECTION指令覆盖)，并只显示找到的第一个匹配的手册页（即使多个章节中都有这个页面）。
下表显示了手册中的章节号，后面跟的是他们包含的手册页类型：
2 系统调用(内核提供的函数)
3 库调用(程序库中的函数)
4 特殊文件(通常位于/dev)
5 文件格式和规范，如/etc/passwd
6 游戏
7 杂项(包括宏包和规范，如man(7)，groff(7))
8 系统管理命令(通常只针对root用户)
9 内核例程[非标准]
一个手册页面包含若干个小节。这些小节名称通常包括NAME(名称), 概述(SYNOPSIS), 配置(CONFIGURATION), 描述(DESCRIPTION), 选项(OPTIONS), 退出状态(EXIT STATUS), 返回值(RETURN VALUE), 错误(ERRORS), 环境(ENVIRONMENT), 文件(FILES), 版本(VERSIONS), 符合标准(CONFORMING TO), 注(NOTES), 缺陷(BUGS), 示例(EXAMPLE), 作者(AUTHORS), 亦见(SEE ALSO)。还有其他一些不常见的小节，通常与内容相关。
以下规范适用于概述(SYNOPSIS)小节，也可作为其他小节的规范指南：
italic text 用相应的参数进行替换。
[-abc] “[ ]”内的任意/全部参数都是可选的。
-a|-b 以“|”分隔的选项可以一起使用。
argument … 参数可以重复，可以指定多个。
[expression] … “[ ]”内的整个expression可以重复。
实际渲染的效果可能因输出设备而异。例如，在终端中man程序通常无法渲染出斜体，这时一般会以下划线或彩色文字代替。
程序和函数说明应该是一个模式(pattern)，应该匹配所有可能用法的。有些情况下，应该分别陈述几种互斥的用法。
命令概述
man有许多选项供用户灵活使用。搜索路径、章节顺序、输出处理器、其他行为和操作均可更改，具体如下。
如果被设置，程序将检查各种环境变量来确定man如何操作。可以对命令行中的任何字符串设置“catch all”变量$MANOPT，除非是选项参数中需要转义的空格（前缀反斜线）。man将会先解析$MANOPT，再解析它自己的命令行。这些需要参数的选项将会被命令行中其他的相同选项所覆盖。若要重置$MANOPT中的所有选项，可以在命令行开头指定-D选项。这会让man“忘掉”$MANOPT中指定的选项，即便它们可能仍然是有效的。
手册分页程序工具封装在man-db程序包里，它们充分利用索引数据库缓存。这些缓存包含了诸如每个手册页存储在文件系统的什么位置，它的whatis(对手册页的一句概述) 包含什么，而且能让man运行更快些，因为不用每次搜索文件系统查找相应的手册页。如果调用时使用了-u选项，man会保证缓存的一致性；这避免了手动运行软件来更新传统的whatis文本数据库。
如果man从mandb初始化的索引数据库中找不到某个手册页层次结构，它仍然会搜索请求的手册页，尽管搜索该层次结构时需要展开文件。如果whatis或apropos找不到索引数据库，它会尝试从传统的whatis数据库中提取信息。
这些工具默认支持以.Z、.z、gz为扩展名的nroff压缩源文件。可以支持其他压缩扩展名，但相应信息需要在编译时提供。同样，任何“cat页面“将使用gzip压缩。每个“全局”手册页层次结构如/usr/share/man或/usr/X11R6/man可以包含任何作为其cat页面层次结构目录。传统上cat页面保存在与man页面相同的层次结构下，但由于某些原因，例如File Hierarchy Standard (文件系统层次结构标准, FHS) 所指出的，可能将它们保存在其他位置更好。有关如何操作的详细信息，请参阅manpath(5)。想了解这样做的详细原因，请阅读标准文档。
此包提供了国际化支持。本地语言的手册页(如果系统上有)可以通过使用locale功能来访问。要启用本地语言支持，需要将$LC_MESSAGES或$LANG或其他系统相关的环境变量设置为你的语言区域代码；该代码通常以基于POSIX1003.1的格式指定：
如果所需的页面有你的区域对应的版本，它会替代标准的(通常为美国英语)手册页进行显示。
国际化的消息分类功能也包含在此包中，可以用同样的方式启用(如果可用的话)。如果你发现此包提供的手册页和消息分类对你的本地语言不可用，并且你想提供支持，请联系协调这类活动的(手册本地化)维护者。
有关此手册分页程序其他可用功能和扩展的信息，请阅读此包提供的文档。
默认
man将在索引数据库缓存中搜索需要的手册页。如果指定了-u选项，将执行缓存一致性检查来保证数据库与文件系统精确对应。如果总是指定该选项，则不必在缓存初次创建后运行mandb，除非缓存被破坏。不
过，缓存一致性检查在安装了很多手册页的系统上可能很慢，因此默认不检查；系统管理员可以隔段时间(如每周)运行一次mandb来保证数据库缓存及时更新。为预防过期缓存导致的问题，man会在查找缓存失败
后退回到文件展开查找，就像没有缓存时一样。
一旦定位到手册页，程序将检查是否已存在一个相关的“cat”文件并且比nroff文件新。如果是，这个预格式化的文件(通常)会使用分页程序解压和显示。分页程序可以通过几种方式指定，或者退回到使用一个默认
的(详见-P选项)。如果找不到cat文件或它比nroff文件旧，nroff将通过各种程序过滤并立即显示。
如果可以生成cat文件(相应的cat目录存在并有正确的权限)，man会在后台压缩并保存cat文件。
可以通过几种方式指定过滤程序。首先，会查询命令行选项-p或环境变量$MANROFFSEQ。如果没有指定-p，环境变量也未设置，将解析nroff文件的第一行来查找预处理器字符串。要包含有效的预处理器字符串，第
一行必须这样写：
其中string可以是下面-p选项所描述的任何字符的组合。
如果以上方法都没有提供过滤程序信息，将使用默认程序集。
过滤程序和主格式化程序(nroff或[tg]roff -t) 将组成格式化流水线并执行。或者，如果man树根节点有可执行的mandb_nfmt (或mandb_tfmt -t) 程序，将转而执行它。手册源文件、预处理字符串，以及可
选的以-T或-E指定的设备将作为参数传递给它。
命令选项
对于非参数的选项如果在命令行和$MANOPT中，如果重复指定，不会产生问题。对于需要参数的选项，每次重复将覆盖上个参数值。
常规选项
-C file, –config-file=file
使用用户配置文件file代替默认的~/.manpath。
-d, –debug
打印调试信息。
-D, –default
此选项通常作为第一个选项，它将man的行为恢复为默认值。它的作用是重置任何在$MANOPT中设置的选项。-D选项之后的任何选项保留其原有效果。
–warnings[=warnings]
启用来自groff的警告。这可以用于检查手册页源文件完整性。warnings是以英文逗号分隔的警告名列表；如果不提供，默认为“mac”。请查阅info groff中的“Warnings”部分来了解可用的警告名列表。
主要的操作方式
-f, –whatis
等同于whatis。显示来自手册页的加简短说明(若有)。详见whatis(1)。
-k, –apropos
等同于apropos。搜索关键词对应的手册概述并显示所有匹配结果。详见apropos。
-K, –global-apropos
在所有手册中搜索文本。这是暴力搜索，需要花费一定时间；如果可以，你应该指定手册章节以减少需要搜索的手册页数量。搜索条目可以是简单的字符串(默认)，或正则表达式(若使用了–regex选项)。
注意，这会搜索手册页的源文件，而不是搜索渲染后的文本，因此可能会由于源文件中的注释之类的东西而误报。而搜索渲染的文本又会慢得多。
-l, –local-file
启用“本地”方式。格式化并显示本地手册文件，而非搜索系统手册集。每个手册页参数将解释为格式正确的nroff源文件。不产生cat文件。如果参数中有“-”，将从标准输入读取。如果未指定该选项，而man未找到要求的页面，在显示错误消息前man会假设指定了此选项进行尝试，使用名称作为文件名并查找精确匹配。
-w, –where, –path, –location
不显示手册页，但打印将被格式化的nroff文件的位置。
-W, –where-cat, –location-cat
不实际显示手册页，但打印将显示的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
指定要使用的另一manpath路径。默认情况下man使用manpath命令得到的代码来确定搜索路径。此选项会覆盖$MANPATH环境变量，并导致选项-m被忽略。
指定为manpath的路径必须是划分为若干章节的手册页层次结构的根目录。“章节”的描述见man-db手册(位于“手册页系统（The manual page system）”)。要查看层次结构之外的手册页，请参阅-l选项。
-S list, -s list, –sections=list
要搜索的“指定顺序”的手册章节列表，其中list以英文冒号或逗号分隔。此选项会覆盖$MANSECT环境变量。(使用-s表示是为了与System V兼容。)
-e sub-extension, –extension=sub-extension
某些系统包含大量的手册页包，例如某些系统将Tcl (手册)包并入主手册页层次目录。为避免两个手册页重名，如exit(3)，Tcl手册页通常都归于l章节。为解决这一不便，现在可以将页面放在正确的节，分配给它们一个特定的“扩展(extension”)即可；这个例子中，就是exit(3tcl)。正常操作时，man会优先显示exit(3) 而不是exit(3tcl)。为协调这一状况并避免要记住所需手册页属于哪个章节，现在可以给man指定一个sub-extension字符串，指示该手册页必须属于哪个包。对于上面的例子，给man加上-e tcl选项，就能限制只搜索带有*tcl扩展的页面。
-i, –ignore-case
搜索手册页时忽略大小写。此为默认值。
-I, –match-case
搜索手册页时匹配大小写。
–regex
显示那些名字（NAME）或描述（DESCRIPTION）的任何部分与所提供的正则表达式参数page匹配的所有页面，像使用apropos(1)一样，该选项会将page视为正则表达式。由于搜索正则表达式时通常没办法选出“最佳”手册页，此选项隐含了-a选项。
–wildcard
显示那些名字（NAME）或描述（DESCRIPTION）的任何部分与所提供的SHELL格式通配符page参数匹配的所有页面，像使用apropos(1) –wildcard一样。page参数必须匹配整个名字或描述，或匹配描述中单词的边界。由于搜索通配符时通常没办法选出“最佳”手册页，此选项隐含了-a选项。
–names-only
如果使用了–regex或–wildcard选项，则只匹配手册页名而不匹配描述，就像使用whatis(1) 一样。否则不起作用。
-a, –all
默认情况下，man在显示它找到的最符合的手册页后会退出。此选项强制man显示名字匹配搜索条件的所有的手册页。
-u, –update
此选项使man对数据库缓存进行“inode级别”的一致性检查，以保证缓存与文件系统精确对应。只有安装的man程序设置了setuid权限位时它才有效。
–no-subpages
默认情况下，man会试图将命令行上提供的一对手册页名视同包含连字符或下划线的单个手册页名来解释。这个行为会支持那些实现了多个子命令的程序的常见模式，允许程序为每个子命令提供手册页，并用和调用各子命令的语法类似的方式访问它们。例如：
/usr/share/man/man1/git-diff.1.gz
要禁用此行为，请使用–no-subpages选项。
/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。此选项会覆盖$MANPAGER环境变量，进一步覆盖$PAGER环境变量。它不和-f或-k合用。
值pager可以是简单的命令名或带参数的命令，并可以使用shell引用(反斜杠、单引号、双引号)。但是，不能使用管道连接多个命令；如果你需要使用管道，请封装脚本，它能够以参数形式或从标准输入获得要显示的文件。
-r prompt, –prompt=prompt
如果使用较新的less作为分页程序，man将尝试设置它的提示消息和一些敏感选项。默认的提示消息类似于
其中name表示手册页名，sec表示找到的手册页所属的章节，x是当前行号。这是通过使用$LESS环境变量实现的。
提供一个带字符串的-r选项会覆盖这个默认值。字符串可以包含文本$MAN_PN，它会展开为当前手册页的章节名，并用“(”和“)”括起来。显示默认提示的字符串可以表示为
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(press h for help or q to quit)
为了方便阅读，这里分成了三行。字符串的含义请参阅less(1)手册页。提示字符串将首先由SHELL解释。提示中的所有的双引号、反斜杠都必须在前面加一个反斜杠转义。提示字符串可以转义的$结束，后面还可以跟其他的less选项。man默认设置-ix8 选项。
下面描述的$MANLESS环境变量可以用来在命令行未指定提示符时设置默认的提示符。
-7, –ascii
当在7位编码的终端或终端模拟器中查看纯ascii(7) 手册页时，若使用GNU nroff的latin1(7) 设备描述，一些字符可能显示不正确。此选项允许纯ascii手册页使用latin11 设备以ascii来显示。它不会转换任何latin1文本。以下表格显示了进行的转换：其中一部分可能只有在使用GNU nroff的latin1(7) 设备时才正确显示。
Description Octal latin1 ascii ───────────────────────────────────────────── continuation hyphen 255 ‐ - bullet (middle dot) 267 · o acute accent 264 ´ ' multiplication sign 327 × x
在命令行中查看当前命令的手册页面时：如果latin1 列显示正确，你的终端可能作了latin1 字符设置，此选项将不需要；如果latin1 和ascii列一样，那么你正在使用此选项阅读本手册页，或man未使用latin1 设备描述来格式化此页；如果latin1 列缺损，你可能要使用此选项来查看手册页。
在使用-t, -H, -T, -Z选项时，此选项可能对GNU版之外的nroff程序无用。
-E encoding, –encoding=encoding
生成对应字符编码的输出，而非默认编码。为向后兼容，encoding可以是nroff设备，如ascii、latin1 或utf8，也可以是实际的字符编码如UTF-8。
–no-hyphenation, –nh
通常，如果需要将单词排在一行而不添加过多的空格，nroff会在换行处自动断字(给文本添加连字符，即使单词本来不包含连字符)。此选项禁止自动断字，即单词包含连字符时才会被断开。
如果你编写手册页时只是不希望nroff在某个位置不恰当地断字，不要使用此选项，而应查阅nroff文档中的相关方法；例如，你可以在单词中插入“\%”来指示该位置可以断字，或在单词开头插入“\%”来阻止对它断字。
–no-justification, –nj
通常，nroff会自动两端对齐文本。此选项禁止两端对齐，只对齐左边，形成所谓的“ragged-right”(右边不齐)的文本。
如果你编写手册页时只是不希望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来格式化手册页，然后输出到stdout。此选项不要求和-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点（12-point）”的基础字号。此选项隐含了带相应X75、X75-12、X100、X100-12 参数的-T选项。
-Z, –ditroff
groff会运行troff然后使用合适的后处理器产生适合所选设备的输出。如果groff -mandoc为groff，此选项会传递给groff并禁止使用后处理器。此选项隐含了-t选项。
获取帮助
-?, –help
打印帮助消息并退出。
–usage
打印简短的帮助消息并退出。
-V, –version
显示版本信息。
相关环境变量
MANPATH
如果设置了$MANPATH，它的值会用作搜索手册页的路径。
MANROFFOPT
$MANROFFOPT的内容会在每次man调用格式化程序(nroff、troff、groff)时添加到命令行。
MANROFFSEQ
如果设置了$MANROFFSEQ，它的值会用于确定每个手册页经过的预处理程序的集合。默认的预处理器列表因系统而异。
MANSECT
如果设置了$MANSECT，它的值(以冒号分隔的章节列表)会用于确定搜索哪些章节及搜索顺序。默认值为“1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7”，除非被/etc/manpath.config中的SECTION指令覆盖。
MANPAGER, PAGER
如果设置了$MANPAGER或$PAGER (优先使用$MANPAGER)，它的值是显示手册页时使用的分页程序名。默认值为“pager”。
它的值可以是简单的命令名或带参数的命令，并可以使用shell引用(反斜杠、单引号或双引号)。不能使用管道连接多个命令；如果你有这个需要，请封装脚本，它能够以参数形式或从标准输入获得要显示的文件。
MANLESS
如果设置了$MANLESS，它的值将用作less分页程序的默认提示字符串，如同作为-r选项的参数传递一样(因此出现的任何$MAN_PN会以同样的方式展开)。例如，如果你想将提示字符串无条件地设置为“my prompt string”，请将$MANLESS设置为‘-Psmy prompt string’。使用-r选项会覆盖此环境变量。
BROWSER
如果设置了$BROWSER，它的值(冒号分隔的命令列表)中的每一个会轮流用于尝试为man –html启动一个网络浏览器。每个命令中，%s会替换成包含groff HTML输出的文件名，%% 会替换成一个百分号(%)，%c会替换成冒号(:)。
SYSTEM
如果设置了$SYSTEM环境变量，其效果将与-m选项的参数相同。
MANOPT
如果设置了$MANOPT，它会先于man的命令行并假设为类似的格式来解析。由于所有其他的man特定环境变量可以表达为命令行选项，而这些又可以包被含进$MANOPT，因此这些环境变量可能废弃。注意，所有应当解释为命令行选项参数一部分的空格必须被转义。
MANWIDTH
如果设置了$MANWIDTH，它的值将用作终端宽度(参阅–long选项)。如果未设置它，终端宽度将通过$COLUMNS环境变量或调用ioctl(2)(如果有的话)计算。若都失败，将退回到80个字符。Cat页面只有在默认格式化可用时才会保存，即终端行长度介于66到80个字符时。
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兼容的全局索引数据库缓存
退出状态
0 程序成功执行。
1 用法、语法或配置文件出错。
2 操作出错。
3 子进程返回了非零的退出状态码。
16 至少有一个页面/文件/关键词不存在或不匹配。
附加说明
相关手册
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)
man-db包的手册，FSSTND
参考文献
man 1 man, version man 2.7.6.1
man – How to search the whole manual pages on Linux? – Unix & Linux Stack Exchange