summaryrefslogtreecommitdiff
path: root/man1/opentracker.1
diff options
context:
space:
mode:
Diffstat (limited to 'man1/opentracker.1')
-rw-r--r--man1/opentracker.116
1 files changed, 2 insertions, 14 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 @@
20is a bittorrent tracker that implements announce and scrape actions over the 20is a bittorrent tracker that implements announce and scrape actions over the
21UDP and the plain http protocol, aiming for minimal resource usage. 21UDP and the plain http protocol, aiming for minimal resource usage.
22.Pp 22.Pp
23
24When invoked with parameters, it binds to TCP and UDP port 6969 on all 23When invoked with parameters, it binds to TCP and UDP port 6969 on all
25interfaces. The recommended way to configure opentracker is by providing a 24interfaces. The recommended way to configure opentracker is by providing a
26config file using the 25config file using the
@@ -29,17 +28,14 @@ option. See
29.Xr opentracker.conf 4 28.Xr opentracker.conf 4
30for details. 29for details.
31.Pp 30.Pp
32
33.Sh OPTIONS 31.Sh OPTIONS
34The following options are available: 32The following options are available:
35
36.Bl -tag -width -indent=8 33.Bl -tag -width -indent=8
37.It Fl f Ar config 34.It Fl f Ar config
38Parse a config file with a list of options. Consecutive command options 35Parse a config file with a list of options. Consecutive command options
39will override options from the config file. See 36will override options from the config file. See
40.Xr opentracker.conf 4 37.Xr opentracker.conf 4
41for details. 38for details.
42
43.It Fl i Ar ip-select 39.It Fl i Ar ip-select
44Select an ip address that will be used with the next 40Select an ip address that will be used with the next
45.Op Fl p 41.Op Fl p
@@ -90,15 +86,11 @@ or
90.Br WANT_ACCESSLIST_WHITE 86.Br WANT_ACCESSLIST_WHITE
91options, this option sets the location of the accesslist. 87options, this option sets the location of the accesslist.
92.El 88.El
93
94.Sh EXAMPLES 89.Sh EXAMPLES
95
96Start 90Start
97.Nm 91.Nm
98bound on UDP and TCP ports 6969 on IPv6 localhost. 92bound on UDP and TCP ports 6969 on IPv6 localhost.
99
100.Dl # ./opentracker -i ::1 -p 6969 -P 6969 93.Dl # ./opentracker -i ::1 -p 6969 -P 6969
101
102.Pp 94.Pp
103Start 95Start
104.Nm 96.Nm
@@ -106,12 +98,9 @@ bound on UDP port 6868 and TCP port 6868 on IPv4 localhost and allow
106privileged access from the network 192.168/16 while redirecting 98privileged access from the network 192.168/16 while redirecting
107HTTP clients accessing the root directory, which is not covered by the 99HTTP clients accessing the root directory, which is not covered by the
108bittorrent tracker protocol, to https://my-trackersite.com/. 100bittorrent tracker protocol, to https://my-trackersite.com/.
109
110.Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/ 101.Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/
111
112The announce URLs are http://192.168.0.4:6868/announce and 102The announce URLs are http://192.168.0.4:6868/announce and
113udp://192.168.0.4:6868/announce respectively. 103udp://192.168.0.4:6868/announce respectively.
114
115.Sh FILES 104.Sh FILES
116.Bl -tag -width indent 105.Bl -tag -width indent
117.It Pa opentracker.conf 106.It Pa opentracker.conf
@@ -127,16 +116,15 @@ opentracker documentation
127.Pp 116.Pp
128Bittorrent tracker protocol 117Bittorrent tracker protocol
129.Lk http://www.bittorrent.org/beps/bep_0015.html 118.Lk http://www.bittorrent.org/beps/bep_0015.html
130.Sh
131.Sh AUTHOR 119.Sh AUTHOR
132.An Dirk Engling 120.An Dirk Engling
133.Aq Mt erdgeist@erdgeist.org . 121.Aq Mt erdgeist@erdgeist.org .
134.Sh LICENSE 122.Sh LICENSE
135This software is released under the Beerware License: 123This software is released under the Beerware License:
136 124.Pp
137Permission is hereby granted, free of charge, to any person obtaining a copy of this software 125Permission is hereby granted, free of charge, to any person obtaining a copy of this software
138and associated documentation files (the "Software"), to deal in the Software with the following 126and associated documentation files (the "Software"), to deal in the Software with the following
139terms and conditions: 127terms and conditions:
140 128.Pp
141If you meet the author(s) someday, and you think this software is worth it, you can buy them 129If you meet the author(s) someday, and you think this software is worth it, you can buy them
142a beer in return. 130a beer in return.