mdhelp: clean-up and add superuser access info

diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md
index dcb3c0672a53d1b11c5b4e7e7189f518602fb8c6..89999faeaa4bd4370f81d396efeaa7677cbd3627 100644 (file)
--- a/docs/class/access_entry.md
+++ b/docs/class/access_entry.md
@@ -46,13 +46,13 @@ anonymous account also apply to subsequent accounts.**
 **Tips**:
 * Be as limiting as possible especially when making Tvheadend available 
 over the Internet.
-* For extra security, always enter (a comma-separated list of) 
+* For extra security always enter (a comma-separated list of) 
 network prefix(es) (*Allowed networks*).
-* If you lock yourself out, you can use the backdoor account to regain 
+* If you lock yourself out, you can use the [backdoor account](#emergency-backdoor-access) to regain 
 access, or restart Tvheadend with the `--noacl` argument.
 * You can have multiple entries using the same username with varying 
 rights, allowing you to enable / disable each as needed. Keep in mind 
-that matching account entry permissions are combined.
+that matching account entry permissions are combined (enabled entries only).
 * If you create an anonymous account, it also requires 
 a [password](class/passwd) entry (enter an asterisk `*` for both the 
 username and password fields when adding the entry).
@@ -66,3 +66,32 @@ username and password fields when adding the entry).
 <tvh_include>inc/del_grid_entries</tvh_include>
 
 ---
+
+###Emergency/Backdoor Access
+
+Tvheadend includes functionality that allows you to regain access to 
+your Tvheadend instance in case of emergency or if you find yourself 
+locked out, this is known as a superuser account. On some systems you 
+might been asked to enter a superuser username and password during 
+installation.
+
+To create a superuser account you must have access to your Tvheadend 
+configuration directory (most commonly `$HOME/.hts/tvheadend`) and 
+be able to create a plain-text file named `superuser` with the following 
+(JSON formatted) content:
+
+```
+{
+"username": "superuser",
+"password": "superpassword"
+}
+```
+
+Once you've created this file you must restart Tvheadend for it to take 
+affect. Note that for security the superuser account is not listed in the 
+access entries grid.
+
+**Tip**: Remember to set the correct permissions so that Tvheadend 
+is able to read the superuser file.
+
+---

diff --git a/docs/class/channel.md b/docs/class/channel.md
index f14c4435b575d38c048b2d076bd6c678c3fe829d..7642e767a8b9ca04fb6b5fcadc6fbbf0e29d370a 100644 (file)
--- a/docs/class/channel.md
+++ b/docs/class/channel.md
@@ -32,6 +32,8 @@ Numbering Button            | Function
 
 <tvh_include>inc/add_grid_entry</tvh_include>
 
+####Example
+
 !['Add Channel Dialog'](static/img/doc/addchanneldialog.png)
 
 ---

diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md
index be6879ef48e0883848a2fae62052a63f270e93b3..30dd4c1c23b220ff295975922b101d6e85f0ef7f 100644 (file)
--- a/docs/class/dvrentry.md
+++ b/docs/class/dvrentry.md
@@ -7,10 +7,10 @@ Each entry is moved between the tabs depending on its state:
 
 * Upcoming and currently recording entries remain in 
 the *Upcoming/Current Recordings* tab.
-* When a recording completes successfully the entry is moved to 
-the *Finished Recordings* tab.
-* When a recording fails (or is aborted) the entry is moved to 
-the *Failed Recordings* tab.
+* When a recording completes successfully the entry is moved 
+(from *Upcoming/Current Recordings*) to the *Finished Recordings* tab.
+* When a recording fails (or is aborted) the entry is moved 
+(from *Upcoming/Current Recordings*) to the *Failed Recordings* tab.
 
 Please note that the grid in each tab may have different columns and 
 not all entry information is available until it completes or fails, 
@@ -20,7 +20,7 @@ e.g filesize, total data errors, etc.
 
 ###Menu Bar/Buttons
 
