-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
manpages: add man pages in xml format
- Loading branch information
Showing
8 changed files
with
1,344 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| <?xml version='1.0'?> | ||
| <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
|
|
||
| <!-- | ||
| manpage of bee-check | ||
| Copyright (C) 2013 | ||
| Matthias Ruester <ruester@molgen.mpg.de> | ||
| Lena Kristin Zander <zander@molgen.mpg.de> | ||
| This file is part of bee. | ||
| bee is free software; you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
| program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
| You should have received a copy of the GNU General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| --> | ||
|
|
||
| <refentry id="bee-check"> | ||
| <refentryinfo> | ||
| <title>bee - bau et einfach</title> | ||
| <productname>bee @BEE_VERSION@</productname> | ||
|
|
||
| <authorgroup> | ||
| <author> | ||
| <contrib></contrib> <!-- prevent warning --> | ||
| <firstname>Marius</firstname> | ||
| <surname>Tolzmann</surname> | ||
| <email>tolzmann@molgen.mpg.de</email> | ||
| </author> | ||
|
|
||
| <author> | ||
| <contrib></contrib> | ||
| <firstname>Tobias</firstname> | ||
| <surname>Dreyer</surname> | ||
| <email>dreyer@molgen.mpg.de</email> | ||
| </author> | ||
|
|
||
| <author> | ||
| <contrib></contrib> | ||
| <firstname>and other bee developers</firstname> | ||
| </author> | ||
| </authorgroup> | ||
| </refentryinfo> | ||
|
|
||
| <refmeta> | ||
| <refentrytitle>bee-check</refentrytitle> | ||
| <manvolnum>1</manvolnum> | ||
| </refmeta> | ||
|
|
||
| <refnamediv> | ||
| <refname>bee-check</refname> | ||
| <refpurpose>perform some consistency checks on a bee package</refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <refsynopsisdiv> | ||
| <cmdsynopsis> | ||
| <command>bee check</command> | ||
| <arg choice="opt">options</arg> | ||
| <arg choice="plain"><replaceable><pattern></replaceable></arg> | ||
| </cmdsynopsis> | ||
| </refsynopsisdiv> | ||
|
|
||
| <refsect1> | ||
| <title>Description</title> | ||
|
|
||
| <para><command>bee-check</command> is used to perform | ||
| consistency checks on a bee package matching | ||
| <replaceable>pattern</replaceable> and shows missing link | ||
| targets, missing files and directories or changed | ||
| md5 sums.</para> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Options</title> | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><option>-d, --deps, --dependencies</option></term> | ||
|
|
||
| <listitem><para>Print package dependencies.</para></listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><option>-f, --force</option></term> | ||
|
|
||
| <listitem><para>Check all packages matching <replaceable>pattern</replaceable> if it does not match a full packagename.</para></listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><option>-h, --help</option></term> | ||
|
|
||
| <listitem><para>Print a usage message.</para></listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Environment</title> | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><option>BEE_METADIR</option></term> | ||
| <listitem><para>Directory searched for installed bee packages</para></listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Bugs</title> | ||
| <para> | ||
| Please report bugs to bee-dev@googlegroups.com or directly to the authors. | ||
| </para> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>See Also</title> | ||
| <para> | ||
| <citerefentry><refentrytitle>bee</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-download</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-list</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-query</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-remove</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-update</refentrytitle><manvolnum>1</manvolnum></citerefentry> | ||
| </para> | ||
| </refsect1> | ||
| </refentry> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| <?xml version='1.0'?> | ||
| <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
|
|
||
| <!-- | ||
| manpage of bee-download | ||
| Copyright (C) 2013 | ||
| Lena Kristin Zander <zander@molgen.mpg.de> | ||
| This file is part of bee. | ||
| bee is free software; you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
| program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
| You should have received a copy of the GNU General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| --> | ||
|
|
||
| <refentry id="bee-download"> | ||
| <refentryinfo> | ||
| <title>bee - bau et einfach</title> | ||
| <productname>bee @BEE_VERSION@</productname> | ||
|
|
||
| <authorgroup> | ||
| <author> | ||
| <contrib></contrib> <!-- prevent warning --> | ||
| <firstname>Marius</firstname> | ||
| <surname>Tolzmann</surname> | ||
| <email>tolzmann@molgen.mpg.de</email> | ||
| </author> | ||
|
|
||
| <author> | ||
| <contrib></contrib> | ||
| <firstname>Tobias</firstname> | ||
| <surname>Dreyer</surname> | ||
| <email>dreyer@molgen.mpg.de</email> | ||
| </author> | ||
|
|
||
| <author> | ||
| <contrib></contrib> | ||
| <firstname>and other bee developers</firstname> | ||
| </author> | ||
| </authorgroup> | ||
| </refentryinfo> | ||
|
|
||
| <refmeta> | ||
| <refentrytitle>bee-download</refentrytitle> | ||
| <manvolnum>1</manvolnum> | ||
| </refmeta> | ||
|
|
||
| <refnamediv> | ||
| <refname>bee-download</refname> | ||
| <refpurpose>Download a repository and convert it into a source tarball</refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <refsynopsisdiv> | ||
| <cmdsynopsis> | ||
| <command>bee download</command> | ||
| <arg choice="opt">options</arg> | ||
| <arg choice="plain"><replaceable><repository-url></replaceable></arg> | ||
| </cmdsynopsis> | ||
| </refsynopsisdiv> | ||
|
|
||
| <refsect1> | ||
| <title>Description</title> | ||
|
|
||
| <para> | ||
| <command>bee-download</command> is used to download a repository and convert it | ||
| into a source tarball. This tarball can be used to create a beefile via | ||
| <command>bee-init</command>. | ||
| </para> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Options</title> | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><option>-n</option></term> | ||
| <term><option>--pkgname <replaceable><name></replaceable></option></term> | ||
|
|
||
| <listitem><para>Specify the tarball's package name.</para></listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><option>-v</option></term> | ||
| <term><option>--pkgversion <replaceable><version></replaceable></option></term> | ||
|
|
||
| <listitem><para>Specify the tarball's package version.</para></listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><option>-c</option></term> | ||
| <term><option>--commit <replaceable><rev></replaceable></option></term> | ||
|
|
||
| <listitem><para> | ||
| When downloading from a git repository: Use a certain commit | ||
| as the HEAD revision. | ||
| </para></listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><option>-t</option></term> | ||
| <term><option>--type</option></term> | ||
|
|
||
| <listitem><para> | ||
| Specify the type of download (http, https or git). | ||
| </para></listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><option>-h</option></term> | ||
| <term><option>--help</option></term> | ||
|
|
||
| <listitem><para>Print a usage message.</para></listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Environment</title> | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><option>BEE_DOWNLOADDIR</option></term> | ||
| <listitem><para>The downloaded file is placed here.</para></listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Bugs</title> | ||
| <para> | ||
| Please report bugs to bee-dev@googlegroups.com or directly to the authors. | ||
| </para> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>See Also</title> | ||
| <para> | ||
| <citerefentry><refentrytitle>bee</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-check</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-list</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-query</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-remove</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | ||
| <citerefentry><refentrytitle>bee-update</refentrytitle><manvolnum>1</manvolnum></citerefentry> | ||
| </para> | ||
| </refsect1> | ||
| </refentry> |
Oops, something went wrong.