File: alevt-cap.1.in

package info (click to toggle)
alevt 1:1.6.2-4
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 956 kB
  • ctags: 662
  • sloc: ansic: 6,284; makefile: 119; perl: 104; sh: 15
file content (160 lines) | stat: -rw-r--r-- 3,816 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
.na
.TH ALEVT-CAP 1 "VERSION" LINUX "Teletext capture"
.SH NAME
alevt-cap \- simple capture of teletext pages

.SH SYNOPSIS
.B alevt-cap
.RI [ options ]
.IR ppp [ .ss ]
.I \.\.\.

.SH "DESCRIPTION"
.B alevt-cap
is a simple program to capture teletext pages and write them to disk.
You just give it a list of pages to fetch and it will save them.  Nothing
fancy like time-outs, page ranges, or channel name detection is supported.
Though, it supports different file formats - at the moment ascii, ansi
(ascii with color escape sequences), html, png, and ppm.

.SH OPTIONS
A summary of options is included below.
.TP
.BI \-name \ filename
Gives the filename under which the pages should be saved.  It may
contain a couple of %-sequences (see below).  (default: ttext-%s.%e)
.TP
.BI \-format \ format-specifier
Sets the file format used to save pages (see below).  (default: ascii)
.TP
.BI \-format \ list\||help
Lists all known file formats and their options.
.TP
.BI \-vbi \ device
Use the given device name (default: /dev/vbi0).
.TP
.BI \-finetune \ \-4..4\||auto
Specify the fine tuning for the decoder.  For the right value
play with
.BR alevt .
Default: 1.
.TP
.BI \-timeout \ seconds
If the pages cannot be captured in
.IR seconds ,
the program terminates with exit status 1 after saving
the already captured pages.  The default is to wait forever.
.TP
.BI \-charset \ latin-1\||latin-2
Selects the character set to use.  Characters not present
in the selected set are replaced by similar looking symbols.
(default: latin-1)
.TP
.B \-\-help
Show summary of options.
.TP
.B \-\-version
Show version of program.
.PP
Every non-option argument is taken as a page number.  Subpages
may be given in the form
.IB ppp . ss
where
.I ppp
is the page number and
.I ss
is the subpage number.  If no subpage is specified,
the first transmitted subpage of that page is taken.
The page is saved with the prior given format and name.

.SS Filenames
The filename may contain %-sequences.  The following sequences
are defined:
.RS
.TP
.B %%
a single % sign.
.TP
.B %e
the default extension of the selected output format.
.TP
.B %p
the page number and an optional subpage number.
.TP
.B %P
the page number.
.TP
.B %S
the subpage number.
.TP
.B %s
the page number as given on the command line.
.RE
.PP
Between the % sign and the letter you can give a field
width to which the replacement string should be padded.

.SS Format specifiers
The output format and associated options are given by the
format specifier.  It is made up of one or more comma separated
words.  The first word selects the output format and the
others are options for that format.  There are common
options valid for all output formats and format specific
(private) ones.  Some options have the form of an assignment.
The order of the options is free.  Only the format name
itself must be the first word.
An example:
.TP
.B ansi,reveal,bg=none
The
.B ansi
is the format and
.BR reveal ,
and
.BR bg=none
are options.
.PP
At the moment there are only two common options:
.BR reveal ,
and
.BR hide .
They control whether the hidden characters present
in a page should be shown in the output or not.
The default is
.BR hide .
.PP
The special format string
.B list
(or
.BR help )
will give you a list of all supported output formats
and their options.
.PP
(The
.B ansi
format is an alias for
.BR ascii,color .)

.SH DIAGNOSTICS
If the program timed out and some pages are missing the exit
status is 1.  On fatal errors the exit status is 2.

.SH NOTE
Before starting this program, you have to set the TV channel
with another program like
.B xawtv
of
.BR set-tv .

.SH FILES
.I /dev/vbi*

.SH SEE ALSO
.BR alevt (1x),
.BR alevt-date (1),

.SH BUGS
If you give a page number that is never transmitted the program will
not terminate.
.PP
Bug reports to <froese@gmx.de>.