Skip to content

Commit 6309765

Browse files
author
Thomas Scholtes
committed
Add docs and changelog for archive import
1 parent 1f74213 commit 6309765

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

docs/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ New stuff:
2525
* There is also a new :doc:`/plugins/keyfinder` that runs a command line
2626
program to get the key from audio data and store it in the
2727
`initial_key` field.
28+
* Beets can now import `zip`, `tar` and `rar` archives.
2829

2930
Fixes:
3031

docs/reference/cli.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,25 @@ import
4343
``````
4444
::
4545

46-
beet import [-CWAPRqst] [-l LOGPATH] DIR...
46+
beet import [-CWAPRqst] [-l LOGPATH] PATH...
4747
beet import [options] -L QUERY
4848

4949
Add music to your library, attempting to get correct tags for it from
5050
MusicBrainz.
5151

52-
Point the command at a directory full of music. The directory can be a single
53-
album or a directory whose leaf subdirectories are albums (the latter case is
54-
true of typical Artist/Album organizations and many people's "downloads"
55-
folders). The music will be copied to a configurable directory structure (see
56-
below) and added to a library database (see below). The command is interactive
57-
and will try to get you to verify MusicBrainz tags that it thinks are suspect.
58-
(This means that importing a large amount of music is therefore very tedious
59-
right now; this is something we need to work on. Read the
60-
:doc:`autotagging guide </guides/tagger>` if you need help.)
52+
Point the command at a directory full of music. The directory can be a
53+
single album or a directory whose leaf subdirectories are albums (the
54+
latter case is true of typical Artist/Album organizations and many
55+
people's "downloads" folders). The path can also be a single file or an
56+
archive. Beets supports `zip` and `tar` archives out of the box. To
57+
extract `rar` files you need to install the `rarfile`_ package and the
58+
`unrar` command. The music will be copied to a configurable directory
59+
structure (see below) and added to a library database (see below). The
60+
command is interactive and will try to get you to verify MusicBrainz
61+
tags that it thinks are suspect. (This means that importing a large
62+
amount of music is therefore very tedious right now; this is something
63+
we need to work on. Read the :doc:`autotagging guide </guides/tagger>`
64+
if you need help.)
6165

6266
* By default, the command copies files your the library directory and
6367
updates the ID3 tags on your music. If you'd like to leave your music
@@ -116,6 +120,8 @@ right now; this is something we need to work on. Read the
116120
``--group-albums`` option to split the files based on their metadata before
117121
matching them as separate albums.
118122

123+
.. _rarfile: https://pypi.python.org/pypi/rarfile/2.2
124+
119125
.. only:: html
120126

121127
Reimporting

0 commit comments

Comments
 (0)