add command utilitly and some .cmd files
[paraslash.git] / server.cmd
1 N: chs
2 P: DB_READ | DB_WRITE
3 D: change the current audio file selector
4 S: chs [new_selector]
5 H: Shutdown the current selector and activate new_selector. If no
6 H: argument was given, print the name of the current selector.
7 ---
8 N: ff:
9 P: VSS_READ | VSS_WRITE
10 D: jmp amount of time forwards or backwards in current audio file
11 S: 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 help text
25 S: help [command]
26 H: Without any arguments, help prints a list of availible 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 and log file
33 S: hup
34 H: After rereading the config file, a signal is sent to all children
35 H: which forces them to close/reopen the log file.
36 ---
37 N: jmp
38 P: VSS_READ | VSS_WRITE
39 D: mp to given position in current audio file
40 S: 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 current audio file
48 S: 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 S: 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 S: 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 S: 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: sb
77 P: VSS_READ
78 D: print status bar for current audio file
79 S: sb [n]
80 H: Without any arguments, sb continuously prints a status bar of the
81 H: form
82 H:
83 H: 12:34 [56:12] (56%) filename
84 H:
85 H: indicating playing time, remaining time, percentage and the name of
86 H: the file being streamed. Use the optional number n to let stat exit
87 H: after having displayed the status bar n times.
88 ---
89 N: sc
90 P: VSS_READ
91 D: print name of audio file whenever it changes
92 S: sc [n]
93 H: sc prints exactly one line (the filename of the audio file
94 H: being played) whenever the audio file changes. Stops after
95 H: n iterations, or never if n is not specified.
96 ---
97 N: sender
98 P: VSS_READ | VSS_WRITE
99 D: control paraslash internal senders
100 S: sender [s cmd [arguments]]
101 H: send command cmd to sender s. cmd may be one of the following:
102 H: help, on, off, add, delete, allow, or deny. Note that not all senders
103 H: support each command. Try e.g. 'para_client sender http help' for
104 H: more information about the http sender. If no argument is given,
105 H: print out a list of all senders that are compiled in.
106 ---
107 N: si
108 P: 0
109 D: print server info
110 S: si
111 H: Print server uptime and other information.
112 ---
113 N: stat
114 P: VSS_READ
115 D: print status info for current audio file
116 S: stat [n]
117 H: Without any arguments, stat continuously prints status messages
118 H: about the audio file being streamed. Use the optional number n
119 H: to let stat exit after having displayed status n times.
120 ---
121 N: stop
122 P: VSS_READ | VSS_WRITE
123 D: stop playing
124 S: stop
125 H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
126 H: flags.
127 ---
128 N: term
129 P: VSS_READ | VSS_WRITE
130 D: terminate para_server
131 S: term
132 H: Shuts down the server. Instead of this command, you can also send
133 H: SIGINT or SIGTERM. It should never be necessary to send SIGKILL.
134 ---
135 N: version
136 P: 0
137 D: print server's version
138 S: version
139 H: Show version and other info