From: Mark Clarkstone Date: Sat, 24 Sep 2016 11:00:44 +0000 (+0100) Subject: mdhelp: more clean-ups X-Git-Tag: v4.2.1~234 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=dfcb9d0bffe8b7b079efd6d60f614a2bb2732601;p=thirdparty%2Ftvheadend.git mdhelp: more clean-ups --- diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md index 89999faea..cd64fd151 100644 --- a/docs/class/access_entry.md +++ b/docs/class/access_entry.md @@ -31,16 +31,11 @@ Button | Function ####Example -This is an example of a very limited user account entry. +This is an example of a limited user account entry. !['Access Entry Example'](static/img/doc/accessentriesnewuser.png) -If you would like to allow anonymous access to your Tvheadend -server you may set-up an anonymous account by entering an asterisk `*` -in the username field. **WARNING: All access rights given to an -anonymous account also apply to subsequent accounts.** - -**Don't forget** to also create a password entry for the user in the +Remember to also create a password entry for the user in the *[Passwords](class/passwd)* tab! **Tips**: @@ -48,14 +43,9 @@ anonymous account also apply to subsequent accounts.** over the Internet. * 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](#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 (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). +rights, allowing you to enable / disable each as needed. Note, matching +(enabled) accounts will have permissions combined. --- @@ -72,7 +62,7 @@ username and password fields when adding the entry). 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 +may been asked to enter a superuser username and password during installation. To create a superuser account you must have access to your Tvheadend @@ -95,3 +85,14 @@ access entries grid. is able to read the superuser file. --- + +###Anonymous Access + +If you would like to allow anonymous access to your Tvheadend server +you may set-up a wildcard account, you can do this by creating a new +user and entering an asterisk `*` in the username field. + +**WARNING**: Permissions given to a wildcard account apply +to **all** accounts. + +--- diff --git a/docs/markdown/configure_tvheadend.md b/docs/markdown/configure_tvheadend.md index 3cd0b1ca8..86ccc1197 100644 --- a/docs/markdown/configure_tvheadend.md +++ b/docs/markdown/configure_tvheadend.md @@ -104,75 +104,24 @@ force a scan and effectively ask your tuner what it can see. This is where the services will appear as your tuners tune to the muxes based on the network you told them to look on. Again, remember what's happening: Tvheadend is telling your tuner hardware (via the drivers) to sequentially -tune to each mux it knows about, and then see what 'programmes' it can see +tune to each mux it knows about, and then see what 'programs' it can see on that mux, each of which is identified by a series of unique identifiers that describe the audio stream(s), the video stream(s), the subtitle stream(s) and language(s), and so on. (For the technically-minded, these unique identifiers - the elementary streams - are referred to as 'packet identifiers' or 'PIDs'). -####5.1. Forcing a Scan - - **Tvheadend web interface: _Configuration -> DVB Inputs -> Networks_** - - Highlight the network(s) you would like to force scan and then press - the "Force Scan" button. - - Force scanning can take some time. You may continue to use Tvheadend - while a scan is in progress, but doing so will increase the time - needed for it to complete. Note that the time required can vary - depending on a number of factors, such as how many tuners you - have available and the number of muxes on each. - - **Tip**: You may select more than one network by holding ctrl and - clicking on additional networks. - ###6. Map Services to Channels **Tvheadend web interface: _Configuration -> DVB Inputs -> Services_** Once scanning for services is complete, you need to map the services to channels so your client can actually request them (i.e. so you can watch - or record). There are a number of methods to mapping available services, - mapping uses the following dialog. - - !['Service mapper dialog'](static/img/doc/mapservicesdialog.png) - -####6.1 Mapping All - - Press the *[Map services]* button and then *[Map all services]*. - - !['Map All Services'](static/img/doc/mapservicesall.png) - - The [Map services to channels](class/service_mapper) dialog will - now be displayed with **all** services checked - feel free to make - changes. Once you're happy with the selection press the - "Map services" button, you will then be taken to the - [Service Mapper](status_service_mapper) tab which will begin mapping - the selected services to channels. - -####6.2 Mapping Selected - - Click on the services you would like to map as channels, - once you're done selecting press the "Map services" button and - then "Map selected services". - - !['Map selected'](static/img/doc/mapselectedservices.png) - - The [Map services to channels](class/service_mapper) dialog will - now be displayed with the **selected** services checked - feel free to make - changes. Once you're happy with the selection press the - "Map services" button, you will then be taken to the - [Service Mapper](status_service_mapper) tab which will begin mapping - the selected services to channels. + or record). -inc/selecting_entries_tip - - **Tip**: By default Tvheadend will only show a small selection of - available services - you can increase this by using the paging - selector at the bottom right of the page. + See [Services](class/mpegts_service) for a detailed look into service mapping. -####6.3. Bouquets +####6.1. Bouquets **Tvheadend web interface: _Configuration -> Channel / EPG -> Bouquets_** @@ -182,7 +131,7 @@ and language(s), and so on. If you would like to use bouquets see [Bouquets](class/bouquet). -### 7. Watch TV +###7. Watch TV That's it - you're done. You should now have a working basic Tvheadend installation with channels mapped and ready for use! diff --git a/docs/markdown/epg.md b/docs/markdown/epg.md index 1822b7d05..198e3516e 100644 --- a/docs/markdown/epg.md +++ b/docs/markdown/epg.md @@ -138,7 +138,7 @@ Icon | Description --- -###Event details and recording +###Event Details and Recording If you click on a single event, a popup will display detailed information about the event. It also allows you to schedule the event diff --git a/docs/markdown/inc/add_grid_entry.md b/docs/markdown/inc/add_grid_entry.md index c0d5e1512..a1c31a4c8 100644 --- a/docs/markdown/inc/add_grid_entry.md +++ b/docs/markdown/inc/add_grid_entry.md @@ -1,10 +1,6 @@ ###Adding an Entry 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. - -You can save your entry by pressing the *[Save]* button, pressing the -*[Apply]* button saves your entry but keeps the dialog open so you can -make further adjustments, pressing the *[Cancel]* button closes the -dialog - any unsaved changes will be lost. +dialog should now be displayed. Once you've filled in the required/desired +fields you can then press *[Save]* to add the entry, *[Apply]* to commit +and continue editing or *[Cancel]* to abort (losing any unsaved changes). diff --git a/docs/markdown/inc/dvr.md b/docs/markdown/inc/dvr.md index 1f934b879..321b2884a 100644 --- a/docs/markdown/inc/dvr.md +++ b/docs/markdown/inc/dvr.md @@ -2,25 +2,22 @@ This tab is where you manage your recordings. Each entry is moved between the *Upcoming / Current Recordings*, *Finished Recordings* and *Failed Recordings* sub-tabs depending on its status. -!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) - -####Upcoming / Current Recordings - -This sub-tab lists current and upcoming recording entries. Entries +**Upcoming / Current Recordings** +: This sub-tab lists current and upcoming recording entries. Entries that appear here are either currently recording or are soon-to-be recorded. -####Finished Recordings - -This sub-tab lists all completed recording entries. Entries that appear +**Finished Recordings** +: This sub-tab lists all completed recording entries. Entries that appear here have reached the end of the scheduled recording time. -####Failed Recordings - -This sub-tab lists all failed recording entries. Entries that appear +**Failed Recordings** +: This sub-tab lists all failed recording entries. Entries that appear here have failed to record due to one (or more) errors that occurred during the recording. +!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) + --- ###Menu Bar/Buttons