[kde-services-devel] r533 - trunk/hotstuff/man

[josef at new.kstuff.org]

Author: josef
Date: 2009-10-03 18:32:11 +0200 (Sat, 03 Oct 2009)
New Revision: 533

Removed:
   trunk/hotstuff/man/hotstuff-search.1
Modified:
   trunk/hotstuff/man/hotstuff-stuff.1
Log:
- adapt manual pages including CGI parameters to merged hotstuff-search script



Deleted: trunk/hotstuff/man/hotstuff-search.1
===================================================================
--- trunk/hotstuff/man/hotstuff-search.1	2009-10-03 16:25:16 UTC (rev 532)
+++ trunk/hotstuff/man/hotstuff-search.1	2009-10-03 16:32:11 UTC (rev 533)
@@ -1,34 +0,0 @@
-.TH HOTSTUFF-SEARCH 1 "November 02, 2005"
-.SH NAME
-hotstuff-search \- search entries in GHNS database and output OpenSearch an list
-.SH SYNOPSIS
-.B hotstuff-search
-.RI [ options ] ...
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.B hotstuff-search
-command. It is part of Hotstuff, the server-side
-processing framework for the
-.IR "Get Hot New Stuff"
-concept.
-.PP
-\fBhotstuff-search\fP is a CGI script.
-.SH OPTIONS
-The CGI parameter \fBq\fR is needed to describe the query.
-.SH SEE ALSO
-.BR hotstuff (7),
-.BR hotstuff-downloads (1),
-.BR hotstuff-http (1),
-.BR hotstuff-scan (1),
-.BR hotstuff-stuff (1),
-.BR hotstuff-search (1),
-.BR hotstuff-versioning (1),
-.BR hotstuff-dxs (1).
-.br
-The programs are documented fully in the hotstuff-doc package.
-.SH AUTHOR
-Hotstuff is written, maintained and offered as a Free Web Service via KStuff.org.
-.PP
-This manual page was written by Josef Spillner <josef at kstuff.org>,
-for the Debian project (but may be used by others).

Modified: trunk/hotstuff/man/hotstuff-stuff.1
===================================================================
--- trunk/hotstuff/man/hotstuff-stuff.1	2009-10-03 16:25:16 UTC (rev 532)
+++ trunk/hotstuff/man/hotstuff-stuff.1	2009-10-03 16:32:11 UTC (rev 533)
@@ -1,6 +1,6 @@
 .TH HOTSTUFF-STUFF 1 "November 02, 2005"
 .SH NAME
-hotstuff-stuff \- generate GHNS download feed from the database
+hotstuff-stuff \- generate GHNS or RSS/OpenSearch download feed from the database
 .SH SYNOPSIS
 .B hotstuff-stuff
 .RI [ options ] ...
@@ -17,7 +17,10 @@
 found in the database. This feed can be used by client applications to
 retrieve the entries. The feed URL is usually referenced within the
 providers.xml file in either the generic 'downloadurl' attribute or
-one of the specialised 'downloadurl-*' attributes.
+one of the specialised 'downloadurl-*' attributes. Entries can be
+filtered according to a query or pagination.
+Alternatively, the script can generate an RSS feed conforming to the
+OpenSearch specification.
 .SH OPTIONS
 This program is intended to be used in a CGI context on a web server.
 For debugging purpose and other uses, it can however also be used on the
@@ -36,13 +39,22 @@
 supported.
 .TP
 .B format=FORMAT
+If FORMAT is set to rss, the script produces an RSS/OpenSearch feed which
+can be used in feed readers.
 Compatibility with the old KNewStuff feed format can be obtained by
 setting FORMAT to 'knewstuff'. Otherwise, this option is not needed.
 This can be used to override the 'compatibility' setting in the configuration
 file.
 .TP
-.B entries=ENTRIES
-Limits the number of entries. The default is 20 entries per feed.
+.B entries=ENTRIES, offset=OFFSET
+Limits the number of entries. The default is 20 entries per feed. An upper
+limit for this option can be specified by administrators in the site
+configuration file. Optionally, an offset can be given to traverse an entry
+list section by section, e.g. for pagination.
+.TP
+.B q=QUERY
+Restricts entries to those matching the query in their name or their
+description.
 .SH SEE ALSO
 .BR hotstuff (7),
 .BR hotstuff-downloads (1),