1NYXMMS2(1) General Commands Manual NYXMMS2(1)
2
6 nycli - New Korving CLI
7
9 nyxmms2 [command] [arguments]
10
12 nycli is the new official CLI XMMS2 client, replacing xmms2(1).
13
15 INLINE MODE
16 If nycli is passed a command as an argument, that command will be
17 interpreted and nycli will exit after it is finished.
18 INTERACTIVE MODE
20 nycli features a powerful shell-like environment via readline that
21 allows the user to enter commands at a prompt and have the usual cool
22 features such as pathname expansion and line editing.
23
25 play
26 Start playback.
28 -h | --help
30 Display command help.
31 pause
33 Pause playback.
35 -h | --help
37 Display command help.
38 stop [-n <tracks> | -t <time>]
40 Stop playback.
42 -n | --tracks
44 Number of tracks after which to stop playback.
45 -t | --time
47 Duration after which to stop playback.
48 -h | --help
50 Display command help.
51 toggle
53 Toggle playback.
55 -h | --help
57 Display command help.
58 seek <time|offset>
60 Seek to a relative or absolute position.
62 -h | --help
64 Display command help.
65 status [-r <time>] [-f <format>]
67 Display playback status, either continuously or once.
69 -r | --refresh
71 Delay between each refresh of the status. If 0, the status is
72 only printed once (default).
73 -f | --format
75 Format string used to display status.
76 -h | --help
78 Display command help.
79 prev [offset]
81 Jump to previous song.
83 -h | --help
85 Display command help.
86 next [offset]
88 Jump to next song.
90 -h | --help
92 Display command help.
93 jump [-b] <pattern|positions>
95 Jump to the first media maching the pattern.
97 -b | --backward
99 Jump backward to the first media matching the pattern
100 -h | --help
102 Display command help.
103 info <pattern|positions>
105 Display all the properties for all media matching the pattern.
107 -h | --help
109 Display command help.
110 search [-p <name> | -c <name>] [-o <prop1[,prop2...]>] [-l
112 <prop1[,prop2...]>] <pattern>
113 Search and print all media matching the pattern. Search can be
115 restricted to a collection or a playlist by using the corresponding
116 flag.
117 -p | --playlist
119 Search in the given playlist.
120 -c | --collection
122 Search in the given collection.
123 -o | --order
125 List of properties to order by (prefix by '-' for reverse
126 ordering).
127 -l | --columns
129 List of properties to use as columns.
130 -h | --help
132 Display command help.
133 list [-p <name>] [pattern]
135 List the contents of a playlist (the active playlist by default).
137 If a pattern is provided, contents are further filtered and only
138 the matching media are displayed.
139 -p | --playlist
141 List the given playlist.
142 -h | --help
144 Display command help.
145 add [-f [-N] [-P]] [-p <playlist> | -c <collection>] [-n | -a <pos|off‐
147 set>] [pattern | paths]
148 Add the matching media or files to a playlist.
150 -f | --file
152 Treat the arguments as file paths instead of a pattern.
153 -P | --pls
155 Treat the files as playlist files (implies --file.)
156 -t | --pattern
158 Force treating arguments as pattern.
159 -N | --non-recursive
161 Do not add directories recursively.
162 -p | --playlist
164 Add to the given playlist.
165 -n | --next
167 Add after the current track.
168 -a | --at
170 Add media at a given position in the playlist, or at a given
171 offset from the current track.
172 -h | --help
174 Display command help.
175 remove [-p <playlist>] <pattern|positions>
177 Remove the matching media from a playlist.
179 -p | --playlist
181 Remove from the given playlist, instead of the active playlist.
182 -h | --help
184 Display command help.
185 move [-p <playlist>] [-n | -a <pos|offset>] <pattern|positions>
187 Move entries inside a playlist.
189 -p | --playlist
191 Playlist to act on.
192 -n | --next
194 Move the matching tracks after the current track.
195 -a | --at
197 Move the matching tracks by an offset or to a position.
198 -h | --help
200 Display command help.
201 exit
203 Exit the shell-like interface.
205 -h | --help
207 Display command help.
208 help [-a] [command]
210 List all commands, or help on one command.
212 -a | --alias
214 List aliases, or alias definition.
215 -h | --help
217 Display command help.
218
220 playlist list [-a] [pattern]
221 List all playlists.
223 -a | --all
225 Include hidden playlists.
226 -h | --help
228 Display command help.
229 playlist
231 No description
233 -h | --help
235 Display command help.
236 playlist switch <playlist>
238 Change the active playlist.
240 -h | --help
242 Display command help.
243 playlist create [-p <playlist>] <name>
245 Change the active playlist.
247 -p | --playlist
249 Copy the content of the playlist into the new playlist.
250 -h | --help
252 Display command help.
253 playlist rename [-f] [-p <playlist>] <newname>
255 Rename a playlist. By default, rename the active playlist.
257 -f | --force
259 Force the rename of the collection, overwrite an existing col‐
260 lection if needed.
261 -p | --playlist
263 Rename the given playlist.
264 -h | --help
266 Display command help.
267 playlist remove <playlist>
269 Remove the given playlist.
271 -h | --help
273 Display command help.
274 playlist clear [playlist]
276 Clear a playlist. By default, clear the active playlist.
278 -h | --help
280 Display command help.
281 playlist shuffle [playlist]
283 Shuffle a playlist. By default, shuffle the active playlist.
285 -h | --help
287 Display command help.
288 playlist sort [-o <order>] [playlist]
290 Sort a playlist. By default, sort the active playlist.
292 -o | --order
294 List of properties to sort by (prefix by '-' for reverse sort‐
295 ing).
296 -h | --help
298 Display command help.
299 playlist config [-t <type>] [-s <history>] [-u <upcoming>] [-i <coll>]
301 [playlist]
302 Configure a playlist by changing its type, attributes, etc. By
304 default, configure the active playlist.
305 -t | --type
307 Change the type of the playlist: list, queue, pshuffle.
308 -s | --history
310 Size of the history of played tracks (for queue, pshuffle).
311 -u | --upcoming
313 Number of upcoming tracks to maintain (for pshuffle).
314 -i | --input
316 Input collection for the playlist (for pshuffle). Default to
317 'All Media'.
318 -h | --help
320 Display command help.
321
323 collection list
324 List all collections.
326 -h | --help
328 Display command help.
329 collection
331 No description
333 -h | --help
335 Display command help.
336 collection show <collection>
338 Display a human-readable description of a collection.
340 -h | --help
342 Display command help.
343 collection create [-f] [-a | -e] [-c <collection>] <name> [pattern]
345 Create a new collection. If pattern is provided, it is used to
347 define the collection. Otherwise, the new collection contains the
348 whole media library.
349 -f | --force
351 Force creating of the collection, overwrite an existing collec‐
352 tion if needed.
353 -c | --collection
355 Copy an existing collection to the new one.
356 -e | --empty
358 Initialize an empty collection.
359 -h | --help
361 Display command help.
362 collection rename [-f] <oldname> <newname>
364 Rename a collection.
366 -f | --force
368 Force renaming of the collection, overwrite an existing collec‐
369 tion if needed.
370 -h | --help
372 Display command help.
373 collection remove <collection>
375 Remove a collection.
377 -h | --help
379 Display command help.
380 collection config <collection> [attrname [attrvalue]]
382 Get or set attributes for the given collection. If no attribute
384 name is provided, list all attributes. If only an attribute name
385 is provided, display the value of the attribute. If both attribute
386 name and value are provided, set the new value of the attribute.
387 -h | --help
389 Display command help.
390
392 server import [-N] <path>
393 Import new files into the media library. By default, directories
395 are imported recursively.
396 -N | --non-recursive
398 Do not import directories recursively.
399 -h | --help
401 Display command help.
402 server
404 No description
406 -h | --help
408 Display command help.
409 server remove <pattern>
411 Remove the matching media from the media library.
413 -h | --help
415 Display command help.
416 server rehash [pattern]
418 Rehash the media matched by the pattern, or the whole media library
420 if no pattern is provided
421 -h | --help
423 Display command help.
424 server config [name [value]]
426 Get or set configuration values. If no name or value is provided,
428 list all configuration values. If only a name is provided, display
429 the content of the corresponding configuration value. If both name
430 and a value are provided, set the new content of the configuration
431 value.
432 -h | --help
434 Display command help.
435 server property [-i | -s | -D] [-S] <mid> [name [value]]
437 Get or set properties for a given media. If no name or value is
439 provided, list all properties. If only a name is provided, display
440 the value of the property. If both a name and a value are pro‐
441 vided, set the new value of the property.
442 By default, set operations use client specific source and list,
444 display operations use source-preference. Use the --source option
445 to override this behaviour.
446 By default, the value will be used to determine whether it should
448 be saved as a string or an integer. Use the --int or --string flag
449 to override this behaviour.
450 -i | --int
452 Force the value to be treated as integer.
453 -s | --string
455 Force the value to be treated as a string.
456 -D | --delete
458 Delete the selected property.
459 -S | --source
461 Property source.
462 -h | --help
464 Display command help.
465 server plugins
467 List the plugins loaded in the server.
469 -h | --help
471 Display command help.
472 server volume [-c <name>] [value]
474 Get or set the audio volume (in a range of 0-100). If a value is
476 provided, set the new value of the volume. Otherwise, display the
477 current volume. By default, the command applies to all audio chan‐
478 nels. Use the --channel flag to override this behaviour.
479 -c | --channel
481 Get or set the volume only for one channel.
482 -h | --help
484 Display command help.
485 server stats
487 Display statistics about the server: uptime, version, size of the
489 medialib, etc
490 -h | --help
492 Display command help.
493 server sync
495 Force the saving of collections to the disk (otherwise only per‐
497 formed on shutdown)
498 -h | --help
500 Display command help.
501 server shutdown
503 Shutdown the server.
505 -h | --help
507 Display command help.
508
510 A list of command aliases are read from the configuration file in the
511 section [alias] at runtime. The syntax of nycli aliases are somewhat
512 similar to bash and other shells. An alias is defined by a list of
513 semi-colon separated commands and arguments. Parameter expansion is
514 supported (see EXPANSION below).
515 The default configuration includes the following aliases:
517 addpls
519 add -f -P $@
521 -h | --help
523 Display command help.
524 current
526 status -f $1
528 -h | --help
530 Display command help.
531 server kill
533 server shutdown
535 -h | --help
537 Display command help.
538 mute
540 server volume 0
542 -h | --help
544 Display command help.
545 repeat
547 seek 0
549 -h | --help
551 Display command help.
552 ls
554 list
556 -h | --help
558 Display command help.
559 quit
561 exit
563 -h | --help
565 Display command help.
566 clear
568 playlist clear
570 -h | --help
572 Display command help.
573 scap
575 stop ; playlist clear ; add $@ ; play
577 -h | --help
579 Display command help.
580 EXPANSION
582 Positional Parameters
583 An alias can use positional parameters, for example:
584 foo = add -f $1 $3
586 foo ctkoz.ogg and slre.ogg
588 Will result in:
590 add -f ctkoz.ogg slre.ogg
592 Special Parameters
594 $@
595 This expands to all parameters passed to the alias.
596
598 All control characters are interpreted as expected, including ANSI
599 escape sequences.
600 PROMPT
602 String to use as a prompt in INTERACTIVE MODE
603 SHELL_START_MESSAGE
605 Boolean, if true, nycli will display a greeting message and basic
606 help when started in INTERACTIVE MODE
607 SERVER_AUTOSTART
609 Boolean, if true nycli will attempt to start xmms2d(1) if it's not
610 running already.
611 AUTO_UNIQUE_COMPLETE
613 Boolean, complete an abbreviation of a command and it's arguments.
614 For example: `serv vol 42' will complete to `server volume 42'.
615 (Note: Abbreviations must be non-ambiguous)
616 PLAYLIST_MARKER
618 String to use to mark the current active entry in the playlist
619 GUESS_PLS
621 Boolean, try to guess if the URL is a playlist and add accordingly.
622 (Not reliable)
623 CLASSIC_LIST
625 Boolean, format list output similar to the classic cli.
626 CLASSIC_LIST_FORMAT
628 String to format classic list output with.
629 STATUS_FORMAT
631 String to format status output with.
632 HISTORY_FILE
634 File to save command history to.
635
637 $XDG_CONFIG_HOME/xmms2/clients/nycli.conf
638 The configuration file for nycli
639 $XDG_CACHE_HOME/xmms2/nyxmms2_history
641 Default command history file if HISTORY_FILE is unset.
642
644 Please report all bugs at http://bugs.xmms2.xmms.se
645
647 Igor Assis, Anders Waldenborg, Anthony Garcia, Sebastien Cevey, and
648 Jonne Lehtinen
649 See the AUTHORS file in the XMMS2 source distribution for more info.
651 The blame for this man page is on Anthony.
653 If you contributed and feel you should be listed here please send me a
655 mail.
656 NYXMMS2(1)