server.cmd

   1 OF: server_command_list
   2 SF: command.c
   3 HC: prototypes for the server command handlers
   4 CC: array of server commands
   5 AT: server_command
   6 SI: openssl/rc4 osl regex
   7 IN: para error crypt command string afh afs server list user_list
   8 SN: list of server commands
   9 ---
  10 N: ff
  11 P: VSS_READ | VSS_WRITE
  12 D: Jump amount of time forwards or backwards in current audio file.
  13 U: ff n[-]
  14 H: Set the 'R' (reposition request) bit of the vss status flags
  15 H: and enqueue a request to jump n seconds forwards or backwards
  16 H: in the current audio file.
  17 H:
  18 H: EXAMPLE
  19 H:
  20 H:      ff 30-
  21 H:
  22 H: jumps 30 seconds backwards.
  23 ---
  24 N: help
  25 P: 0
  26 D: Print online help.
  27 U: help [command]
  28 H: Without any arguments, help prints a list of available commands. When
  29 H: issued with a command name as first argument, print out a description
  30 H: for that command.
  31 ---
  32 N: hup
  33 P: VSS_WRITE
  34 D: Force reload of config file, log file and user list.
  35 U: hup
  36 H: Reread the config file and the user list file, close and reopen the log
  37 H: file, and tell all children to do the same.
  38 ---
  39 N: jmp
  40 P: VSS_READ | VSS_WRITE
  41 D: Jump to given position in current audio file.
  42 U: jmp [n]
  43 H: Set the 'R' (reposition request) bit of the vss status flags
  44 H: and enqueue a request to jump to n% of the current audio file,
  45 H: where 0 <= n <= 100.
  46 ---
  47 N: next
  48 P: VSS_READ | VSS_WRITE
  49 D: Skip rest of the current audio file.
  50 U: next
  51 H: Set the 'N' (next audio file) bit of the vss status flags. When
  52 H: playing, change audio file immediately. Equivalent to stop
  53 H: if paused, NOP if stopped.
  54 ---
  55 N: nomore
  56 P: VSS_READ | VSS_WRITE
  57 D: Stop playing after current audio file.
  58 U: nomore
  59 H: Set the 'O' (no more) bit of the vss status flags. This instructs
  60 H: para_server to clear the 'P' (playing) bit as soon as it encounters
  61 H: the 'N' (next audio file) bit being set.
  62 H: Use this command instead of stop if you don't like
  63 H: sudden endings.
  64 ---
  65 N: pause
  66 P: VSS_READ | VSS_WRITE
  67 D: Pause current audio file.
  68 U: pause
  69 H: Clear the 'P' (playing) bit of the vss status flags.
  70 ---
  71 N: play
  72 P: VSS_READ | VSS_WRITE
  73 D: Start playing or resume playing when paused.
  74 U: play
  75 H: Set the 'P' (playing) bit of the vss status flags. This
  76 H: results in starting/continuing to stream.
  77 ---
  78 N: sender
  79 P: VSS_READ | VSS_WRITE
  80 D: Control paraslash internal senders.
  81 U: sender [s cmd [arguments]]
  82 H: send command cmd to sender s. cmd may be one of the following:
  83 H: help, on, off, add, delete, allow, or deny. Note that not all senders
  84 H: support each command. Try e.g. 'para_client sender http help' for
  85 H: more information about the http sender. If no argument is given,
  86 H: print out a list of all senders that are compiled in.
  87 ---
  88 N: si
  89 P: 0
  90 D: Print server info.
  91 U: si
  92 H: Print server uptime and other information.
  93 ---
  94 N: stat
  95 P: VSS_READ
  96 D: Print status info for the current audio file.
  97 U: stat [-n num] [-p]
  98 H: If -n is given, the command exits after having displayed the status n
  99 H: times. Otherwise, the command runs in an endless loop.
 100 H:
 101 H: The -p option activates parser-friendly output: Each status item is
 102 H: prefixed with its size in bytes and the status items identifiers are
 103 H: printed as numerical values.
 104 ---
 105 N: stop
 106 P: VSS_READ | VSS_WRITE
 107 D: Stop streaming.
 108 U: stop
 109 H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
 110 H: flags.
 111 ---
 112 N: term
 113 P: VSS_READ | VSS_WRITE
 114 D: Terminate para_server.
 115 U: term
 116 H: Shuts down the server. Instead of this command, you can also send
 117 H: SIGINT or SIGTERM. It should never be necessary to send SIGKILL.
 118 ---
 119 N: version
 120 P: 0
 121 D: Print server's version.
 122 U: version
 123 H: Show version and other info