Warning, /plasma/kde-cli-tools/doc/kdesu/man-kdesu.1.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY % English "INCLUDE">
0004 ]>
0005 
0006 <refentry lang="&language;">
0007 <refentryinfo>
0008 <title>KDE User's Manual</title>
0009 <author>&Lauri.Watts; &Lauri.Watts.mail;</author>
0010 <date>2010-09-18</date>
0011 <productname>K Desktop Environment</productname>
0012 </refentryinfo>
0013 
0014 <refmeta>
0015 <refentrytitle><command>kdesu</command></refentrytitle>
0016 <manvolnum>1</manvolnum>
0017 </refmeta>
0018 
0019 <refnamediv>
0020 <refname><command>kdesu</command></refname>
0021 <refpurpose>Runs a program with elevated privileges</refpurpose>
0022 </refnamediv>
0023 
0024 <refsynopsisdiv>
0025 <cmdsynopsis>
0026 <command>kdesu</command>
0027 
0028 <group choice="opt"><option>-c</option> <replaceable> command</replaceable></group>
0029 <group choice="opt"><option>-d</option></group>
0030 <group choice="opt"><option>-f</option> <replaceable> file</replaceable></group>
0031 <group choice="opt"><option>-i</option> <replaceable> icon name</replaceable></group>
0032 <group choice="opt"><option>-n</option></group>
0033 <group choice="opt"><option>-p</option> <replaceable> priority</replaceable></group>
0034 <group choice="opt"><option>-r</option></group>
0035 <group choice="opt"><option>-s</option></group>
0036 <group choice="opt"><option>-t</option></group>
0037 <group choice="opt"><option>-u</option> <replaceable> user</replaceable></group>
0038 <group choice="opt"><option>--noignorebutton</option></group>
0039 <group choice="opt"><option>--attach</option> <replaceable> winid</replaceable></group>
0040 <!--group choice="opt"><option>- -nonewdcop</option></group>
0041 
0042 <group><arg choice="req"><replaceable>command</replaceable> <arg><replaceable>arg1</replaceable></arg>
0043           <arg><replaceable>arg2</replaceable></arg>
0044           <arg rep="repeat"><replaceable></replaceable></arg></arg></group-->
0045 </cmdsynopsis>
0046 <cmdsynopsis>
0047 <command>kdesu</command>
0048 <arg choice="opt">&kde; Generic Options</arg>
0049 <arg choice="opt">&Qt; Generic Options</arg>
0050 </cmdsynopsis>
0051 </refsynopsisdiv>
0052 
0053 <refsect1>
0054 <title>Description</title>
0055 <para>&kdesu; is a graphical front end for the
0056 &UNIX; <command>su</command> command for the K Desktop Environment.
0057 It allows you to run a program as different user by supplying the
0058 password for that user. &kdesu; is an unprivileged program; it uses
0059 the system's <command>su</command>.</para>
0060 
0061 <para>&kdesu; has one additional feature: it can optionally remember passwords
0062 for you. If you are using this feature, you only need to enter the
0063 password once for each command.</para>
0064 
0065 <para>This program is meant to be started from the command line or
0066 from <filename>.desktop</filename> files.</para>
0067 
0068 <para>Since <command>kdesu</command> is no longer installed in <userinput>
0069 $(kf5-config --prefix)</userinput>/bin but in <userinput>kf5-config --path libexec</userinput>
0070 and therefore not in your <envar>Path</envar>, you have to use <userinput>$(kf5-config
0071 --path libexec)<command>kdesu</command></userinput> to launch <command>kdesu</command>.</para>
0072 </refsect1>
0073 
0074 <refsect1>
0075 <title>Options</title>
0076 
0077 <variablelist>
0078 <varlistentry>
0079 <term><option>-c <replaceable>command</replaceable></option></term>
0080 <listitem><para>This specifies the command to run as root. It has to be passed
0081 in one argument. So if, for example, you want to start a new file manager, you
0082 would enter at the prompt: <userinput>$(kf5-config --path libexec)<command>kdesu <option>-c <replaceable>
0083 &dolphin;</replaceable></option></command></userinput></para></listitem>
0084 </varlistentry>
0085 <varlistentry>
0086 <term><option>-d</option></term>
0087 <listitem><para>Show debug information.</para></listitem>
0088 </varlistentry>
0089 <varlistentry>
0090 <term><option>-f <replaceable>file</replaceable></option></term>
0091 <listitem><para>This option allow efficient use of &kdesu; in
0092 <filename>.desktop</filename> files. It tells &kdesu; to examine the
0093 file specified by <parameter>file</parameter>. If this file is
0094 writable by the current user, &kdesu; will execute the command as the
0095 current user. If it is not writable, the command is executed as user
0096 <parameter>user</parameter> (defaults to root).</para>
0097 <para><parameter>file</parameter> is evaluated like this: if
0098 <parameter>file</parameter> starts with a <literal>/</literal>, it is
0099 taken as an absolute filename. Otherwise, it is taken as the name of a
0100 global &kde; configuration file.</para></listitem>
0101 </varlistentry>
0102 <varlistentry>
0103 <term><option>-i</option> <replaceable>icon name</replaceable></term>
0104 <listitem><para>Specify icon to use in the password dialog. You may specify
0105 just the name, without any extension.</para>
0106 </listitem>
0107 </varlistentry>
0108 
0109 <varlistentry>
0110 <term><option>-n</option></term>
0111 <listitem><para>Do not keep the password. This disables the <guilabel>keep
0112 password</guilabel> checkbox in the password dialog.</para></listitem>
0113 </varlistentry>
0114 <varlistentry>
0115 <term><option>-p</option> <replaceable>priority</replaceable></term>
0116 <listitem>
0117 <para>Set priority value. The priority is an arbitrary number between 0 and
0118 100, where 100 means highest priority, and 0 means lowest. The default is
0119 50.</para>
0120 </listitem>
0121 </varlistentry>
0122 <varlistentry>
0123 <term><option>-r</option></term>
0124 <listitem><para>Use realtime scheduling.</para>
0125 </listitem>
0126 </varlistentry>
0127 
0128 <varlistentry>
0129 <term><option>-s</option></term>
0130 <listitem><para>Stop the kdesu daemon. This is the daemon that caches
0131 successful passwords in the background. This feature may also be disabled with
0132 <option>-n</option> when &kdesu; is initially run.</para></listitem>
0133 </varlistentry>
0134 <varlistentry>
0135 <term><option>-t</option></term>
0136 <listitem><para>Enable terminal output. This disables password keeping. This is
0137 largely for debugging purposes; if you want to run a console mode app, use the
0138 standard <command>su</command> instead.</para> </listitem>
0139 </varlistentry>
0140 <varlistentry>
0141 <term><option>-u</option> <replaceable> user</replaceable></term>
0142 <listitem><para>While the most common use for &kdesu; is to run a command as
0143 the superuser, you can supply any user name and the appropriate
0144 password.</para>
0145 </listitem>
0146 </varlistentry>
0147 
0148 <varlistentry>
0149 <term><option>--noignorebutton</option></term>
0150 <listitem><para>Do not display an ignore button.</para>
0151 </listitem>
0152 </varlistentry>
0153 
0154 <varlistentry>
0155 <term><option>--attach</option> <replaceable> winid</replaceable></term>
0156 <listitem><para>Makes the dialog transient for an X app specified by winid.</para>
0157 </listitem>
0158 </varlistentry>
0159 
0160 </variablelist>
0161 
0162 </refsect1>
0163 
0164 <refsect1>
0165 <title>See Also</title>
0166 <para>su(1)</para>
0167 
0168 <para>More detailed user documentation is available from <ulink
0169 url="help:/kdesu">help:/kdesu</ulink>
0170 (either enter this &URL; into &konqueror;, or run
0171 <userinput><command>khelpcenter</command>
0172 <parameter>help:/kdesu</parameter></userinput>).</para>
0173 
0174 </refsect1>
0175 
0176 <refsect1>
0177 <title>Examples</title>
0178 <para>Run <command>kfmclient</command> as user <systemitem
0179 class="username">jim</systemitem>, and show the &konqueror; icon in the
0180 password dialog:</para>
0181 <screen><userinput>$(kf5-config --path libexec)<command>kdesu</command> <option>-u jim</option> <option>-i konqueror</option> <command>kfmclient</command></userinput></screen>
0182 
0183 </refsect1>
0184 
0185 <refsect1>
0186 <title>Authors</title>
0187 <para>&kdesu; was written by
0188 &Geert.Jansen; &Geert.Jansen.mail;
0189 and <personname><firstname>Pietro</firstname><surname>Iglio</surname></personname>
0190 <email>iglio@fub.it</email>.
0191 </para>
0192 </refsect1>
0193 
0194 </refentry>