From 0a9c918ccd657493a7c972c98036a486a70c5e73 Mon Sep 17 00:00:00 2001 From: Jaroslav Kysela Date: Tue, 19 Apr 2016 10:26:18 +0200 Subject: [PATCH] remove the old html help pages and support code, use only mdhelp --- docs/html/en/about.html | 8 - docs/html/en/config_access.html | 81 ------- docs/html/en/config_bouquet.html | 57 ----- docs/html/en/config_caclient.html | 127 ----------- docs/html/en/config_channels.html | 88 -------- docs/html/en/config_debugging.html | 37 ---- docs/html/en/config_dvr.html | 292 ------------------------- docs/html/en/config_epggrab.html | 107 --------- docs/html/en/config_esfilter.html | 96 -------- docs/html/en/config_general.html | 93 -------- docs/html/en/config_misc.html | 92 -------- docs/html/en/config_muxes.html | 134 ------------ docs/html/en/config_muxsched.html | 54 ----- docs/html/en/config_networks.html | 83 ------- docs/html/en/config_passwords.html | 53 ----- docs/html/en/config_services.html | 83 ------- docs/html/en/config_streamprofile.html | 102 --------- docs/html/en/config_tags.html | 52 ----- docs/html/en/config_timeshift.html | 54 ----- docs/html/en/config_tvadapters.html | 80 ------- docs/html/en/config_tvhlog.html | 38 ---- docs/html/en/dvr_autorec.html | 66 ------ docs/html/en/dvr_failed.html | 71 ------ docs/html/en/dvr_finished.html | 71 ------ docs/html/en/dvr_timerec.html | 86 -------- docs/html/en/dvr_upcoming.html | 90 -------- docs/html/en/epg.html | 234 -------------------- docs/html/en/status_connections.html | 31 --- docs/html/en/status_servicemapper.html | 31 --- docs/html/en/status_stream.html | 31 --- docs/html/en/status_subscriptions.html | 31 --- src/webui/static/app/acleditor.js | 15 +- src/webui/static/app/caclient.js | 5 +- src/webui/static/app/chconf.js | 3 - src/webui/static/app/config.js | 13 +- src/webui/static/app/cteditor.js | 6 - src/webui/static/app/dvr.js | 26 +-- src/webui/static/app/epggrab.js | 13 +- src/webui/static/app/esfilter.js | 35 +-- src/webui/static/app/idnode.js | 75 ++++--- src/webui/static/app/mpegts.js | 12 - src/webui/static/app/servicemapper.js | 6 - src/webui/static/app/timeshift.js | 5 +- src/webui/static/app/tvadapters.js | 5 +- src/webui/static/app/tvheadend.js | 26 --- src/webui/static/app/tvhlog.js | 10 +- src/webui/static/app/wizard.js | 2 +- src/webui/webui.c | 13 -- 48 files changed, 70 insertions(+), 2753 deletions(-) delete mode 100644 docs/html/en/about.html delete mode 100644 docs/html/en/config_access.html delete mode 100644 docs/html/en/config_bouquet.html delete mode 100644 docs/html/en/config_caclient.html delete mode 100644 docs/html/en/config_channels.html delete mode 100644 docs/html/en/config_debugging.html delete mode 100644 docs/html/en/config_dvr.html delete mode 100644 docs/html/en/config_epggrab.html delete mode 100644 docs/html/en/config_esfilter.html delete mode 100644 docs/html/en/config_general.html delete mode 100644 docs/html/en/config_misc.html delete mode 100644 docs/html/en/config_muxes.html delete mode 100644 docs/html/en/config_muxsched.html delete mode 100644 docs/html/en/config_networks.html delete mode 100644 docs/html/en/config_passwords.html delete mode 100644 docs/html/en/config_services.html delete mode 100644 docs/html/en/config_streamprofile.html delete mode 100644 docs/html/en/config_tags.html delete mode 100644 docs/html/en/config_timeshift.html delete mode 100644 docs/html/en/config_tvadapters.html delete mode 100644 docs/html/en/config_tvhlog.html delete mode 100644 docs/html/en/dvr_autorec.html delete mode 100644 docs/html/en/dvr_failed.html delete mode 100644 docs/html/en/dvr_finished.html delete mode 100644 docs/html/en/dvr_timerec.html delete mode 100644 docs/html/en/dvr_upcoming.html delete mode 100644 docs/html/en/epg.html delete mode 100644 docs/html/en/status_connections.html delete mode 100644 docs/html/en/status_servicemapper.html delete mode 100644 docs/html/en/status_stream.html delete mode 100644 docs/html/en/status_subscriptions.html diff --git a/docs/html/en/about.html b/docs/html/en/about.html deleted file mode 100644 index a97ce28d9..000000000 --- a/docs/html/en/about.html +++ /dev/null @@ -1,8 +0,0 @@ - -
-

About

-

This tab gives you basic information about Tvheadend's copyright, the authors, licensing, etc.

-

You can also check the build options for your binary by clicking Toggle details .

-

Oh, and you can make a donation as well, of course :)

-

For more information about Tvheadend, please visit our home page, read the full online documentation or just cut straight to the FAQs.

-
diff --git a/docs/html/en/config_access.html b/docs/html/en/config_access.html deleted file mode 100644 index 80ecc1247..000000000 --- a/docs/html/en/config_access.html +++ /dev/null @@ -1,81 +0,0 @@ - -
-

Configuration - Access Entries

-

Setting up access control is an important initial step as the system -is initially wide open .

-

Tvheadend verifies access by scanning through all enabled access control entries in sequence, from the top of the list to the bottom. The permission flags, streaming profiles, DVR config profiles, channel tags and so on are combined for all matching access entries. An access entry is said to match if the username / password matches and the IP source address of the requesting peer is within the prefix.

-

'Access Entries' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the access rules.
UndoUndo any changes made to the access rules since the last save.
AddAdd a new access rule.
DeleteDelete the selected access rule.
Move upMove the selected rule up one level (rules are executed top to bottom).
Move downMove the selected rule down one level (rules are executed top to bottom).
EditEdit the selected access rule.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Enabled : Enable this access control rule. Uncheck the box to disable.

-

Username : Login name to be used. If no username is required, this entry should contain a single asterisk (*).

-

Network prefix : IPv4 prefix for matching based on source IP address. If set to 0.0.0.0/0 it will match everything. The multiple networks can be delimited using comma or semicolon.

-

Web interface : Required for web user interface access. Also gives access to the EPG.

-

Admin : Enables access to the Configuration tab.

-

Streaming : Enables access to streaming functionality for HTTP (web).

-

Advanced Streaming : Enables access to advanced streaming function for HTTP (web) - like direct service or whole MPEG-TS stream (mux)..

-

HTSP Streaming : Enables access to streaming for the HTSP protocol (Movian, Kodi etc.).

-

Streaming Profile : Specify a streaming profile to be used when this user logs in; use the (default) stream if not specified.

-

Connection Limit Type : Allow to restrict the limit for connections to streaming or DVR only.

-

Limit Connections : If set, this will limit the number of concurrent streaming connections and DVR sessions a user is permitted to have. 0=disabled

-

Video Recorder : Enables access to all video recording functions. This also include administration of the auto recordings.

-

HTSP DVR : Enables access to video recording functions for the HTSP protocol (Movian, Kodi etc.).

-

All DVR : Enable to access to DVR entries created by other users (read-only).

-

All DVR (rw) : Enable to access to DVR entries created by other users with the ability to remove the DVR entries.

-

DVR Config Profile : If set, the user will only be able to use the DVR config profile equal to this value. Note that this field is unset when the DVR Config Profile is removed.

-

Min Channel Num : If non-zero, this sets the lower limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or greater than this value.

-

Max Channel Num : If non-zero, this sets the upper limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or less than this value.

-

Channel Tag : If set, the user will only be able to access channels containing this channel tag. Note that this field is unset when the channel tag is removed.

-

Comment : Allows the administrator to set a comment only visible in this editor. It does not serve any active purpose.

-
-

Let’s also take a look at an example:

-

Access Entries Example

-

The first line gives clients originating from 192.168.0.0 - 192.168.0.255 network access to streaming functions. Typically, you would use this for your local media players at home (Although Movian can prompt for username and password in its HTSP client)

-

The second line adds a user with world wide access who might want to modify recordings, etc., perhaps from their workplace or via a mobile 'phone.

-

The third line provide admin access to an admin user. As an extra precaution this user is only allowed to log in from the home network.

-
diff --git a/docs/html/en/config_bouquet.html b/docs/html/en/config_bouquet.html deleted file mode 100644 index 5f6ad01cd..000000000 --- a/docs/html/en/config_bouquet.html +++ /dev/null @@ -1,57 +0,0 @@ - -
-

Configuration - Channel/EPG - Bouquets

-

Bouquets are broadcaster-defined groupings and orders of channels.

-

NOTE: SCREENSHOT HERE

-

To use bouquets, ensure to add and scan all available muxes using the predefined muxes or manual configuration.

-

The bouquets are obtained automatically from the DVB source during the mux scan period. Note that bouquets may use more muxes and only services from scanned muxes are added. The mux with bouquets might require another scan when all muxes are discovered (manually using the rescan checkbox).

-

The fastscan bouquets are pre-defined in the configuration tree. These bouquets must be manually enabled to let Tvheadend to subscribe and listen to the specific MPEG-TS PIDs.

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the bouquet configuration.
UndoUndo any changes made to the bouquetconfiguration since the last save.
DeleteDelete an existing bouquet.
EditEdit an existing bouquet. This allows you to change any of the parameters you’d otherwise set when adding a new channel, e.g. enabled, map radio, etc.
HelpDisplays this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Enabled : Text...

-

Rescan : Text...

-

Name : Text...

-

Auto-Map to Channels : Text...

-

Map Zero Numbers : Text...

-

Channel Number Offset : Text...

-

Map No Name : Text...

-

Map Radio : Text...

-

Create Tag : Text...

-

Source : Text...

-

# Services : Text...

-

# Seen Services : Text...

-

Comment : Text...

-
diff --git a/docs/html/en/config_caclient.html b/docs/html/en/config_caclient.html deleted file mode 100644 index aa2538aea..000000000 --- a/docs/html/en/config_caclient.html +++ /dev/null @@ -1,127 +0,0 @@ - -
-

Configuration - CAs

-

Tvheadend support connecting to card clients via the cwc (newcamd) and capmt (dvbapi) protocols for so-called 'softcam' descrambling.

-

'CAs' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the CA client configuration
UndoUndo any changes made to the CA client configuration since the last save.
AddAdd a new CA client configuration.
DeleteDelete an existing CA client configuration.
Move UpMove the selected CA client configuration up in the list.
Move DownMove the selected CA client configuration down in the list.
Show PasswordsReveals any stored CA client passwords.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Enabled : If selected, connection will be tried to be established and retained up. If unselected, Tvheadend will disconnect (if connected) and not try to reconnect.

-

Hostname : Server hostname. DNS lookup is performed upon every connection attempt.

-

Port : Server TCP port

-

Username : Username to use.

-

Password : Password to use.

-

DES Key : Initial DES key.

-

Update Card : Forward Entitlement Management Messages (EMMs) to the server.

-

Update One : Forward EMMs only from one channel at a time.

-

Comment : Allows the administrator to set a comment only visible in this editor. It does not serve any active purpose.

-

'CAs Tab 2'

-
-

The columns have the following functions:

-

Enabled : If selected, connection will be tried to be established and retained up. If unselected, Tvheadend will disconnect (if connected) and not try to reconnect.

-

Camd.socket Filename / IP Address : Socket filename which is usually opened by cam client. Tvheadend tries to connect to this socket file.

-

In mode 3 (TCP), enter the IP address of the oscam server. Tvheadend tries to create a TCP connecting to this IP adress and Connect port .

-

Listen / Connect port : If running on a so called full-featured DVB-Card this can be left empty. Running on Budget-Cards one has to use a dummy ca-device. This is emulated via capmt_ca.so. This module has to be pre-loaded prior to the cam client.

-

LD_PRELOAD=/path/to/capmt_ca.so cam_client &

-

This module will communicate the received control-words back to Tvheadend via Port 9000

-

In mode 3 (TCP), this port is used for the oscam connection. It must be equal to the listen port in the oscam/dvbapi settings.

-

OSCam mode

- - -
-

Usage Note for Mode 1

-

The following lines are required in [dvbapi] section of oscam.conf -file:

-boxtype = pc - pmt_mode = 4 -
- - - -
-

Usage Note for Mode 3

-

The following lines are required in [dvbapi] section of oscam.conf -file:

-boxtype = pc - pmt_mode = 4 - listen_port = 9000 # or your preferred port -
- - -
-

Usage Note for Mode 5

-

The following lines are required in [dvbapi] section of oscam.conf -file:

-boxtype = pc - pmt_mode = 4 - listen_port = 9000 # or your preferred port -
- -

Comment Allows the administrator to set a comment only visible in this editor. It does not serve any active purpose.

-
diff --git a/docs/html/en/config_channels.html b/docs/html/en/config_channels.html deleted file mode 100644 index d70c79505..000000000 --- a/docs/html/en/config_channels.html +++ /dev/null @@ -1,88 +0,0 @@ - -
-

Configuration - Channel/EPG - Channels

-

Display and edit channel configuration here.

-

