This is the "VDRAdmin-AM" a web user interface for VDR.

Written by:                  Andreas Mair (andreas AT vdr - developer DOT org)

Project's homepage:          http://andreas.vdr-developer.org

Latest version available at: http://andreas.vdr-developer.org


License
-------

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License along
	with this program; if not, write to the Free Software Foundation, Inc.,
	51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

See the file COPYING for the full GNU GENERAL PUBLIC LICENSE Version 2 (GPLv2).

"Bubblehelp infoboxes" (templates/default/infobox.js) is licensed under
GNU GENERAL PUBLIC LICENSE Version 2 (GPLv2) *only*.

"Crystal Theme Icons" are licensed under GNU LESSER GENERAL PUBLIC LICENSE v2.1
(LGPLv2.1), see LGPL.txt.


Requirements
------------

- VDR (http://www.tvdr.de/)
- Some Perl modules (see "./install.sh -p"):
  - Required:
	  - Template
	  - Template::Plugin::JavaScript
	  - CGI
	  - HTTP::Date
	  - IO::Socket
	  - Time::Local
	  - MIME::Base64
	  - File::Temp
	  - URI
	  - URI::Escape
	  - Locale::gettext OR Locale::Messages
	- Optional:
	  - Required for built-in HTTP response compression:
	    - Compress::Zlib
	  - Required for AutoTimer email notification:
	    - Net::SMTP
	    - Authen::SASL
	  - Required for AutoTimer email notification and CRAM-MD5 authentication:
	    - Digest::HMAC_MD5
	  - Required for syslog logging:
	    - Sys::Syslog
	  - Required for IPv6 support:
	    - IO::Socket::INET6
	  - Required for SSL support (https):
	    - IO::Socket::SSL

Description
-----------

VDRAdmin-AM is a web based interface to VDR.


Installation
------------

See "INSTALL" file.


Options
-------

	-n, --nofork
		don't fork, log to stderr.

	-c,  --config
		run configuration dialog.

	-d [dir], --cfgdir [dir]
		use [dir] for configuration files.

	-k, --kill
		kill a forked vdradmind[.pl].

	-p [name], --pid [name]
		name of pidfile to use.

  -6, --ipv6
    use IPv6. [EXPERIMENTAL!]

  -s, --ssl
    only accept https:// connections.

		NOTE: this requires server-cert.pem and server-key.pem in the "certs" directory.
		      You can create them for example like this:
		# openssl req -new -x509 -days 9999 -keyout server-rsa-key.pem -out server-cert.pem
		# openssl rsa -in server-rsa-key.pem > server-key.pem

	-l [level], --log [level]
		set log level for this session [0 - 7].

	-h, --help
		print usage information.


Credits
-------

See "CREDITS" file.

VDRAdmin-AM translators guide
==============================

Since vdradmin-0.97-am3.2 almost every text has been extracted from the
scripts and templates. This makes it much easier for anybody, who wants to
translate VDRAdmin-AM to another language.

All you need to do is to let me (mail AT andreas DOT vdr-developer DOT org)
know, that you plan to add a new language, so that I can tell you if anybody
else is already working on that language. After my OK you can start your work.


Howto
-----

We've decided to use GNU gettext for translating the user interface to
different languages. GNU gettext is widely used among Linux programs of all
kind. It comes with a lot of tools and with support for most programming
languages.

The translations are stored in plain text files with a *.po file extension.
Each language has its own file (e.g. de.po, fi.po, ...). You may edit these
po-files with any text editor, but we recommend to use a po-editor like
poedit [1], kbabel [2] or gtranslator [3].

You must have installed the "gettext" package of your distribution to compile
the plain text translations to the binary files needed by VDRAdmin-AM.

The basic work flow for a translation looks like this:

1) Copy po/vdradmin.pot to po/<language code>.po. See [4] for a list of
   available language codes.

2) Open the file in your favorite po-editor. Make sure you set the correct
   encoding and fill in your email and language in the corresponding header
   fields. poedit makes this pretty easy - just go to catalog/options and
   fill out the form.

3) Now you can start translating. Keep in mind, that if you translate a message,
   you should use html entities [5], [6] for special characters. Any text that
   origins from vdradmind[.pl] must not have html entities.
   Beside the help texts, you will not need any formating tags.

   Messages marked as "fuzzy" indicate, that they may have been derived from
   similar messages and it's not sure, that the translation is correct. Check
   these translations and correct them if needed or simply mark them as not
   fuzzy (poedit: edit/mark as fuzzy)

4) To check how your translated texts look like, you have to compile them
   first to *.mo-files. To do so, you edit "make.sh" first and append
   your  <language code> to the "LANGS=" line. Running "./make.sh po" will then
	 create a new *.mo-file from your changed *.po-file.

   Please note, that you have to restart vdradmind[.pl] after any changes you
   make to the translation. In order to allow VDRAdmin-AM to select your language,
   you must have the appropriate locales installed on your system (see
   "locale -a"). You should make sure, that the correct locale is selected
   with the LANG and LC_* environment variables.

	 For example: LANG=de_DE ./vdradmind

5) If you are done, send the *.po-file to me:

   mail AT andreas DOT vdr-developer DOT org

6) When changes have been made to VDRAdmin-AM, that cause some messages to
   change, the *.po-files will by modified and we will send them to the
   translators. The process then starts with 2) again and we will include your
   new translation with the next release.


If you have any further questions, please don't hesitate to contact me.


--- 2007-12-18, Andreas Mair ---


[1] http://www.poedit.org (available for Windows and Linux)
[2] http://i18n.kde.org/tools/kbabel/ (KDE)
[3] http://gtranslator.sourceforge.net/ (GNOME)
[4] http://www.gnu.org/software/gettext/manual/html_chapter/gettext_15.html
[5] http://www.w3.org/TR/WD-entities-961125 (English)
[6] http://de.selfhtml.org/html/referenz/zeichen.htm (German).