Befehlszeilenoptionen und Handbuchseiten

Weil man ebenso man-Hilfeseiten für ein docbook-Referenzeintrag erstellen kann, klingt es nach einer guten Idee, es für diesen Zweck einzusetzen. Auf diese Weise ist die Schnittstelle Teil der Referenz und man erhält kostenfrei die man-Hilfeseite.

7.1.1. Dokumentieren des Werkzeuges

Create one refentry file per tool. Following our example we would call it meep/docs/reference/meeper/meep.xml. For the xml tags that should be used and can look at generated file in the xml subdirectory as well as examples e.g. in glib.

7.1.2. Hinzufügen der zusätzlichen Configure-Überprüfungen

Beispiel 7-1Zusätzliche Configure-Überprüfungen
AC_ARG_ENABLE(man,
              [AC_HELP_STRING([--enable-man],
                              [regenerate man pages from Docbook [default=no]])],enable_man=yes,
              enable_man=no)

AC_PATH_PROG([XSLTPROC], [xsltproc])
AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)

            

7.1.3. Hinzufügen der zusätzlichen Makefile-Regeln

Beispiel 7-2Zusätzliche Configure-Überprüfungen
man_MANS = \
       meeper.1

if ENABLE_GTK_DOC
if ENABLE_MAN

%.1 : %.xml
        @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<

endif
endif

BUILT_EXTRA_DIST = $(man_MANS)
EXTRA_DIST += meep.xml