+ pod

twatch-lite

@@ -228,3 +228,94 @@ save_state($opts{state}, $state);
 exit 0;
 
 __END__
+
+=pod
+
+=head1 NAME
+
+twatch-lite -- periodically polls RSS/ATOM feeds and cherry-picks wanted torrent files
+
+=head1 SYNOPSIS
+
+  man twatch-lite
+  mkdir -p ~/.config/twatch-lite
+  vim ~/.config/twatch-lite/config
+  twatch-lite --verbose # 1st time, debug
+
+=head1 DESCRIPTION
+
+This is very simple and specialized alternative to full-featured software called L<Twatch>. It works only with RSS/ATOM feeds.
+
+=head1 Config file
+
+File format is simple: YAML. Real config example:
+
+  ---
+  outdir: /tmp
+  proxy: http://192.168.1.1:3128
+  defaults:
+    use: link
+    lookup: title
+  feeds:
+    - url: http://torrent-tracker.org/rss.php
+      matches:
+      - 'match substring'
+      - '/match regex/'
+
+Now let looks closer: we have two mandatory sections, 'defaults', 'feeds' and a lot of global parameters
+
+=head2 Global parameters
+
+=head3 C<outdir>
+
+Where to save downloaded torrent files. You may want configure your torrent-client to pickup files from this dir. If unset, you'll get warning, and '/tmp' will be used.
+
+=head3 C<proxy>
+
+If set - will use http proxy, when fetching rss and torrent-files. Otherwise will connect directly (default).
+
+=head3 C<cookies>
+
+If set to any non-empty value, will accept and send back cookies in http-requests. Default - unset.
+
+=head2 Section C<defaults>
+
+This is default values for each configured feed.
+
+=head3 C<use>
+
+Use this field in RSS/ATOM entry as link to torrent file. For now, only acceptable value is 'link'.
+
+=head3 C<lookup>
+
+Lookup this field in RSS/ATOM entry for wanted keywords. Acceptable values: 'body', 'title' (default).
+
+=head2 Section C<feeds>
+
+Configured feeds.
+
+=head3 C<url>
+
+URL with RSS/ATOM feed. This option must be set in each feed.
+
+=head3 C<matches>
+
+List of wanted 'keywords'. If keyword surrounded with slashes, like C</this/>,  it will be handled as regex, and as substring otherwise. Regex syntax is PCRE and described in L<perlre(3)>.
+
+If feed entry matches ANY keyword, torrent file will be downloaded and stored to B<outdir>.
+
+Matches list must contain at least one keyword. If you want all torrents from this feed, use '/.*/' regex keyword.
+
+=head3 C<lookup>, C<use>
+
+Normally this options uses values from C<defaults> section, but you may override them for each feed you want.
+
+=head1 SEE ALSO
+
+L<Twatch>
+
+=head1 AUTHORS
+
+Alex 'AdUser' Z <aduser@cpan.org>
+
+=cut