手册页

✍ dations ◷ 2025-05-21 02:15:40 #手册页

手册页(英语:Manual pages,缩写man page)是在Unix或类Unix操作系统在线软件文档的一种普遍的形式。内容包括计算机程序(包括库和系统调用),正式的标准和惯例,甚至是抽象的概念。用户可以通过执行man命令调用手册页。

为查阅某个Unix命令的手册页,用户可以在命令行界面执行如下命令:

man <command_name>

例如,“man ftp”。为了方便用户查阅输出的信息,man命令一般会提供一个Less终端分页器(英语:Terminal pager)。

按惯例,man页面可以按照“程序名(区块)”的标记来查阅:例如ftp。相同的手册页标记可能出现在多个不同的区块(section)中,例如相同的名字在系统调用、用户命令或宏软件包中重复出现的时候。比如manman,以及exitexit

访问非默认手册页区块的语法在不同的软件实现中是不一样的。例如,在Solaris中,阅读printf的语法为:

man -s 3c printf

在Linux和类BSD系统中,相同的命令语法为:

man 3 printf

此命令在手册页的第3区块中搜寻“printf”的信息。

《UNIX程序员手册 (页面存档备份,存于互联网档案馆)》1971年11月3日第一次出版。1971年,在主管道格拉斯·麦克罗伊的坚持下,丹尼斯·里奇和肯·汤普逊编写了第一份实际意义上的手册页。除了手册页,《UNIX程序员手册》还汇编了一些简短的论文,其中一部分是教程(英语:Tutorial)(例如Unix的一般用法、C语言,以及Yacc等工具),另一部分是对操作系统功能的更详细的说明。手册的印刷版最初装在一个活页夹中,但PWB/UNIX(英语:PWB/UNIX)和Research Unix第七版的手册被分为两卷,印刷版的手册页成为了其第1卷。

手册页是用troff排版软件包排版的,是一组-man宏。当时,手册页系统带来的联机文档可用性被认为是一项伟大的进步。时至今日,几乎所有的Unix命令行应用程序都附带了手册页,而很多Unix用户将缺少手册页视为低质量应用程序的一个标志。事实上,有些项目(如Debian)不辞劳苦的为缺乏手册页的应用编写手册页;4.4BSD的现代继任者也将手册页作为系统文档的主要形式之一(将旧的-man宏用新的-mdoc宏取代)。

几乎没有什么替代品能像man那样流行,只有GNU计划的info系统可能是个例外。此外,一些Unix图形用户界面应用程序(尤其是那些使用GNOME和KDE开发环境构建的)现在提供的HTML版本的最终用户手册,并包含内嵌的HTML阅读器,如Yelp,以供阅读应用程序中的帮助文档。

手册页通常是用英文写的,在某些系统上可能有翻译成其他语言的版本。

手册页的默认格式是troff,使用man宏软件包(英语:Troff macros)(着重展现)或mdoc宏软件包(着重语义)。可以把手册页排版成PostScript、PDF和其他各种格式进行查看或打印。

大多数Unix系统有一个man2html命令的软件包,该命令允许用户使用HTML浏览器浏览手册页(例如,FreeBSD的textproc/man2html,或某些Linux发行版中的man)。

2010年,OpenBSD宣布淘汰troff,改用mandoc(英语:mandoc)展示手册页。

在Research Unix、BSD、OS X和Linux中,手册通常被分为8个区块,安排如下:

Unix System V采用了类似的编号方案,但顺序不同:

在某些系统中还有下述的区块可用:

一些区块利用后缀进一步细分了。例如在一些系统中,区块3C是C函数库调用,3M是数学(Math)函数库,等等。这样做的结果是区块8(系统管理命令)有时也被移动到区块1M(作为命令区块的子区块)。一些子区块后缀有跨区块的一般含义:

所有的手册页遵循一个常见的布局,其为通过简单的ASCII文本展示而优化,而这种情况下可能没有任何形式的高亮或字体控制。一般包括以下部分内容:

也可能存在其他部分内容,但这些部分没有得到跨手册页的标准化。常见的例子包括:OPTIONS(选项),EXIT STATUS(退出状态),ENVIRONMENT(环境),BUGS(程序漏洞),FILES(文件),AUTHOR(作者),REPORTING BUGS(已知漏洞),HISTORY(历史)和COPYRIGHT(著作权)。

参考:archlinux社区的使用在线手册页 (页面存档备份,存于互联网档案馆)

相关