rss_converter_twitter.com.xsl: improve the naming of some variables

[tweeper.git] / tweeper.1.asciidoc

diff --git a/tweeper.1.asciidoc b/tweeper.1.asciidoc
index 0ffb3b6..c5c5fa9 100644 (file)
--- a/tweeper.1.asciidoc
+++ b/tweeper.1.asciidoc
@@ -20,7 +20,7 @@ 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 started as the TWitter FEEd scraPER but support for other web sites
+tweeper started as the TWitter fEEd scraPER but support for other web sites
 has been added.
 
 The sites that tweeper is able to scrape and convert to RSS are:
@@ -32,8 +32,8 @@ The sites that tweeper is able to scrape and convert to RSS are:
 tweeper can be used as:
 
 1. a command line tool;
-2. as a filter for feed readers
-3. as a web based tool when PHP support is available in the web server.
+2. a filter for feed readers;
+3. a web based tool when PHP support is available in the web server.
 
 
 OPTIONS
@@ -57,6 +57,19 @@ 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):
+
+  sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www
+  xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers
+
+
+NOTES
+-----
+
+In order to use tweeper with a symlink with the apache 'userdir' module, the
+'SymLinksIfOwnerMatch' option must be replaced by 'FollowSymlink' in
+/etc/apache2/mods-enabled/userdir.conf
+
 
 EXIT STATUS
 -----------
@@ -79,7 +92,7 @@ Main web site: <http://git.ao2.it/tweeper.git>
 
 COPYING
 -------
-Copyright \(C) 2013  Antonio Ospite <ospite@studenti.unina.it>
+Copyright \(C) 2013-2014  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