~vcs-imports/gnome-control-center/trunk

« back to all changes in this revision

Viewing changes to man/gnome-control-center.xml

  • Committer: Matthias Clasen
  • Date: 2012-08-04 16:54:49 UTC
  • Revision ID: git-v1:dfede0780038d6aae840ef059c6efff0060876d4
Add a man page

The main purpose of this man page is to document which options
can be given to individual panels.

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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-control-center">
 
6
 
 
7
        <refentryinfo>
 
8
                <title>gnome-control-center</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-control-center</refentrytitle>
 
24
                <manvolnum>1</manvolnum>
 
25
                <refmiscinfo class="manual">User Commands</refmiscinfo>
 
26
        </refmeta>
 
27
 
 
28
        <refnamediv>
 
29
                <refname>gnome-control-center</refname>
 
30
                <refpurpose>Configure GNOME settings</refpurpose>
 
31
        </refnamediv>
 
32
 
 
33
        <refsynopsisdiv>
 
34
                <cmdsynopsis>
 
35
                        <command>gnome-control-center <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt">PANEL</arg> <arg choice="opt" rep="repeat">ARG</arg></command>
 
36
                </cmdsynopsis>
 
37
        </refsynopsisdiv>
 
38
 
 
39
        <refsect1>
 
40
                <title>Description</title>
 
41
 
 
42
                <para><command>gnome-control-center</command> is a graphical
 
43
                user interface to configure various aspects of GNOME.</para>
 
44
 
 
45
                <para>When run without arguments, the shell displays the
 
46
                <firstterm>overview</firstterm>, which shows all available
 
47
                configuration panels. The overview allows to open individual
 
48
                panels by clicking on them. It also has a search entry
 
49
                to find panels by searching keywords.</para>
 
50
 
 
51
                <para>It is also possible to specify a panel name
 
52
                as commandline argument to go directly to that panel.
 
53
                Individual panels may accept further arguments to specify
 
54
                which tab to open (for multi-tabbed panels) or which
 
55
                item to display (for panels with lists).</para>
 
56
 
 
57
                <para>Note that <command>gnome-control-center</command>
 
58
                is not meant to expose each and every setting that is
 
59
                available. The settings that can be found here represent
 
60
                what is considered useful and commonly needed options.
 
61
                For more exotic or uncommon options, you can look at
 
62
                <command>gnome-tweak-tool</command> or the
 
63
                <command>gsettings</command> commandline utility.</para>
 
64
        </refsect1>
 
65
 
 
66
        <refsect1>
 
67
                <title>Panels</title>
 
68
 
 
69
                <para>The following panel names can be specified:</para>
 
70
 
 
71
                <variablelist>
 
72
                        <varlistentry>
 
73
                                <term><option>background</option></term>
 
74
 
 
75
                                <listitem><para>The background panel lets you
 
76
                                set your desktop background.</para></listitem>
 
77
                        </varlistentry>
 
78
 
 
79
                        <varlistentry>
 
80
                                <term><option>bluetooth</option></term>
 
81
 
 
82
                                <listitem><para>The bluetooth panel lets you
 
83
                                configure your computer's Bluetooth adapter,
 
84
                                and pair the computer with Bluetooth keyboards,
 
85
                                phones, etc.</para></listitem>
 
86
                        </varlistentry>
 
87
 
 
88
                        <varlistentry>
 
89
                                <term><option>color</option></term>
 
90
 
 
91
                                <listitem><para>The color panel can calibrate
 
92
                                monitors, web cams and printers for accurate
 
93
                                color reproduction.</para></listitem>
 
94
                        </varlistentry>
 
95
 
 
96
                        <varlistentry>
 
97
                                <term><option>datetime</option></term>
 
98
 
 
99
                                <listitem><para>The datetime panel lets you
 
100
                                set the timezone and time format.</para>
 
101
                                <para>Some operations in this panel
 
102
                                affect all user accounts on the computer
 
