[apt.git] / doc / sources.list.5.xml

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>

 <refentryinfo>
   &apt-author.jgunthorpe;
   &apt-author.team;
   &apt-email;
   &apt-product;
   <!-- The last update date -->
   <date>29 February 2004</date>
 </refentryinfo>
 
 <refmeta>
   <refentrytitle>sources.list</refentrytitle>
   <manvolnum>5</manvolnum>
 </refmeta>
 
 <!-- Man page title -->
 <refnamediv>
    <refname>sources.list</refname>
    <refpurpose>Package resource list for APT</refpurpose>
 </refnamediv>
 
 <refsect1><title>Description</title>
   <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</filename></para>

   <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</literal> The first item, <literal>type</literal>
   determines the format for <literal>args</literal> <literal>uri</literal> 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 #.</para>
 </refsect1>
 
 <refsect1><title>sources.list.d</title>
   <para>The <filename>/etc/apt/sources.list.d</filename> directory provides
   a way to add sources.list entries in separate files.
   The format is the same as for the regular <filename>sources.list</filename> file.
   File names need to end with
   <filename>.list</filename> and may only contain letters (a-z and A-Z),
   digits (0-9), underscore (_), hyphen (-) and period (.) characters.
   Otherwise they will be silently ignored.</para>
 </refsect1>

 <refsect1><title>The deb and deb-src types</title>
   <para>The <literal>deb</literal> type describes a typical two-level Debian
   archive, <filename>distribution/component</filename>. Typically,
   <literal>distribution</literal> is generally one of
   <literal>stable</literal> <literal>unstable</literal> or 
   <literal>testing</literal> while component is one of <literal>main</literal> 
   <literal>contrib</literal> <literal>non-free</literal> or
   <literal>non-us</literal> The 
   <literal>deb-src</literal> type describes a debian distribution's source
   code in the same form as the <literal>deb</literal> type.
   A <literal>deb-src</literal> line is required to fetch source indexes.</para>


   <para>The format for a <filename>sources.list</filename> entry using the
   <literal>deb</literal> and <literal>deb-src</literal> types are:</para>

   <literallayout>deb uri distribution [component1] [component2] [...]</literallayout>

   <para>The URI for the <literal>deb</literal> type must specify the base of the
   Debian distribution, from which APT will find the information it needs. 
   <literal>distribution</literal> can specify an exact path, in which case the 
   components must be omitted and <literal>distribution</literal> 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</literal> does not specify an exact path, at least
   one <literal>component</literal> must be present.</para>

   <para><literal>distribution</literal> may also contain a variable, 
   <literal>$(ARCH)</literal>
   which expands to the Debian architecture (i386, m68k, powerpc, ...)
   used on the system. This permits architecture-independent
   <filename>sources.list</filename> files to be used. In general this is only
   of interest when specifying an exact path, <literal>APT</literal> will
   automatically generate a URI with the current architecture otherwise.</para>

   <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>

   <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>

   <para>Some examples:</para>
   <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, ftp, copy,
   ssh, rsh.
   <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.</para></listitem>
    </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.</para></listitem>
    </varlistentry>

    <varlistentry><term>http</term>
    <listitem><para>
    The http scheme specifies an HTTP server for the archive. If an environment
    variable <envar>http_proxy</envar> is set with the format 
    http://server:port/, the proxy server specified in
    <envar>http_proxy</envar> 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.</para></listitem>
    </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</envar> 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.</para></listitem>
    </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.</para></listitem>
    </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. It is a good idea to do prior
	arrangements with RSA keys or rhosts.
    Access to files on the remote uses standard <command>find</command> and
    <command>dd</command> 
    commands to perform the file transfers from the remote.</para></listitem>
    </varlistentry>
  </variablelist>
 </para>
 </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.</para>
   <literallayout>deb file:/home/jason/debian stable main contrib non-free</literallayout>

   <para>As above, except this uses the unstable (development) distribution.</para>
   <literallayout>deb file:/home/jason/debian unstable main contrib non-free</literallayout>

   <para>Source line for the above</para>
   <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.</para>
   <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.</para>
   <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</filename>.
   a single FTP session will be used for both resource lines.</para>
   <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.</para>
   <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</filename> on i386 machines, 
   <filename>unstable/binary-m68k</filename> 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>
   </para>
 </refsect1>
 
 <refsect1><title>See Also</title>
   <para>&apt-cache; &apt-conf;
   </para>
 </refsect1>

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