README.progress-reporting

   1 Install-progress reporting
   2 --------------------------
   3
   4 If the apt options: "APT::Status-Fd" is set, apt will send status
   5 reports to that fd. The status information is separated with a ':',
   6 there are the following status conditions:
   7
   8 status = {"pmstatus", "dlstatus", "conffile-prompt", "error", "media-change" }
   9
  10 The reason for using a fd instead of a OpProgress class is that many
  11 apt front-end fork a (vte) terminal for the actual installation.
  12
  13 The reason to do the mapping and l10n of the dpkg states to human
  14 readable (and translatable) strings is that this way the translation
  15 needs to be done only once for all front-ends.
  16
  17
  18 pmstatus
  19 --------
  20 Status of the package manager (dpkg). This is send when packages
  21 are installed/removed.
  22 pmstatus:pkgname:TotalPercentage:action-description
  23
  24 PkgName = the name of the package
  25 TotalPercentage = the total progress between [0..100]
  26 description = a i18ned human readable decription of the current action
  27
  28
  29 Example:
  30 # ./apt-get install -o APT::Status-Fd=2 3dchess >/dev/null
  31 pmstatus:3dchess:20:Preparing 3dchess
  32 pmstatus:3dchess:40:Unpacking 3dchess
  33 pmstatus:3dchess:60:Preparing to configure 3dchess
  34 pmstatus:3dchess:80:Configuring 3dchess
  35 pmstatus:3dchess:100:Installed 3dchess
  36
  37 pmerror
  38 -------
  39 pmerror:deb:TotalPercentage:error string
  40
  41 Example:
  42 pmerror: /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
  45 pmconffile
  46 ----------
  47 pmconffile:conffile:percent:'current-conffile' 'new-conffile' useredited distedited
  48
  49
  50 media-change
  51 ------------
  52 media-change:medium:drive:human-readable string
  53
  54 example:
  55 media-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.
  56
  57
  58 dlstatus
  59 --------
  60 dlstatus:AlreadDownloaded:TotalPercentage:action-description
  61
  62 AlreadyDownloaded = the number of already downloaded packages
  63 TotalPercentage = the total progress between [0..100]
  64 description = a i18ned human readable decription of the current action
  65
  66 Example:
  67 dlstatus:1:9.05654:Downloading file 1 of 3 (4m40s remaining)
  68 dlstatus:1:9.46357:Downloading file 1 of 3 (4m39s remaining)
  69 dlstatus:1:9.61022:Downloading file 1 of 3 (4m38s remaining)