frodovdr/vdr
1
0
Fork 0
mirror of https://github.com/vdr-projects/vdr.git synced 2025-03-01 10:50:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated SVDRP help (markdown)

Manuel Reimer 2023-09-19 11:14:57 +02:00
parent 0bfc53d347
commit b6c1debd6b
1 changed files with 32 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
SVDRP-help.md

@ -2,15 +2,15 @@
## SVDRP commands
### CHAN [ + | - | <number> | <name> | <id> ]
Switch channel up, down or to the given channel number, name or id.Without option (or after successfully switching to the channel)it returns the current channel number and name.
Switch channel up, down or to the given channel number, name or id. Without option (or after successfully switching to the channel) it returns the current channel number and name.
### CLRE [ <number> | <name> | <id> ]
Clear the EPG list of the given channel number, name or id.Without option it clears the entire EPG list.After a CLRE command, no further EPG processing is done for 10seconds, so that data sent with subsequent PUTE commands doesn'tinterfere with data from the broadcasters.
Clear the EPG list of the given channel number, name or id. Without option it clears the entire EPG list. After a CLRE command, no further EPG processing is done for 10 seconds, so that data sent with subsequent PUTE commands doesn't interfere with data from the broadcasters.
### CONN name:<name> port:<port> vdrversion:<vdrversion> apiversion:<apiversion> timeout:<timeout>
Used by peer-to-peer connections between VDRs to tell the other VDRto establish a connection to this VDR. The name is the SVDRP host nameof this VDR, which may differ from its DNS name.
Used by peer-to-peer connections between VDRs to tell the other VDR to establish a connection to this VDR. The name is the SVDRP host name of this VDR, which may differ from its DNS name.
### DELC <number> | <id>
@ -18,19 +18,19 @@ Delete the channel with the given number or channel id.
### DELR <id>
Delete the recording with the given id. Before a recording can bedeleted, an LSTR command should have been executed in order to retrievethe recording ids. The ids are unique and don't change while thisinstance of VDR is running.CAUTION: THERE IS NO CONFIRMATION PROMPT WHEN DELETING ARECORDING - BE SURE YOU KNOW WHAT YOU ARE DOING!
Delete the recording with the given id. Before a recording can be deleted, an LSTR command should have been executed in order to retrieve the recording ids. The ids are unique and don't change while this instance of VDR is running. CAUTION: THERE IS NO CONFIRMATION PROMPT WHEN DELETING A RECORDING - BE SURE YOU KNOW WHAT YOU ARE DOING!
### DELT <id>
Delete the timer with the given id. If this timer is currently recording,the recording will be stopped without any warning.
Delete the timer with the given id. If this timer is currently recording, the recording will be stopped without any warning.
### EDIT <id>
Edit the recording with the given id. Before a recording can beedited, an LSTR command should have been executed in order to retrievethe recording ids.
Edit the recording with the given id. Before a recording can be edited, an LSTR command should have been executed in order to retrieve the recording ids.
### GRAB <filename> [ <quality> [ <sizex> <sizey> ] ]
Grab the current frame and save it to the given file. Images canbe stored as JPEG or PNM, depending on the given file name extension.The quality of the grabbed image can be in the range 0..100, where 100(the default) means \"best\" (only applies to JPEG). The size parametersdefine the size of the resulting image (default is full screen).If the file name is just an extension (.jpg, .jpeg or .pnm) the imagedata will be sent to the SVDRP connection encoded in base64. The samehappens if '-' (a minus sign) is given as file name, in which case theimage format defaults to JPEG.
Grab the current frame and save it to the given file. Images can be stored as JPEG or PNM, depending on the given file name extension. The quality of the grabbed image can be in the range 0..100, where 100 (the default) means \"best\" (only applies to JPEG). The size parameters define the size of the resulting image (default is full screen). If the file name is just an extension (.jpg, .jpeg or .pnm) the image data will be sent to the SVDRP connection encoded in base64. The same happens if '-' (a minus sign) is given as file name, in which case the image format defaults to JPEG.
### HELP [ <topic> ]
@ -38,39 +38,39 @@ The HELP command gives help info.
### HITK [ <key> ... ]
Hit the given remote control key. Without option a list of allvalid key names is given. If more than one key is given, they areentered into the remote control queue in the given sequence. Therecan be up to 31 keys.
Hit the given remote control key. Without option a list of all valid key names is given. If more than one key is given, they are entered into the remote control queue in the given sequence. There can be up to 31 keys.
### LSTC [ :ids ] [ :groups | <number> | <name> | <id> ]
List channels. Without option, all channels are listed. Otherwiseonly the given channel is listed. If a name is given, all channelscontaining the given string as part of their name are listed.If ':groups' is given, all channels are listed including groupseparators. The channel number of a group separator is always 0.With ':ids' the channel ids are listed following the channel numbers.The special number 0 can be given to list the current channel.
List channels. Without option, all channels are listed. Otherwise only the given channel is listed. If a name is given, all channels containing the given string as part of their name are listed. If ':groups' is given, all channels are listed including group separators. The channel number of a group separator is always 0. With ':ids' the channel ids are listed following the channel numbers. The special number 0 can be given to list the current channel.
### LSTD
List all available devices. Each device is listed with its name andwhether it is currently the primary device ('P') or it implements adecoder ('D') and can be used as output device.
List all available devices. Each device is listed with its name and whether it is currently the primary device ('P') or it implements a decoder ('D') and can be used as output device.
### LSTE [ <channel> ] [ now | next | at <time> ]
List EPG data. Without any parameters all data of all channels islisted. If a channel is given (either by number or by channel ID),only data for that channel is listed. 'now', 'next', or 'at <time>'restricts the returned data to present events, following events, orevents at the given time (which must be in time_t form).
List EPG data. Without any parameters all data of all channels is listed. If a channel is given (either by number or by channel ID), only data for that channel is listed. 'now', 'next', or 'at <time>' restricts the returned data to present events, following events, or events at the given time (which must be in time_t form).
### LSTR [ <id> [ path ] ]
List recordings. Without option, all recordings are listed. Otherwisethe information for the given recording is listed. If a recordingid and the keyword 'path' is given, the actual file name of thatrecording's directory is listed.Note that the ids of the recordings are not necessarily given innumeric order.
List recordings. Without option, all recordings are listed. Otherwise the information for the given recording is listed. If a recording id and the keyword 'path' is given, the actual file name of that recording's directory is listed. Note that the ids of the recordings are not necessarily given in numeric order.
### LSTT [ <id> ] [ id ]
List timers. Without option, all timers are listed. Otherwiseonly the timer with the given id is listed. If the keyword 'id' isgiven, the channels will be listed with their unique channel idsinstead of their numbers. This command lists only the timers that aredefined locally on this VDR, not any remote timers from other VDRs.
List timers. Without option, all timers are listed. Otherwise only the timer with the given id is listed. If the keyword 'id' is given, the channels will be listed with their unique channel ids instead of their numbers. This command lists only the timers that are defined locally on this VDR, not any remote timers from other VDRs.
### MESG <message>
Displays the given message on the OSD. The message will be queuedand displayed whenever this is suitable.
Displays the given message on the OSD. The message will be queued and displayed whenever this is suitable.
### MODC <number> <settings>
Modify a channel. Settings must be in the same format as returnedby the LSTC command.
Modify a channel. Settings must be in the same format as returned by the LSTC command.
### MODT <id> on | off | <settings>
Modify a timer. Settings must be in the same format as returnedby the LSTT command. The special keywords 'on' and 'off' can beused to easily activate or deactivate a timer.
Modify a timer. Settings must be in the same format as returned by the LSTT command. The special keywords 'on' and 'off' can be used to easily activate or deactivate a timer.
### MOVC <number> <to>
@ -78,51 +78,51 @@ Move a channel to a new position.
### MOVR <id> <new name>
Move the recording with the given id. Before a recording can bemoved, an LSTR command should have been executed in order to retrievethe recording ids. The ids don't change during subsequent MOVRcommands.
Move the recording with the given id. Before a recording can be moved, an LSTR command should have been executed in order to retrieve the recording ids. The ids don't change during subsequent MOVR commands.
### NEWC <settings>
Create a new channel. Settings must be in the same format as returnedby the LSTC command.
Create a new channel. Settings must be in the same format as returned by the LSTC command.
### NEWT <settings>
Create a new timer. Settings must be in the same format as returnedby the LSTT command.
Create a new timer. Settings must be in the same format as returned by the LSTT command.
### NEXT [ abs | rel ]
Show the next timer event. If no option is given, the output will bein human readable form. With option 'abs' the absolute time of the nextevent will be given as the number of seconds since the epoch (time_tformat), while with option 'rel' the relative time will be given as thenumber of seconds from now until the event. If the absolute time givenis smaller than the current time, or if the relative time is less thanzero, this means that the timer is currently recording and has startedat the given time. The first value in the resulting line is the idof the timer.
Show the next timer event. If no option is given, the output will be in human readable form. With option 'abs' the absolute time of the next event will be given as the number of seconds since the epoch (time_t format), while with option 'rel' the relative time will be given as the number of seconds from now until the event. If the absolute time given is smaller than the current time, or if the relative time is less than zero, this means that the timer is currently recording and has started at the given time. The first value in the resulting line is the id of the timer.
### PING
Used by peer-to-peer connections between VDRs to keep the connectionfrom timing out. May be used at any time and simply returns a line ofthe form '<hostname> is alive'.
Used by peer-to-peer connections between VDRs to keep the connection from timing out. May be used at any time and simply returns a line of the form '<hostname> is alive'.
### PLAY <id> [ begin | <position> ]
Play the recording with the given id. Before a recording can beplayed, an LSTR command should have been executed in order to retrievethe recording ids.The keyword 'begin' plays the recording from its very beginning, whilea <position> (given as hh:mm:ss[.ff] or framenumber) starts at thatposition. If neither 'begin' nor a <position> are given, replay is resumedat the position where any previous replay was stopped, or from the beginningby default. To control or stop the replay session, use the usual remotecontrol keypresses via the HITK command.
Play the recording with the given id. Before a recording can be played, an LSTR command should have been executed in order to retrieve the recording ids. The keyword 'begin' plays the recording from its very beginning, while a <position> (given as hh:mm:ss[.ff] or framenumber) starts at that position. If neither 'begin' nor a <position> are given, replay is resumed at the position where any previous replay was stopped, or from the beginning by default. To control or stop the replay session, use the usual remote control keypresses via the HITK command.
### PLUG <name> [ help | main ] [ <command> [ <options> ]]
Send a command to a plugin.The PLUG command without any parameters lists all plugins.If only a name is given, all commands known to that plugin are listed.If a command is given (optionally followed by parameters), that commandis sent to the plugin, and the result will be displayed.The keyword 'help' lists all the SVDRP commands known to the named plugin.If 'help' is followed by a command, the detailed help for that command isgiven. The keyword 'main' initiates a call to the main menu function of thegiven plugin.
Send a command to a plugin. The PLUG command without any parameters lists all plugins. If only a name is given, all commands known to that plugin are listed. If a command is given (optionally followed by parameters), that command is sent to the plugin, and the result will be displayed. The keyword 'help' lists all the SVDRP commands known to the named plugin. If 'help' is followed by a command, the detailed help for that command is given. The keyword 'main' initiates a call to the main menu function of the given plugin.
### POLL <name> timers
Used by peer-to-peer connections between VDRs to inform other machinesabout changes to timers. The receiving VDR shall use LSTT to query theremote machine with the given name about its timers and update its listof timers accordingly.
Used by peer-to-peer connections between VDRs to inform other machines about changes to timers. The receiving VDR shall use LSTT to query the remote machine with the given name about its timers and update its list of timers accordingly.
### PRIM [ <number> ]
Make the device with the given number the primary device.Without option it returns the currently active primary device in the sameformat as used by the LSTD command.
Make the device with the given number the primary device. Without option it returns the currently active primary device in the same format as used by the LSTD command.
### PUTE [ <file> ]
Put data into the EPG list. The data entered has to strictly follow theformat defined in vdr(5) for the 'epg.data' file. A '.' on a lineby itself terminates the input and starts processing of the data (allentered data is buffered until the terminating '.' is seen).If a file name is given, epg data will be read from this file (whichmust be accessible under the given name from the machine VDR is runningon). In case of file input, no terminating '.' shall be given.
Put data into the EPG list. The data entered has to strictly follow the format defined in vdr(5) for the 'epg.data' file. A '.' on a line by itself terminates the input and starts processing of the data (all entered data is buffered until the terminating '.' is seen). If a file name is given, epg data will be read from this file (which must be accessible under the given name from the machine VDR is running on). In case of file input, no terminating '.' shall be given.
### REMO [ on | off ]
Turns the remote control on or off. Without a parameter, the currentstatus of the remote control is reported.
Turns the remote control on or off. Without a parameter, the current status of the remote control is reported.
### SCAN
Forces an EPG scan. If this is a single DVB device system, the scanwill be done on the primary device unless it is currently recording.
Forces an EPG scan. If this is a single DVB device system, the scan will be done on the primary device unless it is currently recording.
### STAT disk
@ -130,21 +130,17 @@ Return information about disk usage (total, free, percent).
### UPDT <settings>
Updates a timer. Settings must be in the same format as returnedby the LSTT command. If a timer with the same channel, day, startand stop time does not yet exist, it will be created.
Updates a timer. Settings must be in the same format as returned by the LSTT command. If a timer with the same channel, day, start and stop time does not yet exist, it will be created.
### UPDR
Initiates a re-read of the recordings directory, which is the SVDRPequivalent to 'touch .update'.
Initiates a re-read of the recordings directory, which is the SVDRP equivalent to 'touch .update'.
### VOLU [ <number> | + | - | mute ]
Set the audio volume to the given number (which is limited to the range0...255). If the special options '+' or '-' are given, the volume willbe turned up or down, respectively. The option 'mute' will toggle theaudio muting. If no option is given, the current audio volume level willbe returned.
Set the audio volume to the given number (which is limited to the range 0...255). If the special options '+' or '-' are given, the volume will be turned up or down, respectively. The option 'mute' will toggle the audio muting. If no option is given, the current audio volume level will be returned.
### QUIT
Exit vdr (SVDRP).You can also hit Ctrl-D to exit.
### NULL
Exit vdr (SVDRP). You can also hit Ctrl-D to exit.