.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TV_GRAB_PT_VODAFONE 1p"
.TH TV_GRAB_PT_VODAFONE 1p 2024-02-24 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
tv_grab_pt_vodafone \- Grab TV listings for Vodafone in Portugal
.SH SYNOPSIS
.IX Header "SYNOPSIS"
tv_grab_pt_vodafone \-\-help
.PP
tv_grab_pt_vodafone \-\-configure [\-\-config\-file FILE]
.PP
tv_grab_pt_vodafone [\-\-config\-file FILE]
                    [\-\-days N] [\-\-offset N] [\-\-channel xmltvid,xmltvid,...]
                    [\-\-output FILE] [\-\-quiet | \-\-debug]
.PP
tv_grab_pt_vodafone \-\-list\-channels [\-\-config\-file FILE]
                    [\-\-output FILE] [\-\-quiet | \-\-debug]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Output TV listings in XMLTV format for many stations available in Portugal.
This program consumes the EPG service from <https://vodafone.pt/>.
.PP
First you must run \fBtv_grab_pt_vodafone \-\-configure\fR to choose which stations
you want to receive.
.PP
Then running \fBtv_grab_pt_vodafone\fR with no arguments will get listings for
the stations you chose for the maximum 7 days, including today.
.SH OPTIONS
.IX Header "OPTIONS"
\&\fB\-\-configure\fR Prompt for which stations to download and write the
configuration file.
.PP
\&\fB\-\-config\-file FILE\fR Set the name of the configuration file, the
default is \fB~/.xmltv/tv_grab_pt_vodafone.conf\fR.  This is the file written by
\&\fB\-\-configure\fR and read when grabbing.
.PP
\&\fB\-\-output FILE\fR When grabbing, write output to FILE rather than
standard output.
.PP
\&\fB\-\-days N\fR When grabbing, grab N days rather than everything available.
.PP
\&\fB\-\-offset N\fR Start grabbing at today + N days.
.PP
\&\fB\-\-quiet\fR Only print error-messages on STDERR.
.PP
\&\fB\-\-debug\fR Provide more information on progress to STDERR to help in
debugging.
.PP
\&\fB\-\-list\-channels\fR Output a list of all channels that data is available for.
The list is in xmltv-format.
.PP
\&\fB\-\-capabilities\fR Show which capabilities the grabber supports. For more
information, see <http://wiki.xmltv.org/index.php/XmltvCapabilities>
.PP
\&\fB\-\-version\fR Show the version of the grabber.
.PP
\&\fB\-\-help\fR Print a help message and exit.
.SH "ERROR HANDLING"
.IX Header "ERROR HANDLING"
If the grabber fails to download data from Vodafone, it will print an
error message to STDERR and then exit with a status code of 1 to indicate
that the data is missing.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
The environment variable HOME can be set to change where configuration
files are stored. All configuration is stored in \f(CW$HOME\fR/.xmltv/. On Windows,
it might be necessary to set HOME to a path without spaces in it.
.SH CREDITS
.IX Header "CREDITS"
Kevin Groeneveld (kgroeneveld at gmail dot com)
.PP
This grabber uses code from tv_grab_pt_meo by Karl Dietz, dekarl \-at\- users \-dot\- sourceforge \-dot\- net,
and from tv_grab_zz_sdjson by Kevin Groeneveld, kgroeneveld \-at\- gmail \-dot\- com.
.PP
The original idea of this grabber came from higuita's shell script, see
<https://github.com/higuita/vodafone.pt\-xmltv>.
.PP
Special thanks to Vodafone for building a clean, fast, and public access API;
much more reliable than Meo's open API (but sadly not as open) and much better
than the lack of any API from NOS.
.SH AUTHOR
.IX Header "AUTHOR"
Nuno Sénica, nsenica \-at\- gmail \-dot\- com.
.SH BUGS
.IX Header "BUGS"
None known.