man: Document the cli inteface a little.
[profile/ivi/pulseaudio.git] / man / default.pa.5.xml.in
1 <?xml version="1.0"?><!--*-nxml-*-->
2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
4
5 <!--
6 This file is part of PulseAudio.
7
8 PulseAudio is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as
10 published by the Free Software Foundation; either version 2.1 of the
11 License, or (at your option) any later version.
12
13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
16 Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public
19 License along with PulseAudio; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 USA.
22 -->
23
24 <manpage name="default.pa" section="5" desc="PulseAudio Sound Server Startup Script">
25
26   <synopsis>
27     <p><file>~/.pulse/default.pa</file></p>
28
29     <p><file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file></p>
30   </synopsis>
31
32   <description>
33     <p>The PulseAudio sound server interprets the file
34     <file>~/.pulse/default.pa</file> on startup, and when that file
35     doesn't exist <file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file>. It
36     should contain directives in the PulseAudio CLI languages, as
37     documented in <manref name="pulse-cli-syntax" section="5"/>.</p>
38
39     <p>The same commands can also be entered during runtime in the <manref name="pacmd"
40       section="1"/> tool, allowing flexible runtime reconfiguration.</p>
41   </description>
42
43   <section name="Authors">
44     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
45     PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
46   </section>
47
48   <section name="See also">
49     <p>
50       <manref name="pulse-cli-syntax" section="5"/>,
51       <manref name="pulse-daemon.conf" section="5"/>,
52       <manref name="pulseaudio" section="1"/>,
53       <manref name="pacmd" section="1"/>
54     </p>
55   </section>
56
57 </manpage>