~ubuntu-branches/ubuntu/trusty/freeguide/trusty

« back to all changes in this revision

Viewing changes to xmltv/README

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Watkins
  • Date: 2008-09-07 15:49:32 UTC
  • mfrom: (1.2.6 upstream) (4.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20080907154932-2jvgv76btq068fe0
Tags: 0.10.9-1
* New upstream release. (Closes: #492789)
* Moved package from contrib to main. (Closes: #492544)
* Added lintian override for 'build-depends-without-arch-dep ant', as ant is
  used in the clean target.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
XMLTV 0.5.50
2
 
 
3
 
Gather television listings, process them and organize your viewing.
4
 
XMLTV is a file format for storing TV listings, defined in xmltv.dtd.
5
 
Then there are several tools to produce and process these listings.
6
 
 
7
 
Please see doc/QuickStart for documentation on what each program does,
8
 
and xmltv.dtd for documentation on the file format.
9
 
 
10
 
Progress is being made for a 1.0 release.  We've really been stable for
11
 
a while I and consider it well overdue. 
12
 
 
13
 
* Changes in this release (0.5.50)
14
 
 
15
 
Add new XMLTV::Supplement capability to many grabbers. Those grabbers
16
 
will now check a XMLTV.ORG web server for channel-id and other
17
 
supplemental information.  This ensures more current versions and should
18
 
make new channels available sooner for effected grabbers.
19
 
 
20
 
DTD has been changed. A "system" attribute has been added to <star-ratings>
21
 
and <star-ratings> now allows multiple instances. 
22
 
 
23
 
tv_grab_na_dtv   : New grabber for North America Direct TV users.
24
 
tv_grab_eu_epgdata New grabber for the commercial epgdata.com service
25
 
 
26
 
tv_grab_fr   : Improves Color/B&W detection, autocorrect, actors, director field parsing
27
 
tv_grab_uk_rt: improved bad character handling. Added "recommended" and "deaf-signed" notations.
28
 
tv_grab_il   : replace Locale::Hebrew module to Text::Bidi due licensing problems
29
 
tv_check     : Skip --myreplaytv as MyReplayTV.com has been discontinued.
30
 
 
31
 
And of course bugfixes and polish.
32
 
 
33
 
* Installation
34
 
 
35
 
Note: Windows users are strongly advised to use the pre-build EXE as installing
36
 
all the prerequisites is non-trivial. For those want to give it a go,
37
 
instructions are in doc/exe_build.html. Those instructions can be used for both
38
 
building xmltv.exe as well as a local install.
39
 
 
40
 
Basically installation instructions (unix):
41
 
 
42
 
% perl Makefile.PL
43
 
% make
44
 
% make test
45
 
% make install
46
 
 
47
 
To install in a custom directory, replace the first line with
48
 
something like
49
 
 
50
 
% perl Makefile.PL PREFIX=/wherever/
51
 
 
52
 
The system requirements are perl 5.6 or later, and a few Perl modules.
53
 
You will be asked about some optional components; if you choose not to
54
 
install them then there are fewer dependencies.  The full list of
55
 
needed modules is:
56
 
 
57
 
LWP 5.65
58
 
XML::Parser 2.34
59
 
XML::Twig 3.10
60
 
XML::Writer 0.4.6
61
 
Date::Manip 5.42a 
62
 
Memoize (included with perl 5.8 and later)
63
 
Storable (included with perl 5.8 and later)
64
 
 
65
 
Archive::Zip             (if you want to run tv_grab_uk_bleb)
66
 
CGI                      (if you want to run tv_pick_cgi)
67
 
Compress::Zlib           (if you want to run tv_grab_se_swedb)
68
 
HTML::Parser 3.34        (for some of the grabbers which use HTML::Entities)
69
 
HTML::TableExtract       (if you want to run tv_grab_na_icons)
70
 
HTML::TreeBuilder        (for many of the grabbers)
71
 
HTTP::Cache::Transparent (if you want to run tv_grab_se_swedb)
72
 
HTTP::Cookies            (if you want to run tv_grab_br_net)
73
 
IO::Scalar               (if you want to run tv_grab_uk_bleb)
74
 
IO::Stringy              (if you want to run tv_grab_se_swedb)
75
 
SOAP::Lite               (if you want to run tv_grab_na_dd)
76
 
Term::ReadKey            (if you want to run tv_grab_na_dd)
77
 
Text::Kakasi             (if you want to run tv_grab_jp)
78
 
Tk                       (if you want to run tv_check)
79
 
Tk::TableMatrix          (if you want to run tv_check)
80
 
WWW::Mechanize           (if you want to run tv_grab_na_icons or tv_grab_br_net)
81
 
XML::LibXML              (if you want to run tv_grab_se, tv_grab_se_swedb)
82
 
Unicode::UTF8simple      (if you want to run tv_grab_pt)
83
 
 
84
 
You may have difficulty with the XML modules on perl 5.8.0 - if so
85
 
send mail to the xmltv-users list.  Other perl versions should be OK.
86
 
 
87
 
The following modules are recommended, but the software still works
88
 
without them:
89
 
 
90
 
Term::ProgressBar                (displays pretty progress meters)
91
 
PerlIO::gzip (for perl 5.8+)     (makes tv_imdb a bit faster)
92
 
Lingua::Preferred 0.2.4          (helps with multilingual listings)
93
 
Unicode::String                  (non-ASCII chars in LaTeX output)
94
 
Lingua::EN::Numbers::Ordinate    (not really needed, to be honest)
95
 
 
96
 
And the Log::TraceMessages module is useful for debugging, but not
97
 
needed for normal use.
98
 
 
99
 
All of these can be installed with tarballs downloaded from CPAN or
100
 
(hopefully) using the CPAN shell program: 'perl -MCPAN -e shell', then
101
 
'install XML::Twig' and so on.  But you may find it easier to search
102
 
for packaged versions from your OS vendor or others - places which
103
 
distribute a packaged version of xmltv will often provide the modules
104
 
it needs too.
105
 
 
106
 
* Proxy servers
107
 
 
108
 
Proxy server support is provide by the LWP modules.
109
 
You can define a proxy server via the HTTP_PROXY enviornment variable.
110
 
    http_proxy=http://somehost.somedomain:port
111
 
 
112
 
For more information, see the the following:
113
 
http://search.cpan.org/~gaas/libwww-perl-5.803/lib/LWP/UserAgent.pm#$ua->env_proxy
114
 
 
115
 
* Known issues
116
 
 
117
 
tv_grab_se_swedb sometimes fails to work on Windows if there are spaces
118
 
in the path to your home-directory. This can be avoided by setting
119
 
the environment variable HOME to a path without spaces (e.g. c:\home).
120
 
 
121
 
* Author and copying
122
 
 
123
 
This is free software distributed under the GPL, see COPYING.  But if
124
 
you would like to use the code under some other conditions, please do
125
 
ask.  There are many who have contributed code, they are credited in
126
 
individual source files.
127
 
 
128
 
There is a web page at http://www.xmltv.org  and a Sourceforge
129
 
project 'XMLTV'.  There are some mailing lists:
130
 
 
131
 
    xmltv-announce@lists.sourceforge.net
132
 
    xmltv-users@lists.sourceforge.net
133
 
    xmltv-devel@lists.sourceforge.net
134
 
 
135
 
You ought to subscribe to the announce list at least.  Contact the
136
 
users list with most problems.
137
 
 
138
 
$Id: README,v 1.150 2007/11/05 08:14:20 rmeden Exp $
 
1
XMLTV 0.5.52
 
2
 
 
3
Gather television listings, process them and organize your viewing.
 
4
XMLTV is a file format for storing TV listings, defined in xmltv.dtd.
 
5
Then there are several tools to produce and process these listings.
 
6
 
 
7
Please see doc/QuickStart for documentation on what each program does,
 
8
and xmltv.dtd for documentation on the file format.
 
9
 
 
10
Progress is being made for a 1.0 release.  We've really been stable for
 
11
a while I and consider it well overdue. 
 
12
 
 
13
* Changes in this release (0.5.52)
 
14
 
 
15
tv_grab_uk_rt: lots of improvements.. should upgrade
 
16
 
 
17
tv_grab_re: better season/episode number handling
 
18
tv_grab_be: responding to source site changes
 
19
tv_grab_fr: better title detection
 
20
tv_grab_huro: now generates stop times
 
21
tv_grab_na_dtv: responding to source site changes
 
22
tv_grab_pt: responding to source site changes
 
23
tv_grab_za: improve episode tags
 
24
 
 
25
not working, removed: tv_grab_il, tv_grab_nl_wolf
 
26
 
 
27
And of some bugfixes and polish.
 
28
 
 
29
* Installation
 
30
 
 
31
Note: Windows users are strongly advised to use the pre-build EXE as installing
 
32
all the prerequisites is non-trivial. For those want to give it a go,
 
33
instructions are in doc/exe_build.html. Those instructions can be used for both
 
34
building xmltv.exe as well as a local install.
 
35
 
 
36
Basically installation instructions (unix):
 
37
 
 
38
% perl Makefile.PL
 
39
% make
 
40
% make test
 
41
% make install
 
42
 
 
43
To install in a custom directory, replace the first line with
 
44
something like
 
45
 
 
46
% perl Makefile.PL PREFIX=/wherever/
 
47
 
 
48
The system requirements are perl 5.6 or later, and a few Perl modules.
 
49
You will be asked about some optional components; if you choose not to
 
50
install them then there are fewer dependencies.  The full list of
 
51
needed modules is:
 
52
 
 
53
LWP 5.65
 
54
XML::Parser 2.34
 
55
XML::Twig 3.10
 
56
XML::Writer 0.4.6
 
57
Date::Manip 5.42a 
 
58
Memoize (included with perl 5.8 and later)
 
59
Storable (included with perl 5.8 and later)
 
60
 
 
61
Archive::Zip             (if you want to run tv_grab_uk_bleb)
 
62
CGI                      (if you want to run tv_pick_cgi)
 
63
Compress::Zlib           (if you want to run tv_grab_se_swedb)
 
64
HTML::Parser 3.34        (for some of the grabbers which use HTML::Entities)
 
65
HTML::TableExtract       (if you want to run tv_grab_na_icons)
 
66
HTML::TreeBuilder        (for many of the grabbers)
 
67
HTTP::Cache::Transparent (if you want to run tv_grab_se_swedb)
 
68
HTTP::Cookies            (if you want to run tv_grab_br_net)
 
69
IO::Scalar               (if you want to run tv_grab_uk_bleb)
 
70
IO::Stringy              (if you want to run tv_grab_se_swedb)
 
71
SOAP::Lite               (if you want to run tv_grab_na_dd)
 
72
Term::ReadKey            (if you want to run tv_grab_na_dd)
 
73
Text::Kakasi             (if you want to run tv_grab_jp)
 
74
Tk                       (if you want to run tv_check)
 
75
Tk::TableMatrix          (if you want to run tv_check)
 
76
WWW::Mechanize           (if you want to run tv_grab_na_icons or tv_grab_br_net)
 
77
XML::LibXML              (if you want to run tv_grab_se, tv_grab_se_swedb)
 
78
Unicode::UTF8simple      (if you want to run tv_grab_pt)
 
79
 
 
80
You may have difficulty with the XML modules on perl 5.8.0 - if so
 
81
send mail to the xmltv-users list.  Other perl versions should be OK.
 
82
 
 
83
The following modules are recommended, but the software still works
 
84
without them:
 
85
 
 
86
Term::ProgressBar                (displays pretty progress meters)
 
87
PerlIO::gzip (for perl 5.8+)     (makes tv_imdb a bit faster)
 
88
Lingua::Preferred 0.2.4          (helps with multilingual listings)
 
89
Unicode::String                  (non-ASCII chars in LaTeX output)
 
90
Lingua::EN::Numbers::Ordinate    (not really needed, to be honest)
 
91
 
 
92
And the Log::TraceMessages module is useful for debugging, but not
 
93
needed for normal use.
 
94
 
 
95
All of these can be installed with tarballs downloaded from CPAN or
 
96
(hopefully) using the CPAN shell program: 'perl -MCPAN -e shell', then
 
97
'install XML::Twig' and so on.  But you may find it easier to search
 
98
for packaged versions from your OS vendor or others - places which
 
99
distribute a packaged version of xmltv will often provide the modules
 
100
it needs too.
 
101
 
 
102
* Proxy servers
 
103
 
 
104
Proxy server support is provide by the LWP modules.
 
105
You can define a proxy server via the HTTP_PROXY enviornment variable.
 
106
    http_proxy=http://somehost.somedomain:port
 
107
 
 
108
For more information, see the the following:
 
109
http://search.cpan.org/~gaas/libwww-perl-5.803/lib/LWP/UserAgent.pm#$ua->env_proxy
 
110
 
 
111
* Known issues
 
112
 
 
113
tv_grab_se_swedb sometimes fails to work on Windows if there are spaces
 
114
in the path to your home-directory. This can be avoided by setting
 
115
the environment variable HOME to a path without spaces (e.g. c:\home).
 
116
 
 
117
* Author and copying
 
118
 
 
119
This is free software distributed under the GPL, see COPYING.  But if
 
120
you would like to use the code under some other conditions, please do
 
121
ask.  There are many who have contributed code, they are credited in
 
122
individual source files.
 
123
 
 
124
There is a web page at http://www.xmltv.org  and a Sourceforge
 
125
project 'XMLTV'.  There are some mailing lists:
 
126
 
 
127
    xmltv-announce@lists.sourceforge.net
 
128
    xmltv-users@lists.sourceforge.net
 
129
    xmltv-devel@lists.sourceforge.net
 
130
 
 
131
You ought to subscribe to the announce list at least.  Contact the
 
132
users list with most problems.
 
133
 
 
134
-- Robert Eden, rmeden@yahoo.com, 2008-07-13
 
135
$Id: README,v 1.153 2008/07/14 04:05:55 rmeden Exp $