diff options
author | Lennart Poettering <lennart@poettering.net> | 2004-07-17 14:06:13 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2004-07-17 14:06:13 +0000 |
commit | 7b8c329578d642d31618d487b97864306c43073c (patch) | |
tree | 4772f1ca82bfde919e559e0a85ce7d728ecb434c /doc/daemon.html.in | |
parent | 3e379ca99d44c84b2117ac048ee6e84fc2837280 (diff) |
add documentation
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@86 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'doc/daemon.html.in')
-rw-r--r-- | doc/daemon.html.in | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/daemon.html.in b/doc/daemon.html.in new file mode 100644 index 00000000..a5d933db --- /dev/null +++ b/doc/daemon.html.in @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>polypaudio: Daemon</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +</head> + +<body> +<h1>Daemon</h1> + +<h2>Command Line Arguments</h2> + +The <tt>polypaudio</tt> daemon accepts several command line arguments: + +<p><tt>-L MODULE</tt>: Load the specified module. This option may be specified more than once.</p> +<p><tt>-F FILE</tt>: Run the specified script. This option may be specified more than once.</p> +<p><tt>-C</tt>: Load the module <a href="modules.html#module-cli"><tt>module-cli</tt></a> after startup.</p> +<p><tt>-D</tt>: Daemonize after successfully executing all scripts and loading all modules.</p> +<p><tt>-f</tt>: Unless this option is given the daemon will terminate if any of the specified modules failed to load or the script didn't execute successfully.</p> +<p><tt>-v</tt>: Increase the verbosity of the daemon.</p> +<p><tt>-h</tt>: Show a quick help.</p> + +<h3>Example</h3> + +<p>It is a good idea to run the daemon like this:</p> + +<pre>polypaudio -D -F /etc/polypaudio/polypaudio.pa</pre> + +<p><tt>/etc/polypaudio/polypaudio.pa</tt> should be a script written in the CLI language described in <a href="cli.html">cli.html</a> + +<h2>Signals</h2> + +<p>The following signals are trapped specially:</p> + +<h3>SIGINT</h3> + +<p>The daemon is shut down cleanly.</p> + +<h3>SIGUSR1</h3> + +<p>The daemon tries to load the module <a href="modules.html#module-cli"><tt>module-cli</tt></a>, effectively providing a command line interface on the calling TTY.</p> + +<h3>SIGUSR2</h3> + +<p>The daemon tries to load the module <a href="modules.html#module-cli-protocol-unix"><tt>module-cli-protocol-unix</tt></a>, effectively providing a command line interface on a special UNIX domain socket.</p> + +<hr/> +<address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, July 2004</address> +<div class="grey"><i>$Id$</i></div> +</body> </html> |