Updated SVDRP help (markdown)

SVDRP-help.md

@@ -1,46 +1,46 @@
 # SVDRP help
 ## SVDRP commands
-### CHAN [ + | - | <number> | <name> | <id> ]
+### CHAN [ + | - | &lt;number&gt; | &lt;name&gt; | &lt;id&gt; ]
 
 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> ]
+### CLRE [ &lt;number&gt; | &lt;name&gt; | &lt;id&gt; ]
 
 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:<name> port:<port> vdrversion:<vdrversion> apiversion:<apiversion> timeout:<timeout>
+### CONN name:&lt;name&gt; port:&lt;port&gt; vdrversion:&lt;vdrversion&gt; apiversion:&lt;apiversion&gt; timeout:&lt;timeout&gt;
 
 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 <number> | <id>
+### DELC &lt;number&gt; | &lt;id&gt;
 
 Delete the channel with the given number or channel id.
 
-### DELR <id>
+### DELR &lt;id&gt;
 
 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 <id>
+### DELT &lt;id&gt;
 
 Delete the timer with the given id. If this timer is currently recording,the recording will be stopped without any warning.
 
-### EDIT <id>
+### EDIT &lt;id&gt;
 
 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 <filename> [ <quality> [ <sizex> <sizey> ] ]
+### GRAB &lt;filename&gt; [ &lt;quality&gt; [ &lt;sizex&gt; &lt;sizey&gt; ] ]
 
 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 [ <topic> ]
+### HELP [ &lt;topic&gt; ]
 
 The HELP command gives help info.
 
-### HITK [ <key> ... ]
+### HITK [ &lt;key&gt; ... ]
 
 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 | <number> | <name> | <id> ]
+### LSTC [ :ids ] [ :groups | &lt;number&gt; | &lt;name&gt; | &lt;id&gt; ]
 
 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.
 
@@ -48,43 +48,43 @@ List channels. Without option, all channels are listed. Otherwiseonly the given
 
 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 [ <channel> ] [ now | next | at <time> ]
+### LSTE [ &lt;channel&gt; ] [ now | next | at &lt;time&gt; ]
 
-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 islisted. If a channel is given (either by number or by channel ID),only data for that channel is listed. 'now', 'next', or 'at &lt;time&gt;'restricts the returned data to present events, following events, orevents at the given time (which must be in time_t form).
 
-### LSTR [ <id> [ path ] ]
+### LSTR [ &lt;id&gt; [ 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.
 
-### LSTT [ <id> ] [ id ]
+### LSTT [ &lt;id&gt; ] [ 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.
 
-### MESG <message>
+### MESG &lt;message&gt;
 
 Displays the given message on the OSD. The message will be queuedand displayed whenever this is suitable.
 
-### MODC <number> <settings>
+### MODC &lt;number&gt; &lt;settings&gt;
 
 Modify a channel. Settings must be in the same format as returnedby the LSTC command.
 
-### MODT <id> on | off | <settings>
+### MODT &lt;id&gt; on | off | &lt;settings&gt;
 
 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.
 
-### MOVC <number> <to>
+### MOVC &lt;number&gt; &lt;to&gt;
 
 Move a channel to a new position.
 
-### MOVR <id> <new name>
+### MOVR &lt;id&gt; &lt;new name&gt;
 
 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.
 
-### NEWC <settings>
+### NEWC &lt;settings&gt;
 
 Create a new channel. Settings must be in the same format as returnedby the LSTC command.
 
-### NEWT <settings>
+### NEWT &lt;settings&gt;
 
 Create a new timer. Settings must be in the same format as returnedby the LSTT command.
 
@@ -94,25 +94,25 @@ Show the next timer event. If no option is given, the output will bein human rea
 
 ### 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 connectionfrom timing out. May be used at any time and simply returns a line ofthe form '&lt;hostname&gt; is alive'.
 
-### PLAY <id> [ begin | <position> ]
+### PLAY &lt;id&gt; [ begin | &lt;position&gt; ]
 
-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 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 &lt;position&gt; (given as hh:mm:ss[.ff] or framenumber) starts at thatposition. If neither 'begin' nor a &lt;position&gt; 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.
 
-### PLUG <name> [ help | main ] [ <command> [ <options> ]]
+### PLUG &lt;name&gt; [ help | main ] [ &lt;command&gt; [ &lt;options&gt; ]]
 
 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.
 
-### POLL <name> timers
+### POLL &lt;name&gt; 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.
 
-### PRIM [ <number> ]
+### PRIM [ &lt;number&gt; ]
 
 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.
 
-### PUTE [ <file> ]
+### PUTE [ &lt;file&gt; ]
 
 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.
 
@@ -128,7 +128,7 @@ Forces an EPG scan. If this is a single DVB device system, the scanwill be done
 
 Return information about disk usage (total, free, percent).
 
-### UPDT <settings>
+### UPDT &lt;settings&gt;
 
 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.
 
@@ -136,7 +136,7 @@ Updates a timer. Settings must be in the same format as returnedby the LSTT comm
 
 Initiates a re-read of the recordings directory, which is the SVDRPequivalent to 'touch .update'.
 
-### VOLU [ <number> | + | - | mute ]
+### VOLU [ &lt;number&gt; | + | - | 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.
 
@@ -144,7 +144,7 @@ Set the audio volume to the given number (which is limited to the range0...255).
 
 Exit vdr (SVDRP).You can also hit Ctrl-D to exit.
 
-
+### NULL