]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: more refresh
authormpmc <git@markclarkstone.co.uk>
Sun, 3 Dec 2017 21:26:04 +0000 (21:26 +0000)
committerJaroslav Kysela <perex@perex.cz>
Thu, 14 Dec 2017 07:18:16 +0000 (08:18 +0100)
24 files changed:
docs/class/bouquet.md
docs/class/caclient.md
docs/class/caclient_capmt.md [deleted file]
docs/class/channel.md
docs/class/channeltag.md
docs/class/codec_profile.md
docs/class/debugging.md
docs/class/dvrconfig.md
docs/class/epgconf.md
docs/class/epggrabber_modules.md
docs/class/filters.md
docs/class/profile.md
docs/class/timeshift.md
docs/markdown/inc/caclient_contents.md [new file with mode: 0644]
docs/markdown/inc/recording_contents.md [new file with mode: 0644]
docs/markdown/toc.md
src/descrambler/capmt.c
src/descrambler/cccam.c
src/descrambler/dvbcam.c
src/webui/static/img/doc/caclient/cas.png [new file with mode: 0644]
src/webui/static/img/doc/caclient/tab.png [deleted file]
src/webui/static/img/doc/caclient_capmt/tab.png [deleted file]
src/webui/static/img/doc/recordings/dvrprofiles.png [new file with mode: 0644]
src/webui/static/img/doc/recordings/timeshift.png [moved from src/webui/static/img/doc/timeshift/tab.png with 100% similarity]

index ba775a8afe319f7aea70c09be591699d721e4374..07f99a1ab794f30643e1631bbf0a57aa09fd2345 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 Bouquets are broadcaster-defined groupings and orders of channels.
 
index 8ddaad56e89ff9f947ac7df85ba97865eb811b9b..e81a23e6cea344eda4675321ec86fbc727ba6066 100644 (file)
@@ -1,45 +1,43 @@
+<tvh_include>inc/caclient_contents</tvh_include>
+
+---
+
+## Overview
+
 Tvheadend supports connecting to card clients via the cwc (newcamd) and
 capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling.
 
-!['CA Client Configuration Example'](static/img/doc/caclient/tab.png)
+!['CA Client Configuration Example'](static/img/doc/caclient/cas.png)
 
 ---
 
-### Menu Bar/Buttons
-
-The following functions are available:
+## Buttons
 
-Button              | Function
---------------------|---------
-**Save**            | Save any changes made to the CA client configuration.
-**Undo**            | Undo any changes made to the CA client configuration since the last save.
-**Add**             | Add a new CA client configuration.
-**Delete**          | Delete an existing CA client configuration.
-**Clone**           | Clone the currently selected configuration.
-**Move Up**         | Move the selected CA client configuration up in the list.
-**Move Down**       | Move the selected CA client configuration down in the list.
-**Show/Hide Passwords**  | Reveal/Hide any stored CA client passwords.
-**Help**            | Display this help page.
+<tvh_include>inc/buttons</tvh_include>
 
 ---
 
-### Available CA types
+## Client Types
 
-The following configuration parameters are used, depending on the type 
-of CA access:
+Type                                                        | Description
+------------------------------------------------------------|------------
+[Linux DVB CAM Client](class/caclient_dvbcam)               | For use with devices that have a CAM module.
+[Code Word Client (CWC) / newcamd](class/caclient_cwc)      | For newcamd or CWC.
+[CCCam](class/caclient_cccam)                               | For CCCam connections.
+[CAPMT (Linux DVBAPI)](class/caclient_capmt)                | For DVBAPI connections
+[CSA CBC Constant Code Word](class/caclient_ccw_csa_cbc)    | For Constant Code Word connections (CSA/CBC variant)
+[DES NCB Constant Code Word](class/caclient_ccw_des_ncb)    | For Constant Code Word connections (DES/NCB variant)
+[AES ECB Constant Code Word](class/caclient_ccw_aes_ecb)    | For Constant Code Word connections (AES/ECB variant)
+[AES ECB Constant Code Word](class/caclient_ccw_aes128_ecb) | For Constant Code Word connections (AES128/ECB variant)
 
