Format Clauses

The Trace Analyzer uses the concept of a format clause to define the presentation format of protocol field data. This section describes what a format clause is and how format clauses are used by the program.

A format clause is a textual phrase used to describe to the Trace Analyzer how the human-readable presentation of a protocol field maps to the actual data extracted from a trace record. Each character in a format clause has a specific meaning. Only certain combinations of these characters are possible. Table 1 summarizes this information.

Character/Phrase	Meaning	Used With	Example
`HH` `hh`	A single byte in hexadecimal format (uppercase or lowercase, respectively) Presents digits 0-9, A-F	`HH` `hh` `:`	An uppercase MAC address: `HH:HH:HH:HH:HH:HH` A lowercase MAC address: `hh:hh:hh:hh:hh:hh`
`9`	A single, integral, base 10 digit Pad to the left with zero Presents digits 0-9	`Z` `9` `.` `,`	A decimal number, 3 decimal places, zero padded: `9,999.999` A decimal number, 3 decimal places, zeros suppressed: `Z,ZZ9.999`
`Z` or `z`	A single, integral, base 10 digit Suppress padding to the left with zero	`Z` `z` `9` `.` `,`	An IP address: `zz9.zz9.zz9.zz9`
`b`	A single bit	`b`	Four bits of binary data: `bbbb`
`x...`	A variable length text string (ASCII or EBCDIC formatted)	(n/a)	Any ASCII or EBCDIC text string: `x...`
`c`	A single text character (ASCII or EBCDIC formatted)	(n/a)	Three ASCII or EBCDIC characters: `ccc`

Table 1. Valid Format Clause Components