--- libdnet-1.12/man/dnet.3.orig	2012-05-23 08:31:15.785689693 -0700

+++ libdnet-1.12/man/dnet.3	2012-05-23 08:46:23.327040849 -0700

@@ -1,206 +1,296 @@

-.\"

+.\"    

 .\" Copyright (c) 2000 Dug Song <[email protected]>

-.\"

+.\"    

 .\" $Id: dnet.3 604 2005-02-25 22:59:04Z dugsong $

 .\"

-.Dd August 21, 2001

-.Dt DNET 3

-.Os

-.Sh NAME

-.Nm dnet

-.Nd dumb networking library

-.Sh SYNOPSIS

-.Fd #include <dnet.h>

-.Ss Network addressing

-.Ft int

-.Fn addr_cmp "const struct addr *a" "const struct addr *b"

-.Ft int

-.Fn addr_bcast "const struct addr *a" "struct addr *b"

-.Ft int

-.Fn addr_net "const struct addr *a" "struct addr *b"

-.Ft char *

-.Fn addr_ntop "const struct addr *src" "char *dst" "size_t size"

-.Ft int

-.Fn addr_pton "const char *src" "struct addr *dst"

-.Ft char *

-.Fn addr_ntoa "const struct addr *a"

-.Ft int

-.Fn addr_aton "const char *src" "struct addr *dst"

-.Ft int

-.Fn addr_ntos "const struct addr *a" "struct sockaddr *sa"

-.Ft int

-.Fn addr_ston "const struct sockaddr *sa" "struct addr *a"

-.Ft int

-.Fn addr_btos "uint16_t bits" "struct sockaddr *sa"

-.Ft int

-.Fn addr_stob "const struct sockaddr *sa" "uint16_t *bits"

-.Ft int

-.Fn addr_btom "uint16_t bits" "void *mask" "size_t size"

-.Ft int

-.Fn addr_mtob "const void *mask" "size_t size" "uint16_t *bits"

-.Ss Address Resolution Protocol

-.Pp

-.Li typedef Ar int Fn (*arp_handler) "const struct arp_entry *entry" "void *arg"

-.Ft arp_t *

-.Fn arp_open "void"

-.Ft int

-.Fn arp_add "arp_t *a" "const struct arp_entry *entry"

-.Ft int

-.Fn arp_delete "arp_t *a" "const struct arp_entry *entry"

-.Ft int

-.Fn arp_get "arp_t *a" "struct arp_entry *entry"

-.Ft int

-.Fn arp_loop "arp_t *a" "arp_handler callback" "void *arg"

-.Ft arp_t *

-.Fn arp_close "arp_t *a"

-.Ss Binary buffers

-.Ft blob_t *

-.Fn blob_new "void"

-.Ft int

-.Fn blob_read "blob_t *b" "void *buf" "int len"

-.Ft int

-.Fn blob_write "blob_t *b" "const void *buf" "int len"

-.Ft int

-.Fn blob_seek "blob_t *b" "int off" "int whence"

-.Ft int

-.Fn blob_index "blob_t *b" "const void *buf" "int len"

-.Ft int

-.Fn blob_rindex "blob_t *b" "const void *buf" "int len"

-.Ft int

-.Fn blob_pack "blob_t *b" "const void *fmt" "..."

-.Ft int

-.Fn blob_unpack "blob_t *b" "const void *fmt" "..."

-.Ft int

-.Fn blob_print "blob_t *b" "char *style" "int len"

-.Ft blob_t *

-.Fn blob_free "blob_t *b"

-.Ss Ethernet

-.Ft eth_t *

-.Fn eth_open "const char *device"

-.Ft int

-.Fn eth_get "eth_t *e" "eth_addr_t *ea"

-.Ft int

-.Fn eth_set "eth_t *e" "const eth_addr_t *ea"

-.Ft ssize_t

-.Fn eth_send "eth_t *e" "const void *buf" "size_t len"

-.Ft eth_t *

-.Fn eth_close "eth_t *e"

-.Ss Firewalling

-.Pp

-.Li typedef Ar int Fn (*fw_handler) "const struct fw_rule *rule" "void *arg"

-.Ft fw_t *

