Specifications

156 System Software Diagnostics Guide — September 2006
Runtime Trace Facility (RTF) Reference
28.5 rtftool Command
This section explains the rtftool command, which is used to control RTF and modify the trace
output. The
rtftool command is issued from the command line. The rtftool command can be
issued from any directory.
28.5.1 Pausing and Reloading RTF
RTF tracing is enabled by default. Use the rtftool command to pause, resume and reload the
RTF’s tracing capabilities. The
rtftool command has the following pause and reload variations:
rtftool pause
Pauses RTF tracing. Trace output will not be written to the log file while RTF is paused.
rtftool resume
Resumes RTF tracing. Issue this command to resume tracing after RTF has been paused.
rtftool reload
Reloads an updated RTF configuration file (RtfConfigLinux.xml or RtfConfigWin.xml) and
restarts RTF, using the settings from the updated RTF configuration file.
Note: You do not need to pause RTF tracing before issuing the
rtftool reload
command. RTF supports dynamic updates to the RTF configuration file. Simply edit
and save the file, then issue the
rtftool reload command to begin tracing with the
updated RTF configuration file settings.
28.5.2 Clearing the RTF Trace Log File Contents
Use the rtftool command to clear all trace data from the RTF log file. The following command
line option clears the RTF log file contents:
rtftool clean [-f]
Clears the RTF log file contents. When the -f option is used, RTF will not ask the user for
confirmation before clearing the log file.
28.5.3 Running RTF in Preservation Mode
You can set RTF to run in preservation mode. Preservation mode allows you to determine whether
old trace data is overwritten or preserved in a separate file when the log file grows to its maximum
size. When preservation mode is turned ON, RTF will append a _p to the end of each RTF log file
name; RTF will not delete or overwrite these _p log files. Use the preserve_size and
preserve_maxbackup Logfile tag attributes to set the size and number of backup log files,
respectively. Use the following command line option to enable/disable preservation mode:
rtftool preservation {on | off}
Turns RTF preservation mode ON and OFF.