add -Wbad-function-cast to +CPPFLAGS and fix two compiler warnings
[paraslash.git] / server.cmd
1 OF: server_command_list
2 SF: command.c
3 HC: prototypes for the server command handlers
4 CC: array of server commands
5 AT: server_command
6 IN: server user_list
7 SN: list of server commands
8 ---
9 N: chs
10 P: AFS_READ | AFS_WRITE
11 D: change the current audio file selector
12 U: chs [new_selector]
13 H: Shutdown the current selector and activate new_selector. If no
14 H: argument was given, print the name of the current selector.
15 ---
16 N: ff
17 P: VSS_READ | VSS_WRITE
18 D: jump amount of time forwards or backwards in current audio file
19 U: ff n[-]
20 H: Set the 'R' (reposition request) bit of the vss status flags
21 H: and enqueue a request to jump n seconds forwards or backwards
22 H: in the current audio file.
23 H:
24 H: EXAMPLE
25 H:
26 H: ff 30-
27 H:
28 H: jumps 30 seconds backwards.
29 ---
30 N: help
31 P: 0
32 D: print help text
33 U: help [command]
34 H: Without any arguments, help prints a list of availible commands. When
35 H: issued with a command name as first argument, print out a description
36 H: for that command.
37 ---
38 N: hup
39 P: VSS_WRITE
40 D: force reload of config file, log file and user list
41 U: hup
42 H: Reread the config file and the user list file, close and reopen the log
43 H: file, and tell all children to do the same.
44 ---
45 N: jmp
46 P: VSS_READ | VSS_WRITE
47 D: jump to given position in current audio file
48 U: jmp [n]
49 H: Set the 'R' (reposition request) bit of the vss status flags
50 H: and enqueue a request to jump to n% of the current audio file,
51 H: where 0 <= n <= 100.
52 ---
53 N: next
54 P: VSS_READ | VSS_WRITE
55 D: skip rest of current audio file
56 U: next
57 H: Set the 'N' (next audio file) bit of the vss status flags. When
58 H: playing, change audio file immediately. Equivalent to stop
59 H: if paused, NOP if stopped.
60 ---
61 N: nomore
62 P: VSS_READ | VSS_WRITE
63 D: stop playing after current audio file
64 U: nomore
65 H: Set the 'O' (no more) bit of the vss status flags. This instructs
66 H: para_server to clear the 'P' (playing) bit as soon as it encounters
67 H: the 'N' (next audio file) bit being set.
68 H: Use this command instead of stop if you don't like
69 H: sudden endings.
70 ---
71 N: pause
72 P: VSS_READ | VSS_WRITE
73 D: pause current audio file
74 U: pause
75 H: Clear the 'P' (playing) bit of the vss status flags.
76 ---
77 N: play
78 P: VSS_READ | VSS_WRITE
79 D: start playing or resume playing when paused
80 U: play
81 H: Set the 'P' (playing) bit of the vss status flags. This
82 H: results in starting/continuing to stream.
83 ---
84 N: sb
85 P: VSS_READ
86 D: print status bar for current audio file
87 U: sb [n]
88 H: Without any arguments, sb continuously prints a status bar of the
89 H: form
90 H:
91 H: 12:34 [56:12] (56%) filename
92 H:
93 H: indicating playing time, remaining time, percentage and the name of
94 H: the file being streamed. Use the optional number n to let stat exit
95 H: after having displayed the status bar n times.
96 ---
97 N: sc
98 P: VSS_READ
99 D: print name of audio file whenever it changes
100 U: sc [n]
101 H: sc prints exactly one line (the filename of the audio file
102 H: being played) whenever the audio file changes. Stops after
103 H: n iterations, or never if n is not specified.
104 ---
105 N: sender
106 P: VSS_READ | VSS_WRITE
107 D: control paraslash internal senders
108 U: sender [s cmd [arguments]]
109 H: send command cmd to sender s. cmd may be one of the following:
110 H: help, on, off, add, delete, allow, or deny. Note that not all senders
111 H: support each command. Try e.g. 'para_client sender http help' for
112 H: more information about the http sender. If no argument is given,
113 H: print out a list of all senders that are compiled in.
114 ---
115 N: si
116 P: 0
117 D: print server info
118 U: si
119 H: Print server uptime and other information.
120 ---
121 N: stat
122 P: VSS_READ
123 D: print status info for current audio file
124 U: stat [n]
125 H: Without any arguments, stat continuously prints status messages
126 H: about the audio file being streamed. Use the optional number n
127 H: to let stat exit after having displayed status n times.
128 ---
129 N: stop
130 P: VSS_READ | VSS_WRITE
131 D: stop playing
132 U: stop
133 H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
134 H: flags.
135 ---
136 N: term
137 P: VSS_READ | VSS_WRITE
138 D: terminate para_server
139 U: term
140 H: Shuts down the server. Instead of this command, you can also send
141 H: SIGINT or SIGTERM. It should never be necessary to send SIGKILL.
142 ---
143 N: version
144 P: 0
145 D: print server's version
146 U: version
147 H: Show version and other info