]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: more changes and additions to the help docs, plus some other little changes
authorMark Clarkstone <hello@markclarkstone.co.uk>
Tue, 16 Aug 2016 23:45:54 +0000 (00:45 +0100)
committerJaroslav Kysela <perex@perex.cz>
Wed, 17 Aug 2016 12:29:41 +0000 (14:29 +0200)
14 files changed:
docs/class/mpegts_service.md
docs/class/service_mapper.md
docs/markdown/configure_tvheadend.md
docs/property/cache_scheme.md
docs/property/duplicate_handling.md
docs/property/dvr_start_extra.md
docs/property/dvr_stop_extra.md
docs/property/dvr_timerec_title_format.md
docs/property/pathname.md
docs/property/predefinedmuxlist.md
docs/property/runningstate.md
docs/property/streaming_priority.md
docs/property/themes.md
src/input/mpegts/linuxdvb/linuxdvb_frontend.c

index 0d44431f31f3552406306da7174bd40e31259041..eb074754e5273b66bf9647f1f1c5fc097aa802e3 100644 (file)
@@ -23,42 +23,38 @@ Mapping Button              | Function
 
 ###Mapping Services to Channels
 
-There are a number of methods to mapping available services.
+  There are a number of methods to mapping available services, 
+  mapping uses the following dialog.
 
-*Map all services* and *Map selected services* functions use the 
-following *Map services to channels* dialog:
-
-!['Service mapper dialog'](static/img/doc/mapservicesdialog.png)
+  !['Service mapper dialog'](static/img/doc/mapservicesdialog.png)
 
 ####Mapping All
 
-Press the *[Map services]* button and then *[Map all services]*
+Press the *[Map services]* button and then *[Map all services]*.
 
 !['Map All Services'](static/img/doc/mapservicesall.png)
-  
-The *Map services to channels* dialog will now appear, listing all available services and various 
-other [mapping options.](class/service_mapper) The ticked check boxes 
-[✓] indicate which services will be mapped, when you're happy with the selection press 
-the "Map services" button. You will then be taken to the Service 
-Mapper tab which will begin mapping services to channels. 
+
+The [Map services to channels](class/service_mapper) 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. 
   
 ####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" - be careful not to click on the grid or 
-you'll lose your selection!
-
-<tvh_include>inc/selecting_entries_tip</tvh_include>
+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* dialog will now appear, listing all available services and various 
-other [mapping options.](class/service_mapper) The ticked 
-check boxes [✓] indicate which services will be mapped, when you're 
-happy with the selection press the "Map services" button. You will 
-then be taken to the Service Mapper tab which will begin mapping 
-services to channels. 
+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. 
+
+<tvh_include>inc/selecting_entries_tip</tvh_include>
 
 **Tip**: By default Tvheadend will only show a small selection of 
 available services - you can increase this by using the paging 
@@ -71,10 +67,10 @@ You can map/remove a service to/from an existing channel by doing the following:
 **1)** Find the desired service from within the services grid. 
 
 If you have a lot of services you may want to use filtering to limit the 
-number of grid entries, you can do this by hovering your mouse over the 
-*Service name* column, a down arrow ▾ should now be visible. Clicking 
+number of grid entries. You can do this by hovering your mouse over the 
+*Service name* column, a down arrow ▾ should now be visible, clicking 
 the arrow will then display a list of options, move your mouse down to 
-"Filters", a text box should then appear, click on it and enter the 
+"Filters" and a text box should then appear, click on it and enter the 
 desired service's name.
 
 !['Service filtering'](static/img/doc/servicefilter.png)
@@ -83,12 +79,12 @@ desired service's name.
 check box next to the "Filters" option). 
 
 **2)** Double click on the channel field, a drop down listing of all defined 
-channels will appear, check/untick the check box next to the channel 
+channels will appear, check/uncheck the check box next to the channel 
 you'd like to associate/disassociate the service with. 
 
 !['Add service to channel example'](static/img/doc/addservicetochannel.png)
 
-**3)** Press the *[Save]* button from the menu bar and you're done!
+**3)** Press the *[Save]* button from the menu bar, and you're done!
 
 ---
 
index 9d1fc2f8aff6464adfa054099bd9fba60d573169..3c155d86e40fbe481351ed7866081b1de65a1786 100644 (file)
@@ -1,4 +1,4 @@
-The map services to channels dialog allows you to control how 
+The map services to channels dialog allows you to control how and which 
 services are mapped. The options selected here get passed to the 
 [Service Mapper](status_service_mapper) tab when you press 
 the *[Map services]* button.