-.Fn fw_open "void"

-.Ft int

-.Fn fw_add "fw_t *f" "const struct fw_rule *rule"

-.Ft int

-.Fn fw_delete "fw_t *f" "const struct fw_rule *rule"

-.Ft int

-.Fn fw_loop "fw_t *f" "fw_handler callback" "void *arg"

-.Ft fw_t *

-.Fn fw_close "fw_t *f"

-.Ss Network interfaces

-.Pp

-.Li typedef Ar int Fn (*intf_handler) "const struct intf_entry *entry" "void *arg"

-.Ft intf_t *

-.Fn intf_open "void"

-.Ft int

-.Fn intf_get "intf_t *i" "struct intf_entry *entry"

-.Ft int

-.Fn intf_get_src "intf_t *i" "struct intf_entry *entry" "struct addr *src"

-.Ft int

-.Fn intf_get_dst "intf_t *i" "struct intf_entry *entry" "struct addr *dst"

-.Ft int

-.Fn intf_set "intf_t *i" "const struct intf_entry *entry"

-.Ft int

-.Fn intf_loop "intf_t *i" "intf_handler callback" "void *arg"

-.Ft intf_t *

-.Fn intf_close "intf_t *i"

-.Ss Internet Protocol

-.Ft ip_t *

-.Fn ip_open "void"

-.Ft ssize_t

-.Fn ip_add_option "void *buf" "size_t len" "int proto" "const void *optbuf" "size_t optlen"

-.Ft void

-.Fn ip_checksum "void *buf" "size_t len"

-.Ft ssize_t

-.Fn ip_send "ip_t *i" "const void *buf" "size_t len"

-.Ft ip_t *

-.Fn ip_close "ip_t *i"

-.Ss Internet Protocol Version 6

-.Ft void

-.Fn ip6_checksum "void *buf" "size_t len"

-.Ss Random number generation

-.Pp

-.Ft rand_t *

-.Fn rand_open "void"

-.Ft int

-.Fn rand_get "rand_t *r" "void *buf" "size_t len"

-.Ft int

-.Fn rand_set "rand_t *r" "const void *seed" "size_t len"

-.Ft int

-.Fn rand_add "rand_t *r" "const void *buf" "size_t len"

-.Ft uint8_t

-.Fn rand_uint8 "rand_t *r"

-.Ft uint16_t

-.Fn rand_uint16 "rand_t *r"

-.Ft uint32_t

-.Fn rand_uint32 "rand_t *r"

-.Ft int

-.Fn rand_shuffle "rand_t *r" "void *base" "size_t nmemb" "size_t size"

-.Ft rand_t *

-.Fn rand_close "rand_t *r"

-.Ss Routing

-.Pp

-.Li typedef Ar int Fn (*route_handler) "const struct route_entry *entry" "void *arg"

-.Ft route_t *

-.Fn route_open "void"

-.Ft int

-.Fn route_add "route_t *r" "const struct route_entry *entry"

-.Ft int

-.Fn route_delete "route_t *r" "const struct route_entry *entry"

-.Ft int

-.Fn route_get "route_t *r" "struct route_entry *entry"

-.Ft int

-.Fn route_loop "route_t *r" "route_handler callback" "void *arg"

-.Ft route_t *

-.Fn route_close "route_t *r"

-.Ss Tunnel interface

-.Pp

-.Ft tun_t *

-.Fn tun_open "struct addr *src" "struct addr *dst" "int mtu"

-.Ft int

-.Fn tun_fileno "tun_t *t"

-.Ft const char *

-.Fn tun_name "tun_t *t"

-.Ft ssize_t

-.Fn tun_send "tun_t *t" "const void *buf" "size_t size"

-.Ft ssize_t

-.Fn tun_recv "tun_t *t" "void *buf" "size_t size"

-.Ft tun_t *

-.Fn tun_close "tun_t *t"

-.Pp

-.Sh DESCRIPTION

-.Nm

+.TH "DNET" "3" "August 21, 2001" "SunOS 5.11" "Library Functions Manual"

+.SH "NAME"

+\fBdnet\fP

+\- dumb networking library

+.SH "SYNOPSIS"

+#include <dnet.h>

+.SS "Network addressing"

