initial commit
[gconf-editor] / docs / oc / gconf-editor.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- -*- indent-tabs-mode: nil -*- -->
3 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY legal SYSTEM "legal.xml">
5 <!ENTITY appversion "2.8">
6 <!ENTITY manrevision "2.8">
7 <!ENTITY date "September 2004">
8 <!ENTITY app "Configuration Editor">
9 ]>
10 <!-- 
11       (Do not remove this comment block.)
12   Maintained by the GNOME Documentation Project
13   http://developer.gnome.org/projects/gdp
14   Template version: 2.0 beta
15   Template last modified Feb 12, 2002
16 -->
17 <article id="index" lang="oc">
18 <!-- please do not change the id; for translations, change lang to -->
19 <!-- appropriate code -->
20   <articleinfo> 
21     <title>Configuration Editor Manual</title>       
22     <copyright> 
23       <year>2004</year>
24       <holder>Sun Microsystems</holder> 
25     </copyright>
26     <!-- translators: uncomment this:
27          <copyright>
28          <year>2003</year>
29          <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
30          </copyright>
31     -->
32
33     <publisher role="maintainer"> 
34       <publishername>Projècte de documentacion de GNOME</publishername> 
35     </publisher> 
36
37        <legalnotice id="legalnotice">
38          <para>
39            Permission is granted to copy, distribute and/or modify this
40            document under the terms of the GNU Free Documentation
41            License (GFDL), Version 1.1 or any later version published
42            by the Free Software Foundation with no Invariant Sections,
43            no Front-Cover Texts, and no Back-Cover Texts.  You can find
44            a copy of the GFDL at this <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
45            distributed with this manual.
46           </para>
47           <para> This manual is part of a collection of GNOME manuals
48            distributed under the GFDL.  If you want to distribute this
49            manual separately from the collection, you can do so by
50            adding a copy of the license to the manual, as described in
51            section 6 of the license.
52          </para>
53  
54          <para>
55            Many of the names used by companies to distinguish their
56            products and services are claimed as trademarks. Where those
57            names appear in any GNOME documentation, and the members of
58            the GNOME Documentation Project are made aware of those
59            trademarks, then the names are in capital letters or initial
60            capital letters.
61          </para>
62  
63          <para>
64            DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
65            UNDER  THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
66            WITH THE FURTHER UNDERSTANDING THAT:
67  
68            <orderedlist>
69                  <listitem>
70                    <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
71                      WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
72                      IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
73                      THAT THE DOCUMENT OR MODIFIED VERSION OF THE
74                      DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
75                      A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
76                      RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
77                      OF THE DOCUMENT OR MODIFIED VERSION OF THE
78                      DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
79                      MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
80                      YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
81                      CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
82                      SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
83                      OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
84                      LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
85                      VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
86                      EXCEPT UNDER THIS DISCLAIMER; AND
87                    </para>
88                  </listitem>
89                  <listitem>
90                    <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
91                         THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
92                         CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
93                         INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
94                         DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
95                         OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
96                         PARTIES, BE LIABLE TO ANY PERSON FOR ANY
97                         DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
98                         CONSEQUENTIAL DAMAGES OF ANY CHARACTER
99                         INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
100                         OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
101                         MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
102                         LOSSES ARISING OUT OF OR RELATING TO USE OF THE
103                         DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
104                         EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
105                         THE POSSIBILITY OF SUCH DAMAGES.
106                    </para>
107                  </listitem>
108            </orderedlist>
109          </para>
110    </legalnotice>
111  
112     <!-- This file  contains link to license for the documentation (GNU FDL), and 
113          other legal stuff such as "NO WARRANTY" statement. Please do not change 
114          any of this. -->
115
116     <authorgroup>
117       <author>
118         <firstname>Sun</firstname>
119         <surname>Còla de documentacion de GNOME</surname>
120         <affiliation><orgname>Sun Microsystems</orgname></affiliation>
121       </author>
122       <author>
123         <firstname>Angela</firstname>
124         <surname>Boyle</surname>
125         <affiliation>
126           <orgname>Projècte de documentacion de GNOME</orgname>
127         </affiliation>
128       </author>
129       <editor>
130         <firstname>Shaun</firstname>
131         <surname>McCance</surname>
132         <affiliation>
133           <orgname>Projècte de documentacion de GNOME</orgname>
134         </affiliation>
135       </editor>
136       <!-- This is appropriate place for other contributors: translators,
137            maintainers,  etc. Commented out by default.
138            <othercredit role="translator">
139            <firstname>Latin</firstname> 
140            <surname>Translator 1</surname> 
141            <affiliation> 
142            <orgname>Latin Translation Team</orgname> 
143            <address> <email>translator@gnome.org</email> </address> 
144            </affiliation>
145            <contrib>Latin translation</contrib>
146            </othercredit>
147       -->
148     </authorgroup>
149     <abstract role="description"><para>Configuration Editor can be used to change configuration options used by applications that may not be available through Preference dialogs</para></abstract>
150
151     <revhistory>
152       <revision>
153         <revnumber>Version 2.8</revnumber>
154         <date>Setembre de 2004</date>
155         <revdescription>
156           <para role="author">Projècte de documentacion de GNOME</para>
157           <para role="publisher">Projècte de documentacion de GNOME</para>
158           <para role="status">unreviewed</para>
159         </revdescription>
160       </revision>
161       <revision> 
162         <revnumber>Version 2.1</revnumber> 
163         <date>Agost de 2004</date> 
164         <revdescription> 
165           <para role="author">Còla Sun de documentacion de GNOME</para>
166           <para role="publisher">Projècte de documentacion de GNOME</para>
167         </revdescription> 
168       </revision>
169       <revision> 
170         <revnumber>Version 2.0.1</revnumber> 
171         <date>January 2004</date> 
172         <revdescription> 
173           <para role="author">Còla Sun de documentacion de GNOME</para>
174           <para role="publisher">Projècte de documentacion de GNOME</para>
175         </revdescription> 
176       </revision>
177     </revhistory> 
178     <releaseinfo>This manual describes version 2.8 of Configuration Editor.</releaseinfo> 
179     <legalnotice> 
180       <title>Feedback</title> 
181       <para>To report a bug or make a suggestion regarding the Configuration Editor application or
182       this manual, follow the directions in the 
183       <ulink url="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>. 
184       </para>
185       <!-- Translators may also add here feedback address for translations -->
186     </legalnotice> 
187 </articleinfo> 
188
189 <indexterm> 
190   <primary>GConf Editor</primary> 
191 </indexterm>
192
193 <sect1 id="introduction">
194   <title>Introduccion</title>
195   <para>The GNOME Desktop and many applications use
196   <application>GConf</application> to store user preferences and
197   system configuration data.  <application>GConf</application>
198   provides a central storage location for preferences, simplifying
199   configuration management for users and system administrators.  More
200   information about <application>GConf</application> can be found in the
201   <ulink url="ghelp:system-admin-guide#gconf-0">GNOME System
202   Administrator's Guide</ulink>.</para>
203   <para><application>Configuration Editor</application> allows users to modify their
204   preferences for the entire GNOME Desktop and any applications which
205   use <application>GConf</application>.  Additionally, system administrators
206   can use <application>Configuration Editor</application> to set default and mandatory
207   settings which will affect all users.</para>
208   <para>Preferences are stored in <application>GConf</application> in a
209   hierarchy of keys.  Each key has an associated value which specifies
210   your setting for that preference.  For instance, the key
211   <literal>/apps/glines/preferences/ball_theme</literal> stores which theme
212   you use in the game <application>Five or More</application>.</para>
213   <caution><para><application>Configuration Editor</application> enables you to modify your
214   configuration source directly. If you are not an experienced user, do not
215   use <application>Configuration Editor</application> to set preferences for the GNOME
216   Desktop. Instead, use the preference tools in the GNOME Desktop. For
217   information about how to use preference tools, see the latest version
218   of the <ulink url="ghelp:user-guide">GNOME Desktop User Guide</ulink> for 
219   your platform.</para></caution>
220 </sect1>
221
222 <sect1 id="getting-started"> 
223   <title>Per començar</title>
224
225   <sect2 id="to-start"> 
226     <title>To Start Configuration Editor</title>
227     <para>You can start <application>Configuration Editor</application> in the following
228     ways:</para>
229     <variablelist>
230       <varlistentry>
231         <term>Menut <guimenu>Applications</guimenu></term>
232         <listitem>
233           <para>Choose <menuchoice><guisubmenu>System Tools</guisubmenu>
234           <guimenuitem>Configuration Editor</guimenuitem></menuchoice>.</para>
235           <note><para>Some distributions hide this menu. In this case, use the 
236           second method described below.</para></note>
237         </listitem>
238       </varlistentry>
239       <varlistentry>
240         <term>Linha de comanda</term>
241         <listitem>
242           <para>Execute the following command:
243           <command>gconf-editor</command></para>
244         </listitem>
245       </varlistentry>
246     </variablelist>
247   </sect2>
248
249   <sect2 id="when-you-start">
250     <title>When You Start Configuration Editor</title>
251     <para>When you start <application>Configuration Editor</application>, the following
252     window is displayed.</para>
253     <figure id="gconf_editor_window"> 
254       <title><application>Configuration Editor</application> Window</title>
255       <screenshot> 
256         <mediaobject> 
257           <imageobject>
258             <imagedata fileref="figures/gconf_editor_anno_window.png" format="PNG"/>
259           </imageobject>
260           <textobject>
261             <phrase>Shows GConf Editor window. Callouts: Tree pane,
262             Modification pane, Documentation pane.</phrase>
263           </textobject>
264         </mediaobject>
265       </screenshot>
266     </figure>
267     <para>The <application>Configuration Editor</application> window contains
268     the following panes:</para>
269     <variablelist>
270       <varlistentry>
271         <term>Tree pane</term>
272         <listitem><para>Enables you to navigate the hierarchy of keys in
273         <application>GConf</application>.  Use this pane to display the keys
274         that you want to modify in the modification pane. The tree pane is on
275         the left side of the window.</para></listitem>
276       </varlistentry>
277       <varlistentry>
278         <term>Modification pane</term>
279         <listitem>
280           <para>Displays the keys in the selected
281           <application>GConf</application> location in the tree pane. Use
282           this pane to select keys that you want to modify and to modify the
283           values of keys. The modification pane is in the upper part of the
284           right side of the window.</para>
285           <para>The icons beside the keys in the modification pane indicate
286           what type of value you can enter for the key. For example, the check
287           mark icon beside the
288           <literal>/system/http_proxy/use_http_proxy</literal> key indicates
289           that you can enter a Boolean value (true or false) for the key.  See
290           <xref linkend="icons"/> for more information on each icon.</para>
291         </listitem>
292       </varlistentry>
293       <varlistentry>
294         <term>Documentation pane</term>
295         <listitem><para>Displays documentation for the currently selected
296         key. Use this pane to read more information about the
297         <application>GConf</application> preference keys.</para>
298         </listitem>
299       </varlistentry>
300       <varlistentry>
301         <term>Results pane (not shown)</term>
302         <listitem><para>Enables you to view the results of a search or to
303         search through the list of your recently viewed key names. The rest
304         of the window will show the information for whichever key you have
305         selected in this pane. The results pane will appear on the bottom of
306         the window when you list the recent keys or perform a search.</para>
307         </listitem>
308       </varlistentry>
309     </variablelist>
310   </sect2>
311 </sect1>
312
313 <sect1 id="workwindows">
314   <title>Working with Windows</title>
315   <sect2 id="workwindows-opennew">
316     <title>Opening New Windows</title>
317     <para>There are a three types of window you can open in
318     <application>Configuration Editor</application>: <application>Settings</application>,
319     <application>Defaults</application>, and <application>Mandatory</application>.
320     What values <application>Configuration Editor</application> sets depends on what type
321     of window you have open.  You can open each type of window with the
322     appropriate item under the <guimenu>File</guimenu> menu.</para>
323     <note><para>Since the settings in <application>Defaults</application> and
324     <application>Mandatory</application> windows affect all users of the
325     computer, only a system administrator can use these types of windows.
326     To change your preferences, you should use the
327     <application>Settings</application> window.</para></note>
328     <variablelist>
329       <varlistentry>
330         <term><application>Paramètres</application></term>
331         <listitem><para>You can use the <application>Settings</application>
332         window to set your personal preferences.  Changes made in the
333         <application>Settings</application> window only affect your desktop.
334         You cannot change the settings that the system administrator has
335         made mandatory.</para></listitem>
336       </varlistentry>
337     </variablelist>
338     <variablelist>
339       <varlistentry>
340         <term><application>Valors per defaut</application></term>
341         <listitem><para>If you are a system administrator, you can use the
342         <application>Defaults</application> window to edit the default
343         settings for all users.  If a user does not set the value of a key
344         explicitly, the value will be taken from the default settings.  Users
345         can always override the default settings.</para></listitem>
346       </varlistentry>
347       <varlistentry>
348         <term><application>Mandatory</application></term>
349         <listitem><para>If you are a system administrator, you can use the
350         <application>Mandatory</application> window to edit the mandatory
351         settings for all users.  When a mandatory value is set for a key,
352         users are not able to change that value.  This can be used to lock
353         down certain options.</para></listitem>
354       </varlistentry>
355     </variablelist>
356   </sect2>
357
358   <sect2 id="workwindows-close">
359     <title>Closing and Quitting</title>
360     <para>You can close a <application>Configuration Editor</application> window by selecting
361     <menuchoice><guimenu>File</guimenu><guimenuitem>Close Window</guimenuitem>
362     </menuchoice> in that window.  To close all <application>Configuration Editor</application>
363     windows and quit the application completely, select <menuchoice>
364     <guimenu>File</guimenu><guimenuitem>Quit</guimenuitem></menuchoice> in any
365     <application>Configuration Editor</application> window.</para>
366   </sect2>
367 </sect1>
368
369 <sect1 id="workkeys">
370   <title>Working with Keys</title>
371   <para>Keys are a way of looking up a value.  Every preference stored in
372   <application>GConf</application> is assigned to a key.  Applications which
373   use <application>GConf</application> access the values of keys to determine
374   how to look and behave.  When you change something in the
375   <guilabel>Preferences</guilabel> of an application, you are changing the
376   value associated to a key in <application>GConf</application>.</para>
377
378   <sect2 id="copy-key">
379     <title>Copying a Key Name</title>
380     <para>To copy a key name to the clipboard, select the key name you want to
381     copy in the modification pane.  Choose <menuchoice><guimenu>Edit</guimenu>
382     <guimenuitem>Copy Key Name</guimenuitem></menuchoice>.  You can paste the
383     key name into any other application.</para>
384   </sect2>
385   <sect2 id="list-key">
386     <title>Viewing Recent Key Names</title>
387     <para>To view recent key names, choose <menuchoice><guimenu>Edit</guimenu>
388     <guimenuitem>List Recent Keys</guimenuitem></menuchoice>. This action will
389     open the results pane at the bottom of the current window. You can move
390     through the results list by scrolling up and down with the scroll bar or
391     the arrow keys. The information for the selected key or folder will appear
392     in the rest of the window.</para>
393     <para>Viewing recent keys is useful if you need to get back to a key you
394     just changed and don't remember where it is.</para>
395     <!-- REMARK -->
396     <remark>A screenshot may be in order.  In particular, The close, copy, and
397     clear buttons on the results pane should be explained.</remark>
398   </sect2>
399   <sect2 id="modify-key">
400     <title>Modifying the Value of a Key</title>
401     <para>The icons next to the key name show what kind of value that key can
402     take. See <xref linkend="icons"/> for more information on each icon.  To
403     modify the value of a key, perform the following steps:</para>
404     <procedure>
405       <step><para>Use the tree pane to display the key that you want to modify
406       in the modification pane.</para></step>
407       <step><para>Select the key to modify in the modification pane.</para></step>
408       <step>
409         <para>To change the value of an integer key or a string key, click
410         in the <guilabel>Value</guilabel> column of the key. Type the new value
411         for the key.  Alternatively, right-click on the key and select
412         <guimenuitem>Edit Key</guimenuitem> from the popup menu.</para>
413         <para>To change the value of a Boolean key, click in the
414         <guilabel>Value</guilabel> column of the key to select or
415         deselect the check box.  Alternatively, right-click on the
416         key and select <guimenuitem>Edit Key</guimenuitem> from the
417         popup menu.</para>
418         <para>To change the value of a list key, right-click on the key and
419         select <guimenuitem>Edit Key</guimenuitem> from the popup menu.  The
420         <application>Edit Key</application> dialog provides a list of the
421         values associated to that key.  You can use this dialog to edit each
422         particular value in the list, add or remove values from the list, and
423         move each value up or down in the list.</para>
424       </step>
425     </procedure>
426     <para>Your system administrator may have locked down certain keys by
427     providing mandatory values.  If the selected key has a mandatory value
428     set, you will not be able to edit the value.  The documentation pane
429     will display the label <guilabel>This key is not writable</guilabel>
430     if you are not allowed to edit the value of that key.</para>
431   </sect2>
432 </sect1>
433
434 <sect1 id="finding">
435   <title>Finding Keys Quickly</title>
436   <para>To locate keys quickly, <application>Configuration Editor</application> allows you
437   to search the key names in <application>GConf</application>.  Additionally,
438   you can use bookmarks to find directories of keys that you need to access
439   frequently.</para>
440
441   <sect2 id="using-bookmark">
442     <title>Using Bookmarks</title>
443     <para>To access a directory location in your bookmarks, choose the location
444     from the <guimenu>Bookmarks</guimenu> menu. You can add and remove directory
445     locations to your <guimenu>Bookmarks</guimenu> menu.</para>
446     <para>To add a bookmark, select the location that you want to bookmark in the
447     tree pane. Choose <menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>Add
448     Bookmark</guimenuitem></menuchoice>.</para>
449     <para>To delete a bookmark, perform the following steps:</para>
450     <procedure>
451       <step><para>Choose <menuchoice><guimenu>Bookmarks</guimenu>
452       <guimenuitem>Edit bookmarks</guimenuitem></menuchoice>.</para></step>
453       <step><para>Select the bookmark in the
454       <application>Edit bookmarks</application> dialog, then click
455       <guibutton>Delete</guibutton>.</para></step>
456       <step><para>Click <guibutton>Close</guibutton>.</para></step>
457     </procedure>
458   </sect2>
459   <sect2 id="search">
460     <title>Searching for Keys</title>
461     <para>To search for keys, perform the following steps:</para>
462     <procedure>
463       <step><para>Choose <menuchoice><guimenu>Edit</guimenu>
464       <guimenuitem>Find</guimenuitem></menuchoice>.</para></step>
465       <step><para>Enter the keyword you want to search for in the
466       <guilabel>Search for</guilabel> field. You can also select the
467       optional check boxes <guilabel>Search also in key names</guilabel>
468       and <guilabel>Search also in key values</guilabel>. If these check boxes
469       are not selected, the search will only be performed on folder names.
470       Selecting these boxes will expand the search parameters.</para></step>
471       <step><para>Click <guibutton>Find</guibutton>.</para></step>
472     </procedure>
473     <para>The results from the search will appear in the results pane.  To move
474     through the results list, first select that pane. Then you can move through
475     the results with the scroll bar or the arrow keys. The information for the
476     selected key or folder will appear in the rest of the window.</para>
477     <!-- REMARK -->
478     <remark>A screenshot may be in order.  In particular, The close, copy, and
479     clear buttons on the results pane should be explained.</remark>
480   </sect2> 
481 </sect1>
482
483 <sect1 id="defaults-mandatory">
484   <title>Default and Mandatory Settings</title>
485   <para>If you are a system administrator, you can set default and mandatory
486   settings in <application>GConf</application> which will affect all users.
487   Default settings are used when the user has not set a value explicitly, and
488   users can always override them.  Mandatory settings are always used for all
489   users, and they cannot override them.</para>
490   <para>You can use the <application>Defaults</application> and
491   <application>Mandatory</application> windows to edit and remove default
492   and mandatory settings.  The <application>Defaults</application> and
493   <application>Mandatory</application> windows will only show you those
494   settings which have already been made default or mandatory.  You cannot
495   use these windows to create new default and mandatory settings.  Instead,
496   you can set settings from the <application>Settings</application> window
497   to be default or mandatory.</para>
498   <para>To open a <application>Defaults</application> window, choose
499   <menuchoice><guimenu>File</guimenu><guimenuitem>New Defaults
500   Window</guimenuitem></menuchoice>.  To open a
501   <application>Mandatory</application> window, choose <menuchoice>
502   <guimenu>File</guimenu><guimenuitem>New Mandatory Window</guimenuitem>
503   </menuchoice>.</para>
504
505   <sect2 id="creating-defaults">
506     <title>Creating Default Settings</title>
507     <para>To create a default setting, perform the following steps:</para>
508     <procedure>
509       <step><para>In the <application>Settings</application> window, use the
510       tree pane to display the key that you want to set as default.</para></step>
511       <step><para>Right-click on the key and select <guimenuitem>Set as
512       Default</guimenuitem> from the popup menu.</para></step>
513     </procedure>
514   </sect2>
515   <sect2 id="creating-mandatory">
516     <title>Creating Mandatory Settings</title>
517     <para>To create a mandatory setting, perform the following steps:</para>
518     <procedure>
519       <step><para>In the <application>Settings</application> window, use the
520       tree pane to display the key that you want to set as
521       mandatory.</para></step>
522       <step><para>Right-click on the key and select <guimenuitem>Set as
523       Mandatory</guimenuitem> from the popup menu.</para></step>
524     </procedure>
525   </sect2>
526   <sect2 id="modifying-defaults-mandatory">
527     <title>Modifying and Removing Default and Mandatory Settings</title>
528     <para>You can use the <application>Defaults</application> and
529     <application>Mandatory</application> windows to modify and remove
530     default and mandatory settings.  To modify a default or mandatory
531     setting, use the appropriate window and modify the key as you would
532     for keys in the <application>Settings</application> window.  See
533     <xref linkend="modify-key"/> for more information on modifying
534     keys.</para>
535     <para>To remove a default or mandatory key, perform the following
536     steps:</para>
537     <procedure>
538       <step><para>In the appropriate window, use the tree pane to display
539       the key that you want to remove from the default or mandatory
540       settings.</para></step>
541       <step><para>Right-click on the key and select <guimenuitem>Unset
542       Key</guimenuitem> from the popup menu.</para></step>
543     </procedure>
544   </sect2>
545 </sect1>
546
547 <sect1 id="icons">
548   <title>Icons and Key Types</title>
549   <para>The icons beside the keys in the modification pane indicate what type
550   of value you can enter for the key.  The following list shows the possible
551   icons and what types of values they represent.</para>
552   <variablelist>
553     <varlistentry>
554       <term><inlinemediaobject><imageobject>
555         <imagedata fileref="figures/entry-bool.png" format="PNG"/>
556       </imageobject></inlinemediaobject> Boolean key</term>
557       <listitem><para>Can be either true or false.
558       <application>Configuration Editor</application> will provide a check box for
559       this type of key.</para></listitem>
560     </varlistentry>
561     <varlistentry>
562       <term><inlinemediaobject><imageobject>
563       <imagedata fileref="figures/entry-number.png" format="PNG"/>
564       </imageobject></inlinemediaobject> Number key</term>
565       <listitem><para>Can hold numbers.  These can be either integer or
566       floating point (fractional) numbers.</para></listitem>
567     </varlistentry>
568     <varlistentry>
569       <term><inlinemediaobject><imageobject>
570       <imagedata fileref="figures/entry-string.png" format="PNG"/>
571       </imageobject></inlinemediaobject> String key</term>
572       <listitem><para>Can hold any string of text.</para></listitem>
573     </varlistentry>
574     <varlistentry>
575       <term><inlinemediaobject><imageobject>
576       <imagedata fileref="figures/entry-schema.png" format="PNG"/>
577       </imageobject></inlinemediaobject> Schema key</term>
578       <listitem><para>Used for documenting other keys.  The documentation
579       for each key is provided by a seperate key, typically under the
580       <literal>/schemas</literal> directory.  Users and system administrators
581       usually will not need to work with schema keys directly.</para></listitem>
582     </varlistentry>
583     <varlistentry>
584       <term><inlinemediaobject><imageobject>
585       <imagedata fileref="figures/entry-list.png" format="PNG"/>
586       </imageobject></inlinemediaobject> List key</term>
587       <listitem><para>Lists of arbitrary length.  Each element of the list must
588       be of the same type, and one of the primitive types of boolean, number, or
589       string.</para></listitem>
590     </varlistentry>
591     <varlistentry>
592       <term><inlinemediaobject><imageobject>
593       <imagedata fileref="figures/entry-blank.png" format="PNG"/>
594       </imageobject></inlinemediaobject> Pair key</term>
595       <listitem><para>Can hold exactly two values.  The two values must
596       be one of the primitive types, but they do not have to be the same
597       type.  Currently, <application>Configuration Editor</application> is unable to edit
598       pair keys.</para></listitem>
599     </varlistentry>
600     <varlistentry>
601       <term><inlinemediaobject><imageobject>
602       <imagedata fileref="figures/entry-blank.png" format="PNG"/>
603       </imageobject></inlinemediaobject> Blank</term>
604       <listitem><para>Used when <application>Configuration Editor</application> does not
605       understand the type of key.  The blank icon is also currently used
606       for pair keys.</para></listitem>
607     </varlistentry>
608   </variablelist>
609 </sect1>
610 </article>