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 check]
  56         purpose = run integrity checks on database tables
  57         aux_info = AFS_READ
  58         [description]
  59                 If no options are given, all checks are run.
  60         [/description]
  61         [option aft]
  62                 short_opt = a
  63                 summary = run audio file table checks
  64                 [help]
  65                         Report stale paths and invalid image and lyrics ids of the audio
  66                         file table.
  67                 [/help]
  68         [option attribute]
  69                 short_opt = A
  70                 summary = check for invalid attributes
  71                 [help]
  72                         Report audio files whose attribute bitmask is invalid, i.e., has a bit
  73                         set which does not correspond to any attribute of the attribute table.
  74                 [/help]
  75         [option mood]
  76                 short_opt = m
  77                 summary = check for invalid mood definitions
  78                 [help]
  79                         Run syntax checks on all moods of the mood table.
  80                 [/help]
  81         [option playlist]
  82                 short_opt = p
  83                 summary = find invalid paths in playlists
  84                 [help]
  85                         Check all playlists for paths not contained in the audio file table.
  86                 [/help]
  87
  88 [subcommand cpsi]
  89         purpose = copy selected parts of the audio file selector info
  90         non-opts-name = source pattern...
  91         aux_info = AFS_READ | AFS_WRITE
  92         [description]
  93                 If no option, or only --verbose is given, all fields of the audio
  94                 file selector info structure are copied to each row of the audio file
  95                 table whose path matches at least one of the given patterns. Otherwise,
  96                 only those fields which correspond to the given options are copied.
  97         [/description]
  98         [option attribute-bitmap]
  99                 short_opt = a
 100                 summary = copy the attribute bitmap
 101         [option image-id]
 102                 short_opt = i
 103                 summary = copy the image id
 104         [option lyrics-id]
 105                 short_opt = y
 106                 summary = copy the lyrics id
 107         [option lastplayed]
 108                 short_opt = l
 109                 summary = copy the lastplayed timestamp
 110         [option numplayed]
 111                 short_opt = n
 112                 summary = copy the numplayed counter
 113         [option verbose]
 114                 short_opt = v
 115                 summary = enable verbose mode
 116
 117 [subcommand ff]
 118         purpose = jump N seconds forward or backward
 119         synopsis = n[-]
 120         aux_info = VSS_READ | VSS_WRITE
 121         [description]
 122                 This sets the 'R' (reposition request) bit of the vss status flags
 123                 which enqueues a request to jump n seconds forwards or backwards.
 124
 125                 Example:
 126
 127                      para_client ff 30-
 128
 129                 jumps 30 seconds backwards.
 130
 131         [/description]
 132
 133 [subcommand help]
 134         purpose = list available commands or print command-specific help
 135         non-opts-name = [command]
 136         aux_info = NO_PERMISSION_REQUIRED
 137         [description]
 138                 Without any arguments, help prints a list of available commands. When
 139                 called with a command name as first argument, it prints the description
 140                 of this command.
 141         [/description]
 142
 143 [subcommand hup]
 144         purpose = reload config file, log file and user list
 145         aux_info = VSS_WRITE
 146         [description]
 147                 Reread the config file and the user list file, close and reopen the log
 148                 file, and ask the afs process to do the same. Sending the HUP signal
 149                 to the server process has the same effect as running this command.
 150         [/description]
 151
 152 [subcommand init]
 153         purpose = initialize the database tables for the audio file selector
 154         synopsis = [table_name...]
 155         aux_info = AFS_READ | AFS_WRITE
 156         [description]
 157                 When invoked without arguments, this command creates all
 158                 tables: audio_files, attributes, scores, moods, lyrics, images,
 159                 playlists. Otherwise only the given tables are created.
 160         [/description]
 161
 162 [subcommand jmp]
 163         purpose = reposition the current stream
 164         non-opts-name = n
 165         aux_info = VSS_READ | VSS_WRITE
 166         [description]
 167                 Set the 'R' (reposition request) bit of the vss status flags and
 168                 enqueue a request to jump to n% of the current audio file, where 0 <=
 169                 n <= 100.
 170         [/description]
 171
 172 [subcommand lsatt]
 173         purpose = list attributes
 174         aux_info = AFS_READ
 175         [description]
 176                 Print the list of all defined attributes which match the given
 177                 pattern. If no pattern is given, the full list is printed.
 178         [/description]
 179
 180         [option id-sort]
 181                 short_opt = i
 182                 summary = sort attributes by id
 183                 [help]
 184                         The default is to sort alphabetically by name.
 185
 186                         Attributes are internally represented as an 64 bit array. The attribute
 187                         id is the bit number in this array.
 188                 [/help]
 189         [option long]
 190                 short_opt = l
 191                 summary = print long listing
 192                 [help]
 193                         The long listing prints the attribute id in addition to the name of
 194                         the attribute. The id is printed as a decimal number and is separated
 195                         from the name by a tab character.
 196                 [/help]
 197         [option reverse]
 198                 short_opt = r
 199                 summary = reverse sort order
 200
 201 [subcommand mvatt]
 202         purpose = rename an attribute
 203         synopsis = source dest
 204         aux_info = AFS_READ | AFS_WRITE
 205         [description]
 206                 Rename the attribute given by the first argument to the destination
 207                 given by the second argument. It is an error if the destination
 208                 attribute exists.
 209         [/description]
 210
 211 [subcommand next]
 212         purpose = close the stream and start to stream the next audio file
 213         aux_info = VSS_READ | VSS_WRITE
 214         [description]
 215                 Set the 'N' (next audio file) bit of the vss status flags. This
 216                 instructs the server to close the current stream, if any. The 'P'
 217                 (playing) bit is not modified by this command. If it is on, playing
 218                 continues with the next audio file.
 219
 220                 This command is equivalent to stop if paused, and has no effect
 221                 if stopped.
 222         [/description]
 223
 224 [subcommand nomore]
 225         purpose = stop playing after current audio file
 226         aux_info = VSS_READ | VSS_WRITE
 227         [description]
 228                 Set the 'O' (no more) bit of the vss status flags which asks
 229                 para_server to clear the 'P' (playing) bit after the 'N' (next audio
 230                 file) bit transitions from off to on (because the end of the current
 231                 audio file is reached). Use this command instead of stop if you don't
 232                 like sudden endings.
 233         [/description]
 234
 235 [subcommand pause]
 236         purpose = suspend the current stream
 237         aux_info = VSS_READ | VSS_WRITE
 238         [description]
 239                 Clear the 'P' (playing) bit of the vss status flags.
 240         [/description]
 241
 242 [subcommand play]
 243         purpose = start or resume playback
 244         aux_info = VSS_READ | VSS_WRITE
 245         [description]
 246                 Set the 'P' (playing) bit of the vss status flags.
 247         [/description]
 248
 249 [subcommand rmatt]
 250         purpose = remove attribute(s)
 251         non-opts-name = pattern...
 252         aux_info = AFS_READ | AFS_WRITE
 253         [description]
 254                 Remove all attributes which match any given pattern. All information
 255                 about the removed attributes in the audio file table is lost.
 256         [/description]
 257
 258 [subcommand sender]
 259         purpose = control paraslash senders
 260         synopsis = [sender cmd [arguments]]
 261         aux_info = VSS_READ | VSS_WRITE
 262         [description]
 263                 Send a command to a specific sender. The following commands are
 264                 available, but not all senders support every command.
 265
 266                        help, on, off, add, delete, allow, deny, status.
 267
 268                 The help command prints the help text of the given sender. If no
 269                 command is given the list of available senders is shown.
 270
 271                 Example:
 272
 273                         para_client sender http help
 274
 275         [/description]
 276
 277 [subcommand setatt]
 278         purpose = set or unset attributes
 279         synopsis = attribute{+|-}... pattern...
 280         aux_info = AFS_READ | AFS_WRITE
 281         [description]
 282                 Set ('+') or unset ('-') the given attributes for all audio files
 283                 matching the given pattern. Example:
 284
 285                         setatt rock+ punk+ pop- '*foo.mp3'
 286
 287                 sets the 'rock' and the 'punk' attribute and unsets the 'pop' attribute
 288                 of all files ending with 'foo.mp3'.
 289         [/description]
 290
 291 [subcommand si]
 292         purpose = print server info
 293         aux_info = NO_PERMISSION_REQUIRED
 294         [description]
 295                 Show server and afs PID, number of connections, uptime and more.
 296         [/description]
 297
 298 [subcommand stat]
 299         purpose = print information about the current audio file
 300         aux_info = VSS_READ
 301         [option num]
 302                 short_opt = n
 303                 summary = number of times to show the status info
 304                 arg_info = required_arg
 305                 arg_type = uint32
 306                 typestr = num
 307                 [help]
 308                         Exit after the status information has been shown num times. If this
 309                         option is not given, the command runs in an endless loop.
 310                 [/help]
 311         [option parser-friendly]
 312                 short_opt = p
 313                 summary = enable parser-friendly output
 314                 [help]
 315                         Show status item identifiers as numerical values and prefix each
 316                         status item with its size in bytes.
 317                 [/help]
 318
 319 [subcommand stop]
 320         purpose = stop playback
 321         aux_info = VSS_READ | VSS_WRITE
 322         [description]
 323                 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
 324                 the vss status flags, effectively stopping playback.
 325         [/description]
 326
 327 [subcommand tasks]
 328         purpose = list active server tasks
 329         aux_info = NO_PERMISSION_REQUIRED
 330         [description]
 331                 For each task, print ID, status and name. This is mostly useful
 332                 for debugging.
 333         [/description]
 334
 335 [subcommand term]
 336         purpose = ask the server to terminate
 337         aux_info = VSS_READ | VSS_WRITE
 338         [description]
 339                 Shut down the server. Instead of this command, you can also send
 340                 SIGINT or SIGTERM to the para_server process. It should never be
 341                 necessary to send SIGKILL.
 342         [/description]
 343
 344 [subcommand version]
 345         purpose = print the git version string of para_server
 346         aux_info = NO_PERMISSION_REQUIRED
 347         [option verbose]
 348                 short_opt = v
 349                 summary = print detailed (multi-line) version text
 350