summaryrefslogtreecommitdiff
path: root/doc/sources.list.5.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sources.list.5.sgml')
-rw-r--r--doc/sources.list.5.sgml199
1 files changed, 0 insertions, 199 deletions
diff --git a/doc/sources.list.5.sgml b/doc/sources.list.5.sgml
deleted file mode 100644
index 45941c215..000000000
--- a/doc/sources.list.5.sgml
+++ /dev/null
@@ -1,199 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
-
- <refmeta>
- <refentrytitle>sources.list</>
- <manvolnum>5</>
- </refmeta>
-
- <!-- Man page title -->
- <refnamediv>
- <refname>sources.list</>
- <refpurpose>Package resource list for APT</>
- </refnamediv>
-
- <RefSect1><Title>Description</>
- <para>
- 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 <filename>/etc/apt/sources.list</>
- <para>
- 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:
- <literal/type uri args/. The first item, <literal/type/, determines the
- format for <literal/args/. <literal/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 #.
- </RefSect1>
-
- <RefSect1><Title>The deb and deb-src types</>
- <para>
- The <literal/deb/ type describes a typical two-level Debian archive,
- <filename>distribution/component</>. Typically, <literal/distribution/ is
- generally one of <literal/stable/, <literal/unstable/, or
- <literal/testing/, while component is one of <literal/main/,
- <literal/contrib/, <literal/non-free/, or <literal/non-us/. The
- <literal/deb-src/ type describes a debian distribution's source code in
- the same form as the <literal/deb/ type. A <literal/deb-src/ line is
- required to fetch source indexes.
- <para>
- The format for a <filename/sources.list/ entry using the <literal/deb/
- and <literal/deb-src/ types are:
- <literallayout>deb uri distribution [component1] [component2] [...]</literallayout>
- <para>
- The URI for the <literal/deb/ type must specify the base of the Debian
- distribution, from which APT will find the information it needs.
- <literal/distribution/ can specify an exact path, in which case the
- components must be omitted and <literal/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. If <literal/distribution/ does
- not specify an exact path, at least one <literal/component/ must be present.
- <para>
- <literal/distribution/ may also contain a variable, <literal/$(ARCH)/,
- which expands to the Debian architecture (i386, m68k, powerpc, ...)
- used on the system. This permits architecture-independent
- <filename/sources.list/ files to be used. In general this is only of
- interest when specifying an exact path, <literal/APT/ will automatically
- generate a URI with the current architecture otherwise.
- <para>
- 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.
- <para>
- 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
- network, followed by distant Internet hosts, for example).
- <para>
- Some examples:
- <literallayout>
-deb http://http.us.debian.org/debian stable main contrib non-free
-deb http://http.us.debian.org/debian dists/stable-updates/
- </literallayout>
- </RefSect1>
-
- <RefSect1><title>URI specification</title>
- <para>
- The currently recognized URI types are cdrom, file, http, and ftp.
- <VariableList>
- <VarListEntry><term>file</term>
- <ListItem><Para>
- 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.
- </VarListEntry>
-
- <VarListEntry><term>cdrom</term>
- <ListItem><Para>
- The cdrom scheme allows APT to use a local CDROM drive with media
- swapping. Use the &apt-cdrom; program to create cdrom entries in the
- source list.
- </VarListEntry>
-
- <VarListEntry><term>http</term>
- <ListItem><Para>
- The http scheme specifies an HTTP server for the archive. If an environment
- variable <EnVar/http_proxy/ is set with the format
- http://server:port/, the proxy server specified in
- <EnVar/http_proxy/ will be used. Users of authenticated HTTP/1.1 proxies
- may use a string of the format http://user:pass@server:port/
- Note that this is an insecure method of authentication.
- </VarListEntry>
-
- <VarListEntry><term>ftp</term>
- <ListItem><Para>
- 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
- by using the <EnVar/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 the
- configuration file will be ignored.
- </VarListEntry>
-
- <VarListEntry><term>copy</term>
- <ListItem><Para>
- 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.
- </VarListEntry>
-
- <VarListEntry><term>rsh</term><term>ssh</term>
- <ListItem><Para>
- The rsh/ssh method invokes rsh/ssh to connect to a remote host
- as a given user and access the files. No password authentication is
- possible, prior arrangements with RSA keys or rhosts must have been made.
- Access to files on the remote uses standard <command/find/ and <command/dd/
- commands to perform the file transfers from the remote.
- </VarListEntry>
- </VariableList>
- </RefSect1>
-
- <RefSect1><title>Examples</title>
- <para>
- Uses the archive stored locally (or NFS mounted) at /home/jason/debian
- for stable/main, stable/contrib, and stable/non-free.
- <literallayout>deb file:/home/jason/debian stable main contrib non-free</literallayout>
- <para>
- As above, except this uses the unstable (development) distribution.
- <literallayout>deb file:/home/jason/debian unstable main contrib non-free</literallayout>
- <para>
- Source line for the above
- <literallayout>deb-src file:/home/jason/debian unstable main contrib non-free</literallayout>
- <para>
- Uses HTTP to access the archive at archive.debian.org, and uses only the
- hamm/main area.
- <literallayout>deb http://archive.debian.org/debian-archive hamm main</literallayout>
- <para>
- Uses FTP to access the archive at ftp.debian.org, under the debian
- directory, and uses only the stable/contrib area.
- <literallayout>deb ftp://ftp.debian.org/debian stable contrib</literallayout>
- <para>
- 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 <filename/sources.list/,
- a single FTP session will be used for both resource lines.
- <literallayout>deb ftp://ftp.debian.org/debian unstable contrib</literallayout>
- <para>
- Uses HTTP to access the archive at nonus.debian.org, under the debian-non-US
- directory.
- <literallayout>deb http://nonus.debian.org/debian-non-US stable/non-US main contrib non-free</literallayout>
- <para>
- Uses HTTP to access the archive at nonus.debian.org, under the
- debian-non-US directory, and uses only files found under
- <filename>unstable/binary-i386</> on i386 machines,
- <filename>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]
- <literallayout>deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/</literallayout>
- </RefSect1>
-
- <RefSect1><Title>See Also</>
- <para>
- &apt-cache; &apt-conf;
- </RefSect1>
-
- &manbugs;
- &manauthor;
-
-</refentry>