1###################################################################
2## GQradio 1.9.2 (February 24, 2005) ##
3## ##
4## Copyright (C) 1999 - 2005 by John Ellis. ##
5## ##
6## Use at your own risk! ##
7## ##
8## This software released under the GNU General Public License. ##
9## Please read the COPYING file for more information. ##
10###################################################################
11
12Author: John Ellis <johne@verizon.net>
13e-mail: gqview@users.sourceforge.net
14homepage: http://gqmpeg.sourceforge.net
15
16======== Major sections of this document
17
18 - Requirements
19 - Notes and changes for this release
20 - Installation
21 - Description / Features
22 - Command Line options
23 - Skins
24 - Documentation (brief) [lists keyboard controls]
25 - Skin editing notes
26 - Credits
27
28======== Requirements
29
30 GTK+ >= 2.4: ftp://ftp.gtk.org/pub/gtk
31
32 one of the following:
33
34 (Linux) supported video4linux radio tuner (uses /dev/radio)
35 (FreeBSD) supported bktr radio tuner (uses /dev/tuner)
36
37 --------------------------
38
39======== Notes and changes for this release [section:release_notes]
40
41 Changes:
42
43 + Now requires GTK+ >= 2.4
44 + Add volume boost option for tuner drivers that initialize with
45 low volume.
46 - Update to dialogs and preferences to newer ui styles.
47 - Clean up build environment for latest autoconf tools and switch
48 to glib-gettext in place of direct use of gettext.
49 * Fix text size issues in skin engine.
50 * Fix skin menus and other popup window placement bugs.
51
52
53 Notes:
54
55 > Please see the Keyboard section below for description of keyboard
56 commands, and briefly how to set presets.
57
58 > Brief explanation of tuner options in preferences:
59
60 Device:
61 /dev device used to access radio card, default is /dev/radio.
62 Use frequency limits reported by driver:
63 When enabled, uses the frequency range that the radio driver claims to
64 support. When disabled (the default), 87.5 to 108.0 Mhz is used.
65 Frequency step:
66 The increment to use when tuning manually. Default is 10 (0.1 Mhz).
67 When this is set to 20 (0.2 Mhz), the odd numbers are used, in
68 alignment with US frequencies (x.0, x.3, x.5, etc.).
69
70 Bugs:
71
72 none ? --- doubt it! ;)
73
74======== Installation
75
76 Compilation: ./configure ; make
77
78 - To build an RPM binary:
79 on RedHat 6.x, 7.x use 'rpm -tb gqradio-x.x.x.tar.gz'.
80 on RedHat 8.x use 'rpmbuild -tb gqradio-x.x.x.tar.gz'.
81 on other rpm based distros, try rpm, if that fails try rpmbuild.
82
83 Installation: make install
84
85 Removal: make uninstall
86
87======== Description / Features
88
89 GQradio interfaces with radio tuners through video4linux. Also supports
90 FreeBSD bktr devices.
91
92 Features:
93
94 > Presets.
95 > Auto tune seeks to next available station.
96 > Auto setting of the preset list (auto scan).
97 > Skins.
98
99======== Command Line options:
100
101 Please see gqradio --help for a list.
102
103======== Skins
104
105 Uses SLIK (SimpLIstic sKin interface), to edit skins use the tilde '~' key.
106
107 Also see (Skin editing notes), below.
108
109 To specify a skin use the -skin:skinfile command line parameter (see above).
110 When specifying a default skin in the config dialog, the skin must reside
111 in HOME/.gqradio/skins
112 If valid, a new default skin is loaded when 'ok' or 'apply' is pressed.
113
114======== Documentation (brief) [section:documentation]
115
116 Keyboard shortcuts:
117
118 [Space], N Seek up, using current seek mode.
119 [BackSpace], B Seek down, using current seek mode.
120
121 [Up] Seek up, first setting auto seek mode.
122 [Down] Seek down, first setting auto seek mode.
123
124 [Right] Seek up, first setting manual seek mode.
125 [Left] Seek down, first setting manual seek mode.
126
127 [PageUp] Select next available preset.
128 [PageDown] Select previous available preset.
129
130 [Enter] Toggle seek mode.
131
132 P Start preset selection, second press sets the
133 selection.
134 (Select the preset number by seeking up/down,
135 clicking the corresponding row in the preset list,
136 or by direct number entry format 0##, see below.)
137 [Escape] Cancel preset selection.
138
139 Delete Clear current preset.
140 [CTRL] Delete Clear preset list.
141
142 ###.## (frequency entry) Jump to a frequency. If both decimal places
143 are entered change is instant, otherwise delays
144 one second (waiting for additional numbers, or
145 cancel by pressing Escape or any non-numerical
146 key). Invalid frequencies are ignored.
147 Example: Entering 99.5 will change the frequency
148 after one second, but entering 99.50 will change
149 it instantly.
150 0## (preset entry) Jump to a preset, if set. Entering three digits
151 (example 025) will change the preset immediately,
152 fewer will incur a one second delay, which works
153 the same as frequency entry, above.
154 Note: The leading zero is required, this is how
155 preset (versus frequency) entry is determined.
156
157 - Decrease volume.
158 +, = Increase volume.
159 [CTRL] - Adjust balance left.
160 [CTRL] +, [CTRL] = Adjust balance Right.
161 M Toggle mute.
162
163 E, [CTRL] E, [CTRL] P Open preset editor.
164 O, [CTRL] O Open preferences.
165
166 I Iconify window.
167 Q Quit.
168 Q + [Shift] Quit without muting radio output.
169
170 [ Scrolls preset list up.
171 ] Scrolls preset list down.
172
173 ~ Start skin editor.
174 ! Print skin debugging info.
175
176
177======== Skin editing notes
178
179 Mouse control:
180 - The mouse in the skin editor uses these buttons in the skin display area:
181 - Button 1 : Same as in the normal main window (press buttons, etc.)
182 - Button 2 : Click to select widget, drag to move selected widget.
183 (when click to focus is disabled, widgets are always draggable)
184 - Button 3 : same as button 2
185
186 Extracting widget from other skins:
187 - To generate a list, and use widgets from any installed skin, press the
188 'extract' button from the 'add' dialog of the skin editor.
189
190 Editing / extracting widgets from the built-in (default) skin:
191 - To re-use widgets from the default skin, first load them
192 into the skin editor and save them as a new skin. To make
193 the new widgets show up in the widget lists, close the skin editor, then
194 reopen it and press the extract button in the add dialog.
195
196 Skin toggle buttons:
197 - The "skin_toggle" button is a special case, the data field must contain
198 the filename of the skin the button is to switch to. If the data field is
199 left blank the default skin (skindata) will be loaded. If the filename
200 does not exist or is an invalid skin file, the button will do nothing.
201
202 (NOTE on naming of the skindata type files: the widget extraction
203 feature only extracts widgets from skins defined by files matching the
204 pattern "skindata*" but _not_ including '.bak'. All others are ignored.)
205
206 Writing a skin to disk:
207 - When saving a skin, existing files are never overwritten: the skindata
208 file is backed up with an extension of .bak or .bakXXX; graphics files
209 will first be compared by file length and checksum, if they match it
210 will keep the existing file, otherwise the new graphics file will be
211 written to a new filename with an appended number increment (name_1.png).
212
213 Dial and Slider 'item link key':
214 - Dials and sliders have a 'Item link key' field, this is for use when you
215 want an item with that key to update with the dial or slider in such a
216 way that the dial/slider handle is drawn over top of the item. This is
217 useful for example when it is desired that a slider that controls the
218 volume also shows the volume level. If you want the item to be the only
219 thing displayed with slider-like interaction, the slider handle size can
220 be set to zero by specifying a trough length equal to the image
221 dimensions.
222
223 Limits:
224 - You can add as many widgets of the same function as you want and they
225 will all work. (For example 100 play buttons :).
226
227 Invalid UI keys:
228 - If an invalid key is assigned to a widget, the widget will still load
229 but be ignored when activated/operated.
230
231 Detailed skin specs:
232 - See SKIN-SPECS.
233
234
235======== Thanks go to the following for fixes, additions, and patches:
236
237 Translations:
238
239 Eric Lassauge <lassauge@users.sourceforge.net>
240 for French translation
241
242 Fixes, additions, and patches:
243
244 Serdar Ozler <sozler@sitebest.com>
245 for FreeBSD bktr support
246
247===========
248
249