[ds6-devel] nc6 INSTALL,NONE,1.1 README,1.2,1.3

[chris@deepspace6.net]

Update of /cvs/nc6

Modified Files:
	README 
Added Files:
	INSTALL 
Log Message:
Updated README and added the standard GNU INSTALL file (explains configure).
There is still some stuff to be added to the README.


--- NEW FILE: INSTALL ---
Copyright 1994, 1995, 1996, 1999, 2000, 2001 Free Software Foundation,
Inc.

   This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.

Basic Installation
==================

   These are generic installation instructions.

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').

   It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring.  (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.

   The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'.  You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
     the package.

  4. Type `make install' to install the programs and any data files and
     documentation.

  5. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  Run `./configure --help'
for details on some of the pertinent environment variables.

   You can give `configure' initial values for variables by setting
them in the environment.  You can do that on the command line like this:

     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix

   *Note Defining Variables::, for more details.

Compiling For Multiple Architectures
====================================

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

   If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory.  After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.

Installation Names
==================

[...131 lines suppressed...]
Index: README
===================================================================
RCS file: /cvs/nc6/README,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- README	7 Apr 2002 21:19:06 -0000	1.2
+++ README	1 Jan 2003 20:40:27 -0000	1.3
@@ -1,12 +1,121 @@
+WHAT IS NETCAT6?
+----------------
 
+netcat6 is a clone of the original netcat utility.  From the netcat README:
 
-netcat6 is a simple netcat clone, with IPv6 support. Currently, I have
-tested it only with Linux (both glibc 2.1 and 2.2) and FreeBSD, but it 
-should work with minor modifications on other Unix platforms too.
+"Netcat is a simple Unix utility which reads and writes data across network
+connections.  It is designed to be a reliable "back-end" tool that can be used
+directly or easily driven by other programs and scripts.  At the same time, it
+is a feature-rich network debugging and exploration tool, since it can create
+almost any kind of connection you would need and has several interesting
+built-in capabilities.  Netcat, or "nc" as the actual program is named, should
+have been supplied long ago as another one of those cryptic but standard Unix
+tools."
 
-You are encouraged to send me bug reports for netcat6 or suggestions 
-on how to improve it (desired features and stuff like that).
+netcat6 is a total rewrite of netcat, with several advantages:
 
+1. It fully supports IPv6.
+2. It is far more efficient, utilizing flexible buffering and minimal (or no)
+   data copying or analysis.
+3. The source is well structured, documented and very easy to follow.
+   One of the main objectives of netcat6 is to produce an excellent example of
+   AF independant networking and efficient data transfer.
+4. Greatly improved configuration and platform indendance.
+5. Can support servers or clients that use TCP half-close.
 
-                                        Mauro Tortonesi
-					<mauro _at_ ferrara.linux.it>
+
+Some features of the original netcat are not present in netcat6, either
+because they haven't yet been implemented or because there exists better tools
+for the job.  See the TODO file for more information.
+
+
+USAGE
+-----
+
+In the simplest usage, "nc6 host port" creates a TCP connection to the given
+port on the given target host (using either IPv4 or IPv6 as appropriate).
+Your standard input is then sent to the host, and anything that comes back
+across the connection is sent to your standard output.  This continues
+indefinitely, until the network side of the connection shuts down.  Note that
+this behavior is different from most applications which shut everything down
+and exit after an end-of-file on standard input.
+
+Netcat6 can also function as a server, by listening for inbound connections on
+arbitrary ports and then doing the same reading and writing when a client
+connects.  With minor limitations, netcat doesn't really care if it runs in
+"client" or "server" mode -- it still shovels data back and forth until there
+isn't any more left.
+
+Netcat6 can also be used over UDP (using the '-u' or '--udp' option).  UDP is
+an unreliable transport protocol, meaning some data can get lost, but it's a
+very useful capability to have.
+
+Some of netcat6's major features are:
+
+    o Outbound or inbound connections, using TCP or UDP over any suitable
+      transport protocol available on the system (usually IPv4 or IPv6).
+    o Full DNS forward/reverse checking, with appropriate warnings.
+    o Ability to use any local source port
+    o Ability to use any locally-configured network source address
+    o Flexible data buffering and control of MTU
+    o Flexible control of connection shutdown.
+
+Efforts have been made to have netcat6 "do the right thing" in all its various
+modes.  One of the development principles is "the principle of least
+surprise".  This means that netcat6 should do what you expect it to do.  If
+you think it doesn't do something quite right, let us know and we'll look into
+it.
+
+Netcat6 is licensed under the GNU Public License (see COPYING).
+
+
+BUILDING
+--------
+
+See the INSTALL file for specific installation instructions.  For those who
+can't wait, the following should do it:
+
+# ./configure
+# make
+# make install
+
+If the build fails on your system, please let us know so that we can fix the
+issue.
+
[...37 lines suppressed...]