| OLD | NEW |
| (Empty) | |
| 1 <?xml version="1.0"?> |
| 2 <?xml-stylesheet type="text/xsl" |
| 3 href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
"?> |
| 4 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
| 5 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
| 6 ]> |
| 7 <refentry id="xdg-settings"> |
| 8 <refentryinfo> |
| 9 <title>xdg-settings Manual</title> |
| 10 <copyright> |
| 11 <year>2009</year> |
| 12 </copyright> |
| 13 <author> |
| 14 <firstname>Mike</firstname> |
| 15 <surname>Mammarella</surname> |
| 16 </author> |
| 17 <address><email>mdm@google.com</email></address> |
| 18 <!--<releaseinfo>xdg-utils 1.0</releaseinfo>--> |
| 19 </refentryinfo> |
| 20 |
| 21 <refmeta> |
| 22 <refentrytitle>xdg-settings</refentrytitle> |
| 23 <manvolnum>1</manvolnum> |
| 24 </refmeta> |
| 25 |
| 26 <refnamediv> |
| 27 <refname>xdg-settings</refname> |
| 28 <refpurpose>get various settings from the desktop environment</refpurpose> |
| 29 </refnamediv> |
| 30 |
| 31 <refsynopsisdiv> |
| 32 <cmdsynopsis> |
| 33 <command>xdg-settings</command> |
| 34 <group choice="req"> |
| 35 <arg choice="plain"><option><replaceable>get</replaceable></option></arg
> |
| 36 <arg choice="plain"><option><replaceable>set</replaceable></option></arg
> |
| 37 </group> |
| 38 <group choice="req"> |
| 39 <option>property</option> |
| 40 </group> |
| 41 <group choice="opt"> |
| 42 <option>value</option> |
| 43 </group> |
| 44 </cmdsynopsis> |
| 45 <cmdsynopsis> |
| 46 <command>xdg-settings</command> |
| 47 <group choice="req"> |
| 48 <arg choice="plain"><option>--help</option></arg> |
| 49 <arg choice="plain"><option>--list</option></arg> |
| 50 <arg choice="plain"><option>--manual</option></arg> |
| 51 <arg choice="plain"><option>--version</option></arg> |
| 52 </group> |
| 53 </cmdsynopsis> |
| 54 </refsynopsisdiv> |
| 55 |
| 56 <refsect1 id="description"> |
| 57 <title>Description</title> |
| 58 <para> |
| 59 xdg-settings gets various settings from the desktop environment. |
| 60 For instance, desktop environments often provide proxy configuration |
| 61 and default web browser settings. Using xdg-settings these parameters |
| 62 can be extracted for use by applications that do not use the desktop |
| 63 environment's libraries (which would use the settings natively). |
| 64 </para> |
| 65 <para> |
| 66 xdg-settings is for use inside a desktop session only. |
| 67 It is not recommended to use xdg-settings as root. |
| 68 </para> |
| 69 </refsect1> |
| 70 <refsect1 id="options"> |
| 71 <title>Options</title> |
| 72 <variablelist> |
| 73 <varlistentry> |
| 74 <term><option>--help</option></term> |
| 75 <listitem> |
| 76 <simpara> |
| 77 Show command synopsis. |
| 78 </simpara> |
| 79 </listitem> |
| 80 </varlistentry> |
| 81 |
| 82 <varlistentry> |
| 83 <term><option>--list</option></term> |
| 84 <listitem> |
| 85 <simpara> |
| 86 List all properties xdg-settings knows about. |
| 87 </simpara> |
| 88 </listitem> |
| 89 </varlistentry> |
| 90 |
| 91 <varlistentry> |
| 92 <term><option>--manual</option></term> |
| 93 <listitem> |
| 94 <simpara> |
| 95 Show this manualpage. |
| 96 </simpara> |
| 97 </listitem> |
| 98 </varlistentry> |
| 99 |
| 100 <varlistentry> |
| 101 <term><option>--version</option></term> |
| 102 <listitem> |
| 103 <simpara> |
| 104 Show the xdg-utils version information. |
| 105 </simpara> |
| 106 </listitem> |
| 107 </varlistentry> |
| 108 </variablelist> |
| 109 </refsect1> |
| 110 <refsect1 id="exitcodes"> |
| 111 <title>Exit Codes</title> |
| 112 <para> |
| 113 An exit code of 0 indicates success while a non-zero exit code |
| 114 indicates failure. The following failure codes can be returned: |
| 115 </para> |
| 116 <variablelist> |
| 117 <varlistentry> |
| 118 <term><option>1</option></term> |
| 119 <listitem> |
| 120 <simpara> |
| 121 Error in command line syntax. |
| 122 </simpara> |
| 123 </listitem> |
| 124 </varlistentry> |
| 125 <varlistentry> |
| 126 <term><option>2</option></term> |
| 127 <listitem> |
| 128 <simpara> |
| 129 One of the files passed on the command line did not exist. |
| 130 </simpara> |
| 131 </listitem> |
| 132 </varlistentry> |
| 133 <varlistentry> |
| 134 <term><option>3</option></term> |
| 135 <listitem> |
| 136 <simpara> |
| 137 A required tool could not be found. |
| 138 </simpara> |
| 139 </listitem> |
| 140 </varlistentry> |
| 141 <varlistentry> |
| 142 <term><option>4</option></term> |
| 143 <listitem> |
| 144 <simpara> |
| 145 The action failed. |
| 146 </simpara> |
| 147 </listitem> |
| 148 </varlistentry> |
| 149 </variablelist> |
| 150 </refsect1> |
| 151 <refsect1 id="examples"> |
| 152 <title>Examples</title> |
| 153 <para> |
| 154 <programlisting> |
| 155 xdg-settings get default-web-browser |
| 156 </programlisting> |
| 157 Gets the desktop file name of the current default web browser |
| 158 </para> |
| 159 <para> |
| 160 <programlisting> |
| 161 xdg-settings set default-web-browser google-chrome.desktop |
| 162 </programlisting> |
| 163 Sets the default web browser to google-chrome.desktop |
| 164 </para> |
| 165 </refsect1> |
| 166 </refentry> |
| OLD | NEW |