'Channels' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the channel configuration.
UndoUndo any changes made to the channel configuration since the last save.
AddAdd a new channel.
DeleteDelete an existing channel.
EditEdit an existing channel. This allows you to change any of the parameters you’d otherwise set when adding a new channel, e.g. name, number, EPG source, tags, etc.
Map ServicesMap all services to channels. You will be prompted to include/exclude e.g. encrypted channels.
Assign numberAssign the lowest free channel number to the selected channel.
Number UpIncrease by one the channel number for the selected channel.
Number DownDecrease by one the channel number for the selected channel.
Swap NumberSwap the numbers over for the two selected channels.
Reset IconReset the icon URL for the selected channel.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Play : Play the relevant channel using HTTP streaming.

-

Enabled : Whether or not the mux is enabled and thus available.

-

Name : Name of the channel as presented in EPG and external interfaces. Changing name of a channel does not interfere with scheduled recordings, etc.

-

Number : Channel number. This is not used by Tvheadend internally, but rather intended to be used by HTSP clients for mapping to remote control buttons, presentation order, etc

-

User Icon : A URL pointing to an image representing the channel. The icon URL will be set automatically when importing data from XMLTV, when picon path is set or when channel icon path is set in the general config. This field allows the user to edit it manually. The reset icon action allows to re-set the automatic URL for selected channel (e.g. after configuration change).

-

Icon URL : text

-

Auto EPG Channel : Auto-link EPG channels from XMLTV and OpenTV EPG grabbers using the channel name for matching. If you turn this option off, only OTA EPG grabber will be used for this channel unless the EPG Grab Source option (below) is not set manually.

-

EPG Grab Source : Name of the Internet-based EPG provider (typically XMLTV) channel that should be used to update this channels EPG info. By default Tvheadend tries to match the name itself, but sometimes it might not match correctly in which case you can do the mapping manually. When using XMLTV, a newly-mapped channel will not appear in the EPG until the next run of the grabber, or service restart.

-
-

Over-the-Air Sources

-

Over the air (OTA) sources do NOT need to be mapped in this way, the -linking is implicitly tied since they are all part of the DVB system.

-
- -

DVR Pre : Allows the user to specify an amount of extra time that should be prepended to a recording scheduled on this channel. In other words, if you type 5 here for a recording that is scheduled for 20:00 will start to record at 19:55. This setting overrides the Extra time before recordings DVR setting.

-

DVR Post : Similar to DVR Pre-Start this allows the user to add an extra amount of time that should be appended to a recording. In other words, if you type 5 here for a recording that is scheduled to end 20:30 will stop to record at 20:35. This setting overrides the Extra time after recordings DVR setting.

-

Services : text

-

Tags : Each channel can be bound to a zero, one or many tags. The tags are used for multiple things and it’s up to you how you wish to use and name them. Tags can be used to aid searching in the EPG if you have many channels. The tags are also presented in a Media player.

-

Bouquet : text

-
diff --git a/docs/html/en/config_debugging.html b/docs/html/en/config_debugging.html deleted file mode 100644 index 645dd5a69..000000000 --- a/docs/html/en/config_debugging.html +++ /dev/null @@ -1,37 +0,0 @@ - -
-

Configuration - Debugging

-

This tab is used to configure various debugging options in tvheadend.

-

'Debugging' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - -
ButtonFunction
Apply Configuration (run-time only)Saves any changes made to the debugging configuration. Changes will be lost on a restart.
HelpDisplay this help page
-
-
Configuration Options
-

Debug log path : Text...

-

Debug to syslog : Text...

-

Debug trace (low-level stuff) : Text...

-

Debug subsystems : Text...

-

Trace subsystems : Text...

-

Changes to any of these settings must be confirmed by pressing the ‘Save configuration’ button before taking effect.

-

Note that 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 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.

-

Note: It'd be helpful to expand as to what happens on what distro...

-
diff --git a/docs/html/en/config_dvr.html b/docs/html/en/config_dvr.html deleted file mode 100644 index 25368d853..000000000 --- a/docs/html/en/config_dvr.html +++ /dev/null @@ -1,292 +0,0 @@ - -
-

Configuration - Recording - Digital Video Recorder Profiles

-

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

-

'Digital Video Recorder Profiles' Tab 2

-

'Digital Video Recorder Profiles' Tab 3

-

NOTE: Merge into one image

-

NOTE: Have overview screenshot showing profiles, then focus on config

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the DVR configuration
UndoUndo any changes made to the DVR configuration since the last save.
AddAdd a new DVR configuration.
DeleteDelete an existing DVR configuration.
HelpDisplay this help page.
-
-
Configuration Options
-
DVR Behaviour
-

Media container : Select the container format used to store recordings.

-

Cache scheme : Select the cache scheme used to store recordings. Leave as “system” unless you have a special case for one of the others.

-

Whenever you read or write data to the filesystems, the information is kept (cached) in memory for a while. This means that regularly-access 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) as changes are buffered to be written in one go.

-
    -
  • Unknown : A placeholder status, meaning that the configuration isn’t properly set.
    • -
-
    -
  • System : Change nothing and rely on standard (default) system caching to behave as it normally would.
    • -
-
    -
  • Do not keep : Tell the system that you’re not expecting to re-use the data soon, so don’t keep it in cache. The data will still be buffered for writing. Useful e.g. in a RAM-limited system like a Pi (given that you’re unlikely to be watching while recording, so data can be discarded now and read back from disc later).
    • -
-
    -
  • Sync : Tell the system to write the data immediately. This doesn’t affect whether or not it’s cached. Useful e.g. if you’ve a particular problem with data loss due to delayed write (such as if you get frequent transient power problems).
    • -
-
    -
  • Sync + Do not keep : A combination of last two variants above - data is written immediately and then discarded from cache.
    • -
-
-

DVR Log retention time (days) : Time that Tvheadend will keep information about the recording in its internal database. Notice that the actual recorded file will not be deleted when the log entry is deleted.

-

Extra time before recordings (minutes) : Specify the number of minutes to record before the events scheduled start time. Used to cope with small scheduling errors.

-

Extra time after recordings (minutes) : Specify the number of minutes to record after the events scheduled stop time. Used to cope with small scheduling errors.

-

Episode duplicate detection : If checked, broadcasts with matching title and matching non-zero episode number are considered duplicates.

-

EPG update window : Maximum difference between event start times when the EPG event is changed. TVHeadend uses a fuzzy match logic (using title, start times, duration, episode) to check when the event was changed.

-

Post-processor command : Command to run after finishing a recording. The command will be run in background and is executed even if a recording is aborted or an error occurred. Use the %e error formatting string to check for errors, the error string is “OK” if recording finished successfully.

-

Supported format strings:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FormatDescriptionExample value
%fFull path to recording/home/user/Videos/News.mkv
%bBasename of recordingNews.mkv
%cChannel nameBBC world
%OOwner of this recordinguser
%CWho created this recordinguser
%tProgram titleNews
%sProgram subtitleAfternoon
%pProgram episodeS02.E07
%dProgram descriptionNews and stories…
%eError messageAborted by user
%SStart time stamp of recording, UNIX epoch1224421200
%EStop time stamp of recording, UNIX epoch1224426600
-
-

Example usage

-

To use special characters (e.g. spaces), either put the string in quotes or escape the individual characters.

-

/path/to/ffmpeg -i "%f" -vcodec libx264 -acodec copy "/path/with white space/%b"

-
- -
-
Recording File Options
-

Recording system path : Path to where Tvheadend will write recorded events. If components of the path does not exist, Tvheadend will try to create them.

-

File permissions : The permissions to be set on the resultant recording files.

-

This is useful if you need to manipulate the files after recording under a different user ID, e.g. to chop out commercials.

-

Common examples:

- - - - - - - - - - - - - - - - - - - - -
ModePermissions
0644rw-r–r–
0664rw-rw-r– (default)
0666rw-rw-rw-
-

Note that the applicable umask applies, so 0666 with umask 0022 will produce 0644 (rw-r–r–). See also Directory permissions in Subdirectory Options .

-
-

Filename charset : Character set for the created filename. Tvheadend will try to approximate characters to similarly looking ones.

-

Tag files with metadata : If checked, media containers that support metadata will be tagged with the metadata associated with the event being recorded.

-

Skip commercials : If checked, commercials will be dropped from the recordings. At the moment, commercial detection only works for the swedish channel TV4.

-
-
Full Pathname Specification
-

