mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-10-29 05:40:23 -04:00
add man pages for padsp, pabrowse, pasuspender
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2027 fefdeb5f-60dc-0310-8127-8f9354f1896f
This commit is contained in:
Lennart Poettering
parent
5dbab0b23a
commit
1821f1f499
4 changed files with 271 additions and 2 deletions
|
|
@ -28,7 +28,10 @@ man_MANS = \
|
|||
paplay.1 \
|
||||
pacat.1 \
|
||||
pacmd.1 \
|
||||
pactl.1
|
||||
pactl.1 \
|
||||
pasuspender.1 \
|
||||
padsp.1 \
|
||||
pabrowse.1
|
||||
|
||||
noinst_DATA = \
|
||||
pulseaudio.1.xml \
|
||||
|
|
@ -37,7 +40,10 @@ noinst_DATA = \
|
|||
paplay.1.xml \
|
||||
pacat.1.xml \
|
||||
pacmd.1.xml \
|
||||
pactl.1.xml
|
||||
pactl.1.xml \
|
||||
pasuspender.1.xml \
|
||||
padsp.1.xml \
|
||||
pabrowse.1.xml
|
||||
|
||||
CLEANFILES = \
|
||||
$(noinst_DATA)
|
||||
|
|
@ -77,6 +83,21 @@ pactl.1.xml: pactl.1.xml.in Makefile
|
|||
-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
|
||||
-e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
|
||||
|
||||
pasuspender.1.xml: pasuspender.1.xml.in Makefile
|
||||
sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
|
||||
-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
|
||||
-e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
|
||||
|
||||
padsp.1.xml: padsp.1.xml.in Makefile
|
||||
sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
|
||||
-e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
|
||||
-e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
|
||||
|
||||
pabrowse.1.xml: pabrowse.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 += \
|
||||
|
|
@ -103,6 +124,15 @@ pacmd.1: pacmd.1.xml Makefile
|
|||
pactl.1: pactl.1.xml Makefile
|
||||
xmltoman $< > $@
|
||||
|
||||
pasuspender.1: pasuspender.1.xml Makefile
|
||||
xmltoman $< > $@
|
||||
|
||||
padsp.1: padsp.1.xml Makefile
|
||||
xmltoman $< > $@
|
||||
|
||||
pabrowse.1: pabrowse.1.xml Makefile
|
||||
xmltoman $< > $@
|
||||
|
||||
xmllint: $(noinst_DATA)
|
||||
for f in $(noinst_DATA) ; do \
|
||||
xmllint --noout --valid "$$f" || exit 1 ; \
|
||||
|
|
@ -121,6 +151,9 @@ EXTRA_DIST = \
|
|||
pacat.1.xml.in \
|
||||
pacmd.1.xml.in \
|
||||
pactl.1.xml.in \
|
||||
pasuspender.1.xml.in \
|
||||
padsp.1.xml.in \
|
||||
pabrowse.1.xml.in \
|
||||
xmltoman.css \
|
||||
xmltoman.xsl \
|
||||
xmltoman.dtd
|
||||
|
|
|
|||
49
man/pabrowse.1.xml.in
Normal file
49
man/pabrowse.1.xml.in
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
<?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="pabrowse" section="1" desc="List PulseAudio sound servers on the network">
|
||||
|
||||
<synopsis>
|
||||
<cmd>pabrowse</cmd>
|
||||
</synopsis>
|
||||
|
||||
<description>
|
||||
<p><file>pabrowse</file> lists all PulseAudio sound servers on the
|
||||
local network that are being announced with Zeroconf/Avahi.</p>
|
||||
|
||||
<p>This program takes no command line arguments.</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="avahi-daemon" section="8"/>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
</manpage>
|
||||
112
man/padsp.1.xml.in
Normal file
112
man/padsp.1.xml.in
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
<?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="padsp" section="1" desc="PulseAudio OSS Wrapper">
|
||||
|
||||
<synopsis>
|
||||
<cmd>padsp [<arg>options</arg>] <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
|
||||
<cmd>padsp <opt>-h</opt></cmd>
|
||||
</synopsis>
|
||||
|
||||
<description>
|
||||
<p><file>padsp</file> starts the specified program and
|
||||
redirects its access to OSS compatible audio devices
|
||||
(<file>/dev/dsp</file> and auxiliary devices) to a PulseAudio
|
||||
sound server.</p>
|
||||
|
||||
<p><file>padsp</file> uses the $LD_PRELOAD environment variable
|
||||
that is interpreted by <manref name="ld.so" section="8"/> and thus
|
||||
does not work for SUID binaries and statically built
|
||||
executables.</p>
|
||||
|
||||
<p>Equivalent to using <file>padsp</file> is starting an
|
||||
application with $LD_PRELOAD set to
|
||||
<file>libpulsedsp.so</file></p>
|
||||
</description>
|
||||
|
||||
<options>
|
||||
|
||||
<option>
|
||||
<p><opt>-h | --help</opt></p>
|
||||
|
||||
<optdesc><p>Show help.</p></optdesc>
|
||||
</option>
|
||||
|
||||
|
||||
<option>
|
||||
<p><opt>-s</opt> <arg>SERVER</arg></p>
|
||||
|
||||
<optdesc><p>Set the PulseAudio server to connect to.</p></optdesc>
|
||||
</option>
|
||||
|
||||
<option>
|
||||
<p><opt>-n</opt> <arg>NAME</arg></p>
|
||||
|
||||
<optdesc><p>The client application name that shall be passed to the server when connecting.</p></optdesc>
|
||||
</option>
|
||||
|
||||
<option>
|
||||
<p><opt>-m</opt> <arg>NAME</arg></p>
|
||||
|
||||
<optdesc><p>The stream name that shall be passed to the server when creating a stream.</p></optdesc>
|
||||
</option>
|
||||
|
||||
<option>
|
||||
<p><opt>-M</opt></p>
|
||||
|
||||
<optdesc><p>Disable <file>/dev/mixer</file> emulation.</p></optdesc>
|
||||
</option>
|
||||
|
||||
<option>
|
||||
<p><opt>-S</opt></p>
|
||||
|
||||
<optdesc><p>Disable <file>/dev/sndstat</file> emulation.</p></optdesc>
|
||||
</option>
|
||||
|
||||
<option>
|
||||
<p><opt>-D</opt></p>
|
||||
|
||||
<optdesc><p>Disable <file>/dev/dsp</file> emulation.</p></optdesc>
|
||||
</option>
|
||||
|
||||
<option>
|
||||
<p><opt>-d</opt></p>
|
||||
|
||||
<optdesc><p>Enable debug output.</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="pasuspender" section="1"/>, <manref name="ld.so" section="8"/>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
</manpage>
|
||||
75
man/pasuspender.1.xml.in
Normal file
75
man/pasuspender.1.xml.in
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
<?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="pasuspender" section="1" desc="Temporarily suspend PulseAudio">
|
||||
|
||||
<synopsis>
|
||||
<cmd>pasuspender [<arg>options</arg>] -- <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
|
||||
<cmd>pasuspender <opt>--help</opt></cmd>
|
||||
<cmd>pasuspender <opt>--version</opt></cmd>
|
||||
</synopsis>
|
||||
|
||||
<description>
|
||||
<p><file>pasuspender</file> is a tool that can be used to tell a
|
||||
local PulseAudio sound server to temporarily suspend access to the
|
||||
audio devices, to allow other
|
||||
applications access them directly. <file>pasuspender</file> will
|
||||
suspend access to the audio devices, fork a child process, and
|
||||
when the child process terminates, resume access again.</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>Specify the sound server to connect to.</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="padsp" section="1"/>, <manref name="pacmd" section="1"/>, <manref name="pactl" section="1"/>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
</manpage>
|
||||
Loading…
Add table
Add a link
Reference in a new issue