-* List of types
+Click a type to see its properties (below).
 
-  - [CAPMT (Linux Network DVBAPI)](class/caclient_capmt)
-  - [Code word client (newcamd)](class/caclient_cwc)
-  - [DES constant code word client](class/caclient_ccw_des)
-  - [AES constant code word client](class/caclient_ccw_aes)
 
 ---
 
-### Connection Status
+## Connection Status
 
-The icon next to each entry within the grid indicates the client'
+The icon next to each entry within the grid indicates the clients 
 connection status.
 
 Icon                                         | Description
@@ -49,3 +47,26 @@ Icon                                         | Description
 !['Stop/Disabled Icon'](icons/stop.png)      | The client is disabled.
 
 ---
+
+## OSCam Modes
+
+| Mode                              | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| OSCam net protocol (rev >= 10389) | A TCP connection to the server is created. All EMM/ECM data is sent to OSCam using this connection without the need for real linuxdvb devices to be present in the system.   This mode is suitable for all DVB devices including SAT\>IP and IPTV. If you run your OSCam server on the same machine as TVHeadend, set *Camd.socket filename / IP Address (TCP mode)* field to 127.0.0.1 and *Listen / Connect port* to 9000 (or your preferred TCP port). Note that the TCP port must match OSCam's configuration. The following lines are required in **[dvbapi]** section of oscam.conf: ```boxtype = pc pmt_mode = 4 listen_port = 9000 # or your preferred port```.|
+| OSCam new pc-nodmx (rev >= 10389) | Similar to *OSCam net protocol (rev >= 10389)* mode, but a namedpipe (/tmp/camd.socket) connection is used instead of the TCP connection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| OSCam TCP (rev >= 9574)           | A TCP connection to the server is created. All EMM/ECM data is sent to OSCam using this connection without the need for real linuxdvb devices to be present in the system. This mode is suitable for all DVB devices including SAT\>IP and IPTV. The following lines are required in **[dvbapi]** section of oscam.conf: ```boxtype = pc pmt_mode = 4 listen_port = 9000 # or your preferred port```                                                                                                                                                                                                                                                                   |
+| OSCam pc-nodmx (rev >= 9756)      | Similar to *OSCam TCP (rev >= 9574)* mode, but a named pipe(/tmp/camd.socket) connection is used instead of the TCP connection.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| OSCam (rev >= 9095)               | This mode uses named pipe (/tmp/camd.socket). The difference between *Older OSCam* mode is that no UDP connections are required. All communication is processed through the named pipe(/tmp/camd.socket). The configuration for OSCam is same as the previous *Older OSCam* mode.                                                                                                                                                                                                                                                                                                                                                                                      |
+| Older OSCam                       | This mode uses named pipe (/tmp/camd.socket). If selected, connection will be made directly to OSCam without using the LD\_PRELOAD / wrapper hack. TVH listens on a range of UDP ports starting with the specified port number (standard port range starts with 9000). The following lines are required in **[dvbapi]** section of oscam.conf: ```boxtype = pc pmt_mode = 4```                                                                                                                                                                                                                                                                                         |
+| Wrapper (capmt_ca.so)             | This mode uses named pipe (/tmp/camd.socket). With the LD\_PRELOAD / wrapper hack active. TVH listens on the local specified UDP port (standard is 9000) for the code words. Only onechannel can be decoded at a time.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+
+Note, because of how markdown generates tables, the OSCam variables ```highlighted``` above must be on separate lines in your config file.
+
+For example..
+```
+boxtype = pc
+pmt_mode = 4 
+listen_port = 9000 # or your preferred port
+``` 
+
+---
diff --git a/docs/class/caclient_capmt.md b/docs/class/caclient_capmt.md
deleted file mode 100644 (file)
index 5a39389..0000000
+++ /dev/null
@@ -1,122 +0,0 @@
-Tvheadend supports connecting to card clients via the cwc (newcamd) and
-capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling.
-
-!['Channel tag'](static/img/doc/caclient_capmt/tab.png)
-
----
-
-### Menu Bar/Buttons
-
-The following functions are available:
-
-Button              | Function
---------------------|---------
-**Save**            | Save any changes made to the CA client configuration.
-**Undo**            | Undo any changes made to the CA client configuration since the last save.
-**Add**             | Add a new CA client configuration.
-**Delete**          | Delete an existing CA client configuration.
-**Clone**           | Clone the currently selected configuration.
-**Move Up**         | Move the selected CA client configuration up in the list.
-**Move Down**       | Move the selected CA client configuration down in the list.
-**Show/Hide Passwords**  | Reveal/Hide any stored CA client passwords.
-**Help**            | Display this help page.
-
----
-
-### Connection Status
-
-The icon next to each entry within the grid indicates the client's 
-connection status.
-
-Icon                                         | Description
----------------------------------------------|------------
-!['Accept/OK Icon'](icons/accept.png)        | The client is connected.
-!['Error Icon'](icons/exclamation.png)       | There was an error.
-!['Stop/Disabled Icon'](icons/stop.png)      | The client is disabled.
-
----
-
-### Modes
-
-#### OSCam net protocol (rev >= 10389)
-
-**This is the most preferred mode for the latest OSCam.** It supports
-the latest features like ECM status.
-
-A TCP connection to the server is created. All EMM/ECM data is sent to
-OSCam using this connection without the need for real linuxdvb
-devices to be present in the system. This mode is suitable for all DVB
-devices including SAT\>IP and IPTV.
-
-If you run your OSCam server on the same machine as TVHeadend, set
-*Camd.socket filename / IP Address (TCP mode)* field to 127.0.0.1
-and *Listen / Connect port* to 9000 (or your preferred TCP port).
-Note that the TCP port must match OSCam's configuration.
-
-The following lines are required in **[dvbapi]** section of oscam.conf:
-
-```
-boxtype = pc
-pmt_mode = 4
-listen_port = 9000 # or your preferred port
-```
-
-#### OSCam new pc-nodmx (rev >= 10389)
-
-Similar to *OSCam net protocol (rev >= 10389)* mode, but a named
-pipe (/tmp/camd.socket) connection is used instead of the TCP connection.
-
-#### OSCam TCP (rev >= 9574)
-
-A TCP connection to the server is created. All EMM/ECM data is sent to
-OSCam using this connection without the need for real linuxdvb
-devices to be present in the system. This mode is suitable for all DVB
-devices including SAT\>IP and IPTV.
-
-The following lines are required in **[dvbapi]** section of oscam.conf:
-
-```
-boxtype = pc
-pmt_mode = 4
-listen_port = 9000 # or your preferred port
-```
-
-#### OSCam pc-nodmx (rev >= 9756)
-
-Similar to *OSCAM TCP (rev >= 9574)* mode, but a named pipe
-(/tmp/camd.socket) connection is used instead of the TCP connection.
-
-#### OSCam (rev >= 9095)
-
-This mode uses named pipe (/tmp/camd.socket).
-
-The difference between *Older OSCam* mode is that no UDP connections
-are required. All communication is processed through the named pipe
-(/tmp/camd.socket). The configuration for OSCam is same as the previous
-*Older OSCam* mode.
-
-#### Older OSCam
-
-This mode uses named pipe (/tmp/camd.socket).
-
-If selected, connection will be made directly to OSCam without using the
-LD\_PRELOAD / wrapper hack. TVH listens on a range of UDP ports
-starting with the specified port number (standard port range starts
-with 9000).
-
-The following lines are required in **[dvbapi]** section of oscam.conf:
-
-```
-boxtype = pc
-pmt_mode = 4
-```
-
-#### Wrapper (capmt_ca.so)
-
-This mode uses named pipe (/tmp/camd.socket).
-
-With the LD\_PRELOAD / wrapper hack active. TVH listens on the local
-specified UDP port (standard is 9000) for the code words. Only one
-channel can be decoded at a time.
-
----
index 235fb3636901e07f37bab80823c840d365155ce5..7a369360435b1f1f3b9f86103e925ec49f0d2b0b 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 This tab lists all defined channels.
 
