You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

426 lines
20 KiB

  1. <?xml version="1.0" encoding="utf-8" standalone="no"?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  3. "" [
  4. <!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
  5. <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
  6. <!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
  7. ]>
  8. <refentry>
  9. <refentryinfo>
  10. &apt-author.jgunthorpe;
  11. &;
  12. &apt-email;
  13. &apt-product;
  14. <!-- The last update date -->
  15. <date>2014-01-18T00:00:00Z</date>
  16. </refentryinfo>
  17. <refmeta>
  18. <refentrytitle>sources.list</refentrytitle>
  19. <manvolnum>5</manvolnum>
  20. <refmiscinfo class="manual">APT</refmiscinfo>
  21. </refmeta>
  22. <!-- Man page title -->
  23. <refnamediv>
  24. <refname>sources.list</refname>
  25. <refpurpose>List of configured APT data sources</refpurpose>
  26. </refnamediv>
  27. <refsect1><title>Description</title>
  28. <para>
  29. The source list <filename>/etc/apt/sources.list</filename> and the the
  30. files contained in <filename>/etc/apt/sources.list.d/</filename> are
  31. designed to support any number of active sources and a variety of source
  32. media. The files list one source per line (one line style) or contain multiline
  33. stanzas defining one or more sources per stanza (deb822 style), with the
  34. most preferred source listed first. The information available from the
  35. configured sources is acquired by <command>apt-get update</command> (or
  36. by an equivalent command from another APT front-end).
  37. </para>
  38. </refsect1>
  39. <refsect1><title>sources.list.d</title>
  40. <para>The <filename>/etc/apt/sources.list.d</filename> directory provides
  41. a way to add sources.list entries in separate files.
  42. Two different file formats are allowed as described in the next two sections.
  43. Filenames need to have either the extension <filename>.list</filename> or
  44. <filename>.sources</filename> depending on the contained format.
  45. The filenames may only contain letters (a-z and A-Z),
  46. digits (0-9), underscore (_), hyphen (-) and period (.) characters.
  47. Otherwise APT will print a notice that it has ignored a file, unless that
  48. file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal>
  49. configuration list - in which case it will be silently ignored.</para>
  50. </refsect1>
  51. <refsect1><title>one line style format</title>
  52. <para>
  53. Files in this format have the extension <filename>.list</filename>.
  54. Each line specifying a source starts with a type (e.g. <literal>deb-src</literal>)
  55. followed by options and arguments for this type.
  56. Individual entries cannot be continued onto a following line. Empty lines
  57. are ignored, and a <literal>#</literal> character anywhere on a line marks
  58. the remainder of that line as a comment. Consequently an entry can be
  59. disabled by commenting out the entire line.
  60. If options should be provided they are separated by spaces and all of
  61. them together are enclosed by square brackets (<literal>[]</literal>)
  62. included in the line after the type separated from it with a space.
  63. If an option allows multiple values these are separated from each other
  64. with a comma (<literal>,</literal>). An option name is separated from its
  65. value(s) by a equal sign (<literal>=</literal>). Multivalue options have
  66. also <literal>-=</literal> and <literal>+=</literal> as separator which
  67. instead of replacing the default with the given value(s) modify the default
  68. value(s) to remove or include the given values.
  69. </para><para>
  70. This is the traditional format and supported by all apt versions.
  71. Note that not all options as described below are supported by all apt versions.
  72. Note also that some older applications parsing this format on its own might not
  73. expect to encounter options as they were uncommon before the introduction of
  74. multi-architecture support.
  75. </para>
  76. </refsect1>
  77. <refsect1><title>deb822 style format</title>
  78. <para>
  79. Files in this format have the extension <filename>.sources</filename>.
  80. The format is similar in syntax to other files used by Debian and its
  81. derivatives, like the metadata itself apt will download from the configured
  82. sources or the <filename>debian/control</filename> file in a Debian source package.
  83. Individual entries are separated by an empty line, additional empty
  84. lines are ignored, and a <literal>#</literal> character at the start of
  85. the line marks the entire line as a comment. An entry can hence be
  86. disabled by commenting out each line belonging to the stanza, but it is
  87. usually easier to add the field "Enabled: no" to the stanza to disable
  88. the entry. Removing the field or setting it to yes reenables it.
  89. Options have the same syntax as every other field: A fieldname separated by
  90. a colon (<literal>:</literal>) and optionally spaces from its value(s).
  91. Note especially that multiple values are separated by spaces, not by
  92. commas as in the one line format. Multivalue fields like <literal>Architectures</literal>
  93. also have <literal>Architectures-Add</literal> and <literal>Architectures-Remove</literal>
  94. to modify the default value rather than replacing it.
  95. </para><para>
  96. This is a new format supported by apt itself since version 1.1. Previous
  97. versions ignore such files with a notice message as described earlier.
  98. It is intended to make this format gradually the default format and
  99. deprecating the previously described one line style format as it is
  100. easier to create, extend and modify by humans and machines alike
  101. especially if a lot of sources and/or options are involved.
  102. Developers who are working with and/or parsing apt sources are highly
  103. encouraged to add support for this format and to contact the APT team
  104. to coordinate and share this work. Users can freely adopt this format
  105. already, but could encounter problems with software not supporting
  106. the format yet.
  107. </para>
  108. </refsect1>
  109. <refsect1><title>The deb and deb-src types: General Format</title>
  110. <para>The <literal>deb</literal> type references a typical two-level Debian
  111. archive, <filename>distribution/component</filename>. The
  112. <literal>distribution</literal> is generally a suite name like
  113. <literal>stable</literal> or <literal>testing</literal> or a codename like
  114. <literal>&stable-codename;</literal> or <literal>&testing-codename;</literal>
  115. while component is one of <literal>main</literal>, <literal>contrib</literal> or
  116. <literal>non-free</literal>. The
  117. <literal>deb-src</literal> type references a Debian distribution's source
  118. code in the same form as the <literal>deb</literal> type.
  119. A <literal>deb-src</literal> line is required to fetch source indexes.</para>
  120. <para>The format for two one line style entries using the
  121. <literal>deb</literal> and <literal>deb-src</literal> types is:</para>
  122. <literallayout>deb [ option1=value1 option2=value2 ] uri suite [component1] [component2] [...]
  123. deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [...]</literallayout>
  124. <para>Alternatively the equivalent entry in deb822 style looks like this:
  125. <literallayout>
  126. Types: deb deb-src
  127. URIs: uri
  128. Suites: suite
  129. Components: [component1] [component2] [...]
  130. option1: value1
  131. option2: value2
  132. </literallayout>
  133. </para>
  134. <para>The URI for the <literal>deb</literal> type must specify the base of the
  135. Debian distribution, from which APT will find the information it needs.
  136. <literal>suite</literal> can specify an exact path, in which case the
  137. components must be omitted and <literal>suite</literal> must end with
  138. a slash (<literal>/</literal>). This is useful for the case when only a
  139. particular sub-directory of the archive denoted by the URI is of interest.
  140. If <literal>suite</literal> does not specify an exact path, at least
  141. one <literal>component</literal> must be present.</para>
  142. <para><literal>suite</literal> may also contain a variable,
  143. <literal>$(ARCH)</literal>
  144. which expands to the Debian architecture (such as <literal>amd64</literal> or
  145. <literal>armel</literal>) used on the system. This permits architecture-independent
  146. <filename>sources.list</filename> files to be used. In general this is only
  147. of interest when specifying an exact path, <literal>APT</literal> will
  148. automatically generate a URI with the current architecture otherwise.</para>
  149. <para>Especially in the one line style format since only one distribution
  150. can be specified per line it may be necessary to have multiple lines for
  151. the same URI, if a subset of all available distributions or components at
  152. that location is desired. APT will sort the URI list after it has
  153. generated a complete set internally, and will collapse multiple
  154. references to the same Internet host, for instance, into a single
  155. connection, so that it does not inefficiently establish a
  156. connection, close it, do something else, and then re-establish a
  157. connection to that same host. APT also parallelizes connections to
  158. different hosts to more effectively deal with sites with low
  159. bandwidth.</para>
  160. <para>It is important to list sources in order of preference, with the most
  161. preferred source listed first. Typically this will result in sorting
  162. by speed from fastest to slowest (CD-ROM followed by hosts on a local
  163. network, followed by distant Internet hosts, for example).</para>
  164. <para>As an example, the sources for your distribution could look like this
  165. in one line style format:
  166. <literallayout>&sourceslist-list-format;</literallayout> or like this in
  167. deb822 style format:
  168. <literallayout>&sourceslist-sources-format;</literallayout></para>
  169. </refsect1>
  170. <refsect1><title>The deb and deb-src types: Options</title>
  171. <para>Each source entry can have options specified modifying which and how
  172. the source is accessed and data acquired from it. Format, syntax and names
  173. of the options varies between the two formats one line and deb822 style
  174. as described, but they have both the same options available. For simplicity
  175. we list the deb822 fieldname and provide the one line name in brackets.
  176. Remember that beside setting multivalue options explicitly, there is also
  177. the option to modify them based on the default, but we aren't listing those
  178. names explicitly here. Unsupported options are silently ignored by all
  179. APT versions.
  180. <itemizedlist>
  181. <listitem><para><literal>Architectures</literal>
  182. (<literal>arch</literal>) is a multivalue option defining for
  183. which architectures information should be downloaded. If this
  184. option isn't set the default is all architectures as defined by
  185. the <literal>APT::Architectures</literal> config option.
  186. </para></listitem>
  187. <listitem><para><literal>Languages</literal>
  188. (<literal>lang</literal>) is a multivalue option defining for
  189. which languages information like translated package
  190. descriptions should be downloaded. If this option isn't set
  191. the default is all languages as defined by the
  192. <literal>Acquire::Languages</literal> config option.
  193. </para></listitem>
  194. <listitem><para><literal>Targets</literal>
  195. (<literal>target</literal>) is a multivalue option defining
  196. which download targets apt will try to acquire from this
  197. source. If not specified, the default set is defined by the
  198. <literal>APT::Acquire::Targets</literal> configuration scope.
  199. </para></listitem>
  200. </itemizedlist>
  201. Further more, there are options which if set effect
  202. <emphasis>all</emphasis> sources with the same URI and Suite, so they
  203. have to be set on all such entries and can not be varied between
  204. different components. APT will try to detect and error out on such
  205. anomalies.
  206. <itemizedlist>
  207. <listitem><para><literal>Trusted</literal> (<literal>trusted</literal>)
  208. is a tri-state value which defaults to APT deciding if a source
  209. is considered trusted or if warnings should be raised before e.g.
  210. packages are installed from this source. This option can be used
  211. to override this decision either with the value <literal>yes</literal>,
  212. which lets APT consider this source always as a trusted source
  213. even if it has no or fails authentication checks by disabling parts
  214. of &apt-secure; and should therefore only be used in a local and trusted
  215. context (if at all) as otherwise security is breached. The opposite
  216. can be achieved with the value no, which causes the source to be handled
  217. as untrusted even if the authentication checks passed successfully.
  218. The default value can't be set explicitly.
  219. </para></listitem>
  220. </itemizedlist>
  221. </para>
  222. </refsect1>
  223. <refsect1><title>URI specification</title>
  224. <para>The currently recognized URI types are:
  225. <variablelist>
  226. <varlistentry><term><command>file</command></term>
  227. <listitem><para>
  228. The file scheme allows an arbitrary directory in the file system to be
  229. considered an archive. This is useful for NFS mounts and local mirrors or
  230. archives.</para></listitem>
  231. </varlistentry>
  232. <varlistentry><term><command>cdrom</command></term>
  233. <listitem><para>
  234. The cdrom scheme allows APT to use a local CD-ROM drive with media
  235. swapping. Use the &apt-cdrom; program to create cdrom entries in the
  236. source list.</para></listitem>
  237. </varlistentry>
  238. <varlistentry><term><command>http</command></term>
  239. <listitem><para>
  240. The http scheme specifies an HTTP server for the archive. If an environment
  241. variable <envar>http_proxy</envar> is set with the format
  242. http://server:port/, the proxy server specified in
  243. <envar>http_proxy</envar> will be used. Users of authenticated
  244. HTTP/1.1 proxies may use a string of the format
  245. http://user:pass@server:port/.
  246. Note that this is an insecure method of authentication.</para></listitem>
  247. </varlistentry>
  248. <varlistentry><term><command>ftp</command></term>
  249. <listitem><para>
  250. The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
  251. is highly configurable; for more information see the
  252. &apt-conf; manual page. Please note that an FTP proxy can be specified
  253. by using the <envar>ftp_proxy</envar> environment variable. It is possible
  254. to specify an HTTP proxy (HTTP proxy servers often understand FTP URLs)
  255. using this environment variable and <emphasis>only</emphasis> this
  256. environment variable. Proxies using HTTP specified in
  257. the configuration file will be ignored.</para></listitem>
  258. </varlistentry>
  259. <varlistentry><term><command>copy</command></term>
  260. <listitem><para>
  261. The copy scheme is identical to the file scheme except that packages are
  262. copied into the cache directory instead of used directly at their location.
  263. This is useful for people using removable media to copy files around with APT.</para></listitem>
  264. </varlistentry>
  265. <varlistentry><term><command>rsh</command></term><term><command>ssh</command></term>
  266. <listitem><para>
  267. The rsh/ssh method invokes RSH/SSH to connect to a remote host and
  268. access the files as a given user. Prior configuration of rhosts or RSA keys
  269. is recommended. The standard <command>find</command> and <command>dd</command>
  270. commands are used to perform the file transfers from the remote host.
  271. </para></listitem>
  272. </varlistentry>
  273. <varlistentry><term>adding more recognizable URI types</term>
  274. <listitem><para>
  275. APT can be extended with more methods shipped in other optional packages, which should
  276. follow the naming scheme <package>apt-transport-<replaceable>method</replaceable></package>.
  277. For instance, the APT team also maintains the package <package>apt-transport-https</package>,
  278. which provides access methods for HTTPS URIs with features similar to the http method.
  279. Methods for using e.g. debtorrent are also available - see &apt-transport-debtorrent;.
  280. </para></listitem>
  281. </varlistentry>
  282. </variablelist>
  283. </para>
  284. </refsect1>
  285. <refsect1><title>Examples</title>
  286. <para>Uses the archive stored locally (or NFS mounted) at /home/apt/debian
  287. for stable/main, stable/contrib, and stable/non-free.</para>
  288. <literallayout>deb file:/home/apt/debian stable main contrib non-free</literallayout>
  289. <literallayout>Types: deb
  290. URIs: file:/home/apt/debian
  291. Suites: stable
  292. Components: main contrib non-free</literallayout>
  293. <para>As above, except this uses the unstable (development) distribution.</para>
  294. <literallayout>deb file:/home/apt/debian unstable main contrib non-free</literallayout>
  295. <literallayout>Types: deb
  296. URIs: file:/home/apt/debian
  297. Suites: unstable
  298. Components: main contrib non-free</literallayout>
  299. <para>Source line for the above</para>
  300. <literallayout>deb-src file:/home/apt/debian unstable main contrib non-free</literallayout>
  301. <literallayout>Types: deb-src
  302. URIs: file:/home/apt/debian
  303. Suites: unstable
  304. Components: main contrib non-free</literallayout>
  305. <para>The first line gets package information for the architectures in <literal>APT::Architectures</literal>
  306. while the second always retrieves <literal>amd64</literal> and <literal>armel</literal>.</para>
  307. <literallayout>deb &stable-codename; main
  308. deb [ arch=amd64,armel ] &stable-codename; main</literallayout>
  309. <literallayout>Types: deb
  310. URIs:
  311. Suites: &stable-codename;
  312. Components: main
  313. Types: deb
  314. URIs:
  315. Suites: &stable-codename;
  316. Components: main
  317. Architectures: amd64 armel
  318. </literallayout>
  319. <para>Uses HTTP to access the archive at, and uses only
  320. the hamm/main area.</para>
  321. <literallayout>deb hamm main</literallayout>
  322. <literallayout>Types: deb
  323. URIs:
  324. Suites: hamm
  325. Components: main</literallayout>
  326. <para>Uses FTP to access the archive at, under the debian
  327. directory, and uses only the &stable-codename;/contrib area.</para>
  328. <literallayout>deb &stable-codename; contrib</literallayout>
  329. <literallayout>Types: deb
  330. URIs:
  331. Suites: &stable-codename;
  332. Components: contrib</literallayout>
  333. <para>Uses FTP to access the archive at, under the debian
  334. directory, and uses only the unstable/contrib area. If this line appears as
  335. well as the one in the previous example in <filename>sources.list</filename>
  336. a single FTP session will be used for both resource lines.</para>
  337. <literallayout>deb unstable contrib</literallayout>
  338. <literallayout>Types: deb
  339. URIs:
  340. Suites: unstable
  341. Components: contrib</literallayout>
  342. <para>Uses HTTP to access the archive at, under the
  343. universe directory, and uses only files found under
  344. <filename>unstable/binary-i386</filename> on i386 machines,
  345. <filename>unstable/binary-amd64</filename> on amd64, and so
  346. forth for other supported architectures. [Note this example only
  347. illustrates how to use the substitution variable; official debian
  348. archives are not structured like this]
  349. <literallayout>deb unstable/binary-$(ARCH)/</literallayout>
  350. <literallayout>Types: deb
  351. URIs:
  352. Suites: unstable/binary-$(ARCH)/</literallayout>
  353. </para>
  354. <para>Uses HTTP to get binary packages as well as sources from the stable, testing and unstable
  355. suites and the components main and contrib.</para>
  356. <literallayout>deb stable main contrib
  357. deb-src stable main contrib
  358. deb testing main contrib
  359. deb-src testing main contrib
  360. deb unstable main contrib
  361. deb-src unstable main contrib</literallayout>
  362. <literallayout>Types: deb deb-src
  363. URIs:
  364. Suites: stable testing unstable
  365. Components: main contrib
  366. </literallayout>
  367. </refsect1>
  368. <refsect1><title>See Also</title>
  369. <para>&apt-get;, &apt-conf;
  370. </para>
  371. </refsect1>
  372. &manbugs;
  373. </refentry>