From 3ad482539ac218f4bafe4f0f841336a3240724e8 Mon Sep 17 00:00:00 2001
From: Ken Tobias <634380+l1a@users.noreply.github.com>
Date: Tue, 1 Sep 2026 12:51:29 -0700
Subject: [PATCH] Fix man page docs for etrs reconnect timeout

Document --reconnect-timeout in OPTIONS and ETR_SERVER_NETWORK_TMOUT
in ENVIRONMENT in man/etrs.1.md. Remove stale BUGS section.
Bump version to 0.8.2.

Assisted-By: Gemini 3.6 Flash
---
 Cargo.lock    |  2 +-
 Cargo.toml    |  2 +-
 NOTES.md      | 23 +++++++++++++++--------
 man/etrs.1.md | 14 ++++++++++----
 4 files changed, 27 insertions(+), 14 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index fdd30c0..ffbe176 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -599,7 +599,7 @@ dependencies = [
 
 [[package]]
 name = "etr"
-version = "0.8.1"
+version = "0.8.2"
 dependencies = [
  "clap",
  "clap_complete",
diff --git a/Cargo.toml b/Cargo.toml
index e637535..ded6400 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "etr"
-version = "0.8.1"
+version = "0.8.2"
 edition = "2024"
 description = "A Rust implementation of Eternal Terminal (et)"
 license = "GPL-3.0-only"
diff --git a/NOTES.md b/NOTES.md
index fd3d82c..17f21d0 100644
--- a/NOTES.md
+++ b/NOTES.md
@@ -9,7 +9,17 @@ the link drops.  This project uses **QUIC** (via the `quinn` crate) for the tran
 layer, which provides reliable, ordered, multiplexed streams with congestion control
 and TLS 1.3 built-in.
 
-## Current state: v0.8.1 — the completions helper could overwrite the binary it was asked to read
+## Current state: v0.8.2 — man page documentation for --reconnect-timeout
+## Current State (v0.8.2)
+
+Documentation fix (145 tests, unchanged).
+
+- **Documented `--reconnect-timeout` and `ETR_SERVER_NETWORK_TMOUT` in `man/etrs.1.md`.**
+  Added `--reconnect-timeout <SECS>` to OPTIONS and `ETR_SERVER_NETWORK_TMOUT` to ENVIRONMENT.
+- **Removed stale BUGS section from `man/etrs.1.md`.**
+  Removed the false claim that *"The reconnect window (30 minutes) is not configurable"*, which had been stale since v0.4.6.
+
+## Previous: v0.8.1 — the completions helper could overwrite the binary it was asked to read
 
 Tooling only; no runtime change (145 tests, unchanged).
 `scripts/install_completions.py` → **template v3**.
@@ -42,7 +52,7 @@ Tooling only; no runtime change (145 tests, unchanged).
   canonical LF file brings the two back into agreement, which is why this is a 50-line diff rather
   than a whole-file rewrite.
 
-## Current state: v0.8.0 — `-4`/`-6` address-family preference
+## Previous: v0.8.0 — `-4`/`-6` address-family preference
 
 New in v0.8.0 (client + server feature; 112 → 145 tests, one new e2e recipe).
 
@@ -104,13 +114,10 @@ New in v0.8.0 (client + server feature; 112 → 145 tests, one new e2e recipe).
   wrong family. `PROTOCOL.md` §2 documents `ETRPREFER:` (and `ETRX11:`, which it had never
   listed) plus the forward-compatibility rule that makes both safe.
 
-### Found while doing this, NOT fixed here
+### Found while doing this, ~~NOT fixed here~~ (Fixed in v0.8.2)
 
-- **`man/etrs.1.md`'s BUGS section still says "The reconnect window (30 minutes) is not
-  configurable."** It has been configurable since v0.4.6 — `--reconnect-timeout`,
-  `ETR_SERVER_NETWORK_TMOUT`, or `[server] reconnect_timeout` — and that flag is not
-  documented in the page's OPTIONS either. Left for its own PR rather than widened into
-  this one; it is a documentation defect, not a behaviour one.
+- ~~**`man/etrs.1.md`'s BUGS section still says "The reconnect window (30 minutes) is not
+  configurable."**~~ **Fixed in v0.8.2**: Documented `--reconnect-timeout` in OPTIONS and `ETR_SERVER_NETWORK_TMOUT` in ENVIRONMENT; removed stale BUGS entry.
 
 ## Previous: v0.7.9 — the release checklist no longer deletes the handoff file
 
diff --git a/man/etrs.1.md b/man/etrs.1.md
index 9ff9e5f..362ea60 100644
--- a/man/etrs.1.md
+++ b/man/etrs.1.md
@@ -73,6 +73,12 @@ window expires), the child exits.
 **\-\-log-path** *PATH*
 :   Path to the server log file. Defaults to **\$XDG_STATE_HOME/etr/etrs.log**.
 
+**\-\-reconnect\-timeout** *SECS*
+:   How long (in seconds) to keep a session alive while the client is
+    disconnected. Defaults to **1800** (30 minutes). Override priority:
+    CLI flag > **ETR_SERVER_NETWORK_TMOUT** > **reconnect_timeout** under
+    **\[server\]** in config file > default.
+
 **-h**, **\-\-help**
 :   Print help and exit.
 
@@ -90,6 +96,10 @@ window expires), the child exits.
 **SHELL**
 :   Shell to launch for the PTY session. Defaults to **/bin/bash** if unset.
 
+**ETR_SERVER_NETWORK_TMOUT**
+:   How long (in seconds) to keep a session alive while disconnected if
+    **\-\-reconnect\-timeout** is not specified.
+
 **XDG_STATE_HOME**
 :   Base directory for the log file. Defaults to **~/.local/state**.
 
@@ -118,10 +128,6 @@ gateway-mode reverse forwarding.
 
 **etr**(1), **ssh**(1)
 
-# BUGS
-
-- The reconnect window (30 minutes) is not configurable.
-
 # AUTHORS
 
 The etr project contributors. See the source repository for details.