X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=debconf_spec%2Finclude%2Fcommands.xml;h=b8d30c27cadc339bbe461f255c56acc389a620fb;hb=3c725b9d2af39ac3a7e24b7d9eb374a48c5b6893;hp=dde75a265ba3b7122cf030dc6c59f8f0e90830ff;hpb=2a0ff03e2c37c1cf40f65c6ec8bac58f9cfc0c66;p=debian%2Fdebian-policy.git
diff --git a/debconf_spec/include/commands.xml b/debconf_spec/include/commands.xml
index dde75a2..b8d30c2 100644
--- a/debconf_spec/include/commands.xml
+++ b/debconf_spec/include/commands.xml
@@ -6,7 +6,7 @@
This exchanges with the frontend the protocol version
number that is being used. The current version is
- 2.0. Versions in the 2.x series will be
+ 2.1. Versions in the 2.x series will be
backwards-compatible. You may specify the protocol version
number you are speaking. The frontend will return the version
of the protocol it speaks. If the version you specify is too
@@ -40,12 +40,22 @@
Backing up to a previous step is supported.
+
+ escape
+
+ The frontend expects commands sent to it to have backslashes and
+ newlines quoted as \\ and \n
+ respectively and will in turn quote backslashes and newlines in its
+ replies. See debconf-escape
+ 1.
+
+
multiselect
- The multiselect data type is supported. For compatability
- reasons, you should not ask questions of this type unless
- this capability is returned.
+ The multiselect data type is supported. You do not need to
+ check this capability if you depend on any modern version
+ of debconf.
@@ -53,10 +63,10 @@
-
+
- TITLE
- string
+ SETTITLE
+ template
You can use this command to set a title in the
@@ -65,7 +75,23 @@
of the frontend's window. If you don't specify anything, a
title will automatically be generated.
-
+
+ Using a template has the advantage that titles are translatable
+ and that they can be maintained in the same place as other text
+ displayed to users.
+
+
+
+
+ TITLE
+ string
+
+
+ Similar to SETTITLE, but takes a string instead of a template as
+ parameter. Consequence is that the title will not be translatable,
+ unless some other mechanism (like gettext) is used.
+
+
STOP
@@ -185,11 +211,12 @@
value
- Questions (and other items) can have substitutions embedded in their
- descriptions. These substitutions look like
- "${key}". When the question is displayed,
- the substitutions are replaced with their values. This
- command can be used to set the value of a substitution.
+ Questions (and other items) can have substitutions embedded in
+ their descriptions (and, currently in their choices fields). These
+ substitutions look like "${key}". When the
+ question is displayed, the substitutions are replaced with their
+ values. This command can be used to set the value of a
+ substitution.
@@ -200,7 +227,7 @@
Questions (and other items) can have flags associated with them. The
- flags have a value of "true" or
+ flags have a value of "true" or
"false". This command returns
the value of a flag.
@@ -214,11 +241,11 @@
This sets the state of a flag on a question. Valid
- states for the flag are "true" and
+ states for the flag are "true" and
"false".
- One common flag is the
+ One common flag is the
"seen" flag. It is normally only set if
a user already seen a question.
Typically, frontends only display questions to users if they have the
@@ -226,6 +253,13 @@
question again -- in these cases you can set the seen flag to
false to force the frontend to redisplay it.
+
+ Note that as a special convenience behavior, frontends will
+ redisplay already seen questions if the question was first seen by
+ the user in the same confmodule run. This makes it easy for a
+ confmodule to back up to previous questions without having to reset
+ the seen flag.
+
@@ -266,7 +300,7 @@
PURGE
- Call this in your postinst when your package is
+ Call this in your postrm when your package is
purged. It removes all templates and questions your
package has generated.