Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-22 16:43:25 +01:00
Code Issues Projects Releases Wiki Activity

bash completion (#553): expand docs

Browse source
This commit is contained in:
Adrian Sampson 2014-03-07 15:03:30 -08:00
parent 606444049e
commit a6ca63d67c
2 changed files with 39 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/changelog.rst
View file

@ -10,6 +10,8 @@ New stuff:
you what you currently have in your config file, point you at where the file
should be, or launch your text editor to let you modify the file. Thanks to
geigerzaehler.
* Beets now ships with a shell command completion script! See
:ref:`completion`. Thanks to geigerzaehler.
* Internally, beets has laid the groundwork for supporting multi-valued
fields. Thanks to geigerzaehler.
* The importer interface now shows the URL for MusicBrainz matches. Thanks to

71
docs/reference/cli.rst
View file

@ -330,40 +330,6 @@ Show or edit the user configuration. This command does one of three things:
on Unix, and direct invocation on Windows.
completion
``````````
::
beet completion
Print a shell script that enables command line completion.
The script completes the names of subcommands and (after typing
``-``) options of the given command. If you are using a command that
accepts a query, the script will also complete field names. ::
beet list ar[TAB]
# artist: artist_credit: artist_sort: artpath:
beet list artp[TAB]
beet list artpat\:
Don't worry about the slash in front of the colon: This is a escape
sequence for the shell and won't be seen by beets.
Note that completion of plugin commands only works for those plugins
that were enabled when running ``beet completion``. If you add a plugin
later on you might want to re-generate the script.
To enable completion in your current shell, type ``eval "$(beet
completion)"``. If you want to use it permanently, load the script from
your shell's rc-file.
Completion is only tested to work on Bash 3.2 and newer. It also
requires the ``bash-completion`` package which is available OSX (through
*homebrew* or *ports*) and Linuxes.
.. _global-flags:
Global Flags
@ -382,6 +348,43 @@ import ...``.
Beets also uses the ``BEETSDIR`` environment variable to look for
configuration and data.
.. _completion:
Shell Completion
----------------
Beets includes support for shell command completion. The command ``beet
completion`` prints out a `bash`_ 3.2 script; to enable completion put a line
like this into your ``.bashrc`` or similar file::
eval $(beet completion)
You will also need to source the `bash-completion`_ script, which is probably
available via your package manager. On OS X, you can install it via Homebrew
with ``brew install bash-completion``; Homebrew will give you instructions for
sourcing the script.
.. _bash-completion: http://bash-completion.alioth.debian.org/
.. _bash: https://www.gnu.org/software/bash/
The completion script suggests names of subcommands and (after typing
``-``) options of the given command. If you are using a command that
accepts a query, the script will also complete field names. ::
beet list ar[TAB]
# artist: artist_credit: artist_sort: artpath:
beet list artp[TAB]
beet list artpath\:
(Don't worry about the slash in front of the colon: this is a escape
sequence for the shell and won't be seen by beets.)
Completion of plugin commands only works for those plugins
that were enabled when running ``beet completion``. If you add a plugin
later on you will want to re-generate the script.
.. only:: man
See Also