summaryrefslogtreecommitdiffstats
path: root/doc/daemon.html.in
blob: e4903a8ba13296568414ec66bd098d03bb672d70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<?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>-r</tt>: Set low nice value (high priority) and SCHED_FIFO scheduling if available. Works only when started as root or SUID root.</p>
<p><tt>-R</tt>: Don't drop root rights if started SUID root.</p>
<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>-n</tt>: Don't load the default configuration file. Normally <tt>~/.polypaudio</tt> or <tt>/etc/polyp/polypaudio.pa</tt> are loaded on startup.</p>
<p><tt>-D</tt>: Daemonize after successfully executing all scripts and loading all modules.</p>
<p><tt>-d</tt>: Disallow module load and unload after startup.</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>-X SECS</tt>: Terminate the daemon after the last client exited an SECS seconds passed.</p>
<p><tt>-h</tt>: Show a quick help.</p>
<p><tt>-l TARGET</tt>: Specify the log target (<tt>syslog</tt>, <tt>stderr</tt>, <tt>auto</tt>). Defaults to <tt>auto</tt>, which means <tt>stderr</tt> when run without <tt>-D</tt> and <tt>syslog</tt> when run with <tt>-D</tt>.</p>
<p><tt>-V</tt>: Show version.</p>

<h3>Example</h3>

<p>It is a good idea to run the daemon like this:</p>

<pre>polypaudio -rD</pre>

<p>This will run <tt>/etc/polypaudio/polypaudio.pa</tt> after startup. This should be a script written in the CLI language described in <a href="cli.html">cli.html</a>. </p>

<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 &lt;@PACKAGE_BUGREPORT@&gt;, September 2004</address>
<div class="grey"><i>$Id$</i></div>
</body> </html>