tweeper.1.asciidoc

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