index 45b55a8538ddeaf601e415d5b35d5e4271443fc6..bd171e14036b858ff7dd9d32bf7f0e5d0262ec4b 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 This tab is used to configure channel tags. Tags are used to define a 
 set of channels - to group them, to aid searches, and similar. 
index 8042d46648d9ac89f80d5eaaa55a81f8455a9785..3a097b84f817d1ee5c759293f562e0ea2f3a7dc7 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 This tab allows you to manage the codec settings used by stream profiles. 
 
@@ -15,4 +15,3 @@ This tab allows you to manage the codec settings used by stream profiles.
 <tvh_include>inc/buttons</tvh_include>
 
 ---
-
index 45f369feb2d786d1520ffadba3d6a5cf98bb6541..7711fcc0769df9495b56e96e17990cd5053db20f 100644 (file)
+Contents                                          | Description
+--------------------------------------------------|------------------------
+[Overview](#overview)                             | Tab overview
+[Subsystems](#subsystems)                         | Available debugging subsystems
+[Items/Properties](#items)                        | Items/Properties
+
+---
+
+## Overview
+
 This tab is used to configure various debugging options in tvheadend.
 
 !['Debugging tab'](static/img/doc/debugging/tab.png)
 
-Changes to any of these settings must be confirmed by pressing the 
+### Notes
+
+* Changes to any of these settings must be confirmed by pressing the 
 *[Apply configuration]* button before taking effect.
 
-Note that settings are not saved to a storage. Any change is available 
+* Settings are not saved to a storage. Any change is available 
 only while Tvheadend is running, and will be lost on a restart. 
 To change the default behaviour permanently, use command line options 
 such as `-l,` `–debug`, `–trace`.
 
-Depending on your distribution, the default command-line configuration 
+Depending on your distribution, the default command-line configuration 
 is usually stored in the `/etc/sysconfig` tree or an init script. 
 You may also be able to change `/etc/default/tvheadend` to add additional 
 command-line parameters.
 
 ---
 
-### Menu Bar/Buttons
-
-The following functions are available:
+## Buttons
 
-Button     | Function
------------|---------
-**Apply configuration (run-time only)**   | Apply the entered debugging settings.
-<tvh_include>inc/common_button_table_end</tvh_include>
+<tvh_include>inc/buttons</tvh_include>
 
 ---
 
-### Subsystems
+## Subsystems
 
 The following options can be passed to tvheadend to provide detailed debugging 
 information while the application is running.
 
 
 
-Subsystem       | Name
-----------------|------------------------
-  START |      START
-  STOP |      STOP
-  CRASH |      CRASH
-  main |      Main
-  gtimer |      Global timer
-  mtimer |      Monitonic timer
-  CPU |      CPU
-  thread |      Thread
-  tvhpoll |      Poll multiplexer
-  time |      Time
-  spawn |      Spawn
-  fsmonitor |      Filesystem monitor
-  lock |      Locking
-  uuid |      UUID
-  idnode |      Node subsystem
-  url |      URL
-  tcp |      TCP Protocol
-  rtsp |      RTSP Protocol
-  upnp |      UPnP Protocol
-  settings |      Settings
-  config |      Configuration
-  access |      Access (ACL)
-  cron |      Cron
-  dbus |      DBUS
-  avahi |      Avahi
-  bonjour |      Bonjour
-  api |      API
-  http |      HTTP Server
-  httpc |      HTTP Client
-  htsp |      HTSP Server
-  htsp-sub |      HTSP Subscription
-  htsp-req |      HTSP Request
-  htsp-ans |      HTSP Answer
-  imagecache |      Image Cache
-  tbl |      DVB SI Tables
-  tbl-base |      Base DVB SI Tables (PAT,CAT,PMT,SDT etc.)
-  tbl-csa |      DVB CSA (descrambling) Tables
-  tbl-eit |      DVB EPG Tables
-  tbl-time |      DVB Time Tables
-  tbl-atsc |      ATSC SI Tables
-  tbl-pass |      Passthrough Muxer SI Tables
-  tbl-satip |      SAT>IP Server SI Tables
-  fastscan |      Fastscan DVB
-  parser |      MPEG-TS Parser
-  TS |      Transport Stream
-  globalheaders |      Global Headers
-  tsfix |      Time Stamp Fix
-  hevc |      HEVC - H.265
-  muxer |      Muxer
-  pass |      Pass-thru muxer
-  mkv |      Matroska muxer
-  service |      Service
-  channel |      Channel
-  subscription |      Subscription
-  service-mapper |      Service Mapper
-  bouquet |      Bouquet
-  esfilter |      Elementary Stream Filter
-  profile |      Streaming Profile
-  descrambler |      Descrambler
-  caclient |      CA (descrambling) Client
-  csa |      CSA (descrambling)
-  capmt |      CAPMT CA Client
-  cwc |      CWC CA Client
-  dvbcam |      DVB CAM Client
-  dvr |      Digital Video Recorder
-  epg |      Electronic Program Guide
-  epgdb |      EPG Database
-  epggrab |      EPG Grabber
-  charset |      Charset
-  dvb |      DVB
-  mpegts |      MPEG-TS
-  muxsched |      Mux Scheduler
-  libav |      libav / ffmpeg
-  transcode |      Transcode
-  iptv |      IPTV
-  iptv-pcr |      IPTV PCR
-  linuxdvb |      LinuxDVB Input
-  diseqc |      DiseqC
-  en50221 |      CI Module
-  en50494 |      Unicable (EN50494)
-  satip |      SAT>IP Client
-  satips |      SAT>IP Server
-  tvhdhomerun |      TVHDHomeRun Client
-  psip |      ATSC PSIP EPG
-  opentv |      OpenTV EPG
-  pyepg |      PyEPG Import
-  xmltv |      XMLTV EPG Import
-  webui |      Web User Interface
-  timeshift |      Timeshift
-  scanfile |      Scanfile
-  tsfile |      MPEG-TS File
+Subsystem                             | Short Description
+--------------------------------------|------------------------
+  START                          |           START
+  STOP                          |            STOP
+  CRASH                          |           CRASH
+  main                          |            Main
+  gtimer                          |          Global timer
+  mtimer                          |          Monitonic timer
+  CPU                          |             CPU
+  thread                          |          Thread
+  tvhpoll                          |         Poll multiplexer
+  time                          |            Time
+  spawn                          |           Spawn
+  fsmonitor                          |       Filesystem monitor
+  lock                          |            Locking
+  uuid                          |            UUID
+  idnode                          |          Node subsystem
+  url                          |             URL
+  tcp                          |             TCP Protocol
+  rtsp                          |            RTSP Protocol
+  upnp                          |            UPnP Protocol
+  settings                          |        Settings
+  config                          |          Configuration
+  access                          |          Access (ACL)
+  cron                          |            Cron
+  dbus                          |            DBUS
+  avahi                          |           Avahi
+  bonjour                          |         Bonjour
+  api                          |             API
+  http                          |            HTTP Server
+  httpc                          |           HTTP Client
+  htsp                          |            HTSP Server
+  htsp-sub                          |        HTSP Subscription
+  htsp-req                          |        HTSP Request
+  htsp-ans                          |        HTSP Answer
+  imagecache                          |      Image Cache
+  tbl                          |             DVB SI Tables
+  tbl-base                          |        Base DVB SI Tables (PAT,CAT,PMT,SDT etc.)
+  tbl-csa                          |         DVB CSA (descrambling) Tables
+  tbl-eit                          |         DVB EPG Tables
+  tbl-time                          |        DVB Time Tables
+  tbl-atsc                          |        ATSC SI Tables
+  tbl-pass                          |        Passthrough Muxer SI Tables
+  tbl-satip                          |       SAT>IP Server SI Tables
+  fastscan                          |        Fastscan DVB
+  pcr                          |             PCR Clocks
+  parser                          |          MPEG-TS Parser
+  TS                          |              Transport Stream
+  globalheaders                          |   Global Headers
+  tsfix                          |           Time Stamp Fix
+  hevc                          |            HEVC - H.265
+  muxer                          |           Muxer
+  pass                          |            Pass-through muxer
+  audioes                          |         Audio muxer
+  mkv                          |             Matroska muxer
+  service                          |         Service
+  channel                          |         Channel
+  subscription                          |    Subscription
+  service-mapper                          |  Service Mapper
+  bouquet                          |         Bouquet
+  esfilter                          |        Elementary Stream Filter
+  profile                          |         Streaming Profile
+  descrambler                          |     Descrambler
+  descrambler-emm                          | Descrambler EMM
+  caclient                          |        CA (descrambling) Client
+  csa                          |             CSA (descrambling)
+  capmt                          |           CAPMT CA Client
+  cwc                          |             CWC CA Client
+  cccam                          |           CWC CCCam Client
+  dvbcam                          |          DVB CAM Client
+  dvr                          |             Digital Video Recorder
+  epg                          |             Electronic Programme Guide
+  epgdb                          |           EPG Database
+  epggrab                          |         EPG Grabber
+  charset                          |         Charset
+  dvb                          |             DVB
+  mpegts                          |          MPEG-TS
+  muxsched                          |        Mux Scheduler
+  libav                          |           libav / ffmpeg
+  transcode                          |       Transcode
+  iptv                          |            IPTV
+  iptv-pcr                          |        IPTV PCR
+  iptv-sub                          |        IPTV Subcription
+  linuxdvb                          |        LinuxDVB Input
+  diseqc                          |          DiseqC
+  en50221                          |         CI Module
+  en50494                          |         Unicable (EN50494)
+  satip                          |           SAT>IP Client
+  satips                          |          SAT>IP Server
+  tvhdhomerun                          |     TVHDHomeRun Client
+  psip                          |            ATSC PSIP EPG
+  opentv                          |          OpenTV EPG
+  pyepg                          |           PyEPG Import
+  xmltv                          |           XMLTV EPG Import
+  webui                          |           Web User Interface
+  timeshift                          |       Timeshift
+  scanfile                          |        Scanfile
+  tsfile                          |          MPEG-TS File
+  tsdebug                          |         MPEG-TS Input Debug
+  codec                          |           Codec
+  vaapi                          |           VA-API
+
 
 ---
index 0fd752fc7a759a466fec5c9682f13498ba8ef52e..be72b98d91a2ed4054c38c84abdaca150c4365ae 100644 (file)
@@ -1,23 +1,19 @@
+<tvh_include>inc/recording_contents</tvh_include>
+
+---
+
+## Overview
+
 This tab is used to configure operation of the Digital Video Recorder.
 It is not used for scheduling or administration of individual
 recordings.
 
-!['Digital Video Recorder Profiles' Tab 1](static/img/doc/dvrconfig/tab.png)
+!['Digital Video Recorder Profiles' Tab 1](static/img/doc/recordings/dvrprofiles.png)
 
 ---
 
-### Menu Bar/Buttons
-
-The following functions are available:
-
-Button              | Function
---------------------|---------
-**Save**            | Save any changes made to the selected profile.
-**Undo**            | Undo any changes made to the selected profile since the last save.
-**Add**             | Add a new profile.
-**Delete**          | Delete an existing profile.
-**Clone**           | Clone the currently selected profile.
+## Buttons
 
-<tvh_include>inc/common_button_table_end</tvh_include>
+<tvh_include>inc/buttons</tvh_include>
 
 ---
index d2cf09acffbdc0ae3b6c5da412ea575352015ad6..c8ea7e8c7dcf29f57e21360943613a46fed5c6c2 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 This tab is used to configure the Electronic Program Guide (EPG) 
 [grabbing](class/epggrab_mod) capabilities.
index 8e06e8dd424bee52d6bf625544dd95542f5b2fa1..e4ca12d12595ac9b5ce20b3e789bb61f0d66baab 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 This tab is used to configure the Electronic Program Guide (EPG) 
 grabber modules. Tvheadend supports a variety of different EPG 
index 68deed74fd44dab96531df37fce525b2281e031b..13c7e1f13c73a2aabfc97c0dfd4a96b5f3221056 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 This tab allows you to define rules that filter and order various 
 elementary streams. 
index 0109cf12ec0c95db5afe309ec34433a461926832..95d62b4f3ce4954ed597a90c4d3d1b0a850d2381 100644 (file)
@@ -2,7 +2,7 @@
 
 ---
 
-# Overview
+## Overview
 
 Stream Profiles are the settings for output formats. These are used for Live TV
 streaming and recordings. The profiles can be assigned through Access Entries,
index 6072f7921a4cfeccf9d0159a032219d0591c0de5..2cda0773e74f3ce2d9faf6bf2cdd16a729a5571d 100644 (file)
@@ -1,17 +1,17 @@
+<tvh_include>inc/recording_contents</tvh_include>
+
+---
+
+## Overview
+
 This tab is used to configure timeshift properties.
 
-!['Timeshift Tab'](static/img/doc/timeshift/tab.png)
+!['Timeshift Tab'](static/img/doc/recordings/timeshift.png)
 
 ---
 
-### Menu Bar/Buttons
-
-The following functions are available:
+## Buttons
 
-Button     | Function
------------|---------
-**Save**   | Save the current configuration.
-**Undo**   | Revert the changes made since last save.
-<tvh_include>inc/common_button_table_end</tvh_include>
+<tvh_include>inc/buttons</tvh_include>
 
 ---
diff --git a/docs/markdown/inc/caclient_contents.md b/docs/markdown/inc/caclient_contents.md
new file mode 100644 (file)
index 0000000..c2d7ebf
--- /dev/null
@@ -0,0 +1,7 @@
+Contents                                          | Description
+--------------------------------------------------|------------------------
+[Overview](#overview)                             | Tab overview
+[Client Types](#client-types)                     | Available CA client types
+[Connection Status](#connection-status)           | Connection status indicators
+[OSCam Modes](#oscam-modes)                       | OSCam Modes
+[Items/Properties](#items)                        | Items/Properties
diff --git a/docs/markdown/inc/recording_contents.md b/docs/markdown/inc/recording_contents.md
new file mode 100644 (file)
index 0000000..a9d5fb5
--- /dev/null
@@ -0,0 +1,6 @@
+Contents                                              | Description
+------------------------------------------------------|-------------
+[Overview](#overview)                                 | Overview of the tab
+[Digital Video Recorder Profiles](class/dvrconfig)    | DVR profiles and related settings
+[Timeshift](class/timeshift)                          | Timeshift settings
+[Items/Properties](#items)                            | Tab specific items and properties
index 8118e4f2c0f9cfef464f1804219b48271fc011aa..c36876a346da221df98bbabf408af98e73c1eb7c 100644 (file)
@@ -18,18 +18,8 @@ Web Interface Guide
   - [DVB Inputs](dvbinputs)
   - [Channel / EPG](class/channel)
   - [Stream](class/profile)
-  - Recording
-
-    * [Digital Video Recorder Profiles](class/dvrconfig)
-    * [Timeshift](class/timeshift)
-
-  - Conditional Access (CA)
-
-    * [CAPMT (Linux Network DVBAPI)](class/caclient_capmt)
-    * [Code word client (newcamd)](class/caclient_cwc)
-    * [DES constant code word client](class/caclient_ccw_des)
-    * [AES constant code word client](class/caclient_ccw_aes)
-
+  - [Recording (Profiles/Timeshift)](class/dvrconfig)
+  - [Conditional Access (CA)](class/caclient)
   - [Debugging](class/tvhlog_conf)
 
   - Status
index 42bc850c3fa7b9d96d63bef9bb9cfe33c4a75598..d745c5bbbcdcc74a91bc2cbaba1c0009423ab350 100644 (file)
@@ -2577,14 +2577,14 @@ caclient_capmt_class_cwmode_list ( void *o, const char *lang )
   return strtab2htsmsg(tab, 1, lang);
 }
 
-CLASS_DOC(caclient_capmt)
+CLASS_DOC(caclient)
 
 const idclass_t caclient_capmt_class =
 {
   .ic_super      = &caclient_class,
   .ic_class      = "caclient_capmt",
   .ic_caption    = N_("CAPMT (Linux Network DVBAPI)"),
-  .ic_doc        = tvh_doc_caclient_capmt_class,
+  .ic_doc        = tvh_doc_caclient_class,
   .ic_properties = (const property_t[]){
     {
       .type     = PT_INT,
@@ -2594,6 +2594,7 @@ const idclass_t caclient_capmt_class =
       .off      = offsetof(capmt_t, capmt_oscam),
       .list     = caclient_capmt_class_oscam_mode_list,
       .def.i    = CAPMT_OSCAM_NET_PROTO,
+      .opts     = PO_DOC_NLIST,
     },
     {
       .type     = PT_STR,
@@ -2619,6 +2620,7 @@ const idclass_t caclient_capmt_class =
       .off      = offsetof(capmt_t, capmt_cwmode),
       .list     = caclient_capmt_class_cwmode_list,
       .def.i    = CAPMT_CWMODE_AUTO,
+      .opts     = PO_DOC_NLIST,
     },
     { }
   }
index 9d9a69830240834d7022598c0a1e442c3658ea90..21784bebc0eb4c0a88df5295033a925350d05262 100644 (file)
@@ -1971,6 +1971,7 @@ const idclass_t caclient_cccam_class =
       .off      = offsetof(cccam_t, cccam_version),
       .list     = caclient_cccam_class_cccam_version_list,
       .def.i    = CCCAM_VERSION_2_3_0,
+      .opts     = PO_DOC_NLIST,
     },
 #if 0
     {
@@ -2019,4 +2020,3 @@ caclient_t *cccam_create(void)
   cccam->cccam_version = CCCAM_VERSION_2_3_0;
   return (caclient_t *)cccam;
 }
-
index bd0831838cf237c368b27dd8a310fbadf4471001..77e3437c2ab60de474351da1e98369144f9ae762 100644 (file)
@@ -847,6 +847,7 @@ const idclass_t caclient_dvbcam_class =
       .desc     = N_("Selection method for CAID"),
       .list     = caclient_dvbcam_class_caid_selection_list,
       .off      = offsetof(dvbcam_t, caid_select),
+      .opts     = PO_DOC_NLIST,
     },
     {
       .type     = PT_STR,
diff --git a/src/webui/static/img/doc/caclient/cas.png b/src/webui/static/img/doc/caclient/cas.png
new file mode 100644 (file)
index 0000000..694bf84
Binary files /dev/null and b/src/webui/static/img/doc/caclient/cas.png differ
diff --git a/src/webui/static/img/doc/caclient/tab.png b/src/webui/static/img/doc/caclient/tab.png
deleted file mode 100644 (file)
index d7b7c08..0000000
Binary files a/src/webui/static/img/doc/caclient/tab.png and /dev/null differ
diff --git a/src/webui/static/img/doc/caclient_capmt/tab.png b/src/webui/static/img/doc/caclient_capmt/tab.png
deleted file mode 100644 (file)
index b7ce0c2..0000000
Binary files a/src/webui/static/img/doc/caclient_capmt/tab.png and /dev/null differ
diff --git a/src/webui/static/img/doc/recordings/dvrprofiles.png b/src/webui/static/img/doc/recordings/dvrprofiles.png
new file mode 100644 (file)
index 0000000..65c8806
Binary files /dev/null and b/src/webui/static/img/doc/recordings/dvrprofiles.png differ