NEWS: add release notes for the v1.2.0 release
[tweeper.git] / 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 *-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 https://twitter.com/NSACareers
58
59 Using tweeper as a filter for the Liferea feed reader:
60
61  liferea-add-feed  "|tweeper https://twitter.com/NSAcareers"
62
63 To use tweeper via web there are two options (the examples assume the
64 installation directory to be `/usr/share/php/tweeper/`):
65
66 1. Using the PHP built-in web server:
67
68   php -S localhost:8000 -t /usr/share/php/tweeper/
69 +
70 and then visit 'http://localhost:8000/tweeper.php' in the web browser.
71
72 2. Using a generic web server with the document root in '/var/www':
73
74   sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www
75   xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers
76 +
77 It is enough to create the symlink only the very first time tweeper is used
78 this way.
79
80
81 NOTES
82 -----
83
84 In order to use tweeper with a symlink with the apache 'userdir' module, the
85 'SymLinksIfOwnerMatch' option must be replaced by 'FollowSymlink' in
86 /etc/apache2/mods-enabled/userdir.conf
87
88
89 EXIT STATUS
90 -----------
91 *0*::
92     Success
93
94 *!0*::
95     Failure
96
97
98 AUTHORS
99 -------
100 Antonio Ospite
101
102
103 RESOURCES
104 ---------
105 Main web site: <https://git.ao2.it/tweeper.git>
106
107
108 COPYING
109 -------
110 Copyright \(C) 2013-2016  Antonio Ospite <ao2@ao2.it>
111
112 This program is free software: you can redistribute it and/or modify
113 it under the terms of the GNU General Public License as published by
114 the Free Software Foundation, either version 3 of the License, or
115 (at your option) any later version.