fmtools version 1.0.
[fmtools.git] / fm.1
blob902ce5cc76fbd1217efae7b0c81542ddc778e809
1 .TH FM 1 "fm 0.99.1"
2 .SH NAME
3 fm \- control frequency, volume, mute/unmute of FM radio card
4 .SH SYNOPSIS
5 .HP
6 .B fm
8 .B \-h
9 ] [
10 .B \-o
11 ] [
12 .B \-q
13 ] [
14 .B \-d
15 .I device
16 ] [
17 .B \-t
18 .I tuner
20 .B on
22 .B off
24 .B +
26 .B \-
28 .B freq
30 .I volume
32 .SH DESCRIPTION
33 .B fm
34 is a program to control the frequency, volume, and mute/unmute state
35 of an FM radio card, using the video4linux interface introduced in
36 2.1.x series Linux kernels.
37 .SS OPTIONS
38 .PP
39 .TP
40 .B \-h
41 Print a usage message to standard output, and exit.
42 .TP
43 .B \-o
44 Ignore frequency range limits of card.  Use if you suspect that the
45 card supports a wider frequency range than its driver believes.
46 .TP
47 .B \-q
48 Quiet mode.  Keeps information on station and volume from being
49 printed on standard output.
50 .TP
51 \fB\-d \fIdevice
52 Sets \fIdevice\fR as the device to tune.  The default is
53 \fB/dev/radio0\fR.
54 .TP
55 \fB\-t \fItuner
56 Sets \fItuner\fR as the tuner on the selected device to adjust.  The
57 default is tuner 0.  Most radio devices have only a single tuner.
58 .TP
59 .BI freq
60 Frequency to tune the radio to, in MHz.  For instance, \fB88.9\fR
61 specifies a frequency of 88.9 MHz.  AM tuner values are also specified
62 in MHz; for instance, 530 kHz would be specified as \fB.530\fR.
63 .TP
64 .BI on
65 Turn the radio on (unmute).
66 .TP
67 .BI off
68 Turn the radio off (mute).
69 .TP
70 .BI volume
71 Specify the desired volume, in percent.  Not all radio devices support
72 volume control.
73 .TP
74 .BI +
75 Increase the current volume.
76 .TP
77 .BI -
78 Decrease the current volume.
79 .SH FILES
80 .TP
81 \fI$HOME\fB/.fmrc\fR
82 Optional configuration file used to set default volume and
83 volume increments, in percents.  Specify default volume with a line of
84 the form
85 .BI VOL
86 percent.  Specify volume increments with a line of the form
87 .BI INCR
88 percent.
90 If this file does not exist then the defaults are 12.5% volume and 10%
91 volume increments.
92 .SH SEE ALSO
93 .TP
94 Additional documentation:
95 .B /usr/share/doc/fmtools/README
96 .TP
97 The fmtools homepage:
98 .B http://benpfaff.org/fmtools
99 .TP
100 The video4linux webpage:
101 .B http://www.exploits.org/v4l/
102 .SH AUTHORS
103 Russell Kroll <rkroll@exploits.org>, now maintained by Ben Pfaff
104 <blp@cs.stanford.edu.>. This manpage written by Ben Pfaff.