summaryrefslogtreecommitdiffstats
path: root/doc/irkick
diff options
context:
space:
mode:
Diffstat (limited to 'doc/irkick')
-rw-r--r--doc/irkick/CMakeLists.txt13
-rw-r--r--doc/irkick/Makefile.am4
-rw-r--r--doc/irkick/index.docbook119
3 files changed, 136 insertions, 0 deletions
diff --git a/doc/irkick/CMakeLists.txt b/doc/irkick/CMakeLists.txt
new file mode 100644
index 0000000..e48e649
--- /dev/null
+++ b/doc/irkick/CMakeLists.txt
@@ -0,0 +1,13 @@
+#################################################
+#
+# (C) 2012 Golubev Alexander
+# fatzer2 (AT) gmail.com
+#
+# Improvements and feedback are welcome
+#
+# This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION irkick )
+
diff --git a/doc/irkick/Makefile.am b/doc/irkick/Makefile.am
new file mode 100644
index 0000000..085981d
--- /dev/null
+++ b/doc/irkick/Makefile.am
@@ -0,0 +1,4 @@
+
+KDE_LANG = en
+KDE_DOCS = AUTO
+
diff --git a/doc/irkick/index.docbook b/doc/irkick/index.docbook
new file mode 100644
index 0000000..e32d246
--- /dev/null
+++ b/doc/irkick/index.docbook
@@ -0,0 +1,119 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+ <!ENTITY irkick "<application>IRKick</application>">
+ <!ENTITY tdelirc "<application>TDE LIRC</application>">
+ <!ENTITY kappname "&irkick;">
+ <!ENTITY package "tdeutils">
+ <!ENTITY % English "INCLUDE" > <!-- change language only here -->
+ <!ENTITY % addindex "IGNORE">
+]>
+
+<book lang="&language;">
+<bookinfo>
+
+<title>&irkick;: The TDE LIRC Server Handbook</title>
+
+<authorgroup>
+<author>
+<firstname>Gav</firstname>
+<surname>Wood</surname>
+<affiliation>
+ <address><email>gav@kde.org</email></address>
+</affiliation>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2004-01-02</date>
+<releaseinfo>1.0</releaseinfo>
+
+<copyright>
+<year>2004</year>
+<holder>Gav Wood</holder>
+</copyright>
+
+<legalnotice>&FDLNotice;</legalnotice>
+
+<abstract><para>&tdelirc; is the infrastructure for the TDE's
+Infrared Remote Control functionality; &irkick; is the server
+component of that infrastructure.</para></abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+<keyword>irkick</keyword>
+<keyword>tdelirc</keyword>
+<keyword>kcmlirc</keyword>
+<keyword>lirc</keyword>
+</keywordset>
+
+</bookinfo>
+
+<chapter id="introduction">
+<title>Introduction</title>
+
+<para>
+&irkick; is a background server that provides the 'glue' between
+the operating system and your TDE applications for the purpose of
+controlling TDE applications with your infrared remote controls.
+</para>
+
+<para>
+It has a configuration tool, which may be accessed either by the
+Trinity Control Center or directly from the menu of &irkick;.
+</para>
+
+<sect1 id="requirements">
+<title>Requirements</title>
+
+<para>
+For the TDELirc framework to be utilised you must have setup a LIRC
+on your TDE machine. If it is properly set up, the &irkick; icon in
+the system tray will light up red. If not, it will be grey and crossed
+out.
+</para>
+
+<para>
+For more information about LIRC, visit their website at http://www.lirc.org.
+</para>
+
+</sect1>
+</chapter>
+
+<chapter id="using-irkick">
+<title>Using &irkick;</title>
+
+<para>
+&irkick; provides one main function: When a button on a remote control is
+pressed, it will temporarily become lit up. Aside from this &irkick; does
+little for the user directly aside from telling them of the activity of their
+remote controls.
+</para>
+
+<para>
+Using the right-mouse-button menu, you can configure the TDE infrared remote
+control framework.
+</para>
+
+</chapter>
+
+<chapter id="credits">
+<title>Credits and Licenses</title>
+
+<para>&tdelirc;: The TDE LIRC Framework Copyright (c) 2004 Gav Wood
+<email>gav@kde.org</email>.</para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+&underFDL;
+&underGPL;
+
+</chapter>
+
+<appendix id="installation">
+<title>Installation</title>
+
+&install.intro.documentation;
+&install.compile.documentation;
+
+</appendix>
+</book>