mirror/transmission
1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2024-12-22 07:42:37 +00:00
Code Issues Releases Wiki Activity

docs: add description for torrent action requests (#6302)

Browse source
This commit is contained in:
Yat Ho 2023-11-27 13:05:42 +08:00 committed by GitHub
parent 4b3f0a15c1
commit 78bb911ea9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/rpc-spec.md
View file

@ -112,13 +112,13 @@ username and password (respectively), separated by a colon.
## 3 Torrent requests
### 3.1 Torrent action requests
| Method name | libtransmission function
|:--|:--
| `torrent-start` | tr_torrentStart
| `torrent-start-now` | tr_torrentStartNow
| `torrent-stop` | tr_torrentStop
| `torrent-verify` | tr_torrentVerify
| `torrent-reannounce` | tr_torrentManualUpdate ("ask tracker for more peers")
| Method name | libtransmission function | Description
|:--|:--|:--
| `torrent-start` | tr_torrentStart | start torrent
| `torrent-start-now` | tr_torrentStartNow | start torrent disregarding queue position
| `torrent-stop` | tr_torrentStop | stop torrent
| `torrent-verify` | tr_torrentVerify | verify torrent
| `torrent-reannounce` | tr_torrentManualUpdate | re-announce to trackers now
Request arguments: `ids`, which specifies which torrents to use.
All torrents are used if the `ids` argument is omitted.