[ds6-devel] nc6/docs nc6.1.in,NONE,1.1 Makefile.am,1.2,1.3 nc6.1,1.4,NONE

[chris@deepspace6.net]

Update of /cvs/nc6/docs

Modified Files:
	Makefile.am 
Added Files:
	nc6.1.in 
Removed Files:
	nc6.1 
Log Message:
Moved the manpage to a .in - so the version can be added at configure time.
Updated the man page - expanded UDP & TIMEOUTS sections, added FILE TRANSFER
and HALF CLOSE sections.


--- NEW FILE: nc6.1.in ---
TH NC6 1 
SH NAME
nc6 \- TCP/IP swiss army knife
SH SYNOPSIS
B nc6
I "[options...] hostname port"
br
B nc6
I "-l -p port [-s addr] [options...] [hostname] [port]"
SH "DESCRIPTION"
B netcat6
is a simple unix utility which reads and writes data across network
connections, using the TCP or UDP protocol over IPv4 or IPv6 networks.
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. 
B netcat6
, or
B nc6
as the actual program is named, should have been supplied long ago
as another one of those cryptic but standard Unix tools.
P
In the simplest usage, "
B nc6 host port
" creates a TCP connection to the
given port on the given target host.  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 other applications which shut everything down and
exit after an end-of-file on the standard input (though this style of
operation can easily be enabled).
P
netcat6 can also function as a server, by listening for inbound connections on
arbitrary ports and then doing the same reading and writing.  With minor
limitations, netcat6 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.
In this manual page, these two working modes are referred as "connect mode"
and "listen mode", respectively.
SH OPTIONS
TP 13
I \-4
Forces the use of IPv4. 
TP 13
I \-6
Forces the use of IPv6 and inhibits the use IPV4-mapped addresses.
TP 13
I \-h, --help
Display a brief help listing.
TP 13
I \-l, --listen
Selects listen mode (for inbound connects).
TP 13
I \-n
Disables DNS queries - you'll have to use numeric IP address 
instead of hostnames.
TP 13
I \-p, --port=PORT
Sets the port number for the local endpoint of the connection.
TP 13
I \-q, --hold-timeout=SEC1[:SEC2]
Sets the hold timeout(s) (see "timeouts" section).  Specifying just one value
will set the hold timeout on the local endpoint, specifying a second value will
set the hold timeout on the remote endpoint as well.  Either value can be '0'
(for instant timeout) or '-' (for no hold timeout, eg. infinite hold).
TP 13
I \-s, --address=ADDRESS
Sets the source address for the local endpoint of the connection.
TP 13
I \-u, --udp
With this option set, netcat6 will use UDP as the transport protocol (TCP is
the default).
TP 13
I \-v
Enable verbose mode.  This gives some basic information about what netcat6
is doing.  Use it twice for extra verbosity.
TP 13
I \-w, --timeout=SECONDS
Timeout for network connects and accepts.
TP 13
I \-x, --transfer
File transfer mode (see "file transfer" section).  If listen mode is
specified, this is equivalent to "--recv-only --buffer-size=65536" otherwise
it is equivalent to "--send-only --buffer-size=65536".
TP 13
I \--recv-only
Only receive data, don't transmit.  This also disables any hold timeouts.
TP 13
I \--send-only
Only send data, don't receive.  This also disables any hold timeouts.
TP 13
I \--buffer-size=BYTES
Set the buffer size for the remote endpoint (network receives).
netcat6 does all network reads into this buffer, so it should be large enough
to minimize excessive reads from the socket and in UDP mode it should be large
enough to receive an entire datagram (also see --nru).  By default, the buffer
size is 8192 bytes for TCP connections and 65536 bytes for UDP.
TP 13
[...140 lines suppressed...]
Index: Makefile.am
===================================================================
RCS file: /cvs/nc6/docs/Makefile.am,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- Makefile.am	15 Dec 2002 22:24:14 -0000	1.2
+++ Makefile.am	1 Jan 2003 20:44:42 -0000	1.3
@@ -1,4 +1,3 @@
 man_MANS = nc6.1
-EXTRA_DIST = $(man_MANS)
 
 MAINTAINERCLEANFILES = Makefile.in
--- nc6.1 DELETED ---