| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "ICESOUND 1" |
| 58 |
.TH ICESOUND 1 2026-01-18 "icewm\ 4.0.0" "User Commands" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SS NAME |
| 64 |
.IX Subsection "NAME" |
| 65 |
.Vb 1 |
| 66 |
\& icesound \- play audio files when interesting GUI events happen |
| 67 |
.Ve |
| 68 |
.SS SYNOPSIS |
| 69 |
.IX Subsection "SYNOPSIS" |
| 70 |
\&\fBicesound\fR [\fIOPTIONS\fR] |
| 71 |
.SS DESCRIPTION |
| 72 |
.IX Subsection "DESCRIPTION" |
| 73 |
The \fBicewm\fR\|(1) window manager generates so-called GUI events in |
| 74 |
response to interesting actions, like opening or closing of application |
| 75 |
windows, switching of workspace, etc. GUI events are a property of the |
| 76 |
X root window. \fBicewm\fR\|(1) updates this property whenever a new GUI |
| 77 |
event occurs. Interested applications can listen for changes to this |
| 78 |
property. There are nearly twenty GUI events defined. |
| 79 |
.PP |
| 80 |
\&\fBicesound\fR responds to these GUI events by playing audio files. |
| 81 |
These sound files are \fI.wav\fR files located in a \fIsounds\fR sub-directory |
| 82 |
in one of the \fBicewm\fR\|(1) configuration directories. |
| 83 |
.PP |
| 84 |
\&\fBicesound\fR supports several common audio interfaces. These are: ALSA, |
| 85 |
OSS and libAO. These must be enabled during configuration. |
| 86 |
ALSA, OSS and libAO all require support for libsndfile, which is a |
| 87 |
very common library to read audio files. |
| 88 |
.IP \fBALSA\fR 4 |
| 89 |
.IX Item "ALSA" |
| 90 |
\&\fBALSA\fR is rather involved to program and it works, but this could use |
| 91 |
more testing. It plays at most one sound at a time. |
| 92 |
.IP \fBLibAO\fR 4 |
| 93 |
.IX Item "LibAO" |
| 94 |
\&\fBLibAO\fR is a cross-platform audio output library which is a convenient |
| 95 |
wrapper around a significant number of common audio interfaces. It has |
| 96 |
a simple configuration file which is documented in the \fBlibao.conf\fR\|(5) |
| 97 |
manual page. |
| 98 |
.IP \fBOSS\fR 4 |
| 99 |
.IX Item "OSS" |
| 100 |
The \fIOpen Sound System (OSS)\fR is a cross-platform sound interface, |
| 101 |
which is fully supported by \fBicesound\fR. |
| 102 |
.PP |
| 103 |
When multiple audio interfaces are available \fBicesound\fR will examine |
| 104 |
them all until it finds one which it can connect to and then use that |
| 105 |
one. By default it prefers them in the order of: \fBAO\fR, \fBALSA\fR, \fBOSS\fR. |
| 106 |
.SS OPTIONS |
| 107 |
.IX Subsection "OPTIONS" |
| 108 |
.SS "SPECIFIC OPTIONS" |
| 109 |
.IX Subsection "SPECIFIC OPTIONS" |
| 110 |
.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4 |
| 111 |
.IX Item "-d, --display=DISPLAY" |
| 112 |
X11 display used by \fBicewm\fR\|(1) (default: \f(CW$DISPLAY\fR). |
| 113 |
.IP "\fB\-s\fR, \fB\-\-sample\-dir\fR=\fIDIRECTORY\fR" 4 |
| 114 |
.IX Item "-s, --sample-dir=DIRECTORY" |
| 115 |
Specifies a directory with sound files. The default is: |
| 116 |
\&\fR\f(CI$HOME\fR\fI/.config/icewm/sounds\fR, \fI\fR\f(CI$HOME\fR\fI/.icewm/sounds\fR, \fICFGDIR/sounds\fR |
| 117 |
and \fILIBDIR/sounds\fR. See the output of \f(CW\*(C`icewm \-\-directories\*(C'\fR. |
| 118 |
.IP "\fB\-i\fR, \fB\-\-interface\fR={\fBAO\fR|\fBALSA\fR|\fBOSS\fR}[,{\fBAO\fR|\fBALSA\fR|\fBOSS\fR}]*" 4 |
| 119 |
.IX Item "-i, --interface={AO|ALSA|OSS}[,{AO|ALSA|OSS}]*" |
| 120 |
Specifies the audio output interfaces. One or more of: \fBAO\fR, |
| 121 |
\&\fBALSA\fR, \fBOSS\fR separated by comma's (\f(CW\*(C`,\*(C'\fR). |
| 122 |
.IP "\fB\-D\fR, \fB\-\-device\fR=\fIDEVICE\fR" 4 |
| 123 |
.IX Item "-D, --device=DEVICE" |
| 124 |
Backwards compatibility only: the default device. |
| 125 |
Please prefer one of the \fB\-A\fR, \fB\-O\fR or \fB\-S\fR options. |
| 126 |
.IP "\fB\-O\fR, \fB\-\-oss\fR=\fIDEVICE\fR" 4 |
| 127 |
.IX Item "-O, --oss=DEVICE" |
| 128 |
Specifies the OSS device (default: \fI/dev/dsp\fR). |
| 129 |
.IP "\fB\-A\fR, \fB\-\-alsa\fR=\fIDEVICE\fR" 4 |
| 130 |
.IX Item "-A, --alsa=DEVICE" |
| 131 |
Specifies the ALSA device (default: \f(CW\*(C`default\*(C'\fR). |
| 132 |
.IP "\fB\-z\fR, \fB\-\-snooze\fR=\fIMILLISECONDS\fR" 4 |
| 133 |
.IX Item "-z, --snooze=MILLISECONDS" |
| 134 |
Specifies the snooze interval between sound events |
| 135 |
in milliseconds. Default is 500 milliseconds. |
| 136 |
.IP "\fB\-p\fR, \fB\-\-play\fR=\fISOUND\fR" 4 |
| 137 |
.IX Item "-p, --play=SOUND" |
| 138 |
Plays the given sound (name or number) and exits. |
| 139 |
.IP "\fB\-l\fR, \fB\-\-list\-files\fR" 4 |
| 140 |
.IX Item "-l, --list-files" |
| 141 |
Lists the available sound file paths and exits. |
| 142 |
.IP \fB\-\-list\-sounds\fR 4 |
| 143 |
.IX Item "--list-sounds" |
| 144 |
Lists the supported sound file names and exits. |
| 145 |
.IP \fB\-\-list\-interfaces\fR 4 |
| 146 |
.IX Item "--list-interfaces" |
| 147 |
Lists the supported audio interfaces and exits. |
| 148 |
.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4 |
| 149 |
.IX Item "-o, --output=FILE" |
| 150 |
Redirect all output to \fIFILE\fR. |
| 151 |
A leading tilde or environment variable is expanded. |
| 152 |
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 |
| 153 |
.IX Item "-v, --verbose" |
| 154 |
Be verbose and print some information when sound events occur. |
| 155 |
.SS "GENERAL OPTIONS" |
| 156 |
.IX Subsection "GENERAL OPTIONS" |
| 157 |
.IP "\fB\-h\fR, \fB\-\-help\fR" 4 |
| 158 |
.IX Item "-h, --help" |
| 159 |
Print a brief usage statement to \fIstdout\fR and exit. |
| 160 |
.IP "\fB\-V\fR, \fB\-\-version\fR" 4 |
| 161 |
.IX Item "-V, --version" |
| 162 |
Print the program version to \fIstdout\fR and exit. |
| 163 |
.IP "\fB\-C\fR, \fB\-\-copying\fR" 4 |
| 164 |
.IX Item "-C, --copying" |
| 165 |
Print copying permissions to \fIstdout\fR for the program and exit. |
| 166 |
.SS "EXIT STATUS" |
| 167 |
.IX Subsection "EXIT STATUS" |
| 168 |
.IP \fB0\fR 4 |
| 169 |
.IX Item "0" |
| 170 |
Success. |
| 171 |
.IP \fB1\fR 4 |
| 172 |
.IX Item "1" |
| 173 |
General error. |
| 174 |
.IP \fB2\fR 4 |
| 175 |
.IX Item "2" |
| 176 |
Command line error. |
| 177 |
.IP \fB3\fR 4 |
| 178 |
.IX Item "3" |
| 179 |
Subsystems error (i.e cannot connect to server). |
| 180 |
.SS "SEE ALSO" |
| 181 |
.IX Subsection "SEE ALSO" |
| 182 |
\&\fBicewm\fR\|(1), |
| 183 |
\&\fBlibao.conf\fR\|(5), |
| 184 |
\&\fBpadsp\fR\|(1), |
| 185 |
\&\fBaplay\fR\|(1), |
| 186 |
\&\fBalsamixer\fR\|(1). |
| 187 |
.SS BUGS |
| 188 |
.IX Subsection "BUGS" |
| 189 |
Please report bugs at <https://github.com/ice\-wm/icewm/issues>. |
| 190 |
.SS AUTHOR |
| 191 |
.IX Subsection "AUTHOR" |
| 192 |
Brian Bidulock <mailto:[email protected]>. |
| 193 |
.PP |
| 194 |
See \fB\-\-copying\fR for full copyright notice and copying permissions. |
| 195 |
.SS LICENSE |
| 196 |
.IX Subsection "LICENSE" |
| 197 |
\&\fBIceWM\fR is licensed under the GNU Library General Public License. |
| 198 |
See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag |
| 199 |
to display copying permissions. |