《UNIX/Linux 系统管理技术手册(第四版)》——1.9 手册页和其他联机文档

1.9 手册页和其他联机文档

UNIX/Linux 系统管理技术手册(第四版)
手册页通常称为“man手册页”,因为要用man命令来阅读,它构成了传统的“联机”文档(当然,现如今所有的文档都以这样或者那样的形式在线存在)。man手册页一般伴随系统一起安装。针对特定程序的man手册页通常随着安装新软件包一同安装。

man手册页对单条命令、驱动程序、文件格式或者库例程给出简洁的说明。它们不会解释诸如“我该怎样安装一个新设备?”或者“为什么我们的系统这么慢?”这样更普通的话题。对于这些问题来说,用户可以参考厂商提供的系统管理指南(参见1.10节),对于Linux系统来说,也可以从“Linux建档项目(Linux Documentation Project)”中获得文档。

1.9.1 手册页的组织
所有的系统都把man手册页分成若干节,但是在各个节的规定上面,不同系统间略有区别。我们的示例系统所采用的基本结构如表1.3所示。

手册页中有些节会做进一步细分。例如,Solaris的第3c节包含了有关系统C标准库的手册页;有些系统的第8节没有内容,而把系统管理命令放到第1节。许多系统撤销了游戏和演示,第6节什么内容都没有。很多系统在手册中都有一个称之为l(L的小写)的节,用于本地手册页。

对于大多数主题而言,各节的确切结构并不重要,因为只要有匹配的手册页,man命令就会找到它。用户只需要对出现在不同节内同名的主题,知道各节的规定就行了。例如,passwd既是一条命令,也是一个配置文件,所以在第1节和第4或第5节都有关于它的手册项。
1.9.2 man:读取手册页
mantitle命令格式化特定的手册页并通过more、less命令,或者在PAGER环境变量中指定的任何程序把手册页发送到用户终端。title通常是一个命令、设备、文件名或者库例程名。手册中的各节大致是按照数字顺序进行搜索的,不过通常首先搜索描述命令的那些节(第1、8和6节)。

命令格式mansection title可让用户从某个特定的节获取手册页。于是在大多数系统上,man sync命令可得到sync命令的手册页,man 2sync命令可得到系统调用sync的手册页。

在Solaris上,必须在节号前面加上-s标志;例如,man -s 2 sync。

man -kkeyword或者aproposkeyword输出一份手册页清单,在其单行概要中有keyword。例如:

keyword指代的库可能已经过期了。如果要向系统添加man手册页,需重构这个库文件,在Ubuntu、SUSE上使用mandb命令,在Red Hat上使用makewhatis命令,在Solaris、HP-UX和AIX上使用catman -w命令。

1.9.3 手册页的保存
手册页的nroff输入通常保存在/usr/share/man/下的多个目录中。Linux系统会把它们用gzip压缩以节省空间(命令man知道如何当场将它们解压缩)。如果在/var/cache/man或者/var/share/man下的适当目录有写入权限,那么命令man会在那里维护一个有格式的手册页的缓存,但是这存在安全风险。大多数系统会在安装的时候预处理一次手册页的格式(参考catman命令),或者根本不做预处理。

除了传统的nroff格式之外,Solaris还支持SGML格式的手册页。SGML格式手册页相关各节的目录都在/usr/share/man下。

命令man会在若干不同的目录中寻找用户需要的手册页。在Linux系统上,用户可以使用manpath命令来确定搜索路径。这个搜索路径(在Ubuntu中)一般为:

ubuntu$ manpath
/usr/local/man:/usr/local/share/man:/usr/share/man

如果有必要,用户可以设置自己的环境变量MANPATH来覆盖默认路径:

export MANPATH=/home/share/localman:/usr/share/man
有些系统能让用户为手册页设置一个自定义的系统级默认搜索路径,如果用户想要维护平行的一套man手册页目录树(比如OpenPKG创建的目录树),就能够用上这种功能。不过,如果用户想要用手册页的形式发布本地文档,更简单的做法是,用系统的标准打包机制打包,并把这些手册页放在标准的man目录下。参考第12章了解有关软件安装和管理的更多知识。

