56beabdcb29ccd41aa7934b7a260833983faf93e
[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 * 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 PHP support is available in the 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 Using tweeper via web (the symlink must be created only the very first time):
65
66   sudo ln -s /usr/share/php/tweeper/tweeper.php /var/www
67   xdg-open http://localhost/tweeper.php?src_url=http://twitter.com/NSAcareers
68
69
70 NOTES
71 -----
72
73 In order to use tweeper with a symlink with the apache 'userdir' module, the
74 'SymLinksIfOwnerMatch' option must be replaced by 'FollowSymlink' in
75 /etc/apache2/mods-enabled/userdir.conf
76
77
78 EXIT STATUS
79 -----------
80 *0*::
81     Success
82
83 *!0*::
84     Failure
85
86
87 AUTHORS
88 -------
89 Antonio Ospite
90
91
92 RESOURCES
93 ---------
94 Main web site: <http://git.ao2.it/tweeper.git>
95
96
97 COPYING
98 -------
99 Copyright \(C) 2013-2014  Antonio Ospite <ao2@ao2.it>
100
101 This program is free software: you can redistribute it and/or modify
102 it under the terms of the GNU General Public License as published by
103 the Free Software Foundation, either version 3 of the License, or
104 (at your option) any later version.