如何创建 Linux 手册页

命令 男子 在 Linux 上嵌入在每个 Linux 开发人员和用户的肌肉记忆中。几乎每个人都在使用它;从业余和新手开发人员到 Linux 专业人士和专家。

它用于阅读 Linux 命令、配置文件或任何其他功能的命令行手册页。手册页通常与在 Linux 中安装软件一起安装。手册页有定义的语法,由命令解析。

让我们为我编写的以下 bash 脚本创建一个手册页:

#!/bin/bash if [ "$1" == "h" ];然后 echo "Hello" fi if [ "$1" = "b" ];然后回声“再见”fi

这个脚本只做两件事:如果选项‘h’被指定为参数,它打印“Hello”,如果选项‘b’被指定为参数,它打印“Bye”。

让我们为这个程序创建一个手册页。利用 vim 或您选择的任何编辑器来创建文本文件。

vim 测试.1

扩展名“.1”表示此手册页用于可执行命令。这不是强制性的,而是在编写手册页时广泛遵循的惯例。 man 的手册页 (男人男人 !) 列出类别:

 1 可执行程序或 shell 命令 2 系统调用(内核提供的函数) 3 库调用(程序库中的函数) 4 特殊文件(通常在 /dev 中) 5 文件格式和约定,例如 /etc/passwd 6 游戏 7 杂项(包括宏包和约定),例如man(7), groff(7) 8 个系统管理命令(通常仅用于 root) 9 个内核例程 [非标准]

手册页是使用非常古老的 roff 标记语言创建的。它具有各种标题和部分的命令(阅读标记)。

  • .TH – 这应该是 man 文件中的第一个命令。它用于指定手册页的标题标题。
  • .SH – 章节标题。
  • .B – 用于以粗体显示其旁边的文本。
  • .TP – 用于显示有关命令的参数(标志)的信息。
  • .BR – 用于以粗体和普通罗马字体显示文本。

以下是我仅使用上述(简单)roff 命令创建的程序的手册页。

.TH test.sh 1 .SH NAME test.sh \- Print Hello or Bye .SH SYNOPSIS .B test.sh [ h ] [ b ] .SH 描述 .B test.sh 这是一个只做两件事的示例脚本.如果参数是'h',它要么打印“Hello”,要么如果参数是'b',它打印“Bye” .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

保存文件 首先按下 退出 键,然后键入 :wq 保存文件并退出 vim 控制台。

使用以下命令测试我们刚刚创建的手册页:

人 ./test.1

有关更多信息 男子 使用,运行 手册页 终端中的命令。

? 小费

这是编写手册页的基本语法。为了使事情更容易,您可以使用 txt2man 等工具将某种标记语言格式的文件转换为 roff 格式。