help2man

将 --help 和 --version 转换为 man 页。

类似项目

• GNU help2man 为具有 --help 和 --version 的任何程序生成 man 页。用 perl 编写。
• click-man 为基于 click 的 Python 程序生成 man 页。用 python 编写。
• cli2man 为具有 --help 和 --version 的任何程序生成 man 页和 markdown。用 python 编写。
• 本项目：为具有 --help 和 --version 或基于 argparse 的任何 Python 程序生成 man 页、markdown 或任何格式（如果您提供了一个 jinja 模板）。

意图

这是 GNU help2man 的 Python 版本。它解决了以下问题[^email]

GNU help2man 无法正确转换 argparse

因为 argparse 输出

usage: help2man [-h] ...
                executable ...

Convert --help and --version to man page.

positional arguments:
  executable            executable program name
  ...

options:
  -h                    show this help message and exit
  ...

help2man 将忽略 位置参数： 和 选项：，因为它只检测到 选项：。它错误地将第一行视为摘要，并将其他行视为描述。

GNU help2man 无法自定义模板

我提供了 help2man --template XXX 和 help2man --template-file XXX 来实现这一点。模板语言是 jinja2。请参阅 模板 作为示例。

GNU help2man 不提供任何编程 API

现在您可以在 Python 中使用它。如果您想在构建 Python 项目时自动生成 man 页面，请参阅 setuptools-generate

参阅 文档 了解更多信息。

[^email]: 我向 GNU help2man 的作者发送了电子邮件，但没有收到回复。