Add documentation and translation for gsettings-tool

This commit is contained in:
Matthias Clasen
2010-04-20 22:41:12 -04:00
parent 1dbe06c30a
commit bedf4c3259
6 changed files with 135 additions and 26 deletions

View File

@@ -117,6 +117,7 @@ content_files = \
migrating.xml \
gio-querymodules.xml \
gschema-compile.xml \
gsettings-tool.xml \
gsettings-schema-convert.xml
expand_content_files = \
@@ -124,6 +125,7 @@ expand_content_files = \
migrating.xml \
gio-querymodules.xml \
gschema-compile.xml \
gsettings-tool.xml \
gsettings-schema-convert.xml
extra_files = \
@@ -140,6 +142,7 @@ if ENABLE_MAN
man_MANS = \
gio-querymodules.1 \
gschema-compile.1 \
gsettings-tool.1 \
gsettings-schema-convert.1
$(man_MANS) : sgml-build.stamp

View File

@@ -142,6 +142,7 @@
<chapter id="tools">
<title>GIO Tools</title>
<xi:include href="xml/gio-querymodules.xml"/>
<xi:include href="xml/gsettings-tool.xml"/>
<xi:include href="xml/gschema-compile.xml"/>
<xi:include href="xml/gsettings-schema-convert.xml"/>
</chapter>

View File

@@ -0,0 +1,93 @@
<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>