QNX Realtime Platform


Documentation Roadmap

You need to install the QNX 6 development package in order to see all these documents.
In the Photon bookset:
Bookset overview
Getting started with the docs

Copyright © QNX Software Systems Ltd. 2001. All rights reserved.
For more information on the new QNX Realtime Platform, including technical support options, please visit our website (www.qnx.com).

Bookset overview

[]

System Architecture

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

[]

Programmer's Guide

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

[]

Utilities Reference

Describes the QNX 6 utilities and manager processes, including support utilities that run under QNX 4. You'll also find the complete manual for the qed editor.

[]

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.

[]

Technotes

Deals with a series of topics, often platform-specific, 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 API 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, arranged alphabetically for easy reference. The back of the manual has a summary of these functions, grouped according to their main area of application.

[]

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.

[]

Photon Technotes

Deals with a series of topics, often platform-specific, that aren't covered in the basic Photon docset.

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
Edit a document Using the Photon editor: ped;
using text-mode editors: vi; qed
Start developing apps Programmer's Guide
Start developing Photon-based apps Photon Programmer's Guide
Look up a function in the Neutrino Library Library Reference
Look up a function in the Photon Library Photon Library Reference
Look up PtButton or other Photon widgets Widget Reference
Run utilities on your host or target (ls, cp, etc.) Utilities Reference
Compile your code Utilities Reference, qcc; see also Programmer's Guide, Compiling and Debugging
Debug your code Utilities Reference, gdb; see also Programmer's Guide, Compiling and Debugging and Using GDB
Learn our makefile conventions Programmer's Guide, Conventions for Makefiles and Directories
Write a resource manager 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
Migrate your QNX 4 code to QNX 6 QNX 4 --> QNX 6 Migration Guide

Technical support options

To obtain technical support for any QNX product, visit the Technical Support section in the Support area on our website (www.qnx.com). You'll find a wide range of support options, including our free web-based QNX Developer's Network.

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

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

Copyright notices

For complete copyright information, see the following:

If a manual refers to third-party software, all appropriate copyright notices are published in an appendix called Third-Party Copyright Notices.
QNX, Neutrino, and Photon microGUI are registered trademarks of QNX Software Systems Ltd. All other trademarks and registered trademarks belong to their respective owners.