1ICESOUND(1) User Commands ICESOUND(1)
2
6 icesound - play audio files when interesting GUI events happen
7
9 icesound [OPTIONS]
10
12 The icewm(1) window manager generates so-called GUI events in response
13 to interesting actions, like opening or closing of application windows,
14 switching of work space, etc. GUI events are a property of the X root
15 window. icewm(1) changes this property whenever a new GUI event
16 occurs. Interested applications can listen for changes to this
17 property. There are nearly twenty GUI events defined.
18 icesound is an application, which is one of the icewm(1) applications,
20 which responds to these GUI events by playing audio files. These sound
21 files are .wav files located in a sounds sub-directory in one of the
22 icewm(1) configuration directories.
23 icesound supports several common audio interfaces. These are: ALSA,
25 OSS and libAO. These must be enabled during configuration. ALSA, OSS
26 and libAO all require support for libsndfile, which is a very common
27 library to read audio files.
28 ALSA
30 ALSA is rather involved to program and it works, but this could use
31 more testing. It plays at most one sound at a time.
32 LibAO
34 LibAO is a cross-platform audio output library which is a
35 convenient wrapper around a significant number of common audio
36 interfaces. It has a simple configuration file which is documented
37 in the libao.conf(5) manual page.
38 OSS The Open Sound System (OSS) is a cross-platform sound interface,
40 which is fully supported by icesound.
41 When multiple audio interfaces are available icesound will examine them
43 all until it finds one which it can connect to and then use that one.
44 By default it prefers them in the order of: AO, ALSA, OSS.
45
47 SPECIFIC OPTIONS
48 -d, --display=DISPLAY
49 X11 display used by icewm(1) (default: $DISPLAY).
50 -s, --sample-dir=DIRECTORY
52 Specifies a directory with sound files. The default is:
53 $HOME/.config/icewm/sounds, $HOME/.icewm/sounds, CFGDIR/sounds and
54 LIBDIR/sounds. See the output of "icewm --directories".
55 -i, --interface={AO|ALSA|OSS}[,{AO|ALSA|OSS}]*
57 Specifies the audio output interfaces. One or more of: AO, ALSA,
58 OSS separated by commas (",").
59 -D, --device=DEVICE
61 Backwards compatibility only: the default device. Please prefer
62 one of the -A, -O or -S options.
63 -O, --oss=DEVICE
65 Specifies the OSS device (default: "default").
66 -A, --alsa=DEVICE
68 Specifies the ALSA device (default: /dev/dsp).
69 -z, --snooze=MILLISECONDS
71 Specifies the snooze interval between sound events in milliseconds.
72 Default is 500 milliseconds.
73 -p, --play=SOUND
75 Plays the given sound (name or number) and exits.
76 -l, --list-files
78 Lists the available sound file paths and exits.
79 --list-sounds
81 Lists the supported sound file names and exits.
82 --list-interfaces
84 Lists the supported audio interfaces and exits.
85 -v, --verbose
87 Be verbose and print some information when sound events occur.
88 GENERAL OPTIONS
90 -h, --help
91 Print a brief usage statement to stdout and exit.
92 -V, --version
94 Print the program version to stdout and exit.
95 -C, --copying
97 Print copying permissions to stdout for the program and exit.
98
100 0 Success.
101 1 General error.
103 2 Command line error.
105 3 Subsystems error (i.e cannot connect to server).
107
109 icewm(1), libao.conf(5), padsp(1), aplay(1), alsamixer(1).
110
112 icesound had no known bugs at the time of release. Please report bugs
113 for current versions to the source code repository at
114 <https://github.com/bbidulock/icewm/issues>.
115
117 Brian Bidulock <mailto:bidulock@openss7.org>.
118 See --copying for full copyright notice and copying permissions.
120
122 IceWM is licensed under the GNU Library General Public License. See
123 the COPYING file in the distribution or use the --copying flag to
124 display copying permissions.
125icewm 2.3.0 2021-04-02 ICESOUND(1)