summaryrefslogtreecommitdiffstats
path: root/scripts/README.md
diff options
context:
space:
mode:
authorGravatar Stefano <l.stickell@yahoo.it> 2014-03-25 12:34:11 +0100
committerGravatar Walter Purcaro <vuolter@gmail.com> 2014-06-28 02:46:42 +0200
commit4691d759c846304ec469004fce9d3d79f50c4e2d (patch)
tree334ac0618658cd4d80e85b3283bd9a4405b6bb10 /scripts/README.md
parentUpdated README (diff)
downloadpyload-4691d759c846304ec469004fce9d3d79f50c4e2d.tar.xz
Updated scripts README
See #559
Diffstat (limited to 'scripts/README.md')
-rw-r--r--scripts/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 000000000..6fd0b168c
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,23 @@
+Script Support
+--------------
+
+pyLoad is able to start any kind of scripts at given events.
+Simply put your script in a suitable folder and pyLoad will execute it at the given events and pass some arguments to them.
+
+
+***Note:***
+**Every script starting with symbol `#` will be ignored!** (ex.: `#converter.sh`)
+
+***Note:***
+You have to restart pyload when you change script names or locations.
+
+
+Below you see the list of arguments, which are passed to the scripts.
+
+### Argument list
+
+ - `download_preparing`: **`pluginname` `url`**
+ - `download_finished`: **`pluginname` `url` `filename` `filelocation`**
+ - `package_finshed`: **`packagename` `packagelocation`**
+ - `before_reconnect`: **`oldip`**
+ - `after_reconnect`: **`newip`**