103
                                and require privieges.</para></listitem>
 
104
                        </varlistentry>
 
105
 
 
106
                        <varlistentry>
 
107
                                <term><option>display</option></term>
 
108
 
 
109
                                <listitem><para>The display panel configures
 
110
                                the resolution and arrangement of monitors
 
111
                                and laptop panels. Note that monitors can be
 
112
                                rearranged by drag-and-drop, and you can change
 
113
                                which monitor is your main display by dragging
 
114
                                the black bar.</para></listitem>
 
115
                        </varlistentry>
 
116
 
 
117
                        <varlistentry>
 
118
                                <term><option>info</option></term>
 
119
 
 
120
                                <listitem><para>The info panel shows a general
 
121
                                overview of the system configuration. It also
 
122
                                lets you change the default applications for
 
123
                                various tasks and the handling of removable
 
124
                                media.</para></listitem>
 
125
                        </varlistentry>
 
126
 
 
127
                        <varlistentry>
 
128
                                <term><option>keyboard</option></term>
 
129
 
 
130
                                <listitem><para>The keyboard panel can
 
131
                                change how the keyboard reacts to key
 
132
                                presses and lets you change keyboard
 
133
                                shortcuts or create custom shortcuts.</para>
 
134
                                <para>You can open this panel on a
 
135
                                specific tab by passing <option>typing</option>
 
136
                                or <option>shortcuts</option> as extra
 
137
                                argument.</para></listitem>
 
138
                        </varlistentry>
 
139
 
 
140
                        <varlistentry>
 
141
                                <term><option>mouse</option></term>
 
142
 
 
143
                                <listitem><para>The mouse panel can change
 
144
                                how mice and touchpads react to user
 
145
                                input.</para></listitem>
 
146
                        </varlistentry>
 
147
 
 
148
                        <varlistentry>
 
149
                                <term><option>network</option></term>
 
150
 
 
151
                                <listitem><para>The network panel provides
 
152
                                a view of available network devices (wired,
 
153
                                wireless or mobile) and their current
 
154
                                configuration. It also provides a way to
 
155
                                create new VPN connections and configure
 
156
                                proxy settings.</para></listitem>
 
157
                        </varlistentry>
 
158
 
 
159
                        <varlistentry>
 
160
                                <term><option>online-accounts</option></term>
 
161
 
 
162
                                <listitem><para>The online-accounts panel
 
163
                                shows your configured online accounts and
 
164
                                lets you add or remove accounts.</para></listitem>
 
165
                        </varlistentry>
 
166
 
 
167
                        <varlistentry>
 
168
                                <term><option>power</option></term>
 
169
 
 
170
                                <listitem><para>The power panel shows
 
171
                                the fill level of batteries and can
 
172
                                configure what happens when the computer
 
173
                                is idle or runs out of battery.</para></listitem>
 
174
                        </varlistentry>
 
175
 
 
176
                        <varlistentry>
 
177
                                <term><option>printers</option></term>
 
178
 
 
179
                                <listitem><para>The printers panel shows
 
180
                                all known printers and their status. It is
 
181
                                possible to inspect queued print jobs and
 
182
                                add new printers.</para>
 
183
                                <para>Some operations in this panel require
 
184
                                privileges.</para></listitem>
 
185
                        </varlistentry>
 
186
 
 
187
                        <varlistentry>
 
188
                                <term><option>region</option></term>
 
189
 
 
190
                                <listitem><para>The region panel
 
191
                                contains regional settings such as
 
192
                                the display language, formatting for
 
193
                                times, dates, numbers, and input sources.</para>
 
194
                                <para>You can open this panel on a
 
195
                                specific tab by passing
 
196
                                <option>language</option>,
 
197
                                <option>formats</option>,
 
198
                                <option>layouts</option> or
 
199
                                <option>system</option> as extra
 
200
                                argument.</para></listitem>
 
201
                        </varlistentry>
 
