diff options
Diffstat (limited to 'upstream/debian-unstable/man1/icesound.1')
| -rw-r--r-- | upstream/debian-unstable/man1/icesound.1 | 182 |
1 files changed, 52 insertions, 130 deletions
diff --git a/upstream/debian-unstable/man1/icesound.1 b/upstream/debian-unstable/man1/icesound.1 index 5d827f0b..5d239e64 100644 --- a/upstream/debian-unstable/man1/icesound.1 +++ b/upstream/debian-unstable/man1/icesound.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,169 +52,107 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICESOUND 1" -.TH ICESOUND 1 "2023-12-31" "icewm\ 3.4.5" "User Commands" +.TH ICESOUND 1 2024-05-24 "icewm\ 3.5.0" "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 "\s-1NAME\s0" +.SS NAME .IX Subsection "NAME" .Vb 1 \& icesound \- play audio files when interesting GUI events happen .Ve -.SS "\s-1SYNOPSIS\s0" +.SS SYNOPSIS .IX Subsection "SYNOPSIS" -\&\fBicesound\fR [\fI\s-1OPTIONS\s0\fR] -.SS "\s-1DESCRIPTION\s0" +\&\fBicesound\fR [\fIOPTIONS\fR] +.SS DESCRIPTION .IX Subsection "DESCRIPTION" -The \fBicewm\fR\|(1) window manager generates so-called \s-1GUI\s0 events in +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. \s-1GUI\s0 events are a property of the -X root window. \fBicewm\fR\|(1) updates this property whenever a new \s-1GUI\s0 +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 \s-1GUI\s0 events defined. +property. There are nearly twenty GUI events defined. .PP -\&\fBicesound\fR responds to these \s-1GUI\s0 events by playing audio files. +\&\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: \s-1ALSA, -OSS\s0 and libAO. These must be enabled during configuration. -\&\s-1ALSA, OSS\s0 and libAO all require support for libsndfile, which is a +\&\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 "\fB\s-1ALSA\s0\fR" 4 +.IP \fBALSA\fR 4 .IX Item "ALSA" -\&\fB\s-1ALSA\s0\fR is rather involved to program and it works, but this could use +\&\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 +.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 "\fB\s-1OSS\s0\fR" 4 +.IP \fBOSS\fR 4 .IX Item "OSS" -The \fIOpen Sound System (\s-1OSS\s0)\fR is a cross-platform sound interface, +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: \fB\s-1AO\s0\fR, \fB\s-1ALSA\s0\fR, \fB\s-1OSS\s0\fR. -.SS "\s-1OPTIONS\s0" +one. By default it prefers them in the order of: \fBAO\fR, \fBALSA\fR, \fBOSS\fR. +.SS OPTIONS .IX Subsection "OPTIONS" -.SS "\s-1SPECIFIC OPTIONS\s0" +.SS "SPECIFIC OPTIONS" .IX Subsection "SPECIFIC OPTIONS" -.IP "\fB\-d\fR, \fB\-\-display\fR=\fI\s-1DISPLAY\s0\fR" 4 +.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=\fI\s-1DIRECTORY\s0\fR" 4 +.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: -\&\fI\f(CI$HOME\fI/.config/icewm/sounds\fR, \fI\f(CI$HOME\fI/.icewm/sounds\fR, \fICFGDIR/sounds\fR +\&\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={\fB\s-1AO\s0\fR|\fB\s-1ALSA\s0\fR|\fB\s-1OSS\s0\fR}[,{\fB\s-1AO\s0\fR|\fB\s-1ALSA\s0\fR|\fB\s-1OSS\s0\fR}]*" 4 +.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: \fB\s-1AO\s0\fR, -\&\fB\s-1ALSA\s0\fR, \fB\s-1OSS\s0\fR separated by comma's (\f(CW\*(C`,\*(C'\fR). -.IP "\fB\-D\fR, \fB\-\-device\fR=\fI\s-1DEVICE\s0\fR" 4 +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=\fI\s-1DEVICE\s0\fR" 4 +.IP "\fB\-O\fR, \fB\-\-oss\fR=\fIDEVICE\fR" 4 .IX Item "-O, --oss=DEVICE" -Specifies the \s-1OSS\s0 device (default: \fI/dev/dsp\fR). -.IP "\fB\-A\fR, \fB\-\-alsa\fR=\fI\s-1DEVICE\s0\fR" 4 +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 \s-1ALSA\s0 device (default: \f(CW\*(C`default\*(C'\fR). -.IP "\fB\-z\fR, \fB\-\-snooze\fR=\fI\s-1MILLISECONDS\s0\fR" 4 +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=\fI\s-1SOUND\s0\fR" 4 +.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 +.IP \fB\-\-list\-sounds\fR 4 .IX Item "--list-sounds" Lists the supported sound file names and exits. -.IP "\fB\-\-list\-interfaces\fR" 4 +.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 \fI\s-1FILE\s0\fR. +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 "\s-1GENERAL OPTIONS\s0" +.SS "GENERAL OPTIONS" .IX Subsection "GENERAL OPTIONS" .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" @@ -241,37 +163,37 @@ 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 "\s-1EXIT STATUS\s0" +.SS "EXIT STATUS" .IX Subsection "EXIT STATUS" -.IP "\fB0\fR" 4 +.IP \fB0\fR 4 .IX Item "0" Success. -.IP "\fB1\fR" 4 +.IP \fB1\fR 4 .IX Item "1" General error. -.IP "\fB2\fR" 4 +.IP \fB2\fR 4 .IX Item "2" Command line error. -.IP "\fB3\fR" 4 +.IP \fB3\fR 4 .IX Item "3" Subsystems error (i.e cannot connect to server). -.SS "\s-1SEE ALSO\s0" +.SS "SEE ALSO" .IX Subsection "SEE ALSO" \&\fBicewm\fR\|(1), \&\fBlibao.conf\fR\|(5), \&\fBpadsp\fR\|(1), \&\fBaplay\fR\|(1), \&\fBalsamixer\fR\|(1). -.SS "\s-1BUGS\s0" +.SS BUGS .IX Subsection "BUGS" Please report bugs at <https://github.com/bbidulock/icewm/issues>. -.SS "\s-1AUTHOR\s0" +.SS AUTHOR .IX Subsection "AUTHOR" Brian Bidulock <mailto:bidulock@openss7.org>. .PP See \fB\-\-copying\fR for full copyright notice and copying permissions. -.SS "\s-1LICENSE\s0" +.SS LICENSE .IX Subsection "LICENSE" -\&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. -See the \fI\s-1COPYING\s0\fR file in the distribution or use the \fB\-\-copying\fR flag +\&\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. |