Add first draft of a man page

1 files changed, 125 insertions, 0 deletions

diff --git a/man1/opentracker.1 b/man1/opentracker.1
new file mode 100644
index 0000000..45d71cb
--- /dev/null
+++ b/man1/opentracker.1
@@ -0,0 +1,125 @@
+.Dd 15/4/2024
+.Dt opentracker 1
+.Os posix
+.Sh opentracker
+.Nm opentracker
+.Nd a free and open bittorrent tracker
+.Sh SYNOPSIS
+.Nm
+.Op Fl f Ar config
+.Op Fl i Ar ip-select
+.Op Fl p Ar port-bind-tcp
+.Op Fl P Ar port-bind-udp
+.Op Fl A Ar blessed-ip
+.Op Fl r Ar redirect-url
+.Op Fl d Ar chdir
+.Op Fl u Ar user
+.Op Fl w| Fl b accesslist
+.Sh DESCRIPTION
+.Nm
+is a bittorrent tracker that implements announce and scrape actions over the
+udp and the plain http protocol, aiming for minimal resource usage.
+.Pp
+
+When invoked with parameters, it binds to tcp and udp port 6969 on all
+interfaces. The recommended way to configure opentracker is by providing a
+config file using the
+.Op Fl f Ar config
+option. See 
+.Xr opentracker.conf 4
+for details.
+.Pp
+
+.Sh OPTIONS
+The following options are available:
+
+.Bl -tag -width -indent=8
+.It Fl f Ar config
+Parse a config file with a list of options. Consecutive command options
+will override options from the config file. See
+.Xr opentracker.conf 4
+for details.
+
+.It Fl i Ar ip-select
+Select an ip address that will be used with the next
+.Op Fl p
+or
+.Op Fl P
+command to actually bind to this address. Setting this option without any bind
+options in the config file or
+.Op Fl p
+or
+.Op Fl P
+commands will limit opentracker to only bind to this address.
+.It Fl p Ar port-bind-tcp
+Bind to the tcp port on the last preceding ip address set with the
+.Op Fl i ip-select
+option or to all available addresses if none has been set. Can be given multiple
+times.
+.It Fl p Ar port-bind-udp
+Bind to the udp port on the last preceding ip address set with the
+.Op Fl i ip-select
+option or to all available addresses if none has been set. Can be given multiple
+times.
+.It Fl A Ar blessed-ip
+Set an ip address in IPv4 or IPv6 or a net in CIDR notation to bless the network
+for access to restricted resources.
+.It Fl r Ar redirect-url
+Set the URL that
+.Nm
+will redirect users to when the / address is requested via HTTP.
+.It Fl d Ar chdir
+Sets the directory
+.Nm
+will
+.Xr chroot 2
+to if ran as root or
+.Xr chdir 2
+to if ran as unprivileged user. Note that any accesslist files need to be
+relative to and within that directory.
+.It Fl u Ar user
+User to run
+.Nm
+under after all operations that need privileges have finished.
+.It Fl w Ar accesslist | Fl b Ar accesslist
+If
+.Nm
+has been compiled with the
+.B WANT_ACCESSLIST_BLACK
+or
+.Br WANT_ACCESSLIST_WHITE
+options, this option sets the location of the accesslist.
+.El
+
+.Sh EXAMPLES
+
+Start
+.Nm
+bound on udp and tcp ports 6969 on IPv6 localhost.
+
+.Dl # ./opentracker -i ::1 -p 6969 -P 6969
+
+.Pp
+Start
+.Nm
+bound on port udp and tcp port 6868 on IPv4 localhost and allow
+privileged access from the nnetwork 192.168/16 while redirecting
+HTTP clients accessing / to https://my-trackersite.com/.
+
+.Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/
+
+The announce URLs are http://192.168.0.4:6868/announce and
+udp://192.168.0.4:6868/announce respectively.
+
+.Sh FILES
+.Bl -tag -width -compact
+.It Pa opentracker.conf
+config file.
+.El
+.Sh SEE ALSO
+.Xr opentracker.conf 4
+.Sh
+.Sh AUTHOR
+.An Dirk Engling
+.Aq erdgeist@erdgeist.org .
+