LIRC kernel modules source for Debian
=====================================

This package provides the LIRC source code which can be used to build 
modules that work with your custom built linux kernel. The source files are 
located in /usr/src/lirc-modules.tar.bz2; unpacking that file in /usr/src
will produce a build tree in /usr/src/modules/lirc-modules/ (The tar file can
also be unpacked elsewhere).

The default module settings and which LIRC modules to build can be set in 
/etc/lirc/lirc-modules-source.conf or though debconf (which is the preferred
way of modification).

	dpkg-reconfigure lirc-modules-source


Special build requirements for certain modules
==============================================

  * gpio:
    needs full kernel sources containing the following headers which are not
    part of the public linux-headers!

	- (bt848.h)
	- btcx-risc.h
	- bttv.h
	- bttvp.h

    For Debian, the kernel sources are usually available in the 

	linux-source-<kernel version>

    package (e.g. linux-source-2.6.24), be aware that you have to point 
    module-assistant or make-kpkg to use these sources instead of the 
    public kernel headers.


Building LIRC kernel modules with module-assistant
==================================================

Please install the module-assistant package and issue the following commands
in a shell:

	$ m-a prepare
	$ m-a a-i lirc

m-a is short for module-assistant, and a-i is short for auto-install. Please
see the module-assistant documentation for futher details about this process.


Building LIRC kernel modules with make-kpkg
===========================================

Please install the kernel-package package and abide the following steps:

  * unpack /usr/src/lirc-modules.tar.bz2 into your working directory.
    (warning, make sure to remove old sources first)

  * change to the base of the kernel source tree.
    (This may be /usr/src/linux, if the sources have been unpacked by the 
    system administrator)

  * To build the LIRC modules, execute:

	$ make-kpkg --revision <number> modules_image

    where <number> is the same revision number used to build the 
    kernel-image package in the previous step. This will generate a 
    lirc-modules-<kernel version> deb file in the parent directory.

    The MODULE_LOC environment variable specifies the top directory to which 
    /usr/src/lirc-modules.tar.bz2 has been extracted. For example, if you 
    want to build LIRC and the sources are in ~/modules/lirc-modules/, you 
    need to set MODULE_LOC="~/modules".


The preferred way to build kernel modules for LIRC is using module-assistant.


This document has been assembled based on original documentation for 
lirc-modules-source by Manuel Estrada Sainz <ranty@debian.org>, which in 
turn was derived from the documentation of the alsa-source and pcmcia 
packages written by Masato Taruishi <taru@debian.org> and Brian Mays 
<brian@debian.org> and has been augmented by information found in the 
acerhk-source package by Kel Modderman <kelrin@tpg.com.au>

 -- Stefan Lippers-Hollmann <s.l-h@gmx.de>  Fri, 14 Mar 2008 23:28:06 +0100