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">describe</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   </cmdsynopsis>
  57   <cmdsynopsis>
  58     <command>gsettings</command>
  59     <arg choice="plain">set</arg>
  60     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  61     <arg choice="plain"><replaceable>KEY</replaceable></arg>
  62     <arg choice="plain"><replaceable>VALUE</replaceable></arg>
  63   </cmdsynopsis>
  64   <cmdsynopsis>
  65     <command>gsettings</command>
  66     <arg choice="plain">reset</arg>
  67     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  68     <arg choice="plain"><replaceable>KEY</replaceable></arg>
  69   </cmdsynopsis>
  70   <cmdsynopsis>
  71     <command>gsettings</command>
  72     <arg choice="plain">reset-recursively</arg>
  73     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  74   </cmdsynopsis>
  75   <cmdsynopsis>
  76     <command>gsettings</command>
  77     <arg choice="plain">list-schemas</arg>
  78   </cmdsynopsis>
  79   <cmdsynopsis>
  80     <command>gsettings</command>
  81     <arg choice="plain">list-relocatable-schemas</arg>
  82   </cmdsynopsis>
  83   <cmdsynopsis>
  84     <command>gsettings</command>
  85     <arg choice="plain">list-keys</arg>
  86     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  87   </cmdsynopsis>
  88   <cmdsynopsis>
  89     <command>gsettings</command>
  90     <arg choice="plain">list-children</arg>
  91     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  92   </cmdsynopsis>
  93   <cmdsynopsis>
  94     <command>gsettings</command>
  95     <arg choice="plain">list-recursively</arg>
  96     <arg choice="opt"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  97   </cmdsynopsis>
  98   <cmdsynopsis>
  99     <command>gsettings</command>
 100     <arg choice="plain">help</arg>
 101     <arg choice="opt"><replaceable>COMMAND</replaceable></arg>
 102   </cmdsynopsis>
 103 </refsynopsisdiv>
 104
 105 <refsect1><title>Description</title>
 106 <para><command>gsettings</command> offers a simple commandline
 107 interface to <link linkend="GSettings"><type>GSettings</type></link>.
 108 It lets you get, set or monitor an individual key for changes.
 109 </para>
 110 <para>
 111 The <replaceable>SCHEMA</replaceable> and <replaceable>KEY</replaceable>
 112 arguments are required for most commands to specify the schema id and the
 113 name of the key to operate on. The schema id may optionally have a
 114 :<replaceable>PATH</replaceable> suffix. Specifying the path is only needed
 115 if the schema does not have a fixed path.
 116 </para>
 117 <para>
 118 When setting a key, you also need specify a <replaceable>VALUE</replaceable>
 119 The format for the value is that of a serialized
 120 <link linkend="GVariant"><type>GVariant</type></link>,
 121 so e.g. a string
 122 must include explicit quotes: "'foo'". This format is also used when printing
 123 out values.
 124 </para>
 125 <para>
 126 Note that gsettings needs a D-Bus session bus connection to write changes to
 127 the dconf database.
 128 </para>
 129 </refsect1>
 130
 131 <refsect1><title>Commands</title>
 132 <variablelist>
 133
 134 <varlistentry>
 135 <term><option>get</option></term>
 136 <listitem><para>
 137 Gets the value of <replaceable>KEY</replaceable>.
 138 The value is printed out as a serialised
 139 <link linkend="GVariant"><type>GVariant</type></link>.
 140 </para></listitem>
 141 </varlistentry>
 142
 143 <varlistentry>
 144 <term><option>monitor</option></term>
 145 <listitem><para>
 146 Monitors <replaceable>KEY</replaceable> for changes and prints the changed
 147 values. If no <replaceable>KEY</replaceable> is specified, all keys in the
 148 schema are monitored. Monitoring will continue until the process is terminated.
 149 </para></listitem>
 150 </varlistentry>
 151
 152 <varlistentry>
 153 <term><option>writable</option></term>
 154 <listitem><para>
 155 Finds out whether <replaceable>KEY</replaceable> is writable.
 156 </para></listitem>
 157 </varlistentry>
 158
 159 <varlistentry>
 160 <term><option>range</option></term>
 161 <listitem><para>
 162 Queries the range of valid values for <replaceable>KEY</replaceable>.
 163 </para></listitem>
 164 </varlistentry>
 165
 166 <varlistentry>
 167 <term><option>describe</option></term>
 168 <listitem><para>
 169 Queries the description of valid values for <replaceable>KEY</replaceable>.
 170 </para></listitem>
 171 </varlistentry>
 172
 173 <varlistentry>
 174 <term><option>set</option></term>
 175 <listitem><para>
 176 Sets the value of <replaceable>KEY</replaceable> to
 177 <replaceable>VALUE</replaceable>. The value is specified as a serialised
 178 <link linkend="GVariant"><type>GVariant</type></link>.
 179 </para></listitem>
 180 </varlistentry>
 181
 182 <varlistentry>
 183 <term><option>reset</option></term>
 184 <listitem><para>
 185 Resets <replaceable>KEY</replaceable> to its default value.
 186 </para></listitem>
 187 </varlistentry>
 188
 189 <varlistentry>
 190 <term><option>reset-recursively</option></term>
 191 <listitem><para>
 192 Reset all keys under the given <replaceable>SCHEMA</replaceable>.
 193 </para></listitem>
 194 </varlistentry>
 195
 196 <varlistentry>
 197 <term><option>list-schemas</option></term>
 198 <listitem><para>
 199 Lists the installed, non-relocatable schemas.
 200 See <option>list-relocatable-schemas</option> if you are interested in
 201 relocatable schemas.
 202 </para></listitem>
 203 </varlistentry>
 204
 205 <varlistentry>
 206 <term><option>list-relocatable-schemas</option></term>
 207 <listitem><para>
 208 Lists the installed, relocatable schemas.
 209 See <option>list-schemas</option> if you are interested in
 210 non-relocatable schemas.
 211 </para></listitem>
 212 </varlistentry>
 213
 214 <varlistentry>
 215 <term><option>list-keys</option></term>
 216 <listitem><para>
 217 Lists the keys in <replaceable>SCHEMA</replaceable>.
 218 </para></listitem>
 219 </varlistentry>
 220
 221 <varlistentry>
 222 <term><option>list-children</option></term>
 223 <listitem><para>
 224 Lists the children of <replaceable>SCHEMA</replaceable>.
 225 </para></listitem>
 226 </varlistentry>
 227
 228 <varlistentry>
 229 <term><option>list-recursively</option></term>
 230 <listitem><para>
 231 Lists keys and values, recursively. If no <replaceable>SCHEMA</replaceable>
 232 is given, list keys in all schemas.
 233 </para></listitem>
 234 </varlistentry>
 235
 236 <varlistentry>
 237 <term><option>help</option></term>
 238 <listitem><para>
 239 Prints help and exits.
 240 </para></listitem>
 241 </varlistentry>
 242
 243 </variablelist>
 244
 245 </refsect1>
 246 </refentry>