webui: docs - another update from tvheadend-documentation

docs/html/en/about.html

@@ -1,5 +1,8 @@
 <!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
 <div class="hts-doc-text">
 <h3>About</h3>
-<p>Content Required. Please add some!</p>
+<p>This tab gives you basic information about Tvheadend's copyright, the authors, licensing, etc.</p>
+<p>You can also check the build options for your binary by clicking <em>Toggle details</em> .</p>
+<p>Oh, and you can make a donation as well, of course :)</p>
+<p>For more information about Tvheadend, please visit <a href="https://tvheadend.org/">our home page</a>, read <a href="http://docs.tvheadend.org/">the full online documentation</a> or just cut straight to <a href="http://docs.tvheadend.org/Appendices/faqs/">the FAQs</a>.</p>
 </div>

docs/html/en/config_debugging.html

@@ -0,0 +1,37 @@
+<!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
+<div class="hts-doc-text">
+<h3>Configuration - Debugging</h3>
+<p>This tab is used to configure various debugging options in tvheadend.</p>
+<p><img src="docresources/configtvhlog.png" alt="&#39;Debugging&#39; Tab" /></p>
+<hr />
+<h5>Menu Bar/Buttons</h5>
+<p>The following functions are available:</p>
+<table>
+<thead><tr>
+<th>Button</th>
+<th>Function </th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>Apply Configuration (run-time only)</strong></td>
+<td>Saves any changes made to the debugging configuration. Changes will be lost on a restart.</td>
+</tr>
+<tr>
+<td><strong>Help</strong></td>
+<td>Display this help page </td>
+</tr>
+</tbody>
+</table>
+<hr />
+<h5>Configuration Options</h5>
+<p><strong>Debug log path</strong> : <font color=red>Text...</font></p>
+<p><strong>Debug to syslog</strong> : <font color=red>Text...</font></p>
+<p><strong>Debug trace (low-level stuff)</strong> : <font color=red>Text...</font></p>
+<p><strong>Debug subsystems</strong> : <font color=red>Text...</font></p>
+<p><strong>Trace subsystems</strong> : <font color=red>Text...</font></p>
+<p>Changes to any of these settings must be confirmed by pressing the ‘Save configuration’ button before taking effect.</p>
+<p>Note that settings are not saved to a storage. Any change is available only while Tvheadend is running, and will be lost on a restart. To change the default behaviour permanently, use command line options such as <code>-l</code>, <code>–debug</code>, <code>–trace</code>.</p>
+<p>Depending on your distribution, the default command-line configuration is usually stored in the <code>/etc/sysconfig</code> tree or an init script. You may also be able to change <code>/etc/default/tvheadend</code> to add additional command-line parameters.</p>
+<h3>Note: <font color=red>It'd be helpful to expand as to what happens on what distro...</font></h3>
+</div>

docs/html/en/config_general.html

