
                         -= Net2BBS Telnet Server =-
                                for Windows

                                Version 1.0
                            September 16, 2007
                       Copyright (c) 2001-2007 PC Micro
____________________________________________________________________________


 Net2BBS is a small yet powerful console Windows Telnet Server which
 is bundled as part of the freeware NetFoss FOSSIL driver package.


 Net2BBS has the following features:

   * Very small footprint, NET2BBS.EXE is about 5K in size.
   * Very fast, Net2BBS is written entirly in MASM32 Assembler.
   * Configurable Node support, up to 256 nodes.
   * Logs IP's and HostNames of connections to screen and file.
   * Allows defining an IP/hostname block list, using wildcards.
   * Multimedia support: plays login.wav and logoff.wav if found.
   * Semaphore support: refuses connections when semaphore file exists.
   * A classic Console mode text interface.


 Editing the NET22BBS.INI Configuration file
 -------------------------------------------

 Net2BBS needs to be configured before you can run it. This is done by
 creating or editing a configuration file named NET2BBS.INI.
 A NET2BBS.SAMPLE.INI is included in the distribution archive, which you
 can rename or copy to NET2BBS.INI before you edit it.

 You can edit the Net2BBS.INI file with a text editor, such as NotePad.
 The NET2BBS.INI must be located in the same directory where NET2BBS.EXE
 is located. Changes to NET2BBS.INI will not take effect until the next
 time Net2BBS is started.

 The Sample .INI file uses these settings:

     [Settings]
     Command=c:\netfoss\nf.bat /n*N /h*H c:\pcb\pcboard.bat *N
     StartPath=c:\pcb\
     Port=23
     Nodes=256
     StartNode=1
     Debug=1
     View=Normal
     Log=net2bbs.log
     Semaphore=wait.sem
     KillList=kill.txt
     KillMsg=You are not welcome here.
     KillMsgFile=goaway.ans
     Editor=notepad.exe
     Resolve=1
     ResolveMsg=Resolving your IP Address, One moment...


 Here is what each line does:

 [Settings]    This line must appear above all other valid lines.
               Any lines above this line will be treated as comments.
               This line is required, as it defines a Settings group.

 Command=      The Command Line Net2BBS spawns each time a node is
               assigned to an incoming telnet connection.
               ======================================================
               Normally this will execute NF.BAT and a second batch
               file for the BBS software. Both the Node number and
               the TCP Socket Handle need to be passed on the command
               line the spawned application, allowing it to take
               control of the incoming TCP connection.
               The following Macros are supported:
               *N = The Node number Net2BBS assigned to this session
               *H = The telnet Socket handle
               *I = The users IP Address


 StartPath=    This is the directory that Net2BBS will change to
               to before spawning the Command Line. You can use the
               *N (Node Macro) in the Startpath which will be replaced
               with the node number.

 Port=         The TCP/IP Port that Net2BBS will monitor for
               incoming telnet connections. By default this will
               be port 23, the Telnet port. Some ISP's block port
               23 from incoming connections, in which case you can
               define a non-standard port here.

 Nodes=        The maximum number of simultaneous connections allowed
               to be active. By default this will be 256 which is the
               maximum value that Net2BBS currently supports. You can
               define any value from 1 to 256.

 StartNode=    The Starting Node number created by Net2BBS. This could
               be handy if you use specific nodes for Telnet, and other
               nodes for dialup. For example you could define Nodes=5
               and StartNode=10, to have Net2BBS only assign nodes 10
               thru 14.


 Debug=        A logical flag (either 0 or 1), to disable or enable
               debug mode. When debug mode is 1 (enabled), some extra
               information is displayed on the screen. By default
               debug mode is disabled.

 View=         The Window view setting for new connections when a
               node is started. Valid options are:
               Normal    - The Window is visable
               Minimized - The Window is Minimized
               Maximize  - The Window is Maximized, to full text mode.
               Hide      - The Window can not be viewed locally.

 Log=          The Log file name (the path is optional). If you do not
               want a log file, set this to Log=nul

 Semaphore=    The Semaphore filename (the path is optional).
               Before Net2BBS assigns an incoming connection to
               a node, it checks to make sure that the Semaphore
               file does not exist. If the file does exist, the
               connection is refused due to a semaphore event.
               If the Semaphore file contains any text, this will
               be displayed to the connection before the user is
               disconnected.

 KillList=     The Blocked IP Address & Hostname list filename.
               This file should contain one IP Address or Hostname
               to block per line, and wildcard characters ? and *
               are fully supported. In order for Hostname blocking
               to be effective, the Resolve Mode must be enabled.

 KillMsg=      A line of text to display to the caller when their
               IP Address or hostname made a wildcard match with
               one of the lines within the KillList file.

 KillMsgFile=  A text file to display to the caller instead of any
               defined KillMsg line, if the KillMsgFile exists.

 Editor=       The name of the Text editor that will be used to
               edit the KillList file. The Path is optional.

 Resolve=      A logical flag (0 or 1). When enabled (1), Net2BBS
               will attempt to resolve the callers IP Address to a
               hostname or domain name. Enabling Resolve mode can
               cause users to experience a short delay once they
               connect, while their IP is resolved.

 ResolveMsg=   A line of text to display to the caller while their
               IP address is being resolved. It is erased as soon
               as the Resolve completes. ANSi characters can be used,
               as long as the first character after = is not an ESC,
               and no more then 128 characters are used.




 The only line you need to adjust in Net2BBS.INI is the "Command="
 line. This needs to run NetFoss and your BBS software, passing the
 Node Number using the *N macro, and passing the Socket Handle using
 the *H macro. The *I macro can be used to pass the callers IP Address.

 Refer to the example BBS configurations listed in NETFOSS.TXT for
 examples of how the "Command=" line should appear for your BBS software.



 Using Net2BBS
 -------------

 Net2BBS runs as a Console mode application, which displays all the
 IP connections and disconnections made.

 Pressing [E] will edit the KillList, which is a list of blocked IP
 and/or HostNames to refuse access to. When editing the KillList file
 the changes will become active as soon as the file is saved.
 Pressing the ESC key twice will exit Net2BBS, and will shut down any
 active telnet connections.



 Customizing the Net2BBS Console interface
 -----------------------------------------

 You can adjust the Height/Width layout of the main Net2BBS Console
 window using either of the following methods:

   * Method 1: Ajust the properties settings of the Net2BBS.exe or
     it's shortcut by right clicking the Net2BBS icon or shortcut
     and choose Properties > Layout to select a new Height or Width.
     You can further customize the look under the Font and Color tabs.

   * Method 2: You can run Net2BBS.exe from a batch file which first
     uses the mode command to set a new Height (defined in lines):
     mode con lines=25

 The Console can be hidden or moved to the System Tray by installing
 a third party tray manager tool such as TrayIt (freeware).
 You can download TrayIt from http://www.teamcti.com/trayit/trayit.htm

 You can define a custom Icon to use with the Net2BBS Console, by
 creating a shortcut to NET2BBS.EXE, then right click the shortcut
 and choose Properties > Shortcut > Change Icon.

 Net2BBS does not accept any command line parameters, as it gets all
 it's settings by reading the Net2BBS.INI.

____________________________________________________________________________


 License and Disclaimer
 ----------------------

 Net2BBS is provided free of charge, without any warranty whatsoever.

 Use Net2BBS entirely at your own risk. In no event will PC Micro,
 or its agents be liable for any damages, including loss of profits or
 other consequential damages arising from the use or inability to use
 Net2BBS.

 You may bundle NetFoss (including Net2BBS) with your own BBS software
 or telnet server only as outlined in the NetFoss License included with
 NETFOSS.TXT.

 Net2BBS is a trademark of PC Micro Systems, Inc.
 NetFoss is a trademark of PC Micro Systems, Inc.
 PC Micro is a trademark of PC Micro Systens, Inc.
 Windows is a trademark of Microsoft Corporation.
 Other products mentioned are properties of their respected authors.

____________________________________________________________________________

 For more information about using Net2BBS with NetFoss, please view
 the included NetFoss.txt document, or visit the NetFoss web site at
 http://netfoss.com.

