wmifinfo: Add manpage.
[dockapps.git] / AlsaMixer.app / README
blob7ca7c10fafab3ea357cb3322ea14cf0652180cf6
1 Description
2 --------------------------------------------------------------
3 AlsaMixer.app is a mixer utility for Linux systems with ALSA sound driver.
4 It is designed to be docked in Window Maker (and other wms). This utility has
5 three volume controllers that can be configured to handle any sound source,
6 he default sources are 'Master', 'PCM' and 'CD' volume. Sound sources can be
7 easily muted and there is also wheel mouse support.
8 The whole GUI and command parsing was taken from Mixer.app (see old doc
9 for URL's), only connection to ALSA driver was added.
12 Hints
13 --------------------------------------------------------------
14 Error led:
15         If the led on Mixer.app is red an error message has
16         been printed to stderr and something is not working
17         correctly. If the led is green everything is working ok.
18         (Error led doesn't work in AlsaMixer.app, TODO)
20 Mute:
21         Right click on a volume controller to mute the sound
22         source. The button will then have a red led in one corner.
23         Right click again to restore the volume. If a muted sound
24         source is modified by another application Mixer.app will
25         automaticaly release its muted state.
27 Wheel mouse:
28         If you have a wheel mouse (where the wheel is configured as
29         Button4 and Button5) you can control the volume by just moving
30         the mouse over Mixer.app and roll the wheel up and down. Use
31         the command line option -w to specify which slider that should
32         react to the wheel movement.
34 Label:
35         If you run multiple instances of AlsaMixer.app you might want
36         to be able to tell them apart. This can easily be done
37         by setting a label to each one of them. By using the -l
38         option you can add a little text label at the bottom of
39         the mixer.
41 Save volume settings:
42         Use the option -S (and -f <file>) if you want the volume
43         settings to be saved when AlsaMixer.app exits, and then
44         -L to be loaded again when AlsaMixer.app is started the next time.
45         When not using -f the settings are saved in/loaded from
46         ~/GNUstep/Defaults/AlsaMixer. Use the -f <file> option
47         if you want to use a different file.
48         (TODO: mute states aren't saved/loaded)
50 Configurable middle click:
51         By default, when you middle click anywhere inside application
52         window, app tries to load default mixer setting from default
53         or explicitly configured (-f) file. If file doesn't exist,
54         nothing happens.
55         You can also configure AlsaMixer.app to run command (i.e.
56         better mixer) on middle click by using -e <command> option.
58 Bugs
59 --------------------------------------------------------------
60 If you discover any bugs in this software, please send a
61 bugreport to xhlavk00@stud.fit.vutbr.cz and describe the problem.
64 Special thanks to
65 --------------------------------------------------------------
66 Per Liden <per@fukt.bth.se> - original author of Mixer.app
67 David Sauer <davids@iol.cz>
68 Theo Schlossnagle <theo@omniti.com>
69 Alban Hertroys <dalroi@wit401310.student.utwente.nl>
72 Copyright
73 --------------------------------------------------------------
74 AlsaMixer.app, 2004, Petr Hlavka
75 Mixer.app is copyright (c) 1998-2002 by Per Liden and is
76 licensed through the GNU General Public License. Read the
77 COPYING file for the complete license.
79 Minor parts of this code were taken from asmixer by Rob Malda
80 (malda@slashdot.org)