share/examples/refuse/id3fs/id3fs.8

   1 .\"
   2 .\" Copyright © 2007 Alistair Crooks.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. The name of the author may not be used to endorse or promote
  13 .\"    products derived from this software without specific prior written
  14 .\"    permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  17 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  20 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  22 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  25 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .Dd April 15, 2007
  29 .Dt ID3FS 8
  30 .Os
  31 .Sh NAME
  32 .Nm id3fs
  33 .Nd refuse-based virtual file system to display mp3 tree by id3 tags
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl v
  37 .Ar Fl p Ar music-directory
  38 .Ar mount_point
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 utility can be used to mount a number of directory tree
  43 under the
  44 mount point, using id3 tags
  45 to make the artists, genres and years appear as virtual directories.
  46 The
  47 .Nm
  48 utility makes use of the
  49 .Xr virtdir 3
  50 virtual directory routines.
  51 Underneath those virtual directories, the individual trackes will be
  52 displayed by category, allowing a different view of the id3-tagged
  53 files from the standard one.
  54 .Pp
  55 The
  56 .Xr refuse 3
  57 library is used to provide the file system features.
  58 .Pp
  59 The mandatory parameter is
  60 the local mount
  61 point.
  62 .Pp
  63 The id3 package, found in pkgsrc/audio/id3, is necessary
  64 to run this package.
  65 .Pp
  66 Two shel lscripts are also included, which must be used to build up an id3
  67 database in advance. First id3info.sh must be run, followed by id3db.sh.
  68 .Sh SEE ALSO
  69 .Xr librefuse 3 ,
  70 .Xr puffs 3 ,
  71 .Xr virtdir 3 .
  72 .Sh HISTORY
  73 The
  74 .Nm
  75 utility first appeared in
  76 .Nx 5.0 .