summaryrefslogtreecommitdiff
path: root/data/doc/feed2imap
diff options
context:
space:
mode:
authorlnu <lnu@f70e237a-67f3-0310-a06c-d2b8a7116972>2006-06-18 08:59:16 +0000
committerlnu <lnu@f70e237a-67f3-0310-a06c-d2b8a7116972>2006-06-18 08:59:16 +0000
commit8ed0ec9fd97511e847315d44cf0070ced31a9557 (patch)
tree96fea79a9dab1f477bc28e6e86799cea516cd86b /data/doc/feed2imap
parent3aba0ce3e74718a8d89d03f69f061158139ad9fa (diff)
downloadfeed2imap-8ed0ec9fd97511e847315d44cf0070ced31a9557.tar.gz
feed2imap-8ed0ec9fd97511e847315d44cf0070ced31a9557.tar.bz2
feed2imap-8ed0ec9fd97511e847315d44cf0070ced31a9557.zip
pre-release cleanup
git-svn-id: svn+ssh://svn.gna.org/svn/feed2imap/trunk/feed2imap@97 f70e237a-67f3-0310-a06c-d2b8a7116972
Diffstat (limited to 'data/doc/feed2imap')
-rw-r--r--data/doc/feed2imap/examples/feed2imaprc26
1 files changed, 17 insertions, 9 deletions
diff --git a/data/doc/feed2imap/examples/feed2imaprc b/data/doc/feed2imap/examples/feed2imaprc
index 35a9f6c..602e68b 100644
--- a/data/doc/feed2imap/examples/feed2imaprc
+++ b/data/doc/feed2imap/examples/feed2imaprc
@@ -1,13 +1,21 @@
-# name is the name of the feed (must be unique)
-# url is the HTTP[S] address where the feed has to be fetched
-# target is the IMAP URI where to put emails
-# min-frequency (in HOURS) is the minimum frequency with which this particular
-# feed will be fetched
+# Global options:
+# dumpdir: (for debugging purposes) directory where all fetched feeds will be
+# dumped.
+# debug-updated: (for debugging purposes) if true, display a lot of information
+# about the "updated-items" algorithm.
+#
+# Per-feed options:
+# name: name of the feed (must be unique)
+# url: HTTP[S] address where the feed has to be fetched
+# target: the IMAP URI where to put emails. Should start with imap:// for IMAP
+# and imaps:// for IMAPS.
+# min-frequency: (in HOURS) is the minimum frequency with which this particular
+# feed will be fetched
# disable: if set to something, the feed will be ignored
-# always-new: feed2imap tries to use a clever algorithm to determine whether an item
-# is new or has been updated. It doesn't work well with some web apps like
-# mediawiki. When this flag is enabled, all items which don't match exactly
-# a previously downloaded item are considered as new items.
+# always-new: feed2imap tries to use a clever algorithm to determine whether
+# an item is new or has been updated. It doesn't work well with some web apps
+# like mediawiki. When this flag is enabled, all items which don't match
+# exactly a previously downloaded item are considered as new items.
#
# If your login contains an @ character, replace it with %40. Other reserved
# characters can be escaped in the same way (see man ascii to get their code)