runtime/doc/kdesu/man-kdesu.1.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3 <!ENTITY % English "INCLUDE">
   4 ]>
   5
   6 <refentry lang="&language;">
   7 <refentryinfo>
   8 <title>KDE User's Manual</title>
   9 <author>&Lauri.Watts; &Lauri.Watts.mail;</author>
  10 <date>Jun 7, 2005</date>
  11 <productname>K Desktop Environment</productname>
  12 </refentryinfo>
  13
  14 <refmeta>
  15 <refentrytitle><command>kdesu</command></refentrytitle>
  16 <manvolnum>1</manvolnum>
  17 </refmeta>
  18
  19 <refnamediv>
  20 <refname><command>kdesu</command></refname>
  21 <refpurpose>Runs a program with elevated privileges</refpurpose>
  22 </refnamediv>
  23
  24 <refsynopsisdiv>
  25 <cmdsynopsis>
  26 <command>kdesu</command>
  27
  28 <group choice="opt"><option>-c</option></group>
  29 <group choice="opt"><option>-d</option></group>
  30 <group choice="opt"><option>-f</option> <replaceable> file</replaceable></group>
  31 <group choice="opt"><option>-i</option> <replaceable> icon name</replaceable></group>
  32 <group choice="opt"><option>-n</option></group>
  33 <group choice="opt"><option>-p</option> <replaceable> priority</replaceable></group>
  34 <group choice="opt"><option>-r</option></group>
  35 <group choice="opt"><option>-s</option></group>
  36 <group choice="opt"><option>-t</option></group>
  37 <group choice="opt"><option>-u</option> <replaceable>
  38 user</replaceable></group>
  39 <group choice="opt"><option>--nonewdcop</option></group>
  40
  41 <group><arg choice="req"><replaceable>command</replaceable> <arg><replaceable>arg1</replaceable></arg>
  42           <arg><replaceable>arg2</replaceable></arg>
  43           <arg rep="repeat"><replaceable></replaceable></arg></arg></group>
  44 </cmdsynopsis>
  45 <cmdsynopsis>
  46 <command>kdesu</command>
  47 <arg choice="opt">KDE Generic Options</arg>
  48 <arg choice="opt">Qt Generic Options</arg>
  49 </cmdsynopsis>
  50 </refsynopsisdiv>
  51
  52 <refsect1>
  53 <title>Description</title>
  54 <para>&kdesu; is a graphical front end for the
  55 &UNIX; <command>su</command> command for the K Desktop Environment.
  56 It allows you to run a program as different user by supplying the
  57 password for that user. &kdesu; is an unprivileged program; it uses
  58 the system's <command>su</command>.</para>
  59
  60 <para>&kdesu; has one additional feature: it can optionally remember passwords
  61 for you. If you are using this feature, you only need to enter the
  62 password once for each command.</para>
  63
  64 <para>This program is meant to be started from the command line or
  65 from <filename>.desktop</filename> files.</para>
  66 </refsect1>
  67
  68 <refsect1>
  69 <title>Options</title>
  70
  71 <variablelist>
  72 <varlistentry>
  73 <term><option>-c <replaceable>program</replaceable></option></term>
  74 <listitem><para>This specifies the program to run as root. It has to be passed
  75 in one argument. So if, for example, you want to start a new file manager, you
  76 would enter at the prompt: <userinput><command>kdesu <option>-c <replaceable>kfm
  77 -sw</replaceable></option></command></userinput></para></listitem>
  78 </varlistentry>
  79 <varlistentry>
  80 <term><option>-d</option></term>
  81 <listitem><para>Show debug information.</para></listitem>
  82 </varlistentry>
  83 <varlistentry>
  84 <term><option>-f <replaceable>file</replaceable></option></term>
  85 <listitem><para>This option allow efficient use of &kdesu; in
  86 <filename>.desktop</filename> files. It tells &kdesu; to examine the
  87 file specified by <parameter>file</parameter>. If this file is
  88 writable by the current user, &kdesu; will execute the command as the
  89 current user. If it is not writable, the command is executed as user
  90 <parameter>user</parameter> (defaults to root).</para>
  91 <para><parameter>file</parameter> is evaluated like this: if
  92 <parameter>file</parameter> starts with a <literal>/</literal>, it is
  93 taken as an absolute filename. Otherwise, it is taken as the name of a
  94 global &kde; configuration file. For example: to configure the K display
  95 manager, <application>kdm</application>, you could issue
  96 <command>kdesu <option>-c kdmconfig -f
  97 kdmrc</option></command></para></listitem>
  98 </varlistentry>
  99 <varlistentry>
 100 <term><option>-i</option> <replaceable>icon name</replaceable></term>
 101 <listitem><para>Specify icon to use in the password dialog.  You may specify
 102 just the name, without any extension.</para>
 103 </listitem>
 104 </varlistentry>
 105
 106 <varlistentry>
 107 <term><option>-n</option></term>
 108 <listitem><para>Do not keep the password. This disables the <guilabel>keep
 109 password</guilabel> checkbox in the password dialog.</para></listitem>
 110 </varlistentry>
 111 <varlistentry>
 112 <term><option>-p</option> <replaceable>priority</replaceable></term>
 113 <listitem>
 114 <para>Set priority value.  The priority is an arbitrary number between 0 and
 115 100, where 100 means highest priority, and 0 means lowest.  The default is
 116 50.</para>
 117 </listitem>
 118 </varlistentry>
 119 <varlistentry>
 120 <term><option>-r</option></term>
 121 <listitem><para>Use realtime scheduling.</para>
 122 </listitem>
 123 </varlistentry>
 124
 125 <varlistentry>
 126 <term><option>-s</option></term>
 127 <listitem><para>Stop the kdesu daemon. This is the daemon that caches
 128 successful passwords in the background.  This feature may also be disabled with
 129 <option>-n</option> when &kdesu; is initially run.</para></listitem>
 130 </varlistentry>
 131 <varlistentry>
 132 <term><option>-t</option></term>
 133 <listitem><para>Enable terminal output. This disables password keeping. This is
 134 largely for debugging purposes; if you want to run a console mode app, use the
 135 standard <command>su</command> instead.</para> </listitem>
 136 </varlistentry>
 137 <varlistentry>
 138 <term><option>-u</option> <replaceable> user</replaceable></term>
 139 <listitem><para>While the most common use for &kdesu; is to run a command as
 140 the superuser, you can supply any user name and the appropriate
 141 password.</para>
 142 </listitem>
 143 </varlistentry>
 144
 145 </variablelist>
 146
 147 </refsect1>
 148
 149 <refsect1>
 150 <title>See Also</title>
 151 <para>su(1)</para>
 152
 153 <para>More detailed user documentation is available from <ulink
 154 url="help:/kdesu">help:/kdesu</ulink>
 155 (either enter this <acronym>URL</acronym> into &konqueror;, or run
 156 <userinput><command>khelpcenter</command>
 157 <parameter>help:/kdesu</parameter></userinput>).</para>
 158
 159 </refsect1>
 160
 161 <refsect1>
 162 <title>Examples</title>
 163 <para>Run <command>kfmclient</command> as user <systemitem
 164 class="username">jim</systemitem>, and show the &konqueror; icon in the
 165 password dialog:</para>
 166 <screen><userinput><command>kdesu</command> <option>-u jim</option> <option>-i konqueror</option> <command>kfmclient</command></userinput></screen>
 167
 168 </refsect1>
 169
 170 <refsect1>
 171 <title>Authors</title>
 172 <para>&kdesu; was written by
 173 <personname><firstname>Geert</firstname><surname>Jansen</surname></personname> <email>jansen@kde.org</email>
 174 and <personname><firstname>Pietro</firstname><surname>Iglio</surname></personname>
 175 <email>iglio@fub.it</email>.
 176 </para>
 177 </refsect1>
 178
 179 </refentry>