# The torrent module

Interface to the torrent clients

The torrent module is an interface to torrent clients. It currently supports KTorrent using dbus.
It provides the following set of commands:
torrent.detect: Performs an autodetection of installed torrent clients
torrent.setclient: Sets the torrent client interface
torrent.start: Starts downloading of a torrent
torrent.stop: Stops downloading of a torrent
torrent.announce: Manually announces torrent to tracker
torrent.startall: Starts downloading of all torrents
torrent.stopall: Stops downloading of all torrents
torrent.setmaxuploadspeed: Sets maximum upload speed
torrent.setmaxdownloadspeed: Sets maximum download speed
torrent.setfilepriority: Sets the priority of a file in a torrent
It provides the following set of functions:
$torrent.client: Returns the currently set torrent client interface
$torrent.clientlist: Returns a list of all supported clients
$torrent.maxuploadspeed: Returns maximum upload speed set in client
$torrent.maxdownloadspeed: Returns maximum download speed set in client
$torrent.speedup: Returns current total upload speed
$torrent.speeddown: Returns current total download speed
$torrent.trafficup: Returns the total number of bytes uploaded
$torrent.trafficdown: Returns the total number of bytes downloaded
$torrent.count: Returns number of torrents in client
$torrent.name: Returns torrent name as displayed in client
$torrent.state: Returns state of torrent
$torrent.filecount: Returns the number of files in a torrent
$torrent.filename: Returns the name of a file in a torrent
$torrent.filepriority: Returns the priority of a file in a torrent

Index, Modules

KVIrc 4.2.0.6190 Documentation
Generated by root at Mon Sep 23 13:56:02 2013