summaryrefslogtreecommitdiff
path: root/docs/MAX25-CLIENT.md
diff options
context:
space:
mode:
authorinfo@mode42.com <info@mode42.com>2026-08-07 18:25:13 +0000
committerinfo@mode42.com <info@mode42.com>2026-08-07 18:25:13 +0000
commit04d965d67a7264a1c7c211494aebda1953df7603 (patch)
tree0ebd700a6e219f84a26a656f4bee8778bc75da7b /docs/MAX25-CLIENT.md
Initial push
Diffstat (limited to 'docs/MAX25-CLIENT.md')
-rw-r--r--docs/MAX25-CLIENT.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/MAX25-CLIENT.md b/docs/MAX25-CLIENT.md
new file mode 100644
index 0000000..65ba453
--- /dev/null
+++ b/docs/MAX25-CLIENT.md
@@ -0,0 +1,36 @@
+# max25-client / M25/1 · MAX25-Stack 1.8.0
+
+M25/1 text protocol reference for client developers.
+
+## Protocol matrix
+
+| Item | Value |
+|------|-------|
+| Transport | TCP `:7325` or Unix socket |
+| Framing | line-oriented text commands |
+| Spec | `include/max25/protocol.md` |
+| Codec | in-tree — no kernel AX.25 required |
+
+## Session matrix
+
+| Phase | Commands |
+|-------|----------|
+| Select device | `SET DEVICE`, `LIST DEVICES` |
+| Connect | `CONNECT`, `DISCONNECT` |
+| Transfer | `SEND`, status queries |
+| Ban list | `BAN`, `UNBAN`, `BANS` |
+
+## Client profile matrix
+
+| Item | Path |
+|------|------|
+| Profiles | `share/clients/` |
+| Index | `share/clients/index.yaml` |
+| Official client | `max25-terminal` only |
+
+## Related
+
+| Goal | Doc |
+|------|-----|
+| Terminal operator | [MAX25-TERMINAL.md](MAX25-TERMINAL.md) |
+| Architecture | [ARCHITECTURE.md](ARCHITECTURE.md) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com