summaryrefslogtreecommitdiffstats
path: root/docs/write_scripts.rst
diff options
context:
space:
mode:
authorGravatar Walter Purcaro <vuolter@gmail.com> 2014-09-08 01:41:49 +0200
committerGravatar Walter Purcaro <vuolter@gmail.com> 2014-09-14 11:04:01 +0200
commit18959723a24867c9574644d9b3c3c901392d3292 (patch)
tree9ec269d6d8fe853bd4989179e031f16839a0934e /docs/write_scripts.rst
parentJsEngine rewritten + utils updated (diff)
downloadpyload-18959723a24867c9574644d9b3c3c901392d3292.tar.xz
Docs cleanup + remove script directory
Diffstat (limited to 'docs/write_scripts.rst')
-rw-r--r--docs/write_scripts.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/write_scripts.rst b/docs/write_scripts.rst
new file mode 100644
index 000000000..55c0e1665
--- /dev/null
+++ b/docs/write_scripts.rst
@@ -0,0 +1,25 @@
+.. _write_scripts:
+
+Scripts
+=======
+
+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`**