command_util: Kill HC and CC header lines.
[paraslash.git] / server.cmd
1 OF: server_command_list
2 SF: command.c
3 AT: server_command
4 SI: osl regex
5 IN: para error crypt sideband command string afh afs server list user_list
6 SN: list of server commands
7 ---
8 N: ff
9 P: VSS_READ | VSS_WRITE
10 D: Jump amount of time forwards or backwards in current audio file.
11 U: ff n[-]
12 H: Set the 'R' (reposition request) bit of the vss status flags
13 H: and enqueue a request to jump n seconds forwards or backwards
14 H: in the current audio file.
15 H:
16 H: EXAMPLE
17 H:
18 H: ff 30-
19 H:
20 H: jumps 30 seconds backwards.
21 ---
22 N: help
23 P: 0
24 D: Print online help.
25 U: help [command]
26 H: Without any arguments, help prints a list of available commands. When
27 H: issued with a command name as first argument, print out a description
28 H: for that command.
29 ---
30 N: hup
31 P: VSS_WRITE
32 D: Force reload of config file, log file and user list.
33 U: hup
34 H: Reread the config file and the user list file, close and reopen the log
35 H: file, and tell all children to do the same.
36 ---
37 N: jmp
38 P: VSS_READ | VSS_WRITE
39 D: Jump to given position in current audio file.
40 U: jmp [n]
41 H: Set the 'R' (reposition request) bit of the vss status flags
42 H: and enqueue a request to jump to n% of the current audio file,
43 H: where 0 <= n <= 100.
44 ---
45 N: next
46 P: VSS_READ | VSS_WRITE
47 D: Skip rest of the current audio file.
48 U: next
49 H: Set the 'N' (next audio file) bit of the vss status flags. When
50 H: playing, change audio file immediately. Equivalent to stop
51 H: if paused, NOP if stopped.
52 ---
53 N: nomore
54 P: VSS_READ | VSS_WRITE
55 D: Stop playing after current audio file.
56 U: nomore
57 H: Set the 'O' (no more) bit of the vss status flags. This instructs
58 H: para_server to clear the 'P' (playing) bit as soon as it encounters
59 H: the 'N' (next audio file) bit being set.
60 H: Use this command instead of stop if you don't like
61 H: sudden endings.
62 ---
63 N: pause
64 P: VSS_READ | VSS_WRITE
65 D: Pause current audio file.
66 U: pause
67 H: Clear the 'P' (playing) bit of the vss status flags.
68 ---
69 N: play
70 P: VSS_READ | VSS_WRITE
71 D: Start playing or resume playing when paused.
72 U: play
73 H: Set the 'P' (playing) bit of the vss status flags. This
74 H: results in starting/continuing to stream.
75 ---
76 N: sender
77 P: VSS_READ | VSS_WRITE
78 D: Control paraslash internal senders.
79 U: sender [s cmd [arguments]]
80 H: send command cmd to sender s. cmd may be one of the following:
81 H: help, on, off, add, delete, allow, or deny. Note that not all senders
82 H: support each command. Try e.g. 'para_client sender http help' for
83 H: more information about the http sender. If no argument is given,
84 H: print out a list of all senders that are compiled in.
85 ---
86 N: si
87 P: 0
88 D: Print server info.
89 U: si
90 H: Print server uptime and other information.
91 ---
92 N: stat
93 P: VSS_READ
94 D: Print status info for the current audio file.
95 U: stat [-n=num] [-p]
96 H: If -n is given, the command exits after having displayed the status n
97 H: times. Otherwise, the command runs in an endless loop.
98 H:
99 H: The -p option activates parser-friendly output: Each status item is
100 H: prefixed with its size in bytes and the status items identifiers are
101 H: printed as numerical values.
102 ---
103 N: stop
104 P: VSS_READ | VSS_WRITE
105 D: Stop streaming.
106 U: stop
107 H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
108 H: flags.
109 ---
110 N: term
111 P: VSS_READ | VSS_WRITE
112 D: Terminate para_server.
113 U: term
114 H: Shuts down the server. Instead of this command, you can also send
115 H: SIGINT or SIGTERM. It should never be necessary to send SIGKILL.
116 ---
117 N: version
118 P: 0
119 D: Print server's version.
120 U: version
121 H: Show version and other info