QNX Momentics Development Suite

Documentation Roadmap


Bookset overview
Getting started with the docs
Your system might not include all of the utilities, managers, and configuration files that these documents describe. For example, some utilities are included only in a specific Board Support Package (BSP).

For the most up-to-date version of the release notes for our products, go to our website, www.qnx.com.


QNX Momentics:
Integrated Development Environment:
QNX Neutrino Realtime Operating System:
Photon microGUI:
BSPs, DDKs, TDKs, and specialty tools:
Dinkum documentation:

Bookset overview

[]

Welcome to QNX Momentics

Gives you a quick introduction to the QNX Momentics development suite, and helps you find your way around the documentation.

[]

Quickstart Guide: 10 Steps to Your First QNX Program

Helps you install and configure the QNX Momentics tools and the QNX Neutrino operating system, so you can start developing right away.

[]

6.3 and 6.2.1 Compatibility

Describes compatibility issues between QNX Momentics 6.3 and 6.2.1.

[]

IDE User's Guide

Describes the QNX Integrated Development Environment, how to set up and start using the tools to build QNX-based target systems, etc.

[]

System Architecture

Describes the philosophy and architecture of the QNX Neutrino microkernel, resource managers, processes, threads, message-passing services, and more.

[]

Neutrino User's Guide

Describes how to use the QNX Neutrino runtime environment and perform various system-administration tasks.

[]

Neutrino Programmer's Guide

Tells you how to get started writing programs, including interrupt handlers, resource managers, etc.

[]

Building Embedded Systems

Tells you how to get the OS running on your target embedded system, write an IPL, customize a startup program, etc.

[]

Utilities Reference

Describes the QNX Neutrino utilities and manager processes. You'll also find the complete manual for the qed editor.

[]

Neutrino Library Reference

Describes the C library functions, including POSIX threads, kernel calls, resource manager functions, etc.

[]

Audio Developer's Guide

Describes the audio drivers and API for developers who wish to write audio applications.

[]

Addon Interfaces Library Reference

Describes the Addon Interfaces Library, and how to use it to add extendibility to applications using standard interfaces.

[]

OS Technotes

Deals with a series of topics that aren't covered in the basic docset.

[]

Photon Programmer's Guide

Gives you a hands-on tour of PhAB, the powerful application builder for Photon. You'll learn how to quickly assemble a GUI from predefined widgets, link the GUI to an application, and generate C source to bring the GUI to life.

[]

Multimedia Developer's Guide

Describes the multimedia architecture for developers who wish to write multimedia plugins.

[]

Photon Library Reference

Provides concise descriptions of Photon's and PhAB's global data structures and functions.

[]

Widget Reference

Contains guidelines for programming widgets, along with concise descriptions of all global data structures, resources, and convenience functions associated with widgets. It also gives you practical examples of how to use Photon widgets and widget functions.

[]

Building Custom Widgets

Explains how to create a custom widget and how to bind it into PhAB. If you need a widget whose features extend the standard capabilities of the Photon widget library, this guide is for you.

[]

Board Support Packages (BSPs)

You'll find two types of documentation for a BSP, depending on whether it's a newer or older BSP:

  • as a single "readme" file
  • as a conventional user's guide

To locate the docs for your installed BSPs, see the Start or Launch menu, or point your browser at:

$QNX_TARGET/usr/help/product/bsp_name_of_board

[]

DDK Guides

DDK guides describe how to write drivers for the QNX OS. You'll find a separate DDK doc for audio, graphics, input, network, printer, and Universal Serial Bus (USB) devices.

Note that QNX Momentics doesn't include the DDKs themselves, but it includes the docs for them, so that you won't end up with multiple copies of the documentation.

[]

Adaptive Partitioning User's Guide

The Adaptive Partitioning User's Guide describes how to use adaptive partitioning to ensure that competing applications are given an engineered set of system resources (e.g. CPU time).

[]

Multicore Processing User's Guide

The Multicore Processing User's Guide will help you get the most performance possible out of a multicore system.

[]

System Analysis Toolkit User's Guide

The System Analysis Toolkit (SAT) guide describes how to use the SAT, which includes an instrumented microkernel, so you can see further into running systems than ever before. Now you can log every communication and state change within the microkernel, including interrupts, all parameters/return values from kernel calls, and scheduling decisions, resulting in a deeper and more detailed analysis of system elements. You can even perform kernel-level diagnostics remotely.

[]

Photon Multilingual Input

Tells you how to input Chinese, Japanese, and Korean characters in Photon.

[]

Phindows Connectivity

Tells you how to access the Photon microGUI from a Windows machine.

[]

High Availability Toolkit Developer's Guide

The High Availability Toolkit (HAT) guide describes the components of the HAT and how to build robust HA-aware software running on the QNX RTOS. The HAT gives you the tools to isolate and even repair software faults before they occur throughout your entire system. The HAT includes a highly resilient manager process that can multistage recovery, a client recovery library, and more.


Getting started with the docs

The following table may help you find your way around the docs for information on some common tasks:

If you want to: Go to:
Get a technical overview of the OS System Architecture
Log in and start using the OS Neutrino User's Guide
Edit a document Using the Photon editor: ped;
using text-mode editors: vi; qed; see also Neutrino User's Guide, Using Editors
Start developing apps IDE User's Guide; Neutrino Programmer's Guide
Start developing Photon-based apps Photon Programmer's Guide
Look up a function in the QNX Neutrino Library Neutrino Library Reference
Look up a function in the Photon Library Photon Library Reference
Look up PtButton or other Photon widgets Widget Reference
Create your own widgets Building Custom Widgets
Make an OS image for your target IDE User's Guide; Building Embedded Systems, Making an OS Image
Run utilities on your host or target (ls, cp, etc.) Utilities Reference
Get quick-reference help about a utility Utilities Reference, use
Get explanations for error codes Utilities Reference, errno
See sample OS buildfiles and configuration files Building Embedded Systems, Sample Buildfiles
Compile your code IDE User's Guide; Utilities Reference, qcc; see also Neutrino Programmer's Guide, Compiling and Debugging
Debug your code IDE User's Guide; Utilities Reference, gdb; see also Neutrino Programmer's Guide, Compiling and Debugging and Using GDB
Learn our makefile conventions Neutrino Programmer's Guide, Conventions for Makefiles and Directories
Write a resource manager Neutrino Programmer's Guide, Writing a Resource Manager
Write an audio application Audio Developer's Guide, Writing an audio application
Write multimedia plugins Multimedia Developer's Guide

Technical support options

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


For typographical conventions used in our documentation, please see conventions.

Please email your comments on the documentation to docs@qnx.com.

If a manual refers to third-party software, all appropriate copyright notices are published in an appendix called Third-Party Copyright Notices.


QNX, Neutrino, Photon, Photon microGUI, Momentics, and Aviage are trademarks, registered in certain jurisdictions, of QNX Software Systems GmbH & Co. KG. and are used under license by QNX Software Systems International Corporation. All other trademarks belong to their respective owners.