SATFILTER Reference
S@
Home SATGUI SATSHELL SATFORM SATFILTER SATREPORT SATMYSQL License Download Examples Contact
Layout of SATFILTER Applications

The base directory for a SAT application must be defined in an exported environment variable called SATHOME. Under this directory the following directories must exist:-

$SATHOME bin
overlay
Executable files for external tags and programs.
Overlay files.


bin

This directory is only required if external or <run> tags are used.


overlay

This directory contains the overlay bitmap/macro files.

Usage

satfilter overlay=overlay

overlay=overlaySet name of overlay to be used for overlay.

SATFILTER reads data from standard input. This can be "piped" in or redirected from a file. SAT/ML tags and macros embedded in the sata will be processed in the same way as for SATFORM.

External Tags

External tags are a method of extending SAT/ML without modifying the core code. Whenever a tag is referred to that is not known to SATFILTER, a program with the tag name is run form the $SATHOME/bin directory. If parameters are specified they are passed to the program. The standard output from the program then replaces the tag.

In this way new (application specific) tags can be added.

For example: Assume there is a date in the data, which has an mm/dd/yyyy format, but you only want to print the year part of the date.

Create a script in the $SATHOME/bin directory called year, something like:

echo ${1} | cut -f3 -d"/"
This new tag can now be used thus:

<year 03/04/2000>

SAT/ML Filter Processing

In order to understand how tags, and macros interact it is necessary to know the order in which they are processed:

  1. Macros.
  2. Tags.


Copyright © 2003
Adrian Davis.