ActiveTcl User Guide

teapot-admin(n) 1.0 tpm "TEA Package Management"

NAME

teapot-admin - TEApot Administrative Client

TABLE OF CONTENTS

    TABLE OF CONTENTS
    SYNOPSIS
    DESCRIPTION
    Commands
    BUGS, IDEAS, FEEDBACK
    SEE ALSO
    KEYWORDS
    COPYRIGHT

SYNOPSIS

DESCRIPTION

This document assumes that the reader has read at least the TEApot Introduction, the TEApot Glossary of Terms, and possibly the TEApot Meta Data Specification.

This tool provides the functionality for the management of local opaque repositories. It allows repository administrators to

1. Create new repositories.
   
   
2. Put entities into repositories.
   
   
3. Remove entities from repositories.
   
   
4. List the contents of repositories.
   
   
5. Retrieve entity archive files from repositories.

Note: If this tool modifies a repository and finds a "htmlcache" directory then it will clear this directory, to ensure that a TEApot Repository Server using it will not serve invalidated information from this cache directory.

Commands

teapot-admin create path

Creates a new repository in the directory path. This directory must not already contain a repository. The new repository is empty.

teapot-admin add ?-v? path file...

Adds the entities contained in the specified files to the repository at the directory path. The directory has to exist and contain a valid repository.

If the option -v was specified the application will print the full meta data of each entity to the standard output as it is added.

teapot-admin remove path ?-entity? name ?version ?architecture??

Removes the entity instance(s) matching the specified name, version, and architecture from the repository at the directory path. The directory has to exist and contain a valid repository.

Any parts not specified are ignored during matching.

If no entity was specified all possible entities are removed. Otherwise only entities of the specified type are removed. The recognized options are derived from the names of the known entity types:

Application

-application

Package

-package

Profile

-profile

teapot-admin get path ?-entity? name ?version ?architecture??

Retrieves the files of the entity instance(s) matching the specified name, version, and architecture from the repository at the directory path. The directory has to exist and contain a valid repository.

Not specified parts are ignored during matching.

The retrieved files are placed into the current directory, with file names constructed from the entity type, name, version, architecture, and type of archive (Tcl Module, Zip archive, ...).

If no entity was specified the archives of all possible entities are retrieved. Otherwise only entities of the specified type are retrieved. The recognized options are derived from the names of the known entity types, see above.

teapot-admin list path ?-entity? ?name ?version ?architecture???

Lists the entity instance(s) matching the specified name, version, and architecture found in the repository at the directory path. The directory has to exist and contain a valid repository.

Any parts not specified are ignored during matching.

If no entity was specified all possible entities are listed. Otherwise only entities of the specified type are listed. The recognized options are derived from the names of the known entity types, see above.

teapot-admin version

Prints the version number of the application.

teapot-admin who

Prints the complete teapot meta data of the application.

teapot-admin status path

Returns information about modification times for repository index and journal, and the range spanned by entries in the journal.

teapot-admin rejournal path

Regenerates the repository journal, compacting it as much as possible. In essence a new journal is created based on the current contents of the repository, thus removing all delete operations from the journal, and all information not in the repository anymore.

BUGS, IDEAS, FEEDBACK

This document, and the application it describes, will undoubtedly contain bugs and other problems. Please report such at the ActiveState ActiveTcl Bug Tracker. The relevant component is teapot. Please also report any ideas for enhancements you may have for either application and/or documentation.

The version number of the teapot-admin application with the problem in question can be queried with the command version

SEE ALSO

teacup, teapot, teapot-md, teapot-pkg

KEYWORDS

TEA, TEAPOT, administration, package management, repository, server

COPYRIGHT

Copyright © 2006-2007 ActiveState Software Inc.