X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=server.cmd;h=847d53d7283720a34a081361d49f2f2947734c7a;hp=41dc2805b4515b20a101b34e54682f764ff73815;hb=becb57ea3aec697bfe953a0c3608e4c255b6d24b;hpb=08a1de75a3a83c728d97a3c4ff182553adbda8cc diff --git a/server.cmd b/server.cmd index 41dc2805..847d53d7 100644 --- a/server.cmd +++ b/server.cmd @@ -4,11 +4,12 @@ HC: prototypes for the server command handlers CC: array of server commands AT: server_command IN: para error string afh afs server list user_list +SI: osl SN: list of server commands --- N: ff P: VSS_READ | VSS_WRITE -D: jump amount of time forwards or backwards in current audio file +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 @@ -22,7 +23,7 @@ H: jumps 30 seconds backwards. --- N: help P: 0 -D: print help text +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 @@ -30,14 +31,14 @@ H: for that command. --- N: hup P: VSS_WRITE -D: force reload of config file, log file and user list +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: jump to given position in current audio file +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, @@ -45,7 +46,7 @@ H: where 0 <= n <= 100. --- N: next P: VSS_READ | VSS_WRITE -D: skip rest of current audio file +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 @@ -53,7 +54,7 @@ H: if paused, NOP if stopped. --- N: nomore P: VSS_READ | VSS_WRITE -D: stop playing after current audio file +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 @@ -63,41 +64,20 @@ H: sudden endings. --- N: pause P: VSS_READ | VSS_WRITE -D: pause current audio file +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 +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 -U: 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 -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. ---- N: sender P: VSS_READ | VSS_WRITE -D: control paraslash internal senders +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 @@ -107,13 +87,13 @@ H: print out a list of all senders that are compiled in. --- N: si P: 0 -D: print server info +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 +D: Print status info for current audio file. U: stat [n] H: Without any arguments, stat continuously prints status messages H: about the audio file being streamed. Use the optional number n @@ -121,20 +101,20 @@ H: to let stat exit after having displayed status n times. --- N: stop P: VSS_READ | VSS_WRITE -D: stop playing +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 +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 +D: Print server's version. U: version H: Show version and other info