mirror of
https://github.com/beetbox/beets.git
synced 2026-01-01 13:33:02 +01:00
add TOCs to some documentation
This commit is contained in:
parent
a8ee13f16e
commit
5d55312fdb
2 changed files with 24 additions and 2 deletions
|
|
@ -19,11 +19,21 @@ Command-Line Interface
|
|||
|
||||
The rest of this document describes the available commands. If you ever need
|
||||
a quick list of what's available, just type ``beet help`` or ``beet help
|
||||
COMMAND`` or help with a specific command.
|
||||
COMMAND`` for help with a specific command.
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
.. only:: html
|
||||
|
||||
Here are the built-in commands available in beets:
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
Also be sure to see the :ref:`global flags <global-flags>`.
|
||||
|
||||
.. _import-cmd:
|
||||
|
||||
import
|
||||
|
|
@ -294,11 +304,13 @@ fields
|
|||
Show the item and album metadata fields available for use in :doc:`query` and
|
||||
:doc:`pathformat`. Includes any template fields provided by plugins.
|
||||
|
||||
.. _global-flags:
|
||||
|
||||
Global Flags
|
||||
------------
|
||||
|
||||
Beets has a few "global" flags that affect all commands. These must appear
|
||||
between the executable name (``beet``) and the command: for example, ``beet -v
|
||||
between the executable name (``beet``) and the command---for example, ``beet -v
|
||||
import ...``.
|
||||
|
||||
* ``-l LIBPATH``: specify the library database file to use.
|
||||
|
|
|
|||
|
|
@ -33,6 +33,14 @@ documentation.
|
|||
|
||||
.. _YAML: http://yaml.org/
|
||||
|
||||
The rest of this page enumerates the dizzying litany of configuration options
|
||||
available in beets. You might also want to see an
|
||||
:ref:`example <config-example>`.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
Global Options
|
||||
--------------
|
||||
|
||||
|
|
@ -546,6 +554,8 @@ fact, just shorthand for the explicit queries ``singleton:true`` and
|
|||
``comp:true``. In contrast, ``default`` is special and has no query equivalent:
|
||||
the ``default`` format is only used if no queries match.
|
||||
|
||||
.. _config-example:
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue