#
# USAGI - Linux IPv6 Development Project
# 
# $USAGI: README.USAGI,v 1.14.2.1.2.1 2002/03/28 14:25:57 yoshfuji Exp $
#

README file for USAGI kit.
							USAGI Project

Overview:
	   Currently we have an IPv6 implementation in Linux kernel
	source tree. Only enabling "Internet Protocol Version 6"
	option in the Networking section, we can enjoy IPv6 life.
	   However, once you begin to use IPv6 on Linux box, you will
	soon be aware that the implementation have some problems...
	Because an existing Linux implementation is too old and not
        so well-tested, it has many bugs and unimplemented functions.
	   Then we decide to start USAGI Project(UniverSAl playGround
	for Ipv6 Project). The project aims to improve IPv6 environments
	on Linux and deploy the IPv6 Internet in the world.
	   We would hack kernel code, libraries and applications
	aggressively, then provide them freely for Linux and IPv6
	communities. In the future we would contribute our codes to the
	main trunks of kernel, glibc and applications.
	   Let's try out USAGI IPv6 environment with us !! Thanks.

Project Goals:
	We try to improve
		- IPv6 stack in the Linux Kernel,
		- IPv6 APIs in the glibc library and
		- IPv6 capable applications.

	Finally, we would like to make most stable and advance IPv6 world
	on Linux environment. So we would contribute and merge our code
	into the main trunks of Linux kernel, glibc and applications. 

Base Version:
	kernel		linux-2.4.18 and linux-2.2.20
	glibc		glibc-2.1.3 and glibc-2.2.4
	application	netkit-combo-0.17 and iputils-ss00110

Differences with original Linux IPv6 stack and USAGI stack:
	We have improved original Linux IPv6 stack at many points, such as
		- catching up the latest RFCs,
		- fixing critical bugs in original Linux kernel,
		- fixing wrong implementations in accordance with RFCs and
		- implementing advanced features.
	For more details, please read RELNOTES.USAGI file and CHANGELOG.USAGI
	file.

	If you are interested in IPv6 and use Linux, there is no reason to
	hesitate applying USAGI patches. We are pleased to provide the best
	IPv6 environment on your Linux box.

	To know the differences from the previous release, please read
	RELNOTES.USAGI and CHANGELOG.USAGI files.

Files:
	README.USAGI		this document
	RELNOTES.USAGI		release notes of this release
	INSTALL.USAGI		how to install USAGI kit
	CHANGELOG.USAGI		changelog of USAGI improvements
	doc/APPLICATIONS	applications list including USAGI kit
	doc/CONFIG.linux22	kernel configuration guide for linux22 kernel
	doc/CONFIG.linux24	kernel configuration guide for linux24 kernel
	doc/FAQ			FAQ regarding USAGI kit and USAGI project
	doc/IMPLEMENTATION	notes of USAGI implementation issue
	doc/CVS.USAGI		CVS guide for getting latest USAGI code
	doc/HOWTO/		howto guides of USAGI new features

Installing USAGI:
	At first, you should get an proper USAGI tarball for your environment.

	If you want to all USAGI kit including kernel sources, libraries and
	applications, you may choose a suitable tarball from the following
	tarballs.

	ftp://ftp.linux-ipv6.org/pub/usagi/snap/kit/
		usagi-linux22-s2001XXXX.tar.bz2	packages for linux-2.2.X system
		usagi-linux24-s2001XXXX.tar.bz2	packages for linux-2.4.X system

	If you want only kernel patches or applications, you can get them
	from the following directory.

	ftp://ftp.linux-ipv6.org/pub/usagi/snap/kit/
		usagi-linux22-s2001XXXX-2.2.XX.diff.bz2
		usagi-linux24-s2001XXXX-2.4.XX.diff.bz2
		usagi-tool-s2001XXXX.tar.bz2

	After downloading, you should extract and build USAGI packages. 
	For further instructions, please read INSTALL.USAGI under doc 
	directory.

Binary Packages:
	We make binary packages for some distributions. You can get the 
	packages from our ftp site or mirror sites. It is easy and convenient 
	to installing binary packages, but the packages are not always 
	up-to-date USAGI package. If you want to use the latest features of 
	USAGI, you might rebuild your system with USAGI source patches.

Reporting Bugs:
	When you find bugs, please be sure to include the following informations
	in your report mail.
		- kernel version (USAGI or non-USAGI)
		- USAGI release version (snap or stable)
		- glibc version
		- exact command lines and results which cause the problem
	When you send a report mail, don't post only to a person. Please post
	our mailing list, usagi-users@linux-ipv6.org. We would like to share
	information to avoid duplicated reports and questions.

Contact Points:
	WEB		http://www.linux-ipv6.org/
	Mailing List	http://www.linux-ipv6.org/ml/
			usagi-users@linux-ipv6.org

	If you have question about license, administrative and political issues,
	please send a mail to:
		usagi-secretary@linux-ipv6.org

Getting latest codes:
	FTP	ftp://ftp.linux-ipv6.org/pub/usagi/
	CVSWEB	http://www.linux-ipv6.org/cvsweb/
	CVS	* INITIAL ANONCVS ACCESS:
		cvs -d :pserver:anoncvs@anoncvs.linux-ipv6.org:/cvsroot/usagi login
		(login as anoncvs; password is 'anoncvs' without quote.)

		* CHECKOUT
		cvs -d :pserver:anoncvs@anoncvs.linux-ipv6.org:/cvsroot/usagi checkout usagi/Makefile
		cd usagi
		make TARGET=linux2{2,4} checkout

		NOTE : Further CVS instructions, see doc/CVS.USAGI

Current core members are:
	Yuji SEKIYA		Keio University
	Hideaki YOSHIFUJI	The University of Tokyo
	Koichi KUNITAKE		Research and Institute of Network Technology
	Mitsuru KANDA		Toshiba Corporation
	Kazunori MIYAZAWA	Yokogawa Electric Corporation
	Kazuyoshi SERIZAWA	Hitachi, Ltd.
	Noriaki TAKAMIYA	NTT Software Corporation

Acknowledgements:
	Takeshi KUSUNE, Masaru YOKOI, Hiroyuki YAMAMORI, Shunsuke TANAKA, 
	Matsuda DAIKI, Aki M Laukkanen, Yoshinori HASEGAWA, Uwe, Sampo Saaristo,
	Hiroshi HOSHINO, David Stevens, FUKUMOTO Atsushi, Masahito Omote,
	Guido Barzini, Fred Templin, Chris Wright, Krishna Kumar, Parijat Mishra,
	Arkadiusz Miskiewicz, Jakub Bogusz, Alakoski Teemu, Pekka Savola,
	Yuchung Cheng, Masanori KUSUNOKI, Daiki UENO, Andreas Ferber, Hajimu UMEMOTO,
	Yasuhiro Ohara, Jun-ichiro HAGINO
	(in no particular order)
