← Back to branch summary

~seb128/unity-settings-daemon/battery-info-key

« back to all changes in this revision

Viewing changes to man/gnome-settings-daemon.xml

  • Committer: Matthias Clasen
  • Date: 2012-08-08 01:59:37 UTC
  • Revision ID: git-v1:fe46c6253471854e09b2e07fd3569d5c1814c226
Add a man page

The main purpose of this man page is to document how
gnome-settings-daemon gets started and to give some hints
about debugging problems with it.

https://bugzilla.gnome.org/show_bug.cgi?id=680600

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/gnome-settings-daemon.xml
 
1
<?xml version='1.0'?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 
3
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
4
 
 
5
<refentry id="gnome-settings-daemon">
 
6
 
 
7
        <refentryinfo>
 
8
                <title>gnome-settings-daemon</title>
 
9
                <productname>GNOME</productname>
 
10
 
 
11
                <authorgroup>
 
12
                        <author>
 
13
                                <contrib>Maintainer</contrib>
 
14
                                <firstname>Bastien</firstname>
 
15
                                <surname>Nocera</surname>
 
16
                                <email>hadess@hadess.net</email>
 
17
                        </author>
 
18
                </authorgroup>
 
19
 
 
20
        </refentryinfo>
 
21
 
 
22
        <refmeta>
 
23
                <refentrytitle>gnome-settings-daemon</refentrytitle>
 
24
                <manvolnum>1</manvolnum>
 
25
                <refmiscinfo class="manual">User Commands</refmiscinfo>
 
26
        </refmeta>
 
27
 
 
28
        <refnamediv>
 
29
                <refname>gnome-settings-daemon</refname>
 
30
                <refpurpose>GNOME settings daemon</refpurpose>
 
31
        </refnamediv>
 
32
 
 
33
        <refsynopsisdiv>
 
34
                <cmdsynopsis>
 
35
                        <command>gnome-settings-daemon <arg choice="opt" rep="repeat">OPTION</arg></command>
 
36
                </cmdsynopsis>
 
37
        </refsynopsisdiv>
 
38
 
 
39
        <refsect1>
 
40
                <title>Description</title>
 
41
 
 
42
                <para><command>gnome-settings-daemon</command> provides many
 
43
                session-wide services and functions that require a
 
44
                long-running process.
 
45
                Among the services implemented by gnome-settings-daemon
 
46
                are an XSettings manager, which provides theming, font
 
47
                and other settings to GTK+ applications, and a clipboard
 
48
                manager, which preserves clipboard contents when an
 
49
                application exits.
 
50
                Many user interface elements of
 
51
                <command>gnome-shell</command> and
 
52
                <command>gnome-control-center</command> rely on
 
53
                gnome-settings-daemon for their functionality.
 
54
                </para>
 
55
 
 
56
                <para>The internal architecture of gnome-settings-daemon
 
57
                consists of a number of plugins, which provide functionality
 
58
                such as printer notifications, software update monitoring,
 
59
                background changing, etc. For debugging purposes, these
 
60
                plugins can be individually disabled by changing the
 
61
                gsettings key <literal>org.gnome.settings-daemon.plugins.<replaceable>plugin-name</replaceable>.active</literal>, where
 
62
                <replaceable>plugin-name</replaceable> is
 
63
                the name of the plugin. To see a list of all plugins,
 
64
                use the command
 
65
                <userinput>
 
66
                gsettings list-children org.gnome.settings-daemon.plugins
 
67
                </userinput>
 
68
                </para>
 
69
 
 
70
                <para>gnome-settings-daemon takes the name
 
71
                org.gnome.SettingsDaemon on the session bus to ensure
 
72
                that only one instance is running. Some plugins export
 
73
                objects under this name to make their functionality
 
74
                available to other applications. The interfaces of
 
75
                these objects should generally be considered private
 
76
                and unstable.</para>
 
77
 
 
78
                <para>gnome-settings-daemon is a required component of
 
79
                the GNOME desktop, i.e. it is listed in the
 
80
                RequiredComponents field of
 
81
                <filename>/usr/share/gnome-session/sessions/gnome.session</filename>.
 
82
                It is started in the initialization phase of the session,
 
83
                and <command>gnome-session</command> will restart it
 
84
                if it crashes.
 
85
                </para>
 
86
 
 
87
        </refsect1>
 
88
 
 
89
        <refsect1>
 
90
                <title>Options</title>
 
91
 
 
92
                <variablelist>
 
93
                        <varlistentry>
 
94
                                <term><option>-h</option>, <option>--help</option></term>
 
95
 
 
96
                                <listitem><para>Prints a short help
 
97
                                text and exits.</para></listitem>
 
98
                        </varlistentry>
 
99
 
 
100
                        <varlistentry>
 
101
                                <term><option>--debug</option></term>
 
102
 
 
103
                                <listitem><para>Enables debugging code.</para></listitem>
 
104
                        </varlistentry>
 
105
 
 
106
                        <varlistentry>
 
107
                                <term><option>--timed-exit</option></term>
 
108
 
 
109
                                <listitem><para>Exits after a timeout (30 seconds) for debugging.</para></listitem>
 
110
                        </varlistentry>
 
111
 
 
112
                </variablelist>
 
113
        </refsect1>
 
114
 
 
115
        <refsect1>
 
116
                <title>Files</title>
 
117
                <variablelist>
 
118
                        <varlistentry>
 
119
                                <term><filename>/usr/share/gnome-session/sessions/gnome.session</filename></term>
 
120
 
 
121
                                <listitem><para>GNOME session definition file where gnome-settings-daemon is listed as a required component.</para></listitem>
 
122
                        </varlistentry>
 
123
                        <varlistentry>
 
124
                                <term><filename>/etc/xdg/autostart/gnome-settings-daemon.desktop</filename></term>
 
125
 
 
126
                                <listitem><para>Autostart file for gnome-settings-daemon, where its autostart phase is set.</para></listitem>
 
127
                        </varlistentry>
 
128
                </variablelist>
 
129
        </refsect1>
 
130
 
 
131
        <refsect1>
 
132
                <title>See Also</title>
 
133
                <para>
 
134
                        <citerefentry><refentrytitle>gnome-shell</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 
135
                        <citerefentry><refentrytitle>gnome-control-center</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 
136
                        <citerefentry><refentrytitle>gnome-session</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 
137
                </para>
 
138
        </refsect1>
 
139
 
 
140
</refentry>