gconftool-2(1) User Commands gconftool-2(1)
NAME
gconftool-2 - GNOME configuration tool
SYNOPSIS
gconftool-2 [-?sguaRpv] [--usage] [--set-schema] [--recursive-unset] [--all-dirs] [--dir-exists=string] [--shutdown] [--spawn] [--type= int
| bool | float | string | list | pair] [--list-type= int | bool | float | string] [--car-type= int | bool | float | string] [--cdr-type=
int | bool | float | string] [--short-desc=description] [--long-desc=description] [--owner=owner] [--install-schema-file=filename] [--con-
fig-source=source] [--direct] [--makefile-install-rule] [--break-key] [--break-directory] [--short-docs] [--long-docs] [--get-schema-name]
[--apply-schema] [--unapply-schema] [--get-default-source]
DESCRIPTION
Each preference in the GConf repository is expressed as a key-value pair. A GConf preference key is an element in the GConf repository that
corresponds to an application preference. Preference keys typically have simple values such as strings, integers, or lists of strings and
integers. The default key-value pairs are installed on the system, and are known as schemas. gconftool-2 is the command-line interface tool
that enables you to set the values of keys, display the values of keys, and install schemas from schema definition files when you install
an application. The GConf preference keys are stored and managed by the GConf daemon (gconfd-2). These keys are cached in memory, and
saved to disk in XML format when appropriate.
OPTIONS
The following options are supported:
--all-dirs Lists all subdirectories in a directory that you specify.
--all-entries Displays the value of all keys in a directory that you specify. You can also use -a to specify this option.
--apply-schema-nApply the specified schema to the specified key.
--break-directorStress-test an application by setting and unsetting several keys within the directories.
--break-key Stress-test an application by setting and unsetting several preference-key values of different types.
--car-type=int|bSpecifies|theitype of the car pair value being set, or the type of the value described by a schema.
--cdr-type=int|bSpecifies|theitype of the cdr pair value being set, or the type of the value described by a schema.
--config-source=Userthis option with the --direct option to specify a configuration source to use. If you do not specify a configuration
source with this option, the command runs on all configuration sources in the path file.
--dir-exists=strReturns 0 if the directory exists, returns 2 if the directory does not exist.
--direct Use this option with the --config-source option to access a configuration source directly. When you use this option, GConf
bypasses the server. Ensure that the GConf daemon, gconfd-2, is not running before you use this option.
--get Displays the value of a preference key that you specify. Also displays the values of the elements in the schema object for
a schema key that you specify. You can also use -g to specify this option.
--get-schema-namGet the name of the schema applied to this key.
--help Displays a help message about the gconftool-2 command, and the options that you can use with the gconftool-2 command. You
can also use -? to specify this option.
--install-schemaSpecifieseaaschema file to be installed
--list-type=int|Specifiestthertype of the list value being set, or the type of the value described by a schema.
--long-desc=descUsetthis option with the --set-schema option to specify a long description for a schema key.
--long-docs Get the long doc string for a key
--makefile-instaInstalls schema definition files to applications.
--owner=owner Use this option with the --set-schema option to specify an owner for a schema key.
--ping Returns 0 if gconfd-2 is running, returns 2 if gconfd-2 is not running. You can also use -p to specify this option.
--recursive-listDisplays the value of all preference keys in all subdirectories in a directory that you specify. You can also use -R to
specify this option.
--recursive-unseResets the values of all preference keys, in all subdirectories in a directory, from the user setting to the setting in the
default configuration source.
--set Sets the value of a preference key, and writes the value to the user configuration source. Use the --type option with the
--set option to specify the data type of the value that you want to set. You can also use -s to specify this option.
--set-schema Sets the value of an attribute in a schema key, and writes the value to the default configuration source..
--short-desc=desUsepthis option with the --set-schema option to specify a short description for a schema key.
--short-docs Get the short doc string for a key
--shutdown Terminates the GConf daemon. Do not use this option unless absolutely necessary.
--spawn Launch the config server (gconfd-2). This normally happens automatically when needed.
--type=data_typeUse this option to specify the data type when you set a value of a preference key. You can also use this option when you
set the value of an attribute in a schema key. Valid data types are bool, float, int, list, pair, and string.
--unapply-schemaRemove any schemas that are currently applied to the specified key.
--unset Resets the value of a preference key from the user setting to the setting in the default configuration source. You can also
use -u to specify this option.
--usage Displays a brief help message about the gconftool-2 command, and the options that you can use with the gconftool-2 command.
--version Display the version number of the gconftool-2 command. You can also use -v to specify this option.
EXAMPLES
Example 1: Turning off the tooltips for gnome-panel
example% gconftool-2 -s /apps/panel/global/tooltips_enabled -t bool false
Example 2: Identifying the values of the http proxy host and port
example% gconftool-2 --get /system/http_proxy/host /system/http_proxy/port
EXIT STATUS
The following exit values are returned:
0 Application exited successfully
>0 Application exited with failure
FILES
The following files are used by this application:
gconftool-2 The command-line executable for the application.
/etc/gconf/schemas Directory containing the schema definition files.
/etc/gconf/version_numbeThealocation of the GConf path file.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Availability |SUNWgnome-config |
+-----------------------------+-----------------------------+
|Interface stability |External |
+-----------------------------+-----------------------------+
SEE ALSO
libgconf-2(3)
Latest version of the GNOME Desktop System Administration Guide for your platform.
NOTES
Some distributions of GNOME also provide a graphical gconf tool called gconf-editor. However, gconftool-2 provides more functionality than
gconf-editor.
Written by Ghee Teo, Sun Microsystems Inc., 2003.
SunOS 5.10 2 Oct 2003 gconftool-2(1)