server.cmd

   1 FN: server_command_list
   2 HC: prototypes for the server command handlers
   3 CC: array of server commands
   4 AT: server_command
   5 IN: server user_list
   6 ---
   7 N: chs
   8 P: DB_READ | DB_WRITE
   9 D: change the current audio file selector
  10 S: chs [new_selector]
  11 H: Shutdown the current selector and activate new_selector. If no
  12 H: argument was given, print the name of the current selector.
  13 ---
  14 N: ff
  15 P: VSS_READ | VSS_WRITE
  16 D: jmp amount of time forwards or backwards in current audio file
  17 S: ff n[-]
  18 H: Set the 'R' (reposition request) bit of the vss status flags
  19 H: and enqueue a request to jump n seconds forwards or backwards
  20 H: in the current audio file.
  21 H:
  22 H: EXAMPLE
  23 H:
  24 H:      ff 30-
  25 H:
  26 H: jumps 30 seconds backwards.
  27 ---
  28 N: help
  29 P: 0
  30 D: print help text
  31 S: help [command]
  32 H: Without any arguments, help prints a list of availible commands. When
  33 H: issued with a command name as first argument, print out a description
  34 H: for that command.
  35 ---
  36 N: hup
  37 P: VSS_WRITE
  38 D: force reload of config file and log file
  39 S: hup
  40 H: After rereading the config file, a signal is sent to all children
  41 H: which forces them to close/reopen the log file.
  42 ---
  43 N: jmp
  44 P: VSS_READ | VSS_WRITE
  45 D: mp to given position in current audio file
  46 S: jmp [n]
  47 H: Set the 'R' (reposition request) bit of the vss status flags
  48 H: and enqueue a request to jump to n% of the current audio file,
  49 H: where 0 <= n <= 100.
  50 ---
  51 N: next
  52 P: VSS_READ | VSS_WRITE
  53 D: skip rest of current audio file
  54 S: next
  55 H: Set the 'N' (next audio file) bit of the vss status flags. When
  56 H: playing, change audio file immediately. Equivalent to stop
  57 H: if paused, NOP if stopped.
  58 ---
  59 N: nomore
  60 P: VSS_READ | VSS_WRITE
  61 D: stop playing after current audio file
  62 S: nomore
  63 H: Set the 'O' (no more) bit of the vss status flags. This instructs
  64 H: para_server to clear the 'P' (playing) bit as soon as it encounters
  65 H: the 'N' (next audio file) bit being set.
  66 H: Use this command instead of stop if you don't like
  67 H: sudden endings.
  68 ---
  69 N: pause
  70 P: VSS_READ | VSS_WRITE
  71 D: pause current audio file
  72 S: pause
  73 H: Clear the 'P' (playing) bit of the vss status flags.
  74 ---
  75 N: play
  76 P: VSS_READ | VSS_WRITE
  77 D: start playing or resume playing when paused
  78 S: play
  79 H: Set the 'P' (playing) bit of the vss status flags. This
  80 H: results in starting/continuing to stream.
  81 ---
  82 N: sb
  83 P: VSS_READ
  84 D: print status bar for current audio file
  85 S: sb [n]
  86 H: Without any arguments, sb continuously prints a status bar of the
  87 H: form
  88 H:
  89 H:      12:34 [56:12] (56%) filename
  90 H:
  91 H: indicating playing time, remaining time, percentage and the name of
  92 H: the file being streamed. Use the optional number n to let stat exit
  93 H: after having displayed the status bar n times.
  94 ---
  95 N: sc
  96 P: VSS_READ
  97 D: print name of audio file whenever it changes
  98 S: sc [n]
  99 H: sc prints exactly one line (the filename of the audio file
 100 H: being played) whenever the audio file changes. Stops after
 101 H: n iterations, or never if n is not specified.
 102 ---
 103 N: sender
 104 P: VSS_READ | VSS_WRITE
 105 D: control paraslash internal senders
 106 S: sender [s cmd [arguments]]
 107 H: send command cmd to sender s. cmd may be one of the following:
 108 H: help, on, off, add, delete, allow, or deny. Note that not all senders
 109 H: support each command. Try e.g. 'para_client sender http help' for
 110 H: more information about the http sender. If no argument is given,
 111 H: print out a list of all senders that are compiled in.
 112 ---
 113 N: si
 114 P: 0
 115 D: print server info
 116 S: si
 117 H: Print server uptime and other information.
 118 ---
 119 N: stat
 120 P: VSS_READ
 121 D: print status info for current audio file
 122 S: stat [n]
 123 H: Without any arguments, stat continuously prints status messages
 124 H: about the audio file being streamed. Use the optional number n
 125 H: to let stat exit after having displayed status n times.
 126 ---
 127 N: stop
 128 P: VSS_READ | VSS_WRITE
 129 D: stop playing
 130 S: stop
 131 H: Clear the 'P' (play) bit and set the 'N' bit of the vss status
 132 H: flags.
 133 ---
 134 N: term
 135 P: VSS_READ | VSS_WRITE
 136 D: terminate para_server
 137 S: term
 138 H: Shuts down the server. Instead of this command, you can also send
 139 H: SIGINT or SIGTERM. It should never be necessary to send SIGKILL.
 140 ---
 141 N: version
 142 P: 0
 143 D: print server's version
 144 S: version
 145 H: Show version and other info