如何创建手册页?
我正在为ubuntu打包一个程序,而且我得到一个lintian警告说我的二进制文件需要一个联机帮助页。
如何为程序创建手册页?
在Gmanedit的帮助下 您可以使用图形GUI创建联机帮助页。
Gtk + Manpages Editor是一个用X / GTK +运行的手册页编辑器。
Gmanedit是一个允许您在Linux / Unix系统上编辑手册页(man)的应用程序。
它就像最常见的HTML编辑器,但更容易。 您需要了解联机帮助页格式。
根据Debian FHS用户程序,联机帮助页存储在usr/share/man/man1
或usr/local/share/man/man1
。
在更改联机帮助页之后,通过在终端中运行mandb
来更新联机帮助页数据库可能是明智的。
有关联机帮助页语法的详细信息在man的联机帮助页中进行了总结。
您可以在docbook / refentry中编写联机帮助页,这是一种XML文档格式,
1 July 2008 VFPLOT 1 1 July 2008 vfplot plot vector fields with curved arrows. vfplot -a aspect -d file -D pen :
然后使用将结果转换为man格式
xsltproc /path/to/docbook.xsl vfplot.xml
用html来
docbook2html docbook2html
等等。 这不是编写联机帮助页的最简单方法,但如果您之前已经编写过XML,那么您已经知道了语法,这只是学习要使用的标记的问题。
给我一个旋转我刚上传它我写了一些应用程序,并一直遇到一个体面的手册页编辑器的麻烦
http://gtk-apps.org/content/show.php/Man+Page+Editor+?content=160219
这是一个gtk2应用程序,每个部分都有一个单独的选项卡,导入联机帮助页预览和导出都是支持的,没有深奥的格式化命令,这仍然在开发中,但肯定足够稳定使用。
你可以用autotools做到这一点。 GNU发布了一个示例,其中C项目使用autotools安装联机帮助页。