path: root/doc/man/be.1.xml

<?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>