afh.h: Trivial whitespace fix.
[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 N seconds forward or backward.
8 U: ff n[-]
9 H: This sets the 'R' (reposition request) bit of the vss status flags
10 H: which enqueues a request to jump n seconds forwards or backwards.
11 H:
12 H: Example:
13 H:
14 H: para_client ff 30-
15 H:
16 H: jumps 30 seconds backwards.
17 ---
18 N: help
19 P: 0
20 D: Print online help.
21 U: help [command]
22 H: Without any arguments, help prints a list of available commands. When
23 H: called with a command name as first argument, it prints the description
24 H: of that command.
25 ---
26 N: hup
27 P: VSS_WRITE
28 D: Reload config file, log file and user list.
29 U: hup
30 H: Reread the config file and the user list file, close and reopen the log
31 H: file, and ask the afs process to do the same. Sending the HUP signal to
32 H: the server process has the same effect.
33 ---
34 N: jmp
35 P: VSS_READ | VSS_WRITE
36 D: Jump to the given position.
37 U: jmp n
38 H: Set the 'R' (reposition request) bit of the vss status flags and enqueue a
39 H: request to jump to n% of the current audio file, where 0 <= n <= 100.
40 ---
41 N: next
42 P: VSS_READ | VSS_WRITE
43 D: Close the current audio file.
44 U: next
45 H: Set the 'N' (next audio file) bit of the vss status flags which instructs the
46 H: server to close its current audio file if necessary. If the 'P' bit (playing)
47 H: is on, playing continues with the next audio file. This command is equivalent
48 H: to stop if paused, and has no effect 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 which asks para_server to
55 H: clear the 'P' (playing) bit after the 'N' (next audio file) bit transitions
56 H: from off to on (because the end of the current audio file is reached). Use this
57 H: command instead of stop if you don't like sudden endings.
58 ---
59 N: pause
60 P: VSS_READ | VSS_WRITE
61 D: Pause current audio file.
62 U: pause
63 H: Clear the 'P' (playing) bit of the vss status flags.
64 ---
65 N: play
66 P: VSS_READ | VSS_WRITE
67 D: Start or resume playing.
68 U: play
69 H: Set the 'P' (playing) bit of the vss status flags.
70 ---
71 N: sender
72 P: VSS_READ | VSS_WRITE
73 D: Control paraslash senders.
74 U: sender [s cmd [arguments]]
75 H: Send a command to a specific sender. The following commands are available, but
76 H: not all senders support every command.
77 H:
78 H: help, on, off, add, delete, allow, deny, status.
79 H:
80 H: The help command prints the help text of the given sender. If no command is
81 H: given the list of compiled in senders is shown.
82 H:
83 H: Example:
84 H:
85 H: para_client sender http help
86 ---
87 N: si
88 P: 0
89 D: Print server info.
90 U: si
91 H: Show server and afs PID, number of connections, uptime and more.
92 ---
93 N: stat
94 P: VSS_READ
95 D: Print information about the current audio file.
96 U: stat [-n=num] [-p]
97 H: If -n is given, exit after the status information has been shown n times.
98 H: Otherwise, the command runs in an endless loop.
99 H:
100 H: The -p option activates parser-friendly output: Each status item is
101 H: prefixed with its size in bytes and the status item identifiers are
102 H: printed as numerical values.
103 ---
104 N: stop
105 P: VSS_READ | VSS_WRITE
106 D: Stop playing.
107 U: stop
108 H: Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of the vss
109 H: status flags, effectively stopping playback.
110 ---
111 N: tasks
112 P: 0
113 D: List server tasks.
114 U: tasks
115 H: For each task, print ID, status and name.
116 ---
117 N: term
118 P: VSS_READ | VSS_WRITE
119 D: Ask the server to terminate.
120 U: term
121 H: Shut down the server. Instead of this command, you can also send SIGINT or
122 H: SIGTERM to the para_server process. It should never be necessary to send
123 H: SIGKILL.
124 ---
125 N: version
126 P: 0
127 D: Print the git version string of para_server.
128 U: version
129 H: Show version and other info.