| 1 | .TH HOTSTUFF-STUFF 1 "November 02, 2005" |
|---|
| 2 | .SH NAME |
|---|
| 3 | hotstuff-stuff \- generate GHNS or RSS/OpenSearch download feed from the database |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B hotstuff-stuff |
|---|
| 6 | .RI [ options ] ... |
|---|
| 7 | .br |
|---|
| 8 | .SH DESCRIPTION |
|---|
| 9 | This manual page documents briefly the |
|---|
| 10 | .B hotstuff-stuff |
|---|
| 11 | command. It is part of Hotstuff, the server-side |
|---|
| 12 | processing framework for the |
|---|
| 13 | .IR "Get Hot New Stuff" |
|---|
| 14 | concept. |
|---|
| 15 | .PP |
|---|
| 16 | \fBhotstuff-stuff\fP generates a GHNS download feed containing entries |
|---|
| 17 | found in the database. This feed can be used by client applications to |
|---|
| 18 | retrieve the entries. The feed URL is usually referenced within the |
|---|
| 19 | providers.xml file in either the generic 'downloadurl' attribute or |
|---|
| 20 | one of the specialised 'downloadurl-*' attributes. Entries can be |
|---|
| 21 | filtered according to a query or pagination. |
|---|
| 22 | Alternatively, the script can generate an RSS feed conforming to the |
|---|
| 23 | OpenSearch specification. |
|---|
| 24 | .SH OPTIONS |
|---|
| 25 | This program is intended to be used in a CGI context on a web server. |
|---|
| 26 | For debugging purpose and other uses, it can however also be used on the |
|---|
| 27 | command line. Arguments are given in the usual URL query parameter way |
|---|
| 28 | in the first case (hotstuff-stuff?param=value¶m2=value2), and as |
|---|
| 29 | key-value pairs in the second case (hotstuff-stuff param=value param2=value2). |
|---|
| 30 | A summary of options is included below. These options include the common |
|---|
| 31 | ones already documented in hotstuff (7). |
|---|
| 32 | .TP |
|---|
| 33 | .B category=CATEGORY |
|---|
| 34 | Only display entries of a certain category. |
|---|
| 35 | .TP |
|---|
| 36 | .B feed=FEED |
|---|
| 37 | Creates distinct feeds by sorting the entries appropriately. |
|---|
| 38 | For the FEED argument, the values 'downloads', 'score' and 'latest' are |
|---|
| 39 | supported. |
|---|
| 40 | .TP |
|---|
| 41 | .B format=FORMAT |
|---|
| 42 | If FORMAT is set to rss, the script produces an RSS/OpenSearch feed which |
|---|
| 43 | can be used in feed readers. |
|---|
| 44 | Compatibility with the old KNewStuff feed format can be obtained by |
|---|
| 45 | setting FORMAT to 'knewstuff'. Otherwise, this option is not needed. |
|---|
| 46 | This can be used to override the 'compatibility' setting in the configuration |
|---|
| 47 | file. |
|---|
| 48 | .TP |
|---|
| 49 | .B entries=ENTRIES, offset=OFFSET |
|---|
| 50 | Limits the number of entries. The default is 20 entries per feed. An upper |
|---|
| 51 | limit for this option can be specified by administrators in the site |
|---|
| 52 | configuration file. Optionally, an offset can be given to traverse an entry |
|---|
| 53 | list section by section, e.g. for pagination. |
|---|
| 54 | .TP |
|---|
| 55 | .B q=QUERY |
|---|
| 56 | Restricts entries to those matching the query in their name or their |
|---|
| 57 | description. |
|---|
| 58 | .SH SEE ALSO |
|---|
| 59 | .BR hotstuff (7), |
|---|
| 60 | .BR hotstuff-downloads (1), |
|---|
| 61 | .BR hotstuff-http (1), |
|---|
| 62 | .BR hotstuff-scan (1), |
|---|
| 63 | .BR hotstuff-stuff (1), |
|---|
| 64 | .BR hotstuff-search (1), |
|---|
| 65 | .BR hotstuff-versioning (1), |
|---|
| 66 | .BR hotstuff-dxs (1). |
|---|
| 67 | .br |
|---|
| 68 | The programs are documented fully in the hotstuff-doc package. |
|---|
| 69 | .SH FILES |
|---|
| 70 | This program is configured via /etc/hotstuff.conf. As a CGI program, this |
|---|
| 71 | cannot be changed by passing parameters. |
|---|
| 72 | .SH AUTHOR |
|---|
| 73 | Hotstuff is written, maintained and offered as a Free Web Service via KStuff.org. |
|---|
| 74 | .PP |
|---|
| 75 | This manual page was written by Josef Spillner <josef@kstuff.org>, |
|---|
| 76 | for the Debian project (but may be used by others). |
|---|
