Skip to content

Commit f144cf2

Browse files
committed
readme: document command line usage
1 parent c80ba48 commit f144cf2

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,38 @@ server.torrents[infoHash].peers
170170

171171
The http server will handle requests for the following paths: `/announce`, `/scrape`. Requests for other paths will not be handled.
172172

173+
## command line
174+
175+
Start a quick torrent tracker server for debugging bittorrent stuff!
176+
177+
```sh
178+
$ bittorrent-tracker
179+
http server listening on 8000
180+
udp server listening on 8000
181+
```
182+
183+
Lots of options:
184+
185+
```sh
186+
$ bittorrent-tracker -h
187+
bittorrent-tracker - Start a bittorrent tracker server
188+
189+
Usage:
190+
bittorrent-tracker
191+
192+
Options:
193+
-p, --port [number] change the port [default: 8000]
194+
--trust-proxy trust 'x-forwarded-for' header from reverse proxy
195+
--interval tell clients to announce on this interval (ms)
196+
--http enable http server [default: true]
197+
--udp enable udp server [default: true]
198+
-q, --quiet only show error output
199+
-s, --silent show no output
200+
-v, --version print the current version
201+
202+
Please report bugs! https://github.com/feross/bittorrent-tracker/issues
203+
```
204+
173205
## license
174206

175207
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).

0 commit comments

Comments
 (0)