man-pages/man1/gsettings.1.html
2021-03-31 01:06:50 +01:00

236 lines
4.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GSETTINGS</TITLE>
</HEAD><BODY>
<H1>GSETTINGS</H1>
Section: User Commands (1)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
gsettings - GSettings configuration tool
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>gsettings</B> get <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] <I>KEY</I>
<DT id="2">
<B>gsettings</B> monitor <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] [<I>KEY</I>]
<DT id="3">
<B>gsettings</B> writable <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] <I>KEY</I>
<DT id="4">
<B>gsettings</B> range <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] <I>KEY</I>
<DT id="5">
<B>gsettings</B> describe <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] <I>KEY</I>
<DT id="6">
<B>gsettings</B> set <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] <I>KEY</I> <I>VALUE</I>
<DT id="7">
<B>gsettings</B> reset <I>SCHEMA</I>&nbsp;[:<I>PATH</I>] <I>KEY</I>
<DT id="8">
<B>gsettings</B> reset-recursively <I>SCHEMA</I>&nbsp;[:<I>PATH</I>]
<DT id="9">
<B>gsettings</B> list-schemas [--print-paths]
<DT id="10">
<B>gsettings</B> list-relocatable-schemas
<DT id="11">
<B>gsettings</B> list-keys <I>SCHEMA</I>&nbsp;[:<I>PATH</I>]
<DT id="12">
<B>gsettings</B> list-children <I>SCHEMA</I>&nbsp;[:<I>PATH</I>]
<DT id="13">
<B>gsettings</B> list-recursively [<I>SCHEMA</I>&nbsp;[:<I>PATH</I>]]
<DT id="14">
<B>gsettings</B> help [<I>COMMAND</I>]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>gsettings</B>
<DD>offers a simple commandline interface to
<B>GSettings</B>. It lets you get, set or monitor an individual key for changes.
<P>
The
<I>SCHEMA</I>
and
<I>KEY</I>
arguments are required for most commands to specify the schema id and the name of the key to operate on. The schema id may optionally have a :<I>PATH</I>
suffix. Specifying the path is only needed if the schema does not have a fixed path.
<P>
When setting a key, you also need specify a
<I>VALUE</I>
The format for the value is that of a serialized
<B>GVariant</B>, so e.g. a string must include explicit quotes: &quot;'foo'&quot;. This format is also used when printing out values.
<P>
Note that gsettings needs a D-Bus session bus connection to write changes to the dconf database.
<A NAME="lbAE">&nbsp;</A>
<H2>COMMANDS</H2>
<P>
<B>get</B>
<DL COMPACT><DT id="15"><DD>
Gets the value of
<I>KEY</I>. The value is printed out as a serialised
<B>GVariant</B>.
</DL>
<P>
<B>monitor</B>
<DL COMPACT><DT id="16"><DD>
Monitors
<I>KEY</I>
for changes and prints the changed values. If no
<I>KEY</I>
is specified, all keys in the schema are monitored. Monitoring will continue until the process is terminated.
</DL>
<P>
<B>writable</B>
<DL COMPACT><DT id="17"><DD>
Finds out whether
<I>KEY</I>
is writable.
</DL>
<P>
<B>range</B>
<DL COMPACT><DT id="18"><DD>
Queries the range of valid values for
<I>KEY</I>.
</DL>
<P>
<B>describe</B>
<DL COMPACT><DT id="19"><DD>
Queries the description of valid values for
<I>KEY</I>.
</DL>
<P>
<B>set</B>
<DL COMPACT><DT id="20"><DD>
Sets the value of
<I>KEY</I>
to
<I>VALUE</I>. The value is specified as a serialised
<B>GVariant</B>.
</DL>
<P>
<B>reset</B>
<DL COMPACT><DT id="21"><DD>
Resets
<I>KEY</I>
to its default value.
</DL>
<P>
<B>reset-recursively</B>
<DL COMPACT><DT id="22"><DD>
Reset all keys under the given
<I>SCHEMA</I>.
</DL>
<P>
<B>list-schemas</B>
<DL COMPACT><DT id="23"><DD>
Lists the installed, non-relocatable schemas. See
<B>list-relocatable-schemas</B>
if you are interested in relocatable schemas. If
[<B>--print-paths</B>]
is given, the path where each schema is mapped is also printed.
</DL>
<P>
<B>list-relocatable-schemas</B>
<DL COMPACT><DT id="24"><DD>
Lists the installed, relocatable schemas. See
<B>list-schemas</B>
if you are interested in non-relocatable schemas.
</DL>
<P>
<B>list-keys</B>
<DL COMPACT><DT id="25"><DD>
Lists the keys in
<I>SCHEMA</I>.
</DL>
<P>
<B>list-children</B>
<DL COMPACT><DT id="26"><DD>
Lists the children of
<I>SCHEMA</I>.
</DL>
<P>
<B>list-recursively</B>
<DL COMPACT><DT id="27"><DD>
Lists keys and values, recursively. If no
<I>SCHEMA</I>
is given, list keys in all schemas.
</DL>
<P>
<B>help</B>
<DL COMPACT><DT id="28"><DD>
Prints help and exits.
</DL>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="29"><A HREF="#lbAB">NAME</A><DD>
<DT id="30"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="31"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="32"><A HREF="#lbAE">COMMANDS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:16 GMT, March 31, 2021
</BODY>
</HTML>