X-Git-Url: https://git.ao2.it/tweeper.git/blobdiff_plain/481f2d015d14180be9982ced2f281494e0ec3855..cf9648c2ee5787195e5b2582aa1f93d2a0b69b0d:/tweeper.1.asciidoc diff --git a/tweeper.1.asciidoc b/tweeper.1.asciidoc index 2782dac..2a4a523 100644 --- a/tweeper.1.asciidoc +++ b/tweeper.1.asciidoc @@ -5,7 +5,7 @@ TWEEPER(1) NAME ---- -tweeper - web scraper to convert a Twitter timeline to an RSS feed +tweeper - web scraper to convert supported websites (e.g. Twitter.com) to RSS SYNOPSIS @@ -16,9 +16,10 @@ SYNOPSIS DESCRIPTION ----------- -tweeper(1) is a web scraper which extracts the most recent public tweets of -a given user from their home page on Twitter.com and formats them in RSS, so -the information can be conveniently accessed and collected by a feed reader. +tweeper(1) is a web scraper which can be used to conveniently follow the +public activity of social network users without the need to log in or even be +subscribed to the social network; tweeper converts the public information to +RSS so that it can be accessed and collected by a feed reader. tweeper started as the TWitter fEEd scraPER but support for other web sites has been added. @@ -36,7 +37,7 @@ tweeper can be used as: 1. a command line tool; 2. a filter for feed readers; -3. a web based tool when PHP support is available in the web server. +3. a web based tool when used with a PHP-enabled web server. OPTIONS @@ -60,10 +61,22 @@ Using tweeper as a filter for the Liferea feed reader: liferea-add-feed "|tweeper http://twitter.com/NSAcareers" -Using tweeper via web (the symlink must be created only the very first time): +To use tweeper via web there are two options (the examples assume the +installation directory to be `/usr/share/php/tweeper/`): + +1. Using the PHP built-in web server: + + php -S localhost:8000 -t /usr/share/php/tweeper/ ++ +and then visit 'http://localhost:8000/tweeper.php' in the web browser. + +2. Using a generic web server with the document root in '/var/www': sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers ++ +It is enough to create the symlink only the very first time tweeper is used +this way. NOTES @@ -95,7 +108,7 @@ Main web site: COPYING ------- -Copyright \(C) 2013-2014 Antonio Ospite +Copyright \(C) 2013-2015 Antonio Ospite This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by