- update sources.list to document the types we support these days
authorpmatilai <pmatilai>
Sun, 9 Apr 2006 09:03:53 +0000 (09:03 +0000)
committerpmatilai <pmatilai>
Sun, 9 Apr 2006 09:03:53 +0000 (09:03 +0000)
doc/sources.list.5.sgml

index a544ca6..c2bd6d5 100644 (file)
  <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.
+   distribution system in use on the system. 
    This control file is located in <filename>/etc/apt/sources.list</>
+   and additionally any files ending in .list in 
+   <filename>/etc/apt/sources.list.d</> are included.
    </>
    <para>
    The source list is designed to support any number of active sources and a
    Resource Locator, or URL. The rest of the line can be marked as a comment 
    by using a #.
    </>
+   <para>
+   The generic format of sources.list entry is:
+   <literallayout>type baseuri distribution [component comp2 ...]</literallayout>
+   </para>
+
+   <para>
+   Type is one of the types explained below. Baseuri is the URI to the root
+   of given distribution, distribution part points to a given distribution
+   name, version and architecture. The splitting of URI into baseuri and
+   distribution parts should be done in a way that allows pointing the baseuri
+   to another mirror without touching distribution.
+
+   Some types additionally support a component-entry.
+   </para>
+
+   <para>
+   The following variable substitutions are done on sources.list entries:
+
+   <literal/$(ARCH)/ is substituted with the base archecture of the system.
+   </para><para>
+   <literal/$(VERSION)/ is substituted with the distribution version if
+   configured automatically via Apt::DistroVerPkg or manually via 
+   Apt::DistroVersion configuration option.
+   </para>
  </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.</>
+ <RefSect1><Title>The repomd and repomd-src types</>
    <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><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><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><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:
-   <literallayout>
-deb http://http.us.debian.org/debian stable main contrib non-free
-deb http://http.us.debian.org/debian dists/stable-updates/
-   </literallayout>
+   The format of repomd and repomd-src sources.list entries is:
+   <literallayout>repomd baseuri distribution</literallayout>
+   <literallayout>repomd-src baseuri distribution</literallayout>
+   Repomd repositories do not support a concept of "components"!
+   </para>
+    
+ </RefSect1>
+
+ <RefSect1><Title>The rpm and rpm-src types</>
+   <para>
+   The format of rpm and rpm-src sources.list entries is:
+   <literallayout>rpm baseuri distribution component [comp2 ...]</literallayout>
+   <literallayout>rpm-src baseuri distribution component [comp2 ...]</literallayout>
+   At least one component must be specified for rpm and rpm-src 
+   repositories.
+   </para>
+ </RefSect1>
+
+ <RefSect1><Title>The rpm-dir and rpm-src-dir types</>
+   <para>
+   The format of rpm-dir and rpm-src-dir sources.list entries is:
+   <literallayout>rpm-dir baseuri distribution component [comp2 ...]</literallayout>
+   <literallayout>rpm-src-dir baseuri distribution component [comp2 ...]</literallayout>
+   At least one component must be specified for rpm and rpm-src 
+   repositories. Rpm-dir and rpm-src-dir only accept file:// uri's!
    </para>
  </RefSect1>
 
@@ -154,50 +154,23 @@ deb http://http.us.debian.org/debian dists/stable-updates/
  
  <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>
-   <para>
-   As above, except this uses the unstable (development) distribution.
-   <literallayout>deb file:/home/jason/debian unstable main contrib non-free</literallayout>
-   </para>
-   <para>
-   Source line for the above
-   <literallayout>deb-src file:/home/jason/debian unstable main contrib non-free</literallayout>
-   </para>
-   <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>
-   <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>
-   <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>
-   <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>
+   Repomd entries for Fedora Core, Extras and Updates using variable
+   substitution, assumes Apt::DistroVerPkg is set to "fedora-release":
+   <literallayout>
+   repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/$(VERSION)/$(ARCH)/os/
+   repomd http://download.fedora.redhat.com/pub/ fedora/linux/extras/$(VERSION)/$(ARCH)/
+   repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/updates/$(VERSION)/$(ARCH)/
+   </literallayout>
    </para>
+   
    <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>
+   Local mirror (local disk, NFS mounted etc) of Fedora Core at 
+   /var/www/html/fedora/
+   <literallayout>
+   repomd file:/var/www/html fedora/linux/core/$(VERSION)/$(ARCH)/
+   </literallayout>
    </para>
+
  </RefSect1>
  
  <RefSect1><Title>See Also</>