Linux中man手册的安装以及使用详解

linux中man手册的安装以及使用详解

man手册是什么

man是manual的简称，中文称之为手册。
man手册是linux系统提供的一种帮助手册。

man手册是干嘛的

当需要查看某个命令的具体参数和使用方法时，不必网上搜索，只需要使用man命令即可查询出所需使用命令的具体参数以及使用方法。

man手册如何安装

首先输入man回车，如出现下列错误请移步到解决方案

如出现以下所示

方可继续进行下一步

在命令行中输入以下命令来进行man手册的安装

apt-get install man-db

输入y进行安装，静静等待安装完成（别问我静静是谁，我也不知道）

接下来查看是否装完成
输入命令

man echo 
//此处我查询的是echo命令，作为测试，可以用不同的命令进行。

如图所示，查询到echo命令的具体参数，即为安装成功。
man手册的安装到此结束。

man手册如何使用

举例讲解

首先我们敲击命令

man mkdir 
man 命令的名称

来查看一下关于mkdir命令的参数以及使用方法

MKDIR(1)                                                                              User Commands                                                                             MKDIR(1)

NAME
       mkdir - make directories

SYNOPSIS
       mkdir [OPTION]... DIRECTORY...

DESCRIPTION
       Create the DIRECTORY(ies), if they do not already exist.

       Mandatory arguments to long options are mandatory for short options too.

       -m, --mode=MODE
              set file mode (as in chmod), not a=rwx - umask

       -p, --parents
              no error if existing, make parent directories as needed

       -v, --verbose
              print a message for each created directory

       -Z     set SELinux security context of each created directory to the default type

       --context[=CTX]
              like -Z, or if CTX is specified then set the SELinux or SMACK security context to CTX

       --help display this help and exit

       --version
              output version information and exit

AUTHOR
       Written by David MacKenzie.

REPORTING BUGS
       GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
       Report mkdir translation bugs to <https://translationproject.org/team/>

COPYRIGHT
       Copyright (C) 2018 Free Software Foundation, Inc.  License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
       This is free software: you are free to change and redistribute it.  There is NO WARRANTY, to the extent permitted by law.

SEE ALSO
       mkdir(2)

       Full documentation at: <https://www.gnu.org/software/coreutils/mkdir>
       or available locally via: info '(coreutils) mkdir invocation'

我们来看一下man手册的目录结构。

名称	含义
NAME	名称
SYNOPSIS	命令语法（又称摘要）
DESCRIPTION	命令完整描述
AUTHOR	作者
REPORTING BUGS	报告的错误
COPYRIGHT	版权
SEE ALSO	查看相关信息

我们平时查询命令的时候，大多数关注的都是第二项和第三项。

进行具体分析

section

首先我们可以看到左上角有大写的MKDIR(1),其中的(1)是什么意思呢?又从何而来？
因为在man手册中，将各类命令分为9大section。

section序号	section的含义
1	可执行文件或者shell命令
2	系统调用（内核提供的函数）
3	库函数
4	特别的文件（通常在/dev）
5	文件格式，如/etc/passwd
6	游戏
7	杂项（包括宏包）
8	系统管理员命令（通常给root用户使用）
9	内核例程（非标准例程）

如需查看section的具体内容，可以使用命令

man man

进行查看。
那么这一部分对我们来说有什么用呢？
上图所示，是在可执行文件这个板块的，此处需要知道，如果没有指定man在哪个板块中寻找，将会按照默认的顺序查找这些板块中的命令，只返回含有该命令的第一个文档，如果指定板块，则只会在指定板块中寻找该命令，所以有时候直接man而不指定板块则可能不会找到自己想要的文档。
例如

man 5 passwd

我们指定板块序号为5，所以会在第五板块中寻找符合要求的文档。

分析具体结构

依旧以mkdir为例

1、NAME部分（名称）

mkdir是命令的name
含义：make directories，中文意思为：创建目录

2、SYNOPSIS部分（摘要，命令语法）

mkdir [OPTION]... DIRECTORY...

“OPTIONS”左右有”[“和”]”，表示这些参数并不必须，但是可以使用。对应的DIRECTORY两边没有”[]”，就是必须要加的参数了。
另外，它们后面都有”…” ，表示这些参数可以重复使用多次。

3、DESCRIPTION部分（描述）

Create the DIRECTORY(ies), if they do not already exist.
中文意思为：如果目录不存在，则创建目录。

文档中有几个具体的运行命令，此处不再一一列举。

4、AUTHOR

命令的作者

5、REPORTING BUGS（已报告的错误）

GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
Report mkdir translation bugs to <https://translationproject.org/team/>

分别是在线帮助以及报告错误的网址

6、COPYRIGHT（版权）

  Copyright (C) 2018 Free Software Foundation, Inc.  License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
       This is free software: you are free to change and redistribute it.  There is NO WARRANTY, to the extent permitted by law.

7、SEE ALSO（查看相关信息的位置）

       mkdir(2)

       Full documentation at: <https://www.gnu.org/software/coreutils/mkdir>
       or available locally via: info '(coreutils) mkdir invocation'

大意为在2板块中也有相关的文档。

man手册页的基本操作

此处仅仅介绍了两个命令，如需使用更多命令可以使用命令

man man

来查看更多man命令的参数

1.查找信息

如果你已经进入文档页面，那么可以使用“/”键进行正则表达式的搜索
如果你不知道索要打开的文档的名称可以使用命令

man -k
例如 man -k mkdir

2.退出man手册

举例结束了，该退下了，那么如何退出man手册呢？
非常简单，只需要轻轻按下键盘上的“q”即可退出man。
至此，man手册功成身退
如有错误，还请各位大佬指点一二，欢迎来共同探讨哦