index 401e7f0b3828decef74a272de4ea98dfab0d0c1d..3cd0b1ca812089585ed9d5d555fee1573edc9583 100644 (file)
@@ -32,8 +32,7 @@ of the same type as necessary, e.g. to have two DVB-T networks defined,
 one with HD muxes, one without.
 
 The creation process allows you to select from a series of pre-defined mux
-lists for common DVB sources. These are maintained outside of Tvheadend, and
-are downloaded from [linuxtv](http://git.linuxtv.org/cgit.cgi/dtv-scan-tables.git/) -
+lists for common DVB sources. These are available [here](https://github.com/tvheadend/dtv-scan-tables) -
 but they do go out of date as broadcasters move services around and national
 authorities change entire pieces of spectrum. As such, you should try the
 pre-defined values, but you may need to add muxes manually.
@@ -114,8 +113,6 @@ and language(s), and so on.
 
 ####5.1. Forcing a Scan
 
-  You may force a scan by going to:
-
   **Tvheadend web interface: _Configuration -> DVB Inputs -> Networks_**
 
   Highlight the network(s) you would like to force scan and then press 
@@ -132,35 +129,44 @@ and language(s), and so on.
 
 ###6. Map Services to Channels
 
-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).
+  **Tvheadend web interface: _Configuration -> DVB Inputs -> Services_**
 
-**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.
 
-####6.1. Mapping All
+  !['Service mapper dialog'](static/img/doc/mapservicesdialog.png)
 
-  Press the "Map services" button and then "Map all services". 
-  
-  A dialog will then appear with the list of available services and various 
-  other mapping options. The ticked check boxes [✓] indicate which 
-  services will be mapped, when you're happy with the selection press 
-  the "Map services" button. You will then be taken to the Service 
-  Mapper tab which will begin mapping services to channels. 
+####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
+####6.2 Mapping Selected
 
-  While holding ctrl (single selection) or shift (to select a range)
-  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" - **be careful not to click on the grid or 
-  you'll lose your selection!**
+  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)
     
-  A dialog will then appear with the list of available services and 
-  various other mapping options. The ticked check boxes [✓] indicate 
-  which services will be mapped, when you're happy with the selection 
-  press the "Map services" button. You will then be taken to the 
-  Service Mapper tab which will begin mapping services to channels. 
+  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. 
+  
+<tvh_include>inc/selecting_entries_tip</tvh_include>
 
   **Tip**: By default Tvheadend will only show a small selection of 
   available services - you can increase this by using the paging 
index f77055ddfc4d565646988ae116f072eb63035f2e..69c0b76ee3b5caf6943db586ec9c80c3dbf995f1 100644 (file)
@@ -1,7 +1,7 @@
 :
 
 Whenever you read or write data to the filesystems, the information is 
-kept (cached) in memory for a while. This means that regularly-access 
+kept (cached) in memory for a while. This means that regularly-accessed 
 files are available quickly without going back to the disc; it also 
 means that there’s a disconnect when writing between the write request 
 (from the application) and the actual write itself (to the disc/storage) 
index 5a8a53e2c61122369eca51ae66ff3381d2f820e3..fff318cfe3155b167bafc8116de0c3da8aa544df 100644 (file)
@@ -9,6 +9,5 @@ Option                                       | Description
 **Record once per week**                     | Record the first matching event once a week.
 **Record once per day**                      | Record the first matching event once a day.
 
-*Local* or *All*? Local only checks the DVR log entries that were created by the 
-same autorec rule for duplicates, All checks all DVR log entries for 
-duplicates.
+*Local* only checks for duplicates created by the same 
+autorec rule, *All* checks all the DVR logs for duplicates.
index 29399c358b9daa1cb947a75c52ec199f1a34bd6f..30408d7393122111ad169a4f6f74e24c17022f98 100644 (file)
@@ -2,9 +2,8 @@
  
 For example, if a program is to start at 13:00 and you set a padding of 
 5 minutes, it will start recording at 12:54:30 (including a warm-up 
-time of 30 seconds (user configurable)). If this isn't 
-specified, any pre-recording padding as set in the channel or DVR 
-profile will be used. 
+time of 30 seconds (user configurable)). Setting the padding per 
+channel will override the padding set in the [DVR Profile](class/profile). 
 
 Be sure to check you have enough free tuners available
 to record all scheduled recordings if they overlap.
