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 = jump N seconds forward or backward
58 aux_info = VSS_READ | VSS_WRITE
60 This sets the 'R' (reposition request) bit of the vss status flags
61 which enqueues a request to jump n seconds forwards or backwards.
67 jumps 30 seconds backwards.
72 purpose = list available commands or print command-specific help
73 non-opts-name = [command]
74 aux_info = NO_PERMISSION_REQUIRED
76 Without any arguments, help prints a list of available commands. When
77 called with a command name as first argument, it prints the description
82 purpose = reload config file, log file and user list
85 Reread the config file and the user list file, close and reopen the log
86 file, and ask the afs process to do the same. Sending the HUP signal
87 to the server process has the same effect as running this command.
91 purpose = initialize the database tables for the audio file selector
92 synopsis = [table_name...]
93 aux_info = AFS_READ | AFS_WRITE
95 When invoked without arguments, this command creates all
96 tables: audio_files, attributes, scores, moods, lyrics, images,
97 playlists. Otherwise only the given tables are created.
101 purpose = reposition the current stream
103 aux_info = VSS_READ | VSS_WRITE
105 Set the 'R' (reposition request) bit of the vss status flags and
106 enqueue a request to jump to n% of the current audio file, where 0 <=
111 purpose = list attributes
114 Print the list of all defined attributes which match the given
115 pattern. If no pattern is given, the full list is printed.
120 summary = sort attributes by id
122 The default is to sort alphabetically by name.
124 Attributes are internally represented as an 64 bit array. The attribute
125 id is the bit number in this array.
129 summary = print long listing
131 The long listing prints the attribute id in addition to the name of
132 the attribute. The id is printed as a decimal number and is separated
133 from the name by a tab character.
137 summary = reverse sort order
140 purpose = rename an attribute
141 synopsis = source dest
142 aux_info = AFS_READ | AFS_WRITE
144 Rename the attribute given by the first argument to the destination
145 given by the second argument. It is an error if the destination
150 purpose = close the stream and start to stream the next audio file
151 aux_info = VSS_READ | VSS_WRITE
153 Set the 'N' (next audio file) bit of the vss status flags. This
154 instructs the server to close the current stream, if any. The 'P'
155 (playing) bit is not modified by this command. If it is on, playing
156 continues with the next audio file.
158 This command is equivalent to stop if paused, and has no effect
163 purpose = stop playing after current audio file
164 aux_info = VSS_READ | VSS_WRITE
166 Set the 'O' (no more) bit of the vss status flags which asks
167 para_server to clear the 'P' (playing) bit after the 'N' (next audio
168 file) bit transitions from off to on (because the end of the current
169 audio file is reached). Use this command instead of stop if you don't
174 purpose = suspend the current stream
175 aux_info = VSS_READ | VSS_WRITE
177 Clear the 'P' (playing) bit of the vss status flags.
181 purpose = start or resume playback
182 aux_info = VSS_READ | VSS_WRITE
184 Set the 'P' (playing) bit of the vss status flags.
188 purpose = control paraslash senders
189 synopsis = [sender cmd [arguments]]
190 aux_info = VSS_READ | VSS_WRITE
192 Send a command to a specific sender. The following commands are
193 available, but not all senders support every command.
195 help, on, off, add, delete, allow, deny, status.
197 The help command prints the help text of the given sender. If no
198 command is given the list of available senders is shown.
202 para_client sender http help
207 purpose = set or unset attributes
208 synopsis = attribute{+|-}... pattern...
209 aux_info = AFS_READ | AFS_WRITE
211 Set ('+') or unset ('-') the given attributes for all audio files
212 matching the given pattern. Example:
214 setatt rock+ punk+ pop- '*foo.mp3'
216 sets the 'rock' and the 'punk' attribute and unsets the 'pop' attribute
217 of all files ending with 'foo.mp3'.
221 purpose = print server info
222 aux_info = NO_PERMISSION_REQUIRED
224 Show server and afs PID, number of connections, uptime and more.
228 purpose = print information about the current audio file
232 summary = number of times to show the status info
233 arg_info = required_arg
237 Exit after the status information has been shown num times. If this
238 option is not given, the command runs in an endless loop.
240 [option parser-friendly]
242 summary = enable parser-friendly output
244 Show status item identifiers as numerical values and prefix each
245 status item with its size in bytes.
249 purpose = stop playback
250 aux_info = VSS_READ | VSS_WRITE
252 Clear the 'P' (playing) bit and set the 'N' (next audio file) bit of
253 the vss status flags, effectively stopping playback.
257 purpose = list active server tasks
258 aux_info = NO_PERMISSION_REQUIRED
260 For each task, print ID, status and name. This is mostly useful
265 purpose = ask the server to terminate
266 aux_info = VSS_READ | VSS_WRITE
268 Shut down the server. Instead of this command, you can also send
269 SIGINT or SIGTERM to the para_server process. It should never be
270 necessary to send SIGKILL.
274 purpose = print the git version string of para_server
275 aux_info = NO_PERMISSION_REQUIRED
278 summary = print detailed (multi-line) version text