]> Sergey Matveev's repositories - btrtrc.git/blob - cmd/btrtrc/USAGE
cmd/btrtrc client
[btrtrc.git] / cmd / btrtrc / USAGE
1 You have to specify correct -bind, -4 and -6 addresses. If -4/-6 is
2 empty, then it won't be announced.
3
4 Each second the current time, overall downloaded/uploaded traffic
5 amount, number of active peers and current download/upload speed in
6 KiB/sec will be shown.
7
8 fifos subdirectory will be created with following FIFO files:
9
10 * fifos/add -- expects newline delimited paths to .torrent files or
11   magnet: links
12 * fifos/del -- expects torrent's info hashes to remove torrents from the
13   client
14 * fifos/list -- prints coloured output of all registered torrents in the
15   client. It shows:
16   * info hash (that you can use in all other FIFOs)
17   * name (name of the file or root directory as a rule)
18   * total size
19   * completion percentage
20   * seed ratio
21   * download/upload speeds in KiB/sec
22   * number of: total/pending/active/seeder peers
23   * (optionally) estimated completion time
24 * fifos/dht -- prints DHT server statistics
25 * fifos/files/HASH -- prints torrent's file list with completion ratio
26 * fifos/peers/HASH -- prints torrent's connected peers information:
27   * peer's ID
28   * status flags, that are concatenated string of:
29     i -- am interested
30     c -- am chocking
31       -
32     E -- RC4 encryption
33     e -- header encryption
34       Tr -- tracker
35       I  -- incoming
36       Hg -- DHT get_peers
37       Ha -- DHT announce_peer
38       X  -- PEX
39       M  -- direct (through magnet:)
40     U -- UTP
41       -
42     i -- he interested
43     c -- he chocking
44   * number of completed pieces
45   * download/upload speeds in KiB/sec during current session
46   * amount of downloaded/uploaded traffic during current session
47   * remote address with port
48   * client's name
49 * fifos/top-seed -- list torrents sorted by total transfer data amount
50
51 For each torrent, corresponding .torrent file will be created.
52 Additional symbolic link with torrent's name will lead to HASH.torrent.
53 HASH.bf file is piece completion database. HASH.tx contains overall
54 outgoing payload traffic amount and it is updated each 10sec.
55
56 If you massively add a bunch of unverified torrents, then
57 github.com/anacrolix/torrent will deal with them in parallel. That means
58 hash verification is done in random order from HDD's point of view, that
59 is rather slow. If you are going to seed many torrents, then it is
60 highly advisable to pre-verify them in advance, by using -verify option
61 with path to all .torrent files.
62
63 Example usage for starting torrents seeding:
64
65     $ cat > seedfile <<EOF
66     big_buck_bunny.torrent
67     exodos.torrent
68     [...]
69     EOF
70     $ btrtrc -verify `cat seedfile`
71     $ btrtrc [...]
72     $ cat seedfile > fifos/add
73     $ cat fifos/list