Rewrite to use video4linux2 API.
[fmtools.git] / fm.1
blob8d65be8f2989d0412610600b6ee38388ac5449c5
1 .TH FM 1 "fm 1.0.2"
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
19 ] [
20 .B \-T
21 .B none
23 .B forever
25 .I time
27 .B on
29 .B off
31 .B +
33 .B \-
35 .B freq
37 .I volume
39 .SH DESCRIPTION
40 .B fm
41 is a program to control the frequency, volume, and mute/unmute state
42 of an FM radio card, using the video4linux interface introduced in
43 2.1.x series Linux kernels.
44 .SS OPTIONS
45 .PP
46 .TP
47 .B \-h
48 Print a usage message to standard output, and exit.
49 .TP
50 .B \-o
51 Ignore frequency range limits of card.  Use if you suspect that the
52 card supports a wider frequency range than its driver believes.
53 .TP
54 .B \-q
55 Quiet mode.  Keeps information on station and volume from being
56 printed on standard output.
57 .TP
58 \fB\-d \fIdevice
59 Sets \fIdevice\fR as the device to tune.  The default is
60 \fB/dev/radio0\fR.
61 .TP
62 \fB\-t \fItuner
63 Sets \fItuner\fR as the tuner on the selected device to adjust.  The
64 default is tuner 0.  Most radio devices have only a single tuner.
65 .TP
66 \fB\-T none \fR| \fBforever \fR| \fItime
67 After tuning, sleep for the time specified or forever.  Time is
68 specified in seconds by default.  A suffix of
69 .B m
70 indicates minutes,
71 .B h
72 indicates hours, or
73 .D d
74 indicates days.
75 .IP
76 The
77 .B -T
78 option is useful with radio card drivers that only maintain the tuner
79 settings while the tuner's file descriptor remains open.  Try using
80 this option if running
81 .B fm
82 ordinarily produces only a single "pop" from your speakers.
83 .TP
84 .BI freq
85 Frequency to tune the radio to, in MHz.  For instance, \fB88.9\fR
86 specifies a frequency of 88.9 MHz.  AM tuner values are also specified
87 in MHz; for instance, 530 kHz would be specified as \fB.530\fR.
88 .TP
89 .BI on
90 Turn the radio on (unmute).
91 .TP
92 .BI off
93 Turn the radio off (mute).
94 .TP
95 .BI volume
96 Specify the desired volume, in percent.  Not all radio devices support
97 volume control.
98 .TP
99 .BI +
100 Increase the current volume.
102 .BI -
103 Decrease the current volume.
104 .SH CONFIGURATION
105 .B fm
106 reads \fI$HOME\fB/.fmrc\fR, if it exists, to obtain default settings.
107 Each line may take one of the following forms:
109 .BR VOL \ percent
110 Specifies default volume (default: 12.5%).
112 .BR INCR \ percent
113 Volume increment used for
114 .B +
116 .B -
117 options (default: 10%).
119 .BR TIME
120 Default sleep time (default:
121 .BR none ).
123 All other lines are ignored.
124 .SH SEE ALSO
126 Additional documentation:
127 .B /usr/share/doc/fmtools/README
129 The fmtools homepage:
130 .B http://benpfaff.org/fmtools
131 .SH AUTHORS
132 Russell Kroll <rkroll@exploits.org>, now maintained by Ben Pfaff
133 <blp@cs.stanford.edu>.  Sleep time feature contributed by Dave Ulrick
134 <d-ulrick@insightbb.com>.  This manpage written by Ben Pfaff.