From: E.Smith <31170571+azlm8t@users.noreply.github.com>
Date: Wed, 3 Oct 2018 15:49:51 +0000 (+0100)
Subject: doc: Add extra documentation for fanart configuration.
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8321bb4f3944f778d327514bfb0c95d80b5b2a99;p=thirdparty%2Ftvheadend.git

doc: Add extra documentation for fanart configuration.
---

diff --git a/docs/property/dvrconfig_fanart.md b/docs/property/dvrconfig_fanart.md
new file mode 100644
index 000000000..a4f8a9dd6
--- /dev/null
+++ b/docs/property/dvrconfig_fanart.md
@@ -0,0 +1,33 @@
+
+Tvheadend supports multiple different fanart grabbers/providers, and
+can be extended with third-party grabbers.
+
+Grabbers frequently require additional options such as "api keys",
+which are generated by registering at the appropriate site.
+
+If you do not register and provide the api keys then the
+fanart grabber will fail.
+
+Modules that are supplied with Tvheadend are listed below.
+
+Module | Extra Arguments                | Description
+:-----:|--------------------------------|------------
+tmdb   | `--tmdb-key ABC`               | Key from [tmdb.org](https://www.themoviedb.org/account/signup) (Movies)
+tvdb   | `--tvdb-key ABC`               | Key from [thetvdb.com](https://www.thetvdb.com/login) (TV Series)
+tvdb   | `--tvdb-languages en,sv,hu,de` | Languages to use for searching for episode.
+
+Fanart grabbers only work correctly if your scrapper provides
+high quality information. In particular, they require season
+and episode details for series, and year details for movies.
+
+Even with these details, fanart grabbers can sometimes return
+incorrect results.
+
+Optional extra arguments can be supplied to alter behaviour.
+Notable arguments are below:
+
+Argument          | Description
+:----------------:| -------------
+`--debug`         | Provide extra level of debugging information
+`--modules-tv`    | Advanced option specifying a csv of tv modules to use.
+`--modules-movie` | Advanced option specifying a csv of movie modules to use.
diff --git a/src/dvr/dvr_config.c b/src/dvr/dvr_config.c
index ac9203c17..3be3f07ec 100644
--- a/src/dvr/dvr_config.c
+++ b/src/dvr/dvr_config.c
@@ -809,6 +809,7 @@ PROP_DOC(runningstate)
 PROP_DOC(dvrconfig_whitespace)
 PROP_DOC(dvrconfig_unsafe)
 PROP_DOC(dvrconfig_windows)
+PROP_DOC(dvrconfig_fanart)
 
 const idclass_t dvr_config_class = {
   .ic_class      = "dvrconfig",
@@ -999,8 +1000,8 @@ const idclass_t dvr_config_class = {
       .id       = "fetch-artwork",
       .name     = N_("Fetch artwork for new recordings."),
       .desc     = N_("Fetch additional artwork from installed providers. "
-                     "Tvheadend has a 'tmdb' provider for movies, which requires "
-                     "you to specify your authorized 'tmdb key' in the options below."),
+                     "Tvheadend has a 'tmdb' and `tvdb' provider which require "
+                     "you to specify your authorized key in the options below."),
       .off      = offsetof(dvr_config_t, dvr_fetch_artwork),
       .opts     = PO_ADVANCED,
       .group    = 8,
@@ -1015,7 +1016,7 @@ const idclass_t dvr_config_class = {
                      "Without this information, lookups will frequently fail "
                      "or return incorrect artwork. "
                      "The default is to only lookup fanart for broadcasts that "
-                     "have high quality identifiable information. "
+                     "have high quality identifiable information."
                     ),
       .off      = offsetof(dvr_config_t, dvr_fetch_artwork_allow_unknown),
       .opts     = PO_ADVANCED,
@@ -1026,8 +1027,10 @@ const idclass_t dvr_config_class = {
       .id       = "fetch-artwork-options",
       .name     = N_("Additional command line options when fetching artwork for new recordings."),
       .desc     = N_("Some artwork providers require additional arguments such as "
-                     "'--tmdb-key my_key_from_website'. These can be specified here."),
+                     "'--tmdb-key my_key_from_website'. These can be specified here. "
+                     "See Help for full details."),
       .off      = offsetof(dvr_config_t, dvr_fetch_artwork_options),
+      .doc      = prop_doc_dvrconfig_fanart,
       .opts     = PO_ADVANCED,
       .group    = 8,
     },