use a format string in ListSingleVersion
[ntk/apt.git] / README.progress-reporting
CommitLineData
75ef8f14
MV
1Install-progress reporting
2--------------------------
3
4If the apt options: "APT::Status-Fd" is set, apt will send status
1e3f4083 5reports to that fd. The status information is separated with a ':',
75ef8f14
MV
6there are the following status conditions:
7
80a26ed1 8status = {"pmstatus", "dlstatus", "conffile-prompt", "error", "media-change" }
75ef8f14
MV
9
10The reason for using a fd instead of a OpProgress class is that many
11apt frontend fork a (vte) terminal for the actual installation.
12
13The reason to do the mapping and l10n of the dpkg states to human
14readable (and translatable) strings is that this way the translation
15needs to be done only once for all frontends.
16
17
18pmstatus
19--------
20Status of the package manager (dpkg). This is send when packages
21are installed/removed.
22pmstatus:pkgname:TotalPercentage:action-description
23
24PkgName = the name of the package
25TotalPercentage = the total progress between [0..100]
26description = a i18ned human readable decription of the current action
27
28
29Example:
30# ./apt-get install -o APT::Status-Fd=2 3dchess >/dev/null
31pmstatus:3dchess:20:Preparing 3dchess
32pmstatus:3dchess:40:Unpacking 3dchess
33pmstatus:3dchess:60:Preparing to configure 3dchess
34pmstatus:3dchess:80:Configuring 3dchess
35pmstatus:3dchess:100:Installed 3dchess
36
37pmerror
38-------
39pmerror:deb:TotalPercentage:error string
40
41Example:
42pmerror: /var/cache/apt/archives/krecipes_0.8.1-0ubuntu1_i386.deb : 75% : trying to overwrite `/usr/share/doc/kde/HTML/en/krecipes/krectip.png', which is also in package krecipes-data
43
44
45pmconffile
46----------
47pmconffile:conffile:percent:'current-conffile' 'new-conffile' useredited distedited
48
49
80a26ed1
MV
50media-change
51------------
1a82c63e 52media-change:medium:drive:human-readable string
80a26ed1
MV
53
54example:
1a82c63e 55media-change: Ubuntu 5.10 _Breezy Badger_ - Alpha i386 (20050830):/cdrom/:Please insert the disc labeled: 'Ubuntu 5.10 _Breezy Badger_ - Alpha i386 (20050830)' in the drive '/cdrom/' and press enter.
80a26ed1 56
75ef8f14
MV
57
58dlstatus
59--------
60dlstatus:AlreadDownloaded:TotalPercentage:action-description
61
62AlreadyDownloaded = the number of already downloaded packages
63TotalPercentage = the total progress between [0..100]
64description = a i18ned human readable decription of the current action
65
66Example:
67dlstatus:1:9.05654:Downloading file 1 of 3 (4m40s remaining)
68dlstatus:1:9.46357:Downloading file 1 of 3 (4m39s remaining)
69dlstatus:1:9.61022:Downloading file 1 of 3 (4m38s remaining)