~callum/barszcz

b253bbd0771b9779cc15d190078daf85f7fb6271 — Callum Brown 1 year, 11 months ago 4e0f10e
Document optional/required arguments for commands.
1 files changed, 7 insertions(+), 5 deletions(-)

M README.md
M README.md => README.md +7 -5
@@ 33,18 33,20 @@ beet barszcz

### Commands

The command input line can be brought up by typing a colon (":").
The command input line at the bottom of the screen can be brought up by typing
a colon (":").

'Thing' is used to refer to beets items and albums collectively.
Positional arguments of commands are in [brackets].
Required arguments are CAPITALISED.

| command       | short form | description |
| ---           | ---        | --- |
| quit          | q          | Quit Barszcz |
| list  [query] | ls         | List albums and items matching the [query] |
| lista [query] | lsa        | List albums matching the [query] |
| listi [query] | lsi        | List items matching the [query] |
| focus [index] |            | Change focus to the thing at the given [index]. A negative [index] focuses the last thing. |
| list  [query] | ls         | List albums and items matching the [query]. Default: [query] is blank, list all. |
| lista [query] | lsa        | List albums matching the [query]. Default: [query] is blank, list all. |
| listi [query] | lsi        | List items matching the [query]. Default: [query] is blank, list all. |
| focus [INDEX] |            | Change focus to the thing at the given [INDEX]. A negative [INDEX] focuses the last thing. |
| up [n]        |            | Change focus up [n] things (wraps). Default: [n] = 1. |
| down [n]      |            | Change focus down [n] things (wraps). Default: [n] = 1. |