如何创建联机帮助页?


29

我正在打包一个用于ubuntu的程序,并且我收到一条林地警告,说我的二进制文件需要联机帮助。

如何为程序创建联机帮助页?

Answers:


23

借助Gmanedit, 安装gmanedit 您可以使用图形GUI创建手册页。

Gtk +手册页编辑器是在GTK +上的X上运行的手册页的编辑器。

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

就像大多数普通的HTML编辑器一样,但是更容易。您需要了解手册页格式。

在此处输入图片说明

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

更改手册页之后,明智的做法是mandb在终端中运行以更新手册页数据库。

有关manpage语法的详细信息,请参见man的手册


当然,您是对的。我打算对其进行更改,但是一看到MarcoCeppi,我就不想对其进行修改。:D
Lucio

@Lucio大声笑-那是从过去的时间,当时还没有apps.ubuntu;)
塔卡特(Takkat

3

您可以使用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,那么您已经知道语法,这只是学习要使用的标记的问题。


2

打个招呼我刚刚上传了它,我编写了许多应用程序,并且在使用体面的手册编辑器时遇到了麻烦

http://gtk-apps.org/content/show.php/Man+Page+Editor+?content=160219

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


1
该应用程序看起来很有趣。您能否在这里提供比链接更多的细节?
凯文·鲍文

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

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.