more explicit MarkRequired algorithm code

[apt.git] / README.progress-reporting

diff --git a/README.progress-reporting b/README.progress-reporting
index 7ae5149293f0743cf09bce258ef8386d2c9383e1..5d9b581c5e41ba67a41d14674c840f90f8ae7c28 100644 (file)
--- a/README.progress-reporting
+++ b/README.progress-reporting
@@ -2,17 +2,17 @@ Install-progress reporting
 --------------------------
 
 If the apt options: "APT::Status-Fd" is set, apt will send status
-reports to that fd. The status information is seperated with a ':', 
+reports to that fd. The status information is separated with a ':',
 there are the following status conditions:
 
-status = {"pmstatus", "dlstatus", "conffile-prompt", "error" } 
+status = {"pmstatus", "dlstatus", "conffile-prompt", "error", "media-change" } 
 
 The reason for using a fd instead of a OpProgress class is that many
-apt frontend fork a (vte) terminal for the actual installation.
+apt front-end fork a (vte) terminal for the actual installation.
 
 The reason to do the mapping and l10n of the dpkg states to human
 readable (and translatable) strings is that this way the translation
-needs to be done only once for all frontends.
+needs to be done only once for all front-ends.
 
 
 pmstatus
@@ -34,6 +34,26 @@ pmstatus:3dchess:60:Preparing to configure 3dchess
 pmstatus:3dchess:80:Configuring 3dchess
 pmstatus:3dchess:100:Installed 3dchess
 
+pmerror
+-------
+pmerror:deb:TotalPercentage:error string
+
+Example:
+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 
+
+
+pmconffile
+----------
+pmconffile:conffile:percent:'current-conffile' 'new-conffile' useredited distedited
+
+
+media-change
+------------
+media-change:medium:drive:human-readable string
+
+example:
+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.
+
 
 dlstatus
 --------