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