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 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.
151 m4_include(`long-help.m4')
154 purpose = reload config file, log file and user list
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.
163 purpose = initialize the database tables for the audio file selector
164 synopsis = [table_name...]
165 aux_info = AFS_READ | AFS_WRITE
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.
173 purpose = reposition the current stream
175 aux_info = VSS_READ | VSS_WRITE
177 Set the 'R' (reposition request) bit of the vss status flags and
178 enqueue a request to jump to n% of the current audio file, where 0 <=
183 purpose = list audio files which match a pattern
184 non-opts-name = [pattern...]
187 If no pattern is given, all files are listed. Otherwise, the command
188 lists all files of the audio file table whose path matches at least
189 one of the given patterns.
191 [option listing-mode]
193 summary = use alternative output format
195 arg_info = optional_arg
199 The optional mode argument is either a single character or a word
200 according to the following list.
202 short (s). List only the path or basename (last component of the path),
203 depending on whether -p is also given. This listing mode acts as if
204 --listing-mode had not been given.
206 long (l). Show detailed information. This is the default if no argument
207 to --listing-mode is supplied.
209 verbose (v). Multi-line output, one row per data field stored in the
212 parser-friendly (p). Like verbose listing mode, but use numerical
213 values for the names of the output fields and prefix each line with
216 mbox (m). Generate output suitable to be viewed with a mail
217 program. One "mail" per matching audio file.
219 chunk-table (c). Print path (or basename, depending on whether -p is
220 also given), chunk time and chunk offsets.
225 summary = list and match basenames only
227 Print only the basename of each matching file and match only the
228 basenames of the paths stored in the audio file table against the
229 given patterns. The default is to print and match the full path.
233 summary = list only admissible files
235 List only files which are admissible with respect to the current mood
240 summary = reverse sort order
243 summary = print dates as seconds after the epoch
246 summary = change sort order
248 arg_info = required_arg
252 The sort order must be given as an required argument. Like for
253 --listing-mode, this argument may either be a single character or a
254 word, according to the following list.
256 path (p). Sort alphabetically by path or basename, depending on
257 whether -b is given. This is the default if --sort is not given.
259 score (s). Iterate over the entries of the score table, rather than
260 the audio file table. This sort order implies --admissible, since
261 the score table contains only admissible files.
283 If --sort is not given, path sort is implied.
287 purpose = list attributes
290 Print the list of all defined attributes which match the given
291 pattern. If no pattern is given, the full list is printed.
296 summary = sort attributes by id
298 The default is to sort alphabetically by name.
300 Attributes are internally represented as an 64 bit array. The attribute
301 id is the bit number in this array.
305 summary = print long listing
307 The long listing prints the attribute id in addition to the name of
308 the attribute. The id is printed as a decimal number and is separated
309 from the name by a tab character.
313 summary = reverse sort order
316 purpose = rename an attribute
317 synopsis = source dest
318 aux_info = AFS_READ | AFS_WRITE
320 Rename the attribute given by the first argument to the destination
321 given by the second argument. It is an error if the destination
326 purpose = close the stream and start to stream the next audio file
327 aux_info = VSS_READ | VSS_WRITE
329 Set the 'N' (next audio file) bit of the vss status flags. This
330 instructs the server to close the current stream, if any. The 'P'
331 (playing) bit is not modified by this command. If it is on, playing
332 continues with the next audio file.
334 This command is equivalent to stop if paused, and has no effect
339 purpose = stop playing after current audio file
340 aux_info = VSS_READ | VSS_WRITE
342 Set the 'O' (no more) bit of the vss status flags which asks
343 para_server to clear the 'P' (playing) bit after the 'N' (next audio
344 file) bit transitions from off to on (because the end of the current
345 audio file is reached). Use this command instead of stop if you don't
350 purpose = suspend the current stream
351 aux_info = VSS_READ | VSS_WRITE
353 Clear the 'P' (playing) bit of the vss status flags.
357 purpose = start or resume playback
358 aux_info = VSS_READ | VSS_WRITE
360 Set the 'P' (playing) bit of the vss status flags.
364 purpose = remove rows from the audio file table
365 non-opts-name = pattern...
366 aux_info = AFS_READ | AFS_WRITE
368 Remove all rows of the audio file table which match any of the given
369 patterns. Note that this affects only the database table; the command
370 won't touch your audio files on disk.
374 summary = print paths of deleted rows
377 summary = don't complain if nothing was removed
378 [option pathname-match]
380 summary = modify matching behaviour
382 Match a slash in the path only with a slash in pattern and not by an
383 asterisk (*) or a question mark (?) metacharacter, nor by a bracket
384 expression ([]) containing a slash (see fnmatch(3)).
388 purpose = remove attribute(s)
389 non-opts-name = pattern...
390 aux_info = AFS_READ | AFS_WRITE
392 Remove all attributes which match any given pattern. All information
393 about the removed attributes in the audio file table is lost.
397 purpose = activate a mood or a playlist
398 non-opts-name = specifier/name
399 aux_info = AFS_READ | AFS_WRITE
401 The specifier is either 'm' or 'p' to indicate whether a playlist or
402 a mood should be activated. Example:
406 activates the mood named 'foo'.
410 purpose = control paraslash senders
411 synopsis = [sender subcmd [arguments]]
412 aux_info = VSS_READ | VSS_WRITE
414 This command executes a subcommand for the given sender, which is
415 one of "http", "dccp" or "udp". Various subcommands exist to print
416 information about the sender, to activate and deactivate the sender,
417 and to change the access permissions and targets. The following
418 subcommands are available:
420 help, status, on, off, allow, deny, add, delete.
422 All senders support the first four commands. The "allow" and "deny"
423 commands are supported by the http and the dccp senders while "add"
424 and "delete" are only supported by the udp sender. If no sender is
425 given, the list of available senders is shown.
429 Get help for the udp sender (contains further examples):
433 Show the access control list and the number of connected clients of
438 Senders may be activated and deactivated independently of each
439 other. The following command switches off the dccp sender:
443 Add an UDP unicast for a client to the target list of the UDP sender:
445 sender udp add client.foo.org
447 Start UDP multicast, using the default multicast address:
449 sender udp add 224.0.1.38
454 purpose = set or unset attributes
455 synopsis = attribute{+|-}... pattern...
456 aux_info = AFS_READ | AFS_WRITE
458 Set ('+') or unset ('-') the given attributes for all audio files
459 matching the given pattern. Example:
461 setatt rock+ punk+ pop- '*foo.mp3'
463 sets the 'rock' and the 'punk' attribute and unsets the 'pop' attribute
464 of all files ending with 'foo.mp3'.
468 purpose = print server info
469 aux_info = NO_PERMISSION_REQUIRED
471 Show server and afs PID, number of connections, uptime and more.
475 purpose = print information about the current audio file
479 summary = number of times to show the status info
480 arg_info = required_arg
484 Exit after the status information has been shown num times. If this
485 option is not given, the command runs in an endless loop.
487 [option parser-friendly]
489 summary = enable parser-friendly output
491 Show status item identifiers as numerical values and prefix each
492 status item with its size in bytes.
496 purpose = stop playback
497 aux_info = VSS_READ | VSS_WRITE
499 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
500 the vss status flags, effectively stopping playback.
504 purpose = list active server tasks (deprecated)
505 aux_info = NO_PERMISSION_REQUIRED
507 This used to print the ID, the status and the name of each task,
508 mainly for debugging purposes. As of version 0.6.2, the subcommand
509 prints nothing. It will be removed in 0.7.0. Don't use.
513 purpose = ask the server to terminate
514 aux_info = VSS_READ | VSS_WRITE
516 Shut down the server. Instead of this command, you can also send
517 SIGINT or SIGTERM to the para_server process. It should never be
518 necessary to send SIGKILL.
522 purpose = manipulate the afs information of audio files
523 non-opts-name = pattern...
524 aux_info = AFS_READ | AFS_WRITE
526 This command modifies the afs info structure of all rows of the audio
527 file table whose path matches at least one of the given patters.
529 If at least one option is given which takes a number as its argument,
530 only those fields of the afs info structure are updated which
531 correspond to the given options while all other fields stay unmodified.
533 If no such option is given, the lastplayed field is set to the current
534 time and the value of the numplayed field is increased by one while
535 all other fields are left unchanged. This mimics what happens when
536 the virtual streaming system selects the file for streaming.
538 If the file is admissible for the current mood (or contained in the
539 current playlist), its score is recomputed according to the changed
544 summary = set the numplayed count manually
546 arg_info = required_arg
549 The numplayed count of an audio file is the number of times the file
550 was selected for streaming. It is one of the inputs to the scoring
551 function which determines the order in which admissible files are
554 The virtual streaming system increases this number automatically each
555 time it opens the file for streaming.
559 summary = set the lastplayed time manually
561 arg_info = required_arg
564 The lastplayed time of an audio file is the time when the file was
565 last opened for streaming.
567 Like the numplayed count, it is an input for the scoring function
568 and is updated automatically by the virtual streaming system.
570 The argument must be a number of seconds since the epoch. Example:
572 touch -l=$(date +%s) file
574 sets the lastplayed time of 'file' to the current time.
578 summary = set the image id
580 arg_info = required_arg
583 The afs info structure of each row of the audio file table contains
584 a slot for the image id of the audio file that corresponds to the
585 row. The image id stored in this slot refers to the key in the image
586 table that identifies the blob.
588 When a new audio file is added to the audio file table, its image
589 id starts out as zero, indicating that there is no image associated
590 with the file. Setting the image id to a non-zero number associates
591 the file with a particular blob of the image table, for example the
592 cover art of the album in jpg format.
596 summary = set the lyrics id
598 arg_info = required_arg
601 This option works just like --image-id, but sets the lyrics ID rather
606 summary = set the amplification value (0-255)
608 arg_info = required_arg
611 The amplification value of an audio file is a number which is stored
612 in the afs info structure.
614 The value determines the scaling factor by which the amplitude of
615 the decoded samples should be multiplied in order to normalize the
616 volume. A value of zero means no amplification, 64 means the amplitude
617 should be multiplied by a factor of two, 128 by three and so on.
619 The amp filter of para_audiod amplifies the volume according to
624 summary = explain what is being done
625 [option pathname-match]
627 summary = modify matching behaviour
629 Match a slash in the path only with a slash in pattern and not by an
630 asterisk (*) or a question mark (?) metacharacter, nor by a bracket
631 expression ([]) containing a slash (see fnmatch(3)).
635 purpose = print the git version string of para_server
636 aux_info = NO_PERMISSION_REQUIRED
639 summary = print detailed (multi-line) version text
641 m4_define(`BLOB_COMMANDS', `
643 purpose = remove `$1' blob(s)
644 non-opts-name = pattern...
645 aux_info = AFS_READ | AFS_WRITE
647 Remove all `$1' blobs which match any of the given patterns.
651 purpose = rename `$1' blob(s)
652 non-opts-name = source dest
653 aux_info = AFS_READ | AFS_WRITE
655 Rename `$1' source to dest. The command fails if the source `$1'
656 does not exist or if the destination `$1' already exists.
660 purpose = add a blob to the `$1' table
661 non-opts-name = `$1'_name
662 aux_info = AFS_READ | AFS_WRITE
664 Read from stdin and ask the audio file selector to create a blob in
665 the `$1' table. If the named blob already exists, it gets replaced
670 purpose = dump a `$1' blob to stdout
671 non-opts-name = `$1'_name
675 purpose = list blobs of type `$1' which match a pattern
676 non-opts-name = [pattern...]
679 Print the list of all blobs which match the given pattern. If no
680 pattern is given, the full list is printed.
684 summary = sort by identifier
686 The default is to sort alphabetically by name.
690 summary = long listing
692 Print identifier and name. The default is to print only the name.
696 summary = reverse sort order
699 BLOB_COMMANDS(`moods', `mood')
700 BLOB_COMMANDS(`playlist', `pl')
701 BLOB_COMMANDS(`image', `img')
702 BLOB_COMMANDS(`lyrics', `lyr')