Minor fixes for FTP support
[ntk/apt.git] / doc / apt-get.8.yo
CommitLineData
de50f048
AL
1mailto(apt@packages.debian.org)
2manpage(apt-get)(8)(4 Dec 1998)(apt)()
3manpagename(apt-get)(APT package handling utility -- command-line interface)
4
5manpagesynopsis()
6 apt-get [options] [command] [package ...]
7
8manpagedescription()
9
10apt-get is the command-line tool for handling packages, and may be considered
11the user's "back-end" to apt(8).
12
13em(command) is one of:
14itemize(
15 it() update
16 it() upgrade
17 it() dselect-upgrade
18 it() dist-upgrade
09f2e026
AL
19 it() install package1 [package2] [...]
20 it() remove package1 [package2] [...]
de50f048
AL
21 it() check
22 it() clean
b381f6ed 23 it() autoclean
de50f048
AL
24)
25
26Unless the -h, or --help option is given one of the above commands
09f2e026 27must be present.
de50f048
AL
28
29startdit()
30dit(bf(update))
31bf(update) is used to resynchronize the package overview files from their
32sources. The overviews of available packages are fetched from the
33location(s) specified in bf(/etc/apt/sources.list).
34For example, when using a Debian archive, this command retrieves and
35scans the bf(Packages.gz) files, so that information about new and updated
36packages is available. An bf(update) should always be performed before an
37bf(upgrade) bf(dist-upgrade).
38
39dit(bf(upgrade))
40bf(upgrade) is used to install the newest versions of all packages currently
41installed on the system from the sources enumerated in
42bf(/etc/apt/sources.list). Packages currently installed with new versions
43available are retrieved and upgraded; under no circumstances are currently
44installed packages removed, or packages not already installed retrieved and
45installed. New versions of currently installed packages that cannot be
46upgraded without changing the install status of another package will be left
47at their current version. An bf(update) must be performed first so that
48bf(apt-get) knows that new versions of packages are available.
49
50dit(bf(dselect-upgrade))
51bf(dselect-upgrade)
52is used in conjunction with the traditional Debian GNU/Linux packaging
53front-end, bf(dselect (8)). bf(dselect-upgrade)
54follows the changes made by bf(dselect) to the em(Status)
55field of available packages, and performs the actions necessary to realize
56that state (for instance, the removal of old and the installation of new
57
58dit(bf(dist-upgrade))
59bf(dist-upgrade),in addition to performing the function of bf(upgrade),
60also intelligently handles changing dependencies with new versions of
61packages; bf(apt-get) has a "smart" conflict resolution system, and it will
62attempt to upgrade the most important packages at the expense of less
63important ones if necessary. The bf(/etc/apt/sources.list) file contains a
64list of locations from which to retrieve desired package files.
65
66dit(bf(install))
67bf(install) is followed by one or more em(packages) desired for installation.
68Each em(package) is a package name, not a fully qualified filename
6d5dd02a 69(for instance, in a Debian GNU/Linux system, em(ldso) would be the argument
de50f048
AL
70provided, not em(ldso_1.9.6-2.deb)). All packages required by the package(s)
71specified for installation will also be retrieved and installed. The
72bf(/etc/apt/sources.list) file is used to locate the desired packages. If a
73hyphen is appended to the package name (with no intervening space), the
74identified package will be removed if it is installed. This latter feature
75may be used to override decisions made by apt-get's conflict resolution system.
76
09f2e026
AL
77dit(bf(remove))
78bf(remove) is identical to bf(install) except that packages are removed
79instead of installed. If a plus sign is appended to the package name (with no
80intervening space), the identified package will be installed.
81
de50f048
AL
82dit(bf(check))
83bf(check) is a diagnostic tool; it updates the package cache and checks for
84brokenpackages.
85
86dit(bf(clean))
87df(clean) clears out the local repository of retrieved package files. It
88removes everything but the lock file from bf(/var/cache/apt/archives/)
89and bf(/var/cache/apt/archives/partial/).
90When APT is used as a bf(dselect(8)) method, bf(clean) is run automatically.
91Those who do not use dselect will likely want to run code(apt-get clean)
92from time to time to free up disk space.
b381f6ed
AL
93
94dit(bf(autoclean))
95Like bf(clean), df(autoclean) clears out the local repository of retrieved
96package files. The difference is that it only removes package files that
97can no longer be downloaded, and are largely useless. This allows a
98cache to be maintained over a long period without it growing out of
99control.
100
de50f048
AL
101enddit()
102
103manpageoptions()
3d8fd174
AL
104All command line options may be set using the configuration file, the
105descriptions indicate the configuration option to set. For boolean
106options you can override the config file by using something like bf(-f-),
107bf(--no-f), bf(-f=no) or several other variations.
de50f048
AL
108
109startdit()
110dit(bf(-d, --download-only))
111Download only; package files are only retrieved, not unpacked or installed.
3d8fd174 112See bf(APT::Get::Download-Only).
de50f048
AL
113
114dit(bf(-f, --fix-broken))
115Fix; attempt to correct a system with broken dependencies in
116place. This option may be used alone or in conjunction with any of the
117command actions, and is sometimes necessary when running APT for the
118first time; APT itself does not allow broken package dependencies to
119exist on a system. It is possible that a system's dependency structure
120can be so corrupt as to require manual intervention (which usually
121means using dselect or dpkg --remove to eliminate some of the offending
122packages). Use of this option together with -m may produce an error in
3d8fd174 123some situations. See bf(APT::Get::Fix-Broken).
de50f048
AL
124
125dit(bf(-h, --help))
126Help; display a helpful usage message and exits.
127
04aa15a8
AL
128dit(bf(-v, --version))
129Show the program verison.
130
de50f048
AL
131dit(bf(-m, --ignore-missing))
132Ignore missing packages; If packages cannot be retrieved or fail the
133integrity check after retrieval (corrupted package files), hold back
134those packages and handle the result. Use of this option together with
d59cbe7f 135-f may produce an error in some situations. See bf(ignore-missing).
de50f048 136
09f2e026 137dit(bf(-q, --quiet))
de50f048
AL
138Quiet; produces output suitable for logging, omitting progress indicators.
139More qs will produce more quite up to a maximum of 2. You can also use
140bf(-q=#) to set the quiet level, overriding the configuration file.
3d8fd174 141See bf(quiet)
de50f048
AL
142
143dit(bf(-s, --simulate, --just-print, --dry-run, --recon, --no-act))
144No action; perform a simulation of events that would occur but do not
5c2cb6e4
AL
145actually change the system. See bf(APT::Get::Simulate). Simulate prints out
146a series of lines each one representing a dpkg operation, Configure (Conf),
147Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with
148and empty set of square brackets meaning breaks that are of no consequence
149(rare).
de50f048
AL
150
151dit(bf(-y, --yes, --assume-yes))
152Automatic yes to prompts; assume "yes" as answer to all prompts and run
153non-interactively. If an undesireable situation, such as changing a held
154package or removing an essential package occures then bf(apt-get) will
3d8fd174 155abort. See bf(APT::Get::Assume-Yes).
de50f048
AL
156
157dit(bf(-u, --show-upgraded))
158Show upgraded packages; Print out a list of all packages that are to be
3d8fd174 159upgraded. See bf(APT::Get::Show-Upgraded).
de50f048
AL
160
161dit(bf(--ignore-hold))
162Ignore package Holds; This causes bf(apt-get) to ignore a hold placed on
163a package. This may be usefull in conjunction with bf(dist-upgrade) to
3d8fd174 164override a large number of undesired holds. See bf(APT::Ingore-Hold).
de50f048
AL
165
166dit(bf(--no-upgrade))
167Do not upgrade packages; When used in conjunction with bf(install)
168bf(no-upgrade) will prevent packages listed from being upgraded if they
3d8fd174 169are already installed. See bf(APT::Get::no-upgrade).
de50f048
AL
170
171dit(bf(--force-yes))
172Force yes; This is a dangerous option that will cause apt to continue without
173prompting if it is doing something potentially harmfull. It should not be used
174except in very special situations. Using bf(force-yes) can potentially destroy
3d8fd174 175your system! See bf(APT::Get::force-yes).
de50f048 176
f7a08e33
AL
177dit(bf(--print-uris))
178Instead of fetching the files to install their URIs are printed. Each
179URI will have the path, the destination file name, the size and the expected
180md5 hash. Note that the file name to write to will not always match
181the file name on the remote site! See bf(APT::Get::Print-URIs).
182
de50f048
AL
183dit(bf(-c, --config-file))
184Configuration File; Specify a configuration file to use. bf(apt-get) will
185read the default configuration file and then this configuration file. See
186bf(apt.conf(5)) for syntax information.
187
188dit(bf(-o, --option))
189Set a Configuration Option; This will set an arbitary configuration option.
190The syntax is
191verb(-o Foo::Bar=bar)
09f2e026 192enddit()
de50f048
AL
193
194manpagefiles()
195itemize(
196 it() /etc/apt/sources.list
197 locations to fetch packages from
198
199 it() /var/cache/apt/archives/
200 storage area for retrieved package files
201
202 it() /var/cache/apt/archives/partial/
203 storage area for package files in transit
204
205 it() /var/state/apt/lists/
206 storage area for state information for each package resource specified in
207
208 it() /var/state/apt/lists/partial/
209 storage area for state information in transit
210)
211
212manpageseealso()
09f2e026
AL
213apt-cache(8),
214dpkg(8),
215dselect(8),
216sources.list(5),
3d8fd174 217apt.conf(5),
09f2e026 218The APT Users Guide in /usr/doc/apt/
de50f048
AL
219
220manpagediagnostics()
221apt-get returns zero on normal operation, decimal 100 on error.
222
223manpagebugs()
d59cbe7f 224See http://bugs.debian.org/apt. If you wish to report a
de50f048
AL
225bug in bf(apt-get), please see bf(/usr/doc/debian/bug-reporting.txt)
226or the bf(bug(1)) command.
227
228manpageauthor()
229apt-get was written by the APT team <apt@packages.debian.org>.