index a897738923fa43c1985a71c0b7c39a6e31a59a7d..acd4fc90b8208568069be22cac8de0bb036656ae 100644 (file)
@@ -3,4 +3,5 @@
 This is extremely useful for those programs you think/know will overrun. 
 Any value selected here will keep a tuner busy for longer, so be sure 
 to check you have enough free tuners to record all scheduled recordings 
-if they overlap.
+if they overlap. Setting the padding per 
+channel will override the padding set in the [DVR Profile](class/profile).
index 42e7f374024fb602c7e5881c7716c5eaede73c85..953ce94a911b930aa2637093f803a7206e456c71 100644 (file)
@@ -6,5 +6,5 @@ String | Format Result
 %R     | The time in 24h HH:MM format (e.g. 19:45).
 %x     | The date, formatted according to your locale settings.
 
-The escape-codes use
+The escape-codes use the
 [strftime](http://man7.org/linux/man-pages/man3/strftime.3.html) format.
index 40ef4187e3d33e8085383dfb2c5cc9b337b1cd2d..221fd6b1381f44d435e7fcfbf1b644a765f12002 100644 (file)
@@ -1,4 +1,4 @@
-: The string allow to manually specify the full path generation using
+: The string allows you to manually specify the full path generation using
   the predefined modifiers for strftime (see `man strftime`, except
   `%n` and `%t`) and Tvheadend specific. Note that you may modify some of
   this format string setting using the GUI fields below.
index 99a2b695f48c6e2524de47e3937f8c41978a3d1e..c5c48dc4cc217d98f00df8d287b99a3787fe74d7 100644 (file)
@@ -1,6 +1,8 @@
 :
 
-Generally an out of date mux list isn't an issue provided that you have 
-*Network Discovery* enabled and a mux (in the list) with [NIT](https://en.wikipedia.org/wiki/Program-specific_information#NIT_.28network_information_specific_data.29) 
-data scans successfully, Tvheadend will parse the NIT and then add/scan 
-newly discovered muxes automatically. 
+If you have *Network Discovery* enabled, an out-of-date mux list isn't 
+usually an issue provided that one of the muxes in the list scans 
+successfully and has a [Network Information Table (NIT)](https://en.wikipedia.org/wiki/Program-specific_information#NIT_.28network_information_specific_data.29) 
+available. Tvheadend will parse the NIT then the add newly discovered 
+muxes automatically.
+
index 4635df83c837346967553169262ddf7ee1725ff1..62c668ccae52dbc31dd4c188e61655250d142c30 100644 (file)
@@ -7,8 +7,8 @@ program starts, pauses or finishes.
 It is recommended that you only enable this option if you're absolutely 
 sure the flags are sent correctly and on time. Incorrect EITp/f flags 
 can result in failed/broken recordings.
-
-You can set this option per channel or per DVR profile
+You can set this option per [channel](class/channel) or per 
+[DVR profile](class/dvrconfig)
 enabling/disabling per channel overrides the DVR profile setting.
 
 Per Channel Option    | Description
index d08f0b2f4fce2768f9e3c323404670bc872fef24..2ec67818adf5d6b99ee92b36227ea730f1080498 100644 (file)
@@ -2,4 +2,4 @@
 
 Streaming priority is like the *Priority* setting (above) but only 
 applies when streaming over HTTP or HTSP. If no streaming priority value 
-is set (0) the priority value is used instead.
+is set (0) the *Priority* value is used instead.
index a2b90efd526587162d290d50cc6e4330ca57a3a4..5f342ae7b8929023a40f2b794d543543470caff8 100644 (file)
@@ -5,3 +5,5 @@ Option           | Description
 **Blue**         | Use the (default) blue theme.
 **Gray**         | Use the gray theme.
 **Access**       | Use the high contrast accessibility theme.
+
+This setting can be overridden on a per-user basis, see [Access Entries](class/access).
index 50cdc50c84c94a6329e9e1db6f2945dc459f0579..326f74aec784f4a08a998856c5fe17106e10211f 100644 (file)
@@ -1573,7 +1573,7 @@ linuxdvb_frontend_tune0
   if (tvhtrace_enabled()) {
     char buf2[256];
     dvb_mux_conf_str(&lm->lm_tuning, buf2, sizeof(buf2));
-    tvhtrace(LS_LINUXDVB, "tuner %s tunning to %s (freq %i)", buf1, buf2, freq);
+    tvhtrace(LS_LINUXDVB, "tuner %s tuning to %s (freq %i)", buf1, buf2, freq);
   }
   memset(&p, 0, sizeof(p));
   p.frequency                = dmc->dmc_fe_freq;