aboutsummaryrefslogtreecommitdiffstats
path: root/doc/avandu.texinfo
diff options
context:
space:
mode:
authorGravatar Tom Willemsen2012-08-04 01:31:55 +0200
committerGravatar Tom Willemsen2012-08-04 01:31:55 +0200
commitfb8e52c1dc022538e3e5874cc12c021e05d1fb50 (patch)
treeb0b649a6187f3bd4373175ae43db28f42124af2c /doc/avandu.texinfo
parentea83dd8c2c4cfca11af8cf6224ca55dd4b4946e7 (diff)
downloadavandu-fb8e52c1dc022538e3e5874cc12c021e05d1fb50.tar.gz
avandu-fb8e52c1dc022538e3e5874cc12c021e05d1fb50.zip
Add avandu-feeds command
This command only returns a vector of feeds, it is not yet useful for users but will be used later to allow for different views of feeds.
Diffstat (limited to 'doc/avandu.texinfo')
-rw-r--r--doc/avandu.texinfo15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/avandu.texinfo b/doc/avandu.texinfo
index 8d12586..b1a8afb 100644
--- a/doc/avandu.texinfo
+++ b/doc/avandu.texinfo
@@ -273,3 +273,18 @@ Tiny Tiny RSS Version: #
and it returns the version as a string.
@end deffn
+
+@deffn avandu-feeds &optional category unread limit offset
+Get a list of all the feeds in CATEGORY. If CATEGORY is @code{nil},
+unspicified or 0, show uncategorized feeds.
+
+If UNREAD is non-@code{nil} only get feeds with unread articles in
+them.
+
+If LIMIT is non-@code{nil} only get LIMIT number of feeds and if
+OFFSET is non-@code{nil} start at OFFSET.
+
+Returns a vector of all the feeds. This is not useful for users on
+its own, but if will be used in the future to make more views
+available.
+@end deffn