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