-------------------------------------------------------------------------------
 streamtuner-local overview
-------------------------------------------------------------------------------

Index

	0. About this document
	1. About streamtuner-local
	2. Usage
	3. Documentation map

0. About this document

	$Id: README,v 1.4 2004/01/31 16:47:13 jylefort Exp $

	Copyright (c) 2003, 2004 Jean-Yves Lefort.

	This document is part of streamtuner-local.
	It may be distributed under the same terms as streamtuner-local.

1. About streamtuner-local

	streamtuner-local is a streamtuner plugin providing access to
	your local music repository. It supports ID3 and Vorbis tags.

	streamtuner is a stream directory browser, available at
	http://www.nongnu.org/streamtuner/

2. Usage

	Before using the plugin, you should point the
	STREAMTUNER_LOCAL_ROOT environment variable to the full path
	of your music collection.

	For instance:

		STREAMTUNER_LOCAL_ROOT=~/music/mp3 streamtuner

	GLib considers that filenames not encoded in plain ASCII or
	UTF-8 are "broken": you might have to define the
	G_BROKEN_FILENAMES environment variable (see
	http://www.gtk.org/gtk-2.0.0-notes.html for further details).

	Optionally, you can define the STREAMTUNER_LOCAL_EXTENSIONS
	environment variable to a colon-separated list of extensions
	to include in the listing (the default is "mp3:ogg").

3. Documentation map

	The following documents are included in the distribution:

		COPYING		licensing information

		README		this document

		INSTALL		installation instructions

		NEWS		reverse chronology of changes,
				manually edited

		ChangeLog	reverse chronology of changes,
				automatically generated from CVS
				commit messages
