[apt-proxy-devel] r587 - in trunk: debian doc
Chris Halls
halls at costa.debian.org
Thu Jan 5 18:27:49 UTC 2006
Author: halls
Date: Thu Jan 5 18:27:48 2006
New Revision: 587
Modified:
trunk/debian/changelog
trunk/doc/apt-proxy.conf.5
Log:
Rework apt-proxy.conf manpage, with help from Roey Katz on IRC
Modified: trunk/debian/changelog
==============================================================================
--- trunk/debian/changelog (original)
+++ trunk/debian/changelog Thu Jan 5 18:27:48 2006
@@ -1,9 +1,13 @@
-apt-proxy (1.9.33) UNRELEASED; urgency=low
+apt-proxy (1.9.32+pre33) UNRELEASED; urgency=low
[ Debconf Translations ]
* Yuriy Talakan <yt at amur.elektra.ru>: ru.po (closes: #310326)
- -- Otavio Salvador <otavio at debian.org> Wed, 24 Aug 2005 19:25:26 -0300
+ [ Chris Halls ]
+ * Rework apt-proxy.conf manpage. Thanks to Roey Katz for all the
+ suggestions
+
+ -- Chris Halls <halls at debian.org> Thu, 5 Jan 2006 18:26:44 +0000
apt-proxy (1.9.32) unstable; urgency=low
Modified: trunk/doc/apt-proxy.conf.5
==============================================================================
--- trunk/doc/apt-proxy.conf.5 (original)
+++ trunk/doc/apt-proxy.conf.5 Thu Jan 5 18:27:48 2006
@@ -1,14 +1,22 @@
.\" Man page copied from apt.conf man page.
-.TH "apt\-proxy\&.conf" "5" "21 Nov 2002" "apt\-proxy" ""
+.TH "apt\-proxy\&.conf" "5" "5 Jan 2006" "apt\-proxy" ""
.SH "NAME"
apt\-proxy\&.conf \- configuration file for apt\-proxy
.PP
.SH "DESCRIPTION"
\fBapt\-proxy\&.conf\fP is the configuration file for apt\-proxy.
-When apt\-proxy starts up, it will read \fB/etc/apt\-proxy/apt\-proxy\&.conf\fP\&.
+When apt\-proxy starts up, it will read \fI/etc/apt\-proxy/apt\-proxy\&.conf\fP\&.
-\fB/etc/apt\-proxy/apt\-proxy-v2\&.conf\fP will be read instead if it exists to
+\fI/etc/apt\-proxy/apt\-proxy-v2\&.conf\fP will be read instead if it exists to
make upgrading from v1 easier.
+
+The configuration file is divided up into several sections, where each \fI[resource]\fP
+section defines a seperate resource. The \fBDEFAULT\fP section applies to all resources.
+
+The supplied \fIapt\-proxy\&.conf\fP will work out of the box, but it is best to
+change the backends you use to a mirror closer to you. There are some in the
+default file, and it may be enough just to reorder the lines in the file\&.
+
.PP
.SH [DEFAULT]
This section holds options global to the whole apt\-proxy:
@@ -81,32 +89,36 @@
http pipelining. Default: 1
.PP
-.SH BACKENDS
-All other sections will be interpreted as backend names, and the options
-specified within are local to the backend.
-
-The supplied apt\-proxy\&.conf will work out of the box, but I suggest you
-look for a mirror closer to you\&. There are some in the default
-apt\-proxy\&.conf and it may be enough just to reorder the lines in the file\&.
+.SH RESOURCES
+All other sections in the configuration file will be interpreted as resource
+names. The options in the section apply to this resource only.
.TP
.B timeout
Overrides the global timeout
.TP
-.B backends = "<protocol>://<server>/<directory>"
-A list of backend URLs\&.
+.B backends = "\fI<protocol>\fP://\fI<server>\fP/\fI<directory>\fP [...]"
+A list one or more URLs referring to servers which hold debian packages\&.
.br
-Protocol \- internet protocol to use: http, ftp or rsync
.br
-Server \- hostname of the backend server to contact
+\fIprotocol\fP: internet protocol to use: http, ftp or rsync
.br
-Directory \- directory name to prepend requests to for this server
+\fIserver\fP: hostname of the backend server to contact
+.br
+\fIdirectory\fP: directory name to prepend requests to for this server
.TP
.B passive_ftp
Override the global setting of passive_ftp
+.SH CONFIGURATION EXAMPLES
+
+To access a resource that's listed under a specific section name, simply append
+the section name (without the brackets) to the end of your deb source line in
+/etc/apt/sources.list
+
+.B Debian main
.PP
This example shows how to give clients access to the main Debian
archive:
@@ -117,11 +129,11 @@
.fi
.PP
-Using this configuration, the client would use a \fBsources.list\fP entry
+Using this configuration, the client would use a \fIsources.list\fP entry
like:
.nf
- deb http://server:9999/debian/ woody main
+ deb http://server:9999/debian woody main
.fi
And so the file request
@@ -137,11 +149,37 @@
`http://ftp.de.debian.org/debian/woody/main/binary\-i386/x11/foo_1\-1.deb'
-.nf
-and the file would be placed in
+.fi
+and apt\-proxy will place the downloaded package in
.nf
`/var/cache/apt\-proxy/debian/debian/woody/main/binary\-i386/x11/foo_1\-1.deb'\&.
+.fi
+.B backports.org
+.PP
+The backports.org website tells you to use this \fIsources.list\fP line:
+.nf
+
+ deb http://www.backports.org/debian sarge-backports main
+
+.fi
+You can add this to apt\-proxy by creating a new section in \fIapt\-proxy\&.conf\fP\&.
+In the new section, add a backends entry for the URL:
+.nf
+
+ [backports]
+ backends = http://www.backports.org/debian
+
+.fi
+On the clients, replace the URL with one pointing to the apt-proxy resource name, in
+the form \fIhttp://hostname:port/backend\fP. If your apt-proxy hostname is \fIproxy\fP and
+it is running on port 9999, you would write:
+.nf
+
+ deb http://proxy:9999/backports sarge-backports main
+
+.fi
+
.PP
For many more examples, see the supplied /etc/apt\-proxy/apt\-proxy\&.conf\&.
More information about the apt-proxy-devel
mailing list