summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoachim Nilsson <troglobit@gmail.com>2019-10-15 06:52:03 +0200
committerJoachim Nilsson <troglobit@gmail.com>2019-10-15 06:52:03 +0200
commit3eb53ad1c2fe171869705f278d38fe579c31ad60 (patch)
tree90bca2bc860a0ae63661cfccf753878d08a6b593
parenta181ce51915f2e2ee5bf276bb489bfb1de4b3a87 (diff)
downloadlibnet-3eb53ad1c2fe171869705f278d38fe579c31ad60.tar.gz
doc: Rename and convert Raw socket heads-up to Markdown
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
-rw-r--r--debian/libnet1-doc.docs2
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/RAWSOCKET.md46
-rw-r--r--doc/RAWSOCKET_NON_SEQUITUR39
4 files changed, 48 insertions, 41 deletions
diff --git a/debian/libnet1-doc.docs b/debian/libnet1-doc.docs
index dd2c687..8e4fd58 100644
--- a/debian/libnet1-doc.docs
+++ b/debian/libnet1-doc.docs
@@ -1,4 +1,4 @@
README
doc/MIGRATION.md
-doc/RAWSOCKET_NON_SEQUITUR
+doc/RAWSOCKET.md
doc/html/
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8ed2ef1..255c143 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,5 @@
SUBDIRS = man
-dist_doc_DATA = MIGRATION.md RAWSOCKET_NON_SEQUITUR
+dist_doc_DATA = MIGRATION.md RAWSOCKET.md
EXTRA_DIST = fixmanpages.in libnet.Pod
EXTRA_DIST += api-main.md api-head.html api-foot.html api-style.css
DISTCLEANFILES = libnet.tag
diff --git a/doc/RAWSOCKET.md b/doc/RAWSOCKET.md
new file mode 100644
index 0000000..f942ab7
--- /dev/null
+++ b/doc/RAWSOCKET.md
@@ -0,0 +1,46 @@
+Raw Socket Non-Sequitur
+=======================
+by Mike D. Schiffman <mike@infonexus.com>
+
+Raw sockets are horribly non-standard across implementations. Here is
+an incomplete list of some of the differences (corrections welcomed).
+
+Solaris, for example, has terrible support for this packet interface.
+Older OpenBSD versions and FreeBSD before 11 versions have the
+`BSD_BYTE_SWAP` issue where the `ip_len` and `ip_frag` fields must be in
+host byte order. Linux apparently doesn't allow for the injection of
+broadcast IP datagrams. Whenever complete control over the IP header is
+desired, use the link layer API.
+
+
+Linux 2.2+
+----------
+
+ IP fragmentation: performed if packet is larger than MTU
+ IP checksum: always filled in
+ IP total length: always filled in
+ IP ID: filled in when zero
+ IP source address: filled in when zero
+ IP destination address: filled in when zero
+
+ Max packet size before kernel complains: 1500 bytes
+
+
+Solaris 2.6+
+------------
+
+ IP fragmentation bits: can't specify
+ IP fragmentation: performed if packet is larger than MTU
+ IP DF bit: always set
+ IP checksum: always filled in
+
+ Max packet size before kernel complains: ?
+
+
+OpenBSD 2.8+
+------------
+
+ IP fragmentation: performed if packet is larger than MTU
+
+ Max packet size before kernel complains: 8192 bytes
+
diff --git a/doc/RAWSOCKET_NON_SEQUITUR b/doc/RAWSOCKET_NON_SEQUITUR
deleted file mode 100644
index a6ac255..0000000
--- a/doc/RAWSOCKET_NON_SEQUITUR
+++ /dev/null
@@ -1,39 +0,0 @@
-===============================================================================
- $Id: RAWSOCKET_NON_SEQUITUR,v 1.2 2004/01/03 20:31:00 mike Exp $
- LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman <mike@infonexus.com>
- http://www.packetfactory.net/libnet
-===============================================================================
-
- Raw sockets are horribly non-standard across implementations. Here is
- an incomplete list of some of the differences (corrections welcomed):
-
- Linux 2.2+:
-
- IP fragmentation: performed if packet is larger than MTU
- IP checksum: always filled in
- IP total length: always filled in
- IP ID: filled in when zero
- IP source address: filled in when zero
- IP destination address: filled in when zero
- Max packet size before kernel complains: 1500 bytes
-
- Solaris 2.6+:
-
- IP fragmentation bits: can't specify
- IP fragmentation: performed if packet is larger than MTU
- IP DF bit: always set
- IP checksum: always filled in
- Max packet size before kernel complains: ?
-
- OpenBSD 2.8+:
-
- IP fragmentation: performed if packet is larger than MTU
- Max packet size before kernel complains: 8192 bytes
-
- Solaris,
- for example, has terrible support for this packet interface. Older OpenBSD
- versions and recent FreeBSD versions have the BSD_BYTE_SWAP issue where
- the ip_len and ip_frag fields need to be in little endian order. Linux
- apparently doesn't allow for the injection of broadcast IP datagrams.
- Whenever complete control over the IP header is desired, use the link
- layer API.