man命令操作简介

man是一个常用来显示系统文档的命令。一般来讲，实用程序应编写有关每个名称操作数的信息。如果名称是标准实用程序的名称，则人员至少应编写一条消息，描述标准实用程序使用的语法、选项和操作数；如果有更多可用信息，man程序应以实施定义的方式提供。

一种实现可以提供除了标准实用程序之外的名称值的信息。被列为可选的且不受实施支持的标准实用程序应显示一条简短的消息，指示该事实，或者应显示前面所述的全部信息。

序言

本手册页是POSIX程序员手册的一部分。该接口的Linux实现可能有所不同（有关Linux行为的详细信息，请参阅相应的Linux手册页面），或者该接口可能未在Linux上实现。

用法

man [-k] name...

选项

man实用程序应符合IEEE Std 1003.1-2001第12.2节“实用程序语法指南”的基本定义卷。

应支持以下选项：

-k：将name操作数解释为关键字，用于搜索包含每个标准实用程序的简短目的条目的实用程序摘要数据库，并从摘要数据库中写入与任何关键字匹配的行。

关键字搜索应产生与以下命令输出等效的结果：

grep -Ei 'name name...' summary-database

这假设summary-database是一个每行只有一个条目的文本文件；这个组织是不需要的，使用grep Ei的例子只是说明了搜索的类型。数据库中的目的条目应包括对公用设施目的的简要描述。

操作数

应支持以下操作数：

name：关键字或标准实用程序的名称。如果未指定-k，并且name不代表某个标准实用程序，则结果是未指定的。

标准输入

未使用。

输入文件

无。

环境变量

以下环境变量将影响man的执行：

LANG：为未设置或为null的国际化变量提供默认值。（有关用于确定区域设置类别值的国际化变量的优先级，请参阅IEEE Std 1003.1-2001的“基本定义”卷，第8.2节“国际化变量”。）

LC_ALL：如果设置为非空字符串值，则覆盖所有其他国际化变量的值。

LC_CTYPE：确定将文本数据的字节序列解释为字符的区域设置（例如，参数和摘要数据库中的单字节字符与多字节字符）。LC_CTYPE的值需要不影响写入的关于name操作数的信息的格式。

LC_MESSAGES：确定应用于影响写入标准错误的诊断消息和写入标准输出的信息性消息的格式和内容的区域设置。

NLSPATH：确定用于处理LC_MESSAGES的消息目录的位置。

PAGER：确定用于将输出写入终端的输出过滤命令。任何可接受作为sh -c命令的command_string操作数的字符串都应有效。当标准输出为终端设备时，参考页面输出应通过命令进行管道传输。如果PAGER变量为空或未设置，则命令应为系统文档中记录的更多或另一个分页器实用程序。

异步事件

默认。

标准输出

man实用程序应编写文本，描述实用程序名称、选项及其操作数的语法，或者，当指定-k时，描述汇总数据库中的行。该文本的格式由实现定义。

标准错误

标准错误只能用于诊断消息。

输出文件

无。

扩展描述

无。

退出状态

应返回以下退出值：

0 ：成功完成。>0：出现错误。

错误的后果

默认。

以下各节内容仅供参考。

应用程序用例

无。

示例

无。

基本原理

人们已经认识到，man的效用只有规定的最小效用。标准开发人员的意见在需要人类提供多少信息方面存在很大分歧。然而，他们认为，提供某种可移植的访问文档的方式将有助于用户的可移植性。反对更全面规范的理由是：

*在没有多余磁盘空间的系统上不应该需要大量文档。

*当前的手册系统没有以极大地有助于用户便携性的方式呈现信息。

*“更好的帮助系统”目前是供应商认为可以为其POSIX实现增加价值的领域。

考虑了-f选项，但由于实现差异，它未包含在IEEE Std 1003.1-2001的本卷中。

描述被更改为更具体地说明实用程序必须显示的内容。标准开发人员认为，只显示概要而不简要描述每个选项和操作数的作用是不够的。

数据库中包含的“目的”条目可以类似于IEEE Std 1003.1-2001本卷中每个实用程序的章节标题（除去数字前缀）。这些标题与历史系统中用于此目的的标题相似。

有关默认分页器的基本原理，请参阅mailx。

添加LC_CTYPE描述中的警告是因为不要求实现为每个系统上所有支持的区域设置提供参考页；更改LC_CTYPE并不一定将参考页面翻译成另一种语言。这相当于IEEE Std 1003.1-2001中LC_MESSAGES的当前状态——还不需要特定于日历的消息。

POSIX中没有包含历史MANPATH变量，因为没有尝试为引用页文件指定命名约定，甚至没有强制要求它们是文件。在某些实现中，它们可以是真正的数据库、超文本文件，甚至是man可执行文件中的固定字符串。标准开发人员认为参考页面的可移植性超出了他们的工作范围。但是，用户应该知道，MANPATH是在许多历史系统上实现的，当系统管理员显示系统上参考页面的位置和约定时，它可以用于从各种类别（实用程序、功能、文件格式等）中定制参考页面的搜索模式。

关键字搜索可以至少依赖于来自这些实用程序描述的部分标题的文本，并且实现可以添加更多的关键字。术语“章节标题”是指字符串，例如：

man-显示系统文档。

ps-报告进程状态。

未来发展方向

无。

相关命令

more

版权

本文本的部分以电子形式转载和复制自电气和电子工程师协会和开放集团的IEEE Std 1003.1，2003版，信息技术标准——可移植操作系统接口（Portable Operating System Interface，POSIX），The Open Group基础规范第6期，版权所有（C）2001-2003。如果本版本与原始IEEE和The Open Group标准之间存在任何差异，则以原始IEEE和The Open Group标准为准。原始标准可在线获取，网址为http://www.opengroup.org/unix/online.html。