Skip to content

LV200-man命令简介

一、man 命令

man 是 manual 的简称,中文称之为手册。man 手册是 linux 系统提供的一种帮助手册,通过这个命令我们可以得到一些帮助信息, 其内容包括命令语法、各选项的意义及相关命令 。更为强大的是,不仅可以查看 Linux 中命令的使用帮助,还可以查看软件服务配置文件、系统调用、库函数等帮助信息。man 手册页文件存放在/usr/share/man 目录下。

1. man 手册安装

通常来说,系统只会默认安装第 1 册的 man 手册,也就是查找 shell 命令的 man 手册,若是发现自己的 man 手册有缺失,我们可以通过以下命令安装:

shell
sudo apt-get install manpages
sudo apt-get install manpages-dev
sudo apt-get install manpages-posix
sudo apt-get install manpages-posix-dev

2. man 命令

2.1 使用格式

使用 man 命令可以找到特定的联机帮助页,并提供简短的命令说明。联机帮助页提供了指定命令 command_name 的相关信息,包括:名称、函数、语法以及可选参数描述等。无论帮助有多长,都遵循这个格式显示。在页面很多的情况下使用 PageUp 和 PageDown 键翻页。最后,使用 :q 退出帮助页面。一般使用格式为:

shell
man [option] <name>

参数说明

  • option :man 命令的一些选项,是可选的。常见 option 选项如下:
option 说明
-a 在所有的 man 帮助手册中搜索
-f 显示给定关键字的简短描述信息
-p 指定内容时使用分页程序
-M 指定 man 手册搜索的路径
-w 显示文件所在位置
- name :要查询的命令名称或者要查询的函数名等。

2.2 使用实例

2.2.1 查询命令的帮助文档

我们在终端执行以下命令:

shell
man ls

然后我们就会进入 man 手册,我们会得到以下信息:

image-20221018174753735
2.2.2 查询有哪些页有帮助信息

我们在终端执行以下命令:

shell
man -f read

然后我们回的到以下信息:

shell
hk@vm:~$ man -f read
read (2)             - read from a file descriptor

3. 帮助信息的分类

我们在终端执行以下命令:

shell
man man

我们会得到 man 命令的班助手册,man 命令帮助我们查找需要的信息,这些信息可以分为以下几类:

编号说明
1可执行程序或 shell 命令
2系统调用(内核提供的函数)
3库调用(程序库中的函数)
4特殊文件(通常位于 /dev)
5文件格式和规范,如 /etc/passwd
6游戏
7杂项(包括宏包和规范,如 man(7),groff(7))
8系统管理命令(通常只针对 root 用户)
9内核例程(非标准)

可以看到其实 man 手册一共有 9 个章节,这 9 个章节帮助文档分别管理不同的帮助信息。我们可以使用前边的编号来直接查询相应册中的帮助信息,比如:

shell
man read   # 将会得到 read 命令的帮助手册
man 2 read # 将会得到 read() 函数的帮助手册

默认将按预定的顺序查找所有可用的章节 (默认是“ 1 n l 8 3 2 3posix 3pm 3perl 5 4 9 6 7 ”,除非被 /etc/manpath.config 中的 SECTION 指令覆盖),并只显示找到的第一个 页,即使多个章节中都有这个 页面。额,写笔记的时候忘记在哪看到的了,现在也看不太懂,不过我们知道 man 是按预定顺序来查找的就行,这不是重点。

4. 具体帮助页

一个手册页面包含若干个小节。小节名称通常包括 NAME,概述(SYNOPSIS),配置(CONFIGURATION),描述(DESCRIPTION),选项(OPTIONS),退出状态(EXIT STATUS),返回值(RETURN VALUE),错误(ERRORS),环境(ENVIRONMENT),文件(FILES),版本(VERSIONS),符合标准(CONFORMING TO),注(NOTES),缺陷(BUGS),示例(EXAMPLE),作者(AUTHORS),和 亦见(SEE ALSO)。常见的几个如下:

名称含义
NAME命令的名称
SYNOPSIS命令的语法格式
DESCRIPTION命令的一般描述以及用途
OPTIONS描述命令所有的参数或选项
SEE ALSO列出联机帮助页中与该命令直接相关或功 能相近的其他命令
BUGS解释命令或其输出中存在的任何已知的问题或缺陷
EXAMPLES普通的用法示例
AUTHORS联机帮助页以及命令的作者