diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2012-07-25 10:43:44 +0200 |
|---|---|---|
| committer | Ryan Lortie <desrt@desrt.ca> | 2012-08-07 10:37:14 -0400 |
| commit | 8d600672d9d2b1be6de69f02ecaa98587633d2bb (patch) | |
| tree | 42839df8bef32735d0963f1ed9cfeea3812d08f2 /docs/dconf-service.xml | |
| parent | b5de278590da16e13b1b8a53e0fee2e57b017d54 (diff) | |
| download | dconf-8d600672d9d2b1be6de69f02ecaa98587633d2bb.tar.gz | |
Add man pages
It is a nice thing if one can learn something about the running
processes by looking up their man pages. This commit adds man pages
for dconf-service, dconf-editor and the dconf utility in section 1.
It also adds an overview man page in section 7. The contents of
the overview are mostly taken from the current README. All these
man pages are also included in the API docs, in a 'Programs'
section.
https://bugzilla.gnome.org/show_bug.cgi?id=680602
Diffstat (limited to 'docs/dconf-service.xml')
| -rw-r--r-- | docs/dconf-service.xml | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/dconf-service.xml b/docs/dconf-service.xml new file mode 100644 index 0000000..507c14d --- /dev/null +++ b/docs/dconf-service.xml @@ -0,0 +1,63 @@ +<?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-service"> + <refentryinfo> + <title>dconf-service</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-service</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User Commands</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>dconf-service</refname> + <refpurpose>D-Bus service for writes to the dconf database</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>dconf-service</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + The <command>dconf-service</command> program provides the <emphasis>ca.desrt.dconf</emphasis> name on the + session or system bus. Users or administrators should never need to start the service, as it will be + automatically started by + <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry> + whenever an application tries to write settings. + </para> + + <para> + Reading values from the dconf database does not involve the service; it is only needed for writes. The + service is stateless and can exit freely at any time (and is therefore robust against crashes). + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>dconf</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> |