Add manual page provided by Decklin Foster.

diff --git a/MANIFEST.in b/MANIFEST.in
index 16447c5319d4fbcad97512b12d9a5321ff29da9d..6f29a25e1ab24d791483c12e537bc54a6bcd7b59 100644 (file)
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -6,5 +6,6 @@ include config
 include style.css
 include rawdog
 include MANIFEST.in
+include rawdog.1
 recursive-include rawdoglib *.py
 

diff --git a/NEWS b/NEWS
index 2466decec21b8672e76615bf4efac7472ce783a8..a6dc06582783f6bb4e06e6f10c189df48107820e 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -6,6 +6,8 @@ Add proxyuser and proxypassword options for feeds, so that you can use
 per-feed proxies requiring HTTP Basic authentication (patch from Jon
 Nelson).
 
+Add a manual page (written by Decklin Foster).
+
 - rawdog 2.0
 
 Update to feedparser 3.3. This meant reworking some of rawdog's

diff --git a/rawdog.1 b/rawdog.1
new file mode 100644 (file)
index 0000000..c600f37
--- /dev/null
+++ b/rawdog.1
@@ -0,0 +1,68 @@
+.TH RAWDOG 1
+.SH NAME
+rawdog \- an RSS Aggregator Without Delusions Of Grandeur
+.SH SYNOPSIS
+.B rawdog
+.RI [ options ]
+.SH DESCRIPTION
+This manual page briefly documents the
+.B rawdog
+command.
+.PP
+\fBrawdog\fP is an RSS (and other) feed aggregator, based on Mark
+Pilgrim's flexible feed parser. \fBrawdog\fP reads articles from a
+number of feeds and writes out a single HTML file, based on a template
+either provided by the user or generated by rawdog, containing the
+latest articles it's seen.
+.SH OPTIONS
+This program follows the usual GNU command line syntax, with long
+options starting with two dashes (`\-'). A summary of options is
+included below. For a complete description, see the README file.
+.TP
+.B \-u, \-\-update
+Fetch data from the feeds and store it. This could take some time if
+you've got lots of feeds.
+.TP
+.B \-w, \-\-write
+Write out the HTML output file.
+.TP
+.BI \-f \ SOMEURL\fP, \ \-\-update\-feed \ SOMEURL
+Update the feed pointed to by
+.I SOMEURL
+immediately, even if its period hasn't elapsed since it was last
+updated.
+.TP
+.BI \-c \ FILE\fP, \ \-\-config \ FILE
+Read
+.I FILE
+as an additional config file; any options provided in
+.I FILE
+will override those set in the default config (with the exception of
+"feed", which is cumulative).
+.I FILE
+may be an absolute path or a path relative to your .rawdog directory.
+.TP
+.B \-t, \ \-\-show\-template
+Print the template currently in use to stdout.
+.TP
+.BI \-a \ URL\fP, \ \-\-add \ URL
+Add a new feed to the config file, using Mark Pilgrim's "feedfinder"
+module to extract the location of the feed from
+.IR URL .
+.TP
+.BI \-d \ DIR\fP, \ \-\-dir \ DIR
+Use
+.I DIR
+instead of the $HOME/.rawdog directory.
+.TP
+.B \-\-help
+Provide a brief summary of all the options rawdog supports, and exit.
+.SH FILES
+$HOME/.rawdog/config
+.SH SEE ALSO
+.BR cron (1).
+.SH AUTHOR
+rawdog was written by Adam Sampson <azz@us\-lot.org>.
+.PP
+This manual page was written by Decklin Foster <decklin@red\-bean.com>,
+for the Debian project (but may be used by others).

diff --git a/setup.py b/setup.py
index d4bfe01a30ca6ec9581af572dfe3b8487f2fccb4..2ddbc01eff14c9848fbdb05f43599627d8a1b77c 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -10,6 +10,7 @@ setup(name = "rawdog",
        url = "http://offog.org/code/rawdog.html",
        license = "GNU GPL v2 or later",
        scripts = ['rawdog'],
+       data_files = [('share/man/man1', ['rawdog.1'])],
        packages = ['rawdoglib'])