tdeutils/doc/kdelirc/kcmlirc/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kcmlirc "<application>KDE LIRC Control Center Module</application>">
  <!ENTITY kdelirc "<application>KDE LIRC</application>">
  
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE">
]>

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

<title>KDE Infrared Remote Control Configuration</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>&kdelirc; configuration: The infrastructure for the KDE's
Infrared Remote Control functionality.</para></abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>irkick</keyword>
<keyword>kdelirc</keyword>
<keyword>kcmlirc</keyword>
<keyword>lirc</keyword>
</keywordset>

</bookinfo>

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

<para>
</para>

<sect1 id="requirements">
<title>Requirements</title>

<para>
For the KDELirc framework to be utilised you must have setup a LIRC
on your KDE machine. If it is properly set up, the &kdelirc; icon in
the system tray (show icon here) 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="usage">
<title>Usage</title>

<para>
There are several sections of the configuration. The list on the left details the remote controls and modes. The selection of that dictates the contents of the right-most list, which shows button/action bindings. Flicking the main tab over to Loaded Extensions will show a list of applications and remote controls that are recognised for the advanced functionality; some data is also viewable by selecting one of the items.
</para>

<sect1 id="modes">
<title>Remote Controls and Modes</title>

<para>
Each remote control can have a number of modes. Having multiple modes allows the same button to conduct different actions in difference situations, and is how many remote controls handle many different appliances with a limited number of buttons. A good example are the TV/Video/Satellite/DVD multi-purpose remote controls - rather than having several sets of number buttons for each appliance they have only one set which works for the currently selected appliance only.
</para>

<para>
Each remote control can be in at most one mode at once (it may also be in no mode at all). The remote control also has a "default mode", which is the mode that it starts in, and the mode that it gets reset to normally. This may be set by using the Edit button.
</para>

<para>
The list contains any remote controls detected on your system. Modes may be added and removed by selecting the desired remote control and using the buttons directly below the list Add, Remove. Modes may be renamed "inline" in the standard KDE fashion by first selecting the mode in the list box, and then clicking it again after a short pause. The Edit button allows mode names to be edited, and also allows you to define an icon that will show up in the system tray when that mode is entered.
</para>

</sect1>

<sect1 id="bindings">
<title>Action-Button Bindings</title>

<para>
An action/button binding ("action") is a connection between a button press and an effect. The effect may be to switch modes, to start a KDE program or to execute a function in a KDE program (using DCOP).
</para>

<para>
Actions may be associated with a mode of the remote control; if it is, the action will only have effect when the remote control is in that mode. Actions may also be placed out of any mode. Such actions will always have their desired effect no matter what mode that remote control happens to be in.
</para>

<para>
To add an action/button binding simply use the Add button. Removal may be performed by selecting the action(s) to be removed and clicking the Remove button. Actions may be Edited with the Edit button, and moved to different modes by dragging and dropping onto the desired mode in the remotes/modes list.
</para>

<para>
Actions may also be "automatically" populated. This handles the instance when you have a supported remote control and you wish to map its buttons to a supported application's functions. &kdelirc; can attempt to match buttons to functions for you; this behaviour may have to be tweaked, however.
</para>

</sect1>

<sect1 id="extensions">
<title>Loaded Extensions</title>

<para>
There is another tab available named "Loaded Extensions". This details the applications and remote controls that &kdelirc; recognises. &kdelirc; can also use unsupported remote controls and applications, but the Auto-Populate function will not work as well (if at all).
</para>

<para>
By clicking on an entry you can see information on it such as the author's details.
</para>

</sect1>

</chapter>

<chapter id="credits">
<title>Credits and Licenses</title>

<para>&kdelirc; KDE LIRC Framework Copyright (c) 2004 Gav Wood
<email>gav@kde.org</email>.</para>

<para>Documentation Copyright (c) 2004 by Gav Wood
<email>gav@kde.org</email>.</para>

&underFDL;
&underGPL;

</chapter>

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

&install.intro.documentation;
&install.compile.documentation;

</appendix>
</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

// vim:ts=2:sw=2:tw=78:noet
-->