Command Line Syntax

KTRACE.EXE is designed to be a VIO window compatible text mode application. This permits tracing to be performed from the simplest telnet window remotely.

Syntax

The KTRACE.EXE program takes all its parameters from the command line, or from KTRACE.CFG. All parameters have reasonable defaults, so that no parameter is mandatory. You may wish to change the default value by specifying a parameter explicitly, or by changing the default in the configuration file (see Configuration section).

The order of precedence in which parameter values are used by KTRACE.EXE, from highest to lowest, is:

Command line parameters
KTRACE.CFG default parameters
Programmatic default parameters

The following command prints help information about KTRACE.EXE parameters.

KTRACE ?

The parameters are options that may be entered in any order, because they are recognized by starting character, ('-' or '/') and by option name.

The general syntax is:

KTRACE [-ffilename] [-lfilefilter] [-mmaxsize] [-ttracepoints] [-ppidmask] [-iPIDx] [-bmaxbufsize] [-ccomment]
KTRACE -k
KTRACE -v

Parameters

Parameter	Description	Default	Example
`-ffilename`	Trace File Name Specifies an alternative drive, path and file name for the capture file being produced. If specified, it must be compliant with the OS/2 file naming rules. When file extension is omitted, `.ktr` is added as the extension. Any extension other than `.ktr` is changed to `.ktr`.	`ktrace.ktr` in the current directory.	`-fd:\temp\apperror.ktr`
`-lfilefilter`	Trace File Filter Used to specify a filename pattern. Only tracepoints which access files whose names match the specified pattern are traced. This filter is case insensitive and wild cards are permissible; asterisk (``) is used for one or more characters. Do not use relative file names; the name must be fully qualified or must be preceded by `` to indicate that any instance of the file regardless of path should be traced. This filter only affects tracepoints related to file access and has no effect on other program directives.	all files	`-lc:\config.sys (correct)` `-lconfig.sys (correct)` `-lconfig.sys (incorrect)` `-los2* (correct)` `-los2* (incorrect)`
`-mmaxsize`	Trace File Size Maximum trace file size in megabytes. Tracing will automatically stop when this size is reached.	8 MB (with a practical minimum of 1MB and no set maximum).	`-m128`
`-ttracepoints`	Tracepoints Allows specification of tracepoints by using hexadecimal tracepoint mask values or tracepoint aliases. Multiple tracepoints may be specified, separated by the plus sign (`+`), to allow targeting a custom set of tracepoints. See the Tracepoints section for more information regarding each tracepoint. It is not necessary to include leading zeros for a hexadecimal tracepoint mask value.	All tracepoints.	`Using Hex Tracepoints:` `-t02+04+800(leading '0's omitted)` `(OPEN_POST+READ_PRE+MOVE_POST)` `Using Aliases:` `-tOC` `(OPEN_POST+CLOSE)` `-tRW` `(READ_POST+WRITE_POST+CHGFILEPTR)`
`-ppidmask`	Process ID Mask The parameter `pidmask` allows a process name pattern to be entered which will cause the program to trace all processes matching the pattern. Tracepoints for processes not matching the pattern will not be traced. The `pidmask` is case insensitive. Since tracepoints may use qualified or unqualified process names, an asterisk (`*`) should be used to represent the process' pathname. An asterisk may also be used as a wildcard for one or more characters.	All processes	`-p*\java.exe`
`-iPIDx`	Process ID This directive allows for a specific process to be traced when identified by its Process ID or PID (using a tool such as PSTAT for OS/2). Multiple PIDs may be specified, separated by commas. `PIDx` may be entered in one of three formats: decimal, octal or hexadecimal. The decimal format requires only the specification of the decimal value. The hexadecimal format is assumed to be any which is preceded by `0x` or `0X`. Finally, the octal format is assumed when a valid octal value is preceded by `0`. Furthermore, this option can be used to exclude from the trace only those tracepoints encountered in the specified processes. To use this option in this mode, `PIDx` must be preceded by a minus sign (`-`).	All processes	`-i15` (decimal) `-i0x15` (hexadecimal) `-i015` (octal) `-i-15,-0x15,-015` (excludes these tracepoints)
`-ccomment`	Comment User comment in double quotes.	none	`-c"Trace of all Java apps"`
`-bmaxbufsize`	Maximum Buffer Bytes to Capture Certain tracepoints will cause a data buffer to be copied from memory to the trace file as the payload for a trace record. These are: `WRITE_PRE` `WRITE_POST` `READ_POST` `FIND_FIRST` `FIND_NEXT` `QUERYFILEINFO` `SETFILEINFO` `SETPATHINFO` `SETDATETIME` `DEVIOCTL` The `maxbufsize` parameter specifies the maximum number of bytes of such data to capture. If the actual buffer size exceeds `maxbufsize`, the data written to the trace file will be truncated.	512 bytes (minimum of 0 and no maximum).	`-b1024`
`-k`	Stop Tracing This option stops any active trace session. This allows for stopping trace sessions launched outside of a command interpreter. For instance, a scheduled trace can be stopped by the scheduler as well. This lends itself to automation.	n/a	`-k`
`-v`	Verify License This option allows a license file to be tested for validity. It also displays the specific details of serial number, licensee name(s), and any limitations of this license.	n/a	`-v`