~ubuntu-branches/ubuntu/quantal/gconf/quantal

« back to all changes in this revision

Viewing changes to doc/gconftool-2.1

  • Committer: Bazaar Package Importer
  • Author(s): Josselin Mouette
  • Date: 2007-11-01 18:47:26 UTC
  • mto: (7.1.1 lenny) (1.2.1) (76.1.1 oneiric-proposed)
  • mto: This revision was merged to the branch mainline in revision 7.
  • Revision ID: james.westby@ubuntu.com-20071101184726-e3e4cxfcp41tz6ui
Tags: upstream-2.20.1
ImportĀ upstreamĀ versionĀ 2.20.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH GCONFTOOL-2 "1" "Feburary 2006" "gconftool-2 2.2.1" "User Commands"
 
2
.SH NAME
 
3
gconftool-2 \- GNOME configuration tool
 
4
.SH SYNOPSIS
 
5
.B gconftool-2
 
6
[\-?] [\-?|\-\-help] [\-\-usage] [\-s|\-\-set] [\-g|\-\-get]
 
7
[\-\-set\-schema] [\-u|\-\-unset] [\-\-recursive\-unset] [\-a|\-\-all\-entries]
 
8
[\-\-all\-dirs] [\-\-dump] [\-\-load=STRING] [\-R|\-\-recursive\-list]
 
9
[\-\-dir\-exists=STRING] [\-\-shutdown] [\-p|\-\-ping] [\-\-spawn]
 
10
[\-t|\-\-type int|bool|float|string|list|pair] [\-T|\-\-get\-type]
 
11
[\-\-get\-list\-size] [\-\-get\-list\-element]
 
12
[\-\-list\-type=int|bool|float|string] [\-\-car\-type=int|bool|float|string]
 
13
[\-\-cdr\-type=int|bool|float|string] [\-\-short\-desc=DESCRIPTION]
 
14
[\-\-long\-desc=DESCRIPTION] [\-\-owner=OWNER]
 
15
[\-\-install\-schema\-file=FILENAME] [\-\-config\-source=SOURCE] [\-\-direct]
 
16
[\-\-makefile\-install\-rule] [\-\-makefile\-uninstall\-rule] [\-\-break\-key]
 
17
[\-\-break\-directory] [\-\-short\-docs] [\-\-long\-docs] [\-\-get\-schema\-name]
 
18
[\-\-apply\-schema] [\-\-unapply\-schema] [\-\-get\-default\-source]
 
19
[\-v|\-\-version]
 
20
.SH DESCRIPTION
 
21
Each preference in the GConf repository is expressed as a
 
22
key\-value pair. A GConf preference key is an element in the
 
23
GConf repository that corresponds to an application prefer\-ence.
 
24
Preference keys typically have simple values such as strings,
 
25
integers, or lists of strings and integers. The
 
26
default key\-value pairs are installed on the system, and are
 
27
known as schemas. gconftool\-2 is the command\-line interface
 
28
tool that enables you to set the values of keys, display the
 
29
values of keys, and install schemas from schema definition
 
30
files when you install an application. The GConf preference
 
31
keys are stored and managed by the GConf daemon (gconfd\-2).
 
32
These keys are cached in memory, and saved to disk in XML
 
33
format when appropriate.
 
34
.SH OPTIONS
 
35
.TP
 
36
\fB\-s\fR, \fB\-\-set\fR
 
37
Set a key to a value and sync. Use with \fB\-\-type\fR.
 
38
.TP
 
39
\fB\-g\fR, \fB\-\-get\fR
 
40
Print the value of a key to standard output.
 
41
.TP
 
42
\fB\-u\fR, \fB\-\-unset\fR
 
43
Unset the keys on the command line.
 
44
.TP
 
45
\fB\-\-recursive\-unset\fR
 
46
Recursively unset all keys at or below the key/directory names on the command line.
 
47
.TP
 
48
\fB\-a\fR, \fB\-\-all\-entries\fR
 
49
Print all key/value pairs in a directory.
 
50
.TP
 
51
\fB\-\-all\-dirs\fR
 
52
Print all subdirectories in a directory.
 
53
.TP
 
54
\fB\-R\fR, \fB\-\-recursive\-list\fR
 
55
Print all subdirectories and entries under a dir, recursively.
 
56
.TP
 
57
\fB\-\-dir\-exists\fR=\fISTRING\fR
 
58
Return 0 if the directory exists, 2 if it does not.
 
59
.TP
 
60
\fB\-t\fR, \fB\-\-type\fR=\fIint\fR|bool|float|string|list|pair
 
