update todo

[pulseaudio] / doc / modules.html.in

diff --git a/doc/modules.html.in b/doc/modules.html.in
index 5e9b8873ca2f43f9cf55c3a420e8e384725c67d1..a549396d082b7b89d0e0ac5ee1a6f94c2ae34707 100644 (file)
--- a/doc/modules.html.in
+++ b/doc/modules.html.in
@@ -138,6 +138,17 @@ buffer control is lost through this tunneling.</p>
   <tr><td><tt>cookie=</tt></td><td>The authentication cookie file to use.</td></tr>
 </table>
 
+<h3>module-esound-sink</h3>
+
+<p>Create a playback sink using an ESOUND server as backend. Whenever you can, try to omit this
+module since it has many disadvantages including bad latency
+and even worse latency measurement. </p>
+
+<table>
+  <tr><td><tt>server=</tt></td><td>The server to connect to</td></tr>
+  <tr><td><tt>cookie=</tt></td><td>The authentication cookie file to use.</td></tr>
+</table>
+
 <h2>Protocols</h2>
 
 <a name="module-cli"/>
@@ -157,7 +168,7 @@ module see <a href="cli.html"><tt>cli.html</tt></a>.
 <a name="module-cli-protocol-tcp"/>
 <a name="module-cli-protocol"/>
 
-<h3>module-cli-protocol-{unix,tcp}</h3>
+<h3>module-cli-protocol-{unix,tcp,tcp6}</h3>
 
 <p>An implemenation of a simple command line based protocol for
 controlling the <tt>polypaudio</tt> daemon. If loaded, the user may
@@ -183,7 +194,7 @@ device, i.e. not publicly accessible. (defaults to 1)</td></tr>
   <tr><td><tt>socket=</tt></td><td>(only for <tt>-unix</tt>) The UNIX socket name (defaults to <tt>/tmp/polypaudio/cli</tt>)</td></tr>
 </table>
 
-<h3>module-simple-protocol-{unix,tcp}</h3>
+<h3>module-simple-protocol-{unix,tcp,tcp6}</h3>
 
 <p>An implementation of a simple protocol which allows playback by using
 simple tools like <tt>netcat</tt>. Just connect to the listening
@@ -226,7 +237,7 @@ about the two possible suffixes of this module.</p>
 
 <p>This implementation misses some features the original ESOUND has: e.g. there is no sample cache yet. However: XMMS works fine.</p>
 
-<h3>module-native-protocol-{unix,tcp}</h3>
+<h3>module-native-protocol-{unix,tcp,tcp6}</h3>
 
 <p>The native protocol of <tt>polypaudio</tt>.</p>
 
@@ -256,6 +267,26 @@ about the two possible suffixes of this module.</p>
   <tr><td><tt>sink=</tt></td><td>Name of the sink to play the sample on. If ommited defaults to the default sink.</td></tr>
 </table>
 
+<h3>module-x11-publish</h3>
+
+<p>Publishes the access credentials to the Polypaudio server in the
+X11 root window. The following properties are used:
+<tt>POLYP_SERVER</tt>, <tt>POYLP_SINK</tt>, <tt>POLYP_SOURCE</tt>,
+<tt>POLYP_COOKIE</tt>. This is very useful when using SSH or any other
+remote login tool for logging into other machines and getting audio
+playback to your local speakers. The Polypaudio client libraries make
+use of this data automatically. Instead of using this module you may
+use the tool <tt>pax11publish</tt> which may be used to access, modify
+and import credential data from/to the X11 display.</p>
+
+<table>
+  <tr><td><tt>display=</tt></td><td>X11 display to connect to. If ommited defaults to the value of <tt>$DISPLAY</tt></td></tr>
+  <tr><td><tt>sink=</tt></td><td>Name of the default sink. If ommited this property isn't stored in the X11 display.</td></tr>
+  <tr><td><tt>source=</tt></td><td>Name of the default source. If ommited this property isn't stored in the X11 display.</td></tr>
+  <tr><td><tt>cookie=</tt></td><td>Name of the cookie file of the
+cookie to store in the X11 display. If ommited the cookie of an
+already loaded protocol module is used.</td></tr> </table>
+
 <h3>module-sine</h3>
 
 <p>Creates a sink input and generates a sine waveform stream.</p>
@@ -290,6 +321,6 @@ about the two possible suffixes of this module.</p>
 <p>The volumes of all streams with titles starting with <tt>sample:</tt> are automatically set to 25. (FYI: All sample cache streams start with <tt>sample:</tt>)</p>
 
 <hr/>
-<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, September 2004</address>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, November 2004</address>
 <div class="grey"><i>$Id$</i></div>
 </body> </html>