doc/daemon.html.in


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
59
60
61
62
63
64
65
66
67
68

<?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:

<pre>
  -h, --help                            Show this help
      --version                         Show version
      --dump-conf                       Dump default configuration
      --dump-modules                    Dump list of available modules

  -D, --daemonize[=BOOL]                Daemonize after startup
      --fail[=BOOL]                     Quit when startup fails
      --verbose[=BOOL]                  Be slightly more verbose
      --high-priority[=BOOL]            Try to set high process priority (only available as root)
      --disallow-module-loading[=BOOL]  Disallow module loading after startup
      --exit-idle-time=SECS             Terminate the daemon when idle and this time passed
      --module-idle-time=SECS           Unload autoloaded modules when idle and this time passed
      --scache-idle-time=SECS           Unload autoloaded samples when idle and this time passed
      --log-target={auto,syslog,stderr} Specify the log target
  -p, --dl-search-path=PATH             Set the search path for dynamic shared objects (plugins)
      --resample-method=[METHOD]        Use the specified resampling method

  -L, --load="MODULE ARGUMENTS"         Load the specified plugin module with the specified argument
  -F, --file=FILENAME                   Run the specified script
  -C                                    Open a command line on the running TTY after startup (identical to -Lmodule-cli)

  -n                                    Don't load default script file
</pre>

<h3>Example</h3>

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

<pre>polypaudio -D</pre>

<p>This will run <tt>/etc/polypaudio/default.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>