command.c: Document return value of handle_connect().
[paraslash.git] / m4 / lls / audioc.suite.m4
1 m4_define(PROGRAM, para_audioc)
2 m4_define(DEFAULT_HISTORY_FILE, ~/.paraslash/audioc.history)
3 [suite audioc]
4 version-string = GIT_VERSION()
5 [supercommand para_audioc]
6 purpose = communicate with para_audiod through a local socket
7 non-opts-name = [command [options]]
8 [description]
9 The client program to control para_audiod at runtime. It allows to
10 enable/disable streaming, to receive status info, or to grab the
11 audio stream at any point of the decoding process.
12
13 If no command is given, para_audioc enters interactive mode.
14 [/description]
15 m4_include(common-option-section.m4)
16 m4_include(help.m4)
17 m4_include(detailed-help.m4)
18 m4_include(version.m4)
19 m4_include(loglevel.m4)
20 m4_include(complete.m4)
21 m4_include(history-file.m4)
22 m4_include(per-command-options-section.m4)
23 [option socket]
24 short_opt = s
25 summary = path to well-known socket
26 arg_info = required_arg
27 arg_type = string
28 typestr = path
29 [help]
30 The default path of the socket is
31 /var/paraslash/audiod.socket.$HOSTNAME.
32 [/help]
33 [option bufsize]
34 short_opt = b
35 summary = size of internal buffer
36 arg_info = required_arg
37 arg_type = uint32
38 typestr = bytes
39 default_val = 8192