Added summary help section.
This commit is contained in:
parent
32f99df53e
commit
795a7c8c76
@ -741,6 +741,8 @@ Available commands:
|
|||||||
quit Quit this program.
|
quit Quit this program.
|
||||||
|
|
||||||
A new user is advised to read the help section for the ${cmdStyle}select${normalStyle} command.
|
A new user is advised to read the help section for the ${cmdStyle}select${normalStyle} command.
|
||||||
|
|
||||||
|
For a quick list of options, consider reading the ${cmdStyle}summary${normalStyle} section.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
// SCAN
|
// SCAN
|
||||||
@ -804,6 +806,11 @@ ${cmdStyle}select files tagged as <tag-name>...${normalStyle}
|
|||||||
This selects all files that are tagged as *both* instrumental and
|
This selects all files that are tagged as *both* instrumental and
|
||||||
orchestral.
|
orchestral.
|
||||||
|
|
||||||
|
${cmdStyle}select untagged files${normalStyle}
|
||||||
|
|
||||||
|
Select all media files that do not have any tags associated with them.
|
||||||
|
|
||||||
|
|
||||||
${cmdStyle}select { album | artist | file | playlist | tag } where <criteria>...${normalStyle}
|
${cmdStyle}select { album | artist | file | playlist | tag } where <criteria>...${normalStyle}
|
||||||
|
|
||||||
${errorStyle}Not yet implemented.${normalStyle}
|
${errorStyle}Not yet implemented.${normalStyle}
|
||||||
@ -848,7 +855,7 @@ ${cmdStyle}play <select-criteria>${normalStyle}
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
// PLAY
|
// ENQUEUE
|
||||||
// --------------
|
// --------------
|
||||||
case 'enqueue': return """\
|
case 'enqueue': return """\
|
||||||
enqueue selection
|
enqueue selection
|
||||||
@ -862,6 +869,9 @@ enqueue <select-criteria>
|
|||||||
the selection.
|
the selection.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
// ADD
|
||||||
|
// --------------
|
||||||
case 'add': return """\
|
case 'add': return """\
|
||||||
add selection to playlist <id | name>
|
add selection to playlist <id | name>
|
||||||
|
|
||||||
@ -876,6 +886,8 @@ add <select-criteria> to playlist <id | name>
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
// REMOVE
|
||||||
|
// --------------
|
||||||
case 'remove': return """\
|
case 'remove': return """\
|
||||||
remove selection from queue
|
remove selection from queue
|
||||||
remove selection from playlist <id | name>
|
remove selection from playlist <id | name>
|
||||||
@ -891,6 +903,9 @@ remove <select-criteria> from playlist <id | name>
|
|||||||
(including partial match).
|
(including partial match).
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
// tag
|
||||||
|
// --------------
|
||||||
case 'tag': return """\
|
case 'tag': return """\
|
||||||
tag <tag>...
|
tag <tag>...
|
||||||
|
|
||||||
@ -910,6 +925,8 @@ tag <select-criteria> as <tag>...
|
|||||||
provided separated by spaces (tags cannot include spaces).
|
provided separated by spaces (tags cannot include spaces).
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
// UNTAG
|
||||||
|
// --------------
|
||||||
case 'untag': return """\
|
case 'untag': return """\
|
||||||
untag <tag>...
|
untag <tag>...
|
||||||
|
|
||||||
@ -930,6 +947,8 @@ taung <select-criteria> as <tag>...
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
// CLEAR
|
||||||
|
// --------------
|
||||||
case 'clear': """\
|
case 'clear': """\
|
||||||
clear Clear the terminal display.
|
clear Clear the terminal display.
|
||||||
clear queue Clear the play queue.
|
clear queue Clear the play queue.
|
||||||
@ -986,8 +1005,66 @@ volume <percent> Set the volume. <percent> may be any value from 0 to 200.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
case 'help': return """\
|
case 'help': return """\
|
||||||
|
help summary Display a quick summary of available commands.
|
||||||
help <commmand> Display detailed information about the given command."""
|
help <commmand> Display detailed information about the given command."""
|
||||||
|
|
||||||
|
|
||||||
|
case 'summary': return """\
|
||||||
|
Selecting files:
|
||||||
|
|
||||||
|
select { album | artist | file | playlist | tag } <id | name>
|
||||||
|
select { albums | artists | files | playlists | tags } where <criteria>
|
||||||
|
select files tagged as <tag>... and not as <tag>...
|
||||||
|
select playing { albums | artists | files | playlists | tags }
|
||||||
|
select queued { albums | artists | files | playlists | tags }
|
||||||
|
|
||||||
|
list selection
|
||||||
|
list <selection-criteria>
|
||||||
|
list selected { albums | artists | files | playlists | tags }
|
||||||
|
|
||||||
|
Play and Controlling Media:
|
||||||
|
|
||||||
|
play
|
||||||
|
play selection
|
||||||
|
play bookmark <id | name>
|
||||||
|
play <selection-criteria>
|
||||||
|
|
||||||
|
next <count> (alias: n)
|
||||||
|
prev <count> (alias: p)
|
||||||
|
|
||||||
|
stop
|
||||||
|
pause
|
||||||
|
fasforward <duration> <time-unit> (aliases: ff, fwd)
|
||||||
|
rewind <duration> <time-unit> (aliases: rw, rwd)
|
||||||
|
jump <id | name>
|
||||||
|
|
||||||
|
Playlist and Queue Management:
|
||||||
|
|
||||||
|
scan
|
||||||
|
enqueue selection
|
||||||
|
enqueue <selection-criteria>
|
||||||
|
|
||||||
|
add selection to playlist to playlist <id | name>
|
||||||
|
add <selection-criteria> to playlist <id | name>
|
||||||
|
|
||||||
|
remove selection from playlist <id | name>
|
||||||
|
remove <selection-criteria> from playlist <id | name>
|
||||||
|
remove selection from queue
|
||||||
|
remove <selection-criteria> from queue
|
||||||
|
|
||||||
|
create playlist named <name> from selection <id | name>
|
||||||
|
create playlist named <name from <selection-criteria>
|
||||||
|
copy playlist <id | name> as <new name>
|
||||||
|
create bookmark <id | name>
|
||||||
|
update bookmark <id | name>
|
||||||
|
|
||||||
|
clear
|
||||||
|
clear queue
|
||||||
|
clear selection
|
||||||
|
clear playlist <id | name>
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
default:
|
default:
|
||||||
err "Unrecognized command: '$line'"
|
err "Unrecognized command: '$line'"
|
||||||
drawLeader()
|
drawLeader()
|
||||||
|
Loading…
Reference in New Issue
Block a user