**************************
*** xbms 0.30.4 README ***
**************************



1... What is xbms?
------------------

xbms is a *nix streaming server for xbox mediaplayer. It provides access to
shared directory on a unix box right from the xboxmediaplayer2 
(www.xboxmediaplayer.de).


2... How is this working in detail?
-----------------------------------

It's quite easy. By editing the xbms.conf, you choose the directory being
shared, an interface to bind to (it's a security reason. I guess you don't
want people from outside watching your videos if they're only ment to be
accessible from your home LAN) and user/group the daemon should be run as.
Next, you got to edit the config.xml from your xboxmediaplayer to point
at your unix server (e.g. <videos> /@192.168.0.1 </videos>). Voila, now
you are able to watch some movies on your xbox straight from your unix box.


3... What else is it capable of?
--------------------------------

Besides streaming videos, xbms is able to share pictures and mp3 audio files,
even though this is not a xbms feature but a xboxmediaplayer one ;)


4... What OSes does it run on?
------------------------------

So far, xbms has been tested with Linux (debian to be precise, but that
shouldn't make big differences) and FreeBSD, both working fine without any
problems.
Someone from the xboxmediaplayer forum reported it to work on Mac OS X, this
has to be confirmed yet.
Other Unices _might_ work (at least Open- and NetBSD are most likely to), but
none has been tested yet.


5... That damn configure script won't work for me!
--------------------------------------------------

uhm, there is no configure anymore ;)


6... What command-line options exist?
-------------------------------------

Usually, you don't need to cope with the command-line switches. But, if you
plan to use xbms without root permissions (especially without installing it),
you'll need to determine most of the options from the command line.

-i [address]
	
	Bind xbms to a specific interface, e.g. 192.168.0.1 to bind it to your
	local LAN. This has to be done for security reasons, you don't want
	other people stream your movies over internet, do you? ;)

-r [address]

	only allow connects from address, e.g. 192.168.0.254. This has to be done 
	for security reasons, you don't want other people stream your movies 
	over internet, do you? ;)
			

-d [media dir]

	The directory to be shared, e.g. /mnt/mp3 or /home/foo/mp3 or
	whatever.

-p [port]

	The port xbms should listen at. Defaults to 1400, so there is almost
	no reason to change it, except you KNOW what you do.

-u [username]

	The user xbms should run as. You might want xbms to run as nobody,
	maybe you even want to have a dedicated xbms-user for additional
	security.
	If you plan on running xbms from a user account, you NEED to state
	your own username.

-g [groupname]

	The group xbms should belong to. Generally, this has to be the
	group your user stated by -u belongs to.

-D [level]

	Debug mode, level does state the verbose depth (level 2 is VERY
	verbose.)

-c [configfile]

	If you plan on using a config different from /etc/xbms.conf, you
	need to state it HERE.

-l [logfile]

	Well, this is self-explanatory. At least I hope so. ;)

-P [pidfile]

	Well, this is self-explanatory too.

-h

	List all command-line options, vulgo: help.


7... Credits
------------

Original xbms code:
	J-F Mammet <jeff@bidou.info>
Additional work:
	BigUglyFool
	Stefan Mansby <stefan@nis.nu>
Error Fixing, security issues, daemonizing and a hell lot of features:
	tric <tric@h4x0rZ.de>
	Forsaken, tc
Tric's secretary and Makefile Bitch:
	DonSkeeto <don@h4x0rZ.de>

