<html>
<head>
<title>QuartzPVR Help - Config</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<link rel="stylesheet" type="text/css" href="css/help.css" media="all">
</head>
<body class='pod'>
<!--
generated by Pod::Simple::HTML v3.03,
using Pod::Simple::PullParser v2.02,
under Perl v5.010001 at Tue Sep 6 10:12:58 2011 GMT.
If you want to change this HTML document, you probably shouldn't do that
by changing it directly. Instead, see about changing the calling options
to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
then reconverting this document from the Pod source.
When in doubt, email the author of Pod::Simple::HTML for advice.
See 'perldoc Pod::Simple::HTML' for more info.
-->
<!-- start doc -->
<p class="backlinktop">
<b> <a name="___top" href="../.." title="Back to application"><img
src="images/tv.png" />
</a> <a href="index.html" title="Help Index"><img
src="images/help.png" />
</a> </b>
</p>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#Installed_Constants'>Installed
Constants</a>
<ul class='indexList indexList3'>
<li class='indexItem indexItem3'><a
href='#Config%2FConstants.inc'>Config/Constants.inc</a>
<ul class='indexList indexList4'>
<li class='indexItem indexItem4'><a href='#Location'>Location</a>
<li class='indexItem indexItem4'><a href='#Description'>Description</a>
<li class='indexItem indexItem4'><a href='#Contents'>Contents</a>
</ul>
<li class='indexItem indexItem3'><a
href='#Config%2FSqlConstants.inc'>Config/SqlConstants.inc</a>
<ul class='indexList indexList4'>
<li class='indexItem indexItem4'><a href='#Location'>Location</a>
<li class='indexItem indexItem4'><a href='#Description'>Description</a>
<li class='indexItem indexItem4'><a href='#Access'>Access</a>
</ul>
<li class='indexItem indexItem3'><a
href='#Config%2FPHP%2FInstall.pm'>Config/PHP/Install.pm</a>
<ul class='indexList indexList4'>
<li class='indexItem indexItem4'><a href='#Location'>Location</a>
<li class='indexItem indexItem4'><a href='#Description'>Description</a>
</ul>
<li class='indexItem indexItem3'><a
href='#Config%2FSqlConstants.pm'>Config/SqlConstants.pm</a>
<ul class='indexList indexList4'>
<li class='indexItem indexItem4'><a href='#Location'>Location</a>
<li class='indexItem indexItem4'><a href='#Description'>Description</a>
<li class='indexItem indexItem4'><a href='#Access'>Access</a>
</ul>
</ul>
</ul>
</ul>
</div>
<h2>
<a class='u' href='#___top' title='click to go to top of document'
name="Installed_Constants">Installed Constants</a>
</h2>
<p>When you install this application, a number of files containing
various constants are created based on the answers to the questions
the install script asked.</p>
<p>Most constants are stored in the PHP file Config/Constants.inc.
This provides constant values for directories, user names etc. both
for the web application and for all of the Perl scripts.</p>
<p>There are some other files created, some of which have to be
protected from casual viewing because they contain the MySQL password
of the QuartzPVR database. The full pathname of the files, as
installed on this system are:</p>
<h3>
<a class='u' href='#___top' title='click to go to top of document'
name="Config/Constants.inc">Config/Constants.inc</a>
</h3>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Location">Location</a>
</h4>
<p>
<b>%PVR_ROOT%/php/Config/Constants.inc</b>
</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Description">Description</a>
</h4>
<p>Contains most of the constants/settings used by the web
application and the Perl scripts. You may adjust some of these
settings to change the behaviour of the application.</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Contents">Contents</a>
</h4>
<dl>
<!-- -->
<dt>
<a name="PVR_USER"><b>PVR_USER</b>
</a>
</dt>
<dd>
<p>
The Linux user to use for Quartz PVR Perl scripts. Set to <b>%PVR_USER%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="PVR_GROUP"><b>PVR_GROUP</b>
</a>
</dt>
<dd>
<p>
The primary group of the Linux user used for Quartz PVR. Set to <b>%PVR_GROUP%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="PVR_HOME"><b>PVR_HOME</b>
</a>
</dt>
<dd>
<p>
The home directory of the Linux user used for Quartz PVR. Set to <b>%PVR_HOME%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="PVR_LOGDIR"><b>PVR_LOGDIR</b>
</a>
</dt>
<dd>
<p>
Main logging directory to use for logging Perl script output. Set to
<b>%PVR_LOGDIR%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="MAIL_TO"><b>MAIL_TO</b>
</a>
</dt>
<dd>
<p>
The mail account that the Perl scripts will send any run errors to.
Set to <b>%MAIL_TO%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="DATABASE"><b>DATABASE</b>
</a>
</dt>
<dd>
<p>
The MySQL database name. Set to <b>%DATABASE%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="PVR_ROOT"><b>PVR_ROOT</b>
</a>
</dt>
<dd>
<p>
The top-level directory under which the web application is
installed. Set to <b>%PVR_ROOT%</b>
</p>
<dt>
<a name="DVBT_FREQFILE"><b>DVBT_FREQFILE</b>
</a>
</dt>
<dd>
<p>
The frequency file to use with the dvbt-scan script when setting up
the DVB-T initial tuning. Set to <b>%DVBT_FREQFILE%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="VIDEO_DIR"><b>VIDEO_DIR</b>
</a>
</dt>
<dd>
<p>
Top-level directory for recording videos. Video files will be stored
in sub-directories under this directory. Set to <b>%VIDEO_DIR%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="AUDIO_DIR"><b>AUDIO_DIR</b>
</a>
</dt>
<dd>
<p>
Top-level directory for recording audio. Audio files will be stored
in sub-directories under this directory. Set to <b>%AUDIO_DIR%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="VIDEO_TRASH"><b>VIDEO_TRASH</b>
</a>
</dt>
<dd>
<p>
During recording, various temporary video files are created and then removed. By default the "deleted" files are moved
to this trashcan location. A cron job is set up in the QUARTZPVR user's crontab which deletes trash files after a week.
This is done to ensure you always have access to the raw recording just in case the file left in the video directory
is not playable (allows for re-processing the original). Set to <b>%VIDEO_TRASH%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="VIDEO_PATH"><b>VIDEO_PATH</b>
</a>
</dt>
<dd>
<p>
Recorded video file will be stored with this full pathname. Obviously the filename must contain variables otherwise every
recording will overwrite the previous recording. Set to <b>%VIDEO_PATH%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="AUDIO_PATH"><b>AUDIO_PATH</b>
</a>
</dt>
<dd>
<p>
Recorded audio file will be stored with this full pathname. Set to <b>%AUDIO_PATH%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="SERVER_PORT"><b>SERVER_PORT</b>
</a>
</dt>
<dd>
<p>
The TCP port number to be used by the Quartz PVR server (which
interfaces requests from the web application to the Perl scheduling
script). Set to <b>%SERVER_PORT%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="ADAPTERS"><b>ADAPTERS</b>
</a>
</dt>
<dd>
<p>
Space separated list of the DVB-T/T2 adapter numbers to use (leave blank for default). This can be used
to keep one or more adapter unused by the PVR (e.g. so that it is available for testing purposes). Also,
if you use udev to number your adapters in a fixed manner, you can specify that the PVR use those
fixed numbers (rather than the random set generated on boot up).
Set to <b>%ADAPTERS%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="ADSKIP"><b>ADSKIP</b>
</a>
</dt>
<dd>
<p>
Advert removal control: 1=remove adverts, 0=do not remove adverts. Set to <b>%ADSKIP%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="PHP_SEARCH"><b>PHP_SEARCH</b>
</a>
</dt>
<dd>
<p>
If this flag is set, then the scripts search all PHP library code defined in php.ini and add any variables
found into the PVR namespace (PHP and Perl). This would allow you to set extra variables that could then
be used in the scripts. However, this is more likely to cause namespace clashes and prevent the PVR from running.
Set to <b>%PHP_SEARCH%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="PHP_LOG"><b>PHP_LOG</b>
</a>
</dt>
<dd>
<p>
Debug: Log file to use for PHP application. Default is no log file specified so no logging is done.
Note: You are responsible for ensuring the directory is writable by the web server.
Set to <b>'%PHP_LOG%'</b>
</p>
</dd>
<!-- -->
<dt>
<a name="SERVER_DEBUG"><b>SERVER_DEBUG</b>
</a>
</dt>
<dd>
<p>
Debug: Level of server debug logging. Debug logs will be stored in /var/log/quartzpvr-server.log. Set to <b>%SERVER_DEBUG%</b>
</p>
</dd>
<!-- -->
<dt>
<a name="DATE_TZ"><b>DATE_TZ</b>
</a>
</dt>
<dd>
<p>The date timezone setting for the PHP application. Set to <b>%DATE_TZ%</b>
</p>
</dd>
</dl>
<h3>
<a class='u' href='#___top' title='click to go to top of document'
name="Config/SqlConstants.inc">Config/SqlConstants.inc</a>
</h3>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Location">Location</a>
</h4>
<p>
<b>%PVR_ROOT%/php/Config/SqlConstants.inc</b>
</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Description">Description</a>
</h4>
<p>Contains the MySQL username and password for the Quartz PVR
database.</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Access">Access</a>
</h4>
<p>This is only readable by root or the web server.</p>
<h3>
<a class='u' href='#___top' title='click to go to top of document'
name="Config/PHP/Install.pm">Config/PHP/Install.pm</a>
</h3>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Location">Location</a>
</h4>
<p>
<b>%perl_lib%/Linux/DVB/DVBT/Apps/QuartzPVR/Config/PHP/Install.pm</b>
</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Description">Description</a>
</h4>
<p>Contains the full path to the web application to allow the Perl
scripts access.</p>
<h3>
<a class='u' href='#___top' title='click to go to top of document'
name="Config/SqlConstants.pm">Config/SqlConstants.pm</a>
</h3>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Location">Location</a>
</h4>
<p>
<b>%perl_lib%/Linux/DVB/DVBT/Apps/QuartzPVR/Config/SqlConstants.pm</b>
</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Description">Description</a>
</h4>
<p>Contains the MySQL username and password for the Quartz PVR
database.</p>
<h4>
<a class='u' href='#___top' title='click to go to top of document'
name="Access">Access</a>
</h4>
<p>This is only readable by root or the Quartz PVR Linux user.</p>
<!-- end doc -->
</body>
</html>