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