vdr/vdr/debian vdr-recordingaction.1 vdr.manpages

[Tobias Grimm]

Update of /cvsroot/pkg-vdr-dvb/vdr/vdr/debian
In directory haydn:/tmp/cvs-serv27868

Added Files:
	vdr-recordingaction.1 vdr.manpages 
Log Message:
added manpage for vdr-recordingaction

--- NEW FILE: vdr.manpages ---
debian/vdr-recordingaction.1

--- NEW FILE: vdr-recordingaction.1 ---
'\" t
.\" ** The above line should force tbl to be a preprocessor **
.\" Man page for vdr-recordingaction
.\"
.\" Copyright (C) 2004 Tobias Grimm
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file COPYING that comes with the
.\" vdr distribution.
.\"
.TH vdr-recordingaction 1
.SH NAME
vdr-recordingaction
.SH DESCRIPTION
.B vdr-recordingaction 
is called by vdr before a recording starts, after a recording ends and after
a recording has been edited.

In order to allow other packages to specify their own recording actions,
.B vdr-recordingaction
will execute all files in /usr/share/vdr/recording-hooks
one after another. If such a file is not an executable or a link to an 
executable, it is executed as a shell script.

Recording hooks are called in their alphabetical order and should follow this
naming scheme: 

R<XX>.<identifier>

Where <XX> is a two digit number, that mainly specifies the execution order 
and <identifier> is a unique descriptor.

Two parameters are passed to each recording hook:

Parameter 1 can have the values "before", "after" and "edited", depending
on whether the recording hook is called before the recording starts,
after the recording ends or after the recording has been edited.

Parameter 2 is the directory of the recording. Be aware, that this directory 
doesn't exist before the recording starts.

If the author of a package wants the user to be able to customize a recording
hook, it should be installed to /etc/vdr/recording-hooks/ and only symlinked
to /usr/share/vdr/recording-hooks/.

Custom user commands associated with the vdr package, can be added by the user
to /etc/vdr/recording-hooks/R90.custom.

Normally there is no need to manually run 
.B vdr-recordingaction
!