-FN: server_command_list
-HC: prototypes for the server command handlers
-CC: array of server commands
-AT: server_command
-IN: server user_list
+BN: server
+SF: command.c
SN: list of server commands
---
-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.
----
N: ff
P: VSS_READ | VSS_WRITE
-D: jump amount of time forwards or backwards in current audio file
-S: 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.
+D: Jump N seconds forward or backward.
+U: ff n[-]
+H: This sets the 'R' (reposition request) bit of the vss status flags
+H: which enqueues a request to jump n seconds forwards or backwards.
H:
-H: EXAMPLE
+H: Example:
H:
-H: ff 30-
+H: para_client ff 30-
H:
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
-H: issued with a command name as first argument, print out a description
-H: for that command.
+D: Print online help.
+U: help [command]
+H: Without any arguments, help prints a list of available commands. When
+H: called with a command name as first argument, it prints the description
+H: of that command.
---
N: hup
P: VSS_WRITE
-D: force reload of config file, log file and user list
-S: hup
+D: Reload 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.
+H: file, and ask the afs process to do the same. Sending the HUP signal to
+H: the server process has the same effect.
---
N: jmp
P: VSS_READ | VSS_WRITE
-D: jump to given position in current audio file
-S: 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.
+D: Jump to the given position.
+U: jmp n
+H: Set the 'R' (reposition request) bit of the vss status flags and enqueue a
+H: request to jump to n% of the current audio file, where 0 <= n <= 100.
---
N: next
P: VSS_READ | VSS_WRITE
-D: skip rest of current audio file
-S: 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.
+D: Close the current audio file.
+U: next
+H: Set the 'N' (next audio file) bit of the vss status flags which instructs the
+H: server to close its current audio file if necessary. If the 'P' bit (playing)
+H: is on, playing continues with the next audio file. This command is equivalent
+H: to stop if paused, and has no effect if stopped.
---
N: nomore
P: VSS_READ | VSS_WRITE
-D: stop playing after current audio file
-S: 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.
-H: Use this command instead of stop if you don't like
-H: sudden endings.
+D: Stop playing after current audio file.
+U: nomore
+H: Set the 'O' (no more) bit of the vss status flags which asks para_server to
+H: clear the 'P' (playing) bit after the 'N' (next audio file) bit transitions
+H: from off to on (because the end of the current audio file is reached). Use this
+H: command instead of stop if you don't like 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
-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.
+D: Start or resume playing.
+U: play
+H: Set the 'P' (playing) bit of the vss status flags.
---
N: sender
P: VSS_READ | VSS_WRITE
-D: control paraslash internal senders
-S: 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
-H: more information about the http sender. If no argument is given,
-H: print out a list of all senders that are compiled in.
+D: Control paraslash senders.
+U: sender [s cmd [arguments]]
+H: Send a command to a specific sender. The following commands are available, but
+H: not all senders support every command.
+H:
+H: help, on, off, add, delete, allow, deny.
+H:
+H: The help command prints the help text of the given sender. If no command is
+H: given the list of compiled in senders is shown.
+H:
+H: Example:
+H:
+H: para_client sender http help
---
N: si
P: 0
-D: print server info
-S: si
-H: Print server uptime and other information.
+D: Print server info.
+U: si
+H: Show server and afs PID, number of connections, uptime and more.
---
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 information about the current audio file.
+U: stat [-n=num] [-p]
+H: If -n is given, exit after the status information has been shown n times.
+H: 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 item identifiers are
+H: printed as numerical values.
---
N: stop
P: VSS_READ | VSS_WRITE
-D: stop playing
-S: stop
-H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
-H: flags.
+D: Stop playing.
+U: stop
+H: Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of the vss
+H: status flags, effectively stopping playback.
---
N: term
P: VSS_READ | VSS_WRITE
-D: terminate para_server
-S: 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.
+D: Ask the server to terminate.
+U: term
+H: Shut down the server. Instead of this command, you can also send SIGINT or
+H: SIGTERM to the para_server process. It should never be necessary to send
+H: SIGKILL.
---
N: version
P: 0
-D: print server's version
-S: version
-H: Show version and other info
+D: Print the git version string of para_server.
+U: version
+H: Show version and other info.
projects / paraslash.git / blobdiff