set bitrate/samplerate to UNKNOWN when == 0
[id3fs.git] / README
1                                 id3fs
2                                 -----
3                http://erislabs.net/ianb/projects/id3fs/
4
5 id3fs provides a browsable filesystem of your music files, organised
6 into sub-directories by id3 tags (or flac/ogg comments).
7
8 id3fs allows you to construct boolean queries from a tag folksonomy
9 such as:
10
11 goth/AND/decade/1980s/
12 postrock/AND/NOT/rating/terrible/
13 thrash/OR/rapmetal/AND/NOT/wears-a-red-hat/
14 prog/AND/decade/1970s/OR/psychedelia/AND/decade/1960s/
15 location/sweden/AND/screamo/AND/postrock/
16
17 Multiple tags can be stored in the genre tag, separated by commas.
18
19 GETTING ID3FS
20
21 See http://erislabs.net/ianb/projects/id3fs/
22 for the source release, git repo and debian packages.
23
24 DEPENDENCIES
25
26 An operating system that supports FUSE (Linux, FreeBSD, NetBSD, GNU/Hurd, etc)
27 Perl
28 Perl modules:
29     Fuse (libfuse-perl)
30     DBI (libdbi-perl)
31     DBD::SQLite (libdbd-sqlite3-perl)
32     MP3::Tag (libmp3-tag-perl)
33     Audio::FLAC::Header (libaudio-flac-header-perl)
34     Ogg::Vorbis::Header (libogg-vorbis-header-perl)
35
36 INSTALL
37
38 Use the standard:
39
40 $ perl Makefile.PL
41 $ make
42 $ sudo make install
43
44 or get the Debian package from http://erislabs.net/ianb/projects/id3fs/
45
46 QUICKSTART
47
48 To mount a view of ~/music on ~/tags:
49
50 $ mkdir ~/tags
51 $ id3fs-index ~/music
52 $ id3fsd ~/music ~/tags
53
54 You may need to be in the 'fuse' group, or be root.
55
56 For more details see the man pages for id3fsd(8) and id3fs-index(1).
57
58 REPORTING BUGS
59
60 Please send comments, bugs and patches to ianb@erislabs.net
61
62 COPYRIGHT
63
64 Copyright 2010 Ian Beckwith <ianb@erislabs.net>
65
66 Licensed under the GNU GPL, version 3 or later. See the file COPYING
67 for more information.
68