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 COMMANDS:
  18   -h, --help                            Show this help
  19       --version                         Show version
  20       --dump-conf                       Dump default configuration
  21       --dump-modules                    Dump list of available modules
  22   -k  --kill                            Kill a running daemon
  23       --check                           Check for a running daemon
  24
  25 OPTIONS:
  26   -D, --daemonize[=BOOL]                Daemonize after startup
  27       --fail[=BOOL]                     Quit when startup fails
  28       --verbose[=BOOL]                  Be slightly more verbose
  29       --high-priority[=BOOL]            Try to set high process priority
  30                                         (only available as root)
  31       --disallow-module-loading[=BOOL]  Disallow module loading after startup
  32       --exit-idle-time=SECS             Terminate the daemon when idle and this
  33                                         time passed
  34       --module-idle-time=SECS           Unload autoloaded modules when idle and
  35                                         this time passed
  36       --scache-idle-time=SECS           Unload autoloaded samples when idle and
  37                                         this time passed
  38       --log-target={auto,syslog,stderr} Specify the log target
  39   -p, --dl-search-path=PATH             Set the search path for dynamic shared
  40                                         objects (plugins)
  41       --resample-method=[METHOD]        Use the specified resampling method
  42                                         (one of src-sinc-medium-quality,
  43                                         src-sinc-best-quality,src-sinc-fastest
  44                                         src-zero-order-hold,src-linear,trivial)
  45       --use-pid-file[=BOOL]             Create a PID file
  46
  47 STARTUP SCRIPT:
  48   -L, --load="MODULE ARGUMENTS"         Load the specified plugin module with
  49                                         the specified argument
  50   -F, --file=FILENAME                   Run the specified script
  51   -C                                    Open a command line on the running TTY
  52                                         after startup
  53
  54   -n                                    Don't load default script file
  55 </pre>
  56
  57 <h3>Example</h3>
  58
  59 <p>It is a good idea to run the daemon like this:</p>
  60
  61 <pre>polypaudio -D</pre>
  62
  63 <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>
  64
  65 <h2>Signals</h2>
  66
  67 <p>The following signals are trapped specially:</p>
  68
  69 <h3>SIGINT</h3>
  70
  71 <p>The daemon is shut down cleanly.</p>
  72
  73 <h3>SIGUSR1</h3>
  74
  75 <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>
  76
  77 <h3>SIGUSR2</h3>
  78
  79 <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>
  80
  81 <h3>SIGHUP</h3>
  82
  83 <p>The daemon logs the current server layout.</p>
  84
  85 <hr/>
  86 <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, November 2004</address>
  87 <div class="grey"><i>$Id$</i></div>
  88 </body> </html>