r385 - in /apt-transport-debtorrent/trunk/debian: 20debtorrent apt-transport-debtorrent.manpages apt-transport-debtorrent.sgml changelog control install rules

camrdale-guest at users.alioth.debian.org camrdale-guest at users.alioth.debian.org
Fri Jun 20 06:16:59 UTC 2008


Author: camrdale-guest
Date: Fri Jun 20 06:16:59 2008
New Revision: 385

URL: http://svn.debian.org/wsvn/debtorrent/?sc=1&rev=385
Log:
Add a config file for APT to load, and a manpage describing the options.

Added:
    apt-transport-debtorrent/trunk/debian/20debtorrent
    apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.manpages
    apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.sgml
Modified:
    apt-transport-debtorrent/trunk/debian/changelog
    apt-transport-debtorrent/trunk/debian/control
    apt-transport-debtorrent/trunk/debian/install
    apt-transport-debtorrent/trunk/debian/rules

Added: apt-transport-debtorrent/trunk/debian/20debtorrent
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/20debtorrent?rev=385&op=file
==============================================================================
--- apt-transport-debtorrent/trunk/debian/20debtorrent (added)
+++ apt-transport-debtorrent/trunk/debian/20debtorrent Fri Jun 20 06:16:59 2008
@@ -1,0 +1,10 @@
+// Options that apply to the debtorrent transport apt method
+
+// The timeout when downloading from the debtorrent method
+//Acquire::debtorrent::Timeout "300";
+
+// If true, apt will not store files downloaded from debtorrent in its cache
+//Acquire::debtorrent::NoCache "false";
+
+// Whether to display debugging messages from the debtorrent transport
+//Debug::Acquire::debtorrent "false";

Added: apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.manpages
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.manpages?rev=385&op=file
==============================================================================
--- apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.manpages (added)
+++ apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.manpages Fri Jun 20 06:16:59 2008
@@ -1,0 +1,1 @@
+debian/apt-transport-debtorrent.1

Added: apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.sgml
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.sgml?rev=385&op=file
==============================================================================
--- apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.sgml (added)
+++ apt-transport-debtorrent/trunk/debian/apt-transport-debtorrent.sgml Fri Jun 20 06:16:59 2008
@@ -1,0 +1,142 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+  <!ENTITY dhfirstname "<firstname>Cameron</firstname>">
+  <!ENTITY dhsurname   "<surname>Dale</surname>">
+  <!-- Please adjust the date whenever revising the manpage. -->
+  <!ENTITY dhdate      "<date>June 19, 2008</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>camrdale at gmail.com</email>">
+  <!ENTITY dhusername  "Cameron Dale">
+  <!ENTITY dhucpackage "<refentrytitle>apt-transport-debtorrent</refentrytitle>">
+  <!ENTITY dhpackage   "apt-transport-debtorrent">
+
+  <!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>2006</year>
+      <holder>&dhusername;</holder>
+    </copyright>
+    &dhdate;
+  </refentryinfo>
+  <refmeta>
+    &dhucpackage;
+
+    &dhsection;
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+
+    <refpurpose>an APT transport for communicating with DebTorrent</refpurpose>
+  </refnamediv>
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>The apt-transport-debtorrent package contains the APT debtorrent transport,
+        which gets installed in <replaceable>/usr/lib/apt/methods</replaceable>.
+        It makes it possible to use 'deb debtorrent://localhost:9988/foo distro main'
+        type lines in your sources.list file. You don't need to run the method
+        yourself, it will be started automatically by APT.</para>
+      
+    <para>This manual page documents briefly the options available to the debtorrent method.
+        For an overview of the DebTorrent program, see the 'debtorrent' package.</para>
+ 
+    <para>You don't actually need this package to use the DebTorrent program, it will
+        work fine using the regular http:// transport.</para>
+ 
+    <para>However, using this method has some advantages over HTTP. Unlike the
+        traditional HTTP method, this transport will send all possible requests to
+        DebTorrent as soon as it recieves them, which will speed up the download
+        as peers can be contacted in parallel. This method also allows the
+        DebTorrent client to return files to APT in any order, which is important
+        since BitTorrent downloads proceed in a random order. Additionally, this
+        method uses a very similar protocol to HTTP, and so can easily be used to
+        access a DebTorrent client running on another host.</para>
+  </refsect1>
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <para>The options below are used by APT when calling the debtorrent method. For a
+        description of how APT reads these options, see the apt.conf man page. The
+        options are available to be modified in the
+        <replaceable>/etc/apt/apt.conf.d/20debtorrent</replaceable> file.</para>
+    
+    <variablelist>
+      <varlistentry>
+        <term><option>Acquire::debtorrent::Timeout <replaceable>seconds</replaceable>;</option></term>
+         <listitem>
+          <para>the number of <replaceable>seconds</replaceable> of inactivity before
+                the request will timeout and the method will give up (defaults to 300)</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>Acquire::debtorrent::NoCache</option> true|false;</term>
+        <listitem>
+          <para>if this is true, then APT will not store copies of the downloaded
+                package files in its cache (defaults to false)</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>Debug::Acquire::debtorrent</option> true|false;</term>
+        <listitem>
+          <para>whether to output debugging messages while the method is downloading
+                files (defaults to false)</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry><refentrytitle>apt.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, 
+      <citerefentry><refentrytitle>debtorrent-client</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+  <refsect1>
+    <title>AUTHOR</title>
+    <para>This manual page was written by &dhusername; &lt;&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:
+-->

