| But the fact remains | that xmms2 is up for removal, and nyxmms2 is to replace it. | | http://git.xmms.se/cgit.cgi/xmms2/xmms2-devel/tree/src/clients/nycli/nyxmms2.1 | | Is the man-page you want to update.
Here are the patches against: f204e0d 2011-03-24 OTHER: Add precompiled C-files if cython is missing. git clone git://git.xmms.se/xmms2/xmms2-devel.git Notes: - Order items alphabetically - Removed EOL whitespaces. - Converted "-h | --help " etc. to use comma as in "-h, --help". See GNU cp(1), mv(1) etc pages that use similar syntax to list options. Thanks for maintaining xmms2 Jari
>From 0402f8646c683a1e400b7cad69645ae0c4d4c8bd Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aa...@cante.net> Date: Sun, 3 Apr 2011 17:34:03 +0300 Subject: [PATCH 1/6] src/clients/nycli/nyxmms2.1: (GENERAL COMMANDS): Order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aa...@cante.net> --- src/clients/nycli/nyxmms2.1 | 280 ++++++++++++++++++++++--------------------- 1 files changed, 141 insertions(+), 139 deletions(-) diff --git a/src/clients/nycli/nyxmms2.1 b/src/clients/nycli/nyxmms2.1 index 20f720e..ca0a66f 100644 --- a/src/clients/nycli/nyxmms2.1 +++ b/src/clients/nycli/nyxmms2.1 @@ -49,59 +49,65 @@ features a powerful shell-like environment via readline that allows the user to enter commands at a prompt and have the usual cool features such as pathname expansion and line editing. .SH GENERAL COMMANDS + .TP -\fBplay\fR +\fBadd\fR [\-f [\-N] [\-P]] [\-p <playlist>, \-c <collection>] [\-n, \-a <pos|offset>] [pattern, paths] .PP .RS 4 -Start playback. +Add the matching media or files to a playlist. .RE .PP .RS 4 -\-h | \-\-help +\-f, \-\-file .RE .RS 8 -Display command help. +Treat the arguments as file paths instead of a pattern. .RE .PP - -.TP -\fBpause\fR -.PP .RS 4 -Pause playback. +\-P, \-\-pls +.RE +.RS 8 +Treat the files as playlist files (implies \-\-file.) .RE .PP .RS 4 -\-h | \-\-help +\-t, \-\-pattern .RE .RS 8 -Display command help. +Force treating arguments as pattern. .RE .PP - -.TP -\fBstop\fR [\-n <tracks> | \-t <time>] +.RS 4 +\-N, \-\-non-recursive +.RE +.RS 8 +Do not add directories recursively. +.RE .PP .RS 4 -Stop playback. +\-p, \-\-playlist +.RE +.RS 8 +Add to the given playlist. .RE .PP .RS 4 -\-n | \-\-tracks +\-n, \-\-next .RE .RS 8 -Number of tracks after which to stop playback. +Add after the current track. .RE .PP .RS 4 -\-t | \-\-time +\-a, \-\-at .RE .RS 8 -Duration after which to stop playback. +Add media at a given position in the playlist, or at a given offset from the current track. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -109,14 +115,14 @@ Display command help. .PP .TP -\fBtoggle\fR +\fBexit\fR .PP .RS 4 -Toggle playback. +Exit the shell-like interface. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -124,14 +130,21 @@ Display command help. .PP .TP -\fBseek\fR <time|offset> +\fBhelp\fR [\-a] [command] .PP .RS 4 -Seek to a relative or absolute position. +List all commands, or help on one command. .RE .PP .RS 4 -\-h | \-\-help +\-a, \-\-alias +.RE +.RS 8 +List aliases, or alias definition. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. @@ -139,28 +152,36 @@ Display command help. .PP .TP -\fBstatus\fR [\-r <time>] [\-f <format>] +\fBinfo\fR <pattern|positions> .PP .RS 4 -Display playback status, either continuously or once. +Display all the properties for all media matching the pattern. .RE .PP .RS 4 -\-r | \-\-refresh +\-h, \-\-help .RE .RS 8 -Delay between each refresh of the status. If 0, the status is only printed once (default). +Display command help. +.RE +.PP + +.TP +\fBjump\fR [\-b] <pattern|positions> +.PP +.RS 4 +Jump to the first media maching the pattern. .RE .PP .RS 4 -\-f | \-\-format +\-b, \-\-backward .RE .RS 8 -Format string used to display status. +Jump backward to the first media matching the pattern .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -168,14 +189,23 @@ Display command help. .PP .TP -\fBprev\fR [offset] +\fBlist\fR [\-p <name>] [pattern] .PP .RS 4 -Jump to previous song. +List the contents of a playlist (the active playlist by default). If a +pattern is provided, contents are further filtered and only the matching +media are displayed. .RE .PP .RS 4 -\-h | \-\-help +\-p, \-\-playlist +.RE +.RS 8 +List the given playlist. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. @@ -183,36 +213,35 @@ Display command help. .PP .TP -\fBnext\fR [offset] +\fBmove\fR [\-p <playlist>] [\-n, \-a <pos|offset>] <pattern|positions> .PP .RS 4 -Jump to next song. +Move entries inside a playlist. .RE .PP .RS 4 -\-h | \-\-help +\-p, \-\-playlist .RE .RS 8 -Display command help. +Playlist to act on. .RE .PP - -.TP -\fBjump\fR [\-b] <pattern|positions> -.PP .RS 4 -Jump to the first media maching the pattern. +\-n, \-\-next +.RE +.RS 8 +Move the matching tracks after the current track. .RE .PP .RS 4 -\-b | \-\-backward +\-a, \-\-at .RE .RS 8 -Jump backward to the first media matching the pattern +Move the matching tracks by an offset or to a position. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -220,14 +249,14 @@ Display command help. .PP .TP -\fBinfo\fR <pattern|positions> +\fBnext\fR [offset] .PP .RS 4 -Display all the properties for all media matching the pattern. +Jump to next song. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -235,43 +264,44 @@ Display command help. .PP .TP -\fBsearch\fR [\-p <name> | \-c <name>] [\-o <prop1[,prop2...]>] [\-l <prop1[,prop2...]>] <pattern> +\fBpause\fR .PP .RS 4 -Search and print all media matching the pattern. Search can be restricted -to a collection or a playlist by using the corresponding flag. +Pause playback. .RE .PP .RS 4 -\-p | \-\-playlist +\-h, \-\-help .RE .RS 8 -Search in the given playlist. +Display command help. .RE .PP + +.TP +\fBplay\fR +.PP .RS 4 -\-c | \-\-collection -.RE -.RS 8 -Search in the given collection. +Start playback. .RE .PP .RS 4 -\-o | \-\-order +\-h, \-\-help .RE .RS 8 -List of properties to order by (prefix by '-' for reverse ordering). +Display command help. .RE .PP + +.TP +\fBprev\fR [offset] +.PP .RS 4 -\-l | \-\-columns -.RE -.RS 8 -List of properties to use as columns. +Jump to previous song. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -279,23 +309,21 @@ Display command help. .PP .TP -\fBlist\fR [\-p <name>] [pattern] +\fBremove\fR [\-p <playlist>] <pattern|positions> .PP .RS 4 -List the contents of a playlist (the active playlist by default). If a -pattern is provided, contents are further filtered and only the matching -media are displayed. +Remove the matching media from a playlist. .RE .PP .RS 4 -\-p | \-\-playlist +\-p, \-\-playlist .RE .RS 8 -List the given playlist. +Remove from the given playlist, instead of the active playlist. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -303,63 +331,72 @@ Display command help. .PP .TP -\fBadd\fR [\-f [\-N] [\-P]] [\-p <playlist> | \-c <collection>] [\-n | \-a <pos|offset>] [pattern | paths] +\fBstatus\fR [\-r <time>] [\-f <format>] .PP .RS 4 -Add the matching media or files to a playlist. +Display playback status, either continuously or once. .RE .PP .RS 4 -\-f | \-\-file +\-r, \-\-refresh .RE .RS 8 -Treat the arguments as file paths instead of a pattern. +Delay between each refresh of the status. If 0, the status is only printed once (default). .RE .PP .RS 4 -\-P | \-\-pls +\-f, \-\-format .RE .RS 8 -Treat the files as playlist files (implies \-\-file.) +Format string used to display status. .RE .PP .RS 4 -\-t | \-\-pattern +\-h, \-\-help .RE .RS 8 -Force treating arguments as pattern. +Display command help. +.RE +.PP + +.TP +\fBsearch\fR [\-p <name>, \-c <name>] [\-o <prop1[,prop2...]>] [\-l <prop1[,prop2...]>] <pattern> +.PP +.RS 4 +Search and print all media matching the pattern. Search can be restricted +to a collection or a playlist by using the corresponding flag. .RE .PP .RS 4 -\-N | \-\-non-recursive +\-p, \-\-playlist .RE .RS 8 -Do not add directories recursively. +Search in the given playlist. .RE .PP .RS 4 -\-p | \-\-playlist +\-c, \-\-collection .RE .RS 8 -Add to the given playlist. +Search in the given collection. .RE .PP .RS 4 -\-n | \-\-next +\-o, \-\-order .RE .RS 8 -Add after the current track. +List of properties to order by (prefix by '-' for reverse ordering). .RE .PP .RS 4 -\-a | \-\-at +\-l, \-\-columns .RE .RS 8 -Add media at a given position in the playlist, or at a given offset from the current track. +List of properties to use as columns. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -367,21 +404,14 @@ Display command help. .PP .TP -\fBremove\fR [\-p <playlist>] <pattern|positions> -.PP -.RS 4 -Remove the matching media from a playlist. -.RE +\fBseek\fR <time|offset> .PP .RS 4 -\-p | \-\-playlist -.RE -.RS 8 -Remove from the given playlist, instead of the active playlist. +Seek to a relative or absolute position. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -389,35 +419,28 @@ Display command help. .PP .TP -\fBmove\fR [\-p <playlist>] [\-n | \-a <pos|offset>] <pattern|positions> +\fBstop\fR [\-n <tracks>, \-t <time>] .PP .RS 4 -Move entries inside a playlist. -.RE -.PP -.RS 4 -\-p | \-\-playlist -.RE -.RS 8 -Playlist to act on. +Stop playback. .RE .PP .RS 4 -\-n | \-\-next +\-n, \-\-tracks .RE .RS 8 -Move the matching tracks after the current track. +Number of tracks after which to stop playback. .RE .PP .RS 4 -\-a | \-\-at +\-t, \-\-time .RE .RS 8 -Move the matching tracks by an offset or to a position. +Duration after which to stop playback. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -425,41 +448,20 @@ Display command help. .PP .TP -\fBexit\fR +\fBtoggle\fR .PP .RS 4 -Exit the shell-like interface. +Toggle playback. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. .RE .PP -.TP -\fBhelp\fR [\-a] [command] -.PP -.RS 4 -List all commands, or help on one command. -.RE -.PP -.RS 4 -\-a | \-\-alias -.RE -.RS 8 -List aliases, or alias definition. -.RE -.PP -.RS 4 -\-h | \-\-help -.RE -.RS 8 -Display command help. -.RE -.PP .SH PLAYLIST COMMANDS .TP \fBplaylist list\fR [\-a] [pattern] -- 1.7.4.1
>From e37ce6851f71e295bb44847d55d71f6ac28bf7a2 Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aa...@cante.net> Date: Sun, 3 Apr 2011 17:37:45 +0300 Subject: [PATCH 2/6] src/clients/nycli/nyxmms2.1: (PLAYLIST COMMANDS): Order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aa...@cante.net> --- src/clients/nycli/nyxmms2.1 | 136 ++++++++++++++++++++++--------------------- 1 files changed, 69 insertions(+), 67 deletions(-) diff --git a/src/clients/nycli/nyxmms2.1 b/src/clients/nycli/nyxmms2.1 index ca0a66f..d3627e7 100644 --- a/src/clients/nycli/nyxmms2.1 +++ b/src/clients/nycli/nyxmms2.1 @@ -463,22 +463,31 @@ Display command help. .PP .SH PLAYLIST COMMANDS + .TP -\fBplaylist list\fR [\-a] [pattern] +\fBplaylist\fR .PP .RS 4 -List all playlists. +No description .RE .PP .RS 4 -\-a | \-\-all +\-h, \-\-help .RE .RS 8 -Include hidden playlists. +Display command help. .RE .PP + +.TP +\fBplaylist clear\fR [playlist] +.PP .RS 4 -\-h | \-\-help +Clear a playlist. By default, clear the active playlist. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. @@ -486,29 +495,43 @@ Display command help. .PP .TP -\fBplaylist\fR +\fBplaylist config\fR [\-t <type>] [\-s <history>] [\-u <upcoming>] [\-i <coll>] [playlist] .PP .RS 4 -No description +Configure a playlist by changing its type, attributes, etc. +By default, configure the active playlist. .RE .PP .RS 4 -\-h | \-\-help +\-t, \-\-type .RE .RS 8 -Display command help. +Change the type of the playlist: list, queue, pshuffle. .RE .PP - -.TP -\fBplaylist switch\fR <playlist> +.RS 4 +\-s, \-\-history +.RE +.RS 8 +Size of the history of played tracks (for queue, pshuffle). +.RE .PP .RS 4 -Change the active playlist. +\-u, \-\-upcoming +.RE +.RS 8 +Number of upcoming tracks to maintain (for pshuffle). .RE .PP .RS 4 -\-h | \-\-help +\-i, \-\-input +.RE +.RS 8 +Input collection for the playlist (for pshuffle). Default to 'All Media'. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. @@ -523,14 +546,14 @@ Change the active playlist. .RE .PP .RS 4 -\-p | \-\-playlist +\-p, \-\-playlist .RE .RS 8 Copy the content of the playlist into the new playlist. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -538,28 +561,21 @@ Display command help. .PP .TP -\fBplaylist rename\fR [\-f] [\-p <playlist>] <newname> -.PP -.RS 4 -Rename a playlist. By default, rename the active playlist. -.RE +\fBplaylist list\fR [\-a] [pattern] .PP .RS 4 -\-f | \-\-force -.RE -.RS 8 -Force the rename of the collection, overwrite an existing collection if needed. +List all playlists. .RE .PP .RS 4 -\-p | \-\-playlist +\-a, \-\-all .RE .RS 8 -Rename the given playlist. +Include hidden playlists. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -574,7 +590,7 @@ Remove the given playlist. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -582,29 +598,28 @@ Display command help. .PP .TP -\fBplaylist clear\fR [playlist] +\fBplaylist rename\fR [\-f] [\-p <playlist>] <newname> .PP .RS 4 -Clear a playlist. By default, clear the active playlist. +Rename a playlist. By default, rename the active playlist. .RE .PP .RS 4 -\-h | \-\-help +\-f, \-\-force .RE .RS 8 -Display command help. +Force the rename of the collection, overwrite an existing collection if needed. .RE .PP - -.TP -\fBplaylist shuffle\fR [playlist] -.PP .RS 4 -Shuffle a playlist. By default, shuffle the active playlist. +\-p, \-\-playlist +.RE +.RS 8 +Rename the given playlist. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -612,21 +627,14 @@ Display command help. .PP .TP -\fBplaylist sort\fR [\-o <order>] [playlist] -.PP -.RS 4 -Sort a playlist. By default, sort the active playlist. -.RE +\fBplaylist shuffle\fR [playlist] .PP .RS 4 -\-o | \-\-order -.RE -.RS 8 -List of properties to sort by (prefix by '-' for reverse sorting). +Shuffle a playlist. By default, shuffle the active playlist. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -634,48 +642,42 @@ Display command help. .PP .TP -\fBplaylist config\fR [\-t <type>] [\-s <history>] [\-u <upcoming>] [\-i <coll>] [playlist] +\fBplaylist sort\fR [\-o <order>] [playlist] .PP .RS 4 -Configure a playlist by changing its type, attributes, etc. -By default, configure the active playlist. +Sort a playlist. By default, sort the active playlist. .RE .PP .RS 4 -\-t | \-\-type +\-o, \-\-order .RE .RS 8 -Change the type of the playlist: list, queue, pshuffle. +List of properties to sort by (prefix by '-' for reverse sorting). .RE .PP .RS 4 -\-s | \-\-history +\-h, \-\-help .RE .RS 8 -Size of the history of played tracks (for queue, pshuffle). +Display command help. .RE .PP -.RS 4 -\-u | \-\-upcoming -.RE -.RS 8 -Number of upcoming tracks to maintain (for pshuffle). -.RE + +.TP +\fBplaylist switch\fR <playlist> .PP .RS 4 -\-i | \-\-input -.RE -.RS 8 -Input collection for the playlist (for pshuffle). Default to 'All Media'. +Change the active playlist. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. .RE .PP + .SH COLLECTION COMMANDS .TP \fBcollection list\fR -- 1.7.4.1
>From b3aa73e661b38e991c7dc636d172906aa7582379 Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aa...@cante.net> Date: Sun, 3 Apr 2011 17:39:08 +0300 Subject: [PATCH 3/6] src/clients/nycli/nyxmms2.1: (COLLECTION COMMANDS): Order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aa...@cante.net> --- src/clients/nycli/nyxmms2.1 | 72 ++++++++++++++++++++++--------------------- 1 files changed, 37 insertions(+), 35 deletions(-) diff --git a/src/clients/nycli/nyxmms2.1 b/src/clients/nycli/nyxmms2.1 index d3627e7..f13c4dc 100644 --- a/src/clients/nycli/nyxmms2.1 +++ b/src/clients/nycli/nyxmms2.1 @@ -679,20 +679,6 @@ Display command help. .PP .SH COLLECTION COMMANDS -.TP -\fBcollection list\fR -.PP -.RS 4 -List all collections. -.RE -.PP -.RS 4 -\-h | \-\-help -.RE -.RS 8 -Display command help. -.RE -.PP .TP \fBcollection\fR @@ -702,7 +688,7 @@ No description .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -710,14 +696,17 @@ Display command help. .PP .TP -\fBcollection show\fR <collection> +\fBcollection config\fR <collection> [attrname [attrvalue]] .PP .RS 4 -Display a human-readable description of a collection. +Get or set attributes for the given collection. +If no attribute name is provided, list all attributes. +If only an attribute name is provided, display the value of the attribute. +If both attribute name and value are provided, set the new value of the attribute. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -725,7 +714,7 @@ Display command help. .PP .TP -\fBcollection create\fR [\-f] [\-a | \-e] [\-c <collection>] <name> [pattern] +\fBcollection create\fR [\-f] [\-a, \-e] [\-c <collection>] <name> [pattern] .PP .RS 4 Create a new collection. @@ -734,28 +723,28 @@ Otherwise, the new collection contains the whole media library. .RE .PP .RS 4 -\-f | \-\-force +\-f, \-\-force .RE .RS 8 Force creating of the collection, overwrite an existing collection if needed. .RE .PP .RS 4 -\-c | \-\-collection +\-c, \-\-collection .RE .RS 8 Copy an existing collection to the new one. .RE .PP .RS 4 -\-e | \-\-empty +\-e, \-\-empty .RE .RS 8 Initialize an empty collection. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -763,21 +752,29 @@ Display command help. .PP .TP -\fBcollection rename\fR [\-f] <oldname> <newname> +\fBcollection list\fR .PP .RS 4 -Rename a collection. +List all collections. .RE .PP .RS 4 -\-f | \-\-force +\-h, \-\-help .RE .RS 8 -Force renaming of the collection, overwrite an existing collection if needed. +Display command help. .RE .PP + +.TP +\fBcollection show\fR <collection> +.PP .RS 4 -\-h | \-\-help +Display a human-readable description of a collection. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. @@ -792,7 +789,7 @@ Remove a collection. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -800,22 +797,27 @@ Display command help. .PP .TP -\fBcollection config\fR <collection> [attrname [attrvalue]] +\fBcollection rename\fR [\-f] <oldname> <newname> .PP .RS 4 -Get or set attributes for the given collection. -If no attribute name is provided, list all attributes. -If only an attribute name is provided, display the value of the attribute. -If both attribute name and value are provided, set the new value of the attribute. +Rename a collection. .RE .PP .RS 4 -\-h | \-\-help +\-f, \-\-force +.RE +.RS 8 +Force renaming of the collection, overwrite an existing collection if needed. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. .RE .PP + .SH SERVER COMMANDS .TP \fBserver import\fR [\-N] <path> -- 1.7.4.1
>From f05657b262f0d866e0958a6f5091dc1929608965 Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aa...@cante.net> Date: Sun, 3 Apr 2011 17:50:02 +0300 Subject: [PATCH 4/6] src/clients/nycli/nyxmms2.1: (ALIASES): Order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aa...@cante.net> --- src/clients/nycli/nyxmms2.1 | 180 +++++++++++++++++++++---------------------- 1 files changed, 89 insertions(+), 91 deletions(-) diff --git a/src/clients/nycli/nyxmms2.1 b/src/clients/nycli/nyxmms2.1 index f13c4dc..4087323 100644 --- a/src/clients/nycli/nyxmms2.1 +++ b/src/clients/nycli/nyxmms2.1 @@ -819,23 +819,16 @@ Display command help. .PP .SH SERVER COMMANDS + .TP -\fBserver import\fR [\-N] <path> -.PP -.RS 4 -Import new files into the media library. -By default, directories are imported recursively. -.RE +\fBserver\fR .PP .RS 4 -\-N | \-\-non-recursive -.RE -.RS 8 -Do not import directories recursively. +No description .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -843,14 +836,17 @@ Display command help. .PP .TP -\fBserver\fR +\fBserver config\fR [name [value]] .PP .RS 4 -No description +Get or set configuration values. +If no name or value is provided, list all configuration values. +If only a name is provided, display the content of the corresponding configuration value. +If both name and a value are provided, set the new content of the configuration value. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -858,30 +854,22 @@ Display command help. .PP .TP -\fBserver remove\fR <pattern> +\fBserver import\fR [\-N] <path> .PP .RS 4 -Remove the matching media from the media library. +Import new files into the media library. +By default, directories are imported recursively. .RE .PP .RS 4 -\-h | \-\-help +\-N, \-\-non-recursive .RE .RS 8 -Display command help. -.RE -.PP - -.TP -\fBserver rehash\fR [pattern] -.PP -.RS 4 -Rehash the media matched by the pattern, -or the whole media library if no pattern is provided +Do not import directories recursively. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -889,17 +877,14 @@ Display command help. .PP .TP -\fBserver config\fR [name [value]] +\fBserver plugins\fR .PP .RS 4 -Get or set configuration values. -If no name or value is provided, list all configuration values. -If only a name is provided, display the content of the corresponding configuration value. -If both name and a value are provided, set the new content of the configuration value. +List the plugins loaded in the server. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -907,7 +892,7 @@ Display command help. .PP .TP -\fBserver property\fR [\-i | \-s | \-D] [\-S] <mid> [name [value]] +\fBserver property\fR [\-i, \-s, \-D] [\-S] <mid> [name [value]] .PP .RS 4 Get or set properties for a given media. @@ -923,35 +908,35 @@ Use the \-\-int or \-\-string flag to override this behaviour. .RE .PP .RS 4 -\-i | \-\-int +\-i, \-\-int .RE .RS 8 Force the value to be treated as integer. .RE .PP .RS 4 -\-s | \-\-string +\-s, \-\-string .RE .RS 8 Force the value to be treated as a string. .RE .PP .RS 4 -\-D | \-\-delete +\-D, \-\-delete .RE .RS 8 Delete the selected property. .RE .PP .RS 4 -\-S | \-\-source +\-S, \-\-source .RE .RS 8 Property source. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -959,14 +944,15 @@ Display command help. .PP .TP -\fBserver plugins\fR +\fBserver rehash\fR [pattern] .PP .RS 4 -List the plugins loaded in the server. +Rehash the media matched by the pattern, +or the whole media library if no pattern is provided .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -974,23 +960,29 @@ Display command help. .PP .TP -\fBserver volume\fR [\-c <name>] [value] +\fBserver remove\fR <pattern> .PP .RS 4 -Get or set the audio volume (in a range of 0-100). -If a value is provided, set the new value of the volume. Otherwise, display the current volume. -By default, the command applies to all audio channels. Use the \-\-channel flag to override this behaviour. +Remove the matching media from the media library. .RE .PP .RS 4 -\-c | \-\-channel +\-h, \-\-help .RE .RS 8 -Get or set the volume only for one channel. +Display command help. +.RE +.PP + +.TP +\fBserver shutdown\fR +.PP +.RS 4 +Shutdown the server. .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -998,14 +990,14 @@ Display command help. .PP .TP -\fBserver stats\fR +\fBserver stats\fR .PP .RS 4 Display statistics about the server: uptime, version, size of the medialib, etc .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1013,14 +1005,14 @@ Display command help. .PP .TP -\fBserver sync\fR +\fBserver sync\fR .PP .RS 4 Force the saving of collections to the disk (otherwise only performed on shutdown) .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1028,14 +1020,23 @@ Display command help. .PP .TP -\fBserver shutdown\fR +\fBserver volume\fR [\-c <name>] [value] .PP .RS 4 -Shutdown the server. +Get or set the audio volume (in a range of 0-100). +If a value is provided, set the new value of the volume. Otherwise, display the current volume. +By default, the command applies to all audio channels. Use the \-\-channel flag to override this behaviour. .RE .PP .RS 4 -\-h | \-\-help +\-c, \-\-channel +.RE +.RS 8 +Get or set the volume only for one channel. +.RE +.PP +.RS 4 +\-h, \-\-help .RE .RS 8 Display command help. @@ -1118,14 +1119,14 @@ below). The default configuration includes the following aliases: .PP .TP -\fBaddpls\fR +\fBaddpls\fR .PP .RS 4 add \-f \-P $@ .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1133,14 +1134,14 @@ Display command help. .PP .TP -\fBcurrent\fR +\fBclear\fR .PP .RS 4 -status \-f $1 +playlist clear .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1148,14 +1149,14 @@ Display command help. .PP .TP -\fBserver kill\fR +\fBcurrent\fR .PP .RS 4 -server shutdown +status \-f $1 .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1163,14 +1164,14 @@ Display command help. .PP .TP -\fBmute\fR +\fBls\fR .PP .RS 4 -server volume 0 +list .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1178,14 +1179,14 @@ Display command help. .PP .TP -\fBrepeat\fR +\fBmute\fR .PP .RS 4 -seek 0 +server volume 0 .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1193,14 +1194,14 @@ Display command help. .PP .TP -\fBls\fR +\fBquit\fR .PP .RS 4 -list +exit .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1208,14 +1209,14 @@ Display command help. .PP .TP -\fBquit\fR +\fBrepeat\fR .PP .RS 4 -exit +seek 0 .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. @@ -1223,38 +1224,37 @@ Display command help. .PP .TP -\fBclear\fR +\fBscap\fR .PP .RS 4 -playlist clear +stop ; playlist clear ; add $@ ; play .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. .RE -.PP .TP -\fBscap\fR +\fBserver kill\fR .PP .RS 4 -stop ; playlist clear ; add $@ ; play +server shutdown .RE .PP .RS 4 -\-h | \-\-help +\-h, \-\-help .RE .RS 8 Display command help. .RE -.SS EXPANSION -.RS 4 +.PP + +.SS Expansion .B Positional Parameters -.RE -.RS 8 +.RS 4 An alias can use positional parameters, for example: .PP foo = add \-f $1 $3 @@ -1266,10 +1266,8 @@ Will result in: add \-f ctkoz.ogg slre.ogg .PP .RE -.RS 4 .B Special Parameters -.RE -.RS 8 +.RS 4 .B $@ .RS 4 This expands to all parameters passed to the alias. -- 1.7.4.1
>From 3890642e29d59ec57a60ac9cb75c06c14ebb785c Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aa...@cante.net> Date: Sun, 3 Apr 2011 18:15:37 +0300 Subject: [PATCH 5/6] src/clients/nycli/nyxmms2.1: (CONFIGURATION): Order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aa...@cante.net> --- src/clients/nycli/nyxmms2.1 | 57 +++++++++++++++++++++---------------------- 1 files changed, 28 insertions(+), 29 deletions(-) diff --git a/src/clients/nycli/nyxmms2.1 b/src/clients/nycli/nyxmms2.1 index 4087323..06a1a6f 100644 --- a/src/clients/nycli/nyxmms2.1 +++ b/src/clients/nycli/nyxmms2.1 @@ -1279,29 +1279,34 @@ This expands to all parameters passed to the alias. .PP All control characters are interpreted as expected, including ANSI escape sequences. .PP -PROMPT +AUTO_UNIQUE_COMPLETE .RS 4 -String to use as a prompt in -.B INTERACTIVE MODE +Boolean, complete an abbreviation of a command and it's arguments. For example: `serv vol 42' will +complete to `server volume 42'. (Note: Abbreviations must be non-ambiguous) .RE .PP -SHELL_START_MESSAGE +CLASSIC_LIST .RS 4 -Boolean, if true, -.B nycli -will display a greeting message and basic help when started in -.B INTERACTIVE MODE +Boolean, format +.B list +output similar to the classic cli. .RE .PP -SERVER_AUTOSTART +CLASSIC_LIST_FORMAT .RS 4 -Boolean, if true nycli will attempt to start \fBxmms2d\fR(1) if it's not running already. +String to format classic +.B list +output with. .RE .PP -AUTO_UNIQUE_COMPLETE +GUESS_PLS .RS 4 -Boolean, complete an abbreviation of a command and it's arguments. For example: `serv vol 42' will -complete to `server volume 42'. (Note: Abbreviations must be non-ambiguous) +Boolean, try to guess if the URL is a playlist and add accordingly. (Not reliable) +.RE +.PP +HISTORY_FILE +.RS 4 +File to save command history to. .RE .PP PLAYLIST_MARKER @@ -1309,23 +1314,23 @@ PLAYLIST_MARKER String to use to mark the current active entry in the playlist .RE .PP -GUESS_PLS +PROMPT .RS 4 -Boolean, try to guess if the URL is a playlist and add accordingly. (Not reliable) +String to use as a prompt in +.B INTERACTIVE MODE .RE .PP -CLASSIC_LIST +SERVER_AUTOSTART .RS 4 -Boolean, format -.B list -output similar to the classic cli. +Boolean, if true nycli will attempt to start \fBxmms2d\fR(1) if it's not running already. .RE .PP -CLASSIC_LIST_FORMAT +SHELL_START_MESSAGE .RS 4 -String to format classic -.B list -output with. +Boolean, if true, +.B nycli +will display a greeting message and basic help when started in +.B INTERACTIVE MODE .RE .PP STATUS_FORMAT @@ -1334,12 +1339,6 @@ String to format .B status output with. .RE -.PP -HISTORY_FILE -.RS 4 -File to save command history to. -.RE -.PP .SH FILES $XDG_CONFIG_HOME/xmms2/clients/nycli.conf .RS 4 -- 1.7.4.1
>From 64496a84c0a57b8a671dc9ebafaf498b7302682f Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aa...@cante.net> Date: Sun, 3 Apr 2011 18:17:28 +0300 Subject: [PATCH 6/6] src/clients/nycli/nyxmms2.1: (FILES): Order alphabetically Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aa...@cante.net> --- src/clients/nycli/nyxmms2.1 | 11 ++++++----- 1 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/clients/nycli/nyxmms2.1 b/src/clients/nycli/nyxmms2.1 index 06a1a6f..1f334a5 100644 --- a/src/clients/nycli/nyxmms2.1 +++ b/src/clients/nycli/nyxmms2.1 @@ -1340,16 +1340,17 @@ String to format output with. .RE .SH FILES -$XDG_CONFIG_HOME/xmms2/clients/nycli.conf -.RS 4 -The configuration file for -.B nycli -.RE .PP $XDG_CACHE_HOME/xmms2/nyxmms2_history .RS 4 Default command history file if HISTORY_FILE is unset. .RE +.PP +$XDG_CONFIG_HOME/xmms2/clients/nycli.conf +.RS 4 +The configuration file for +.B nycli +.RE .SH BUGS Please report all bugs at http://bugs.xmms2.xmms.se .SH AUTHORS -- 1.7.4.1