1.9.4 GNUTexinfo
Linux系统包括一种补充的联机手册页系统,叫做Texinfo。很久以前,GNU人士针对设定man页面格式的nroff为AT&T专有命令这一现实情况,发明了Texinfo文档。现在,我们已经有了GNU的groff来为我们完成这项工作,nroff的问题不再重要了,但它仍然在人们脑海里阴魂不散。

虽然Texinfo逐渐不用了,但仍有很少几个GNU软件包坚持用Texinfo文件而不是man页面来提供自身的文档。用户可以把读取Texinfo的命令info的输出通过管道送给less命令,避开info命令内建的浏览体系。幸运的是,采用Texinfo提供文档的软件包通常会安装指示性的man页面,告诉用户使用info命令来阅读了解那些特殊的软件包。用户可以坚持使用man命令来查找手册,只有在被告知要采用info时再这么做,这样的做法很保险。命令info info将会把用户带入Texinfo的黑暗神秘世界。

时间: 2024-09-17 15:36:00

《UNIX/Linux 系统管理技术手册(第四版)》——1.9 手册页和其他联机文档的相关文章

《UNIX/Linux 系统管理技术手册(第四版)》——2.2 bash脚本编程

2.2 bash脚本编程 UNIX/Linux 系统管理技术手册(第四版) bash特别适合编写简单的脚本,用来自动执行那些以往在命令行输入的操作.在命令行用的技巧也能用在bash的脚本里,反之亦然,这让用户在bash上投入的学习时间获得了最大的回报.不过,一旦bash脚本超过了100行,或者需要的特性bash没有,那么就要换到Perl或者Python上了. bash脚本的注释以一个井号(#)开头,并且注释一直延续到行尾.和命令行中一样,可以把逻辑上的一行分成多个物理上的多行来写,每行末尾用反斜

《UNIX/Linux 系统管理技术手册(第四版)》——第2章 脚本和shell 2.1 shell的基础知识

第2章 脚本和shell 好的系统管理员都要写脚本.脚本以标准和自动的方式履行系统管理员的繁杂事务,藉此把管理员的时间节省出来,以花在更重要和更有意思的任务上.从某种意义上讲,脚本也是一种低质量的文档,因为它们充当了一种权威提纲,提纲里列出完成特殊任务所需的步骤. 从复杂性来看,系统管理脚本的范围很广,小到一个脚本,简单得只封装几条静态命令,大到一个重要的软件项目,为整个站点管理主机配置和管理性数据.在本书里,我们所感兴趣的主要是系统管理员通常会碰到的较小的日常脚本项目.因此,对于较大项目才需要

《UNIX/Linux 系统管理技术手册(第四版)》——2.7 推荐读物

2.7 推荐读物 UNIX/Linux 系统管理技术手册(第四版) BROOKS, FREDERICK P., JR. The Mythical Man-Month: Essays on Software Engineer- ing. Reading, MA: Addison-Wesley, 1995. Shell基础知识和bash脚本编程 ALBING, CARL, JP VOSSEN, AND CAMERON NEWHAM.Bash Cookbook. Sebastopol, CA: O'R

《UNIX/Linux 系统管理技术手册(第四版)》——1.2 读者的知识背景

1.2 读者的知识背景 UNIX/Linux 系统管理技术手册(第四版) 本书假定读者已经具备一定程度的Linux或者UNIX经验.尤其要从用户的角度对系统的风格有个一般性的概念,因为我们不再复述这方面的材料.有一些优秀的书籍可以帮助读者迅速掌握这些概念,参见本章1.14节. 即便在现今有三维图形显示功能的桌面计算机上,用于UNIX和Linux系统管理的GUI工具与其下层丰富的软件相比,依然显得相当简单.在现实世界里,我们仍然要通过编辑配置文件和编写脚本来完成管理工作,因此读者需要习惯于使用某种

《UNIX/Linux 系统管理技术手册(第四版)》——2.6 脚本编程的最佳实践

2.6 脚本编程的最佳实践 UNIX/Linux 系统管理技术手册(第四版) 虽然本章里的代码片段几乎不带注释,而且很少打印用法说明,只是因为我们已经列出了每个例子的大纲,从而体现出若干关键点.实际的脚本应该有更好的表现.有几本书通篇就讲编码的最佳实践,不过其中的基本指导原则如下. 如果运行脚本时带了不合适的参数,脚本应该打印一则用法说明,然后再退出.更好的做法是,也以这样的方式实现--help选项. 验证输入的有效性,并检查获得的输入值.例如,在对算出来的一个路径执行rm -fr操作之前,可能

《UNIX/Linux 系统管理技术手册(第四版)》——2.4 Perl编程

2.4 Perl编程 UNIX/Linux 系统管理技术手册(第四版) Larry Wall发明了Perl语言,它第一种真正伟大的脚本编程语言.它的能耐要比bash大得多,而且编写良好的Perl代码也相当容易阅读.另一方面,Perl没有给开发人员强加太多的风格规范,所以不考虑可读性的Perl代码显得很神秘.Perl也被诟病为只适合写(不适合读)的语言. 我们在这里介绍Perl 5,这个版本成为标准已经有10年了.Perl 6是一个仍处在开发之中的主要版本.参考perl6.org了解详情. 对于系

《UNIX/Linux 系统管理技术手册(第四版)》——1.14 推荐读物

1.14 推荐读物 UNIX/Linux 系统管理技术手册(第四版) ROBBINS, ARNOLD. UNIX in a Nutshell (4th Edition). Sebastopol, CA: O'Reilly Me- dia, 2008. SIEVER, ELLEN, AARON WEBER, AND STEPHEN FIGGINS.Linux in a Nutshell (5thEdition). Sebastopol, CA: O'Reilly Media, 2006. GANC

《UNIX/Linux 系统管理技术手册(第四版)》——1.6 特定于系统的管理工具

1.6 特定于系统的管理工具 UNIX/Linux 系统管理技术手册(第四版) 在现代的操作系统内,包含有各种各样可视化的工具和控制面板(比如SUSE的YaST2和IBM的SMIT),帮助用户配置或者管理选定的系统功能.这些工具非常有用,特别是对于管理员新手来说更是如此,但是它们也倾向于不能完整地体现下层软件的实际操作.它们让管理工作变得容易,但大多数又变得不那么权威. 在本书中,出于下面几个原因,我们要介绍可视化工具调用的底层机制,而不是工具本身.第一,可视化工具趋于专有化(或者至少是趋于为系

《UNIX/Linux 系统管理技术手册(第四版)》——第1章 从何处入手 1.1 系统管理员的基本任务

第1章 从何处入手 UNIX/Linux 系统管理技术手册(第四版) 现如今,有关UNIX和Linux的知识太多太多,由手册.博客.期刊.图书以及其他参考资料构成了浩如烟海的知识库,因此,我们在策划本书内容的时候,就从上述的知识库中遴选出沧海一粟,力求专门满足系统管理员的需求. 首先,本书是一本入门培训指南.书中探讨了主要的管理性系统,先区分它们彼此间的不同之处,然后又阐述它们如何协同工作.在很多情况下,同一概念有若干种不同的实现,系统管理员必须要在其中做出自己的选择,我们则介绍每种实现的优缺点

《UNIX/Linux 系统管理技术手册(第四版)》——1.10 其他的权威文档

1.10 其他的权威文档 UNIX/Linux 系统管理技术手册(第四版) 手册页仅仅是官方文档中的很小一部分.遗憾的是,其余更大一部分的文档都散布在Web上. 1.10.1 针对系统的专门指南 大多数发行商都有自己专门的文档项目,许多发行商还出整本书那样的手册.现在,一般都能找到联机形式的手册,而不是纸质的书.文档的规模和质量则大有不同,但是大多数发行商都至少提供一份系统管理指南和一份安装指南.表1.4给出了在哪儿可以找到我们示例系统的文档. 在这其间最出众的是IBM,IBM针对系统管理的各方