mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-02 07:23:41 +02:00
Rename gsettings-tool to gsettings
And make it verb-based.
This commit is contained in:
Matthias Clasen
@@ -117,16 +117,12 @@ content_files = \
|
||||
migrating.xml \
|
||||
gio-querymodules.xml \
|
||||
gschema-compile.xml \
|
||||
gsettings-tool.xml \
|
||||
gsettings.xml \
|
||||
gsettings-schema-convert.xml
|
||||
|
||||
expand_content_files = \
|
||||
overview.xml \
|
||||
migrating.xml \
|
||||
gio-querymodules.xml \
|
||||
gschema-compile.xml \
|
||||
gsettings-tool.xml \
|
||||
gsettings-schema-convert.xml
|
||||
migrating.xml
|
||||
|
||||
extra_files = \
|
||||
version.xml.in \
|
||||
@@ -147,7 +143,7 @@ man_MANS = \
|
||||
|
||||
$(man_MANS) : sgml-build.stamp
|
||||
|
||||
%.1 : xml/%.xml
|
||||
%.1 : %.xml
|
||||
@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
|
||||
|
||||
endif
|
||||
|
||||
@@ -141,10 +141,10 @@
|
||||
</chapter>
|
||||
<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"/>
|
||||
<xi:include href="gio-querymodules.xml"/>
|
||||
<xi:include href="gsettings.xml"/>
|
||||
<xi:include href="gschema-compile.xml"/>
|
||||
<xi:include href="gsettings-schema-convert.xml"/>
|
||||
</chapter>
|
||||
</part>
|
||||
|
||||
|
||||
@@ -23,9 +23,10 @@
|
||||
<para><command>gschema-compile</command> compiles all the GSettings XML
|
||||
schema files in <replaceable>directory</replaceable> into a binary file
|
||||
with the name <filename>gschemas.compiled</filename> that can be used
|
||||
by #GSettings. The XML schema files must have the filename extension
|
||||
<filename>.gschema.xml</filename>. For a detailed description of the XML
|
||||
file format, see the #GSettings documentation.
|
||||
by <link linkend="GSettings"><type>GSettings</type></link>. The XML schema
|
||||
files must have the filename extension <filename>.gschema.xml</filename>.
|
||||
For a detailed description of the XML file format, see the
|
||||
<link linkend="GSettings"><type>GSettings</type></link> documentation.
|
||||
</para>
|
||||
<para>
|
||||
At runtime, GSettings looks for schemas in the
|
||||
|
||||
@@ -1,93 +0,0 @@
|
||||
<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>
|
||||
|
||||
137
docs/reference/gio/gsettings.xml
Normal file
137
docs/reference/gio/gsettings.xml
Normal file
@@ -0,0 +1,137 @@
|
||||
<refentry id="gsettings" lang="en">
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>gsettings</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="manual">User Commands</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gsettings</refname>
|
||||
<refpurpose>GSettings configuration tool</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>gsettings</command>
|
||||
<arg choice="plain">get</arg>
|
||||
<arg choice="opt" rep="repeat">option</arg>
|
||||
<arg choice="req"><replaceable>schema</replaceable></arg>
|
||||
<arg choice="req"><replaceable>key</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>gsettings</command>
|
||||
<arg choice="plain">monitor</arg>
|
||||
<arg choice="opt" rep="repeat">option</arg>
|
||||
<arg choice="req"><replaceable>schema</replaceable></arg>
|
||||
<arg choice="req"><replaceable>key</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>gsettings</command>
|
||||
<arg choice="plain">writable</arg>
|
||||
<arg choice="opt" rep="repeat">option</arg>
|
||||
<arg choice="req"><replaceable>schema</replaceable></arg>
|
||||
<arg choice="req"><replaceable>key</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>gsettings</command>
|
||||
<arg choice="plain">set</arg>
|
||||
<arg choice="opt" rep="repeat">option</arg>
|
||||
<arg choice="req"><replaceable>schema</replaceable></arg>
|
||||
<arg choice="req"><replaceable>key</replaceable></arg>
|
||||
<arg choice="req"><replaceable>value</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>gsettings</command>
|
||||
<arg choice="plain">help</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1><title>Description</title>
|
||||
<para><command>gsettings</command> offers a simple commandline
|
||||
interface to <link linkend="GSettings"><type>GSettings</type></link>.
|
||||
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
|
||||
<link linkend="GVariant"><type>GVariant</type></link>,
|
||||
so e.g. a string
|
||||
must include explicit quotes: "'foo'". This format is also used when printing
|
||||
out values.
|
||||
</para>
|
||||
|
||||
<refsect2><title>Commands</title>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>get</option></term>
|
||||
<listitem><para>
|
||||
Get the value of <replaceable>key</replaceable>. The value is printed out
|
||||
as a serialised
|
||||
<link linkend="GVariant"><type>GVariant</type></link>.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><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>writable</option></term>
|
||||
<listitem><para>
|
||||
Find out whether <replaceable>key</replaceable> is writable.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>set</option></term>
|
||||
<listitem><para>
|
||||
Set the value of <replaceable>key</replaceable> to <replaceable>value</replaceable>.
|
||||
The value is specified as a serialised
|
||||
<link linkend="GVariant"><type>GVariant</type></link>.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>help</option></term>
|
||||
<listitem><para>
|
||||
Print help and exit
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect2>
|
||||
|
||||
|
||||
<refsect2><title>Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-h</option>, <option>--help</option></term>
|
||||
<listitem><para>
|
||||
Print help for the command and exit
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-p <replaceable>path</replaceable></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>
|
||||
|
||||
Reference in New Issue
Block a user