tdesudo/doc/en/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY tdesudo '<application>tdesudo</application>'>
  <!ENTITY kappname "&tdesudo;">
  <!ENTITY package "tdebase">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>

<book lang="&language;">
<bookinfo>

<title>The &tdesudo; handbook</title>

<authorgroup>
<author>
<firstname>Robert</firstname>
<surname>Gruber</surname>
<affiliation>
<address><email>rgruber@users.sourceforge.net</email></address>
</affiliation>
</author>

</authorgroup>

<copyright>
<year>2003</year>
<holder>Robert Gruber</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2002-03-29</date>
<releaseinfo>1.00.00</releaseinfo>


<abstract><para>&tdesudo; is a graphical front end for the
<command>sudo</command> command.</para></abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>sudo</keyword>
<keyword>password</keyword>
<keyword>root</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>Welcome to &tdesudo;! &tdesudo; is a graphical front end for the
<command>su</command> command for the Trinity Desktop Environment.
It allows you to run a program as different user if the sys admin allows
it. &tdesudo; is an unprivileged program; it uses
the system's <command>sudo</command> command.</para>

<para>This program is meant to be started from the command line or
from <filename>.desktop</filename> files.</para>

</chapter>

<chapter id="using-tdesu">
<title>Using &tdesudo;</title>

<para>Usage of &tdesudo; is easy. The syntax is like this:</para>

    <cmdsynopsis>
      <command>tdesudo</command>
      <arg>-u <replaceable>RUNAS</replaceable></arg>
      <arg>COMMAND</arg>
    </cmdsynopsis>

<para>The command line options are explained below.</para>

<variablelist>

<varlistentry>
<term><option>COMMAND</option></term>
<listitem><para>This is the command that <command>sudo</command> will execute.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-u <replaceable>RUNAS</replaceable></option></term>
<listitem><para>This option allow to run COMMAND as a different user which
is specified at RUNAS</para></listitem>
</varlistentry>

</variablelist>

</chapter>

<chapter id="Author">
<title>Author</title>

<para>&tdesudo;</para>

<para>Copyright 2003 Robert Gruber</para>

<para>
&tdesudo; is part of the TDE project, for bug reports, please, report them to
 the Trinity developpers.
</para>

&underFDL;
&underGPL;

</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="downloading">
<title>Downloading</title>
<para>
The source code is available at <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/tdesudo">https://mirror.git.trinitydesktop.org/gitea/TDE/tdesudo</ulink> .
</para>

</sect1>

<sect1 id="compiling">
<title>Compiling</title>

<para>
In order to compile and install &tdesudo; on your system, you will need cmake.

<screen width="40">
<prompt>%</prompt> <userinput>mkdir -p build</userinput>
<prompt>%</prompt> <userinput>cd build</userinput>
<prompt>%</prompt> <userinput>cmake ..</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>

For further instructions, please, read the INSTALL file.
</para>

</sect1>
</appendix>

</book>