From 7764b5618ee98ef2d8953ff780f2001206172571 Mon Sep 17 00:00:00 2001 From: "Andrew C. Martin" Date: Thu, 21 Feb 2013 20:49:29 -0700 Subject: [PATCH] documentation updates - fix typos/misspellings in documentation - fix broken link on how to build Tvheadend - standardize on most commonly used capitalization of "Tvheadend" - update copyright year to 2013 - break up the handful of run-on lines --- docs/html/config_access.html | 4 +-- docs/html/config_channels.html | 4 +-- docs/html/config_dvb.html | 32 ++++++++++----------- docs/html/config_epggrab.html | 51 ++++++++++++++++++++++++--------- docs/html/config_timeshift.html | 2 +- docs/html/epg.html | 2 +- docs/html/features.html | 2 +- docs/html/install.html | 4 +-- docs/html/overview.html | 2 +- docs/html/sysreq.html | 13 +++++---- 10 files changed, 70 insertions(+), 46 deletions(-) diff --git a/docs/html/config_access.html b/docs/html/config_access.html index 0eddf860..ef6c5fcb 100644 --- a/docs/html/config_access.html +++ b/docs/html/config_access.html @@ -6,7 +6,7 @@ wide open.

-When Tvheadend verifies access is scan thru all the enabled access control entries. +When Tvheadend verifies access is scan through all the enabled access control entries. The permission flags 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. @@ -42,7 +42,7 @@ The columns have the following functions:

Username
Name of user, if no username is needed for match it should contain a - single asterix (*). + single asterisk (*).
Password
diff --git a/docs/html/config_channels.html b/docs/html/config_channels.html index 022dbe59..5062c39e 100644 --- a/docs/html/config_channels.html +++ b/docs/html/config_channels.html @@ -3,7 +3,7 @@
- The channels are listed / edited in a grid. + The channels are listed / edited in a grid.
  • To edit a cell, double-click on it. After a cell is changed it @@ -37,7 +37,7 @@ player.
    EPG Grab Source -
    Name of the Internet based EPG provider (typically XMLTV) channel +
    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 diff --git a/docs/html/config_dvb.html b/docs/html/config_dvb.html index a772da80..1f713325 100644 --- a/docs/html/config_dvb.html +++ b/docs/html/config_dvb.html @@ -53,7 +53,7 @@ This will attempt to close all available device handles. This can be necessary to allow some devices to go into low power states.
    - However this option has been known to cause problems with some multi tuner + However, this option has been known to cause problems with some multi-tuner DVB cards. If you have signal problems, try disabling this option.
    Note: this option has no effect if idle scanning is enabled. @@ -110,8 +110,8 @@
    Turn off LNB when idle
    This option can be enabled to disable the power to the LNB when the adapter - is not in use. This can reduce power consumption, however for poorly shieled - multi tuner setups you may some inteference when the LNB is re-enabled. + is not in use. This can reduce power consumption, however for poorly shielded + multi-tuner setups you may have some interference when the LNB is re-enabled. @@ -143,25 +143,25 @@ temporary broken
    Network -
    Network name as given in the DVB stream. Can not be changed +
    Network name as given in the DVB stream. Cannot be changed
    Frequency -
    Center frequency for the mux. Can not be changed +
    Center frequency for the mux. Cannot be changed
    Modulation -
    Information about the modulation used on the mux. Can not be changed +
    Information about the modulation used on the mux. Cannot be changed
    Polarisation -
    Information about the polarisation used on the mux. Can not be changed +
    Information about the polarisation used on the mux. Cannot be changed
    Satellite config (DVB-S only) -
    The satellite configuration in use on this mux. Can not be changed. +
    The satellite configuration in use on this mux. Cannot be changed.
    Frontend status -
    The status of the frontend signal last time the mux was tuned. Can not be changed +
    The status of the frontend signal last time the mux was tuned. Cannot be changed
    Mux id -
    Unique ID for this mux in the dvb network. Can not be changed +
    Unique ID for this mux in the dvb network. Cannot be changed
    Quality
    Tvheadend's estimated quality for the mux. @@ -180,7 +180,7 @@ 'Save changes' button. In order to change a Checkbox cell you only have to click once in it. -
  • Service can not be deleted since they are directly inherited / +
  • Service cannot be deleted since they are directly inherited / discovered from a mux they will reappear in just a few seconds should one delete them.
