In need of documentation of new .rc commands

[SineSwiper]

There appear to be quite a few changes/additions of the .rc commands and the new format. Yet, I can't really find any documentation on all of the new commands or just a reference list that shows the command and what it does. The latter would be a good place to start, and if a command needs better explanation, that can eventually be expanded upon.

[SineSwiper]

Furthermore, this could be used to fill the system.methodHelp command.

[rakshasa]

I'm looking forward to someone sending patches.

[xxxxxxxxxxxx]

I second this!

[SineSwiper]

Well, besides the obvious ones, we sorta need a starting point. Reverse engineering the source code to figure out each option is hard work, and if one of the devs already has a list of the descriptions buried on a HD/brain somewhere, that would be a good place to start.

[rakshasa]

'One of the' devs?

There's no plural of dev involved here, which is why time for documentation is rather limited.

[SineSwiper]

Heh, what a shame considering it's used by seedboxes everywhere. Okay, I'll carve out some time to at least get some descriptions down. My C coding sucks, so I may need some help getting it translated into a methodHelp command.

[rakshasa]

If you write it, make it easily parseable for the command name and description.

The command_* files contain so many commands (and LOC) that I'd rather not want them cluttered more.

[pyroscope]

http://wiki.rtorrent.org/XmlRpcReference#Existing_references is where existing efforts are listed, and a place where a combined effort could actually lead to a comprehensive and current reference. The groundwork is there, and I would add more, as soon as a few people join in, so I don't have to do it all alone.

Even if help strings for all comannds are added to the source, and thus an automatic reference can be generated from system.listMethods, you can only put so much into a help string. At least the often-used and/or complex commands need additional explanation.

[SineSwiper]

rakshasa, if I were to compile the command references that we have so far, what kind of format would you need them in? I know it'll need to be converted to C++ code, but again, my C coding sucks and I'm not sure where you'd want it.

[SineSwiper]

Nevermind, saw the comment above. I can just make it a text file with separation of the fields somehow.

[ne0ark]

Yeh anyone can post a updated .rc even if i go through code i would need explanation in terms on torrent.

[ne0ark]

I wish someone post a good guide to performance tunning to make rtorrent little more aggressive on downloads and uploads.

[rakshasa]

https://github.com/rakshasa/rtorrent-doc

A repository has been added which allows push request to be made for the rtorrent github wiki. Archive.org has old libtorrent wiki pages that can be scavanged for examples and such.

Currently working on IPv6 and such, so no time for that atm.

[ne0ark]

What i meant was settings for performance tuning.

[skarekrow]

Unfortunately @rakshasa is pretty busy developing rtorrent. This is where the community needs to submit and get that documentation right as he can't have time to do both. I do most of my settings through ruTorrent, so I can't really contribute much, but @pyroscope is a great person who knows a lot about it. Maybe he'll find some time to throw together a wiki on that github page or some pointers for performance tuning.