tweeper.1.asciidoc

   1 TWEEPER(1)
   2 ===========
   3 :doctype: manpage
   4
   5
   6 NAME
   7 ----
   8 tweeper - web scraper to convert supported websites (e.g. Twitter.com) to RSS
   9
  10
  11 SYNOPSIS
  12 --------
  13 *tweeper* ['OPTIONS'] 'URL'
  14
  15
  16 DESCRIPTION
  17 -----------
  18
  19 tweeper(1) is a web scraper which can be used to conveniently follow the
  20 public activity of social network users without the need to log in or even be
  21 subscribed to the social network; tweeper converts the public information to
  22 RSS so that it can be accessed and collected by a feed reader.
  23
  24 tweeper started as the TWitter fEEd scraPER but support for other web sites
  25 has been added.
  26
  27 The sites that tweeper is able to scrape and convert to RSS are:
  28
  29 * Twitter.com
  30 * Pump.io based websites, like Identi.ca
  31 * Dilbert.com
  32 * Howtoons.com
  33 * Instagram.com
  34 * Facebook.com (public pages)
  35
  36 tweeper can be used as:
  37
  38 1. a command line tool;
  39 2. a filter for feed readers;
  40 3. a web based tool when used with a PHP-enabled web server.
  41
  42
  43 OPTIONS
  44 -------
  45
  46 *-e*::
  47     show links to supported media files in the RSS <enclosure/> element
  48
  49 *-h, --help*::
  50     show the help message
  51
  52
  53 EXAMPLE OF USE
  54 --------------
  55
  56 Getting the RSS feed of some Twitter user:
  57
  58  tweeper http://twitter.com/NSACareers
  59
  60 Using tweeper as a filter for the Liferea feed reader:
  61
  62  liferea-add-feed  "|tweeper http://twitter.com/NSAcareers"
  63
  64 To use tweeper via web there are two options (the examples assume the
  65 installation directory to be `/usr/share/php/tweeper/`):
  66
  67 1. Using the PHP built-in web server:
  68
  69   php -S localhost:8000 -t /usr/share/php/tweeper/
  70 +
  71 and then visit 'http://localhost:8000/tweeper.php' in the web browser.
  72
  73 2. Using a generic web server with the document root in '/var/www':
  74
  75   sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www
  76   xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers
  77 +
  78 It is enough to create the symlink only the very first time tweeper is used
  79 this way.
  80
  81
  82 NOTES
  83 -----
  84
  85 In order to use tweeper with a symlink with the apache 'userdir' module, the
  86 'SymLinksIfOwnerMatch' option must be replaced by 'FollowSymlink' in
  87 /etc/apache2/mods-enabled/userdir.conf
  88
  89
  90 EXIT STATUS
  91 -----------
  92 *0*::
  93     Success
  94
  95 *!0*::
  96     Failure
  97
  98
  99 AUTHORS
 100 -------
 101 Antonio Ospite
 102
 103
 104 RESOURCES
 105 ---------
 106 Main web site: <http://git.ao2.it/tweeper.git>
 107
 108
 109 COPYING
 110 -------
 111 Copyright \(C) 2013-2014  Antonio Ospite <ao2@ao2.it>
 112
 113 This program is free software: you can redistribute it and/or modify
 114 it under the terms of the GNU General Public License as published by
 115 the Free Software Foundation, either version 3 of the License, or
 116 (at your option) any later version.