diff options
Diffstat (limited to 'doc/kiostdetool')
-rw-r--r-- | doc/kiostdetool/Makefile.am | 2 | ||||
-rw-r--r-- | doc/kiostdetool/extra-steps.docbook | 4 | ||||
-rw-r--r-- | doc/kiostdetool/index.docbook | 98 | ||||
-rw-r--r-- | doc/kiostdetool/introduction.docbook | 25 | ||||
-rw-r--r-- | doc/kiostdetool/profile-assign.docbook | 4 | ||||
-rw-r--r-- | doc/kiostdetool/profile-create.docbook | 4 | ||||
-rw-r--r-- | doc/kiostdetool/profile-setup.docbook | 4 | ||||
-rw-r--r-- | doc/kiostdetool/profiles.docbook | 39 | ||||
-rw-r--r-- | doc/kiostdetool/settings.docbook | 4 |
9 files changed, 184 insertions, 0 deletions
diff --git a/doc/kiostdetool/Makefile.am b/doc/kiostdetool/Makefile.am new file mode 100644 index 0000000..c01e3fc --- /dev/null +++ b/doc/kiostdetool/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kiosktool diff --git a/doc/kiostdetool/extra-steps.docbook b/doc/kiostdetool/extra-steps.docbook new file mode 100644 index 0000000..da9c35e --- /dev/null +++ b/doc/kiostdetool/extra-steps.docbook @@ -0,0 +1,4 @@ +<chapter id="extra-steps"> +<title>Using Profiles with Older KDE Versions</title> +<para>&TODO;</para> +</chapter> diff --git a/doc/kiostdetool/index.docbook b/doc/kiostdetool/index.docbook new file mode 100644 index 0000000..12c2221 --- /dev/null +++ b/doc/kiostdetool/index.docbook @@ -0,0 +1,98 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kiosktool "<application>KIOSK Admin Tool</application>"> + <!ENTITY kappname "&kiosktool;"> + <!ENTITY TODO "Yet to be written."> + <!ENTITY etc_kderc "/etc/kderc"> + <!ENTITY kiosktool-introduction SYSTEM "introduction.docbook"> + <!ENTITY kiosktool-profiles SYSTEM "profiles.docbook"> + <!ENTITY kiosktool-profile-create SYSTEM "profile-create.docbook"> + <!ENTITY kiosktool-profile-setup SYSTEM "profile-setup.docbook"> + <!ENTITY kiosktool-profile-assign SYSTEM "profile-assign.docbook"> + <!ENTITY kiosktool-extra-steps SYSTEM "extra-steps.docbook"> + <!ENTITY kiosktool-settings SYSTEM "settings.docbook"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>&kiosktool; user manual</title> + +<authorgroup> +<author> +<firstname>Waldo</firstname> +<surname>Bastian</surname> +<affiliation> +<address><email>[email protected]</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2004</year> +<holder>[email protected]</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2004-11-12</date> +<releaseinfo>1.0</releaseinfo> + +<abstract> +<para><ulink url="http://extragear.kde.org/apps/tdeiosktool.php">&kiosktool;</ulink> +is a &kde; administration tool that offers system administrators an easy way to +predefine desktop configurations for groups of users, lock down settings or otherwise +restrict features of the &kde; desktop environment.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KIOSK</keyword> +<keyword>kiosktool</keyword> +<keyword>administration</keyword> +<keyword>lock down</keyword> +<keyword>policy</keyword> +<keyword>policies</keyword> +<keyword>profile</keyword> +</keywordset> + +</bookinfo> + +&kiosktool-introduction; +&kiosktool-profiles; +&kiosktool-profile-create; +&kiosktool-profile-assign; +&kiosktool-profile-setup; +&kiosktool-extra-steps; +&kiosktool-settings; + +<chapter id="credits"> + +<title>Credits and License</title> + +<para> +&kiosktool; +</para> +<para> +Program copyright 2004 Waldo Bastian <email>[email protected]</email> +</para> +<para> +Documentation copyright 2004 Waldo Bastian <email>[email protected]</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + +</chapter> + +&documentation.index; + +</book> + +<!-- +vim:tabstop=2:shiftwidth=2:expandtab +--> diff --git a/doc/kiostdetool/introduction.docbook b/doc/kiostdetool/introduction.docbook new file mode 100644 index 0000000..629a78d --- /dev/null +++ b/doc/kiostdetool/introduction.docbook @@ -0,0 +1,25 @@ +<chapter id="introduction"> +<title>Overview</title> + +<para>&kiosktool; is a &kde; administration tool that offers system administrators an easy way to +predefine desktop configurations for groups of users, lock down settings or otherwise +restrict features of the &kde; desktop environment.</para> + +<para>&kiosktool; takes advantage of KDE's KIOSK restrictions framework. It is centered around +<link linkend="profiles">profiles</link>. A profile is a collection of default settings and +restrictions that can be applied to either individual users or groups of users.</para> + +<para>Typical usage of &kiosktool; is to +<link linkend="profile-create">create a new profile</link>, +then to <link linkend="profile-setup">set up the profile</link> with the desired +default settings and restrictions, and finally to activate the profile by +<link linkend="profile-assign">assigning the profile</link> to one or more users. +</para> + +<para> +When using &kiosktool; in combination with older versions of &kde; (KDE 3.2 or older) +some <link linkend="extra-steps">additional steps</link> need to be taken in order +to properly activate the profiles. +</para> + +</chapter> diff --git a/doc/kiostdetool/profile-assign.docbook b/doc/kiostdetool/profile-assign.docbook new file mode 100644 index 0000000..057f1fc --- /dev/null +++ b/doc/kiostdetool/profile-assign.docbook @@ -0,0 +1,4 @@ +<chapter id="profile-assign"> +<title>Assigning Profiles</title> +<para>&TODO;</para> +</chapter> diff --git a/doc/kiostdetool/profile-create.docbook b/doc/kiostdetool/profile-create.docbook new file mode 100644 index 0000000..f455920 --- /dev/null +++ b/doc/kiostdetool/profile-create.docbook @@ -0,0 +1,4 @@ +<chapter id="profile-create"> +<title>Creating a New Profile</title> +<para>&TODO;</para> +</chapter> diff --git a/doc/kiostdetool/profile-setup.docbook b/doc/kiostdetool/profile-setup.docbook new file mode 100644 index 0000000..31384e8 --- /dev/null +++ b/doc/kiostdetool/profile-setup.docbook @@ -0,0 +1,4 @@ +<chapter id="profile-setup"> +<title>Setting up a Profile</title> +<para>&TODO;</para> +</chapter> diff --git a/doc/kiostdetool/profiles.docbook b/doc/kiostdetool/profiles.docbook new file mode 100644 index 0000000..1753c11 --- /dev/null +++ b/doc/kiostdetool/profiles.docbook @@ -0,0 +1,39 @@ +<chapter id="profiles"> +<title>Profiles</title> +<para>A profile is a collection of default settings and restrictions +that can be applied to either individual users or groups of users.</para> + +<para>The KDE desktop environment as well as all TDE applications use +a specific +<ulink url="http://www.kde.org/areas/sysadmin/fsh.php#dir_structure">directory structure</ulink> +to lookup configuration settings and various other information. +KDE knows about several +<ulink url="http://www.kde.org/areas/sysadmin/fsh.php#dir_location">locations</ulink> +for these directory structures. +All the information and +<ulink url="http://www.kde.org/areas/sysadmin/config_file.php">configuration settings</ulink> +found in the various locations are +<ulink url="http://www.kde.org/areas/sysadmin/config_file.php#cascading">combined</ulink> +before they are used. +<ulink url="http://www.kde.org/areas/sysadmin/config_file.php#lock_down">Lock down</ulink> +features control whether settings in the user's home folder ($TDEHOME or ~/.trinity) +are taken into account or not. +</para> + +<para> +A profile consists of a standard KDE directory structure in a custom location with +settings and information chosen by you. +</para> + +<para>&kiosktool; lets you chose in which location +a profile should be stored. Information about available profiles is stored in +the file &etc_kderc;. +</para> + +<para>It is recommended to store all profiles under a single +directory. In this case the &etc_kderc; file only needs to contain a reference to this +single directory and KDE and &kiosktool; will automatically pick up all profiles stored +under this directory. See the <xref linkend="settings" /> chapter for more information. +</para> + +</chapter> diff --git a/doc/kiostdetool/settings.docbook b/doc/kiostdetool/settings.docbook new file mode 100644 index 0000000..d4e4a78 --- /dev/null +++ b/doc/kiostdetool/settings.docbook @@ -0,0 +1,4 @@ +<chapter id="settings"> +<title>&kiosktool; Settings</title> +<para>&TODO;</para> +</chapter> |