From c854b3db9bf620e86481acfcc9fc31eba64bc8e6 Mon Sep 17 00:00:00 2001 From: Dirk Engling Date: Sat, 22 Jun 2024 14:39:10 +0200 Subject: address linter warnings. Thanks to gagath@debian.org --- man1/opentracker.1 | 16 ++-------------- man4/opentracker.conf.4 | 42 +++++++++++++++++++++--------------------- 2 files changed, 23 insertions(+), 35 deletions(-) diff --git a/man1/opentracker.1 b/man1/opentracker.1 index 85ded7b..0103ebe 100644 --- a/man1/opentracker.1 +++ b/man1/opentracker.1 @@ -20,7 +20,6 @@ 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 @@ -29,17 +28,14 @@ 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 @@ -90,15 +86,11 @@ 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 @@ -106,12 +98,9 @@ bound on UDP port 6868 and TCP port 6868 on IPv4 localhost and allow privileged access from the network 192.168/16 while redirecting HTTP clients accessing the root directory, which is not covered by the bittorrent tracker protocol, 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 indent .It Pa opentracker.conf @@ -127,16 +116,15 @@ opentracker documentation .Pp Bittorrent tracker protocol .Lk http://www.bittorrent.org/beps/bep_0015.html -.Sh .Sh AUTHOR .An Dirk Engling .Aq Mt erdgeist@erdgeist.org . .Sh LICENSE This software is released under the Beerware License: - +.Pp Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software with the following terms and conditions: - +.Pp If you meet the author(s) someday, and you think this software is worth it, you can buy them a beer in return. diff --git a/man4/opentracker.conf.4 b/man4/opentracker.conf.4 index b4f5f51..2bc1389 100644 --- a/man4/opentracker.conf.4 +++ b/man4/opentracker.conf.4 @@ -14,59 +14,59 @@ configuration file specifies various options for configuring the behavior of the Lines starting with '#' are comments and are ignored. Options are specified as 'keyword value' pairs. .Pp The following options are available: - +.Pp .Bl -tag -width ".It access.proxy" -compact .It listen.tcp_udp Ar address Specifies an address opentracker will listen on for both TCP and UDP connections. If none are specified, opentracker listens on 0.0.0.0:6969 by default. Can be added more than once. - +.Pp .It listen.tcp Ar address Specifies the address opentracker will listen on for TCP connections. Can be added more than once. - +.Pp .It listen.udp Ar address Specifies the address opentracker will listen on for UDP connections. Can be added more than once. - +.Pp .It listen.udp.workers Ar threads Specifies how many threads will be spawned to handle UDP connections. Defaults to 4. - +.Pp .It access.whitelist Ar path/to/whitelist Specifies the path to the whitelist file containing all torrent hashes that opentracker will serve. Use this option if opentracker runs in a non-open mode. - +.Pp .It access.blacklist Ar path/to/blacklist Specifies the path to the blacklist file containing all torrent hashes that opentracker will not serve. Use this option if opentracker was compiled to allow blacklisting. - +.Pp .It access.fifo_add Ar path/to/adder.fifo Specifies the path to the FIFO (named pipe) used for dynamic changesets to accesslists. Info hashes written to this FIFO will be added to the main accesslist file. - +.Pp .It access.fifo_delete Ar path/to/deleter.fifo Specifies the path to the FIFO (named pipe) used for dynamic changesets to accesslists. Info hashes written to this FIFO will be removed from the main accesslist file. - +.Pp .It access.stats Ar ip_address_or_network Specifies the IP address or network in CIDR notation allowed to fetch stats from opentracker. - +.Pp .It access.stats_path Ar path Specifies the path to the stats location. You can configure opentracker to appear anywhere on your tracker. Defaults to /stats. - +.Pp .It access.proxy Ar ip_address_or_network Specifies the IP address or network of the reverse proxies. Opentracker will take the X-Forwarded-For address instead of the source IP address. Can be added more than once. - +.Pp .It livesync.cluster.listen Ar ip_address:port Specifies the IP address and port opentracker will listen on for incoming live sync packets to keep a cluster of opentrackers synchronized. - +.Pp .It livesync.cluster.node_ip Ar ip_address Specifies one trusted IP address for sync between trackers running in a cluster. Can be added more than once. - +.Pp .It batchsync.cluster.admin_ip Ar ip_address Specifies the admin IP address for old-style (HTTP-based) asynchronous tracker syncing. - +.Pp .It tracker.rootdir Ar path Specifies the directory opentracker will chroot/chdir to. All black/white list files must be located in this directory. - +.Pp .It tracker.user Ar username Specifies the user opentracker will setuid to after binding to potentially privileged ports. - +.Pp .It tracker.redirect_url Ar URL Specifies the URL opentracker will redirect to in response to a "GET / HTTP" request. - +.El .Sh EXAMPLES To specify the address opentracker will listen on for both TCP and UDP connections: .Dl listen.tcp_udp 0.0.0.0:6969 @@ -76,11 +76,11 @@ To specify the address opentracker will listen on for TCP connections: .Pp To specify the address opentracker will listen on for UDP connections: .Dl listen.udp 0.0.0.0:6969 - +.Pp .Sh SEE ALSO .Xr opentracker 1 - +.Pp .Sh AUTHOR .An Dirk Engling .Aq Mt erdgeist@erdgeist.org - +.Pp -- cgit v1.2.3