From: Antonio Ospite <ao2@ao2.it>
Date: Sun, 13 Sep 2015 09:57:07 +0000 (+0200)
Subject: tweeper.1.asciidoc: document how to use the PHP built-in web server
X-Git-Tag: v0.4~6
X-Git-Url: https://git.ao2.it/tweeper.git/commitdiff_plain/4c100ab24ab3d0368db320e0806dd755bd32bd34

tweeper.1.asciidoc: document how to use the PHP built-in web server
---

diff --git a/tweeper.1.asciidoc b/tweeper.1.asciidoc
index 56beabd..c9af25f 100644
--- a/tweeper.1.asciidoc
+++ b/tweeper.1.asciidoc
@@ -37,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
@@ -61,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