Created VDR command reference (markdown)

Manuel Reimer 2022-01-30 12:43:46 +01:00
parent dad00355de
commit f113df9791

647
VDR-command-reference.md Normal file

@ -0,0 +1,647 @@
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Sun Jan 30 11:38:57 2022 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>vdr</title>
</head>
<body>
<h1 align="center">vdr</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#SIGNALS">SIGNALS</a><br>
<a href="#EXIT STATUS">EXIT STATUS</a><br>
<a href="#FILES">FILES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#REPORTING BUGS">REPORTING BUGS</a><br>
<a href="#COPYRIGHT">COPYRIGHT</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">vdr &minus; the
Video Disk Recorder</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>vdr</b>
[options]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>vdr</b>
implements a complete digital Set-Top Box and Video
Recorder. It can work with signals received from satellites
(DVB-S) as well as cable (DVB-C) and terrestrial (DVB-T)
signals.</p>
<p style="margin-left:11%; margin-top: 1em">At least one
DVB card is required to run <b>vdr</b>. With it you can
watch live TV while recording one or more other broadcasts
from the same transponder. It is also possible to start
watching a recorded programme before the live broadcast has
ended (<b>time shifting</b>). In order to record from
different transponders simultaneously two or more DVB cards
are necessary. By default <b>vdr</b> can support up to eight
DVB cards. The primary DVB card (the one your TV set is
connected to) can either be a &quot;full featured&quot;
card, which means it contains an MPEG decoder and provides
audio and video signal outputs, or you can use some third
party plugin that implements software decoding of the MPEG
data and displays it via the system&rsquo;s graphics
adapter.</p>
<p style="margin-left:11%; margin-top: 1em"><b>vdr</b> uses
an On Screen Display (OSD) to display its menus. It can be
controlled by the PC keyboard, the &quot;Linux Infrared
Remote Control&quot; (LIRC), or any other means of remote
control, implemented by a third party plugin.</p>
<p style="margin-left:11%; margin-top: 1em">Remote access
is possible via the &quot;Simple Video Disk Recorder
Protocol&quot; (SVDRP), which can be accessed on port 6419,
for instance by <b>telnet</b>.</p>
<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;a&nbsp;</b><i>cmd</i><b>,&nbsp;&minus;&minus;audio=</b><i>cmd</i></p>
<p style="margin-left:22%;">Send Dolby Digital audio to
stdin of command <i>cmd</i>.</p>
<p style="margin-left:11%;"><b>&minus;&minus;cachedir=</b><i>dir</i></p>
<p style="margin-left:22%;">Save cache files in <i>dir</i>
(default is to save them in the video directory).</p>
<p style="margin-left:11%;"><b>&minus;&minus;chartab=</b><i>character_table</i></p>
<p style="margin-left:22%;">Set the character table to use
for strings in the DVB data stream that don&rsquo;t begin
with a character table indicator, but don&rsquo;t use the
standard default character table (for instance
ISO-8859-9).</p>
<p style="margin-left:11%;"><b>&minus;c&nbsp;</b><i>dir</i><b>,&nbsp;&minus;&minus;config=</b><i>dir</i></p>
<p style="margin-left:22%;">Read config files from
directory <i>dir</i> (default is to read them from the video
directory).</p>
<p style="margin-left:11%;"><b>&minus;d,
&minus;&minus;daemon</b></p>
<p style="margin-left:22%;">Run in daemon mode (implies
&minus;&minus;no&minus;kbd).</p>
<p style="margin-left:11%;"><b>&minus;D&nbsp;</b><i>num</i><b>,&nbsp;&minus;&minus;device=</b><i>num</i></p>
<p style="margin-left:22%;">Use only the given DVB device
(<i>num</i> = 0, 1, 2...). There may be several
<b>&minus;D</b> options (by default all DVB devices will be
used). If <b>&minus;D&minus;</b> is given, no DVB devices
will be used at all, independent of any other &minus;D
options.</p>
<p style="margin-left:11%;"><b>&minus;&minus;dirnames=</b><i>path</i><b>[,</b><i>name</i><b>[,</b><i>enc</i><b>]]</b></p>
<p style="margin-left:22%;">Set the maximum directory path
length to <i>path</i> (default is the maximum value allowed
on the system). If <i>name</i> is also given, it defines the
maximum directory name length (default is the maximum value
allowed on the system). The optional <i>enc</i> can be 0 or
1, and controls whether special characters in directory
names are encoded as hex values (default: 0). If <i>path</i>
or <i>name</i> are left empty (as in &quot;,,1&quot; to only
set <i>enc</i>), the defaults apply. The length of the video
directory name and that of the actual recording directory is
subtracted from <i>path</i>, to make sure the directory path
will never become too long.</p>
<p style="margin-left:11%;"><b>&minus;&minus;edit=</b><i>rec</i></p>
<p style="margin-left:22%;">Edit the given recording.
<i>rec</i> must be the full path name of an existing
recording. The program will return immediately after editing
the recording.</p>
<p style="margin-left:11%;"><b>&minus;E&nbsp;</b><i>file</i><b>,&nbsp;&minus;&minus;epgfile=</b><i>file</i></p>
<p style="margin-left:22%;">Write the EPG data into the
given <i>file</i> (default is <i>epg.data</i> in the cache
directory). Use <b>&minus;E&minus;</b> to disable this. If
<i>file</i> is a directory, the file <i>epg.data</i> will be
created in that directory.</p>
<p style="margin-left:11%;"><b>&minus;&minus;filesize=</b><i>size</i></p>
<p style="margin-left:22%;">Limit video files to
<i>size</i> bytes (default is 2000M). This option is only
useful in conjunction with --edit, and must precede that
option to have an effect. <i>size</i> is an integer number
and may be followed by one of the letters K, M, G or T to
abbreviate Kilo-, Mega-, Giga- or Terabyte, respectively.
The given value is silently limited to the program&rsquo;s
internal minimum and maximum values.</p>
<p style="margin-left:11%;"><b>&minus;&minus;genindex=</b><i>rec</i></p>
<p style="margin-left:22%;">Generate the index file for the
given recording. <i>rec</i> must be the full path name of an
existing recording. The recording must be in TS format. If
the recording already has an index file, it will be deleted
before creating the new one. The program will return
immediately after generating the index. Note that using this
option while another instance of VDR is currently replaying
the given recording, or if the recording has not been
finished yet, may lead to unexpected results.</p>
<p style="margin-left:11%;"><b>&minus;g,&nbsp;&minus;&minus;grab=</b><i>dir</i></p>
<p style="margin-left:22%;">Write images from the SVDRP
command GRAB into the given directory <i>dir</i>. <i>dir</i>
must be the full path name of an existing directory, without
any &quot;..&quot;, double &rsquo;/&rsquo; or symlinks. By
default, or if <b>&minus;g&minus;</b> is given, grabbing
images to disk is disabled.</p>
<p style="margin-left:11%;"><b>&minus;h,
&minus;&minus;help</b></p>
<p style="margin-left:22%;">Print a help message and
exit.</p>
<p style="margin-left:11%;"><b>&minus;i&nbsp;</b><i>instance</i><b>,&nbsp;&minus;&minus;instance=</b><i>instance</i></p>
<p style="margin-left:22%;">Use <i>instance</i> as the id
of this VDR instance (default is 0). In an environment where
several instances of VDR use the same video directory, this
parameter can be set to a positive integer value
that&rsquo;s unique for each instance, so that they
won&rsquo;t interfere with each other in case they record
exactly the same broadcast. The number given here will be
part of the directory name in which the recordings will be
stored.</p>
<p style="margin-left:11%;"><b>&minus;l&nbsp;</b><i>level</i><b>,&nbsp;&minus;&minus;log=</b><i>level</i></p>
<p style="margin-left:22%;">Set logging to <i>level</i>.
<b>0&nbsp;</b>=&nbsp;no logging, <b>1&nbsp;</b>=&nbsp;errors
only, <b>2&nbsp;</b>=&nbsp;errors and info,
<b>3&nbsp;</b>=&nbsp;errors, info and debug. The default
logging level is <b>3</b>. If logging should be done to
LOG_LOCAL<i>n</i> instead of LOG_USER, add &rsquo;.n&rsquo;
to LEVEL, as in 3.7 (n=0..7).</p>
<p style="margin-left:11%;"><b>&minus;L&nbsp;</b><i>dir</i><b>,&nbsp;&minus;&minus;lib=</b><i>dir</i></p>
<p style="margin-left:22%;">Search for plugins in directory
<i>dir</i> (default is ./PLUGINS/lib). There can be several
<b>&minus;L</b> options with different <i>dir</i> values.
Each of them will apply to the <b>&minus;P</b> options
following it.</p>
<p style="margin-left:11%;"><b>&minus;&minus;lirc[=</b><i>path</i><b>]</b></p>
<p style="margin-left:22%;">Use a LIRC remote control
device. If <i>path</i> is omitted, vdr uses
<i>/var/run/lirc/lircd</i>.</p>
<p style="margin-left:11%;"><b>&minus;&minus;localedir=</b><i>dir</i></p>
<p style="margin-left:22%;">Search for locale files in
<i>dir</i> (default is ./locale).</p>
<p style="margin-left:11%;"><b>&minus;m,
&minus;&minus;mute</b></p>
<p style="margin-left:22%;">Mute audio of the primary DVB
device at startup.</p>
<p style="margin-left:11%;"><b>&minus;&minus;no&minus;kbd</b></p>
<p style="margin-left:22%;">Don&rsquo;t use the keyboard as
an input device.</p>
<p style="margin-left:11%;"><b>&minus;p&nbsp;</b><i>port</i><b>,&nbsp;&minus;&minus;port=</b><i>port</i></p>
<p style="margin-left:22%;">Use <i>port</i> for SVDRP. A
value of <b>0</b> turns off SVDRP. The default SVDRP port is
<b>6419</b>. You need to edit the file
<i>svdrphosts.conf</i> in order to enable access to the
SVDRP port from hosts other than the localhosts. Note that
this option only changes the TCP port used for SVDRP
commands. The UDP port for discovering peer VDRs in the same
network is always set to 6419 and can&rsquo;t be
changed.</p>
<p style="margin-left:11%;"><b>&minus;P&nbsp;</b><i>options</i><b>,&nbsp;&minus;&minus;plugin=</b><i>options</i></p>
<p style="margin-left:22%;">Load a plugin, defined by the
given <i>options</i>. The first word in <i>options</i> must
be the name of an existing <b>vdr</b> plugin, optionally
followed by a blank separated list of command line options
for that plugin. If <i>options</i> contains any blanks, you
need to enclose it in quotes, like for example</p>
<p style="margin-left:22%; margin-top: 1em"><b>vdr &minus;P
&quot;abc &minus;a &minus;b xyz&quot;</b></p>
<p style="margin-left:22%; margin-top: 1em">which would
load a plugin named <b>abc</b>, giving it the command line
options <b>&minus;a&nbsp;&minus;b&nbsp;xyz</b>. If you want
to load all available plugins (without any particular
options) you can use</p>
<p style="margin-left:22%; margin-top: 1em"><b>vdr &minus;P
&quot;*&quot;</b></p>
<p style="margin-left:22%; margin-top: 1em">(note the
quotes around the asterisk to prevent wildcard
expansion).</p>
<p style="margin-left:11%;"><b>&minus;r&nbsp;</b><i>cmd</i><b>,&nbsp;&minus;&minus;record=</b><i>cmd</i></p>
<p style="margin-left:22%;">Call <i>cmd</i> before and
after a recording. See the file <i>INSTALL</i> for more
information.</p>
<p style="margin-left:11%;"><b>&minus;&minus;resdir=</b><i>dir</i></p>
<p style="margin-left:22%;">Read resource files from
<i>dir</i> (default is to read them from the config
directory).</p>
<p style="margin-left:11%;"><b>&minus;&minus;showargs[=</b><i>dir</i><b>]</b></p>
<p style="margin-left:22%;">Read command line arguments
from <i>dir</i> (default is <i>/etc/vdr/conf.d</i>), display
them to the console and exit.</p>
<p style="margin-left:11%;"><b>&minus;s&nbsp;</b><i>cmd</i><b>,&nbsp;&minus;&minus;shutdown=</b><i>cmd</i></p>
<p style="margin-left:22%;">Call <i>cmd</i> to shutdown the
computer. See the file <i>INSTALL</i> for more
information.</p>
<p style="margin-left:11%;"><b>&minus;&minus;split</b></p>
<p style="margin-left:22%;">Split edited files at the
editing marks. This option is only useful in conjunction
with --edit, and must precede that option to have an
effect.</p>
<p style="margin-left:11%;"><b>&minus;t&nbsp;</b><i>tty</i><b>,&nbsp;&minus;&minus;terminal=</b><i>tty</i></p>
<p style="margin-left:22%;">Set the controlling
terminal.</p>
<p style="margin-left:11%;"><b>&minus;u&nbsp;</b><i>user</i><b>,&nbsp;&minus;&minus;user=</b><i>user</i></p>
<p style="margin-left:22%;">Run as user <i>user</i> in case
vdr was started as user &rsquo;root&rsquo;. Starting vdr as
&rsquo;root&rsquo; is necessary if the system time shall be
set from the transponder data, but for security reasons vdr
can switch to a lesser privileged user id during normal
operation. <i>user</i> can be a user name or a numerical
id.</p>
<p style="margin-left:11%;"><b>&minus;&minus;updindex=</b><i>rec</i></p>
<p style="margin-left:22%;">Update the index file for the
given recording. <i>rec</i> must be the full path name of an
existing recording. The recording must be in TS format. If
the recording already has an index file, it will be checked
whether it is complete, and will be updated if it
isn&rsquo;t. If there is no index file yet, a new one will
be generated. The program will return immediately after
updating the index. Note that using this option while
another instance of VDR is currently replaying the given
recording, or if the recording has not been finished yet,
may lead to unexpected results.</p>
<p style="margin-left:11%;"><b>&minus;&minus;userdump</b></p>
<p style="margin-left:22%;">Allow coredumps if -u is given
(only for debugging).</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>&minus;&minus;vfat</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>For backwards compatibility (same as
&minus;&minus;dirnames= 250,40,1).</p></td></tr>
</table>
<p style="margin-left:11%;"><b>&minus;v&nbsp;</b><i>dir</i><b>,&nbsp;&minus;&minus;video=</b><i>dir</i></p>
<p style="margin-left:22%;">Use <i>dir</i> as video
directory. The default is <i>/video</i>.</p>
<p style="margin-left:11%;"><b>&minus;V,
&minus;&minus;version</b></p>
<p style="margin-left:22%;">Print version information and
exit.</p>
<p style="margin-left:11%;"><b>&minus;w&nbsp;</b><i>sec</i><b>,&nbsp;&minus;&minus;watchdog=</b><i>sec</i></p>
<p style="margin-left:22%;">Activate the watchdog timer
with a timeout of <i>sec</i> seconds. A value of <b>0</b>
(default) disables the watchdog.</p>
<p style="margin-left:11%; margin-top: 1em">If started
without any options, vdr tries to read command line options
from files named &rsquo;*.conf&rsquo; in the directory
/etc/vdr/conf.d. Files are read in alphabetical order. See
vdr(5) for details.</p>
<h2>SIGNALS
<a name="SIGNALS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>SIGINT,
SIGTERM</b></p>
<p style="margin-left:22%;">Program exits with status
0.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>SIGHUP</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Program exits with status 1. This can be used to force a
reload, for example if an update has been installed.</p></td></tr>
</table>
<h2>EXIT STATUS
<a name="EXIT STATUS"></a>
</h2>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p style="margin-top: 1em"><b>0</b></p></td>
<td width="10%"></td>
<td width="78%">
<p style="margin-top: 1em">Successful program
execution.</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p><b>1</b></p></td>
<td width="10%"></td>
<td width="78%">
<p>An error has been detected which requires the DVB driver
and <b>vdr</b> to be reloaded.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p><b>2</b></p></td>
<td width="10%"></td>
<td width="78%">
<p>An non-recoverable error has been detected, <b>vdr</b>
has given up.</p></td></tr>
</table>
<h2>FILES
<a name="FILES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>channels.conf</i></p>
<p style="margin-left:22%;">Channel configuration.</p>
<p style="margin-left:11%;"><i>timers.conf</i></p>
<p style="margin-left:22%;">Timer configuration.</p>
<p style="margin-left:11%;"><i>setup.conf</i></p>
<p style="margin-left:22%;">User definable setup.</p>
<p style="margin-left:11%;"><i>commands.conf</i></p>
<p style="margin-left:22%;">User definable commands
(executed from the <b>Commands</b> menu).</p>
<p style="margin-left:11%;"><i>svdrphosts.conf</i></p>
<p style="margin-left:22%;">SVDRP host configuration,
defining which hosts or networks are given access to the
SVDRP port.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><i>marks</i></p></td>
<td width="2%"></td>
<td width="78%">
<p>Contains the editing marks defined for a recording.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><i>info</i></p></td>
<td width="2%"></td>
<td width="78%">
<p>Contains a description of the recording.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><i>resume</i></p></td>
<td width="2%"></td>
<td width="78%">
<p>Contains the index into the recording where the last
replay session left off.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><i>index</i></p></td>
<td width="2%"></td>
<td width="78%">
<p>Contains the file number, offset and type of each frame
of the recording.</p></td></tr>
</table>
<p style="margin-left:11%;"><i>remote.conf</i></p>
<p style="margin-left:22%;">Contains the key assignments
for the remote control.</p>
<p style="margin-left:11%;"><i>keymacros.conf</i></p>
<p style="margin-left:22%;">Contains user defined remote
control key macros.</p>
<p style="margin-left:11%;"><i>00001.ts&nbsp;</i>...&nbsp;<i>65535.ts</i></p>
<p style="margin-left:22%;">The actual data files of a
recording.</p>
<p style="margin-left:11%;"><i>epg.data</i></p>
<p style="margin-left:22%;">Contains all current EPG data.
Can be used for external processing and will also be read at
program startup to have the full EPG data available
immediately.</p>
<p style="margin-left:11%;"><i>.update</i></p>
<p style="margin-left:22%;">If this file is present in the
video directory, its last modification time will be used to
trigger an update of the list of recordings in the
&quot;Recordings&quot; menu.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>vdr</b>(5),<b>svdrpsend</b>(1)</p>
<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Written by
Klaus Schmidinger, with contributions from many others. See
the file <i>CONTRIBUTORS</i> in the <b>vdr</b> source
distribution.</p>
<h2>REPORTING BUGS
<a name="REPORTING BUGS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Report bugs to
&lt;vdr&minus;bugs@tvdr.de&gt;.</p>
<h2>COPYRIGHT
<a name="COPYRIGHT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Copyright
&copy; 2018 Klaus Schmidinger.</p>
<p style="margin-left:11%; margin-top: 1em">This is free
software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.</p>
<hr>
</body>
</html>