aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGuido Guenther <agx@sigxcpu.org>2006-10-04 19:36:39 +0200
committerGuido Guenther <agx@bogon.sigxcpu.org>2006-10-04 19:36:39 +0200
commit8bf69562ee4059d188e1d2715ad8168a01039fea (patch)
treec8703f6dc553252faf97755d805eab84b93dfc62 /docs
parent45ee9dfaa901bbb182903b1a3d157f2ee10f6720 (diff)
add manpages
Diffstat (limited to 'docs')
-rw-r--r--docs/entities14
-rw-r--r--docs/git-buildpackage.sgml128
-rw-r--r--docs/git-import-dsc.sgml102
-rw-r--r--docs/git-import-orig.sgml121
4 files changed, 365 insertions, 0 deletions
diff --git a/docs/entities b/docs/entities
new file mode 100644
index 0000000..2884605
--- /dev/null
+++ b/docs/entities
@@ -0,0 +1,14 @@
+ <!ENTITY dhfirstname "<firstname>Guido</firstname>">
+ <!ENTITY dhsurname "<surname>Guenther</surname>">
+ <!ENTITY dhdate "<date>2006-10-02</date>">
+ <!ENTITY dhsection "<manvolnum>1</manvolnum>">
+ <!ENTITY dhemail "<email>agx@sigxcpu.org</email>">
+ <!ENTITY dhusername "&dhfirstname; &dhsurname">
+ <!ENTITY git-buildpackage "<command>git-buildpackage</command>">
+ <!ENTITY git-import-orig "<command>git-import-orig</command>">
+ <!ENTITY git-import-dsc "<command>git-import-dsc</command>">
+
+ <!ENTITY debian "<productname>Debian</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
+
diff --git a/docs/git-buildpackage.sgml b/docs/git-buildpackage.sgml
new file mode 100644
index 0000000..06a5401
--- /dev/null
+++ b/docs/git-buildpackage.sgml
@@ -0,0 +1,128 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % ENTS SYSTEM "entities">
+ %ENTS;
+ <!ENTITY dhucpackage "<refentrytitle>git-buildpackage</refentrytitle>">
+ ]>
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&git-buildpackage;</refname>
+ <refpurpose>Build Debian packages from a Git repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &git-buildpackage;
+
+ <arg><option>--git-ignore-new</option></arg>
+ <arg><option>--git-tag</option></arg>
+ <arg><option>--git-verbose</option></arg>
+ <arg><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &git-buildpackage; is used to build Debian source and .deb packages from a GIT repository.
+ </para>
+ <para>
+ &git-buildpackage; will, in order:
+ </para>
+ <itemizedlist>
+ <listitem><para>Verify that it is being executed from the
+ proper location.</para>
+ </listitem>
+ <listitem><para>Call <application>debuild</application> (1)
+ (or the application specified via --git-builder)
+ with arguments instructing it to ignore Git meta-data in
+ the diff.gz, passing along all arguments given to
+ &git-buildpackage; that don't start with --git-.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--git-ignore-new</option>
+ </term>
+ <listitem>
+ <para>Build the .diff.gz and debian package although there are
+ uncommitted changes in the source tree.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--git-tag</option>
+ </term>
+ <listitem>
+ <para>Add a git tag after a successfull build.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></term>
+ <listitem>
+ <para>Use <replaceable>BUILD_CMD</replaceable> instead of <command>debuild</command></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term><option>--git-verbose</option>
+ </term>
+ <listitem>
+ <para>Verbose execution</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>git-import-dsc (1), git-import-orig (1), debuild (1), git (1)</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</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/docs/git-import-dsc.sgml b/docs/git-import-dsc.sgml
new file mode 100644
index 0000000..7cfb344
--- /dev/null
+++ b/docs/git-import-dsc.sgml
@@ -0,0 +1,102 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % ENTS SYSTEM "entities">
+ %ENTS;
+ <!ENTITY dhucpackage "<refentrytitle>git-import-dsc</refentrytitle>">
+ ]>
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&git-import-dsc;</refname>
+
+ <refpurpose>Import Debian packages into a Git repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &git-import-dsc;
+
+ <arg><option>--verbose</option></arg>
+ <arg><option>--upstream-branch=<replaceable>branch_name</replaceable></option></arg>
+ <arg choice="plain"><replaceable>dsc_file</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &git-import-dsc; imports a Debian source package into a &git-buildpackage;
+ repository, notes the package version in the commit logs, and commits the
+ change. All information, including package name, version, Debian diffs,
+ and upstream source, is automatically detected from the source package.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--upstream-branch</option>
+ </term>
+ <listitem>
+ <para>The branch in the Git repository the upstream sources are put onto. Default is 'upstream'</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--verbose</option>,
+ <option>-v</option>
+ </term>
+ <listitem>
+ <para>Verbose execution.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>git-buildpackage (1), git-import-orig (1), git (1), git_load_dirs (1)</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</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/docs/git-import-orig.sgml b/docs/git-import-orig.sgml
new file mode 100644
index 0000000..ff09ccd
--- /dev/null
+++ b/docs/git-import-orig.sgml
@@ -0,0 +1,121 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % ENTS SYSTEM "entities">
+ %ENTS;
+ <!ENTITY dhucpackage "<refentrytitle>git-import-orig</refentrytitle>">
+ ]>
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&git-import-orig;</refname>
+
+ <refpurpose>Import an upstream source into a git-buildpackage repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &git-import-orig;
+
+ <arg><option>--verbose</option></arg>
+ <arg><option>--upstream-branch=<replaceable>branch_name</replaceable></option></arg>
+ <arg><option>--debian-branch=<replaceable>branch_name</replaceable></option></arg>
+ <arg><option>--upstream-version=<replaceable>version</replaceable></option></arg>
+ <arg choice="plain"><replaceable>tar_gz</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &git-import-orig; tar.gz file given by tar_gz into the git-buildpackage
+ repository. It tries to guess the version information from the tarball's
+ filename but it can also be specified on the command line.
+
+ When importing the new version <command>git_load_dirs</command> is being
+ used to detect file renames and removals.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--upstream-version</option>=<replaceable>version</replaceable>,
+ <option>-u</option> <replaceable>version</replaceable>
+ </term>
+ <listitem>
+ <para>The upstream version number</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
+ </term>
+ <listitem>
+ <para>The branch in the Git repository the upstream sources are put onto. Default is 'upstream'</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
+ </term>
+ <listitem>
+ <para>The branch in the Git repository the Debian package is being developed on, default is 'master'</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--verbose</option>,
+ <option>-v</option>
+ </term>
+ <listitem>
+ <para>Verbose execution.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>git-buildpackage (1), git-import-dsc (1), git (1), git_load_dirs (1)</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</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:
+-->
+
+