test

#include 
int main()
{
    return 0;
}

名称
man - 在线参考手册接口


概要
。。。


描述
man是系统手册页面程序。传递给man的每个页面参数一般是程序,工具或者函数的名称。和这些参数有关的手册页将会被找到并且显示出来。如果手册提供了章节,man将只会查看该章节。man默认会根据预先定义的顺序查找所有可用的章节并且显示找到的改章节的第一页,而不管改页是否存在于多个章节。

下面的表格列出了章节号和它们所包含的页面类型。


1 可执行程序或者shell命令
2 系统调用(内核提供的函数)
3 函数库调用(程序库函数?)
4 特殊文件(通常在/dev里)
5 文件格式和约定,例如 /etc/passwd
6 游戏
7 杂项(包括大量的软件包和约定),例如 man(7),groff(7)
8 系统管理命令(通常是root权限)
9 内核程序(非标准)


一个手册页由几个部分组成。


约定的部分名称包括 名称,概要,配置,描述,选项,退出状态,返回值,错误,环境,文件,版本,遵循,注意,漏洞,例子,作者和参阅。


下面的约定适用于概要部分,也可以作为其他部分的指南。

粗体 完整的类型
斜体 用适当的参数代替
[-abc] 在[]内的是可选项的
-a|-b 用|分割的选项不能同时使用
argument... argument是可重复的
[expression]... 在[]内的整个表达式是可以重复的


实际的显示效果可能会随着设备的不同而改变。例如,一般来说man在终端运行的时候不能显示斜体,而将会使用下划线或着色字体替代。


命令和函数的说明是一个会匹配所有可能调用的模式。在一些情况下,会在手册页的概要部分进行适当的说明几种专有的调用。


例子
man ls
显示ls命令的手册页
man -a intro
连续显示所有在手册里关于intro的可用的手册页。可以在连续的显示或者跳跃后退出。
man -t alias | lpr -Pps
使用alias对手册页进行格式化,通常是将一个shell手册页格式化成troff或者groff格式,并用管道传递到名为ps的显示器。groff格式的默认输出是PostScript。man --help应该指明使用-t选项而受到限制的进程。
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
命令将会解压nroff资源手册页./foo.1x.gz并格式化到一个独立的设备文件。需要使用-T重定向标志将输出送到标准输出而不使用页面程序。可以用程序xdvi查看输出或使用dvips将输出进一步处理成PostScript。
man -k printf
以关键字printf作为表达式搜索简要描述和手册页名。输出任何有关的匹配。等于使用apropos -r printf。
man -f smail
查找smail有关的手册页,并输出找到的简短描述。等于使用whatis -r smail。


综述
很多man可用的选项都按一定的顺序尽可能灵活的展示给用户。可以改变查找路径,章节顺序,输出设备和下面详细的其他行为和操作。


如果有,将根据几种环境变量决定man的操作。可以使用可避免空格作为选项参数所发生异常的命令行格式(预先使用反斜杠)将“catch all”的变量$MANOPT设置成任意字符串。man会在分析命令行你之前解析$MANOPT变量。这些选项的参数会被在命令行中找到的相同名称的选项所重写。指定-D作为命令行的初始选项可以重置所有在$MANOPT变量的选项设置。这会使man“忘记”在$MANOPT变量中的指定选项,即使是合法的。


手册页面程序工具会打包成man-db以作为扩展使用的数据库索引缓存。这些缓存包含一些信息,例如手册页在文件系统的位置和手册页的whatis内容(简短的一行描述),这会让man比每次都在文件系统查找手册页要快。如果-u选项被要求,man会保证缓存内容的一致性,使得不用手动运行软件来升级whatis文本内容的数据库。


如果man不能为一个特别的手册页层次找到一个mandb初始化索引数据库,它将会继续查找请求的手册页,尽管需要搜索全局文件。如果whatis或者apropos查找一个索引失败了,man会尝试从传统的whatis数据库中提取信息以进行替代。


