如何建立自己的man手册

  • 原创
  • |
  • 浏览:1686
  • |
  • 更新:
  • |
  • 标签:LINUX 

Linux中man手册非常好用,任何不了解的命令,都可以通过“man 命令”获得它的帮助。如何创建一个自己的man手册呢?本文会先介绍一个man手册是怎样制作出来的,再图解man手册定义和最终看到的man帮助的关系。

工具/原料

  • linux
  • man

方法/步骤

  1. 1

    打开Terminal,输入以下命令,创建一个路径,并将路径添加到系统环境变量中。

    mkdir -p tmp/man1

    chmod 777 tmp/man1 -R

    export MANPATH=$HOME/tmp

    如何建立自己的man手册
  2. 1
    该信息未经授权抓取自百度经验
  3. 2

    在上述目录中,创建一个testMan.1的文件,命令和内容如下:

    cd tmp/man1

    vim testMan.1

    以下是testMan.1文件内容:

    .\ "author : author name

    .TH testMan 1 "2017-12-28" "GNU" "User Commands"  \"  testMan(1)  User Commands  testMan(1)

                                                      \"  GNU       2017-17-28  testMan(1)

    .SH Name                                          \"  left

    testMan \- testMan use to do somehing

    .SH SYNOPSIS

    .B testMan

    .RB [\fB\-option1\fR]

    .RB [\-option2]

    .sp

    .SH DESCRIPTION

    this is a test man sample\&.

    .TP

    -a 1111111111111111111111111111111

    .TP

    -n 2222222222222222222222222222222

    .sp

    .sp

    .TP 3

    3333333333333333333333

    444

    如何建立自己的man手册
  4. 3

    给予testMan.1可执行权限,并备份它,接着再使用gzip命令生产gz文件,命令如下:

    chmod a+x testMan.1

    cp testMan.1 testMan.1.bak

    gzip testMan.1

    如何建立自己的man手册
  5. 4

    现在自己创建的man手册就制作好啦,输入以下命令即可获得testMan的帮助。

    man testMan

    如何建立自己的man手册
  6. 5

    现在我们可以对比一下man手册定义文件testMan.1文件和最后看到的man帮助之间的关系了,如下图,蓝色字为小编添加的注解,testMan.1文件与man帮助中相对应的部分用相同颜色的方格或线条标志出来了。朋友们可以根据这个图,制作自己的man手册。

    如何建立自己的man手册
  7. 6

    注意,请先将输入法切换成英文半角符号状态,再创建testMan.1文件。如果直接复制这篇经验步骤2的内容到testMan.1中,由于经验是在Windows电脑上写的,复制过去可能会产生格式的问题,可以在vim中输入以下命令切换成unix格式。

    :set ff=unix

    如何建立自己的man手册
    END

注意事项

  • 图有点大,看不清楚的话,请放大看哦。
  • 谢谢您的阅读,如果您觉得本文有用,请点赞哦。
经验内容仅供参考,如果您需解决具体问题(尤其法律、医学等领域),建议您详细咨询相关领域专业人士。
作者声明:本篇经验系本人依照真实经历原创,未经许可,谢绝转载。
展开阅读全部
相关标签LINUX