1 <refentry id="gsettings-tool" lang="en">
4 <title>gsettings</title>
5 <productname>GIO</productname>
8 <contrib>Developer</contrib>
9 <firstname>Ryan</firstname>
10 <surname>Lortie</surname>
16 <refentrytitle>gsettings</refentrytitle>
17 <manvolnum>1</manvolnum>
18 <refmiscinfo class="manual">User Commands</refmiscinfo>
22 <refname>gsettings</refname>
23 <refpurpose>GSettings configuration tool</refpurpose>
28 <command>gsettings</command>
29 <arg choice="plain">get</arg>
30 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
31 <arg choice="plain"><replaceable>KEY</replaceable></arg>
34 <command>gsettings</command>
35 <arg choice="plain">monitor</arg>
36 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
37 <arg choice="opt"><replaceable>KEY</replaceable></arg>
40 <command>gsettings</command>
41 <arg choice="plain">writable</arg>
42 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
43 <arg choice="plain"><replaceable>KEY</replaceable></arg>
46 <command>gsettings</command>
47 <arg choice="plain">range</arg>
48 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
49 <arg choice="plain"><replaceable>KEY</replaceable></arg>
52 <command>gsettings</command>
53 <arg choice="plain">set</arg>
54 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
55 <arg choice="plain"><replaceable>KEY</replaceable></arg>
56 <arg choice="plain"><replaceable>VALUE</replaceable></arg>
59 <command>gsettings</command>
60 <arg choice="plain">reset</arg>
61 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
62 <arg choice="plain"><replaceable>KEY</replaceable></arg>
65 <command>gsettings</command>
66 <arg choice="plain">reset-recursively</arg>
67 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
70 <command>gsettings</command>
71 <arg choice="plain">list-schemas</arg>
74 <command>gsettings</command>
75 <arg choice="plain">list-relocatable-schemas</arg>
78 <command>gsettings</command>
79 <arg choice="plain">list-keys</arg>
80 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
83 <command>gsettings</command>
84 <arg choice="plain">list-children</arg>
85 <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
88 <command>gsettings</command>
89 <arg choice="plain">list-recursively</arg>
90 <arg choice="opt"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
93 <command>gsettings</command>
94 <arg choice="plain">help</arg>
95 <arg choice="opt"><replaceable>COMMAND</replaceable></arg>
99 <refsect1><title>Description</title>
100 <para><command>gsettings</command> offers a simple commandline
101 interface to <link linkend="GSettings"><type>GSettings</type></link>.
102 It lets you get, set or monitor an individual key for changes.
105 The <replaceable>SCHEMA</replaceable> and <replaceable>KEY</replaceable>
106 arguments are required for most commands to specify the schema id and the
107 name of the key to operate on. The schema id may optionally have a
108 :<replaceable>PATH</replaceable> suffix. Specifying the path is only needed
109 if the schema does not have a fixed path.
112 When setting a key, you also need specify a <replaceable>VALUE</replaceable>
113 The format for the value is that of a serialized
114 <link linkend="GVariant"><type>GVariant</type></link>,
116 must include explicit quotes: "'foo'". This format is also used when printing
121 <refsect1><title>Commands</title>
125 <term><option>get</option></term>
127 Gets the value of <replaceable>KEY</replaceable>.
128 The value is printed out as a serialised
129 <link linkend="GVariant"><type>GVariant</type></link>.
134 <term><option>monitor</option></term>
136 Monitors <replaceable>KEY</replaceable> for changes and prints the changed
137 values. If no <replaceable>KEY</replaceable> is specified, all keys in the
138 schema are monitored. Monitoring will continue until the process is terminated.
143 <term><option>writable</option></term>
145 Finds out whether <replaceable>KEY</replaceable> is writable.
150 <term><option>range</option></term>
152 Queries the range of valid values for <replaceable>KEY</replaceable>.
157 <term><option>set</option></term>
159 Sets the value of <replaceable>KEY</replaceable> to
160 <replaceable>VALUE</replaceable>. The value is specified as a serialised
161 <link linkend="GVariant"><type>GVariant</type></link>.
166 <term><option>reset</option></term>
168 Resets <replaceable>KEY</replaceable> to its default value.
173 <term><option>reset-recursively</option></term>
175 Reset all keys under the given <replaceable>SCHEMA</replaceable>.
180 <term><option>list-schemas</option></term>
182 Lists the installed, non-relocatable schemas.
183 See <option>list-relocatable-schemas</option> if you are interested in
189 <term><option>list-relocatable-schemas</option></term>
191 Lists the installed, relocatable schemas.
192 See <option>list-schemas</option> if you are interested in
193 non-relocatable schemas.
198 <term><option>list-keys</option></term>
200 Lists the keys in <replaceable>SCHEMA</replaceable>.
205 <term><option>list-children</option></term>
207 Lists the children of <replaceable>SCHEMA</replaceable>.
212 <term><option>list-recursively</option></term>
214 Lists keys and values, recursively. If no <replaceable>SCHEMA</replaceable>
215 is given, list keys in all schemas.
220 <term><option>help</option></term>
222 Prints help and exits.