X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=debconf_spec%2Fdebconf_specification.xml;h=a163213b97d37ed64d394e47c50e5ea614092c3e;hb=bb91a7facf981330bd079b0ba58523b9f28c57ce;hp=ce90d050465fcf8cd248d475c98fb64d1216e919;hpb=1d83fcff82d53005f1adc62f3c002d8cb7b98517;p=debian%2Fdebian-policy.git diff --git a/debconf_spec/debconf_specification.xml b/debconf_spec/debconf_specification.xml index ce90d05..a163213 100644 --- a/debconf_spec/debconf_specification.xml +++ b/debconf_spec/debconf_specification.xml @@ -1,5 +1,5 @@ - @@ -10,7 +10,8 @@ Configuration management - revision 7.0 + Protocol version 2.1 + Revision 7.1 Wichert @@ -60,7 +61,7 @@ - + Introduction @@ -92,13 +93,13 @@ use a flat space, or divide its space further into sub-hierarchies. If multiple packages share a common purpose they may use a shared toplevel hierarchy, preferably with the same name - as a shared (virtual) package name (for example, both + as a shared (virtual) package name (for example, both <application>mutt</application> and <application>elm</application> - can use <literal>mail-reader</literal>, + can use <literal>mail-reader</literal>, <application>strn</application> and <application>nn</application> could use <literal>news-reader</literal>). This shared tree can also be used as a default, ie a variable - <literal>news-reader/nntpserver</literal> can be used by + <literal>news-reader/nntpserver</literal> can be used by <application>strn</application> if <literal>strn/nntpserver</literal> does not exist. </para> @@ -109,7 +110,7 @@ </para> </sect2> </sect1> - + <sect1> <title> Templates @@ -138,8 +139,8 @@ So, what do we need to store in a variable template? Of course we need a name to identify the template. Template names are made up of components separated by the character `/' (slash). - Each component is limited to alphanumerics and `+' `-' `.' - (plus, minus, full stop). + Each component is limited to alphanumerics and `+' `-' `.' `_' + (plus, minus, full stop, underscore). </para> <para> A type is also needed so data can be verified. Here is a table @@ -164,7 +165,7 @@ </para> <para> This information is stored in a template file that consists of - stanzas in a rfc-822 compliant format, separated by blank lines. + stanzas in a rfc-822 compliant format, separated by blank lines. Here is an example: <programlisting> Template: hostname @@ -181,6 +182,15 @@ Description: domain for this computer something like "mycompany.com" or "myuniversity.edu". </programlisting> </para> + <para> + For localization, the description field (and also the choices + field of a select or multiselect type question, and the + default field of a string or password type question) can be + supplemented with versions for other languages. These are + named <emphasis>Description-ll</emphasis>, + <emphasis>Description-ll_LL</emphasis>, + <emphasis>Description-ll_LL.encoding</emphasis> and so on. + </para> </sect2> </sect1> <sect1> @@ -226,7 +236,7 @@ Description: domain for this computer exactly one line. </para> <para> - After sending each command to stdout, the client + After sending each command to stdout, the client should read one line from stdin. This is the response to the command, and it will be in the form of a number followed by whitespace and an optional string of text. The number is the status code, while the @@ -264,12 +274,16 @@ Description: domain for this computer section on templates. </para> <para> - The config-file contains a new element, which I call the configmodule. - This is a program that will determine the configuration before the - package is unpacked. This means it is run <emphasis>before</emphasis> - the preinst, and before the package is unpacked! This is done to make - sure that we can use the desired configuration in the preinst if - necessary. + The config-file contains a new element, which I call the + configmodule. This is a program that will determine the + configuration before the package is unpacked. This means it is + usually run <emphasis>before</emphasis> the preinst, and before + the package is unpacked! + <note> + <simpara>Please see debconf-devel(7) for details.</simpara> + </note> + This is done to make sure that we can + use the desired configuration in the preinst if necessary. </para> <para> How does the configmodule get its information? The configmodule