aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/be.1.txt
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/be.1.txt
parent06e30d93038de9da326e4bc5c5ed7154b83a18e6 (diff)
downloadbugseverywhere-2aeaa4e265deb093a5e37c5973deb8d932974491.tar.gz
Use Docutils' rst2doc instead of DocBook XML to generate man page.
Diffstat (limited to 'doc/man/be.1.txt')
-rw-r--r--doc/man/be.1.txt72
1 files changed, 72 insertions, 0 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