Automatic Journal File Creation

Controlling Automatic Journal File Creation

By default, Trelis automatically creates a journal file each time it is executed. The file is created in the current directory, and its name begins with the word "Trelis " or "history", depending on the version of Trelis, followed by a number starting with cubit01.jou and continuing up to a maximum of cubit999.jou. It is recommended that the user keep no more than around 100 journal files in any directory, to avoid using up disk space and causing confusion. To that end, when the journal name increments to more than cubit99.jou, a warning will be given on startup telling the user that there are at least 99 journal files, and to please clean out unused files. If the user has up through cubit999.jou, then the user is warned that there are too many journal files in the current directory, and cubit999.jou will be re-used, destroying the previous contents.

When starting Trelis, the choice of journal file name to be used depends on whether it is creating a historyXX.jou file, or a cubitXX.jou file. For historyXX.jou files, it will look for the highest used number in the current directory and increment it by one. For example, if there are already journal files with names history01.jou, history02.jou, and history04.jou, Trelis will use history05.jou as the current journal file. For cubitXX.jou files, Trelis will fill in gaps, starting with the lowest number. For example, if there are already journal files with names cubit01.jou, cubit02, jou, and cubit04.jou, then Trelis will use cubit03.jou as the current journal file.

Journal file names end with a ".jou" extension, though this is not strictly required for user-generated journal files. If no journaling is desired, the user may start Trelis with the -nojournal command line option or use the command :

[Set] Journal {Off | On}

Turning journaling back on resumes writing commands to the same journal file.

Most Trelis commands entered during a session are journaled; the exceptions are commands that require interactive input (such as Zoom Cursor), some graphics related commands, and the Playback command.

Recording Graphics Commands

All graphics related commands may be enabled or disabled with the command:

Journal Graphics {On | Off}

The default is Journal Graphics Off .

Recording Entity IDs and Names

When an entity is specified in a command using its name, the command may be journaled using the entity name, or by using the corresponding entity type and id. The method used to journal commands using names is determined with the command:

Journal Names {On | Off}

The default is Journal Names On .

If an entity is referred to using its entity type and id, the command will be journaled with the entity type and id, even if the entity has been named.

Recording APREPRO Commands

APREPRO commands may be echoed to the journal file using the following command

[set] Journal [Graphics|Names|Aprepro|Errors] [on|off]

See APREPRO Journaling for more information.

Recording Errors

The default mode for Trelis is to not journal any command that does not execute successfully. To turn this mode off and echo all commands to the journal file, regardless of the success status, use the following command:

Journal Errors {On|OFF}

If a command did not execute successfully and the journal errors status is ON, then the unsuccessful command will be written as a comment to the file. For example an unsuccessful command might look like the following in the journal file

## create brick x 10 x 10 z 10

Since Trelis recognizes this as erroneous syntax, it will issue an error when the command is issued, but will still write the command to the journal file as a comment, prefixing the command with "##".

This option may be useful when tracking or documenting program errors.