From: Mark Clarkstone Date: Wed, 14 Jun 2017 11:11:08 +0000 (+0100) Subject: mdhelp/markdown: add a space to all headers and fix a few little niggles properties... X-Git-Tag: v4.2.3~20 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=283a54c8c22839f7455f8b1935b9b913eb43942d;p=thirdparty%2Ftvheadend.git mdhelp/markdown: add a space to all headers and fix a few little niggles properties: remove hash (#) from a few .name(s) and change a few others to (hopefully) make them clearer, as well as update a few .desc(s) --- diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md index 49541b1bf..0385d4209 100644 --- a/docs/class/access_entry.md +++ b/docs/class/access_entry.md @@ -35,7 +35,7 @@ Button | Function --- -###Example +### Example This is an example of a limited user entry. @@ -55,7 +55,7 @@ rights, allowing you to enable / disable each as needed. Note, matching --- -###Emergency/Backdoor Access +### Emergency/Backdoor Access Tvheadend includes functionality that allows you to regain access to your Tvheadend instance in case of emergency or if you find yourself @@ -84,7 +84,7 @@ is able to read the superuser file. --- -###Anonymous Access +### Anonymous Access If you would like to allow anonymous access to your Tvheadend server you may set-up a wildcard account, you can do this by creating a new diff --git a/docs/class/bouquet.md b/docs/class/bouquet.md index c548b294f..67c966eb6 100644 --- a/docs/class/bouquet.md +++ b/docs/class/bouquet.md @@ -31,7 +31,7 @@ Button | Function --- -###Example +### Example !['Add Bouquet Dialog'](static/img/doc/bouquet/add.png) @@ -39,7 +39,7 @@ Note that the URL must begin with `file://` or `http(s)://`. --- -###Detaching Channels +### Detaching Channels If you're mapping another service to a channel created by a bouquet you must first detach the channel to prevent unexpected diff --git a/docs/class/caclient.md b/docs/class/caclient.md index e08ba2c1b..8ddaad56e 100644 --- a/docs/class/caclient.md +++ b/docs/class/caclient.md @@ -5,7 +5,7 @@ capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -23,7 +23,7 @@ Button | Function --- -###Available CA types +### Available CA types The following configuration parameters are used, depending on the type of CA access: @@ -37,7 +37,7 @@ of CA access: --- -###Connection Status +### Connection Status The icon next to each entry within the grid indicates the client's connection status. diff --git a/docs/class/caclient_capmt.md b/docs/class/caclient_capmt.md index 4e305e6a4..5a3938935 100644 --- a/docs/class/caclient_capmt.md +++ b/docs/class/caclient_capmt.md @@ -5,7 +5,7 @@ capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -23,7 +23,7 @@ Button | Function --- -###Connection Status +### Connection Status The icon next to each entry within the grid indicates the client's connection status. @@ -36,7 +36,7 @@ Icon | Description --- -###Modes +### Modes #### OSCam net protocol (rev >= 10389) diff --git a/docs/class/channel.md b/docs/class/channel.md index 1803c33b4..a845f88c7 100644 --- a/docs/class/channel.md +++ b/docs/class/channel.md @@ -30,7 +30,7 @@ Numbering Button | Function --- -###Example +### Example !['Add Channel Dialog'](static/img/doc/channel/add.png) diff --git a/docs/class/config.md b/docs/class/config.md index e75022b01..e809097ad 100644 --- a/docs/class/config.md +++ b/docs/class/config.md @@ -5,7 +5,7 @@ the core Tvheadend functionality. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/class/debugging.md b/docs/class/debugging.md index 2a9aead1d..45f369feb 100644 --- a/docs/class/debugging.md +++ b/docs/class/debugging.md @@ -17,7 +17,7 @@ command-line parameters. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -28,7 +28,7 @@ Button | Function --- -###Subsystems +### Subsystems The following options can be passed to tvheadend to provide detailed debugging information while the application is running. diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md index 4104bcbdb..bb26c85cd 100644 --- a/docs/class/dvrautorec.md +++ b/docs/class/dvrautorec.md @@ -10,7 +10,7 @@ This tab controls EPG-driven recording rules. --- -###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: diff --git a/docs/class/dvrconfig.md b/docs/class/dvrconfig.md index e49cb68ce..0fd752fc7 100644 --- a/docs/class/dvrconfig.md +++ b/docs/class/dvrconfig.md @@ -6,7 +6,7 @@ recordings. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index a982c3a65..4af17d94a 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -25,7 +25,7 @@ Entries shown here link to file(s) that Tvheadend cannot locate --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available (tab dependant): @@ -46,7 +46,7 @@ Button | Function --- -###Entry Overview +### Entry Overview The *Details* column gives a quick overview as to the status of each entry: @@ -61,13 +61,13 @@ Icon | Description --- -###Manual Recording Entry Example +### Manual Recording Entry Example This is an example of a one-time recording entry. !['Add new recording dialog'](static/img/doc/dvrentry/add.png) -###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 @@ -80,7 +80,7 @@ details dialog you can: 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. @@ -91,14 +91,14 @@ See [Autorec](class/dvrautorec) for more information. --- -###Downloading a Recording +### Downloading a Recording Highlight (select) the desired entry, then press the *[Download]* button on the menu bar. --- -###Re-recording an Entry/Re-schedule a Recording +### Re-recording an Entry/Re-schedule a Recording You can re-schedule an entry by pressing the *[Re-record]* button on the menu bar. diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md index 6a41d7ab9..87f066ac9 100644 --- a/docs/class/dvrtimerec.md +++ b/docs/class/dvrtimerec.md @@ -10,7 +10,7 @@ This tab controls timer-driven recording rules. --- -###Example +### Example This is an example of a one-time timer-based recording entry. diff --git a/docs/class/epgconf.md b/docs/class/epgconf.md index be19d3a38..514917cd7 100644 --- a/docs/class/epgconf.md +++ b/docs/class/epgconf.md @@ -5,7 +5,7 @@ This tab is used to configure the Electronic Program Guide (EPG) --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/class/epggrabber_channel.md b/docs/class/epggrabber_channel.md index 1f1a9687d..b5ba0d6a4 100644 --- a/docs/class/epggrabber_channel.md +++ b/docs/class/epggrabber_channel.md @@ -4,7 +4,7 @@ This tab displays EPG data used by channels. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/class/epggrabber_modules.md b/docs/class/epggrabber_modules.md index 85ffe0694..d51fa3dd5 100644 --- a/docs/class/epggrabber_modules.md +++ b/docs/class/epggrabber_modules.md @@ -7,7 +7,7 @@ there are a variety of specific grabber implementations. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -20,7 +20,7 @@ Button | Function --- -###Notes +### Notes * Only OTA EIT and PSIP (ATSC) grabbers are enabled by default. If you're missing EPG data, make sure to enable the correct grabber(s) diff --git a/docs/class/filters.md b/docs/class/filters.md index 21f90f87d..6e35962bd 100644 --- a/docs/class/filters.md +++ b/docs/class/filters.md @@ -18,7 +18,7 @@ Button | Function --- -###Filter Basics +### Filter Basics * Each rule is executed in sequence (as displayed in the grid). * If a rule removes a stream, it will not be available to other rules @@ -34,7 +34,7 @@ already selected - it cannot be ignored). --- -###Visual Verification of Filtering +### Visual Verification of Filtering For visual verification of filtering, there is the service info dialog in the [Services](class/mpegts_service) tab. @@ -42,7 +42,7 @@ This dialog shows the received PIDs and filtered PIDs in one window. --- -###Filtering out a Stream +### Filtering out a Stream !['Removing a stream'](static/img/doc/filters/example.png) @@ -50,7 +50,7 @@ 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 diff --git a/docs/class/imagecache.md b/docs/class/imagecache.md index 282b9312e..df62e5059 100644 --- a/docs/class/imagecache.md +++ b/docs/class/imagecache.md @@ -7,7 +7,7 @@ providers. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/class/linuxdvb_frontend_dvbc.md b/docs/class/linuxdvb_frontend_dvbc.md index 5f5e93d39..66fd0e1ab 100644 --- a/docs/class/linuxdvb_frontend_dvbc.md +++ b/docs/class/linuxdvb_frontend_dvbc.md @@ -5,7 +5,7 @@ parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/linuxdvb_frontend_dvbs.md b/docs/class/linuxdvb_frontend_dvbs.md index 7a70047b0..640165ba6 100644 --- a/docs/class/linuxdvb_frontend_dvbs.md +++ b/docs/class/linuxdvb_frontend_dvbs.md @@ -5,7 +5,7 @@ parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/linuxdvb_frontend_dvbt.md b/docs/class/linuxdvb_frontend_dvbt.md index 737582e15..6e39b90f3 100644 --- a/docs/class/linuxdvb_frontend_dvbt.md +++ b/docs/class/linuxdvb_frontend_dvbt.md @@ -5,7 +5,7 @@ parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/linuxdvb_satconf.md b/docs/class/linuxdvb_satconf.md index 068ea84fd..782cafeb5 100644 --- a/docs/class/linuxdvb_satconf.md +++ b/docs/class/linuxdvb_satconf.md @@ -3,7 +3,7 @@ parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/mpegts_network.md b/docs/class/mpegts_network.md index cc984d605..0c1038188 100644 --- a/docs/class/mpegts_network.md +++ b/docs/class/mpegts_network.md @@ -36,7 +36,7 @@ Button | Function --- -###Force Scanning +### Force Scanning 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 @@ -46,7 +46,7 @@ number of muxes on each. --- -###IPTV Automatic Network - Don't Probe Services +### IPTV Automatic Network - Don't Probe Services Tvheadend will by default probe each playlist entry for service information. Some service providers do not allow such probing & will deny (or rate diff --git a/docs/class/mpegts_service.md b/docs/class/mpegts_service.md index ac9cb5b7e..308daefe9 100644 --- a/docs/class/mpegts_service.md +++ b/docs/class/mpegts_service.md @@ -27,14 +27,14 @@ Maintenance Button | Function --- -###Mapping Services to Channels +### Mapping Services to Channels There are a number of methods to mapping available services, mapping uses the following dialog. !['Service mapper dialog'](static/img/doc/service_mapper/dialog.png) -####Mapping All +#### Mapping All Press the *[Map services]* button and then *[Map all services]*. @@ -45,7 +45,7 @@ checked - feel free to make changes. Once you're happy with the selection press then be taken to the [Service Mapper](status_service_mapper) tab which will begin mapping the selected services to channels. -####Mapping Selected +#### Mapping Selected Click on the services you would like to map as channels, once you're done selecting press the "Map services" button and @@ -64,7 +64,7 @@ the selected services to channels. available services - you can increase this by using the paging selector at the bottom right of the page. -####Mapping/Removing a Service to/from an Existing Channel +#### Mapping/Removing a Service to/from an Existing Channel You can map/remove a service to/from an existing channel by doing the following: @@ -88,7 +88,7 @@ you'd like to associate/disassociate the service with. --- -###Service Information +### Service Information Clicking the !['Information Icon'](static/icons/information.png) information icon will display service details. diff --git a/docs/class/passwd.md b/docs/class/passwd.md index 871aa61f7..e33cae016 100644 --- a/docs/class/passwd.md +++ b/docs/class/passwd.md @@ -11,7 +11,7 @@ where you set and maintain all user passwords (e.g. for streaming or DVR access) --- -###Example +### Example This is an example of a password entry. diff --git a/docs/class/profile.md b/docs/class/profile.md index 324652b78..439af7e92 100644 --- a/docs/class/profile.md +++ b/docs/class/profile.md @@ -23,7 +23,7 @@ be available. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/class/satip_client.md b/docs/class/satip_client.md index d943b04e2..a890d8c8c 100644 --- a/docs/class/satip_client.md +++ b/docs/class/satip_client.md @@ -4,7 +4,7 @@ This panel displays all available SAT>IP client parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/satip_frontend.md b/docs/class/satip_frontend.md index d813425d0..7dc1dd20a 100644 --- a/docs/class/satip_frontend.md +++ b/docs/class/satip_frontend.md @@ -3,7 +3,7 @@ DVB-T/DVB-S/DVB-C/ATSC-T/ATSC-C frontend parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/satip_satconf.md b/docs/class/satip_satconf.md index 068ea84fd..782cafeb5 100644 --- a/docs/class/satip_satconf.md +++ b/docs/class/satip_satconf.md @@ -3,7 +3,7 @@ parameters. --- -###Buttons +### Buttons The following buttons are available: diff --git a/docs/class/satip_server.md b/docs/class/satip_server.md index 6774968eb..833c6d37f 100644 --- a/docs/class/satip_server.md +++ b/docs/class/satip_server.md @@ -6,7 +6,7 @@ clients. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -19,7 +19,7 @@ Button | Function --- -###How to Configure Tvheadend as a SAT\>IP Server (Basic Guide) +### How to Configure Tvheadend as a SAT\>IP Server (Basic Guide) **1. Define the RTSP Port** @@ -59,9 +59,9 @@ Hopefully (and if everything went to plan) your client should have now detected Tvheadend as a SAT\>IP server. If not, restart or force it to perform a service discovery. -###Custom M3U Playlist +### Custom M3U Playlist -You may put your custom m3u playlist which is advertised to the clients -to your tvheadend's configuration directory - filename *satip.m3u*. +You may put your custom m3u playlist which is advertised to clients +in your tvheadend's configuration directory - filename *satip.m3u*. --- diff --git a/docs/class/service_mapper.md b/docs/class/service_mapper.md index 64c15d857..d4a3693e8 100644 --- a/docs/class/service_mapper.md +++ b/docs/class/service_mapper.md @@ -9,7 +9,7 @@ See [Services](class/mpegts_service) for more details on service mapping. --- -###Buttons +### Buttons The following functions are available: diff --git a/docs/class/timeshift.md b/docs/class/timeshift.md index 4c9af2e10..6072f7921 100644 --- a/docs/class/timeshift.md +++ b/docs/class/timeshift.md @@ -4,7 +4,7 @@ This tab is used to configure timeshift properties. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/markdown/before_begin.md b/docs/markdown/before_begin.md index 387af8fe1..2c2d143a6 100644 --- a/docs/markdown/before_begin.md +++ b/docs/markdown/before_begin.md @@ -1,9 +1,9 @@ -##Before You Begin +## Before You Begin There are some basic concepts that will make life much easier if you understand them from the outset. -###Hardware/Software Fundamentals +### Hardware/Software Fundamentals * A **tuner** is the hardware (chipset) needed to interpret a digital television signal and extract from it the programme stream. The tuner hardware @@ -24,7 +24,7 @@ sends to the tuner upon initialisation. This is the cause of more problems than you'd imagine... if you find yourself in trouble, this is the first thing to check along with kernel support for your hardware. -###Application/Tvheadend Fundamentals +### Application/Tvheadend Fundamentals The Tvheadend software then sets up a series of configuration elements, and the way in which these interact determines how a TV signal ends up in front @@ -52,7 +52,7 @@ catch-up IPTV services. and your client software think in terms of: _"I'd like to watch BBC One now, please"_. -###Why The Complexity? +### Why The Complexity? Simply, because 'BBC One' might exist in many different places... it might have regional variations on multiple frequencies (so different services diff --git a/docs/markdown/cmdline_options.md b/docs/markdown/cmdline_options.md index 3cd2401eb..01ad44ee1 100644 --- a/docs/markdown/cmdline_options.md +++ b/docs/markdown/cmdline_options.md @@ -1,14 +1,14 @@ -##Command-line Options +## Command-line Options Usage: `tvheadend [OPTIONS]` -###Generic options +### Generic options ``` -h, --help Show this page -v, --version Show version information ``` -###Service configuration +### Service configuration ``` -c, --config Alternate configuration path -B, --nobackup Don't backup configuration tree at upgrade @@ -30,7 +30,7 @@ Usage: `tvheadend [OPTIONS]` --nosatip Disable SAT>IP client --satip_xml URL with the SAT>IP server XML location ``` -###Server connectivity +### Server connectivity ``` -6, --ipv6 Listen on IPv6 -b, --bindaddr Specify bind address @@ -41,7 +41,7 @@ Usage: `tvheadend [OPTIONS]` --useragent Specify User-Agent header for the http client --xspf Use XSPF playlist instead of M3U ``` -###Debug options +### Debug options ``` -d, --stderr Enable debug on stderr -n, --nostderr Disable debug on stderr @@ -60,7 +60,7 @@ Usage: `tvheadend [OPTIONS]` --nobat Disable DVB bouquets -j, --join Subscribe to a service permanently ``` -###Testing options +### Testing options ``` --tsfile_tuners Number of tsfile tuners --tsfile tsfile input (mux file) diff --git a/docs/markdown/configure_tvheadend.md b/docs/markdown/configure_tvheadend.md index 18cc0756e..ad4a76f3e 100644 --- a/docs/markdown/configure_tvheadend.md +++ b/docs/markdown/configure_tvheadend.md @@ -1,4 +1,4 @@ -##Configure Tvheadend +## Configure Tvheadend This section gives a high-level overview of the steps needed to get Tvheadend up and running. For more detailed information, please consult the rest of @@ -8,7 +8,7 @@ Tvheadend interface so you know where to look. You can also consult the in-application help text, which mirrors this guide to a very great extent. -###1. Ensure Tuners are Available for Use +### 1. Ensure Tuners are Available for Use **Tvheadend web interface: _Configuration -> DVB Inputs -> TV Adapters_** @@ -23,7 +23,7 @@ is checked in the 'Parameters' list If anything is obviously wrong at this point, you probably have a driver/firmware error which you'll need to resolve before going any further. -###2. Set up Relevant Network(s) +### 2. Set up Relevant Network(s) **Tvheadend web interface: _Configuration -> DVB Inputs -> Networks_** @@ -45,7 +45,7 @@ you may not be able to receive. * Network discovery (enabled by default) increases the likelihood of receiving all available muxes and services. -###3. Associate the Network with the Respective Tuner(s) +### 3. Associate the Network with the Respective Tuner(s) **Tvheadend web interface: _Configuration -> DVB Inputs -> TV Adapters_** @@ -63,7 +63,7 @@ At this point, your tuners now know what networks to use: one network can appear on multiple tuners (many-to-one), and one tuner can have multiple networks. -###4. If Necessary, Manually Add Muxes +### 4. If Necessary, Manually Add Muxes **Tvheadend web interface: _Configuration -> DVB Inputs -> Muxes_** @@ -97,7 +97,7 @@ central and northern Europe You can also use [dvbscan](http://www.linuxtv.org/wiki/index.php/Dvbscan) to force a scan and effectively ask your tuner what it can see. -###5. Scan for Services +### 5. Scan for Services **Tvheadend web interface: _Configuration -> DVB Inputs -> Services_** @@ -111,7 +111,7 @@ and language(s), and so on. (For the technically-minded, these unique identifiers - the elementary streams - are referred to as 'packet identifiers' or 'PIDs'). -###6. Map Services to Channels +### 6. Map Services to Channels **Tvheadend web interface: _Configuration -> DVB Inputs -> Services_** @@ -121,7 +121,7 @@ and language(s), and so on. See [Services](class/mpegts_service) for a detailed look into service mapping. -####6.1. Bouquets +#### 6.1. Bouquets **Tvheadend web interface: _Configuration -> Channel / EPG -> Bouquets_** @@ -131,7 +131,7 @@ and language(s), and so on. If you would like to use bouquets see [Bouquets](class/bouquet). -###7. Watch TV +### 7. Watch TV That's it - you're done. You should now have a working basic Tvheadend installation with channels mapped and ready for use! diff --git a/docs/markdown/doc_about.md b/docs/markdown/doc_about.md index fc3d78897..1df47dd4f 100644 --- a/docs/markdown/doc_about.md +++ b/docs/markdown/doc_about.md @@ -1,4 +1,4 @@ -##About +## About This documentation forms part of the Tvheadend project. @@ -8,13 +8,13 @@ expressly excluded. Use everything entirely at your own risk. If your television explodes, your house burns down or your kittens end up in tears, that's nothing to do with us. -(c) 2006 - 2016 Tvheadend Foundation CIC +(c) 2006 - 2017 Tvheadend Foundation CIC -##Licensing +## Licensing The entire project is currently licensed using [GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt). -##Further Information +## Further Information For more information regarding the project, licensing and contributions, please see: diff --git a/docs/markdown/doc_update.md b/docs/markdown/doc_update.md index 1be10a78c..e9530ef1c 100644 --- a/docs/markdown/doc_update.md +++ b/docs/markdown/doc_update.md @@ -1,4 +1,4 @@ -##Updating the Documentation +## Updating the Documentation The documentation is written in markdown, and then converted for direct inclusion to tvheadend binary. The markdown processor in @@ -10,7 +10,7 @@ in [documentatation repository](https://github.com/tvheadend/tvheadend-documenta fetches the markdown files using the build-in web server and use them as source for mkdocs. -###Instructions For Built-in Help +### Instructions For Built-in Help Change markdown files in `docs/markdown`, `docs/markdown/inc`, `docs/class`, `docs/wizard`, etc. Images are placed in `src/webui/static/img/doc/`. diff --git a/docs/markdown/epg.md b/docs/markdown/epg.md index 8ecadbaae..144ce8f2f 100644 --- a/docs/markdown/epg.md +++ b/docs/markdown/epg.md @@ -1,4 +1,4 @@ -##Electronic Program Guide +## 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 @@ -12,11 +12,11 @@ based on start time. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: -####Filtering (or searching) +#### 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 @@ -62,7 +62,7 @@ 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 +#### Buttons The following buttons are also available: @@ -75,7 +75,7 @@ Button | Function --- -###Grid Items +### Grid Items The main grid items have the following functions: @@ -138,7 +138,7 @@ Icon | Description --- -###Event Details and Recording +### 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 @@ -178,7 +178,7 @@ you can open as many detailed information popups as you want. --- -###Autorecordings +### 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 @@ -191,7 +191,7 @@ channel, tag, or similar. --- -###Watch TV +### 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 @@ -199,21 +199,21 @@ 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) +#### Supported formats (containers) Browser | MPEG-TS | MPEG-PS | Matroska | WebM ------- | :-----: | :-----: | :------: | :--: Google Chrome | ![no](icons/exclamation.png) | ![no](icons/exclamation.png) | ![yes](icons/accept.png) | ![yes](icons/accept.png) Mozilla Firefox | ![no](icons/exclamation.png) | ![no](icons/exclamation.png) | | ![yes](icons/accept.png) -####Supported video codecs +#### Supported video codecs Browser | MPEG2 Video | H.264 | VP8 ------- | :---------: | :---: | :-: Google Chrome | ![no](icons/exclamation.png) | ![yes](icons/accept.png) | ![yes](icons/accept.png) Mozilla Firefox | ![no](icons/exclamation.png) | | ![yes](icons/accept.png) -####Supported audio codecs +#### Supported audio codecs Browser | MPEG2 Audio | Dolby Digital (AC3) | AAC | Vorbis ------- | :---------: | :-----------------: | :-: | :----: diff --git a/docs/markdown/faqs.md b/docs/markdown/faqs.md index 74dc6f886..8b7394985 100644 --- a/docs/markdown/faqs.md +++ b/docs/markdown/faqs.md @@ -20,7 +20,7 @@ This usually happens when Tvheadend is installed incorrectly. As a start, make s Note: The above path only applies to Debian/Ubuntu systems others may differ. -###Q: Why can't I see my tuners in Tvheadend's interface? +### Q: Why can't I see my tuners in Tvheadend's interface? This is normally because they're not installed properly. Check syslog/dmesg (e.g. `dmesg | grep dvb`) and see that you have startup messages that indicate whether or not the tuners have initialized properly. Similarly, check `/dev/dvb` to @@ -29,7 +29,7 @@ see if the block device files (i.e. the files used to communicate with the tuner The other major cause of this issue is when you're running Tvheadend as a user who doesn't have sufficient access to the tuners, such as not being a member of the *video* group. -###Q: Access Tvheadend through HTTP proxy +### Q: Access Tvheadend through HTTP proxy Use '--http_root' directive to specify the alternative http webroot (initial path prefix). The proxy server *MUST* pass this webroot path in the HTTP diff --git a/docs/markdown/features.md b/docs/markdown/features.md index 70a698915..ac22eec8b 100644 --- a/docs/markdown/features.md +++ b/docs/markdown/features.md @@ -1,12 +1,12 @@ -##Features of Tvheadend +## Features of Tvheadend -####SDTV and HDTV support +#### SDTV and HDTV support * H.265 (HEVC), H.264 (MPEG-4 AVC) and MPEG2 video supported. * AC-3, AAC and MP2 audio supported. * DVB subtitles supported. * Teletext subtitles supported. -####Input Sources +#### Input Sources * Satellite signals via DVB-S and DVB-S2 * Terrestrial/Over-the-Air signals via DVB-T, DVB-T2 and ATSC * Cable signals via DVB-C @@ -18,17 +18,17 @@ receive simultaneously all programmes on the current mux. channels irrespective of the underlying carrier (for channels that broadcast on multiple sources). -####Output Targets +#### Output Targets * Local or remote disk, via the built-in digital video recorder. * HTSP (Home TV Streaming Protocol). * HTTP streaming. * SAT>IP server (including on-the-fly descrambling). -####Transcoding Support +#### Transcoding Support * Subject to your system's capabilities, support for on-the-fly transcoding for both live and recorded streams in various formats. -####Digital Video Recorder +#### Digital Video Recorder * Built in video recorder stores recorded programs as Transport Stream (.ts) or Matroska (.mkv) files. * Multiple simultaneous recordings are supported. * All original streams (multiple audio tracks, etc) are recorded. @@ -36,17 +36,17 @@ for both live and recorded streams in various formats. * Create rule sets manually or based on EPG queries. * Multiple DVR profiles that support different target directories, post-processing options, filtering options, etc. -####Electronic Program Guide +#### Electronic Program Guide * Rich EPG support, with data from DVB/OTA, XMLTV (scheduled and socket). * Searchable and filterable from the web user interface. * Results can be scheduled for recording with a single click. -####Rich Browser-Driven Interface +#### Rich Browser-Driven Interface * The entire application is loaded into the browser. * Based on extJS, all pages are dynamic and self-refreshing. * All sorting/filtering is then done in C by the main application for speed. -####Easy to Configure and Administer +#### Easy to Configure and Administer * All setup and configuration is done from the built in web user interface. * All settings are stored in human-readable text files. * Initial setup can be done by choosing one of the pre-defined [linuxtv](http://git.linuxtv.org/cgit.cgi/dtv-scan-tables.git) networks @@ -54,25 +54,25 @@ or manually configured. * Idle scanning for automatic detection of muxes and services. * Support for broadcaster (primarily DVB-S) bouquets for easy channel mapping. -####Multi-User Support +#### Multi-User Support * Access to system features (streaming, administration, configurations) can be configured based on username/password and/or IP address. -####Software-Based CSA Descrambling +#### Software-Based CSA Descrambling * Requires a card server (newcamd and capmt protocol is supported). -####Fully-Integrated with Mainstream Media Players +#### Fully-Integrated with Mainstream Media Players * Movian and Kodi are the main targets. * All channel data, channel groups/tags, EPG and TV streaming is carried over a single TCP connection. -####Mobile/Remote Client Support +#### Mobile/Remote Client Support * As well as the web interface, which is accessible through VPN if required, third-party clients are available for both [Android](https://play.google.com/store/apps/details?id=org.tvheadend.tvhclient&hl=en_GB) and [iOS](https://itunes.apple.com/gb/app/tvhclient/id638900112?mt=8) (other clients may also be available). -####Internationalisation +#### Internationalisation * All text is encoded in UTF-8 to provide full international support. * All major character encodings in DVB are supported (e.g. for localised EPG character sets). * [Web interface internationalization](https://tvheadend.org/projects/tvheadend/wiki/Internationalization) diff --git a/docs/markdown/inc/common_button_table_start.md b/docs/markdown/inc/common_button_table_start.md index 60ba8241c..3d4b8e5bb 100644 --- a/docs/markdown/inc/common_button_table_start.md +++ b/docs/markdown/inc/common_button_table_start.md @@ -1,4 +1,4 @@ -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: diff --git a/docs/markdown/inc/play.md b/docs/markdown/inc/play.md index 1068d4a91..907c8bbfc 100644 --- a/docs/markdown/inc/play.md +++ b/docs/markdown/inc/play.md @@ -1,4 +1,4 @@ -###Playing a Stream/File +### Playing a Stream/File You can play a stream/file by clicking the play icon !['Play Icon Image'](static/icons/control_play.png). This will automatically launch an appropriate player, otherwise you will diff --git a/docs/markdown/index.md b/docs/markdown/index.md index a71da1b43..a7a5ae486 100644 --- a/docs/markdown/index.md +++ b/docs/markdown/index.md @@ -1,8 +1,8 @@ -#Tvheadend 4.2 User Guide +# Tvheadend 4.2 User Guide ![Tvheadend Logo](static/img/doc/index/logo.png) -#Purpose +# Purpose This document is intended to give you a high-level overview of how to set up Tvheadend for the first time. It does not aim to provide a complete description diff --git a/docs/markdown/install_hardware.md b/docs/markdown/install_hardware.md index f654edb08..74e3b9657 100644 --- a/docs/markdown/install_hardware.md +++ b/docs/markdown/install_hardware.md @@ -1,4 +1,4 @@ -##Install Your Tuners +## Install Your Tuners This section will give you some basic ideas on how to get your tuner working with your operating system. However, it's clearly way beyond the scope of @@ -9,7 +9,7 @@ before you hand over any money. There is a discussion about supported hardware on [the Tvheadend forums](https://tvheadend.org/boards/5/topics/5102). -###1. Install the Tuner Hardware +### 1. Install the Tuner Hardware This is obviously a core requirement that's outside of the scope of this guide. @@ -24,7 +24,7 @@ Follow the appropriate installation instructions and, if relevant, the setup instruction (e.g. for SAT>IP, which are effectively small, standalone computers). -####A Note on USB Tuners +#### A Note on USB Tuners USB tuners are cheap, work well and are frequently well-matched to physically-smaller builds (e.g. HTPCs) which simply don't have the internal slots. However, please @@ -39,7 +39,7 @@ bandwidth with the Ethernet port. Don't be surprised if this kind of platform st and/or reports errors in a multi-tuner configuration, especially on high-bandwidth (e.g. HD) streams. -###2. Install Firmware and/or Drivers +### 2. Install Firmware and/or Drivers Similar to the above, Tvheadend can do nothing if your tuners aren't working properly. A good place to check how to set up your tuners is the diff --git a/docs/markdown/install_tvheadend.md b/docs/markdown/install_tvheadend.md index 246a17add..921ae3e95 100644 --- a/docs/markdown/install_tvheadend.md +++ b/docs/markdown/install_tvheadend.md @@ -1,4 +1,4 @@ -##Install Tvheadend +## Install Tvheadend This section tells you how to get hold of the software in the first place, and how to get it onto your system. diff --git a/docs/markdown/markdown_cribsheet.md b/docs/markdown/markdown_cribsheet.md index b00ac840e..374dfc3be 100644 --- a/docs/markdown/markdown_cribsheet.md +++ b/docs/markdown/markdown_cribsheet.md @@ -1,4 +1,4 @@ -##Markdown/Formatting Crib Sheet +## Markdown/Formatting Crib Sheet Some notable items about how formatting is used on this particular site. @@ -6,11 +6,11 @@ In general, **keep it simple**, especially if you're contributing to the pages that get carried over into the web help. The simpler the formatting, the cleaner the conversion, the less tidying up there is afterwards. -###References +### References * Markdown basics: [GitHub mastering markdown](https://guides.github.com/features/mastering-markdown) -###Including Documentation/Items +### Including Documentation/Items You can include documentation/items in other markdown files by using the tvh_class_doc, tvh_include and tvh_class_items tags. @@ -33,7 +33,7 @@ To include multi-use docs (placed in the `docs/markdown/inc/` folder: inc/common_button_table_end ``` -###Paragraphs Versus Definition Lists +### Paragraphs Versus Definition Lists Watch this one - indentation is key. diff --git a/docs/markdown/overview.md b/docs/markdown/overview.md index 790da0b38..fef4e44dd 100644 --- a/docs/markdown/overview.md +++ b/docs/markdown/overview.md @@ -1,6 +1,6 @@ -##Overview of Tvheadend +## Overview of Tvheadend -###Welcome to Tvheadend! +### Welcome to Tvheadend! Tvheadend is a lightweight, easily-configured, general-purpose TV/video streaming server and recorder (PVR/DVR) for GNU/Linux, FreeBSD and Android. diff --git a/docs/markdown/requirements.md b/docs/markdown/requirements.md index d9c18a541..845b57c40 100644 --- a/docs/markdown/requirements.md +++ b/docs/markdown/requirements.md @@ -1,6 +1,6 @@ -##Basic Requirements +## Basic Requirements -###Physical Architecture +### Physical Architecture It's perfectly possible to install and run Tvheadend as a single-seat installation, with the software running on the same system as any client software (e.g. Kodi), @@ -14,7 +14,7 @@ you use SAT>IP or have some other way to transport your TV signal over a LAN, your Tvheadend installation has to live where you can actually connect your tuners. -###System Requirements +### System Requirements Wherever you install it, Tvheadend primarily runs on **Linux** - pre-built binaries are available for most Debian-based distributions (Debian itself, Ubuntu, @@ -45,7 +45,7 @@ have an accurate clock for EPG timers to work, for example, but this can be synchronised from the broadcast signal if you're not in a position to use `ntp` or similar. -###How Lightweight? +### How Lightweight? How about light enough to run on a travel router? Take a look at this [example](https://tvheadend.org/boards/4/topics/16579) from one of our users... diff --git a/docs/markdown/status_connections.md b/docs/markdown/status_connections.md index f9d606b31..b21be118d 100644 --- a/docs/markdown/status_connections.md +++ b/docs/markdown/status_connections.md @@ -1,4 +1,4 @@ -##Status - Connections +## Status - Connections This tab shows information about all active connections. @@ -8,7 +8,7 @@ This is a read-only tab; nothing is configurable. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -18,7 +18,7 @@ Button | Function --- -###Grid Items +### Grid Items The main grid items have the following functions: diff --git a/docs/markdown/status_service_mapper.md b/docs/markdown/status_service_mapper.md index 384ecb5c7..97e53bed7 100644 --- a/docs/markdown/status_service_mapper.md +++ b/docs/markdown/status_service_mapper.md @@ -1,4 +1,4 @@ -##Service Mapper +## Service Mapper This tab shows information about current service mapping activity. @@ -12,7 +12,7 @@ determines how services are mapped. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -22,7 +22,7 @@ Button | Function --- -###Items +### Items **Mapped** : Number of services mapped. diff --git a/docs/markdown/status_stream.md b/docs/markdown/status_stream.md index 1bfbeb0d2..b3c92e69e 100644 --- a/docs/markdown/status_stream.md +++ b/docs/markdown/status_stream.md @@ -1,4 +1,4 @@ -##Status - Stream +## Status - Stream This tab shows information about all currently-open streams. @@ -8,7 +8,7 @@ This is a read-only tab; nothing is configurable. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -18,7 +18,7 @@ Button | Function --- -###Grid Items +### Items The main grid items have the following functions: diff --git a/docs/markdown/status_subscriptions.md b/docs/markdown/status_subscriptions.md index ab11e3b06..0cdb4e8fe 100644 --- a/docs/markdown/status_subscriptions.md +++ b/docs/markdown/status_subscriptions.md @@ -1,4 +1,4 @@ -##Status - Subscriptions +## Status - Subscriptions This tab shows information about all active subscriptions to Tvheadend. @@ -8,7 +8,7 @@ This is a read-only tab; nothing is configurable. --- -###Menu Bar/Buttons +### Menu Bar/Buttons The following functions are available: @@ -18,7 +18,7 @@ Button | Function --- -####Grid Items +#### Items The main grid items have the following functions: diff --git a/docs/markdown/toc.md b/docs/markdown/toc.md index ad979caf3..962862bfd 100644 --- a/docs/markdown/toc.md +++ b/docs/markdown/toc.md @@ -1,4 +1,4 @@ -####Table of Contents +#### Table of Contents [Introduction](index) * [Overview](overview) diff --git a/docs/markdown/todo.md b/docs/markdown/todo.md index a9260ac67..3730fede4 100644 --- a/docs/markdown/todo.md +++ b/docs/markdown/todo.md @@ -1,6 +1,6 @@ -##Things To Do on This Guide... +## Things To Do on This Guide... -####Work-in-progress notes +#### Work-in-progress notes These are not part of the final product, obviously! They're just some of the areas I'm aware of that we need to close off before release diff --git a/docs/markdown/tv_adapters.md b/docs/markdown/tv_adapters.md index ab21440d5..bb299a7e3 100644 --- a/docs/markdown/tv_adapters.md +++ b/docs/markdown/tv_adapters.md @@ -1,4 +1,4 @@ -##DVB Inputs - TV Adapters +## DVB Inputs - TV Adapters The adapters and tuners are listed and edited in a tree. @@ -6,7 +6,7 @@ The adapters and tuners are listed and edited in a tree. --- -###Buttons +### Buttons The following functions are available: @@ -17,7 +17,7 @@ Button | Function --- -###Device Tree +### Device Tree The device tree lists the available frontends, LNB configuration and so on related to your device(s) in sections. Clicking on these sections @@ -29,11 +29,11 @@ will display available parameters and device information. --- -###Device Configuration +### Device Configuration Click on an item to display more information. -####Satellite (DVB-S/ISDB-S) +#### Satellite (DVB-S/ISDB-S) * Frontend - [Master](class/linuxdvb_frontend_dvbs) @@ -51,21 +51,21 @@ Click on an item to display more information. - [Rotor (GOTOX)](class/linuxdvb_rotor_gotox) - [Rotor (USALS)](class/linuxdvb_rotor_usals) -####Terrestrial (DVB-T/ATSC-T/ISDB-T) +#### Terrestrial (DVB-T/ATSC-T/ISDB-T) * Frontend - [DVB-T/DVB-T2](class/linuxdvb_frontend_dvbt) - [ATSC-T](class/linuxdvb_frontend_atsc_t) - [ISDB-T](class/linuxdvb_frontend_isdb_t) -####Cable (DVB-C/ATSC-C/ISDB-C) +#### Cable (DVB-C/ATSC-C/ISDB-C) * Frontend - [DVB-C](class/linuxdvb_frontend_dvbc) - [ATSC-C](class/linuxdvb_frontend_atsc_c) - [ISDB-C](class/linuxdvb_frontend_isdb_c) -####SAT>IP (DVB-T/ATSC-T/ATSC-C/DVB-S) +#### SAT>IP (DVB-T/ATSC-T/ATSC-C/DVB-S) * [Client](class/satip_client) diff --git a/docs/markdown/webui_about.md b/docs/markdown/webui_about.md index 79a62083b..35288c701 100644 --- a/docs/markdown/webui_about.md +++ b/docs/markdown/webui_about.md @@ -1,4 +1,4 @@ -##About +## About This page displays general information about the current Tvheadend version. diff --git a/docs/markdown/webui_general.md b/docs/markdown/webui_general.md index 92f67c41e..ca8233d78 100644 --- a/docs/markdown/webui_general.md +++ b/docs/markdown/webui_general.md @@ -1,11 +1,11 @@ -##General Overview of Web Interface +## General Overview of Web Interface Tvheadend is operated primarily through a tabbed web interface. There are some basic navigation concepts that will help you get around and make the best of it. -###Page Structure +### Page Structure 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 @@ -24,7 +24,7 @@ parameters common to DVB-S, -T, -C and IPTV networks, but specific things such as FEC rolloff or mux URL are then only in the dialogs for networks that need these values. -####View level +#### 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. @@ -37,7 +37,7 @@ View level | Description Depending on configuration, the view-level drop-down is not always visible. -###Displaying and Manipulating Columns +### Displaying and Manipulating Columns * Not all columns are necessarily visible. If you hover your mouse over a column heading, you'll see a down arrow - click here, and a drop-down menu @@ -61,7 +61,7 @@ Depending on configuration, the view-level drop-down is not always visible. * A cookie is used to remember your column/filtering preferences. Clearing your cookies will reset the interface to default. -###Adding, Editing and More +### Adding, Editing and More * 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 @@ -72,12 +72,11 @@ Depending on configuration, the view-level drop-down is not always visible. 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). + 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. + save (*Save* button), apply (*Apply* button), or abandon (*Cancel* button). 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. diff --git a/src/bouquet.c b/src/bouquet.c index c6eb56bd5..a92379f3d 100644 --- a/src/bouquet.c +++ b/src/bouquet.c @@ -1089,7 +1089,7 @@ const idclass_t bouquet_class = { { .type = PT_U32, .id = "services_seen", - .name = N_("# Services seen"), + .name = N_("Services seen"), .desc = N_("Total number of services seen."), .off = offsetof(bouquet_t, bq_services_seen), .opts = PO_RDONLY, @@ -1097,7 +1097,7 @@ const idclass_t bouquet_class = { { .type = PT_U32, .id = "services_count", - .name = N_("# Services"), + .name = N_("Services"), .desc = N_("Total number of services."), .get = bouquet_class_services_count_get, .opts = PO_RDONLY | PO_NOSAVE, diff --git a/src/config.c b/src/config.c index dad2723cc..d4b6b8e24 100644 --- a/src/config.c +++ b/src/config.c @@ -2072,7 +2072,7 @@ const idclass_t config_class = { .id = "server_name", .name = N_("Tvheadend server name"), .desc = N_("Set the name of the server so you can distinguish " - "multiple instances apart on your LAN."), + "multiple instances apart."), .off = offsetof(config_t, server_name), .group = 1 }, @@ -2092,8 +2092,8 @@ const idclass_t config_class = { .type = PT_BOOL, .id = "uilevel_nochange", .name = N_("Persistent user interface level"), - .desc = N_("Prevents users from overriding the above user " - "interface level setting and removes the view level " + .desc = N_("Prevent users from overriding the user " + "interface level setting, and remove the view level " "drop-dowm from the interface."), .off = offsetof(config_t, uilevel_nochange), .opts = PO_ADVANCED, @@ -2270,7 +2270,7 @@ const idclass_t config_class = { .type = PT_STR, .id = "theme_ui", .name = N_("Theme"), - .desc = N_("The default web interface to use if the user's " + .desc = N_("The default web interface to use if the user " " theme isn't set in the Access Entries tab."), .doc = prop_doc_themes, .list = theme_get_ui_list, @@ -2284,7 +2284,7 @@ const idclass_t config_class = { .name = N_("DVB scan files path"), .desc = N_("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 " + "/usr/share/dvb/. Leave blank to use the " "internal file set."), .off = offsetof(config_t, muxconf_path), .notify = config_muxconfpath_notify, diff --git a/src/dvr/dvr_config.c b/src/dvr/dvr_config.c index 13fc9bf13..97523f665 100644 --- a/src/dvr/dvr_config.c +++ b/src/dvr/dvr_config.c @@ -1029,7 +1029,7 @@ const idclass_t dvr_config_class = { .type = PT_STR, .id = "preproc", .name = N_("Pre-processor command"), - .desc = N_("Script/program to be run when a recording starts " + .desc = N_("Script/program to run when a recording starts " "(service is subscribed but no filename available)."), .doc = prop_doc_preprocessor, .off = offsetof(dvr_config_t, dvr_preproc), @@ -1040,7 +1040,7 @@ const idclass_t dvr_config_class = { .type = PT_STR, .id = "postproc", .name = N_("Post-processor command"), - .desc = N_("Script/program to be run when a recording completes."), + .desc = N_("Script/program to run when a recording completes."), .doc = prop_doc_postprocessor, .off = offsetof(dvr_config_t, dvr_postproc), .opts = PO_ADVANCED, @@ -1050,7 +1050,7 @@ const idclass_t dvr_config_class = { .type = PT_STR, .id = "postremove", .name = N_("Post-remove command"), - .desc = N_("Script/program to be run when a recording gets removed."), + .desc = N_("Script/program to run when a recording gets removed."), .doc = prop_doc_postremove, .off = offsetof(dvr_config_t, dvr_postremove), .opts = PO_EXPERT, diff --git a/src/epggrab.c b/src/epggrab.c index 2802f578a..50e80c9c3 100644 --- a/src/epggrab.c +++ b/src/epggrab.c @@ -279,7 +279,7 @@ const idclass_t epggrab_class = { .name = N_("Update channel name"), .desc = N_("Automatically update channel names using " "information provided by the enabled EPG providers. " - "Note: this may cause unwanted changes to " + "Note, this may cause unwanted changes to " "already defined channel names."), .off = offsetof(epggrab_conf_t, channel_rename), .opts = PO_ADVANCED, @@ -291,7 +291,7 @@ const idclass_t epggrab_class = { .name = N_("Update channel number"), .desc = N_("Automatically update channel numbers using " "information provided by the enabled EPG providers. " - "Note: this may cause unwanted changes to " + "Note, this may cause unwanted changes to " "already defined channel numbers."), .off = offsetof(epggrab_conf_t, channel_renumber), .opts = PO_ADVANCED, @@ -303,7 +303,7 @@ const idclass_t epggrab_class = { .name = N_("Update channel icon"), .desc = N_("Automatically update channel icons using " "information provided by the enabled EPG providers. " - "Note: this may cause unwanted changes to " + "Note, this may cause unwanted changes to " "already defined channel icons."), .off = offsetof(epggrab_conf_t, channel_reicon), .opts = PO_ADVANCED, @@ -349,7 +349,7 @@ const idclass_t epggrab_class = { .id = "ota_cron", .name = N_("Over-the-air Cron multi-line"), .desc = N_("Multiple lines of the cron time specification. " - "The default cron triggers the Over-the-air " + "The default cron triggers the over-the-air " "grabber daily at 02:04 and 14:04. See Help on how " "to define your own."), .doc = prop_doc_cron, @@ -361,10 +361,9 @@ const idclass_t epggrab_class = { { .type = PT_U32, .id = "ota_timeout", - .name = N_("EPG scan timeout in seconds (30-7200)"), - .desc = N_("The multiplex (mux) is tuned for this amount of " - "time at most. If the EPG data is complete before " - "this limit, the mux is released sooner."), + .name = N_("EPG scan time-out in seconds (30-7200)"), + .desc = N_("The maximum amount of time a grabber is allowed " + "scan a mux for data (in seconds)."), .off = offsetof(epggrab_conf_t, ota_timeout), .opts = PO_EXPERT, .group = 3, diff --git a/src/epggrab/module.c b/src/epggrab/module.c index 4ffb3a65b..73d9a0c50 100644 --- a/src/epggrab/module.c +++ b/src/epggrab/module.c @@ -154,7 +154,7 @@ const idclass_t epggrab_mod_class = { .type = PT_INT, .id = "priority", .name = N_("Priority"), - .desc = N_("Grabber priority. This option let's you pick which " + .desc = N_("Grabber priority. This option lets you pick which " "EPG grabber's data get used first. Priority is " "given to the grabber with the highest value set here. " "See Help for more info."), diff --git a/src/imagecache.c b/src/imagecache.c index 3a2432aa7..6d4af5717 100644 --- a/src/imagecache.c +++ b/src/imagecache.c @@ -86,7 +86,7 @@ const idclass_t imagecache_class = { .type = PT_BOOL, .id = "enabled", .name = N_("Enabled"), - .desc = N_("Select whether or not to enable caching. Note: " + .desc = N_("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."), diff --git a/src/input/mpegts/mpegts_mux.c b/src/input/mpegts/mpegts_mux.c index 5f4791d62..0b00af164 100644 --- a/src/input/mpegts/mpegts_mux.c +++ b/src/input/mpegts/mpegts_mux.c @@ -615,7 +615,7 @@ const idclass_t mpegts_mux_class = .type = PT_INT, .id = "scan_result", .name = N_("Scan result"), - .desc = N_("The outcome of the last scan performed on this mux."), + .desc = N_("The outcome of the last scan performed."), .off = offsetof(mpegts_mux_t, mm_scan_result), .opts = PO_RDONLY | PO_SORTKEY | PO_DOC_NLIST, .list = mpegts_mux_class_scan_result_enum, @@ -624,9 +624,9 @@ const idclass_t mpegts_mux_class = .type = PT_STR, .id = "charset", .name = N_("Character set"), - .desc = N_("The character set used on this mux. You should " - "not have to change this unless channel names, etc " - " appear garbled."), + .desc = N_("The character set to use/used. You should " + "not have to change this unless channel names " + "and EPG data appear garbled."), .off = offsetof(mpegts_mux_t, mm_charset), .list = dvb_charset_enum, .opts = PO_ADVANCED | PO_DOC_NLIST, @@ -634,17 +634,17 @@ const idclass_t mpegts_mux_class = { .type = PT_INT, .id = "num_svc", - .name = N_("# Services"), - .desc = N_("The total number of services found on this mux."), + .name = N_("Services"), + .desc = N_("The total number of services found."), .opts = PO_RDONLY | PO_NOSAVE, .get = mpegts_mux_class_get_num_svc, }, { .type = PT_INT, .id = "num_chn", - .name = N_("# Channels"), - .desc = N_("The number of services on the mux that are " - "mapped to channels."), + .name = N_("Mapped"), + .desc = N_("The number of services currently mapped to " + "channels."), .opts = PO_RDONLY | PO_NOSAVE, .get = mpegts_mux_class_get_num_chn, }, @@ -659,7 +659,7 @@ const idclass_t mpegts_mux_class = .type = PT_INT, .id = "pmt_06_ac3", .name = N_("AC-3 detection"), - .desc = N_("Use AC-3 detection on the mux."), + .desc = N_("Use AC-3 detection."), .off = offsetof(mpegts_mux_t, mm_pmt_ac3), .def.i = MM_AC3_STANDARD, .list = mpegts_mux_ac3_list, diff --git a/src/profile.c b/src/profile.c index b893fdb30..5e64a67be 100644 --- a/src/profile.c +++ b/src/profile.c @@ -305,7 +305,7 @@ const idclass_t profile_class = .type = PT_BOOL, .id = "enabled", .name = N_("Enabled"), - .desc = N_("Enable/disable the profile."), + .desc = N_("Enable/disable profile."), .off = offsetof(profile_t, pro_enabled), .get_opts = profile_class_enabled_opts, .group = 1, @@ -315,7 +315,7 @@ const idclass_t profile_class = .type = PT_BOOL, .id = "default", .name = N_("Default"), - .desc = N_("Set profile as default."), + .desc = N_("Set as default profile."), .set = profile_class_default_set, .get = profile_class_default_get, .opts = PO_EXPERT, @@ -345,9 +345,9 @@ const idclass_t profile_class = .id = "priority", .name = N_("Default priority"), .desc = N_("If no specific priority was requested. This " - "gives certain users a higher priority by " - "assigning a streaming profile with a higher " - "priority."), + "gives certain users a higher priority by " + "assigning a streaming profile with a higher " + "priority."), .list = profile_class_priority_list, .off = offsetof(profile_t, pro_prio), .opts = PO_SORTKEY | PO_ADVANCED, @@ -358,7 +358,7 @@ const idclass_t profile_class = .type = PT_INT, .id = "fpriority", .name = N_("Force priority"), - .desc = N_("Force the stream profile to use this priority."), + .desc = N_("Force profile to use this priority."), .off = offsetof(profile_t, pro_fprio), .opts = PO_EXPERT, .group = 1 @@ -387,7 +387,7 @@ const idclass_t profile_class = { .type = PT_BOOL, .id = "contaccess", - .name = N_("Continue even if descrambling fails"), + .name = N_("Continue if descrambling fails"), .desc = N_("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."), @@ -1937,11 +1937,13 @@ const idclass_t profile_transcode_class = .type = PT_STR, .id = "src_vcodec", .name = N_("Source video codec"), - .desc = N_("Transcode video only if source video codec mattch. " - "\"Any\" will ingnore source vcodec check and always do transcode. " - "Separate codec names with coma. " - "If no codec match found - transcode with \"copy\" codec, " - "if match found - transcode with parameters in this profile."), + .desc = N_("Transcode video only if source video codec matches. " + "\"Any\" ignores source video codec checking and " + "always transcodes. If no codec match is found, " + "transcoding is done using the \"copy\" codec. " + "if a match is found, transcode with the " + "parameters in this profile. Separate codec names " + "with comma."), .off = offsetof(profile_transcode_t, pro_src_vcodec), .def.i = SCT_UNKNOWN, .list = profile_class_src_vcodec_list, @@ -1976,7 +1978,7 @@ const idclass_t profile_transcode_class = .id = "vbitrate", .name = N_("Video bitrate (kb/s) (0=auto)"), .desc = N_("Bitrate to use for the transcode. See Help for " - "detailed information."), + "details."), .off = offsetof(profile_transcode_t, pro_vbitrate), .opts = PO_ADVANCED, .def.u32 = 0, @@ -1998,7 +2000,7 @@ const idclass_t profile_transcode_class = .type = PT_U32, .id = "abitrate", .name = N_("Audio bitrate (kb/s) (0=auto)"), - .desc = N_("Audio birate to use for transcoding."), + .desc = N_("Audio bitrate to use for transcoding."), .off = offsetof(profile_transcode_t, pro_abitrate), .opts = PO_ADVANCED, .def.u32 = 0, diff --git a/src/satip/server.c b/src/satip/server.c index c00435b72..512eef6c8 100644 --- a/src/satip/server.c +++ b/src/satip/server.c @@ -668,7 +668,7 @@ const idclass_t satip_server_class = { .type = PT_BOOL, .id = "satip_rewrite_pmt", .name = N_("Rewrite PMT"), - .desc = N_("Rewrite Program Association Table (PMT) packets " + .desc = N_("Rewrite Program Map Table (PMT) packets " "to only include information about the currently " "streamed service."), .off = offsetof(struct satip_server_conf, satip_rewrite_pmt), diff --git a/src/service_mapper.c b/src/service_mapper.c index f4784ecb8..db3667f78 100644 --- a/src/service_mapper.c +++ b/src/service_mapper.c @@ -505,8 +505,10 @@ static const idclass_t service_mapper_conf_class = { .type = PT_BOOL, .id = "check_availability", .name = N_("Check availability"), - .desc = N_("Check service availability (add live services " - "only)."), + .desc = N_("Check services for availability. If enabled, " + "services that are not currently broadcasting (or " + "can't be decrypted) will be ignored. Leave disabled " + "if you want Tvheadend to also map offline services."), .off = offsetof(service_mapper_t, d.check_availability), .opts = PO_ADVANCED }, @@ -522,7 +524,7 @@ static const idclass_t service_mapper_conf_class = { .type = PT_BOOL, .id = "merge_same_name", .name = N_("Merge same name"), - .desc = N_("Merge services with the same name to one channel."), + .desc = N_("Merge services with the same name into one channel."), .off = offsetof(service_mapper_t, d.merge_same_name), }, { diff --git a/src/timeshift.c b/src/timeshift.c index 2358a68b1..671986995 100644 --- a/src/timeshift.c +++ b/src/timeshift.c @@ -198,9 +198,6 @@ const idclass_t timeshift_conf_class = { .type = PT_BOOL, .id = "ondemand", .name = N_("On-demand (no first rewind)"), - /*.desc = N_("Use timeshift only on-demand. It is started when the first request " - "to move in the playback time occurs (fast-forward, rewind, goto)."), - */ .desc = N_("Only activate timeshift when the client makes the first " "rewind, fast-forward or pause request. Note, " "because there is no buffer on the first request " @@ -253,7 +250,7 @@ const idclass_t timeshift_conf_class = { .id = "ram_size", .name = N_("Maximum RAM size (MB)"), .desc = N_("The maximum RAM (system memory) size for timeshift " - "buffers. When free RAM buffers are available, they " + "buffers. When free RAM buffers are available they " "are used for timeshift data in preference to using " "storage."), .set = timeshift_conf_class_ram_size_set, @@ -276,7 +273,7 @@ const idclass_t timeshift_conf_class = { .name = N_("RAM only"), .desc = N_("Keep timeshift buffers in RAM only. " "With this option enabled, the amount of rewind time " - "is limited by how much RAM Tvheadend is allowed."), + "is limited by how much RAM TVHeadend is allowed."), .off = offsetof(timeshift_conf_t, ram_only), .opts = PO_ADVANCED, }, diff --git a/src/tvhlog.c b/src/tvhlog.c index a6af03fbf..66941ea68 100644 --- a/src/tvhlog.c +++ b/src/tvhlog.c @@ -720,10 +720,9 @@ const idclass_t tvhlog_conf_class = { { .type = PT_STR, .id = "path", - .name = N_("Debug log path"), - /* Should this really be called Debug log path? Don't you need to - * enter a filename here not just a path? */ - .desc = N_("Enter a filename you want to save the debug log to."), + .name = N_("Filename (including path)"), + .desc = N_("Enter the filename (including path) where " + "Tvheadend should write the log."), .get = tvhlog_class_path_get, .set = tvhlog_class_path_set, .group = 1,