61
Specify the type of the value being set, or the type of the value a schema describes. Unique abbreviations are allowed.
 
62
.TP
 
63
\fB\-\-list\-type\fR=\fIint\fR|bool|float|string
 
64
Specify the type of the list value being set, or the type of the value a schema describes. Unique abbreviations are allowed.
 
65
.TP
 
66
\fB\-\-car\-type\fR=\fIint\fR|bool|float|string
 
67
Specify the type of the car pair value being set, or the type of the value a schema describes. Unique abbreviations are allowed.
 
68
.TP
 
69
\fB\-\-cdr\-type\fR=\fIint\fR|bool|float|string
 
70
Specify the type of the cdr pair value being set, or the type of the value a schema describes. Unique abbreviations are allowed.
 
71
.TP
 
72
\fB\-\-short\-desc\fR=\fIDESCRIPTION\fR
 
73
Specify a short half-line description to go in a schema.
 
74
.TP
 
75
\fB\-\-long\-desc\fR=\fIDESCRIPTION\fR
 
76
Specify a several-line description to go in a schema.
 
77
.TP
 
78
\fB\-\-owner\fR=\fIOWNER\fR
 
79
Specify the owner of a schema.
 
80
.TP
 
81
\fB\-\-install\-schema\-file\fR=\fIFILENAME\fR
 
82
Specify a schema file to be installed
 
83
.TP
 
84
\fB\-\-config\-source\fR=\fISOURCE\fR
 
85
Specify a configuration source to use rather than the default path
 
86
.TP
 
87
\fB\-\-direct\fR
 
88
Access the config database directly, bypassing server. Requires that gconfd is not running.
 
89
.TP
 
90
\fB\-\-set\-schema\fR
 
91
Set a schema and sync. Use with \fB\-\-short\-desc\fR, \fB\-\-long\-desc\fR, \fB\-\-owner\fR, and \fB\-\-type\fR.
 
92
.TP
 
93
\fB\-\-makefile\-install\-rule\fR
 
94
Properly installs schema files on the command line into 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.
 
95
.TP
 
96
\fB\-\-break\-key\fR
 
97
Torture-test an application by setting and unsetting a bunch of values of different types for keys on the command line.
 
98
.TP
 
99
\fB\-\-break\-directory\fR
 
100
Torture-test an application by setting and unsetting a bunch of keys inside the directories on the command line.
 
101
.TP
 
102
\fB\-\-short\-docs\fR
 
103
Get the short doc string for a key
 
104
.TP
 
105
\fB\-\-long\-docs\fR
 
106
Get the long doc string for a key
 
107
.TP
 
108
\fB\-\-get\-schema\-name\fR
 
109
Get the name of the schema applied to this key
 
110
.TP
 
111
\fB\-\-apply\-schema\fR
 
112
Specify the schema name followed by the key to apply the schema name to
 
113
.TP
 
114
\fB\-\-unapply\-schema\fR
 
115
Remove any schema name applied to the given keys
 
116
.TP
 
117
\fB\-\-get\-default\-source\fR
 
118
Get the name of the default source.
 
119
.TP
 
120
\fB\-\-shutdown\fR
 
121
Shut down gconfd. \fBDon't use this option without good reason.\fP
 
122
.TP
 
123
\fB\-p\fR, \fB\-\-ping\fR
 
124
Return 0 if gconfd is running, 2 if not.
 
125
.TP
 
126
\fB\-\-spawn\fR
 
127
Launch the config server (gconfd). (Normally happens automatically when needed.)
 
128
.TP
 
129
\fB\-v\fR, \fB\-\-version\fR
 
130
Print version
 
131
.PP
 
132
Help options
 
133
.TP
 
134
-?, \fB\-\-help\fR
 
135
Show the help message.
 
136
.TP
 
137
\fB\-\-usage\fR
 
138
Display brief usage message.
 
139
.SH EXAMPLES
 
140
Display the path to the current desktop wallpaper.
 
141
.IP
 
142
gconftool-2 \-\-get /desktop/gnome/background/picture_filename
 
143
.PP
 
144
Change the widget font to "Serif 12"
 
145
.IP
 
146
gconftool-2 \-\-type string \-\-set /desktop/gnome/interface/font_name "Serif 12"
 
147
.PP
 
148
.SH AUTHOR
 
149
\fBGConf\fP was written by Havoc Pennington <hp@redhat.com>.
 
150
.SH "SEE ALSO"
 
151
The GConf web site, \fIhttp://www.gnome.org/projects/gconf/\fI.