From: Antonio Ospite <ospite@studenti.unina.it>
Date: Sun, 17 Nov 2013 23:43:00 +0000 (+0100)
Subject: Add a man page
X-Git-Tag: v0.1~3
X-Git-Url: https://git.ao2.it/tweeper.git/commitdiff_plain/6abf3adca8e6aa2ecd08b2881b4ae19d6d8dd9d2?ds=inline

Add a man page
---

diff --git a/Makefile b/Makefile
index e39db8e..e076b13 100644
--- a/Makefile
+++ b/Makefile
@@ -3,13 +3,23 @@ prefix ?= /usr/local
 
 PHP_SCRIPT_DIR ?= $(prefix)/share/php
 BIN_DIR := $(prefix)/bin
+MAN_DIR := $(prefix)/share/man
 
 TWEEPER_DIR := $(PHP_SCRIPT_DIR)/tweeper
 
 all:
+
 clean:
+	rm -f tweeper.1
+
+docs:
+	a2x -f manpage tweeper.1.asciidoc
+
+installdocs: docs
+	install -d $(DESTDIR)$(MAN_DIR)/man1
+	install -m644 tweeper.1 $(DESTDIR)$(MAN_DIR)/man1
 
-install:
+install: installdocs
 	install -d $(DESTDIR)$(TWEEPER_DIR)
 	install -m644 *.xsl $(DESTDIR)$(TWEEPER_DIR)
 	install -m644 *.php $(DESTDIR)$(TWEEPER_DIR)
diff --git a/tweeper.1.asciidoc b/tweeper.1.asciidoc
new file mode 100644
index 0000000..0ffb3b6
--- /dev/null
+++ b/tweeper.1.asciidoc
@@ -0,0 +1,87 @@
+TWEEPER(1)
+===========
+:doctype: manpage
+
+
+NAME
+----
+tweeper - web scraper to convert a Twitter timeline to an RSS feed
+
+
+SYNOPSIS
+--------
+*tweeper* ['OPTIONS'] 'URL'
+
+
+DESCRIPTION
+-----------
+
+tweeper(1) is a web scraper which extracts the most recent public tweets of
+a given user from their home page on Twitter.com and formats them in RSS, so
+the information can be conveniently accessed and collected by a feed reader.
+
+Tweeper started as the TWitter FEEd scraPER but support for other web sites
+has been added.
+
+The sites that tweeper is able to scrape and convert to RSS are:
+  
+* Twitter.com
+* Pump.io based websites, like Identi.ca
+* Dilbert.com
+
+tweeper can be used as:
+
+1. a command line tool;
+2. as a filter for feed readers
+3. as a web based tool when PHP support is available in the web server.
+
+
+OPTIONS
+-------
+
+*-e*::
+    show links to supported media files in the RSS <enclosure/> element
+
+*-h, --help*::
+    show the help message
+
+
+EXAMPLE OF USE
+--------------
+
+Getting the RSS feed of some Twitter user:
+
+ tweeper http://twitter.com/NSACareers
+
+Using tweeper as a filter for the Liferea feed reader:
+
+ liferea-add-feed  "|tweeper http://twitter.com/NSAcareers"
+
+
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*!0*::
+    Failure
+
+
+AUTHORS
+-------
+Antonio Ospite
+
+
+RESOURCES
+---------
+Main web site: <http://git.ao2.it/tweeper.git>
+
+
+COPYING
+-------
+Copyright \(C) 2013  Antonio Ospite <ospite@studenti.unina.it>
+
+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.