Scripting Guide

rTorrent Scripting Explained

⚠️	This guide is still very incomplete — the best way to remedy that is to contribute what you know.

You can use the quite powerful GitHub search to find information on commands, e.g. their old vs. new syntax variants, what they actually do (i.e. “read the source”), and internal uses in predefined methods, handlers, and schedules. Consider the view.add example.

• Sending commands with XMLRPC2SCGI
• Auto-generated list of options used with some commands.

Commands Reference

Command	Short Description
execute	Call operating system commands, possibly catching their output for use within rTorrent.
schedule	Repeatedly execute commands, either in a given frequency, or at certain times.
system.*	Commands related to the operating system and the XMLRPC API.
ui.*	These commands control aspects of the ‘curses’ UI.

Variable types

This is a summary about the possible variable types in command_dynamic.cc (applies to v0.9.6).

• private , const

• multi

  • allowed subtypes: static , private , const , rlookup

• simple

  • allowed subtypes: static , private , const

• value , bool , string , list

  • allowed subtypes: static , private , const