2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include <pulse/xmalloc.h>
33 #include <pulse/i18n.h>
34 #include <pulse/util.h>
36 #include <pulsecore/core-util.h>
37 #include <pulsecore/strbuf.h>
38 #include <pulsecore/macro.h>
42 /* Argument codes for getopt_long() */
53 ARG_DISALLOW_MODULE_LOADING,
70 ARG_DUMP_RESAMPLE_METHODS,
76 /* Tabel for getopt_long() */
77 static const struct option long_options[] = {
78 {"help", 0, 0, ARG_HELP},
79 {"version", 0, 0, ARG_VERSION},
80 {"dump-conf", 0, 0, ARG_DUMP_CONF},
81 {"dump-modules", 0, 0, ARG_DUMP_MODULES},
82 {"daemonize", 2, 0, ARG_DAEMONIZE},
83 {"fail", 2, 0, ARG_FAIL},
84 {"verbose", 2, 0, ARG_LOG_LEVEL},
85 {"log-level", 2, 0, ARG_LOG_LEVEL},
86 {"high-priority", 2, 0, ARG_HIGH_PRIORITY},
87 {"realtime", 2, 0, ARG_REALTIME},
88 {"disallow-module-loading", 2, 0, ARG_DISALLOW_MODULE_LOADING},
89 {"disallow-exit", 2, 0, ARG_DISALLOW_EXIT},
90 {"exit-idle-time", 2, 0, ARG_EXIT_IDLE_TIME},
91 {"scache-idle-time", 2, 0, ARG_SCACHE_IDLE_TIME},
92 {"log-target", 1, 0, ARG_LOG_TARGET},
93 {"log-meta", 2, 0, ARG_LOG_META},
94 {"log-time", 2, 0, ARG_LOG_TIME},
95 {"log-backtrace", 1, 0, ARG_LOG_BACKTRACE},
96 {"load", 1, 0, ARG_LOAD},
97 {"file", 1, 0, ARG_FILE},
98 {"dl-search-path", 1, 0, ARG_DL_SEARCH_PATH},
99 {"resample-method", 1, 0, ARG_RESAMPLE_METHOD},
100 {"kill", 0, 0, ARG_KILL},
101 {"start", 0, 0, ARG_START},
102 {"use-pid-file", 2, 0, ARG_USE_PID_FILE},
103 {"check", 0, 0, ARG_CHECK},
104 {"system", 2, 0, ARG_SYSTEM},
105 {"no-cpu-limit", 2, 0, ARG_NO_CPU_LIMIT},
106 {"disable-shm", 2, 0, ARG_DISABLE_SHM},
107 {"dump-resample-methods", 2, 0, ARG_DUMP_RESAMPLE_METHODS},
108 {"cleanup-shm", 2, 0, ARG_CLEANUP_SHM},
112 void pa_cmdline_help(const char *argv0) {
115 printf(_("%s [options]\n\n"
117 " -h, --help Show this help\n"
118 " --version Show version\n"
119 " --dump-conf Dump default configuration\n"
120 " --dump-modules Dump list of available modules\n"
121 " --dump-resample-methods Dump available resample methods\n"
122 " --cleanup-shm Cleanup stale shared memory segments\n"
123 " --start Start the daemon if it is not running\n"
124 " -k --kill Kill a running daemon\n"
125 " --check Check for a running daemon (only returns exit code)\n\n"
128 " --system[=BOOL] Run as system-wide instance\n"
129 " -D, --daemonize[=BOOL] Daemonize after startup\n"
130 " --fail[=BOOL] Quit when startup fails\n"
131 " --high-priority[=BOOL] Try to set high nice level\n"
132 " (only available as root, when SUID or\n"
133 " with elevated RLIMIT_NICE)\n"
134 " --realtime[=BOOL] Try to enable realtime scheduling\n"
135 " (only available as root, when SUID or\n"
136 " with elevated RLIMIT_RTPRIO)\n"
137 " --disallow-module-loading[=BOOL] Disallow module user requested module\n"
138 " loading/unloading after startup\n"
139 " --disallow-exit[=BOOL] Disallow user requested exit\n"
140 " --exit-idle-time=SECS Terminate the daemon when idle and this\n"
142 " --module-idle-time=SECS Unload autoloaded modules when idle and\n"
143 " this time passed\n"
144 " --scache-idle-time=SECS Unload autoloaded samples when idle and\n"
145 " this time passed\n"
146 " --log-level[=LEVEL] Increase or set verbosity level\n"
147 " -v Increase the verbosity level\n"
148 " --log-target={auto,syslog,stderr} Specify the log target\n"
149 " --log-meta[=BOOL] Include code location in log messages\n"
150 " --log-time[=BOOL] Include timestamps in log messages\n"
151 " --log-backtrace=FRAMES Include a backtrace in log messages\n"
152 " -p, --dl-search-path=PATH Set the search path for dynamic shared\n"
153 " objects (plugins)\n"
154 " --resample-method=METHOD Use the specified resampling method\n"
155 " (See --dump-resample-methods for\n"
156 " possible values)\n"
157 " --use-pid-file[=BOOL] Create a PID file\n"
158 " --no-cpu-limit[=BOOL] Do not install CPU load limiter on\n"
159 " platforms that support it.\n"
160 " --disable-shm[=BOOL] Disable shared memory support.\n\n"
163 " -L, --load=\"MODULE ARGUMENTS\" Load the specified plugin module with\n"
164 " the specified argument\n"
165 " -F, --file=FILENAME Run the specified script\n"
166 " -C Open a command line on the running TTY\n"
169 " -n Don't load default script file\n"),
170 pa_path_get_filename(argv0));
173 int pa_cmdline_parse(pa_daemon_conf *conf, int argc, char *const argv [], int *d) {
174 pa_strbuf *buf = NULL;
181 buf = pa_strbuf_new();
183 if (conf->script_commands)
184 pa_strbuf_puts(buf, conf->script_commands);
186 while ((c = getopt_long(argc, argv, "L:F:ChDnp:kv", long_options, NULL)) != -1) {
190 conf->cmd = PA_CMD_HELP;
194 conf->cmd = PA_CMD_VERSION;
198 conf->cmd = PA_CMD_DUMP_CONF;
201 case ARG_DUMP_MODULES:
202 conf->cmd = PA_CMD_DUMP_MODULES;
205 case ARG_DUMP_RESAMPLE_METHODS:
206 conf->cmd = PA_CMD_DUMP_RESAMPLE_METHODS;
209 case ARG_CLEANUP_SHM:
210 conf->cmd = PA_CMD_CLEANUP_SHM;
215 conf->cmd = PA_CMD_KILL;
219 conf->cmd = PA_CMD_START;
220 conf->daemonize = TRUE;
224 conf->cmd = PA_CMD_CHECK;
229 pa_strbuf_printf(buf, "load-module %s\n", optarg);
235 pa_strbuf_printf(buf, ".include %s\n", p = pa_make_path_absolute(optarg));
241 pa_strbuf_puts(buf, "load-module module-cli exit_on_eof=1\n");
246 if ((conf->daemonize = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
247 pa_log(_("--daemonize expects boolean argument"));
253 if ((conf->fail = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
254 pa_log(_("--fail expects boolean argument"));
263 if (pa_daemon_conf_set_log_level(conf, optarg) < 0) {
264 pa_log(_("--log-level expects log level argument (either numeric in range 0..4 or one of debug, info, notice, warn, error)."));
268 if (conf->log_level < PA_LOG_LEVEL_MAX-1)
274 case ARG_HIGH_PRIORITY:
275 if ((conf->high_priority = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
276 pa_log(_("--high-priority expects boolean argument"));
282 if ((conf->realtime_scheduling = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
283 pa_log(_("--realtime expects boolean argument"));
288 case ARG_DISALLOW_MODULE_LOADING:
289 if ((conf->disallow_module_loading = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
290 pa_log(_("--disallow-module-loading expects boolean argument"));
295 case ARG_DISALLOW_EXIT:
296 if ((conf->disallow_exit = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
297 pa_log(_("--disallow-exit expects boolean argument"));
302 case ARG_USE_PID_FILE:
303 if ((conf->use_pid_file = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
304 pa_log(_("--use-pid-file expects boolean argument"));
310 case ARG_DL_SEARCH_PATH:
311 pa_xfree(conf->dl_search_path);
312 conf->dl_search_path = *optarg ? pa_xstrdup(optarg) : NULL;
316 conf->load_default_script_file = FALSE;
320 if (pa_daemon_conf_set_log_target(conf, optarg) < 0) {
321 pa_log(_("Invalid log target: use either 'syslog', 'stderr' or 'auto'."));
327 if ((conf->log_time = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
328 pa_log(_("--log-time expects boolean argument"));
334 if ((conf->log_meta = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
335 pa_log(_("--log-meta expects boolean argument"));
340 case ARG_LOG_BACKTRACE:
341 conf->log_backtrace = (unsigned) atoi(optarg);
344 case ARG_EXIT_IDLE_TIME:
345 conf->exit_idle_time = atoi(optarg);
348 case ARG_SCACHE_IDLE_TIME:
349 conf->scache_idle_time = atoi(optarg);
352 case ARG_RESAMPLE_METHOD:
353 if (pa_daemon_conf_set_resample_method(conf, optarg) < 0) {
354 pa_log(_("Invalid resample method '%s'."), optarg);
360 if ((conf->system_instance = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
361 pa_log(_("--system expects boolean argument"));
366 case ARG_NO_CPU_LIMIT:
367 if ((conf->no_cpu_limit = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
368 pa_log(_("--no-cpu-limit expects boolean argument"));
373 case ARG_DISABLE_SHM:
374 if ((conf->disable_shm = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
375 pa_log(_("--disable-shm expects boolean argument"));
385 pa_xfree(conf->script_commands);
386 conf->script_commands = pa_strbuf_tostring_free(buf);