point to 'transmission-remote --debug' as a reference for the RPC syntax of various requests

This commit is contained in:
Jordan Lee 2012-05-30 16:21:43 +00:00
parent 5c1feaf937
commit 695c048268
1 changed files with 11 additions and 3 deletions

View File

@ -7,10 +7,18 @@
The JSON terminology in RFC 4627 is used.
In benc terms, a JSON "array" is equivalent to a benc list,
a JSON "object" is equivalent to a benc dictionary,
and a JSON object's "keys" are the dictionary's string keys.
JSON is fairly common now, but for the benefit of
torrent developers familiar with benc:
a JSON array is equivalent to a benc list,
a JSON object is equivalent to a benc dictionary,
and a JSON object's keys are the dictionary's string keys.
1.2 Resources
The command-line utility "transmission-remote" uses this RPC API.
Several developers have reported using its --debug JSON output as
a reference when developing/debugging their own code.
2. Message Format
Messages are formatted as objects. There are two types: