From ac1978db40795c76202c010583a40c7d108bdf68 Mon Sep 17 00:00:00 2001 From: XANTRONIX Development Date: Mon, 23 Dec 2024 12:14:44 -0500 Subject: [PATCH] Add README --- README | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..69cfad8 --- /dev/null +++ b/README @@ -0,0 +1,46 @@ + +patty AX.25 stack + + patty (packet TTY multiplexer) is a portable implementation of the AX.25 2.2 + standard, able to run in userland on many POSIX-like operating systems. The + software uses the KISS TNC protocol to communicate with hardware. + +Features + + * Full support for AX.25 2.2 stateful connections + + * BSD sockets-like API for listening, accepting, establishing, and creating + connections + + * Separate BSD sockets-like API for sending/receiving Unnumbered Information + (UI) datagrams + + * Supports one separate program per SSID (up to 16) to accept inbound + connections + + * Supports thousands of concurrent inbound and outbound stateful connections + + * Able to multiplex a single KISS TNC to multiple software endpoints via + BSD pseudoterminals + + * Allows APRS-IS connections to be used by software speaking the KISS TNC + protocol + +Building + + $ ./configure + $ make + $ sudo make install + +Manual + + Section 5 - Configuration file formats + + pattyd.conf(5) AX.25 daemon configuration file + + Section 8 - System binaries + + ax25dump(8) dump AX.25 traffic + pattyd(8) AX.25 userland stack daemon + tncd(8) create a KISS TNC from an AX.25 interface +