202
 
 
203
                        <varlistentry>
 
204
                                <term><option>screen</option></term>
 
205
 
 
206
                                <listitem><para>The screen panel contains
 
207
                                settings that control the screen brightness
 
208
                                and screen lock behavior.</para></listitem>
 
209
                        </varlistentry>
 
210
 
 
211
                        <varlistentry>
 
212
                                <term><option>sound</option></term>
 
213
 
 
214
                                <listitem><para>The sound panel shows
 
215
                                all known sound devices and their configuration,
 
216
                                including volume and balance settings.</para>
 
217
                                <para>You can open this panel on a
 
218
                                specific tab by passing
 
219
                                <option>output</option>,
 
220
                                <option>input</option>,
 
221
                                <option>hardware</option>,
 
222
                                <option>effects</option> or
 
223
                                <option>applications</option> as extra
 
224
                                argument.</para></listitem>
 
225
                        </varlistentry>
 
226
 
 
227
                        <varlistentry>
 
228
                                <term><option>universal-access</option></term>
 
229
 
 
230
                                <listitem><para>The universal-access panel
 
231
                                contains settings for accessible technologies
 
232
                                such as the screen reader, magnifier, screen
 
233
                                keyboard and AccessX options.</para></listitem>
 
234
                        </varlistentry>
 
235
 
 
236
                        <varlistentry>
 
237
                                <term><option>user-accounts</option></term>
 
238
 
 
239
                                <listitem><para>The user-accounts panel
 
240
                                shows all user accounts that exist on the
 
241
                                computer and allows to change them in some
 
242
                                ways, such as changing the user name, password
 
243
                                or permissions. It also allows to create
 
244
                                or remove accounts.</para>
 
245
                                <para>Some operations in this panel require
 
246
                                privileges.</para></listitem>
 
247
                        </varlistentry>
 
248
 
 
249
                        <varlistentry>
 
250
                                <term><option>wacom</option></term>
 
251
 
 
252
                                <listitem><para>the wacom panel shows
 
253
                                connected Wacom graphics tablets and lets
 
254
                                you calibrate and configure such devices.</para></listitem>
 
255
                        </varlistentry>
 
256
 
 
257
                </variablelist>
 
258
 
 
259
        </refsect1>
 
260
 
 
261
        <refsect1>
 
262
                <title>Options</title>
 
263
 
 
264
                <variablelist>
 
265
                        <varlistentry>
 
266
                                <term><option>-?</option>, <option>--help</option></term>
 
267
 
 
268
                                <listitem><para>Prints a short help
 
269
                                text and exits.</para></listitem>
 
270
                        </varlistentry>
 
271
 
 
272
                        <varlistentry>
 
273
                                <term><option>--version</option></term>
 
274
 
 
275
                                <listitem><para>Prints the program version
 
276
                                and exits.</para></listitem>
 
277
                        </varlistentry>
 
278
 
 
279
                        <varlistentry>
 
280
                                <term><option>-v</option>, <option>--verbose</option></term>
 
281
 
 
282
                                <listitem><para>Enables verbose mode.</para></listitem>
 
283
                        </varlistentry>
 
284
 
 
285
                        <varlistentry>
 
286
                                <term><option>-o</option>, <option>--overview</option></term>
 
287
 
 
288
                                <listitem><para>Opens the overview.</para></listitem>
 
289
                        </varlistentry>
 
290
 
 
291
                </variablelist>
 
292
        </refsect1>
 
293
 
 
294
        <refsect1>
 
295
                <title>Exit status</title>
 
296
 
 
297
                <para>On success 0 is returned, a non-zero failure
 
298
                code otherwise.</para>
 
299
        </refsect1>
 
300
 
 
301
        <refsect1>
 
302
                <title>See Also</title>
 
303
                <para>
 
304
                        <citerefentry><refentrytitle>gsettings</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 
305
                </para>
 
306
        </refsect1>
 
307
 
 
308
</refentry>