add status description to rpc-spec.txt (#1760)

I couldn't find infos about the "status" field of "torrent-get" in this file or on the web, so I had to look in the source code to find it, and I don't think everyone will do that. So it would be nice for this file to contain details about status

Co-authored-by: Charles Kerr <charles@charleskerr.com>
This commit is contained in:
Nathan Benichou 2021-08-27 18:24:57 +02:00 committed by GitHub
parent 841f56dc3a
commit 1077f639b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions

View File

@ -237,7 +237,7 @@
seedRatioMode | number | tr_ratiolimit
sizeWhenDone | number | tr_stat
startDate | number | tr_stat
status | number | tr_stat
status | number (see below) | tr_stat
trackers | array (see below) | n/a
trackerStats | array (see below) | n/a
totalSize | number | tr_info
@ -309,6 +309,15 @@
| numbers. each is the tr_priority_t |
| mode for the corresponding file. |
-------------------+--------------------------------------+
status | a number between 0 and 6, where: | tr_stat
| 0: Torrent is stopped |
| 1: Queued to check files |
| 2: Checking files |
| 3: Queued to download |
| 4: Downloading |
| 5: Queued to seed |
| 6: Seeding |
-------------------+--------------------------------------+
trackers | array of objects, each containing: |
+-------------------------+------------+
| announce | string | tr_tracker_info