wmradio/doc/wmradio.1

   1 .TH WMRADIO 1
   2 .SH NAME
   3 wmradio \- dockable FM radio for WindowMaker.
   4 .SH SYNOPSIS
   5 .B wmradio
   6 .I "[options]"
   7 .B wmradio-remote COMMAND
   8 .I "[param]"
   9 .SH OPTIONS
  10 .LP
  11 .TP
  12 .B \-q|\-\-dont\-quit
  13 Start in "Don't quit" mode.
  14 .TP
  15 .B \-m|\-\-start\-muted
  16 Start and don't open the radio device.
  17 .TP
  18 .B \-h|\-\-help
  19 Print help page and quit
  20 .SH wmradio-remote
  21 is simple shell script. It writes commands into wmradio's named pipe.
  22 Example:
  23 .I wmradio-remote SET_PRESET 3
  24 .SH wmradio-config.py
  25 GUI application for setting wmradio
  26 .SH Tunning
  27 You can tune the radio by clicking into <left> or <right> buttons in
  28 the skin. Fine tunning is posible to do by <control-click> in these buttons.
  29 .SH Preset stations
  30 Current frequency is stored in the buttons
  31 memory by <control-click> in the station button .
  32 When program quits trough the <power> button, all freq are saved in
  33 the ~/.wmradio file.
  34 .SH Mouse wheel support
  35 In the diaplay the mouse wheel changes stations with names.
  36 With <shift-wheel> it change frequency (<shift-control-wheel>
  37 = fine tuning). In other place the Mouse wheel changes
  38 the preset station.
  39 .SH Normal mode
  40 In this mode, program mutes the radio, closes the device and quits by clicking
  41 into <power> button. <control-power> click close the device only, the program
  42 doesn't quit. Next <control-power> click unmutes the radio.
  43 .SH Don't quit mode
  44 In this mode, program mutes the radio and closes the device by click into <power>.
  45 Next <power> click unmutes the radio. <control-power> click terminates the program.
  46 .SH Skins
  47 Every skin is specified in two files. The XPM bitmap file and the text description file.
  48 There are coordinates and dimensions of skin parts (as buttons and digits) in this
  49 file. You can change the skin by editing your ~/.wmradio file.
  50 .P
  51 In the skin image is the background in left top corner. Default size is
  52 56x56 pixels. Buttons and digits are around this. Button is defined by
  53 6 numbers.
  54 .P
  55 name=xdest,ydest,xsource,ysource,width,height
  56 .P
  57 Other state of button (as pressed) must be next to normal state image.
  58 Take a look at default.xpm and default.skin. xsource and ysource are
  59 ignored in display line.
  60 .P
  61 Digits are specified with more dimensions
  62 .P
  63 digits=xdest,ydest,xsrc,ysrc,width_of_0,...,9,width_of.,height
  64 .P
  65 xpm line contains the name of bitmap
  66 .P
  67 Icon size is defided with two lines
  68 .P
  69 iconwidth=width
  70 .br
  71 iconheight=height
  72 .SH FILES
  73 .B ~/.wmradio
  74 .SH AUTHOR
  75 This manual page was written by Tomas Cermak
  76 .br
  77 <Tomas.Cermak(at)email.cz>.
  78