hscpitt

hsc Project Interfering and Trashing Tool

hscpitt can be used to extract and manipulate data stored in hsc's project file. It lists all documents stored in the project and removes entries and correspoding files for documents.

hscpitt is part of the hsc-distribution and therefor the same legal issues apply.

hscpitt is dedicated to Brad Pitt.

Important: hscpitt should be used with caution. It asumes that the user knows what he is doing and does not ask back before performing any action. Using hscpitt it is rather easy to remove information within seconds that required hours being implemented.

Options and switches

HELP=-h=?/S

Display short help message and exit.

LICENSE/S

Display a short version of Copyright and exit.

COMMAND

Command to be applied to project. Supported commands are:

INFO - show general info about project
LIST - show list of documents
EXTRACT - show detailed list of all documents currently stored in project
DELETE - remove documents entries from project, but leave corresponding files intact
ERASE - remove documents entries from project and also corresponding document and source file.

For a more detailed explanation of these commands see below.

ARG/M

Arguments for command. Depends on the value of COMMAND.

PRJFILE/K

Specifies project file to be examined/manipulated. If none given, hsc.project is used.

QUIET/S

Act quietly, do not display progress and status messages.

-DEBUG/S

Enable debug mode; only usefull if compiled in debug mode.

Commands

COUNT

Setting COMMAND=COUNT will output the number of documents currently stored in the project file.

LIST

Setting COMMAND=LIST will output a short list of documents to stdout. Every line contains the name of a html object.

EXTRACT

Setting COMMAND=EXTRACT will output a detailed list of documents to stdout. This command is ment to be used if you want to utilize the information stored in the project file. Just redirect the output of hscpitt and scan it by your program.

All lines match the template

identifier="value"

You must not make any assumptions about the sequence of identifiers. Your programm should be able to skip unknown identifiers. At the end of data about a document, an EOF occures or an empty line with another document succeeding.

Currently, possible identifers are:

DOCUMENT: URI of document, relative to current directory
SOURCE: Filename of main source file used to create document, relative to current directory

DELETE

Setting COMMAND=DELETE will remove the entries specified in ARG from the project file. The document and the corresponding source remains untouched.

ERASE

Setting COMMAND=ERASE will remove the entries specified in ARG from the project file. Different to COMMAND=DELETE, it will also remove the files for document and source. This command should be used with caution.

Examples

hscpitt HELP: Displays help and exits.
hscpitt PRJFILE=sepp.project COMMAND=LIST: List all documents currently stored in project file sepp.project.
hscpitt EXTRACT: List information about all documents currently stored in project file hsc.project.
hscpitt COMMAND=DELETE www:index.html www:sepp/hugo.html: Remove entries for the documents www:index.html and www:sepp/hugo.html from the project file. The html object and hsc sources for these documents will not be removed.

Thomas Aglassinger (agi@giga.or.at), 04-Dec-1996