- only build documentation in maintainer-mode, include prebuilt manuals
[apt.git] / doc / sources.list.5
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "SOURCES.LIST" "5" "29 May 2006" "" ""
7
8 .SH NAME
9 sources.list \- Package resource list for APT
10 .SH "DESCRIPTION"
11 .PP
12 The package resource list is used to locate archives of the package
13 distribution system in use on the system. 
14 This control file is located in \fI/etc/apt/sources.list\fR
15 and additionally any files ending in .list in 
16 \fI/etc/apt/sources.list.d\fR are included.
17 .PP
18 The source list is designed to support any number of active sources and a
19 variety of source media. The file lists one source per line, with the
20 most preferred source listed first. The format of each line is:
21 type uri args\&. The first item, type, determines the 
22 format for args\&. uri is a Universal Resource Identifier 
23 (URI), which is a superset of the more specific and well-known Universal
24 Resource Locator, or URL. The rest of the line can be marked as a comment 
25 by using a #.
26 .PP
27 The generic format of sources.list entry is:
28
29 .nf
30 type baseuri distribution [component comp2 ...]
31 .fi
32 .PP
33 Type is one of the types explained below. Baseuri is the URI to the root
34 of given distribution, distribution part points to a given distribution
35 name, version and architecture. The splitting of URI into baseuri and
36 distribution parts should be done in a way that allows pointing the baseuri
37 to another mirror without touching distribution.
38 Some types additionally support a component-entry.
39 .PP
40 The following variable substitutions are done on sources.list entries:
41 $(ARCH) is substituted with the base archecture of the system.
42 .PP
43 $(VERSION) is substituted with the distribution version if
44 configured automatically via Apt::DistroVerPkg or manually via 
45 Apt::DistroVersion configuration option.
46 .SH "THE REPOMD AND REPOMD-SRC TYPES"
47 .PP
48 The format of repomd and repomd-src sources.list entries is:
49
50 .nf
51 repomd baseuri distribution
52 .fi
53
54 .nf
55 repomd-src baseuri distribution
56 .fi
57 Repomd repositories do not support a concept of "components"!
58 .SH "THE RPM AND RPM-SRC TYPES"
59 .PP
60 The format of rpm and rpm-src sources.list entries is:
61
62 .nf
63 rpm baseuri distribution component [comp2 ...]
64 .fi
65
66 .nf
67 rpm-src baseuri distribution component [comp2 ...]
68 .fi
69 At least one component must be specified for rpm and rpm-src 
70 repositories.
71 .SH "THE RPM-DIR AND RPM-SRC-DIR TYPES"
72 .PP
73 The format of rpm-dir and rpm-src-dir sources.list entries is:
74
75 .nf
76 rpm-dir baseuri distribution component [comp2 ...]
77 .fi
78
79 .nf
80 rpm-src-dir baseuri distribution component [comp2 ...]
81 .fi
82 At least one component must be specified for rpm and rpm-src 
83 repositories. Rpm-dir and rpm-src-dir only accept file:// uri's!
84 .SH "URI SPECIFICATION"
85 .PP
86 The currently recognized URI types are cdrom, file, http, and ftp.
87 .TP
88 \fBfile\fR
89 The file scheme allows an arbitrary directory in the file system to be
90 considered an archive. This is useful for NFS mounts and local mirrors or
91 archives.
92 .TP
93 \fBcdrom\fR
94 The cdrom scheme allows APT to use a local CDROM drive with media
95 swapping. Use the \fBapt-cdrom\fR(8) program to create cdrom entries in the
96 source list.
97 .TP
98 \fBhttp\fR
99 The http scheme specifies an HTTP server for the archive. If an environment
100 variable \fBhttp_proxy\fR is set with the format 
101 http://server:port/, the proxy server specified in
102 \fBhttp_proxy\fR will be used. Users of authenticated HTTP/1.1 proxies 
103 may use a string of the format http://user:pass@server:port/
104 Note that this is an insecure method of authentication.
105 .TP
106 \fBftp\fR
107 The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
108 is highly configurable; for more information see the
109 \fB\fIapt.conf\fB\fR(5) manual page. Please note that a ftp proxy can be specified
110 by using the \fBftp_proxy\fR environment variable. It is possible to 
111 specify a http proxy (http proxy servers often understand ftp urls) using 
112 this method and ONLY this method. ftp proxies using http specified in the 
113 configuration file will be ignored.
114 .TP
115 \fBcopy\fR
116 The copy scheme is identical to the file scheme except that packages are
117 copied into the cache directory instead of used directly at their location.
118 This is useful for people using a zip disk to copy files around with APT.
119 .TP
120 \fBrsh\fR
121 .TP
122 \fBssh\fR
123 The rsh/ssh method invokes rsh/ssh to connect to a remote host
124 as a given user and access the files. No password authentication is 
125 possible, prior arrangements with RSA keys or rhosts must have been made.
126 Access to files on the remote uses standard \fBfind\fR and \fBdd\fR 
127 commands to perform the file transfers from the remote.
128 .SH "EXAMPLES"
129 .PP
130 Repomd entries for Fedora Core, Extras and Updates using variable
131 substitution, assumes Apt::DistroVerPkg is set to "fedora-release":
132
133 .nf
134    repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/$(VERSION)/$(ARCH)/os/
135    repomd http://download.fedora.redhat.com/pub/ fedora/linux/extras/$(VERSION)/$(ARCH)/
136    repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/updates/$(VERSION)/$(ARCH)/
137    
138 .fi
139 .PP
140 Local mirror (local disk, NFS mounted etc) of Fedora Core at 
141 /var/www/html/fedora/
142
143 .nf
144    repomd file:/var/www/html fedora/linux/core/$(VERSION)/$(ARCH)/
145    
146 .fi
147 .SH "SEE ALSO"
148 .PP
149 \fBapt-cache\fR(8) \fB\fIapt.conf\fB\fR(5)
150 .SH "BUGS"
151 .PP
152 See the APT bug page <URL:http://bugs.debian.org/src:apt>\&.  
153 If you wish to report a bug in APT, please see
154 \fI/usr/share/doc/debian/bug-reporting.txt\fR or the \fBreportbug\fR(1) command.
155 .SH "AUTHOR"
156 .PP
157 APT was written by the APT team <apt@packages.debian.org>\&.