Changeset 533 for trunk/hotstuff/man

Timestamp:

10/03/09 18:32:11 (3 years ago)

Author:

josef

Message:

- adapt manual pages including CGI parameters to merged hotstuff-search script

Location:

trunk/hotstuff/man

Files:

• hotstuff-search.1 (deleted)
• hotstuff-stuff.1 (modified) (4 diffs)

trunk/hotstuff/man/hotstuff-stuff.1

@@ -1 +1 @@
 .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
@@ -18 +18 @@
 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.
@@ -37 +40 @@
 .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.
@@ -42 +47 @@
 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),