Changeset 261 for trunk/hotstuff/man

Timestamp:

12/19/05 09:49:45 (6 years ago)

Author:

josef

Message:

- introduction of compatibility switch for incoming/outgoing/both formats
- moving all sample files and scripts to new ghns format
- support for different feeds in hotstuff-stuff

Files:

• trunk/hotstuff/man/hotstuff-stuff.1 (modified) (2 diffs)

trunk/hotstuff/man/hotstuff-stuff.1

@@ -14 +14 @@
 concept.
 .PP
-\fBhotstuff-stuff\fP ...
+\fBhotstuff-stuff\fP generates a GHNS download feed containing entries
+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.
 .SH OPTIONS
-This program follows the usual GNU command line syntax, with long
-options starting with two dashes (`-').
+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
+command line. Arguments are given in the usual URL query parameter way
+in the first case (hotstuff-stuff?param=value&param2=value2), and as
+key-value pairs in the second case (hotstuff-stuff param=value param2=value2).
 A summary of options is included below. These options include the common
 ones already documented in hotstuff (7).
 .TP
-.B \-h, \-\-help
-Show summary of options.
+.B category=CATEGORY
+Only display entries of a certain category.
 .TP
-.B \-v, \-\-version
-Show version of program.
+.B feed=FEED
+Creates distinct feeds by sorting the entries appropriately.
+For the FEED argument, the values 'downloads', 'score' and 'latest' are
+supported.
 .TP
-.B \-c, \-\-configuration
-Specify an alternative configuration file (default is /etc/hotstuff.conf).
+.B format=FORMAT
+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.
 .SH SEE ALSO
 .BR hotstuff (7),
@@ -40 +55 @@
 .br
 The programs are documented fully in the hotstuff-doc package.
+.SH FILES
+This program is configured via /etc/hotstuff.conf. As a CGI program, this
+cannot be changed by passing parameters.
 .SH AUTHOR
 Hotstuff is written, maintained and offered as a Free Web Service via KStuff.org.