file log_file
The log_file is an ASCII file Adams View creates, that becomes a record of Adams View session.
Format:
file log_file |
|---|
file_name = | string |
write_switch = | on_off |
messages_include = | on_off |
commands_include = | on_off |
expand_commands = | on_off |
Example:
file log_file & |
|---|
write_switch = | on & |
messages_include = | on & |
commands_include = | on |
Description:
Parameter | Value Type | Description |
|---|
file_name | String | Specifies the name of the file that is to be read, written, or executed. |
write_switch | On_Off | This parameter controls whether or not Adams View generates a log file. |
messages_include | On_Off | Allows you to specify the inclusion or exclusion of diagnostic messages, produced by Adams View, into the log file |
commands_include | On_Off | COMMANDS_INCLUDE is a parameter to the "file log_file" command |
expand_commands | On_Off | EXPAND_COMMANDS is a parameter on the "file log_file" command |
Extended Definition:
1. All commands, messages, and prompts are sent to the log file. The name of this file is defaulted to aview.log.
The default name may be overridden using the file_name parameter of the LOG_FILE command.
The log_file command allows modification of the behavior of the log file that is generated when Adams View is running. These modifications include:
■Specification of the name of the log file
■A switch to turn off the log file write (slight system performance improvement)
■A switch for inclusion or exclusion of system messages
■A switch to include or exclude commands entered
■A switch for the expansion of abbreviated commands
The log file is also useful for reproducing a session (e.g. recreating a session after a system crash or other such catastrophic failure) and for creation of command macros (see help for the expand_commands parameter). Log files are command files generated by the Adams View containing all commands executed as well as diagnostics generated (All diagnostics and messages are written to the log file as comments.
This allows the log file to be executed directly as a command file).
Log files may be read in and executed in the same fashion as other command files. Each time Adams View is run, a new log file is generated. If you wish to save the log file after finishing a session, make sure the log file is renamed, otherwise it may be replaced the next time the application is started.
2. The proper extension is the default but can be overridden by simply supplying a different extension.
You do not need to enclose the file name in quotes if it only contains alpha-numeric characters and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory paths, you must enclose the name in quotes.
3. Turning off the log file will result in a slight performance improvement. The name of the log file is defaulted to aview.log. The default name may be overridden using the file_name parameter. By default, Adams View generates a log file that may be played back at a later time. Each time Adams View is run a new log file is generated.
If this parameter is turned Off, Adams View will not generate a log file. It is recommended that the log file remain activated because it represents a record of the session. A log file may be executed as a command file in order to reproduce a session. This is useful in recreating a session after a system crash or other such catastrophic failure.
4. By default, all messages from Adams View are sent to the log file. This allows a more complete representation of the session in the log file and provides more information to someone who is reading the log file.
Messages are stored as comments in the log file, and are therefore ignored by the command processor if the log file is read in as a command file.
5. commands_include parameter allows you to specify whether the command entered during an Adams View session should be echoed to the log file. If the value of the COMMANDS_INCLUDE parameter is Off, no commands entered by the user or a command file will be printed to the log file. ON, the default, indicates all commands will be echoed to the log file.
If the user wishes to use the log file as a command file, this parameter should be set to ON. Also, the EXPAND_COMMANDS parameter should be set as well.
Note: | If a command file is executed, these commands will be sent to the log file as comments. This is because if the command that executes the command file, as well as the commands in the command file are both left as executable in the log file, then the commands will be executed twice! Once, by calling the same command file, and next, as logged when the file was read the first time. |
6. expand_commands allows you to specify whether the commands entered should be written to the log file as they are entered (possibly abbreviated) or expanded to full length. If EXPAND_COMMANDS is turned ON, entire command keywords and parameter names are written to the log file even if only abbreviations are entered. The default setting is OFF. This provides a very efficient way to create command procedures. For example, the user can interactively enter the abbreviated commands to quickly create an xy plot. (Entering the abbreviated commands is much faster but can create a log file that is not very readable.) With the EXPAND_COMMANDS parameter set to "on", the fully expanded commands are written to the log file. This log file can be renamed and executed as a command file to repeat a given action, such as recreating the xy plot for subsequent analysis runs. Also, once created, the converted log file can be edited to perform similar yet different functions. You may expand commands in an existing command file by first placing the command "file log_file expand_commands=on commands_include=on" at the beginning of the file. If you then execute the command file, the resulting log file will contain an expanded copy of the commands.