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