Plugin installation: Difference between revisions

From VDR Wiki
Jump to navigation Jump to search
(initial)
 
m (Protected "Plugin installation" [edit=sysop:move=sysop])
 
(15 intermediate revisions by 11 users not shown)
Line 2: Line 2:


==Installation==
==Installation==
{{Box Hint|
{{Box Info|
The variable $SOURCEDIR stands for the directory where all the sources archives should be decompressed. Common directories are /usr/local/src, /usr/src and the home directory of the user.
The variable ''$SOURCEDIR'' stands for the directory where all the sources archives should be decompressed. Common directories are ''/usr/local/src'', ''/usr/src'' and the home directory of the user.


The variable $PLUGIN_NAME stands for name of the plugin that is to be installed.
The variable ''$PLUGIN_NAME'' stands for name of the plugin that is to be installed.
}}
}}


After the plugin sources are downloaded from the internet, change to the ''PLUGINS/src'' directory of VDR
After the plugin sources have been downloaded from the internet, change to the ''PLUGINS/src'' directory of VDR
<pre>
<pre>
cd $SOURCEDIR/VDR/PLUGINS/src
cd $SOURCEDIR/vdr/PLUGINS/src
</pre>
</pre>
and decompress the archive.
and decompress the archive.


Is it a BZIP2 archive (*.tar.bz2) use
If it is a BZIP2 archive (*.tar.bz2), use
<pre>
<pre>
tar -jxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.tar.bz2
tar -jxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.tar.bz2
</pre>
</pre>
when it's a GZIP archive (*.tgz, *.tar.gz) use
If it is a GZIP archive (*.tgz, *.tar.gz), use
<pre>
<pre>
tar -zxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.{tgz,tar.gz}
tar -zxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.{tgz,tar.gz}
</pre>
</pre>


Finally an symbolic link to the plugin name without the version number is to be created
Finally, a symbolic link to the plugin name without the version number is to be created
<pre>
<pre>
ln -s $PLUGIN_NAME-<VERSION $PLUGIN_NAME
ln -s $PLUGIN_NAME-<VERSION> $PLUGIN_NAME
</pre>
</pre>


{{Box Hint|
{{Box Info|
These instruction assume that the author of the plugin stick with the naming conventions for VDR plugins. unfortunately this is not always the case.
These instruction assume that the author of the plugin sticks with the naming conventions for VDR plugins. Unfortunately, this is not always the case.


VDR only compiles plugins in directories without version numbers and prefixes like ''vdr-'' or ''plugin-''. (Attention: ''vdrcd'' is correct, but ''vdr-cd'' not).
VDR only compiles plugins in directories without version numbers and prefixes like ''vdr-'' or ''plugin-''. (Attention: ''vdrcd'' is correct, but ''vdr-cd'' not).
}}
{{Box Info|
These instruction also assume that the main vdr directory has been patched by the new user according to the relevant recommandation provided within each README or INSTALL plugin file.

You should take into notice that usually there is a patch(es) directory provided within plugins. And you are pretty often expected to patch your main vdr directory with some of those patches.
}}
}}


Line 40: Line 45:
</pre>
</pre>


After everything has compiled without errors copy the plugins to their target directory
After everything has been compiled without errors, copy the plugins to their target directory
<pre>
<pre>
cp PLUGINS/lib/* /usr/lib/vdr
cp PLUGINS/lib/* /usr/lib/vdr
</pre>
</pre>

And last but not least you have to add the plugin to the vdr start command
<pre>
vdr ....... -P$PLUGIN_NAME ....
</pre>
The vdr start command can be found in runvdr, vdrstart, or any other script file depending on the distribution you are using.


==For developers==
==For developers==
Line 70: Line 81:
plugin's name, and '0.0.1' will be your plugin's current version number.
plugin's name, and '0.0.1' will be your plugin's current version number.
</pre>
</pre>

<!-- Link to german wiki page -->
[[de:Plugin Installation]]

<!-- Link to russian wiki page -->
[[ru:Инсталляция модуля расширения]]

Latest revision as of 08:01, 6 July 2008

The installation instruction of all plugins is basically the same. For specialties see the particual plugins description. But the last instance is always the README file of the plugin.

Installation

Info
Info

The variable $SOURCEDIR stands for the directory where all the sources archives should be decompressed. Common directories are /usr/local/src, /usr/src and the home directory of the user.

The variable $PLUGIN_NAME stands for name of the plugin that is to be installed.


After the plugin sources have been downloaded from the internet, change to the PLUGINS/src directory of VDR

cd $SOURCEDIR/vdr/PLUGINS/src

and decompress the archive.

If it is a BZIP2 archive (*.tar.bz2), use

tar -jxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.tar.bz2

If it is a GZIP archive (*.tgz, *.tar.gz), use

tar -zxvf /path/to/vdr-$PLUGIN_NAME-<VERSION>.{tgz,tar.gz}

Finally, a symbolic link to the plugin name without the version number is to be created

ln -s $PLUGIN_NAME-<VERSION> $PLUGIN_NAME
Info
Info

These instruction assume that the author of the plugin sticks with the naming conventions for VDR plugins. Unfortunately, this is not always the case.

VDR only compiles plugins in directories without version numbers and prefixes like vdr- or plugin-. (Attention: vdrcd is correct, but vdr-cd not).

Info
Info

These instruction also assume that the main vdr directory has been patched by the new user according to the relevant recommandation provided within each README or INSTALL plugin file.

You should take into notice that usually there is a patch(es) directory provided within plugins. And you are pretty often expected to patch your main vdr directory with some of those patches.


Change to the VDR root directory and compile the plugins

cd ../..
make plugins

After everything has been compiled without errors, copy the plugins to their target directory

cp PLUGINS/lib/* /usr/lib/vdr

And last but not least you have to add the plugin to the vdr start command

vdr ....... -P$PLUGIN_NAME ....

The vdr start command can be found in runvdr, vdrstart, or any other script file depending on the distribution you are using.

For developers

Sinngemäß entsprechend ../VDR/PLUGINS.html: An extract of ../VDR/PLUGINS.html

Erstellen eines Plugin-Pakets

If you want to make your plugin available to other VDR users, you'll need to
make a package that can be easily distributed.
The 'Makefile' that has been created by the call to newplugin
provides the target 'dist', which does this for you.

Simply change into your source directory and execute 'make dist':


 cd VDR/PLUGINS/src/hello
 make dist

After this you should find a file named like

 vdr-hello-0.0.1.tgz


in your source directory, where 'hello' will be replaced with your actual
plugin's name, and '0.0.1' will be your plugin's current version number.