docs/reference/gio/html/gsettings-tool.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsettings</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="tools.html" title="GIO Tools">
   9 <link rel="prev" href="gio-querymodules.html" title="gio-querymodules">
  10 <link rel="next" href="glib-compile-schemas.html" title="glib-compile-schemas">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
  16 <td><a accesskey="p" href="gio-querymodules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  17 <td><a accesskey="u" href="tools.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  19 <th width="100%" align="center">GIO Reference Manual</th>
  20 <td><a accesskey="n" href="glib-compile-schemas.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  21 </tr></table>
  22 <div lang="en" class="refentry">
  23 <a name="gsettings-tool"></a><div class="titlepage"></div>
  24 <div class="refnamediv"><table width="100%"><tr>
  25 <td valign="top">
  26 <h2><span class="refentrytitle">gsettings</span></h2>
  27 <p>gsettings — GSettings configuration tool</p>
  28 </td>
  29 <td valign="top" align="right"></td>
  30 </tr></table></div>
  31 <div class="refsynopsisdiv">
  32 <h2>Synopsis</h2>
  33 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   get   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]   <em class="replaceable"><code>KEY</code></em> </p></div>
  34 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   monitor   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]  [<em class="replaceable"><code>KEY</code></em>]</p></div>
  35 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   writable   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]   <em class="replaceable"><code>KEY</code></em> </p></div>
  36 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   range   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]   <em class="replaceable"><code>KEY</code></em> </p></div>
  37 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   set   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]   <em class="replaceable"><code>KEY</code></em>   <em class="replaceable"><code>VALUE</code></em> </p></div>
  38 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   reset   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]   <em class="replaceable"><code>KEY</code></em> </p></div>
  39 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   reset-recursively   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>] </p></div>
  40 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   list-schemas </p></div>
  41 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   list-relocatable-schemas </p></div>
  42 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   list-keys   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>] </p></div>
  43 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   list-children   <em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>] </p></div>
  44 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   list-recursively  [<em class="replaceable"><code>SCHEMA</code></em> [:<em class="replaceable"><code>PATH</code></em>]]</p></div>
  45 <div class="cmdsynopsis"><p><code class="command">gsettings</code>   help  [<em class="replaceable"><code>COMMAND</code></em>]</p></div>
  46 </div>
  47 <div class="refsect1">
  48 <a name="idp30817120"></a><h2>Description</h2>
  49 <p><span class="command"><strong>gsettings</strong></span> offers a simple commandline
  50 interface to <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a>.
  51 It lets you get, set or monitor an individual key for changes.
  52 </p>
  53 <p>
  54 The <em class="replaceable"><code>SCHEMA</code></em> and <em class="replaceable"><code>KEY</code></em>
  55 arguments are required for most commands to specify the schema id and the
  56 name of the key to operate on. The schema id may optionally have a
  57 :<em class="replaceable"><code>PATH</code></em> suffix. Specifying the path is only needed
  58 if the schema does not have a fixed path.
  59 </p>
  60 <p>
  61 When setting a key, you also need specify a <em class="replaceable"><code>VALUE</code></em>
  62 The format for the value is that of a serialized
  63 <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>,
  64 so e.g. a string
  65 must include explicit quotes: "'foo'". This format is also used when printing
  66 out values.
  67 </p>
  68 <div class="refsect2">
  69 <a name="idp48480272"></a><h3>Commands</h3>
  70 <div class="variablelist"><table border="0">
  71 <col align="left" valign="top">
  72 <tbody>
  73 <tr>
  74 <td><p><span class="term"><code class="option">get</code></span></p></td>
  75 <td><p>
  76 Gets the value of <em class="replaceable"><code>KEY</code></em>.
  77 The value is printed out as a serialised
  78 <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.
  79 </p></td>
  80 </tr>
  81 <tr>
  82 <td><p><span class="term"><code class="option">monitor</code></span></p></td>
  83 <td><p>
  84 Monitors <em class="replaceable"><code>KEY</code></em> for changes and prints the changed
  85 values. If no <em class="replaceable"><code>KEY</code></em> is specified, all keys in the
  86 schema are monitored. Monitoring will continue until the process is terminated.
  87 </p></td>
  88 </tr>
  89 <tr>
  90 <td><p><span class="term"><code class="option">writable</code></span></p></td>
  91 <td><p>
  92 Finds out whether <em class="replaceable"><code>KEY</code></em> is writable.
  93 </p></td>
  94 </tr>
  95 <tr>
  96 <td><p><span class="term"><code class="option">range</code></span></p></td>
  97 <td><p>
  98 Queries the range of valid values for <em class="replaceable"><code>KEY</code></em>.
  99 </p></td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term"><code class="option">set</code></span></p></td>
 103 <td><p>
 104 Sets the value of <em class="replaceable"><code>KEY</code></em> to
 105 <em class="replaceable"><code>VALUE</code></em>. The value is specified as a serialised
 106 <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.
 107 </p></td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term"><code class="option">reset</code></span></p></td>
 111 <td><p>
 112 Resets <em class="replaceable"><code>KEY</code></em> to its default value.
 113 </p></td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><code class="option">reset-recursively</code></span></p></td>
 117 <td><p>
 118 Reset all keys under the given <em class="replaceable"><code>SCHEMA</code></em>.
 119 </p></td>
 120 </tr>
 121 <tr>
 122 <td><p><span class="term"><code class="option">list-schemas</code></span></p></td>
 123 <td><p>
 124 Lists the installed, non-relocatable schemas.
 125 See <code class="option">list-relocatable-schemas</code> if you are interested in
 126 relocatable schemas.
 127 </p></td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><code class="option">list-relocatable-schemas</code></span></p></td>
 131 <td><p>
 132 Lists the installed, relocatable schemas.
 133 See <code class="option">list-schemas</code> if you are interested in
 134 non-relocatable schemas.
 135 </p></td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><code class="option">list-keys</code></span></p></td>
 139 <td><p>
 140 Lists the keys in <em class="replaceable"><code>SCHEMA</code></em>.
 141 </p></td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"><code class="option">list-children</code></span></p></td>
 145 <td><p>
 146 Lists the children of <em class="replaceable"><code>SCHEMA</code></em>.
 147 </p></td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><code class="option">list-recursively</code></span></p></td>
 151 <td><p>
 152 Lists keys and values, recursively. If no <em class="replaceable"><code>SCHEMA</code></em>
 153 is given, list keys in all schemas.
 154 </p></td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><code class="option">help</code></span></p></td>
 158 <td><p>
 159 Prints help and exits.
 160 </p></td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 </div>
 166 </div>
 167 <div class="footer">
 168 <hr>
 169           Generated by GTK-Doc V1.18</div>
 170 </body>
 171 </html>