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 * 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 used with a PHP-enabled web server.
  40
  41
  42 OPTIONS
  43 -------
  44
  45 *-e*::
  46     show links to supported media files in the RSS <enclosure/> element
  47
  48 *-u <0|1>*::
  49     enable or disable showing usernames in front of the item for hosts which
  50     supports it (Twitter.com/Instagram.com). Default is 1 (enable).
  51
  52 *-h, --help*::
  53     show the help message
  54
  55
  56 EXAMPLE OF USE
  57 --------------
  58
  59 Getting the RSS feed of some Twitter user:
  60
  61  tweeper https://twitter.com/NSACareers
  62
  63 Using tweeper as a filter for the Liferea feed reader:
  64
  65  liferea-add-feed  "|tweeper https://twitter.com/NSAcareers"
  66
  67 To use tweeper via web there are two options (the examples assume the
  68 installation directory to be `/usr/share/php/tweeper/`):
  69
  70 1. Using the PHP built-in web server:
  71
  72   php -S localhost:8000 -t /usr/share/php/tweeper/
  73 +
  74 and then visit 'http://localhost:8000/tweeper.php' in the web browser.
  75
  76 2. Using a generic web server with the document root in '/var/www':
  77
  78   sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www
  79   xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers
  80 +
  81 It is enough to create the symlink only the very first time tweeper is used
  82 this way.
  83
  84
  85 NOTES
  86 -----
  87
  88 In order to use tweeper with a symlink with the apache 'userdir' module, the
  89 'SymLinksIfOwnerMatch' option must be replaced by 'FollowSymlink' in
  90 /etc/apache2/mods-enabled/userdir.conf
  91
  92
  93 EXIT STATUS
  94 -----------
  95 *0*::
  96     Success
  97
  98 *!0*::
  99     Failure
 100
 101
 102 AUTHORS
 103 -------
 104 Antonio Ospite
 105
 106
 107 RESOURCES
 108 ---------
 109 Main web site: <https://git.ao2.it/tweeper.git>
 110
 111
 112 COPYING
 113 -------
 114 Copyright \(C) 2013-2018  Antonio Ospite <ao2@ao2.it>
 115
 116 This program is free software: you can redistribute it and/or modify
 117 it under the terms of the GNU General Public License as published by
 118 the Free Software Foundation, either version 3 of the License, or
 119 (at your option) any later version.