'\" t
.\"     Title: tweeper
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/11/2016
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "TWEEPER" "1" "12/11/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tweeper \- web scraper to convert supported websites (e\&.g\&. Twitter\&.com) to RSS
.SH "SYNOPSIS"
.sp
\fBtweeper\fR [\fIOPTIONS\fR] \fIURL\fR
.SH "DESCRIPTION"
.sp
tweeper(1) is a web scraper which can be used to conveniently follow the public activity of social network users without the need to log in or even be subscribed to the social network; tweeper converts the public information to RSS so that it can be accessed and collected by a feed reader\&.
.sp
tweeper started as the TWitter fEEd scraPER but support for other web sites has been added\&.
.sp
The sites that tweeper is able to scrape and convert to RSS are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Twitter\&.com
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Pump\&.io based websites, like Identi\&.ca
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Dilbert\&.com
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Howtoons\&.com
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Instagram\&.com
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Facebook\&.com (public pages)
.RE
.sp
tweeper can be used as:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
a command line tool;
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
a filter for feed readers;
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
a web based tool when used with a PHP\-enabled web server\&.
.RE
.SH "OPTIONS"
.PP
\fB\-e\fR
.RS 4
show links to supported media files in the RSS <enclosure/> element
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
show the help message
.RE
.SH "EXAMPLE OF USE"
.sp
Getting the RSS feed of some Twitter user:
.sp
.if n \{\
.RS 4
.\}
.nf
tweeper https://twitter\&.com/NSACareers
.fi
.if n \{\
.RE
.\}
.sp
Using tweeper as a filter for the Liferea feed reader:
.sp
.if n \{\
.RS 4
.\}
.nf
liferea\-add\-feed  "|tweeper https://twitter\&.com/NSAcareers"
.fi
.if n \{\
.RE
.\}
.sp
To use tweeper via web there are two options (the examples assume the installation directory to be /usr/share/php/tweeper/):
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
Using the PHP built\-in web server:
.sp
.if n \{\
.RS 4
.\}
.nf
php \-S localhost:8000 \-t /usr/share/php/tweeper/
.fi
.if n \{\
.RE
.\}
.sp
and then visit
\fIhttp://localhost:8000/tweeper\&.php\fR
in the web browser\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
Using a generic web server with the document root in
\fI/var/www\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
sudo ln \-s /usr/share/php/tweeper/tweeper\&.php /var/www
xdg\-open http://localhost/tweeper\&.php?src_url=http://twitter\&.com/NSAcareers
.fi
.if n \{\
.RE
.\}
.sp
It is enough to create the symlink only the very first time tweeper is used this way\&.
.RE
.SH "NOTES"
.sp
In order to use tweeper with a symlink with the apache \fIuserdir\fR module, the \fISymLinksIfOwnerMatch\fR option must be replaced by \fIFollowSymlink\fR in /etc/apache2/mods\-enabled/userdir\&.conf
.SH "EXIT STATUS"
.PP
\fB0\fR
.RS 4
Success
.RE
.PP
\fB!0\fR
.RS 4
Failure
.RE
.SH "AUTHORS"
.sp
Antonio Ospite
.SH "RESOURCES"
.sp
Main web site: https://git\&.ao2\&.it/tweeper\&.git
.SH "COPYING"
.sp
Copyright (C) 2013\-2016 Antonio Ospite <ao2@ao2\&.it>
.sp
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version\&.