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 addatt]
  56         purpose = add new attribute(s)
  57         non-opts-name = attribute...
  58         aux_info = AFS_READ | AFS_WRITE
  59         [description]
  60                 This adds new attributes to the attribute table. At most 64 attributes
  61                 may be defined.
  62         [/description]
  63
  64 [subcommand check]
  65         purpose = run integrity checks on database tables
  66         aux_info = AFS_READ
  67         [description]
  68                 If no options are given, all checks are run.
  69         [/description]
  70         [option aft]
  71                 short_opt = a
  72                 summary = run audio file table checks
  73                 [help]
  74                         Report stale paths and invalid image and lyrics ids of the audio
  75                         file table.
  76                 [/help]
  77         [option attribute]
  78                 short_opt = A
  79                 summary = check for invalid attributes
  80                 [help]
  81                         Report audio files whose attribute bitmask is invalid, i.e., has a bit
  82                         set which does not correspond to any attribute of the attribute table.
  83                 [/help]
  84         [option mood]
  85                 short_opt = m
  86                 summary = check for invalid mood definitions
  87                 [help]
  88                         Run syntax checks on all moods of the mood table.
  89                 [/help]
  90         [option playlist]
  91                 short_opt = p
  92                 summary = find invalid paths in playlists
  93                 [help]
  94                         Check all playlists for paths not contained in the audio file table.
  95                 [/help]
  96
  97 [subcommand cpsi]
  98         purpose = copy selected parts of the audio file selector info
  99         non-opts-name = source pattern...
 100         aux_info = AFS_READ | AFS_WRITE
 101         [description]
 102                 If no option, or only --verbose is given, all fields of the audio
 103                 file selector info structure are copied to each row of the audio file
 104                 table whose path matches at least one of the given patterns. Otherwise,
 105                 only those fields which correspond to the given options are copied.
 106         [/description]
 107         [option attribute-bitmap]
 108                 short_opt = a
 109                 summary = copy the attribute bitmap
 110         [option image-id]
 111                 short_opt = i
 112                 summary = copy the image id
 113         [option lyrics-id]
 114                 short_opt = y
 115                 summary = copy the lyrics id
 116         [option lastplayed]
 117                 short_opt = l
 118                 summary = copy the lastplayed timestamp
 119         [option numplayed]
 120                 short_opt = n
 121                 summary = copy the numplayed counter
 122         [option verbose]
 123                 short_opt = v
 124                 summary = enable verbose mode
 125
 126 [subcommand ff]
 127         purpose = jump forward or backward in the current audio file
 128         synopsis = seconds
 129         aux_info = VSS_READ | VSS_WRITE
 130         [description]
 131                 This enqueues a request to reposition the audio stream according to
 132                 the argument, which may be a signed or an unsigned integer. Negative
 133                 values correspond to backward jumps.
 134
 135                 If a negative number is given whose absolute value exceeds the current
 136                 postition of the stream, a jump to the beginning of the audio file
 137                 is performed. If a positive amount of seconds is given which exceeds
 138                 the remaining time of the audio file, the next audio file is loaded.
 139
 140         [/description]
 141
 142 [subcommand help]
 143         purpose = list available commands or print command-specific help
 144         non-opts-name = [command]
 145         aux_info = NO_PERMISSION_REQUIRED
 146         [description]
 147                 When executed without any arguments, the available server commands
 148                 are listed. Otherwise, if the first argument is the name of a server
 149                 command, the description of this command is shown.
 150         [/description]
 151         m4_include(`long-help.m4')
 152
 153 [subcommand hup]
 154         purpose = reload config file, log file and user list
 155         aux_info = VSS_WRITE
 156         [description]
 157                 Reread the config file and the user list file, close and reopen the log
 158                 file, and ask the afs process to do the same. Sending the HUP signal
 159                 to the server process has the same effect as running this command.
 160         [/description]
 161
 162 [subcommand init]
 163         purpose = initialize the database tables for the audio file selector
 164         synopsis = [table_name...]
 165         aux_info = AFS_READ | AFS_WRITE
 166         [description]
 167                 When invoked without arguments, this command creates all
 168                 tables: audio_files, attributes, scores, moods, lyrics, images,
 169                 playlists. Otherwise only the given tables are created.
 170         [/description]
 171
 172 m4_include(`com_ll.m4')
 173
 174 [subcommand jmp]
 175         purpose = reposition the current stream
 176         non-opts-name = n
 177         aux_info = VSS_READ | VSS_WRITE
 178         [description]
 179                 Set the 'R' (reposition request) bit of the vss status flags and
 180                 enqueue a request to jump to n% of the current audio file, where 0 <=
 181                 n <= 100.
 182         [/description]
 183
 184 [subcommand ls]
 185         purpose = list audio files which match a pattern
 186         non-opts-name = [pattern...]
 187         aux_info = AFS_READ
 188         [description]
 189                 If no pattern is given, all files are listed.  Otherwise, the command
 190                 lists all files of the audio file table whose path matches at least
 191                 one of the given patterns.
 192         [/description]
 193         [option listing-mode]
 194                 short_opt = l
 195                 summary = use alternative output format
 196                 arg_type = string
 197                 arg_info = optional_arg
 198                 typestr = mode
 199                 default_val = long
 200                 [help]
 201                         The optional mode argument is either a single character or a word
 202                         according to the following list.
 203
 204                         short (s). List only the path or basename (last component of the path),
 205                         depending on whether -p is also given. This listing mode acts as if
 206                         --listing-mode had not been given.
 207
 208                         long (l). Show detailed information. This is the default if no argument
 209                         to --listing-mode is supplied.
 210
 211                         verbose (v). Multi-line output, one row per data field stored in the
 212                         audio file table.
 213
 214                         parser-friendly (p). Like verbose listing mode, but use numerical
 215                         values for the names of the output fields and prefix each line with
 216                         a length field.
 217
 218                         mbox (m). Generate output suitable to be viewed with a mail
 219                         program. One "mail" per matching audio file.
 220
 221                         chunk-table (c). Print path (or basename, depending on whether -p is
 222                         also given), chunk time and chunk offsets.
 223
 224                 [/help]
 225         [option limit]
 226                 short_opt = L
 227                 summary = list at most this many files
 228                 arg_type = uint32
 229                 arg_info = required_arg
 230                 typestr = num
 231                 [help]
 232                         An argument of zero means "unlimited". This is also the default which
 233                         applies if the option is not given.
 234                 [/help]
 235         [option basename]
 236                 short_opt = b
 237                 summary = list and match basenames only
 238                 [help]
 239                         Print only the basename of each matching file and match only the
 240                         basenames of the paths stored in the audio file table against the
 241                         given patterns. The default is to print and match the full path.
 242                 [/help]
 243         [option admissible]
 244                 short_opt = a
 245                 summary = list only admissible files
 246                 arg_type = string
 247                 arg_info = optional_arg
 248                 typestr = specifier/name
 249                 default_val = .
 250                 [help]
 251                         If the optional argument is supplied, it must be of the form "p/foo"
 252                         or "m/bar" (which refer to the playlist named "foo" and the mood named
 253                         "bar", respectively). The command then restricts its output to the set
 254                         of files which are admissible with respect to the thusly identified
 255                         mood or playlist.
 256
 257                         If no argument is given, or if the argument is the special value ".",
 258                         the current mood or playlist is assumed.
 259                 [/help]
 260         [option reverse]
 261                 short_opt = r
 262                 summary = reverse sort order
 263         [option unix-date]
 264                 short_opt = d
 265                 summary = print dates as seconds after the epoch
 266         [option sort]
 267                 short_opt = s
 268                 summary = change sort order
 269                 arg_type = string
 270                 arg_info = required_arg
 271                 typestr = order
 272                 default_val = path
 273                 [help]
 274                         The sort order must be given as an required argument. Like for
 275                         --listing-mode, this argument may either be a single character or a
 276                         word, according to the following list.
 277
 278                         path (p). Sort alphabetically by path or basename, depending on
 279                         whether -b is given. This is the default if --sort is not given.
 280
 281                         score (s). Iterate over the entries of the score table, rather than
 282                         the audio file table. This sort order implies --admissible, since
 283                         the score table contains only admissible files.
 284
 285                         lastplayed (l)
 286
 287                         numplayed (n)
 288
 289                         frequency (f)
 290
 291                         channels (c)
 292
 293                         image-id (i)
 294
 295                         lyrics-id (y)
 296
 297                         bitrate (b)
 298
 299                         duration (d)
 300
 301                         audio-format (a)
 302
 303                         hash (h)
 304
 305                         If --sort is not given, path sort is implied.
 306                 [/help]
 307
 308 [subcommand lsatt]
 309         purpose = list attributes
 310         aux_info = AFS_READ
 311         [description]
 312                 Print the list of all defined attributes which match the given
 313                 pattern. If no pattern is given, the full list is printed.
 314         [/description]
 315
 316         [option id-sort]
 317                 short_opt = i
 318                 summary = sort attributes by id
 319                 [help]
 320                         The default is to sort alphabetically by name.
 321
 322                         Attributes are internally represented as an 64 bit array. The attribute
 323                         id is the bit number in this array.
 324                 [/help]
 325         [option long]
 326                 short_opt = l
 327                 summary = print long listing
 328                 [help]
 329                         The long listing prints the attribute id in addition to the name of
 330                         the attribute. The id is printed as a decimal number and is separated
 331                         from the name by a tab character.
 332                 [/help]
 333         [option reverse]
 334                 short_opt = r
 335                 summary = reverse sort order
 336
 337 [subcommand mvatt]
 338         purpose = rename an attribute
 339         synopsis = source dest
 340         aux_info = AFS_READ | AFS_WRITE
 341         [description]
 342                 Rename the attribute given by the first argument to the destination
 343                 given by the second argument. It is an error if the destination
 344                 attribute exists.
 345         [/description]
 346
 347 [subcommand next]
 348         purpose = close the stream and start to stream the next audio file
 349         aux_info = VSS_READ | VSS_WRITE
 350         [description]
 351                 Set the 'N' (next audio file) bit of the vss status flags. This
 352                 instructs the server to close the current stream, if any. The 'P'
 353                 (playing) bit is not modified by this command. If it is on, playing
 354                 continues with the next audio file.
 355
 356                 This command is equivalent to stop if paused, and has no effect
 357                 if stopped.
 358         [/description]
 359
 360 [subcommand nomore]
 361         purpose = stop playing after current audio file
 362         aux_info = VSS_READ | VSS_WRITE
 363         [description]
 364                 Set the 'O' (no more) bit of the vss status flags which asks
 365                 para_server to clear the 'P' (playing) bit after the 'N' (next audio
 366                 file) bit transitions from off to on (because the end of the current
 367                 audio file is reached). Use this command instead of stop if you don't
 368                 like sudden endings.
 369         [/description]
 370
 371 [subcommand pause]
 372         purpose = suspend the current stream
 373         aux_info = VSS_READ | VSS_WRITE
 374         [description]
 375                 Clear the 'P' (playing) bit of the vss status flags.
 376         [/description]
 377
 378 [subcommand play]
 379         purpose = start or resume playback
 380         aux_info = VSS_READ | VSS_WRITE
 381         [description]
 382                 Set the 'P' (playing) bit of the vss status flags.
 383         [/description]
 384
 385 [subcommand rm]
 386         purpose = remove rows from the audio file table
 387         non-opts-name = pattern...
 388         aux_info = AFS_READ | AFS_WRITE
 389         [description]
 390                 Remove all rows of the audio file table which match any of the given
 391                 patterns. Note that this affects only the database table; the command
 392                 won't touch your audio files on disk.
 393         [/description]
 394         [option verbose]
 395                 short_opt = v
 396                 summary = print paths of deleted rows
 397         [option force]
 398                 short_opt = f
 399                 summary = don't complain if nothing was removed
 400         [option pathname-match]
 401                 short_opt = p
 402                 summary = modify matching behaviour
 403                 [help]
 404                         Match a slash in the path only with a slash in pattern and not by an
 405                         asterisk (*) or a question mark (?) metacharacter, nor by a bracket
 406                         expression ([]) containing a slash (see fnmatch(3)).
 407                 [/help]
 408
 409 [subcommand rmatt]
 410         purpose = remove attribute(s)
 411         non-opts-name = pattern...
 412         aux_info = AFS_READ | AFS_WRITE
 413         [description]
 414                 Remove all attributes which match any given pattern. All information
 415                 about the removed attributes in the audio file table is lost.
 416         [/description]
 417
 418 [subcommand select]
 419         purpose = activate a mood or a playlist
 420         non-opts-name = specifier/name
 421         aux_info = AFS_READ | AFS_WRITE
 422         [description]
 423                 The specifier is either 'm' or 'p' to indicate whether a playlist or
 424                 a mood should be activated. Example:
 425
 426                         select m/foo
 427
 428                 activates the mood named 'foo'.
 429         [/description]
 430         [option verbose]
 431                 short_opt = v
 432                 summary = print information about the loaded mood or playlist
 433
 434 [subcommand sender]
 435         purpose = control paraslash senders
 436         synopsis = [sender subcmd [arguments]]
 437         aux_info = VSS_READ | VSS_WRITE
 438         [description]
 439                 This command executes a subcommand for the given sender, which is
 440                 one of "http", "dccp" or "udp". Various subcommands exist to print
 441                 information about the sender, to activate and deactivate the sender,
 442                 and to change the access permissions and targets. The following
 443                 subcommands are available:
 444
 445                        help, status, on, off, allow, deny, add, delete.
 446
 447                 All senders support the first four commands. The "allow" and "deny"
 448                 commands are supported by the http and the dccp senders while "add"
 449                 and "delete" are only supported by the udp sender. If no sender is
 450                 given, the list of available senders is shown.
 451
 452                 Examples:
 453
 454                 Get help for the udp sender (contains further examples):
 455
 456                         sender udp help
 457
 458                 Show the access control list and the number of connected clients of
 459                 the http sender:
 460
 461                         sender http status
 462
 463                 Senders may be activated and deactivated independently of each
 464                 other. The following command switches off the dccp sender:
 465
 466                         sender dccp off
 467
 468                 Add an UDP unicast for a client to the target list of the UDP sender:
 469
 470                         sender udp add client.foo.org
 471
 472                 Start UDP multicast, using the default multicast address:
 473
 474                         sender udp add 224.0.1.38
 475
 476         [/description]
 477
 478 [subcommand setatt]
 479         purpose = set or unset attributes
 480         synopsis = attribute{+|-}... pattern...
 481         aux_info = AFS_READ | AFS_WRITE
 482         [description]
 483                 Set ('+') or unset ('-') the given attributes for all audio files
 484                 matching the given pattern. Example:
 485
 486                         setatt rock+ punk+ pop- '*foo.mp3'
 487
 488                 sets the 'rock' and the 'punk' attribute and unsets the 'pop' attribute
 489                 of all files ending with 'foo.mp3'.
 490         [/description]
 491
 492 [subcommand si]
 493         purpose = print server info
 494         aux_info = NO_PERMISSION_REQUIRED
 495         [description]
 496                 Show server and afs PID, number of connections, uptime and more.
 497         [/description]
 498
 499 [subcommand stat]
 500         purpose = print information about the current audio file
 501         aux_info = VSS_READ
 502         [option num]
 503                 short_opt = n
 504                 summary = number of times to show the status info
 505                 arg_info = required_arg
 506                 arg_type = uint32
 507                 typestr = num
 508                 [help]
 509                         Exit after the status information has been shown num times. If this
 510                         option is not given, the command runs in an endless loop.
 511                 [/help]
 512         [option parser-friendly]
 513                 short_opt = p
 514                 summary = enable parser-friendly output
 515                 [help]
 516                         Show status item identifiers as numerical values and prefix each
 517                         status item with its size in bytes.
 518                 [/help]
 519
 520 [subcommand stop]
 521         purpose = stop playback
 522         aux_info = VSS_READ | VSS_WRITE
 523         [description]
 524                 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
 525                 the vss status flags, effectively stopping playback.
 526         [/description]
 527
 528 [subcommand term]
 529         purpose = ask the server to terminate
 530         aux_info = VSS_READ | VSS_WRITE
 531         [description]
 532                 Shut down the server. Instead of this command, you can also send
 533                 SIGINT or SIGTERM to the para_server process. It should never be
 534                 necessary to send SIGKILL.
 535         [/description]
 536
 537 [subcommand touch]
 538         purpose = manipulate the afs information of audio files
 539         non-opts-name = pattern...
 540         aux_info = AFS_READ | AFS_WRITE
 541         [description]
 542                 This command modifies the afs info structure of all rows of the audio
 543                 file table whose path matches at least one of the given patters.
 544
 545                 If at least one option is given which takes a number as its argument,
 546                 only those fields of the afs info structure are updated which
 547                 correspond to the given options while all other fields stay unmodified.
 548
 549                 If no such option is given, the lastplayed field is set to the current
 550                 time and the value of the numplayed field is increased by one while
 551                 all other fields are left unchanged. This mimics what happens when
 552                 the virtual streaming system selects the file for streaming.
 553
 554                 If the file is admissible for the current mood (or contained in the
 555                 current playlist), its score is recomputed according to the changed
 556                 values.
 557         [/description]
 558         [option numplayed]
 559                 short_opt = n
 560                 summary = set the numplayed count manually
 561                 arg_type = uint32
 562                 arg_info = required_arg
 563                 typestr = num
 564                 [help]
 565                         The numplayed count of an audio file is the number of times the file
 566                         was selected for streaming. It is one of the inputs to the scoring
 567                         function which determines the order in which admissible files are
 568                         streamed.
 569
 570                         The virtual streaming system increases this number automatically each
 571                         time it opens the file for streaming.
 572                 [/help]
 573         [option lastplayed]
 574                 short_opt = l
 575                 summary = set the lastplayed time manually
 576                 arg_type = uint64
 577                 arg_info = required_arg
 578                 typestr = num
 579                 [help]
 580                         The lastplayed time of an audio file is the time when the file was
 581                         last opened for streaming.
 582
 583                         Like the numplayed count, it is an input for the scoring function
 584                         and is updated automatically by the virtual streaming system.
 585
 586                         The argument must be a number of seconds since the epoch. Example:
 587
 588                                 touch -l=$(date +%s) file
 589
 590                         sets the lastplayed time of 'file' to the current time.
 591                 [/help]
 592         [option image-id]
 593                 short_opt = i
 594                 summary = set the image id
 595                 arg_type = uint32
 596                 arg_info = required_arg
 597                 typestr = num
 598                 [help]
 599                         The afs info structure of each row of the audio file table contains
 600                         a slot for the image id of the audio file that corresponds to the
 601                         row. The image id stored in this slot refers to the key in the image
 602                         table that identifies the blob.
 603
 604                         When a new audio file is added to the audio file table, its image
 605                         id starts out as zero, indicating that there is no image associated
 606                         with the file. Setting the image id to a non-zero number associates
 607                         the file with a particular blob of the image table, for example the
 608                         cover art of the album in jpg format.
 609                 [/help]
 610         [option lyrics-id]
 611                 short_opt = y
 612                 summary = set the lyrics id
 613                 arg_type = uint32
 614                 arg_info = required_arg
 615                 typestr = num
 616                 [help]
 617                         This option works just like --image-id, but sets the lyrics ID rather
 618                         than the image id.
 619                 [/help]
 620         [option amp]
 621                 short_opt = a
 622                 summary = set the amplification value (0-255)
 623                 arg_type = uint32
 624                 arg_info = required_arg
 625                 typestr = num
 626                 [help]
 627                         The amplification value of an audio file is a number which is stored
 628                         in the afs info structure.
 629
 630                         The value determines the scaling factor by which the amplitude of
 631                         the decoded samples should be multiplied in order to normalize the
 632                         volume. A value of zero means no amplification, 64 means the amplitude
 633                         should be multiplied by a factor of two, 128 by three and so on.
 634
 635                         The amp filter of para_audiod amplifies the volume according to
 636                         this value.
 637                 [/help]
 638         [option verbose]
 639                 short_opt = v
 640                 summary = explain what is being done
 641         [option pathname-match]
 642                 short_opt = p
 643                 summary = modify matching behaviour
 644                 [help]
 645                         Match a slash in the path only with a slash in pattern and not by an
 646                         asterisk (*) or a question mark (?) metacharacter, nor by a bracket
 647                         expression ([]) containing a slash (see fnmatch(3)).
 648                 [/help]
 649
 650 [subcommand version]
 651         purpose = print the git version string of para_server
 652         aux_info = NO_PERMISSION_REQUIRED
 653         [option verbose]
 654                 short_opt = v
 655                 summary = print detailed (multi-line) version text
 656
 657 m4_define(`BLOB_COMMANDS', `
 658 [subcommand rm`$2']
 659         purpose = remove `$1' blob(s)
 660         non-opts-name = pattern...
 661         aux_info = AFS_READ | AFS_WRITE
 662         [description]
 663                 Remove all `$1' blobs which match any of the given patterns.
 664         [/description]
 665
 666 [subcommand mv`$2']
 667         purpose = rename `$1' blob(s)
 668         non-opts-name = source dest
 669         aux_info = AFS_READ | AFS_WRITE
 670         [description]
 671                 Rename `$1' source to dest. The command fails if the source `$1'
 672                 does not exist or if the destination `$1' already exists.
 673         [/description]
 674
 675 [subcommand add`$2']
 676         purpose = add a blob to the `$1' table
 677         non-opts-name = `$1'_name
 678         aux_info = AFS_READ | AFS_WRITE
 679         [description]
 680                 Read from stdin and ask the audio file selector to create a blob in
 681                 the `$1' table. If the named blob already exists, it gets replaced
 682                 with the new data.
 683         [/description]
 684
 685 [subcommand cat`$2']
 686         purpose = dump a `$1' blob to stdout
 687         non-opts-name = `$1'_name
 688         aux_info = AFS_READ
 689
 690 [subcommand ls`$2']
 691         purpose = list blobs of type `$1' which match a pattern
 692         non-opts-name = [pattern...]
 693         aux_info = AFS_READ
 694         [description]
 695                 Print the list of all blobs which match the given pattern. If no
 696                 pattern is given, the full list is printed.
 697         [/description]
 698         [option id-sort]
 699                 short_opt = i
 700                 summary = sort by identifier
 701                 [help]
 702                         The default is to sort alphabetically by name.
 703                 [/help]
 704         [option long]
 705                 short_opt = l
 706                 summary = long listing
 707                 [help]
 708                         Print identifier and name. The default is to print only the name.
 709                 [/help]
 710         [option reverse]
 711                 short_opt = r
 712                 summary = reverse sort order
 713 ')
 714
 715 BLOB_COMMANDS(`moods', `mood')
 716 BLOB_COMMANDS(`playlist', `pl')
 717 BLOB_COMMANDS(`image', `img')
 718 BLOB_COMMANDS(`lyrics', `lyr')