Merge branch 'maint'
[paraslash.git] / server.cmd
index a7a1fb5..73ee341 100644 (file)
@@ -1,14 +1,16 @@
-N: chs
-P: DB_READ | DB_WRITE
-D: change the current audio file selector
-S: chs [new_selector]
-H: Shutdown the current selector and activate new_selector. If no
-H: argument was given, print the name of the current selector.
+OF: server_command_list
+SF: command.c
+HC: prototypes for the server command handlers
+CC: array of server commands
+AT: server_command
+SI: openssl/rc4 osl regex
+IN: para error crypt command string afh afs server list user_list
+SN: list of server commands
 ---
 N: ff
 P: VSS_READ | VSS_WRITE
-D: jmp amount of time forwards or backwards in current audio file
-S: ff n[-]
+D: Jump amount of time forwards or backwards in current audio file.
+U: ff n[-]
 H: Set the 'R' (reposition request) bit of the vss status flags
 H: and enqueue a request to jump n seconds forwards or backwards
 H: in the current audio file.
@@ -21,39 +23,39 @@ H: jumps 30 seconds backwards.
 ---
 N: help
 P: 0
-D: print help text
-S: help [command]
-H: Without any arguments, help prints a list of availible commands. When
+D: Print online help.
+U: help [command]
+H: Without any arguments, help prints a list of available commands. When
 H: issued with a command name as first argument, print out a description
 H: for that command.
 ---
 N: hup
 P: VSS_WRITE
-D: force reload of config file and log file
-S: hup
-H: After rereading the config file, a signal is sent to all children
-H: which forces them to close/reopen the log file.
+D: Force reload of config file, log file and user list.
+U: hup
+H: Reread the config file and the user list file, close and reopen the log
+H: file, and tell all children to do the same.
 ---
 N: jmp
 P: VSS_READ | VSS_WRITE
-D: mp to given position in current audio file
-S: jmp [n]
+D: Jump to given position in current audio file.
+U: jmp [n]
 H: Set the 'R' (reposition request) bit of the vss status flags
 H: and enqueue a request to jump to n% of the current audio file,
 H: where 0 <= n <= 100.
 ---
 N: next
 P: VSS_READ | VSS_WRITE
-D: skip rest of current audio file
-S: next
+D: Skip rest of the current audio file.
+U: next
 H: Set the 'N' (next audio file) bit of the vss status flags. When
 H: playing, change audio file immediately. Equivalent to stop
 H: if paused, NOP if stopped.
 ---
 N: nomore
 P: VSS_READ | VSS_WRITE
-D: stop playing after current audio file
-S: nomore
+D: Stop playing after current audio file.
+U: nomore
 H: Set the 'O' (no more) bit of the vss status flags. This instructs
 H: para_server to clear the 'P' (playing) bit as soon as it encounters
 H: the 'N' (next audio file) bit being set.
@@ -62,42 +64,21 @@ H: sudden endings.
 ---
 N: pause
 P: VSS_READ | VSS_WRITE
-D: pause current audio file
-S: pause
+D: Pause current audio file.
+U: pause
 H: Clear the 'P' (playing) bit of the vss status flags.
 ---
 N: play
 P: VSS_READ | VSS_WRITE
-D: start playing or resume playing when paused
-S: play
+D: Start playing or resume playing when paused.
+U: play
 H: Set the 'P' (playing) bit of the vss status flags. This
 H: results in starting/continuing to stream.
 ---
-N: sb
-P: VSS_READ
-D: print status bar for current audio file
-S: sb [n]
-H: Without any arguments, sb continuously prints a status bar of the
-H: form
-H:
-H:     12:34 [56:12] (56%) filename
-H:
-H: indicating playing time, remaining time, percentage and the name of
-H: the file being streamed. Use the optional number n to let stat exit
-H: after having displayed the status bar n times.
----
-N: sc
-P: VSS_READ
-D: print name of audio file whenever it changes
-S: sc [n]
-H: sc prints exactly one line (the filename of the audio file
-H: being played) whenever the audio file changes. Stops after
-H: n iterations, or never if n is not specified.
----
 N: sender
 P: VSS_READ | VSS_WRITE
-D: control paraslash internal senders
-S: sender [s cmd [arguments]]
+D: Control paraslash internal senders.
+U: sender [s cmd [arguments]]
 H: send command cmd to sender s. cmd may be one of the following:
 H: help, on, off, add, delete, allow, or deny. Note that not all senders
 H: support each command. Try e.g. 'para_client sender http help' for
@@ -106,34 +87,37 @@ H: print out a list of all senders that are compiled in.
 ---
 N: si
 P: 0
-D: print server info
-S: si
+D: Print server info.
+U: si
 H: Print server uptime and other information.
 ---
 N: stat
 P: VSS_READ
-D: print status info for current audio file
-S: stat [n]
-H: Without any arguments, stat continuously prints status messages
-H: about the audio file being streamed. Use the optional number n
-H: to let stat exit after having displayed status n times.
+D: Print status info for the current audio file.
+U: stat [-n num] [-p]
+H: If -n is given, the command exits after having displayed the status n
+H: times. Otherwise, the command runs in an endless loop.
+H:
+H: The -p option activates parser-friendly output: Each status item is
+H: prefixed with its size in bytes and the status items identifiers are
+H: printed as numerical values.
 ---
 N: stop
 P: VSS_READ | VSS_WRITE
-D: stop playing
-S: stop
+D: Stop streaming.
+U: stop
 H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
 H: flags.
 ---
 N: term
 P: VSS_READ | VSS_WRITE
-D: terminate para_server
-S: term
+D: Terminate para_server.
+U: term
 H: Shuts down the server. Instead of this command, you can also send
 H: SIGINT or SIGTERM. It should never be necessary to send SIGKILL.
 ---
 N: version
 P: 0
-D: print server's version
-S: version
+D: Print server's version.
+U: version
 H: Show version and other info