]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - server.cmd
server: Convert com_mvatt() to lopsub.
[paraslash.git] / server.cmd
index 3053ab002e2dae867d92928973064ea0b18340fd..b7d0af1a6326aade2ba58fe2d4fd53e2af57902d 100644 (file)
@@ -1,146 +1,3 @@
-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.
-H:
-H: EXAMPLE
-H:
-H:     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.
----
-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.
----
-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.
----
-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.
----
-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.
----
-N: pause
-P: VSS_READ | VSS_WRITE
-D: pause current audio file
-S: 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.
----
-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.
----
-N: si
-P: 0
-D: print server info
-S: 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.
----
-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.
----
-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.
----
-N: version
-P: 0
-D: print server's version
-S: version
-H: Show version and other info