a couple new extremely basic FAQs

These are also very common questions from new users.
This commit is contained in:
Adrian Sampson 2014-03-21 18:04:35 -07:00
parent 882d2305c0
commit 810841ba5a
2 changed files with 25 additions and 2 deletions

View file

@ -190,6 +190,7 @@ If you've never reported a bug before, Mozilla has some well-written
`general guidelines for good bug
reports <http://www.mozilla.org/bugs/>`__.
.. _find-config:
…find the configuration file (config.yaml)?
@ -199,6 +200,15 @@ You create this file yourself; beets just reads it. See
:doc:`/reference/config`.
.. _special-chars:
…avoid using special characters in my filenames?
------------------------------------------------
Use the ``%asciify{}`` function in your path formats. See
:ref:`template-functions`.
Why does beets…
===============
@ -339,3 +349,16 @@ safely.
Most notably, Windows forbids trailing dots, so a folder called "M.I.A."
will be rewritten to "M.I.A\_" by default. Change the ``replace`` config
if you don't want this behavior and don't need Windows-safe names.
.. _pathq:
…say "command not found"?
-------------------------
You need to put the ``beet`` program on your system's search path. If you
installed using pip, the command ``pip show -f beets`` can show you where
``beet`` was placed on your system. If you need help extending your ``$PATH``,
try `this Super User answer`_.
.. _this Super User answer: http://superuser.com/a/284361/4569

View file

@ -45,8 +45,8 @@ As a convenience, however, beets allows ``$albumartist`` to fall back to the val
.. _template-functions:
Functions
---------
Template Functions
------------------
Beets path formats also support *function calls*, which can be used to transform
text and perform logical manipulations. The syntax for function calls is like