Commits

Laurent Bachelier committed 8cd2646

Better documentation

  • Participants
  • Parent commits 987b2f9

Comments (0)

Files changed (2)

-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
 -----------
 
 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
 ---------
 
 - PyRSS2Gen
 - argparse (or Python 2.7).
+- An irkerd server running on localhost (optional, only if you want IRC notifications)
 
 Configuration
 -------------
 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``.