☰

如何创建手册页？

tag-icon • tag-icon manpage
如何创建手册页？

我正在为 ubuntu 打包一个程序，我收到一个 lintian 警告，说我的二进制文件需要一个手册页。

如何为程序创建手册页？

答案1

在...的帮助下格曼尼蒂 安装 gmanedit 您可以使用图形用户界面 (GUI) 创建手册页。

Gtk+ Manpages Editor 是一个在装有 GTK+ 的 X 上运行的手册页编辑器。

Gmanedit 是一个允许您在 Linux/Unix 系统上编辑手册页 (man) 的应用程序。

它与大多数常见的 HTML 编辑器类似，但更简单。您需要了解手册页格式。

在此处输入图片描述

根据Debian FHS用户程序手册页存储在usr/share/man/man1或中usr/local/share/man/man1。

更改手册页后，最好通过mandb在终端中运行来更新手册页数据库。

总结了 manpage 语法的详细信息在 man 的手册页中。

答案2

您可以使用 docbook/refentry（一种 XML 文档格式）编写手册页，

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id='vfplot1'>
<refentryinfo><date>1 July 2008</date></refentryinfo>
<refmeta>
<refentrytitle>VFPLOT</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>1 July 2008</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>vfplot</refname>
<refpurpose>plot vector fields with curved arrows.</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>vfplot</command>    
  <arg choice='opt'>-a <replaceable>aspect</replaceable></arg>
  <arg choice='opt'>-d <replaceable>file</replaceable></arg>
  <arg choice='opt'>-D <replaceable>pen</replaceable></arg>
    :

然后使用以下方法将结果转换为 man 格式

xsltproc /path/to/docbook.xsl vfplot.xml

到 html 与

docbook2html docbook2html

等等。这不是编写手册页的最简单方法，但如果您以前编写过 XML，那么您已经了解语法，只需学习要使用的标签即可。

答案3

试试这个，我刚刚上传了它，我编写了许多应用程序，但在使用像样的手册页编辑器时遇到了麻烦

现在托管在 github、docs 和 repo 上： https://keithdhedger.github.io/pages/manpageeditor/manpageeditor.html https://github.com/KeithDHedger/ManPageEditor

这是一个 gtk2 应用程序，每个部分都有单独的选项卡，支持导入手册页、预览和导出，没有深奥的格式化命令，它仍在开发中，但肯定足够稳定可以使用。

答案4

您可以使用 autotools 来完成此操作。GNU 已发布示例，其中 C 项目使用 autotools 安装手册页。

相关内容