X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/e4b16ac68196eab5e58abf715459fe70c199cff3..123fa88a1a77da53c55adea7dfdb4334e58dedb4:/doc/sources.list.5.xml diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml index c758be61f..fa32297c2 100644 --- a/doc/sources.list.5.xml +++ b/doc/sources.list.5.xml @@ -1,10 +1,13 @@ - %aptent; + +%aptverbatiment; + ]> @@ -15,7 +18,7 @@ &apt-email; &apt-product; - 29 February 2004 + 2012-06-09T00:00:00Z @@ -27,24 +30,24 @@ sources.list - Package resource list for APT + List of configured APT data sources Description - The package resource list is used to locate archives of the package - distribution system in use on the system. At this time, this manual page - documents only the packaging system used by the Debian GNU/Linux system. - This control file is located in /etc/apt/sources.list - - The source list is designed to support any number of active sources and a - variety of source media. The file lists one source per line, with the - most preferred source listed first. The format of each line is: - type uri args The first item, type - determines the format for args uri is - a Universal Resource Identifier - (URI), which is a superset of the more specific and well-known Universal - Resource Locator, or URL. The rest of the line can be marked as a comment - by using a #. + + The source list /etc/apt/sources.list is designed to support + any number of active sources and a variety of source media. The file lists one + source per line, with the most preferred source listed first. The information available + from the configured sources is acquired by apt-get update + (or by an equivalent command from another APT front-end). + + + Each line specifying a source starts with type (e.g. deb-src) + followed by options and arguments for this type. + Individual entries cannot be continued onto a following line. Empty lines + are ignored, and a # character anywhere on a line marks + the remainder of that line as a comment. + sources.list.d @@ -54,40 +57,42 @@ File names need to end with .list and may only contain letters (a-z and A-Z), digits (0-9), underscore (_), hyphen (-) and period (.) characters. - Otherwise they will be silently ignored. + Otherwise APT will print a notice that it has ignored a file, unless that + file matches a pattern in the Dir::Ignore-Files-Silently + configuration list - in which case it will be silently ignored. The deb and deb-src types - The deb type describes a typical two-level Debian - archive, distribution/component. Typically, - distribution is generally one of - stable unstable or - testing while component is one of main - contrib non-free or - non-us The - deb-src type describes a debian distribution's source + The deb type references a typical two-level Debian + archive, distribution/component. The + distribution is generally an archive name like + stable or testing or a codename like + &stable-codename; or &testing-codename; + while component is one of main, contrib or + non-free. The + deb-src type references a Debian distribution's source code in the same form as the deb type. A deb-src line is required to fetch source indexes. The format for a sources.list entry using the - deb and deb-src types are: + deb and deb-src types is: - deb uri distribution [component1] [component2] [...] + deb [ options ] uri distribution [component1] [component2] [...] The URI for the deb type must specify the base of the Debian distribution, from which APT will find the information it needs. distribution can specify an exact path, in which case the components must be omitted and distribution must end with - a slash (/). This is useful for when only a particular sub-section of the - archive denoted by the URI is of interest. + a slash (/). This is useful for the case when only a + particular sub-section of the archive denoted by the URI is of interest. If distribution does not specify an exact path, at least one component must be present. distribution may also contain a variable, $(ARCH) - which expands to the Debian architecture (i386, m68k, powerpc, ...) - used on the system. This permits architecture-independent + which expands to the Debian architecture (such as amd64 or + armel) used on the system. This permits architecture-independent sources.list files to be used. In general this is only of interest when specifying an exact path, APT will automatically generate a URI with the current architecture otherwise. @@ -104,6 +109,26 @@ simultaneous anonymous users. APT also parallelizes connections to different hosts to more effectively deal with sites with low bandwidth. + options is always optional and needs to be surrounded by + square brackets. It can consist of multiple settings in the form + setting=value. + Multiple settings are separated by spaces. The following settings are supported by APT + (note however that unsupported settings will be ignored silently): + + arch=arch1,arch2,… + can be used to specify for which architectures information should + be downloaded. If this option is not set all architectures defined by the + APT::Architectures option will be downloaded. + arch+=arch1,arch2,… + and arch-=arch1,arch2,… + which can be used to add/remove architectures from the set which will be downloaded. + trusted=yes can be set to indicate that packages + from this source are always authenticated even if the Release file + is not signed or the signature can't be checked. This disables parts of &apt-secure; + and should therefore only be used in a local and trusted context. trusted=no + is the opposite which handles even correctly authenticated sources as not authenticated. + + It is important to list sources in order of preference, with the most preferred source listed first. Typically this will result in sorting by speed from fastest to slowest (CD-ROM followed by hosts on a local @@ -111,68 +136,77 @@ Some examples: -deb http://http.us.debian.org/debian stable main contrib non-free -deb http://http.us.debian.org/debian dists/stable-updates/ +deb http://ftp.debian.org/debian &stable-codename; main contrib non-free +deb http://security.debian.org/ &stable-codename;/updates main contrib non-free URI specification - The currently recognized URI types are cdrom, file, http, ftp, copy, - ssh, rsh. + The currently recognized URI types are: - file + file The file scheme allows an arbitrary directory in the file system to be considered an archive. This is useful for NFS mounts and local mirrors or archives. - cdrom + cdrom - The cdrom scheme allows APT to use a local CDROM drive with media + The cdrom scheme allows APT to use a local CD-ROM drive with media swapping. Use the &apt-cdrom; program to create cdrom entries in the source list. - http + http The http scheme specifies an HTTP server for the archive. If an environment variable http_proxy is set with the format http://server:port/, the proxy server specified in http_proxy will be used. Users of authenticated HTTP/1.1 proxies may use a string of the format - http://user:pass@server:port/ + http://user:pass@server:port/. Note that this is an insecure method of authentication. - ftp + ftp The ftp scheme specifies an FTP server for the archive. APT's FTP behavior is highly configurable; for more information see the - &apt-conf; manual page. Please note that a ftp proxy can be specified + &apt-conf; manual page. Please note that an FTP proxy can be specified by using the ftp_proxy environment variable. It is possible - to specify a http proxy (http proxy servers often understand ftp urls) - using this method and ONLY this method. ftp proxies using http specified in + to specify an HTTP proxy (HTTP proxy servers often understand FTP URLs) + using this environment variable and only this + environment variable. Proxies using HTTP specified in the configuration file will be ignored. - copy + copy The copy scheme is identical to the file scheme except that packages are copied into the cache directory instead of used directly at their location. - This is useful for people using a zip disk to copy files around with APT. + This is useful for people using removable media to copy files around with APT. - rshssh + rshssh - The rsh/ssh method invokes rsh/ssh to connect to a remote host - as a given user and access the files. It is a good idea to do prior - arrangements with RSA keys or rhosts. - Access to files on the remote uses standard find and - dd - commands to perform the file transfers from the remote. + The rsh/ssh method invokes RSH/SSH to connect to a remote host and + access the files as a given user. Prior configuration of rhosts or RSA keys + is recommended. The standard find and dd + commands are used to perform the file transfers from the remote host. + + + + adding more recognizable URI types + + APT can be extended with more methods shipped in other optional packages, which should + follow the naming scheme apt-transport-method. + For instance, the APT team also maintains the package apt-transport-https, + which provides access methods for HTTPS URIs with features similar to the http method. + Methods for using e.g. debtorrent are also available - see &apt-transport-debtorrent;. + @@ -189,32 +223,33 @@ deb http://http.us.debian.org/debian dists/stable-updates/ Source line for the above deb-src file:/home/jason/debian unstable main contrib non-free + The first line gets package information for the architectures in APT::Architectures + while the second always retrieves amd64 and armel. + deb http://ftp.debian.org/debian &stable-codename; main +deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main + Uses HTTP to access the archive at archive.debian.org, and uses only the hamm/main area. deb http://archive.debian.org/debian-archive hamm main Uses FTP to access the archive at ftp.debian.org, under the debian - directory, and uses only the stable/contrib area. - deb ftp://ftp.debian.org/debian stable contrib + directory, and uses only the &stable-codename;/contrib area. + deb ftp://ftp.debian.org/debian &stable-codename; contrib Uses FTP to access the archive at ftp.debian.org, under the debian directory, and uses only the unstable/contrib area. If this line appears as - well as the one in the previous example in sources.list. + well as the one in the previous example in sources.list a single FTP session will be used for both resource lines. deb ftp://ftp.debian.org/debian unstable contrib - Uses HTTP to access the archive at nonus.debian.org, under the - debian-non-US directory. - deb http://nonus.debian.org/debian-non-US stable/non-US main contrib non-free - - Uses HTTP to access the archive at nonus.debian.org, under the - debian-non-US directory, and uses only files found under - unstable/binary-i386 on i386 machines, - unstable/binary-m68k on m68k, and so - forth for other supported architectures. [Note this example only - illustrates how to use the substitution variable; non-us is no longer - structured like this] - deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/ + Uses HTTP to access the archive at ftp.tlh.debian.org, under the + universe directory, and uses only files found under + unstable/binary-i386 on i386 machines, + unstable/binary-amd64 on amd64, and so + forth for other supported architectures. [Note this example only + illustrates how to use the substitution variable; official debian + archives are not structured like this] + deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/