m4/lls/server_cmd.suite.m4

   1 [suite server_cmd]
   2 caption = list of server commands
   3 aux_info_prefix = Permissions:
   4
   5 [introduction]
   6         The server process listens on a network socket and accepts connections
   7         from para_client or para_audiod. For the connection to succeed the
   8         connecting peer must authenticate as one of the users stored in the
   9         user table of para_server. Each entry of the user table contains the
  10         set of permission bits that are granted to the user. Authenticated
  11         users may execute one of the commands below if the set of permission
  12         bits of the command is a subset of the permission bits that are
  13         granted to the user.
  14 [/introduction]
  15
  16 [subcommand add]
  17         purpose = add or update audio files
  18         non-opts-name = path...
  19         aux_info = AFS_READ | AFS_WRITE
  20         [description]
  21                 Each path must be absolute and refer to either an audio file or a
  22                 directory. In case of a directory, all audio files in that directory
  23                 are added recursively. Note that the given paths refer to files or
  24                 directories on the host on which para_server is running.
  25         [/description]
  26         [option all]
  27                 short_opt = a
  28                 summary = add all files
  29                 [help]
  30                         The default is to add only files ending in a known suffix for a
  31                         supported audio format.
  32                 [/help]
  33         [option lazy]
  34                 short_opt = l
  35                 summary = add files lazily
  36                 [help]
  37                         If the path already exists in the database, skip this file. This
  38                         operation is really cheap. Useful to update large directories after
  39                         some files have been added.
  40                 [/help]
  41         [option force]
  42                 short_opt = f
  43                 summary = force adding/updating
  44                 [help]
  45                         Recompute the audio format handler data even if a file with the same
  46                         path and the same hash value exists.
  47                 [/help]
  48         [option verbose]
  49                 short_opt = v
  50                 summary = enable verbose mode
  51                 [help]
  52                         Print what is being done.
  53                 [/help]
  54
  55 [subcommand ff]
  56         purpose = jump N seconds forward or backward
  57         synopsis = n[-]
  58         aux_info = VSS_READ | VSS_WRITE
  59         [description]
  60                 This sets the 'R' (reposition request) bit of the vss status flags
  61                 which enqueues a request to jump n seconds forwards or backwards.
  62
  63                 Example:
  64
  65                      para_client ff 30-
  66
  67                 jumps 30 seconds backwards.
  68
  69         [/description]
  70
  71 [subcommand help]
  72         purpose = list available commands or print command-specific help
  73         non-opts-name = [command]
  74         aux_info = NO_PERMISSION_REQUIRED
  75         [description]
  76                 Without any arguments, help prints a list of available commands. When
  77                 called with a command name as first argument, it prints the description
  78                 of this command.
  79         [/description]
  80
  81 [subcommand hup]
  82         purpose = reload config file, log file and user list
  83         aux_info = VSS_WRITE
  84         [description]
  85                 Reread the config file and the user list file, close and reopen the log
  86                 file, and ask the afs process to do the same. Sending the HUP signal
  87                 to the server process has the same effect as running this command.
  88         [/description]
  89
  90 [subcommand init]
  91         purpose = initialize the database tables for the audio file selector
  92         synopsis = [table_name...]
  93         aux_info = AFS_READ | AFS_WRITE
  94         [description]
  95                 When invoked without arguments, this command creates all
  96                 tables: audio_files, attributes, scores, moods, lyrics, images,
  97                 playlists. Otherwise only the given tables are created.
  98         [/description]
  99
 100 [subcommand jmp]
 101         purpose = reposition the current stream
 102         non-opts-name = n
 103         aux_info = VSS_READ | VSS_WRITE
 104         [description]
 105                 Set the 'R' (reposition request) bit of the vss status flags and
 106                 enqueue a request to jump to n% of the current audio file, where 0 <=
 107                 n <= 100.
 108         [/description]
 109
 110 [subcommand next]
 111         purpose = close the stream and start to stream the next audio file
 112         aux_info = VSS_READ | VSS_WRITE
 113         [description]
 114                 Set the 'N' (next audio file) bit of the vss status flags. This
 115                 instructs the server to close the current stream, if any. The 'P'
 116                 (playing) bit is not modified by this command. If it is on, playing
 117                 continues with the next audio file.
 118
 119                 This command is equivalent to stop if paused, and has no effect
 120                 if stopped.
 121         [/description]
 122
 123 [subcommand nomore]
 124         purpose = stop playing after current audio file
 125         aux_info = VSS_READ | VSS_WRITE
 126         [description]
 127                 Set the 'O' (no more) bit of the vss status flags which asks
 128                 para_server to clear the 'P' (playing) bit after the 'N' (next audio
 129                 file) bit transitions from off to on (because the end of the current
 130                 audio file is reached). Use this command instead of stop if you don't
 131                 like sudden endings.
 132         [/description]
 133
 134 [subcommand pause]
 135         purpose = suspend the current stream
 136         aux_info = VSS_READ | VSS_WRITE
 137         [description]
 138                 Clear the 'P' (playing) bit of the vss status flags.
 139         [/description]
 140
 141 [subcommand play]
 142         purpose = start or resume playback
 143         aux_info = VSS_READ | VSS_WRITE
 144         [description]
 145                 Set the 'P' (playing) bit of the vss status flags.
 146         [/description]
 147
 148 [subcommand sender]
 149         purpose = control paraslash senders
 150         synopsis = [sender cmd [arguments]]
 151         aux_info = VSS_READ | VSS_WRITE
 152         [description]
 153                 Send a command to a specific sender. The following commands are
 154                 available, but not all senders support every command.
 155
 156                        help, on, off, add, delete, allow, deny, status.
 157
 158                 The help command prints the help text of the given sender. If no
 159                 command is given the list of available senders is shown.
 160
 161                 Example:
 162
 163                         para_client sender http help
 164
 165         [/description]
 166
 167 [subcommand si]
 168         purpose = print server info
 169         aux_info = NO_PERMISSION_REQUIRED
 170         [description]
 171                 Show server and afs PID, number of connections, uptime and more.
 172         [/description]
 173
 174 [subcommand stat]
 175         purpose = print information about the current audio file
 176         aux_info = VSS_READ
 177         [option num]
 178                 short_opt = n
 179                 summary = number of times to show the status info
 180                 arg_info = required_arg
 181                 arg_type = uint32
 182                 typestr = num
 183                 [help]
 184                         Exit after the status information has been shown num times. If this
 185                         option is not given, the command runs in an endless loop.
 186                 [/help]
 187         [option parser-friendly]
 188                 short_opt = p
 189                 summary = enable parser-friendly output
 190                 [help]
 191                         Show status item identifiers as numerical values and prefix each
 192                         status item with its size in bytes.
 193                 [/help]
 194
 195 [subcommand stop]
 196         purpose = stop playback
 197         aux_info = VSS_READ | VSS_WRITE
 198         [description]
 199                 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
 200                 the vss status flags, effectively stopping playback.
 201         [/description]
 202
 203 [subcommand tasks]
 204         purpose = list active server tasks
 205         aux_info = NO_PERMISSION_REQUIRED
 206         [description]
 207                 For each task, print ID, status and name. This is mostly useful
 208                 for debugging.
 209         [/description]
 210
 211 [subcommand term]
 212         purpose = ask the server to terminate
 213         aux_info = VSS_READ | VSS_WRITE
 214         [description]
 215                 Shut down the server. Instead of this command, you can also send
 216                 SIGINT or SIGTERM to the para_server process. It should never be
 217                 necessary to send SIGKILL.
 218         [/description]
 219
 220 [subcommand version]
 221         purpose = print the git version string of para_server
 222         aux_info = NO_PERMISSION_REQUIRED
 223         [option verbose]
 224                 short_opt = v
 225                 summary = print detailed (multi-line) version text
 226