名称

help2man - 输出一份简单的手册页

描述

`help2man' 根据 `--help' 和 `--version' 输出生成手册页面。

用法：help2man [选项]... 可执行程序

可执行程序应接纳 `--help' 和 `--version' 选项并输出到标准输出，尽管你也可以这样指定替代:

附加材料可以通过 --include 和 --opt-include 选项加入生成的输出。格式很简单

[章节]
文字

/正则表达式/
文字

逐字 *roff 文字块将在给定的 [章节] （大小写不敏感）开始处，或在匹配 /正则表达式/ 的段后加入。

正则表达式模式使用 Perl 正则表达式语法指定，并可以跟随如下修饰符： i, s 或 m （参见 perlre(1) ）.

第一节前的行，或由 `-' 开始的模式，将被认为是选项。其他的都将被安静地忽略，可被用作注释、RCS 关键字等。

章节输出（包含的）顺序为：

名称
摘要
描述
选项
其它
环境
文件
示例
作者
报告程序臭虫
版权
参见

在包含文件中的任何 [名称] 或 [摘要] 章节都将替换自动生成的内容。如果有必要的话，你还是可以用 --name 覆盖前者。

其他章节会自动附加到以上自动生成章节之上，或按照它们在包含文件中出现的顺序包含于其他（以上）章节内。

文字在章节中的位置可分别用分别用以下方式来指明： [<章节], [=章节] 或 [>章节] ，分别将附加文字置于默认文字之前、替代默认文字和置于其后。

本发行的最新版本可以在此处在线找到:

ftp://ftp.gnu.org/gnu/help2man/

作者 Brendan O'Dea <bod@debian.org>

报告错误给 <bug-help2man@gnu.org>.

help2man 的完整文档以 Texinfo 手册的形式维护。若 info 和 help2man 程序在你处已安装妥当，运行命令

应可提供完整文档。