From 1eebb6af3c80f92b5c257f58fc060f48d53de71b Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sat, 15 Nov 2014 12:06:38 -0800 Subject: [PATCH] Docs for link option (#710) --- docs/changelog.rst | 3 +++ docs/reference/config.rst | 14 ++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index 521b92d5d..1ad644d7f 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -16,6 +16,9 @@ The major new features are: * A new :doc:`/plugins/freedesktop` creates metadata files for Freedesktop.org--compliant file managers. Thanks to :user:`kerobaros`. :bug:`1056`, :bug:`707` +* A new :ref:`link` option in the ``import`` section creates symbolic links + during import instead of moving or copying. Thanks to Rovanion Luckey. + :bug:`710`, :bug:`114` * :doc:`/plugins/fetchart`: You can now search for art on the iTunes Store. There's also a new ``sources`` config option that lets you choose exactly where to look for images and in which order. diff --git a/docs/reference/config.rst b/docs/reference/config.rst index 75592e499..482ac05db 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -322,6 +322,20 @@ This option *overrides* ``copy``, so enabling it will always move (and not copy) files. The ``-c`` switch to the ``beet import`` command, however, still takes precedence. +.. _link: + +link +~~~~ + +Either ``yes`` or ``no``, indicating whether to use symbolic links instead of +moving or copying files. Defaults to ``no``. + +This option only works on platforms that support symbolic links: i.e., Unixes. +It will fail on Windows. + +It's likely that you'll also want to set ``write`` to ``no`` if you use this +option to preserve the metadata on the linked files. + resume ~~~~~~