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