BOOTSTRAP commands
PROGRAM NAME
kecho - Echo attributes of toolbox or software object
DESCRIPTION
kecho is utility for printing information about toolboxes and
software objects.
Although it can be useful to run from the command-line,
it is most useful when writing shell scripts where you want to
iterate over toolboxes and software objects.
For example,
the following bourne shell script will print out the path to
all software objects in all available toolboxes:
#!/bin/sh
for toolbox in `kecho -echo toolboxes`; do
echo "Toolbox: $toolbox"
for object in `kecho -tb $toolbox -echo objects`; do
OPATH=`kecho -tb $toolbox -oname $object -echo path`
echo " Object: $object"
echo " Path: $OPATH"
done
done
Note that this is not the most efficient approach in terms of run-time,
but using kecho in this way makes it easy to write one-off tools.
The simplest use of kecho is to determine the list of available
toolboxes:
% kecho -echo toolboxes
BOOTSTRAP DATASERV DESIGN DATAMANIP ENVISION
You can use the -tb toolbox switch to request information
about a particular toolbox:
% kecho -tb bootstrap -echo path
/usr/local/khoros/bootstrap
% kecho -tb dataserv -echo objects
kdatafmt kgdbm_dump kapputils kappserv kdataccess kdataman
The -type object-type switch can only be used in combination
with -tb and the -echo objects switches:
% kecho -tb bootstrap -type library -echo objects
kclui kexpr kutils klibm klibdb kcodegen kforms ktestutils kcms
Most of the echo options are for use with software objects.
For example,
the following examples show how you can get various software
object attributes using kecho:
% kecho -tb datamanip -oname kadd -echo category
Arithmetic
% kecho -tb datamanip -oname kadd -echo description
Output = Input 1 + (Input 2 or Constant)
% kecho -tb datamanip -oname kadd -echo version
2.0.5
REQUIRED ARGUMENTS
- -echo
-
type: string toggle
desc: what to echo
allowed values:
- toolboxes (list all the toolbox objects),
- path (echo the path of the object),
- binpath (echo the binary path of the object),
- lsrc (list Lex source code files in the object),
- allfiles (list all files in the object),
- objects (list the software objects in a toolbox),
- libpath (echo the library path of the object),
- allsrc (list all source code files in the object),
- src (list C source code files in the object),
- category (echo object category string),
- subcategory (echo object subcategory string),
- bname (echo the software objects binary name),
- fsrc (list all FORTRAN source code in the object),
- icon (echo the icon name for the object),
- object-info (echo all string attributes),
- description (echo the short description of the object),
- ysrc (list YACC source code files in the object),
- version (echo the version string for the object),
- poc (echo the point of contact string),
- email (echo the email address of the point of contact),
- keywords (list the keywords associated with the object),
- type (echo the object type),
- alib (echo the associated library),
- or config-name (echo the configuration name used at build time)
OPTIONAL ARGUMENTS
- -tb
-
type: string
desc: toolbox name
default: {none}
- -fullpath
-
type: flag
desc: Colonel Flag
Mutually Exclusive Group; if desired, specify ONE of:
- -oname
-
type: string
desc: Program or Library Object Name
default: {none}
OR
- -type
-
type: string
desc: type of object
default: {none}
EXAMPLES
List all available toolboxes:
% kecho -echo toolboxes
List all objects in the BOOTSTRAP toolbox:
% kecho -tb bootstrap -echo objects
List all xvroutines in the BOOTSTRAP toolbox:
% kecho -tb bootstrap -type xvroutine -echo objects
List path to 'guise' software object:
% kecho -tb design -oname guise -echo path
List all source code associated with the 'guise' software object:
% kecho -tb design -oname guise -echo allsrc
SEE ALSO
RESTRICTIONS
REFERENCES
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.