0065242764271ebde845b67de0f3dc092a26f42c
[debian/teleschorsch.git] / teleschorsch.1
1 .\" This page is in the public domain
2 .TH TELESCHORSCH 1 "2007-03-04" "Toastfreeware" "User Commands"
3 .SH NAME
4 teleschorsch \- configurable viewer for video streams
5 .SH SYNOPSIS
6 .B teleschorsch
7 .SH DESCRIPTION
8 .I teleschorsch
9 is a frontend to view (or listen to) video (or audio) streams with
10 programs like 
11 .BR vlc (1)
12 or
13 .BR mplayer (1).
14 .I teleschorsch
15 hereby makes it unnecessary to browse through terrible web pages in order
16 to see the user's favourite news broadcast etc.
17 .P
18 It allows to configure preferred streams in a configuration file, providing
19 a simple syntax to replace variables at runtime.
20 .P
21 The user then simply selects the stream she'd like to see (or listen too), the date of the
22 transmission and the offset to start at.
23 .SH OPTIONS
24 Currently
25 .I teleschorsch
26 has not implemented any options.
27 .SH FILES
28 .I teleschorsch
29 first tries to open
30 .B ~/.teleschorschrc,
31 then 
32 .B /etc/teleschorschrc
33 if the former does not exist.
34 .SH EXAMPLES
35 An entry in
36 .I ~/.teleschorschrc
37 might look like this:
38 .RS
39 .RE
40 [FreeTv]
41 .RE
42 FULLNAME=Free (as in Freedom) Television - Evening News
43 .RE
44 STATICURL=mms://stream.freetv.example.org/evening/news_${Y}${m}${d}.ogg
45 .RE
46 PLAYER=vlc
47 .SH AUTHORS
48 .I teleschorsch
49 is written by Toastfreeware (Philipp Spitzer <philipp@spitzer.priv.at>,
50 gregor herrmann <gregor+debian@comodo.priv.at>) and is released under the GNU GPL version 2.