Modified: apt-transport-debtorrent/trunk/debian/changelog
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/changelog?rev=385&op=diff
==============================================================================
--- apt-transport-debtorrent/trunk/debian/changelog (original)
+++ apt-transport-debtorrent/trunk/debian/changelog Fri Jun 20 06:16:59 2008
@@ -2,8 +2,9 @@
 
   * Add a config option to make debtorrent sources local (Closes: #477383)
   * Upgrade the recommends on debtorrent to 0.1.7.
+  * Add a config file for APT to load, and a manpage describing the options.
 
- -- Cameron Dale <camrdale at gmail.com>  Thu, 19 Jun 2008 22:07:31 -0700
+ -- Cameron Dale <camrdale at gmail.com>  Thu, 19 Jun 2008 23:13:30 -0700
 
 apt-transport-debtorrent (0.2.0) unstable; urgency=low
 

Modified: apt-transport-debtorrent/trunk/debian/control
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/control?rev=385&op=diff
==============================================================================
--- apt-transport-debtorrent/trunk/debian/control (original)
+++ apt-transport-debtorrent/trunk/debian/control Fri Jun 20 06:16:59 2008
@@ -4,7 +4,7 @@
 Maintainer: Cameron Dale <camrdale at gmail.com>
 Homepage: http://debtorrent.alioth.debian.org/
 Standards-Version: 3.7.3
-Build-Depends: debhelper (>= 5.0), libapt-pkg-dev
+Build-Depends: debhelper (>= 5.0), libapt-pkg-dev, docbook-to-man
 Vcs-Svn: svn://svn.debian.org/debtorrent/apt-transport-debtorrent/trunk
 Vcs-Browser: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/
 XS-Dm-Upload-Allowed: yes

Modified: apt-transport-debtorrent/trunk/debian/install
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/install?rev=385&op=diff
==============================================================================
--- apt-transport-debtorrent/trunk/debian/install (original)
+++ apt-transport-debtorrent/trunk/debian/install Fri Jun 20 06:16:59 2008
@@ -1,1 +1,2 @@
 debtorrent /usr/lib/apt/methods
+debian/20debtorrent /etc/apt/apt.conf.d

Modified: apt-transport-debtorrent/trunk/debian/rules
URL: http://svn.debian.org/wsvn/debtorrent/apt-transport-debtorrent/trunk/debian/rules?rev=385&op=diff
==============================================================================
--- apt-transport-debtorrent/trunk/debian/rules (original)
+++ apt-transport-debtorrent/trunk/debian/rules Fri Jun 20 06:16:59 2008
@@ -13,7 +13,7 @@
 
 build: build-stamp
 
-build-stamp:
+build-stamp: apt-transport-debtorrent.1
 	dh_testdir
 
 	# Add here commands to compile the package.
@@ -21,8 +21,12 @@
 
 	touch $@
 
+%.1:	debian/%.sgml
+	/usr/bin/docbook-to-man $< > debian/$@
+
 clean:
 	dh_testdir
+	rm -f debian/*.1
 	rm -f build-stamp
 
 	# Add here commands to clean up after the build process.
@@ -51,6 +55,7 @@
 	dh_testroot
 	dh_installchangelogs 
 	dh_installdocs
+	dh_installman
 	dh_strip
 	dh_compress
 	dh_fixperms




More information about the Debtorrent-commits mailing list