From 158643f42aecd827a208725769a6721ab9d6a6a7 Mon Sep 17 00:00:00 2001 From: Andreas Waidler Date: Wed, 11 May 2011 19:44:42 +0200 Subject: [PATCH] Updated doc for release of v0.2.1. --- README | 72 +++++++++++++++++++++++++++++++++++++++--------------------------- agg.1 | 30 +++++++++++++++++----------- 2 files changed, 61 insertions(+), 41 deletions(-) diff --git a/README b/README index 90403e0..957a6db 100644 --- a/README +++ b/README @@ -2,7 +2,9 @@ ## about -agg is a news aggregator for POSIX-compliant systems. +agg is a news aggregator (currently RSS 2.0 only) for +POSIX-compliant systems (currently tested on GNU/Linux +only). It follows the UNIX philosophy and simply reads a news feed from stdin and creates or updates a filesystem @@ -14,12 +16,27 @@ networking. ## news +* 2011-05-11 agg-0.2.1 released +* 2011-05-10 agg-0.2.0 released * 2011-04-16 agg-0.1.1 released * 2011-04-08 agg-0.1.0 released * 2011-04-01 development started -## version summary +## changelog + +### 2011-05-11 agg-0.2.1 + +* Adjusted documentation. +* Fixed install target of makefile. + +### 2011-05-10 agg-0.2.0 + +* Tests and refactoring. +* New output format, no HTML output anymore. +* Now requiring that title or description of items come + first, and title has to come before description. +* Made nomtime work from outside of feed directory ### 2011-04-16 agg-0.1.1 @@ -40,10 +57,10 @@ Initial release. make test install -To install somewhere else see Make.config. +For configuration see Make.config. Please, run the test suites, they've been written for *you* -and take only two seconds on a 500 MHz CPU anyways. +and take few seconds on a 500 MHz CPU anyways. ## faq @@ -65,22 +82,6 @@ the job of a news aggregator to enforce quotas. Because it's a news aggregator, not a download-and-news-aggregation-program. -### Why no user interface? - -Because it's a news aggregator, not a -download-and-news-aggregation-and-news-reader-program. -The file system hierarchy created is pretty much usable -using the default UNIX tools. Feel free to write your own -frontend. - -### No way! This program writes HTML! - -Yes, I like to be able to subscribe to xkcd and similar, -even if it means I have to launch a graphical browser once -in a while. Anyways, there's - - cat $item | elinks -dump - ### But do I have to download the feed by hand? wget $URL -O - | agg @@ -99,18 +100,30 @@ ratio of processing vs. download rate. (wget $feed -qO - --limit-rate=10K | agg) & done -Sky is the limit. +You get the point. + +### Why no user interface? + +Because it's a news aggregator, not a +download-and-news-aggregation-and-news-reader-program. The +file system hierarchy is pretty much usable using various +unixoid tools. + +Sky is the limit. Feel free to write your own frontend; you +should be able to find mine on my blog. ### How to fetch only new items from feeds that don't use publication dates? Not supported by agg itsself, since it would require a second level storage that contains (hashes of) everything the agg directory contained -- including items you -explicitly deleted. You can easily built such functionality +explicitly deleted. You can easily build such functionality on top using a few lines of shell code. +Again, its a news aggregator not a caching program. + -## bugs +## bugs to be fixed * Supports only RSS. * Currently only tested on GNU/Linux. @@ -133,7 +146,6 @@ on top using a few lines of shell code. long and have been cutted. * Items will always be (over-) written in the order they are placed in the feed. -* HTML output is formatted badly. * Standard mtime for items without pubDate should be now. * Sometimes, mtime of feed directory is set to current time. This seems to happen only when a "new" item is not @@ -147,17 +159,19 @@ on top using a few lines of shell code. ## repo -* git://repo.or.cz/agg.git -* http://www.repo.or.cz/w/agg.git +* +* ## homepage -* http://programmers.at/work/on/agg +* ## download -* http://programmers.at/work/on/agg/agg-0.1.1.tar.gz -* http://programmers.at/work/on/agg/agg-0.1.0.tar.gz +* +* +* +* ## license diff --git a/agg.1 b/agg.1 index b629b0c..16682fd 100644 --- a/agg.1 +++ b/agg.1 @@ -1,4 +1,4 @@ -.TH AGG 1 2011-04-04 agg "the news aggregator" +.TH AGG 1 2011-05-11 agg "the news aggregator" .SH NAME .B agg @@ -10,32 +10,38 @@ cat feed.rss | .SH DESCRIPTION .B agg -reads a news feed (currently RSS only) from stdin and +reads a news feed (currently RSS 2.0 only) from stdin and creates or updates its filesystem representation. .SH FILE SYSTEM -.B agg -creates or updates the following directory structure in the -current working directory: +The following hierarchy in the current working +directory is created/maintained. .nf $FEED_NAME |-- $ITEM_1 - |-- $ITEM_2 + | |-- desc + | |-- link + | `-- title |-- ... `-- $ITEM_N +.fi + +Where link, title and desc are missing if not present in +news feed, but at least one of title or desc will exist +(i.e. the news feed conforms to the RSS 2.0). .SH USAGE -.B agg -uses the mtime of files and directories to represent dates -of publication. +The mtime of files and directories is used to represent +dates of publication. If the feed directory does not exist, .B agg will create it and store all items in the feed there. -The mtimes of the files will be set to the corresponding -date of publication, the mtime of the feed directory will -be set to the date of publication of the most recent item. +The mtimes of the item directories will be set to the +corresponding date of publication, the mtime of the feed +directory will be set to the date of publication of the +most recent item. If the feed directory already exists (e.g. on subsequent runs), -- 2.11.4.GIT