X-Git-Url: https://git.ao2.it/tweeper.git/blobdiff_plain/73c2c3b86ad0bc069e3a3e905fb84d94e2832971..8f00d77403980577c59aedd4c350685ffda80667:/tweeper.1.asciidoc?ds=inline diff --git a/tweeper.1.asciidoc b/tweeper.1.asciidoc index 56beabd..37e885a 100644 --- a/tweeper.1.asciidoc +++ b/tweeper.1.asciidoc @@ -29,7 +29,6 @@ The sites that tweeper is able to scrape and convert to RSS are: * Twitter.com * Pump.io based websites, like Identi.ca * Dilbert.com -* Howtoons.com * Instagram.com * Facebook.com (public pages) @@ -37,7 +36,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 @@ -46,6 +45,14 @@ OPTIONS *-e*:: show links to supported media files in the RSS element +*-m <0|1>*:: + enable or disable showing multimedia content (e.g. Twitter or Instagram + pictures) directly inside the item description. Default is 1 (enable). + +*-u <0|1>*:: + enable or disable showing usernames in front of the item for hosts which + supports it (Twitter.com/Instagram.com). Default is 1 (enable). + *-h, --help*:: show the help message @@ -55,16 +62,28 @@ EXAMPLE OF USE Getting the RSS feed of some Twitter user: - tweeper http://twitter.com/NSACareers + tweeper https://twitter.com/NSACareers Using tweeper as a filter for the Liferea feed reader: - liferea-add-feed "|tweeper http://twitter.com/NSAcareers" + liferea-add-feed "|tweeper https://twitter.com/NSAcareers" + +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. -Using tweeper via web (the symlink must be created only the very first time): +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 @@ -91,12 +110,12 @@ Antonio Ospite RESOURCES --------- -Main web site: +Main web site: COPYING ------- -Copyright \(C) 2013-2014 Antonio Ospite +Copyright \(C) 2013-2018 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