server: Convert non-afs commands to lopsub.
[paraslash.git] / m4 / lls / server_cmd.suite.m4
1 [suite server_cmd]
2 caption = list of server commands
3 aux_info_prefix = Permissions:
4
5 [introduction]
6 The server process listens on a network socket and accepts connections
7 from para_client or para_audiod. For the connection to succeed the
8 connecting peer must authenticate as one of the users stored in the
9 user table of para_server. Each entry of the user table contains the
10 set of permission bits that are granted to the user. Authenticated
11 users may execute one of the commands below if the set of permission
12 bits of the command is a subset of the permission bits that are
13 granted to the user.
14 [/introduction]
15
16 [subcommand ff]
17 purpose = jump N seconds forward or backward
18 synopsis = n[-]
19 aux_info = VSS_READ | VSS_WRITE
20 [description]
21 This sets the 'R' (reposition request) bit of the vss status flags
22 which enqueues a request to jump n seconds forwards or backwards.
23
24 Example:
25
26 para_client ff 30-
27
28 jumps 30 seconds backwards.
29
30 [/description]
31
32 [subcommand help]
33 purpose = list available commands or print command-specific help
34 non-opts-name = [command]
35 aux_info = NO_PERMISSION_REQUIRED
36 [description]
37 Without any arguments, help prints a list of available commands. When
38 called with a command name as first argument, it prints the description
39 of this command.
40 [/description]
41
42 [subcommand hup]
43 purpose = reload config file, log file and user list
44 aux_info = VSS_WRITE
45 [description]
46 Reread the config file and the user list file, close and reopen the log
47 file, and ask the afs process to do the same. Sending the HUP signal
48 to the server process has the same effect as running this command.
49 [/description]
50
51 [subcommand jmp]
52 purpose = reposition the current stream
53 non-opts-name = n
54 aux_info = VSS_READ | VSS_WRITE
55 [description]
56 Set the 'R' (reposition request) bit of the vss status flags and
57 enqueue a request to jump to n% of the current audio file, where 0 <=
58 n <= 100.
59 [/description]
60
61 [subcommand next]
62 purpose = close the stream and start to stream the next audio file
63 aux_info = VSS_READ | VSS_WRITE
64 [description]
65 Set the 'N' (next audio file) bit of the vss status flags. This
66 instructs the server to close the current stream, if any. The 'P'
67 (playing) bit is not modified by this command. If it is on, playing
68 continues with the next audio file.
69
70 This command is equivalent to stop if paused, and has no effect
71 if stopped.
72 [/description]
73
74 [subcommand nomore]
75 purpose = stop playing after current audio file
76 aux_info = VSS_READ | VSS_WRITE
77 [description]
78 Set the 'O' (no more) bit of the vss status flags which asks
79 para_server to clear the 'P' (playing) bit after the 'N' (next audio
80 file) bit transitions from off to on (because the end of the current
81 audio file is reached). Use this command instead of stop if you don't
82 like sudden endings.
83 [/description]
84
85 [subcommand pause]
86 purpose = suspend the current stream
87 aux_info = VSS_READ | VSS_WRITE
88 [description]
89 Clear the 'P' (playing) bit of the vss status flags.
90 [/description]
91
92 [subcommand play]
93 purpose = start or resume playback
94 aux_info = VSS_READ | VSS_WRITE
95 [description]
96 Set the 'P' (playing) bit of the vss status flags.
97 [/description]
98
99 [subcommand sender]
100 purpose = control paraslash senders
101 synopsis = [sender cmd [arguments]]
102 aux_info = VSS_READ | VSS_WRITE
103 [description]
104 Send a command to a specific sender. The following commands are
105 available, but not all senders support every command.
106
107 help, on, off, add, delete, allow, deny, status.
108
109 The help command prints the help text of the given sender. If no
110 command is given the list of available senders is shown.
111
112 Example:
113
114 para_client sender http help
115
116 [/description]
117
118 [subcommand si]
119 purpose = print server info
120 aux_info = NO_PERMISSION_REQUIRED
121 [description]
122 Show server and afs PID, number of connections, uptime and more.
123 [/description]
124
125 [subcommand stat]
126 purpose = print information about the current audio file
127 aux_info = VSS_READ
128 [option num]
129 short_opt = n
130 summary = number of times to show the status info
131 arg_info = required_arg
132 arg_type = uint32
133 typestr = num
134 [help]
135 Exit after the status information has been shown num times. If this
136 option is not given, the command runs in an endless loop.
137 [/help]
138 [option parser-friendly]
139 short_opt = p
140 summary = enable parser-friendly output
141 [help]
142 Show status item identifiers as numerical values and prefix each
143 status item with its size in bytes.
144 [/help]
145
146 [subcommand stop]
147 purpose = stop playback
148 aux_info = VSS_READ | VSS_WRITE
149 [description]
150 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
151 the vss status flags, effectively stopping playback.
152 [/description]
153
154 [subcommand tasks]
155 purpose = list active server tasks
156 aux_info = NO_PERMISSION_REQUIRED
157 [description]
158 For each task, print ID, status and name. This is mostly useful
159 for debugging.
160 [/description]
161
162 [subcommand term]
163 purpose = ask the server to terminate
164 aux_info = VSS_READ | VSS_WRITE
165 [description]
166 Shut down the server. Instead of this command, you can also send
167 SIGINT or SIGTERM to the para_server process. It should never be
168 necessary to send SIGKILL.
169 [/description]
170
171 [subcommand version]
172 purpose = print the git version string of para_server
173 aux_info = NO_PERMISSION_REQUIRED
174 [option verbose]
175 short_opt = v
176 summary = print detailed (multi-line) version text
177