@@ -0,0 +1,93 @@
+<!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
+<div class="hts-doc-text">
+<h3>Configuration - General</h3>
+<p>This tabs allow configuration of several general parameters that affect the core Tvheadend functionality.</p>
+<h3>NOTE: <font color=red>THE TWO IMAGES BELOW SHOULD BE REPLACED WITH A SINGLE ONE</font></h3>
+<p><img src="docresources/configgeneraltab1.png" alt="&#39;General&#39; Tab Screenshot 1" /></p>
+<p><img src="docresources/configgeneraltab2.png" alt="&#39;General&#39; Tab Screenshot 2" /></p>
+<hr />
+<h5>Menu Bar/Buttons</h5>
+<p>The following functions are available:</p>
+<table>
+<thead><tr>
+<th>Button</th>
+<th>Function </th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>Save configuration</strong></td>
+<td>Save any changes to the current configuration. </td>
+</tr>
+<tr>
+<td><strong>Clean image (icon) cache</strong></td>
+<td>Clears the local channel icon cache, forcing images to be re-generated from sources (channel icons or picons).</td>
+</tr>
+<tr>
+<td><strong>Discover SAT>IP servers</strong></td>
+<td>Forces a scan for any SAT>IP servers on the local network. </td>
+</tr>
+<tr>
+<td><strong>Help</strong></td>
+<td>Displays this help page </td>
+</tr>
+</tbody>
+</table>
+<hr />
+<h5>Server</h5>
+<p><strong>Tvheadend server name</strong> : Set the name of the server so you can distinguish multiple instances apart on your LAN.</p>
+<h5>Language Settings</h5>
+<p><strong>Default Language(s)</strong> : Select the list of languages (in order of priority) to be used for supplying EPG information to clients that don’t provide their own configuration.</p>
+<p>The EPG information is NOT translated, this only applies to EPG providers that give information (titles, descriptions, etc..) in multiple languages.</p>
+<hr />
+<h5>DVB Scan Files Path</h5>
+<p><strong>DVB scan files path</strong> : Select the path to use for DVB scan configuration files. Typically dvb- apps stores these in <code>/usr/share/dvb/</code>. Leave blank to use Tvheadend's internal file set.</p>
+<hr />
+<h5>Time Update</h5>
+<p>Tvheadend has a built-in capability to update the system time. However, you should bear in mind that DVB time is not highly accurate and is prone to both jitter and variation between different transponders.</p>
+<p>Where possible, it’s probably still better to use an internet based NTP source to synchronise the system clock (i.e. through the underlying operating system).</p>
+<p><strong>Update time</strong> : Enable system time updates. This will only work if the user running Tvheadend has rights to update the system clock (normally only root).</p>
+<p><strong>Enable NTP driver</strong> : This will create an NTP driver (using shmem interface) that you can feed into ntpd. This can be run without root privileges, but generally the performance is not that great.</p>
+<p><strong>Update tolerance (milliseconds)</strong> : Only update the system clock (doesn’t affect NTP driver) if the delta between the system clock and DVB time is greater than this. This can help stop excessive oscillations on the system clock.</p>
+<hr />
+<h5>Picons</h5>
+<p>Picons (from <em>p</em> ersonal <em>icons</em> ) are collections of similar icons that can be automatically matched against your channels based on a number of technical parameters that will uniquely define a channel. The use of these parameters (e.g. mux, frequency, orbital position) removes the ambiguity of using names - it’s not case sensitive, it doesn’t care if there are spaces or not, and so on. You can generate picons yourself from existing images, or you can usually find sets pre-made on the Internet if you search for them. They’re a good way to get large numbers of icons matched quickly, and usually in a similar style (such as square, x * y pixels, with a consistent highlight/reflection effect).</p>
+<p><strong>Prefer picons over channel name</strong> : If both a picon and a channel-specific (e.g. channelname.jpg) icon are defined, use the picon.</p>
+<p><strong>Channel icon path</strong> : Path to an icon for this channel. This can be named however you wish, as either a local (<code>file://</code>) or remote (<code>http://</code>) image. The following placeholders are available:</p>
+<table>
+<thead><tr>
+<th>Placeholder</th>
+<th>Function </th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>%C</strong></td>
+<td>The transliterated channel name in ASCII (safe characters, no spaces etc.)</td>
+</tr>
+<tr>
+<td><strong>%c</strong></td>
+<td>The channel name (URL encoded ASCII) </td>
+</tr>
+</tbody>
+</table>
+<p>Example: <code>file:///tmp/icons/%C.png</code> or <code>http://example.com/%c.png</code></p>
+<p><strong>Picon path</strong> : Path to a directory (folder) containing your picon collection. This can be named however you wish, as either a local (<code>file://</code>) or remote (<code>http://</code>) location - however, remember that it’s pointing to a directory as the picon names are automatically generated from the service parameters frequency, orbital position, etc.).</p>
+<p>Example: <code>file:///home/hts/picons</code></p>
+<hr />
+<h5>SAT>IP Server</h5>
+<p>SAT>IP Server is something like DVB network tuner. Tvheadend can forward mpegts input streams including on-the-fly descramling to SAT>IP clients.</p>
+<p>Only networks with the “SAT>IP Source” field set are exported through the SAT>IP protocol. This field is matched through the “src” parameter asked from the SAT>IP client. Usually (and by default) this value is 1. For satellite tuners, this value determines the satellite source (dish). By specification position 1 = DiseqC AA, 2 = DiseqC AB, 3 = DiseqC BA, 4 = DiseqC BB, but any numbers may be used - depends on the SAT>IP client. Note that if you use a similar number for multiple networks, the first matched network containing the mux with requested parameters will win (also for unknown mux).</p>
+<p><strong>RTSP Port</strong> : Select RTSP port (TCP) for realtime commands from SAT>IP clients. Usually (as defined in the specification) this port is 554. But as extension, Tvheadend can use any TCP port value (which is default 9983 for non-root users). But the SAT>IP client must allow to set this value (Tvheadend client will obtain the RTSP port number automatically using the XML description). If the RTSP port value is zero, the SAT>IP server functionality is not enabled.</p>
+<p><strong>Subscription Weight</strong> : Subscription weight value. Default value is 100 (standard streaming). Note that the default value for DVR is 300 (normal priority).</p>
+<p><strong>Descramble Services</strong> : The maximum limit of services descrambled per a mux. If zero, the descrambling functionality is disabled.</p>
+<p><strong>Muxes Handling</strong> : When SAT>IP client requests new mux configuration, Tvheadend can handle it in three ways. The auto (0) configuration means that if the mux does not exists, a temporary mux is created and removed when the client closes the connection. The keep (1) configuration will remember all successfuly scanned muxes. The reject (2) configuration will reject unknown muxes.</p>
+<p><strong>Exported .... Tuners</strong> : Each option lists the tuners, by type, you wish to present over IP to other clients.</p>
+<hr />
+<h5>Image Caching</h5>
+<p>This will cache any channel icons or other images (such as EPG metadata) to be served from the local webserver. This can be useful for multi-client systems and, generally, to reduce hits on upstream providers.</p>
+<p><strong>Enabled</strong> : Select whether or not to enable caching. Note: even with this disabled you can still specify local (file://) icons and these will be served by the built-in webserver.</p>
+<p><strong>Re-fetch period (hours)</strong> : How frequently the upstream provider is checked for changes.</p>
+<p><strong>Re-try period (hours)</strong> : How frequently it will re-try fetching an image that has failed to be fetched.</p>
+<p><strong>Ignore invalid SSL certificates</strong> : Ignore invalid/unverifiable (expired, self-certified, etc.) certificates</p>
+</div>

docs/html/en/config_passwords.html

@@ -0,0 +1,53 @@
+<!-- Do not edit! Automatically created file: https://github.com/tvheadend/tvheadend-documentation -->
+<div class="hts-doc-text">
+<h3>Configuration - Passwords</h3>
+<p>This tab is the second part of Tvheadend's access control mechanism. It is where you set and maintain all user passwords (e.g. for streaming or DVR access).</p>
+<h3>Note: <font color=red>Screenshot</font></h3>
+<hr />
+<h5>Menu Bar/Buttons</h5>
+<p>The following functions are available:</p>
+<table>
+<thead><tr>
+<th>Button</th>
+<th>Function </th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>Save</strong></td>
+<td>Save any changes made to the password rules. </td>
+</tr>
+<tr>
+<td><strong>Undo</strong></td>
+<td>Undo any changes made to the password rules since the last save. </td>
+</tr>
+<tr>
+<td><strong>Add</strong></td>
+<td>Add a new password rule. </td>
+</tr>
+<tr>
+<td><strong>Delete</strong></td>
+<td>Delete the selected password rule. </td>
+</tr>
+<tr>
+<td><strong>Move up</strong></td>
+<td>Move the selected rule up one level (rules are executed top to bottom). </td>
+</tr>
+<tr>
+<td><strong>Move down</strong></td>
+<td>Move the selected rule down one level (rules are executed top to bottom).</td>
+</tr>
+<tr>
+<td><strong>Edit</strong></td>
+<td>Edit the selected password rule. </td>
+</tr>
+<tr>
+<td><strong>Help</strong></td>
+<td>Display this help page. </td>
+</tr>
+</tbody>
+</table>
+<hr />
+<h5>Grid Items</h5>
+<p>The main grid items have the following functions:</p>
+</div>

docs/html/en/config_timeshift.html

@@ -31,7 +31,7 @@ <h5>Configuration options</h5>
 <p><strong>Max. Period (mins)</strong> : Specify the maximum time period that will be buffered for any given (client) subscription.</p>
 <p><strong>Unlimited</strong> : If checked, this allows the timeshift buffer to grow unbounded until your storage media runs out of space.</p>
 <div class="admonition danger">
-<p class="admonition-title">Danger</p>
+<p class="admonition-title">Warning</p>
 <p>Unless you have adequate storage, or monitor use, enabling this option
 could cause your system to slow down or crash completely!</p>
 </div>
@@ -40,7 +40,7 @@ <h5>Configuration options</h5>
 <p><strong>Max. RAM Size (MegaBytes)</strong> : Specifies the maximum RAM (system memory) size for timeshift buffers. When free RAM buffers are available, they are used instead storage to save the timeshift data.</p>
 <p><strong>Unlimited</strong> : If checked, this allows the combined size of all timeshift buffers to potentially grow unbounded until your storage media runs out of space.</p>
 <div class="admonition danger">
-<p class="admonition-title">Danger</p>
+<p class="admonition-title">Warning</p>
 <p>Unless you have adequate storage, or monitor use, enabling this option
 could cause your system to slow down or crash completely!</p>
 </div>