id3fsd: update usage
authorIan Beckwith <ianb@erislabs.net>
Tue, 19 Oct 2010 12:51:24 +0000 (13:51 +0100)
committerIan Beckwith <ianb@erislabs.net>
Tue, 19 Oct 2010 12:51:24 +0000 (13:51 +0100)
sbin/id3fsd

index 93d2d6c..0809985 100755 (executable)
@@ -52,10 +52,11 @@ $fuse->run();
 
 sub usage
 {
-    die("Usage: $me [-vqh] [-f <dbfile>] [--] <sourcedir> <mountpoint>\n".
+    die("Usage: $me [-vh] [-f <dbfile>] [-t <tagdepth>] [--] <sourcedir> <mountpoint>\n".
+       " -t|--tagdepth=NUM\tMaximum number of tags in expression (default: 10)\n" .
+       " -f|--database=FILE\tPath to database file\n" .
        " -v\t\t\tVerbose (repeat for more verbosity)\n".
        " -h\t\t\tThis help\n".
-       " -f|--database=FILE\tPath to database file\n" .
        " --\t\t\tEnd of options\n");
 }
 
@@ -107,18 +108,35 @@ You may need to be in the I<fuse> group, or be root.
 
 =over 4
 
-=item B<-v>
+=item I<SOURCEDIR>
 
-Enable verbose operation. Repeat for more verbosity.
+Directory containing actual audio files and database file F<.id3fs>
+(unless otherwise specified with B<-f>).
 
-=item B<-h>
+=item I<MOUNTPOINT>
 
-Show a short help message.
+Directory to mount the id3fs view of the files.
+
+=item S<B<-t >I<NUM>> | S<B<--tagdepth=>I<NUM>>
+
+Maximum number of tags in an expression. A query with many ANDs and
+NOTs can get quite slow. This option allows a cutoff before things get
+too slow, as well as providing some eventual limit when processes
+recurse into the filesystem. The default is 10.
 
 =item S<B<-f >I<FILE>> | S<B<--database=>I<FILE>>
 
 Use database in I<FILE>. The default is I<SOURCEDIR>/B<.id3fs>.
 
+=item B<-v>
+
+Enable verbose operation. Repeat for more verbosity.  If verbose is
+enabled, id3fsd does not detach from the terminal.
+
+=item B<-h>
+
+Show a short help message.
+
 =item B<-->
 
 End of options.
@@ -224,27 +242,6 @@ traverse it.
 Ensure your backups, cron jobs, F</etc/updatedb.conf>, etc. are
 configured to exclude the mount point.
 
-=head1 EXAMPLES
-
-To mount an id3fs filesystem which indexes B<~/music/albums> on
-B<~/music/tags>:
-
-First create the index:
-
-    id3fs-index -v ~/music/albums
-
-If you have a large collection of music, this may take some time.
-
-Then create the mountpoint:
-
-    mkdir ~/music/tags
-
-and mount the filesystem:
-
-    id3fsd ~/music/albums ~/music/tags
-
-Then explore the tags in ~/music/tags/
-
 =head1 BUGS
 
 Please report any found to ianb@erislabs.net