diff --git a/SVDRP-help.md b/SVDRP-help.md new file mode 100644 index 0000000..f59d268 --- /dev/null +++ b/SVDRP-help.md @@ -0,0 +1,150 @@ +# SVDRP help +## SVDRP commands +### CHAN [ + | - | | | ] + +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 [ | | ] + +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. + +### CONN name: port: vdrversion: apiversion: 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. + +### DELC | + +Delete the channel with the given number or channel id. + +### DELR + +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! + +### DELT + +Delete the timer with the given id. If this timer is currently recording,the recording will be stopped without any warning. + +### EDIT + +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. + +### GRAB [ [ ] ] + +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. + +### HELP [ ] + +The HELP command gives help info. + +### HITK [ ... ] + +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. + +### LSTC [ :ids ] [ :groups | | | ] + +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. + +### 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. + +### LSTE [ ] [ now | next | at