Re: [RFR] Description and manpage of rsstail
Rene Mayorga wrote:
> Hi!
> I'm preparing a package for 'rsstail', this would be the first upload
> for this package.
>
> I'll be happy if someone can review the description and the manpage[0].
Okay. Patch attached.
> Package: rsstail
...
> Description: console RSS reader that monitors a feed and detects new entries
Sorry, Christian, "new entries detection" doesn't work. Besides, it
doesn't just watch the feed twice, what it does is:
Description: console RSS reader that monitors a feed and outputs new entries
> Simple and small application that allows to read a RSS Feed and show it
> in an ouput like the 'tail' command
First, the correction that seems to have become my main job on
d-l-e: you can't "allow to VERB". But instead of correcting it
("allow VERBing") I'm simplifying it.
This small, simple application reads an RSS feed and outputs it
like the 'tail' command.
> Homepage: http://www.vanheusden.com/rsstail/
This bit's fine.
> [0] http://rmayorga.org/debian/rsstail/rsstail.1
Some comments on the formatted text:
> NAME
> rsstail - Console Based RSS news reader
RaNdomcAps. Just use:
rsstail - console RSS reader
> SYNOPSIS
> rsstail [OPTIONS]... -u URL
>
> DESCRIPTION
> This manual page was written for the Debian distribution
> because the original program does not have a manual page.
>
> Parse a RSS feed and read it, in an output similar to the
> tail command.
An RSS (ar ess ess) feed. "In" is wrong - rsstail doesn't read the
feed in its own output; make it:
Parse an RSS feed and read it, giving output similar to the
tail command.
> OPTIONS
> This is a Few Description on the main options for rsstail
Maybe you mean:
This is a synopsis of the main options for rsstail:
What kind of order are they in?
> -t Show timestamp.
> -l Show link
> -d Show Description
> -p Show Publication date
Standardising the punctuation:
-t Show timestamp
-l Show links
-d Show description
-p Show publication date
(But what does "description" mean?)
The rest of the man page is okay, although it's missing some
traditional sections.
--
JBR
Ankh kak! (Ancient Egyptian blessing)
--- control.old 2007-06-09 12:30:01.000000000 +0100
+++ control 2007-06-09 12:47:01.000000000 +0100
@@ -8,9 +8,8 @@
Package: rsstail
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: console RSS reader that monitors a feed and detects new
-entries
- Simple and small application that allows to read a RSS Feed and show it
- in an ouput like the 'tail' command
+Description: console RSS reader that monitors a feed and outputs new entries
+ This small, simple application reads an RSS feed and outputs it like the
+ 'tail' command.
.
Homepage: http://www.vanheusden.com/rsstail/
--- rsstail.1.old 2007-06-09 03:50:46.000000000 +0100
+++ rsstail.1 2007-06-09 12:28:59.000000000 +0100
@@ -1,6 +1,6 @@
.TH "RSSTAIL" "1" "0.1" "" "User Commands"
.SH "NAME"
-\fBrsstail\fB \- Console Based RSS news reader
+\fBrsstail\fB \- console RSS reader
.SH "SYNOPSIS"
.PP
\fBrsstail\fR [\fBOPTIONS\fB]... \fB\-u\fB URL
@@ -10,19 +10,19 @@
because the original program does not have a manual page.
.PP
-Parse a RSS feed and read it, in an output similar to the tail command.
+Parse a RSS feed and read it, giving output similar to the tail command.
.SH "OPTIONS"
.PP
-This is a Few Description on the main options for rsstail
+This is a synopsis of the main options for rsstail:
.IP "\fB\-t\fP" 10
-Show timestamp.
+Show timestamp
.IP "\fB\-l\fP" 10
-Show link
+Show links
.IP "\fB\-d\fB" 10
-Show Description
+Show description
.IP "\fB\-p\fB" 10
-Show Publication date
+Show publication date
.IP "\fB\-a\fB" 10
Show author
.IP "\fB\-c\fB" 10
Reply to: