Debian Codegraph @

upstream/opensuse-tumbleweed/man1/icesound.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "ICESOUND 1"
61 .TH ICESOUND 1 2025-08-31 "icewm 3.9.0" "User Commands"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SS NAME
67 .IX Subsection "NAME"
68 .Vb 1
69 \& icesound \- play audio files when interesting GUI events happen
70 .Ve
71 .SS SYNOPSIS
72 .IX Subsection "SYNOPSIS"
73 \&\fBicesound\fR [\fIOPTIONS\fR]
74 .SS DESCRIPTION
75 .IX Subsection "DESCRIPTION"
76 The \fBicewm\fR\|(1) window manager generates so\-called GUI events in
77 response to interesting actions, like opening or closing of application
78 windows, switching of workspace, etc. GUI events are a property of the
79 X root window. \fBicewm\fR\|(1) updates this property whenever a new GUI
80 event occurs. Interested applications can listen for changes to this
81 property. There are nearly twenty GUI events defined.
82 .PP
83 \&\fBicesound\fR responds to these GUI events by playing audio files.
84 These sound files are \fI.wav\fR files located in a \fIsounds\fR sub\-directory
85 in one of the \fBicewm\fR\|(1) configuration directories.
86 .PP
87 \&\fBicesound\fR supports several common audio interfaces. These are: ALSA,
88 OSS and libAO. These must be enabled during configuration.
89 ALSA, OSS and libAO all require support for libsndfile, which is a
90 very common library to read audio files.
91 .IP \fBALSA\fR 4
92 .IX Item "ALSA"
93 \&\fBALSA\fR is rather involved to program and it works, but this could use
94 more testing. It plays at most one sound at a time.
95 .IP \fBLibAO\fR 4
96 .IX Item "LibAO"
97 \&\fBLibAO\fR is a cross\-platform audio output library which is a convenient
98 wrapper around a significant number of common audio interfaces. It has
99 a simple configuration file which is documented in the \fBlibao.conf\fR\|(5)
100 manual page.
101 .IP \fBOSS\fR 4
102 .IX Item "OSS"
103 The \fIOpen Sound System (OSS)\fR is a cross\-platform sound interface,
104 which is fully supported by \fBicesound\fR.
105 .PP
106 When multiple audio interfaces are available \fBicesound\fR will examine
107 them all until it finds one which it can connect to and then use that
108 one. By default it prefers them in the order of: \fBAO\fR, \fBALSA\fR, \fBOSS\fR.
109 .SS OPTIONS
110 .IX Subsection "OPTIONS"
111 .SS "SPECIFIC OPTIONS"
112 .IX Subsection "SPECIFIC OPTIONS"
113 .IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4
114 .IX Item "-d, --display=DISPLAY"
115 X11 display used by \fBicewm\fR\|(1) (default: \f(CW$DISPLAY\fR).
116 .IP "\fB\-s\fR, \fB\-\-sample\-dir\fR=\fIDIRECTORY\fR" 4
117 .IX Item "-s, --sample-dir=DIRECTORY"
118 Specifies a directory with sound files. The default is:
119 \&\fR\f(CI$HOME\fR\fI/.config/icewm/sounds\fR, \fI\fR\f(CI$HOME\fR\fI/.icewm/sounds\fR, \fICFGDIR/sounds\fR
120 and \fILIBDIR/sounds\fR. See the output of \f(CW\*(C`icewm \-\-directories\*(C'\fR.
121 .IP "\fB\-i\fR, \fB\-\-interface\fR={\fBAO\fR|\fBALSA\fR|\fBOSS\fR}[,{\fBAO\fR|\fBALSA\fR|\fBOSS\fR}]*" 4
122 .IX Item "-i, --interface={AO|ALSA|OSS}[,{AO|ALSA|OSS}]*"
123 Specifies the audio output interfaces. One or more of: \fBAO\fR,
124 \&\fBALSA\fR, \fBOSS\fR separated by comma\*(Aqs (\f(CW\*(C`,\*(C'\fR).
125 .IP "\fB\-D\fR, \fB\-\-device\fR=\fIDEVICE\fR" 4
126 .IX Item "-D, --device=DEVICE"
127 Backwards compatibility only: the default device.
128 Please prefer one of the \fB\-A\fR, \fB\-O\fR or \fB\-S\fR options.
129 .IP "\fB\-O\fR, \fB\-\-oss\fR=\fIDEVICE\fR" 4
130 .IX Item "-O, --oss=DEVICE"
131 Specifies the OSS device (default: \fI/dev/dsp\fR).
132 .IP "\fB\-A\fR, \fB\-\-alsa\fR=\fIDEVICE\fR" 4
133 .IX Item "-A, --alsa=DEVICE"
134 Specifies the ALSA device (default: \f(CW\*(C`default\*(C'\fR).
135 .IP "\fB\-z\fR, \fB\-\-snooze\fR=\fIMILLISECONDS\fR" 4
136 .IX Item "-z, --snooze=MILLISECONDS"
137 Specifies the snooze interval between sound events
138 in milliseconds. Default is 500 milliseconds.
139 .IP "\fB\-p\fR, \fB\-\-play\fR=\fISOUND\fR" 4
140 .IX Item "-p, --play=SOUND"
141 Plays the given sound (name or number) and exits.
142 .IP "\fB\-l\fR, \fB\-\-list\-files\fR" 4
143 .IX Item "-l, --list-files"
144 Lists the available sound file paths and exits.
145 .IP \fB\-\-list\-sounds\fR 4
146 .IX Item "--list-sounds"
147 Lists the supported sound file names and exits.
148 .IP \fB\-\-list\-interfaces\fR 4
149 .IX Item "--list-interfaces"
150 Lists the supported audio interfaces and exits.
151 .IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4
152 .IX Item "-o, --output=FILE"
153 Redirect all output to \fIFILE\fR.
154 A leading tilde or environment variable is expanded.
155 .IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
156 .IX Item "-v, --verbose"
157 Be verbose and print some information when sound events occur.
158 .SS "GENERAL OPTIONS"
159 .IX Subsection "GENERAL OPTIONS"
160 .IP "\fB\-h\fR, \fB\-\-help\fR" 4
161 .IX Item "-h, --help"
162 Print a brief usage statement to \fIstdout\fR and exit.
163 .IP "\fB\-V\fR, \fB\-\-version\fR" 4
164 .IX Item "-V, --version"
165 Print the program version to \fIstdout\fR and exit.
166 .IP "\fB\-C\fR, \fB\-\-copying\fR" 4
167 .IX Item "-C, --copying"
168 Print copying permissions to \fIstdout\fR for the program and exit.
169 .SS "EXIT STATUS"
170 .IX Subsection "EXIT STATUS"
171 .IP \fB0\fR 4
172 .IX Item "0"
173 Success.
174 .IP \fB1\fR 4
175 .IX Item "1"
176 General error.
177 .IP \fB2\fR 4
178 .IX Item "2"
179 Command line error.
180 .IP \fB3\fR 4
181 .IX Item "3"
182 Subsystems error (i.e cannot connect to server).
183 .SS "SEE ALSO"
184 .IX Subsection "SEE ALSO"
185 \&\fBicewm\fR\|(1),
186 \&\fBlibao.conf\fR\|(5),
187 \&\fBpadsp\fR\|(1),
188 \&\fBaplay\fR\|(1),
189 \&\fBalsamixer\fR\|(1).
190 .SS BUGS
191 .IX Subsection "BUGS"
192 Please report bugs at <https://github.com/bbidulock/icewm/issues>.
193 .SS AUTHOR
194 .IX Subsection "AUTHOR"
195 Brian Bidulock <mailto:[email protected]>.
196 .PP
197 See \fB\-\-copying\fR for full copyright notice and copying permissions.
198 .SS LICENSE
199 .IX Subsection "LICENSE"
200 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
201 See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag
202 to display copying permissions.