This is a "plugin" for the Video Disk Recorder (VDR).

Written by:                  Thomas Heiligenmann <thomas@heiligenmann.de>

Project's homepage:          http://vdr.heiligenmann.de/

Latest version available at: http://vdr.heiligenmann.de/download/

See the file COPYING for license information.

Description:                 This plugin implements remote control per WAP.

------------------------------------------------------------------------------


This plugin lets VDR listen to WAP requests to allow remote control by WML
enabled browsers - eg. mobile devices - and is called "WAP daemon" or "wapd".

The plugin however answers no WAP requests directly - it provides a http daemon
serving WML content. Normally your mobile device is preconfigured to talk to
your provider's WAP gateway which will then convert the WAP requests into HTTP
requests sent via the internet to your VDR box and vice versa.

If you are interested to setup a WAP gateway by yourself have a look at the
'Open Source WAP and SMS gateway' under http://www.kannel.org/

------------------------------------------------------------------------------
Installation:
------------------------------------------------------------------------------

The plugin was developed and tested under VDR version 1.3.37. Support for
earlier versions has been removed.

Extract the downloaded file into VDRs plugin source directory and create a
symlink:

     cd /path/to/VDR/PLUGINS/src
     tar xzf vdr-wapd-#.#.#.tgz
     ln -s wapd-#.#.# wapd

Compilation is done the usual way by calling 'make plugins' from the VDR source
directory. Add the parameter '-Pwapd' to load the plugin when starting VDR.


------------------------------------------------------------------------------
Files:
------------------------------------------------------------------------------

The plugin needs 2 files under /video/plugins/wapd (default):

'waphosts' controls host based access and is similar to svdrphosts.conf

'wapaccess' controls user based access. The format is similar to apache's
htpasswd file format and holds lines in the form 'user:passwdhash'. Apache's
htpasswd utility can be used to create and edit the 'wapaccess' file. You can
also take the utility 'wappasswd' described below.


------------------------------------------------------------------------------
Invocation:
------------------------------------------------------------------------------

Call

     /path/to/vdr -P"wapd" [...]

to load the plugin. It will listen on port 8888 (default) for incoming WAP
requests. You can use the command line option '-p/--port' to select another
port:

     /path/to/vdr -P"wapd -p 4711" [...]       or
     /path/to/vdr -P"wapd --port=4711" [...]


------------------------------------------------------------------------------
Navigation:
------------------------------------------------------------------------------

The WML pages sent by the plugin are oriented at VDRs OSD as close as possible.
Point your WML browser to the following URL:

      http://your-vdr-machine:8888

The start page should offer the following links:

      Schedule
      Channels
      Timers
      Recordings
      Language

Navigation through subsequent menus is provided by a 'bottom line', which may
appear differently depending on your WML browser. Language settings will be the
same as selected in the OSD.


------------------------------------------------------------------------------
Utilities:
------------------------------------------------------------------------------

After compilation of the plugin you'll also find an executable 'wappasswd' in
the source directory. It will help maintaining the 'wapaccess' file and you may
want to copy it to a directory contained in $PATH.

To create a new 'wapaccess' file with a new user simply type:

     [/path/to/]wappasswd username password > /video/plugins/wapaccess

To add a new user to 'wapaccess' type:

     [/path/to/]wappasswd username password >> /video/plugins/wapaccess

To delete a user from 'wapaccess' use your favourite text editor and remove the
line 'username:passwordhash'.
