About This Guide

This chapter includes:

What you'll find in this guide
Typographical conventions
Technical support

What you'll find in this guide

The QNX Neutrino System Analysis Toolkit User's Guide describes how to use the instrumented microkernel to obtain a detailed analysis of what's happening in an entire QNX Neutrino system. This guide contains the following sections and chapters:

To find out about:	Go to:
What the SAT is, what it can do for you, and how it works	Introduction
What generates events	Events and the Kernel
How the kernel buffers data	Kernel Buffer Management
How to save data	Capturing Trace Data
Different ways to reduce the amount of data	Filtering
What the data tells you	Interpreting Trace Data
Examples of filtering the trace data	Tutorials
What specific events return	Current Trace Events and Data

Typographical conventions

Throughout this manual, we use certain typographical conventions to distinguish technical terms. In general, the conventions we use conform to those found in IEEE POSIX publications. The following table summarizes our conventions:

Reference	Example
Code examples	`if( stream == NULL )`
Command options	`-lR`
Commands	`make`
Environment variables	PATH
File and pathnames	`/dev/null`
Function names	exit()
Keyboard chords	Ctrl-Alt-Delete
Keyboard input	`something you type`
Keyboard keys	Enter
Program output	`login:`
Programming constants	NULL
Programming data types	`unsigned short`
Programming literals	`0xFF`, `"message string"`
Variable names	stdin
User-interface components	Cancel

We use an arrow (→) in directions for accessing menu items, like this:

You'll find the Other... menu item under Perspective-->Show View.

We use notes, cautions, and warnings to highlight important messages:

Notes point out something important or useful.

Cautions tell you about commands or procedures that may have unwanted or undesirable side effects.

Warnings tell you about commands or procedures that could be dangerous to your files, your hardware, or even yourself.

Note to Windows users

In our documentation, we use a forward slash (/) as a delimiter in all pathnames, including those pointing to Windows files.

We also generally follow POSIX/UNIX filesystem conventions.

Navigation buttons

At the top and bottom of our HTML docs, you'll see some or all of these buttons:

Use this button:	To move:
	To the previous part of the document.
	“Up” in the document: In a prose book, this typically takes you to About This Guide. In a reference book, it takes you to the listing of items that start with a given letter. For example, if you're looking at the docs for abs(), this button takes you to the listing of the functions that start with `A`.
	To the keyword index.
	To the next part of the document.

Technical support

To obtain technical support for any QNX product, visit the Support area on our website (www.qnx.com). You'll find a wide range of support options, including community forums.