debconf_spec/include/types.xml

   1 <table frame="all">
   2   <title>Available data types</title>
   3   <tgroup cols="2">
   4   <thead>
   5     <row>
   6       <entry>Type</entry>
   7       <entry>Description</entry>
   8     </row>
   9   </thead>
  10   <tbody>
  11     <row>
  12       <entry>string</entry>
  13       <entry>Holds any arbitrary string of data.</entry>
  14     </row>
  15     <row>
  16       <entry>boolean</entry>
  17       <entry>
  18          Holds "<literal>true</literal>" or "<literal>false</literal>".
  19       </entry>
  20     </row>
  21     <row>
  22       <entry>select</entry>
  23       <entry>
  24         Holds one of a finite number of possible values. These
  25         values must be specified in a field named
  26         <literal>Choices:</literal>. Separate the possible values
  27         with commas and spaces, like this:
  28         <literal>
  29           Choices: yes, no, maybe
  30         </literal>
  31       </entry>
  32     </row>
  33     <row>
  34       <entry>multiselect</entry>
  35       <entry>
  36         Just like the select data type, except the user can choose any
  37         number of items from the list. This means that the
  38         <literal>Default:</literal> field and the actual value of the
  39         question may be a comma and space delimited list of values,
  40         just like the <literal>Choices:</literal> field.
  41       </entry>
  42     </row>
  43     <row>
  44       <entry>note</entry>
  45       <entry>
  46         This template is a note that can be displayed to the user. As
  47         opposed to text, it is something important, that the user really
  48         should see. If it is not possible to display it, it might be
  49         saved to a log file or mailbox for them to see later.
  50       </entry>
  51     </row>
  52     <row>
  53       <entry>text</entry>
  54       <entry>
  55         This template is a scrap of text that can be displayed to
  56         the user. It's intended to be used for mostly cosmetic
  57         reasons, touching up around other questions that are asked
  58         at the same time. Unlike a note, it isn't treated as
  59         something the user should definitely see. Less complex frontends
  60         may refuse to ever display this type of element.
  61       </entry>
  62     </row>
  63     <row>
  64       <entry>password</entry>
  65       <entry>
  66         Holds a password. Use with caution. Be aware that the password
  67         the user enters will be written to a database. You
  68         should consider clearing that value out of the database as soon
  69         as is possible.
  70       </entry>
  71     </row>
  72     <row>
  73       <entry>title</entry>
  74       <entry>
  75         Holds a (short) string that can be displayed using the SETTITLE
  76         command. Only the value of the short description will be used.
  77       </entry>
  78     </row>
  79   </tbody>
  80 </tgroup>
  81 </table>
  82