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

« back to all changes in this revision

Viewing changes to xmltv/doc/man/tv_grab_it.txt

  • Committer: Bazaar Package Importer
  • Author(s): Shaun Jackman
  • Date: 2007-09-11 16:52:59 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070911165259-4r32oke21i1ezbmv
Tags: 0.10.5-1
* New upstream release.
* Update the watch file.
* Change Debian policy to version 3.7.2.2. No changes necessary.
* Add ant-optional to build dependencies. Closes: #441762.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
NAME
2
 
    tv_grab_it - Grab TV listings for Italy.
3
 
 
4
 
SYNOPSIS
5
 
    tv_grab_it --help
6
 
 
7
 
    tv_grab_it [--config-file FILE] --configure
8
 
 
9
 
    tv_grab_it [--config-file FILE] [--output FILE] [--days N] [--offset N]
10
 
    [--quiet] [--slow] [--verbose] [--errors-in-xml] [--backend
11
 
    SITE1[,SITE2[,SITE3]]]
12
 
 
13
 
DESCRIPTION
14
 
    Output TV listings for several channels available in Italy. The grabber
15
 
    relies on parsing HTML so it might stop working at any time. The data
16
 
    comes from different backends. This is to minimize blackouts in case of
17
 
    site changes but also to extend the number of channels. If the grabber
18
 
    can't find the data with the first backend it will try the second one,
19
 
    and so on. You can specify your order of preference using the --backend
20
 
    option.
21
 
 
22
 
    Currently configured backends are (in default order):
23
 
 
24
 
    wfactory - grabs data from www.wfactory.net
25
 
    skytv - grabs data from www.skytv.it
26
 
 
27
 
    First run tv_grab_it --configure to choose which channels you want to
28
 
    download. Then running tv_grab_it with no arguments will output listings
29
 
    in XML format to standard output.
30
 
 
31
 
    --configure Prompt for which channels, and writes the configuration
32
 
    file.
33
 
 
34
 
    --config-file FILE Set the name of the configuration file, the default
35
 
    is ~/.xmltv/tv_grab_it.conf. This is the file written by --configure and
36
 
    read when grabbing.
37
 
 
38
 
    --gui OPTION Use this option to enable a graphical interface to be used.
39
 
    OPTION may be 'Tk', or left blank for the best available choice.
40
 
    Additional allowed values of OPTION are 'Term' for normal terminal
41
 
    output (default) and 'TermNoProgressBar' to disable the use of
42
 
    XMLTV::ProgressBar.
43
 
 
44
 
    --output FILE write to FILE rather than standard output.
45
 
 
46
 
    --days N Grab N days. The default is 7.
47
 
 
48
 
    --offset N Start N days in the future. The default is to start from
49
 
    today.
50
 
 
51
 
    --quiet Suppress the progress messages normally written to standard
52
 
    error.
53
 
 
54
 
    --slow Downloads more details (descriptions, actors...). This means
55
 
    downloading a new file for each programme, so it's off by default to
56
 
    save time.
57
 
 
58
 
    --verbose Prints out verbose information useful for debugging.
59
 
 
60
 
    --errors-in-xml Outputs warnings as programmes in the xml file, so that
61
 
    you can see errors in your favorite frontend in addition to the default
62
 
    STDERR.
63
 
 
64
 
    --backend Set the backend (or backends) to use. See the examples.
65
 
 
66
 
    --version Show the version of the grabber.
67
 
 
68
 
    --help Print a help message and exit.
69
 
 
70
 
CAVEATS
71
 
    If you use --quiet you should also use --errors-in-xml or you won't be
72
 
    warned about errors. Note also that, as opposed to previous versions,
73
 
    this grabber doesn't die if it cannot find any data, but returns an
74
 
    empty (or optionally containing just warnings) xml file instead.
75
 
 
76
 
    The mytv backend is currently disabled (site does not provide data
77
 
    anymore).
78
 
 
79
 
    The backends' data quality differs a lot. For example, mytv was very
80
 
    basic, yet complete and uses the least amount of bandwith. Skytv has a
81
 
    lot of channels, but unless you use it with the --slow option the data
82
 
    is not very good (and in this case i would be VERY slow). wfactory is a
83
 
    good overall site if you don't need the whole sky package.
84
 
 
85
 
EXAMPLES
86
 
    tv_grab_it --backend mytv --configure
87
 
        configures tv_grab_it using only the backend mytv
88
 
 
89
 
    tv_grab_it --backend skytv,wfactory --days 1
90
 
        grabs one day of data overiding the default order (could also be
91
 
        --backend skytv --backend wfactory)
92
 
 
93
 
    tv_grab_it --cache --slow --days 3
94
 
        grabs the full data for the next three days using the default
95
 
        backend order and using a disk cache.
96
 
 
97
 
SEE ALSO
98
 
    xmltv(5).
99
 
 
100
 
AUTHOR
101
 
    Davide Chiarini, davide.chiarini@gmail.com
102
 
 
 
1
NAME
 
