1. 概要
获取帮助方式:
- whatis
- command --help
- man and info
- /usr/share/doc/
- RedHat documentation,Ubuntu documentation
- 软件项目网站
- 其他网站
- 搜索
2. whatis
whatis command
使用数据库来显示命令的简短描述
生成数据库命令
# centos7 版本之后
[root@centos7 ~]# mandb
# centos6 版本之前
[root@centos6 ~]# makewhatis
3. 查看命令的帮助
内部命令帮助:
[root@centos7 ~]# help command #command 为内部命令,如 history,type等
[root@centos7 ~]# man bash # bash 为bash程序文件,如/usr/bin/date
外部命令及软件帮助:
- COMMAND --help 或 COMMAND -h
- 使用man手册(manual):
man command
- 信息页:
info command
- 程序自身的帮助文档:README,INSTALL,ChangeLog
- 程序官方文档
- 相关网站,如技术论坛
- 搜索引擎
4. 外部命令的--help或-h选项
帮助语法格式说明:
- []表示可选项
- CAPS或<>表示变化的数据
- ...表示一个列表
- x|y|z相当于“x或y或z”
- -abc相当于 -a -b -c
- {}表示分组
5. man命令
- man提供命令帮助的文件
手册页存放在/usr/share/man,几乎每个命令都有man的页面。 - 中文man需要安装包:
man-pages man-pages-zh-CN
- man 页面分组
- 1用户命令
- 2系统调用
- 3C库调用
- 4设备文件及特殊文件
- 5配置文件格式
- 6游戏
- 7杂项
- 8管理类的命令
- 9Linux内核API
- man命令配置文件:
- centos6版本之前
/etc/man.config
- centos7版本之后
/etc/man_db.conf
- ubuntu版本
/etc/manpath.config
- centos6版本之前
- man帮助段落说明:
- NAME 名称及简要说明
- SYNOPSIS 用法格式说明
- []可选内容
- <>必选内容
- a|b二选一
- {}分组
- ...同一内容可出现多次
- DESCRIPTION详细说明
- OPTIONS选项说明
- EXAMPLES示例
- FILES相关文件
- AUTHOR作者
- COPYRIGHT版本信息
- REPORTING BUGS bug信息
- SEE ALSO其他帮助参考
man bash
man用法:
NAME
man - 格式化并显示在线帮助手册页
manpath - 定义用户查找man手册页的路径
总览
man [-acdfFhkKtwW] [-m 系统名] [-p <前处理程序>] [-C <配置文件>] [-M <路径>] [-P <浏览方式>] [-S <区段清单>] [区段名称] 帮助主题 ...
描述
man格式化并显示在线帮助手册页面。此版本支持 MANPATH 和(MAN)PAGER
环境变量,因此,你可以拥有你自己的一系列man
手册页并决定使用哪个程序来显示此格式的页面。如果定义了区段,man
将只查找在指定区段内的文档。你也可以通过命令行或环境变量来指定查找区段
的顺序和预定义将要执行的程序。如果主题中有“/”符号,则将其作为文件名的一部分处理 ,也就是说你可以用 man ./foo.5 也可以用 man /cd/foo/bar.1.gz 来查看各man 文档。
选项
-C 配置文件 定义man.conf供使用;默认使用的是 /etc/man.config 。(参见 man.conf(5))。
-M 路径 定义一组查找man手册页的目录。如果没有指定此参数,系统环境变量MANPATH将被使用。
-P 浏览方式 定义浏览的方式。
-S 区段清单
具体区段划分如下所示:
区段1:用户指令
区段2:系统调用
区段3:程序库调用
区段4:设备
区段5:文件格式
区段6:游戏
区段7:杂项
区段8:系统指令
区段9:内核内部指令
区段n:Tcl或Tk指令
-a 默认情况下,man在显示完每一个所查到的man手册页时会自动退出程序。而使用此选项则可使man显示所有与此主题相匹配的手册页内容,而不仅仅是第一项。
-c 即使已存在最近已排版过的帮助文件(即以前曾查询过该主题的帮助文档),使用该参数后仍会再次执行一次排版操作。此参数适用于已排版过的帮助文件已损坏或屏幕的行列数有 改变时。
-d 不显示帮助文档的具体内容,只显示调试排错信息。
-D 既显示帮助文档内容,同时又显示调试排错信息。
-f 相当于运行whatis 的操作。
-h 显示man的语法和参数说明,执行完成后退出程序。
-k 查当于使用 apropos 命令。
-K 在所有的帮助文件中查找包含有指定关键字的帮助文档。此操作可能很慢,所以在使用 此参数时最好配合-s的参数来查找指定区段。(这只是一个粗略的概念,在作者本人的机器 上每分钟可查500个man文档。)
-m 系统名 定义所要查找的man文档所属的系统名。
-p 字串定义在排版帮助文件这前所要执行的预处理程序的次序。不是所有的安装都有完整预处理程序组。一般有6个预处理程序,它们是:eqn(e)、grap(g)、pic(p)、tbl(t)、vgrind(v)和reger(r)。此参数将覆盖环境变量MANROFFSEQ。
-t 使用 /usr/bin/groff - Tps - mandoc 来排版man手册页,并输出到标准输出。从 /usr/bin/groff - Tpa - madoc 输出的内容可能需要某些其它过滤才能真正输出到标准输出打印。
-w" 或 --path 不显示帮助文档的具体内容而只显示相应帮助主题文件的位置。如果没有给定参数,则将在标准输出显示一组由man所查到的相匹配的man文档所在目录。如果命令manpath是一个到man的链接,那么执行“manpath”就相当于执行“man --ath”。
-W 相当于-w参数,但所显示的内容以分行方式显示。此参数方便其它指定或程序对其输出 做进一步处理,如:man -aW man | xargs ls -l
6. info
man常用于命令参考
GNU工具info适合通用文档参考
info没有参数,列出所有页面,更像是一个网站,每一页分为节点
info页导航
- 方向键,PgUp,PgDn导航
- Tab键 移动到下一个连接
- d 显示主题目录
- Home 显示主题首部
- Enter进入 选定链接
- n/p/u/l进入下/前/上一层/最后一个链接
- s文字 文本搜索
- q退出info
7. Linux安装提供的本地文档获取帮助
- centos7: Applications ==> documentation ==> help
- centos6: System ==> help
8. 命令自身提供的官方使用指南
- /usr/share/doc目录
- 多数安装了的软件包的子目录,包括了这些软件的相关原理说明
- 常见文档:README,INSTALL,CHANGES
- 不适合其他地方的文档的位置
- 配置文件范例
- HTML/PDF/PS格式的文档
- 授权书详情
9. 系统及第三方应用官方文档
- 在线文档获取帮助
如 - linux官方在线文档和知识库
通过发行版官方的文档光盘或网站可以获取安装指南,部署指南,虚拟化指南等,如下 - 红帽全球技术支持服务
10.相关网站和搜索
如