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
30 #include <pulse/xmalloc.h>
31 #include <pulse/util.h>
33 #include <pulsecore/core-util.h>
34 #include <pulsecore/i18n.h>
35 #include <pulsecore/strbuf.h>
36 #include <pulsecore/macro.h>
40 /* Argument codes for getopt_long() */
51 ARG_DISALLOW_MODULE_LOADING
,
68 ARG_DUMP_RESAMPLE_METHODS
,
74 /* Table for getopt_long() */
75 static const struct option long_options
[] = {
76 {"help", 0, 0, ARG_HELP
},
77 {"version", 0, 0, ARG_VERSION
},
78 {"dump-conf", 0, 0, ARG_DUMP_CONF
},
79 {"dump-modules", 0, 0, ARG_DUMP_MODULES
},
80 {"daemonize", 2, 0, ARG_DAEMONIZE
},
81 {"fail", 2, 0, ARG_FAIL
},
82 {"verbose", 2, 0, ARG_LOG_LEVEL
},
83 {"log-level", 2, 0, ARG_LOG_LEVEL
},
84 {"high-priority", 2, 0, ARG_HIGH_PRIORITY
},
85 {"realtime", 2, 0, ARG_REALTIME
},
86 {"disallow-module-loading", 2, 0, ARG_DISALLOW_MODULE_LOADING
},
87 {"disallow-exit", 2, 0, ARG_DISALLOW_EXIT
},
88 {"exit-idle-time", 1, 0, ARG_EXIT_IDLE_TIME
},
89 {"scache-idle-time", 1, 0, ARG_SCACHE_IDLE_TIME
},
90 {"log-target", 1, 0, ARG_LOG_TARGET
},
91 {"log-meta", 2, 0, ARG_LOG_META
},
92 {"log-time", 2, 0, ARG_LOG_TIME
},
93 {"log-backtrace", 1, 0, ARG_LOG_BACKTRACE
},
94 {"load", 1, 0, ARG_LOAD
},
95 {"file", 1, 0, ARG_FILE
},
96 {"dl-search-path", 1, 0, ARG_DL_SEARCH_PATH
},
97 {"resample-method", 1, 0, ARG_RESAMPLE_METHOD
},
98 {"kill", 0, 0, ARG_KILL
},
99 {"start", 0, 0, ARG_START
},
100 {"use-pid-file", 2, 0, ARG_USE_PID_FILE
},
101 {"check", 0, 0, ARG_CHECK
},
102 {"system", 2, 0, ARG_SYSTEM
},
103 {"no-cpu-limit", 2, 0, ARG_NO_CPU_LIMIT
},
104 {"disable-shm", 2, 0, ARG_DISABLE_SHM
},
105 {"dump-resample-methods", 2, 0, ARG_DUMP_RESAMPLE_METHODS
},
106 {"cleanup-shm", 2, 0, ARG_CLEANUP_SHM
},
110 void pa_cmdline_help(const char *argv0
) {
113 printf(_("%s [options]\n\n"
115 " -h, --help Show this help\n"
116 " --version Show version\n"
117 " --dump-conf Dump default configuration\n"
118 " --dump-modules Dump list of available modules\n"
119 " --dump-resample-methods Dump available resample methods\n"
120 " --cleanup-shm Cleanup stale shared memory segments\n"
121 " --start Start the daemon if it is not running\n"
122 " -k --kill Kill a running daemon\n"
123 " --check Check for a running daemon (only returns exit code)\n\n"
126 " --system[=BOOL] Run as system-wide instance\n"
127 " -D, --daemonize[=BOOL] Daemonize after startup\n"
128 " --fail[=BOOL] Quit when startup fails\n"
129 " --high-priority[=BOOL] Try to set high nice level\n"
130 " (only available as root, when SUID or\n"
131 " with elevated RLIMIT_NICE)\n"
132 " --realtime[=BOOL] Try to enable realtime scheduling\n"
133 " (only available as root, when SUID or\n"
134 " with elevated RLIMIT_RTPRIO)\n"
135 " --disallow-module-loading[=BOOL] Disallow module user requested module\n"
136 " loading/unloading after startup\n"
137 " --disallow-exit[=BOOL] Disallow user requested exit\n"
138 " --exit-idle-time=SECS Terminate the daemon when idle and this\n"
140 " --scache-idle-time=SECS Unload autoloaded samples when idle and\n"
141 " this time passed\n"
142 " --log-level[=LEVEL] Increase or set verbosity level\n"
143 " -v Increase the verbosity level\n"
144 " --log-target={auto,syslog,stderr,file:PATH,newfile:PATH}\n"
145 " Specify the log target\n"
146 " --log-meta[=BOOL] Include code location in log messages\n"
147 " --log-time[=BOOL] Include timestamps in log messages\n"
148 " --log-backtrace=FRAMES Include a backtrace in log messages\n"
149 " -p, --dl-search-path=PATH Set the search path for dynamic shared\n"
150 " objects (plugins)\n"
151 " --resample-method=METHOD Use the specified resampling method\n"
152 " (See --dump-resample-methods for\n"
153 " possible values)\n"
154 " --use-pid-file[=BOOL] Create a PID file\n"
155 " --no-cpu-limit[=BOOL] Do not install CPU load limiter on\n"
156 " platforms that support it.\n"
157 " --disable-shm[=BOOL] Disable shared memory support.\n\n"
160 " -L, --load=\"MODULE ARGUMENTS\" Load the specified plugin module with\n"
161 " the specified argument\n"
162 " -F, --file=FILENAME Run the specified script\n"
163 " -C Open a command line on the running TTY\n"
166 " -n Don't load default script file\n"),
167 pa_path_get_filename(argv0
));
170 int pa_cmdline_parse(pa_daemon_conf
*conf
, int argc
, char *const argv
[], int *d
) {
171 pa_strbuf
*buf
= NULL
;
179 buf
= pa_strbuf_new();
181 if (conf
->script_commands
)
182 pa_strbuf_puts(buf
, conf
->script_commands
);
184 while ((c
= getopt_long(argc
, argv
, "L:F:ChDnp:kv", long_options
, NULL
)) != -1) {
188 conf
->cmd
= PA_CMD_HELP
;
192 conf
->cmd
= PA_CMD_VERSION
;
196 conf
->cmd
= PA_CMD_DUMP_CONF
;
199 case ARG_DUMP_MODULES
:
200 conf
->cmd
= PA_CMD_DUMP_MODULES
;
203 case ARG_DUMP_RESAMPLE_METHODS
:
204 conf
->cmd
= PA_CMD_DUMP_RESAMPLE_METHODS
;
207 case ARG_CLEANUP_SHM
:
208 conf
->cmd
= PA_CMD_CLEANUP_SHM
;
213 conf
->cmd
= PA_CMD_KILL
;
217 conf
->cmd
= PA_CMD_START
;
218 conf
->daemonize
= TRUE
;
222 conf
->cmd
= PA_CMD_CHECK
;
227 pa_strbuf_printf(buf
, "load-module %s\n", optarg
);
233 pa_strbuf_printf(buf
, ".include %s\n", p
= pa_make_path_absolute(optarg
));
239 pa_strbuf_puts(buf
, "load-module module-cli exit_on_eof=1\n");
244 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
245 pa_log(_("--daemonize expects boolean argument"));
248 conf
->daemonize
= !!b
;
252 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
253 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 ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
276 pa_log(_("--high-priority expects boolean argument"));
279 conf
->high_priority
= !!b
;
283 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
284 pa_log(_("--realtime expects boolean argument"));
287 conf
->realtime_scheduling
= !!b
;
290 case ARG_DISALLOW_MODULE_LOADING
:
291 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
292 pa_log(_("--disallow-module-loading expects boolean argument"));
295 conf
->disallow_module_loading
= !!b
;
298 case ARG_DISALLOW_EXIT
:
299 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
300 pa_log(_("--disallow-exit expects boolean argument"));
303 conf
->disallow_exit
= !!b
;
306 case ARG_USE_PID_FILE
:
307 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
308 pa_log(_("--use-pid-file expects boolean argument"));
311 conf
->use_pid_file
= !!b
;
315 case ARG_DL_SEARCH_PATH
:
316 pa_xfree(conf
->dl_search_path
);
317 conf
->dl_search_path
= *optarg
? pa_xstrdup(optarg
) : NULL
;
321 conf
->load_default_script_file
= FALSE
;
325 if (pa_daemon_conf_set_log_target(conf
, optarg
) < 0) {
326 pa_log(_("Invalid log target: use either 'syslog', 'stderr' or 'auto' or a valid file name 'file:<path>', 'newfile:<path>'."));
332 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
333 pa_log(_("--log-time expects boolean argument"));
336 conf
->log_time
= !!b
;
340 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
341 pa_log(_("--log-meta expects boolean argument"));
344 conf
->log_meta
= !!b
;
347 case ARG_LOG_BACKTRACE
:
348 conf
->log_backtrace
= (unsigned) atoi(optarg
);
351 case ARG_EXIT_IDLE_TIME
:
352 conf
->exit_idle_time
= atoi(optarg
);
355 case ARG_SCACHE_IDLE_TIME
:
356 conf
->scache_idle_time
= atoi(optarg
);
359 case ARG_RESAMPLE_METHOD
:
360 if (pa_daemon_conf_set_resample_method(conf
, optarg
) < 0) {
361 pa_log(_("Invalid resample method '%s'."), optarg
);
367 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
368 pa_log(_("--system expects boolean argument"));
371 conf
->system_instance
= !!b
;
374 case ARG_NO_CPU_LIMIT
:
375 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
376 pa_log(_("--no-cpu-limit expects boolean argument"));
379 conf
->no_cpu_limit
= !!b
;
382 case ARG_DISABLE_SHM
:
383 if ((b
= optarg
? pa_parse_boolean(optarg
) : 1) < 0) {
384 pa_log(_("--disable-shm expects boolean argument"));
387 conf
->disable_shm
= !!b
;
395 pa_xfree(conf
->script_commands
);
396 conf
->script_commands
= pa_strbuf_tostring_free(buf
);