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