1ICESOUND(1)                      User Commands                     ICESOUND(1)
2
3
4
5   NAME
6        icesound - play audio files when interesting GUI events happen
7
8   SYNOPSIS
9       icesound [OPTIONS]
10
11   DESCRIPTION
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 workspace, etc.  GUI events are a property of the X root
15       window.  icewm(1) updates 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
19       icesound responds to these GUI events by playing audio files.  These
20       sound files are .wav files located in a sounds sub-directory in one of
21       the icewm(1) configuration directories.
22
23       icesound supports several common audio interfaces.  These are: ALSA,
24       OSS and libAO.  These must be enabled during configuration.  ALSA, OSS
25       and libAO all require support for libsndfile, which is a very common
26       library to read audio files.
27
28       ALSA
29           ALSA is rather involved to program and it works, but this could use
30           more testing.  It plays at most one sound at a time.
31
32       LibAO
33           LibAO is a cross-platform audio output library which is a
34           convenient wrapper around a significant number of common audio
35           interfaces.  It has a simple configuration file which is documented
36           in the libao.conf(5) manual page.
37
38       OSS The Open Sound System (OSS) is a cross-platform sound interface,
39           which is fully supported by icesound.
40
41       When multiple audio interfaces are available icesound will examine them
42       all until it finds one which it can connect to and then use that one.
43       By default it prefers them in the order of: AO, ALSA, OSS.
44
45   OPTIONS
46   SPECIFIC OPTIONS
47       -d, --display=DISPLAY
48           X11 display used by icewm(1) (default: $DISPLAY).
49
50       -s, --sample-dir=DIRECTORY
51           Specifies a directory with sound files.  The default is:
52           $HOME/.config/icewm/sounds, $HOME/.icewm/sounds, CFGDIR/sounds and
53           LIBDIR/sounds.  See the output of "icewm --directories".
54
55       -i, --interface={AO|ALSA|OSS}[,{AO|ALSA|OSS}]*
56           Specifies the audio output interfaces. One or more of: AO, ALSA,
57           OSS separated by comma's (",").
58
59       -D, --device=DEVICE
60           Backwards compatibility only: the default device.  Please prefer
61           one of the -A, -O or -S options.
62
63       -O, --oss=DEVICE
64           Specifies the OSS device (default: /dev/dsp).
65
66       -A, --alsa=DEVICE
67           Specifies the ALSA device (default: "default").
68
69       -z, --snooze=MILLISECONDS
70           Specifies the snooze interval between sound events in milliseconds.
71           Default is 500 milliseconds.
72
73       -p, --play=SOUND
74           Plays the given sound (name or number) and exits.
75
76       -l, --list-files
77           Lists the available sound file paths and exits.
78
79       --list-sounds
80           Lists the supported sound file names and exits.
81
82       --list-interfaces
83           Lists the supported audio interfaces and exits.
84
85       -o, --output=FILE
86           Redirect all output to FILE.  A leading tilde or environment
87           variable is expanded.
88
89       -v, --verbose
90           Be verbose and print some information when sound events occur.
91
92   GENERAL OPTIONS
93       -h, --help
94           Print a brief usage statement to stdout and exit.
95
96       -V, --version
97           Print the program version to stdout and exit.
98
99       -C, --copying
100           Print copying permissions to stdout for the program and exit.
101
102   EXIT STATUS
103       0   Success.
104
105       1   General error.
106
107       2   Command line error.
108
109       3   Subsystems error (i.e cannot connect to server).
110
111   SEE ALSO
112       icewm(1), libao.conf(5), padsp(1), aplay(1), alsamixer(1).
113
114   BUGS
115       Please report bugs at <https://github.com/bbidulock/icewm/issues>.
116
117   AUTHOR
118       Brian Bidulock <mailto:bidulock@openss7.org>.
119
120       See --copying for full copyright notice and copying permissions.
121
122   LICENSE
123       IceWM is licensed under the GNU Library General Public License.  See
124       the COPYING file in the distribution or use the --copying flag to
125       display copying permissions.
126
127
128
129icewm 3.4.4                       2023-11-03                       ICESOUND(1)