that you put the wildcard (asterisk `*`) accounts at top and all other
accounts (with special permissions) at the bottom.
-
+
---
<tvh_include>inc/common_button_table_end</tvh_include>
Entries are checked in order (when logging in, etc), the following
-functions allows you to change the ordering:
+functions allow you to change the ordering:
Button | Function
-----------------------|---------
---
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-####Example
+###Example
This is an example of a limited user entry.
-
+
Remember to also add a password entry in the
*[Passwords](class/passwd)* tab - not required for wildcard accounts.
---
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
###Emergency/Backdoor Access
Tvheadend includes functionality that allows you to regain access to
Bouquets are broadcaster-defined groupings and orders of channels.
-
+
To use bouquets, ensure to add and scan all available muxes using the
predefined muxes or manual configuration.
---
-<tvh_include>inc/add_grid_entry</tvh_include>
+###Example
-####Example
-
-
+
Note that the URL must begin with `file://` or `http(s)://`.
---
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
###Detaching Channels
If you're mapping another service to a channel created by a bouquet you
the grid and then pressing the *Detach selected channels from bouquet*
option from the *[Map services]* button.
-
+
If you do not detach channel(s) before mapping additional
services the following changes can occur..
provided by the bouquet, which unfortunately means you will have to
manually re-map when changes to services occur (e.g, mux moves, ceased broadcasting etc).
-<tvh_include>inc/selecting_entries_tip</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
---
Tvheadend supports connecting to card clients via the cwc (newcamd) and
capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling.
-
+
---
 | The client is disabled.
---
-
-###Adding/Editing a CA Configuration
-
-To create a new CA configuration press the *[Add]* button from the
-menu bar, you will then be asked to select a client type. Once you've
-selected a type you can then enter/select the desired options from the
-resultant *Add* dialog.
-
-
-
-To edit an existing configuration, click on it from within the grid, the
-*Parameters* panel should then appear on the right hand side.
-
-**Tips**:
-* Remember to *[Save]* your changes before selecting another config
-from within the grid.
-* You can clone an existing config by clicking the *[Clone]*
-button.
-
----
-
-###Deleting a CA Configuration
-
-Highlight (select) the desired entry from the grid, then press the
-*[Delete]* button from the menu bar.
-
----
This tab lists all defined channels.
-
+
---
---
-<tvh_include>inc/add_grid_entry</tvh_include>
+###Example
-####Example
-
-
+
In the above example image, we're creating a channel called Channel 4
and mapping it to the service of the same name. You can name a channel
If you have a lot of services you may want to use the [Map services](class/mpegts_service)
functions or a [Bouquet](class/bouquet).
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
-
-
-Note that editing a channel created by a bouquet can have unexpected
+Note, that editing a channel created by a bouquet can have unexpected
results, please see *Detaching Channels* on the [Bouquet](class/bouquet) page for info.
---
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
<tvh_include>inc/play</tvh_include>
---
applications such as Kodi and are a requirement for using Tvheadend
with Movian.
-
-
----
-
-<tvh_include>inc/common_button_table_start</tvh_include>
-
-<tvh_include>inc/common_button_table_end</tvh_include>
-
----
-
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-
-
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
+
---
This tabs allow configuration of several general parameters that affect
the core Tvheadend functionality.
-
+
---
This tab is used to configure various debugging options in tvheadend.
-
+
Changes to any of these settings must be confirmed by pressing the
*[Apply configuration]* button before taking effect.
This tab controls EPG-driven recording rules.
-
+
---
---
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-####Example
+###Example
If you wanted to record any programs matching "BBC News" on
BBC One you would enter something like this into the add entry dialog:
-
+
This uses a regular expression (regex) to match the program title
"BBC News" exactly, otherwise event titles containing the phrase would
automatically start being recorded.**
---
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
-
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
It is not used for scheduling or administration of individual
recordings.
-
+
---
<tvh_include>inc/common_button_table_end</tvh_include>
---
-
-###Adding/Editing a Profile
-
-To create a new profile press the *[Add]* button from the
-menu bar, a new entry "! New config" will be added to the grid, click
-on that entry to configure it - don't forget to save!
-
-
-
-To edit an existing configuration, click on it from within the grid, the
-*Parameters* panel should then appear on the right hand side.
-
-**Tips**:
-* Remember to *[Save]* your changes before selecting another profile
-from within the grid.
-* You can clone an existing profile by clicking the *[Clone]*
-button.
-
----
-
-###Deleting a Profile
-
-Highlight (select) the desired entry from the grid, then press the
-*[Delete]* button from the menu bar.
-
----
Entries shown here link to file(s) that Tvheadend cannot locate
(files which have been externally removed).
-
+
---
 | the program recorded successfully
