doc/daemon.html.in

   1 <?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>polypaudio: Daemon</title>
   6 <link rel="stylesheet" type="text/css" href="style.css" />
   7 </head>
   8
   9 <body>
  10 <h1>Daemon</h1>
  11
  12 <h2>Command Line Arguments</h2>
  13
  14 The <tt>polypaudio</tt> daemon accepts several command line arguments:
  15
  16 <pre>
  17   -h, --help                            Show this help
  18       --version                         Show version
  19       --dump-conf                       Dump default configuration
  20       --dump-modules                    Dump list of available modules
  21
  22   -D, --daemonize[=BOOL]                Daemonize after startup
  23       --fail[=BOOL]                     Quit when startup fails
  24       --verbose[=BOOL]                  Be slightly more verbose
  25       --high-priority[=BOOL]            Try to set high process priority (only available as root)
  26       --disallow-module-loading[=BOOL]  Disallow module loading after startup
  27       --exit-idle-time=SECS             Terminate the daemon when idle and this time passed
  28       --module-idle-time=SECS           Unload autoloaded modules when idle and this time passed
  29       --scache-idle-time=SECS           Unload autoloaded samples when idle and this time passed
  30       --log-target={auto,syslog,stderr} Specify the log target
  31   -p, --dl-search-path=PATH             Set the search path for dynamic shared objects (plugins)
  32       --resample-method=[METHOD]        Use the specified resampling method
  33
  34   -L, --load="MODULE ARGUMENTS"         Load the specified plugin module with the specified argument
  35   -F, --file=FILENAME                   Run the specified script
  36   -C                                    Open a command line on the running TTY after startup (identical to -Lmodule-cli)
  37
  38   -n                                    Don't load default script file
  39 </pre>
  40
  41 <h3>Example</h3>
  42
  43 <p>It is a good idea to run the daemon like this:</p>
  44
  45 <pre>polypaudio -D</pre>
  46
  47 <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>
  48
  49 <h2>Signals</h2>
  50
  51 <p>The following signals are trapped specially:</p>
  52
  53 <h3>SIGINT</h3>
  54
  55 <p>The daemon is shut down cleanly.</p>
  56
  57 <h3>SIGUSR1</h3>
  58
  59 <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>
  60
  61 <h3>SIGUSR2</h3>
  62
  63 <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>
  64
  65 <hr/>
  66 <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, September 2004</address>
  67 <div class="grey"><i>$Id$</i></div>
  68 </body> </html>