QNX Neutrino OS


QNX Momentics Non-Commercial

Documentation Roadmap

QNX Neutrino Realtime Operating System:
Photon microGUI:
DDKs, and specialty tools:
Bookset overview
Getting started with the docs

Copyright © QNX Software Systems Ltd. 2002. All rights reserved.

Bookset overview

[]

System Architecture

Describes the philosophy and architecture of the QNX 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.

[]

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, 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.

[]

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 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.

[]

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 that aren't covered in the basic Photon docset.

[]

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.

[]

Citrix ICA Client for QNX Neutrino

Tells you how to configure and run ICA Client, a tool that lets you connect to Windows NT from Photon.

[]

Mozilla Web Browser for QNX 6

Tells you how to use the Mozilla web browser for QNX Neutrino.

[]

Photon Chinese Supplement

Tells you how to input Chinese characters in Photon.

[]

Photon Japanese Supplement

Tells you how to input Japanese characters in Photon.

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 QNX Neutrino Library 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 Building Embedded Systems, Making an OS Image
Run utilities on your host or target (ls, cp, etc.) Utilities Reference
Get explanations for error codes Utilities Reference, errno
See sample OS buildfiles and configuration files Building Embedded Systems, Sample Buildfiles
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 Neutrino QNX 4 --> QNX Neutrino 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, Momentics, Neutrino, and Photon are registered trademarks, and PhAB is a trademark, of QNX Software Systems Ltd. All other trademarks and registered trademarks belong to their respective owners.