xmltv/grab/uk_rt tv_grab_uk_rt,1.26,1.27

Update of /cvsroot/xmltv/xmltv/grab/uk_rt
In directory vz-cvs-3.sog:/tmp/cvs-serv11431/grab/uk_rt

Modified Files:
	tv_grab_uk_rt 
Log Message:
Perldoc updates

Index: tv_grab_uk_rt
===================================================================
RCS file: /cvsroot/xmltv/xmltv/grab/uk_rt/tv_grab_uk_rt,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -d -r1.26 -r1.27
*** tv_grab_uk_rt	10 Jun 2012 09:54:48 -0000	1.26
--- tv_grab_uk_rt	10 Jun 2012 11:31:39 -0000	1.27
***************
*** 5255,5259 ****
  tv_grab_uk_rt --list-lineups
  
! tv_grab_uk_rt --lineup LINEUP_ID
  
  =head1 DESCRIPTION
--- 5255,5259 ----
  tv_grab_uk_rt --list-lineups
  
! tv_grab_uk_rt --get-lineup [--config-file FILE]
  
  =head1 DESCRIPTION
***************
*** 5309,5324 ****
  (default) and 'TermNoProgressBar' to disable the use of Term::ProgressBar.
  
! B<--configure> Prompt for which channels to download listings for, where to
! store the cache directory for retrieved listings, what character encoding
! to use for output, and also specify regional and TV platform information.
  
! B<--list-channels> Outputs a list of every channel available to the grabber
! in XMLTV format.
  
! B<--list-lineups> Outputs a list of every channel lineup available to the
! grabber in XMLTV format.
  
! B<--lineup LINEUP_ID> Outputs the given channel lineup in XMLTV format for
! the given LINEUP_ID.
  
  =head1 SOURCE DATA TERMS OF USE
--- 5309,5325 ----
  (default) and 'TermNoProgressBar' to disable the use of Term::ProgressBar.
  
! B<--configure> Prompt for which channels/lineup to download listings for,
! where to store the cache directory for retrieved listings, what character
! encoding to use for output, and whether to enable programme title and bad
! character fixups.
  
! B<--list-channels> Outputs an XML document containing all channels
! available to the grabber.
  
! B<--list-lineups> Outputs an XML document containing all channel lineups
! available to the grabber.
  
! B<--get-lineup> Outputs an XML document containing the configured channel
! lineup.
  
  =head1 SOURCE DATA TERMS OF USE
***************
*** 5333,5336 ****
--- 5334,5349 ----
  including any third-party software applications available to the general public.
  
+ =head1 CHANNEL LINEUPS
+ 
+ A channel lineup is a list of TV and radio channels that are available in a
+ particular location on a particular TV platform (e.g. Freeview).
+ 
+ Whilst configurations containing individual "channel=..." entries are still
+ supported, the grabber allows a user to select their location and TV platform
+ at configuration time and have their channel lineup generated dynamically
+ at runtime. This means that if a new channel launches or a channel ceases
+ broadcasting, an update to the relevant lineup (stored on the XMLTV server)
+ will result in listings  containing such channel changes without any reconfiguration by the user.
+ 
  =head1 CHARACTER ENCODING
  
***************
*** 5341,5349 ****
  =head1 TITLE PROCESSING
  
! Over time, the listings may contain inconsistent programme details, such as
  the programme title combined with episode details for some showings of a
  programme, but separate for others; or the episode title being given as the
  programme title, and the programme title given as the episode title. Some
  programme titles may also change slightly over time, or across channels.
  Enabling title processing during configuration enables this software to
  process programme titles against a list of flagged titles. The
--- 5354,5363 ----
  =head1 TITLE PROCESSING
  
! Over time, listings may contain inconsistent programme details, such as
  the programme title combined with episode details for some showings of a
  programme, but separate for others; or the episode title being given as the
  programme title, and the programme title given as the episode title. Some
  programme titles may also change slightly over time, or across channels.
+ 
  Enabling title processing during configuration enables this software to
  process programme titles against a list of flagged titles. The
***************
*** 5358,5362 ****
  to fail if they have been configured using an old title. Whilst care is
  taken to ensure title updates are made as far ahead of transmission as
! possible, be aware that last minute updates can occasionally be made.
  
  =head1 MIS-ENCODED UTF-8 SOURCE DATA
--- 5372,5376 ----
  to fail if they have been configured using an old title. Whilst care is
  taken to ensure title updates are made as far ahead of transmission as
! possible, be aware that last minute updates can be made.
  
  =head1 MIS-ENCODED UTF-8 SOURCE DATA
***************
*** 5365,5393 ****
  2011, there was an ongoing issue with source data containing mis-encoded UTF-8
  characters. Since the transition, the source data should be UTF-8 safe and
! automatic processing of the data has been disabled. A configuration option
! is provided nonetheless to permit detection and correction of such character
! encoding errors if these re-appear in the future.
! 
! =head1 REGIONAL CHANNELS
! 
! During configuration, the software asks for UK postcode information. The first
! half of a user's postcode is used to determine which regional channels
! are likely available in their locality, and only these matching regional
! channels are included in the list of available channels. A user can enter
! 'none' during configuration to disable regional channel filtering. Users in
! the Republic of Ireland should use the pseudo-postcode 'EIRE' to enable
! filtering of regional channels. Errors are quite possible, so please report
! any incorrect channel/postcode information.
  
! =head1 TV PLATFORMS
  
! After specifying a postcode, the software will ask the user to select their
! TV service platform (Freeview, Freesat, Virgin TV, etc) from a list. Selecting one
! of these entries will filter the channel selection list (shown at the end of
! the configuration phase) to show only those channels available on the chosen
! platform. If the user has entered a valid postcode, the channel list will
! also only include those regional channels available in the user's locality.
! Again, errors are quite possible, so please report any incorrect
! channel/platform information.
  
  =head1 ERROR HANDLING
--- 5379,5391 ----
  2011, there was an ongoing issue with source data containing mis-encoded UTF-8
  characters. Since the transition, the source data should be UTF-8 safe and
! automatic processing of the data may not be required.  A configuration option
! is provided to permit detection and correction of such character encoding 
! errors and users are recommended to enable this option during configuration.
  
! =head1 PERFORMANCE
  
! Improvements to date and time handling in the grabber have increased performance
! 6-7X. Grabbing 14 days of listings with utf-8 and title fixups enabled
! should take about 2 seconds per configured channel on a typical machine.
  
  =head1 ERROR HANDLING
***************
*** 5424,5428 ****
  =head1 RADIO LISTINGS
  
! Ironically, the Radio Times does not offer listings for radio. They
  have been asked about the possibility of adding radio listings, but stated
  that this would require significant development effort. It has not been
--- 5422,5426 ----
  =head1 RADIO LISTINGS
  
! Ironically, the Radio Times feed does not offer listings for radio. They
  have been asked about the possibility of adding radio listings, but stated
  that this would require significant development effort. It has not been
***************
*** 5434,5446 ****
  information.
  
- =head1 LINEUPS
- 
- ** Work in progress ** In order to allow more straightforward configuration
- of programs that make use of XMLTV data, lineups contain a list of channels
- and their names, EPG numbers and identifiers, to allow such programs to quickly
- match XMLTV channel data against channels configured in the program. The
- intention is to allow programs to be made aware of changes to a lineup and to
- allow automated configuration of XMLTV listings.
- 
  =head1 MAILING LIST
  
--- 5432,5435 ----


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/