Package: apt-cacher Version: 1.0.9 Severity: minor Tags: patch Hi,
I added the escape of the minus signs in the apt-cacher.1 man page and fixed a typo apt-ftpachive -> apt-ftparchive. Regards, Bastian -- System Information: Debian Release: testing/unstable APT prefers unstable APT policy: (500, 'unstable') Architecture: i386 (i686) Shell: /bin/sh linked to /bin/bash Kernel: Linux 2.6.12-treasure6 Locale: [EMAIL PROTECTED], [EMAIL PROTECTED] (charmap=ISO-8859-15) Versions of packages apt-cacher depends on: ii bzip2 1.0.2-8 high-quality block-sorting file co ii libwww-perl 5.803-4 WWW client/server library for Perl ii perl 5.8.7-4 Larry Wall's Practical Extraction apt-cacher recommends no packages. -- no debconf information
--- apt-cacher.1.orig 2005-08-19 14:55:11.000000000 +0200 +++ apt-cacher.1 2005-08-19 14:51:21.885897003 +0200 @@ -1,13 +1,13 @@ -.TH APT-CACHER 1 +.TH APT\-CACHER 1 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection .\" other parms are allowed: see man(7), man(1) .SH NAME -apt-cacher \- caching proxy for Debian packages +apt\-cacher - caching proxy for Debian packages .SH SYNOPSIS .B http://proxy.example.com:3142/ .I "[mirror] / [distribution]" .SH "DESCRIPTION" -.B Apt-cacher +.B Apt\-cacher is a caching proxy for Debian packages, allowing a number of computers to share a single local cache. Packages requested from the cache only need to be downloaded from the Debian mirrors once, no matter how many @@ -15,20 +15,20 @@ improves performance for local users, and reduces the load on the mirrors. .PP -Setting up apt-cacher involves two stages: installing apt-cacher +Setting up apt\-cacher involves two stages: installing apt\-cacher itself on a single machine on your network, and configuring all local machines to use the cache. .PP -The cache machine needs apt-cacher installed, which runs as a daemon or as a +The cache machine needs apt\-cacher installed, which runs as a daemon or as a CGI under a web server (eg. Apache). When Apt requests a package from the cache machine, the -request is handled by apt-cacher which checks whether it already has +request is handled by apt\-cacher which checks whether it already has that particular package. If so, the package is returned immediately to Apt for installation. If not, or if the package in the local cache has been superseded by a more recent version, the package is fetched from the specified mirror. While being fetched it is simultaneously streamed to Apt, and also saved to the local cache for future use. .PP -Other machines on your network do not need apt-cacher installed in +Other machines on your network do not need apt\-cacher installed in order to use the local cache. The only modification to each client computer is to prepend the cache machine's address and script identifier to each HTTP mirror in /etc/apt/sources.list (depending on the installation method @@ -39,26 +39,27 @@ For example, if you have a line in your sources.list that looks like this: .PP -.B deb http://mirror.aarnet.edu.au/debian unstable main contrib non-free +.B deb http://mirror.aarnet.edu.au/debian unstable main contrib non\-free .PP You would add 'proxy.example.com:3142/' at the start to make it look like this: .PP -.B deb http://proxy.example.com:3142/mirror.aarnet.edu.au/debian unstable main contrib non-free +.B deb http://proxy.example.com:3142/mirror.aarnet.edu.au/debian unstable main contrib non\-free .PP -where 'proxy.example.com' is the address of the computer running your apt-cacher cache. +where 'proxy.example.com' is the address of the computer running your apt\-cacher cache. .PP -For installations using a web server (CGI) the prefix should be 'proxy.example.com/apt-cacher?/' instead. +For installations using a web server (CGI) the prefix should be +'proxy.example.com/apt\-cacher?/' instead. .PP -Apt-cacher currently only handles HTTP requests. +Apt\-cacher currently only handles HTTP requests. .SH INSTALLATION METHODS -Apt-cacher can be installed in various ways. The recommended is running the +Apt\-cacher can be installed in various ways. The recommended is running the program as a stand-alone daemon. This should get the best performance and the lowest overall memory usage. .PP -To run apt-cacher in +To run apt\-cacher in .B stand-alone mode, -edit the file /etc/defaults/apt-cacher +edit the file /etc/defaults/apt\-cacher to enable the execution, then run the init script to start the daemon. The local clients can access the daemon using the .B 'http://server:PORT/' @@ -71,23 +72,23 @@ .PP The last method is using the CGI mode. It is not recommended for long-term use because it brings a visible performance impact on the network and server speed. -By default, apt-cacher package adds a default configuration profile to Apache. -The URL prefix for sources.list is 'proxy.example.com/apt-cacher?/' for a +By default, apt\-cacher package adds a default configuration profile to Apache. +The URL prefix for sources.list is 'proxy.example.com/apt\-cacher?/' for a server in this mode. .PP -In both daemon modes you can use apt-cacher to simulate a web server. When +In both daemon modes you can use apt\-cacher to simulate a web server. When bound to port 80 it will even emulate the behaviour of the previous CGI-based versions. However, you cannot real another web server on the port then, and -only root can start apt-cacher directly. +only root can start apt\-cacher directly. .SH OPTIONS -Apt-cacher uses a configuration file for setting all +Apt\-cacher uses a configuration file for setting all options. The configuration file is installed by default as -/etc/apt-cacher/apt-cacher.conf. The options available in the conf +/etc/apt\-cacher/apt\-cacher.conf. The options available in the conf file (and their default settings) are: .TP -.B cache_dir [/var/cache/apt-cacher] -The directory where apt-cacher will store local +.B cache_dir [/var/cache/apt\-cacher] +The directory where apt\-cacher will store local copies of all packages requested. This can grow to many hundreds of MB, so make sure it is on a partition with plenty of room. .TP @@ -96,15 +97,15 @@ and traffic reports. .TP .B allowed_hosts [*] -If your apt-cacher machine is directly exposed to the Internet and +If your apt\-cacher machine is directly exposed to the Internet and you are worried about unauthorised machines fetching packages through it, you can specify a range of IP addresses that are allowed to use it. Localhost (127.0.0.1) is explicitly always allowed, other addresses must be matched by allowed_hosts and not by denied_hosts to be permitted to use the cache. -Note that by default apt-cacher will allow requests from any client, so set a +Note that by default apt\-cacher will allow requests from any client, so set a range here if you want to restrict access. -See the default configuration file apt-cacher.conf for further details and +See the default configuration file apt\-cacher.conf for further details and examples. .TP .B denied_hosts @@ -120,7 +121,7 @@ .B generate_reports [1] Whether to generate traffic reports daily. Traffic reports can be accessed by pointing a browser to -http://proxy.example.com/apt-cacher/report/ (using the address of +http://proxy.example.com/apt\-cacher/report/ (using the address of your own cache of course). .TP .B clean_cache [1] @@ -128,7 +129,7 @@ deleted on the basis of whether they have been superseded by newer packages, not on age, so it should be safe to leave this on. .TP -.B logdir [/var/log/apt-cacher] +.B logdir [/var/log/apt\-cacher] Directory to use for the access and error log files and traffic report. The access log records all successful package requests using a timestamp, whether the request was fulfilled from cache, the IP @@ -144,7 +145,7 @@ headers on the server with those stored localy. .TP .B http_proxy [proxy.example.com:8080] -Apt-cacher can pass all its requests to an external http proxy like +Apt\-cacher can pass all its requests to an external http proxy like Squid, which could be very useful if you are using an ISP that blocks port 80 and requires all web traffic to go through its proxy. The format is 'hostname:port', eg: 'proxy.example.com:8080'. @@ -192,32 +193,32 @@ A: Yes! However a bit additional work is required to make them useable and persistent in the cache. .PP -First: alongside with the debs apt-cacher stores additional information: a +First: alongside with the debs apt\-cacher stores additional information: a flag file to verify that the package is completely downloaded, and a file with HTTP headers that have been sent from the server. If you copy .debs straight in and don't add those things, fetching them *will* fail. .PP -Fortunately Apt-cacher now comes with an import helper script to make things -easier. Just put a bunch of .debs into /var/cache/apt-cacher/import (or +Fortunately Apt\-cacher now comes with an import helper script to make things +easier. Just put a bunch of .debs into /var/cache/apt\-cacher/import (or a directory called 'import' inside whatever you've set your cache dir to be, -and run /usr/share/apt-cacher/apt-cacher-import.pl. The script will +and run /usr/share/apt\-cacher/apt\-cacher\-import.pl. The script will run through all the .debs it finds in that dir and move them around to the correct locations plus create additional flag/header files. It does even work with symlinks to .debs, eg. created from a Debian Sarge DVD with a command like this: .PP -find /cdrom/ -name '*.deb' | xargs cp -sf --target-directory=import/ +find /cdrom/ \-name '*.deb' | xargs cp \-sf \-\-target\-directory=import/ .PP Second: if the daily cleanup operation is enabled (see clean_cache option above) and there is no Packages.gz (or .bz2) file that refers to your .debs, the package files will be removed really soon. From another point of view: if there are potential clients that would download these packages and the clients did run -"apt-get update" using apt-cacher once, there is no reason to worry. If you +"apt\-get update" using apt\-cacher once, there is no reason to worry. If you just want to add the .debs for further use, you can use a tool like -apt-ftpachive to fake the Packages.gz file. +apt\-ftparchive to fake the Packages.gz file. .SH AUTHOR -Apt-cacher was originally written by Nick Andrews <[EMAIL PROTECTED]>. +Apt\-cacher was originally written by Nick Andrews <[EMAIL PROTECTED]>. This manual page was written by Jonathan Oxer <[EMAIL PROTECTED]>, for the Debian GNU/Linux system (but may be used by others). Updates by Eduard Bloch <[EMAIL PROTECTED]>.
