From 445991287d541d15a9a446980e1485263ae55e10 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 8 Nov 2007 22:30:33 +0000 Subject: add remaing man pages git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2029 fefdeb5f-60dc-0310-8127-8f9354f1896f --- man/Makefile.am | 37 ++++- man/default.pa.5.xml.in | 58 +++++++ man/pacat.1.xml.in | 32 ++-- man/pulse-client.conf.5.xml.in | 115 +++++++++++++ man/pulse-daemon.conf.5.xml.in | 366 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 590 insertions(+), 18 deletions(-) create mode 100644 man/default.pa.5.xml.in create mode 100644 man/pulse-client.conf.5.xml.in create mode 100644 man/pulse-daemon.conf.5.xml.in diff --git a/man/Makefile.am b/man/Makefile.am index e5ce5530..0a355f95 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -31,7 +31,10 @@ man_MANS = \ pactl.1 \ pasuspender.1 \ padsp.1 \ - pabrowse.1 + pabrowse.1 \ + pulse-daemon.conf.5 \ + pulse-client.conf.5 \ + default.pa.5 noinst_DATA = \ pulseaudio.1.xml \ @@ -43,7 +46,10 @@ noinst_DATA = \ pactl.1.xml \ pasuspender.1.xml \ padsp.1.xml \ - pabrowse.1.xml + pabrowse.1.xml \ + pulse-daemon.conf.5.xml \ + pulse-client.conf.5.xml \ + default.pa.5.xml CLEANFILES = \ $(noinst_DATA) @@ -98,6 +104,21 @@ pabrowse.1.xml: pabrowse.1.xml.in Makefile -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ +pulse-daemon.conf.5.xml: pulse-daemon.conf.5.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +pulse-client.conf.5.xml: pulse-client.conf.5.xml.in Makefile + sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \ + -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ + -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ + +default.pa.5.xml: default.pa.5.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 += \ @@ -133,6 +154,15 @@ padsp.1: padsp.1.xml Makefile pabrowse.1: pabrowse.1.xml Makefile xmltoman $< > $@ +pulse-daemon.conf.5: pulse-daemon.conf.5.xml Makefile + xmltoman $< > $@ + +pulse-client.conf.5: pulse-client.conf.5.xml Makefile + xmltoman $< > $@ + +default.pa.5: default.pa.5.xml Makefile + xmltoman $< > $@ + xmllint: $(noinst_DATA) for f in $(noinst_DATA) ; do \ xmllint --noout --valid "$$f" || exit 1 ; \ @@ -154,6 +184,9 @@ EXTRA_DIST = \ pasuspender.1.xml.in \ padsp.1.xml.in \ pabrowse.1.xml.in \ + pulse-daemon.conf.5.xml.in \ + pulse-client.conf.5.xml.in \ + default.pa.5.xml.in \ xmltoman.css \ xmltoman.xsl \ xmltoman.dtd diff --git a/man/default.pa.5.xml.in b/man/default.pa.5.xml.in new file mode 100644 index 00000000..0f826db6 --- /dev/null +++ b/man/default.pa.5.xml.in @@ -0,0 +1,58 @@ + + + + + + + + + + + +

~/.pulse/default.pa

+ +

@pulseconfdir@/default.pa

+ + + +

The PulseAudio sound server interprets the file + ~/.pulse/default.pa on startup, and when that file + doesn't exist @pulseconfdir@/default.pa. It + should contain directives in the PulseAudio CLI languages, as + documented on .

+ +

The same commands can also be entered during runtime in the tool, allowing flexible runtime reconfiguration.

+ + +
+

The PulseAudio Developers <@PACKAGE_BUGREPORT@>; + PulseAudio is available from

+
+ +
+

+ , , +

+
+ + diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in index 35c7651b..e02ad667 100644 --- a/man/pacat.1.xml.in +++ b/man/pacat.1.xml.in @@ -109,11 +109,11 @@ USA.

--format=FORMAT

