linux 帮助文档

Linux中man手册的使用 ——以CentOS为例
本文旨在介绍在Linux中如何快速入手新命令，毕竟在Linux系统中，可以通过命令完成一切操作。

相关命令：help man whatis info

• man

  最常用帮助文档命令，用来查看命令的详细使用方法，参数，行为等，学习命令使用的最佳选择

• info

  info命令是Linux下info格式的帮助指令

• help

  help命令用于显示shell内部命令的帮助信息。help命令只能显示shell内部的命令帮助信息。而对于外部命令的帮助信息只能使用man或者info命令查看。

• whatis

  whatis命令是用于查询一个命令执行什么功能，并将查询结果打印到终端上。
  使用频率不是很高，在新版的centos已经不会有显示

man

• man 手册分类

下面显示了man手册的不同分类

分类号	原文解释	中文解释
1	Executable programs or shell commands	可执行文件 或 shell 命令
2	System calls (functions provided by the kernel)	系统调用
3	Library calls (functions within program libraries)	库调用
4	Special files (usually found in /dev)	特殊文件设备
5	File formats and conventions eg /etc/passwd	文件格式和约定, 如配置文件等
6	Games	游戏
7	Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7)	杂项
8	System administration commands (usually only for root)	系统管理命令
9	Kernel routines [Non standard]	系统进程

## 查看systemctl 文档

$ man systemctl

## 查看 systemctl 配置格式

$ man 5  systemctl

• man 文档格式

man手册中字段说明
帮助手册中的段落说明：
NAME 名称及简要说明
SYNOPSIS 用法格式说明
- [] 可选内容
- <> 必选内容
- a|b 二选一
- { } 分组
- ... 同一内容可出现多次
DESCRIPTION 详细说明
OPTIONS 选项说明
EXAMPLES 示例
FILES 相关文件
AUTHOR 作者
COPYRIGHT 版本信息
REPORTING BUGS bug信息
SEE ALSO 其它帮助参考

• man 查看操作

进入man手册后，可以移动和搜索操作， 命令有些类似vim

q Q ZZ 退出

g  1g       光标跳至文档首部
G       光标跳至文档尾部

e j     文档前进N行

y k     文档后退N行

f space 文档前进N页

b ^B    文档后退N页

/pattern    n/N 向后查询、
?pattern        向前查询

&pattern    只显示匹配到的行

info

info命令是Linux下info格式的帮助指令。

就内容来说，info页面比man page编写得要更好、更容易理解，也更友好，但man page使用起来确实要更容易得多。一个man page只有一页，而info页面几乎总是将它们的内容组织成多个区段（称为节点），每个区段也可能包含子区段（称为子节点）。理解这个命令的窍门就是不仅要学习如何在单独的Info页面中浏览导航，还要学习如何在节点和子节点之间切换。可能刚开始会一时很难在info页面的节点之间移动和找到你要的东西，真是具有讽刺意味：原本以为对于新手来说，某个东西比man命令会更好些，但实际上学习和使用起来更困难。

• 参数

帮助主题：指定需要获得帮助的主题，可以是指令、函数以及配置文件。

• 语法

info(选项)(参数)


-d：添加包含info格式帮助文档的目录；
-f：指定要读取的info格式的帮助文档；
-n：指定首先访问的info帮助文件的节点；
-o：输出被选择的节点内容到指定文件。

• 常用操作

进入info后的命令操作

？     显示帮助窗口

在帮助窗口中：
Ctrl-x 0          关闭帮助窗口
Ctrl-x Ctrl-c    关闭整个 Info
        
q      退出 info
n      打开与本 Node 关联的下一个 Node
p      打开与本 Node 关联的前一个 Node
u      打开与本 Node 关联的上一个 Node
l      回到上一次访问的 Node
m或g   选择一个菜单项（Node 的名字）
       输入指定菜单的名字后按回车，打开指定菜单项关联的 Node
空格键 下一页（PageDown 也可以，下一页从当前页的最后两行开始算起）
       下一个 Node （若当前页在 Node 文档的末尾）
Del 键 上一页（PageUp 也可以，上一页从当前页的开始两行开始算起）
       上一个 Node （若当前页 Node 文档的开始）

b 或 t 或 Home   文档的开始（b 是 begining 的意思）
e 或 End         文档的末尾（b 是 ending 的意思）
Ctrl-l    刷新当前页，若当前文档显示情况有问题时
Ctrl-g    取消所键入的指令

help

help 只能用于显示内建命令的文档

$ help shopt
shopt: shopt [-pqsu] [-o] [optname ...]
    Set and unset shell options.

    Change the setting of each shell option OPTNAME.  Without any option
    arguments, list all shell options with an indication of whether or not each
    is set.

    Options:
      -o    restrict OPTNAMEs to those defined for use with `set -o'
      -p    print each shell option with an indication of its status
      -q    suppress output
      -s    enable (set) each OPTNAME
      -u    disable (unset) each OPTNAME

    Exit Status:
    Returns success if OPTNAME is enabled; fails if an invalid option is
    given or OPTNAME is disabled.

whatis

whatis 搜索并显示命令概要

## 以mac 为例，搜索命令名称或摘要中含有man的命令
$ whatis man

mysqlman(1)              - default man page for mysql
IO::Socket::SSL::Intercept(3pm) - -- SSL interception (man in the middle)
Pod::Man(3pm)            - Convert POD data to formatted *roff input
Pod::Perldoc::ToMan(3pm) - let Perldoc render Pod as man pages
groff_man(7)             - groff `man' macros to support generation of man pages
groffer(1)               - display groff files and man~pages on X and tty
man(1)                   - format and display the on-line manual pages
man.conf(5)              - configuration data for man
zshall(1)                - the Z shell meta-man page

信息一共两列：第1列是命令名称及文档信息，第2列是简述命令或函数的作用

以第一行为例，意思为：echo命令在man手册第一部分有介绍，并且它的作用是展示一行文本信息。如果想详细了解echo命令，可以使用一下命令：

man 1 echo 或 man echo
当然你也可以省略1，即使用man echo命令查看，但是如果是其他数字，则不可省略。 man手册分为几个部分，后面会介绍man手册的构成。

** centos8 中输入此命令，已经不会显示结果了**