Linux Man手册的使用示例

Linux的命令非常多,很多人在学一个命令时,首先想到的是使用百度或者谷歌,或者参考书上给出怎么使用的例子。但授人以鱼不如授人以渔,通过man该命令可以得到关于该命令的有用信息。当我们学会使用man文档时,将大大提升使用命令的能力。这里,本人认为更多人是不知道列出的选项怎么用,有什么规律,导致不想使用man。为此,本文通过对mkdir的命令文档进行解释,并给出使用示例,希望对读者们有所帮助。

一、man命令

man将各类命令分为9个模块:

模块 含义
1 可执行文件或者shell命令
2 系统调用(内核提供的函数)
3 库函数
4 特别的文件(通常在/dev)
5 文件格式,如/etc/passwd
6 游戏
7 杂项(包括宏包)
8 系统管理员命令(通常给root用户使用)
9 内核例程(非标准例程)
那么,这部分和我们有什么关系呢?事实上,当我们man一个命令的时候,默认会从这些模块中查找,但找到的可能不是我们想要的。例如
 man mkdir
得到:
这里写图片描述

我们确实得到了mkdir命令的帮助文档。但是如果我要查询mkdir这个系统调用呢?这时就不是我想要的了。从上面表格,可以知道系统调用是在第二部分,这时就要用如下命令:

man 2 mkdir
这里写图片描述

这时看到的是MKDIR(2),表示是系统调用这个板块的。要知道,man在没有指定板块时,将使用一种默认的顺序查找这些板块中的命令,只返回含有该命令的第一个文档。当指定板块时,只从该板块中查找。所以,当我们man得不到想要的文档时,就要给出板块号了。
下面,我们来对剩余的一些板块的命令举一个例子。

man 3 fread

这里写图片描述
man 4 tty
这里写图片描述
man 5 passwd
这里写图片描述

这时展示的是/etc/passwd的格式。

二、man mkdir

这里以man mkdir为例,解释这个文档里面的内容。为了方便,这里对所有非空行添加了行号。
     1  MKDIR(1)                            User Commands                            MKDIR(1)
       
       
       
     2  NAME
     3         mkdir - make directories
       
     4  SYNOPSIS
     5         mkdir [OPTION]... DIRECTORY...
       
     6  DESCRIPTION
     7         Create the DIRECTORY(ies), if they do not already exist.
       
     8         Mandatory arguments to long options are mandatory for short options too.
       
     9         -m, --mode=MODE
    10                set file mode (as in chmod), not a=rwx - umask
       
    11         -p, --parents
    12                no error if existing, make parent directories as needed
       
    13         -v, --verbose
    14                print a message for each created directory
       
    15         -Z     set  SELinux  security context of each created directory to the default
    16                type
       
    17         --context[=CTX]
    18                like -Z, or if CTX is specified then set the SELinux or SMACK  security
    19                context to CTX
       
    20         --help display this help and exit
       
    21         --version
    22                output version information and exit
       
    23  AUTHOR
    24         Written by David MacKenzie.
       
    25  REPORTING BUGS
    26         GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
    27         Report mkdir translation bugs to <http://translationproject.org/team/>
       
    28  COPYRIGHT
    29         Copyright  © 2014 Free Software Foundation, Inc.  License GPLv3+: GNU GPL ver‐
    30         sion 3 or later <http://gnu.org/licenses/gpl.html>.
    31         This is free software: you are free to change and redistribute it.   There  is
    32         NO WARRANTY, to the extent permitted by law.
       
    33  SEE ALSO
    34         mkdir(2)
       
    35         Full documentation at: <http://www.gnu.org/software/coreutils/mkdir>
    36         or available locally via: info '(coreutils) mkdir invocation'
       
       
       
    37  GNU coreutils 8.23                  November 2014                            MKDIR(1)

2.1 man命令文档的构成

可以看出,文档有几个部分:
部分 解释
NAME 命令的名字
SYNOPSIS 命令的格式
DESCRIPTION 语法,主要是一些选项
AUTHOR 命令的作者
REPORTING BUGS 报告bug的链接
COPYRIGHT 版权
SEE ALSO 更多参考
一般情况下还可能有其他部分,如EXAMPLES,这个部分会给出命令的使用示例。首先,来看看第5行:
mkdir [OPTION]... DIRECTORY...
这一行定义了命令的使用格式。[]表示可选,也就是可以添加OPTION,也可以不用添加OPTION。而DIRECTORY不可以缺少,必须至少有一个。...表示可以有多个。如:

a. 无选项,一个DIRECTORY

mkdir mk1

b. 无选项,两个DIRECTORY

mkdir mk2 mk3

c. 两个选项,两个DIRECTORY

mkdir -m 775 -p mk4/tmp mk5
结果:
这里写图片描述

2.2 参数的使用

接着看第8行:
Mandatory arguments to long options are mandatory for short options too.
这句话的意思是:对于长选项必不可少的参数对短选项来说也是必不可少的。
通常一个选项可以用-开头,给出首个字母,这时是短选项。也可以用--开头,给出全名,这时是长选项。如第9行:
-m, --mode=MODE
表示既可以用-m这个短选项,也可以用--mode这个长选项。
另外,后面有一个参数MODE,这个参数是指定被创建目录的权限,而且这个参数是必不可少的,因为没有加[]。这时的用法是-m MODE 或者--mode=MODE。但对于短选项来说,在-m MODE之间的空格一般可以去掉,即变成-mMODE。
这里写图片描述

不管哪种情况,MODE这个参数不能去掉。上面提示丢失了参数,出错。

2.3 使用剩余的选项

剩余的选项类似上面的情况,使用示例如下:
这里写图片描述

注:
本文来自Linux Man手册的使用示例

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,012评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,628评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,653评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,485评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,574评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,590评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,596评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,340评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,794评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,102评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,276评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,940评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,583评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,201评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,441评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,173评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,136评论 2 352

推荐阅读更多精彩内容