1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="dconf-tool">
<refentryinfo>
<title>dconf</title>
<productname>dconf</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Ryan</firstname>
<surname>Lortie</surname>
<email>desrt@desrt.ca</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>dconf</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>dconf</refname>
<refpurpose>Simple tool for manipulating a dconf database</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">read</arg>
<arg choice="opt">-d</arg>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">list</arg>
<arg choice="plain"><replaceable>DIR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">write</arg>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<arg choice="plain"><replaceable>VALUE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">reset</arg>
<arg choice="opt">-f</arg>
<arg choice="plain"><replaceable>PATH</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">compile</arg>
<arg choice="plain"><replaceable>OUTPUT</replaceable></arg>
<arg choice="plain"><replaceable>KEYFILEDIR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">update</arg>
<arg choice="opt"><replaceable>DBDIR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">watch</arg>
<arg choice="plain"><replaceable>PATH</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">dump</arg>
<arg choice="plain"><replaceable>DIR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">load</arg>
<arg choice="opt">-f</arg>
<arg choice="plain"><replaceable>DIR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dconf</command>
<arg choice="plain">help</arg>
<arg choice="opt"><replaceable>COMMAND</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>dconf</command> program can perform various operations on a dconf database, such as reading
or writing individual values or entire directories. This tool operates on dconf directly, without using
gsettings schema information. Therefore, it cannot perform type and consistency checks on values. The
<citerefentry><refentrytitle>gsettings</refentrytitle><manvolnum>1</manvolnum></citerefentry> utility is
an alternative if such checks are needed.
</para>
<para>
The <replaceable>DIR</replaceable> arguments must be directory paths (starting and ending with '/'), the
<replaceable>KEY</replaceable> arguments must be key paths (starting, but not ending with '/') and the
<replaceable>PATH</replaceable> arguments can be either directory or key paths.
</para>
<para>
The <replaceable>OUTPUT</replaceable> argument must the location to write a (binary) dconf database to and the
<replaceable>KEYFILEDIR</replaceable> argument must be a .d directory containing keyfiles.
</para>
<para>
<replaceable>VALUE</replaceable> arguments must be in GVariant format, so e.g. a string must include
explicit quotes: "'foo'". This format is also used when printing out values.
</para>
<para>
Note that dconf needs a D-Bus session bus connection to write changes to the dconf database.
</para>
</refsect1>
<refsect1>
<title>Commands</title>
<variablelist>
<varlistentry>
<term><option>read</option></term>
<listitem><para>Read the value of a key. Use <option>-d</option> to print the default value rather than the user-set value.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>list</option></term>
<listitem><para>List the sub-keys and sub-directories of a directory.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>write</option></term>
<listitem><para>Write a new value to a key.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>reset</option></term>
<listitem><para>Reset a key or an entire directory. For directories, <option>-f</option> must be specified.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>compile</option></term>
<listitem>
<para>Compile a binary database from keyfiles.</para>
<para>
The result is always in little-endian byte order, so it can be safely installed in 'share'. If it
is used on a big endian machine, dconf will automatically byteswap the contents on read.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>update</option></term>
<listitem><para>Update the system dconf databases.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>watch</option></term>
<listitem><para>Watch a key or directory for changes.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>dump</option></term>
<listitem><para>Dump an entire subpath to stdout. The output is in a keyfile-like format, with values in GVariant syntax.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>load</option></term>
<listitem>
<para>
Populate a subpath from stdin. The expected format is the same as produced by <option>dump</option>.
Attempting to change non-writable keys cancels the load command.
To ignore changes to non-writable keys instead, use <option>-f</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>help</option></term>
<listitem><para>Display help and exit. If <replaceable>COMMAND</replaceable> is given, display help for this command.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>DCONF_PROFILE</envar></term>
<listitem><para>
This environment variable determines which dconf <firstterm>profile</firstterm> to use. See
<citerefentry><refentrytitle>dconf</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>dconf</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gsettings</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dconf-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|