sbin/id3fsd

   1 #!/usr/bin/perl -w
   2 # Ian Beckwith <ianb@erislabs.net>
   3 #
   4
   5 use lib '/home/ianb/projects/id3fs/id3fs/lib';
   6 use strict;
   7 use Getopt::Long qw(Configure);
   8 use ID3FS::DB;
   9 use ID3FS::Fuse;
  10 use vars qw($me);
  11 $me=($0=~/(?:.*\/)?(.*)/)[0];
  12
  13 our $VERSION="1.00";
  14 my $verbose=0;
  15 my $help=0;
  16 my $dbpath=undef;
  17
  18 Configure(qw(bundling no_ignore_case));
  19 my $optret=GetOptions(
  20     "verbose|v"    => \$verbose,
  21     "quiet|q"      => sub { $verbose=0; },
  22     "help|h"       => \$help,
  23     "database|f=s" => \$dbpath,
  24     );
  25
  26 usage() if(scalar(@ARGV) != 2 || !$optret || $help);
  27
  28 my $source=shift;
  29 my $mountpoint=shift;
  30
  31 my $db=ID3FS::DB->new($me, $dbpath, $source);
  32 my $fuse=ID3FS::Fuse->new($db, $source, $mountpoint, $verbose);
  33 $fuse->run();
  34
  35 sub usage
  36 {
  37     die("Usage: $me [-vqh] [-f <dbfile>] [--] <sourcedir> <mountpoint>\n".
  38         " -v\t\t\tVerbose\n".
  39         " -q\t\t\tQuiet (default)\n".
  40         " -h\t\t\tThis help\n".
  41         " -f|--database=FILE\tPath to database file\n" .
  42         " --\t\t\tEnd of options\n");
  43 }
  44
  45 __END__
  46
  47 =head1 NAME
  48
  49 id3fsd - FUSE filesystem for browsing id3 tags
  50
  51 =head1 SYNOPSIS
  52
  53 B<id3fsd> [B<-vqh>] S<B<[-f >I<dbfile>]> [B<-->] I<SOURCEDIR> I<MOUNTPOINT>
  54
  55 =head1 DESCRIPTION
  56
  57 id3fsd provides a browsable filesystem of your music files, organised
  58 into sub-directories by id3 tags (or flac/ogg comments).
  59
  60 An index should first be created with L<id3fs-index(1)>, then id3fsd
  61 can mount the files in I<SOURCEDIR> on the directory I<MOUNTPOINT>.
  62
  63 If not explicitly specified (with B<-f>), the index is searched for
  64 at I<SOURCEDIR>/B<.id3fs>.
  65
  66 The resulting filesystem is read-only. Tags appear as directories,
  67 and files appear as symlinks to the actual files in I<SOURCEDIR>.
  68
  69 FIXME: better description, allow_others/fuse.conf, fstab, explain genre tag
  70
  71 =head1 OPTIONS
  72
  73 =over 4
  74
  75 =item B<-v>
  76
  77 Enable verbose operation.
  78
  79 =item B<-q>
  80
  81 Quiet (no output). This is the default.
  82
  83 =item B<-h>
  84
  85 Show a short help message.
  86
  87 =item S<B<-f >I<FILE>> | S<B<--database=>I<FILE>>
  88
  89 Use database in I<FILE>. The default is I<SOURCEDIR>/B<.id3fs>.
  90
  91 =item B<-->
  92
  93 End of options.
  94
  95 =back
  96
  97 =head1 EXAMPLES
  98
  99 To mount an id3fs filesystem which indexes B<~/music/albums> on
 100 B<~/music/tags>:
 101
 102 First create the index:
 103
 104     id3fs-index -v ~/music/albums
 105
 106 If you have a large collection of music, this may take some time.
 107
 108 Then create the mountpoint:
 109
 110     mkdir ~/music/tags
 111
 112 and mount the filesystem:
 113
 114     id3fsd ~/music/albums ~/music/tags
 115
 116 Then explore the tags in ~/music/tags/
 117
 118 FIXME: fstab
 119
 120 =head1 BUGS
 121
 122 Please report any found to ianb@erislabs.net
 123
 124 =head1 SEE ALSO
 125
 126 L<id3fs-index(1)>, L<http://fuse.sourceforge.net>
 127
 128 =head1 AUTHOR
 129
 130 Ian Beckwith <ianb@erislabs.net>
 131
 132 =head1 AVAILABILITY
 133
 134 The latest version can be found at:
 135
 136 B<http://erislabs.net/ianb/projects/id3fs/>
 137
 138 =head1 COPYRIGHT
 139
 140 Copyright 2010 Ian Beckwith <ianb@erislabs.net>
 141
 142 This program is free software: you can redistribute it and/or modify
 143 it under the terms of the GNU General Public License as published by
 144 the Free Software Foundation; either version 3 of the License, or
 145 (at your option) any later version.
 146
 147 This program is distributed in the hope that it will be useful,
 148 but WITHOUT ANY WARRANTY; without even the implied warranty of
 149 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 150 GNU General Public License for more details.
 151
 152 You should have received a copy of the GNU General Public License
 153 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 154
 155 =cut