From: W. Trevor King Date: Wed, 29 Sep 2010 01:25:43 +0000 (-0400) Subject: Converted man page source to DocBook V5.0. X-Git-Tag: 1.0.0~5^2~4 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=8c9f876ae69f7bf92686edea320931d875b5c681;p=be.git Converted man page source to DocBook V5.0. This has the dual benefits of keeping up with the current DocBook standard as well as removing the dependency on SGML parsers like docbook-to-man and docbook2man which may not be available on all systems. An XSLT processor and the DocBook style sheets are easier dependencies to satisfy. --- diff --git a/Makefile b/Makefile index 0b96832..c7203df 100644 --- a/Makefile +++ b/Makefile @@ -26,7 +26,11 @@ # along with Bugs Everywhere. If not, see . SHELL = /bin/bash -RM = rm +RM = /bin/rm +DB2MAN = http://docbook.sourceforge.net/release/xsl-ns/current/manpages/docbook.xsl +XP = /usr/bin/xsltproc --nonet --param man.charmap.use.subset "0" \ + --param make.year.ranges "1" --param make.single.year.ranges "1" + #PATH = /usr/bin:/bin # must include sphinx-build for 'sphinx' target. #PREFIX = /usr/local @@ -75,8 +79,8 @@ libbe/_version.py: .PHONY: man man: ${MANPAGE_FILES} -%.1: %.1.sgml - docbook-to-man $< > $@ +%.1: %.1.xml + $(XP) -o $@ $(DB2MAN) $< .PHONY: sphinx sphinx: diff --git a/doc/man/be.1.sgml b/doc/man/be.1.sgml deleted file mode 100644 index a2df21f..0000000 --- a/doc/man/be.1.sgml +++ /dev/null @@ -1,134 +0,0 @@ - manpage.1'. You may view - the manual page with: `docbook-to-man manpage.sgml | nroff -man | - less'. A typical entry in a Makefile or Makefile.am is: - -be.1: be.1.sgml - docbook-to-man $< > $@ - - The docbook-to-man binary is found in the docbook-to-man package. - Please remember that if you create the nroff version in one of the - debian/rules file targets (such as build), you will need to include - docbook-to-man in your Build-Depends control field. - - --> - - Ben"> - Finney"> - - 2009-06-25"> - - 1"> - ben+debian@benfinney.id.au"> - - BUGS-EVERYWHERE"> - - - BE"> - - - Debian"> - GNU"> - GPL"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2009 - &dhusername; - - &dhdate; - - - &uccmdname; - - &dhsection; - - - &cmdname; - - distributed bug tracker - - - - &cmdname; - command - command_options ... - command_args ... - - - &cmdname; help - - - &cmdname; help - command - - - - DESCRIPTION - - This manual page documents briefly the - &cmdname; command, part of the - &pkgfullname; package. - - &cmdname; allows commandline interaction - with the &pkgfullname; database in a project tree. - - - - COMMANDS - - - help - - - Print help for be and a list of all available commands. - - - - - - - AUTHOR - - This manual page was written by &dhusername; <&dhemail;> for - the &debian; system (but may be used by others). Permission is - granted to copy, distribute and/or modify this document under - the terms of the &gnu; General Public License, Version 2 or any - later version published by the Free Software Foundation. - - - On Debian systems, the complete text of the GNU General Public - License can be found in /usr/share/common-licenses/GPL. - - - - - - diff --git a/doc/man/be.1.xml b/doc/man/be.1.xml new file mode 100644 index 0000000..3b5c8d0 --- /dev/null +++ b/doc/man/be.1.xml @@ -0,0 +1,133 @@ + + + + + + + + + + +]> + +
+&pkgfullname; Refentries + + + Debian + &dhdate; +
+ &dhemail; +
+ + + &dhfirstname; + &dhsurname; + Created the initial SGML version of this manpage for + the Debian system. +
+ &dhemail; +
+ + + W. Trevor + King + Converted this manpage to DocBook 5 XML and extended + following + + dh_make + 8 + 's + manpage.xml.ex. +
+ &dhemail; +
+ + + + 2009 + 2010 + &dhusername; + + + This manual page was written for the Debian system + (and may be used by others). + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU General Public License, + Version 2 or (at your option) any later version published by + the Free Software Foundation. + On Debian systems, the complete text of the GNU General Public + License can be found in + /usr/share/common-licenses/GPL. + + + + &uccmdname; + &dhsection; + + + &cmdname; + distributed bug tracker + + + + &cmdname; + options + command + command_options + command_args + + + + DESCRIPTION + + This manual page documents briefly the + &cmdname; command, part of the &pkgfullname; + package. + + &cmdname; allows commandline interaction + with the &pkgfullname; database in a project tree. + + To avoid bit-rotted documentation, we do not describe all + available commands and options in this manpage. + Run &cmdname; help for accurate + documentation. See + the &pkgfullname; + Manual for more detailed documentation and + tutorials. + + + + COMMANDS + + + help + + + Print help for be and a list of all + available commands. + + + + + + EXAMPLES + + + &cmdname; help + + Show general help and a list of all commands. + + + + &cmdname; help init + + Show help for the init command. + + + + + +