pat/README.md

<a href="http://getpat.io"><img src="https://raw.githubusercontent.com/la5nta/pat-website/gh-pages/img/logo.png" width="128" ></a>

[![Build status](https://github.com/la5nta/pat/actions/workflows/go.yaml/badge.svg)](https://github.com/la5nta/pat/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/la5nta/pat)](https://goreportcard.com/report/github.com/la5nta/pat)
[![Liberapay Patreons](http://img.shields.io/liberapay/patrons/la5nta.svg?logo=liberapay)](https://liberapay.com/la5nta)

## Overview

Pat is a cross platform Winlink client with basic messaging capabilities.

It is the primary sandbox/prototype application for the [wl2k-go](https://github.com/la5nta/wl2k-go) project, and provides both a command line interface and a responsive (mobile-friendly) web interface.

It is mainly developed for Linux, but is also known to run on OS X, Windows and Android.

#### Features
* Message composer/reader (basic mailbox functionality).
* Auto-shrink image attachments.
* Post position reports with location from local GPS, browser location or manual entry.
* Rig control (using hamlib).
* CRON-like syntax for execution of scheduled commands (e.g. QSY or connect).
* Built in http-server with web interface (mobile friendly).
* Git style command line interface.
* Listen for P2P connections using multiple modes concurrently.
* AX.25, telnet, PACTOR and ARDOP support.
* Experimental gzip message compression (See "Gzip experiment" below).

##### Example
```
martinhpedersen@duo:~$ pat interactive
> listen winmor,telnet-p2p,ax25
2015/02/03 10:33:10 Listening for incoming traffic (winmor,telnet-p2p,ax25)...
> connect winmor:///LA3F
2015/02/03 10:34:28 Connecting to winmor:LA3F...
2015/02/03 10:34:33 Connected to WINMOR:LA3F
RMS Trimode 1.3.3.0 Follo.SE Oslo. Pactor & Winmor Hybrid Gateway
LA5NTA has 117 minutes remaining with LA3F
[WL2K-2.8.4.8-B2FWIHJM$]
Wien CMS via LA3F >
>FF
FC EM FOYNU8AKXX59 260 221 0
F> 68
1 proposal(s) received
Accepting FOYNU8AKXX59
Receiving [//WL2K test til linux] [offset 0]
>FF
FQ
Waiting for remote node to close the connection...
> _
```

### Gzip experiment

Gzip message compression has been added as an experimental B2F extension. The extension is implemented as a backwards compatible alternative to the ancient LZHUF compression.

This experiment is enabled by default and sessions between two Pat nodes (or other software supporting this B2F extension) will use gzip compression when transferring messages.

For more information, see <https://github.com/la5nta/wl2k-go#gzip-experiment>.

## Copyright/License

Copyright (c) 2020 Martin Hebnes Pedersen LA5NTA

### Contributors (alphabetical)

* AB3E - Justin Overfelt
* DL1THM - Torsten Harenberg
* HB9GPA - Matthias Renner
* K0RET - Ryan Turner
* K0SWE - Chris Keller
* KD8DRX - Will Davidson
* KE8HMG - Andrew Huebner
* KI7RMJ - Rainer Grosskopf
* KM6LBU - Robert Hernandez
* LA3QMA - Kai Günter Brandt
* LA4TTA - Erlend Grimseid
* LA5NTA - Martin Hebnes Pedersen
* N2YGK - Alan Crosswell
* VE7GNU - Doug Collinge
* W6IPA  - JC Martin
* WY2K - Benjamin Seidenberg

## Thanks to

The JNOS developers for the properly maintained lzhuf implementation, as well as the original author Haruyasu Yoshizaki.

The paclink-unix team (Nicholas S. Castellano N2QZ and others) - reference implementation

Amateur Radio Safety Foundation, Inc. - The Winlink 2000 project

F6FBB Jean-Paul ROUBELAT - the FBB forwarding protocol

_Pat/wl2k-go is not affiliated with The Winlink Development Team nor the Winlink 2000 project [http://winlink.org]._
README.md: Add goreportcard and logo 2016-05-11 19:01:17 +02:00			`<a href="http://getpat.io"><img src="https://raw.githubusercontent.com/la5nta/pat-website/gh-pages/img/logo.png" width="128" ></a>`

Use Github Actions (#390) Switch from Travis and AppVeyor to Github Actions. We keep running out of OSS credits from Travis, and it's a pain having to request more credits via email every time. 2023-01-29 10:46:30 +01:00			`[![Build status](https://github.com/la5nta/pat/actions/workflows/go.yaml/badge.svg)](https://github.com/la5nta/pat/actions)`
README.md: Add goreportcard and logo 2016-05-11 19:01:17 +02:00			`[![Go Report Card](https://goreportcard.com/badge/github.com/la5nta/pat)](https://goreportcard.com/report/github.com/la5nta/pat)`
Update README.md Add Liberapay shield 2019-09-21 00:45:37 +02:00			`[![Liberapay Patreons](http://img.shields.io/liberapay/patrons/la5nta.svg?logo=liberapay)](https://liberapay.com/la5nta)`
Add README.md 2016-02-22 22:43:33 +01:00
README.md: Add goreportcard and logo 2016-05-11 19:01:17 +02:00			`## Overview`
Add README.md 2016-02-22 22:43:33 +01:00
			`Pat is a cross platform Winlink client with basic messaging capabilities.`

			`It is the primary sandbox/prototype application for the [wl2k-go](https://github.com/la5nta/wl2k-go) project, and provides both a command line interface and a responsive (mobile-friendly) web interface.`

Fix typing errors in documentation and comments Some errors were found using codespell. 2021-09-26 14:49:09 +02:00			`It is mainly developed for Linux, but is also known to run on OS X, Windows and Android.`
Add README.md 2016-02-22 22:43:33 +01:00
			`#### Features`
			`* Message composer/reader (basic mailbox functionality).`
Update README.md 2016-08-05 13:43:52 +02:00			`* Auto-shrink image attachments.`
Add README.md 2016-02-22 22:43:33 +01:00			`* Post position reports with location from local GPS, browser location or manual entry.`
Remove WINMOR support Resolves #331. 2022-03-18 17:40:16 -06:00			`* Rig control (using hamlib).`
Add README.md 2016-02-22 22:43:33 +01:00			`* CRON-like syntax for execution of scheduled commands (e.g. QSY or connect).`
			`* Built in http-server with web interface (mobile friendly).`
			`* Git style command line interface.`
			`* Listen for P2P connections using multiple modes concurrently.`
Remove WINMOR support Resolves #331. 2022-03-18 17:40:16 -06:00			`* AX.25, telnet, PACTOR and ARDOP support.`
Add README.md 2016-02-22 22:43:33 +01:00			`* Experimental gzip message compression (See "Gzip experiment" below).`

			`##### Example`
			```
			`martinhpedersen@duo:~$ pat interactive`
			`> listen winmor,telnet-p2p,ax25`
			`2015/02/03 10:33:10 Listening for incoming traffic (winmor,telnet-p2p,ax25)...`
			`> connect winmor:///LA3F`
			`2015/02/03 10:34:28 Connecting to winmor:LA3F...`
			`2015/02/03 10:34:33 Connected to WINMOR:LA3F`
			`RMS Trimode 1.3.3.0 Follo.SE Oslo. Pactor & Winmor Hybrid Gateway`
			`LA5NTA has 117 minutes remaining with LA3F`
			`[WL2K-2.8.4.8-B2FWIHJM$]`
			`Wien CMS via LA3F >`
			`>FF`
			`FC EM FOYNU8AKXX59 260 221 0`
			`F> 68`
			`1 proposal(s) received`
			`Accepting FOYNU8AKXX59`
			`Receiving [//WL2K test til linux] [offset 0]`
			`>FF`
			`FQ`
			`Waiting for remote node to close the connection...`
			`> _`
			```

			`### Gzip experiment`

Update README.md 2016-08-05 13:43:52 +02:00			`Gzip message compression has been added as an experimental B2F extension. The extension is implemented as a backwards compatible alternative to the ancient LZHUF compression.`

Fix typo in README.md 2016-08-25 23:03:43 +02:00			`This experiment is enabled by default and sessions between two Pat nodes (or other software supporting this B2F extension) will use gzip compression when transferring messages.`
Add README.md 2016-02-22 22:43:33 +01:00
Update README.md 2016-03-11 19:50:39 +01:00			`For more information, see <https://github.com/la5nta/wl2k-go#gzip-experiment>.`
Add README.md 2016-02-22 22:43:33 +01:00
			`## Copyright/License`

Update copyright year 2020-02-20 21:46:06 +01:00			`Copyright (c) 2020 Martin Hebnes Pedersen LA5NTA`
Add README.md 2016-02-22 22:43:33 +01:00
			`### Contributors (alphabetical)`

Add mps command for managing message pickup stations ref #51 2025-06-11 00:06:17 +00:00			`* AB3E - Justin Overfelt`
Add Torsten and me to the contributors list 2019-09-26 11:34:43 +02:00			`* DL1THM - Torsten Harenberg`
			`* HB9GPA - Matthias Renner`
fix(manpage): update manpage to point users to proper paths for config, logs, and mailbox e94f05f37cc5866f66e88d177dc39b2b5dc579a0 introduced a change, but the docs got missed. This follows up on that to fix the manpage documentation. As a chore at the same time, this fixes dev doc references to old travis-ci paths and adds the committer as a contributor. Closes !326 2022-04-06 20:40:46 -05:00			`* K0RET - Ryan Turner`
Add xylo04 to contributors 2019-12-02 15:04:00 -07:00			`* K0SWE - Chris Keller`
Add Will to contributors list 2016-09-12 18:20:23 +02:00			`* KD8DRX - Will Davidson`
Added name to contributers Added name to contributers 2017-11-13 17:41:33 -05:00			`* KE8HMG - Andrew Huebner`
added CLI option composeform for generating a message based on Winlink forms, like ICS213 2020-11-14 13:51:23 -08:00			`* KI7RMJ - Rainer Grosskopf`
add KM6LBU as contributor to readme 2024-08-31 19:40:16 +00:00			`* KM6LBU - Robert Hernandez`
Add README.md 2016-02-22 22:43:33 +01:00			`* LA3QMA - Kai Günter Brandt`
Add Erlend to the contributors list For his great effort with on-air testing of patches/fixes with me, and helping me answer pat-users messages. Thanks! 2017-02-23 17:44:22 +01:00			`* LA4TTA - Erlend Grimseid`
Add README.md 2016-02-22 22:43:33 +01:00			`* LA5NTA - Martin Hebnes Pedersen`
Add several (some undocumented) insertion tags that are required for the Winlink Check In form. 2022-03-13 17:26:46 -04:00			`* N2YGK - Alan Crosswell`
Fix ordering of contributors list 2022-04-07 22:01:09 +02:00			`* VE7GNU - Doug Collinge`
Add Distance and Azimuth in rmslist 2017-12-14 09:57:29 -08:00			`* W6IPA - JC Martin`
Add myself to contributor list 2021-12-02 18:34:08 -08:00			`* WY2K - Benjamin Seidenberg`
Add README.md 2016-02-22 22:43:33 +01:00
			`## Thanks to`

			`The JNOS developers for the properly maintained lzhuf implementation, as well as the original author Haruyasu Yoshizaki.`

			`The paclink-unix team (Nicholas S. Castellano N2QZ and others) - reference implementation`

			`Amateur Radio Safety Foundation, Inc. - The Winlink 2000 project`

			`F6FBB Jean-Paul ROUBELAT - the FBB forwarding protocol`

			`_Pat/wl2k-go is not affiliated with The Winlink Development Team nor the Winlink 2000 project [http://winlink.org]._`