docs/reference/gio/gsettings.xml

   1 <refentry id="gsettings-tool" lang="en">
   2
   3 <refmeta>
   4   <refentrytitle>gsettings</refentrytitle>
   5   <manvolnum>1</manvolnum>
   6   <refmiscinfo class="manual">User Commands</refmiscinfo>
   7 </refmeta>
   8
   9 <refnamediv>
  10   <refname>gsettings</refname>
  11   <refpurpose>GSettings configuration tool</refpurpose>
  12 </refnamediv>
  13
  14 <refsynopsisdiv>
  15   <cmdsynopsis>
  16     <command>gsettings</command>
  17     <arg choice="plain">get</arg>
  18     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  19     <arg choice="plain"><replaceable>KEY</replaceable></arg>
  20   </cmdsynopsis>
  21   <cmdsynopsis>
  22     <command>gsettings</command>
  23     <arg choice="plain">monitor</arg>
  24     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  25     <arg choice="opt"><replaceable>KEY</replaceable></arg>
  26   </cmdsynopsis>
  27   <cmdsynopsis>
  28     <command>gsettings</command>
  29     <arg choice="plain">writable</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">range</arg>
  36     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  37     <arg choice="plain"><replaceable>KEY</replaceable></arg>
  38   </cmdsynopsis>
  39   <cmdsynopsis>
  40     <command>gsettings</command>
  41     <arg choice="plain">set</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     <arg choice="plain"><replaceable>VALUE</replaceable></arg>
  45   </cmdsynopsis>
  46   <cmdsynopsis>
  47     <command>gsettings</command>
  48     <arg choice="plain">reset</arg>
  49     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  50     <arg choice="plain"><replaceable>KEY</replaceable></arg>
  51   </cmdsynopsis>
  52   <cmdsynopsis>
  53     <command>gsettings</command>
  54     <arg choice="plain">reset-recursively</arg>
  55     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  56   </cmdsynopsis>
  57   <cmdsynopsis>
  58     <command>gsettings</command>
  59     <arg choice="plain">list-schemas</arg>
  60   </cmdsynopsis>
  61   <cmdsynopsis>
  62     <command>gsettings</command>
  63     <arg choice="plain">list-relocatable-schemas</arg>
  64   </cmdsynopsis>
  65   <cmdsynopsis>
  66     <command>gsettings</command>
  67     <arg choice="plain">list-keys</arg>
  68     <arg choice="plain"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  69   </cmdsynopsis>
  70   <cmdsynopsis>
  71     <command>gsettings</command>
  72     <arg choice="plain">list-children</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-recursively</arg>
  78     <arg choice="opt"><replaceable>SCHEMA</replaceable><arg choice="opt">:<replaceable>PATH</replaceable></arg></arg>
  79   </cmdsynopsis>
  80   <cmdsynopsis>
  81     <command>gsettings</command>
  82     <arg choice="plain">help</arg>
  83     <arg choice="opt"><replaceable>COMMAND</replaceable></arg>
  84   </cmdsynopsis>
  85 </refsynopsisdiv>
  86
  87 <refsect1><title>Description</title>
  88 <para><command>gsettings</command> offers a simple commandline
  89 interface to <link linkend="GSettings"><type>GSettings</type></link>.
  90 It lets you get, set or monitor an individual key for changes.
  91 </para>
  92 <para>
  93 The <replaceable>SCHEMA</replaceable> and <replaceable>KEY</replaceable>
  94 arguments are required for most commands to specify the schema id and the
  95 name of the key to operate on. The schema id may optionally have a
  96 :<replaceable>PATH</replaceable> suffix. Specifying the path is only needed
  97 if the schema does not have a fixed path.
  98 </para>
  99 <para>
 100 When setting a key, you also need specify a <replaceable>VALUE</replaceable>
 101 The format for the value is that of a serialized
 102 <link linkend="GVariant"><type>GVariant</type></link>,
 103 so e.g. a string
 104 must include explicit quotes: "'foo'". This format is also used when printing
 105 out values.
 106 </para>
 107
 108 <refsect2><title>Commands</title>
 109 <variablelist>
 110
 111 <varlistentry>
 112 <term><option>get</option></term>
 113 <listitem><para>
 114 Gets the value of <replaceable>KEY</replaceable>.
 115 The value is printed out as a serialised
 116 <link linkend="GVariant"><type>GVariant</type></link>.
 117 </para></listitem>
 118 </varlistentry>
 119
 120 <varlistentry>
 121 <term><option>monitor</option></term>
 122 <listitem><para>
 123 Monitors <replaceable>KEY</replaceable> for changes and prints the changed
 124 values. If no <replaceable>KEY</replaceable> is specified, all keys in the
 125 schema are monitored. Monitoring will continue until the process is terminated.
 126 </para></listitem>
 127 </varlistentry>
 128
 129 <varlistentry>
 130 <term><option>writable</option></term>
 131 <listitem><para>
 132 Finds out whether <replaceable>KEY</replaceable> is writable.
 133 </para></listitem>
 134 </varlistentry>
 135
 136 <varlistentry>
 137 <term><option>range</option></term>
 138 <listitem><para>
 139 Queries the range of valid values for <replaceable>KEY</replaceable>.
 140 </para></listitem>
 141 </varlistentry>
 142
 143 <varlistentry>
 144 <term><option>set</option></term>
 145 <listitem><para>
 146 Sets the value of <replaceable>KEY</replaceable> to
 147 <replaceable>VALUE</replaceable>. The value is specified as a serialised
 148 <link linkend="GVariant"><type>GVariant</type></link>.
 149 </para></listitem>
 150 </varlistentry>
 151
 152 <varlistentry>
 153 <term><option>reset</option></term>
 154 <listitem><para>
 155 Resets <replaceable>KEY</replaceable> to its default value.
 156 </para></listitem>
 157 </varlistentry>
 158
 159 <varlistentry>
 160 <term><option>reset-recursively</option></term>
 161 <listitem><para>
 162 Reset all keys under the given <replaceable>SCHEMA</replaceable>.
 163 </para></listitem>
 164 </varlistentry>
 165
 166 <varlistentry>
 167 <term><option>list-schemas</option></term>
 168 <listitem><para>
 169 Lists the installed, non-relocatable schemas.
 170 See <option>list-relocatable-schemas</option> if you are interested in
 171 relocatable schemas.
 172 </para></listitem>
 173 </varlistentry>
 174
 175 <varlistentry>
 176 <term><option>list-relocatable-schemas</option></term>
 177 <listitem><para>
 178 Lists the installed, relocatable schemas.
 179 See <option>list-schemas</option> if you are interested in
 180 non-relocatable schemas.
 181 </para></listitem>
 182 </varlistentry>
 183
 184 <varlistentry>
 185 <term><option>list-keys</option></term>
 186 <listitem><para>
 187 Lists the keys in <replaceable>SCHEMA</replaceable>.
 188 </para></listitem>
 189 </varlistentry>
 190
 191 <varlistentry>
 192 <term><option>list-children</option></term>
 193 <listitem><para>
 194 Lists the children of <replaceable>SCHEMA</replaceable>.
 195 </para></listitem>
 196 </varlistentry>
 197
 198 <varlistentry>
 199 <term><option>list-recursively</option></term>
 200 <listitem><para>
 201 Lists keys and values, recursively. If no <replaceable>SCHEMA</replaceable>
 202 is given, list keys in all schemas.
 203 </para></listitem>
 204 </varlistentry>
 205
 206 <varlistentry>
 207 <term><option>help</option></term>
 208 <listitem><para>
 209 Prints help and exits.
 210 </para></listitem>
 211 </varlistentry>
 212
 213 </variablelist>
 214 </refsect2>
 215
 216 </refsect1>
 217 </refentry>
 218