2
    tv_grab_it - Grab TV listings for Italy.
 
3
 
 
4
SYNOPSIS
 
5
    tv_grab_it --help
 
6
 
 
7
    tv_grab_it [--config-file FILE] --configure
 
8
 
 
9
    tv_grab_it [--config-file FILE] [--output FILE] [--days N] [--offset N]
 
10
    [--quiet] [--slow] [--verbose] [--errors-in-xml] [--backend
 
11
    SITE1[,SITE2[,SITE3]]] [--cache-slow]
 
12
 
 
13
DESCRIPTION
 
14
    Output TV listings for several channels available in Italy. The grabber
 
15
    relies on parsing HTML so it might stop working at any time. The data
 
16
    comes from different backends. This is to minimize blackouts in case of
 
17
    site changes but also to extend the number of channels. If the grabber
 
18
    can't find the data with the first backend it will try the second one,
 
19
    and so on. You can specify your order of preference using the --backend
 
20
    option.
 
21
 
 
22
    Currently configured backends are (in default order):
 
23
 
 
24
    skylife - grabs data from www.skylife.it
 
25
    wfactory - grabs data from www.wfactory.net
 
26
    skytv - grabs data from www.skytv.it
 
27
    boingtv - grabs data from www.boingtv.it
 
28
    sitcom1 - grabs data from www.sitcom1.it
 
29
 
 
30
    First run tv_grab_it --configure to choose which channels you want to
 
31
    download. Then running tv_grab_it with no arguments will output listings
 
32
    in XML format to standard output.
 
33
 
 
34
    --configure Prompt for which channels, and writes the configuration
 
35
    file.
 
36
 
 
37
    --config-file FILE Set the name of the configuration file, the default
 
38
    is ~/.xmltv/tv_grab_it.conf. This is the file written by --configure and
 
39
    read when grabbing.
 
40
 
 
41
    --gui OPTION Use this option to enable a graphical interface to be used.
 
42
    OPTION may be 'Tk', or left blank for the best available choice.
 
43
    Additional allowed values of OPTION are 'Term' for normal terminal
 
44
    output (default) and 'TermNoProgressBar' to disable the use of
 
45
    XMLTV::ProgressBar.
 
46
 
 
47
    --output FILE write to FILE rather than standard output.
 
48
 
 
49
    --days N Grab N days. The default is 7.
 
50
 
 
51
    --offset N Start N days in the future. The default is to start from
 
52
    today.
 
53
 
 
54
    --quiet Suppress the progress messages normally written to standard
 
55
    error.
 
56
 
 
57
    --slow Downloads more details (descriptions, actors...). This means
 
58
    downloading a new file for each programme, so it's off by default to
 
59
    save time.
 
60
 
 
61
    --cache-slow If you use the --cache option to speed up thing when you
 
62
    grab data several times a week, using this option you will cache only
 
63
    the --slow data, so you shouldn't miss changes in schedules.
 
64
 
 
65
    --verbose Prints out verbose information useful for debugging.
 
66
 
 
67
    --errors-in-xml Outputs warnings as programmes in the xml file, so that
 
68
    you can see errors in your favorite frontend in addition to the default
 
69
    STDERR.
 
70
 
 
71
    --backend Set the backend (or backends) to use. See the examples.
 
72
 
 
73
    --version Show the version of the grabber.
 
74
 
 
75
    --help Print a help message and exit.
 
76
 
 
77
CAVEATS
 
78
    If you use --quiet you should also use --errors-in-xml or you won't be
 
79
    warned about errors. Note also that, as opposed to previous versions,
 
80
    this grabber doesn't die if it cannot find any data, but returns an
 
81
    empty (or optionally containing just warnings) xml file instead.
 
82
 
 
83
    The mytv backend is currently disabled (site does not provide data
 
84
    anymore).
 
85
 
 
86
    The backends' data quality differs a lot. For example, mytv was very
 
87
    basic, yet complete and uses the least amount of bandwith. Skytv has a
 
88
    lot of channels, but unless you use it with the --slow option the data
 
89
    is not very good (and in this case i would be VERY slow). wfactory is a
 
90
    good overall site if you don't need the whole sky package.
 
91
 
 
92
EXAMPLES
 
93
    tv_grab_it --backend mytv --configure
 
94
        configures tv_grab_it using only the backend mytv
 
95
 
 
96
    tv_grab_it --backend skytv,wfactory --days 1
 
97
        grabs one day of data overiding the default order (could also be
 
98
        --backend skytv --backend wfactory)
 
99
 
 
100
    tv_grab_it --cache --slow --days 3
 
101
        grabs the full data for the next three days using the default
 
102
        backend order and using a disk cache.
 
103
 
 
104
RECOMMENDED USAGE
 
105
    tv_grab_it --cache --slow --cache-slow --errors-in-xml
 
106
 
 
107
SEE ALSO
 
108
        xmltv(5).
 
109
 
 
110
AUTHOR
 
111
        Davide Chiarini, davide.chiarini@gmail.com
 
112