这些工具支持压缩以固定宽度调整输出格式的源文件,默认的扩展名是.Z,.z和.gz。可以处理任何扩展的压缩,但必须事先知道压缩信息。默认下,所有的手册页都是经由gzip压缩。每一个“全局”的手册页层次例如/usr/share/man或者/usr/X11R6/man可能含有其相关的测试页层次(?)。习惯上,测试页是存放在与手册页的相同层次,但由于一些原因,例如在File Hierarchy Standard(FHS)的指定里,可能存放在别的地方会更好。详细的如何存放,请参考manpath(5)。详细的为何要这样存放,请参考标准。


这个软件包可以得到国际上的支持。本地语言的手册页可以通过使用locale相关函数进行使用(如果在你系统上可以访问的话)。要获得这个功能的支持,需要设置$LC_MESSAGES,$LANG两个变量或者其他与你的语言区域设置有关的系统依赖变量,通常在POSIX 1003.1中以下列格式指定:


[_[.[,]]]


如果你所期望的区域页面可以被使用的话,它将会替代标准页面进行输出。


这个软件包同样国际性的消息目录支持,可以以同样的方法进行激活使用。如果你发现软件包里的手册页和消息目录不能使用你的本地语言并且你希望使用的话,请联系进行这些整合活动的维护人员。


关于其他特性和可用扩展的手册页面程序信息,请阅读软件包提供的文档。


默认
man会在索引数据库缓存里搜索期望的手册页。如果指明了-u选项,将会进行缓存的一致性检查以确保数据库能准确反映文件系统。如果这个选项总是指定的话,则通常不需要在缓存被最初创建的时候运行mandb,除非缓存损坏了。然而,在系统里对已经进行安装的许多手册页进行缓存的一致性检查是缓慢的,所以默认情况下是不会这么做的,而且系统管理员也可能希望每个星期允许一次mandb以刷新数据库。为了防止缓存信息落后的问题,当缓存查找一个信息失败的时候,man会向全局文件进行求助,就像缓存是不存在的那样。


在每次手册页被定位之后,将进行一次检测以找出相关的“cat”文件是否已经存在和是否比已进行等宽格式化的文件更新。如果“cat”存在并且更新,将会通过页面程序压缩并展示这个显示文件。页面程序可以被多种方式指定使用,或者使用默认方式(详细查看-P选项)。如果“cat”不存在或者不是更新的,等宽格式化的文件通过几种程序的过滤后会马上显示。


如果可以产生cat文件(存在相关的cat目录并且有适当的权限),man会在后台对cat文件进行压缩和存放。


过滤器会使用一个有意义的数字进行解密。首先,会查询命令行的-p参数或者环境变量$MANROFFSEQ。如果没有使用-p选项并且没有设置环境变量,等宽格式化文件的首行会被解析成预处理字符处。为了得到一个合法的预处理字符串,首行必须类似如下格式


'\"


string可以是按下面-p选项描述的任意字母组合。


如果没有提供上述的方法提供过滤信息,将会使用默认设置。


一个格式化的管道由过滤器和格式化器建立并运行。或者,如果在man的树根存在可执行程序mandb nfmt(或者 mandb tfmt 加-t),将会运行该程序以作替代。运行的程序会将传递进来的手册页源文件,预处理字符串和可选的用-T或-E指定的设备作为参数。


选项
在命令行或者(并且)在$MANOPT中,无参数的选项是可以重复的,要求一个参数的选项,后一个选项的参数会覆盖前一个选项的参数.


一般选项
-C file,--config-file=file
使用用户配置文件,而非默认的~/.manpath.
-d,--debug
打印调试信息
-D,--default
这个选项通常放在选项的最前面,用来重设man's的默认行为.

你可能感兴趣的:(postscript,数据库,hierarchy,扩展,语言,工具)