2 caption = list of server commands
3 aux_info_prefix = Permissions:
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
17 purpose = add or update audio files
18 non-opts-name = path...
19 aux_info = AFS_READ | AFS_WRITE
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.
28 summary = add all files
30 The default is to add only files ending in a known suffix for a
31 supported audio format.
35 summary = add files lazily
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.
43 summary = force adding/updating
45 Recompute the audio format handler data even if a file with the same
46 path and the same hash value exists.
50 summary = enable verbose mode
52 Print what is being done.
56 purpose = add new attribute(s)
57 non-opts-name = attribute...
58 aux_info = AFS_READ | AFS_WRITE
60 This adds new attributes to the attribute table. At most 64 attributes
65 purpose = run integrity checks on database tables
68 If no options are given, all checks are run.
72 summary = run audio file table checks
74 Report stale paths and invalid image and lyrics ids of the audio
79 summary = check for invalid attributes
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.
86 summary = check for invalid mood definitions
88 Run syntax checks on all moods of the mood table.
92 summary = find invalid paths in playlists
94 Check all playlists for paths not contained in the audio file table.
98 purpose = copy selected parts of the audio file selector info
99 non-opts-name = source pattern...
100 aux_info = AFS_READ | AFS_WRITE
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.
107 [option attribute-bitmap]
109 summary = copy the attribute bitmap
112 summary = copy the image id
115 summary = copy the lyrics id
118 summary = copy the lastplayed timestamp
121 summary = copy the numplayed counter
124 summary = enable verbose mode
127 purpose = jump N seconds forward or backward
129 aux_info = VSS_READ | VSS_WRITE
131 This sets the 'R' (reposition request) bit of the vss status flags
132 which enqueues a request to jump n seconds forwards or backwards.
138 jumps 30 seconds backwards.
143 purpose = list available commands or print command-specific help
144 non-opts-name = [command]
145 aux_info = NO_PERMISSION_REQUIRED
147 Without any arguments, help prints a list of available commands. When
148 called with a command name as first argument, it prints the description
153 purpose = reload config file, log file and user list
156 Reread the config file and the user list file, close and reopen the log
157 file, and ask the afs process to do the same. Sending the HUP signal
158 to the server process has the same effect as running this command.
162 purpose = initialize the database tables for the audio file selector
163 synopsis = [table_name...]
164 aux_info = AFS_READ | AFS_WRITE
166 When invoked without arguments, this command creates all
167 tables: audio_files, attributes, scores, moods, lyrics, images,
168 playlists. Otherwise only the given tables are created.
172 purpose = reposition the current stream
174 aux_info = VSS_READ | VSS_WRITE
176 Set the 'R' (reposition request) bit of the vss status flags and
177 enqueue a request to jump to n% of the current audio file, where 0 <=
182 purpose = list audio files which match a pattern
183 non-opts-name = [pattern...]
186 If no pattern is given, all files are listed. Otherwise, the command
187 lists all files of the audio file table whose path matches at least
188 one of the given patterns.
190 [option listing-mode]
192 summary = use alternative output format
194 arg_info = optional_arg
198 The optional mode argument is either a single character or a word
199 according to the following list.
201 short (s). List only the path or basename (last component of the path),
202 depending on whether -p is also given. This listing mode acts as if
203 --listing-mode had not been given.
205 long (l). Show detailed information. This is the default if no argument
206 to --listing-mode is supplied.
208 verbose (v). Multi-line output, one row per data field stored in the
211 parser-friendly (p). Like verbose listing mode, but use numerical
212 values for the names of the output fields and prefix each line with
215 mbox (m). Generate output suitable to be viewed with a mail
216 program. One "mail" per matching audio file.
218 chunk-table (c). Print path (or basename, depending on whether -p is
219 also given), chunk time and chunk offsets.
224 summary = list and match basenames only
226 Print only the basename of each matching file and match only the
227 basenames of the paths stored in the audio file table against the
228 given patterns. The default is to print and match the full path.
232 summary = list only admissible files
234 List only files which are admissible with respect to the current mood
239 summary = reverse sort order
242 summary = print dates as seconds after the epoch
245 summary = change sort order
247 arg_info = required_arg
251 The sort order must be given as an required argument. Like for
252 --listing-mode, this argument may either be a single character or a
253 word, according to the following list.
255 path (p). Sort alphabetically by path or basename, depending on
256 whether -b is given. This is the default if --sort is not given.
258 score (s). Iterate over the entries of the score table, rather than
259 the audio file table. This sort order implies --admissible, since
260 the score table contains only admissible files.
282 If --sort is not given, path sort is implied.
286 purpose = list attributes
289 Print the list of all defined attributes which match the given
290 pattern. If no pattern is given, the full list is printed.
295 summary = sort attributes by id
297 The default is to sort alphabetically by name.
299 Attributes are internally represented as an 64 bit array. The attribute
300 id is the bit number in this array.
304 summary = print long listing
306 The long listing prints the attribute id in addition to the name of
307 the attribute. The id is printed as a decimal number and is separated
308 from the name by a tab character.
312 summary = reverse sort order
315 purpose = rename an attribute
316 synopsis = source dest
317 aux_info = AFS_READ | AFS_WRITE
319 Rename the attribute given by the first argument to the destination
320 given by the second argument. It is an error if the destination
325 purpose = close the stream and start to stream the next audio file
326 aux_info = VSS_READ | VSS_WRITE
328 Set the 'N' (next audio file) bit of the vss status flags. This
329 instructs the server to close the current stream, if any. The 'P'
330 (playing) bit is not modified by this command. If it is on, playing
331 continues with the next audio file.
333 This command is equivalent to stop if paused, and has no effect
338 purpose = stop playing after current audio file
339 aux_info = VSS_READ | VSS_WRITE
341 Set the 'O' (no more) bit of the vss status flags which asks
342 para_server to clear the 'P' (playing) bit after the 'N' (next audio
343 file) bit transitions from off to on (because the end of the current
344 audio file is reached). Use this command instead of stop if you don't
349 purpose = suspend the current stream
350 aux_info = VSS_READ | VSS_WRITE
352 Clear the 'P' (playing) bit of the vss status flags.
356 purpose = start or resume playback
357 aux_info = VSS_READ | VSS_WRITE
359 Set the 'P' (playing) bit of the vss status flags.
363 purpose = remove rows from the audio file table
364 non-opts-name = pattern...
365 aux_info = AFS_READ | AFS_WRITE
367 Remove all rows of the audio file table which match any of the given
368 patterns. Note that this affects only the database table; the command
369 won't touch your audio files on disk.
373 summary = print paths of deleted rows
376 summary = don't complain if nothing was removed
377 [option pathname-match]
379 summary = modify matching behaviour
381 Match a slash in the path only with a slash in pattern and not by an
382 asterisk (*) or a question mark (?) metacharacter, nor by a bracket
383 expression ([]) containing a slash (see fnmatch(3)).
387 purpose = remove attribute(s)
388 non-opts-name = pattern...
389 aux_info = AFS_READ | AFS_WRITE
391 Remove all attributes which match any given pattern. All information
392 about the removed attributes in the audio file table is lost.
396 purpose = activate a mood or a playlist
397 non-opts-name = specifier/name
398 aux_info = AFS_READ | AFS_WRITE
400 The specifier is either 'm' or 'p' to indicate whether a playlist or
401 a mood should be activated. Example:
405 activates the mood named 'foo'.
409 purpose = control paraslash senders
410 synopsis = [sender subcmd [arguments]]
411 aux_info = VSS_READ | VSS_WRITE
413 This command executes a subcommand for the given sender, which is
414 one of "http", "dccp" or "udp". Various subcommands exist to print
415 information about the sender, to activate and deactivate the sender,
416 and to change the access permissions and targets. The following
417 subcommands are available:
419 help, status, on, off, allow, deny, add, delete.
421 All senders support the first four commands. The "allow" and "deny"
422 commands are supported by the http and the dccp senders while "add"
423 and "delete" are only supported by the udp sender. If no sender is
424 given, the list of available senders is shown.
428 Get help for the udp sender (contains further examples):
432 Show the access control list and the number of connected clients of
437 Senders may be activated and deactivated independently of each
438 other. The following command switches off the dccp sender:
442 Add an UDP unicast for a client to the target list of the UDP sender:
444 sender udp add client.foo.org
446 Start UDP multicast, using the default multicast address:
448 sender udp add 224.0.1.38
453 purpose = set or unset attributes
454 synopsis = attribute{+|-}... pattern...
455 aux_info = AFS_READ | AFS_WRITE
457 Set ('+') or unset ('-') the given attributes for all audio files
458 matching the given pattern. Example:
460 setatt rock+ punk+ pop- '*foo.mp3'
462 sets the 'rock' and the 'punk' attribute and unsets the 'pop' attribute
463 of all files ending with 'foo.mp3'.
467 purpose = print server info
468 aux_info = NO_PERMISSION_REQUIRED
470 Show server and afs PID, number of connections, uptime and more.
474 purpose = print information about the current audio file
478 summary = number of times to show the status info
479 arg_info = required_arg
483 Exit after the status information has been shown num times. If this
484 option is not given, the command runs in an endless loop.
486 [option parser-friendly]
488 summary = enable parser-friendly output
490 Show status item identifiers as numerical values and prefix each
491 status item with its size in bytes.
495 purpose = stop playback
496 aux_info = VSS_READ | VSS_WRITE
498 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
499 the vss status flags, effectively stopping playback.
503 purpose = list active server tasks (deprecated)
504 aux_info = NO_PERMISSION_REQUIRED
506 This used to print the ID, the status and the name of each task,
507 mainly for debugging purposes. As of version 0.6.2, the subcommand
508 prints nothing. It will be removed in 0.7.0. Don't use.
512 purpose = ask the server to terminate
513 aux_info = VSS_READ | VSS_WRITE
515 Shut down the server. Instead of this command, you can also send
516 SIGINT or SIGTERM to the para_server process. It should never be
517 necessary to send SIGKILL.
521 purpose = manipulate the afs information of audio files
522 non-opts-name = pattern...
523 aux_info = AFS_READ | AFS_WRITE
525 This command modifies the afs info structure of all rows of the audio
526 file table whose path matches at least one of the given patters.
528 If at least one option is given which takes a number as its argument,
529 only those fields of the afs info structure are updated which
530 correspond to the given options while all other fields stay unmodified.
532 If no such option is given, the lastplayed field is set to the current
533 time and the value of the numplayed field is increased by one while
534 all other fields are left unchanged. This mimics what happens when
535 the virtual streaming system selects the file for streaming.
537 If the file is admissible for the current mood (or contained in the
538 current playlist), its score is recomputed according to the changed
543 summary = set the numplayed count manually
545 arg_info = required_arg
548 The numplayed count of an audio file is the number of times the file
549 was selected for streaming. It is one of the inputs to the scoring
550 function which determines the order in which admissible files are
553 The virtual streaming system increases this number automatically each
554 time it opens the file for streaming.
558 summary = set the lastplayed time manually
560 arg_info = required_arg
563 The lastplayed time of an audio file is the time when the file was
564 last opened for streaming.
566 Like the numplayed count, it is an input for the scoring function
567 and is updated automatically by the virtual streaming system.
569 The argument must be a number of seconds since the epoch. Example:
571 touch -l=$(date +%s) file
573 sets the lastplayed time of 'file' to the current time.
577 summary = set the image id
579 arg_info = required_arg
582 The afs info structure of each row of the audio file table contains
583 a slot for the image id of the audio file that corresponds to the
584 row. The image id stored in this slot refers to the key in the image
585 table that identifies the blob.
587 When a new audio file is added to the audio file table, its image
588 id starts out as zero, indicating that there is no image associated
589 with the file. Setting the image id to a non-zero number associates
590 the file with a particular blob of the image table, for example the
591 cover art of the album in jpg format.
595 summary = set the lyrics id
597 arg_info = required_arg
600 This option works just like --image-id, but sets the lyrics ID rather
605 summary = set the amplification value (0-255)
607 arg_info = required_arg
610 The amplification value of an audio file is a number which is stored
611 in the afs info structure.
613 The value determines the scaling factor by which the amplitude of
614 the decoded samples should be multiplied in order to normalize the
615 volume. A value of zero means no amplification, 64 means the amplitude
616 should be multiplied by a factor of two, 128 by three and so on.
618 The amp filter of para_audiod amplifies the volume according to
623 summary = explain what is being done
624 [option pathname-match]
626 summary = modify matching behaviour
628 Match a slash in the path only with a slash in pattern and not by an
629 asterisk (*) or a question mark (?) metacharacter, nor by a bracket
630 expression ([]) containing a slash (see fnmatch(3)).
634 purpose = print the git version string of para_server
635 aux_info = NO_PERMISSION_REQUIRED
638 summary = print detailed (multi-line) version text
640 m4_define(`BLOB_COMMANDS', `
642 purpose = remove `$1' blob(s)
643 non-opts-name = pattern...
644 aux_info = AFS_READ | AFS_WRITE
646 Remove all `$1' blobs which match any of the given patterns.
650 purpose = rename `$1' blob(s)
651 non-opts-name = source dest
652 aux_info = AFS_READ | AFS_WRITE
654 Rename `$1' source to dest. The command fails if the source `$1'
655 does not exist or if the destination `$1' already exists.
659 purpose = add a blob to the `$1' table
660 non-opts-name = `$1'_name
661 aux_info = AFS_READ | AFS_WRITE
663 Read from stdin and ask the audio file selector to create a blob in
664 the `$1' table. If the named blob already exists, it gets replaced
669 purpose = dump a `$1' blob to stdout
670 non-opts-name = `$1'_name
674 purpose = list blobs of type `$1' which match a pattern
675 non-opts-name = [pattern...]
678 Print the list of all blobs which match the given pattern. If no
679 pattern is given, the full list is printed.
683 summary = sort by identifier
685 The default is to sort alphabetically by name.
689 summary = long listing
691 Print identifier and name. The default is to print only the name.
695 summary = reverse sort order
698 BLOB_COMMANDS(`moods', `mood')
699 BLOB_COMMANDS(`playlist', `pl')
700 BLOB_COMMANDS(`image', `img')
701 BLOB_COMMANDS(`lyrics', `lyr')