---
-<tvh_include>inc/add_grid_entry</tvh_include>
-Note that the *[Add]* functionality is only available in
-the *Upcoming/Current Recordings* tab.
-
-####Manual Recording Entry Example
+###Manual Recording Entry Example
This is an example of a one-time recording entry.
-
+
-####Adding an Entry Using the EPG
+###Adding an Entry Using the EPG
Using the Electronic Program Guide search functionality, find the
program/event you would like to record. Click on it, then using the broadcast
For full instructions on how to search and record using the EPG take a
look at the [EPG](epg) page.
-####Adding an Entry Using Autorec Rules
+###Adding an Entry Using Autorec Rules
Autorec rules allow you to match events using various options.
---
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/play</tvh_include>
-
----
-
###Downloading a Recording
Highlight (select) the desired entry, then press the *[Download]*
This tab controls timer-driven recording rules.
-
+
---
---
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-####Example
+###Example
This is an example of a one-time timer-based recording entry.
-
+
Note that when you create a rule/entry it will also generate a [DVR Entry](class/dvrentry).
---
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
This tab is used to configure the Electronic Program Guide (EPG)
[grabbing](class/epggrab_mod) capabilities.
-
+
---
This tab displays EPG data used by channels.
-
+
---
**Delete** | Delete the selected grid entries.
**Edit** | Edit the selected grid entries.
-<tvh_include>inc/common_button_table_end</tvh_include>
-
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
---
grabbing mechanisms. These fall into 3 broad categories, within which
there are a variety of specific grabber implementations.
-
+
---
This tab allows you to define rules that filter and order various
elementary streams.
-
+
---
---
-<tvh_include>inc/add_grid_entry</tvh_include>
+###Filtering out a Stream
-Below are some examples:
-
-####Filtering out a Stream
-
-
+
Here we're removing the Bulgarian language audio from the
input (first rule). However, if Bulgarian is the only language
available add it back in as a last resort (second rule).
-####Ignoring Unknown Streams
+###Ignoring Unknown Streams
If you'd like to ignore unknown elementary streams, add a rule to the
end of grid with the *ANY* (not defined) comparison(s) and the
action set to *IGNORE*.
---
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
multi-client systems and, generally, to reduce hits on upstream
providers.
-
+
---
This tab allows to configure blocked IP ranges. Users within these ranges
are not allowed to login (use any Tvheadend service).
-
+
---
<tvh_include>inc/common_button_table_end</tvh_include>
---
-
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-
-
-**Tip**: You can enter a comma-separated list of network prefixes, if you're
-unsure as to what to enter in the *Network prefix* field take a look at
-[this guide](https://www.ripe.net/about-us/press-centre/understanding-ip-addressing).
-
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
This panel lists all the available Cable (DVB-C/C2/ISDB-C/ATSC-C) frontend
parameters.
-
+
---
This panel lists all the available satellite (DVB-S/ISDB-S) frontend
parameters.
-
+
---
This panel lists all the available Terrestrial (DVB-T/T2/ISDB-T/ATSC-T) frontend
parameters.
-
+
---
also uses the term ‘mux’ to describe a source for multiple IP
streams - so an IP address, in effect.
-
+
---
---
-###Adding an Entry/Mux
-
-To add a mux press the *[Add]* button from the menu bar and select the
-network you want to add the mux to:
-
-
-
-Then enter the mux information:
-
-
-
-Pressing the *[Save]* button (at the bottom of the dialog)
-will commit your changes and close the dialog, pressing the *[Apply]*
-button will commit your changes but won't close the dialog, pressing
-the *[Cancel]* button closes the dialog - any unsaved changes will be
-lost.
-
-Note: You only really need to add muxes if the pre-defined list didn't
-work, e.g. because of out-of-date data as broadcasters re-arrange their
-services or because automatic detection (network discovery) hasn't
-successfully found all the muxes over time.
-
-**Tips**:
-* If you're not sure what to enter here, take a look at the "If Necessary,
-Manually Add Muxes" section on the [Configure Tvheadend](configure_tvheadend)
-page.
-* Some tuners (or drivers) require more tuning parameters than
-others so be sure to enter as many tuning parameters as possible.
-* Newly added muxes are automatically set to the *PEND* state.
-* Tvheadend won't scan the newly added mux instantly, it can take up to
-10 minutes to begin an initial scan.
-
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-###Deleting an Entry/Mux
-
-To delete a mux highlight (select) the desired muxes from within the
-grid, and press the *[Delete]* button from the menu bar.
-
-Deleting a mux will also remove any associated services, including
-those mapped to channels. If you have network discovery enabled any
-previously deleted muxes found in the NIT during a scan will
-automatically be re-added.
-
-<tvh_include>inc/selecting_entries_tip</tvh_include>
-
-<tvh_include>inc/paging_tip</tvh_include>
-
----
-
<tvh_include>inc/play</tvh_include>
---
Mux Schedulers enable Tvheadend to automatically play channels. This is
useful to get EPG, services or access rights updates.
-
-
----
-
-<tvh_include>inc/common_button_table_start</tvh_include>
-
-<tvh_include>inc/common_button_table_end</tvh_include>
-
----
-
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-
-
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
+
---
Click the desired network type (above) to see all available
[parameters](#items).
-
+
---
---
-###Adding an Entry/Network
-
-To create a network click the *[Add]* button from the menu bar and
-then select the required network type:
-
-
-
-Then using the resultant dialog enter/select the desired network
-options.
-
-
-
-Once you're happy with what you've entered into the dialog you can save
-the network using the *[Save]* button (closing the dialog), save your
-pending changes and continue making further adjustments by pressing the
-*[Apply]* button, or cancel any unsaved changes (and close the dialog)
-by pressing the *[Cancel]* button.
-
-**Notes**:
-
-* Once you've created a network (and added muxes) you must assign it to
-an **enabled** adapter.
-* There is a 5-10 minute delay before a scan starts, this is so you can
-make changes if needed (this does not apply to IPTV networks).
-
-For more detailed information on networks and how to set them up, see
-[Configure Tvheadend.](configure_tvheadend)
-
----
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
-
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
###Force Scanning
-Highlight (select) the network(s) you would like to force scan, and
-then press the "Force Scan" button from the menu bar.
-
Force scanning can take some time. You may continue to use Tvheadend
while a scan is in progress, but doing so will increase the time needed
for it to complete. Note that the time required can vary depending on a
number of factors, such as how many tuners you have available and the
number of muxes on each.
-<tvh_include>inc/selecting_entries_tip</tvh_include>
-
-<tvh_include>inc/paging_tip</tvh_include>
-
---
Services are automatically pulled from muxes and can be mapped to Channels.
-
+
---
There are a number of methods to mapping available services,
mapping uses the following dialog.
- 
+ 
####Mapping All
Press the *[Map services]* button and then *[Map all services]*.
-
+
The [Map services to channels](class/service_mapper) will now be displayed with **all** services
checked - feel free to make changes. Once you're happy with the selection press the "Map services" button, you will
once you're done selecting press the "Map services" button and
then "Map selected services".
-
+
The [Map services to channels](class/service_mapper) dialog will
now be displayed with the **selected** services checked - feel free to make
[Service Mapper](status_service_mapper) tab which will begin mapping
the selected services to channels.
-<tvh_include>inc/selecting_entries_tip</tvh_include>
-
**Tip**: By default Tvheadend will only show a small selection of
available services - you can increase this by using the paging
selector at the bottom right of the page.
**1)** Find the desired service from within the services grid.
If you have a lot of services you may want to use filtering to limit the
-number of grid entries. You can do this by hovering your mouse over the
-*Service name* column, a down arrow â–¾ should now be visible, clicking
-the arrow will then display a list of options, move your mouse down to
-"Filters" and a text box should then appear, click on it and enter the
-desired service's name.
+number of grid entries.
-
+
-**Tip**: Remember to remove the filter when you're finished (uncheck the
+**Tip**: Remember to remove the filter when you're finished (untick the
check box next to the "Filters" option).
**2)** Double click on the channel field, a drop down listing of all defined
channels will appear, check/uncheck the check box next to the channel
you'd like to associate/disassociate the service with.
-
+
**3)** Press the *[Save]* button from the menu bar, and you're done!
---
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
-
###Service Information
Clicking the 
information icon will display service details.
-
+
---
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).
-
+
---
---
-<tvh_include>inc/add_grid_entry</tvh_include>
-
-####Example
+###Example
This is an example of a password entry.
-
+
Be aware that the username you enter here must match a username/entry in
-the [Access Entries](class/access_entry) tab for it to apply. You may
+the Access Entries tab for it to apply. You may
have multiple password entries for the same username if you wish.
---
-
-<tvh_include>inc/edit_grid_entries</tvh_include>
-
----
-
-<tvh_include>inc/del_grid_entries</tvh_include>
-
----
the [Access Entries](class/access),
DVR Profiles or as parameter for HTTP Streaming.
-
+
* Types
* Built-in
<tvh_include>inc/common_button_table_end</tvh_include>
---
-
-###Add a Profile
-
-To create a new profile press the *[Add]* button from the
-menu bar, you will then be asked to select a profile type.
-
-
-
-Once you've selected a type you can then enter/select the desired options from the
-resultant *Add* dialog.
-
-
-
----
-
-###Edit a Profile
-
-To edit an existing profile, click on it from within the grid, the
-*Parameters* panel should then appear on the right hand side.
-
-**Tips**:
-* Remember to *[Save]* your changes before selecting another config
-from within the grid.
-* You can clone an existing config by clicking the *[Clone]*
-button.
-
----
-
-###Deleting a Profile
-
-Highlight (select) the desired entry from the grid, then press the
-*[Delete]* button from the menu bar.
-
----
This panel displays all available SAT>IP client parameters.
-
+
---
forward mpegts input streams including on-the-fly descrambling to SAT\>IP
clients.
-
+
---
[Service Mapper](status_service_mapper) tab when you press
the *[Map services]* button.
-
+
See [Services](class/mpegts_service) for more details on service mapping.
This tab is used to configure timeshift properties.
-
+
---
The following diagram explains the relationship between these components:
-
+
##Updating the Documentation
-This information was last updated on 11 May 2016.
-
The documentation is written in markdown, and then converted for
direct inclusion to tvheadend binary. The markdown processor in
tvheadend binary adds other information from the internal
The EPG tab displays a filterable grid containing all events, sorted
based on start time.
-
+
---
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.
-
+
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.
+++ /dev/null
-###Adding an Entry
-
-To add an entry click the *[Add]* button from the menu bar, the add
-dialog should now be displayed. Once you've filled in the required/desired
-fields you can then press *[Save]* to add the entry, *[Apply]* to commit
-and continue editing or *[Cancel]* to abort (losing any unsaved changes).
+++ /dev/null
-###Deleting an Entry
-
-Highlight (select) the desired entries in the grid, then press the *[Delete]* button on the
-menu bar.
-
-**Deleting can't be undone. You will be prompted to confirm. **
-
-**Tip**: Rather than deleting an entry, you can disable it instead by
-unchecking the "Enabled" check box (if available).
-
-<tvh_include>inc/selecting_entries_tip</tvh_include>
-
-<tvh_include>inc/paging_tip</tvh_include>
+++ /dev/null
-###Editing an Entry
-
-There are two methods for editing an entry.
-
-####Editing in the Grid
-
-Highlight (select) the desired entry and then..:
-
-* To edit a cell, double click on it.
-* To change a check box or radio button, click once.
-
-After a cell is changed, a small red flag or triangle will appear in
-the top-left corner to indicate that it has been changed. These changes
-can now be kept (*[Save]* button), or abandoned (*[Undo]* button).
-
-<tvh_include>inc/selecting_entries_tip</tvh_include>
-
-<tvh_include>inc/paging_tip</tvh_include>
-
-####Using the *[Edit]* Button
-
-Highlight (select) the entries in the grid that you'd like to edit, then
-click the *[Edit]* button from the menu bar, the edit dialog should now
-be displayed. Note that when editing multiple
-entries there is an additional check box before each setting,
-ticking it will apply that setting to all selected entries.
-After you've finished editing an entry you can save your pending changes
-using the *[Save]* button (closing the dialog), save your changes and continue making
-further adjustments by pressing the *[Apply]* button, or cancel any unsaved
-changes (and close the dialog) by pressing the *[Cancel]* button.
+++ /dev/null
-\n**Tip**: You can select all entries within the grid by pressing ctrl+A.
-You can also ctrl+click to make additional selections, or shift+click to
-select a range.
#Tvheadend 4.2 User Guide
-
+
#Purpose
Tvheadend is a lightweight, easily-configured, general-purpose TV/video
streaming server and recorder (PVR/DVR) for GNU/Linux, FreeBSD and Android.
-
+
It supports input from:
This is a read-only tab; nothing is configurable.
-
+
---
This is a read-only tab; nothing is configurable.
-
+
The [Map services to channels](class/service_mapper) dialog
This is a read-only tab; nothing is configurable.
-
+
---
This is a read-only tab; nothing is configurable.
-
+
---
The adapters and tuners are listed and edited in a tree.
-
+
---
so on related to your device(s) in sections. Clicking on these sections
will display available parameters and device information.
-
+
**Tip**: Remember to save your changes *before* switching panels.
The interface is made up of nested tabs, so similar functions are grouped
together (e.g. all configuration items at the top level, then all configuration
-items for a particular topic are below that).
+items for a particular topic are below that). However, be aware that not all tabs are
+shown by default, some tabs are hidden depending on the current [view level](#view-level).
-Each tab is then typically laid out with a menu bar across the top that
-provides access to Add/Save/Edit-type functions, and a grid like a spreadsheet
-below that. The grid items are frequently editable.
+Each tab is then typically laid out with a menu bar that provides access
+to Add/Save/Edit-type functions, and a grid like a spreadsheet below that.
+The grid items are frequently editable.
Most configuration items - certainly the ones that are common to all types
of item covered by that tab - are in this grid. However, some item-specific
such as FEC rolloff or mux URL are then only in the dialogs for networks
that need these values.
+####View level
+
+The *View level* drop-down/button - next to the Help button,
+displays/hides the more advanced features. By default it is set to Basic.
+
+View level | Description
+----------------------|-------------------------------------------------
+**Basic** | Display the most commonly used tabs/items.
+**Advanced** | Display the more advanced tabs/items.
+**Expert** | Show all tabs/items.
+
+Depending on configuration, the view-level drop-down is not always visible.
+
###Displaying and Manipulating Columns
* Not all columns are necessarily visible. If you hover your mouse over a
* **Re-size** the columns by dragging the very edges of the column header as
required.
-###Editing Fields
-
-* To edit a cell, double click on it. After a cell is changed, a small red
- flag or triangle will appear in the top-left corner to indicate that it
- has been changed. These changes can now be kept (*Save* button), or
- abandoned (*Undo* button).
-
-* To change a check box or radio button, click once.
+* A cookie is used to remember your column/filtering preferences. Clearing
+ your cookies will reset the interface to default.
-* To add a new entry, press the *Add* button. The new (empty) entry will
- be created on the server but will not be saved and will not necessarily
- be enabled. You can now change all the cells to the desired values, check
- the ‘enable’ box if applicable and then press *Save* to activate the new
- entry.
+###Adding, Editing and More
-* Most rows are multi-selectable, so you can carry out certain actions on
+* Rows (in the grid) are multi-selectable, so you can carry out certain actions on
more than one entry at the same time. So, for example, you can select
- multiple items by using ctrl+click on each
- entry or click, shift+click to select a range.
+ multiple items by using ctrl+click on each entry or click,
+ shift+click to select a range, or ctrl+A to select all.
+
+* To add an entry, click the *Add* button from the menu bar. You'll then
+ see a dialog, or in some cases (where a list/split panel is used), a
+ parameter panel. You can now fill in the desired/required fields, the
+ entry can then be saved (*Create/Save* button), applied (*Apply* button),
+ or abandoned (*Cancel button).
+
+* To edit a single entry in the grid, double click on the desired field/cell.
+ It should now be editable. Once you've made your changes you can then
+ save (*Save* button), apply (*Apply* button), or abandon (*Cancel* button)
+ them.
+
+ After a cell is changed, a small red flag or triangle will appear in
+ the top-left corner to indicate that it has been changed.
+
+ To change a check box or radio button, click once.
+
+* To edit multiple entries, select the desired entries (as explained above), and
+ then press the *Edit* button - a dialog will be displayed. You can now make
+ your changes to each field. These changes can then be kept (*Save* button),
+ applied (*Apply* button), or abandoned (*Undo* button). Remember to tick the
+ check box before each field when saving/applying, so that the changes are applied
+ to all selected entries.
+
+* To delete entries, simply select the entry/entries and press the *Delete* button.
+ You will be prompted to confirm deletion.
Option | Description
------------------------|------------
**Default** | Use the default view level value as set in [Base Config](class/config).
-**Basic** | Show basic settings/information.
-**Advanced** | Show more advanced settings/information.
-**Expert** | Show the expert (All) settings/information.
-
-
+**Basic** | Display the most commonly used tabs/items.
+**Advanced** | Display the more advanced tabs/items.
+**Expert** | Show all tabs/items.
--- /dev/null
+../../../../webui/static/icons
\ No newline at end of file
projects / thirdparty / tvheadend.git / commitdiff
