aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorW. Trevor King <wking@drexel.edu>2011-01-10 22:30:11 -0500
committerW. Trevor King <wking@drexel.edu>2011-01-10 22:30:11 -0500
commit2aeaa4e265deb093a5e37c5973deb8d932974491 (patch)
treecc898d16a4e8f5d32013ecdd854e2a7d7ba035f8 /doc/man
parent06e30d93038de9da326e4bc5c5ed7154b83a18e6 (diff)
downloadbugseverywhere-2aeaa4e265deb093a5e37c5973deb8d932974491.tar.gz
Use Docutils' rst2doc instead of DocBook XML to generate man page.
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/be.1.txt72
-rw-r--r--doc/man/be.1.xml133
2 files changed, 72 insertions, 133 deletions
diff --git a/doc/man/be.1.txt b/doc/man/be.1.txt
new file mode 100644
index 0000000..a636a18
--- /dev/null
+++ b/doc/man/be.1.txt
@@ -0,0 +1,72 @@
+==
+be
+==
+
+----------------------------------------------
+distributed bug tracking from the command line
+----------------------------------------------
+
+:Author: wking@drexel.edu
+:Date: 2011-01-10
+:Copyright: 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.
+:Version: 0.2
+:Manual section: 1
+:Manual group: distributed bug tracker
+
+SYNOPSIS
+========
+
+be [options] [command] [command_options] [commands_args...]
+
+DESCRIPTION
+===========
+
+``be`` allows commandline interaction with the Bugs Everywhere
+database in a project tree.
+
+To avoid bit-rotted documentation, we do not describe all available
+commands and options in this manpage. Run ``be help`` for accurate
+documentation. See the `Bugs Everywhere Manual`_ for more detailed
+documentation and tutorials.
+
+.. _Bugs Everywhere Manual: http://docs.bugseverywhere.org/
+
+COMMANDS
+========
+
+help
+ Print help for ``be`` and a list of all available commands.
+
+Run ``be help`` for a complete list.
+
+EXAMPLES
+========
+
+be help
+ Show general help and a list of all commands.
+
+be help init
+ Show help for the ``init`` command.
+
+be init
+ Initialize a new Bugs Everywhere database.
+
+BUGS
+====
+
+The Bugs Everywhere uses Bugs Everywhere to track its bugs. You can
+submit bugs directly using ``be``::
+
+ % be --repo http://bugs.bugseverywhere.org/ new "The demuxulizer is broken"
+ Created bug with ID bea/abc
+ % be --repo http://bugs.bugseverywhere.org/ comment bea/abc
+ <Describe bug>
+ % be --repo http://bugs.bugseverywhere.org/ commit "Reported bug in demuxulizer"
+
+Or send an email to the mailing list at `be-devel@bugseverywhere.org`_.
+
+.. _be-devel@bugseverywhere.org:
+ http://void.printf.net/cgi-bin/mailman/listinfo/be-devel
diff --git a/doc/man/be.1.xml b/doc/man/be.1.xml
deleted file mode 100644
index 3b5c8d0..0000000
--- a/doc/man/be.1.xml
+++ /dev/null
@@ -1,133 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE article [
- <!ENTITY dhfirstname "Ben">
- <!ENTITY dhsurname "Finney">
- <!ENTITY dhusername "&dhfirstname; &dhsurname;">
- <!ENTITY dhemail "ben+debian@benfinney.id.au">
- <!ENTITY dhdate "2010-09-28">
- <!ENTITY dhsection "1">
- <!ENTITY pkgfullname "Bugs Everywhere">
- <!ENTITY uccmdname "BE">
- <!ENTITY cmdname "be">
-]>
-
-<article xmlns="http://docbook.org/ns/docbook" version="5.0"
- xmlns:xlink="http://www.w3.org/TR/xlink/">
-<title>&pkgfullname; Refentries</title>
-<refentry>
- <info>
- <productname>Debian</productname>
- <date>&dhdate;</date>
- <address>
- <email>&dhemail;</email>
- </address>
- <authorgroup>
- <author>
- <firstname>&dhfirstname;</firstname>
- <surname>&dhsurname;</surname>
- <contrib>Created the initial SGML version of this manpage for
- the Debian system.</contrib>
- <address>
- <email>&dhemail;</email>
- </address>
- </author>
- <author>
- <firstname>W. Trevor</firstname>
- <surname>King</surname>
- <contrib>Converted this manpage to DocBook 5 XML and extended
- following
- <citerefentry>
- <refentrytitle>dh_make</refentrytitle>
- <manvolnum>8</manvolnum>
- </citerefentry>'s
- <filename>manpage.xml.ex</filename>.</contrib>
- <address>
- <email>&dhemail;</email>
- </address>
- </author>
- </authorgroup>
- <copyright>
- <year>2009</year>
- <year>2010</year>
- <holder>&dhusername;</holder>
- </copyright>
- <legalnotice>
- <para>This manual page was written for the Debian system
- (and may be used by others).</para>
- <para>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.</para>
- <para>On Debian systems, the complete text of the GNU General Public
- License can be found in
- <filename>/usr/share/common-licenses/GPL</filename>.</para>
- </legalnotice>
- </info>
- <refmeta>
- <refentrytitle>&uccmdname;</refentrytitle>
- <manvolnum>&dhsection;</manvolnum>
- </refmeta>
- <refnamediv>
- <refname>&cmdname;</refname>
- <refpurpose>distributed bug tracker</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>&cmdname;</command>
- <arg><replaceable>options</replaceable></arg>
- <arg><replaceable>command</replaceable></arg>
- <arg><replaceable>command_options</replaceable></arg>
- <arg rep="repeat"><replaceable>command_args</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1 id="description">
- <title>DESCRIPTION</title>
-
- <para>This manual page documents briefly the
- <command>&cmdname;</command> command, part of the &pkgfullname;
- package.</para>
-
- <para><command>&cmdname;</command> allows commandline interaction
- with the &pkgfullname; database in a project tree.</para>
-
- <para>To avoid bit-rotted documentation, we do not describe all
- available commands and options in this manpage.
- Run <command>&cmdname; help</command> for accurate
- documentation. See
- the <link xlink:href="http://docs.bugseverywhere.org/">&pkgfullname;
- Manual</link> for more detailed documentation and
- tutorials.</para>
-
- </refsect1>
- <refsect1 id="commands">
- <title>COMMANDS</title>
- <variablelist>
- <varlistentry>
- <term><command>help</command>
- </term>
- <listitem>
- <para>Print help for <command>be</command> and a list of all
- available commands.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1 id="examples">
- <title>EXAMPLES</title>
- <glosslist>
- <glossentry>
- <glossterm><command>&cmdname; help</command></glossterm>
- <glossdef>
- <para>Show general help and a list of all commands.</para>
- </glossdef>
- </glossentry>
- <glossentry>
- <glossterm><command>&cmdname; help init</command></glossterm>
- <glossdef>
- <para>Show help for the <command>init</command> command.</para>
- </glossdef>
- </glossentry>
- </glosslist>
- </refsect1>
-</refentry>
-</article>