Current File : //usr/man/man1/gconftool-2.1

'\" te
.TH gconftool-2 1 "09 Nov 2007" "SunOS 5.11" "User Commands"
.SH "NAME"
gconftool-2 \- GNOME configuration tool
.SH "SYNOPSIS"
.PP
\fBgconftool-2\fR [-\fB-all-dirs\fR] [-\fB-all-entries\fR] [-\fB-apply-schema\fR] [-\fB-break-directory\fR] [-\fB-break-key\fR] [-\fB-car-type=\fR \fBint\fR | \fBbool\fR | \fBfloat\fR | \fBstring\fR] [-\fB-cdr-type=\fR \fBint\fR | \fBbool\fR | \fBfloat\fR | \fBstring\fR] [-\fB-config-source=\fIsource\fR\fR] [-\fB-dir-exists=\fIstring\fR\fR] [-\fB-direct\fR] [-\fB-dump\fR] [-\fB-get\fR] [-\fB-get-default-source\fR] [-\fB-get-list-size\fR] [-\fB-get-list-element\fR] [-\fB-get-schema-name\fR] [-\fB-get-type\fR] [-\fB-ignore-schema-defaults\fR] [-\fB-install-schema-file=\fIfile\fR\fR] [-\fB-list-type=\fR \fBint\fR | \fBbool\fR | \fBfloat\fR | \fBstring\fR] [-\fB-load=\fIfile\fR\fR] [-\fB-makefile-install-rule\fR] [-\fB-makefile-uninstall-rule\fR] [-\fB-owner=\fIowner\fR\fR] [-\fB-ping\fR] [-\fB-recursive-unset\fR] [-\fB-search-key\fR] [-\fB-set\fR] [-\fB-set-schema\fR] [-\fB-short-desc=\fIdescription\fR\fR] [-\fB-long-desc=\fIdescription\fR\fR] [-\fB-short-docs\fR] [-\fB-long-docs\fR] [-\fB-shutdown\fR] [-\fB-spawn\fR] [-\fB-type=\fR \fBint\fR | \fBbool\fR | \fBfloat\fR | \fBstring\fR | \fBlist\fR | \fBpair\fR] [-\fB-unapply-schema\fR] [-\fB-unload\fR] [-\fB-unset\fR] [-\fB-help\fR] \fB\fIkey\fR\fR \fB\fIvalue\fR\fR
.SH "DESCRIPTION"
.PP
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\&. \fBgconftool-2\fR
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 (\fBgconfd-2\fR)\&.   These keys
are cached in memory, and saved to disk in XML format when appropriate\&.
.SH "OPTIONS"
.PP
The following options are supported:
.sp
.ne 2
.mk
\fB-\fB-all-dirs\fR\fR
.sp .6
.in +4
Lists all subdirectories in a directory that you specify\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBa\fR, -\fB-all-entries\fR\fR
.sp .6
.in +4
Displays the value of all keys in a directory that you specify\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-apply-schema\fR\fR
.sp .6
.in +4
Apply the specified schema to the specified key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-break-directory\fR\fR
.sp .6
.in +4
Stress-test an application by setting and unsetting several keys within the
directories\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-break-key\fR\fR
.sp .6
.in +4
Stress-test an application by setting and unsetting several preference-key
values of different types\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-car-type=\fIint|bool|float|string\fR\fR\fR
.sp .6
.in +4
Specifies the type of the car pair value being set, or the type of the value
described by a schema\&.  Unique abbreviations are allowed\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-cdr-type=\fIint|bool|float|string\fR\fR\fR
.sp .6
.in +4
Specifies the type of the cdr pair value being set, or the type of the value
described by a schema\&.  Unique abbreviations are allowed\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-config-source=\fIsource\fR\fR\fR
.sp .6
.in +4
Use this option with the -\fB-direct\fR option to specify a
configuration \fIsource\fR to use\&. If you do not specify a
configuration source with this option, the command runs on all configuration
sources in the path file\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-dir-exists=\fIstring\fR\fR\fR
.sp .6
.in +4
Returns 0 if the directory exists, returns 2 if the directory does not
exist\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-direct\fR\fR
.sp .6
.in +4
Use this option with the -\fB-config-source\fR option to access a
configuration source directly\&. When you use this option, GConf bypasses the
server\&. Ensure that the GConf daemon, \fBgconfd-2\fR, is not
running before you use this option\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-dump\fR\fR
.sp .6
.in +4
Dump to standard output an XML description of all entries under a 
directory, recursively\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBg\fR, -\fB-get\fR\fR
.sp .6
.in +4
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, unless you specify the -\fB-ignore-schema-defaults\fR
option\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-get-default-source\fR\fR
.sp .6
.in +4
Get the name of the default source\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-get-list-element\fR\fR
.sp .6
.in +4
Get a specific element from a list key, numerically indexed\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-get-list-size\fR\fR
.sp .6
.in +4
Get the number of elements in a list key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-get-schema-name\fR\fR
.sp .6
.in +4
Get the name of the schema applied to this key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBT\fR, -\fB-get-type\fR\fR
.sp .6
.in +4
Print the data type of a key to standard output\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-ignore-schema-defaults\fR\fR
.sp .6
.in +4
Ignore schema defaults when reading values\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB?\fR, -\fB-help\fR\fR
.sp .6
.in +4
Displays a help message about the \fBgconftool-2\fR command, and the
options that you can use with the \fBgconftool-2\fR command\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-install-schema-file=\fIfile\fR\fR\fR
.sp .6
.in +4
Specifies a schema \fIfile\fR to be installed\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-list-type=\fIint|bool|float|string\fR\fR\fR
.sp .6
.in +4
Specifies the type of the list value being set, or the type of the value
described by a schema\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-long-desc=\fIdescription\fR\fR\fR
.sp .6
.in +4
Use this option with the -\fB-set-schema\fR option to specify a long
description for a schema key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-long-docs\fR\fR
.sp .6
.in +4
Get the long doc string for a key
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-load=\fIfile\fR\fR\fR
.sp .6
.in +4
Load from the specified \fIfile\fR an XML description of
values and set them relative to a directory\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-makefile-install-rule\fR\fR
.sp .6
.in +4
Properly installs schema files on the command line into the database\&.
GCONF_CONFIG_SORUCE environment variable should be set to a non-default
config source or set to the empty string to use the default\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-makefile-uninstall-rule\fR\fR
.sp .6
.in +4
Properly uninstalls schema files on the command line from the database
GCONF_CONFIG_SOURCE environment variable should be set to a non-default
config source or set to the empty string to use the default\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-owner=\fIowner\fR\fR\fR
.sp .6
.in +4
Use this option with the -\fB-set-schema\fR option to specify an
\fIowner\fR for a schema key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBp\fR, -\fB-ping\fR\fR
.sp .6
.in +4
Returns 0 if \fBgconfd-2\fR is running, returns 2 if
\fBgconfd-2\fR is not running\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBR\fR, -\fB-recursive-list\fR\fR
.sp .6
.in +4
Displays the value of all preference keys in all subdirectories in a directory
that you specify\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-recursive-unset\fR\fR
.sp .6
.in +4
Recursively unset all keys at or below the key/directory names on the command
line\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBS\fR, -\fB-search-key\fR\fR
.sp .6
.in +4
Search for a key, recursively\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBs\fR, -\fB-set\fR\fR
.sp .6
.in +4
Sets the value of a preference key, and writes the value to
the user configuration source\&.  Use the -\fB-type\fR option with the
-\fB-set\fR option to specify the data type of the value that you
want to set\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-set-schema\fR\fR
.sp .6
.in +4
Sets the value of an attribute in a schema key, and writes the value to the
default configuration source\&.  Use with -\fB-short-desc\fR, 
-\fB-long-desc\fR, -\fB-owner\fR, and
-\fB-type\fR\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-short-desc=\fIdescription\fR\fR\fR
.sp .6
.in +4
Use this option with the -\fB-set-schema\fR option to specify a short
description for a schema key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-short-docs\fR\fR
.sp .6
.in +4
Get the short doc string for a key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-shutdown\fR\fR
.sp .6
.in +4
Terminates the GConf daemon\&. Do not use this option unless absolutely
necessary\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-spawn\fR\fR
.sp .6
.in +4
Launch the config server (\fBgconfd-2\fR)\&. This normally happens
automatically when needed\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBt\fR, -\fB-type=\fIdata_type\fR\fR\fR
.sp .6
.in +4
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 \fBbool\fR,
\fBfloat\fR, \fBint\fR, \fBlist\fR,
\fBpair\fR, and \fBstring\fR\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-unapply-schema-name\fR\fR
.sp .6
.in +4
Remove any schemas that are currently applied to the specified key\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-unload\fR\fR
.sp .6
.in +4
Unoload a set of values described in an XML file\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBu\fR, -\fB-unset\fR\fR
.sp .6
.in +4
Resets the value of a preference key from the user setting to the setting in
the default configuration source\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fB-help\fR\fR
.sp .6
.in +4
Displays a brief help message about the \fBgconftool-2\fR command, and
the options that you can use with the \fBgconftool-2\fR command\&.
.sp
.sp 1
.in -4
.sp
.ne 2
.mk
\fB-\fBv\fR, -\fB-version\fR\fR
.sp .6
.in +4
Display the version number of the \fBgconftool-2\fR command\&.
.sp
.sp 1
.in -4
.SH "OPERANDS"
.PP
The following operands are supported:
.sp
.ne 2
.mk
\fB\fB\fIkey\fR\fR\fR
.in +24n
.rt
Configuration key or directory\&. 
.sp
.sp 1
.in -24n
.sp
.ne 2
.mk
\fB\fB\fIvalue\fR\fR\fR
.in +24n
.rt
When setting configuration options, the value to set\&.
.sp
.sp 1
.in -24n
.SH "ENVIRONMENT VARIABLES"
.PP
See \fBenviron\fR(5) for descriptions of environment variables\&.
.sp
.ne 2
.mk
\fB\fBGCONF_CONFIG_SOURCES\fR\fR
.in +24n
.rt
The directory of the GConf database\&.
.sp
.sp 1
.in -24n
.SH "EXAMPLES"
.PP
\fBExample 1: Turning off the tooltips for gnome-panel\fR
.PP
.PP
.nf
example% \fBgconftool-2 -s /apps/panel/global/tooltips_enabled -t bool false\fR
.fi
.PP
\fBExample 2: Identifying the values of the http proxy host
and port \fR
.PP
.PP
.nf
example% \fBgconftool-2 --get /system/http_proxy/host /system/http_proxy/port\fR
.fi
.SH "EXIT STATUS"
.PP
The following exit values are returned:
.sp
.ne 2
.mk
\fB\fB0\fR\fR
.in +9n
.rt
Application exited successfully
.sp
.sp 1
.in -9n
.sp
.ne 2
.mk
\fB\fB>0\fR\fR
.in +9n
.rt
Application
exited with failure
.sp
.sp 1
.in -9n
.SH "FILES"
.PP
The following files are used by this application:
.sp
.ne 2
.mk
\fB\fBgconftool-2\fR \fR
.in +32n
.rt
The command-line executable for the application\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB\fB/etc/gconf/schemas\fR \fR
.in +32n
.rt
Directory containing the schema definition files\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB\fB/etc/gconf/\fIversion\fR/path\fR \fR
.in +32n
.rt
The location of the GConf path file\&.
.sp
.sp 1
.in -32n
.SH "ATTRIBUTES"
.PP
See \fBattributes\fR(5)
for descriptions of the following attributes:
.sp
.TS
tab() allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPEATTRIBUTE VALUE
Availabilitygnome/config/gconf
Interface stabilityVolatile
.TE
.sp
.SH "SEE ALSO"
.PP
Latest version of the \fIGNOME Desktop System Administration Guide\fR for your platform\&.
.PP
\fBgconf-editor\fR(1),
\fBlibgconf-2\fR(3),
\fBattributes\fR(5),
\fBenviron\fR(5)
.SH "NOTES"
.PP
Some distributions of GNOME also provide a graphical \fBgconf\fR tool called \fBgconf-editor\fR\&. However, \fBgconftool-2\fR
provides more functionality than \fBgconf-editor\fR\&.
.PP
Written by Ghee Teo, updated by Brian Cameron Sun Microsystems Inc\&.,
2003, 2006, 2007\&.
...\" created by instant / solbook-to-man, Thu 19 Jul 2012, 22:33
...\" LSARC 2002/146 GNOME 2.0 Configuration - GConf