X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=server.cmd;h=d9134693ebf362e43a024576adfc98e25b7244e0;hp=36553542f70b994099ddccd73a30c424794b70ff;hb=c2eecbd1d8445b6605f0d07aea0ed9a66499e5dd;hpb=4c034f8d2e17a35b8f94408996a0bd1de4a2533a diff --git a/server.cmd b/server.cmd index 36553542..d9134693 100644 --- a/server.cmd +++ b/server.cmd @@ -1,14 +1,22 @@ +OF: server_command_list +SF: command.c +HC: prototypes for the server command handlers +CC: array of server commands +AT: server_command +IN: server user_list +SN: list of server commands +--- N: chs -P: DB_READ | DB_WRITE +P: AFS_READ | AFS_WRITE D: change the current audio file selector -S: chs [new_selector] +U: 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: +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. @@ -22,22 +30,22 @@ H: jumps 30 seconds backwards. N: help P: 0 D: print help text -S: help [command] +U: 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. +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. @@ -45,7 +53,7 @@ H: where 0 <= n <= 100. N: next P: VSS_READ | VSS_WRITE D: skip rest of current audio file -S: next +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. @@ -53,7 +61,7 @@ H: if paused, NOP if stopped. N: nomore P: VSS_READ | VSS_WRITE D: stop playing after current audio file -S: nomore +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. @@ -63,20 +71,20 @@ H: sudden endings. N: pause P: VSS_READ | VSS_WRITE D: pause current audio file -S: pause +U: pause H: Clear the 'P' (playing) bit of the vss status flags. --- N: play -P: VSS_READ | VSS_WRITE, +P: VSS_READ | VSS_WRITE D: start playing or resume playing when paused -S: play +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] +U: sb [n] H: Without any arguments, sb continuously prints a status bar of the H: form H: @@ -89,7 +97,7 @@ 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] +U: 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. @@ -97,7 +105,7 @@ 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]] +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 @@ -107,13 +115,13 @@ H: print out a list of all senders that are compiled in. N: si P: 0 D: print server info -S: si +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] +U: 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. @@ -121,19 +129,19 @@ H: to let stat exit after having displayed status n times. N: stop P: VSS_READ | VSS_WRITE D: stop playing -S: stop +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 +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 +U: version H: Show version and other info