Test Script Support Files for Utilities
=======================================

These files are used in conjunction with each test
script in the utility repository.

Optionally the test script can use valgrind(1) or
kdump(1) to look for memory leaks.  See arguments
below.

    .---------.-------------------------------.
    | OS      | Memory Check Method           |
    |---------+-------------------------------|
    | Linux   | valgrind(1), if installed     |
    |---------+-------------------------------|
    | OpenBSD | ktrace(1) and kdump(1)        |
    |---------+-------------------------------|
    | Others  | Memory Testing not performed  |
    '---------'-------------------------------'

File description:
=================

    .-----------.-------------------------------------.
    | File      | How used                            |
    |-----------+-------------------------------------|
    | tsetup.sh | source script used by all Test      |
    |           | Scrpts, t-XXXXX.sh, for each        |
    |           | utility                             |
    |-----------+-------------------------------------|
    | setup.csh | csh and tcsh source script to       |
    |           | define aliases to help with testing |
    |-----------+-------------------------------------|
    | setup.sh  | sh type shell source script to      |
    |           | define aliases to help with testing |
    '-----------'-------------------------------------'

    One important note --
        j_lib2 is **not** required for these
        utilities.  Use of j_lib2 is automatically
        determined.

Arguments for Testing
=====================

    Arguments can be supplied to determine how
    to test.  These arguments are optional, default
    action is noted.

    .----------.--------------------------------------.
    | Argument | Action                               |
    |----------+--------------------------------------|
    | NO_MEM   | Do not perform Memory Testing        |
    |          | This is the default action.          |
    |----------+--------------------------------------|
    | YES_MEM  | Perform Memory Testing.              |
    |----------+--------------------------------------|
    | NO_J     | Compile without using j_lib2.        |
    |----------+--------------------------------------|
    | YES_J    | Compile with using j_lib2.           |
    |----------+--------------------------------------|
    | YES_J    | Compile with using j_lib2.           |
    |----------+--------------------------------------|
    | SKIP     | Do not automatically compile prior   |
    |          | to executing the test.               |
    |          | By default, the object is compiled.  |
    |----------+--------------------------------------|
    | others   | A couple of test scripts have their  |
    |          | own arguments, use --help to see the |
    |          | arguments.                           |
    '----------'--------------------------------------'

To Test:
========
  * These files should be stored in dir "test"
  * Execute t-XXXXX.sh where XXXXX is the program to
    be tested.  For example:
    t-jfile.sh is the test script for j_file which
    is in the directory where j_file source is storred.

Licensed using the https://en.wikipedia.org/wiki/ISC_license

$Id: test.txt,v 1.4 2025/07/23 15:04:42 jmccue Exp $