first previous next last contents

Special Note Types

Several types of note have special meanings to Gap4. These include the OPEN, CLOS and RAWD note types.

These notes should contain pure Tcl code. If they exists, they will be executed when the database is opened (OPEN) and closed (CLOS). Take great care in creating and editing a note with these types! The purpose is to allow configuration options to be attached to a database itself, and hence allow for different Gap4 configurations to be used when a UNIX directory contains more than one database. In general use of the `.gaprc' file is probably safer. If there is a problem with a database containing a malformed OPEN or CLOS note, it may be opened using gap4 -no_exec_notes. This will prevent Gap4 from executing the OPEN and CLOS notes and so allow them to be fixed using the note editor.

This note specifies an alternative to the RAWDATA environment variable. This should be set to a UNIX pathname where the trace files may be found. If both the environment variable and the note are present then the note will take priority. This automatic use of this note can be disabled be using the -no_rawdata_note command line option to Gap4.

It is possible to create your own types by editing the `$STADTABL/NOTEDB' file. The format is fairly self explainatory, and is very similar to the `TAGDB' file. Each note type should consist of the long name followed by a colon and id=4_letter_short_name, optionally followed by dt="any default text for this note". Lines may be split at colons by adding a backslash to the end of the line. See the standard `NOTEDB' file for examples.

first previous next last contents
This page is maintained by James Bonfield. Last generated on 2 Febuary 1999.