| 1 | .TH "hotstuff" "7" "01.02.2007" "kstuff.org" "Hotstuff GHNS Tools" |
|---|
| 2 | .SH "NAME" |
|---|
| 3 | .LP |
|---|
| 4 | Hotstuff \- server-side GHNS data processing framework |
|---|
| 5 | .SH SYNOPSIS |
|---|
| 6 | \fBhotstuff-*\fR [\fIoptions\fR] ... |
|---|
| 7 | .SH "DESCRIPTION" |
|---|
| 8 | This manual page documents the Hotstuff scripts suite, which implement a |
|---|
| 9 | server-side data processing framework for the \fBGet Hot New Stuff\fR (GHNS) |
|---|
| 10 | collaborative data sharing concept. |
|---|
| 11 | Hotstuff is composed of different scripts, some of which are intended |
|---|
| 12 | to be run by the administrator, some by cron jobs and some by a web |
|---|
| 13 | server for incoming requests. In addition to the server scripts, two |
|---|
| 14 | utilities for the client side are available with Hotstuff. |
|---|
| 15 | All of those scripts are documented briefly in this manual page. |
|---|
| 16 | In addition to the scripts, an administrative web frontend is part of |
|---|
| 17 | Hotstuff. A web frontend for users (Cocodrilo) also exists, but is not |
|---|
| 18 | part of Hotstuff, since it can be installed by any application author on |
|---|
| 19 | a homepage and reference remote GHNS repositories. |
|---|
| 20 | .LP |
|---|
| 21 | GHNS repositories can be set up as sites, similar to the concept of virtual hosts, |
|---|
| 22 | and each of the following commands then operates on one site. |
|---|
| 23 | .TP |
|---|
| 24 | \fBhotstuff-scan\fP is a program that scans uploaded data and inserts the extracted information |
|---|
| 25 | into the database, following the storage of the files in the publically accessible download area. |
|---|
| 26 | This script runs as a cron job. |
|---|
| 27 | .TP |
|---|
| 28 | \fBhotstuff-dxs\fP is a web service handler which is invoked as a CGI script to enable users to |
|---|
| 29 | upload and download data and collaboratively interact with the Hotstuff database. |
|---|
| 30 | .TP |
|---|
| 31 | \fBdxsclient\fP is an interactive command-line client to the \fBhotstuff-dxs\fR CGI script. |
|---|
| 32 | .TP |
|---|
| 33 | \fBghnsmetatemplate\fP is a small utility script which generates a meta file for a data file, |
|---|
| 34 | both of which are then uploaded into a GHNS repository. |
|---|
| 35 | .TP |
|---|
| 36 | \fBhotstuff-downloads\fP can keep track of downloads by scanning the web server log files |
|---|
| 37 | and updating the number of downloads for each data item in the database. |
|---|
| 38 | This script runs as a cron job. |
|---|
| 39 | .TP |
|---|
| 40 | \fBhotstuff-http\fP is a cron job which moves files which were uploaded with HTTP/PHP into a |
|---|
| 41 | temporary directory into the main upload pool. |
|---|
| 42 | .TP |
|---|
| 43 | \fBhotstuff-search\fP is an OpenSearch-format search engine for the Hotstuff database. |
|---|
| 44 | .TP |
|---|
| 45 | \fBhotstuff-siteadmin\fP is an admin tool to set up new GHNS repositories, including the |
|---|
| 46 | database setup and configuration file modification. |
|---|
| 47 | .TP |
|---|
| 48 | \fBhotstuff-stuff\fP is a GHNS feed generator which creates XML files out of the database |
|---|
| 49 | information for a GHNS repository. |
|---|
| 50 | .TP |
|---|
| 51 | \fBhotstuff-versioning\fP is a cronjob which, when versioning is activated for a GHNS repository, |
|---|
| 52 | scans all newly uploaded and approved files and creates a new version for them. |
|---|
| 53 | .SH "OPTIONS" |
|---|
| 54 | Each of the Hotstuff programs comes with its own command-line options. |
|---|
| 55 | Please refer to the individual manual pages. |
|---|
| 56 | .SH "AUTHOR" |
|---|
| 57 | .LP |
|---|
| 58 | Josef Spillner |
|---|
| 59 | <josef@kstuff.org> |
|---|
| 60 | .SH "SEE ALSO" |
|---|
| 61 | .LP |
|---|
| 62 | ghns(7), hotstuff-scan(1), hotstuff-dxs(1), hotstuff-siteadmin(1), hotstuff-stuff(1), ... |
|---|
