diff options
Diffstat (limited to 'upstream/archlinux/man1/icesound.1')
| -rw-r--r-- | upstream/archlinux/man1/icesound.1 | 199 |
1 files changed, 199 insertions, 0 deletions
diff --git a/upstream/archlinux/man1/icesound.1 b/upstream/archlinux/man1/icesound.1 new file mode 100644 index 00000000..df357bcd --- /dev/null +++ b/upstream/archlinux/man1/icesound.1 @@ -0,0 +1,199 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "ICESOUND 1" +.TH ICESOUND 1 2023-12-28 "icewm 3.4.5" "User Commands" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SS NAME +.IX Subsection "NAME" +.Vb 1 +\& icesound \- play audio files when interesting GUI events happen +.Ve +.SS SYNOPSIS +.IX Subsection "SYNOPSIS" +\&\fBicesound\fR [\fIOPTIONS\fR] +.SS DESCRIPTION +.IX Subsection "DESCRIPTION" +The \fBicewm\fR\|(1) window manager generates so-called GUI events in +response to interesting actions, like opening or closing of application +windows, switching of workspace, etc. GUI events are a property of the +X root window. \fBicewm\fR\|(1) updates this property whenever a new GUI +event occurs. Interested applications can listen for changes to this +property. There are nearly twenty GUI events defined. +.PP +\&\fBicesound\fR responds to these GUI events by playing audio files. +These sound files are \fI.wav\fR files located in a \fIsounds\fR sub-directory +in one of the \fBicewm\fR\|(1) configuration directories. +.PP +\&\fBicesound\fR supports several common audio interfaces. These are: ALSA, +OSS and libAO. These must be enabled during configuration. +ALSA, OSS and libAO all require support for libsndfile, which is a +very common library to read audio files. +.IP \fBALSA\fR 4 +.IX Item "ALSA" +\&\fBALSA\fR is rather involved to program and it works, but this could use +more testing. It plays at most one sound at a time. +.IP \fBLibAO\fR 4 +.IX Item "LibAO" +\&\fBLibAO\fR is a cross-platform audio output library which is a convenient +wrapper around a significant number of common audio interfaces. It has +a simple configuration file which is documented in the \fBlibao.conf\fR\|(5) +manual page. +.IP \fBOSS\fR 4 +.IX Item "OSS" +The \fIOpen Sound System (OSS)\fR is a cross-platform sound interface, +which is fully supported by \fBicesound\fR. +.PP +When multiple audio interfaces are available \fBicesound\fR will examine +them all until it finds one which it can connect to and then use that +one. By default it prefers them in the order of: \fBAO\fR, \fBALSA\fR, \fBOSS\fR. +.SS OPTIONS +.IX Subsection "OPTIONS" +.SS "SPECIFIC OPTIONS" +.IX Subsection "SPECIFIC OPTIONS" +.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4 +.IX Item "-d, --display=DISPLAY" +X11 display used by \fBicewm\fR\|(1) (default: \f(CW$DISPLAY\fR). +.IP "\fB\-s\fR, \fB\-\-sample\-dir\fR=\fIDIRECTORY\fR" 4 +.IX Item "-s, --sample-dir=DIRECTORY" +Specifies a directory with sound files. The default is: +\&\fR\f(CI$HOME\fR\fI/.config/icewm/sounds\fR, \fI\fR\f(CI$HOME\fR\fI/.icewm/sounds\fR, \fICFGDIR/sounds\fR +and \fILIBDIR/sounds\fR. See the output of \f(CW\*(C`icewm \-\-directories\*(C'\fR. +.IP "\fB\-i\fR, \fB\-\-interface\fR={\fBAO\fR|\fBALSA\fR|\fBOSS\fR}[,{\fBAO\fR|\fBALSA\fR|\fBOSS\fR}]*" 4 +.IX Item "-i, --interface={AO|ALSA|OSS}[,{AO|ALSA|OSS}]*" +Specifies the audio output interfaces. One or more of: \fBAO\fR, +\&\fBALSA\fR, \fBOSS\fR separated by comma's (\f(CW\*(C`,\*(C'\fR). +.IP "\fB\-D\fR, \fB\-\-device\fR=\fIDEVICE\fR" 4 +.IX Item "-D, --device=DEVICE" +Backwards compatibility only: the default device. +Please prefer one of the \fB\-A\fR, \fB\-O\fR or \fB\-S\fR options. +.IP "\fB\-O\fR, \fB\-\-oss\fR=\fIDEVICE\fR" 4 +.IX Item "-O, --oss=DEVICE" +Specifies the OSS device (default: \fI/dev/dsp\fR). +.IP "\fB\-A\fR, \fB\-\-alsa\fR=\fIDEVICE\fR" 4 +.IX Item "-A, --alsa=DEVICE" +Specifies the ALSA device (default: \f(CW\*(C`default\*(C'\fR). +.IP "\fB\-z\fR, \fB\-\-snooze\fR=\fIMILLISECONDS\fR" 4 +.IX Item "-z, --snooze=MILLISECONDS" +Specifies the snooze interval between sound events +in milliseconds. Default is 500 milliseconds. +.IP "\fB\-p\fR, \fB\-\-play\fR=\fISOUND\fR" 4 +.IX Item "-p, --play=SOUND" +Plays the given sound (name or number) and exits. +.IP "\fB\-l\fR, \fB\-\-list\-files\fR" 4 +.IX Item "-l, --list-files" +Lists the available sound file paths and exits. +.IP \fB\-\-list\-sounds\fR 4 +.IX Item "--list-sounds" +Lists the supported sound file names and exits. +.IP \fB\-\-list\-interfaces\fR 4 +.IX Item "--list-interfaces" +Lists the supported audio interfaces and exits. +.IP "\fB\-o\fR, \fB\-\-output=FILE\fR" 4 +.IX Item "-o, --output=FILE" +Redirect all output to \fIFILE\fR. +A leading tilde or environment variable is expanded. +.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 +.IX Item "-v, --verbose" +Be verbose and print some information when sound events occur. +.SS "GENERAL OPTIONS" +.IX Subsection "GENERAL OPTIONS" +.IP "\fB\-h\fR, \fB\-\-help\fR" 4 +.IX Item "-h, --help" +Print a brief usage statement to \fIstdout\fR and exit. +.IP "\fB\-V\fR, \fB\-\-version\fR" 4 +.IX Item "-V, --version" +Print the program version to \fIstdout\fR and exit. +.IP "\fB\-C\fR, \fB\-\-copying\fR" 4 +.IX Item "-C, --copying" +Print copying permissions to \fIstdout\fR for the program and exit. +.SS "EXIT STATUS" +.IX Subsection "EXIT STATUS" +.IP \fB0\fR 4 +.IX Item "0" +Success. +.IP \fB1\fR 4 +.IX Item "1" +General error. +.IP \fB2\fR 4 +.IX Item "2" +Command line error. +.IP \fB3\fR 4 +.IX Item "3" +Subsystems error (i.e cannot connect to server). +.SS "SEE ALSO" +.IX Subsection "SEE ALSO" +\&\fBicewm\fR\|(1), +\&\fBlibao.conf\fR\|(5), +\&\fBpadsp\fR\|(1), +\&\fBaplay\fR\|(1), +\&\fBalsamixer\fR\|(1). +.SS BUGS +.IX Subsection "BUGS" +Please report bugs at <https://github.com/bbidulock/icewm/issues>. +.SS AUTHOR +.IX Subsection "AUTHOR" +Brian Bidulock <mailto:bidulock@openss7.org>. +.PP +See \fB\-\-copying\fR for full copyright notice and copying permissions. +.SS LICENSE +.IX Subsection "LICENSE" +\&\fBIceWM\fR is licensed under the GNU Library General Public License. +See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag +to display copying permissions. |