glib/docs/reference/gio/gsettings-tool.xml
2010-04-20 22:55:15 -04:00

94 lines
2.5 KiB
XML

<refentry id="gsettings-tool" lang="en">
<refmeta>
<refentrytitle>gsettings-tool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gsettings-tool</refname>
<refpurpose>GSettings configuration tool</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>gsettings-tool</command>
<arg choice="opt" rep="repeat">option</arg>
<arg choice="req"><replaceable>schema</replaceable></arg>
<arg choice="req"><replaceable>key</replaceable></arg>
<arg choice="opt"><replaceable>value</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para><command>gsettings-tool</command> offers a simple commandline
interface to #GSettings. It lets you get, set or monitor an individual
key for changes.
</para>
<para>
The <replaceable>schema</replaceable> and <replaceable>key</replaceable>
arguments are required to specify the schema id and the name of the key
to operate on.
</para>
<para>
When setting a key, you also need specify a <replaceable>value</replaceable>
The format for the value is that of a serialized #GVariant, so e.g. a string
must include explicit quotes: "'foo'". This format is also used when printing
out values.
</para>
<refsect2><title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h</option>, <option>--help</option></term>
<listitem><para>
Print help and exit
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option>, <option>--get</option></term>
<listitem><para>
Get the value of <replaceable>key</replaceable>
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>, <option>--set</option></term>
<listitem><para>
Set the value of <replaceable>key</replaceable>
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option>, <option>--writable</option></term>
<listitem><para>
Find out whether <replaceable>key</replaceable> is writable
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option>, <option>--monitor</option></term>
<listitem><para>
Monitor <replaceable>key</replaceable> for changes and print the
changed values. Monitoring will continue until the process is
terminated.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>, <option>--path=<replaceable>path</replaceable></option></term>
<listitem><para>
The path for the schema. This option is only needed if the schema
does not have a fixed path.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>