diff options
| author | Dirk Engling <erdgeist@erdgeist.org> | 2024-04-18 17:39:51 +0200 |
|---|---|---|
| committer | Dirk Engling <erdgeist@erdgeist.org> | 2024-04-18 17:39:51 +0200 |
| commit | b01f1a0723c3c3a9e33a1b97bf9b3c4db5db7880 (patch) | |
| tree | 94d938f00420f0d8ac1df66ee7f7aef365f40e4c | |
| parent | dcc47f9612577ff4109f9448f08641eff5284baa (diff) | |
Some fixes to the man page
| -rw-r--r-- | man1/opentracker.1 | 43 |
1 files changed, 30 insertions, 13 deletions
diff --git a/man1/opentracker.1 b/man1/opentracker.1 index 45d71cb..85ded7b 100644 --- a/man1/opentracker.1 +++ b/man1/opentracker.1 | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | .Dd 15/4/2024 | 1 | .Dd 15/4/2024 |
| 2 | .Dt opentracker 1 | 2 | .Dt opentracker 1 |
| 3 | .Os posix | 3 | .Os Unix |
| 4 | .Sh opentracker | 4 | .Sh opentracker |
| 5 | .Nm opentracker | 5 | .Nm opentracker |
| 6 | .Nd a free and open bittorrent tracker | 6 | .Nd a free and open bittorrent tracker |
| @@ -18,14 +18,14 @@ | |||
| 18 | .Sh DESCRIPTION | 18 | .Sh DESCRIPTION |
| 19 | .Nm | 19 | .Nm |
| 20 | is a bittorrent tracker that implements announce and scrape actions over the | 20 | is a bittorrent tracker that implements announce and scrape actions over the |
| 21 | udp and the plain http protocol, aiming for minimal resource usage. | 21 | UDP and the plain http protocol, aiming for minimal resource usage. |
| 22 | .Pp | 22 | .Pp |
| 23 | 23 | ||
| 24 | When invoked with parameters, it binds to tcp and udp port 6969 on all | 24 | When invoked with parameters, it binds to TCP and UDP port 6969 on all |
| 25 | interfaces. The recommended way to configure opentracker is by providing a | 25 | interfaces. The recommended way to configure opentracker is by providing a |
| 26 | config file using the | 26 | config file using the |
| 27 | .Op Fl f Ar config | 27 | .Op Fl f Ar config |
| 28 | option. See | 28 | option. See |
| 29 | .Xr opentracker.conf 4 | 29 | .Xr opentracker.conf 4 |
| 30 | for details. | 30 | for details. |
| 31 | .Pp | 31 | .Pp |
| @@ -52,12 +52,12 @@ or | |||
| 52 | .Op Fl P | 52 | .Op Fl P |
| 53 | commands will limit opentracker to only bind to this address. | 53 | commands will limit opentracker to only bind to this address. |
| 54 | .It Fl p Ar port-bind-tcp | 54 | .It Fl p Ar port-bind-tcp |
| 55 | Bind to the tcp port on the last preceding ip address set with the | 55 | Bind to the TCP port on the last preceding ip address set with the |
| 56 | .Op Fl i ip-select | 56 | .Op Fl i ip-select |
| 57 | option or to all available addresses if none has been set. Can be given multiple | 57 | option or to all available addresses if none has been set. Can be given multiple |
| 58 | times. | 58 | times. |
| 59 | .It Fl p Ar port-bind-udp | 59 | .It Fl P Ar port-bind-udp |
| 60 | Bind to the udp port on the last preceding ip address set with the | 60 | Bind to the UDP port on the last preceding ip address set with the |
| 61 | .Op Fl i ip-select | 61 | .Op Fl i ip-select |
| 62 | option or to all available addresses if none has been set. Can be given multiple | 62 | option or to all available addresses if none has been set. Can be given multiple |
| 63 | times. | 63 | times. |
| @@ -95,16 +95,17 @@ options, this option sets the location of the accesslist. | |||
| 95 | 95 | ||
| 96 | Start | 96 | Start |
| 97 | .Nm | 97 | .Nm |
| 98 | bound on udp and tcp ports 6969 on IPv6 localhost. | 98 | bound on UDP and TCP ports 6969 on IPv6 localhost. |
| 99 | 99 | ||
| 100 | .Dl # ./opentracker -i ::1 -p 6969 -P 6969 | 100 | .Dl # ./opentracker -i ::1 -p 6969 -P 6969 |
| 101 | 101 | ||
| 102 | .Pp | 102 | .Pp |
| 103 | Start | 103 | Start |
| 104 | .Nm | 104 | .Nm |
| 105 | bound on port udp and tcp port 6868 on IPv4 localhost and allow | 105 | bound on UDP port 6868 and TCP port 6868 on IPv4 localhost and allow |
| 106 | privileged access from the nnetwork 192.168/16 while redirecting | 106 | privileged access from the network 192.168/16 while redirecting |
| 107 | HTTP clients accessing / to https://my-trackersite.com/. | 107 | HTTP clients accessing the root directory, which is not covered by the |
| 108 | bittorrent tracker protocol, to https://my-trackersite.com/. | ||
| 108 | 109 | ||
| 109 | .Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/ | 110 | .Dl # ./opentracker -i 192.168.0.4 -p 6868 -P 6969 -A 192.168/16 -r https://my-trackersite.com/ |
| 110 | 111 | ||
| @@ -112,14 +113,30 @@ The announce URLs are http://192.168.0.4:6868/announce and | |||
| 112 | udp://192.168.0.4:6868/announce respectively. | 113 | udp://192.168.0.4:6868/announce respectively. |
| 113 | 114 | ||
| 114 | .Sh FILES | 115 | .Sh FILES |
| 115 | .Bl -tag -width -compact | 116 | .Bl -tag -width indent |
| 116 | .It Pa opentracker.conf | 117 | .It Pa opentracker.conf |
| 118 | The | ||
| 119 | .Nm | ||
| 117 | config file. | 120 | config file. |
| 118 | .El | 121 | .El |
| 119 | .Sh SEE ALSO | 122 | .Sh SEE ALSO |
| 120 | .Xr opentracker.conf 4 | 123 | .Xr opentracker.conf 4 |
| 124 | .Pp | ||
| 125 | opentracker documentation | ||
| 126 | .Lk https://erdgeist.org/arts/software/opentracker | ||
| 127 | .Pp | ||
| 128 | Bittorrent tracker protocol | ||
| 129 | .Lk http://www.bittorrent.org/beps/bep_0015.html | ||
| 121 | .Sh | 130 | .Sh |
| 122 | .Sh AUTHOR | 131 | .Sh AUTHOR |
| 123 | .An Dirk Engling | 132 | .An Dirk Engling |
| 124 | .Aq erdgeist@erdgeist.org . | 133 | .Aq Mt erdgeist@erdgeist.org . |
| 134 | .Sh LICENSE | ||
| 135 | This software is released under the Beerware License: | ||
| 136 | |||
| 137 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software | ||
| 138 | and associated documentation files (the "Software"), to deal in the Software with the following | ||
| 139 | terms and conditions: | ||
| 125 | 140 | ||
| 141 | If you meet the author(s) someday, and you think this software is worth it, you can buy them | ||
| 142 | a beer in return. | ||
