2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
<!ENTITY legal SYSTEM "legal.xml">
5
<!ENTITY appversion "1.3">
6
<!ENTITY manrevision "1.0">
7
<!ENTITY date "October 2002">
8
<!ENTITY app "Gnomeradio">
12
(Do not remove this comment block.)
13
Maintained by the GNOME Documentation Project
14
http://developer.gnome.org/projects/gdp
15
Template version: 2.0 beta
16
Template last modified Mar 12, 2002
20
<article id="index" lang="en">
21
<!-- please do not change the id; for translations, change lang to -->
22
<!-- appropriate code -->
24
<title>&app; Manual V&manrevision;</title>
28
<holder>Jörgen Scheibengruber</holder>
30
<!-- translators: uncomment this:
34
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
39
<publishername>GNOME Documentation Project</publishername>
46
<author role="maintainer">
47
<firstname>Jörgen</firstname>
48
<surname>Scheibengruber</surname>
50
<orgname>GNOME Documentation Project</orgname>
51
<address> <email>mfcn@gmx.de</email> </address>
58
<revnumber>1.0</revnumber>
61
<para role="author">Jörgen Scheibengruber
62
<email>mfcn@gmx.de</email></para>
63
<para role="publisher">GNOME Documentation Project</para>
67
<releaseinfo> This manual describes version &appversion; of &app;.
70
<title>Feedback</title>
71
<para> To report a bug or make a suggestion regarding &app; or this
72
manual, send a e-mail to <ulink url="mailto:mfcn@gmx.de" type="mail">Jörgen Scheibengruber</ulink>. </para>
76
<primary>&app;</primary>
79
<!-- ============= Document Body ============================= -->
80
<!-- ============= Section Introduction ========================= -->
81
<sect1 id="gnomeradio-introduction">
82
<title>Introduction</title>
84
<application>&app;</application> is a FM-Tuner application for the GNOME desktop.
85
It should work with all tuner hardware that is supported by the
86
<ulink url="http://roadrunner.swansea.uk.linux.org/v4l.shtml" type="http">video4linux</ulink> drivers.
89
To start <application>&app;</application> open the applications menu, then choose
91
<guimenu>Multimedia</guimenu>
92
<guimenuitem>&app;</guimenuitem>
94
or type <command>gnomeradio</command> in a shell.
98
<!-- ============= Section Usage ========================= -->
99
<sect1 id="gnomeradio-usage">
101
<!-- ============= SubSection Status Window ========================= -->
102
<sect2 id="gnomeradio-usage-status">
103
<title>Status window</title>
104
<figure id="status-window-fig">
105
<title>The black box in the upper left of &app; is the status window</title>
108
<imageobject><imagedata fileref="figures/status-window.png" format="PNG"/>
111
<phrase>The black box in the upper left of &app; is the status window.</phrase>
117
The status window is located in the upper left corner of the &app; main window. It consists of:
119
<itemizedlist mark="bullet">
122
a label showing wether the reception is mono or stereo,
127
an icon indicating the quality of the reception and
132
the current frequency.
138
<!-- ============= SubSection Frequency Controls========================= -->
139
<sect2 id="gnomeradio-usage-freq">
140
<title>Frequency controls</title>
141
<figure id="freq-controls-fig">
142
<title>Use these controls to change the frequency</title>
145
<imageobject><imagedata fileref="figures/freq-controls.png" format="PNG"/>
148
<phrase>Use these controls to change the frequency.</phrase>
154
The following controls are available to change the frequency:
156
<itemizedlist mark="bullet">
159
Using the slider you can change the frequency very quick.
164
The <guibutton>scan backwards</guibutton> button (left-arrow with bar) will decrease the frequency until if detects the next radio station with good reception.
169
The <guibutton>0.5 MHz backwards</guibutton> button (left-arrow without bar) decreases the frequency by 0.5 MHz.
174
The <guibutton>0.5 MHz forward</guibutton> button (right-arrow without bar) increases the frequency by 0.5 MHz.
179
The <guibutton>scan forwards</guibutton> button (right-arrow with bar) does the same as the "scan backwards" button, but it increases
186
<!-- ============= SubSection Volume Controls========================= -->
187
<sect2 id="gnomeradio-usage-vol">
188
<title>Volume controls</title>
189
<figure id="vol-controls-fig">
190
<title>Use these controls to change the volume</title>
193
<imageobject><imagedata fileref="figures/volume-controls.png" format="PNG"/>
196
<phrase>Use these controls to change the volume.</phrase>
202
Controls available to change the volume:
204
<itemizedlist mark="bullet">
207
Use the slider to adjust the volume. Note that it will only work if you have picked the right <guilabel>mixer
208
source</guilabel>, in the <xref linkend="gnomeradio-settings"/> Dialog.
213
Toggling the button showing the speaker will mute/unmute &app;.
219
<!-- ============= Presets Box ========================= -->
220
<sect2 id="gnomeradio-usage-presets">
221
<title>Presets menubutton</title>
222
<figure id="presets-fig">
223
<title>Choose a preset using the menubutton</title>
226
<imageobject><imagedata fileref="figures/presets-box.png" format="PNG"/>
229
<phrase>Choose a preset using the menubutton.</phrase>
235
Use the menubutton in the upper right to choose a radio station preset.
236
You can edit presets in the <xref linkend="gnomeradio-settings"/> Dialog.
240
<!-- ============= SubSection Misc Controls========================= -->
241
<sect2 id="gnomeradio-usage-misc">
242
<title>Misc. controls</title>
243
<figure id="misc-controls-fig">
244
<title>Remaining controls</title>
247
<imageobject><imagedata fileref="figures/misc-controls.png" format="PNG"/>
250
<phrase>Remaining controls.</phrase>
257
<itemizedlist mark="bullet">
260
The <guibutton>record</guibutton> button opens the <xref linkend="gnomeradio-recording"/> Dialog.
265
Clicking the <guibutton>about</guibutton> button will show a window with some credits.
270
Behind the <guibutton>settings</guibutton> button hides the <xref linkend="gnomeradio-settings"/> Dialog.
275
The <guibutton>quit</guibutton> button will terminate &app;
283
<!-- ============= Section Settings ========================= -->
284
<sect1 id="gnomeradio-settings">
285
<title>Preferences</title>
287
To open the preferences dialog, click the <guibutton>preferences</guibutton> button in the main window.
290
If you are finished click <guibutton>OK</guibutton> to accept your changes
291
or <guibutton>Cancel</guibutton> to undo the changes.
293
<!-- ============= Misc Settings ========================= -->
294
<sect2 id="gnomeradio-settings-misc">
295
<title>General preferences</title>
296
<figure id="gnomeradio_settings_misc-fig">
297
<title>General preferences</title>
300
<imageobject><imagedata fileref="figures/settings-misc.png" format="PNG"/>
303
<phrase>General preferences.</phrase>
310
<itemizedlist mark="bullet">
313
<guilabel>Radio Device:</guilabel> Enter your radio device. Unless you have several radio
314
tuners installed this is usually /dev/radio.
319
<guilabel>Mixer Source:</guilabel> Choose the mixer source that is able to control the volume
320
of your radio tuner. The combobox lists all devices that you can choose as a recording source.
321
You should usually pick one of these, otherwise you won't be able to record radio. If you have
322
set up own names for the sources in gnome volume control, these names will be shown in paranthesis
323
behind the "official" name.
328
<guilabel>Mute on Exit:</guilabel> Uncheck this checkbox, if you want that the radio keeps on
329
playing after you have terminated &app;.
334
<!-- ============= Settings Presets ========================= -->
335
<sect2 id="gnomeradio-settings-presets">
336
<title>Editing presets</title>
337
<figure id="gnomeradio_settings_presets-fig">
338
<title>Editing presets</title>
341
<imageobject><imagedata fileref="figures/settings-presets.png" format="PNG"/>
344
<phrase>Editing presets.</phrase>
350
Here you can add some preset radio stations. You can select one of these
351
using the <xref linkend="gnomeradio-usage-presets"/> or your
352
<xref linkend="gnomeradio-lirc"/> remote control.
354
<itemizedlist mark="bullet">
357
<guilabel>Name:</guilabel> Enter a name for the preset (usually the name
358
of the radio station).
363
<guilabel>Frequency:</guilabel> Choose the frequency for the radio station.
368
Click the button <guibutton>add preset</guibutton> (shows a +) to add the preset
374
The button <guibutton>remove preset</guibutton> (shows a -) will remove the currently
375
selected preset from the list.
380
Use the button <guibutton>update preset</guibutton> to update the selected preset with
381
the values currently entered in the name and frequency entries.
388
<!-- ============= Section Recording ========================= -->
389
<sect1 id="gnomeradio-recording">
390
<title>Recording</title>
392
You can use gnomeradio to (live)record radio. In this dialog you
393
have to give some information, on how this shall be done.
395
<important><para>You need the external application <application>sox</application>
396
installed in order to use the recording functionality of &app;.
397
If you want to record as MP3,
398
you have to install a MP3 encoder, too. Currently the MP3 encoders
399
<ulink url="http://www.mp3dev.org/mp3/" type="http">lame</ulink> and
400
<ulink url="http://bladeenc.mp3.no/" type="http">bladeenc</ulink> are supported.
401
To record files as ogg vorbis you need
402
<ulink url="http://www.xiph.org/ogg/vorbis/index.html" type="http">oggenc</ulink>.
405
To open this dialog, click the <guibutton>record</guibutton> button in the main window.
408
Use the <guibutton>Start</guibutton> button to start recording.
409
Otherwise click <guibutton>Cancel</guibutton> to close the dialog.
411
<!-- ============= Recording: General ========================= -->
412
<sect2 id="gnomeradio-recording-general">
413
<title>General settings</title>
414
<figure id="gnomeradio_recording-general-fig">
415
<title>General recording settings</title>
418
<imageobject><imagedata fileref="figures/recording-general.png" format="PNG"/>
421
<phrase>General recording settings.</phrase>
428
<itemizedlist mark="bullet">
431
<guilabel>Audio Device:</guilabel> Enter your audio device. Unless you have several soundcards
432
installed this is usually /dev/audio.
437
<guilabel>Filename:</guilabel> Choose a filename and destination for the file in which the audio
438
data should be stored. This file should usually have the suffix ".wav", in case you want to record
439
as wave data, ".mp3", in case the audio should be stored in the mp3-format or ".ogg", for ogg vorbis
445
<guilabel>Record as:</guilabel> Select <guilabel>Wave (.wav)</guilabel>, if you want the audio
446
data to be stored in the wave format (uncompressed - about 10 megabyte per minute playlength).
447
Otherwise choose <guilabel>MP3/Ogg (.mp3/.ogg)</guilabel> which will lead to a much lower filesize, but
448
also a little bit lower audio quality.
454
<!-- ============= Recording: Wave ========================= -->
455
<sect2 id="gnomeradio-recording-wav">
456
<title>Wave settings</title>
457
<figure id="gnomeradio_recording-wav-fig">
458
<title>The wave settings</title>
461
<imageobject><imagedata fileref="figures/recording-wav.png" format="PNG"/>
464
<phrase>The wave settings.</phrase>
470
These settings apply to the mp3 file, too.
472
<itemizedlist mark="bullet">
475
<guilabel>Sample rate:</guilabel> Choose a sample rate for the recording audio file. Higher sampling
476
rate means better quality. 44100 kHz is a good default (aprox. CD quality). If the reception
477
is bad you can take a lower sampling rate, because the quality won't be that good anyways.
482
<guilabel>Sample format:</guilabel> Available options are 8 or 16 bit. Usually you want to
488
<guilabel>Record in:</guilabel> Select <guilabel>stereo</guilabel>, if you want to record in
489
stereo or <guilabel>mono</guilabel> otherwise. It probably doen't make much sense to record
490
in stereo, if the reception is only mono.
496
<!-- ============= Recording: MP3 ========================= -->
497
<sect2 id="gnomeradio-recording-mp3">
498
<title>MP3/Ogg settings</title>
499
<figure id="gnomeradio_recording-mp3-fig">
500
<title>The MP3/Ogg settings</title>
503
<imageobject><imagedata fileref="figures/recording-mp3.png" format="PNG"/>
506
<phrase>The MP3 settings.</phrase>
513
<itemizedlist mark="bullet">
516
<guilabel>Encoder:</guilabel> A list of supported MP3/Ogg encoders that you have installed. Choose the one you like the
517
best. Currently <ulink url="http://www.mp3dev.org/mp3/" type="http">lame</ulink>,
518
<ulink url="http://bladeenc.mp3.no/" type="http">bladeenc</ulink> and
519
<ulink url="http://www.xiph.org/ogg/vorbis/index.html" type="http">oggenc</ulink> are supported.
520
The encoder must be in your PATH, otherwise &app; can't find it.
525
<guilabel>Bitrate:</guilabel> Choose a bitrate. This will have the largest impact
526
on the size and quality of the resulting MP3/Ogg file. The higher the bitrate the better the
527
quality. 128 kb/s is usually a good value which will result in files that are aprox. 1 MB
528
per minute playlength.
533
<!-- ============= Recording: status window ========================= -->
534
<sect2 id="gnomeradio-recording-status">
535
<title>Recording status window</title>
536
<figure id="gnomeradio_recording_status-fig">
537
<title>The status window</title>
540
<imageobject><imagedata fileref="figures/recording_status.png" format="PNG"/>
543
<phrase>The status window.</phrase>
549
Click <guibutton>Stop Recording</guibutton> to stop the recording and return to
550
the main window. The window shows the name and size of the file in which the audio
551
data is being stored.
556
<!-- ============= Section Shortcuts ========================= -->
557
<sect1 id="gnomeradio-shortcuts">
558
<title>Keybindings</title>
560
&app; has a few keybindings.
562
<table frame="topbot">
563
<title>Keyboard shortcuts in &app;</title>
564
<tgroup cols="2" colsep="0" rowsep="0">
565
<colspec colwidth="20.00*"/>
566
<colspec colwidth="20.00*"/>
569
<entry>Shortcut</entry>
570
<entry>Description</entry>
587
Open the recording dialog.
595
Mute/unmute the volume.
635
Select previous preset.
660
<!-- ============= Section LIRC ========================= -->
661
<sect1 id="gnomeradio-lirc">
664
You can use a remote control supported by <ulink url="http://www.lirc.org/" type="http">LIRC</ulink>
665
(Linux infrared remote control) to control <application>&app;</application>.
668
<para>Your remote control will only work if <application>&app;</application> has been compiled with
669
LIRC support enabled. If you are unsure wether this is the case or not, check the about dialog.
672
<!-- ============= LIRC: .lircrc ========================= -->
673
<sect2 id="gnomeradio-lirc-lircrc">
674
<title>The .lircrc config file</title>
676
In the file <filename>.lircrc</filename> in your home directory, you set up which keys
677
on your remote control you want to associate with actions in &app;. A typical
678
section in the file looks like this:
680
<example><title>Example for a .lircrc section</title>
691
This associates the button VOL+ (Attention: Buttonnames are remote control specific)
692
with the command "volume up". "repeat = 1" means that in case you keep the button of
693
your remote control pressed, the command is repeated as long as you press the button.
697
For more information, please consult the LIRC documentation.
701
<!-- ============= LIRC: commands ========================= -->
702
<sect2 id="gnomeradio-lirc-commands">
703
<title>Available commands</title>
705
The following commands are available in &app;:
707
<table frame="topbot">
708
<title>LIRC commands</title>
709
<tgroup cols="2" colsep="0" rowsep="0">
710
<colspec colwidth="20.00*"/>
711
<colspec colwidth="20.00*"/>
714
<entry>Command</entry>
715
<entry>Description</entry>
721
<command>tune up</command>
729
<command>tune down</command>
737
<command>preset up</command>
745
<command>preset down</command>
748
Select previous preset.
753
<command>volume up</command>
761
<command>volume down</command>
769
<command>mute</command>
772
Mute/unmute the volume.
777
<command>quit</command>
785
<command>preset x</command>
788
Select preset x + 1 (where x is between 0 and 9)
added
removed
help/C/gnomeradio.xml
