docs/reference/gio/gsettings.xml

   1 <refentry id="gsettings-tool" lang="en">
   2
   3 <refentryinfo>
   4   <title>gsettings</title>
   5   <productname>GIO</productname>
   6   <authorgroup>
   7     <author>
   8       <contrib>Developer</contrib>
   9       <firstname>Ryan</firstname>
  10       <surname>Lortie</surname>
  11     </author>
  12   </authorgroup>
  13 </refentryinfo>
  14
  15 <refmeta>
  16   <refentrytitle>gsettings</refentrytitle>
  17   <manvolnum>1</manvolnum>
  18   <refmiscinfo class="manual">User Commands</refmiscinfo>
  19 </refmeta>
  20
  21 <refnamediv>
  22   <refname>gsettings</refname>
  23   <refpurpose>GSettings configuration tool</refpurpose>
  24 </refnamediv>
  25
  26 <refsynopsisdiv>
  27   <cmdsynopsis>
  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>
  32   </cmdsynopsis>
  33   <cmdsynopsis>
  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>
  38   </cmdsynopsis>
  39   <cmdsynopsis>
  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>
  44   </cmdsynopsis>
  45   <cmdsynopsis>
  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>
  50   </cmdsynopsis>
  51   <cmdsynopsis>
  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>
  57   </cmdsynopsis>
  58   <cmdsynopsis>
  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>
  63   </cmdsynopsis>
  64   <cmdsynopsis>
  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>
  68   </cmdsynopsis>
  69   <cmdsynopsis>
  70     <command>gsettings</command>
  71     <arg choice="plain">list-schemas</arg>
  72   </cmdsynopsis>
  73   <cmdsynopsis>
  74     <command>gsettings</command>
  75     <arg choice="plain">list-relocatable-schemas</arg>
  76   </cmdsynopsis>
  77   <cmdsynopsis>
  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>
  81   </cmdsynopsis>
  82   <cmdsynopsis>
  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>
  86   </cmdsynopsis>
  87   <cmdsynopsis>
  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>
  91   </cmdsynopsis>
  92   <cmdsynopsis>
  93     <command>gsettings</command>
  94     <arg choice="plain">help</arg>
  95     <arg choice="opt"><replaceable>COMMAND</replaceable></arg>
  96   </cmdsynopsis>
  97 </refsynopsisdiv>
  98
  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.
 103 </para>
 104 <para>
 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.
 110 </para>
 111 <para>
 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>,
 115 so e.g. a string
 116 must include explicit quotes: "'foo'". This format is also used when printing
 117 out values.
 118 </para>
 119 <para>
 120 Note that gsettings needs a D-Bus session bus connection to write changes to
 121 the dconf database.
 122 </para>
 123 </refsect1>
 124
 125 <refsect1><title>Commands</title>
 126 <variablelist>
 127
 128 <varlistentry>
 129 <term><option>get</option></term>
 130 <listitem><para>
 131 Gets the value of <replaceable>KEY</replaceable>.
 132 The value is printed out as a serialised
 133 <link linkend="GVariant"><type>GVariant</type></link>.
 134 </para></listitem>
 135 </varlistentry>
 136
 137 <varlistentry>
 138 <term><option>monitor</option></term>
 139 <listitem><para>
 140 Monitors <replaceable>KEY</replaceable> for changes and prints the changed
 141 values. If no <replaceable>KEY</replaceable> is specified, all keys in the
 142 schema are monitored. Monitoring will continue until the process is terminated.
 143 </para></listitem>
 144 </varlistentry>
 145
 146 <varlistentry>
 147 <term><option>writable</option></term>
 148 <listitem><para>
 149 Finds out whether <replaceable>KEY</replaceable> is writable.
 150 </para></listitem>
 151 </varlistentry>
 152
 153 <varlistentry>
 154 <term><option>range</option></term>
 155 <listitem><para>
 156 Queries the range of valid values for <replaceable>KEY</replaceable>.
 157 </para></listitem>
 158 </varlistentry>
 159
 160 <varlistentry>
 161 <term><option>set</option></term>
 162 <listitem><para>
 163 Sets the value of <replaceable>KEY</replaceable> to
 164 <replaceable>VALUE</replaceable>. The value is specified as a serialised
 165 <link linkend="GVariant"><type>GVariant</type></link>.
 166 </para></listitem>
 167 </varlistentry>
 168
 169 <varlistentry>
 170 <term><option>reset</option></term>
 171 <listitem><para>
 172 Resets <replaceable>KEY</replaceable> to its default value.
 173 </para></listitem>
 174 </varlistentry>
 175
 176 <varlistentry>
 177 <term><option>reset-recursively</option></term>
 178 <listitem><para>
 179 Reset all keys under the given <replaceable>SCHEMA</replaceable>.
 180 </para></listitem>
 181 </varlistentry>
 182
 183 <varlistentry>
 184 <term><option>list-schemas</option></term>
 185 <listitem><para>
 186 Lists the installed, non-relocatable schemas.
 187 See <option>list-relocatable-schemas</option> if you are interested in
 188 relocatable schemas.
 189 </para></listitem>
 190 </varlistentry>
 191
 192 <varlistentry>
 193 <term><option>list-relocatable-schemas</option></term>
 194 <listitem><para>
 195 Lists the installed, relocatable schemas.
 196 See <option>list-schemas</option> if you are interested in
 197 non-relocatable schemas.
 198 </para></listitem>
 199 </varlistentry>
 200
 201 <varlistentry>
 202 <term><option>list-keys</option></term>
 203 <listitem><para>
 204 Lists the keys in <replaceable>SCHEMA</replaceable>.
 205 </para></listitem>
 206 </varlistentry>
 207
 208 <varlistentry>
 209 <term><option>list-children</option></term>
 210 <listitem><para>
 211 Lists the children of <replaceable>SCHEMA</replaceable>.
 212 </para></listitem>
 213 </varlistentry>
 214
 215 <varlistentry>
 216 <term><option>list-recursively</option></term>
 217 <listitem><para>
 218 Lists keys and values, recursively. If no <replaceable>SCHEMA</replaceable>
 219 is given, list keys in all schemas.
 220 </para></listitem>
 221 </varlistentry>
 222
 223 <varlistentry>
 224 <term><option>help</option></term>
 225 <listitem><para>
 226 Prints help and exits.
 227 </para></listitem>
 228 </varlistentry>
 229
 230 </variablelist>
 231
 232 </refsect1>
 233 </refentry>