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 full paths, match full paths against patterns
226 This option is the default, so it does nothing. Deprecated as of
227 v0.6.0, scheduled for removal in v0.6.1.
231 summary = list and match basenames only
233 Print only the basename of each matching file and match only the
234 basenames of the paths stored in the audio file table against the
235 given patterns. The default is to print and match the full path.
239 summary = list only admissible files
241 List only files which are admissible with respect to the current mood
246 summary = reverse sort order
249 summary = print dates as seconds after the epoch
252 summary = change sort order
254 arg_info = required_arg
258 The sort order must be given as an required argument. Like for
259 --listing-mode, this argument may either be a single character or a
260 word, according to the following list.
262 path (p). Sort alphabetically by path or basename, depending on
263 whether -b is given. This is the default if --sort is not given.
265 score (s). Iterate over the entries of the score table, rather than
266 the audio file table. This sort order implies --admissible, since
267 the score table contains only admissible files.
287 If --sort is not given, path sort is implied.
291 purpose = list attributes
294 Print the list of all defined attributes which match the given
295 pattern. If no pattern is given, the full list is printed.
300 summary = sort attributes by id
302 The default is to sort alphabetically by name.
304 Attributes are internally represented as an 64 bit array. The attribute
305 id is the bit number in this array.
309 summary = print long listing
311 The long listing prints the attribute id in addition to the name of
312 the attribute. The id is printed as a decimal number and is separated
313 from the name by a tab character.
317 summary = reverse sort order
320 purpose = rename an attribute
321 synopsis = source dest
322 aux_info = AFS_READ | AFS_WRITE
324 Rename the attribute given by the first argument to the destination
325 given by the second argument. It is an error if the destination
330 purpose = close the stream and start to stream the next audio file
331 aux_info = VSS_READ | VSS_WRITE
333 Set the 'N' (next audio file) bit of the vss status flags. This
334 instructs the server to close the current stream, if any. The 'P'
335 (playing) bit is not modified by this command. If it is on, playing
336 continues with the next audio file.
338 This command is equivalent to stop if paused, and has no effect
343 purpose = stop playing after current audio file
344 aux_info = VSS_READ | VSS_WRITE
346 Set the 'O' (no more) bit of the vss status flags which asks
347 para_server to clear the 'P' (playing) bit after the 'N' (next audio
348 file) bit transitions from off to on (because the end of the current
349 audio file is reached). Use this command instead of stop if you don't
354 purpose = suspend the current stream
355 aux_info = VSS_READ | VSS_WRITE
357 Clear the 'P' (playing) bit of the vss status flags.
361 purpose = start or resume playback
362 aux_info = VSS_READ | VSS_WRITE
364 Set the 'P' (playing) bit of the vss status flags.
368 purpose = remove rows from the audio file table
369 non-opts-name = pattern...
370 aux_info = AFS_READ | AFS_WRITE
372 Remove all rows of the audio file table which match any of the given
373 patterns. Note that this affects only the database table; the command
374 won't touch your audio files on disk.
378 summary = print paths of deleted rows
381 summary = don't complain if nothing was removed
382 [option pathname-match]
384 summary = modify matching behaviour
386 Match a slash in the path only with a slash in pattern and not by an
387 asterisk (*) or a question mark (?) metacharacter, nor by a bracket
388 expression ([]) containing a slash (see fnmatch(3)).
392 purpose = remove attribute(s)
393 non-opts-name = pattern...
394 aux_info = AFS_READ | AFS_WRITE
396 Remove all attributes which match any given pattern. All information
397 about the removed attributes in the audio file table is lost.
401 purpose = activate a mood or a playlist
402 non-opts-name = specifier/name
403 aux_info = AFS_READ | AFS_WRITE
405 The specifier is either 'm' or 'p' to indicate whether a playlist or
406 a mood should be activated. Example:
410 activates the mood named 'foo'.
414 purpose = control paraslash senders
415 synopsis = [sender cmd [arguments]]
416 aux_info = VSS_READ | VSS_WRITE
418 Send a command to a specific sender. The following commands are
419 available, but not all senders support every command.
421 help, on, off, add, delete, allow, deny, status.
423 The help command prints the help text of the given sender. If no
424 command is given the list of available senders is shown.
428 para_client sender http help
433 purpose = set or unset attributes
434 synopsis = attribute{+|-}... pattern...
435 aux_info = AFS_READ | AFS_WRITE
437 Set ('+') or unset ('-') the given attributes for all audio files
438 matching the given pattern. Example:
440 setatt rock+ punk+ pop- '*foo.mp3'
442 sets the 'rock' and the 'punk' attribute and unsets the 'pop' attribute
443 of all files ending with 'foo.mp3'.
447 purpose = print server info
448 aux_info = NO_PERMISSION_REQUIRED
450 Show server and afs PID, number of connections, uptime and more.
454 purpose = print information about the current audio file
458 summary = number of times to show the status info
459 arg_info = required_arg
463 Exit after the status information has been shown num times. If this
464 option is not given, the command runs in an endless loop.
466 [option parser-friendly]
468 summary = enable parser-friendly output
470 Show status item identifiers as numerical values and prefix each
471 status item with its size in bytes.
475 purpose = stop playback
476 aux_info = VSS_READ | VSS_WRITE
478 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
479 the vss status flags, effectively stopping playback.
483 purpose = list active server tasks
484 aux_info = NO_PERMISSION_REQUIRED
486 For each task, print ID, status and name. This is mostly useful
491 purpose = ask the server to terminate
492 aux_info = VSS_READ | VSS_WRITE
494 Shut down the server. Instead of this command, you can also send
495 SIGINT or SIGTERM to the para_server process. It should never be
496 necessary to send SIGKILL.
500 purpose = manipulate the afs information of audio files
501 non-opts-name = pattern...
502 aux_info = AFS_READ | AFS_WRITE
504 This command modifies the afs info structure of all rows of the audio
505 file table whose path matches at least one of the given patters.
507 If at least one option is given which takes a number as its argument,
508 only those fields of the afs info structure are updated which
509 correspond to the given options while all other fields stay unmodified.
511 If no such option is given, the lastplayed field is set to the current
512 time and the value of the numplayed field is increased by one while
513 all other fields are left unchanged. This mimics what happens when
514 the virtual streaming system selects the file for streaming.
516 If the file is admissible for the current mood (or contained in the
517 current playlist), its score is recomputed according to the changed
522 summary = set the numplayed count manually
524 arg_info = required_arg
527 The numplayed count of an audio file is the number of times the file
528 was selected for streaming. It is one of the inputs to the scoring
529 function which determines the order in which admissible files are
532 The virtual streaming system increases this number automatically each
533 time it opens the file for streaming.
537 summary = set the lastplayed time manually
539 arg_info = required_arg
542 The lastplayed time of an audio file is the time when the file was
543 last opened for streaming.
545 Like the numplayed count, it is an input for the scoring function
546 and is updated automatically by the virtual streaming system.
548 The argument must be a number of seconds since the epoch. Example:
550 touch -l=$(date +%s) file
552 sets the lastplayed time of 'file' to the current time.
556 summary = set the image id
558 arg_info = required_arg
561 The afs info structure of each row of the audio file table contains
562 a slot for the image id of the audio file that corresponds to the
563 row. The image id stored in this slot refers to the key in the image
564 table that identifies the blob.
566 When a new audio file is added to the audio file table, its image
567 id starts out as zero, indicating that there is no image associated
568 with the file. Setting the image id to a non-zero number associates
569 the file with a particular blob of the image table, for example the
570 cover art of the album in jpg format.
574 summary = set the lyrics id
576 arg_info = required_arg
579 This option works just like --image-id, but sets the lyrics ID rather
584 summary = set the amplification value (0-255)
586 arg_info = required_arg
589 The amplification value of an audio file is a number which is stored
590 in the afs info structure.
592 The value determines the scaling factor by which the amplitude of
593 the decoded samples should be multiplied in order to normalize the
594 volume. A value of zero means no amplification, 64 means the amplitude
595 should be multiplied by a factor of two, 128 by three and so on.
597 The amp filter of para_audiod amplifies the volume according to
602 summary = explain what is being done
603 [option pathname-match]
605 summary = modify matching behaviour
607 Match a slash in the path only with a slash in pattern and not by an
608 asterisk (*) or a question mark (?) metacharacter, nor by a bracket
609 expression ([]) containing a slash (see fnmatch(3)).
613 purpose = print the git version string of para_server
614 aux_info = NO_PERMISSION_REQUIRED
617 summary = print detailed (multi-line) version text
619 m4_define(`BLOB_COMMANDS', `
621 purpose = remove `$1' blob(s)
622 non-opts-name = pattern...
623 aux_info = AFS_READ | AFS_WRITE
625 Remove all `$1' blobs which match any of the given patterns.
629 purpose = rename `$1' blob(s)
630 non-opts-name = source dest
631 aux_info = AFS_READ | AFS_WRITE
633 Rename `$1' source to dest. The command fails if the source `$1'
634 does not exist or if the destination `$1' already exists.
638 purpose = add a blob to the `$1' table
639 non-opts-name = `$1'_name
640 aux_info = AFS_READ | AFS_WRITE
642 Read from stdin and ask the audio file selector to create a blob in
643 the `$1' table. If the named blob already exists, it gets replaced
648 purpose = dump a `$1' blob to stdout
649 non-opts-name = `$1'_name
653 purpose = list blobs of type `$1' which match a pattern
654 non-opts-name = [pattern...]
657 Print the list of all blobs which match the given pattern. If no
658 pattern is given, the full list is printed.
662 summary = sort by identifier
664 The default is to sort alphabetically by name.
668 summary = long listing
670 Print identifier and name. The default is to print only the name.
674 summary = reverse sort order
677 BLOB_COMMANDS(`moods', `mood')
678 BLOB_COMMANDS(`playlist', `pl')
679 BLOB_COMMANDS(`image', `img')
680 BLOB_COMMANDS(`lyrics', `lyr')