SVN: toys/rsget.pl/README.config

[sparky]

Author: sparky
Date: Wed Jul 28 16:29:12 2010
New Revision: 11724

Modified:
   toys/rsget.pl/README.config
Log:
- added callbacks description


Modified: toys/rsget.pl/README.config
==============================================================================
--- toys/rsget.pl/README.config	(original)
+++ toys/rsget.pl/README.config	Wed Jul 28 16:29:12 2010
@@ -85,6 +85,36 @@
 # * execute your own script which does anything you want:
 #postdownload = ${HOME}/bin/postdownload $(file) $(source) || notify-send "rsget.pl: "$(name) "postdownload failed"
 
+# Execute shell command after successfully adding new link directly to the list
+# (direct list manipulation only, http interface doesn't trigger it).
+# Recognized special variables:
+#  $(uri) - original URI
+#  $(newuri) - unified URI
+#  $(getter) - name of the plugin
+# 
+# * send dbus org.freedesktop.notifications message
+#list_link_new = notify-send "rsget.pl: " "Added "$(uri)" as "$(newuri)" for "$(getter)
+
+# Execute shell command if link wasn't recognized.
+# (no getter found that supports it)
+# Recognized special variables:
+#  $(uri) - original URI
+#
+# * send dbus org.freedesktop.notifications message
+#list_link_failed = notify-send "rsget.pl: " "Link "$(uri)" failed"
+
+# Execute shell command if download fails.
+# (download returns an error)
+# Recognized special variables:
+#  $(uri) - URI that was used
+#  $(error) - error message
+#  $(getter) - plugin used
+#  $(interface) - interface used, if any
+#  $(command) - what rsget.pl was trying to do: check or get
+#
+# * send dbus org.freedesktop.notifications message
+#download_fail = notify-send "rsget.pl: " $(uri)" download failed: "$(error)
+
 # update automatically from SVN (possibly dangerous, but very convenient):
 #use_svn = update