Capture or play back audio with the specified sample - format. Specify one of u8, s16le, - s16be, float32le, float32be, - ulaw, alaw. Depending on the endianess of - the CPU the formats s16ne, s16re, - float32ne, float32re (for native, + format. Specify one of u8, s16le, + s16be, float32le, float32be, + ulaw, alaw. Depending on the endianess of + the CPU the formats s16ne, s16re, + float32ne, float32re (for native, resp. reverse endian) are available as aliases. Defaults to s16ne.

 @@ -132,17 +132,17 @@ USA.

Explicitly choose a channel map when playing back this stream. The argument should be a comma separated list of - channel names: front-left, front-right, - mono, front-center, rear-left, - rear-right, rear-center, lfe, - front-left-of-center, - front-right-of-center, side-left, - side-right, top-center, - top-front-center, top-front-left, - top-front-right, top-rear-left, - top-rear-right, top-rear-center, or any of - the 32 auxiliary channel names aux0 to - aux31.

 + channel names: front-left, front-right, + mono, front-center, rear-left, + rear-right, rear-center, lfe, + front-left-of-center, + front-right-of-center, side-left, + side-right, top-center, + top-front-center, top-front-left, + top-front-right, top-rear-left, + top-rear-right, top-rear-center, or any of + the 32 auxiliary channel names aux0 to + aux31.

diff --git a/man/pulse-client.conf.5.xml.in b/man/pulse-client.conf.5.xml.in new file mode 100644 index 00000000..dbf8dc0b --- /dev/null +++ b/man/pulse-client.conf.5.xml.in @@ -0,0 +1,115 @@ + + + + + + + + + + + +

~/.pulse/client.conf

+ +

@pulseconfdir@/client.conf

+ + + +

The PulseAudio client library reads configuration directives from + a file ~/.pulse/client.conf on startup, and when that + file doesn't exist from + @pulseconfdir@/client.conf.

+ +

The configuration file is a simple collection of variable + declarations. If the configuration file parser encounters either ; + or # for it ignores the rest of the line until its end.

+ +

For the settings that take a boolean argument, the values + true, yes, on and 1 + are equivalent, resp. false, no, + off, 0.

+ + + +
+ + + + + + + + + + + + + + + + + +
+ +
+

The PulseAudio Developers <@PACKAGE_BUGREPORT@>; + PulseAudio is available from

+
+ +
+

+ , +

+
+ + diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in new file mode 100644 index 00000000..88bf8f58 --- /dev/null +++ b/man/pulse-daemon.conf.5.xml.in @@ -0,0 +1,366 @@ + + + + + + + + + + + +

~/.pulse/daemon.conf

+ +

@pulseconfdir@/daemon.conf

+ + + +

The PulseAudio sound server reads configuration directives from + a file ~/.pulse/daemon.conf on startup, and when that + file doesn't exist from + @pulseconfdir@/daemon.conf. Please note that the + server also reads a configuration script on startup + default.pa which also contains runtime configuration + directives.

+ +

The configuration file is a simple collection of variable + declarations. If the configuration file parser encounters either ; + or # for it ignores the rest of the line until its end.

+ +

For the settings that take a boolean argument, the values + true, yes, on and 1 + are equivalent, resp. false, no, + off, 0.

+ + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + +
+ +
+ + + + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +
+ +

See for + more information. Set to -1 if PulseAudio shall not touch the resource + limit. Not all resource limits are available on all operating + systems.

+ + + + + + + + + + + + +
+ +
+ +

Most drivers try to open the audio device with these settings + and then fall back to lower settings. The default settings are CD + quality: 16bit native endian, 2 channels, 44100 Hz sampling.

+ + + + + + + +
+ +
+ +

Some hardware drivers require the hardware playback buffer to + be subdivided into several fragments. It is possible to change + these buffer metrics for machines with high scheduling + latencies. Not all possible values that may be configured here are + available in all hardware. The driver will to find the nearest + setting supported.

+ + + + +
+ +
+

The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from

+
+ +
+

+ , , , +

+
+ + -- cgit