diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 72 | ||||
| -rw-r--r-- | man/esdcompat.1.xml.in | 91 | ||||
| -rw-r--r-- | man/pacat.1.xml.in | 160 | ||||
| -rw-r--r-- | man/pacmd.1.xml.in | 52 | ||||
| -rw-r--r-- | man/pactl.1.xml.in | 145 | ||||
| -rw-r--r-- | man/paplay.1.xml.in | 129 | ||||
| -rw-r--r-- | man/pax11publish.1.xml.in | 153 | ||||
| -rw-r--r-- | man/pulseaudio.1.xml.in | 69 |
8 files changed, 867 insertions, 4 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index b701a2ea..a3427aa7 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -22,10 +22,22 @@ pulseconfdir=$(sysconfdir)/pulse if BUILD_MANPAGES man_MANS = \ - pulseaudio.1 + pulseaudio.1 \ + esdcompat.1 \ + pax11publish.1 \ + paplay.1 \ + pacat.1 \ + pacmd.1 \ + pactl.1 noinst_DATA = \ - pulseaudio.1.xml + pulseaudio.1.xml \ + esdcompat.1.xml \ + pax11publish.1.xml \ + paplay.1.xml \ + pacat.1.xml \ + pacmd.1.xml \ + pactl.1.xml CLEANFILES = \ $(noinst_DATA) @@ -35,6 +47,36 @@ pulseaudio.1.xml: pulseaudio.1.xml.in Makefile -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ +esdcompat.1.xml: esdcompat.1.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +pax11publish.1.xml: pax11publish.1.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +paplay.1.xml: paplay.1.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +pacat.1.xml: pacat.1.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +pacmd.1.xml: pacmd.1.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +pactl.1.xml: pactl.1.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + if USE_XMLTOMAN CLEANFILES += \ @@ -43,6 +85,24 @@ CLEANFILES += \ pulseaudio.1: pulseaudio.1.xml Makefile xmltoman $< > $@ +esdcompat.1: esdcompat.1.xml Makefile + xmltoman $< > $@ + +pax11publish.1: pax11publish.1.xml Makefile + xmltoman $< > $@ + +paplay.1: paplay.1.xml Makefile + xmltoman $< > $@ + +pacat.1: pacat.1.xml Makefile + xmltoman $< > $@ + +pacmd.1: pacmd.1.xml Makefile + xmltoman $< > $@ + +pactl.1: pactl.1.xml Makefile + xmltoman $< > $@ + xmllint: $(noinst_DATA) for f in $(noinst_DATA) ; do \ xmllint --noout --valid "$$f" || exit 1 ; \ @@ -54,7 +114,13 @@ endif EXTRA_DIST = \ $(man_MANS) \ - pulseaudio.1.xml.in + pulseaudio.1.xml.in \ + esdcompat.1.xml.in \ + pax11publish.1.xml.in \ + paplay.1.xml.in \ + pacat.1.xml.in \ + pacmd.1.xml.in \ + pactl.1.xml.in \ xmltoman.css \ xmltoman.xsl \ xmltoman.dtd diff --git a/man/esdcompat.1.xml.in b/man/esdcompat.1.xml.in new file mode 100644 index 00000000..864dc5db --- /dev/null +++ b/man/esdcompat.1.xml.in @@ -0,0 +1,91 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- +This file is part of PulseAudio. + +PulseAudio is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2.1 of the +License, or (at your option) any later version. + +PulseAudio is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with PulseAudio; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +USA. +--> + +<manpage name="esdcompat" section="1" desc="PulseAudio ESD wrapper script"> + + <synopsis> + <cmd>esdcompat [<arg>options</arg>]</cmd> + <cmd>esdcompat <opt>--help</opt></cmd> + <cmd>esdcompat <opt>--version</opt></cmd> + </synopsis> + + <description> + <p><file>esdcompat</file> is a compatiblity script that takes the + same arguments as the ESD sound daemon <manref name="esd" + section="1"/>, but uses them to start a the PulseAudio sound server with the appropriate parameters. It is + required to make PulseAudio a drop-in replacement for esd, i.e. it + can be used to make <manref name="gnome-session" section="1"/> + start up PulseAudio instead of esd.</p> + + <p>It is recommended to make <file>esd</file> a symbolic link to this script.</p> + </description> + + <options> + + <option> + <p><opt>-h | --help</opt></p> + + <optdesc><p>Show help.</p></optdesc> + </option> + + <option> + <p><opt>--version</opt></p> + + <optdesc><p>Show version information.</p></optdesc> + </option> + + <option> + <p><opt>-tcp | -promiscuous | -d | -b | -r | -as | -unix | -public | -terminate | -nobeeps | -trust | -port | -bind</opt></p> + + <optdesc><p>These options understood by the original + <file>esd</file> are ignored by + <file>esdcompat</file>.</p></optdesc> + + </option> + + + <option> + <p><opt>-spawnpid | -spawnfd</opt></p> + + <optdesc><p>These internally used options understood by the + original <file>esd</file> are properly handled by + <file>esdcompat</file>, however are not to be used + manually.</p></optdesc> + + </option> + + </options> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="esd" section="1"/> + </p> + </section> + +</manpage> diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in new file mode 100644 index 00000000..35c7651b --- /dev/null +++ b/man/pacat.1.xml.in @@ -0,0 +1,160 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- +This file is part of PulseAudio. + +PulseAudio is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2.1 of the +License, or (at your option) any later version. + +PulseAudio is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with PulseAudio; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +USA. +--> + +<manpage name="pacat" section="1" desc="Play back or record raw audio streams on a PulseAudio sound server"> + + <synopsis> + <cmd>pacat [<arg>options</arg>] [<arg>FILE</arg>]</cmd> + <cmd>parec [<arg>options</arg>] [<arg>FILE</arg>]</cmd> + <cmd>paplay <opt>--help</opt></cmd> + <cmd>paplay <opt>--version</opt></cmd> + </synopsis> + + <description> + <p><file>pacat</file> is a simple tool for playing back or + capturing raw audio files on a PulseAudio sound server.</p> + </description> + + <options> + + <option> + <p><opt>-h | --help</opt></p> + + <optdesc><p>Show help.</p></optdesc> + </option> + + <option> + <p><opt>--version</opt></p> + + <optdesc><p>Show version information.</p></optdesc> + </option> + + <option> + <p><opt>-r | --record</opt></p> + + <optdesc><p>Capture raw audio data and write it to the specified file or to STDOUT if none is specified. If the tool is called under the name <file>parec</file> this is the default.</p></optdesc> + </option> + + <option> + <p><opt>-p | --playback</opt></p> + + <optdesc><p>Read raw audio data from the specified file or STDIN if none is specified, and play it back. If the tool is called under the name <file>pacat</file> this is the default.</p></optdesc> + </option> + + <option> + <p><opt>-v | --verbose</opt></p> + + <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.</p></optdesc> + </option> + + <option> + <p><opt>-s | --server</opt><arg>=SERVER</arg></p> + + <optdesc><p>Choose the server to connect to.</p></optdesc> + </option> + + <option> + <p><opt>-d | --device</opt><arg>=SINKORSOURCE</arg></p> + + <optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc> + </option> + + <option> + <p><opt>-n | --client-name</opt><arg>=NAME</arg></p> + + <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc> + </option> + + <option> + <p><opt>--stream-name</opt><arg>=NAME</arg></p> + + <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc> + </option> + + <option> + <p><opt>--volume</opt><arg>=VOLUME</arg></p> + + <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc> + </option> + + <option> + <p><opt>--rate</opt><arg>=SAMPLERATE</arg></p> + + <optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc> + </option> + + <option> + <p><opt>--format</opt><arg>=FORMAT</arg></p> + + <optdesc><p>Capture or play back audio with the specified sample + format. Specify one of <arg>u8</arg>, <arg>s16le</arg>, + <arg>s16be</arg>, <arg>float32le</arg>, <arg>float32be</arg>, + <arg>ulaw</arg>, <arg>alaw</arg>. Depending on the endianess of + the CPU the formats <arg>s16ne</arg>, <arg>s16re</arg>, + <arg>float32ne</arg>, <arg>float32re</arg> (for native, + resp. reverse endian) are available as aliases. Defaults to + s16ne.</p></optdesc> + </option> + + <option> + <p><opt>--channels</opt><arg>=CHANNELS</arg></p> + + <optdesc><p>Capture or play back audio with the specified number + of channels. If more than two channels are used it is + recommended to use the <opt>--channel-map</opt> option + below. Defaults to 2.</p></optdesc> + </option> + + <option> + <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p> + + <optdesc><p>Explicitly choose a channel map when playing back + this stream. The argument should be a comma separated list of + channel names: <arg>front-left</arg>, <arg>front-right</arg>, + <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>, + <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>, + <arg>front-left-of-center</arg>, + <arg>front-right-of-center</arg>, <arg>side-left</arg>, + <arg>side-right</arg>, <arg>top-center</arg>, + <arg>top-front-center</arg>, <arg>top-front-left</arg>, + <arg>top-front-right</arg>, <arg>top-rear-left</arg>, + <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of + the 32 auxiliary channel names <arg>aux0</arg> to + <arg>aux31</arg>.</p></optdesc> + </option> + + </options> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="paplay" section="1"/> + </p> + </section> + +</manpage> diff --git a/man/pacmd.1.xml.in b/man/pacmd.1.xml.in new file mode 100644 index 00000000..b760ba0e --- /dev/null +++ b/man/pacmd.1.xml.in @@ -0,0 +1,52 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- +This file is part of PulseAudio. + +PulseAudio is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2.1 of the +License, or (at your option) any later version. + +PulseAudio is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with PulseAudio; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +USA. +--> + +<manpage name="pacmd" section="1" desc="Reconfigure a PulseAudio sound server during runtime"> + + <synopsis> + <cmd>pacmd</cmd> + </synopsis> + + <description> + <p>This tool can be used to introspect or reconfigure a running + PulseAudio sound server during runtime. It connects to the sound + server and offers a simple live shell that can be used to enter + the commands also understood in the <file>default.pa</file> + configuration scripts.</p> + + <p>This program takes no command line options.</p> + </description> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>, <manref name="default.pa" section="5"/> + </p> + </section> + +</manpage> diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in new file mode 100644 index 00000000..0b7b9a78 --- /dev/null +++ b/man/pactl.1.xml.in @@ -0,0 +1,145 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- +This file is part of PulseAudio. + +PulseAudio is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2.1 of the +License, or (at your option) any later version. + +PulseAudio is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with PulseAudio; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +USA. +--> + +<manpage name="pactl" section="1" desc="Control a running PulseAudio sound server"> + + <synopsis> + <cmd>pulseaudio [<arg>options</arg>] stat</cmd> + <cmd>pulseaudio [<arg>options</arg>] list</cmd> + <cmd>pulseaudio [<arg>options</arg>] exit</cmd> + <cmd>pulseaudio [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd> + <cmd>pulseaudio [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd> + <cmd>pulseaudio [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd> + <cmd>pulseaudio [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd> + <cmd>pulseaudio [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd> + <cmd>pulseaudio [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd> + <cmd>pulseaudio [<arg>options</arg>] unload-module <arg>ID</arg></cmd> + <cmd>pulseaudio [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd> + <cmd>pulseaudio [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd> + <cmd>pulseaudio <opt>--help</opt></cmd> + <cmd>pulseaudio <opt>--version</opt></cmd> + </synopsis> + + <description> + <p>PulseAudio is a networked low-latency sound server for Linux, POSIX and Windows systems.</p> + </description> + + <options> + + <option> + <p><opt>-h | --help</opt></p> + + <optdesc><p>Show help.</p></optdesc> + </option> + + <option> + <p><opt>--version</opt></p> + + <optdesc><p>Show version information.</p></optdesc> + </option> + + <option> + <p><opt>-s | --server</opt><arg>=SERVER</arg></p> + + <optdesc><p>Choose the server to connect to.</p></optdesc> + </option> + + <option> + <p><opt>-n | --client-name</opt><arg>=NAME</arg></p> + + <optdesc><p>Specify the client name <file>pactl</file> shall pass to the server when connecting.</p></optdesc> + </option> + + <option> + <p><opt>stat</opt></p> + + <optdesc><p>Dump a few statistics about the PulseAudio daemon.</p></optdesc> + </option> + + <option> + <p><opt>list</opt></p> + + <optdesc><p>Dump all currently loaded modules, available sinks, sources, streams and clients.</p></optdesc> + </option> + + <option> + <p><opt>exit</opt></p> + + <optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc> + </option> + + + <option> + <p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p> + + <optdesc><p>Upload a sound from the specified audio file into + the sample cache. The file types supported are those understood + by <file>libsndfile</file>. The sample in the cache is named + after the audio file, unless the name is explicitly + specified.</p></optdesc> + + </option> + + <option> + <p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p> + + <optdesc><p>Play the specified sample from the sample cache. It + is played on the default sink, unless the symbolic name or the + numerical index of the sink to play it on is + specified.</p></optdesc> + + </option> + + <option> + <p><opt>remove-sample</opt> <arg>NAME</arg></p> + + <optdesc><p>Remove the specified sample from the sample cache.</p></optdesc> + </option> + + <option> + <p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p> + + <optdesc><p>Move the specified playback stream (identified by its numerical index) to the specified sink (identified by its symbolic name or numerical index).</p></optdesc> + </option> + + <option> + <p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p> + + <optdesc><p>Move the specified recording stream (identified by its numerical index) to the specified source (identified by its symbolic name or numerical index).</p></optdesc> + </option> + + </options> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/> + </p> + </section> + +</manpage> diff --git a/man/paplay.1.xml.in b/man/paplay.1.xml.in new file mode 100644 index 00000000..bab45dc3 --- /dev/null +++ b/man/paplay.1.xml.in @@ -0,0 +1,129 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- +This file is part of PulseAudio. + +PulseAudio is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2.1 of the +License, or (at your option) any later version. + +PulseAudio is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with PulseAudio; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +USA. +--> + +<manpage name="paplay" section="1" desc="Play back audio files on a PulseAudio sound server"> + + <synopsis> + <cmd>paplay [<arg>options</arg>] <arg>FILE</arg></cmd> + <cmd>paplay <opt>--help</opt></cmd> + <cmd>paplay <opt>--version</opt></cmd> + </synopsis> + + <description> + <p><file>paplay</file> is a simple tool for playing back audio + files on a PulseAudio sound server. It understands all audio file + formats supported by <file>libsndfile</file>.</p> + </description> + + <options> + + <option> + <p><opt>-h | --help</opt></p> + + <optdesc><p>Show help.</p></optdesc> + </option> + + <option> + <p><opt>--version</opt></p> + + <optdesc><p>Show version information.</p></optdesc> + </option> + + <option> + <p><opt>-v | --verbose</opt></p> + + <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback.</p></optdesc> + </option> + + <option> + <p><opt>-s | --server</opt><arg>=SERVER</arg></p> + + <optdesc><p>Choose the server to connect to.</p></optdesc> + </option> + + <option> + <p><opt>-d | --device</opt><arg>=SINK</arg></p> + + <optdesc><p>Specify the symbolic name of the sink to play this file on.</p></optdesc> + </option> + + <option> + <p><opt>-n | --client-name</opt><arg>=NAME</arg></p> + + <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc> + </option> + + <option> + <p><opt>--stream-name</opt><arg>=NAME</arg></p> + + <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc> + </option> + + <option> + <p><opt>--volume</opt><arg>=VOLUME</arg></p> + + <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc> + </option> + + <option> + <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p> + + <optdesc><p>Explicitly choose a channel map when playing back + this stream. The argument should be a comma separated list of + channel names: <arg>front-left</arg>, <arg>front-right</arg>, + <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>, + <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>, + <arg>front-left-of-center</arg>, + <arg>front-right-of-center</arg>, <arg>side-left</arg>, + <arg>side-right</arg>, <arg>top-center</arg>, + <arg>top-front-center</arg>, <arg>top-front-left</arg>, + <arg>top-front-right</arg>, <arg>top-rear-left</arg>, + <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of + the 32 auxiliary channel names <arg>aux0</arg> to + <arg>aux31</arg>.</p></optdesc> + </option> + + </options> + + <section name="Limitations"> + + <p>Due to a limitation in <file>libsndfile</file> + <file>paplay</file> currently does not always set the correct channel + mapping for playback of multichannel (i.e. surround) audio files, even if the channel mapping information is + available in the audio file.</p> + + </section> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="pacat" section="1"/> + </p> + </section> + +</manpage> diff --git a/man/pax11publish.1.xml.in b/man/pax11publish.1.xml.in new file mode 100644 index 00000000..1e3a1f01 --- /dev/null +++ b/man/pax11publish.1.xml.in @@ -0,0 +1,153 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- +This file is part of PulseAudio. + +PulseAudio is free software; you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as +published by the Free Software Foundation; either version 2.1 of the +License, or (at your option) any later version. + +PulseAudio is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with PulseAudio; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +USA. +--> + +<manpage name="pax11publish" section="1" desc="PulseAudio X11 Credential Utility"> + + <synopsis> + <cmd>pax11publish <opt>-h</opt></cmd> + <cmd>pax11publish [<arg>options</arg>] [<opt>-d</opt>]</cmd> + <cmd>pax11publish [<arg>options</arg>] <opt>-e</opt></cmd> + <cmd>pax11publish [<arg>options</arg>] <opt>-i</opt></cmd> + <cmd>pax11publish [<arg>options</arg>] <opt>-r</opt></cmd> + </synopsis> + + <description> + <p>The <file>pax11publish</file> utility can be used to dump or + manipulate the PulseAudio server credentials that can be stored as + properties on the X11 root window.</p> + + <p>Please note that the loadable module + <file>module-x11-publish</file> exports the same information + directly from the PulseAudio sound server, and should in most + cases be used in preference over this tool.</p> + + <p>Use the following command to dump the raw + PulseAudio-specific data that is stored in your X11 root + window:</p> + + <p>xprop -root | grep ^PULSE_</p> + + </description> + + <options> + + <option> + <p><opt>-h</opt></p> + + <optdesc><p>Show help.</p></optdesc> + </option> + + <option> + <p><opt>-d</opt></p> + + <optdesc><p>Read the PulseAudio server credentials currently set + on the X11 root window and dump them in a human readable form. This reads the + PULSE_SERVER, PULSE_SINK, PULSE_SOURCE and PULSE_COOKIE + properties.</p></optdesc> + </option> + + <option> + <p><opt>-i</opt></p> + <optdesc><p>Similar to <opt>-d</opt>, however dumps them in a + Bourne shell compatible format so they may be used together with + the <file>eval</file> shell command to set the $PULSE_SERVER, + $PULSE_SINK, $PULSE_SOURCE environment variables. Also reads the + authentication cookie from the root window and stores it in + <file>~/.pulse-cookie</file>. </p></optdesc> + </option> + + <option> + <p><opt>-e</opt></p> + + <optdesc><p>Export the currently locally used sound server, + sink, source configuration to the X11 root window. This takes + the data from the $PULSE_SERVER, $PULSE_SINK, $PULSE_SOURCE + environment variables and combines them with the data from + <file>~/.pulse/client.conf</file> (or + <file>@pulseconfdir@/client.conf</file> if that file does not + exist). If specific options are passed on the command line + (<opt>-S</opt>, <opt>-O</opt>, <opt>-I</opt>, <opt>-c</opt>, see + below), they take precedence. Also uploads the local + authentication cookie <file>~/.pulse-cookie</file> to the X11 + server.</p></optdesc> + </option> + + <option> + <p><opt>-r</opt></p> + + <optdesc><p>Removes the configured PulseAudio configuration from the X11 root window.</p></optdesc> + </option> + + <option> + <p><opt>-D</opt> <arg>DISPLAY</arg></p> + + <optdesc><p>Connect to the specified X11 display, instead of the default one configured in $DISPLAY.</p></optdesc> + </option> + + <option> + <p><opt>-S</opt> <arg>SERVER</arg></p> + + <optdesc><p>Only valid for <opt>-e</opt>: export the specified + PulseAudio server as default to the X11 display instead of the + one configured via local configuration.</p></optdesc> + </option> + + <option> + <p><opt>-O</opt> <arg>SINK</arg></p> + + <optdesc><p>Only valid for <opt>-e</opt>: export the specified + sink as default sink to the X11 display instead of the one + configured via local configuration.</p></optdesc> + </option> + + <option> + <p><opt>-I</opt> <arg>SOURCE</arg></p> + + <optdesc><p>Only valid for <opt>-e</opt>: export the specified + source as default to the X11 display instead of the one + configured via local configuration.</p></optdesc> + </option> + + <option> + <p><opt>-c</opt> <arg>FILE</arg></p> + + <optdesc><p>Only valid for <opt>-e</opt>: export the PulseAudio + authentication cookie stored in the specified file to the X11 + display instead of the one stored in <file>~/.pulse-cookie</file>.</p></optdesc> + </option> + + </options> + + <section name="Authors"> + <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="pulseaudio" section="1"/>, <manref name="xprop" section="1"/> + </p> + </section> + +</manpage> diff --git a/man/pulseaudio.1.xml.in b/man/pulseaudio.1.xml.in index b30f4484..1f53a60b 100644 --- a/man/pulseaudio.1.xml.in +++ b/man/pulseaudio.1.xml.in @@ -28,6 +28,7 @@ USA. <synopsis> <cmd>pulseaudio [<arg>options</arg>]</cmd> <cmd>pulseaudio <opt>--help</opt></cmd> + <cmd>pulseaudio <opt>--version</opt></cmd> <cmd>pulseaudio <opt>--dump-conf</opt></cmd> <cmd>pulseaudio <opt>--dump-modules</opt></cmd> <cmd>pulseaudio <opt>--dump-resample-methods</opt></cmd> @@ -363,7 +364,73 @@ USA. </section> <section name="Real-time and high-priority scheduling"> - Blablub + <p>To minimize the risk of drop-outs during playback it is + recommended to run PulseAudio with real-time scheduling if the + underlying platform supports it. This decouples the scheduling + latency of the PulseAudio daemon from the system load and is thus + the best way to make sure that PulseAudio always gets CPU time + when it needs it to refill the hardware playback + buffers. Unfortunately this is a security risk on most systems, + since PulseAudio runs as user process, and giving realtime + scheduling priviliges to a user process always comes with the risk + that the user misuses it to lock up the system -- which is + possible since making a process real-time effectively disables + preemption.</p> + + <p>To minimize the risk PulseAudio by default does not enable + real-time scheduling. It is however recommended to enable it + on trusted systems. To do that start PulseAudio with + <opt>--realtime</opt> (see above) or enabled the appropriate option in + <file>daemon.conf</file>. Since acquiring realtime scheduling is a + priviliged operation on most systems, some special changes to the + system configuration need to be made to allow them to the calling + user. Two options are available:</p> + + <p>On newer Linux systems the system resource limit RLIMIT_RTPRIO + (see <manref name="setrlimit" section="2"/> for more information) + can be used to allow specific users to acquire real-time + scheduling. This can be configured in + <file>/etc/security/limits.conf</file>, a resource limit of 9 is recommended.</p> + + <p>Alternatively, the SUID root bit can be set for the PulseAudio + binary. Then, the daemon will drop root priviliges immediately on + startup, however retain the CAP_NICE capability (on systems that + support it), but only if the calling user is a member of the + <arg>pulse-rt</arg> group (see above). For all other users all + capababilities are dropped immediately. The advantage of this + solution is that the real-time priviliges are only granted to the + PulseAudio daemon -- not to all the user's processes.</p> + + <p>Alternatively, if the risk of locking up the machine is + considered too big to enable real-time scheduling, high-priority + scheduling can be enabled instead (i.e. negative nice level). This + can be enabled by passing <opt>--high-priority</opt> (see above) + when starting PulseAudio and may also be enabled with the + approriate option in <file>daemon.conf</file>. Negative nice + levels can only be enabled when the appropriate resource limit + RLIMIT_NICE is set (see <manref name="setrlimit" section="2"/> for + more information), possibly configured in + <file>/etc/security/limits.conf</file>. A resource limit of 31 + (corresponding with nice level -11) is recommended.</p> + </section> + + <section name="Environment variables"> + + <p>The PulseAudio client libraries check for the existance of the + following environment variables and change their local configuration accordingly:</p> + + <p><arg>$PULSE_SERVER</arg>: the server string specifying the server to connect to when a client asks for a sound server connection and doesn't explicitly ask for a specific server.</p> + + <p><arg>$PULSE_SINK</arg>: the symbolic name of the sink to connect to when a client creates a playback stream and doesn't explicitly ask for a specific sink.</p> + + <p><arg>$PULSE_SOURCE</arg>: the symbolic name of the source to connect to when a client creates a record stream and doesn't explicitly ask for a specific source.</p> + + <p><arg>$PULSE_BINARY</arg>: path of PulseAudio executable to run when server auto-spawning is used.</p> + + <p><arg>$PULSE_CLIENTCONFIG</arg>: path of file that shall be read instead of <file>client.conf</file> (see above) for client configuration.</p> + + <p>These environment settings take precedence -- if set -- over the configuration settings from <file>client.conf</file> (see above).</p> + </section> <section name="Authors"> |