Committing SVN revision 3532 to git

INSTALL

@@ -0,0 +1,142 @@
+INSTALLATION INSTRUCTIONS for Netkit
+====================================
+
+PRECONDITIONS
+-------------
+
+Netkit only runs under the Linux operating system. The toolkit is fairly
+independent from of the specific Linux distribution you have.
+
+It is strongly advised that you have an installed X server which provides you
+with a graphical environment. Netkit virtual machines can also be started in
+text only virtual terminals, but this limits considerably the flexibility when
+you have to start and manage several machines simultaneously. If you choose to
+start virtual machines inside windows of the graphical environment, you need to
+have a terminal emulator application like xterm, konsole, or gnome-terminal
+properly installed on your machine. Please refer to the documentation of your
+Linux distribution for information about installing these applications.
+
+In principle, there is no restriction on the host filesystem Netkit can be
+installed on. However, installing it on a non-standard Linux filesystem (e.g.,
+FAT32) is likely to cause performance losses and malfunctions. We *strongly*
+recommend to install Netkit on an ext2/ext3 filesystem. Most Linux distributions
+adopt ext3 as a default choice.
+
+
+INSTALLING NETKIT
+-----------------
+
+Starting from Netkit version 2, a complete Netkit distribution consists of three
+different packages:
+- the Netkit "core", which contains commands, documentation and other stuff
+  which is necessary for Netkit to work;
+- the Netkit filesystem, which contains the filesystem for virtual machines;
+- the Netkit kernel, which contains the kernel used by virtual machines.
+
+Please always make sure you are using the most recent available releases of the
+three packages. Upgrading some of them while leaving others stale may cause
+unpredictable malfunctions of the Netkit environment.
+
+--- STEP 1: DOWNLOAD AND UNPACK ---
+
+Download all the files to a directory of your choice. Then unpack them by using
+the following commands:
+
+  tar -xjSf netkit-x.y.tar.bz2
+  tar -xjSf netkit-filesystem-Fx.y.tar.bz2
+  tar -xjSf netkit-kernel-Kx.y.tar.bz2
+
+Note that all the three packages must be uncompressed while staying in the same
+directory. It is strongly advised to use the -S option to save space on your
+disk, because this option handles sparse files (i.e., files with lots of empty
+blocks) efficiently.
+
+Once Netkit has been unpacked, no root privileges are required to configure it
+and start working.
+
+--- STEP 2: CONFIGURATION ---
+
+The first step is to set the environment variable NETKIT_HOME to the name of the
+directory Netkit has been installed into. Versions of Netkit prior to 2 used
+variable VLAB_HOME. Such variable is supported as well, but you are encouraged
+not to use it. In order to access the Netkit man pages, the MANPATH variable
+must be set to ":$NETKIT_HOME/man". For example, assuming that you have
+installed Netkit to /home/foo/netkit and that your shell is bash, you would use
+the following commands:
+
+  export NETKIT_HOME=/home/foo/netkit
+  export MANPATH=:$NETKIT_HOME/man
+
+It may also be useful to put these lines inside your shell initialization file
+(`.bashrc' in case you are using the bash shell). Consult your shell
+documentation for more information about this.
+
+After doing this, you need to update your PATH environment variable to include
+the path to the standard Netkit commands. This is required in order to make
+Netkit work properly. The entry you need to add to the PATH is
+"$NETKIT_HOME/bin". For example, assuming Netkit is (still) installed into
+/home/foo/netkit and that your shell is (still) bash, you would type:
+
+  export PATH=$NETKIT_HOME/bin:$PATH
+
+Again, it may be convenient to put this line inside your shell initialization
+file.
+
+--- STEP 3: CHECK YOUR CONFIGURATION ---
+
+At this point, change the current directory to the Netkit directory:
+
+  cd netkit
+
+Now, run the `check_configuration.sh' script by typing:
+
+  ./check_configuration.sh
+
+This script takes care of checking whether your system is configured properly to
+make Netkit run. Any misconfigurations are signalled and instructions for fixing
+them are reported as well. If the script exits with success, then Netkit is
+ready for use.
+
+We suggest reading the documentation by starting from the man page netkit(7).
+
+
+TESTING YOUR INSTALLATION
+-------------------------
+
+In order to test whether Netkit is working properly, you can start a simple
+virtual machine by issuing the command:
+
+  vstart pc1
+
+If everything is in place, you should see a new virtual machine starting up
+(eventually popping up an xterm window) and the command `vlist' on the host
+machine should show an output which is similar to the following:
+
+  vlist
+
+  USER        VHOST               PID  UPTIME         SIZE  INTERFACES
+  foo         pc1               24102  00:03         12376
+
+  Total virtual machines:       1    (you),        1    (all users).
+  Total consumed memory:    12376 KB (you),    12376 KB (all users).
+
+You can stop the virtual machine by typing the following command on the host
+machine console:
+
+  vhalt -r pc1
+
+You can now delete the file pc1.log.
+
+
+COMMAND AUTOCOMPLETION
+----------------------
+
+As an additional feature, users of the bash shell can take advantage of command line autocompletion for Netkit commands (supported starting from release 2.7).
+In order to activate it, first of all make sure your shell is bash:
+
+  readlink -f $SHELL
+
+If it is, then you can safely add the following line at the end of your ~/.bashrc file:
+
+  . $NETKIT_HOME/bin/netkit_bash_completion
+

Makefile

@@ -0,0 +1,54 @@
+# The following variables must contain relative paths
+NK_VERSION=$(shell awk '/ version [0-9]/ {print $$NF}' netkit-version)
+PUBLISH_DIR=/afs/vn.uniroma3.it/user/n/netkit/public/public_html/download/netkit/
+MANPAGES_DIR=/afs/vn.uniroma3.it/user/n/netkit/public/public_html/man/
+
+.PHONY: default help pack publish
+
+default: help
+
+help:
+	@echo
+	@echo -e "\e[1mAvailable targets are:\e[0m"
+	@echo
+	@echo -e "  \e[1mpack\e[0m       Create a distributable tarball of Netkit."
+	@echo
+	@echo -e "  \e[1mpublish\e[0m    Copy the Netkit tarball to the publicly accessible"
+	@echo "             download directory. Also update the currently"
+	@echo "             published readme, installation instructions, and"
+	@echo "             changelog. Must be run from a machine with AFS"
+	@echo "             access and by a user having a token with write"
+	@echo "             permissions on the Netkit web site directory."
+	@echo
+	@echo -e "  \e[1mmanpublish\e[0m Publish the Netkit man pages on the Netkit web"
+	@echo "             site, after converting them to HTML."
+	@echo
+	@echo "The above targets only affect the core Netkit distribution."
+	@echo "In order to also package the kernel and/or filesystem, please"
+	@echo "run the corresponding Makefile in the applicable directory."
+	@echo
+
+pack: ../netkit-$(NK_VERSION).tar.bz2
+	mv ../netkit-$(NK_VERSION).tar.bz2 .
+
+../netkit-$(NK_VERSION).tar.bz2:
+	cd bin; ln -s lstart lrestart; ln -s lstart ltest; find uml_tools -mindepth 1 -maxdepth 1 -type f -exec ln -s {} ';'
+	tar -C .. --owner=0 --group=0 -cjf "../netkit-$(NK_VERSION).tar.bz2" \
+		--exclude=DONT_PACK --exclude=Makefile --exclude=fs --exclude=kernel \
+		--exclude=awk --exclude=basename --exclude=date --exclude=dirname \
+		--exclude=find --exclude=fuser --exclude=grep --exclude=head --exclude=id \
+		--exclude=kill --exclude=ls --exclude=lsof --exclude=ps --exclude=wc \
+		--exclude=getopt --exclude=netkit_commands.log --exclude=stresslabgen.sh \
+		--exclude=build_tarball.sh --exclude="netkit-$(NK_VERSION).tar.bz2" --exclude=FAQ.old \
+		--exclude=CVS --exclude=TODO --exclude=netkit-filesystem-F* \
+		--exclude=netkit-kernel-* --exclude=.* netkit/
+
+publish: netkit-$(NK_VERSION).tar.bz2
+	cp "netkit-$(NK_VERSION).tar.bz2" CHANGES INSTALL README $(PUBLISH_DIR)
+
+manpublish:
+	for i in $(shell find man -type f ! -wholename "*svn*"); do \
+		mkdir -p $(MANPAGES_DIR)/$$(dirname $$i); \
+		man2html -r $$i > $(MANPAGES_DIR)/$$i.html; \
+	done
+

Netkit-konsole.profile

@@ -0,0 +1,20 @@
+[Appearance]
+AntiAliasFonts=true
+ColorScheme=BlackOnWhite
+Font=Monospace,10,-1,5,50,0,0,0,0,0
+
+[General]
+Icon=utilities-terminal
+LocalTabTitleFormat=
+MenuIndex=2
+Name=Netkit shell
+Parent=FALLBACK/
+RemoteTabTitleFormat=
+StartInCurrentSessionDir=false
+
+[Scrolling]
+HistoryMode=2
+HistorySize=9000
+
+[Terminal Features]
+FlowControlEnabled=false

README

@@ -0,0 +1,130 @@
+Welcome to Netkit version 2.8.
+
+
+WHAT IS NETKIT
+--------------
+
+Netkit is a self-contained environment that makes it easy and costless to
+emulate complex network configurations on a single host machine. The idea
+underlying Netkit is that each network device is implemented by a virtual
+machine running the appropriate software. Virtual machines can then be
+interconnected as desired by configuring virtual collision domains.
+
+Interconnected machines may be organized to form a laboratory (lab), which can
+be used to emulate the behavior of a particular service or protocol (e.g., DNS).
+The configuration of the lab can be saved to ease its distribution and
+replication.
+
+Netkit, in itself, is an open source project aiming at integrating different
+other open source products. See the THANKS section for a brief list of the
+software resources integrated into Netkit.
+
+The project was born (and is still carried on) with the main purpose of
+supporting teaching of networking subjects with realistic experiences.
+
+
+SYSTEM REQUIREMENTS
+-------------------
+
+Netkit virtual machines can be configured in a flexible way, so that you can
+decide how many system resources on the host machine should be allocated to
+them. System requirements are not very strict. Netkit can run on a personal
+computer with:
+
+- An i386/amd64 architecture (read: Pentiums and AMDs are fine). For best
+  performance, CPU frequency should be above 600MHz. Netkit works fine also on
+  slower systems, but this may impact usability. If your host runs a 64-bit OS,
+  you may need to install 32-bit compatibility libraries (most notably,
+  libc6-i386 and ia32-libs).
+- At least 256MB of RAM (this mainly depends on the requirements of the Linux
+  installation you are using: Netkit virtual machines may consume slightly more
+  than 32MB each).
+- At least 1GB of free hard disk space (this is required to install the
+  virtual machines filesystem that is distributed with Netkit); even if not
+  explicitly required, it is *strongly* recommended that Netkit is installed on
+  an ext2/ext3 partition. Not doing so is likely to result in performance losses
+  and/or malfunctions.  
+- A Linux operating system installation running a 2.6 kernel (2.4 kernels
+  may still be supported though); the installation should be capable of
+  running a graphical session (read: should include a configured X server);
+  this is not strictly required, but it eases running multiple virtual machines
+  a lot.
+
+Due to the particular nature of the User Mode Linux kernel (which Netkit is
+based on), Netkit cannot be natively run on operating systems which are
+different from Linux.
+
+
+DOCUMENTATION
+-------------
+
+Netkit documentation is available in two separate forms: the Netkit environment
+is fully described by man pages (you can start your reading from 'man netkit'),
+while some other documentation and the description of the labs are provided as
+slides. Standard Netkit documentation is included in the Netkit package itself.
+Additional documentation can be downloaded from http://www.netkit.org/.
+
+
+BUG REPORTING
+-------------
+
+Being an integration of different software products, Netkit is a somewhat
+complex product. We are doing our best to make it be a stable, fast, solid and
+reliable product. However, due to the complex interactions between the various
+components, misbehaviors or malfunctions may occur in the presence of particular
+configurations. We put our effort in trying to fix these bugs as fast as
+possible (remember that this is not the only activity in our lives ;) ). In
+turn, we expect users to signal them so that we can improve the quality of
+Netkit as time goes on.
+
+Please make sure you have carefully read the documentation (including man pages
+and FAQs, if available) before submitting a bug report. Instructions for doing
+this are provided in the man pages. Bug reports should be sent to
+<[email protected]> or submitted for public discussion to
+<[email protected]>.
+
+
+CREDITS AND CONTACTS
+--------------------
+
+This distribution has been released by the Computer Networks (CompuNet) Research
+Group at the University of Roma Tre (http://www.dia.uniroma3.it).  People
+involved in the project include (but are not limited to):
+Giuseppe Di Battista
+Maurizio Patrignani
+Stefano Pettini
+Maurizio Pizzonia
+Fabio Ricci
+Massimo Rimondini
+
+The project has been carried on in the past with significant contributions from
+the Linux User Group "LUG Roma Tre" (http://www.lugroma3.org).
+
+Apart from people from CompuNet and from the LUG, another special mention is due
+for contributions provided by Andrea Cecchetti, Lorenzo Colitti, Federico
+Mariani, and Flavia Picard.
+
+The current official Netkit site is http://www.netkit.org/. Here you can find the
+Netkit distribution itself and also some additional resources (e.g., some labs).
+Contact information is provided as well. You can reach the Netkit team by
+writing to <[email protected]> or by subscribing to the mailing list
+<[email protected]>.
+
+
+THANKS
+------
+
+Netkit is a software integration project. Hence, we would like to thank at least
+the following people for having made all this possible:
+
+- Linus Torvalds for Linux
+- All the people working on the Linux kernel
+- James R. Leu and Ramon Casellas for their work on MPLS routing
+- Jeff Dike, Paolo Giarrusso, and the other contributors for User Mode Linux
+  specific resources
+- Kunihiro Ishiguro, Paul Jakma, and the other developers for the Zebra/Quagga
+  routing daemon
+- Lennert Buytenhenk and the other people working on bridge sources and
+  utilities at http://bridge.sourceforge.net
+- many many others...
+