]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: cleanup satip_server doc & add a little more info about grabber priority
authorMark Clarkstone <hello@markclarkstone.co.uk>
Thu, 5 Jan 2017 23:20:21 +0000 (23:20 +0000)
committerJaroslav Kysela <perex@perex.cz>
Fri, 6 Jan 2017 09:12:10 +0000 (10:12 +0100)
docs/class/satip_server.md
docs/property/epggrabber_priority.md [new file with mode: 0644]
src/epggrab/module.c

index 6a1ac2e5069e8158ad3ef3a80eb5d0cffa6c0f87..c4c185f7bff3a343f134316b6bbc2604a63897e3 100644 (file)
@@ -1,5 +1,5 @@
 SAT\>IP Server is something like DVB network tuner. Tvheadend can
-forward mpegts input streams including on-the-fly descramling to SAT\>IP
+forward mpegts input streams including on-the-fly descrambling to SAT\>IP
 clients.
 
 !['SAT\>IP Config tab'](static/img/doc/satipconfig.png)
@@ -19,49 +19,44 @@ Button                      | Function
 
 ---
 
-###General Information
+###How to Configure Tvheadend as a SAT\>IP Server (Basic Guide)
 
-Only networks with the “SAT>IP Source” field set are exported through 
-the SAT>IP protocol. This field is matched through the “src” parameter 
-requested by 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 applies to unknown muxes).
-
----
+**1. Define the RTSP Port**
 
-###Basic Configuration Guide
+This can be anything you like, it is recommended that you use 9983 
+(to avoid permission issues). Entering zero (0) in this field will 
+disable the server. 
 
-####1. Define the RTSP Port
+**2. Export the Tuners**
 
-This can be anything you like, however it is 
-recommended that you use 9983 (to avoid permission issues). Entering 
-zero (0) in this field will disable the server. 
+In the *Exported tuners* section, enter the number of tuners (per 
+delivery system) that you'd like to export. This setting lets the 
+client know how many tuners are available for use, while you can enter 
+any number you like here, exporting more tuners than you have can lead 
+to scanning/tuning failures, e.g. "No free tuner".
 
-####2. Export the Tuners
+**3. Export Your Networks** 
 
-In the *Exported tuners* section enter the 
-number of tuners (per delivery system) that you'd like to export. This 
-setting lets the client know how many tuners are available for use. 
-While you can enter any number you like here, exporting more tuners 
-than you have can lead to scanning/tuning failures, e.g. "No free tuner".
+You must enter a *SAT\>IP source number* for all the 
+[networks](class/mpegts_network) you want to export. If you don't export 
+any, you will see the following error message (in the log).
 
-####3. Export Your Networks 
+`satips: SAT>IP server announces an empty tuner list to a client <IP ADDRESS OF CLIENT> (missing network assignment)` 
 
-Tvheadend won't export any tuners without any assigned networks, if you 
-haven't already done so you must enter a *SAT\>IP source number* for 
-a [network](class/mpegts_network). If you don't export a network you 
-may see the following debug error message.
+The *SAT\>IP source number* is matched through the “src” parameter 
+requested by 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 and 4 = DiseqC BB.
 
-`satips: SAT>IP server announces an empty tuner list to a client <IP ADDRESS OF CLIENT> (missing network assignment)` 
+Note that if you use a similar number for multiple 
+networks, the first matched network containing the mux with the 
+requested parameters will win (also applies to unknown muxes).
 
-####4. Configure Your Client
+**4. Configure Your Client**
 
 Hopefully (and if everything went to plan) your client should have 
-now detected Tvheadend as a SAT\>IP server, if not, you may want to 
-trigger service discovery or restart it.
+now detected Tvheadend as a SAT\>IP server. If not, restart or force 
+it to perform a service discovery.
 
 ---
diff --git a/docs/property/epggrabber_priority.md b/docs/property/epggrabber_priority.md
new file mode 100644 (file)
index 0000000..72c0795
--- /dev/null
@@ -0,0 +1,7 @@
+:
+
+Only OTA EIT and PSIP (ATSC) grabbers are enabled by default. 
+Also note that **EPG data isn't merged**, so be sure to 
+give the highest priority to the grabber that provides you with the 
+best data available.
+
index 95091e87c904ef9d62f952f53a7686330fb51b07..a30d34a77e2c911f3d079c18adff1276ccd5d9fd 100644 (file)
@@ -105,6 +105,7 @@ static int epggrab_mod_class_type_set(void *o, const void *v)
 }
 
 CLASS_DOC(epggrabber_modules)
+PROP_DOC(epggrabber_priority)
 
 const idclass_t epggrab_mod_class = {
   .ic_class      = "epggrab_mod",
@@ -153,10 +154,11 @@ const idclass_t epggrab_mod_class = {
       .type   = PT_INT,
       .id     = "priority",
       .name   = N_("Priority"),
-      .desc   = N_("Grabber priority. This option lets you pick which "
-                   "EPG grabber's data gets used first if more than one "
-                   "grabber is enabled. Priority is given to the grabber "
-                   "with the highest value set here."),
+      .desc   = N_("Grabber priority. This option let's you pick which "
+                   "EPG grabber's data get used first. Priority is "
+                   "given to the grabber with the highest value set here. "
+                   "See Help for more info."),
+      .doc    = prop_doc_epggrabber_priority,
       .off    = offsetof(epggrab_module_t, priority),
       .opts   = PO_EXPERT,
       .group  = 1