.ig
 Copyright (C) 1993,1994 by the author(s).
 
 This software is published in the hope that it will be useful, but
 WITHOUT ANY WARRANTY for any part of this software to work correctly
 or as described in the manuals. See the ShapeTools Public License
 for details.

 Permission is granted to use, copy, modify, or distribute any part of
 this software but only under the conditions described in the ShapeTools 
 Public License. A copy of this license is supposed to have been given
 to you along with ShapeTools in a file named LICENSE. Among other
 things, this copyright notice and the Public License must be
 preserved on all copies.


Author: Andreas Lampen (Andreas.Lampen@cs.tu-berlin.de)

$Header: sttkintro.3[4.0] Thu Jun 24 17:43:28 1993 andy@cs.tu-berlin.de frozen $
..
.TH sttk_intro 3 "Thu Jun 24 17:43:28 1993" "sttk-1.7" "ShapeTools Toolkit Library"
.SH NAME
sttk_intro \- introduction to the ShapeTools Toolkit Library
.SH SYNOPSIS
#include <config.h>
.br
#include <sttk.h>
.sp
char* stVersion (void);
.sp
.SH DESCRIPTION
The ShapeTools Toolkit library (sttk) is a set of functions to be used
in various parts of the ShapeTools configuration management toolkit.
.LP
Inclusion of \fIconfig.h\fP may be omitted when \fIatfs.h\fP is
included.
.LP
\fIstVersion\fP returns a version identification string for the
ShapeTools Toolkit library.
.SH LIST OF FUNCTIONS AND VARIABLES
.ta 3.5c 7c
\fIName	Appears on Page	Description\fP
.sp
.nf
stAbortThis	sttransaction.3	abort transaction
stAskConfirm	stuserio.3	ask user for confirmation
stCallCmd	stcall.3	call command
stCallCmdErrno	stcall.3	error code returned by command (variable)
stCallEditor	stcall.3	call editor with default contents
stCatchSigs	stsignal.3	catch signals
stCleanup	stsignal.3	do cleanup (remove temporary files etc.)
stConvertPattern	ststring.3	convert sh(1) pattern to regex pattern
stExit	stsignal.3	stop program execution
stFindProgram	stcall.3	check if file exists and is executable
stGetFromStdin	stuserio.3	read text from standard input
stGetTermWidth	stuserio.3	get current terminal width in columns
stInterruptAction	stsignal.3	address of signal handler for SIGINT (variable)
stLog	stuserio.3	print message
stMessage	stuserio.3	buffer for constructing messages (variable)
stMktime	sttime.3	parse time string
stParseArgs	stparseargs.3	parse command line arguments
stProgramName	stuserio.3	name how program was called
stQuietFlag	stuserio.3	suppress normal messages (no error messages) (variable) 
stQuitAction	stsignal.3	address of signal handler for SIGQUIT (variable)
stRegisterFile	sttmpfiles.3	register file
stRmRegisteredFiles	sttmpfiles.3	remove all registered files
stShortUsage	stparseargs.3	print usage string
stShutupFlag	stuserio.3	supress all messages (variable)
stStrEnter	ststring.3	enter string to string table
stStrtok	ststring.3	tokenize string
stSubstituteString	ststring.3	replace parts of a string by new string
stTermAction	stsignal.3	address of signal handler for SIGTERM (variable)
stThisTransaction	sttransaction.3	current transaction (variable)
stTmpFile	sttmpfiles.3	return unique name for temporary file
stUnRegisterFile	sttmpfiles.3	unregister file
stVersion	sttkintro.3	print version identification string
stWriteTime	sttime.3	generate time string
.fi
.SH SEE ALSO
Andreas Lampen and Axel Mahler (Eds.)
.br
\fIShapeTools\fP, Technical Report No. 92-14, Technische Universität
Berlin, May 1992