+.LP

+.nf

+int

+addr_cmp(const struct addr *a, const struct addr *b);

+

+int

+addr_bcast(const struct addr *a, struct addr *b);

+

+int

+addr_net(const struct addr *a, struct addr *b);

+

+char *

+addr_ntop(const struct addr *src, char *dst size_t size);

+

+int

+addr_pton(const char *src, struct addr *dst);

+

+char *

+addr_ntoa(const struct addr *a);

+

+int

+addr_aton(const char *src, struct addr *dst);

+

+int

+addr_ntos(const struct addr *a, struct sockaddr *sa);

+

+int

+addr_ston(const struct sockaddr *sa, struct addr *a);

+

+int

+addr_btos(uint16_t bits, struct sockaddr *sa);

+

+int

+addr_stob(const struct sockaddr *sa, uint16_t *bits);

+

+int

+addr_btom(uint16_t bits, void *mask, size_t size);

+

+int

+addr_mtob(const void *mask, size_t size, uint16_t *bits);

+.fi

+.SS "Address Resolution Protocol"

+.LP

+.nf

+typedef int (*arp_handler)(const struct arp_entry *entry, void *arg);

+

+arp_t *

+arp_open(void);

+

+int

+arp_add(arp_t *a, const struct arp_entry *entry);

+

+int

+arp_delete(arp_t *a, const struct arp_entry *entry);

+

+int

+arp_get(arp_t *a, struct arp_entry *entry);

+

+int

+arp_loop(arp_t *a, arp_handler callback, void *arg);

+

+arp_t *

+arp_close(arp_t *a);

+.fi

+.SS "Binary buffers"

+.LP

+.nf

+blob_t *

+blob_new(void);

+

+int

+blob_read(blob_t *b, void *buf, int len);

+

+int

+blob_write(blob_t *b, const void *buf, int len);

+

+int

+blob_seek(blob_t *b, int off, int whence);

+

+int

+blob_index(blob_t *b, const void *buf, int len);

+

+int

+blob_rindex(blob_t *b, const void *buf, int len);

+

+int

+blob_pack(blob_t *b, const void *fmt, ...);

+

+int

+blob_unpack(blob_t *b, const void *fmt, ...);

+

+int

+blob_print(blob_t *b, char *style, int len);

+

+blob_t *

+blob_free(blob_t *b);

+.fi

+.SS "Ethernet"

+.LP

+.nf

+eth_t *

+eth_open(const char *device);

+

+int

+eth_get(eth_t *e, eth_addr_t *ea);

+

+int

+eth_set(eth_t *e, const eth_addr_t *ea);

+

+ssize_t

+eth_send(eth_t *e, const void *buf, size_t len);

+

+eth_t *

+eth_close(eth_t *e);

+.fi

+.SS "Firewalling"

+.LP

+.nf

+typedef int (*fw_handler)(const struct fw_rule *rule, void *arg);

+

+fw_t *

+fw_open void

+

+int

+fw_add(fw_t *f, const struct fw_rule *rule);

+

+int

+fw_delete(fw_t *f, const struct fw_rule *rule);

+

+int

+fw_loop(fw_t *f, fw_handler callback, void *arg);

+

+fw_t *

+fw_close(fw_t *f);

+.fi

+.SS "Network interfaces"

+.LP

+.nf

+typedef int (*intf_handler)(const struct intf_entry *entry void *arg);

+

+intf_t *

+intf_open(void);

+

+int

+intf_get(intf_t *i, struct intf_entry *entry);

+

+int

+intf_get_src(intf_t *i, struct intf_entry *entry, struct addr *src);

+

+int

+intf_get_dst(intf_t *i, struct intf_entry *entry, struct addr *dst);

+

+int

+intf_set(intf_t *i, const struct intf_entry *entry);

+

+int

+intf_loop(intf_t *i, intf_handler callback, void *arg);

+

+intf_t *

+intf_close(intf_t *i);

+.fi

+.SS "Internet Protocol"

+.LP

+.nf

+ip_t *

+ip_open(void);

+

+ssize_t

+ip_add_option(void *buf, size_t len, int proto, const void *optbuf, size_t optlen);

+

+void

