Difference between revisions of "MythUtil-Channel-visibility"

From MythTV Official Wiki
Jump to: navigation, search
m (update references)
(initial (non-stub) doc)
Line 1: Line 1:
 
'''MythUtil-Channel-visibility''' is a python script which is part of a set of related utility scripts ([[MythUtil-Channel-XMLTV-getLineup]] [[MythUtil-Channel-videosource]] [[MythUtil-Channel-HDHR-channelCheck]] [[MythUtil-Channel-HDHR-visibilityCheck]] [[MythUtil-Channel-visibility]]) that may be useful for users to maintain their channel lineup.
 
'''MythUtil-Channel-visibility''' is a python script which is part of a set of related utility scripts ([[MythUtil-Channel-XMLTV-getLineup]] [[MythUtil-Channel-videosource]] [[MythUtil-Channel-HDHR-channelCheck]] [[MythUtil-Channel-HDHR-visibilityCheck]] [[MythUtil-Channel-visibility]]) that may be useful for users to maintain their channel lineup.
 +
 +
The definitive source location for this script is located on [https://github.com/garybuhrmaster/MythUtil github], which is where one should obtain the current script.
 +
 +
'''MythUtil-Channel-visibiliy''' supports setting the MythTV lineup channel visibility.
 +
 +
==Usage:==
 +
  MythUtil-Channel-visibility [-h] [--backend BACKEND] [--port PORT]
 +
                              [--username USERNAME] [--password PASSWORD]
 +
                              (--videosource-name SOURCENAME | --videosource-id SOURCEID)
 +
                              [--channel CHANNELINCLUDE [CHANNELINCLUDE ...]]
 +
                              [--exclude-channel CHANNELEXCLUDE [CHANNELEXCLUDE ...]]
 +
                              [--force-visible | --force-invisible]
 +
                              [--update]
 +
 +
==Optional arguments:==
 +
  -h, --help            show this help message and exit
 +
  --backend BACKEND, --host BACKEND
 +
                        the host (backend) to access. The default is localhost.
 +
  --port PORT          the port to connect to on on the host. The default is 6544
 +
  --username USERNAME  the username to use for host authentication
 +
  --password PASSWORD  the password to use for host authentication
 +
  --videosource-name SOURCENAME
 +
                        the video source name
 +
  --videosource-id SOURCEID
 +
                        the video source id
 +
  --channel CHANNELINCLUDE [CHANNELINCLUDE ...], --channels CHANNELINCLUDE [CHANNELINCLUDE ...], --include-channel CHANNELINCLUDE [CHANNELINCLUDE ...], --include-channels CHANNELINCLUDE [CHANNELINCLUDE ...]
 +
                        list of channels to consider. The default is all
 +
  --exclude-channel CHANNELEXCLUDE [CHANNELEXCLUDE ...], --exclude-channels CHANNELEXCLUDE [CHANNELEXCLUDE ...], --no-channel CHANNELEXCLUDE [CHANNELEXCLUDE ...], --no-channels CHANNELEXCLUDE [CHANNELEXCLUDE ...]
 +
                        list of channels to exclude. The default is none
 +
  --force-visible      force the channel(s) to be set to visible
 +
  --force-invisible    force the channel(s) to be set to invisible
 +
  --update              update the channels to correct any detected problem.  The default is just report
 +
==Requirements==
 +
Only tested with MythTV 0.28.
 +
==Examples==
 +
For the examples below, it is presumed you are running on the backend host with the default ports and the sourceid of your lineup is 1.
 +
 +
* Scenario: You want set the visibility of channel 100 to be visible.
 +
  MythUtil-Channel-visibility --videosource-id=1 --channel 100 --force-visible --update
 +
 +
 +
[[Category:Management Scripts]]
 +
[[Category:Scripts]]

Revision as of 03:29, 25 August 2017

MythUtil-Channel-visibility is a python script which is part of a set of related utility scripts (MythUtil-Channel-XMLTV-getLineup MythUtil-Channel-videosource MythUtil-Channel-HDHR-channelCheck MythUtil-Channel-HDHR-visibilityCheck MythUtil-Channel-visibility) that may be useful for users to maintain their channel lineup.

The definitive source location for this script is located on github, which is where one should obtain the current script.

MythUtil-Channel-visibiliy supports setting the MythTV lineup channel visibility.

Usage:

 MythUtil-Channel-visibility [-h] [--backend BACKEND] [--port PORT]
                             [--username USERNAME] [--password PASSWORD]
                             (--videosource-name SOURCENAME | --videosource-id SOURCEID)
                             [--channel CHANNELINCLUDE [CHANNELINCLUDE ...]]
                             [--exclude-channel CHANNELEXCLUDE [CHANNELEXCLUDE ...]]
                             [--force-visible | --force-invisible]
                             [--update]

Optional arguments:

 -h, --help            show this help message and exit
 --backend BACKEND, --host BACKEND
                       the host (backend) to access. The default is localhost.
 --port PORT           the port to connect to on on the host. The default is 6544
 --username USERNAME   the username to use for host authentication
 --password PASSWORD   the password to use for host authentication
 --videosource-name SOURCENAME
                       the video source name
 --videosource-id SOURCEID
                       the video source id
 --channel CHANNELINCLUDE [CHANNELINCLUDE ...], --channels CHANNELINCLUDE [CHANNELINCLUDE ...], --include-channel CHANNELINCLUDE [CHANNELINCLUDE ...], --include-channels CHANNELINCLUDE [CHANNELINCLUDE ...]
                       list of channels to consider. The default is all
 --exclude-channel CHANNELEXCLUDE [CHANNELEXCLUDE ...], --exclude-channels CHANNELEXCLUDE [CHANNELEXCLUDE ...], --no-channel CHANNELEXCLUDE [CHANNELEXCLUDE ...], --no-channels CHANNELEXCLUDE [CHANNELEXCLUDE ...]
                       list of channels to exclude. The default is none
 --force-visible       force the channel(s) to be set to visible
 --force-invisible     force the channel(s) to be set to invisible
 --update              update the channels to correct any detected problem.  The default is just report

Requirements

Only tested with MythTV 0.28.

Examples

For the examples below, it is presumed you are running on the backend host with the default ports and the sourceid of your lineup is 1.

  • Scenario: You want set the visibility of channel 100 to be visible.
 MythUtil-Channel-visibility --videosource-id=1 --channel 100 --force-visible --update