'\" t
.\"     Title: dconf
.\"    Author: Ryan Lortie <desrt@desrt.ca>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 06/02/2021
.\"    Manual: User Commands
.\"    Source: dconf
.\"  Language: English
.\"
.TH "DCONF" "1" "" "dconf" "User Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dconf \- Simple tool for manipulating a dconf database
.SH "SYNOPSIS"
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR read [\-d] \fIKEY\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR list \fIDIR\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR write \fIKEY\fR \fIVALUE\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR reset [\-f] \fIPATH\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR compile \fIOUTPUT\fR \fIKEYFILEDIR\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR update [\fIDBDIR\fR]
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR watch \fIPATH\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR dump \fIDIR\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR load [\-f] \fIDIR\fR
.HP \w'\fBdconf\fR\ 'u
\fBdconf\fR help [\fICOMMAND\fR]
.SH "DESCRIPTION"
.PP
The
\fBdconf\fR
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
\fBgsettings\fR(1)
utility is an alternative if such checks are needed\&.
.PP
The
\fIDIR\fR
arguments must be directory paths (starting and ending with \*(Aq/\*(Aq), the
\fIKEY\fR
arguments must be key paths (starting, but not ending with \*(Aq/\*(Aq) and the
\fIPATH\fR
arguments can be either directory or key paths\&.
.PP
The
\fIOUTPUT\fR
argument must the location to write a (binary) dconf database to and the
\fIKEYFILEDIR\fR
argument must be a \&.d directory containing keyfiles\&.
.PP
\fIVALUE\fR
arguments must be in GVariant format, so e\&.g\&. a string must include explicit quotes: "\*(Aqfoo\*(Aq"\&. This format is also used when printing out values\&.
.PP
Note that dconf needs a D\-Bus session bus connection to write changes to the dconf database\&.
.SH "COMMANDS"
.PP
\fBread\fR
.RS 4
Read the value of a key\&.
.RE
.PP
\fBlist\fR
.RS 4
List the sub\-keys and sub\-directories of a directory\&.
.RE
.PP
\fBwrite\fR
.RS 4
Write a new value to a key\&.
.RE
.PP
\fBreset\fR
.RS 4
Reset a key or an entire directory\&. For directories,
\fB\-f\fR
must be specified\&.
.RE
.PP
\fBcompile\fR
.RS 4
Compile a binary database from keyfiles\&.
.sp
The result is always in little\-endian byte order, so it can be safely installed in \*(Aqshare\*(Aq\&. If it is used on a big endian machine, dconf will automatically byteswap the contents on read\&.
.RE
.PP
\fBupdate\fR
.RS 4
Update the system dconf databases\&.
.RE
.PP
\fBwatch\fR
.RS 4
Watch a key or directory for changes\&.
.RE
.PP
\fBdump\fR
.RS 4
Dump an entire subpath to stdout\&. The output is in a keyfile\-like format, with values in GVariant syntax\&.
.RE
.PP
\fBload\fR
.RS 4
Populate a subpath from stdin\&. The expected format is the same as produced by
\fBdump\fR\&. Attempting to change non\-writable keys cancels the load command\&. To ignore changes to non\-writable keys instead, use
\fB\-f\fR\&.
.RE
.PP
\fBhelp\fR
.RS 4
Display help and exit\&. If
\fICOMMAND\fR
is given, display help for this command\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBDCONF_PROFILE\fR
.RS 4
This environment variable determines which dconf
profile
to use\&. See
\fBdconf\fR(7)\&.
.RE
.SH "SEE ALSO"
.PP
\fBdconf\fR(7),
\fBgsettings\fR(1),
\fBdconf-editor\fR(1)