Format String : The string allow 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.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FormatDescriptionExample
$t$n.$xDefault format (title, unique number, extension)Tennis - Wimbledon-1.mkv
$sEvent subtitle nameSport
$tEvent title nameTennis - Wimbledon
$eEvent episode nameS02-E06
$cChannel nameSkySport
$nUnique number added when the file already exists-1
$xFilename extension (from the active stream muxermkv
%FISO 8601 date format2011-03-19
%RThe time in 24-hour notation14:12
-

The format strings $t,$s,%e,$c also have delimiter variants such as $ t (space after the dollar character), $-t, $_t, $.t, $,t, $;t. In these cases, the delimiter is applied only when the substituted string is not empty.

-
-
Subdirectory Options
-

Directory permissions : The permissions to be set on any sub-directories created for recordings.

-

This is useful if you need to manipulate the files after recording under a different user ID, e.g. to chop out commercials.

-

Common examples:

- - - - - - - - - - - - - - - - - - - - -
ModePermissions
0755rwxr-xr-x
0775rwxrwxr-x (default)
0777rwxrwxrwx
-

Note that the applicable umask applies, so 0777 with umask 0022 will produce 0755 (rwxr-xr-x). See also File permissions in Recording File Options .

-
-

Make sub-directories per day : If checked, create a new directory per day in the recording system path. Only days when anything is recorded will be created. The format of the directory will be ISO standard YYYY-MM-DD .

-

Make sub-directories per channel : If checked, create a directory per channel when storing events. If both this and the ‘directory per day’ checkbox is enabled, the date-directory will be parent to the per-channel directory.

-

Make sub-directories per title : If checked, create a directory per title when storing events. If the day/channel directory checkboxes are also enabled, those directories will be parents of this directory.

-
-
Filename Options
-

Include channel name in title : If checked, include the name of the channel in the event title. This applies to both the titled stored in the file and to the file name itself.

-

Include date in title : If checked, include the date for the recording in the event title. This applies to both the titled stored in the file and to the file name itself.

-

Include time in title : If checked, include the time for the recording in the event title. This applies to both the titled stored in the file and to the file name itself.

-

Include episode in title : If checked, include the season and episode in the title (if such info is available).

-

Include subtitle in title : If checked, include the episode subtitle in the title (if such info is available).

-

Put episode in filename before date and time : If checked, insert the episode number before the data and time rather than after (assumes Include date , Include time and Include episode options are set).

-

Remove all unsafe characters from filename : If checked, all characters that could possibly cause problems for filenaming will be replaced with underscore (_).

-

Applies to characters:

-
    -
  • not supported by Windows: / : \ < > | * ? "
    • -
  • control characters (ASCII code below 32)
    • -
  • control and national characters (ASCII code above 122) Replace whitespace in title with ‘-’ : If checked, whitespace characters (spaces and tabs) will be replaced with ‘-’.
    • -
-
-

Use Windows-compatible filenames : If checked, characters not supported in Windows filenames (e.g. for an SMB/CIFS share) will be stripped out or converted.

-

Makes the following changes:

-
    -
  • characters not supported by Windows (/ : \ < > | * ? ") will be replaced with underscore (_)
    • -
  • trailing spaces and dots will be removed Changes to any of these settings must be confirmed by pressing the ‘Save configuration’ button before taking effect.
    • -
-
-
diff --git a/docs/html/en/config_epggrab.html b/docs/html/en/config_epggrab.html deleted file mode 100644 index 66e49f444..000000000 --- a/docs/html/en/config_epggrab.html +++ /dev/null @@ -1,107 +0,0 @@ - -
-

Configuration - Channel/EPG - EPG Grabber

-

This tab is used to configure the Electronic Program Guide (EPG) grabbing capabilities. Tvheadend supports a variety of different EPG grabbing mechanisms. These fall into 3 broad categories, within which there are a variety of specific grabber implementations.

-

NOTE: SCREENSHOT HERE

-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - -
ButtonFunction
Save ConfigurationSave any changes made to the grabber configuration.
Trigger OTA EPG GrabberForce an immediate tune to the OTA EPG mux to request EPG updates.
HelpDisplays this help page.
-
-
Grabber Types
- - - -
Grabber Modules
- - - - - -
Cron multi-line config text areas
-

The cron lines looks like:

-
           # * * * * *  command to execute
-           # ┬ ┬ ┬ ┬ ┬
-           # │ │ │ │ │
-           # │ │ │ │ │
-           # │ │ │ │ └───── day of week (0 - 6 or Sunday - Saturday)
-           # │ │ │ └────────── month (1 - 12)
-           # │ │ └─────────────── day of month (1 - 31)
-           # │ └──────────────────── hour (0 - 23)
-           # └───────────────────────── min (0 - 59)
-
-

With the following cron special characters...

- - - - - -
-
Configuration Options
-
General Config
-

Update channel name : Automatically update channel names using information provided by the enabled EPG providers.

-

Update channel number : Automatically update channel numbers using information provided by the enabled EPG providers.

-

Update channel icon : Automatically update channel icons using information provided by the enabled EPG providers.

-

Periodic save EPG to disk Interval : Writes the current in-memory EPG database to disk every x Hours (user defined), so should a crash/unexpected shutdown occur EPG data is saved periodically to the database (Re-read on next startup). Set to 0 to disable.

-
Internal Grabber
-

Module : Select which internal grabber to use.

-

Cron multi-line : Multiple lines of the cron time specification.

-
Over-the-air Grabbers
-

Force initial EPG scan at startup : … no comment

-

Cron multi-line : Multiple lines of the cron time specification.

-

EPG scan timeout in seconds : The multiplex (mux) is tuned for this amount of time at maximum. If EPG data are completed before this limit, the mux is released sooner.

-

Checkbox list : Checkbox list to enable/disable available modules. By default all grabbers should be enabled.

-
External interfaces
-

Checkbox list to enable/disable available modules. The path field contains the absolute path of the unix domain socket into which EPG data can be sent.

-

To send data to the socket use the command netcat -u SOCKET_PATH.

-

Note: for some systems the netcat flags can vary so please consult the man page.

-
Notes
-

To apply any changes please use the [Save configuration button]

-

XMLTV/PyEPG - if you are using the internal versions of these modules then you must first configure them externally as Tvheadend provides no support for this. Nor does it provide the ability to pass command line options (for this use the external interface).

-
diff --git a/docs/html/en/config_esfilter.html b/docs/html/en/config_esfilter.html deleted file mode 100644 index 4358847e7..000000000 --- a/docs/html/en/config_esfilter.html +++ /dev/null @@ -1,96 +0,0 @@ - -
-

Configuration - Stream - Elementary Stream Filters

-
-

Elementary Stream Filters

-

This section applies to the filters for Video, -Audio, Teletext, Subtitle, -CA and Other.

-
- -

This table defines rules to filter and order the elementary streams (PIDs) like video or audio from the input feed. The execution order of commands is granted. It means that first rule is executed for all available streams then second and so on.

-

NOTE: SCREENSHOT HERE

-

If any elementary stream is not marked as ignored or exclusive, it is used. If you like to ignore unknown elementary streams, add a rule to the end of grid with the any (not defined) comparisons and with the action ignore.

-

The rules for different elementary stream groups (video, audio, teletext, subtitle, CA, other) are executed separately (as visually edited).

-

For the visual verification of the filtering, there is a service info dialog in the Configuration / DVB Inputs / Services window . This dialog shows the received PIDs and filtered PIDs in one window.

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the filters.
UndoUndo any changes made to the filters since the last save.
AddAdd a new filter.
DeleteDelete an existing filter.
Move UpMove the filter up in the list.
Move DownMove the filter down in the list.
EditEdit an existing filter. This allows you to change any of the parameters you’d otherwise set when adding a new channel, e.g. language, PID, action, etc.
HelpDisplays this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Class : : Text...

-

Index : Text...

-

Enabled : If selected, the rule will be enabled.

-

Stream Type : Select the elementary stream type to compare. Empty field means any.

-

Language : Select the language to compare. Empty field means any. Not applicable to CA filters .

-

Service : The service to compare. Empty field means any.

-

CA Identification : The CAID to compare. Empty field means any. Applicable only to CA filters .

-

CA Provider : The CA provider to compare. Empty field means any. Applicable only to CA filters .

-

Stream Index : The logical stream index to compare. Note that this index is computed using all filters.

-

Example: If filter is set to AC3 audio type and the language to ‘eng’ and there are two AC3 ‘eng’ streams in the service, the first stream could be identified using number 1 and the second using number 2.

-
-

PID : Program identification (PID) number to compare. Zero means any. This comparison is processed only when service comparison is active and for the Conditional Access filter.

-

Action : The rule action defines the operation when all comparisons succeeds.

- - - - - - -

Log : Write a short message to log identifying the matched parameters. It is useful for debugging your setup or structure of incoming streams.

-

Comment : Free-format text comment. Not used otherwise.

-
diff --git a/docs/html/en/config_general.html b/docs/html/en/config_general.html deleted file mode 100644 index e2a6f1412..000000000 --- a/docs/html/en/config_general.html +++ /dev/null @@ -1,93 +0,0 @@ - -
-

Configuration - General

-

This tabs allow configuration of several general parameters that affect the core Tvheadend functionality.

-

NOTE: THE TWO IMAGES BELOW SHOULD BE REPLACED WITH A SINGLE ONE

-

'General' Tab Screenshot 1

-

'General' Tab Screenshot 2

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
Save configurationSave any changes to the current configuration.
Clean image (icon) cacheClears the local channel icon cache, forcing images to be re-generated from sources (channel icons or picons).
Discover SAT>IP serversForces a scan for any SAT>IP servers on the local network.
HelpDisplays this help page
-
-
Server
-

Tvheadend server name : Set the name of the server so you can distinguish multiple instances apart on your LAN.

-
Language Settings
-

Default Language(s) : Select the list of languages (in order of priority) to be used for supplying EPG information to clients that don’t provide their own configuration.

-

The EPG information is NOT translated, this only applies to EPG providers that give information (titles, descriptions, etc..) in multiple languages.

-
-
DVB Scan Files Path
-

DVB scan files path : Select the path to use for DVB scan configuration files. Typically dvb- apps stores these in /usr/share/dvb/. Leave blank to use Tvheadend's internal file set.

-
-
Time Update
-

Tvheadend has a built-in capability to update the system time. However, you should bear in mind that DVB time is not highly accurate and is prone to both jitter and variation between different transponders.

-

Where possible, it’s probably still better to use an internet based NTP source to synchronise the system clock (i.e. through the underlying operating system).

-

Update time : Enable system time updates. This will only work if the user running Tvheadend has rights to update the system clock (normally only root).

-

Enable NTP driver : This will create an NTP driver (using shmem interface) that you can feed into ntpd. This can be run without root privileges, but generally the performance is not that great.

-

Update tolerance (milliseconds) : Only update the system clock (doesn’t affect NTP driver) if the delta between the system clock and DVB time is greater than this. This can help stop excessive oscillations on the system clock.

-
-
Picons
-

Picons (from p ersonal icons ) are collections of similar icons that can be automatically matched against your channels based on a number of technical parameters that will uniquely define a channel. The use of these parameters (e.g. mux, frequency, orbital position) removes the ambiguity of using names - it’s not case sensitive, it doesn’t care if there are spaces or not, and so on. You can generate picons yourself from existing images, or you can usually find sets pre-made on the Internet if you search for them. They’re a good way to get large numbers of icons matched quickly, and usually in a similar style (such as square, x * y pixels, with a consistent highlight/reflection effect).

-

Prefer picons over channel name : If both a picon and a channel-specific (e.g. channelname.jpg) icon are defined, use the picon.

-

Channel icon path : Path to an icon for this channel. This can be named however you wish, as either a local (file://) or remote (http://) image. The following placeholders are available:

- - - - - - - - - - - - - - - - -
PlaceholderFunction
%CThe transliterated channel name in ASCII (safe characters, no spaces etc.)
%cThe channel name (URL encoded ASCII)
-

Example: file:///tmp/icons/%C.png or http://example.com/%c.png

-

Picon path : Path to a directory (folder) containing your picon collection. This can be named however you wish, as either a local (file://) or remote (http://) location - however, remember that it’s pointing to a directory as the picon names are automatically generated from the service parameters frequency, orbital position, etc.).

-

Example: file:///home/hts/picons

-
-
SAT>IP Server
-

SAT>IP Server is something like DVB network tuner. Tvheadend can forward mpegts input streams including on-the-fly descramling to SAT>IP clients.

-

Only networks with the “SAT>IP Source” field set are exported through the SAT>IP protocol. This field is matched through the “src” parameter asked from 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 for unknown mux).

-

RTSP Port : Select RTSP port (TCP) for realtime commands from SAT>IP clients. Usually (as defined in the specification) this port is 554. But as extension, Tvheadend can use any TCP port value (which is default 9983 for non-root users). But the SAT>IP client must allow to set this value (Tvheadend client will obtain the RTSP port number automatically using the XML description). If the RTSP port value is zero, the SAT>IP server functionality is not enabled.

-

Subscription Weight : Subscription weight value. Default value is 100 (standard streaming). Note that the default value for DVR is 300 (normal priority).

-

Descramble Services : The maximum limit of services descrambled per a mux. If zero, the descrambling functionality is disabled.

-

Muxes Handling : When SAT>IP client requests new mux configuration, Tvheadend can handle it in three ways. The auto (0) configuration means that if the mux does not exists, a temporary mux is created and removed when the client closes the connection. The keep (1) configuration will remember all successfuly scanned muxes. The reject (2) configuration will reject unknown muxes.

-

Exported .... Tuners : Each option lists the tuners, by type, you wish to present over IP to other clients.

-
-
Image Caching
-

This will cache any channel icons or other images (such as EPG metadata) to be served from the local webserver. This can be useful for multi-client systems and, generally, to reduce hits on upstream providers.

-

Enabled : Select whether or not to enable caching. Note: even with this disabled you can still specify local (file://) icons and these will be served by the built-in webserver.

-

Re-fetch period (hours) : How frequently the upstream provider is checked for changes.

-

Re-try period (hours) : How frequently it will re-try fetching an image that has failed to be fetched.

-

Ignore invalid SSL certificates : Ignore invalid/unverifiable (expired, self-certified, etc.) certificates

-
diff --git a/docs/html/en/config_misc.html b/docs/html/en/config_misc.html deleted file mode 100644 index 420d88f91..000000000 --- a/docs/html/en/config_misc.html +++ /dev/null @@ -1,92 +0,0 @@ - -
-

Configuration - General

-

NOTE: THIS SOURCE SHOULD BE RENAMED CONFIG_GENERAL.MD WITH CORRESPONDING CHANGE IN TVH WEBUI JS

-

This tabs allow configuration of several general parameters that affect the core Tvheadend functionality.

-

NOTE: THE TWO IMAGES BELOW SHOULD BE REPLACED WITH A SINGLE ONE

-

'General' Tab Screenshot 1

-

'General' Tab Screenshot 2

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
Save configurationSave any changes to the current configuration.
Clean image (icon) cacheClears the local channel icon cache, forcing images to be re-generated from sources (channel icons or picons).
Discover SAT>IP serversForces a scan for any SAT>IP servers on the local network.
HelpDisplays this help page
-
-
Language Settings
-

Default Language(s) : Select the list of languages (in order of priority) to be used for supplying EPG information to clients that don’t provide their own configuration.

-

The EPG information is NOT translated, this only applies to EPG providers that give information (titles, descriptions, etc..) in multiple languages.

-
-
DVB Scan Files Path
-

DVB scan files path : Select the path to use for DVB scan configuration files. Typically dvb- apps stores these in /usr/share/dvb/. Leave blank to use Tvheadend's internal file set.

-
-
Time Update
-

Tvheadend has a built-in capability to update the system time. However, you should bear in mind that DVB time is not highly accurate and is prone to both jitter and variation between different transponders.

-

Where possible, it’s probably still better to use an internet based NTP source to synchronise the system clock (i.e. through the underlying operating system).

-

Update time : Enable system time updates. This will only work if the user running Tvheadend has rights to update the system clock (normally only root).

-

Enable NTP driver : This will create an NTP driver (using shmem interface) that you can feed into ntpd. This can be run without root privileges, but generally the performance is not that great.

-

Update tolerance (milliseconds) : Only update the system clock (doesn’t affect NTP driver) if the delta between the system clock and DVB time is greater than this. This can help stop excessive oscillations on the system clock.

-
-
Picons
-

Picons (from p ersonal icons ) are collections of similar icons that can be automatically matched against your channels based on a number of technical parameters that will uniquely define a channel. The use of these parameters (e.g. mux, frequency, orbital position) removes the ambiguity of using names - it’s not case sensitive, it doesn’t care if there are spaces or not, and so on. You can generate picons yourself from existing images, or you can usually find sets pre-made on the Internet if you search for them. They’re a good way to get large numbers of icons matched quickly, and usually in a similar style (such as square, x * y pixels, with a consistent highlight/reflection effect).

-

Prefer picons over channel name : If both a picon and a channel-specific (e.g. channelname.jpg) icon are defined, use the picon.

-

Channel icon path : Path to an icon for this channel. This can be named however you wish, as either a local (file://) or remote (http://) image. The following placeholders are available:

- - - - - - - - - - - - - - - - -
PlaceholderFunction
%CThe transliterated channel name in ASCII (safe characters, no spaces etc.)
%cThe channel name (URL encoded ASCII)
-

Example: file:///tmp/icons/%C.png or http://example.com/%c.png

-

Picon path : Path to a directory (folder) containing your picon collection. This can be named however you wish, as either a local (file://) or remote (http://) location - however, remember that it’s pointing to a directory as the picon names are automatically generated from the service parameters frequency, orbital position, etc.).

-

Example: file:///home/hts/picons

-
-
SAT>IP Server
-

SAT>IP Server is something like DVB network tuner. Tvheadend can forward mpegts input streams including on-the-fly descramling to SAT>IP clients.

-

Only networks with the “SAT>IP Source” field set are exported through the SAT>IP protocol. This field is matched through the “src” parameter asked from 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 for unknown mux).

-

RTSP Port : Select RTSP port (TCP) for realtime commands from SAT>IP clients. Usually (as defined in the specification) this port is 554. But as extension, Tvheadend can use any TCP port value (which is default 9983 for non-root users). But the SAT>IP client must allow to set this value (Tvheadend client will obtain the RTSP port number automatically using the XML description). If the RTSP port value is zero, the SAT>IP server functionality is not enabled.

-

Subscription Weight : Subscription weight value. Default value is 100 (standard streaming). Note that the default value for DVR is 300 (normal priority).

-

Descramble Services : The maximum limit of services descrambled per a mux. If zero, the descrambling functionality is disabled.

-

Muxes Handling : When SAT>IP client requests new mux configuration, Tvheadend can handle it in three ways. The auto (0) configuration means that if the mux does not exists, a temporary mux is created and removed when the client closes the connection. The keep (1) configuration will remember all successfuly scanned muxes. The reject (2) configuration will reject unknown muxes.

-

Exported .... Tuners : Each option lists the tuners, by type, you wish to present over IP to other clients.

-
-
Image Caching
-

This will cache any channel icons or other images (such as EPG metadata) to be served from the local webserver. This can be useful for multi-client systems and, generally, to reduce hits on upstream providers.

-

Enabled : Select whether or not to enable caching. Note: even with this disabled you can still specify local (file://) icons and these will be served by the built-in webserver.

-

Re-fetch period (hours) : How frequently the upstream provider is checked for changes.

-

Re-try period (hours) : How frequently it will re-try fetching an image that has failed to be fetched.

-

Ignore invalid SSL certificates : Ignore invalid/unverifiable (expired, self-certified, etc.) certificates

-
diff --git a/docs/html/en/config_muxes.html b/docs/html/en/config_muxes.html deleted file mode 100644 index c2fa0a995..000000000 --- a/docs/html/en/config_muxes.html +++ /dev/null @@ -1,134 +0,0 @@ - -
-

Configuration - DVB Inputs - Muxes

-

Muxes are locations at which services can be found. On traditional networks (DVB-C, -T and -S), these are carrier signals on which the individual channels are multiplexed, hence the name. However, Tvheadend also uses the term ‘mux’ to describe a source for multiple IP streams - so an IP address, in effect.

-

'Muxes' Tab Screenshot

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the mux configuration.
UndoUndo any changes made to the mux configuration since the last save.
AddAdd a new mux.
DeleteDelete an existing mux.
EditEdit an existing mux. This allows you to change any of the parameters you’d otherwise set when adding a new mux, e.g. delivery system, frequency, polarisation, etc.
Hide ??????. Options are Parent Disabled, All, None
HelpDisplays this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Play : Downloads a playlist file (M3U or XSPF, depending on your startup options) so you can tune to the mux from an external application.

-

Enabled : Whether or not the mux is enabled and thus available.

-

EPG : EPG scan setup

- - - - - - - - - - -

Network : The name of the network to which the mux belongs. Networks are defined in Configuration -> DVB Inputs -> Networks - DVB-S or ATSC, for example.

-

Network UUID : The internal UUID reference for the network to which the mux belongs.

-

Name : Short name for the mux - derived from the frequency and polarisation if applicable (e.g. 10788V or 578MHz).

-

Original Network ID : The ONID is a code which uniquely identifies a network.

-

Transport Stream ID : The TSID is a code which identifies the network origination source or transmitter.

-

CRID Authority : The group responsible for the Content Reference Identifier for this mux. This is effectively a URL/URI to an authoritative source for programme data (e.g. series link).

-

Scan Status : Whether the mux is being scanned (ACTIVE), is planned to be scanned (PEND) or has reverted to idle scan (IDLE).

-

Scan Result : Whether there were any problems with the last scan of this mux.

-

Character Set : The character encoding for this mux (e.g. UTF-8).

-

# Services : The number of services found on this mux.

-

# Channels : The number of channels mapped to services found on this mux.

-

AC-3 Detection : Enables alternative detection methods for AC-3 audio.

- - - -
DVB-S/S2-Specific Configuration Items (Add/Edit Dialogs Only)
-

Text...

-
DVB-T/T2-Specific Configuration Items (Add/Edit Dialogs Only)
-

Text...

-
DVB-C-Specific Configuration Items (Add/Edit Dialogs Only)
-

Text...

-
IPTV-Specific Configuration Items (Add/Edit Dialogs Only)
-

URL : Mux URL.

- - - - - -

Interface : The network interface/card on which the IPTV source can be found.

-

ATSC : Whether or not this is an ATSC IPTV source.

-

Mux Name : Text...

-

Service Name : Text...

-

Priority : The mux priority value (higher value = higher priority to use services from this mux). Value 0 means use the IPTV network priority value.

-

Streaming Priority : The mux priority value for streamed channels through HTTP or HTSP (higher value = higher priority to use services from this mux). Value 0 means use the standard streaming network priority value.

-

Environment (pipe) : List of environment variables for pipe (like PATH=/bin:/sbin) separated by spaces. The backslash character is handled like in URL.

-

Respawn (pipe) : Respawn the executed process when it dies.

-
diff --git a/docs/html/en/config_muxsched.html b/docs/html/en/config_muxsched.html deleted file mode 100644 index 40369fc45..000000000 --- a/docs/html/en/config_muxsched.html +++ /dev/null @@ -1,54 +0,0 @@ - -
-

Configuration - DVB Inputs - Mux Schedulers

-

Mux Schedulers enable Tvheadend to automatically play channels. This is useful to get EPG, services or access rights updates.

-

NOTE: SCREENSHOT REQUIRED

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the mux schedulers.
UndoUndo any changes made to the mux schedulers since the last save.
AddAdd a new mux scheduler.
DeleteDelete an existing mux scheduler.
EditEdit an existing mux scheduler.
Hide ??????. Options are Parent Disabled, All, None
HelpDisplays this help page.
-

'Mux Schedulers \'Add\' Dialog' Tab

-
-
Grid Items
-

The main grid items have the following functions:

-

Enabled : If selected, schedule will be triggered. If unselected, schedule will be ignored.

-

Mux : Select mux to be played from the available muxes.

-

Cron : Schedule frequency, using cron syntax. Example : every day at 2am is `0 2 \ `*

-

Timeout : Time in seconds the selected mux will be played. Example : 1 hour would be 3600

-
diff --git a/docs/html/en/config_networks.html b/docs/html/en/config_networks.html deleted file mode 100644 index ea05e4860..000000000 --- a/docs/html/en/config_networks.html +++ /dev/null @@ -1,83 +0,0 @@ - -
-

Configuration - DVB Inputs - Networks

-

A network is the type of carrier for your television signals. Tvheadend supports several different types of network, notably:

- - - - - -

'Networks' Tab Screenshot

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the network configuration.
UndoUndo any changes made to the network configuration since the last save.
AddAdd a new network. You can choose from any of the types described above.
DeleteDelete an existing network. This will also remove any association with an adapter.
EditEdit an existing network. This allows you to change any of the parameters you’d otherwise set when adding a new network, e.g. network discovery, idle scan, etc. - similar to using the check boxes to enable/disable functions.
Force ScanForce a new scan (i.e. scan all muxes for services) for the selected networks.
HelpDisplays this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Network Name : The name of the network. This can be set automatically or you can give it a name that means something to you (e.g. if you have multiple OTA networks).

-

Network ID (limit scanning) : If you experience problems caused by overlaps between multiple network providers this option can be used to filter which network ID is received by a given adapter.

-

Network Discovery : Whether automatic discovery is enabled for this network, i.e. whether Tvheadend looks for muxes or simply stays with the list of muxes as defined initially.

-

Skip initial Scan : Don’t scan all muxes in this network at Tvheadend start. The initial scan procedure is not a blind scan. Only known muxes registered to this network are scanned. If Network Discovery is enabled and new muxes are discovered using DVB descriptors, these muxes will be scanned too.

-

Idle Scan Muxes : When nothing else happens Tvheadend will continuously rotate among all muxes and tune to them to verify that they are still working when the inputs are not used for streaming. If your adapter have problems with lots of (endless) tuning, try to disable this. Note that this option should be OFF for the normal operation. This type of mux probing is not required and it may cause issues for SAT>IP (limited number of PID filters).

-

Ignore Provider’s Channel Numbers : Some providers will try to set a channel number so that every receiver is consistent - “tune to Channel x on 150”. This option allows you to ignore this and let tvhheadend allocate a channel number itself.

-

SAT>IP Source Number : This field is matched through the “src” parameter asked from 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 same number for multiple networks, the first matched network containing the mux with requested parameters will win (also for unknown mux). If this field is set to zero, the network cannot be used by the SAT>IP server.

-

Character Set : The character encoding for this network (e.g. UTF-8).

-

EIT Local Time : EPG (EIT) events uses local time instead of UTC.

-

# Muxes : The number of muxes defined for/discovered on this network.

-

# Services : The number of services (across all muxes) defined for/discovered on this network.

-

# Mapped Channels : The number of channels (across all services) mapped for this network.

-

Scan Q Length : The number of muxes remaining to be scanned on this network.

-
IPTV-Specific Configuration Items (Add/Edit Dialogs Only)
-

Max Input Streams : Maximum simultaneous streams that can be played.

-

Max Bandwidth : Maximum bandwidth allowed for streams.

-

Max timeout : Maximum timeout trying to play stream.

-

Priority : The network priority value (higher value = higher priority to use muxes/services from this network).

-

Streaming Priority : The network priority value for streamed channels through HTTP or HTSP (higher value = higher priority to use muxes/services from this network). If not set, the standard network priority value is used.

-
diff --git a/docs/html/en/config_passwords.html b/docs/html/en/config_passwords.html deleted file mode 100644 index 1610a9d38..000000000 --- a/docs/html/en/config_passwords.html +++ /dev/null @@ -1,53 +0,0 @@ - -
-

Configuration - Passwords

-

This tab is the second part of Tvheadend's access control mechanism. It is where you set and maintain all user passwords (e.g. for streaming or DVR access).

-

Note: Screenshot

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the password rules.
UndoUndo any changes made to the password rules since the last save.
AddAdd a new password rule.
DeleteDelete the selected password rule.
Move upMove the selected rule up one level (rules are executed top to bottom).
Move downMove the selected rule down one level (rules are executed top to bottom).
EditEdit the selected password rule.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-
diff --git a/docs/html/en/config_services.html b/docs/html/en/config_services.html deleted file mode 100644 index 99f68f5df..000000000 --- a/docs/html/en/config_services.html +++ /dev/null @@ -1,83 +0,0 @@ - -
-

Configuration - DVB Inputs - Services

-

Services are automatically pulled from muxes and can be mapped to Channels.

-

'Services' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the services.
UndoUndo any changes made to the services since the last save.
DeleteDelete an existing service.
EditEdit an existing service.
Hide ??????. Options are Parent Disabled, All, None
Map allMap all services to channels. You will be prompted to include/exclude e.g. encrypted channels.
HelpDisplays this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Play : Opens a playlist (M3U of XSPF, depending on your startup options) to allow you to stream this service to another application, e.g. to watch a channel in VLC.

-

Details : Display details on this service, e.g. PID, streams, audio/video CODECs, languages, etc.

-

Enabled : Whether or not this service is available for use

-

Channel : Text...

-

Service Name : Text...

-

Automatic Checking : Check for the service presence. If service is no longer broadcasted, this field will become as “Missing In PAT/SDT”. The check can be also disabled for given service using this column.

-

Priority (1-10) : Define priority (range -10..10) for this service. The higher value means more preferred. Note that this value is added to the input (tuner) priority. Take this in account when you set the input priorities.

-

Channel : The channel to which the service is mapped

-

Service Name : The name of the service, detected when the service was discovered

-

Encrypted : Whether or not the service is scrambled

-

CAID : Text...

-

Network : The network on which this service resides (i.e. whether it’s a cable channel or a terrestrial one)

-

Mux : The mux which carries this service. This is typically the frequency of the carrier signal in kHz, with polarisation (H or V) as applicable.

-

Mux UUID : Text...

-

Service ID : A unique identifier for this service within this mux/transport stream.

-

Local Channel Number : Channel number as assigned by the broadcaster.

-

Local Channel Minor : Text...

-

OpenTV Channel Number : Text...

-

Provider : Any supplied provider string, e.g. where multiple broadcasters share a platform, such as for free-to-air and pay TV.

-

CRID Authority : The group responsible for the Content Reference Identifier for this service. This is effectively a URL/URI to an authoritative source for programme data (e.g. series link).

-

Service Type : The service type flag as defined by the DVB specifications (e.g. 0x02 = radio, 0x11 = MPEG2 HD TV, 0x19 = H.264 HD TV)

-

Ignore EPG (EIT) : Text...

-

Character Set : The character encoding for this service (e.g. UTF-8).

-

Pref. CA PID : The Preferred Conditional Access Packet Identifier. Used for decrypting scrambled streams.

-

Lock Pref. CA PID : The locking mechanism selection for The Preferred Conditional Access Packet Identifier.

- - -

Force CA ID (e.g. 0x2600) : Text...

-

Created : When the service was first identified and recorded.

-

Last Seen : Whenthe service was last seen during a mux scan.

-
diff --git a/docs/html/en/config_streamprofile.html b/docs/html/en/config_streamprofile.html deleted file mode 100644 index 8ef545a5d..000000000 --- a/docs/html/en/config_streamprofile.html +++ /dev/null @@ -1,102 +0,0 @@ - -
-

Configuration - Stream - Stream Profiles

-

Stream Profiles are the settings for output formats. These are used for Live TV streaming and recordings. The profiles are assigned through the Access Entries, DVR Profiles or as parameter for HTTP Streaming.

-

'Stream Profiles'

-
-

Menu Bar/Buttons

-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the stream profile configuration.
UndoUndo any changes made to the stream profile configuration since the last save.
AddAdd a new stream profile.
DeleteDelete an existing stream profile.
HelpDisplay this help page.
-
-

Stream Profile Types

-

MPEG-TS Pass-through /build-in : Pass through of MPEG-TS packets.

-

Matroska (mkv) /build-in : Matroska/WebM muxer (built-in) to output in Matroska format.

-

HTSP Stream Profile : Stream Settings for HTSP.

-

MPEG-TS /av-lib : MPEG-TS stream muxer (libav) to output in MPEG-TS format (only available with libav/ffmpeg).

-

Matroska /av-lib : Matroska/WebM muxer (libav) to output in Matroska format (only available with libav/ffmpeg).

-

Transcode /av-lib : Transcode video/audio/subtitles with various encoders and output in various formats (only available with libav/ffmpeg).

-

Common Settings

-

Enabled : Profile is enabled.

-

Default : Profile is the default profile.

-

Default Priority : The priority of the profile, if no specific priority was requested. This allows to give certain users a higher priority by assigning a streaming profile with a higher priority.

-

Force Priority : Don't allow the Default Priority to be overridden.

-

Timeout : Timeout for streaming to start.

-

Restart On Error : Restart streaming on error. This is useful for DVR, so a recording isn't aborted if an error occurs.

-

Continue On Access Error : Don't abort streaming, when an encrypted stream can't be decrypted by a CA client, that normally should be able to decrypt the stream.

-

Preferred Service Video Type [v4.2 ] : The selected video type should be preferred, when multiple services are available for a channel.

-

MPEG-TS Pass-through Settings

-

Rewrite PMT/PAT/SDT/EIT : Rewrite PMT/PAT/SDT/EIT packets to only include information about the currently streamed service.

-

Matroska Settings

-

WEBM : Use WebM format (WebM is a restricted subset of the Matroska format)

-

Transcode Settings

-

Container : Container to use for transcoded streams.

-

Resolution : Vertical resolution (height) of the output video stream. Horizontal resolution is adjusted automatically to preserve aspect ratio. When set to 0, the input resolution is used.

-

Channels : Channel layout for audio streams.

-

Language : Currently unused.

-

Video Codec : Video encoder codec.

- - - -

Video Bitrate : Video quality/bitrate of the transcoded video stream.

- - - -

Audio Codec : Codec for audio streams.

- - - -

Audio Bitrate : Audio bitrate of the transcoded audio streams.

-

Subtitles Codec : Codec for subtitles.

- - -
diff --git a/docs/html/en/config_tags.html b/docs/html/en/config_tags.html deleted file mode 100644 index 4e4ac7796..000000000 --- a/docs/html/en/config_tags.html +++ /dev/null @@ -1,52 +0,0 @@ - -
-

Configuration - Channel/EPG - Channel Tags

-

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. Tags are not required by Tvheadend itself, but are useful in media applications such as Kodi and are a requirement for using Tvheadend with Movian.

-

'Channel Tags' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the tag configuration.
UndoUndo any changes made to the tag configuration since the last save.
AddAdd a new tag.
DeleteDelete an existing tag.
EditEdit an existing tag. This allows you to change any of the parameters you’d otherwise set when adding a new channel, e.g. internal/private status, icon, etc.
HelpDisplays this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Enabled : Make the tag available in the rest of the system. If the tag is not enabled it is only presented in this grid for the administrator.

-

Name : Name of the tag. Changing the tag name does not interfere with any automatic recordings, groups, etc.

-

Internal : Tags are exported via HTSP/HTTP and used there for grouping of TV channels. If you do not wish to export a tag you can flag it as internal only.

-

Private : Tags are exported via HTSP/HTTP and used there for grouping of TV channels. If you do not wish to export a tag to other users you can flag it as private only. Only users with this tag configured in the access configuration (or users with not set tags) can use it.

-

Icon : Full path to an icon used to depict the tag. This can be a TV network logotype, etc.

-

Icon has title : If set, presentation of the tag icon will not superimpose the tag name on top of the icon.

-

Comment : Allows the administrator to set a comment only visible in this editor. It does not serve any active purpose.

-
diff --git a/docs/html/en/config_timeshift.html b/docs/html/en/config_timeshift.html deleted file mode 100644 index 66a8c18f6..000000000 --- a/docs/html/en/config_timeshift.html +++ /dev/null @@ -1,54 +0,0 @@ - -
-

Configuration - Recording - Timeshift

-

This tab is used to configure timeshift properties.

-

'Timeshift' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - -
ButtonFunction
Save ConfigurationSave any changes made to the timeshift configuration
HelpDisplay this help page.
-
-
Configuration options
-

Enabled : Turn on and off timeshift.

-

On-Demand : Turn this on to start timeshift buffer on pause. In this mode you cannot rewind the buffer (it always begins on the currently playing frame). Without this option there will be a permanent, circular, buffer up to the limits defined below.

-

Storage Path : Where the timeshift data will be stored. If nothing is specified this will default to CONF_DIR/timeshift/buffer

-

Max. Period (mins) : Specify the maximum time period that will be buffered for any given (client) subscription.

-

Unlimited : If checked, this allows the timeshift buffer to grow unbounded until your storage media runs out of space.

-
-

Warning

-

Unless you have adequate storage, or monitor use, enabling this option -could cause your system to slow down or crash completely!

-
- -

Max. Size (MegaBytes) : Specifies the maximum combined size of all timeshift buffers. If you specify an unlimited period its highly recommended you specifying a value here.

-

Max. RAM Size (MegaBytes) : Specifies the maximum RAM (system memory) size for timeshift buffers. When free RAM buffers are available, they are used instead storage to save the timeshift data.

-

Unlimited : If checked, this allows the combined size of all timeshift buffers to potentially grow unbounded until your storage media runs out of space.

-
-

Warning

-

Unless you have adequate storage, or monitor use, enabling this option -could cause your system to slow down or crash completely!

-
- -

Changes to any of these settings must be confirmed by pressing the ‘Save configuration’ button before taking effect.

-
-

Note

-

These settings represent server side maximums, however the clients can -request smaller buffers or even not to create a buffer at all (for example -should they not support timeshifting).

-
diff --git a/docs/html/en/config_tvadapters.html b/docs/html/en/config_tvadapters.html deleted file mode 100644 index d5c91b5b6..000000000 --- a/docs/html/en/config_tvadapters.html +++ /dev/null @@ -1,80 +0,0 @@ - -
-

Configuration - DVB Inputs - TV Adapters

-

The adapters and tuners are listed and edited in a tree.

-

'TV Adapters' Tab Screenshot

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave the current TV adapter configuration.
HelpDisplay this help page.
-
-
Basic Settings
-

Enabled : If selected, this tuner/adapter will be enabled and will become available to receive broadcasts or programmes.

-

Name : : The name of this tuner.

-

Over-the-Air EPG : Enable over-the-air programme guide (EPG) scanning on this input device.

-

Networks : Associate this device with one or more networks.

-
-
Advanced Settings
-

Priority : The tuner priority value (a higher value means to use this tuner out of preference).

-

Streaming Priority : The tuner priority value for streamed channels through HTTP or HTSP (a higher value means to use this tuner out of preference). If not set (zero), the standard priority value is used.

-

Init Scan : Allow the initial scan tuning on this device (scan when Tvheadend starts). See Skip Initial Scan in the network settings for further details.

-

Idle Scan : Allow idle scan tuning on this device.

-

Linked Input : Wake up the linked input whenever this adapter is used. The subscriptions are named as “keep”. Note that this isn't normally needed, and is here simply as a workaround to driver bugs in certain dual tuner cards that otherwise lock the second tuner .

-
-
LinuxDVB Specific Rows
-

Power Save : If enabled, allows the tuner to go to sleep when idle.

-

Tune Before DiseqC : If set, one tune request (setup) is sent before the DiseqC sequence (voltage, tone settings). Some linux drivers require this procedure.

-

Tune Repeats : Number of repeats for the tune requests (default is zero - no repeats). Note: this represents the number of repeats, not the number of requests - so 0 means 'send once: don't repeat', 1 means 'send twice: send once, then send one repeat', etc.

-

Skip Initial Bytes : If set, the first bytes from the MPEG-TS stream are discarded. It may be required for some drivers or hardware which do not flush completely the MPEG-TS buffers after a frequency/parameter change.

-

Input Buffer (Bytes) : By default, linuxdvb's input buffer is 18800 bytes long. The accepted range is 18800-1880000 bytes.

-

Status Period : By default, linuxdvb's status read period is 1000ms (one second). The accepted range is 250ms to 8000ms. Note that for some hardware or drivers (like USB), the status operations take too much time and CPU. In this case, increase the default value. For fast hardware, this value might be decreased to make the decision of the re-tune algorithm based on the signal status faster.

-

Force old status : Always use the old ioctls to read the linuxdvb status (signal strength, SNR, error counters). Some drivers are not mature enough to provide the correct values using the new v5 linuxdvb API.

-
-
LinuxDVB Satellite Config Rows
-

DiseqC repeats : Number of repeats for the DiseqC commands (default is zero - no DiseqC repeats). Note: this represents the number of repeats, not the number of requests - so 0 means 'send once: don't repeat', 1 means 'send twice: send once, then send one repeat', etc.

-

Full DiseqC : Always send the whole DiseqC sequence including LNB setup (voltage, tone). If this is not checked, only changed settings are sent, which may cause issues with some drivers. If the tuning is not reliable, try activating this option.

-

Turn off LNB when idle : Turn off LNB when it is not used. It may save some power.

-

Switch Then Rotor : If the DiseqC switch is located before the rotor (i.e. tuner - switch - rotor), enable this.

-

Init Rotor Time (seconds) : Upon start, Tvheadend doesn't know the last rotor position. This value defines the initial rotor movement. TVHeadend waits the specified time when the first movement is requested.

-

Min Rotor Time (seconds) : The minimum delay after the rotor movement command is send.

-
-
SAT>IP Specific Rows
-

Full Mux Rx mode supported : Enable if the SAT>IP box supports the full mux rx mode (pids=all)

-

Signal scale (240 or 100) : Some SAT>IP boxes only report a 0-100 (percentage) signal strength. If your signal strength reports as too low, try setting this to 100.

-

Maximum PIDs : Maximum supported PIDs in the filter of the SAT>IP box.

-

Maximum length of PIDs : Maximum length in characters for the command setting PIDs to the SAT>IP box.

-

Addpids/delpids supported : Enable if the SAT>IP box supports the addpids/delpids commands.

-

PIDs in setup : Enable if the SAT>IP box requires pids=0 parameter in the SETUP RTSP command.

-

Double RTSP Shutdown : Enable if the SAT>IP box might require to send twice the RTSP SHUTDOWN command.

-

Force pilot for DVB-S2 : Enable if the SAT>IP box requiest plts=on parameter in the SETUP RTSP command for DVB-S2 muxes.

-

UDP RTP Port Number (2 ports) : Force the local UDP Port number here. The number should be even (RTP port). The next odd number (+1) will be used as the RTCP port.

-

Satellite Positions : Select the number of satellite positions supported by the SAT>IP hardware and your coaxial cable wiring.

-

Master Tuner : Select the master tuner.

-

The signal from the standard universal LNB can be split using a simple coaxial splitter (no multiswitch) to several outputs. In this case, the position, the polarization and low-high band settings must be equal.

-

If you set other tuner as master, then this tuner will act like a slave one and tvheadend will assure that this tuner will not use incompatible parameters (position, polarization, lo-hi).

-
-

Next tune delay in ms (0-2000) : The minimum delay before tuning in milliseconds after tuner stop. If the time between the previous and next start is greater than this value then the delay is not applied.

-

Send full PLAY cmd : Send the full RTSP PLAY command after full RTSP SETUP command. Some device firmware require this to get an MPEG-TS stream.

-

Override tuner count : Force Tvheadend to see a specific number of tuners.

-

Some devices, notably AVM’s FRITZ!Box Cable 6490, report wrong number of tuners and this setting allows you to override that. Any value below 1 or above 32 is ignored. For now this setting requires a restart of tvheadend.

-
-

PIDs 21 in setup : Enable if the SAT>IP box requires pids=21 parameter in the SETUP RTSP command.

-

Force teardown delay : Force the delay between RTSP TEARDOWN and RTSP SETUP command (value from ‘Next tune delay in ms’ is used). Some devices are not able to handle quick continuous tuning.

-

Tuner bind IP address : Force all network connections to this tuner to be made over the specified IP address, similar to the setting for the SAT>IP device itself. Setting this overrides the device-specific setting.

-
diff --git a/docs/html/en/config_tvhlog.html b/docs/html/en/config_tvhlog.html deleted file mode 100644 index ca33037bb..000000000 --- a/docs/html/en/config_tvhlog.html +++ /dev/null @@ -1,38 +0,0 @@ - -
-

Configuration - Debugging

-

This tab is used to configure various debugging options in tvheadend.

-

NOTE:Rename this and the html to config_degugging for consistency

-

'Debugging' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - -
ButtonFunction
Apply Configuration (run-time only)Saves any changes made to the debugging configuration. Changes will be lost on a restart.
HelpDisplay this help page
-
-
Configuration Options
-

Debug log path : Text...

-

Debug to syslog : Text...

-

Debug trace (low-level stuff) : Text...

-

Debug subsystems : Text...

-

Trace subsystems : Text...

-

Changes to any of these settings must be confirmed by pressing the ‘Save configuration’ button before taking effect.

-

Note that 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 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.

-

Note: It'd be helpful to expand as to what happens on what distro...

-
diff --git a/docs/html/en/dvr_autorec.html b/docs/html/en/dvr_autorec.html deleted file mode 100644 index 241ae680f..000000000 --- a/docs/html/en/dvr_autorec.html +++ /dev/null @@ -1,66 +0,0 @@ - -
-

Digital Video Recorder - Autorec

-

This tab is used to create and maintain Digital Video Recorder rules. These can be EPG-driven (such as those created from the initial EPG tab) through the DVR AutoRec Entries tab , or can be timer-based through the Time Schedules tab.

-

This tab controls EPG-driven recording rules.

-

'Autorec' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSave any changes made to the recording rule list.
UndoUndo any changes made to the recording rules list since the last save.
AddAdd and configure a recording rule - define the channel, schedule, DVR configuration, priority, etc.
DeleteDelete an existing recording rule.
EditManually edit an existing recording rule. This uses the same fields as Add , but they’re pre-populated with their current values.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions::

-

Enabled : Check or clear this box to enable or disable this rule.

-

Name : The name you’ve given to the rule, e.g. ‘Stuff involving Jeremy Clarkson’.

-

Directory : When specified, this setting overrides the subdirectory rules (except the base directory) specified by the DVR configuration and puts all recordings done by this entry into the specified subdirectory.

-

Useful for e.g. recording multiple different news broadcasts into one common subdirectory called “News”. The backslash and other special characters are escaped, so it is possible to create only one sublevel subdirectories (the base path for the target directory is always taken from the DVR configuration).

-
-

Title (Regexp) : The title of the programme to look for. Note that this accepts case- insensitive regular expressions, so you can use pattern matching as Tvheadend scans the EPG for programmes to record.

-

Fulltext : When the fulltext is checked, the title pattern is matched against title, subtitle, summary and description.

-

Channel : The channel on which this rule applies, i.e. the channel you’re aiming to record.

-

Channel Tag : A channel tag (e.g. a group of channels) on which this rule applies.

-

Content Type : The content type (Movie/Drama , Sports , etc.) to be used to filter matching events/programmes.

-

Minimal Duration : The minimal duration of a matching event - in other words, only match programmes that are no shorter than this duration.

-

Maximal Duration : The maximal duration of a matching event - in other words, only match programmes that are no longer than this duration.

-

Week Days : On which specific days of the week to find matching programmes.

-

Start After : An event which starts between this “start after” and “start before” will be matched (including boundary values).

-

Start Before : An event which starts between this “start after” and “start before” will be matched (including boundary values).

-

Priority : The priority of any recordings set because of this rule: in descending priority, values are important , high , normal , low , and unimportant . Higher-priority events will take precedence and cancel lower-priority events.

-

DVR Configuration : The DVR configuration (e.g. extra start/stop time, post-processing rules) to be used for any recordings set because of this rule.

-

Owner : Text...

-

Creator : The creator of the rule. Automatically set.

-

Comment : A free-text comment. Not used otherwise.

-
diff --git a/docs/html/en/dvr_failed.html b/docs/html/en/dvr_failed.html deleted file mode 100644 index a6a99ff06..000000000 --- a/docs/html/en/dvr_failed.html +++ /dev/null @@ -1,71 +0,0 @@ - -
-

Digital Video Recorder - Failed Recordings

-

This tab show all failed recordings.

-

'Failed Recordings' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - -
ButtonFunction
DeleteDelete the selected finished recording records and associated files . You will be prompted for confirmation.
DownloadDownload the selected finished recordings to local disk. You will be prompted to select the path for the saved file(s).
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Details : Shows the status of the recording event:

- - - - - - - - - - - - - - - - -
IconDescription
Exclamation iconthe recording has failed
Information iconclick to display detailed information about the selected recording
-

The detailed information dialog is as follows:

-

Failed Recording Details

-

Play : Play the selected recording in your browser via the VLC Plugin or some other external player (dependent on there being enough of the failed recording to play, of course).

-

Title : The title of the recording.

-

Subtitle : Text...

-

Episode : The episode number of the record.

-

Scheduled Start Time : The date and time when the recording was started.

-

Scheduled Stop Time : The date and time when the recording was stopped.

-

Duration : The total duration of the recording.

-

File Size : The size of the recording file on disk.

-

Channel Name : The name of the channel from which the recording was made.

-

Owner : Text...

-

Creator : The name of the user who created the recording.

-

DVR Configuration : The DVR configuration to be used for this recording.

-

Status : Status information on the failure (e.g. file missing ).

-

Schedule Status : The status of the recording (failed).

-

Errors : Text...

-

Data Errors : Text...

-

URL : The URL of the recording.

-

Comment : Text...

-
diff --git a/docs/html/en/dvr_finished.html b/docs/html/en/dvr_finished.html deleted file mode 100644 index ff3485ef4..000000000 --- a/docs/html/en/dvr_finished.html +++ /dev/null @@ -1,71 +0,0 @@ - -
-

Digital Video Recorder - Finished Recordings

-

This tab shows your all finished recordings.

-

'Finished Recordings' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - -
ButtonFunction
DeleteDelete the selected finished recording records and associated files . You will be prompted for confirmation.
DownloadDownload the selected finished recordings to local disk. You will be prompted to select the path for the saved file(s).
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Details : Shows the status of the recording event:

- - - - - - - - - - - - - - - - -
IconDescription
Tick iconthe recording has completed
Information iconclick to display detailed information about the selected recording
-

The detailed information dialog is as follows:

-

Finished Recording Detail

-

The columns also provide the following details:

-

Play : Play the selected recording in your browser via the VLC Plugin or some other external player.

-

Title : The title of the recording.

-

Subtitle : Text...

-

Episode : The episode number of the record.

-

Scheduled Start Time : The date and time when the recording was started.

-

Scheduled Stop Time : The date and time when the recording was stopped.

-

Duration : The total duration of the recording.

-

File Size : The size of the recording file on disk.

-

Channel Name : The name of the channel from which the recording was made.

-

Owner : Text...

-

Creator : The name of the user who created the recording.

-

DVR Configuration : The DVR configuration to be used for this recording.

-

Schedule Status : The status of the recording (completed.

-

Errors : Text...

-

Data Errors : Text...

-

URL : The URL of the recording.

-

Comment : Text...

-
diff --git a/docs/html/en/dvr_timerec.html b/docs/html/en/dvr_timerec.html deleted file mode 100644 index 9a1df6cf9..000000000 --- a/docs/html/en/dvr_timerec.html +++ /dev/null @@ -1,86 +0,0 @@ - -
-

Digital Video Recorder - Time Schedules

-

This tab is used to create and maintain Digital Video Recorder rules. These can be EPG-driven (such as those created from the initial EPG tab) through the DVR AutoRec Entries tab , or can be timer-based through the Time Schedules tab.

-

This tab controls timer-driven recording rules.

-

Time Schedules Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonAction
SaveSave any changes made to the recording rule list.
UndoUndo any changes made to the recording rules list since the last save.
AddAdd and configure a recording rule - define the channel, schedule, DVR configuration, priority, etc.
DeleteDelete an existing recording rule.
EditManually edit an existing recording rule. This uses the same fields as Add, but they’re pre-populated with their current values.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Enabled : Check or clear this box to enable or disable this rule.

-

Name : The name you’ve given to the rule, e.g. ‘Evening cartoons for the children’.

-

Directory : When specified, this setting overrides the subdirectory rules specified by the DVR configuration and puts all recordings done by this entry into the specified subdirectory.

-

Useful for e.g. recording multiple different news broadcasts into one common subdirectory called “News”.

-
-

Title : The title is used in the filename that is created for the recording.

-

The default format string suggests Time-[date]_[time] .

-

The escape-codes use strftime format.

-
-

Examples:

- - - - - - - - - - - - - - - - - - - - -
StringFormat Result
%FThe date in ISO-format (e.g. 2015-02-28)
%RThe time in 24h HH:MM format (e.g. 19:45)
%xThe date, formatted according to your locale settings
-

Channel : The channel on which this rule applies, i.e. the channel you’re aiming to record.

-

Week Days : On which specific days of the week you wish this rule to be active (e.g. only record channel XXX at xx:yy on Saturdays and Sundays ).

-

Start : Start recording at this time.

-

Stop : Stop recording at this time.

-

Priority : The priority of any recordings set because of this rule: in descending priority, values are important , high , normal , low , and unimportant . Higher-priority events will take precedence and cancel lower-priority events.

-

DVR Configuration : The DVR configuration (e.g. extra start/stop time, post-processing rules) to be used for any recordings set because of this rule.

-

Owner : Text...

-

Creator : Text...

-

Comment : A free-text comment. Not used otherwise.

-
diff --git a/docs/html/en/dvr_upcoming.html b/docs/html/en/dvr_upcoming.html deleted file mode 100644 index 7e12774ac..000000000 --- a/docs/html/en/dvr_upcoming.html +++ /dev/null @@ -1,90 +0,0 @@ - -
-

Digital Video Recorder - Upcoming/Current Recordings

-

This tab show your all upcoming/current recordings.

-

'Upcoming/Current Recordings' Tab

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
SaveSaves any changes made to the recording list.
UndoUndo any changes made since the last save.
AddAdd and configure a recording event by hand as opposed to choosing something from the EPG. This is useful if you wish to record something that isn’t yet in the EPG, or record at a particular time that perhaps spans several EPG events.
DeleteDelete the selected recording event. You will be prompted for confirmation.
AbortAbort an already-underway recording. Note that this does not remove the (partial) recording file from disk.
EditManually edit an already-scheduled recording event. This uses the same fields as Add , but they’re obviously pre-populated with their current values.
HelpDisplay this help page.
-
-
Grid Items
-

The main grid items have the following functions:

-

Details : Shows the status of the recording event:

- - - - - - - - - - - - - - - - - - - - -
IconDescription
Clock iconthe programme is scheduled (upcoming)
Recording iconthe programme is active and underway (current)
Information iconclick to display detailed information about the selected recording (upcoming or current)
-

The detailed information dialog is as follows:

-

Detailed Recording Information

-

Rerun Of : Text...

-

Title : The title (name) of the recording. While this is copied from the EPG when you create a recording, it’s not used to match the event itself and is thus used here as the name of the event (see also: adding an event manually with the Add button).

-

Subtitle : Text...

-

Episode : The episode number of the recording (whether this is available depends on your broadcaster and/or EPG data source).

-

Priority : The priority of the recording: Not set, Important, High, Normal, Low, Unimportant. If there is a clash, more important recordings will take priority over less important ones.

-

Scheduled Start Time :The date and time when the scheduled recording will start. Note that this includes any extra time defined in the recording profile (e.g. “start two minutes earlier than the EPG start time”).

-

Scheduled Stop Time : The date and time when the scheduled recording will stop. Note that this includes any extra time defined in the recording profile (e.g. “finish recording five minutes after the EPG stop time”).

-

Duration : The total duration of the scheduled recording, including any extra time before or after.

-

File Size : Text...

-

Channel : The channel to be recorded.

-

Owner : Text...

-

Creator : The user who created the recording or the auto-recording source and IP address if scheduled by a matching rule.

-

DVR Configuration : The DVR configuration to be used for this recording.

-

Schedule Status : The status of the recording (scheduled or recording).

-

Errors : Text...

-

Data Errors : Text...

-

Comment : Text...

-
diff --git a/docs/html/en/epg.html b/docs/html/en/epg.html deleted file mode 100644 index aef09e000..000000000 --- a/docs/html/en/epg.html +++ /dev/null @@ -1,234 +0,0 @@ - -
-

Electronic Program Guide

-

Tvheadend has a built-in Electronic Program Guide. The EPG is an in-memory database populated with all the information about events received from the DVB networks over-the-air or from external grabbers such as XMLTV.

-

The EPG tab displays a filterable grid containing all events, sorted based on start time.

-

'Electronic Program Guide' Tab

-
-

Menu Bar/Buttons

-

The following functions are available:

-
Filtering (or searching)
-

In the EPG top tool bar you can access five input fields. These are used to filter/search for events. The form uses implicit AND between the input fields. This means that all filters must match for an event to be displayed.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FilterFunction
Search title...Only display events that match the given title.

The filter uses case-insensitive regular expressions. If you don’t know what a regular expression is, this simply means that you can type just parts of the title and filter on that - there’s no need for full, exact matching. If the fulltext checkbox is checked, the title text is matched against title, subtitle, summary and description.
Filter channel...Only display events from the selected channel.

Channels in the drop down are ordered by name and can be filtered (by name) by typing in the box.
Filter tag...Only display events from channels which are included in the selected tag.

Tags are used for grouping channels together - such as ‘Radio’ or ‘HDTV’ - and are configured by the administrator. You can start typing a tag name to filter the list.
Filter content type...Only display events that match the given content type tag.

Most DVB networks classify their events into content groups. This field allows you to filter based on content type (e.g. “Sports” or “Game Show”). Supported tags are determined by your broadcaster. Again, simply start typing to filter the entries if you have a long list to choose from.
Filter duration...Only display events that fall between the given minimum and maximum durations.

This allows you to filter for or against, say, a daily broadcast and a weekly omnibus edition of a programme, or only look for short news bulletins and not the 24-hour rolling broadcasts.
-

Title , Channel , Tag and Content Type are dependent on your configuration and on what your broadcaster sends. Options for the Duration are as follows:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Filter RangeExample Purpose
00:00:01 to 00:15:00Very short news bulletins, children's programmes, etc.
00:15:01 to 00:30:00Short programmes, e.g. daily soap operas
00:30:01 to 01:30:00Medium-length programmes, e.g. documentaries
01:30:01 to 03:00:00Longer programmes, e.g. films
03:00:00 to no maximumVery long programmes, e.g. major sporting events
-

So, if you only want to see Movies from your available HD channels, you would select ‘HDTV’ in the [Filter tag…] field, and select ‘Movie / Drama’ in the [Filter content type…] field. If you wish, you could then further limit the search to programmes of between 90 minutes and 3 hours by selecting ‘01:30:01 to 03:00:00’ in the [Filter duration…] field.

-

Note that you don’t have to press a ‘Search’ button: the grid immediately updates itself as you change the filters.

-

You can clear an individual filter by simply deleting its contents, or by selecting ‘(Clear filter)’ as appropriate on all except the title filter. If you want to clear all filters, just press the [Reset All] button.

-
Buttons
-

The following buttons are also available:

- - - - - - - - - - - - - - - - - - - - - - - - -
ButtonFunction
Reset AllClears all search filters.
Watch TVLaunches Live TV via HTML5 video (see below).
Create AutorecCreates an auto-recording rule based on the current filter criteria (see below).
HelpDisplay this help page.
-
-

Grid Items

-

The main grid items have the following functions:

-

Details : Displays the current status of a recording event for this programme if one applies:

- - - - - - - - - - - - - - - - - - - - -
IconDescription
Clock iconthe programme is scheduled for recording
Recording iconthe programme is currently recording
Broadcast details iconclick to call up more detailed information about an event
-

Progress : A bar graph display of how far through a programme we currently are.

-

Title : The title of the programme. You can automatically set a filter to the value of this field by clicking on it (e.g. click on 'Daily News' will automatically filter the whole grid to only show programmes with the same name).

-

SubTitle : The subtitle of the programme, if gien by your EPG provider. Note that some (notably, UK) providers use this for a programme synopsis instead of a true subtitle.

-

Episode : Episode number, if given by your EPG provider.

-

Start Time : The scheduled start time of the programme.

-

End Time : The scheduled end time of the programme.

-

Duration : The scheduled duration (i.e. start time to end time) of the programme.

-

Number : The channel number of the broadcasting channel, if defined.

-

Channel : The name of the broadcasting channel. You can automatically set a filter to the value of this field by clicking on it (e.g. click on 'Channel 4 HD' will automatically filter the whole grid to only show programmes from that channel).

-

Stars : Rating (in stars) of the programme.

-

Age : Age rating of the programme.

-

Content Type : Any content/genre information as provided by the EPG provider. You can automatically set a filter to the value of this field by clicking on it (e.g. click on 'Movie/Drama' will automatically filter the whole grid to only show programmes of the same type).

-
-

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 for recording by clicking on the [Record program] button.

-

For EPG providers that supply series link information there will also be a [Record series] button that will record all entries in the series.

-

For events without any series link information, an [Autorec] button will be provided to create a pseudo-series link using the autorec feature.

-

EPG Detail 1 EPG Detail 2

-

If you schedule any kind of recording from this point, you can choose a specific DVR profile that will apply to the recording or autorec rule. This will normally show as (default) , but you can define different profiles in the Configuration -> Recording -> Digital Video Recorder tab. This allows you to set, for example, more post- broadcast padding for a channel that always runs late, or perhaps define a different post-processing command to strip adverts out on a commercial channel.

-

You will also see a [Search IMDB] button to look for the programme by name on imdb.com, and a [Play program] button to watch a programme that’s already in progress. This second button downloads a playlist file (XSPF or M3U depending on your startup options); if your system is configured for it, this will automatically launch an appropriate player, otherwise you will need to manually open the playlist to start watching (normally a double-click on the downloaded file).

-

To close the popup, just click on the [X] window button. The popup isn’t modal, so you don’t have to close it before doing something else, and you can open as many detailed information popups as you want.

-
-

Autorecordings

-

Should you wish to record all events matching a specific query (to record your favourite show every week, for example) you can press the [Create AutoRec] button in the top toolbar.

-

A popup with details about the to-be-created autorecording rule needs to be confirmed before the rule takes effect.

-

Autorec Dialogue Box

-

You can change or delete the autorec rules in the Digital Video Recorder tab. Use that editor if you temporarily want to disable an autorecording or make adjustments to the channel, tag, or similar.

-
-

Watch TV

-

If you want to watch live TV in the web UI, the [Watch TV] button will pop up a HTML5 video player, where you can select the channel to watch and a stream profile to use. A transcoding stream profile is required to transcode the stream to a format that is supported by your browser, as browsers only support certain formats and codecs.

-
Supported formats (containers)
- - - - - - - - - - - - - - - - - - - - - - - - - -
BrowserMPEG-TSMPEG-PSMatroskaWebM
Google Chromenonoyesyes
Mozilla Firefoxnonoyes
-
Supported video codecs
- - - - - - - - - - - - - - - - - - - - - - -
BrowserMPEG2 VideoH.264VP8
Google Chromenoyesyes
Mozilla Firefoxnoyes
-
Supported audio codecs
- - - - - - - - - - - - - - - - - - - - - - - - - -
BrowserMPEG2 AudioDolby Digital (AC3)AACVorbis
Google Chromenonoyesyes
Mozilla Firefoxnonoyes
-
diff --git a/docs/html/en/status_connections.html b/docs/html/en/status_connections.html deleted file mode 100644 index 8b8ecc022..000000000 --- a/docs/html/en/status_connections.html +++ /dev/null @@ -1,31 +0,0 @@ - -
-

Status - Connections

-

Note: Intro text

-

Note: Screenshot

-

This is a read-only tab; nothing is configurable.

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - -
ButtonFunction
HelpDisplay this help page.
-

Note: Need to add a help button!

-
-
Grid Items
-

The main grid items have the following functions:

-

Item : Description

-

Item : Description

-

Item : Description

-

Item : Description

-
diff --git a/docs/html/en/status_servicemapper.html b/docs/html/en/status_servicemapper.html deleted file mode 100644 index 169b7c4da..000000000 --- a/docs/html/en/status_servicemapper.html +++ /dev/null @@ -1,31 +0,0 @@ - -
-

Status - Service Mapper

-

Note: Intro text

-

Note: Screenshot

-

This is a read-only tab; nothing is configurable.

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - -
ButtonFunction
HelpDisplay this help page.
-

Note: Need to add a help button!

-
-
Grid Items
-

The main grid items have the following functions:

-

Item : Description

-

Item : Description

-

Item : Description

-

Item : Description

-
diff --git a/docs/html/en/status_stream.html b/docs/html/en/status_stream.html deleted file mode 100644 index 1df9b38f5..000000000 --- a/docs/html/en/status_stream.html +++ /dev/null @@ -1,31 +0,0 @@ - -
-

Status - Stream

-

Note: Intro text

-

Note: Screenshot

-

This is a read-only tab; nothing is configurable.

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - -
ButtonFunction
HelpDisplay this help page.
-

Note: Need to add a help button!

-
-
Grid Items
-

The main grid items have the following functions:

-

Item : Description

-

Item : Description

-

Item : Description

-

Item : Description

-
diff --git a/docs/html/en/status_subscriptions.html b/docs/html/en/status_subscriptions.html deleted file mode 100644 index 28964bbb5..000000000 --- a/docs/html/en/status_subscriptions.html +++ /dev/null @@ -1,31 +0,0 @@ - -
-

Status - Subscriptions

-

Note: Intro text

-

Note: Screenshot

-

This is a read-only tab; nothing is configurable.

-
-
Menu Bar/Buttons
-

The following functions are available:

- - - - - - - - - - - - -
ButtonFunction
HelpDisplay this help page.
-

Note: Need to add a help button!

-
-
Grid Items
-

The main grid items have the following functions:

-

Item : Description

-

Item : Description

-

Item : Description

-

Item : Description

-
diff --git a/src/webui/static/app/acleditor.js b/src/webui/static/app/acleditor.js index 60757dccc..5a53f709f 100644 --- a/src/webui/static/app/acleditor.js +++ b/src/webui/static/app/acleditor.js @@ -61,10 +61,7 @@ tvheadend.acleditor = function(panel, index) }, del: true, move: true, - list: list, - help: function() { - new tvheadend.mdhelp('class/access'); - } + list: list }); }; @@ -100,10 +97,7 @@ tvheadend.passwdeditor = function(panel, index) create: { } }, del: true, - list: list, - help: function() { - new tvheadend.mdhelp('class/passwd'); - } + list: list }); }; @@ -139,9 +133,6 @@ tvheadend.ipblockeditor = function(panel, index) create: { } }, del: true, - list: list, - help: function() { - new tvheadend.mdhelp('class/ipblocking'); - } + list: list }); }; diff --git a/src/webui/static/app/caclient.js b/src/webui/static/app/caclient.js index 6a0d9e4ec..2bbe2cbb3 100644 --- a/src/webui/static/app/caclient.js +++ b/src/webui/static/app/caclient.js @@ -57,10 +57,7 @@ tvheadend.caclient = function(panel, index) { move: true, hidepwd: true, lcol: [actions], - plugins: [actions], - help: function() { - new tvheadend.mdhelp('class/caclient'); - } + plugins: [actions] }); return panel; diff --git a/src/webui/static/app/chconf.js b/src/webui/static/app/chconf.js index dbca62564..6c9aae0c2 100644 --- a/src/webui/static/app/chconf.js +++ b/src/webui/static/app/chconf.js @@ -218,9 +218,6 @@ tvheadend.channel_tab = function(panel, index) titleP: _('Channels'), iconCls: 'channels', tabIndex: index, - help: function() { - new tvheadend.help(_('Channels'), 'config_channels.html'); - }, add: { url: 'api/channel', create: {} diff --git a/src/webui/static/app/config.js b/src/webui/static/app/config.js index eb18c5036..9d9bea5f9 100644 --- a/src/webui/static/app/config.js +++ b/src/webui/static/app/config.js @@ -55,9 +55,6 @@ tvheadend.baseconf = function(panel, index) { reload = 1; if (reload) window.location.reload(); - }, - help: function() { - new tvheadend.mdhelp('class/config'); } }); @@ -114,10 +111,7 @@ tvheadend.imgcacheconf = function(panel, index) { comet: 'imagecache', width: 550, labelWidth: 200, - tbar: [cleanButton, triggerButton], - help: function() { - new tvheadend.mdhelp('class/imagecache'); - } + tbar: [cleanButton, triggerButton] }); }; @@ -156,9 +150,6 @@ tvheadend.satipsrvconf = function(panel, index) { comet: 'satip_server', width: 600, labelWidth: 250, - tbar: [discoverButton], - help: function() { - new tvheadend.mdhelp('class/satip_server'); - } + tbar: [discoverButton] }); }; diff --git a/src/webui/static/app/cteditor.js b/src/webui/static/app/cteditor.js index 1cb89552d..d33f4a7c8 100644 --- a/src/webui/static/app/cteditor.js +++ b/src/webui/static/app/cteditor.js @@ -19,9 +19,6 @@ tvheadend.cteditor = function(panel, index) sort: { field: 'name', direction: 'ASC' - }, - help: function() { - new tvheadend.help(_('Channel Tags'), 'config_tags.html'); } }); @@ -67,9 +64,6 @@ tvheadend.bouquet = function(panel, index) sort: { field: 'name', direction: 'ASC' - }, - help: function() { - new tvheadend.help(_('Bouquets'), 'config_bouquet.html'); } }); diff --git a/src/webui/static/app/dvr.js b/src/webui/static/app/dvr.js index 341e861ba..633161c86 100644 --- a/src/webui/static/app/dvr.js +++ b/src/webui/static/app/dvr.js @@ -318,10 +318,7 @@ tvheadend.dvr_upcoming = function(panel, index) { lcol: [actions], tbar: [stopButton, abortButton], selected: selected, - beforeedit: beforeedit, - help: function() { - new tvheadend.mdhelp('class/dvrentry'); - } + beforeedit: beforeedit }); return panel; @@ -459,10 +456,7 @@ tvheadend.dvr_finished = function(panel, index) { } }], tbar: [downloadButton, rerecordButton, moveButton], - selected: selected, - help: function() { - new tvheadend.mdhelp('class/dvrentry'); - } + selected: selected }); return panel; @@ -600,10 +594,7 @@ tvheadend.dvr_failed = function(panel, index) { } }], tbar: [downloadButton, rerecordButton, moveButton], - selected: selected, - help: function() { - new tvheadend.mdhelp('class/dvrentry'); - } + selected: selected }); return panel; @@ -626,10 +617,7 @@ tvheadend.dvr_settings = function(panel, index) { url: 'api/dvr/config', create: { } }, - del: true, - help: function() { - new tvheadend.mdhelp('class/dvrconfig'); - } + del: true }); return panel; @@ -694,9 +682,6 @@ tvheadend.autorec_editor = function(panel, index) { sort: { field: 'name', direction: 'ASC' - }, - help: function() { - new tvheadend.mdhelp('class/dvrautorec'); } }); @@ -747,9 +732,6 @@ tvheadend.timerec_editor = function(panel, index) { sort: { field: 'name', direction: 'ASC' - }, - help: function() { - new tvheadend.mdhelp('class/dvrtimerec'); } }); diff --git a/src/webui/static/app/epggrab.js b/src/webui/static/app/epggrab.js index 7f94567d1..990250f27 100644 --- a/src/webui/static/app/epggrab.js +++ b/src/webui/static/app/epggrab.js @@ -25,10 +25,7 @@ tvheadend.epggrab_base = function(panel, index) { tabIndex: index, width: 550, labelWidth: 200, - tbar: [triggerButton], - help: function() { - new tvheadend.help(_('EPG Grab Configuration'), 'config_epggrab.html'); - } + tbar: [triggerButton] }); } @@ -46,9 +43,6 @@ tvheadend.epggrab_map = function(panel, index) { sort: { field: 'name', direction: 'ASC' - }, - help: function() { - new tvheadend.help(_('EPG Grabber Channels'), 'config_epggrab.html'); } }); @@ -79,10 +73,7 @@ tvheadend.epggrab_mod = function(panel, index) { fields: ['uuid', 'title', 'status'], list: { url: 'api/epggrab/module/list', params: { } }, lcol: [actions], - plugins: [actions], - help: function() { - new tvheadend.help(_('EPG Grab Configuration'), 'config_epggrab.html'); - } + plugins: [actions] }); }; diff --git a/src/webui/static/app/esfilter.js b/src/webui/static/app/esfilter.js index ed29582ef..7113b746c 100644 --- a/src/webui/static/app/esfilter.js +++ b/src/webui/static/app/esfilter.js @@ -38,10 +38,7 @@ tvheadend.esfilter_tab = function(panel) }, create: { } }, - del: true, - help: function() { - new tvheadend.mdhelp('class/profile') - } + del: true }); var eslist = '-class,index'; @@ -60,10 +57,7 @@ tvheadend.esfilter_tab = function(panel) create: { } }, del: true, - move: true, - help: function() { - new tvheadend.mdhelp('class/esfilter_video') - } + move: true }); tvheadend.idnode_grid(panel, { @@ -80,10 +74,7 @@ tvheadend.esfilter_tab = function(panel) create: {} }, del: true, - move: true, - help: function() { - new tvheadend.mdhelp('class/esfilter_audio') - } + move: true }); tvheadend.idnode_grid(panel, { @@ -100,10 +91,7 @@ tvheadend.esfilter_tab = function(panel) create: {} }, del: true, - move: true, - help: function() { - new tvheadend.mdhelp('class/esfilter_teletext') - } + move: true }); tvheadend.idnode_grid(panel, { @@ -120,10 +108,7 @@ tvheadend.esfilter_tab = function(panel) create: {} }, del: true, - move: true, - help: function() { - new tvheadend.mdhelp('class/esfilter_subtit') - } + move: true }); tvheadend.idnode_grid(panel, { @@ -139,10 +124,7 @@ tvheadend.esfilter_tab = function(panel) create: {} }, del: true, - move: true, - help: function() { - new tvheadend.mdhelp('class/esfilter_ca') - } + move: true }); tvheadend.idnode_grid(panel, { @@ -159,9 +141,6 @@ tvheadend.esfilter_tab = function(panel) create: {} }, del: true, - move: true, - help: function() { - new tvheadend.mdhelp('class/esfilter_other') - } + move: true }); }; diff --git a/src/webui/static/app/idnode.js b/src/webui/static/app/idnode.js index 79fbe784d..825e54e98 100644 --- a/src/webui/static/app/idnode.js +++ b/src/webui/static/app/idnode.js @@ -1199,15 +1199,19 @@ tvheadend.idnode_editor = function(_uilevel, item, conf) buttons.push(uilevelBtn); } - if (conf.help) { - var helpBtn = new Ext.Button({ - text: _('Help'), - iconCls: 'help', - handler: conf.help - }); - buttons.push(uilevelBtn ? '-' : '->'); - buttons.push(helpBtn); + var help = conf.help; + if (!help) { + help = function() { + new tvheadend.mdhelp('class/' + item['class']); + } } + var helpBtn = new Ext.Button({ + text: _('Help'), + iconCls: 'help', + handler: help + }); + buttons.push(uilevelBtn ? '-' : '->'); + buttons.push(helpBtn); if (conf.buildbtn) conf.buildbtn(conf, buttons); @@ -2036,15 +2040,20 @@ tvheadend.idnode_grid = function(panel, conf) } /* Help */ - if (conf.help) { - buttons.push(abuttons.uilevel ? '-' : '->'); - buttons.push({ - text: _('Help'), - iconCls: 'help', - handler: conf.help - }); + var help = conf.help; + if (!help) { + help = function() { + new tvheadend.mdhelp('class/' + idnode.clazz); + } } + buttons.push(abuttons.uilevel ? '-' : '->'); + buttons.push({ + text: _('Help'), + iconCls: 'help', + handler: help + }); + plugins.push(filter); var gconf = { stateful: true, @@ -2419,14 +2428,18 @@ tvheadend.idnode_form_grid = function(panel, conf) } /* Help */ - if (conf.help) { - buttons.push(abuttons.uilevel ? '-' : '->'); - buttons.push({ - text: _('Help'), - iconCls: 'help', - handler: conf.help - }); + var help = conf.help; + if (!help) { + help = function() { + new tvheadend.mdhelp('class/' + conf.clazz); + } } + buttons.push(abuttons.uilevel ? '-' : '->'); + buttons.push({ + text: _('Help'), + iconCls: 'help', + handler: help + }); function roweditor_destroy() { if (current && current.editor) { @@ -2853,14 +2866,18 @@ tvheadend.idnode_simple = function(panel, conf) } /* Help */ - if (conf.help) { - buttons.push(abuttons.uilevel ? '-' : '->'); - buttons.push({ - text: _('Help'), - iconCls: 'help', - handler: conf.help - }); + var help = conf.help; + if (!help) { + help = function() { + new tvheadend.mdhelp('class/' + lastdata['class']); + } } + buttons.push(abuttons.uilevel ? '-' : '->'); + buttons.push({ + text: _('Help'), + iconCls: 'help', + handler: help + }); function form_load(force) { if (!force && current) diff --git a/src/webui/static/app/mpegts.js b/src/webui/static/app/mpegts.js index 6c23cbf0c..cc6664092 100644 --- a/src/webui/static/app/mpegts.js +++ b/src/webui/static/app/mpegts.js @@ -67,9 +67,6 @@ tvheadend.networks = function(panel, index) titleP: _('Networks'), iconCls: 'networks', tabIndex: index, - help: function() { - new tvheadend.help(_('Networks'), 'config_networks.html'); - }, tbar: [scanButton], add: { titleS: _('Network'), @@ -102,9 +99,6 @@ tvheadend.muxes = function(panel, index) iconCls: 'muxes', tabIndex: index, hidemode: true, - help: function() { - new tvheadend.help(_('Muxes'), 'config_muxes.html'); - }, add: { titleS: _('Mux'), select: { @@ -317,9 +311,6 @@ tvheadend.services = function(panel, index) hidemode: true, add: false, del: true, - help: function() { - new tvheadend.help(_('Services'), 'config_services.html'); - }, lcol: [ { width: 50, @@ -352,9 +343,6 @@ tvheadend.mux_sched = function(panel, index) titleP: _('Mux Schedulers'), iconCls: 'muxSchedulers', tabIndex: index, - help: function() { - new tvheadend.help(_('Mux Schedulers'), 'config_muxsched.html'); - }, hidemode: true, add: { url: 'api/mpegts/mux_sched', diff --git a/src/webui/static/app/servicemapper.js b/src/webui/static/app/servicemapper.js index d257d4c86..042ece76f 100644 --- a/src/webui/static/app/servicemapper.js +++ b/src/webui/static/app/servicemapper.js @@ -107,9 +107,6 @@ tvheadend.service_mapper_sel = function(t, e, store, select) modifyData: select ? modify_data : null, postsave: function() { tvheadend.select_tab('service_mapper'); - }, - help: function() { - new tvheadend.help(_('Map services'), 'config_mapper.html'); } }); } @@ -135,9 +132,6 @@ tvheadend.service_mapper0 = function(all) } : null, postsave: function() { tvheadend.select_tab('service_mapper'); - }, - help: function() { - new tvheadend.help(_('Map services'), 'config_mapper.html'); } }); } diff --git a/src/webui/static/app/timeshift.js b/src/webui/static/app/timeshift.js index 8bb064da3..75507d100 100644 --- a/src/webui/static/app/timeshift.js +++ b/src/webui/static/app/timeshift.js @@ -19,10 +19,7 @@ tvheadend.timeshift = function(panel, index) { comet: 'timeshift', labelWidth: 220, width: 570, - onchange: onchange, - help: function() { - new tvheadend.help(_('Timeshift Configuration'), 'config_timeshift.html'); - } + onchange: onchange }); }; diff --git a/src/webui/static/app/tvadapters.js b/src/webui/static/app/tvadapters.js index 19a428d4c..81283b111 100644 --- a/src/webui/static/app/tvadapters.js +++ b/src/webui/static/app/tvadapters.js @@ -6,10 +6,7 @@ tvheadend.tvadapters = function(panel, index) { title: _('TV adapters'), iconCls: 'tvCards', tabIndex: index, - comet: 'hardware', - help: function() { - new tvheadend.help(_('TV adapters'), 'config_tvadapters.html'); - } + comet: 'hardware' }); return panel; diff --git a/src/webui/static/app/tvheadend.js b/src/webui/static/app/tvheadend.js index 4906e7b40..269ca26ee 100644 --- a/src/webui/static/app/tvheadend.js +++ b/src/webui/static/app/tvheadend.js @@ -68,32 +68,6 @@ tvheadend.select_tab = function(id) /** * Displays a help popup window */ -tvheadend.help = function(title, pagename) { - Ext.Ajax.request({ - url: 'redir/docs/' + pagename, - success: function(result, request) { - - var content = new Ext.Panel({ - autoScroll: true, - border: false, - layout: 'fit', - html: result.responseText - }); - - var win = new Ext.Window({ - title: _('Help for') + ' ' + title, - iconCls: 'help', - layout: 'fit', - width: 900, - height: 400, - constrainHeader: true, - items: [content] - }); - win.show(); - } - }); -}; - tvheadend.mdhelp = function(pagename) { var parse = function(text) { diff --git a/src/webui/static/app/tvhlog.js b/src/webui/static/app/tvhlog.js index 866cec75a..f3453cd8d 100644 --- a/src/webui/static/app/tvhlog.js +++ b/src/webui/static/app/tvhlog.js @@ -23,10 +23,7 @@ tvheadend.tvhlog = function(panel, index) { onchange: onchange, saveText: _("Apply configuration (run-time only)"), saveTooltip: _('Apply any changes made below to the run-time configuration.') + '
' + - _('They will be lost when the application next restarts.'), - help: function() { - new tvheadend.help(_('Debug Configuration'), 'config_debugging.html'); - } + _('They will be lost when the application next restarts.') }); }; @@ -39,9 +36,6 @@ tvheadend.memoryinfo = function(panel, index) titleP: _('Memory Information Entries'), iconCls: 'exclamation', tabIndex: index, - readonly: true, - help: function() { - new tvheadend.mdhelp('class/memoryinfo'); - } + readonly: true }); }; diff --git a/src/webui/static/app/wizard.js b/src/webui/static/app/wizard.js index e3f0adfca..cc14d73a5 100644 --- a/src/webui/static/app/wizard.js +++ b/src/webui/static/app/wizard.js @@ -162,7 +162,7 @@ tvheadend.wizard_start = function(page) { cancel: cancel, uilevel: 'expert', help: function() { - new tvheadend.help(_('Wizard - initial configuration and tutorial'), 'config_wizard.html'); + new tvheadend.mdhelp('wizard'); } }); } diff --git a/src/webui/webui.c b/src/webui/webui.c index 46d2aaa93..cb0918ee6 100644 --- a/src/webui/webui.c +++ b/src/webui/webui.c @@ -1814,19 +1814,6 @@ http_redir(http_connection_t *hc, const char *remain, void *opaque) } } - if (nc >= 2) { - if (!strcmp(components[0], "docs")) { - lang = tvh_gettext_get_lang(hc->hc_access->aa_lang_ui); - snprintf(buf, sizeof(buf), "docs/html/%s/%s%s%s", lang, components[1], - nc > 2 ? "/" : "", nc > 2 ? components[1] : ""); - if (http_file_test(buf)) lang = "en"; - snprintf(buf, sizeof(buf), "/docs/%s/%s%s%s", lang, components[1], - nc > 2 ? "/" : "", nc > 2 ? components[1] : ""); - http_redirect(hc, buf, NULL, 0); - return 0; - } - } - return HTTP_STATUS_BAD_REQUEST; } -- 2.47.3