code.delx.au - pulseaudio/blob - 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 <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>
  17 <p><tt>-R</tt>: Don't drop root rights if started SUID root.</p>
  18 <p><tt>-L MODULE</tt>: Load the specified module. This option may be specified more than once.</p>
  19 <p><tt>-F FILE</tt>: Run the specified script. This option may be specified more than once.</p>
  20 <p><tt>-C</tt>: Load the module <a href="modules.html#module-cli"><tt>module-cli</tt></a> after startup.</p>
  21 <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>
  22 <p><tt>-D</tt>: Daemonize after successfully executing all scripts and loading all modules.</p>
  23 <p><tt>-d</tt>: Disallow module load and unload after startup.</p>
  24 <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>
  25 <p><tt>-v</tt>: Increase the verbosity of the daemon.</p>
  26 <p><tt>-X SECS</tt>: Terminate the daemon after the last client exited an SECS seconds passed.</p>
  27 <p><tt>-h</tt>: Show a quick help.</p>
  28 <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>
  29 <p><tt>-V</tt>: Show version.</p>
  30
  31 <h3>Example</h3>
  32
  33 <p>It is a good idea to run the daemon like this:</p>
  34
  35 <pre>polypaudio -rD</pre>
  36
  37 <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>
  38
  39 <h2>Signals</h2>
  40
  41 <p>The following signals are trapped specially:</p>
  42
  43 <h3>SIGINT</h3>
  44
  45 <p>The daemon is shut down cleanly.</p>
  46
  47 <h3>SIGUSR1</h3>
  48
  49 <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>
  50
  51 <h3>SIGUSR2</h3>
  52
  53 <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>
  54
  55 <hr/>
  56 <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, September 2004</address>
  57 <div class="grey"><i>$Id$</i></div>
  58 </body> </html>