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-su"> |
| 8 <refentryinfo> |
| 9 <title>xdg-su Manual</title> |
| 10 <copyright> |
| 11 <year>2006</year> |
| 12 </copyright> |
| 13 <author> |
| 14 <firstname>Kevin</firstname> |
| 15 <surname>Krammer</surname> |
| 16 </author> |
| 17 <address><email>kevin.krammer@gmx.at</email></address> |
| 18 <author> |
| 19 <firstname>Jeremy</firstname> |
| 20 <surname>White</surname> |
| 21 </author> |
| 22 <address><email>jwhite@codeweavers.com</email></address> |
| 23 <releaseinfo>This is release 0.5 of the xdg-su Manual.</releaseinfo> |
| 24 </refentryinfo> |
| 25 |
| 26 <refmeta> |
| 27 <refentrytitle>xdg-su</refentrytitle> |
| 28 <manvolnum>1</manvolnum> |
| 29 </refmeta> |
| 30 |
| 31 <refnamediv> |
| 32 <refname>xdg-su</refname> |
| 33 <refpurpose>run a GUI program as root after prompting for the root password<
/refpurpose> |
| 34 </refnamediv> |
| 35 |
| 36 <refsynopsisdiv> |
| 37 <cmdsynopsis> |
| 38 <command>xdg-su</command> |
| 39 <arg><option>-u <replaceable>user</replaceable></option></arg> |
| 40 <arg choice="plain"><option>-c <replaceable>command</replaceable></option>
</arg> |
| 41 </cmdsynopsis> |
| 42 <cmdsynopsis> |
| 43 <command>xdg-su</command> |
| 44 <group choice="req"> |
| 45 <arg choice="plain"><option>--help</option></arg> |
| 46 <arg choice="plain"><option>--manual</option></arg> |
| 47 <arg choice="plain"><option>--version</option></arg> |
| 48 </group> |
| 49 </cmdsynopsis> |
| 50 </refsynopsisdiv> |
| 51 |
| 52 <refsect1 id="description"> |
| 53 <title>Description</title> |
| 54 <para> |
| 55 xdg-su provides a graphical dialog that prompts the user for a password |
| 56 to run <replaceable>command</replaceable> as <replaceable>user</replaceabl
e> |
| 57 or as root if no user was specified. |
| 58 </para> |
| 59 <para> |
| 60 xdg-su is for use inside a desktop session only. |
| 61 </para> |
| 62 <para> |
| 63 xdg-su discards any stdout and stderr output from |
| 64 <replaceable>command</replaceable>. |
| 65 </para> |
| 66 </refsect1> |
| 67 <refsect1 id="options"> |
| 68 <title>Options</title> |
| 69 <variablelist> |
| 70 <varlistentry> |
| 71 <term><option>-u <replaceable>user</replaceable></option></term> |
| 72 <listitem> |
| 73 <simpara> |
| 74 run <replaceable>command</replaceable> as |
| 75 <replaceable>user</replaceable>. The default is to run as root. |
| 76 </simpara> |
| 77 </listitem> |
| 78 </varlistentry> |
| 79 |
| 80 <varlistentry> |
| 81 <term><option>--help</option></term> |
| 82 <listitem> |
| 83 <simpara> |
| 84 Show command synopsis. |
| 85 </simpara> |
| 86 </listitem> |
| 87 </varlistentry> |
| 88 |
| 89 <varlistentry> |
| 90 <term><option>--manual</option></term> |
| 91 <listitem> |
| 92 <simpara> |
| 93 Show this manualpage. |
| 94 </simpara> |
| 95 </listitem> |
| 96 </varlistentry> |
| 97 |
| 98 <varlistentry> |
| 99 <term><option>--version</option></term> |
| 100 <listitem> |
| 101 <simpara> |
| 102 Show the xdg-utils version information. |
| 103 </simpara> |
| 104 </listitem> |
| 105 </varlistentry> |
| 106 |
| 107 </variablelist> |
| 108 </refsect1> |
| 109 <refsect1 id="exitcodes"> |
| 110 <title>Exit Codes</title> |
| 111 <para> |
| 112 An exit code of 0 indicates success while a non-zero exit code |
| 113 indicates failure. The following failure codes can be returned: |
| 114 </para> |
| 115 <variablelist> |
| 116 <varlistentry> |
| 117 <term><option>1</option></term> |
| 118 <listitem> |
| 119 <simpara> |
| 120 Error in command line syntax. |
| 121 </simpara> |
| 122 </listitem> |
| 123 </varlistentry> |
| 124 <varlistentry> |
| 125 <term><option>2</option></term> |
| 126 <listitem> |
| 127 <simpara> |
| 128 One of the files passed on the command line did not exist. |
| 129 </simpara> |
| 130 </listitem> |
| 131 </varlistentry> |
| 132 <varlistentry> |
| 133 <term><option>3</option></term> |
| 134 <listitem> |
| 135 <simpara> |
| 136 A required tool could not be found. |
| 137 </simpara> |
| 138 </listitem> |
| 139 </varlistentry> |
| 140 <varlistentry> |
| 141 <term><option>4</option></term> |
| 142 <listitem> |
| 143 <simpara> |
| 144 The action failed. |
| 145 </simpara> |
| 146 </listitem> |
| 147 </varlistentry> |
| 148 </variablelist> |
| 149 </refsect1> |
| 150 <refsect1 id="seealso"> |
| 151 <title>See Also</title> |
| 152 <para><citerefentry><refentrytitle>su</refentrytitle> |
| 153 <manvolnum>1</manvolnum> |
| 154 </citerefentry> |
| 155 </para> |
| 156 </refsect1> |
| 157 <refsect1 id="examples"> |
| 158 <title>Examples</title> |
| 159 <para> |
| 160 <programlisting> |
| 161 xdg-su -u root -c "/opt/shinythings/bin/install-GUI --install fast" |
| 162 </programlisting> |
| 163 Runs the /opt/shinythings/bin/install-GUI command with root permissions. |
| 164 </para> |
| 165 </refsect1> |
| 166 </refentry> |
OLD | NEW |