summaryrefslogtreecommitdiffstats
path: root/doc/en/index.docbook
blob: 7886bb705228c0edf97152b3d8bb7fafa93ea20d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?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>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->