+ip_checksum(void *buf, size_t len);

+

+ssize_t

+ip_send(ip_t *i, const void *buf, size_t len);

+

+ip_t *

+ip_close(ip_t *i);

+.fi

+.SS "Internet Protocol Version 6"

+.LP

+.nf

+void

+ip6_checksum(void *buf, size_t len);

+.fi

+.SS "Random number generation"

+.LP

+.nf

+rand_t *

+rand_open(void);

+

+int

+rand_get(rand_t *r, void *buf, size_t len);

+

+int

+rand_set(rand_t *r, const void *seed, size_t len);

+

+int

+rand_add(rand_t *r, const void *buf, size_t len);

+

+uint8_t

+rand_uint8(rand_t *r);

+

+uint16_t

+rand_uint16(rand_t *r);

+

+uint32_t

+rand_uint32(rand_t *r);

+

+int

+rand_shuffle(rand_t *r, void *base, size_t nmemb, size_t size);

+

+rand_t *

+rand_close(rand_t *r);

+.fi

+.SS "Routing"

+.LP

+.nf

+typedef int (*route_handler)(const struct route_entry *entry void *arg);

+

+route_t *

+route_open(void);

+

+int

+route_add(route_t *r, const struct route_entry *entry);

+

+int

+route_delete(route_t *r, const struct route_entry *entry);

+

+int

+route_get(route_t *r, struct route_entry *entry);

+

+int

+route_loop(route_t *r, route_handler callback, void *arg);

+

+route_t *

+route_close(route_t *r);

+.fi

+.SS "Tunnel interface"

+.LP

+.nf

+tun_t *

+tun_open(struct addr *src, struct addr *dst, int mtu);

+

+int

+tun_fileno(tun_t *t);

+

+const char *

+tun_name(tun_t *t);

+

+ssize_t

+tun_send(tun_t *t, const void *buf, size_t size);

+

+ssize_t

+tun_recv(tun_t *t, void *buf, size_t size);

+

+tun_t *

+tun_close(tun_t *t);

+.fi

+.SH "DESCRIPTION"

+\fBdnet\fP

 provides a simplified, portable interface to several low-level

 networking routines, including network address manipulation, kernel

-.Xr arp 4

-cache and 

-.Xr route 4

+cache and

 table lookup and manipulation, network firewalling, network interface

 lookup and manipulation, and raw IP packet and Ethernet frame

 transmission. It is intended to complement the functionality provided

 by

-.Xr pcap 3 .

-.Pp

-In addition, 

-.Nm

+pcap(3).

+.PP

+In addition,

+\fBdnet\fP

 also provides platform-independent definitions of various network

 protocol formats and values for portable low-level network

 programming, as well as a simple binary buffer handling API.

-.Pp

-.Ss Network addressing

+.PP

+.SS "Network addressing"

 Network addresses are described by the following structure:

-.Bd -literal

+.nf

 struct addr {

 	uint16_t		addr_type;

 	uint16_t		addr_bits;

@@ -208,7 +298,7 @@

 		eth_addr_t	__eth;

 		ip_addr_t	__ip;

 		ip6_addr_t	__ip6;

-		

+

 		uint8_t		__data8[16];

 		uint16_t	__data16[8];

 		uint32_t	__data32[4];

@@ -220,279 +310,281 @@

 #define addr_data8	__addr_u.__data8

 #define addr_data16	__addr_u.__data16

 #define addr_data32	__addr_u.__data32

-.Ed

-.Pp

+.fi

+.PP

 The following values are defined for

-.Ar addr_type :

-.Bd -literal

+\fIaddr_type\fP:

+.nf

 #define ADDR_TYPE_NONE		0	/* No address set */

 #define	ADDR_TYPE_ETH		1	/* Ethernet */

 #define	ADDR_TYPE_IP		2	/* Internet Protocol v4 */

 #define	ADDR_TYPE_IP6		3	/* Internet Protocol v6 */

-.Ed

-.Pp

+.fi

+.PP

 The field

-.Ar addr_bits

+\fIaddr_bits\fP

 denotes the length of the network mask in bits.

-.Pp

-.Fn addr_cmp

+.PP

+addr_cmp

 compares network addresses