diff --git a/VDR-command-reference.md b/VDR-command-reference.md index cd23335..97ce057 100644 --- a/VDR-command-reference.md +++ b/VDR-command-reference.md @@ -41,26 +41,26 @@

OPTIONS

-
-a cmd, --audio=cmd
+

-a cmd, --audio=cmd

Send Dolby Digital audio to stdin of command cmd.
-
--cachedir=dir
+

--cachedir=dir

Save cache files in dir (default is to save them in the video directory).
-
--chartab=character_table
+

--chartab=character_table

Set the character table to use for strings in the DVB data stream that don't begin with a character table indicator, but don't use the standard default character table (for instance ISO-8859-9).
-
-c dir, --config=dir
+

-c dir, --config=dir

Read config files from directory dir (default is to read them from the video directory).
-
-d, --daemon
+

-d, --daemon

Run in daemon mode (implies --no-kbd).
-
-D num, --device=num
+

-D num, --device=num

Use only the given DVB device (num = 0, 1, 2...). There may be several -D options (by default all DVB devices will be used). If -D- is given, no DVB devices will be used at all, independent of any other -D options.
-
--dirnames=path[,name[,enc]]
+

--dirnames=path[,name[,enc]]

Set the maximum directory path length to path (default is the maximum value allowed on the system). If name is also given, it defines the maximum directory name length (default is the maximum value @@ -71,23 +71,23 @@ the video directory name and that of the actual recording directory is subtracted from path, to make sure the directory path will never become too long.
-
--edit=rec
+

--edit=rec

Edit the given recording. rec must be the full path name of an existing recording. The program will return immediately after editing the recording.
-
-E file, --epgfile=file
+

-E file, --epgfile=file

Write the EPG data into the given file (default is epg.data in the cache directory). Use -E- to disable this. If file is a directory, the file epg.data will be created in that directory.
-
--filesize=size
+

--filesize=size

Limit video files to size bytes (default is 2000M). This option is only useful in conjunction with --edit, and must precede that option to have an effect. size 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's internal minimum and maximum values.
-
--genindex=rec
+

--genindex=rec

Generate the index file for the given recording. rec 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 @@ -95,47 +95,47 @@ 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.
-
-g, --grab=dir
+

-g, --grab=dir

Write images from the SVDRP command GRAB into the given directory dir. dir must be the full path name of an existing directory, without any "..", double '/' or symlinks. By default, or if -g- is given, grabbing images to disk is disabled.
-
-h, --help
+

-h, --help

Print a help message and exit.
-
-i instance, --instance=instance
+

-i instance, --instance=instance

Use instance 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's unique for each instance, so that they won'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.
-
-l level, --log=level
+

-l level, --log=level

Set logging to level. 0 = no logging, 1 = errors only, 2 = errors and info, 3 = errors, info and debug. The default logging level is 3. If logging should be done to LOG_LOCALn instead of LOG_USER, add '.n' to LEVEL, as in 3.7 (n=0..7).
-
-L dir, --lib=dir
+

-L dir, --lib=dir

Search for plugins in directory dir (default is ./PLUGINS/lib). There can be several -L options with different dir values. Each of them will apply to the -P options following it.
-
--lirc[=path]
+

--lirc[=path]

Use a LIRC remote control device. If path is omitted, vdr uses /var/run/lirc/lircd.
-
--localedir=dir
+

--localedir=dir

Search for locale files in dir (default is ./locale).
-
-m, --mute
+

-m, --mute

Mute audio of the primary DVB device at startup.
-
--no-kbd
+

--no-kbd

Don't use the keyboard as an input device.
-
-p port, --port=port
+

-p port, --port=port

Use port for SVDRP. A value of 0 turns off SVDRP. The default SVDRP port is 6419. You need to edit the file svdrphosts.conf 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't be changed.
-
-P options, --plugin=options
+

-P options, --plugin=options

Load a plugin, defined by the given options. The first word in options must be the name of an existing vdr plugin, optionally followed by a blank separated list of command line options for @@ -149,31 +149,31 @@

(note the quotes around the asterisk to prevent wildcard expansion).

-
-r cmd, --record=cmd
+

-r cmd, --record=cmd

Call cmd before and after a recording. See the file INSTALL for more information.
-
--resdir=dir
+

--resdir=dir

Read resource files from dir (default is to read them from the config directory).
-
--showargs[=dir]
+

--showargs[=dir]

Read command line arguments from dir (default is /etc/vdr/conf.d), display them to the console and exit.
-
-s cmd, --shutdown=cmd
+

-s cmd, --shutdown=cmd

Call cmd to shutdown the computer. See the file INSTALL for more information.
-
--split
+

--split

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.
-
-t tty, --terminal=tty
+

-t tty, --terminal=tty

Set the controlling terminal.
-
-u user, --user=user
+

-u user, --user=user

Run as user user in case vdr was started as user 'root'. Starting vdr as 'root' 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. user can be a user name or a numerical id.
-
--updindex=rec
+

--updindex=rec

Update the index file for the given recording. rec 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 @@ -182,15 +182,15 @@ 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.
-
--userdump
+

--userdump

Allow coredumps if -u is given (only for debugging).
-
--vfat
+

--vfat

For backwards compatibility (same as --dirnames= 250,40,1).
-
-v dir, --video=dir
+

-v dir, --video=dir

Use dir as video directory. The default is /video.
-
-V, --version
+

-V, --version

Print version information and exit.
-
-w sec, --watchdog=sec
+

-w sec, --watchdog=sec

Activate the watchdog timer with a timeout of sec seconds. A value of 0 (default) disables the watchdog.
@@ -201,10 +201,9 @@

SIGNALS

-
SIGINT, - SIGTERM
+

SIGINT, SIGTERM

Program exits with status 0.
-
SIGHUP
+

SIGHUP

Program exits with status 1. This can be used to force a reload, for example if an update has been installed.
@@ -212,55 +211,55 @@

EXIT STATUS

-
0
+

0

Successful program execution.
-
1
+

1

An error has been detected which requires the DVB driver and vdr to be reloaded.
-
2
+

2

An non-recoverable error has been detected, vdr has given up.

FILES

-
channels.conf
+

channels.conf

Channel configuration.
-
timers.conf
+

timers.conf

Timer configuration.
-
setup.conf
+

setup.conf

User definable setup.
-
commands.conf
+

commands.conf

User definable commands (executed from the Commands menu).
-
svdrphosts.conf
+

svdrphosts.conf

SVDRP host configuration, defining which hosts or networks are given access to the SVDRP port.
-
marks
+

marks

Contains the editing marks defined for a recording.
-
info
+

info

Contains a description of the recording.
-
resume
+

resume

Contains the index into the recording where the last replay session left off.
-
index
+

index

Contains the file number, offset and type of each frame of the recording.
-
remote.conf
+

remote.conf

Contains the key assignments for the remote control.
-
keymacros.conf
+

keymacros.conf

Contains user defined remote control key macros.
-
00001.ts ... 65535.ts
+

00001.ts ... 65535.ts

The actual data files of a recording.
-
epg.data
+

epg.data

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.
-
donerecs.data
+

donerecs.data

Contains the names of recordings that have been done by pattern timers with '@' as the first character of the pattern. File names are appended to this file after a recording has finished, and the entire file is read upon startup of VDR.
-
.update
+

.update

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 "Recordings" menu.
diff --git a/VDR-file-formats-and-conventions.md b/VDR-file-formats-and-conventions.md index a66b4e6..fa473e3 100644 --- a/VDR-file-formats-and-conventions.md +++ b/VDR-file-formats-and-conventions.md @@ -49,7 +49,7 @@

The fields in a channel definition have the following meaning (from left to right):

-
Name
+

Name

The channel's name (if the name originally contains a ':' character it has to be replaced by '|'). Some TV stations provide a way of deriving a "short name" from the channel name, which can be used in @@ -65,12 +65,12 @@ semicolon, as in

RTL Television,RTL;RTL World:...

-
Frequency
+

Frequency

The transponder frequency (as an integer). For DVB-S this value is in MHz. For DVB-C and DVB-T it can be given either in MHz, kHz or Hz (the actual value given will be multiplied by 1000 until it is larger than 1000000).
-
Parameters
+

Parameters

Various parameters, depending on whether this is a DVB-S, DVB-C or DVB-T channel. Each parameter consist of a key character, followed by an integer number that represents the actual setting of that parameter. The valid key @@ -82,17 +82,17 @@ C - Code rate high priority (0, 12, 23, 34, 35, 45, 56, 67, 78, 89, - 910) + Code rate high priority (0, 12, 23, 34, 35, 45, 56, 67, 78, 89, 910, + 999) D - coDe rate low priority (0, 12, 23, 34, 35, 45, 56, 67, 78, 89, - 910) + coDe rate low priority (0, 12, 23, 34, 35, 45, 56, 67, 78, 89, 910, + 999) G - Guard interval (4, 8, 16, 32, 128, 19128, 19256) + Guard interval (4, 8, 16, 32, 128, 19128, 19256, 999) H @@ -100,7 +100,7 @@ I - Inversion (0, 1) + Inversion (0, 1, 999) L @@ -136,7 +136,7 @@ T - Transmission mode (1, 2, 4, 8, 16, 32) + Transmission mode (1, 2, 4, 8, 16, 32, 999) V @@ -148,7 +148,7 @@ Y - hierarchY (0, 1, 2, 4) + hierarchY (0, 1, 2, 4, 999)

Bandwidth: The bandwidth of the channel in MHz (1712 in @@ -265,12 +265,12 @@ The only condition is that the string may not contain colons (':') or newline characters.

-
Source
+

Source

The signal source of this channel, as defined in the file sources.conf.
-
Srate
+

Srate

The symbol rate of this channel (DVB-S and DVB-C only).
-
VPID
+

VPID

The video PID (set to '0' for radio channels). If this channel uses a separate PCR PID, it follows the VPID, separated by a plus sign, as in

...:164+17:...

@@ -278,7 +278,7 @@ follows the pids, separated by an '=' sign, as in

...:164+17=27:...

-
APID
+

APID

The audio PID (either one number, or several, separated by commas). If this channel also carries Dolby Digital sound, the Dolby PIDs follow the audio PIDs, separated by a semicolon, as in @@ -298,7 +298,7 @@ separating '=' if there is an audio type.

-
TPID
+

TPID

The teletext PID. If this channel also carries DVB subtitles, the DVB subtitling PIDs follow the teletext PID, separated by a semicolon, as in

...:201;2001,2002:...

@@ -308,8 +308,7 @@

...:201;2001=deu,2002=eng:...

-
Conditional - access
+

Conditional access

A hexadecimal integer defining how this channel can be accessed: @@ -337,13 +336,13 @@

The values are in hex because that's the way they are defined in the "ETR 162" document. Leading zeros may be omitted.

-
SID
+

SID

The Service ID of this channel.
-
NID
+

NID

The Network ID of this channel.
-
TID
+

TID

The Transport stream ID of this channel.
-
RID
+

RID

The Radio ID of this channel (typically 0, may be used to distinguish channels where NID, TID and SID are all equal).
@@ -375,7 +374,7 @@

The fields in a timer definition have the following meaning (from left to right):

-
Flags
+

Flags

The individual bits in this field have the following meaning:
@@ -406,7 +405,7 @@

All other bits are reserved for future use.

-
Channel
+

Channel

The channel to record from. This is either the channel number as shown in the on-screen menus, or a complete channel ID. When reading timers.conf any channel numbers will be mapped to the respective @@ -415,7 +414,7 @@ creation of timers when manually editing timers.conf. Also, when timers are listed via SVDRP commands, the channels are given as numbers.
-
Day
+

Day

The day when this timer shall record.

If this is a `single-shot' timer, this is the date on which this timer shall record, given in ISO notation (YYYY-MM-DD), as @@ -452,14 +451,14 @@ first day date given need not be that of a day when the timer would actually hit.

-
Start
+

Start

A four digit integer defining when this timer shall start recording. The format is hhmm, so 1430 would mean "half past two" in the afternoon.
-
Stop
+

Stop

A four digit integer defining when this timer shall stop recording. The format is the same as for the start time.
-
Priority
+

Priority

An integer in the range 0...99, defining the priority of this timer and of recordings created by this timer. 0 represents the lowest value, 99 the highest. The priority is used to decide @@ -475,7 +474,7 @@ with a higher priority will interrupt the timer with the lowest priority in order to start recording.

-
Lifetime
+

Lifetime

The guaranteed lifetime (in days) of a recording created by this timer. 0 means that this recording may be automatically deleted at any time by a new recording with higher priority. 99 means that @@ -483,7 +482,7 @@ range 1...98 means that this recording may not be automatically deleted in favour of a new recording, until the given number of days since the start time of the recording has passed by.
-
File
+

File

The file name this timer will give to a recording. If the name contains any ':' characters, these have to be replaced by '|'. If the name shall contain subdirectories, these have to be delimited by '~' (since the @@ -541,8 +540,7 @@
-
Auxiliary - data
+

Auxiliary data

An arbitrary string that can be used by external applications to store any kind of data related to this timer. The string must not contain any newline characters. If this field is not empty, its contents will be diff --git a/svdrpsend-command-reference.md b/svdrpsend-command-reference.md index ff7692a..a7bae82 100644 --- a/svdrpsend-command-reference.md +++ b/svdrpsend-command-reference.md @@ -23,10 +23,10 @@

OPTIONS

-
-d hostname
+

-d hostname

Accesses the VDR at the specified hostname (default is localhost).
-
-p port
+

-p port

Uses the SVDRP port number port (default is 6419).