From 2d87bd2d2f088220ccf98af93073cfd807dc2d1b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 20 Sep 2004 20:52:35 +0000 Subject: documentation update git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@225 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/daemon.html.in | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) (limited to 'doc/daemon.html.in') diff --git a/doc/daemon.html.in b/doc/daemon.html.in index e4903a8b..147ee551 100644 --- a/doc/daemon.html.in +++ b/doc/daemon.html.in @@ -13,28 +13,38 @@ The polypaudio daemon accepts several command line arguments: -

-r: Set low nice value (high priority) and SCHED_FIFO scheduling if available. Works only when started as root or SUID root.

-

-R: Don't drop root rights if started SUID root.

-

-L MODULE: Load the specified module. This option may be specified more than once.

-

-F FILE: Run the specified script. This option may be specified more than once.

-

-C: Load the module module-cli after startup.

-

-n: Don't load the default configuration file. Normally ~/.polypaudio or /etc/polyp/polypaudio.pa are loaded on startup.

-

-D: Daemonize after successfully executing all scripts and loading all modules.

-

-d: Disallow module load and unload after startup.

-

-f: 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.

-

-v: Increase the verbosity of the daemon.

-

-X SECS: Terminate the daemon after the last client exited an SECS seconds passed.

-

-h: Show a quick help.

-

-l TARGET: Specify the log target (syslog, stderr, auto). Defaults to auto, which means stderr when run without -D and syslog when run with -D.

-

-V: Show version.

+
+  -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
+

Example

It is a good idea to run the daemon like this:

-
polypaudio -rD
+
polypaudio -D
-

This will run /etc/polypaudio/polypaudio.pa after startup. This should be a script written in the CLI language described in cli.html.

+

This will run /etc/polypaudio/default.pa after startup. This should be a script written in the CLI language described in cli.html.

Signals

-- cgit