about summary refs log tree commit diff
path: root/loxy.8
diff options
context:
space:
mode:
Diffstat (limited to 'loxy.8')
-rw-r--r--loxy.854
1 files changed, 54 insertions, 0 deletions
diff --git a/loxy.8 b/loxy.8
new file mode 100644
index 0000000..612d3c0
--- /dev/null
+++ b/loxy.8
@@ -0,0 +1,54 @@
+.\" SPDX-FileCopyrightText: V <v@anomalous.eu>
+.\" SPDX-FileCopyrightText: edef <edef@edef.eu>
+.\" SPDX-License-Identifier: OSL-3.0
+.Dd June 9, 2020
+.Dt LOXY 8
+.Os
+.
+.Sh NAME
+.Nm loxy
+.Nd logging IRC proxy
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl addr Oo Ar host Oc : Ns Ar port
+.Op Fl cert Ar path
+.Op Fl db Ar path
+.
+.Sh DESCRIPTION
+.Nm
+is a logging IRC proxy.
+It sits between your IRC client and the IRC servers you connect to, and logs timestamped raw IRC protocol lines to an SQLite database.
+It is implemented as an HTTP proxy server, making it compatible with most modern IRC clients.
+.
+.Sh OPTIONS
+.Bl -tag -width addr
+.It Fl addr Oo Ar host Oc : Ns Ar port
+Listening address.
+If
+.Ar port
+is specified, but
+.Ar host
+is empty,
+.Nm
+will listen on all available interfaces.
+Defaults to
+.Sy [::1]:3893 .
+Incompatible with
+.Xr systemd.socket 5
+activation.
+.It Fl cert Ar path
+Path to a file containing a PEM-encoded X.509 certificate and its corresponding private key.
+.It Fl db Ar path
+Path for the SQLite database.
+Defaults to
+.Pa loxy.db .
+.El
+.
+.Sh AUTHORS
+.An -nosplit
+.Nm
+was written by
+.An V Aq Mt v@anomalous.eu
+and
+.An edef Aq Mt edef@edef.eu .