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