gconftool-2(1) User Commands gconftool-2(1)NAMEgconftool-2 - GNOME configuration tool
SYNOPSISgconftool-2 [--all-dirs] [--all-entries] [--apply-schema] [--break-
directory] [--break-key] [--car-type= int | bool | float | string]
[--cdr-type= int | bool | float | string] [--config-source=source]
[--dir-exists=string] [--direct] [--dump] [--get] [--get-default-
source] [--get-list-size] [--get-list-element] [--get-schema-name]
[--get-type] [--ignore-schema-defaults] [--install-schema-file=file]
[--list-type= int | bool | float | string] [--load=file] [--makefile-
install-rule] [--makefile-uninstall-rule] [--owner=owner] [--ping]
[--recursive-unset] [--search-key] [--set] [--set-schema] [--short-
desc=description] [--long-desc=description] [--short-docs] [--long-
docs] [--shutdown] [--spawn] [--type= int | bool | float | string |
list | pair] [--unapply-schema] [--unload] [--unset] [--help] key value
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.
-a, --all-entries
Displays the value of all keys in a directory that you specify.
--apply-schema
Apply the specified schema to the specified key.
--break-directory
Stress-test an application by setting and unsetting several keys
within the directories.
--break-key
Stress-test an application by setting and unsetting several prefer‐
ence-key values of different types.
--car-type=int|bool|float|string
Specifies the type of the car pair value being set, or the type of
the value described by a schema. Unique abbreviations are allowed.
--cdr-type=int|bool|float|string
Specifies the type of the cdr pair value being set, or the type of
the value described by a schema. Unique abbreviations are allowed.
--config-source=source
Use this 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=string
Returns 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 config‐
uration 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.
--dump
Dump to standard output an XML description of all entries under a
directory, recursively.
-g, --get
Displays the value of a preference key that you specify. Also dis‐
plays the values of the elements in the schema object for a schema
key that you specify, unless you specify the --ignore-schema-
defaults option.
--get-default-source
Get the name of the default source.
--get-list-element
Get a specific element from a list key, numerically indexed.
--get-list-size
Get the number of elements in a list key.
--get-schema-name
Get the name of the schema applied to this key.
-T, --get-type
Print the data type of a key to standard output.
--ignore-schema-defaults
Ignore schema defaults when reading values.
-?, --help
Displays a help message about the gconftool-2 command, and the
options that you can use with the gconftool-2 command.
--install-schema-file=file
Specifies a schema file to be installed.
--list-type=int|bool|float|string
Specifies the type of the list value being set, or the type of the
value described by a schema.
--long-desc=description
Use this 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
--load=file
Load from the specified file an XML description of values and set
them relative to a directory.
--makefile-install-rule
Properly installs schema files on the command line into the data‐
base. GCONF_CONFIG_SORUCE environment variable should be set to a
non-default config source or set to the empty string to use the
default.
--makefile-uninstall-rule
Properly uninstalls schema files on the command line from the data‐
base GCONF_CONFIG_SOURCE environment variable should be set to a
non-default config source or set to the empty string to use the
default.
--owner=owner
Use this option with the --set-schema option to specify an owner
for a schema key.
-p, --ping
Returns 0 if gconfd-2 is running, returns 2 if gconfd-2 is not run‐
ning.
-R, --recursive-list
Displays the value of all preference keys in all subdirectories in
a directory that you specify.
--recursive-unset
Recursively unset all keys at or below the key/directory names on
the command line.
-S, --search-key
Search for a key, recursively.
-s, --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.
--set-schema
Sets the value of an attribute in a schema key, and writes the
value to the default configuration source. Use with --short-desc,
--long-desc, --owner, and --type.
--short-desc=description
Use this 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 abso‐
lutely necessary.
--spawn
Launch the config server (gconfd-2). This normally happens automat‐
ically when needed.
-t, --type=data_type
Use 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-schema-name
Remove any schemas that are currently applied to the specified key.
--unload
Unoload a set of values described in an XML file.
-u, --unset
Resets the value of a preference key from the user setting to the
setting in the default configuration source.
--help
Displays a brief help message about the gconftool-2 command, and
the options that you can use with the gconftool-2 command.
-v, --version
Display the version number of the gconftool-2 command.
OPERANDS
The following operands are supported:
key Configuration key or directory.
value When setting configuration options, the value
to set.
ENVIRONMENT VARIABLES
See environ(5) for descriptions of environment variables.
GCONF_CONFIG_SOURCES The directory of the GConf database.
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 defini‐
tion files.
/etc/gconf/version/path The location of the GConf path file.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────┤
│Availability │gnome/config/gconf │
├─────────────────────────────┼─────────────────────────────┤
│Interface stability │Volatile │
└─────────────────────────────┴─────────────────────────────┘
SEE ALSO
Latest version of the GNOME Desktop System Administration Guide for
your platform.
gconf-editor(1), libgconf-2(3), attributes(5), environ(5)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, updated by Brian Cameron Sun Microsystems Inc.,
2003, 2006, 2007.
SunOS 5.11 09 Nov 2007 gconftool-2(1)
