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
  34 tweeper can be used as:
  35
  36 1. a command line tool;
  37 2. a filter for feed readers;
  38 3. a web based tool when PHP support is available in the web server.
  39
  40
  41 OPTIONS
  42 -------
  43
  44 *-e*::
  45     show links to supported media files in the RSS <enclosure/> element
  46
  47 *-h, --help*::
  48     show the help message
  49
  50
  51 EXAMPLE OF USE
  52 --------------
  53
  54 Getting the RSS feed of some Twitter user:
  55
  56  tweeper http://twitter.com/NSACareers
  57
  58 Using tweeper as a filter for the Liferea feed reader:
  59
  60  liferea-add-feed  "|tweeper http://twitter.com/NSAcareers"
  61
  62 Using tweeper via web (the symlink must be created only the very first time):
  63
  64   sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www
  65   xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers
  66
  67
  68 NOTES
  69 -----
  70
  71 In order to use tweeper with a symlink with the apache 'userdir' module, the
  72 'SymLinksIfOwnerMatch' option must be replaced by 'FollowSymlink' in
  73 /etc/apache2/mods-enabled/userdir.conf
  74
  75
  76 EXIT STATUS
  77 -----------
  78 *0*::
  79     Success
  80
  81 *!0*::
  82     Failure
  83
  84
  85 AUTHORS
  86 -------
  87 Antonio Ospite
  88
  89
  90 RESOURCES
  91 ---------
  92 Main web site: <http://git.ao2.it/tweeper.git>
  93
  94
  95 COPYING
  96 -------
  97 Copyright \(C) 2013-2014  Antonio Ospite <ao2@ao2.it>
  98
  99 This program is free software: you can redistribute it and/or modify
 100 it under the terms of the GNU General Public License as published by
 101 the Free Software Foundation, either version 3 of the License, or
 102 (at your option) any later version.