X-Git-Url: https://git.ao2.it/tweeper.git/blobdiff_plain/481f2d015d14180be9982ced2f281494e0ec3855..75c303bf7c570748a5564de6e266cc40f75b1697:/tweeper.1.asciidoc?ds=sidebyside

diff --git a/tweeper.1.asciidoc b/tweeper.1.asciidoc
index 2782dac..42a5d7e 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.
@@ -28,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)
 
@@ -36,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
@@ -45,6 +45,18 @@ OPTIONS
 *-e*::
     show links to supported media files in the RSS <enclosure/> 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).
+
+*-v <0|1>*::
+    enable or disable showing verbose output like, for instance, non-fatal
+    errors and warnings from the XML parser. Default is 1 (enable).
+
 *-h, --help*::
     show the help message
 
@@ -54,16 +66,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
@@ -90,12 +114,12 @@ Antonio Ospite
 
 RESOURCES
 ---------
-Main web site: <http://git.ao2.it/tweeper.git>
+Main web site: <https://git.ao2.it/tweeper.git>
 
 
 COPYING
 -------
-Copyright \(C) 2013-2014  Antonio Ospite <ao2@ao2.it>
+Copyright \(C) 2013-2020  Antonio Ospite <ao2@ao2.it>
 
 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