-The following functions are available:
+The following functions are available in all tabs:
 
 Button                       | Function
 -----------------------------|---------

diff --git a/docs/class/mpegts_network.md b/docs/class/mpegts_network.md
index 2e93dd4544c778f28922e67f41a674417d8ed2a8..a199475fc6a82389a714bbae07aedc94ad87cff0 100644 (file)
--- a/docs/class/mpegts_network.md
+++ b/docs/class/mpegts_network.md
@@ -49,11 +49,11 @@ most of which can be seen in the grid view.
 
 !['Add new network'](static/img/doc/addnewnetwork.png)
 
-Pressing the *[Save]* button (at the bottom of the dialog) 
-will commit your changes and close the dialog, pressing the *[Apply]* 
-button will commit your changes but won't close the dialog, pressing 
-the *[Cancel]* button closes the dialog - any unsaved changes will be 
-lost.
+Once you're happy with what you've entered into the dialog you can save 
+the network using the *[Save]* button (closing the dialog), save your 
+pending changes and continue making further adjustments by pressing the 
+*[Apply]* button, or cancel any unsaved changes (and close the dialog) 
+by pressing the *[Cancel]* button.
 
 **Notes**:
 

diff --git a/docs/markdown/inc/add_grid_entry.md b/docs/markdown/inc/add_grid_entry.md
index 806053818136146f9c9ae371730b7757b0d6ecc7..84446909f22bd0e26ed236cb43a6424ddba66a91 100644 (file)
--- a/docs/markdown/inc/add_grid_entry.md
+++ b/docs/markdown/inc/add_grid_entry.md
@@ -4,8 +4,9 @@ To add an entry click the *[Add]* button from the menu bar, the add
 dialog should now be displayed. A common set of fields is used for the 
 add dialog, most of which can be seen in the grid view.
 
-Pressing the *[Save]* button (at the bottom of the dialog) 
-will commit your changes and close the dialog, the *[Apply]* 
-button will commit your changes but won't close the dialog, 
-the *[Cancel]* button closes the dialog, any unsaved changes will be 
-lost.
+Once you're happy with what you've entered into the dialog you can save 
+your entry using the *[Save]* button (closing the dialog), save your 
+pending changes and continue making further adjustments by pressing the 
+*[Apply]* button, or cancel any unsaved changes (and close the dialog) 
+by pressing the *[Cancel]* button.
+

diff --git a/docs/markdown/inc/edit_grid_entries.md b/docs/markdown/inc/edit_grid_entries.md
index cafef24b48951b5a164c6b209703c0102d71f383..f7227d8dbd3b2f6c01c25aaa0e70a399c322ccfc 100644 (file)
--- a/docs/markdown/inc/edit_grid_entries.md
+++ b/docs/markdown/inc/edit_grid_entries.md
@@ -22,13 +22,11 @@ can now be kept (*[Save]* button), or abandoned (*[Undo]* button).
 Highlight (select) the entries in the grid that you'd like to edit, then 
 click the *[Edit]* button from the menu bar, the edit dialog should now 
 be displayed. A common set of fields is used for the edit dialog, most 
-of which can be seen in the grid view. 
-Note that when editing 
-multiple entries there is an additional check box before each setting, 
+of which can be seen in the grid view. Note that when editing multiple 
+entries there is an additional check box before each setting, 
 ticking it will apply that setting to all selected entries.
 
-Pressing the *[Save]* button (at the bottom of the dialog) 
-will commit your changes and close the dialog, pressing the *[Apply]* 
-button will commit your changes but won't close the dialog, pressing 
-the *[Cancel]* button closes the dialog - any unsaved changes will be 
-lost.
+After you've finished editing an entry you can save your pending changes 
+using the *[Save]* button (closing the dialog), save your changes and continue making 
+further adjustments by pressing the *[Apply]* button, or cancel any unsaved 
+changes (and close the dialog) by pressing the *[Cancel]* button.