diff options
| -rw-r--r-- | README.md | 38 | ||||
| -rw-r--r-- | man/linea-caliente.1 | 26 |
2 files changed, 64 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0fd43bf --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Linea Caliente + +A hotline protocol server and library written in rust. + +Everything is under construction, so unless this message isn't here, anything +below this is aspirational rather than reflective of reality. + +## Using as a Server + +You can use linea caliente as a stand-alone server. The default command is: + +``` +linea-caliente +``` + +This will listen on 127.0.0.1:5500. You can specify the address to listen +with the `-l` / `--listen-address` flag. + +``` +linea-caliente -l 0.0.0.0:5500 +``` + +### Install via Homebrew + +Not yet done. + +### Install via cargo + +Not yet done. + +### Prebuilt releases + +Not yet done. + +## Using as a Library + +Linea caliente is also available to be imported as a library so you can build +your own hotline compatible clients and servers. diff --git a/man/linea-caliente.1 b/man/linea-caliente.1 new file mode 100644 index 0000000..f5316c9 --- /dev/null +++ b/man/linea-caliente.1 @@ -0,0 +1,26 @@ +.TH LINEA-CALIENTE 1 "2025-08-26" "1.0.0" "Linea Caliente Manual" +.SH NAME +linea-caliente \- hotline protocol server written in rust. +.SH SYNOPSIS +.B linea-caliente +[\fB\-l\fP|\fB\-\-listen\-address\fP=\fIADDRESS\fP] +[\fB\-\-help\fP] +.SH DESCRIPTION +.PP +linea-caliente is a hotline protocol server that lets you run your own hotline +communities. +.SH OPTIONS +.TP +.BR \-l ", " \-\-listen\-address =\fIADDRESS\fP +Set the listener address (default: 127.0.0.1:6666). The address should be in the +format <address>:<port> where <address> can be an IPv4 or IPv6 address (eg. +127.0.0.1:5500, or [::1]:5500). +.TP +.BR \-\-help +Display usage information and exit. +.SH VERSION +.BR 1.0.0 +.SH HOMEPAGE +.I https://r.bdr.sh/hotline.html +.SH AUTHORS +\ Rubén Beltrán del Río <\fIlinea.caliente@r.bdr.sh\fP> |