1 | | = Transmission Scripts = |
2 | | == Introduction == |
3 | | |
4 | | Thanks to the powerful [wiki:rpc], {{{transmission-remote}}} can talk to any client that has the rpc enabled. This means that a script written using {{{transmission-remote}}} or [wiki:rpc] can, without rewrite, comunicate with all the Transmission clients: GTK+ client, Mac client and the daemon. |
5 | | |
6 | | Mac OS users may wonder wether there will be Applescript scripts, the answer is ''no''. Although Applescript is a nice technology, it's a pain to implement. However, Mac OS X is a Unix after all, so any script you find here will also work on the Mac. Even from within Applescript, you can run these scripts by typing: {{{do shell script "path/to/script"}}}. |
7 | | |
8 | | == How-To == |
9 | | If you are interested at writing scripts for Transmission, have a look at the following pages: |
10 | | * [wiki:man Transmission man pages] |
11 | | * [wiki:ConfigFiles Configuration Files] |
12 | | * [wiki:EditConfigFiles Editing Configuration Files] |
13 | | * [wiki:EnvironmentVariables Environment Variables] |
14 | | * [wiki:rpc RPC Protocol Specification] |
15 | | |
16 | | For those who need more information how to use the scripts, have a look at the following links: |
17 | | * [https://help.ubuntu.com/community/CronHowto Cron How-To]: Run scripts at a regular interval |
18 | | |
19 | | == Scripts == |
20 | | |
21 | | === Start/Stop === |
22 | | * [wiki:Scripts/initd init.d script] (Debian, Ubuntu and BSD deratives) |
23 | | * [wiki:Scripts/runscript runscript] (Gentoo and other {{{runscript}}} compatible systems) |
24 | | |
25 | | |
26 | | === On Torrent Completion === |
27 | | Transmission can be set to invoke a script when downloads complete. The environment variables supported are: |
28 | | |
29 | | * TR_APP_VERSION |
30 | | * TR_TIME_LOCALTIME |
31 | | * TR_TORRENT_DIR |
32 | | * TR_TORRENT_HASH |
33 | | * TR_TORRENT_ID |
34 | | * TR_TORRENT_NAME |
35 | | |
36 | | [https://trac.transmissionbt.com/browser/trunk/extras/send-email-when-torrent-done.sh Here is an example script] that sends an email when a torrent finishes. |
37 | | |
38 | | === Obsoleted === |
39 | | Functionality of these scripts has been implemented in libtransmission and is thus available in all clients. |
40 | | |
41 | | * [wiki:Scripts/EmailNotifier Email Notification Script] |
42 | | * [wiki:Scripts/BlockListUpdater Block List Updater] |
43 | | * [wiki:Scripts/Watchdog Watch Directory Script] |
44 | | * [wiki:Scripts/Scheduler Bandwidth Scheduler] |
45 | | |
46 | | == contrib/scripts == |
47 | | Tomas Carnecky (aka wereHamster) is maintaining a set of scripts in his [http://github.com/wereHamster/transmission/tree/master/contrib/scripts/ github repository]. |
48 | | |
49 | | Falk Husemann (aka hxgn) is maintaining scripts in his [http://falkhusemann.de/blog/category/tcp_ip/transmission-tcp_ip/ blog]. |
50 | | |
51 | | oguz wrote [http://oguzarduc.blogspot.com/2012/05/transmission-quit-script-in-php.html on his blog] a PHP script to stop Transmission after it finishes downloading and seeding. |
52 | | Scripts which have not yet been ported and may not work with the latest version: |
53 | | * http://pastie.org/338556: Python - Fetch new torrents from tvrss |
54 | | * http://pastie.org/338555: PHP - Stop finished torrents |
55 | | * http://pastie.org/443058: Perl - Network traffic graph, based on rrdtool (example: http://skitch.com/werehamster/bmjg8/bittorrent-traffic) |
56 | | * http://transmission.pastebin.com/QzVxQDtM: Bash - (cron)script to keep a maximum number of torrents running; starting and pausing torrents as necessary |
57 | | * https://github.com/jaboto/Transmission-script - (cron)script set network limits according to the number of clients in the network |
| 1 | https://github.com/transmission/transmission/wiki/Scripts |