A Roadmap to the QNX Software Development Platform

Caution: This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

The tables below will help you find your way around the documentation for QNX SDP.

See this document: For:
Welcome to the QNX Software Development Platform An introduction to the QNX Software Development Platform, the QNX Momentics Tool Suite, the QNX Neutrino RTOS, and QNX Aviage middleware, including an extensive documentation roadmap.
10 Steps to Developing a QNX Program: Quickstart Guide A short tutorial that helps you install and configure QNX SDP and the QNX Neutrino operating system, and then develop a simple application in the IDE and run it on QNX Neutrino.
Installation Guide Instructions for installing and uninstalling QNX SDP.
Release Notes Important details about QNX SDP. This link goes to the most recent version in the Download area of the website.

QNX Momentics Tool Suite:

See this document: For:
QNX Neutrino Utilities Reference Reference material for the compiler, linker, and debugger, and other command-line utilities.
IDE User's Guide A description of the QNX Momentics Integrated Development Environment, and how to set up and start using the tools to build and analyze QNX Neutrino-based target systems.
Phindows Connectivity Instructions for accessing the Photon microGUI from a Microsoft Windows machine.

QNX Neutrino Realtime Operating System:

See this document: For:
System Architecture A description of the philosophy and architecture of the QNX Neutrino microkernel, resource managers, processes, threads, message-passing services, and more.
Neutrino User's Guide Instructions for using the QNX Neutrino runtime environment and performing various system-administration tasks.
Getting Started with QNX Neutrino: A Guide for Realtime Programmers Help designing and developing robust realtime systems -- from tiny embedded control applications to large network-distributed systems -- using the QNX Neutrino RTOS.
Neutrino Programmer's Guide Information about writing programs, including compiling and debugging, writing interrupt handlers, etc.
Building Embedded Systems Instructions for getting QNX Neutrino running on your target embedded system, writing an IPL, customizing a startup program, etc.
Utilities Reference Reference material about the QNX Neutrino utilities, manager processes, and configuration files. You'll also find the complete manual for the qed editor.
Neutrino Library Reference Reference material about the C library functions and data structures, including POSIX threads, kernel calls, resource manager functions, etc.
Writing a Resource Manager Instructions for creating a resource manager, a process that registers a name in the filesystem name space, which other processes then use to communicate with the resource manager.
Audio Developer's Guide Instructions for writing audio applications.
Addon Interfaces Library Reference A description of the Addon Interfaces Library and how to use it to add extendibility to applications that use standard interfaces.
Adaptive Partitioning User's Guide Instructions for using adaptive partitioning to ensure that competing applications are given an engineered set of system resources (e.g. CPU time).
Core Networking Stack User's Guide Instructions for using io-pkt for networking on QNX Neutrino.
High Availability Framework Developer's Guide Instructions for detecting, isolating and recovering from software faults.
Instant Device Activation User's Guide Instructions for starting devices quickly when the system boots.
Multicore Processing User's Guide Information on getting the most performance possible out of a multicore system.
System Analysis Toolkit User's Guide Instructions for using the instrumented microkernel to obtain a detailed analysis of what's happening in a QNX Neutrino system.
Driver Development Kit Guides Instructions for writing device drivers for the QNX Neutrino OS. You'll find a separate DDK doc for audio, graphics, input, and Universal Serial Bus (USB) devices.

Note that the QNX Software Development Platform doesn't include the DDKs themselves, but it includes the documentation for them.

OS Technotes Specialized topics that aren't covered in the basic Neutrino documentation.

Note: 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).

QNX Neutrino Photon microGUI:

See this document: For:
Photon Programmer's Guide 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.
Photon Library Reference Concise descriptions of Photon's and PhAB's global data structures and functions.
Widget Reference 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 Instructions for creating a custom widget and binding it into PhAB.
Photon Multilingual Input Instructions for inputting Chinese, Japanese, and Korean characters in Photon.

QNX Neutrino Advanced Graphics:

See this document: For:
Advanced Graphics Developer's Guide Instructions for creating graphical applications that use the QNX Graphics Framework API and the OpenGL ES APIs.
Composition Manager Instructions for using the QNX Composition Manager, a hardware-independent layer of abstraction that encompasses all aspects of window management, such as window creation, realization, and destruction.
Web Browser Engine Developer's Guide Instructions for building a web browser using the Web Browser Engine, a high-performance embeddable web browser that's based on the WebKit open-source engine.

Dinkum documentation:

See this document: For:
Dinkum C++ Library Descriptions of the Dinkum C++ functions, a conforming implementation of the Standard C++ library.
Dinkum C99 Library Descriptions of the Dinkum C99 functions, a conforming implementation of the Standard C library.
Dinkum EC++ Library Descriptions of the Dinkum EC++ functions, a conforming implementation of the Embedded C++ library.

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.

Typographical conventions

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

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.