@@ -194,7 +194,7 @@ temporary broken
Service name -
Service name as given in the DVB stream. Can not be changed +
Service name as given in the DVB stream. Cannot be changed
Play
Open the VLC plugin window to play this service. @@ -210,13 +210,13 @@ charset to use when none is specified by the broadcaster.
EPG -
Uncheck this if EPG data should not be retreived for this service. +
Uncheck this if EPG data should not be retrieved for this service.
Type -
Type of service. Can not be changed +
Type of service. Cannot be changed
Provider -
Provider as given in the DVB stream. Can not be changed +
Provider as given in the DVB stream. Cannot be changed
Network
Network name for the mux this service resides on @@ -259,7 +259,7 @@
Port number to select for this configuration (numbering begins at 0).
In DiSEqC 1.0/2.0 mode, ports 0-3 are valid.
In DiSEqC 1.1/2.1 mode, ports 0-63 are valid. -
Use numbers 0-3 for LNBs behind first input on the uncommited switch, +
Use numbers 0-3 for LNBs behind first input on the uncommitted switch, then 4-7 and so on to support up to 64 ports using DiSEqC 1.1/2.1.
LNB type diff --git a/docs/html/config_epggrab.html b/docs/html/config_epggrab.html index 222e4ce6..2eda58ef 100644 --- a/docs/html/config_epggrab.html +++ b/docs/html/config_epggrab.html @@ -1,28 +1,51 @@

- This tab is used to configure 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. + 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.

Grabber Types

    -
  • Over-the-Air (OTA) - These grabbers receive EPG data directly from the DVB network. This is often the easiest way to get up and running and does provide timely updates should scheduling change. However the information isn't always as rich as some of the other grabbers. -
  • Internal - These are grabbers which can be internally initiated from within TVheadend using a very simple scheduler. These are typically Internet based services. This can be a quick way to get richer EPG data where you don't have decent OTA support. -
  • External - These provide the option to run grabber scripts externally and to send data into TVheadend via Unix domain sockets. It provides the ability to run more complex configurations using things like cronjob's, script chains, etc. +
  • Over-the-Air (OTA) - These grabbers receive EPG data directly from the + DVB network. This is often the easiest way to get up and running and does + provide timely updates should scheduling change. However, the information + isn't always as rich as some of the other grabbers. +
  • Internal - These are grabbers which can be internally initiated from + within Tvheadend using a very simple scheduler. These are typically + Internet-based services. This can be a quick way to get richer EPG data + where you don't have decent OTA support. +
  • External - These provide the option to run grabber scripts externally and + to send data into Tvheadend via Unix domain sockets. It provides the ability + to run more complex configurations using things like cronjob's, script + chains, etc.

Grabber Modules

    -
  • EIT - This is a DVB standards compatible EIT grabber. Typically it will - retrieve now/next information, though on some networks there may be more +
  • EIT - This is a DVB standards compatible EIT grabber. Typically it + will retrieve now/next information, though on some networks there may be more extensive data published. -
  • Freesat/view - This is an extended version of EIT that is used by the Free-to-air DVB providers in the UK. It includes additional information such as series links and episode identifiers. -
  • OpenTV - This is a proprietary OTA EPG grabber. Its known to be used on the SKY networks, but others may use it. You need two configuration files to define settings for your particular network, if you don't see yours listed please visit IRC #hts for help. -
  • XMLTV - This is am Internet based suite of scripts, for more information about XMLTV please visit http://www.xmltv.org. To make use of the internal XMLTV grabber you typically require the xmltv-utils package to be installed. If you install new grabbers you will need to restart TVheadend to pick these up as they're loaded at startup. If you see no XMLTV grabbers listed then most probably XMLTV is not properly installed and in the PATH. -
  • PyEPG - This is another Internet based scraper. It currently only supports the Atlas UK system (for which you need a key), but it does provide a very rich EPG data set. For more information see http://github.com/adamsutton/PyEPG.
    • +
  • Freesat/view - This is an extended version of EIT that is used by the + Free-to-air DVB providers in the UK. It includes additional information such + as series links and episode identifiers. +
  • OpenTV - This is a proprietary OTA EPG grabber. It's known to be used on + the SKY networks, but others may use it. You need two configuration files to + define settings for your particular network, if you don't see yours listed + please visit IRC #hts for help. +
  • XMLTV - This is am Internet-based suite of scripts, for more information + about XMLTV please visit http://www.xmltv.org. + To make use of the internal XMLTV grabber you typically require the xmltv-utils + package to be installed. If you install new grabbers you will need to + restart Tvheadend to pick these up as they're loaded at startup. If you see + no XMLTV grabbers listed then most probably XMLTV is not properly installed + and in the PATH. +
  • PyEPG - This is another Internet-based scraper. It currently only + supports the Atlas UK system (for which you need a key), but it does provide + a very rich EPG data set. For more information see + http://github.com/adamsutton/PyEPG.

