- initial import of revision 374 from cnc
[apt.git] / doc / sources.list.5.sgml
1 <!-- -*- mode: sgml; mode: fold -*- -->
2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
3
4 <!ENTITY % aptent SYSTEM "apt.ent">
5 %aptent;
6
7 ]>
8
9 <refentry>
10  &apt-docinfo;
11  
12  <refmeta>
13    <refentrytitle>sources.list</>
14    <manvolnum>5</>
15  </refmeta>
16  
17  <!-- Man page title -->
18  <refnamediv>
19     <refname>sources.list</>
20     <refpurpose>Package resource list for APT</>
21  </refnamediv>
22  
23  <RefSect1><Title>Description</>
24    <para>   
25    The package resource list is used to locate archives of the package
26    distribution system in use on the system. At this time, this manual page
27    documents only the packaging system used by the Debian GNU/Linux system.
28    This control file is located in <filename>/etc/apt/sources.list</>
29    </>
30    <para>
31    The source list is designed to support any number of active sources and a
32    variety of source media. The file lists one source per line, with the
33    most preferred source listed first. The format of each line is:
34    <literal/type uri args/. The first item, <literal/type/, determines the 
35    format for <literal/args/. <literal/uri/ is a Universal Resource Identifier 
36    (URI), which is a superset of the more specific and well-known Universal
37    Resource Locator, or URL. The rest of the line can be marked as a comment 
38    by using a #.
39    </>
40  </RefSect1>
41  
42  <RefSect1><Title>The deb and deb-src types</>
43    <para>   
44    The <literal/deb/ type describes a typical two-level Debian archive,
45    <filename>distribution/component</>. Typically, <literal/distribution/ is 
46    generally one of <literal/stable/, <literal/unstable/, or 
47    <literal/testing/, while component is one of <literal/main/, 
48    <literal/contrib/, <literal/non-free/, or <literal/non-us/. The 
49    <literal/deb-src/ type describes a debian distribution's source code in 
50    the same form as the <literal/deb/ type. A <literal/deb-src/ line is 
51    required to fetch source indexes.</>
52    <para>
53    The format for a <filename/sources.list/ entry using the <literal/deb/ 
54    and <literal/deb-src/ types are:
55    <literallayout>deb uri distribution [component1] [component2] [...]</literallayout>
56    </para><para>
57    The URI for the <literal/deb/ type must specify the base of the Debian 
58    distribution, from which APT will find the information it needs. 
59    <literal/distribution/ can specify an exact path, in which case the 
60    components must be omitted and <literal/distribution/ must end with a 
61    slash (/). This is useful for when only a particular sub-section of the 
62    archive denoted by the URI is of interest. If <literal/distribution/ does 
63    not specify an exact path, at least one <literal/component/ must be present.
64    </para><para>
65    <literal/distribution/ may also contain a variable, <literal/$(ARCH)/,
66    which expands to the Debian architecture (i386, m68k, powerpc, ...)
67    used on the system. This permits architecture-independent
68    <filename/sources.list/ files to be used. In general this is only of 
69    interest when specifying an exact path, <literal/APT/ will automatically 
70    generate a URI with the current architecture otherwise.
71    </para><para>
72    Since only one distribution can be specified per line it may be necessary
73    to have multiple lines for the same URI, if a subset of all available
74    distributions or components at that location is desired.
75    APT will sort the URI list after it has generated a complete set 
76    internally, and will collapse multiple references to the same Internet 
77    host, for instance, into a single connection, so that it does not 
78    inefficiently establish an FTP connection, close it, do something else, 
79    and then re-establish a connection to that same host. This feature is 
80    useful for accessing busy FTP sites with limits on the number of 
81    simultaneous anonymous users. APT also parallelizes connections to 
82    different hosts to more effectively deal with sites with low bandwidth.
83    </para><para>
84    It is important to list sources in order of preference, with the most
85    preferred source listed first. Typically this will result in sorting
86    by speed from fastest to slowest (CD-ROM followed by hosts on a local
87    network, followed by distant Internet hosts, for example).
88    </para><para>
89    Some examples:
90    <literallayout>
91 deb http://http.us.debian.org/debian stable main contrib non-free
92 deb http://http.us.debian.org/debian dists/stable-updates/
93    </literallayout>
94    </para>
95  </RefSect1>
96
97  <RefSect1><title>URI specification</title>
98    <para>
99    The currently recognized URI types are cdrom, file, http, and ftp.
100    <VariableList>
101     <VarListEntry><term>file</term>
102     <ListItem><Para>
103     The file scheme allows an arbitrary directory in the file system to be
104     considered an archive. This is useful for NFS mounts and local mirrors or
105     archives.</para></listitem>
106     </VarListEntry>
107     
108     <VarListEntry><term>cdrom</term>
109     <ListItem><Para>
110     The cdrom scheme allows APT to use a local CDROM drive with media
111     swapping. Use the &apt-cdrom; program to create cdrom entries in the
112     source list.</para></listitem>
113     </VarListEntry>
114
115     <VarListEntry><term>http</term>
116     <ListItem><Para>
117     The http scheme specifies an HTTP server for the archive. If an environment
118     variable <EnVar/http_proxy/ is set with the format 
119     http://server:port/, the proxy server specified in
120     <EnVar/http_proxy/ will be used. Users of authenticated HTTP/1.1 proxies 
121     may use a string of the format http://user:pass@server:port/
122     Note that this is an insecure method of authentication.</para></listitem>
123     </VarListEntry>
124
125     <VarListEntry><term>ftp</term>
126     <ListItem><Para>
127     The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
128     is highly configurable; for more information see the
129     &apt-conf; manual page. Please note that a ftp proxy can be specified
130     by using the <EnVar/ftp_proxy/ environment variable. It is possible to 
131     specify a http proxy (http proxy servers often understand ftp urls) using 
132     this method and ONLY this method. ftp proxies using http specified in the 
133     configuration file will be ignored.</para></listitem>
134     </VarListEntry>
135
136     <VarListEntry><term>copy</term>
137     <ListItem><Para>
138     The copy scheme is identical to the file scheme except that packages are
139     copied into the cache directory instead of used directly at their location.
140     This is useful for people using a zip disk to copy files around with APT.</para></listitem>
141     </VarListEntry>
142     
143     <VarListEntry><term>rsh</term><term>ssh</term>
144     <ListItem><Para>
145     The rsh/ssh method invokes rsh/ssh to connect to a remote host
146     as a given user and access the files. No password authentication is 
147     possible, prior arrangements with RSA keys or rhosts must have been made.
148     Access to files on the remote uses standard <command/find/ and <command/dd/ 
149     commands to perform the file transfers from the remote.</para></listitem>
150     </VarListEntry>
151   </VariableList>
152  </para>
153  </RefSect1>
154  
155  <RefSect1><title>Examples</title>
156    <para>
157    Uses the archive stored locally (or NFS mounted) at /home/jason/debian
158    for stable/main, stable/contrib, and stable/non-free.
159    <literallayout>deb file:/home/jason/debian stable main contrib non-free</literallayout>
160    </para>
161    <para>
162    As above, except this uses the unstable (development) distribution.
163    <literallayout>deb file:/home/jason/debian unstable main contrib non-free</literallayout>
164    </para>
165    <para>
166    Source line for the above
167    <literallayout>deb-src file:/home/jason/debian unstable main contrib non-free</literallayout>
168    </para>
169    <para>
170    Uses HTTP to access the archive at archive.debian.org, and uses only the
171    hamm/main area.
172    <literallayout>deb http://archive.debian.org/debian-archive hamm main</literallayout>
173    </para>
174    <para>
175    Uses FTP to access the archive at ftp.debian.org, under the debian
176    directory, and uses only the stable/contrib area.
177    <literallayout>deb ftp://ftp.debian.org/debian stable contrib</literallayout>
178    </para>
179    <para>
180    Uses FTP to access the archive at ftp.debian.org, under the debian
181    directory, and uses only the unstable/contrib area. If this line appears as
182    well as the one in the previous example in <filename/sources.list/,
183    a single FTP session will be used for both resource lines.
184    <literallayout>deb ftp://ftp.debian.org/debian unstable contrib</literallayout>
185    </para>
186    <para>
187    Uses HTTP to access the archive at nonus.debian.org, under the debian-non-US
188    directory.
189    <literallayout>deb http://nonus.debian.org/debian-non-US stable/non-US main contrib non-free</literallayout>
190    </para>
191    <para>
192    Uses HTTP to access the archive at nonus.debian.org, under the
193    debian-non-US directory, and uses only files found under
194    <filename>unstable/binary-i386</> on i386 machines, 
195    <filename>unstable/binary-m68k</> on m68k, and so
196    forth for other supported architectures. [Note this example only 
197    illustrates how to use the substitution variable; non-us is no longer 
198    structured like this] 
199    <literallayout>deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/</literallayout>
200    </para>
201  </RefSect1>
202  
203  <RefSect1><Title>See Also</>
204    <para>
205    &apt-cache; &apt-conf;
206    </para>
207  </RefSect1>
208
209  &manbugs;
210  &manauthor;
211  
212 </refentry>
213