fujin/rtorrent
1
0
Fork 0
mirror of https://github.com/rakshasa/rtorrent.git synced 2026-10-04 21:29:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated User Guide (markdown)

kannibalox
2018-05-08 11:56:31 -04:00
parent 5774fa1616
commit e5d2187d7c
1 changed files with 40 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
User-Guide.md
+40 -28
@@ -167,7 +167,7 @@ The main view window lists all loaded torrents with respective status info. Exam
Amount of uploaded data.
**[24%]**
Download ratio. 161.6 MB downloaded makes 24% of the total 617.2 MB. Well, roughly apparently, presumably since some of the downloaded data may have been bad and discarded.
Download ratio. 161.6 MB downloaded makes 24% of the total 617.2 MB. This is a rough estimate, as it's possible some of the downloaded data was bad and needed to be discarded.
**0d 3:09**
Estimated completion time. This torrent is expected to be completely downloaded in 0 days, 3 hours and 9 minutes.
@@ -199,8 +199,8 @@ Throttle U/D: 200/off Rate: 141.6 / 0.0 KiB Listen:<default>:xxxxx Bind: xx
**Throttle U/D: 200/off**
These are the current speed settings.
U = upload = outgoing transfer
D = download = incoming transfer
U = upload = outgoing transfers
D = download = incoming transfers
In this case the total upload speed is limited to 200 KB/s.
With the D setting to "off" there is no limit on download speed.
@@ -214,17 +214,16 @@ See Throttling section for information on how to change the settings.
It should be the same as the ip from where you are browsing the tracker.
**Bind: xxx.xxx.xxx.xxx**
This is the ip on which libtorrent/rtorrent is running.
The external ip if you're behind a NAT.
This is the IP which libtorrent/rtorrent is bound it.
**[D 15/0]**
Current number of download slots in use and the maximum (0 if unlimited).
Current number of download slots in use/the maximum (the maximum is shown as 0 if unlimited).
**[H 1/32]**
Current number of active HTTP requests (for tracker announces and downloads of .torrent files), and the maximum.
Current number of active HTTP requests (for tracker announces and downloads of .torrent files)/the maximum.
**[U 3/14]**
Current number of upload slots in use, and the maximum, which depends on the global upload rate limit.
Current number of upload slots in use/the maximum, which depends on the global upload rate limit.
**[S 6/40/768]**
The three numbers represent handshakes/open sockets/max open sockets.
@@ -234,7 +233,7 @@ See Throttling section for information on how to change the settings.
## The Peers screen ##
Some parts of this screen is fairly cryptic, here's an explanation of the fields.
Some parts of this screen are fairly cryptic, here's an explanation of the fields.
Header:
```
@@ -258,7 +257,7 @@ Example entry:
The rate at which your client is downloading from the peer (KiB/sec).
**PEER**
The download rate (KiB/sec) of this peer for this torrent (reported to your client by the peer client).
The download rate (KiB/sec) of this peer for this torrent (as reported to your client by the peer client).
**C/RE/LO**
C = Connection type, can be r, l, R or L.
@@ -269,7 +268,7 @@ C = Connection type, can be r, l, R or L.
RE = Remote client information, has two parts; the first is u or c and the second is i or n.
* c = This peer has choked your client (which means it is not going to send you any pieces for now).
* u = Your client is not choked by this peer (unchoked).
* u = This peer has not choked your client (unchoked).
* i = This peer is interested in downloading from your client.
* n = This peer is not interested in downloading from your client.
@@ -280,12 +279,12 @@ LO = Local client information, has two parts; the first is u or c and the second
* n = Your client is not interested in downloading from this peer.
**QS**
Queues Outoing/Incoming pieces.
Queues for outgoing/incoming pieces.
The first is the number of pieces that are queued to be sent to the peer.
The second is the number of pieces your client has requested and is waiting for the peer to send.
**DONE**
What percent this peer has of the file.
**DONE**
The percent of data the peer has.
**REQ**
The number of the piece that is currently on the top of the request queue.
@@ -295,7 +294,7 @@ This field has a * in it when your client is snubbing this peer. When a peer agr
### Status ###
A status line in this screen lists information such as:
The status line in this screen lists information such as:
```
Peers: 99(1002) Min/Max: 40/100 Uploads: 15 U/I/C/A: 3/71/5/3 Unchoked: 2/1 Failed: 0
```
@@ -303,10 +302,10 @@ Peers: 99(1002) Min/Max: 40/100 Uploads: 15 U/I/C/A: 3/71/5/3 Unchoked: 2/1 Fail
The amount of peers you are connected and (not connected) to.
**Min/Max**
The minimum and maximum amount of peers to try to keep connected. Can be toyed with keys 3, 4, 5 and 6.
The minimum and maximum amount of peers to try to keep connected. Can be changed with keys 3, 4, 5 and 6.
**Uploads**
Maximum number of peers to upload to at the same time (given the global upload slots are available). Can be toyed with keys 1 and 2.
Maximum number of peers to upload to at the same time (given the global upload slots are available). Can be changed with keys 1 and 2.
**U/I/C/A**
U = Number of currently unchoked peers
@@ -318,7 +317,7 @@ A = Peers accounted
Number of unchoked peers for upload / download.
**Failed**
Number of failed chunks.
Number of failed chunks.
## The Tracker list screen ##
@@ -326,22 +325,35 @@ Number of failed chunks.
0: http://tracker.publicbt.com:80/announce
Id: Counters: 0f / 1s (0) on S/L/D: 114/42/0 (0/50)
1: udp://tracker.openbittorrent.com:80/announce
Id: 2527549 Counters: 0f / 705s (18) on S/L/D: 30/1/285 (2/15)</code></pre>
req Id: 2527549 Counters: 0f / 705s (18) on S/L/D: 30/1/285 (2/15)</code></pre>
Displays the available trackers for a torrent with their announce URL and different properties.
**Possible values in the header**
req = requesting
prom = promiscuous mode
fail = failure mode
* req = requesting
* prom = promiscuous mode
* fail = failure mode
**Properties of a tracker**
Properties from left to right, using the second (1) tracker as an example:
Id: 2527549 = id (can be empty)
Counters: 0f / 705s (18) = failed / successful (scrape) counters
on = status , [on|off|err] , on -> usable , off -> disabled , err -> error
S/L/D: 30/1/285 = number of seeders/leechers/downloads reported by the tracker during a scrape request
(2/15) = number of new peers received last request / total number of peers received
**req**
The busy indicator: can either be req (requesting), scr (scraping), or empty if nothing is happening (as seen in the first tracker)
**Id: 2527549**
The tracker ID (can be empty)
**Counters: 0f / 705s (18)**
Counters for failed/successful (scrape) requests, respectively
**on**
status, can be [on|off|err] where on -> usable , off -> disabled , err -> error
**S/L/D: 30/1/285**
The number of seeders/leechers/downloads reported by the tracker during a scrape request
**(2/15)**
The number of new peers received last request/total number of peers received
## The Chunks seen screen ##
@@ -355,7 +367,7 @@ S/L/D: 30/1/285 = number of seeders/leechers/downloads reported by the tracker d
C/A/D stands for Complete/Accounted/Distributed copies. Only those peers whose bitfields are accounted for are included above; they do not include seeders, peers with empty bitfields, nor normal peers if there are too many.
C/A/D stands for Complete/Accounted/Distributed copies. Only those peers whose bitfields are accounted for are included above. They do not include seeders, peers with empty bitfields, nor normal peers if there are too many.
Then, you have a view of the chunks of the torrent. The chunks are shown in groups of 10. Each new line begins with the number of the first chunk on that line.