   This is version 1.28 of NetBEUI extension to Linux and SAMBA, 
under Linux and SAMBA releases 1.9.x to 2.0.x (up to 2.0.6 for the 
time being). This extension is maintained by Procom Technology Inc.

   This document covers a how-to-install and how-to-use guide. Examples
are available below docs/examples.

This software is freely distributable under the GNU public license, a
copy of which you should have received with this software (in a file
called COPYING).

HOW TO INSTALL NETBEUI 
======================

There are two ways for installing NetBEUI on a Linux system:

	1. Express installation - Easy installation in only one step.

	2. Custom installation - More controlled installation in 5 steps.
		Useful while express installation has some errors.


1. EXPRESS INSTALLATION
-----------------------

STEP 0. Edit the Makefile and specify needed information. These are 
	needed for installation script and should be done before any
	make command issue. You may specify the following:

	- Specify your kernel directory source path. The default 
	  path is /usr/src/linux.

	- Specify your SAMBA directory source path. The default path
	  is /usr/local/samba. 

**IMPORTANT**
	- You MUST specify your current SAMBA release in one of the 
	  forms 1.9.xx or 2.0.xx. This is essential for the installation
	  script to work. You can simply uncomment one of the lines
	  matching with your SAMBA release (Do not replace the "xx",
	  just uncomment one of the lines).


**IMPORTANT**
	- Make sure that the kernel has support for loadable modules or
	  NetBEUI can never start up on your system.


STEP 1. Just go ahead with:

		make world
	
	You perhaps had better take a cup of coffee and wait about 10
	to 15 minutes for the whole job to get finished!

	Then REBOOT YOUR SYSTEM and boot again with the new kernel, 
	the kernel image for netbeui is named "vmlinux_netbeui" and
	is created right below the root directory. 
	Then go to HOW TO USE section in this document. 

	NOTE: During the make process, the system will be reconfigured
	and you'll be asked for new configuration. Just push ENTER to
	pass through old configuration except the brand new configuration
	'NetBEUI protocol' which is introduced below 'Networking Options'.
	Make sure to enter 'M' in front of this option to configure the
	NetBEUI as a kernel loadable module.


2. CUSTOM INSTALLATION
----------------------

STEP 0. Edit the Makefile and specify needed information. These are 
	needed for installation script and should be done before any
	make command issue. You may specify the following:

	- Specify your kernel directory source path. The default 
	  path is /usr/src/linux.

	- Specify your SAMBA directory source path. The default path
	  is /usr/local/samba. 

**IMPORTANT**
	- You MUST specify your current SAMBA release in one of the 
	  forms 1.9.xx or 2.0.xx. This is essential for the installation
	  script to work. You can simply uncomment one of the lines
	  matching with your SAMBA release (Do not replace the "xx",
	  just uncomment one of the lines).

**IMPORTANT**
	- If using SAMBA 2.0.xx, make sure that SAMBA is configured
	  before adding the NetBEUI extension.


STEP 1. To install NetBEUI code into kernel and SAMBA go ahead with
	the following:

		make install

	You can install either the kernel NetBEUI extension or just 
	the SAMBA NetBEUI extension by:

		make install_netbeui

		make install_smb

	For other tags and usage issue:

		make

STEP 2. If you didn't get any errors at the previous step, you NOW
	have got the extension on your system. Just go ahead with
	STEP 3. Otherwise, you should repeat the last two steps
	until you successfully add the extension to your system. 

STEP 3. Reconfigure your system kernel by going below the kernel 
	source path and issuing:
	
		make config
	or
		make menuconfig

	You can find 'NetBEUI Protocol' below 'Networking Options'
	menu. NetBEUI can be setup only as a kernel module for now, 
	so activate the tag by typing 'M' on it. Also note that you
	have had 'Loadable Modules support' enabled on your system
	in the main menu.

	You then should go on with making the kernel by:

		make dep

		make zImage

	and then making the NetBEUI modules by:

		make modules

	and installing the module among your other kernel modules by:

		make modules_install

STEP 4. Create a boot entry for NetBEUI kernel image in /etc/lilo.conf and
	update the LILO (You can get more information by reading the 
	manpages of lilo.conf) and then REBOOT YOUR SYSTEM by:

		lilo; reboot

	And boot up using NetBEUI kernel image. To test if the modules 
	for NetBEUI are properly installed, you can either start or stop 
	the NetBEUI by the following:

		netb start
	or
		netb stop

STEP 5. For SAMBA extension, there's only one more step to rebuild
	SAMBA by issuing:

		make clean 
		make proto
		make all

	right below SAMBA source path on your system. (Note that 'make
	proto' is ESSENTIAL after the first installation of NetBEUI and
	before the first 'make all' of SAMBA. It's also quite the same
	after the first uninstallation of NetBEUI)


HOW TO USE NETBEUI 
==================

  After installation, there are two groups of programs that make use 
of NetBEUI:

	1. NetBEUI scripts and utilities.

	2. SAMBA daemons and utilities.


   NetBEUI scripts and utilities are useful utilities and programs for 
administration and monitoring the NetBEUI itself. They consist of:

	nbadmin - C program for issuing some administrative commands
		on NetBEUI. See doc/NBADMIN.txt for more information.

	nbstatus - C program for reporting statistics and status of 
		NetBEUI such as name table and other useful parameter
		values. See doc/NBSTATUS.txt to know how to use this
		utility.

	nbview - A menu-driven bash script which helps a lot in showing
		the current state of NetBEUI, such as registered names,
		name status, links, adapters and sessions established and 
		detailed information about each of them. 
		See doc/NBVIEW.txt to know how to use this useful utility.

	netb - Bash script for either starting or stopping the NetBEUI.

	(Note that right after NetBEUI installation all above commands
	are available below /usr/sbin, but they have no effect until 
	NetBEUI is started.)
	
   SAMBA daemons and utilities that the current NetBEUI extension is applied 
to them consist of:

	smbd - The SAMBA server which performs all the job of SMB/CIFS file
		and printer sharing in the network. There are two options
		added to smbd:

		-S <NETEIOS NAME> : For giving a netbios name to the server.

		-Z <NETBEUI | TCPIP> : For selecting between NetBEUI and TCPIP.

**IMPORTANT**
	- All names and options should be entered UPPERCASE


	nmbd - The SAMBA name server which handles browsing and group and
		domain listing and management in the network. There is
		only one option added:

		-Z <NETBEUI | TCPIP> : For selecting between NetBEUI and TCPIP.


	smbclient - The SAMBA client that can talk to an SMB/CIFS 
		    server. It offers an interface similar to that 
		    of the ftp program. There is only one option 
		    added: 
	
		-Z <NETBEUI | TCPIP> : For selecting between NetBEUI and TCPIP.

   The above comments for SAMBA programs are also available while using 
'-h' option for each of the above utilities and daemons.
