diff options
| author | Laurent Bachelier <laurent@bachelier.name> | 2012-10-14 01:47:20 +0200 |
|---|---|---|
| committer | Laurent Bachelier <laurent@bachelier.name> | 2012-10-23 20:52:18 +0200 |
| commit | 8cd2646c70b9be730140b207cf72ac0e3288101e (patch) | |
| tree | 08c2331a34c48bcdb2f389d8eed775ad88906532 | |
| parent | Add --irknick shortcut (diff) | |
| download | rtorrent-notify-8cd2646c70b9be730140b207cf72ac0e3288101e.tar.xz | |
Better documentation
| -rw-r--r-- | LICENSE | 2 | ||||
| -rw-r--r-- | README | 21 |
2 files changed, 19 insertions, 4 deletions
@@ -1,4 +1,4 @@ -Copyright (c) 2009 Laurent Bachelier +Copyright (c) 2009-2012 Laurent Bachelier Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -6,7 +6,7 @@ Description ----------- rtorrent-notify aims to be a very simple tool to notify users of rtorrent-related events. -It can actually be used for other kind of events, being +It can actually be used for other kind of events, being mostly generic. Upgrading --------- @@ -18,6 +18,7 @@ Requirements - PyRSS2Gen - argparse (or Python 2.7). +- An irkerd server running on localhost (optional, only if you want IRC notifications) Configuration ------------- @@ -37,6 +38,20 @@ Unless you specify their location, the files (``rtorrent-notify.db`` and ``rtorr Yes, it is that unreadable. ``FINISH`` and ``START`` are just strings, you can change them. Some tips: + - There are other events you might be interested in. As there is no documentation, you can try to grep for ``event.`` in rtorrent's source code. -- get_base_path doesn't work with the "inserted" event, you can use get_name instead. -- You will find a list of properties to use in ui/download.cc +- ``get_base_path`` doesn't work with the "inserted" event, you can use ``get_name`` instead. +- You will find a list of properties to use in ``ui/download.cc`` + +Complete help for the rtorrent-notify command is available by running ``rtorrent-notify -h``. + +Examples +-------- + +Advanced usage with some options would be:: + + "execute=~/rtorrent-notify/rtorrent-notify,-r,~/public_html/feed.xml,-n,irc://chat.freenode.net/mynick,FINISH,$d.get_base_path=" + +- The target RSS feed is changed from the default. +- This also sends a notification to the freenode nick ``mynick``. ``-n`` is used instead of -i ``irc://chat.freenode.net/mynick,isnick`` as the ``,`` character is already used by rtorrent's config. +- Notifications to channels could be sent by ``-i irc://chat.freenode.net/mychannel``. |