blob: 255d712e3491cb45b2723de6c1abdd3038dfed19 (
plain)
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
|
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl"
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="xdg-settings">
<refentryinfo>
<title>xdg-settings Manual</title>
<copyright>
<year>2009-2011</year>
</copyright>
<author>
<firstname>Mike</firstname>
<surname>Mammarella</surname>
</author>
<address><email>mdm@google.com</email></address>
<releaseinfo>xdg-utils 1.1.0</releaseinfo>
</refentryinfo>
<refmeta>
<refentrytitle>xdg-settings</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-settings</refname>
<refpurpose>get various settings from the desktop environment</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-settings</command>
<group choice="req">
<arg choice="plain"><option><replaceable>get</replaceable></option></arg>
<arg choice="plain"><option><replaceable>check</replaceable></option></arg>
<arg choice="plain"><option><replaceable>set</replaceable></option></arg>
</group>
<group choice="req">
<option>property</option>
</group>
<group choice="opt">
<option>subproperty</option>
</group>
<group choice="opt">
<option>value</option>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>xdg-settings</command>
<group choice="req">
<arg choice="plain"><option>--help</option></arg>
<arg choice="plain"><option>--list</option></arg>
<arg choice="plain"><option>--manual</option></arg>
<arg choice="plain"><option>--version</option></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para>
xdg-settings gets various settings from the desktop environment.
For instance, desktop environments often provide proxy configuration
and default web browser settings. Using xdg-settings these parameters
can be extracted for use by applications that do not use the desktop
environment's libraries (which would use the settings natively).
</para>
<para>
xdg-settings is for use inside a desktop session only.
It is not recommended to use xdg-settings as root.
</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<simpara>
Show command synopsis.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--list</option></term>
<listitem>
<simpara>
List all properties xdg-settings knows about.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--manual</option></term>
<listitem>
<simpara>
Show this manual page.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<simpara>
Show the xdg-utils version information.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="properties">
<title>Properties</title>
<para>
When using xdg-settings to get, check or set a desktop setting, properties
and possibly sub-properties are used to specify the setting to be changed.
</para>
<para>
Some properties (such as default-web-browser) fully describe the setting
to be changed. Other properties (such as default-url-scheme-handler) require
more information (in this case the actual scheme to set the default handler
for) which must be provided in a sub-property.
</para>
</refsect1>
<refsect1 id="exitcodes">
<title>Exit Codes</title>
<para>
An exit code of 0 indicates success while a non-zero exit code
indicates failure. The following failure codes can be returned:
</para>
<variablelist>
<varlistentry>
<term><option>1</option></term>
<listitem>
<simpara>
Error in command line syntax.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>2</option></term>
<listitem>
<simpara>
One of the files passed on the command line did not exist.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>3</option></term>
<listitem>
<simpara>
A required tool could not be found.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><option>4</option></term>
<listitem>
<simpara>
The action failed.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="seealso">
<title>See Also</title>
<para><citerefentry><refentrytitle>xdg-mime</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry><refentrytitle>xdg-open</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<ulink url="http://www.freedesktop.org/wiki/Specifications/mime-apps-spec/">MIME applications associations specification</ulink>
</para>
</refsect1>
<refsect1 id="examples">
<title>Examples</title>
<para>
Get the desktop file name of the current default web browser
<programlisting>
xdg-settings get default-web-browser
</programlisting>
</para>
<para>
Check whether the default web browser is firefox.desktop, which can be
false even if "get default-web-browser" says that is the current value
(if only some of the underlying settings actually reflect that value)
<programlisting>
xdg-settings check default-web-browser firefox.desktop
</programlisting>
</para>
<para>
Set the default web browser to google-chrome.desktop
<programlisting>
xdg-settings set default-web-browser google-chrome.desktop
</programlisting>
</para>
<para>
Set the default mailto URL scheme handler to be evolution.desktop
<programlisting>
xdg-settings set default-url-scheme-handler mailto evolution.desktop
</programlisting>
</para>
</refsect1>
</refentry>
|
