X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/aec2216091b3d70b3baa5a5b8c87ce208e35c19c..7dd62ea93413a73b4ec394b16ff4e0367d226395:/doc/sources.list.5.xml diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml index 6499df7e3..a2f6e985e 100644 --- a/doc/sources.list.5.xml +++ b/doc/sources.list.5.xml @@ -1,6 +1,6 @@ - %aptent; @@ -8,6 +8,8 @@ %aptverbatiment; + +%aptvendor; ]> @@ -18,7 +20,7 @@ &apt-email; &apt-product; - 2004-02-29T00:00:00Z + 2014-01-18T00:00:00Z @@ -30,24 +32,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 /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 @@ -57,67 +59,93 @@ 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 APT will print a notice that it has ignored a file if the file - doesn't match a pattern in the Dir::Ignore-Files-Silently - configuration list - in this case it 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 an archivename like + 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 + while component is one of main, contrib or non-free. The - deb-src type describes a debian distribution's source + 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 is: - deb [ options ] uri distribution [component1] [component2] [...] + deb [ options ] uri suite [component1] [component2] [...] + + Alternatively a rfc822 style format is also supported: + + Type: deb + URI: http://example.com + Suites: stable testing + Sections: component1 component2 + Description: short + long long long + [option1]: [option1-value] + + Type: deb-src + URI: http://example.com + Suites: stable + Sections: component1 component2 + Enabled: no + Description: short + long long long + [option1]: [option1-value] + + 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 the case 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 + suite can specify an exact path, in which case the + components must be omitted and suite must end with + 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 suite does not specify an exact path, at least one component must be present. - distribution may also contain a variable, + suite 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. - Since only one distribution can be specified per line it may be necessary - to have multiple lines for the same URI, if a subset of all available - distributions or components at that location is desired. - APT will sort the URI list after it has generated a complete set - internally, and will collapse multiple references to the same Internet - host, for instance, into a single connection, so that it does not - inefficiently establish an FTP connection, close it, do something else, - and then re-establish a connection to that same host. This feature is - useful for accessing busy FTP sites with limits on the number of - 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 surounded by + In the traditional style sources.list format since only one + distribution can be specified per line it may be necessary to have + multiple lines for the same URI, if a subset of all available + distributions or components at that location is desired. APT will + sort the URI list after it has generated a complete set internally, + and will collapse multiple references to the same Internet host, + for instance, into a single connection, so that it does not + inefficiently establish an FTP connection, close it, do something + else, and then re-establish a connection to that same host. This + feature is useful for accessing busy FTP sites with limits on the + number of 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 though that unsupported settings will be ignored silently: - arch=arch1,arch2,… - can be used to specify for which architectures packages information should + 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; @@ -151,7 +179,7 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free 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. @@ -171,10 +199,11 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free 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. @@ -182,26 +211,25 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free 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 - 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 nameing scheme apt-transport-method. - The APT team e.g. maintains also the apt-transport-https package which - provides access methods for https-URIs with features similar to the http method, but other - methods for using e.g. debtorrent are also available, see &apt-transport-debtorrent;. + 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;.