Configuration options

@@ -46,7 +69,7 @@
Select which internal grabber to use.
Grab interval -
Time period between grabs. Value and unit are indepdently set. +
Time period between grabs. Value and unit are independently set.

Over-the-air Grabbers

diff --git a/docs/html/config_timeshift.html b/docs/html/config_timeshift.html index bf1e6052..c664a986 100644 --- a/docs/html/config_timeshift.html +++ b/docs/html/config_timeshift.html @@ -14,7 +14,7 @@ you cannot rewind the buffer (it always begins on the currently playing frame). - Without this option there will be a permanent, cicular, buffer upto + Without this option there will be a permanent, circular, buffer up to the limits defined below.
Storage Path: diff --git a/docs/html/epg.html b/docs/html/epg.html index c11bc718..13118c8f 100644 --- a/docs/html/epg.html +++ b/docs/html/epg.html @@ -62,7 +62,7 @@ sorted based on start time. [Record series] button that will record all entries in the series.

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

diff --git a/docs/html/features.html b/docs/html/features.html index b1760939..7e7dc8ff 100644 --- a/docs/html/features.html +++ b/docs/html/features.html @@ -16,7 +16,7 @@

Multicasted IPTV.
Both raw transport streams in UDP and transport stream in RTP in UDP - is supported. The precense of RTP is autodetected. + is supported. The presence of RTP is autodetected.
Analog TV
diff --git a/docs/html/install.html b/docs/html/install.html index a6fc34af..569ee74b 100644 --- a/docs/html/install.html +++ b/docs/html/install.html @@ -38,7 +38,7 @@ Parts of this documentation is also available in the Tvheadend man page. access to all features / settings in the web user interface. If this is the first time you setup Tvheadend you are most encouraged to enter the web user interface, selected the 'Configuration' + 'Access Control' - tab and make reasonable changes. Futher help / documentation can be obtained + tab and make reasonable changes. Further help / documentation can be obtained inside the web interface.
Settings storage @@ -47,7 +47,7 @@ Parts of this documentation is also available in the Tvheadend man page.
Logging
- All activity inside tvheadend is logged to syslog using log facility. + All activity inside Tvheadend is logged to syslog using log facility. Also, if logged in to the web interface you will receive the same log in the bottom tab (System log). diff --git a/docs/html/overview.html b/docs/html/overview.html index 437dab8c..735f95c9 100644 --- a/docs/html/overview.html +++ b/docs/html/overview.html @@ -4,7 +4,7 @@

HTS Tvheadend 3.2

-© 2006 - 2012, Andreas Öman, et al.

+© 2006 - 2013, Andreas Öman, et al.

diff --git a/docs/html/sysreq.html b/docs/html/sysreq.html index 0f908e07..bf365f79 100644 --- a/docs/html/sysreq.html +++ b/docs/html/sysreq.html @@ -1,16 +1,17 @@

-If you want to build tvheadend from source, please visit -this page. -Please notice that wiki development site only reflects the work +If you want to build Tvheadend from source, please visit +this page. +Please note: that wiki development site only reflects the work in HEAD (-current). It should not deviate much should you want to build a released version from source, but you never know.

-Tvheadend is part of the HTS project hosted at -http://hts.lonelycoder.com/. +Tvheadend is part of the HTS project and is hosted at +https://www.lonelycoder.com/redmine/projects/tvheadend.

-It functions primarily as a TV backend for the Showtime Media player but +It functions primarily as a TV backend for the Showtime Media player, but can be used standalone for other purposes.