1
2 Documentation overview
3 ======================
4
5 README [this file] gives a overview over the package.
6 Build instructions, short overview over every
7 program, some maybe useful URL's.
8
9 man pages For most programs a manual page is available.
10
11 README.xfree4 Some notes about XFree86 4.x and the Xvideo
12 extention.
13
14 README.recording If you want record videos, have a look at this
15 file. It also has some notes about how to process /
16 playback the files recorded by xawtv/streamer.
17
18 README.network How to stream video/audio over the net. Pointers to
19 other software for the most part.
20
21 README.lirc Some hints how make lirc work with xawtv.
22
23 README.bttv Some hints to get bttv going, also lists some
24 known problems.
25
26 UPDATE_TO_v3.0 Some hints for upgrading from 2.x to 3.x (config
27 file syntax changes, ...)
28
29
30 before sending me email...
31 ==========================
32
33 IMPORTANT: Don't send me mails with images attached unless I ask you
34 to do so. Mails with images attached will go to /dev/null unseen, you
35 will never ever see an answer for these.
36
37 If you have problems after upgrading, please check the ChangeLog for
38 hints first. Looking into the ChangeLog is a good idea in general,
39 because it is updated for every release, the other files are updated
40 less frequently and might be a bit outdated.
41
42 For problem/bug reports:
43
44 * emails with questions answered in the documentation will go to
45 /dev/null.
46 * emails which don't have any useful informations (like "xawtv
47 doesn't work, please help me") will go to /dev/null.
48
49 "useful information" includes at least:
50 - xawtv version
51 - kernel version
52 - which driver (+ version if you know)
53 - which hardware (although I probably can help with bttv
54 driver problems only).
55 - which TV norms are used in your country.
56 - if xawtv prints errors, include these too (cut+paste)
57 - don't forget a description of your problem :-)
58
59 If you are using bttv as driver:
60 - the insmod arguments for the modules
61 - the kernel messages printed by bttv while loading.
62
63 If you are _really_sure_ some information isn't important for your
64 problem, you can skip it. But if in doubt, better include it...
65
66
67 For patches/changes:
68
69 * Please add a comment on what is changed and why you changed it.
70 * Please send unified diffs ("diff -u") against the latest version.
71 * Please don't reformat my source code.
72 * Complete patches have better chances to go in. Quick+dirty hacks
73 which need cleanups and lack documentation updates are less likely
74 to go in simply because I need more time to deal with them.
75
76
77 compile & install
78 =================
79
80 The commands
81
82 $ ./configure [ options ]
83 $ make
84
85 should compile xawtv, v4l-conf, fbtv and a few other utilities. You can
86 also simply type "make" if you don't want to pass any options to
87 configure.
88
89 If it fails, check that all required packages are installed. Note that
90 the *-devel packages are also required to compile stuff, i.e. you need
91 both libjpeg and libjpeg-devel for example.
92
93 You can install the programs (as root) with:
94
95 # make install
96
97 If you want build RPMs: No problem, just run
98
99 $ rpm -ta xawtv-3.xx.tar.gz
100
101 and install them the usual way with "rpm -i".
102
103
104 usage
105 =====
106
107 bttv
108 ----
109
110 bttv isn't bundled with xawtv any more. You can the latest version
111 from http://bytesex.org/bttv/. If you are using kernel 2.4.x, it is
112 very unlikely that you need an update, the bttv driver in 2.4.x is
113 updated in regular intervals.
114
115
116 v4l-conf
117 --------
118
119 v4l-conf is a small tool which tells video4linux about the current
120 video mode (size and color depth). This requires root privileges,
121 because it is easy to crash the box by passing bogus values there.
122 It requires the X-Server with DGA support up and running or a
123 framebuffer device. It is a temporary hack, this problem will be
124 solved in a better way with a X11 extention. See README.xfree4
125 for details.
126
127 Try "v4l-conf -h" for a short description. It is installed suid-root,
128 and xawtv runs it at startup. Should work out-of-the-box without
129 extra configuration. Normally you shouldn't need to worry about it,
130 but for debugging it is handy do run it from the shell and check the
131 output.
132
133
134 xawtv
135 -----
136
137 There is a man page now, read it. Don't expect you can use xawtv
138 without reading the documentation at least once. You are lost if you
139 don't know the keyboard shortcuts, xawtv isn't a mouse-only program.
140
141 xawtv will not work without the app-defaults. If you want to try
142 xawtv without installing it, use this...
143
144 $ XUSERFILESEARCHPATH=./%N.ad
145 $ export XUSERFILESEARCHPATH
146 $ ./xawtv
147
148 ...to make sure xawtv finds the application defaults (the Xawtv.ad
149 file). If v4l-conf isn't installed too, you have to run it once
150 (as root) before starting xawtv.
151
152
153 motv
154 ----
155
156 That's basically xawtv with better (IMO), motif-based GUI. Feature set
157 is very close to xawtv, they share a lot of code (basically everything
158 but the athena/motif GUI code).
159
160 motv uses Motif 2.x features (utm, render tables). This means you
161 need openmotif, lesstif does *not* work.
162
163
164 xawtv-remote
165 ------------
166
167 remote control for xawtv. Works with motv too. Takes commands for
168 xawtv as command line arguments. Check 'xawtv-remote -h' for details.
169 A man-page exists too.
170
171 ObSecurity: This uses X Properties, everyone who is allowed to connect
172 to your X11 Display can control xawtv.
173
174 There is a GUI (Qt) version at:
175 http://www.ben2.ucla.edu/~wtho/xawtv-qremote/xawtv-qremote-0.01.tar.gz
176
177
178 fbtv
179 ----
180
181 TV program for the linux console. Runs on top of a framebuffer
182 device. Check out man-page and source code for details.
183
184
185 ttv
186 ---
187
188 aa-lib based TV app which renders the TV image on any text terminal.
189
190
191 scantv
192 ------
193
194 scans for tv stations and writes a initial config file for xawtv and
195 motv.
196
197
198 v4lctl
199 ------
200
201 This tool allows to control a v4l device from the command line.
202 Also can capture images. Check the man-page for details.
203
204
205 streamer
206 --------
207
208 Command line tool for streaming capture, including audio. Single
209 frames work too. Try the '-h' switch for a description. A (short)
210 man page is available too.
211
212
213 pia
214 ---
215
216 simple movie player, should play every movie file (mov+avi) recorded
217 by streamer, xawtv and motv.
218
219
220 radio
221 -----
222
223 You have to load the driver using "insmod bttv radio=1" for radio
224 support. The MAKEDEV script should create the required /dev/radio*
225 devices.
226
227 radio is a console application (curses). up/down tune, 'q' quits,
228 the function keys recall the programmed stations. radio reads the
229 kradio config file. You can't configure anything with radio, you'll
230 have to use kradio or vi for this. The config file format is
231 documented in the man page.
232
233 kradio (my KDE radio app) isn't included any more, it is available as
234 separate tarball now.
235
236
237 videotext / teletext
238 --------------------
239
240 alevt is _the_ videotext application for bttv. URL below.
241
242 A http server for videotext called 'alevtd' is in the vbistuff
243 subdirectory. Recent xawtv version also come with mtt, which is a
244 interactive videotext application for X11 (Motif) and console.
245
246
247 webcam
248 ------
249
250 This is a webcam tool. Captures a image, annotates with a text +
251 current time and uploads it to the webserver using ftp in an endless
252 loop. Needs the ftp utility. Should survive dropped ftp-connections
253 (webserver reboot) without problems. It has a man-page...
254
255
256 perl
257 ----
258
259 Hint for all perl users/hackers: There is a Video::Capture::V4l module
260 available at CPAN. It can do capture, vbi decoding, and it comes with a
261 nifty tool to do a channel scan (decodes the station ID from vbi).
262
263
264 resources
265 =========
266
267 http://bytesex.org/xawtv/ - xawtv [me]
268 http://bytesex.org/bttv/ - bttv [me]
269 http://lecker.essen.de/~froese/ - alevt [Edgar]
270 http://bttv-v4l2.sourceforge.net/ - bttv2 [Justin]
271 http://roadrunner.swansea.uk.linux.org/v4l.shtml - v4l [Alan]
272 http://www.thedirks.org/v4l2/ - v4l2 [Bill]
273 http://www.tk.uni-linz.ac.at/~simon/private/i2c/ - i2c [Simon]
274 http://www-mice.cs.ucl.ac.uk/multimedia/software/vic/ - vic
275
276 Have fun!
277
278 Gerd
279
280 --
281 Gerd Knorr <kraxel@bytesex.org>
|
This page was automatically generated by the
LXR engine.
|