aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/be.1.sgml247
-rw-r--r--doc/module.mk31
2 files changed, 278 insertions, 0 deletions
diff --git a/doc/be.1.sgml b/doc/be.1.sgml
new file mode 100644
index 0000000..5e6efc3
--- /dev/null
+++ b/doc/be.1.sgml
@@ -0,0 +1,247 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+<!-- Process this file with docbook-to-man to generate an nroff manual
+ page: `docbook-to-man manpage.sgml > 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.
+
+ -->
+
+ <!ENTITY dhfirstname "<firstname>Ben</firstname>">
+ <!ENTITY dhsurname "<surname>Finney</surname>">
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>2008-04-21</date>">
+ <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+ allowed: see man(7), man(1). -->
+ <!ENTITY dhsection "<manvolnum>1</manvolnum>">
+ <!ENTITY dhemail "<email>ben+debian@benfinney.id.au</email>">
+ <!ENTITY dhusername "Ben Finney">
+ <!ENTITY dhucpackage "<refentrytitle>BUGS-EVERYWHERE</refentrytitle>">
+ <!ENTITY dhpackage "bugs-everywhere">
+ <!ENTITY pkgfullname "Bugs Everywhere">
+ <!ENTITY uccmdname "<refentrytitle>BE</refentrytitle>">
+ <!ENTITY cmdname "be">
+
+ <!ENTITY debian "<productname>Debian</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2008</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &uccmdname;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&cmdname;</refname>
+
+ <refpurpose>distributed bug tracker</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&cmdname;</command>
+ <arg><replaceable>command</replaceable></arg>
+ <arg><replaceable>command_options ...</replaceable></arg>
+ <arg><replaceable>command_args ...</replaceable></arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>&cmdname; help</command>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>&cmdname; help</command>
+ <arg><replaceable>command</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <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>
+
+ </refsect1>
+ <refsect1>
+ <title>COMMANDS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><command>assign</command>
+ </term>
+ <listitem>
+ <para>Assign an individual or group to fix a bug
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>close</command>
+ </term>
+ <listitem>
+ <para>Close a bug
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>comment</command>
+ </term>
+ <listitem>
+ <para>Add a comment to a bug
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>diff</command>
+ </term>
+ <listitem>
+ <para>Compare bug reports with older tree
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>help</command>
+ </term>
+ <listitem>
+ <para>Print help for given subcommand
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>inprogress</command>
+ </term>
+ <listitem>
+ <para>Bug fixing in progress
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>list</command>
+ </term>
+ <listitem>
+ <para>List bugs
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>new</command>
+ </term>
+ <listitem>
+ <para>Create a new bug
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>open</command>
+ </term>
+ <listitem>
+ <para>Re-open a bug
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>set</command>
+ </term>
+ <listitem>
+ <para>Change tree settings
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>set-root</command>
+ </term>
+ <listitem>
+ <para>Assign the root directory for bug tracking
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>severity</command>
+ </term>
+ <listitem>
+ <para>Show or change a bug's severity level
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>show</command>
+ </term>
+ <listitem>
+ <para>Show a particular bug
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>target</command>
+ </term>
+ <listitem>
+ <para>Show or change a bug's target for fixing
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>upgrade</command>
+ </term>
+ <listitem>
+ <para>Upgrade the bugs to the latest format
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>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.
+ </para>
+ <para>
+ On Debian systems, the complete text of the GNU General Public
+ License can be found in /usr/share/common-licenses/GPL.
+ </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
diff --git a/doc/module.mk b/doc/module.mk
new file mode 100644
index 0000000..1b365c8
--- /dev/null
+++ b/doc/module.mk
@@ -0,0 +1,31 @@
+# :vim: filetype=make : -*- makefile; coding: utf-8; -*-
+
+# doc/module.mk
+# Part of Bugs Everywhere, a distributed bug tracking system.
+#
+# Copyright © 2008 Ben Finney <ben+python@benfinney.id.au>
+# This is free software; you may copy, modify and/or distribute this work
+# under the terms of the GNU General Public License, version 2 or later.
+# No warranty expressed or implied. See the file COPYING for details.
+
+# Makefile module for documentation
+
+MODULE_DIR := doc
+
+MANPAGES = be.1
+manpage_files = $(patsubst %,${MODULE_DIR}/%,${MANPAGES})
+
+GENERATED_FILES += ${manpage_files}
+
+
+.PHONY: doc
+doc: man
+
+build: doc
+
+
+.PHONY: man
+man: ${manpage_files}
+
+%.1: %.1.sgml
+ docbook-to-man $< > $@