| HELP2MAN(1) | 用户命令 | HELP2MAN(1) |
名称¶
help2man - 输出一份简单的手册页
描述¶
`help2man' 根据 `--help' 和 `--version' 输出生成手册页面。
用法：help2man [选项]... 可执行程序
- -n, --name=STRING
- 名称段落的描述
- -s, --section=SECTION
- 手册页章节号 (1, 6, 8)
- -m, --manual=TEXT
- 手册名 (用户命令, ...)
- -S, --source=TEXT
- 程序来源 (FSF, Debian, ...)
- -L, --locale=STRING
- 选择语区 (默认 "C")
- -i, --include=FILE
- 从 `FILE' 包含材料
- -I, --opt-include=FILE
- 从 `FILE' 包含材料若其存在
- -o, --output=FILE
- 输出到 `FILE'
- -p, --info-page=TEXT
- Texinfo 手册名
- -N, --no-info
- 不输出到 Texinfo 手册的指示
- -l, --libtool
- 从程序名中忽略 `lt-' 前缀
- --help
- 打印此帮助并退出
- --version
- 打印版本号并退出
可执行程序应接纳 `--help' 和 `--version' 选项并输出到标准输出，尽管你也可以这样指定替代:
- -h, --help-option=STRING
- 帮助选项字串
- -v, --version-option=STRING
- 版本选项字串
- --version-string=STRING
- 版本字串
- --no-discard-stderr
- 解析输出时包含标准错误
包含文件¶
附加材料可以通过 --include 和 --opt-include 选项加入生成的输出。格式很简单
[章节]
文字
/正则表达式/
文字
逐字 *roff 文字块将在给定的 [章节] （大小写不敏感）开始处，或在匹配 /正则表达式/ 的段后加入。
正则表达式模式使用 Perl 正则表达式语法指定，并可以跟随如下修饰符： i, s 或 m （参见 perlre(1) ）.
第一节前的行，或由 `-' 开始的模式，将被认为是选项。 其他的都将被安静地忽略，可被用作注释、RCS 关键字等。
章节输出（包含的）顺序为：
名称
摘要
描述
选项
环境
文件
示例
其它
作者
报告程序臭虫
版权
参见
在包含文件中的任何 [名称] 或 [摘要] 章节都将替换自动生成的内容。如果有必要的话，你还是可以用 --name 覆盖前者。
其他章节会自动附加到以上自动生成章节之上，或按照它们在包含文件中出现的顺序包含于 其他 （以上）章节内。
文字在章节中的位置可分别用分别用以下方式来指明： [<章节], [=章节] 或 [>章节] ，分别将附加文字置于默认文字之前、替代默认文字和置于其后。
可用性¶
本发行的最新版本可以在此处在线找到:
作者¶
作者 Brendan O'Dea <bod@debian.org>
报告程序臭虫¶
报告错误给 <bug-help2man@gnu.org>.
版权所有 (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 自由软件基金会。 本软件为自由软件；参见源码以获取分发条件。本软件不含任何保证，甚至不含对于适销性和对某一 特定用途的适用性的保证。
参见¶
help2man 的完整文档以 Texinfo 手册的形式维护。若 info 和 help2man 程序在你处已安装妥当，运行命令
- info help2man
应可提供完整文档。
| 2018 二月 | help2man 1.47.6 |