QNX® Software Development Platform

The tables below will help you find your way around the documentation for the QNX Software Development Platform. Here you'll find a comprehensive library of titles to help you understand the OS and its tools so you can develop and deploy superior realtime embedded systems. If you're new to the QNX Neutrino® OS, you should start with the Quickstart Guide and System Architecture; if you've used an earlier version of QNX SDP, see Migrating to QNX SDP 7.

Quickstart

Document Description
Quickstart Guide A short tutorial that helps you install and configure the QNX Software Development Platform, and then develop a simple application in the IDE and run it on the QNX Neutrino RTOS.

OS Core Components

Document Description
Adaptive Partitioning User's Guide Describes how to use adaptive partitioning to control the allocation of resources among competing processes.
Boot Optimization Guide Describes optimization techniques to minimize the startup time of your system
Building Embedded Systems Tells you how to get the OS running on your target embedded system, write an IPL, customize a startup program, etc.
Core Networking Stack User's Guide Describes how to use io-pkt-* for networking on QNX Neutrino.
Customizing a BSP Provides guidance on modifying a reference board BSP to work with a custom board.
Device Publishers Developer's Guide Provides a reference of all PPS objects written by device publishers and lists the command options you can set for publishers.
High Availability Framework Developer's Guide How to build robust high-availability software running on the QNX Neutrino realtime operating system.
Instant Device Activation How to set up a “minidriver” to start devices quickly when the system boots.
Migrating to QNX SDP 7 Describes how to adapt your programs, buildfiles, and so on if you're moving to QNX SDP 7.0 from an earlier release
Persistent Publish/Subscribe Developer's Guide Describes the QNX Persistent Publish/Subscribe service and its API.
QDB Developer's Guide How to set up, configure, and use the QNX database (QDB).
Security Developer's Guide Describes how to implement and enforce security policies to create and maintain a trusted execution environment.
System Analysis Toolkit (SAT) User's Guide Describes how you can use the instrumented microkernel to perform a detailed analysis of what's happening in an entire QNX Neutrino system.
System Architecture Describes the philosophy and architecture of the microkernel, resource managers, processes, threads, message-passing services, and more.
Technotes Deals with a series of topics, often platform-specific, that aren't covered in the basic docset.
User's Guide Explains how to use the QNX Neutrino runtime environment and perform system-administration tasks.

Audio & Graphics API

Document Description
Audio Developer's Guide Describes the audio drivers and API for developers who wish to write audio applications.
Gestures Library Reference How to determine what sort of gestures someone is using to interact with an application.
Image Library Reference How to write applications that render images using the libimg library.
Input Events Library Reference How to receive and process events from input devices.
OpenWF Display Configuration Developer's Guide Explains how to modify and build the Wfdcfg library for your display hardware.
Screen Graphics Subsystem Developer's Guide Brings together modern graphics, multimedia, and user interface (UI) technologies and provides a platform for applications built with HTML5, Elektrobit GUIDE, Crank Storyboard, Qt and native (e.g., OpenGL ES) code.
Video Capture Library Reference Explains how to use the video capture framework to capture frames from a video input source.

Programming

Document Description
Getting Started with QNX Neutrino This book, by Rob Krten and updated by QNX Software Systems, will help you design and develop robust realtime systems—from tiny embedded control applications to large network-distributed systems—using the QNX Neutrino RTOS.
PCI Server User's Guide Describes how to use the PCI server to attach and configure PCI devices.
Programmer's Guide Tells you how to get started writing programs, including interrupt handlers, etc.
The QNX Neutrino Cookbook: Recipes for Programmers Provides small, well-defined pieces of code that you can modify and incorporate in your system.
Writing a Resource Manager Explains how to write 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.

Utilities & Libraries

Document Description
Addon Interfaces Library Reference How to create addons that dynamically add functionality to applications.
C Library Reference Describes the QNX Neutrino C library functions, including POSIX threads, kernel calls, resource manager functions, etc.
Devctl and Ioctl Commands Describes the device- and I/O-control commands that you can use with devctl() and ioctl().
PAM Reference Describes the set of configurable and pluggable authentication modules that are included as part of the QNX Neutrino RTOS.
Utilities Reference Describes the QNX Neutrino utilities and manager processes.
Note: Your system might not include all of the utilities, managers, and configuration files that these documents describe, depending on what software you've installed. For example, some utilities are included in a specific Board Support Package (BSP).

Technical support options

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.

Typographical conventions

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