From 70f7800986812ad0d1a5dd6f280f66fd2bf1dd12 Mon Sep 17 00:00:00 2001
From: Thijs Schreijer <thijs@thijsschreijer.nl>
Date: Tue, 1 Sep 2026 10:00:21 +0200
Subject: docs: document socket.unix and socket.serial, fix stale/missing API
 references

Pre-release documentation audit against master. Adds the two fully
undocumented modules and closes gaps found by diffing every docs/*.html
page against its corresponding source:

- New docs/unix.html and docs/serial.html (socket.unix stream/dgram and
  socket.serial were never documented), linked from index.html,
  introduction.html, socket.html and reference.html. serial.html notes
  the current lack of a baud/parity/flow-control API and includes an
  os.execute+stty workaround example. Both note Windows is unsupported.
- socket.html: document headers.setcanonic, point to unix/serial modules.
- tcp.html: document getfamily, setpeername/setsockname aliases.
- udp.html: document getfamily, getfd/setfd, dirty; document the
  ipv6-multicast-hops/ipv6-unicast-hops aliasing as current (known-buggy)
  behavior rather than the originally intended semantics.
- http.html: correct redirect text (301/302/303/307/308, was 301/302
  only); document MAXHEADERLINE/MAXHEADERSIZE.
- dns.html: document getnameinfo.
- ltn12.html: document source.rewind and BLOCKSIZE.
- installation.html: fix stale "LuaSocket 3.0" sample output to 3.1.0.
- reference.html: index every anchor added above plus new Unix/Serial
  blocks.
---
 docs/reference.html | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

(limited to 'docs/reference.html')

diff --git a/docs/reference.html b/docs/reference.html
index 2bc5f78..7425716 100644
--- a/docs/reference.html
+++ b/docs/reference.html
@@ -43,6 +43,7 @@ Support, Manual">
 <a href="dns.html">DNS (in socket)</a>
 <blockquote>
 <a href="dns.html#getaddrinfo">getaddrinfo</a>,
+<a href="dns.html#getnameinfo">getnameinfo</a>,
 <a href="dns.html#gethostname">gethostname</a>,
 <a href="dns.html#tohostname">tohostname</a>,
 <a href="dns.html#toip">toip</a>.
@@ -73,6 +74,9 @@ Support, Manual">
 <blockquote>
 <a href="ltn12.html">LTN12</a>
 <blockquote>
+<a href="ltn12.html#BLOCKSIZE">BLOCKSIZE</a>.
+</blockquote>
+<blockquote>
 <a href="ltn12.html#filter">filter</a>:
 <a href="ltn12.html#filter.chain">chain</a>,
 <a href="ltn12.html#filter.cycle">cycle</a>.
@@ -98,6 +102,7 @@ Support, Manual">
 <a href="ltn12.html#source.empty">empty</a>,
 <a href="ltn12.html#source.error">error</a>,
 <a href="ltn12.html#source.file">file</a>,
+<a href="ltn12.html#source.rewind">rewind</a>,
 <a href="ltn12.html#source.simplify">simplify</a>,
 <a href="ltn12.html#source.string">string</a>,
 <a href="ltn12.html#source.table">table</a>.
@@ -129,6 +134,23 @@ Support, Manual">
 </blockquote>
 </blockquote>
 
+<!-- serial +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
+
+<blockquote>
+<a href="serial.html">Serial</a>
+<blockquote>
+<a href="serial.html#close">close</a>,
+<a href="serial.html#getfd">getfd</a>,
+<a href="serial.html#getstats">getstats</a>,
+<a href="serial.html#receive">receive</a>,
+<a href="serial.html#send">send</a>,
+<a href="serial.html#setfd">setfd</a>,
+<a href="serial.html#setstats">setstats</a>,
+<a href="serial.html#settimeout">settimeout</a>,
+<a href="serial.html#socket.serial">socket.serial</a>.
+</blockquote>
+</blockquote>
+
 <!-- smtp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
 
 <blockquote>
@@ -153,6 +175,7 @@ Support, Manual">
 <a href="dns.html#dns">dns</a>,
 <a href="socket.html#gettime">gettime</a>,
 <a href="socket.html#headers.canonic">headers.canonic</a>,
+<a href="socket.html#headers.setcanonic">headers.setcanonic</a>,
 <a href="socket.html#newtry">newtry</a>,
 <a href="socket.html#protect">protect</a>,
 <a href="socket.html#select">select</a>,
@@ -183,6 +206,7 @@ Support, Manual">
 <a href="tcp.html#close">close</a>,
 <a href="tcp.html#connect">connect</a>,
 <a href="tcp.html#dirty">dirty</a>,
+<a href="tcp.html#getfamily">getfamily</a>,
 <a href="tcp.html#getfd">getfd</a>,
 <a href="tcp.html#getoption">getoption</a>,
 <a href="tcp.html#getpeername">getpeername</a>,
@@ -194,6 +218,8 @@ Support, Manual">
 <a href="tcp.html#send">send</a>,
 <a href="tcp.html#setfd">setfd</a>,
 <a href="tcp.html#setoption">setoption</a>,
+<a href="tcp.html#setpeername">setpeername</a>,
+<a href="tcp.html#setsockname">setsockname</a>,
 <a href="tcp.html#setstats">setstats</a>,
 <a href="tcp.html#settimeout">settimeout</a>,
 <a href="tcp.html#shutdown">shutdown</a>.
@@ -206,6 +232,9 @@ Support, Manual">
 <a href="udp.html">UDP (in socket)</a>
 <blockquote>
 <a href="udp.html#close">close</a>,
+<a href="udp.html#dirty">dirty</a>,
+<a href="udp.html#getfamily">getfamily</a>,
+<a href="udp.html#getfd">getfd</a>,
 <a href="udp.html#getoption">getoption</a>,
 <a href="udp.html#getpeername">getpeername</a>,
 <a href="udp.html#getsockname">getsockname</a>,
@@ -214,6 +243,7 @@ Support, Manual">
 <a href="udp.html#receivefrom">receivefrom</a>,
 <a href="udp.html#send">send</a>,
 <a href="udp.html#sendto">sendto</a>,
+<a href="udp.html#setfd">setfd</a>,
 <a href="udp.html#setpeername">setpeername</a>,
 <a href="udp.html#setsockname">setsockname</a>,
 <a href="udp.html#setoption">setoption</a>,
@@ -221,6 +251,48 @@ Support, Manual">
 </blockquote>
 </blockquote>
 
+<!-- unix +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
+
+<blockquote>
+<a href="unix.html">Unix</a>
+<blockquote>
+<a href="unix.html#socket.unix.stream">socket.unix.stream</a>:
+<a href="unix.html#stream.accept">accept</a>,
+<a href="unix.html#stream.bind">bind</a>,
+<a href="unix.html#stream.close">close</a>,
+<a href="unix.html#stream.connect">connect</a>,
+<a href="unix.html#stream.dirty">dirty</a>,
+<a href="unix.html#stream.getfd">getfd</a>,
+<a href="unix.html#stream.getsockname">getsockname</a>,
+<a href="unix.html#stream.getstats">getstats</a>,
+<a href="unix.html#stream.listen">listen</a>,
+<a href="unix.html#stream.receive">receive</a>,
+<a href="unix.html#stream.send">send</a>,
+<a href="unix.html#stream.setfd">setfd</a>,
+<a href="unix.html#stream.setoption">setoption</a>,
+<a href="unix.html#stream.setstats">setstats</a>,
+<a href="unix.html#stream.settimeout">settimeout</a>,
+<a href="unix.html#stream.shutdown">shutdown</a>.
+</blockquote>
+<blockquote>
+<a href="unix.html#socket.unix.dgram">socket.unix.dgram</a>:
+<a href="unix.html#dgram.bind">bind</a>,
+<a href="unix.html#dgram.close">close</a>,
+<a href="unix.html#dgram.connect">connect</a>,
+<a href="unix.html#dgram.dirty">dirty</a>,
+<a href="unix.html#dgram.getfd">getfd</a>,
+<a href="unix.html#dgram.getsockname">getsockname</a>,
+<a href="unix.html#dgram.gettimeout">gettimeout</a>,
+<a href="unix.html#dgram.receive">receive</a>,
+<a href="unix.html#dgram.receivefrom">receivefrom</a>,
+<a href="unix.html#dgram.send">send</a>,
+<a href="unix.html#dgram.sendto">sendto</a>,
+<a href="unix.html#dgram.setfd">setfd</a>,
+<a href="unix.html#dgram.setoption">setoption</a>,
+<a href="unix.html#dgram.settimeout">settimeout</a>.
+</blockquote>
+</blockquote>
+
 <!-- url ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
 
 <blockquote>
-- 
cgit v1.2.3-55-g6feb