Utilities Reference

® ®
QNX Neutrino Realtime Operating System

Utilities Reference
For QNX ® Neutrino® 6.5.0
© 2010, QNX Software Systems GmbH & Co. KG.

© 1996–2010, QNX Software Systems GmbH & Co. KG. All rights reserved.
Published under license by:
QNX Software Systems Co.
175 Terence Matthews Crescent
Kanata, Ontario
K2M 1W8
Canada
Voice: +1 613 591-0931
Fax: +1 613 591-3579
Email: info@qnx.com
Web: http://www.qnx.com/
Electronic edition published 2010
QNX, Neutrino, Photon, Photon microGUI, Momentics, Aviage, and related marks, names, and logos are trademarks, registered in certain jurisdictions, of QNX Software
Systems GmbH & Co. KG. and are used under license by QNX Software Systems Co. All other trademarks belong to their respective owners.
Contents
About This Reference xxi

Typographical conventions xxiii
Note to Windows users xxiv
Technical support xxiv
Utility Conventions 1
Syntax conventions 3
Interpreting utility syntax 3
Invoking utilities 4
File conventions 5
Signal conventions 5
Exit status conventions 5
Error conventions 6
Utilities 7
/etc/acl.conf 10
addr2line 12
addvariant 13
appbuilder 16
applypatch 18
aps 20
ar 24
arp 25
/etc/autoconnect 27
basename 29
bc 31
bdftophf2 39
bindres 40
bison 41
bkgdmgr 42
bootpd 44
/etc/bootptab 46
brconfig 51
bunzip2 54
June 22, 2010 Contents iii

bz2cat 55
bzip2 56
c++filt 58
calib 59
cam-cdrom.so 61
cam-disk.so 62
cam-optical.so 64
cat 66
CC, cc 68
chat 69
chattr 75
chgrp 77
chkdosfs 79
chkfsys 82
chkqnx6fs 87
chmod 90
chown 94
cksum 96
clear 98
cmp 99
/etc/context.conf 101
coreinfo 103
cp 104
cpio 112
cron 115
crontab 117
ctags 121
cut 123
cvs 125
date 137
dcheck 142
dd 145
deflate 148
deva-ctrl-4dwave.so 150
deva-ctrl-audiopci.so 152
deva-ctrl-cs4281.so 154
deva-ctrl-ess1938.so 156
deva-ctrl-geode.so 158
deva-ctrl-i8x0.so 160
deva-ctrl-intel_hda.so 162
deva-ctrl-nmg6.so 164
iv Contents June 22, 2010

deva-ctrl-sb.so 166
deva-ctrl-via686.so 168
deva-ctrl-vortex.so 170
deva-ctrl-ymfds1.so 172
deva-mixer-ac97.so 174
deva-mixer-ak4531.so 175
deva-mixer-hda.so 176
deva-util-restore.so 177
devb-adpu320 178
devb-aha8 182
devb-ahci 186
devb-btmm 190
devb-eide 194
devb-fdc 200
devb-loopback 203
devb-mvSata 208
devb-ram 212
devb-umass 215
devc-con, devc-con-hid 217
devc-par 237
devc-pty 239
devc-ser8250 240
devc-serpci 245
devc-serusb 247
devc-serzscc 250
devf-generic 254
devf-ram 261
devg-ati_rage128.so 267
devg-carmine.so 270
devg-chips.so 274
devg-coral.so 277
devg-extreme2.so 282
devg-flat.so 285
devg-geode.so 286
devg-gma9xx.so 289
devg-i810.so 292
devg-i830.so 295
devg-intelhd.so 298
devg-matroxg.so 301
devg-poulsbo.so 304
devg-radeon.so 307
June 22, 2010 Contents v

devg-rage.so 310
devg-s3_savage.so 313
devg-sis630.so 316
devg-smi5xx.so 319
devg-smi7xx.so 322
devg-soft3d.so 325
devg-soft3d-fixed.so 326
devg-svga.so 327
devg-tnt.so 329
devg-tvia.so 332
devg-vesabios.so 335
devg-vmware.so 337
devh-egalax.so 339
devh-microtouch.so 341
devh-ps2ser.so 343
devh-touchintl.so 347
devh-usb.so 349
devi-dyna 351
devi-elo 353
devi-hid 356
devi-hirun 359
devi-microtouch 364
devi-semtech 367
devi-zytronic 369
devn-asix.so 372
devn-crys8900.so 375
devn-dm9102.so 378
devn-el509.so 380
devn-el900.so 382
devn-epic.so 385
devn-fd.so 388
devn-i82544.so 390
devn-micrel8841.so 393
devn-ne2000.so 395
devn-pcnet.so 398
devn-pegasus.so 402
devn-rtl.so 405
devn-rtl8150.so 408
devn-sis9.so 411
devn-smc9000.so 414
devn-speedo.so 417
vi Contents June 22, 2010

devn-tigon3.so 420
devn-tulip.so 423
devn-via-rhine.so 426
devnp-ath.so 429
devnp-axe.so 431
devnp-bce.so 433
devnp-bcm1250.so 435
devnp-bcm43xx.so 438
devnp-bge.so 440
devnp-e1000.so 442
devnp-i80579.so 445
devnp-i82544.so 447
devnp-mpcsec.so 451
devnp-mpc85xx.so 453
devnp-msk.so 456
devnp-ral.so, devnp-ural.so 458
devnp-rtl8169.so 461
devnp-rum.so 464
devnp-shim.so 467
devnp-speedo.so 468
devp-pccard 471
devu-ehci.so 474
devu-kbd 476
devu-mouse 477
devu-ohci.so 478
devu-prn 480
devu-uhci.so 482
df 484
dhcp.client 486
dhcpd 492
/etc/dhcpd.conf 500
/var/state/dhcp/dhcpd.leases 521
dhcprelay 524
diff 528
diff3 533
dig 542
dinit 543
dirname 548
diskboot 550
dispconf 553
dloader 555
June 22, 2010 Contents vii

dnssec-dsfromkey 558
dnssec-keyfromlabel 559
dnssec-keygen 560
dnssec-signzone 561
ds 562
du 566
dumpefs 568
dumper 569
dumpifs 572
echo 575
ed 577
egrep 578
elvis 579
enum-devices 602
enum-usb 615
env 625
errno 627
esh 628
etfsctl 635
expand 640
/etc/exports 642
expr 644
false 647
fcat 648
fdformat 649
fdisk 652
fesh 659
fgrep 662
file 663
find 667
finstall 683
flashctl 684
flex 689
fmt 691
fold 692
fontinfo 694
fpemu.so 697
freeze 698
fs-cd.so 701
fs-cifs 703
fs-dos.so 707
viii Contents June 22, 2010

fs-etfs-ram 712
fs-ext2.so 716
fs-mac.so 718
fs-nfs2 720
fs-nfs3 722
fs-nt.so 725
fs-qnx4.so 727
fs-qnx6.so 730
fs-udf.so 733
fsysinfo 738
/etc/fstab 742
ftp 744
/etc/ftpchroot 745
ftpd 746
/etc/ftpd.conf 749
/etc/ftpusers 754
fullpath 756
g++ 757
/etc/gateways 759
gawk 764
gcc 782
gcov 788
gdb 790
getconf 794
getty 799
gf-calib 800
gns 802
gprof 809
grep 810
gunzip 815
gzip 816
ham 820
hamctrl 821
hd 822
head 826
helpviewer 828
hidview 837
hogs 839
host 841
hostapd 842
hostname 844
June 22, 2010 Contents ix

/etc/hosts 845
/etc/hosts.equiv 846
id 849
if_up 851
ifconfig 853
ifwatchd 864
indent 866
inetd 868
/etc/inetd.conf 870
inflator 875
infocmp 878
input-cfg 880
inputtrap 882
io-audio 885
io-blk.so 888
io-display 899
io-graphics 903
io-hid 906
io-pkt-v4, io-pkt-v4-hc, io-pkt-v6-hc 908
io-usb 914
join 916
kill 918
ksh 920
ld 971
ldd 972
ldrel 974
less 976
link 986
ln 987
ln-w 990
logger 991
login 993
logout 997
lpd 998
lpr 1000
lprc 1003
lprq 1006
lprrm 1008
ls 1010
lsm-autoip.so 1015
lsm-pf-v4.so, lsm-pf-v6.so 1018
x Contents June 22, 2010

lsm-qnet.so 1019
lwresd 1026
m4 1027
/usr/share/misc/magic 1028
make 1031
mcd 1036
mcs 1060
melt 1061
mesg 1062
/etc/mib.txt 1063
mixer 1064
mkasmoff 1067
mkcldr 1068
mkbuild 1070
mkdir 1072
mkdosfs 1074
mkefs 1077
mketfs 1085
mkfifo 1093
mkfontdir 1095
mkifs 1097
mkimage 1126
mkkbd 1127
mkqnx6fs 1129
mkrec 1132
mksbp 1134
/etc/moduli 1135
more 1136
mount 1139
mq 1143
mqueue 1145
mrouted 1146
mstrip 1154
mv 1155
named 1159
named-checkconf 1160
named-checkzone, named-compilezone 1161
/etc/named.conf 1162
ndp 1163
netmanager 1165
netstat 1167
June 22, 2010 Contents xi

/etc/networks 1172
newgrp 1173
nfsd 1175
/etc/nfsstart 1178
nice 1179
nicinfo 1182
nm 1185
nohup 1186
nslookup 1188
/etc/nsswitch.conf 1194
nsupdate 1196
ntpd 1197
ntpdate 1202
ntpdc 1205
ntpq 1212
ntptrace 1222
objcopy 1224
objdump 1225
od 1226
omshell 1229
on 1234
op 1238
openssl 1239
/etc/party.conf 1244
passwd 1246
paste 1250
patch 1252
pax 1256
pccard-launch 1262
pci 1264
pci-bios, pci-bios-v2 1265
pcnfsd 1267
/etc/pcnfsd.conf 1268
pdebug 1269
ped 1271
pf 1280
/etc/pf.conf 1296
pfctl 1333
pfm 1340
ph 1344
phablang 1347
xii Contents June 22, 2010

phabmsg 1349
phcalc 1352
phdialer 1353
phditto 1356
phfind 1360
phfont 1363
phgrafx 1371
phin 1374
phlip 1379
phlocale 1391
phlogin, phlogin2 1394
phmenu 1398
Photon 1401
phrelay 1403
phrelaycfg 1411
phs-to-bjc 1413
phs-to-bmp 1416
phs-to-escp2 1419
phs-to-ijs 1423
phs-to-pcl 1426
phs-to-ps 1432
phshutdown 1434
phuser 1437
phview 1440
pidin 1442
pin 1454
ping 1455
ping6 1460
pipe 1465
pppd 1467
pppoectl 1470
pppoed 1475
pps 1476
pr 1477
preview 1480
/etc/printcap 1482
printf 1486
prjobs 1491
procnto* 1493
/etc/protocols 1500
ps 1501
June 22, 2010 Contents xiii

pterm 1505
ptermcs 1516
pv 1518
pwd 1520
pwm 1521
pwmopts 1526
python 1530
qbinaudit 1533
QCC, qcc 1535
qconfig 1543
qconn 1546
qcp 1548
qde 1551
qed 1553
qtalk 1555
QWinCfg 1564
racoon 1566
/etc/racoon.conf 1568
random 1578
ranlib 1580
rcp 1581
readelf 1583
renice 1584
/etc/resolv.conf 1586
˜/.rhosts 1589
rlogin 1592
rlogind 1594
rm 1596
rmdir 1598
rndc 1600
rndc-confgen 1601
rndc.conf 1602
route 1603
route6d 1607
routed 1610
/etc/rpc 1615
rpcbind 1616
rpcgen 1618
rpcinfo 1621
rsh 1623
rshd 1625
xiv Contents June 22, 2010

rtadvd 1628
/etc/rtadvd.conf 1631
rtc 1634
rtquery 1637
rtsold 1639
ruptime 1641
rwho 1642
rwhod 1643
savercfg 1645
scp 1648
script 1649
sed 1650
seedres 1657
sendnto 1658
/etc/services 1660
setconf 1661
setkey 1663
setupbsp 1669
sftp 1671
sftp-server 1672
sh 1673
shelf 1674
showlicense 1676
showmem 1677
showmount 1678
show_vesa 1679
shutdown 1681
size 1683
slay 1684
sleep 1689
slinger 1690
slogger 1706
sloginfo 1710
smic 1712
snapshot 1717
snmpbulkwalk 1720
snmpd 1723
/etc/snmpd.conf 1725
snmpget 1726
snmpgetnext 1729
snmpnetstat 1731
June 22, 2010 Contents xv

snmpset 1734
snmpstatus 1737
snmptest 1739
snmptranslate 1745
snmptrap 1747
snmptrapd 1750
snmpwalk 1752
/etc/socks.conf 1755
sockstat 1758
sort 1760
spatch 1763
split 1766
spooler 1768
ssh 1770
ssh-add 1771
ssh-agent 1772
˜/.ssh/ssh_config, /etc/ssh/ssh_config 1773
ssh-keygen 1774
ssh-keyscan 1776
ssh-keysign 1777
sshd 1778
/etc/ssh/sshd_config 1779
startup-* options 1780
startup-apic 1785
startup-bios, startup-bios-32 1788
strings 1791
strip 1792
stty 1793
su 1801
sync 1803
sysctl 1804
sysinfo 1810
/etc/syslog.conf 1812
syslogd 1815
tail 1817
tar 1819
tcpdump 1823
tee 1854
telnet 1856
telnetd 1866
textto 1870
xvi Contents June 22, 2010

tftp 1871
tftpd 1874
tic 1876
time 1878
tinit 1880
top 1882
touch 1883
tr 1886
tracelogger 1889
traceprinter 1893
traceroute 1898
traceroute6 1903
true 1905
tsort 1906
tty 1907
uesh 1908
umask 1913
umount 1916
uname 1917
unexpand 1919
unifdef 1921
uniq 1922
unlink 1924
unzip 1925
uptime 1929
usb 1930
use 1932
usemsg 1935
uud 1939
uudecode 1940
uue 1941
uuencode 1942
vi 1943
view 1944
/etc/view.conf 1945
waitfor 1946
wc 1947
which 1948
who 1950
wpa_cli 1951
wpa_passphrase 1955
June 22, 2010 Contents xvii

wpa_supplicant 1956
xargs 1961
zap 1964
zcat 1966
zip 1967
A Commonly Used Environment Variables 1973

A 1975
B 1975
C 1976
D 1976
E 1977
F 1977
G 1977
H 1977
I 1978
J 1979
L 1979
M 1980
N 1981
O 1981
P 1981
Q 1984
R 1984
S 1985
T 1987
U 1987
B Selecting the Target System 1989

Target selection 1991
Architecture selection 1992
Linker emulation selection 1993
C What’s New in this Reference? 1995

What’s new in the QNX Software Development Platform 6.5.0? 1997
New entries 1997
Deprecated content 1999
Changed content 1999
Errata 2009
New entries 2010
xviii Contents June 22, 2010


Errata 2018
New entries 2019
Errata 2032
What’s new in QNX Momentics 6.3.2? 2033
New entries 2033
Errata 2035
What’s new in the QNX Neutrino Core OS 6.3.2? 2035
New entries 2035
Errata 2036
What’s new in QNX Momentics 6.3.0 Service Pack 2? 2036
New entries 2036
Errata 2037
New entries 2038
New entries 2039
Deleted entries 2042
Errata 2043
New entries 2044
Deleted entries 2044
Errata 2045
Glossary 2047
Index 2067
June 22, 2010 Contents xix

About This Reference
June 22, 2010 About This Reference xxi

© 2010, QNX Software Systems GmbH & Co. KG. Typographical conventions
The Utilities Reference describes the utilities, manager processes, and configuration
files included with the QNX Neutrino operating system. This reference is intended for
everyone from end-users to system administrators.
For information about: See:

An overview of the syntax for utilities Utility Conventions
Environment variables Commonly Used Environment Variables
Targets for GNU utilities Selecting the Target System
A summary of changes to this reference What’s New in this Reference?
Terms used in QNX documentation Glossary
Your system might not include all of the things that this reference describes,
depending on what software you’ve installed. For example, some utilities are included
in the QNX Momentics Tool Suite, and others are included in a specific Board Support
Package (BSP).
For information about licensing, see:
• the QNX Development Suite License Guide at

http://licensing.qnx.com/license-guide/
• the Third Party License Terms List at

http://licensing.qnx.com/third-party-terms/
• the matrix of all the versions of all our legal documents at

http://licensing.qnx.com/document-archive/
Typographical conventions
Throughout this manual, we use certain typographical conventions to distinguish
technical terms. In general, the conventions we use conform to those found in IEEE
POSIX publications. The following table summarizes our conventions:
Reference Example
Code examples if( stream == NULL )
Command options -lR
Commands make
Environment variables PATH
continued. . .
June 22, 2010 About This Reference xxiii

Technical support © 2010, QNX Software Systems GmbH & Co. KG.
Reference Example
File and pathnames /dev/null
Function names exit()
Keyboard chords Ctrl-Alt-Delete
Keyboard input something you type
Keyboard keys Enter
Program output login:
Programming constants NULL
Programming data types unsigned short
Programming literals 0xFF, "message string"
Variable names stdin
User-interface components Cancel
We use an arrow (→) in directions for accessing menu items, like this:
You’ll find the Other... menu item under Perspective→Show View.
We use notes, cautions, and warnings to highlight important messages:
Notes point out something important or useful.
CAUTION: Cautions tell you about commands or procedures that may have
! unwanted or undesirable side effects.
WARNING: Warnings tell you about commands or procedures that could be

dangerous to your files, your hardware, or even yourself.
Note to Windows users

In our documentation, we use a forward slash (/) as a delimiter in all pathnames,
including those pointing to Windows files.
We also generally follow POSIX/UNIX filesystem conventions.
Technical support
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.
xxiv About This Reference June 22, 2010

Utility Conventions
June 22, 2010 Utility Conventions 1

© 2010, QNX Software Systems GmbH & Co. KG. Syntax conventions
Syntax conventions
Most QNX utilities follow standard conventions for argument syntax and behavior.
These conventions are based on the utility conventions outlined in POSIX
1003.2-1992.
The syntax synopsis for each utility appears at the top of the page of its manual entry.
The utility name appears first, followed by other allowed command-line arguments,
which include options, option arguments (e.g. “number” in -n number), and operands
(e.g. the names of files to act on).
The syntax synopsis is the only reliable source for information about mutual
exclusivity of options and about whether a command-line element is optional or
required. This information isn’t usually contained in the detailed option listings that
appear after the syntax section.
A typical utility syntax line looks like this:
utilityname [-abcd] [-o arg | -p arg] infile... outfile
The example above shows a utility called utilityname that accepts the options -a,
-b, -c, and -d — these options may be used alone or in any combination.
The utility also accepts the options -o and -p, both of which require an option
argument, and which may not be used together (but may be used with the other options
-abcd). The utility requires two or more operands: one or more infile and exactly one
outfile.
Interpreting utility syntax

Here are the main principles at work:
• When utilities have many options, the options may appear grouped together in the
syntax like this:
utilname [-abcd]
which means that the options -a, -b, -c, and -d are supported.
• Options, option arguments, and operands enclosed in brackets ([ and ]) are
optional and can be omitted. Note that the [ and ] symbols should never be
included in the actual command.
• Arguments separated by | are mutually exclusive. Sometimes mutually exclusive
arguments that relate to modes of operation are indicated with multiple syntax lines
representing the different forms of the command.
• A trailing ellipsis mark (...) after options or operands indicates that the preceding
item may be repeated. If the preceding item is optional, the ellipsis indicates that
the item may occur zero or more times, e.g.:
utility [filename...]
If the item is mandatory, the ellipsis indicates it may occur one or more times, e.g.:

Syntax conventions © 2010, QNX Software Systems GmbH & Co. KG.
utility filename...
Invoking utilities
There are a number of general guidelines to follow when running utilities:
• An option may be followed by another option after a single dash (-) on the
command line as long as each preceding option doesn’t have an option argument.
For example, the option string -abc is equivalent to -a -b -c. However, if -a
accepts an option argument, then -abc would be equivalent to -a bc instead.
• Options and their option arguments should be specified with spacing as shown in
their documentation. If the documentation says:
-n number
the number should be a separate command-line argument from the -n. But if the
documentation refers to:
-nnumber
then number should appear in the same argument as -n without any intervening
blanks. Utilities in QNX and in POSIX-conforming systems permit both forms in
all utilities unless otherwise stated, but you’ll achieve the greatest portability by
using the preferred form. This is particularly important when developing scripts
that may be used on multiple (QNX and non-QNX) platforms.
• Options are usually listed in alphabetical order, but there’s no restriction on the
order that they may appear in the command line when used, unless otherwise
indicated in the documentation for the utility. Note that in some utilities, mutually
exclusive options override each other in a “last one wins” manner.
• All options and associated option arguments must precede any operands on the
command line. For example, if you want to run the cp utility with the -R option,
you may enter:
cp -R dir1 dir2
but not:
cp dir1 dir2 -R
• Decimal integers are accepted when numeric values are required in operands and
option arguments, unless otherwise specified. Some utilities may support 0octal
and 0xhex numbers as well without being documented as doing so. For this reason,
don’t precede decimal numbers with leading zeros.
• Integer numerical operands and option arguments must be in the range 0 to

2147483647 unless otherwise specified. If negative numbers are accepted, the
acceptable range is -2147483647 to 2147483647.
4 Utility Conventions June 22, 2010

© 2010, QNX Software Systems GmbH & Co. KG. File conventions
• The argument -- (“dash dash”) may be placed on the command line as a delimiter
indicating the end of options and the start of operands. This is particularly useful
when the operands themselves might start with a dash. For example, to remove a
file named “-t”, you would use:
rm -- -t
Utilities that don’t accept any options also accept and discard a -- before their
operands, unless otherwise indicated.
• Most utilities that accept filenames as operands (and sometimes as option

arguments) accept the filename “-” to mean standard input, or, when unambiguous
from its context, standard output.
File conventions
File pathnames specified on the command line are restricted to 255 characters. Some
input files are specifically identified as “text files.” Text files are expected to contain
ASCII text in newline-terminated lines that don’t exceed 2048 characters, unless
otherwise indicated.
Signal conventions
Signal actions are inherited from the process that invokes the utility. Most utilities
don’t do any special processing upon receipt of a signal, but behave instead according
to the system defaults. When a utility performs some action on receipt of a signal
other than the default, it’s documented as doing so.
Note that temporary files aren’t left in place after a utility is terminated due to a signal,
unless otherwise specified.
Servers and resident processes typically run only as root and ignore most signals
(such as SIGPWR).
Exit status conventions

Utilities normally return zero for successful completion and values greater than zero
when unsuccessful. Some utilities return different nonzero numbers according to the
reason they failed. Beware of testing for a specific nonzero number to indicate failure.
(In most cases utilities that may return different nonzero numbers are explicitly
documented as doing so. However, you should not rely on this.)
For some utilities, the exit status may reflect only the success or failure of the last
action taken (of many). In these cases, this behavior is explicitly documented in the
“Exit status” section.
In the ksh, you can use $? to get the exit status of the last command. For more
information, see “Parameters” in the documentation for ksh.

Error conventions © 2010, QNX Software Systems GmbH & Co. KG.
Error conventions
Utilities may fail for many reasons ranging from incorrect usage to underlying system
failure. The documentation for the utilities doesn’t attempt to outline the exact
behavior for all possible modes of failure.
In all cases, unless otherwise specified, every error results in a diagnostic message
printed to standard error.
When an error occurs, the utility stops the processing of the current operand and
proceeds to process the next operand in the sequence. If a utility fails to process one
operand but succeeds on others, the exit status still reflects failure. For utilities that
recurse through a filesystem (e.g. find), if an action cannot be performed on one file
within a hierarchy, the utility stops processing that file and goes on to the subsequent
files in the hierarchy.
When an unrecoverable error occurs (e.g. insufficient memory), the utility prints a
diagnostic message to standard error and exits immediately.
6 Utility Conventions June 22, 2010

Utilities
June 22, 2010 Utilities 7

The utilities and configuration files are described here in alphabetical order.

/etc/acl.conf © 2010, QNX Software Systems GmbH & Co. KG.
Specify permitted operations on a defined SNMP context
Name:
/etc/acl.conf
Description:
The acl.conf file is used to specify what context is available to an agent and
manager. This definition includes what operations are permitted on this collection of
data objects.
Here’s the search order that’s used to find this file:
1 /nodecfg/node_name/etc/acl.conf, where node_name is the value of the

CS_NODENAME configuration string (see getconf and setconf)
2 /etc/acl.conf
The file is in the format:

targetParty sourceParty context privileges
where:
targetParty Party that a request is sent to (agent).

sourceParty Party sending the request (manager).
context Collection of objects that the sourceParty can view.
privileges Actions that the source party is allowed to perform.
The privileges that you can specify are:
B GetBulk
G Get
I Inform
N GetNext
R Response
S Set
U SNMPv2-Trap
For example:
agent_party manager_party agent_context G
The agent acting as agent_party allows the manager acting as manager_party to do
GET operations on the collection of data objects included in the agent_context.
10 Utilities June 22, 2010

© 2010, QNX Software Systems GmbH & Co. KG. /etc/acl.conf
See also:
snmpget, snmptest, snmptrapd, snmpwalk
Based on ISO IS 8824 (ASN.1), RFC 1065, RFC 1066, RFC 1067, RFC 1446

addr2line © 2010, QNX Software Systems GmbH & Co. KG.
Convert addresses into line number/file name pairs (GNU)
Syntax:
addr2line_variant [options] [addr ...]
Runs on:
QNX Neutrino, Linux, Microsoft Windows
Options:
The addr2line_variant depends on the target platform, as follows:
Target platform: addr2line_variant:

ARM ntoarm-addr2line
MIPS ntomips-addr2line
PowerPC ntoppc-addr2line
SH4 ntosh-addr2line
x86 ntox86-addr2line
Description:
The addr2line utility translates program addresses into file names and line numbers.
Given an address and an executable, it uses the debugging information in the
executable to figure out which file name and line number are associated with a given
address.
For detailed documentation, see the GNU website at http://www.gnu.org/.
Contributing author:
GNU

© 2010, QNX Software Systems GmbH & Co. KG. addvariant
Add a new OS, CPU, or VARIANT directory structure to a source tree
Syntax:
addvariant [-c] [-i init_lvls] [-P] [[os_name]
cpu_name] variant_name
Runs on:
Options:
-c Add the created directory structure to the CVS repository on the
next cvs commit.
-i init_lvls Create the initial common.mk and Makefile files in the current
working directory. The Makefile contains a line defining the
level(s) contained in the directory structure. Specify init_lvls as OS,
OS/CPU, or OS/CPU/VARIANT (use a slash (/) or a dash (-) to
separate multiple levels).
-P Create initial directories for a PhAB application.
os_name The name of the operating system to add (e.g. qnx4, nto, linux).
cpu_name The name of the CPU to add (e.g. mips, ppc, x86).
variant_name The name of the variant to add (e.g. o, a.be)
Description:
The addvariant utility is a shell script that creates a directory structure for your
source tree. It also ensures that each level of this structure contains necessary files
used by the make utility.
Using addvariant to create your variant directory structure enables you to take
advantage of the makefile rules of the QNX build environment. For more information
on these rules, see the Conventions for Recursive Makefiles and Directories appendix
of the Neutrino Programmer’s Guide.
The project level includes a file called common.mk. This file contains any “special”
flags and settings needed for compilation and linking.
Each level in the directory structure needs a properly constructed Makefile with
appropriate macros and include files. At most levels, Makefile includes
recurse.mk, the file used by higher-level makefiles to recurse into lower-levels. The
Makefile at the lowest level of the directory tree (the variant level) includes the
common.mk file from the project level instead of recurse.mk.
If requested, addvariant also adds the directories and files it has created to CVS,
ready for your next cvs commit.

addvariant © 2010, QNX Software Systems GmbH & Co. KG.
Dealing with GNU projects

The utility begins by checking to see the projects conform to a GNU-type structure. If
the current working directory (CWD) contains files named configure and
Makefile.in, addvariant assumes that the project is configured in the GNU style.
In that case, it automatically squashes the directory levels (as described below) into a
single OS-CPU-VARIANT level and creates GNUmakefile files in the newly created
directories along with a recursing Makefile to take advantage of them.
After you’ve run addvariant, create an executable shell script called build-hooks
file in the root of the project. This script defines some shell functions that make
invokes to build your project properly; for more information, see “GNU configure”
in the Conventions for Recursive Makefiles and Directories appendix of the Neutrino
Programmer’s Guide.
Creating the initial files

The addvariant utility either creates and installs standard Makefile and
common.mk files in the CWD, or, if these files already exist, edits them to add the
same standard script lines used for recursing.
Creating the subdirectories and files

Starting from the CWD, the addvariant utility searches down into the directory tree
looking in each Makefile for a line starting with LIST. This line indicates the
particular directory level the Makefile is placed in, like this:
• LIST=OS (if three levels are specified)
• LIST=CPU (if two levels are specified)
• LIST=VARIANT (if one level is specified)
The utility then decides whether to create a subdirectory by looking at the:
• LIST macro
• *_name options
• current subdirectories
If needed, addvariant then creates an appropriately named subdirectory containing

a suitable Makefile.
This process continues down into the directory structure until all the required
directories have been created and populated with the necessary recursing Makefile.
Squashing levels
The addvariant utility has the ability to “squash” directory levels together. If you
enter the command:
addvariant -i OS/CPU/VARIANT nto x86 o

© 2010, QNX Software Systems GmbH & Co. KG. addvariant
addvariant creates a recursing Makefile in the CWD structure that has a line like
this:
LIST=OS CPU VARIANT
and then creates a single subdirectory called nto-x86-o.

Any subsequent invocation of addvariant in the tree notices this squashing of the
directory levels and automatically generates the appropriate directory structure.
Examples:
Create a two-level directory called nto-x86/o:
addvariant -i OS/CPU nto x86 o
Create the opposite two-level scheme, nto/x86-o:
addvariant -i OS nto x86/o
For detailed examples, see “Examples of creating Makefiles” in the Conventions for
Recursive Makefiles and Directories appendix of the Neutrino Programmer’s Guide.
See also:
make
Conventions for Recursive Makefiles and Directories appendix of the QNX Neutrino
Programmer’s Guide
Andrew Oram and Steve Talbott, Managing Projects with make, O’Reilly and
Associates, 1991

appbuilder © 2010, QNX Software Systems GmbH & Co. KG.
Photon Application Builder (PhAB)
Syntax:
appbuilder [options]
Runs on:
QNX Neutrino, Microsoft Windows
Options:
-h height[%] The height of the window, in pixels, or as a percentage of the
screen height if % is specified.
-l filepath (“el”) Look in filepath for the library callbacks file. Make the
callbacks found in this file available to all applications loaded
later.
The format for the library callbacks file is as follows:
l=library_name
L=path
f=function1
f=function2
l=another_library_name
f=function3
f=function4
f=function5
Lines beginning with l= specify the library in which to find the
following functions; if no library specification is given, the
function specifications are ignored. The L=path specification
line is optional, it tells the linker where to look for the library
callbacks; if you don’t specify this path, the linker will use its
default path.
In addition to functions in the library callbacks file, the linker
looks in the application directory (the directory containing
abapp.dfn) for libcalls.def. Callbacks found in
libcalls.def will be available only while the application is
loaded.
-n Don’t lock the application’s files. If someone already has an
application open, PhAB won’t open it unless you started PhAB
with the -n option.
If you’re using NFS or SMB, you should start PhAB with the -n
option because you can’t lock files with either.
-Si|m|n The initial state of the main window (iconified, maximized, or
normal).
-s server_name The name of the Photon server:

© 2010, QNX Software Systems GmbH & Co. KG. appbuilder
If server_name is: This server is used:

node_path node_path/dev/photon
fullpath fullpath
relative_path /dev/relative_path
-w width[%] The width of the window, in pixels, or as a percentage of the

screen width if % is specified.
-x position[%][r] The x coordinate of the upper-left corner of the window, in

pixels, or as a percentage of screen width if % is specified. If r is
specified, the coordinate is relative to the current console.
-y position[%][r] The y coordinate of the upper-left corner of the window, in

pixels, or as a percentage of screen height if % is specified. If r
is specified, the coordinate is relative to the current console.
Description:
The appbuilder utility starts the Photon Application Builder (PhAB). For
information about using PhAB to develop Photon applications, see the Photon

applypatch © 2010, QNX Software Systems GmbH & Co. KG.
Install or uninstall a patch (QNX Neutrino)
Since this utility modifies the installation tree, you must run it as a privileged user. It
also requires the environment be properly set. On Linux, if you use sudo (as would be
the case on Ubuntu), you must also specify the -E option to preserve the environment.
In this case, however, the PATH environment variable is set to a safe one for security
reasons, so you need to specify the full path to the utility:
sudo -E $QNX_HOST/usr/bin/applypatch patchfile
Syntax:
Install a patch:
applypatch [-b] [-c] [-d path] [-F] [-H] [-v] patch_file
List the installed patches:

applypatch -l
Uninstall a patch:
applypatch -U num
Runs on:
Options:
-b Don’t make a backup.
CAUTION: If you specify the -b option, you won’t be able to uninstall this patch or
! any patches applied after it. We don’t recommend this option for general use.
-c Extract the patch contents only. No metadata will be recorded, nor will
any backup file be generated. This is useful when pulling out individual
files for testing, but we don’t recommend this option for general use.
-d path Specify the destination path. This path will be the root directory used for
extracting the patch contents as well as for storing the patch metadata.
The default is the currently active QNX SDP installation.
-F Turn off prompting by forcing a “yes” answer to all queries. Normally
newer files aren’t overwritten by older files from the patch. This option
disables that check. This means locally updated files may be silently
replaced by an older version from the patch.
-H (QNX Neutrino 6.5.0 and later) Install all host-side files in the patch. By
default, applypatch installs only those for the current host OS.
The version of applypatch in 6.4.1 installs host-side files for all host OSs.

© 2010, QNX Software Systems GmbH & Co. KG. applypatch
-l List the patches, ordered from newest to oldest (based on installation

time).
-v Be verbose. Display some information on progress and activities.
-U num Uninstall the patch with the specified ID number, num.
CAUTION: Due to the nature of the patching process, any patch that was installed
! after patch ID num will be uninstalled as well. In effect, you’ll roll back to the state the
system was in just before patch ID num and all subsequent patches were applied.
Description:
The applypatch utility installs and uninstalls QNX patches, and also lists the
installed patches. It’s installed in $QNX_HOST/usr/bin and supports our current
patch tar files.
On Windows, run applypatch in cmd.exe.
This utility first backs up any files which will be overwritten and then extracts the
patch files.
If you’ve applied a sequence of patches, you can uninstall them only in reverse order.
If you select a patch (Patch ID X) for uninstallation, then any patches installed since
Patch ID X are also marked for uninstallation. A warning and list of affected patches is
printed and confirmation requested for this situation.
See also:
tar

aps © 2010, QNX Software Systems GmbH & Co. KG.
Manage adaptive scheduler partitions
Syntax:
aps show [-d delay] [-f shorthand] [-l] [-v...]
[partition_name ...]
aps create -b budget [-B critical_budget] partition_name
aps modify [-b budget] [-B critical_budget] partition_name
aps modify [-y bankruptcy_policy ...] [-S scheduling_policy...]

[-s security_policy ...] [-w windowsize_ms]
Runs on:
Neutrino
Options:
-B milliseconds Specify the critical CPU budget, in milliseconds. The default is 0.
-b budget Specify the CPU budget as a percentage.
-d delay The delay period, in tenths of a second, when using the -l option.
The default is 50.
-f shorthand Display the information specified by shorthand:

• all — all the below
• overall_stats — information about the last bankruptcy
• scheduler — parameters for the thread scheduler, including
the current security setting, bankruptcy policy, and the size of
the averaging window
• partitions — information about the partitions, including
their names, IDs, parent IDs, budgets, critical budgets, and the
process and thread IDs of the last thread to go bankrupt
• usage — the amount of budget and critical budget that each
partition is currently using
The default is usage.
-l (“el”) Loop mode; display the information at the interval specified

by the -d option.
-S scheduling_policy . . .
Specify the policies for the adaptive partitioning scheduler. Each
scheduling_policy must be one of:
• normal
• freetime_by_ratio

© 2010, QNX Software Systems GmbH & Co. KG. aps
• bmp_safety
The default is normal. For more information about the policies,
see “Scheduling policies” in the entry for SchedCtl() in the
Neutrino Library Reference.
-s security_policy . . .
Specify the security policies to add to the system. Each
security_policy must be one of:
• root0_overall
• root_makes_partitions
• sys_makes_partitions
• parent_modifies
• nonzero_budgets
• root_makes_critical
• sys_makes_critical
• root_joins
• sys_joins
• parent_joins
• join_self_only
• partitions_locked
• recommended
• flexible
• basic
• none
The default is none. For more information about the policies, see
the description of SCHED_APS_ADD_SECURITY in the entry for
SchedCtl() in the Neutrino Library Reference.
Once you’ve added a security policy, you can’t remove it, except by rebooting the
system.
-v... Be verbose; display more information with the show command:

• -v — display the budget usage over the last averaging
window, window 2 (typically 10 times the length of the
averaging window), and window 3 (typically 100 times the
length of the averaging window)
• -vv — display the budget usage and critical budget usage over
the last averaging window, window 2, and window 3

aps © 2010, QNX Software Systems GmbH & Co. KG.
-w windowsize_ms
Set the size of the averaging window, in milliseconds, for the
system. You can set the window size to any value from 8 ms to
400 ms.
If you change the tick size of the system at runtime, do so before defining the adaptive
partitioning scheduler’s window size. That’s because Neutrino converts the window
size from milliseconds to clock ticks for internal use.
For more information, see “Choosing the window size” in the
System Considerations chapter of the Adaptive Partitioning
User’s Guide.
-y bankruptcy_policy . . .
Set the bankruptcy policy for the system to the specified items.
Each bankruptcy_policy must be one of:
• cancel_budget — set the offending partition’s critical
budget to zero, which forces the partition to be scheduled by
its percentage CPU budget only. This also means that a second
bankruptcy can’t occur.
• log — not currently implemented.
• reboot — cause the system to crash with a brief message
identifying the offending partition. This is the most severe
response, suggested for use while testing a product, to make
sure bankruptcies are never ignored. You probably shouldn’t
use this option in your finished product.
• basic — deliver bankruptcy-notification events and make the
partition out-of-budget for the rest of the scheduling window
(nominally 100 ms).
• recommended — the combination of cancel_budget and
log.
• none — do nothing.
The default is basic. For more information about the policies,
see “Handling bankruptcy” in the entry for SchedCtl() in the
Description:
Use the aps command to create, modify, and query adaptive partitions from the
command line, as well as to set the averaging window, and the security and bankruptcy
policies for the entire system.

© 2010, QNX Software Systems GmbH & Co. KG. aps
You can’t include slashes (/) in a partition name.
To launch an application into a partition, use the -Xaps option to the on command.
Examples:
Create a partition called Drivers with a budget of 20% and a critical budget of 5
milliseconds:
aps create -b 20 -B 5 Drivers
Change the Drivers partition’s budget to 25% and its critical budget to 7
milliseconds:
aps modify -b 25 -B 7 Drivers
Specify a bankruptcy policy of recommended and a security policy of

root_makes_partitions for the entire system:
aps modify -y recommended -s root_makes_partitions
Display the amount of the budget and critical budget that the partitions are using,
every 2 seconds:
aps show -l -d 20 -f usage
Since usage is the default shorthand for the -f option, the above command is the
same as:
aps show -l -d 20
See also:
on, pidin
SchedCtl() in the Neutrino Library Reference
Adaptive Partitioning User’s Guide

ar © 2010, QNX Software Systems GmbH & Co. KG.
Create and maintain library archives (POSIX)
Syntax:
ar_variant -key_letter[mod [relpos]] archive [member...]
ar_variant -M [ <mri-script ]
Runs on:
Options:
The ar_variant depends on the target platform, as follows:
Target platform: ar_variant:

ARM ntoarm-ar
MIPS ntomips-ar
PowerPC ntoppc-ar
SH4 ntosh-ar
x86 ntox86-ar
Description:
The ar program creates and modifies archives, and extracts members from them. An
archive is a single file holding a collection of other files in a structure that makes it
possible to retrieve the original individual files (called members of the archive).
The original files’ contents, mode (permissions), timestamp, owner, and group are
preserved in the archive; you can restore them on extraction. The ar utility can
maintain archives whose members have names of any length.
GNU
See also:
nm

© 2010, QNX Software Systems GmbH & Co. KG. arp
Address Resolution Protocol (ARP) display and control
Syntax:
arp [-n] hostname
arp [-nv] -a
arp [-v] -d -a
arp [-v] -d hostname [pro [iface_name]]
arp -s hostname ether_addr [temp] [pub [pro [iface_name]]]
arp -f filename
Runs on:
Neutrino
Options:
-a Display all of the current ARP entries.
-d hostname Delete an entry for the specified host. Only the superuser can use
this option.
-f filename Load the ARP cache with entries found in the specified file. Entries
in the file should be of the form:
hostname ether_addr [pub] [temp]

with argument meanings as given for the -s option.
-n Don’t try to resolve hostnames.
-s hostname ether_addr [temp] [pub [pro [iface_name]]]

Create an ARP entry for the host hostname with the Ethernet
address ether_addr. The Ethernet address is given as six hex bytes
separated by colons.
If pub is given, the entry is “published.” That is, this system acts as
an ARP server, responding to requests for hostname, even though
the IP address that’s mapped to hostname isn’t the address of this
system.
The entry is permanent unless the word temp is given in the
command.
Specify the pro string to create or delete a proxy-only ARP entry.
The iface_name argument is the name of the interface (e.g. fxp0).
-v Be verbose.
hostname A host name or the IP address.

arp © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The arp utility displays and modifies the Internet-to-Ethernet address translation
tables used by the Address Resolution Protocol (ARP).
With no options, the utility displays the current ARP entry for hostname. The host
may be specified by name or by number, using Internet dot notation.
License:
This utility is based on copyright software of The Regents of the University of
California; for licensing information, see the Third Party License Terms List at
http://licensing.qnx.com/third-party-terms/.
See also:
ifconfig, io-pkt*

© 2010, QNX Software Systems GmbH & Co. KG. /etc/autoconnect
Automatic TCP/IP connection-configuration script
Name:
/etc/autoconnect
Description:
The /etc/autoconnect script is run when an application needs to establish a
TCP/IP connection to a remote host. This file can be in any form (e.g. a shell script or
an executable), and contains all of the necessary commands required to create the
connection.
To activate the script, define the environment variable AUTOCONNECT and set its
value to 1.
If there’s no route to a remote host (see route, ifconfig, netmanager, phlip or
the options to io-pkt*), or there are no nameservers defined (see
/etc/nsswitch.conf) and a hostname can’t be resolved, the autoconnect script is
run. The exit status of the script determines whether or not a retry is attempted:
Zero The socket library attempts the action again.

Nonzero It doesn’t retry because the script failed.
One time you might use this feature is when you have a dialup ISP account for internet
access. The ppp link is established only when an application needs to reach a host over
the link. When the link is terminated depends on inactivity timeouts specified by the
client or server, errors, or other events. The autoconnect script only launches
commands to establish a connection; it doesn’t terminate the connection.
Suppose that a host is configured with only the localhost interface, and no
nameservers. You need to create a script:
pppd connect "/bin/chat -v -f /etc/chat" defaultroute \
+resconf 115200 updetach /dev/ser2
exit
The chat utility is used to dial the service provider. The important option here is the
updetach option. This option daemonizes pppd after the PPP interface has been
configured. This way, the script doesn’t exit until the interface is configured. If an
application attempts to resolve a hostname, the application blocks while a connection
to an ISP is established, which provides a nameserver and a default route. When the
script exits with a status of zero, the socket library retries and the application
continues, assuming that the function succeeded. If an exit status of non-zero is
returned, the socket library returns the original error to the application.
If you’re using the Photon dialer to establish your connection, the script would look
like this:
phdialer -a
exit

/etc/autoconnect © 2010, QNX Software Systems GmbH & Co. KG.
The -a option causes phdialer to autoconnect and daemonize itself when the
interface is configured.
See also:
ifconfig, io-pkt*, netmanager, /etc/nsswitch.conf, phdialer, phlip,
pppd, route

© 2010, QNX Software Systems GmbH & Co. KG. basename
Return the nondirectory portion of pathname (POSIX)
Syntax:
basename string [suffix]
Runs on:
Neutrino
Options:
string A string of text.
suffix A string of text.
Description:
The basename utility is useful primarily for extracting the filename portion of a
pathname, but since it performs only string operations, you can use it with any string.
The basename utility prints to standard output a substring of its string argument, plus
a newline character. The basename utility forms this substring by doing the
following, in order:
1 Discarding any trailing slash (/) characters.
2 Discarding all characters up to and including the last slash character.
3 Deleting the string argument’s suffix, provided you’ve specified a suffix operand
that’s identical to the string operand’s suffix.
If suffix is equal to the remaining string, the suffix isn’t removed (e.g. if suffix is
prog.c and the remaining string is prog.c, the suffix .c isn’t removed).
The result is a null string only if string is a null string (""). In this case, basename
outputs a single newline character.
If string consists entirely of slash characters, basename prints a single slash, followed
by a newline character.
You’ll use the basename utility most often within shell scripts, where it’s normally
invoked inside back-ticks (‘...‘), or contained in $(...).
Examples:
Command: Output:
basename . .
basename /usr/src/prog.c prog.c
continued. . .

basename © 2010, QNX Software Systems GmbH & Co. KG.
Command: Output:
basename /usr/src/prog.c .c prog
basename /usr/src/prog.c .a prog.c
basename /usr/src/ src
basename ...//[fred] [fred]
Exit status:
0 Successful completion.
>0 An error occurred.
See also:
dirname, fullpath

© 2010, QNX Software Systems GmbH & Co. KG. bc
“Bench calculator” arbitrary-precision arithmetic language (POSIX)
Syntax:
bc [-l] [file...]
Runs on:
Neutrino
Options:
-l (“el”) Include a library of defined math functions and set the scale to 20. (See
“Library functions,” below.)
file The pathname of a text file containing commands and function definitions to
be interpreted by bc. If any files are specified, bc processes those files, then
reads from the standard input.
Description:
The bc utility is an interactive, programmable calculator that supports a complete set
of control structures, including functions.
The bc utility supports 26 functions, 26 simple variables, and 26 array variables. Each
array may have up to 2048 elements. In addition, the utility performs arithmetic
operations using a radix 100 number system with user-definable precision. When you
specify the precision, the numbers are exact to that precision, unlike binary
floating-point representation where rounding errors may compromise accuracy. The
utility also operates in different bases, so you can easily convert numbers from one
base to another.
Many common programming language constructs are supported, including:
• if, while, and for statements
• user-defined functions with parameters
• local variables.
The bc utility provides no support for character or string manipulation. The syntax of
bc is derived from C, but doesn’t constitute a programming language.
Let’s look at a very simple bc program:
"hello, world\n"
When this program is run, the statement "hello, world" is echoed with a newline
character. In general, the result of any expression that isn’t assigned to a variable or
used in a control structure is echoed. For example, the following statement:
5ˆ2

bc © 2010, QNX Software Systems GmbH & Co. KG.
causes bc to respond with 25.

Note that the caret (ˆ) is an integer exponentiation operator: aˆb is a raised to the bth
power, where b is truncated to an integer in the range -2ˆ31 to +2ˆ31. All of the “usual”
arithmetic operators (+, -,*,/,%) are available, but % is the remainder, not the modulus.
Bases
Two special builtin variables let you choose the base in which numbers are input and
output:
ibase Input base.
obase Output base.
When numbers are recognized, the input base determines the significance of each
digit. For example, the value 66 in base 10 is:
6 × 10ˆ0 = 6
+ 6 × 10ˆ1 = 60
--
66
whereas in base 8, it’s:
6 × 8ˆ0 = 6
+ 6 × 8ˆ1 = 48
--
54
Note that hex numbers are recognized in the different bases and that their values also
change with the base. For example, the number FF is valid in base 10 and has the
decimal value 165:
F(=15) × 10ˆ0 = 15
+ F(=15) × 10ˆ1 = 150
---
165
Setting the output base results in one of two numerical formats:
• For bases in the range 2 to 16, the format consists of the alphabet 0-9,A-F.
• For bases in the range 17 to 10000, the format consists of a series of decimal digits
with groups separated by spaces. In this format, each group represents a digit of
significance, thus the number 61 in obase=20 is printed as:
3 1
which should be interpreted as:
1 × 20ˆ0 = 1
+ 3 × 20ˆ1 = 60
--
61

Variables
The bc utility supports 26 simple variables, named a through z (case is significant),
and 26 arrays, also named a through z. The context determines whether the simple
variable or the array is selected. All variables are auto-initialized to 0 and are always
available (i.e. there’s no declaration statement).
Functions may create local variables (with the auto statement) that hide the global
variables of the same name while the function is executing. Arrays are limited to 2048
elements. Variables may be referenced (right-valued) or assigned to (left-valued).
Assignment operators
The assignment operator has many variations, as in the C language. For example:
a += x
means the same as:
a = a + x
All of the binary operators have a corresponding assignment operator.

An assignment expression (e.g. a=10) has a right value that’s the new value of a.
Thus:
a = b = 10
assigns 10 to b, then assigns b to a.

The increment and decrement operators may be applied only to variables. The
statement:
b = a++
is semantically the same as:
b = a; a = a + 1;
and the statement:
b = ++a
is semantically the same as:
a = a + 1; b = a;
The following table summarizes operator precedence and associativity:
Operator Associativity Class

++, – Nonassociative (increment, decrement)
continued. . .

Operator Associativity Class

- Right to left (unary minus)
ˆ Right to left (exponentiation)
*, /, % Left to right (multiplicative)
+, - Left to right (additive)
==, <=, >=, !=, <, > Left to right (comparative)
= +=, -=, *=, /=, %=, ˆ=, Right to left (assignment)
The if statement
The if statement takes the following form:
if (expr) statement
The statement is executed only if expr evaluates to a nonzero quantity. Regardless of
the value of expr, the next statement is executed.
if (i > 2047) {
"i exceeds array limit"
i = 2047; /* limit index */
}
a[i] /* always print value */
Iteration statements
The bc utility supports two iteration statements: while and for. In both of these
structures, break means “exit the loop immediately,” and continue means “pretend
you have finished executing statement.”
The while statement has the general form:
while (expr) statement

and is executed following this algorithm:
1 If expr is false, go to 4.
2 Execute statement.
3 Go to 1.
4 Proceed.
In the while statement, continue and break are analogous to “Go to 1” and “Go to
4,” respectively.
The for statement has the general form:
for (expr1;expr2;expr3) statement

and is executed following this algorithm:
1 expr1
2 If expr2 is false, go to 6.
3 Execute statement.
4 Execute expr3.
5 Go to 2.
6 Proceed.
In the for statement, continue and break are analogous to “Go to 4” and “Go to 6,”
respectively.
User-defined functions
In bc, you can define named functions that support parameters, local variables, and
recursion. A function name is a single lowercase character (a to z). A function has the
general form:
define name(parameter-list) { function-body }
You can’t remove or replace functions; it’s an error to attempt to do so. Functions can
call other functions, including themselves.
Functions can accept an arbitrary number of parameters, which may be either simple
or array variables.
Parameters are passed by value, that is, the function is given a private copy of all
parameters that remains in effect until the function returns. Notice that arrays are also
passed by value; this differs from the C calling convention.
The first statement in a function can be an auto statement, which creates “local”
variables for the function. The auto statement has this general form:
auto [variable|array]...
The local variables are used in place of the global variables of the same name until the
function returns; the local variables are also initialized to zero (see the example
below).
Functions can contain a return statement. The return statement causes the function
to exit, discarding any local variables and parameters. The statement may be in either
of two forms:
return
Or
return [retval]
where retval is a constant or a variable name. If no specific return statement is
given, or if retval is omitted, a value of 0 is returned.

The following example shows various constructs being used in functions:

/* function s(b[], n)
* return the sum of the first n elements of b[]
*/
define s(b[],n) {
auto t,i; /* note that the ’;’s are for style,
and aren’t required. */
if (n > 2048) {
"Array length out of bounds...\n"
return 0;
}
for (i=0; i < n; i++) {
t += b[i];
}
return t;
}
The function s() is introduced by the define statement, which also reveals the
parameter types. It’s important that all functions be called with the appropriate types
and number of parameters. Failure to do so results in unpredictable errors.
All parameters in bc are passed by value, including arrays. This is unlike C, where
arrays are always passed by reference.
The auto statement introduces the locally scoped variables t and i. You should use
automatic variables to prevent unwanted side effects of using global variables.
Builtin variables and functions

Several builtin control variables affect how bc operates. The following variables may
be set or queried:
Name Function Range Default

scale Minimum precision maintained in 0..100 0
calculations
ibase Radix for input 2..10000 numbers 10
obase Radix for output 2..10000 numbers 10
The bc utility provides the following builtin functions:
Function Returns
sqrt(expression) Square root of the value
continued. . .

Function Returns
length(expression) Number of significant decimal digits in the expression
scale(expression) Number of decimal digits to the right of the decimal marker
Library functions
The bc library is enabled if you invoke bc with the -l option, or if you include the
interpretation file /usr/lib/bclib.b in the command line. The library sets the
scale to 20, which you can override by assigning a new value. The library defines the
following functions:
Syntax Function
a(expression) Arctangent (in radians)
c(expression) Cosine (in radians)
e(expression) Exponential function
k(expr1,expr2) Bessel function of integer order
l(expression) Natural logarithm
s(expression) Sine (in radians)
Files:
/usr/lib/bclib.b
Contains the bc library, a set of function definitions that are loaded
automatically when the -l option is specified. This file must be present for the
-l option to work.
Exit status:
Caveats:
The bc utility’s syntax contains a few ambiguities:
• The notion of a statement in bc is either a structured statement or an expression

followed by a newline or a semicolon (;). An expression may be nil, thus a single
newline forms a statement. This can lead to unexpected behavior, as in the
following example, where the while statement never terminates:
a=0
while (a < 100)

a++
a
Although the intent is obvious, the newline at the end of the while statement
comprises the body of the loop, thus a is never incremented. The C equivalent of
this example is:
a=0;
while (a < 100);
The following are “correct” versions:
a=0
while (a < 100) a++
Or
while (++a < 100)
Or
while (a < 100) {
a++
}
• The quit statement causes bc to exit when it encounters the statement, not when it
attempts to execute it. Thus, the following causes bc to exit immediately:
if (0) {
quit
}
and is equivalent to:
quit
See also:
Brian W. Kernighan and Dennis M. Ritchie, The C Programming Language,
Prentice-Hall, 1978

© 2010, QNX Software Systems GmbH & Co. KG. bdftophf2
Convert BDF fonts to Photon fonts
Syntax:
bdftophf2 [-A offset] [-E end_character]
[-N num_chars] [-O output_file]
[-o output_path] [-S start_character]
bdf_file
Runs on:
Neutrino
Options:
-A offset Offset character encodings.
-E end_character Set ending character code.
-N num_chars The maximum number of characters to convert.
-O output_file Write the converted file to output_file. Overrides the -o option.
-o output_path Write the converted file to output_path.
-S start_character Set starting character code.
bdf_file Name of the BDF file to convert.
Description:
The bdftophf2 utility converts Binary Data Format (BDF) font files into Photon font
files. BDF is a universal standard for ASCII bitmap font representation.
Examples:
Convert all the BDF Courier font files in the /font/bdf directory to Photon font files
in the /home/fred/font directory:
bdftophf2 -o /home/fred/font /font/bdf/cour*.bdf
The Extension installation is necessary only if you want this font to be searched for
characters not found (such as Asian/Latin fonts) in other font files.
Caveats:
This utility works only with Unicode BDF files.
The glyphs within the .bdf file must be sorted in ascending order. For example,
0x0000, 0x0020,0x2e5f, 0xfffe is an example of a set of glyphs listed in ascending
order.

bindres © 2010, QNX Software Systems GmbH & Co. KG.
Bind or extract resources from a file
Syntax:
bindres [-x|-l][-q|-v] resfile|loadfile [widgetfile...]
Runs on:
Options:
-l List the widgetfiles in the resfile. If no widget files are specified, all the
files are listed.
-q Quiet mode, produce no output.
-v Verbose mode.
-x Extract the widgetfiles in the resfile. If no widget files are specified, all
the widget files are extracted.
resfile A widget resource file created by bindres.
loadfile The name of an executable program or shared object to bind the

resource information to.
widgetfile The name of a widget file (for example, base.wgtw).
Description:
This utility binds the widgets in one or more widgetfiles into a single resource file
resfile. It’s usually run automatically as part of the PhAB build process. If you specify
a loadfile (an executable or shared object in ELF format), bindres creates a
temporary resource file, then binds it into the application.
It is possible to run an application with a separate widget resource file. If widget
resources are not bound into an application executable, at runtime the system looks for
widgets in a file with the same name as the application, but with a .res extension.
This utility can also list or extract the widgets in widget resource (.res) files
generated by bindres.
See also:
ldrel
Generating, Compiling, and Running Code in the Photon Programmer’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. bison
General-purpose parser generator (GNU)
Syntax:
bison [options] input_file
Runs on:
Options:
For a complete listing, see the documentation at
http://www.gnu.org/software/bison/manual/.
Description:
The bison utility is a general-purpose parser generator that converts an annotated
context-free grammar into a parser for that grammar. For detailed documentation, see
http://www.gnu.org/software/bison/manual/.
This utility is subject to the GNU Public License (GPL). We’ve included it for use on
development systems.
GNU

bkgdmgr © 2010, QNX Software Systems GmbH & Co. KG.
Photon Background Manager
Syntax:
bkgdmgr
Runs on:
Neutrino
Options:
None.
Description:
The Photon Background Manager (bkgdmgr) provides advanced capabilities for
Photon’s desktop background display.
In addition to being able to draw a solid color background, bkgdmgr can blend
primary and secondary colors in a tiled 8×8 pixel pattern, or display a bitmap image
in any format that Photon supports. Bitmaps can be displayed in any of the following
modes:
Tiled to fill Repeats the image side-to-side and top-to-bottom to fill the
screen. Tile positioning can be biased to the top, bottom, left,
right (or a combination such as top-left), or centered.
Stretched to fill Stretches the image to fill the screen. You can specify that
bkgdmgr either maintain the original aspect (width:height) ratio
of the image, or ignore it if necessary to fill the screen.
Unmodified Don’t tile or stretch the image, but display only a single copy.
Positioning can be biased to the top, bottom, left, right (or a
combination such as top-left), or centered.
If you need only a solid background color, you don’t need to run bkgdmgr. The
Photon Window Manager, pwm, can draw a solid color desktop background.
The Background Manager reads options from a config file that it shares with pwm,
located in $HOME/.ph/wm/wm.cfg. If $HOME isn’t set, bkgdmgr looks for the
file in /.ph/wm/wm.cfg. Normally you don’t edit this file manually. Use the
Background tab on the pwmopts utility to set the options for bkgdmgr, which are
saved to the configuration file.
You can force bkgdmgr to reread the configuration file and reapply the settings by
rerunning it, or by sending it the signal SIGUSR1, for example, slay -sUSR1
bkgdmgr.

© 2010, QNX Software Systems GmbH & Co. KG. bkgdmgr
Files:
$HOME/.ph/wm/wm.cfg
Holds a user’s PWM workspace and configuration.
See also:
pwm, pwmopts

bootpd © 2010, QNX Software Systems GmbH & Co. KG.
Internet boot protocol server
You must be root to start this server.
Syntax:
bootpd [-dpsT] [-t timeout] [configfile]
Runs on:
Neutrino
Options:
-d Increase the level of debugging output (-dd to be more verbose).
-s Run in standalone configuration. Use this option if bootpd is not

being started by inetd (e.g. when started in a sysinit file).
-T Do not remove unknown vendor-specific information. The default is to

remove the vendor-specific section of the response packet if unknown,
or remove unknown options if the vendor is known.
-t timeout When not running standalone, this option specifies the time in minutes
that bootpd will wait for the next boot request before exiting to
conserve system resources. When the next boot request arrives, inetd
will restart bootpd. If you don’t want bootpd to exit, give timeout a
value of 0. The default timeout is 15 minutes.
configfile Specify a configuration file (the default file is /etc/bootptab).
Description:
The bootpd server implements an Internet Boot Protocol server as defined in RFC
951 and RFC 1048.
It’s normally invoked by the inetd daemon via the following line in the
/etc/inetd.conf file:
bootps dgram udp wait root /usr/sbin/bootpd bootpd
This method conserves system resources: bootpd is started only when a boot request
arrives, and if it doesn’t receive another boot request within fifteen minutes (default) of
the last one received, it exits. You can use the -t option to specify a different timeout
value in minutes (e.g. -t 20). A timeout value of zero means forever.
Rather than wait for a boot request, bootpd can be started independently of inetd.
This is probably the desired mode of operation for large network installations with
many hosts.

© 2010, QNX Software Systems GmbH & Co. KG. bootpd
When using the -s option, bootpd and inetd may compete for the same port. Make
sure to comment out the bootps entry in the /etc/inetd.conf file. In this case, the
-t option has no effect, because bootpd never exits.
Upon startup, bootpd first reads its configuration file, /etc/bootptab, and then
begins listening for BOOTREQUEST packets.
The server rereads its configuration file when it receives a hangup signal (SIGHUP) or
when it receives a bootp request packet and detects that the file has been updated.
Hosts may be added, deleted, or modified when the configuration file is reread.
Files:
/etc/bootptab Boot protocol server configuration file.
/etc/services Service name database.
The bootpd daemon requires the libsocket.so shared library.
Errors:
Reported to system log.
License:
This utility is based on software of Carnegie Mellon University; for licensing
information, see the Third Party License Terms List at
Caveats:
Individual host entries must not exceed 1024 characters.
See also:
/etc/bootptab, inetd, tftpd
TCP/IP Networking in the Neutrino User’s Guide
Based on RFC 951, RFC 1048, RFC 1084, Assigned Numbers

/etc/bootptab © 2010, QNX Software Systems GmbH & Co. KG.
Boot protocol server configuration file
Name:
/etc/bootptab
Description:
The /etc/bootptab file is used by the bootpd daemon.
The configuration file has a format similar to that of termcap, in which two-character
case-sensitive tag symbols are used to represent host parameters. These parameter
declarations are separated by colons (:). The general format is:
hostname:tg=value... :tg=value... :tg=value...

where hostname is the actual name of a bootp client and tg is a two-character tag
symbol. Most tags must be followed by an equals sign (=) and a value as above. Some
may also appear in a Boolean form with no value (e.g. :tg:). The currently
recognized tags are:
bf Bootfile.
bs Bootfile size. This can be:

• a decimal, octal, or hexadecimal integer (specifying the size of the bootfile
in 512-octet blocks)
Or
• the keyword auto, which causes the server to automatically calculate the
bootfile size at each request.
If bs is specified as a boolean, auto is assumed.
cs Cookie server address list (a whitespace-separated list of IP addresses).
ds Domain name server address list (a whitespace-separated list of IP addresses).
gw Gateway address list (a whitespace-separated list of IP addresses).
ha Host hardware address. This must be specified in hexadecimal (optional

periods and/or a leading 0x may be included for readability). The ha tag must
follow the ht tag (either explicitly or implicitly; see tc below).
hd Bootfile home directory.
hn Send hostname. This is strictly a boolean tag; it doesn’t take the usual equals
sign and value. Its presence indicates that the hostname should be sent to
RFC 1048 clients. The bootpd daemon attempts to send the entire hostname
as it’s specified in the configuration file. If the name doesn’t fit into the reply
packet, it’s shortened to just the host field (up to the first period, if present) and
then tried. The server never sends an arbitrarily truncated hostname (if nothing
reasonable fits, nothing is sent).

© 2010, QNX Software Systems GmbH & Co. KG. /etc/bootptab
ht Host hardware type (see Assigned Numbers RFC). This tag specifies the
hardware type code as either an unsigned decimal, octal, or hexadecimal
integer or as one of the following symbolic names:
• ethernet or ether for 10M Ethernet
• ieee802, tr, or token-ring for IEEE 802 networks.
im Impress server address list (a whitespace-separated list of IP addresses).
ip Host IP address (a single IP address).
lg Log server address list (a whitespace-separated list of IP addresses).
lp LPR server address list (a whitespace-separated list of IP addresses).
ns IEN-116 name server address list (a whitespace-separated list of IP addresses).
rl Resource location protocol server address list (a whitespace-separated list of

IP addresses).
sa TFTP server address the client should use (useful with multi-homed servers).
This tag takes a whitespace-separated list of IP addresses.
sm Host subnet mask (a single IP address).
tc Table continuation (points to similar “template” host entry).
td TFTP root directory used by secured TFTP server.
to Time offset. This can be:

• a signed decimal integer specifying the client’s timezone offset (in seconds
from UTC)
Or
• the keyword auto, which uses the server’s timezone offset.
If to is specified as a boolean, auto is assumed.
ts Time server address list (a whitespace-separated list of IP addresses).
vm Vendor magic cookie selector. This can be one of the following keywords:
• auto (indicating that vendor information is determined by the client’s
request)
• rfc1048 (which always forces an RFC 1048-style reply)
• cmu (which always forces a CMU-style reply).
There’s also a generic tag, Tn, where n is an RFC 1048 vendor field tag number. This
lets you take advantage of future extensions to RFC 1048 without being forced to
modify bootpd first. Generic data may be represented as either a stream of
hexadecimal numbers or as a quoted string of ASCII characters. The length of the

generic data is automatically determined and inserted into the proper field(s) of the
RFC 1048-style bootp reply.
All IP addresses are specified in standard Internet “dot” notation and may use decimal,
octal, or hexadecimal numbers (octal numbers begin with 0, hexadecimal numbers
begin with 0x or 0X).
The hostname, home directory, and bootfile are ASCII strings that may be optionally
surrounded by double quotes ("). The client’s request and the values of the hd and bf
symbols determine how the server fills in the bootfile field of the bootp reply packet.
If the client specifies an absolute pathname and that file exists on the server machine,
then that pathname is returned in the reply packet. If the file can’t be found, the
request is discarded and no reply is sent. If the client specifies a relative pathname, a
full pathname is formed by prepending the value of the hd tag and testing for existence
of the file. If the hd tag isn’t supplied in the configuration file or if the resulting boot
file can’t be found, then the request is discarded.
Clients that specify null boot files always elicit a reply from the server. The exact reply
again depends on the hd and bf tags. If the bf tag gives an absolute pathname and the
file exists, then that pathname is returned in the reply packet. If the hd and bf tags
together specify an accessible file, then that filename is returned in the reply. If a
complete filename can’t be determined or if the file doesn’t exist, then the reply
contains a zeroed-out bootfile field.
In all these cases, the file must have its public read access bit set, since this is required
by tftpd.
Many host entries often share common values for certain tags (such as name servers,
etc.). Rather than repeatedly specify these tags, you can use the tc (table
continuation) mechanism to list a full specification for one host entry that can be
shared by others. The template entry is often a dummy host that doesn’t actually exist
and never sends bootp requests. This feature is similar to the tc feature of termcap
for similar terminals.
Note that bootpd allows the tc tag symbol to appear anywhere in the host entry,
unlike termcap, which requires it to be the last tag. Information explicitly specified
for a host always overrides information implied by a tc tag symbol, regardless of its
location within the entry. The value of the tc tag may be the hostname or IP address
of any host entry previously listed in the configuration file.
Sometimes it’s necessary to delete a specific tag after it’s been inferred via tc. You
can do this by using the construction tag @, which removes the effect of the tag as in
termcap.
For example, to completely undo an IEN-116 name server specification, put the
following at an appropriate place in the configuration entry:
:ns@:
After removal with @, a tag is eligible to be set again through the tc mechanism.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/bootptab
Blank lines and lines beginning with a pound sign (#) are ignored in the configuration
file. Host entries are separated from one another by newlines; a single host entry may
be extended over multiple lines if the lines end with a backslash (\). Lines can be
longer than 80 characters.
Tags may appear in any order, with the following exceptions:
• the hostname must be the very first field in an entry
• the hardware type must precede the hardware address.
Here’s a sample /etc/bootptab file:
# Sample bootptab file
default1:\
:hd=/usr/boot:bf=null:\
:ds=128.2.35.50 128.2.13.21:\
:ns=0x80020b4d 0x80020ffd:\
:ts=0x80020b4d 0x80020ffd:\
:sm=255.255.0.0:gw=0x8002fe24:\
:hn:vm=auto:to=-18000:\
:T37=0x12345927AD3BCF:T99="Special ASCII string":
carnegie:ht=6:ha=7FF8100000AF:ip=128.2.11.1:tc=default1:
baldwin:ht=1:ha=0800200159C3:ip=128.2.11.10:tc=default1:
wylie:ht=1:ha=00DD00CADF00:ip=128.2.11.100:tc=default1:
arnold:ht=1:ha=0800200102AD:ip=128.2.11.102:tc=default1:
bairdford:ht=1:ha=08002B02A2F9:ip=128.2.11.103:tc=default1:
bakerstown:ht=1:ha=08002B0287C8:ip=128.2.11.104:tc=default1:
# Special domain name server for next host

butlerjct:ht=1:ha=08002001560D:ip=128.2.11.108:ds=128.2.13.42:tc=default1:
gastonville:ht=6:ha=7FFF81000A47:ip=128.2.11.115:tc=default1:
hahntown:ht=6:ha=7FFF81000434:ip=128.2.11.117:tc=default1:
hickman:ht=6:ha=7FFF810001BA:ip=128.2.11.118:tc=default1:
lowber:ht=1:ha=00DD00CAF000:ip=128.2.11.121:tc=default1:
mtoliver:ht=1:ha=00DD00FE1600:ip=128.2.11.122:tc=default1:
The bootpd daemon looks in /etc/services to find the port numbers it should use.
Two entries are extracted:
• bootps — the bootp server listening port
• bootpc — the destination port used to reply to clients.
If the port numbers can’t be determined this way, they’re assumed to be 67 for the
server and 68 for the client.
Caveats:
As a QNX Neutrino extension, the argument to the bf tag can start with an “or bar”
character (|). If it does, then the following is taken to be a command to spawn in order
to get a boot image:
bf=|cd /boot; mkifs build/node1:

If you use this extension, tftpd must not be started as root. One choice is to create
the user tftp and start tftpd as that user. You could also create and use the user
ftp, but that opens up your machine to anonymous ftp. For information on how to
change the user as which tftpd starts, see /etc/inetd.conf.
See also:
bootpd

© 2010, QNX Software Systems GmbH & Co. KG. brconfig
Configure network bridge parameters
Syntax:
brconfig -a
or:
brconfig bridge [command [args ...]]
Runs on:
Neutrino
Options:
-a Display the status of all bridge devices present on the system. This flag is
mutually exclusive with all other subcommands.
All other operations require that a bridge be specified. If a bridge is specified with no
subcommands, the status of that bridge is displayed. The following subcommands are
available:
up Start forwarding packets on the bridge.
down Stop forwarding packets on the bridge.
add interface Add the interface named by interface as a member of the

bridge. The interface is put into promiscuous mode so that it
can receive every packet sent on the network.
delete interface Remove the interface named by interface from the bridge.
Promiscuous mode is disabled on the interface when it’s
removed from the bridge.
maxaddr size Set the size of the bridge address cache to size. The default is
100 entries.
timeout seconds Set the timeout of address cache entries to the given number of
seconds. If seconds is zero, then address cache entries don’t
expire. The default is 1200 seconds.
deladdr address Delete address from the address cache.
flush Delete all dynamically-learned addresses from the address

cache.
flushall Delete all addresses, including static addresses, from the

address cache.

brconfig © 2010, QNX Software Systems GmbH & Co. KG.
discover interface Mark an interface as a “discovering” interface. When the bridge

has no address cache entry (either dynamic or static) for the
destination address of a packet, the bridge forwards the packet
to all member interfaces marked as “discovering.” This is the
default for all interfaces added to a bridge.
-discover interface
Clear the “discovering” attribute on a member interface. For
packets without the “discovering” attribute, the only packets
forwarded on the interface are broadcast or multicast packets
and packets for which the destination address is known to be on
the interface’s segment.
learn interface Mark an interface as a “learning” interface. When a packet

arrives on such an interface, the source address of the packet is
entered into the address cache as being a destination address on
the interface’s segment. This is the default for all interfaces
added to a bridge.
-learn interface Clear the “learning” attribute on a member interface.
stp interface Enable the IEEE 802.1D Spanning Tree Protocol (STP) on the
interface. Spanning Tree is used to detect and remove loops in a
network topology.
-stp interface Disable the Spanning Tree Protocol on the interface. This is the
default for all interfaces added to a bridge.
maxage seconds Set the time that a Spanning Tree Protocol configuration is
valid. The default is 20 seconds, the minimum 1 second, and
the maximum 255 seconds.
fwddelay seconds Set the time that must pass before an interface begins
forwarding packets when Spanning Tree is enabled. The default
is 15 seconds, the minimum 1 second, and the maximum 255
seconds.
hellotime seconds Set the time between broadcasting of Spanning Tree protocol
configuration messages. The default is 2 seconds, the minimum
1 second, and the maximum 255 seconds.
priority value Set the bridge priority for Spanning Tree. The default is 32768.
Allowed numerical values range from 0 (highest priority) to
65535 (lowest priority).
ifpriority interface value

Set the Spanning Tree priority of the interface to value. The
default is 128, the minimum 0, and the maximum 255.

© 2010, QNX Software Systems GmbH & Co. KG. brconfig
ifpathcost interface value

Set the Spanning Tree path cost of the interface to value. The
default is 55, the minimum 0, and the maximum 65535.
Description:
The brconfig utility is used to configure network bridge parameters and retrieve
network bridge parameters and status from io-pkt.
A network bridge creates a logical link between two or more IEEE 802 networks that
use the same (or “similar enough”) framing format. For example, it’s possible to
bridge Ethernet and 802.11 networks together, but it isn’t possible to bridge Ethernet
and Token Ring networks together.
To create a bridge interface, use the ifconfig command’s create subcommand.
Perform all other bridge configuration using the brconfig utility.
Examples:
The following code, when placed in the file /etc/ifconfig.bridge0, creates a
bridge called bridge0, adds the interfaces ray0 and fxp0 to the bridge, and then
enables packet forwarding. You could use such a configuration to implement a simple
802.11-to-Ethernet bridge (assuming the 802.11 interface is in ad hoc mode).
create
!brconfig $int add ray0 add fxp0 up
Consider a system with two 4-port Ethernet boards. The following code, when placed
in the file /etc/ifconfig.bridge0 causes a bridge consisting of all eight ports to
be created with Spanning Tree enabled:
create
!brconfig $int \
add tlp0 stp tlp0 \
add tlp1 stp tlp1 \
add tlp2 stp tlp2 \
add tlp3 stp tlp3 \
add tlp4 stp tlp4 \
add tlp5 stp tlp5 \
add tlp6 stp tlp6 \
add tlp7 stp tlp7 \
up
See also:
ifconfig, pf

bunzip2 © 2010, QNX Software Systems GmbH & Co. KG.
Decompress files
Syntax:
bunzip2 [options] [files...]
Runs on:
Neutrino
Options:
For a complete listing, see bzip2
Description:
This utility decompresses files that have been compressed with bzip2.
See also:
bzip2 freeze, gzip, pax, tar
Backing Up and Recovering Data in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. bz2cat
Decompress files to standard output
Syntax:
bz2cat [options] [files...]
Runs on:
Neutrino
Options:
For a complete listing, see bzip2
Description:
This utility decompresses files that have been compressed with bzip2, and sends the
output to standard output.
See also:
bzip2 freeze, gzip, pax, tar

bzip2 © 2010, QNX Software Systems GmbH & Co. KG.
Compress and decompress files
Syntax:
Compress and decompress files:
bzip2 [options] [files...]
Decompress files:
bunzip2 [options] [files...]
Decompress files to standard output:
bz2cat [options] [files...]
Runs on:
Neutrino
Options:
-1 . . . -9 Set the blocksize to 100k . . . 900k.
-c Send output to standard output.
-d Force decompression.
-f Force the utility to overwrite existing output files.
-h Display a help message.
-k Keep (i.e. don’t delete) input files.
--repetitive-best
Compress repetitive blocks better.
--repetitive-fast
Compress repetitive blocks faster.
-s (Small) use less memory (at most 2500K).
-t Test the integrity of the compressed file.
-v Verbose output; a second v makes the utility more verbose.
-z Force compression.

© 2010, QNX Software Systems GmbH & Co. KG. bzip2
Description:
This utility compresses and decompresses files:
• If invoked as bzip2, the default action is to compress.
• As bunzip2, the default action is to decompress.
• As bz2cat, the default action is to decompress to stdout.
If no file names are given, bzip2 compresses or decompresses from standard input to
standard output.
See also:
freeze, gzip, pax, tar

c++filt © 2010, QNX Software Systems GmbH & Co. KG.
Demangle C++ and Java symbols
Syntax:
c++filt [options] [symbol...]
Runs on:
Options:
See the GNU website at http://www.gnu.org/.
Description:
The C++ and Java languages provides function overloading, which means that you can
write many functions with the same name (providing each takes parameters of
different types). All C++ and Java function names are encoded into a low-level
assembly label (this process is known as mangling). The c++filt program does the
inverse mapping: it decodes (demangles) low-level names into user-level names so
that the linker can keep these overloaded functions from clashing.
GNU

© 2010, QNX Software Systems GmbH & Co. KG. calib
Calibrate a touchscreen
Syntax:
calib [options]
Runs on:
Neutrino
Options:
-a alg Specify the calibration algorithm. Valid algorithms are 3 and 4. Default
value is 3.
-b val Specify the touch point acceptance variance (range 0 - 2000). Enabling
this will force bound checking on touch points.
-c Don’t run if a configuration file already exists at

/etc/system/config/calib.$(hostname).
-d w,h The width and height of the screen to be calibrated. If you don’t specify
this option, calib attempts to get this information from the hardware.
-f file The name and location of a calibration file to create instead of the
default at /etc/system/config/calib.$hostname.
-l limit Limit the number of samples for each touch point. Default value is 15.
-o offset Offset for crosshair position, which you can use to tweak calibration.
Applicable only with 4-point calibration.
-O The Origin. Touch screen origin (0,0) is at the lower right side. Default
is upper left corner.
-p x, y The offset position of the calibration region.
-P Supress prompts (no text is displayed on screen). Prompts are on by

default.
-s server The server node or the device name.
-S Use small touch targets. Default is large.
-t timer The done button timer value. Default value is 10.
-v Verbose output.
-x x The initial x position.
-y y The initial y position.

calib © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The calib utility is used to calibrate a touchscreen. Once the touchscreen is
successfully configured (i.e. you’ve created an input.node file), it must be calibrated.
The calib utility saves a configuration file at
/etc/system/config/calib.$hostname. For information about this file format,
see the “Calibration file format” section of the “Writing an Input Device Driver”
chapter of the Input DDK documentation.
To invoke the calibration screen:
1 Start Photon.
2 Run calib.
3 Touch the bullseye target on the screen.
4 Touch the Press to Complete Calibration button to finish calibration.
Examples:
Calibrate a quarter of a standard 640x480 VGA screen (the driver will cover only part
of the screen):
calib -d 320,240

© 2010, QNX Software Systems GmbH & Co. KG. cam-cdrom.so
Provide a common access method for CD-ROMs
Syntax:
driver ... cdrom cdrom_options ... &
Runs on:
Neutrino
Options:
driver One of the devb-* drivers.
The cdrom options control the driver’s interface to cam-cdrom.so for CD-ROM
devices. If specified, they must follow the cdrom keyword:
name=prefix Specify the device prefix (default: cd);
retries=num:path_id:target:lun
Set the maximum number of command retries on the specified
path, target, and lun. The default is 10.
timeout=time:path_id:target:lun
Set the command timeout on the specified path, target, and lun.
The default for a CD-ROM is 10 seconds; for a CD changer, it’s
20 seconds.
verbose[=level] Be verbose. If you don’t specify a level, cam-cdrom.so

increments the current level by one.
Description:
The cam-cdrom.so shared object provides common access methods (CAMs) for
CD-ROM devices.
See also:
cam-disk.so, cam-optical.so, devb-*, fs-*, io-blk.so
Connecting Hardware in the Neutrino User’s Guide

cam-disk.so © 2010, QNX Software Systems GmbH & Co. KG.
Provide a common access method for hard disks
Syntax:
driver ... disk disk_options ... &
Runs on:
Neutrino
Options:
The disk options control the driver’s interface to cam-disk.so. If specified, they
must follow the disk keyword:
name=prefix[@device_number]
Specify the device prefix and optionally where to start
numbering the devices from:
• disk name=usb names the devices /dev/usb0,
/dev/usb1, and so on
• disk name=usb@2 starts at /dev/usb2, /dev/usb3, and
so on (in the absence of any existing naming conflicts)
CAUTION: Specify device numbers only on a closed system where you know all the
! devices and indexes.

The default is hd.
nobios Don’t use the geometry from BIOS int 13. By default, if you
don’t specify the translation option, the BIOS geometry is
used.
noptab Don’t use the geometry from the partition table. The geometry
from the partition table is used if you specify the nobios
option, or the BIOS geometry is invalid.
retries=num:path_id:target:lun
Set the maximum number of command retries on the specified
path, target, and lun. The default is 10.
timeout=time:path_id:target:lun
Set the command timeout on the specified path, target, and lun.
translation=heads[:sectors[:path_ID[:target[:lun]]]]
Specify the geometry explicitly; this overrides the geometry
from the BIOS and the partition table. The arguments are:

© 2010, QNX Software Systems GmbH & Co. KG. cam-disk.so
• heads and sectors — report this many heads (and optionally,

sectors) to io-blk.so for hard disks (default is 64 heads
and 32 sectors). The QNX filesystem doesn’t need this
information for normal operation. It’s needed only to let
fdisk write the correct boot cylinder for booting.
• path_ID — the number of the controller to use, where the
first controller is 0 (the default).
• target — for IDE, this is the master (0) or slave (1); for SCSI,
it’s the SCSI ID the device is jumpered for. The default is 0.
• lun — the Logical Unit Number for SCSI; not needed for
IDE. The default is 0.
verbose[=level] Be verbose. If you don’t specify a level, cam-disk.so

increments the current level by one.
Description:
The cam-disk.so provides common access methods (CAMs) for hard disk devices.
See also:
cam-cdrom.so, cam-optical.so, devb-*, fdisk, fs-*, io-blk.so

cam-optical.so © 2010, QNX Software Systems GmbH & Co. KG.
Provide a common access method for optical disks
Syntax:
driver ... optical disk_options ... &
Runs on:
Neutrino
Options:
The optical options control the driver’s interface to cam-optical.so. If specified,

they must follow the optical keyword:
name=prefix Specify the device prefix (default: mo);
nobios Don’t use the geometry from BIOS int 13. By default, if you don’t
specify the translation option, the BIOS geometry is used.
noptab Don’t use the geometry from the partition table. The geometry from
the partition table is used if you specify the nobios option, or the
BIOS geometry is invalid.
retries=num@path_id:target:lun
Set the maximum number of command retries on the specified path,
target, and Logical Unit Number (LUN). The default is 10.
rmb=[true|false]@path_id:target:lun
Set/clear the device as removable on path N, target N, and LUN N.
timeout=g1:g2:g3:rw@path_id:target:lun
Set the rw and group command timeouts on path N, target N, and
LUN N. The defaults are the values from the Timeout and Protect
mode page if supported, otherwise 60:90:10:10 (in seconds).
translation=heads[:sectors[@path_ID[:target[:lun]]]]
Specify the geometry explicitly; this overrides the geometry from the
BIOS and the partition table. The arguments are:
• heads and sectors — report this many heads (and optionally,
sectors) to io-blk.so for hard disks (default is 64 heads and 32
sectors). The QNX filesystem doesn’t need this information for
normal operation. It’s needed only to let fdisk write the correct
boot cylinder for booting.
• path_ID — the number of the controller to use, where the first
controller is 0 (the default).
• target — for IDE, this is the master (0) or slave (1); for SCSI, it’s
the SCSI ID the device is jumpered for. The default is 0.

© 2010, QNX Software Systems GmbH & Co. KG. cam-optical.so
• lun — the Logical Unit Number for SCSI; not needed for IDE.
The default is 0.
verbose=verbosity@path_id:target:lun
Set the verbosity level on path N, target N, and LUN N.
Description:
The cam-optical.so provides common access methods (CAMs) for optical disk
devices.
See also:
cam-disk.so, cam-cdrom.so, devb-*, fdisk, fs-*, io-blk.so

cat © 2010, QNX Software Systems GmbH & Co. KG.
Concatenate and print files (POSIX)
Syntax:
cat [-c] [-n|-r] [-u] [file...]
Runs on:
Options:
-c Compress sequences of multiple newline characters into single newlines.
-n Print line numbers, but don’t restart the number for each new file.
-r Print line numbers, restarting the number for each new file.
-u Write unbuffered output. Data from the input file(s) is written to the standard
output without delay as each file is read.
file The pathname of an input file. If no files are specified, the standard input is
used. If a file is the dash character (-), cat reads from the standard input at
that point in the sequence.
Description:
The cat utility reads files in the order you specify and writes their contents to
standard output.
Examples:
Write the contents of myfile to standard output:
cat myfile
Concatenate doc1 and doc2 and write the result to doc.all:
cat doc1 doc2 > doc.all
Exit status:
0 All input files were output successfully.
Caveats:
Because of the shell language mechanism used to perform output redirection, a
command such as:
cat doc doc.end > doc
causes the original data in doc to be lost. The file doc is opened for write by the shell,
and therefore truncated to zero length, before cat is executed.

© 2010, QNX Software Systems GmbH & Co. KG. cat
See also:
cp, head, tail

CC, cc © 2010, QNX Software Systems GmbH & Co. KG.
C++, C compilers
Syntax:
cc [options] [operands]
CC [options] [operands]
Runs on:
Options:
For a complete list, see qcc.
Description:
The cc utility is used to compile code; CC is for compiling C++ code. Under QNX
Neutrino, they’re both links to qcc.
Under QNX 4, CC and cc are links to an older compiler that you can’t use to compile
code for QNX Neutrino.
GNU
See also:
qcc

© 2010, QNX Software Systems GmbH & Co. KG. chat
Automated conversational script with a modem (QNX Neutrino)
Syntax:
chat [options] script
Runs on:
Neutrino
Options:
-e Turn on echoing. Echoing may be turned on or off at specific
points in the chat script by using the ECHO keyword. When
echoing is enabled, all output from the modem is echoed to
stderr.
-f chatfile Read the chat script from chatfile. If you use this option, don’t
also specify a script argument. You must have read access to
chatfile. Multiple lines are permitted in the file. Use spaces or
horizontal tab characters to separate the strings.
-r report file Set the file for output of the report strings. If you use the
keyword REPORT, the resulting strings are written to this file. If
this option isn’t used and you still use REPORT keywords, the
stderr stream is used for the report strings.
-s Send all log messages from the -v options and all error
messages to stderr.
-S Don’t use the system log for log messages from the -v options
or error messages.
-T phone_number Pass an arbitrary string, usually a phone number, that’s

substituted for the \T substitution meta character in a send
string.
-t timeout Set the timeout for the expected string to be received. If the
string isn’t received within the time limit, the reply string isn’t
sent. An alternate reply may be sent; the script fails if there’s
no alternate reply string. A failed script causes chat to
terminate with a nonzero error code.
-U phone_number_2 Pass a second string, usually a phone number, that’s substituted

for the \U substitution meta character in a send string. This is
useful when dialing an ISDN terminal adapter that requires two
numbers.
-V Verbose mode, but send all output to stderr; chat logs all text
received from the modem and the output strings that it sends.
This device is usually the local console at the station running
chat or pppd.

chat © 2010, QNX Software Systems GmbH & Co. KG.
-v Verbose mode; chat logs all text received from the modem
and the output strings that it sends. In order to capture the log
messages, you need to have syslogd running.
script If the script isn’t specified in a file with the -f option, the
script is included as parameters to the chat program.
Description:
The chat program defines a conversational exchange between the computer and the
modem. Its primary purpose is to establish the connection between the Point-to-Point
Protocol Daemon (pppd) and the remote’s pppd process.
You should consider the modem functions (modem_open(), modem_read(),
modem_script(), and modem_write(), described in the Library Reference) or the
Photon Dialer as an alternative to chat.
Chat script
The chat script defines the communications.
A script consists of one or more “expect–send” pairs of strings, separated by spaces,
with an optional “subexpect–subsend” string pair, separated by a dash as in the
following example:
ogin:-BREAK-ogin: ppp ssword: hello2u2
This line indicates that the chat program should expect the string ogin:. If it fails to
receive a login prompt within the time interval allotted, it’s to send a break sequence to
the remote and then expect the string ogin:. If the first ogin: is received, the break
sequence isn’t generated.
Once it receives the login prompt, chat sends the string ppp and then expects the
prompt ssword:. When it receives the prompt for the password, it sends the password
hello2u2.
CAUTION: This could be a security issue as only plain-text passwords may be

! passed.
A carriage return is normally sent following the reply string. It isn’t expected in the
“expect” string unless it’s specifically requested by using the \r character sequence.
The expect sequence should contain only what is needed to identify the string. Since
it’s normally stored on a disk file, it shouldn’t contain variable information. It’s
generally not acceptable to look for time strings, network identification strings, or
other variable pieces of data as an expect string.
To help correct for characters that may be corrupted during the initial sequence, look
for the string ogin: rather than login:. The leading l character might be received in
error and you may never find the string even though it was sent by the system. For this
reason, scripts look for ogin: rather than login: and ssword: rather than
password:.

A very simple script might look like this:
ogin: ppp ssword: hello2u2

In other words, expect ...ogin:, send ppp, expect ...ssword:, send hello2u2.
In actual practice, simple scripts are rare. At the very least, you should include
sub-expect sequences in case the original string isn’t received. For example, consider
the following script:
ogin:--ogin: ppp ssword: hello2u2

This is a better script than the simple one used earlier. It looks for the same login:
prompt, however, if one isn’t received, a single return sequence is sent and then it
looks for login: again. Should line noise obscure the first login prompt, sending the
empty line usually generates a login prompt again.
Abort strings
Many modems report the status of the call as a string. These strings may be
CONNECTED, NO CARRIER or BUSY. It’s often desirable to terminate the script should
the modem fail to connect to the remote. The difficulty is that a script doesn’t know
exactly which modem string it may receive. On one attempt, it may receive BUSY,
while the next time it may receive NO CARRIER.
These “abort” strings may be specified in the script using the ABORT sequence. It’s
written in the script as in the following example:
ABORT BUSY ABORT ’NO CARRIER’ ’’ ATZ OK ATDT5551212

CONNECT
This sequence expects nothing and then sends the string ATZ. The expected response
to this is the string OK. When it receives OK, chat sends the string ATDT5551212 to
dial the telephone. The expected string is CONNECT. If the string CONNECT is received,
the remainder of the script is executed. However, should the modem find a busy
telephone, it sends the string BUSY. This causes the string to match the abort character
sequence. The script then fails because it found a match to the abort string. If it
received the string NO CARRIER, it aborts for the same reason. Either string may be
received. Either string terminates the chat script.
Report strings
A “report” string is similar to the ABORT string. The difference is that the strings, and
all characters to the next control character such as a carriage return, are written to the
report file.
The report strings may be used to isolate the transmission rate of the modem’s connect
string and return the value to the chat user. The analysis of the report string logic
occurs in conjunction with the other string processing such as looking for the expect
string. The use of the same string for a report and abort sequence is probably not very
useful, however, it is possible.
The report strings don’t change the completion code of the program.

These report strings may be specified in the script using the REPORT sequence. It’s
written in the script as in the following example:
REPORT CONNECT ABORT BUSY ’’ ATDT5551212 CONNECT ’’

ogin: account
This sequence expects nothing and then sends the string ATDT5551212 to dial the
telephone. The expected string is CONNECT. If the string CONNECT is received, the
remainder of the script is executed. In addition the program writes to the expect-file
the string CONNECT plus any characters that follow it, such as the connection rate.
Timeout
The initial timeout value is 45 seconds; you can change it by using the -t option.
To change the timeout value for the next expect string, specify the TIMEOUT string.
For exmple:
ATZ OK ATDT5551212 CONNECT TIMEOUT 10 ogin:--ogin:

TIMEOUT 5 ssword: hello2u2
This changes the timeout to 10 seconds when it expects the login: prompt. The
timeout is then changed to 5 seconds when it looks for the password: prompt.
The timeout, once changed, remains in effect until it’s changed again.
Sending EOT
The special reply string of EOT indicates that the chat program should send an EOT
character to the remote. This is normally the end-of-file character sequence. A return
character isn’t sent following the EOT. The EOT sequence may be embedded into the
send string using the sequence ˆD.
Generating break
The special reply string of BREAK causes a break condition to be sent. The break is a
special signal on the transmitter. The normal processing on the receiver is to change
the transmission rate. It may be used to cycle through the available transmission rates
on the remote until you’re able to receive a valid login: prompt. The break sequence
may be embedded into the send string using the \K sequence.
Escape sequences
The expect and reply strings may contain escape sequences. All of the sequences are
legal in the reply string. Many are legal in the expect. The Expect? column in the table
below indicates whether or not the sequence is valid in an expect string.

Sequence Expect? Description

’’ Yes Expects or sends a null string. If you send a null string, it
still sends the return character. This sequence may either
be a pair of apostrophe or quote characters.
\b Yes Represents a backspace character.
\c No Suppresses the newline at the end of the reply string. This
is the only method to send a string without a trailing
return character. It must be at the end of the send string.
For example, the sequence hello\c sends the characters
h, e, l, l, o.
\d No Delay for one second. The program uses sleep(1),
which delays for a maximum of one second.
\K No Insert a BREAK.
\n Yes Send a newline or linefeed character.
\N No Send a null character. The same sequence may be
represented by \0.
\p No Pause for a fraction of a second. The delay is 1/10th of a
second.
\q No Suppress writing the string to the SYSLOG file. The
string ?????? is written to the log in its place.
\r Yes Send or expect a carriage return.
\s Yes Represents a space character in the string. This may be
used when it isn’t desirable to quote the strings that
contains spaces. The sequence ’HI TIM’ and HI\sTIM
are the same.
\t Yes Send or expect a tab character.
\\ Yes Send or expect a backslash character.
\ddd Yes Collapse the octal digits ddd into a single ASCII character
and send that character. (Some characters aren’t valid in
expect sequences.)
ˆC Yes Substitute the sequence with the control character
represented by C. For example, the character DC1 (17) is
shown as ˆQ. (Some characters aren’t valid in expect
sequences.)
Exit status:
0 The normal termination of the program. This indicates that the script was
executed without error to the normal conclusion.

1 One or more of the parameters are invalid or an expect string was too large for
the internal buffers. This indicates that the program wasn’t properly executed.
2 An error occurred during the execution of the program. A read or write

operation might have failed for some reason or chat might have received a
signal such as SIGINT.
3 A timeout event occurred when there was an expect string without having a
“-subsend” string. This may mean that you didn’t program the script correctly
for the condition or that some unexpected event has occurred and the expected
string couldn’t be found.
4 The first string marked as an ABORT condition occurred.
5 The second string marked as an ABORT condition occurred.
6 The third string marked as an ABORT condition occurred.
7 The fourth string marked as an ABORT condition occurred.
... The other termination codes are also strings marked as an ABORT condition.
Using the termination code, it’s possible to determine which event terminated the
script. It’s possible to decide if the string BUSY was received from the modem as
opposed to NO DIALTONE. While the first event may be retried, the second probably
has little chance of succeeding during a retry.
See also:
syslogd
modem_open(), modem_read(), modem_script(), modem_write() in the Library
Reference

© 2010, QNX Software Systems GmbH & Co. KG. chattr
Manipulate the attributes of a file (QNX Neutrino)
Syntax:
chattr [+/- attribute]... [filename]...
Runs on:
Neutrino
Options:
attribute The attribute you want to remove (-) or set (+).
filename The name of a file whose attributes you want to display or manipulate.
Description:
The chattr utility is a front end to the devctl(DCMD_FSYS_FILE_FLAGS)
command (from <sys/dcmd_blk.h>), which gets and sets file attributes (that are
outside the scope of the POSIX standard). For example, the DOS/FAT filesystem has
the concept of “hidden” or “system” files. Such attributes are typically stored as flags
in the on-disk inode of each file.
These attributes are divided into the following classes:
Generic An attribute that corresponds to a concept that may be shared across

multiple filesystem formats (even if implemented in a different manner
for each one).
Filesystem-specific
An attribute that has meaning only within a specific filesystem.
It’s the responsibility of each io-blk.so filesystem module to map generic attributes
to and from their private representation.
For example, a hidden file is a generic concept of a filename that may be hidden from
normal user browsing (not displayed by ls) but remains available (to open() by an
application) if its name is already known. The representation of this concept varies
between filesystems:
• For DOS/FAT, it directly corresponds to the “hidden” bit.
• For ISO-9660, it’s the “existence” bit.
• The QNX 4 filesystem has no such thing.
This mapping functionality allows for application abstraction away from a particular
on-disk structure (a program can work unchanged against any file on any filesystem).
Many filesystem-specific attributes have no corresponding generic concept, and must

chattr © 2010, QNX Software Systems GmbH & Co. KG.
be manipulated with knowledge of the underlying filesystem structure; the various

<sys/fs_*.h> header files contain relevant bit definitions.
When you invoke chattr with no attributes and a filename (or a list of filenames), it
displays the currently set attributes of each file. When you invoke chattr with an
attribute (or list of attributes), it applies those modifications to each file.
Examples:
List the attributes for a file:
# chattr chattr.c
chattr.c: +backup +contiguous +used +modified
Add to and remove from the attributes for a file:
# chattr -archive +system /fs/dos/autoexec.bat

/fs/dos/autoexec.bat: -archive +system
Turn off snapshots for a Power-Safe (fs-qnx6.so) filesystem:
# chattr -snapshot /fs/qnx6

/fs/qnx6: -snapshot
See also:
devb-*, fs-*, fsysinfo, io-blk.so

© 2010, QNX Software Systems GmbH & Co. KG. chgrp
Change file group ownership (POSIX)
Syntax:
chgrp [-R] [-v] group file...
Runs on:
Neutrino
Options:
-R Recursively change group ownership of files. For each file that names a
directory, chgrp changes the group of the directory and of all files in the
file hierarchy below it.
-v Be verbose; display to stdout all the operations being performed.
group A group name from the group database, or a numeric group ID.
file The pathname of a file whose group ID is to be modified.
Description:
The chgrp utility lets you change the group ownership of one or more files. For each
file you name, chgrp sets the file’s group ID to that specified by the group argument.
If you invoke chgrp with the -R option, and chgrp attempts but fails to change the
group ID of a particular file in a specified file hierarchy, it continues to process the
remaining files in the hierarchy.
You must be root or the owner of the file in order to change its group ownership. The
underlying filesystem might impose further restrictions. For example, the QNX 4
filesystem sets the _PC_CHOWN_RESTRICTED configuration variable; for more
information, see pathconf() in the Neutrino Library Reference.
Examples:
Change the group of myfile to 27:
chgrp 27 myfile
Change the group of myfile to technical:
chgrp technical myfile
Files:
/etc/group This file defines the known group IDs for the system. It associates
group names with a numerical ID and a list of users who are
members of the group.
Entries in this file appear in the following format:

chgrp © 2010, QNX Software Systems GmbH & Co. KG.
groupname:unused:groupid:user[,user]...
Exit status:
0 The utility executed successfully and all requested changes were made.
See also:
chmod, chown, find ... -chgrp
Working with Files in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. chkdosfs
Check a DOS (FAT-12/16/32) filesystem for consistency (QNX Neutrino)
Syntax:
chkdosfs [-npuy] device | mountpoint | file
Runs on:
Neutrino
Options:
-n Answer “no” to all repair questions and prompts.
-p Check and fix the filesystem non-interactively (i.e. “preen” mode).
-u Perform unconditional check of the filesystem (regardless of the

on-disk/dirty status).
-y Answer “yes” to all repair questions and prompts.
device The device name hosting the DOS filesystem (e.g. /dev/hd0t6).
mountpoint The mountpoint of the DOS filesystem (e.g. /fs/hd0-dos).
file A regular file containing a DOS filesystem image.
Description:
The chkdosfs utility performs a consistency check on the specified DOS filesystem.
This check consists of multiple passes over the filesystem.
If an error occurs, the action taken depends on the command-line options used. If -p
was specified (typically to auto-check the filesystem at startup), no message is
displayed and the default repair action is silently made. If either -n or -y was
specified, a descriptive message is displayed and a “no” or “yes” response to the
suggested action is automatically generated. Otherwise the user interactively decides
on the repair action to make (the suggested default is indicated).
In order to perform repairs, chkdosfs requires write access to the device hosting the
DOS filesystem. Normally, only root has permission for write access; if chkdosfs
does not have such access, it will still check the filesystem but will operate as if the -n
option had been specified.
By default, the chkdosfs utility checks an on-disk flag that’s maintained by the
filesystem that indicates to chkdosfs whether or not anything needs to be checked.
This flag is usually updated when mounting or unmounting the filesystem. The -u
option can be used to force the chkdosfs to run regardless of the state of this flag.

chkdosfs © 2010, QNX Software Systems GmbH & Co. KG.
Summary of filesystem commands

The following table shows the shared objects and related commands for the
filesystems:
Partition type Filesystem Shared object Initialize with: Check with:

1, 4, or 6 DOS fs-dos.so mkdosfs chkdosfs
7 Windows NTa fs-nt.so N/A N/A
11, 12, or 14 FAT32 fs-dos.so mkdosfs chkdosfs
77, 78, or 79 QNX 4 fs-qnx4.so dinit chkfsys
131 Linux (Ext2) fs-ext2.so N/A N/A
175 Apple Macintosh HFS or HFS Plusa fs-mac.so N/A N/A
177, 178, or 179 Power-Safe fs-qnx6.so mkqnx6fs chkqnx6fsb
a Read-only.
b Not usually necessary.
For more information, see the Filesystems chapter of the System Architecture guide.
Examples:
Check the filesystem on the DOS partition of a hard disk:
# chkdosfs /dev/hd0t11
Phase 1 - Read and compare FATs

Phase 2 - Check cluster chains
Phase 3 - Check directories
Phase 4 - Check for lost files
1476784 kb used, 1010088 kb free, 24932 files, 2921 directories

Filesystem is clean.
Exit status:
0 The filesystem was checked and either no errors were detected or all such errors
were repaired.
1 The filesystem was not checked. This may be because the user interrupted the
operation, a non-recoverable internal error such as insufficient memory
occurred, or chkdosfs found an unrepairable error.

© 2010, QNX Software Systems GmbH & Co. KG. chkdosfs
Wolfgang Solfrank, Martin Husemann
See also:
chkfsys, chkqnx6fs, devb-eide, fs-dos.so, mkdosfs, mount, umount

chkfsys © 2010, QNX Software Systems GmbH & Co. KG.
Check an entire QNX 4 filesystem for consistency (QNX)
You must be root to run this utility.
Syntax:
When running on QNX 4:
chkfsys [-fpPqrsuvV] [-z zapfile] drive
When running on QNX Neutrino:
chkfsys [-fpPqrsuvVx] [-z zapfile] mountpoint
Or:
chkfsys [-fpPqrsuvVx] [-z zapfile] -m drive
Runs on:
Neutrino
Options:
-f Don’t fix anything.
-m (QNX Neutrino only) No mountpoint; the path specified is a raw
device/partition.
-p Prompt before starting.
-P Suppress prompting (i.e. fix without asking any questions).
-q Be quiet.
-r Rebuild the bitmap without prompts or messages.
-s Suppress the display of statistics.
-u Check the filesystem, regardless of the status recorded on the disk.
-v Be verbose. (Shows files in addition to directories as they’re being
checked. Slows chkfsys considerably.)
-V Very verbose display.
-x (QNX Neutrino only) Exit with detailed error codes; see below.
-z zapfile Record pathnames of files that need to be zapped in the specified file.
The zapfile must reside on a different filesystem from the one being
checked.
drive The disk to check (e.g. /dev/fd0, /dev/hd0t77).
mountpoint (QNX Neutrino only) The filesystem mountpoint of the drive (e.g. /).

© 2010, QNX Software Systems GmbH & Co. KG. chkfsys
Description:
The chkfsys utility performs a consistency check of a QNX 4 filesystem on the
requested drive. The chkfsys utility doesn’t operate on disk partitions containing
non-QNX filesystems (e.g. DOS partitions, QNX 2 partitions). In addition, chkfsys
must have access to the block special file that the filesystem is contained in. For this
reason, chkfsys can’t be used on NFS-mounted QNX filesystems.
The chkfsys utility claims that a Power-Safe (fs-qnx6.so) filesystem is corrupt;

use chkqnx6fs instead.
For QNX filesystems, chkfsys recursively walks the filesystem, checking every file
on the disk. During the walk, checks are made on the directory entry of each file and
the extents that make up the file. A bitmap is constructed in memory that’s consistent
with the block allocation of all files and directories on the disk. This bitmap is then
compared to the existing one on the disk. If they differ, the user is given the option of
replacing the existing bitmap on disk with the one constructed in memory.
By default, chkfsys checks an on-disk flag that’s maintained by the filesystem that
indicates to chkfsys whether or not anything needs to be checked. If the flag is set,
chkfsys reports that everything is fine and exits immediately. When you do an
orderly shutdown of the system, this flag is always set (unless an error had occurred in
the process). If you shut down the system by powering down, the flag may or may not
be set, depending on the state of the filesystem at the time. You can use the -u option
to force chkfsys to run even if the flag is set.
CAUTION: You should use chkfsys only when the filesystem is stable. There
! should be NO files open for writing when chkfsys is running. If you make any
repairs, remount the filesystem by slaying and restarting the disk driver.
If you aren’t doing any fixes (with the -f option), you may check a filesystem with
open files, but beware: you may get inconsistent reports in this case.
The chkfsys utility is normally used to recover blocks that were lost through the use
of the zap utility. When zap has been used, chkfsys reports that there are blocks
used in the bitmap that are in fact not used by any file. These blocks may be recovered
by writing the reconstructed bitmap back to disk. The chkfsys utility attempts to
read each of these blocks, but doesn’t mark bad blocks as available. Any blocks found
this way are added to the /.bad_blks file at the root of the filesystem being checked.
The chkfsys utility tells you if any files are using blocks that are now known to be
bad.
If chkfsys reports that a block is used by more than one file, this could indicate one
of two problems:
• If bad blocks exist, then this means that the file uses a block that’s bad and marked
as used in the bitmap.

• If there are no known bad blocks, then a multiple allocation of a single block has
occurred.
In either case, the file should be saved on another disk (if possible), and the original
file should be destroyed with the zap utility. The chkfsys utility should then be run
again to update the bitmap, after which the saved file may be restored onto this disk.
In general, whenever the bitmap is replaced, chkfsys should be run a second time to
ensure that the filesystem is indeed consistent. To do so you must specify the -u
option.
The -f (no fix) option prevents chkfsys from attempting to make any fixes to the
filesystem. The disk isn’t opened for write, but only for read. This option lets a user
examine the filesystem without requiring other users to stop using the disk or
filesystem. Beware, however, that the -f option may report errors that don’t really
exist (if other users are opening, closing, or growing files during the time that
chkfsys is running). Even so, this can be a valuable option for sites that are up and
running 24 hours a day, when the system operator carefully evaluates the results. If
you see errors that you believe result from current activity, run chkfsys again with
the -f option to verify the errors. If you have located errors that require fixing, you
should idle the filesystem and run chkfsys without the -f option.
The -p (pause) option is used primarily with floppy disks. You can start chkfsys
from a floppy diskette, wait for chkfsys to pause, remove the current disk (which
contains the chkfsys command), and then insert another disk you wish to check.
The -q (quiet) option suppresses the display of each filename as that file is checked.
This speeds up the checking significantly, without loss of information, because
chkfsys shows you the name of any files that have errors.
The -r (rebuild) option suppresses the warning message that normally appears at the
end of a chkfsys run when the existing bitmap differs from the newly constructed
bitmap in memory. When -r is specified, chkfsys automatically rebuilds the bitmap.
Note that this option isn’t effective with the -f (no fix) option.
The -s (no stats) option prevents the display of the statistics message that normally
appears at the end of a chkfsys run.
The -v (verbose) option displays information on the checking.
The -P (no prompt) option causes chkfsys to automatically fix problems
encountered without prompting the user before each fix. However, there are some
serious errors (disk IO error or corruption of a high level directory) for which the fix
may be to remove a directory (and all its hierarchy/contents). This may not be a
prudent action to undertake without user confirmation. In such a situation -P will print
an error message and exit. If you wish chkfsys to continue unattended in all
circumstances, you can specify this as “-PP”.
The -z zapfile option is used to record, in the named file, the names of files that should
be zapped after chkfsys is finished. The zapfile must be on a different filesystem
from the one being checked. When a file is found to use an area of the disk allocated

© 2010, QNX Software Systems GmbH & Co. KG. chkfsys
to another file, or when a file uses an area of the disk marked as bad in the bitmap, the
files must be zapped and chkfsys run again.
After a power failure
The chkfsys utility may also be run after a system crash or power failure, which may
have left some files busy. The utility makes the files “unbusy” and also makes checks
to ensure that no damage to the filesystem has occurred. QNX is designed to be
immune to this type of damage.
In the event of the loss of a filesystem due to the corruption of the root directory and
the bitmap (first few blocks of the disk), you should refer to the QNX Neutrino System
Architecture, and the dinit utility documentation for methods of initializing just
those portions of your disk. If only the root block and bitmap are damaged, chkfsys
is able to recover the files in most cases. If the root directory or inode file is damaged
(the next areas on the disk), recovery may be possible with the dinit, spatch, and
chkfsys utilities. Note that such repair requires intimate knowledge of the filesystem
structure. Many users would just recover lost files from a backup at this point. You
shouldn’t expect to run into such problems; these are very rare events that we’ve tried
to anticipate.

filesystems:

a Read-only.
Examples:
Check the filesystem on the QNX partition of a hard disk:
chkfsys /hd

Check the QNX filesystem mounted as the root (/) and automatically rebuild the
bitmap:
chkfsys -rs /
Exit status:
The exit status depends on whether or not you specified the -x option:
• If you didn’t specify the -x option, the exit status is as follows:
0 The filesystem(s) have been checked.
CAUTION: An exit status of zero doesn’t indicate that no problems were found with
! the filesystem(s). It merely indicates that no irrecoverable errors internal to the
chkfsys utility were encountered.
>0 The filesystem(s) may not have been checked. The chkfsys operation may
have been interrupted at the request of the user or an internal error (such as
running out of memory) may have occurred.
• If you specified the -x option, the lower bit of the error code indicates whether or
not anything was fixed, while the upper four bits identify the cause of failure if
nonzero:
0x00 The filesystem was clean; there was nothing to do.

0x01 The disk data has been fixed.
0x10 Insufficient memory.
0x20 General program failure.
0x30 The filesystem query or request failed.
0x40 Failed to read from the device.
0x50 Failed to write to the device.
0x60 Filesystem corruption was detected but not fixed.
See also:
chkdosfs, chkqnx6fs, dcheck, dinit, fs-qnx4.so, spatch, zap

© 2010, QNX Software Systems GmbH & Co. KG. chkqnx6fs
Check an entire Power-Safe filesystem for consistency (QNX Neutrino)
You must be logged in as root to run this utility.
Syntax:
chkqnx6fs [-sv] host
Runs on:
Neutrino
Options:
-s Display header information from the superblock. The number of -v options
controls which fields chkqnx6fs displays.
If you specify -s, chkqnx6fs locates and verifies the active superblock, but doesn’t
check the filesystem itself.
-v Increase output verbosity. You can specify multiple -v options.
host The host of the filesystem. You can specify this as a block-special device or
partition (e.g. /dev/hd0t76), as a regular file, or as the root directory of a
mounted fs-qnx6 filesystem (which will be resolved to the real host device).
Description:
The chkqnx6fs performs a consistency check on a Power-Safe (fs-qnx6)
filesystem. The check is conducted in these passes:
1 Locate and verify superblocks and select the newest stable one.
2 Traverse the system inodes and bitmap files.
3 Recursively walk the directory hierarchy from the root.
Only a stable filesystem can be checked (i.e. one that isn’t going to change or be
updated during the scan). A stable filesystem is one of the following:
• unmounted
• mounted read-only
• mounted read-write with snapshots disabled (in which case the stable filesystem,
not the working copy, is checked)

chkqnx6fs © 2010, QNX Software Systems GmbH & Co. KG.
You shouldn’t actually need to use chkqnx6fs in a production system (e.g. in a boot
script). The design of the fs-qnx6 filesystem should (in the absence of software bugs,
physical bad blocks, or malicious data modification on the raw device) make any such
check unnecessary.

filesystems:

a Read-only.
Examples:
# chkqnx6fs -v /dev/hd0t76
** Prelude: read and verify superblocks **
** Pass 1 : verify bitmap and inodes **
** Pass 2 : verify directory hierarchy **
** Summary: 20216/8040524 blocks, 142/62816 inodes **
Exit status:
0 The filesystem is consistent/stable.
1 An error occurred checking the filesystem (descriptive messages are written to

stderr).

© 2010, QNX Software Systems GmbH & Co. KG. chkqnx6fs
See also:
chkdosfs, chkfsys, fs-qnx6.so, mkqnx6fs
“Power-Safe filesystem” in the Filesystems chapter of the System Architecture guide
“Power-Safe filesystem” in the Filesystems chapter of the Neutrino User’s Guide

chmod © 2010, QNX Software Systems GmbH & Co. KG.
Change file modes (POSIX)
Syntax:
chmod [-Rv] mode file...
Runs on:
Options:
-R Recursively change file modes. For each file that names a directory, chmod
changes the file mode bits of the directory and all files in the file hierarchy
below it.
-v Be verbose; display the operations that are being performed.
mode Represents the change to be made to the file mode of each file named (see
the Description below).
file The pathname of a file whose file mode bits are to be modified.
Description:
The chmod utility lets you change any or all of the file permission mode bits of one or
more files. For each file that you name, chmod changes the file permission mode bits
according to the mode operand.
To change a file’s permission mode bits, the user of chmod must be either the owner of
the file or the superuser, root.
The mode option can be either a symbolic_mode expression or a nonnegative octal
integer.
Symbolic Modes
The symbolic_mode has the following form:
[who]operator[copy|permissions][,symbolic_mode]
The who part of the symbolic mode is any combination of:
a User, group, and other access
g Group access
o Other access
u User access
The operator is one of:

© 2010, QNX Software Systems GmbH & Co. KG. chmod
+ Add specified permissions to the group, other, or user category of the specified
files.
- Remove specified permissions from the group, other, or user category of the
specified files.
= Set the specified permissions for the group, other, or user category of the
specified files.
The copy part specifies the unmodified permissions (i.e. before the chmod command
has been executed) of one of:
g Group
o Other
u User
The permissions part is any combination of:
r Read permission
s When executed, set the user ID (if who contains or implies u) and/or group ID
(if who contains or implies g)
t Sticky bit
w Write permission
X Execute/search permission if the file is a directory or at least one execute bit is

on before any of the file mode bits are modified
x Execute permission
The who specification is optional. When it isn’t supplied, all the permissions (user,
group and other) are affected, but for + and = operators, only those permissions that
aren’t set in the file creation mask (see umask) are set.
The permissions part is also optional. If omitted, it defaults to none (i.e. the command
adds no permissions, removes no permissions, or sets the permissions to none,
depending on the operator).
Some examples of symbolic modes:
Make myfile executable by all:
chmod a+x myfile

Remove read permission for group and others:
chmod og-r myfile

chmod © 2010, QNX Software Systems GmbH & Co. KG.
Perform both the above operations, in the order given, on three files: myfile, file2,
and zzz:
chmod a+x,og-r myfile file2 zzz
Add read permission to the user, remove write permission from the user, and set the
group permissions to be the same as the other permissions:
chmod u+r,u-w,g=o myfile
Octal Modes
In octal mode, permissions are specified with a three-digit octal number. The three
digits represent user, group, and other permissions in that order.
Each permission may be specified with an octal number: read = 4; write = 2; execute
= 1; no permission = 0. The octal equivalents are derived by adding the numbers
associated with the four basic permissions. The following table illustrates their use:
Octal number Symbolic Permission

0 --- None
1 --x Execute
2 -w- Write
3 -wx Write/execute
4 r-- Read
5 r-x Read/execute
6 rw- Read/write
7 rwx Read/write/execute
For example, give the user read/write/execute (octal 7 = rwx), group read/execute
(octal 5 = r-x), and other read only (octal 4 = r--) for the file myfile:
chmod 754 myfile
Setgid and setuid

The following table shows how the setgid and setuid file modes are represented in
octal:

© 2010, QNX Software Systems GmbH & Co. KG. chmod
Octal number File mode

1000 Sticky
2000 Setgid
4000 Setuid
6000 Setgid and setuid
You can combine these file modes with the permission modes described above. For
example:
chmod 4666 testfile
In this case, setuid is set, and the user, group, and other get read/write access.
Exit status:
Caveats:
If the mode operand isn’t valid, chmod doesn’t change the file mode bits of any file.
See also:
chgrp, chown, find ... -chmod ..., ls, umask

chown © 2010, QNX Software Systems GmbH & Co. KG.
Change the ownership of files and directories (POSIX)
Syntax:
chown [-Rv] owner[:group] file...
Deprecated:
chown [-Rv] owner[.group] file...
Runs on:
Neutrino
Options:
-R Recursively change ownership of files. For each file operand that names a
directory, chown changes the user ID of that directory and of all files in the
file hierarchy below it.
-v Verbose. Display to stdout the operations which are being performed.
owner A username from the user database, or a numeric userid. The chown utility
changes the owner of each file to the user ID of the specified owner.
group A group name from the user database, or a numeric groupid. The chown
utility changes the group of each file to the groupid of the specified group.
file The pathname of a file whose ownership is to be modified.
Description:
The chown utility sets each file’s owner and group to the user and group IDs specified
by the owner and group operands.
Examples:
Change the owner of file data to user 27:
chown 27 data
Change the owner of the file data to dtdodge:
chown dtdodge data
Change the owner of the file subfile to dtdodge and set the group of the file to
techies:
chown dtdodge:techies subfile

© 2010, QNX Software Systems GmbH & Co. KG. chown
Exit status:
Caveats:
If you invoke chown with the -R option, and chown attempts but fails to change the
owner or group of a particular file in a specified file hierarchy, it continues to process
the remaining files in the hierarchy. The chown utility can fail to change the user or
group of a file if you don’t have appropriate permissions.
In QNX Neutrino, the _PC_CHOWN_RESTRICTED flag is enforced, therefore you

must be root to use chown unless you are changing ownership to yourself. Normal
users can’t give a file away to another user by changing the file ownership.
For compatibility with some other implementations of chown, a deprecated syntax

allows a period (.) to be used instead of a colon (:) to separate user and group (e.g.
user:group and user.group are both allowed). However, be aware that if a userid
contains a period, it may be specified either alone or in conjunction with a group using
:, but may not be used in conjunction with a group using .. For instance, if there was
a userid my.name and a group tech, you could do a chown my.name myfile or
chown my.name:tech myfile, but not chown my.name.tech myfile.
See also:
chgrp, chmod, find ... -chown ...

cksum © 2010, QNX Software Systems GmbH & Co. KG.
Display file checksums and block counts (POSIX)
Syntax:
cksum [-o algorithm] [-q|-v] [file...]
Runs on:
Options:
-o algorithm Use the specified algorithm. Valid algorithm values include:
Algorithm Action
1 Use historic 16-bit checksum algorithm.
2 Use historic 32-bit checksum algorithm.
9 Use 1003.2 draft 9 algorithm (QNX versions 4.0 and 6)
11 Use 1003.2 draft 11 algorithm
12 Use 1003.2 draft 12 algorithm
92 Use 1003.2-1992 standard algorithm (DEFAULT)
4.1 Use old QNX cksum algorithm (QNX 4.10-4.21)
-q Quiet. Don’t display header (counteracts -v). (Default)
-v Verbose. Display a header which states the algorithm used and

names the output columns.
file The pathname of a file to be checked. If no files are specified, the

standard input is used.
Description:
The cksum utility writes one line to standard output for each file you specify. This line
contains the checksum of the file, as well as the file size and the name of the file being
checked. The format of this output varies slightly depending on the command line
options specified to cksum as follows:
-o algorithm: Filesize units Output format

1 Kilobytes %lu %lu %s
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. cksum
-o algorithm: Filesize units Output format

2 512-byte blocks %lu %lu %s
All others Bytes %10lu %10lu %s
If you don’t specify any files, cksum processes standard input; no filename is given in
the output line.
The cksum utility lets you quickly compare a suspect version of a file to a trusted
version of the same file. You can also use cksum to check files after they have been
transferred by modem, restored from backup media, or unpacked from a compressed
form. The utilities that perform these operations have their own checks, but cksum
serves as a useful independent checking mechanism.
If you wish to perform a byte-by-byte comparison of files, you can use the cmp utility.
Exit status:
0 All files were processed successfully.
See also:
cmp, diff

clear © 2010, QNX Software Systems GmbH & Co. KG.
Clear the screen
Syntax:
clear
Runs on:
Neutrino
Options:
None.
Description:
This utility clears the text-mode screen or the current pterm window.

© 2010, QNX Software Systems GmbH & Co. KG. cmp
Compare two files (POSIX)
Syntax:
cmp [-l|-s] file1 file2
Runs on:
Neutrino
Options:
-l (“el”) Print the byte position (in decimal) and the differing bytes (octal) for
all differences (not just the first one) between the two files.
-s Be silent. Return the exit status only.
file1 The pathname of the first file to be compared. If file1 is the dash (-)
character, standard input is used.
file2 The pathname of the second file to be compared.
Description:
The cmp utility compares two files.
This utility is intended for comparing binary files, if you want to compare text files,
use diff.
If you don’t specify any options, cmp behaves as follows:
• If the two files are the same, cmp writes no output.

• If the files differ, cmp writes to standard output the byte and line number at which
the first difference occurred. Bytes and lines are numbered beginning at 1.
If you specify both the -s and -l options, nothing is printed (no long output).
Examples:
Compare the files myfile.dat and save.dat:
cmp myfile.dat save.dat
Exit status:
0 The files are identical.
1 The files differ. This includes cases where one file is identical to the first part
of the other. In such cases, if you haven’t specified the -s option, cmp writes to
standard error a message that EOF was reached in the shorter file (before any
differences were found).

cmp © 2010, QNX Software Systems GmbH & Co. KG.
See also:
cksum, diff, patch, wc

© 2010, QNX Software Systems GmbH & Co. KG. /etc/context.conf
Context definitions for SNMPv2
Name:
/etc/context.conf
Description:
The context.conf file is used to define a collection of object resources that’s
accessible by a network entity. A context is made up of:
• information stored on the agent machine (views; see /etc/view.conf)
• information stored on another machine that doesn’t understand SNMP.
The agent acts as a proxy machine for the remote non-SNMP system.
1 /nodecfg/node_name/etc/context.conf, where node_name is the value

of the CS_NODENAME configuration string (see getconf and setconf)
2 /etc/context.conf
The file is in this format:

contextname contextidentity
contextviewindex contextlocalentity contextlocaltime
contextdstpartyindex contextsrcpartyindex contextproxyxcontext
where:
contextName Unique alphanumeric friendly name.
contextIdentity Unique object identifier.
contextViewIndex Numeric value representing a view as defined in

/etc/view.conf.
contextLocalEntity String or NULL.
contextLocalTime CurrentTime or restartTime.
contextDstpartyIndex
Decimal value.
contextSrcpartyIndex
Decimal value.
contextProxyContext
Object identifier.
For example, the following defines a context (agent_context) that consists of view
index number 3 from the /etc/view.conf file:

/etc/context.conf © 2010, QNX Software Systems GmbH & Co. KG.
agent_context .1.3.6.1.6.3.3.1.4.10.0.0.59.3
3 NULL CurrentTime
0 0 0
See also:
snmpget, snmpgetnext, snmptest, snmptrapd, snmpwalk

© 2010, QNX Software Systems GmbH & Co. KG. coreinfo
Display information about a QNX Neutrino core file
Syntax:
coreinfo
Runs on:
Neutrino
Options:
None.
Description:
The coreinfo utility displays information about a QNX Neutrino core file. It lets you
examine a core dump directly, without using a debugger.
See also:
dumper

cp © 2010, QNX Software Systems GmbH & Co. KG.
Copy files (POSIX)
Syntax:
cp [-f|-i] [-Rrp] [QNX Neutrino extensions]
source_file target_file
cp [-f|-i] [-Rrp] [QNX Neutrino extensions]

source_file... target_dir
Runs on:
Options:
-A (QNX Neutrino extension) Preserve source file access times.
-B (QNX Neutrino extension) Use a very small (2 KB) copy buffer.
-c (QNX Neutrino extension) Create any directories necessary to open
the destination path. For example, if the directory /home/eric
doesn’t exist, and you enter:
cp -c file /home/eric/source/file
cp performs the equivalent of:

mkdir -p /home/eric/source
cp file /home/eric/source/file
-D (QNX Neutrino extension) Descend past device boundaries when

using the -R option. This is the default behavior; if you want to
prevent cp -R from descending past device boundaries, use the -N
option.
-f (QNX Neutrino extension) Force the unlinking of the destination
file prior to copying. This option prevents interactive prompting
(unless you also specify -i) but doesn’t disable diagnostic
messages.
-i Run interactively; always prompt for confirmation when the
destination path exists, regardless of whether you have write
permission for the destination file. The -i option is useful when
you want to avoid accidentally clobbering files when copying.
When you don’t have write permission for the destination file and
you answer yes to the prompt, the destination file is unlinked first.
Otherwise, the destination is simply overwritten and truncated.
The combination of -i and -f works as if you specified only -i,
except that when you answer yes to the prompt, the destination is
always unlinked first — even if you have write permission for the
destination file. When you specify only -i, the destination is
unlinked only when you don’t have write permission for the
destination file.

© 2010, QNX Software Systems GmbH & Co. KG. cp
-l n (“el” — QNX Neutrino extension) If source_file is a directory, and

you specify the -R or -r option, copy only n levels of the directory
tree. If you specify -l 0, -R or -r is defeated; only files at the
current level (files named directly on the command line) are copied.
-L (QNX Neutrino extension) Attempt to preserve hard links. When

cp encounters a file that has a link count greater than 1, it
remembers that file’s device ID and serial number (inode). If
during the cp another file with a link count greater than 1 is found
matching the serial number and device ID, cp creates a link instead
of making a second copy of the file. When the destination media is
changed, cp wipes its memory of links encountered to that point.
(This is significant when making floppy backups, or backups to
removable hard disks.)
-M qnx|unix (QNX Neutrino extension) Do recursive copies in UNIX (the

default) or old-style QNX mode.
QNX has, in the past, copied the contents of the directories named
on the command line into the target directory. UNIX copies the
directory itself into the target directory (like mv). In either case, if
there’s only one directory being copied and the destination names a
directory that doesn’t exist, cp creates the destination directory and
then copies the contents of the source directory into the destination
directory.
The default mode under QNX Neutrino is different from that under QNX 4.
For more information, see “Recursive Copying,” below.
-N (QNX Neutrino extension) Don’t descend past device boundaries

when using the -R option. By default, cp -R descends past device
boundaries while traversing a directory tree; specifying -N prevents
this behavior. For example:
cp -R / /hd/backup
causes cp to back up the contents of the disk, including the

contents of the /dev directory.
In this particular example, only the disk devices (block special files) actually have
their data backed up to files in /hd/backup/dev because cp doesn’t copy character
special files on recursive copies.
The addition of -N, as follows:
cp -RN / /hd/backup
causes the contents of the disk to be backed up, but the /dev
directory is skipped, since it doesn’t exist on the hard disk device.

-n (QNX Neutrino extension) See the -u option.
-p After copying, attempt to duplicate the modification time and file

mode of each input file in the corresponding output file. Also
duplicate the ownership of each file if the process is run with the
privileges of the superuser (root). If the process doesn’t have the
appropriate privileges, the duplication fails.
-r Recursively copy directories. If a source file is a special file (e.g.

FIFO, named special file), cp doesn’t create a special file as the
destination. Read the section on recursive copying and see the -M
and -R options.
-R If the source_file is a directory, recursively copy the directory with

the files and subdirectories under it, attempting to preserve special
files. QNX Neutrino doesn’t allow block special files and character
special files to be created in this manner. Read the section on
recursive copying, and see the -M and -r options.
-s (QNX Neutrino extension) Run safely; copy only if the existing

destination file has write permission. If the file doesn’t have write
permission, skip the file without prompting.
-t (QNX Neutrino extension) Don’t attempt to duplicate file time and

mode if the -p option was specified or if the POSIX_STRICT
environment variable is set to on.
-u (QNX Neutrino extension) Copy only if the source is newer than

the destination (i.e the source has a more recent file-modified time),
or if the destination doesn’t already exist.
-V (QNX Neutrino extension) Be extra verbose. In addition to doing

everything -v does, this option displays a running progress counter
(% complete) and it also displays lines when cp skips a file or a
directory (i.e. you can see what cp isn’t doing as well as what it is
doing).
For example, if you select options -R and -n, you’ll find that cp
-VRn is more useful than cp -vRn, because the -v option in this
case might let cp go away and put you back at the prompt without
providing you with any feedback.
-v (QNX Neutrino extension) Be verbose. Display a line of

explanatory text every time a file is copied or a directory is created.
-X (QNX Neutrino extension) Copy only if the destination file doesn’t

exist.
-x (QNX Neutrino extension) Copy only if the destination file already

exists.

source_file The pathname of a file to be copied. If you want source_file to

name a directory, you must also specify the -R option.
target_file The pathname to which a single file is copied.
target_dir The pathname of an existing directory that’s to contain the output

file(s).
Description:
There are two syntax forms for cp:
cp [-f|-i] [-Rrp] [QNX Neutrino extensions] source_file target_file

The cp utility copies the contents of the source file to the destination file named
by target_file. This first syntax form is assumed when the destination file isn’t
an existing directory and there’s only one source file.
cp [-f|-i] [-Rrp] [QNX Neutrino extensions] source_file... target_dir

For each source_file, cp copies the contents of the file to a destination file in the
existing directory named by target_dir. The destination’s filename under the
target directory is the same as its basename (final path component), unless it’s a
directory (see “Recursive Copying”). For example:
cp dir/dir/myfile /existingdir
copies the contents of dir/dir/myfile to the file /existingdir/myfile.
This second form is assumed when the destination file is an existing directory or
when you specify more than one source file.
General
Unless you specify the -R (recursive) option, cp refuses to copy any source_file that is
a directory.
For duplicating lists of files, see the pax -rw utility, which is another POSIX utility
for duplicating files. You can select sets of files that match complex criteria by using
find, and then pipe them to pax.
What cp does when a destination file already exists depends on the options used. If
you don’t specify -f or -i, cp prompts you only if you don’t have write permission
for the existing destination file. When this happens, you’re asked if you want to unlink
the file first. If you don’t, cp goes on to any remaining files. You’re prompted only if
stdin is a tty. Otherwise, cp prints a diagnostic message to stderr and skips that file.
If you’re copying to removable media, such as a floppy or removable disk, and the
media becomes full, cp closes and removes the incompletely copied destination file,
displays a message, then exits.

Recursive copying
When doing a recursive copy of a directory, the destination must be a directory. If
you’re copying more than one item, the directory must already exist. If you’re copying
a single directory, cp creates the destination directory (all intermediate directories
must already exist unless you specify the -c option).
There are two recursive copying modes available with cp:
• In the historical QNX 4 behavior, specified by the -Mqnx option, cp copies the files
and directories underneath the source directory to the destination directory. The
source directory itself isn’t duplicated within the destination directory.
• The default mode (-Munix) causes cp to duplicate the source directory within the
destination directory (unless a single directory is being copied and the destination
directory doesn’t yet exist, in which case -Munix and -Mqnx modes do the same
thing).
The default mode under QNX Neutrino is different from that under QNX 4.
In the default -Munix mode, cp -r /bin /mydir/bin duplicates /bin in

/mydir/bin, i.e. the destination is /mydir/bin/bin and, for example, the file
/bin/sh is copied to /mydir/bin/bin/sh. This is analogous to the way the mv
utility treats destinations.
In -Mqnx mode, cp -Mqnx -r /bin /mydir/bin copies the contents of /bin to
/mydir/bin (so, for example, /bin/sh is copied to /mydir/bin/sh).
Examples:
Copy file1, file2, and file3 from the current working directory to the
/home/eric directory:
cp file1 file2 file3 /home/eric

Perform a backup of the entire contents of the home directory to floppy disks
(assuming that /f0 is a mountpoint for /dev/fd0), in the (default) UNIX
recursive-copy mode:
cp -rvp /home /f0

Do the same in QNX recursive-copy mode:
cp -Mqnx -rvp /home /f0/home

Recursively copy the /home/eric directory to the /home/ejohnson directory,
assuming /home/ejohnson doesn’t yet exist (this works in either -Munix or -Mqnx
mode):
cp -rv /home/eric /home/ejohnson

Do the same in -Mqnx mode if the directory ejohnson already exists:

cp -Mqnx -rv /home/eric /home/ejohnson

Do the same in -Munix mode if the directory ejohnson already exists:
cp -Munix -rv /home/eric/. /home/ejohnson

Recursively copy the contents of the current directory into /mydir/ in -Mqnx or
-Munix mode:
cp -Rpv . /mydir/
Do the same in -Munix mode only:
cp -Munix -Rpv * /mydir/
Using -Mqnx instead of -Munix in the previous example copies the contents of the
directories named on the command line into /mydir/ (i.e. the file ./bin/ls is
copied to /mydir/ls, and the directory ./usr/bin is /mydir/bin in the
destination).
Recursively copy the /home/eric directory to the /backups/eric directory:
cp -rv /home/eric /backups

Do the same in QNX-style recursive copy mode:
cp -Mqnx -rv /home/eric /backups/eric
Files:
Input files If you don’t specify the -r option, and you name only one source file,
that source file may be of any filetype.
If you specify the -r option, or there’s more than one source file, the
input files specified by each source_file operand, including those files
contained within named directories, must be either regular files, block
special files, or directories.
If you use the -R option, FIFOs are duplicated in the destination
directory structure, but contents of the source FIFOs aren’t copied. If
cp encounters any block special or character special files in the source
files, an error occurs, because cp can’t create them at the destination.
Output files Each newly created output file is one of the following:
• A directory that contains copies of the files and subdirectories — if
any — found in the input directory.
• A regular file that has the same contents as the corresponding input
file.
• A FIFO that was created because the corresponding input file was
a FIFO and you specified -R. The data from the original FIFO isn’t
copied into the new FIFO (i.e. the new FIFO is empty).

• A symbolic link that was created because the corresponding input

file was a symbolic link and you specified -R. The new symbolic
link references the same pathname as the original symbolic link.
If an existing destination names some other type of file, cp opens it
for writing and attempts to copy the contents of the corresponding
input file to it.
Environment variables:
POSIX_STRICT Affects whether file modification times are copied, and, if set
on, causes the QNX Neutrino extension options to be disabled.
The setting of the POSIX_STRICT environment variable
affects the -p and -t options, as follows:
POSIX_STRICT Option Action

Set Neither -p nor -t If the destination doesn’t exist, duplicate the mode only.
Set -p Duplicate the time and mode; if run by root, also duplicate the user ID
and group ID.
Set -pt If run by root, duplicate the user ID and group ID.
Set -t If destination doesn’t exist, duplicate the mode only.
Unset Neither -p nor -t Duplicate the time and mode.
Unset -p Duplicate the time and mode; if run by root, also duplicate the user ID
and group ID.
Unset -pt If run by root, duplicate the user ID and group ID.
Unset -t If destination doesn’t exist, duplicate the mode only.
Exit status:
0 All input files were copied successfully.
Caveats:
If cp is copying multiple files or doing a recursive copy, but you didn’t specify the -R
option, cp refuses to copy FIFO and character special files.
If you specify the -R option, and cp attempts but fails to copy a particular file in a
specified file hierarchy, it continues to process the remaining files in the hierarchy.

See also:
mv, ln, pax

cpio © 2010, QNX Software Systems GmbH & Co. KG.
Copy file archives in and out (UNIX)
Syntax:
Read/list an archive:
cpio -i[Bcdfmrtuv] [pattern...]
Write an archive:
cpio -o[Bacv]
Copy files:
cpio -p[adlmruv] directory
Runs on:
Options:
-a Reset access times of input files after they’ve been copied. When the -l
option is also specified, the access times of linked files aren’t reset. You
can use this option only with the -o or -i options.
-B Cause input/output to be blocked 5120 bytes to the record. You can use
this option only with the -o or -i options for data directed to or from
character special files.
-c Write header information in ASCII (Default; option present for

compatibility)
-d Create directories as needed. You can use this option only with the -i or
-p options.
-f Copy in all files except those in patterns. You can use this option only
with the -i option.
-i Copy in. (Extract files from an archive being read from standard input.)
-l (“el”) Whenever possible, link files rather than copy them. You can use
this option only with the -p option.
-m Retain previous modification times. This option won’t work on

directories that are being copied. You can use this option only with the
-i or -p options.
-o Copy out. (Write an archive to standard output.)
-p Pass. Conditionally copy files from a list read from standard input to the
destination directory named as an argument to cpio.

© 2010, QNX Software Systems GmbH & Co. KG. cpio
-r Interactively rename files. A new name for each file is requested from
the user. Read and write permissions for the controlling terminal
(/dev/tty) are required for this option. If you type a null line, the file
is skipped. You should use this option only with the -i or -o options.
-t Print a table of contents of the input. No files are created. You can use
this option only with the -i option.
-u Copy files unconditionally. Usually an older file doesn’t replace a new
file with the same name. You can use this option only with the -i or -p
options.
-v Be verbose. Print the names of the affected files. You can use this option
only with the -i option. It provides a detailed listing when used with the
-t option.
pattern Simple regular expression given in the name-generating notation of the

shell.
directory The destination directory.
Description:
The cpio utility produces and reads files in the format specified by the POSIX cpio
Archive/Interchange File Format. It operates in three modes.
The -i mode (copy in) extracts files from the standard input, which is assumed to be
the product of a previous cpio -o. Only files with names that match patterns are
selected. Multiple patterns may be specified. If no patterns are specified, the default
for patterns is to select all files. The extracted files are conditionally created and
copied into the current directory, and possibly any levels below, based on the options
used. The permissions of the files are those stored by the previous cpio -o
invocation. The owner and group of the files are that of the current user unless the user
has appropriate privileges, which causes cpio to retain the owner and group of the
files stored by the previous cpio -o invocation.
The -o mode writes the archive to the standard output.
The -p mode (pass) reads the standard input to obtain a list of pathnames of files that
are conditionally created and copied into the destination directory based upon the
options used.
If an error is detected, the cause is reported and the cpio utility continues to copy
other files. The utility skips over any unrecognized files encountered in the archive.
The following restrictions apply to the cpio utility:
• Pathnames are restricted to 256 characters.
• Appropriate privileges are required to copy special files.
• Blocks are reported in 512-byte quantities.
• Leading slashes (/) are stripped when files are extracted from an archive.

cpio © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Copy out the files listed by the ls utility and redirect them to the file archive:
ls | cpio -o >archive
Use the output file archive from the cpio -o utility, extract those files that match
the patterns memo/al and memo/b*, create the directories below the current directory,
and place the files in the appropriate directories:
cpio -id "memo/al" "memo/b*" <archive
Take the filenames piped to cpio from the find utility and copy or link those files to
another directory named newdir, while retaining the modification time:
find . -depth -print | cpio -pdlmv newdir
Exit status:
0 All input files were copied.
2 The utility encountered errors in copying or accessing files or directories. An

error is reported for nonexistent files or directories or for permissions that don’t
allow the user to access the source or target files.
Caveats:
When cpio restores a directory, it matches the permissions of the directory created to
those of the original. If that directory lacks write permission, any attempt to copy
additional files under that directory fails. To get around this, save the files under a
directory first before the directory itself. If find is used to generate pathnames for
cpio, the -depth option should be supplied to find.
Note also that the controlling terminal (/dev/tty) is used to prompt the user for
information when the -i or -r options are specified.
See also:
cp, find, pax, tar

© 2010, QNX Software Systems GmbH & Co. KG. cron
Clock server (UNIX)
Syntax:
cron [-d crondir] [-s] [-v] &
Runs on:
Neutrino
Options:
-d crondir Use the named directory instead of /var/spool/cron.
-s Poll for jobs every minute (to compensate for clock skew).
-v Turn on verbose mode. Log and diagnostic messages are written to

standard error as cron operates.
Description:
The cron server schedules commands to be run at specified times, without user
intervention. This server supports user-specific cron entries, and runs continuously.
The server must be run in the background.
The cron server assumes it has sole use of the /var/spool/cron directory.
Therefore, you can run only one cron server per filesystem containing that directory.
You typically run the cron server on the network server.
Commands are specified by instructions found in crontab files, which you can access
via the crontab utility.
To minimize overhead, cron examines the contents of the files in
/var/spool/cron/crontabs when it first comes up, and then reexamines only
those that have been changed via the crontab utility.
Files:
Errors cause diagnostic messages to be written to standard error. If you specify -v, log
messages are written to the standard error.
The cron utility uses data read from the following:
/var/spool/cron
Each cron command assumes it has exclusive use of this directory.
/var/spool/cron/cron.allow
If present, this file lists the only users authorized to have their crontab run. By
default, all users are authorized. The cron.deny list (below) overrides the
setting of the cron.allow list.

cron © 2010, QNX Software Systems GmbH & Co. KG.
/var/spool/cron/cron.deny
If present, this file lists users who aren’t authorized to have their crontab run.
This list overrides the list of users authorized (the cron.allow file).
/var/spool/cron/crontabs/*
The periodic commands to be run are read out of files found in this directory.
Exit status:
The cron utility normally runs indefinitely. However, it terminates early if errors are
encountered in startup, errors are encountered in reading the crontabs files, or if it’s
terminated by a signal.
0 cron was successfully and cleanly terminated by a SIGTERM or SIGPWR

signal.
>0 An error occurred. A diagnostic message will have been written to standard
error.
See also:
crontab

© 2010, QNX Software Systems GmbH & Co. KG. crontab
Schedule periodic background work (POSIX)
Syntax:
crontab [-d cron_dir] [-u user] [file]
crontab [-d cron_dir] [-e | -l | -r] [-u user]
Runs on:
Neutrino
Options:
-d cron_dir The location of the crontab directory.
-e Edit a user’s crontab entry. If you don’t specify the -u option,

crontab edits your own entry. It uses vi unless the EDITOR
environment variable names another editor.
-l (“el”) List the crontab entry of the user. Without the -u option, the
invoking user’s entry is listed.
-r Remove a user’s crontab entry. Without the -u option, the invoking

user’s entry is removed.
-u user Specify the user whose crontab is to be acted upon. When submitting
a crontab, the new crontab entry replaces or creates that user’s
crontab. When removing (-r) or listing (-l) existing crontabs, this
specifies which user’s crontab to remove or list. Only root may use
this option.
file The pathname of a file that contains specifications for crontab

entries (see the Description section for the format for these
specifications). If no file is specified, crontab uses the standard
input.
Description:
The crontab utility creates or replaces a user’s crontab entry. You can input the new
crontab entry by specifying a file that contains specifications for crontab entries. If you
don’t specify a file, the standard input is used.
This utility needs to have the setuid (“set user ID”) bit set in its permissions. If you use
mkefs, mketfs, or mkifs on a Windows host to include this utility in an image, use
the perms attribute to specify its permissions explicitly, and the uid and gid
attributes to set the ownership correctly.
Users may use crontab if their names appear in the

/var/spool/cron/cron.allow file. If that file doesn’t exist, the file
/var/spool/cron/cron.deny is checked to determine whether the user should be
denied access to crontab. If neither file exists, only the superuser is allowed to

crontab © 2010, QNX Software Systems GmbH & Co. KG.
modify crontab entries. If cron.allow doesn’t exist and cron.deny exists and is
empty, then global usage is allowed. These permission files consist of one user name
per line.
Each command you specify is executed from your home directory using the shell
(/bin/sh). The cron utility supplies a default environment for the shell, defining
HOME, LOGNAME, SHELL(=/bin/sh), PATH (=:/bin:/usr/bin) and TZ.
Users who want to have their .profile executed must explicitly do so in their
crontab entry.
A crontab entry consists of lines of six fields each. The fields are separated by
blanks. The first five are integer patterns that specify the following:
• minute (0-59)
• hour (0-23)
• day of the month (1-31)
• month of the year (1-12)
• day of the week (0-6 with 0=Sunday)
Each of these patterns can be an asterisk (meaning all valid values), an element, a list
of elements separated by commas, or a range separated by a hyphen (-).
An element is either a number or two numbers separated by a hyphen (meaning an
inclusive range). You can specify days by two fields (day of the month and day of the
week). If both are specified, both are adhered to.
As an example of specifying the two types of days, the following line:
0 0 1,15 * 1
runs a command at 00:00h on the first and fifteenth of each month, as well as at 00:00h
on every Monday. To specify days with only one field, the other field should be set to
*. For example:
0 0 * * 1
runs a command only on Mondays.

The sixth field of a line in a crontab entry is a string that is executed by the command
interpreter at the specified times. A percent character in this field — unless escaped by
a backslash — is translated to a newline character.
Only the first line (up to a % or end-of-line) of the command field is executed by the
command interpreter.
Sample crontab entries

Invoke the calendar program each day one minute after midnight:
1 0 * * * calendar -

© 2010, QNX Software Systems GmbH & Co. KG. crontab
Display the current time on the system console every 20 minutes:
1,21,41 * * * * (echo -n " "; date; echo) > /dev/con1
Clean up the UUCP work directories each weekday at 5:30 am:
30 5 * * 1-5 /usr/lib/uucp/uuclean
Remove any files under /tmp that haven’t been modified in more than seven days:
0 4 * * * find /tmp -mtime +7 -exec rm -f {} \;
If you want the output from your commands, redirect it to a file.
Examples:
List your own crontab entry:
crontab -l
Files:
When an error occurs, a diagnostic message is written to the standard error.
The standard input may be read for the content of crontab files when they are being
created (none of -e, -l or -r are specified) and no file is specified on the command
line.
When a crontab file is being edited, the editor invoked by crontab inherits
crontab’s standard input, standard output, and standard error.
The following files relative to one of /var/spool/cron, or the directory named in
the -d option are used by crontab:
cron.allow If this file exists, it is read by crontab to determine the

exclusive list of userids who are allowed to schedule cron
jobs.
cron.deny If cron.allow doesn’t exist, crontab reads this file to

determine a list of userids who are NOT allowed to schedule
cron jobs.
crontabs/userid The crontab utility may create, edit, list or remove this file.
Exit status:

crontab © 2010, QNX Software Systems GmbH & Co. KG.
Caveats:
If you inadvertently enter the crontab utility with no argument, don’t try to get out
by typing Ctrl-D (end-of-file), since this would replace your crontab file with an empty
file. In this case, you should exit by typing your interrupt character, which is typically
Ctrl-C.
See also:
cron

© 2010, QNX Software Systems GmbH & Co. KG. ctags
Generate tags files (POSIX)
Syntax:
ctags options files...
Runs on:
Options:
-a Append to the tags file, instead of overwriting it.
-B Use ?regexp? instead of /regexp/.
-Dword Ignore word. This is handy for parameter macro names.
-e Include extern tags.
-F Use /regexp/ (the default).
-h Add hints to help elvis distinguish between overloaded tags.
-i Include inline definitions.
-l (“el”) Add a ln line number hint (implies -h).
-N Use line numbers instead of /regexp/.
-p Write parsing information to stdout (for debugging ctags).
-r Write a refs file, in addition to tags.
-s Include static tags.
-t Include typedefs.
-v Include variable declarations.
-x Write a cross-reference table to stdout instead of to the tags file.
files The pathnames of the files that are to be scanned for tags.
Description:
The ctags utility generates a file called tags from a group of C source files.
Each C source file is scanned for #define statements and function definitions. The
name of the macro or function becomes the name of a tag. For each tag, a line is added
to the tags file, which contains:
• the name of the tag
• a tab character
• the name of the file containing the tag

ctags © 2010, QNX Software Systems GmbH & Co. KG.
• a tab character
• a way to find the particular line within the file
If you don’t specify any options, ctags uses -l -i -s -t -v.

The elvis, less, more, and vi utilities can use entries in the tags file to locate and
display a definition.
Examples:
Generate tags for all the C source and header files in the current directory:
ctags *.[ch]
Steve Kirkendall; ctags is part of the elvis suite.
See also:
elvis, less, more, vi

© 2010, QNX Software Systems GmbH & Co. KG. cut
Cut out selected fields of each line of a file (POSIX)
Syntax:
cut -b list [-n] [file...]
cut -c list [file...]
cut -f list [-d delim] [-s] [file...]
Runs on:
Neutrino
Options:
-b list Cut out the bytes found in the byte positions specified by list.
-c list Cut out the characters found in the character positions specified by list.
For example, a list of -c 1-64 outputs the first 64 characters of each
line.
-d delim Use the delimiter specified by delim (default is tab).
-f list Cut out the fields specified by list. For example, -f 2,9 outputs the
second and ninth fields. The fields described by list are assumed to be
separated in the file by a delimiter character (see option -d). Lines
without field delimiters are passed through intact, unless -s is specified.
-n Don’t split multi-byte characters. Characters are output only if at least
one byte is selected, and, after a prefix of zero or more unselected bytes,
the rest of the bytes that form the character are selected.
-s If -f is specified, suppress lines with no field delimiters.
file The pathname of a text file, whose contents are used instead of the
standard input.
Description:
For every file you name, the cut utility cuts out columns or fields from each line,
concatenates them, and writes them to the standard output.
If the fields are of a fixed length, you can select them by the byte or character position
with option -b or -c. If, however, the fields vary in length from line to line, you can
select them with the -f option, provided they’re separated by a delimiter character. By
default, cut assumes the field delimiter character to be tab. You can use the -d option
to specify another delimiter.
In options -b, -c, and -f, list is a comma-separated list of integers (in increasing
order), with an optional dash (-) to indicate ranges.
You can use the cut utility as a filter; if no files are given, the standard input is used.

cut © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
The following are examples of the list argument:
list argument: Meaning:

1,4,7 Select the first, fourth, and seventh characters or fields.
1-3,8 Equivalent to 1, 2, 3, 8.
-5,10 Equivalent to 1, 2, 3, 4, 5, 10.
3- Equivalent to the third through last.
Map userids to names:
cut -d: -f1,5 /etc/passwd
List filenames and their permissions:
ls -l | cut -c57-79,56,56,1-11
Exit status:
See also:
grep, join, paste

© 2010, QNX Software Systems GmbH & Co. KG. cvs
Concurrent version-control system
Syntax:
cvs [ global_options ] cmd [ cmd_options ] [ args ]
Runs on:
Options:
The global_options are:
--allow-root=rootdir
Specify the legal CVSROOT directory (server only).
-a Authenticate all communication (client only).
-b Specify RCS location (CVS 1.9 and older).
-d root Specify the CVSROOT.
On Windows, cvs checks for environment variables in this order:

1 HOME
2 HOMEDRIVE
3 HOMEPATH
If these are not set, you won’t be able to access :pserver: repositories.
-eeditor Edit messages with editor.
-f Don’t read the ‘˜/.cvsrc’ file.
-H
--help Print a help message.
-l Don’t log in CVSROOT/history file.
-n Don’t change any files.
-Q Be really quiet.
-q Be somewhat quiet.
-r Make new working files read-only.
-s variable=value Set a user variable.
-T tempdir Put temporary files in tempdir.
-t Trace CVS execution.

cvs © 2010, QNX Software Systems GmbH & Co. KG.
-v
--version Display version and copyright information for CVS.
-w Make new working files read-write.
-x Encrypt all communication (client only).
-z gzip-level Set the compression level (client only).
Description:
CVS is a concurrent version-control system that you can use to keep track of source
files. The cvs commands, command options, and command arguments are
summarized below; for more information, see Version Management with CVS by Per
Cederqvist et al.
add
add [options] [files...]
Add a new file or directory. The options include:
-k kflag Set keyword expansion. See “Keyword substitution,” below.

-m msg Set the file description.
admin
admin [options] [files...]
Administration of history files in the repository. The options include:
-b[rev] Set the default branch.

-cstring Set the comment leader.
-ksubst Set keyword substitution. See “Keyword substitution,” below.
-l[rev] Lock revision rev, or the latest revision.
-mrev:msg Replace the log message of revision rev with msg.
-orange Delete revisions from the repository.
-q Run quietly; don’t print diagnostics.
-sstate[:rev] Set the state.
-t Set the file description from standard input.
-tfile Set the file description from file.
-t-string Set the file description to string.
-u[rev] Unlock revision rev, or the latest revision.

annotate
annotate [options] [files...]
Show the last revision where each line was modified. The options include:
-D date Annotate the most recent revision no later than date.
-f Use the head revision if the specified tag or date isn’t found.
-l Local; run only in the current working directory.
-R Operate recursively (default).
-r tag Annotate revision tag.
checkout
checkout [options] modules...
Get a copy of the sources. The options include:
-A Reset any sticky tags/date/options.
-c Output the module database.
-D date Check out revisions as of date (is sticky).
-d dir Check out into dir.
-f Use the head revision if the specified tag or date isn’t found.
-j rev Merge in changes.
-k kflag Use kflag keyword expansion. See “Keyword substitution,” below.
-N Don’t shorten module paths if -d is specified.
-n Don’t run the module program (if any).
-P Prune empty directories.
-p Check out files to standard output (avoids stickiness).
-r tag Checkout revision tag (is sticky).
-s Like -c, but include module status.

commit
commit [options] [files...]
Check changes into the repository. The options include:
-F file Read the log message from file.
-f Force the file to be committed; disables recursion.
-l Local; run only in current working directory.
-m msg Use msg as the log message.
-n Don’t run the module program (if any).
-r rev Commit to rev.
diff
diff [options] [files...]
Show differences between revisions. In addition to the options shown below, diff
accepts a wide variety of options to control output style, for example ‘-c’ for context
diffs.
The options include:
-D date1 Diff revision for date against working file.
-D date2 Diff rev1/date1 against date2.
-N Include diffs for added and removed files.
-r rev1 Diff revision for rev1 against the working file.
-r rev2 Diff rev1/date1 against rev2.
edit
edit [options] [files...]
Get ready to edit a watched file. The options include:
-a actions Specify actions for temporary watch, where the actions argument is
edit, unedit, commit, all, or none.

editors
editors [options] [files...]
See who’s editing a watched file. The options include:
export
export [options] modules...
Export files from CVS. The options include:
-D date Check out revisions as of date.
-d dir Check out into dir.
-f Use head revision if the tag or date isn’t found.
-N Don’t shorten module paths if -d is specified.
-n Don’t run the module program (if any).]
history
history [options] [files...]
Show repository access history. The options include:
-a All users (default is self).
-b str Back to record with str in module/file/repos field.
-c Report on committed (modified) files.
-D date Since date.
-e Report on all record types.
-l Last modified (committed or modified report).
-m module Report on module (repeatable).
-n module In module.

-o Report on checked out modules.
-r rev Since revision rev.
-T Produce report on all tags.
-t tag Since tag record placed in history file (by anyone).
-u user For user user (repeatable).
-w Working directory must match.
-x types Report on types, one or more of TOEFWUCGMAR.
-z zone Output for time zone zone.
import
import [options] repository vendor-tag release-tags...
Import files into CVS, using vendor branches. The options include:
-b bra Import to vendor branch bra.
-d Use the file’s modification time as the time of import.
-k kflag Set default keyword substitution mode. See “Keyword substitution,”

below.
-m msg Use msg for log message.
-I ign More files to ignore (! to reset).
-W spec More wrappers.
init
init
Create a CVS repository if it doesn’t exist.
log
log [options] [files...]
Print out history information for files. The options include:
-b List only revisions on the default branch.
-d dates Specify dates (d1<d2 for range, d for latest before).
-h Print only the header.
-N Don’t list tags.

-R Print only the name of the RCS file.
-rrevs List only revisions revs.
-s states List only revisions with the specified states.
-t Print only the header and descriptive text.
-wlogins List only revisions checked in by specified logins.
login
login
Prompt for password for authenticating server.
logout
logout
Remove stored password for authenticating server.
rdiff
rdiff [options] modules...
Show differences between releases. The options include:
-c Context diff output format (default).
-D date Select revisions based on date.
-f Use the head revision if the tag or date wasn’t found.
-r rev Select revisions based on rev.
-s Short patch — one line per file.
-t Top two diffs — last change made to the file.
-u Unidiff output format.
-V vers Use RCS Version vers for keyword expansion (obsolete).
release
release [options] directory
Indicate that a directory is no longer in use. The options include:
-d Delete the given directory.

remove
remove [options] [files...]
Remove an entry from the repository. The options include:
-f Delete the file before removing it.
rtag
rtag [options] tag modules...
Add a symbolic tag to a module. The options include:
-a Clear the tag from removed files that would not otherwise be tagged.
-b Create a branch named tag.
-D date Tag revisions as of date.
-d Delete the given tag.
-F Move the tag if it already exists.
-f Force a head revision match if the tag/date wasn’t found.
-n No execution of tag program.
-r tag Tag the existing tag tag.
status
status [options] files...
Display status information in a working directory. The options include:
-v Include tag information for file.

tag
tag [options] tag [files...]
Add a symbolic tag to checked out version of files. The options include:
-b Create a branch named tag.
-D date Tag revisions as of date.
-d Delete the given tag.
-F Move the tag if it already exists.
-f Force a head revision match if the tag/date wasn’t found.
-n No execution of tag program.
-r tag Tag the existing tag tag.
unedit
unedit [options] [files...]
Undo an edit command. The options include:
-a actions Specify actions for temporary watch, where the actions argument is
edit, unedit, commit, all, or none.
update
update [options] [files...]
Bring the work tree into sync with the repository. The options include:
-A Reset any sticky tags/date/options.
-D date Check out revisions as of date (is sticky).
-d Create directories.
-f Use the head revision if the tag/date wasn’t found.
-I ign More files to ignore (! to reset).
-j rev Merge in changes.

-p Check out files to standard output (avoids stickiness).
-W spec More wrappers.
watch
watch [on|off|add|remove] [options] [files...]
For on/off, turn on/off read-only checkouts of files. For add/remove, add or remove
notification on actions. The options include:
-a actions Specify actions for temporary watch, where actions is edit, unedit,
commit, all, or none.
watchers
watchers [options] [files...]
See who’s watching a file. The options include:
Keyword substitution
Keyword expansion modes:
-kkv $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp $
-kkvl $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
-kk $Id$
-kv file1,v 1.1 1993/12/09 03:21:13 joe Exp
-ko No expansion.
-kb No expansion; file is binary.
Keywords:

$Author: joe $
$Date: 1993/12/09 03:21:13 $
$Header: /home/files/file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
$Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
$Locker: harry $
$Name: snapshot_1_14 $
$RCSfile: file1,v $
$Revision: 1.1 $
$Source: /home/files/file1,v $
$State: Exp $
$Log: file1,v $
Revision 1.1 1993/12/09 03:30:17 joe
Initial revision
Per Cederqvist et al, Version Management with CVS
Copyright (C) 1992, 1993 Signum Support AB
Permission is granted to make and distribute verbatim copies of this manual provided
the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this manual under
the conditions for verbatim copying, provided also that the entire resulting derived
work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual into another
language, under the above conditions for modified versions, except that this permission
notice may be stated in a translation approved by the Free Software Foundation.
See also:
Using CVS in the Neutrino User’s Guide
Per Cederqvist et al, Version Management with CVS, available at
http://www.loria.fr/˜molli/cvs-index.html

© 2010, QNX Software Systems GmbH & Co. KG. date
Display or set the date and time (POSIX)
Syntax:
Display the date and time:
date [-tuv] [-s seconds] [+format]
Set the date and time:
date [-uv] [-S seconds] date
Runs on:
Options:
-S seconds Set the maximum number of seconds (of real time) over which date
is to adjust the time. The date utility doesn’t increase the clock speed
by more than 100% or decrease it by more than 50%. If date can’t do
a slow adjustment within those constraints, the time is changed
immediately. (The default is 300 seconds; use -S0 to disable the
gradual adjustment.)
-s seconds Display the string equivalent of this date, supplied as seconds since the
start of the Epoch (00:00 January 1, 1970). This value is used instead
of the system time value for the number of seconds.
-t Display the current operating system time, in seconds since the start of
the Epoch, as a long integer.
-u Perform operations using Coordinated Universal Time (UTC) instead

of local time. UTC is the standard term for Greenwich Mean Time
(GMT).
-v Be verbose.
date A date specification to set the date to. Only the superuser (root) can
change the date. For more information, see “Setting the date,” below.
+format The format in which the date and time are to be displayed.
Description:
The date utility is used to display and set the current system date and time in
software. Only the superuser (root) may use date to set the time.

date © 2010, QNX Software Systems GmbH & Co. KG.
Displaying the date

The date utility normally displays the current date and time according to the
operating system’s internal time, maintained in software as the number of seconds
since the Epoch (00:00 January 1, 1970). When the -s seconds option is used, date
uses the value specified by the seconds argument instead of the current OS time.
You can specify the format and content of the displayed date and time with the
+format option. The format is composed of ASCII characters and field descriptors
prefaced with %, in a manner similar to a C-language printf() format specifier (the
specific characters used to specify field types are, however, completely different). In
the output, each field descriptor is replaced by its corresponding value; all other
characters are copied to the output without change.
This utility uses strftime(), a libc library function, to format the time into a string.
For a complete list of the field descriptors you can use in the +format option, see
strftime() in the Library Reference.
The date utility always terminates its output with a newline character.
Setting the date

If you’re a system administrator running as root, you may use date to set the system
time. To set the hardware clock to match the current system time set by date, you
should use the rtc utility.
Be careful if you set the date during the period that a time zone is switching from
daylight saving time to standard time. When a time zone changes to standard time, the
local time goes back one hour (for example, 2:00 a.m. becomes 1:00 a.m.). The local
time during this hour is ambiguous (e.g. 1:14 a.m. occurs twice in the morning that the
time zone switches to DST). To avoid problems, use UTC time to set the date in this
period.
By default, if the new time is in the range of:

(-2.5 minutes + old time, 5 minutes + old time)
the date utility makes a “slow adjustment” — it increases the clock speed by less than
100% or decreases the clock speed by less than 50% over a period of time from 1
second to 5 minutes until the clock catches up with the new time. This slow
adjustment doesn’t cause major discontinuities in the time flow. You can disable the
slow adjustment by using the -S0 option.
The date utility recognizes three formats for setting the time:
1 [[[CC]YY]MM]DD]hhmm[.SS]
2 MMDDhhmm[YY]
3 DD [Month [[CC]YY [hh [mm [SS]]]]] [am|pm]

Where:
CC Century (e.g. 19 if the year is 1997)
YY Year modulo 100 (e.g. 97 if the year is 1997)
MM Numerical month of the year (01 for January, 02 for February, etc.)
Month Either the numerical month (1, 2,...12) or the standard English
abbreviation for the month (jan, feb,...dec)
DD Day of the month
hh Hour of the day
mm Minute of the hour
SS Seconds of the minute
am|pm Literally am or pm; you can combine them with hour values less than 13 if
you don’t want a 24-hour clock
Format 1 is compatible with the touch utility. Since each field is two digits, you must
specify a leading 0 for single-digit numbers. You should find this format particularly
useful for adjusting the time of day, since its minimal form is just hhmm (hour and
minute).
Format 2 follows the UNIX System V date conventions. It’s similar to the Format 1,
with the month and day specified, but the year is optional at the end of the
specification instead of the beginning. If there’s a dot (.) in the date, date assumes
the date is Format 1 instead of Format 2. The date utility also differentiates between
MMDDhhmmYY (Format 2) and YYMMDDhhmm (Format 1) by the value of the first
pair of digits. The years 00-12 are before the Epoch. Therefore, if the first pair of
digits is in that range, the date is treated as it is in Format 1.
Format 3 follows the date convention used in QNX 4.00 and earlier. This format is
assumed if there’s more than one operand (the other two formats consist of a single
string of digits), or if there’s just one number that’s two or fewer digits in length.
If you change the date or time, date adds a a line to the /var/log/wtmp if it already
exists.
The date utility doesn’t create /var/log/wtmp if it doesn’t already exist. This file
can quickly become very big, which isn’t good on an embedded system with limited
resources.

date © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Display the date and time on separate lines:
$ date "+DATE: %m/%d/%y%nTIME: %H:%M:%S"

DATE: 01/20/99
TIME: 08:51:59
Display the time in 12-hour format:
$ date "+TIME: %r"

TIME: 01:36:32 PM
Set the system date to 22 February 1997:
date 22 2 97
Set the system date and time to 16 May 1997, 4:30 pm:
date 16 may 1997 4 30 pm
Adjust the system time to 4:34 pm; use today’s date:
date 1634
The following command, which illustrates the use of date -s, displays the date of
the last entry in the /usr/adm/syslog file (in this file, the first column of each
record is the time in seconds since the Epoch):
$ date -s ‘tail -n1 /usr/adm/syslog | cut -f1 -d ’ ’‘

Wed Apr 15 14:25:49 EDT 1997
For more information, see cut, logger, and tail.
Files:
/var/log/wtmp If you change the data or time, and this file already exists, an
entry is added to it to log the change.
TZ Specifies the local time zone. The value of TZ affects the conversion between
the system clock (UTC) and the local time.
Exit status:
0 The date was displayed or set successfully.

Caveats:
Some field descriptors are of unspecified format when not in the POSIX locale. As a
result, parsing the output of date may be difficult in other locales. QNX Neutrino
currently supports only the POSIX (i.e. C) locale.
See also:
phlocale, rtc, uptime
strftime() in the Library Reference

dcheck © 2010, QNX Software Systems GmbH & Co. KG.
Check a disk for bad blocks (QNX 4, QNX Neutrino)
Syntax:
dcheck [options] drive
Runs on:
Neutrino
Options:
-B max_blks The maximum number of blocks to read at a time; max_blks can be
up to 32 (the default).
-b blk_cnt The maximum number of blocks to check.
-f first_blk The first block to check.
-L loops Loop as in the -l option, but with a specified number of loops.
-l (“el”) Loop until input (switching serial/random).
-m In the bitmap, mark bad blocks as unavailable.
-q Be quiet; don’t display progress information.
-r Use a random head-movement algorithm.
-V Verify write after read.
-v Be verbose; display every bad block on the disk.
-w Write after read (nondestructive) check.
drive The name of the disk (e.g. /dev/fd0, /dev/hd0t77) or the root of
the filesystem.
Description:
The dcheck utility verifies that a disk has been correctly formatted, by attempting to
read every block on the drive. The block numbers of any blocks that can’t be read are
displayed (in hex) to standard output. A summary of the total number of bad blocks is
also displayed. You can use dcheck to check any formatted disk, including disks that
contain files. The files aren’t damaged.
If you don’t specify the number of blocks to verify, dcheck obtains this information
from the filesystem and checks all the blocks on the specified drive.
If a disk has been initialized for a QNX 4 filesystem, you should use the -m option to
remove any bad blocks from the disk-allocation bitmap (/.bitmap). This is
especially true for hard disks. When you specify the -m option, dcheck attempts to
read the file /.bad_blks from the disk. This file contains a list of all known bad

© 2010, QNX Software Systems GmbH & Co. KG. dcheck
blocks, in sorted order. If /.bad_blks is found, dcheck reads it, and when it’s
finished checking the disk, dcheck updates the bitmap and recreates the /.bad_blks
file. Note that the dcheck utility only adds to, but never removes, bad block
information in this file.
Some blocks may be marginal, so if you run dcheck multiple times (see the -l and
-L options), you can increase the chance of recognizing these blocks and adding them
to the /.bad_blks file.
The chkfsys utility also recognizes the /.bad_blks file.
To help you find any marginal blocks, dcheck has a number of options to provide
additional checking of a disk. For example, the -r option checks the blocks in a
random order; each check consists of a random number of blocks between 1 and 32 (or
less, depending on the value specified in the -B option). The dcheck utility keeps
track of the checked blocks and checks each one only once. This option allows you to
find blocks that are bad due to a slight lag time in head movement.
The -l option makes dcheck continuously check the disk until you stop it. For this
option, -r is implicitly used and is toggled for each invocation. That is, for the first
loop, random checking is set on; for the second loop, it is off, etc. At the end of each
complete check, you’re prompted to stop the loop. If you don’t stop it within 15
seconds, dcheck is started again, etc. The -L option is identical to -l with an upper
limit to the number of loops.
The -w option makes dcheck rewrite each block on the device after reading it. This is
a nondestructive check that tests the write portion of the hardware. Note that, although
this is a more thorough test, it takes more time, depending on the hardware.
The -V option is similar to the -w option, in that dcheck rewrites each block after
reading it, but in this case dcheck also rereads each block after the rewrite check and
compares this second read with the first. Like the -w option, this test is nondestructive.
Note, however, that this is a more thorough test that takes longer.
Examples:
Check all blocks on the hard disk and mark bad blocks in the bitmap:
dcheck -m /
Check the first 640 blocks on the floppy disk:
dcheck -b 640 /dev/fd0
Check all blocks on the hard disk:
dcheck /dev/hd0t77

dcheck © 2010, QNX Software Systems GmbH & Co. KG.
Files:
If you specify the -m (mark bad blocks) option, the block-special file being checked
must be a currently mounted QNX partition. The .bad_blks and .bitmap files on
that filesystem are updated if dcheck discovers any bad blocks.
Exit status:
0 No bad blocks were found.
>0 An error occurred, or bad blocks were found.
Caveats:
The dcheck utility normally opens the disk in read-only mode. However, if you
specify the -m, -w, or -V option, the disk is opened in read/write mode. For read/write
access, there must be no open files on the disk, or else dcheck fails with a “Device or
resource busy” message. While dcheck is working in read/write mode, no other
utilities or programs is allowed to access the disk.
When using the -m option, if dcheck is terminated by a SIGBREAK or other signal,
any pending bad blocks may not be recorded. In any event, the results are
nondestructive.
See also:
chkfsys, dinit, fdformat, io-blk.so

© 2010, QNX Software Systems GmbH & Co. KG. dd
Convert a file while copying it (UNIX)
Syntax:
dd [if=input_file] [of=output_file] [options]
Runs on:
Neutrino
Options:
if=input_file Read from input_file instead of the standard input.
of=output_file Write to output_file instead of the standard output. Unless

conv=notrunc is given, truncate the file to the size specified by
seek= (0 bytes if seek= isn’t given).
ibs=bytes Read bytes bytes at a time.
obs=bytes Write bytes bytes at a time.
bs=bytes Read and write bytes bytes at a time. Override ibs and obs.
cbs=bytes Convert bytes bytes at a time.
skip=blocks Skip blocks ibs-sized blocks at start of input.
seek=blocks Skip blocks obs-sized blocks at start of output.
count=blocks Copy only blocks ibs-sized input blocks.
conv=conversion[,conversion...]
Convert the file as specified by the conversion arguments.
Conversions are:
ascii Convert EBCDIC to ASCII.

ebcdic Convert ASCII to EBCDIC.
ibm Convert ASCII to alternate EBCDIC.
block Pad newline-terminated records to size of cbs,
replacing newline with trailing spaces.
unblock Replace trailing spaces in cbs-sized block with
newline.
lcase Change uppercase characters to lowercase.
ucase Change lowercase characters to uppercase.
swab Swap every pair of input bytes. Unlike the UNIX dd,
this works when an odd number of bytes are read. If
the input file contains an odd number of bytes, the last
byte is simply copied (since there’s nothing to swap it
with).

dd © 2010, QNX Software Systems GmbH & Co. KG.
noerror Continue after read errors.

notrunc Don’t truncate the output file.
sync Pad every input block to size of ibs with trailing
NULs.
You can follow all numbers by a multiplier:
b Blocks (×512).
k Kbytes (×1024).
w Words (×2).
xm Multiply by m.
Description:
The dd utility copies a file (from the standard input to the standard output, by default)
with a user-selectable blocksize, while optionally performing conversions on it. It’s
meant for writing raw data directly to devices such as tape and disk or writing over the
network, with control over blocking factors and character set translations.
You can use this command for copying partial files. You can specify the block size,
skip count, and the number of blocks to copy. Sizes are in bytes by default; you can
append the letters w, b, or k to the number to indicate words (2 bytes), blocks (512
bytes), or K (1024 bytes). When dd is finished, it reports the number of full and partial
blocks read and written.
Examples:
Copy file file1 to file2, converting all text to lowercase letters:
dd if=file1 of=file2 conv=lcase
Exit status:
0 The copy and translation operation was successful.

© 2010, QNX Software Systems GmbH & Co. KG. dd
GNU
See also:
cat, cp, pax, head, tr

deflate © 2010, QNX Software Systems GmbH & Co. KG.
Compress files for flash filesystems
Syntax:
deflate [options] [filename]...
Runs on:
Options:
-b size The compression block size; one of 4K, 8K, 16K or 32K (default: 8K).
The K is assumed; you don’t need to specify it.
-o fname The output filename. A filename of - means standard output. By

default, deflate compresses the files in place.
-i Inflate files (default: deflate).
-t 1|2 The compression type; the default is 2. For a comparison of the types,
see below.
-v Be verbose; list information on each file as it’s compressed.
filename... The files to compress. If no files are given and the -i option is
specified, deflate reads from standard input and writes to standard
output, allowing it to be used as a filter.
Description:
The deflate utility compresses files for a flash filesystem. It’s intended to be used in
conjunction with the filter attribute for mkefs. It can also be used to precompress
files intended for a flash filesystem.
The compression types (specified with the -t option) are:
Type Compression Speed Decompression Speed Compression Amount

1 Fast Very fast 30% on executables
2 Slow Fast 45% on executables
Examples:
Deflate all executables that are to be placed on an embedded target:
deflate -v /target/bin/* /target/lib/*
Inflate a previously deflated file:

deflate -i deflated_file
Deflate a file without changing the input file:

© 2010, QNX Software Systems GmbH & Co. KG. deflate
deflate -o file.dfl file
See also:
devf-*, inflator

deva-ctrl-4dwave.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the Trident 4DWave
You must be root to start this driver.
Syntax:
Direct invocation (also causes a new io-audio process to start):
io-audio -d 4dwave [pci=xx] &
Mounting (requires that io-audio is already running):
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-4dwave.so &
Runs on:
Neutrino
Targets:
x86
Options:
pci xx The PCI index of the card you want to attach to. If this option is not
specified, the driver will attempt to find the first unused card in the system.
Description:
The deva-ctrl-4dwave.so shared object is a device driver DLL used by the
io-audio manager. It uses the API described in the Audio Developer’s Guide.
While deva-ctrl-4dwave.so is running, you can use applications with sound, and
those that control the sound-system (e.g. mixer).
Graphics drivers run at a higher priority than applications, but they shouldn’t run at a
higher priority than the audio, or else breaks in the audio occur. You can use the on
command to adjust the priorities of the audio and graphics drivers.
Examples:
Invoke deva-ctrl-4dwave.so directly from io-audio:
io-audio -d 4dwave &
Mount deva-ctrl-4dwave.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-4dwave.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-4dwave.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-4dwave.so sends a description of the error to the
system logger (see slogger).
See also:
io-audio, mixer
Audio Developer’s Guide

deva-ctrl-audiopci.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the AudioPCI chip family
Syntax:
io-audio -d audiopci [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-audiopci.so &
Runs on:
Neutrino
Targets:
x86, MIPS, and PPC
Options:
Description:
The deva-ctrl-audiopci.so shared object is a device driver DLL used by the
While deva-ctrl-audiopci.so is running, you can use applications with sound,
and those that control the sound-system (e.g. mixer).
Examples:
Invoke deva-ctrl-audiopci.so directly from io-audio:
io-audio -d audiopci &
Mount deva-ctrl-audiopci.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-audiopci.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-audiopci.so
Files:
deva-mixer-ac97.so or deva-mixer-ak4531.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-audiopci.so sends a description of the error to
the system logger (see slogger).
This utility is based on software contributed to The NetBSD Foundation
by Lennart Augustsson <augustss@netbsd.org> and Charles M. Hannum.
License:
This utility is based on software from The NetBSD foundation; for licensing
information, see the Third Party License Terms List at
See also:
io-audio, mixer

deva-ctrl-cs4281.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the CS4281
Syntax:
io-audio -d cs4281 [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-cs4281.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-cs4281.so shared object is a device driver DLL used by the
While deva-ctrl-cs4281.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-cs4281.so directly from io-audio:
io-audio -d cs4281 &
Mount deva-ctrl-cs4281.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-cs4281.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-cs4281.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-cs4281.so sends a description of the error to the
See also:
io-audio, mixer

deva-ctrl-ess1938.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the ESS1938
Syntax:
io-audio -d ess1938 [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-ess1938.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-ess1938.so shared object is a device driver DLL used by the
While deva-ctrl-ess1938.so is running, you can use applications with sound,
and those that control the sound-system (e.g. mixer).
Examples:
Invoke deva-ctrl-ess1938.so directly from io-audio:
io-audio -d ess1938 &
Mount deva-ctrl-ess1938.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-ess1938.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-ess1938.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-ess1938.so sends a description of the error to
See also:
io-audio, mixer

deva-ctrl-geode.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the National Semiconductor Geode family of chips
Syntax:
io-audio -d geode [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-geode.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-geode.so shared object is a device driver DLL used by the
While deva-ctrl-geode.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-geode.so directly from io-audio:
io-audio -d geode &
Mount deva-ctrl-geode.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-geode.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-geode.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-geode.so sends a description of the error to the
Caveats:
You need a current BIOS to run deva-ctrl-geode.so. The BIOS VSA (Virtual
System Architecture) technology must be sufficiently up-to-date to enable the native
audio programming techniques used by this driver. If the BIOS is too old,
deva-ctrl-geode.so will exit and slogger will contain the exit message.
See also:
io-audio, mixer

deva-ctrl-i8x0.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the Intel 8X0
Syntax:
io-audio -d i8x0 [pci=xx] &
Mounting (requires that io-audio already be running):
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-i8x0.so &
Runs on:
Neutrino
Targets:
x86
Options:
pci xx The PCI index of the card you want to attach to. If you don’t specify this
option, the driver attempts to find the first unused card in the system.
Description:
The deva-ctrl-i8x0.so shared object is a device driver DLL used by the
While deva-ctrl-i8x0.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-i8x0.so directly from io-audio:
io-audio -d i8x0 &
Mount deva-ctrl-i8x0.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-i8x0.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-i8x0.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-i8x0.so sends a description of the error to the
See also:
deva-mixer-ac97.so, io-audio, mixer

deva-ctrl-intel_hda.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the Intel High Definition Audio controllers
Syntax:
io-audio -d intel_hda [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-intel_hda.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-intel_hda.so shared object is a device driver DLL used by the
While deva-ctrl-intel_hda.so is running, you can use applications with sound,
and those that control the sound system (e.g. mixer).
Examples:
Invoke deva-ctrl-intel_hda.so directly from io-audio:
io-audio -d intel_hda &
Mount deva-ctrl-intel_hda.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-intel_hda.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-intel_hda.so
Files:
deva-mixer-hda.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-intel_hda.so sends a description of the error
to the system logger (see slogger).
See also:
deva-mixer-hda.so, io-audio, mixer

deva-ctrl-nmg6.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the NeoMagic 6 family of chips
Syntax:
io-audio -d nmg6 [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-nmg6.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-nmg6.so shared object is a device driver DLL used by the
While deva-ctrl-nmg6.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-nmg6.so directly from io-audio:
io-audio -d nmg6 &
Mount deva-ctrl-nmg6.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-nmg6.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-nmg6.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-nmg6.so sends a description of the error to the
See also:
deva-mixer-ac97.so, io-audio, mixer

deva-ctrl-sb.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Sound Blaster 16 and compatible sound cards.
Syntax:
io-audio -dsb ioport=port,irq=req,dma=ch,dma1=ch &
mount -Tio-audio -oioport=port,irq=req,dma=ch,dma1=ch \

/lib/dll/deva-ctrl-sb.so &
Runs on:
x86 only (requires ISA bus)
Options:
dma=ch The primary DMA channel to be used. The value of ch may be 0, 1,
3, 5, 6, or 7. The default value is 1.
dma1=ch The secondary DMA channel to be used. The value of ch may be 0,

1, 3, 5, 6, or 7. The default value is 0.
ioport=port Specifies the base I/O port for Sound Blaster commands. The value
of port is usually 0x220, 0x240, 0x260, or 0x280. The default
value is 0x220.
irq=req The interrupt request line specified by req cannot be shared. The
default value is 10.
Description:
The deva-ctrl-sb.so shared object is a DLL for the io-audio manager. It uses
the API described in the Audio Developer’s Guide.
While deva-ctrl-sb.so is running, you can use applications with sound, and those
that control the sound-system (e.g. mixer).

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-sb.so
Errors:
When an error occurs, deva-ctrl-sb.so sends a description of the error to the
Caveats:
Some sound cards listed as being Sound Blaster compatible default to another mode
(e.g. some ESS 18xx series (not ESS 1869), OPTi 931, Yamaha OPL3-SA). These
cards will not work with this driver.
See also:
io-audio, mixer Audio Developer’s Guide

deva-ctrl-via686.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the VIA686
Syntax:
io-audio -d via686 [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-via686.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-via686.so shared object is a device driver DLL used by the
While deva-ctrl-via686.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-via686.so directly from io-audio:
io-audio -d via686 &
Mount deva-ctrl-via686.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-via686.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-via686.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-via686.so sends a description of the error to the
See also:
io-audio, mixer

deva-ctrl-vortex.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the Aureal Vortex
Syntax:
io-audio -d vortex [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-vortex.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-vortex.so shared object is a device driver DLL used by the
While deva-ctrl-vortex.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-vortex.so directly from io-audio:
io-audio -d vortex &
Mount deva-ctrl-vortex.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-vortex.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-vortex.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-vortex.so sends a description of the error to the
Aureal Semiconductor Inc.
See also:
io-audio, mixer

deva-ctrl-ymfds1.so © 2010, QNX Software Systems GmbH & Co. KG.
Sound driver for the Yamaha DS1
Syntax:
io-audio -d ymfds1 [pci=xx] &
mount -Tio-audio [-opci=xx] /lib/dll/deva-ctrl-ymfds1.so &
Runs on:
Neutrino
Targets:
x86
Options:
Description:
The deva-ctrl-ymfds1.so shared object is a device driver DLL used by the
While deva-ctrl-ymfds1.so is running, you can use applications with sound, and
Examples:
Invoke deva-ctrl-ymfds1.so directly from io-audio:
io-audio -d ymfds1 &
Mount deva-ctrl-ymfds1.so (io-audio must be running):
mount -Tio-audio /lib/dll/deva-ctrl-ymfds1.so &

© 2010, QNX Software Systems GmbH & Co. KG. deva-ctrl-ymfds1.so
Files:
deva-mixer-ac97.so
Supports the mixer.
Errors:
When an error occurs, deva-ctrl-ymfds1.so sends a description of the error to the
Aureal Semiconductor Inc.
See also:
io-audio, mixer

deva-mixer-ac97.so © 2010, QNX Software Systems GmbH & Co. KG.
Mixer DLL for the Intel Audio Codec ’97 (AC’97)
You can’t invoke this shared object. An audio driver (deva-ctrl-*) loads it if the
driver determines that your hardware needs it.
Syntax:
N/A
Runs on:
Neutrino
Options:
None.
Description:
The deva-mixer-ac97.so shared object provides an interface between the AC’97
standard codec and an audio driver.
Errors:
When an error occurs, deva-mixer-ac97.so sends a description of the error to the
See also:
io-audio, mixer
The Intel Corporation web site for the the Audio Codec ’97 specification

© 2010, QNX Software Systems GmbH & Co. KG. deva-mixer-ak4531.so
Mixer DLL for the ASAHI KASEI AK4531 CODEC
Syntax:
N/A
Runs on:
Neutrino
Options:
None.
Description:
The deva-mixer-ak4531.so shared object provides an interface between the
AK4531 CODEC and an audio driver.
Errors:
When an error occurs, deva-mixer-ak4531.so sends a description of the error to
See also:
io-audio, mixer,

deva-mixer-hda.so © 2010, QNX Software Systems GmbH & Co. KG.
Mixer DLL for High Definition Audio codecs
Syntax:
N/A
Runs on:
Neutrino
Options:
None.
Description:
The deva-mixer-hda.so shared object provides an interface between High
Definition Audio codecs and an audio driver.
The Dll has support for a subset of the codecs in production; your particular codec
may not yet be supported.
Errors:
When an error occurs, deva-mixer-hda.so sends a description of the error to the
See also:
io-audio, mixer

© 2010, QNX Software Systems GmbH & Co. KG. deva-util-restore.so
Shared object used to restore an audio driver’s state
You don’t invoke this object directly; io-audio loads it on loading a new driver.
Syntax:
N/A
Runs on:
Neutrino
Targets:
ARM, MIPS, PPC, SH, x86
Options:
None.
Description:
When io-audio loads a new driver, it uses the deva-util-restore.so shared
object to restore the driver’s state, which consists of all the device settings, such as the
output volume level and the selected input connection. The state information is
restored from a configuration file that was updated the last time the driver ran.
This shared object is an optional component of the audio system. If io-audio can’t
load it, io-audio continues, but doesn’t restore the driver state. See also the
io-audio global option config_write_delay.
Errors:
When an error occurs, deva-util-restore.so sends a description of it to the
system logger, slogger.
See also:
io-audio, mixer
Driver Development Kits Audio Devices

devb-adpu320 © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Adaptec AIC-7901/7902-based SCSI adapters (QNX Neutrino)
Syntax:
devb-adpu320 [cam option[,option]...]
[cdrom option[,option]...]
[disk option[,option]...]
[optical option[,option]...]
[adpu320 option[,option]...]
[blk option[,option]...] &
Runs on:
Neutrino
Options:
Use commas (,) to separate the options. You can put the cam, cdrom, disk,
optical, adpu320, and blk groups of options in any order.
cam options
lun=mask Enable Logical Unit Number (LUN) scan for the devices specified in
mask. The mask is a hex bitmask specifying which IDs to scan for; the
default is 0x00.
quiet Be quiet: don’t display any information on startup.
verbose Be verbose: display full information about SCSI units (devices) on

startup.
cdrom options
The cdrom options control the driver’s interface to cam-cdrom.so. If specified, they
must follow the cdrom keyword.
disk options
must follow the disk keyword.
optical options
they must follow the optical keyword.

© 2010, QNX Software Systems GmbH & Co. KG. devb-adpu320
adpu320 options
The adpu320 options control the driver’s interface to the U320 series controllers. If
you’ve installed multiple controllers, you can repeat these options for each controller.
Remember, however, to specify the adpu320 keyword before each controller’s set of
options.
vid= vid The vendor ID of the controller.
did=did The device ID of the controller.
pci=index The PCI index of the controller in the machine, where index is a value
between 0 and the number of adapters.
blk options
The blk options control io-blk.so. If specified, they must follow the blk keyword.
Description:
The devb-adpu320 driver is for SCSI adapters based on the Adaptec AIC-790X
chips.
Controllers supported by this driver include, but aren’t necessarily limited to:
Manufacturer Controller
Adaptec AIC-7901
Adaptec AIC-7902
Adaptec 29320A-R
If you have problems with the PCI adapter make sure that you have an up to date
version of the the adapter BIOS as well as system BIOS.
Controllers are numbered from 0 to n, in the order they’re found. For each controller,
the driver performs a scan, looking for installed units. All targets are scanned (0 to 7)
and for each target, each LUN (Logical Unit Number) is scanned (0 to 7). Devices are
numbered starting from 0, and each type of device is numbered separately.
The devb-adpu320 driver closes its standard input, standard output and standard
error immediately after completing its initializations. Error messages may be
produced during the initialization phase and are written to standard error.
Examples:
Assume an U320 controller, and list all connected devices:
devb-adpu320 &
Assume an U320 PCI controller with a PCI index of 1, and list all connected devices:

devb-adpu320 © 2010, QNX Software Systems GmbH & Co. KG.
devb-adpu320 adpu320 pci=1 &
Files:
The devb-adpu320 driver causes io-blk.so to adopt various block special devices
under /dev. These devices are normally named hd n (or cd n for CD-ROMs), where n
is the physical unit number of the device. This driver could also require the following
shared objects:
Binary Required
cam-cdrom.so For CD-ROM access
cam-disk.so For hard-disk access
libcam.so Always
Exit status:
The devb-adpu320 driver terminates only if an error occurs during startup, or if it
has successfully forked itself upon startup because it hadn’t been initially started in the
background.
0 The devb-adpu320 driver wasn’t started in the background and therefore

forked itself. The original process terminated with a zero exit status, the
forked process continued.
>0 An error occurred during startup.
Caveats:
Unless overridden with the blk automount= option (see io-blk.so), devices are
mounted as:
Device Mountpoint Filesystem type

/dev/hd0t77 /hd qnx4
/dev/cd0 /cd cd
/dev/hd0t6 /dos dos
/dev/hd0t11 /dos dos
While there’s no limit to the size of a disk or partition, I/O (i.e. the lseek(), read() and
write() functions) is currently limited to 2 gigabytes per partition (or disk). This I/O
limit has no effect on the partition size for mounted filesystems.
Known supported functions include:

© 2010, QNX Software Systems GmbH & Co. KG. devb-adpu320
chmod(), chown(), close(), closedir(), creat(), devctl(), dup(), dup2(),

fcntl(), fpathconf(), fstat(), lseek(), mkdir(), mkfifo(), mknod(), open(),
opendir(), pathconf(), read(), readdir(), readlink(), rewinddir(), rmdir(),
stat(), symlink(), unlink() (not supported for directories$ utime(), write()
Note that certain calls (such as pipe(), as well as read() and write() on FIFOs) may
require the pipe manager.
See also:
cam-*, devb-*, fs-*, io-blk.so
“Filesystems and block I/O (devb-*) drivers” in the Fine-Tuning Your System
chapter of the QNX Neutrino User’s Guide

devb-aha8 © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Adaptec AIC-7870/7880 based SCSI adapters (QNX Neutrino)
Syntax:
devb-aha8 [cam option[,option]...]
[aha8 option[,option]...]
Runs on:
Neutrino
Options:
optical, aha8, and blk groups of options in any order.
cam options
default is 0x00.

startup.
cdrom options
disk options
optical options

© 2010, QNX Software Systems GmbH & Co. KG. devb-aha8
aha8 options
The aha8 options control the drivers interface to the AHA 8 series controllers. If
you’ve installed multiple controllers, you can repeat these options for each controller.
Remember, however, to specify the aha8 keyword before each controller’s set of
options.
pci=index The PCI index of the controller in the machine, where index is a value
between 0 and the number of adapters.
noreset Don’t reset the SCSI bus.
blk options
Description:
The devb-aha8 driver is for SCSI adapters based on the Adaptec AIC-7870 and
AIC-7880 chips. Controllers supported by this driver include, but aren’t necessarily
limited to:
Manufacturer Controller
Adaptec AIC-7870
Adaptec AIC-7880
Adaptec AHA-2940
Adaptec AHA-2940W
Adaptec AHA-3940
The devb-aha8 driver queries the BIOS for PCI card memory addresses.
If you have problems with the PCI adapter make sure that you have an up to date
version of the the adapter BIOS as well as system BIOS.
Controllers are numbered from 0 to n, in the order they’re found.

For each controller, the driver performs a scan, looking for installed units. All targets
are scanned (0 to 7) and for each target, each LUN (Logical Unit Number) is scanned
(0 to 7). Devices are numbered starting from 0, and each type of device is numbered
separately.
The devb-aha8 driver closes its standard input, standard output and standard error
immediately after completing its initializations. Error messages may be produced
during the initialization phase and are written to standard error.

devb-aha8 © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Assume an AHA 8 controller, and list all connected devices:
devb-aha8 &
Assume an AHA 8 PCI controller with a PCI index of 1, and list all connected devices:
devb-aha8 aha8 pci=1 &
Files:
The devb-aha8 driver causes io-blk.so to adopt various block special devices
under /dev. These devices are normally named hdn (or cdn for CD-ROMs), where n
is the physical unit number of the device.
This driver could also require the following shared objects:
Binary Required
cam-cdrom.so For CD-ROM access.
cam-disk.so For hard-disk access.
libcam.so Always
Exit status:
The devb-aha8 driver terminates only if an error occurs during startup, or if it has
successfully forked itself upon startup because it hadn’t been initially started in the
background.
0 The devb-aha8 driver wasn’t started in the background and therefore forked
itself. The original process terminated with a zero exit status, the forked
process continued.
Caveats:
mounted as:

continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devb-aha8

/dev/cd0 /cd cd
/dev/hd0t6 /dos dos

stat(), symlink(), unlink() (not supported for directories), utime(), write()
See also:

devb-ahci © 2010, QNX Software Systems GmbH & Co. KG.
Driver for AHCI SATA interfaces (QNX Neutrino)
Syntax:
devb-ahci [cam option[,option]...]
[ahci option[,option]...]
Runs on:
QNX Neutrino
Options:
Use commas (,) to separate the options. You can put the cam, ahci, and blk groups
of options in any order.
cam options
default is 0x00.

startup.
ahci options
The ahci options control the driver’s interface to the AHCI controller. If you’ve
installed multiple controllers, you can repeat these options for each controller.
Remember, however, to specify the ahci keyword before each controller’s set of
options.
Interface-specific options:
irq=req The interrupt used by the controller.
vid=vid The vendor ID of the controller.
pci=index The PCI index of the controller in the machine, where index is
a value between 0 and the number of adapters.
nobmstr Don’t use busmastering.
port=N ,device Specify options for device on port N.

© 2010, QNX Software Systems GmbH & Co. KG. devb-ahci
priority=prio Set the priority of the processing thread. The default is 21.
timeout=timeout Set the I/O request timeout, in seconds. The default is 10.
Device-specific options:
geometry=heads:cyl:sect
Specify the drive geometry.
chs Use Cylinder-Head-Sector mode. The default is LBA.
blk options
Description:
The devb-ahci supports the Intel AHCI SATA controller with the following device
IDs:
• ICH-6 82801FB_SATA 0x2651
• ICH-6 82801FBM_SATA 0x2653
• ICH-7 82801GB_SATA 0x27c1
• ICH-7 82801GBM_SATA 0x27c5
You need to enable AHCI mode in the BIOS.
Examples:
Detect all SATA controllers, and list all connected devices:
devb-ahci &
Files:
The devb-ahci driver causes io-blk.so to adopt various block special devices
under /dev. These devices are normally named hdn, where n is the physical unit
number of the device.

devb-ahci © 2010, QNX Software Systems GmbH & Co. KG.
Binary Required
libcam.so Always
Exit status:
The devb-ahci driver terminates only if an error occurs during startup, or if it has
background.
0 The devb-ahci driver wasn’t started in the background and therefore forked
process continued.
Caveats:
mounted as:

/dev/hd0t6 /dos dos


© 2010, QNX Software Systems GmbH & Co. KG. devb-ahci
See also:

devb-btmm © 2010, QNX Software Systems GmbH & Co. KG.
Driver for BusLogic/Mylex Multimaster host adapters (QNX Neutrino)
Syntax:
devb-btmm [cam option[,option]...]
[btmm option[,option]...]
Runs on:
Neutrino
Options:
optical, btmm, and blk groups of options in any order.
cam options
default is 0x00.

startup.
cdrom options
disk options
optical options

© 2010, QNX Software Systems GmbH & Co. KG. devb-btmm
btmm options
The btmm options control the drivers interface to the BusLogic/Mylex Multimaster
series controllers. If you’ve installed multiple controllers, you can repeat these options
for each controller. Remember, however, to specify the btmm keyword before each
controller’s set of options.
ioport=port The I/O port of the interface. By default, it’s detected automatically.
clone Use this for clones; the default is for the driver to attempt to verify
the type of card, and clone disables this check.
dma=channel Use the specified DMA channel.
irq=req Assume that the controller is using this interrupt. Default is 11.
noreset Reset the controller and SCSI bus at initialization time.
scsiid=id Specify the SCSI ID used by the controller. Default is 7.
blk options
Description:
The devb-btmm driver is for the BusLogic/Mylex Multimaster and compatible SCSI
controllers.
Controllers supported by this driver include, but aren’t necessarily limited to:
Controller Description
BT-440C Bus master VL SCSI host adapter.
BT-445C Bus master VL SCSI host adapter with floppy controller.
BT-542B Bus master ISA SCSI host adapter with floppy controller.
BT-542D Bus master ISA-to-Fast SCSI host adapter with floppy controller.
BT-545C Bus master ISA SCSI host adapter with floppy controller.
BT-545S Bus master ISA-to-Fast SCSI host adapter with floppy controller.
BT-646S Bus master MCA SCSI host adapter.
BT-747S Bus master EISA SCSI host adapter.
BT-946C Bus master PCI-to-Fast SCSI host adapter with floppy controller.

devb-btmm © 2010, QNX Software Systems GmbH & Co. KG.
The driver performs a scan, looking for installed units. All targets are scanned (0 to 7)
and for each target, each LUN (Logical Unit Number) is scanned (0 to 7). Devices are
numbered starting from 0, and each type of device is numbered separately.
The devb-btmm driver closes its standard input, standard output and standard error
immediately after completing its initializations. Error messages may be produced
during the initialization phase and are written to standard error.
Examples:
Start the Multimaster driver:
devb-btmm &
Start the Multimaster driver with an I/O port of 0x330 and an interrupt of 11:
devb-btmm btmm ioport=0x330,irq=11 &
Files:
The devb-btmm driver causes io-blk.so to adopt various block special devices
Binary Required
libcam.so Always
Exit status:
The devb-btmm driver terminates only if an error occurs during startup, or if it has
background.
0 The devb-btmm driver wasn’t started in the background and therefore forked
process continued.

© 2010, QNX Software Systems GmbH & Co. KG. devb-btmm
Caveats:
The BusLogic/Mylex Multimaster host adapter is compatible with the Adaptec
AIC-154x SCSI controller. On startup, the enumerators recognize this adapter as the
Adaptec card but devb-aha4 will fail unless it includes the clone option.
mounted as:

/dev/cd0 /cd cd
/dev/hd0t6 /dos dos

Note that certain calls (such as pipe() as well as read() and write() on FIFOs) may
See also:

devb-eide © 2010, QNX Software Systems GmbH & Co. KG.
Driver for ATA/IDE disk interface and ATAPI CD-ROM interface (QNX Neutrino)
Syntax:
devb-eide [blk option[,option]...]
[cam option[,option]...]
[eide option[,option]...] &
Runs on:
Neutrino
Options:
Use commas (,) to separate the options. You can put the blk, cam, cdrom, disk, and
eide groups of options in any order.
blk options
cam options
verbose Be verbose.
cdrom options
disk options
eide options
The eide options control the driver’s interface to the EIDE controller. If you’ve
Remember, however, to specify the eide keyword before each controller’s set of
options.

© 2010, QNX Software Systems GmbH & Co. KG. devb-eide
chnl=chnl The channel number of the controller (0 or 1).
decode=xor Set the layout between I/O registers. The default is 0.
ioport=pri[:sec] The I/O port of the interface. By default, it’s detected

automatically.
master=device Specify master device options. For device-specific options, see

below.
nobios Do not use BIOS transfer mode settings. The default is to use
them.
nobmstr Do not use busmastering. Specify this option if you want to

disable DMA.
noconcurrent Don’t allow concurrent access to both channels.
nolegacy Don’t scan legacy addresses (0x1f0, 0x170).
nomaster Don’t scan for master devices.
noreset Don’t reset devices at initialization.
noslave Don’t scan for slave devices.
slave=device. Specify slave device options. For device-specific options, see

below.
stride=space Set the spacing offset between I/O ports (IDE command
registers). E.g. if the ports are located on 4-byte boundaries, set
space to 4. The default is 1.
timeout=timeout Set the I/O request timeout in seconds. The default is 10.

ata Set the device type to ATA.

atapi Set the device type to ATAPI.
chs Use Cylinder-Head-Sector mode instead of Logical Block
Addressing. LBA is used by default.
Specify drive geometry.
lba48 Enable LBA 48-bit addressing (off by default).
mdma=mode Set multi-word DMA mode. Values for mode can be 0-2 (or off
to disable).
multiblk=blks Set the number of blocks per interrupt for multiblk mode.
nonremovable Report the device as nonremovable.
pio=mode Set PIO mode. Values for mode can be 0-4 (or off to disable
PIO).
smart Enable SMART monitoring.
udma=mode Set ultra DMA mode. Values for mode can be 0-6 (or off to
disable).
wcache Enable the device write cache.
xfer=width Set the I/O access width (8, 16, or 32 bits).
Description:
The devb-eide driver is for IDE (Integrated Drive Electronics), EIDE (Enhanced
IDE) and ATA (AT Attachment) hard disk interface, as well as the ATAPI (ATA Packet
Interface) CD-ROM interface. This driver autodetects all interfaces.
If you’re installing multiple operating systems on the drive, make sure they all use a
compatible mode. For example, if your drive is ≥ 528M and DOS will also be installed
on the drive, the driver should be configured to use LBA.
The devb-eide driver uses DMA by default. If you want to disable DMA, specify
the nobmstr command-line option.
By default, the driver uses LBA (Logical Block Addressing) modes if the drive
supports them. If you want the device programmed to CHS (Cylinder-Head-Sector)
mode, specify the chs option.
The devb-eide driver closes its standard input, standard output, and standard error
immediately after completing its initializations. Any error messages produced during
the initialization phase are written to standard error.

Examples:
Detect all IDE controllers, and list all connected devices:
devb-eide &
Detect an IDE controller at a specific I/O port address and IRQ number, and list all
connected devices:
devb-eide eide ioport=0x1f0,irq=14
Detect a PCMCIA disk that is configured in contiguous I/O mapped addressing at a

specific I/O port address and IRQ number:
devb-eide eide ioport=0x320:0x32c,irq=7,noslave
For PCMCIA devices configured in contiguous I/O mapped addressing, you should
always specify the control block address of the interface by adding an offset (usually
12) to the base address of the port. This is not required for legacy addressing (0x1f0
or 0x170), where the driver adds the standard control block offset (0x200)
automatically.
Detect an IDE controller with a specific vendor and device identity, and list all
connected devices:
devb-eide eide vid=0x8086,did=0x2411,pci=0,chnl=0
Detect an IDE controller with a specific vendor ID, device ID, and channel number,
and disable ultra DMA on the master:
devb-eide eide vid=0x8086,did=0x2411,pci=0,chnl=1,master=udma=off
Pass cache and delwri options to io-blk.so, uid and gid options to fs-cd.so,
and vollabel option to fs-dos.so:
devb-eide blk cache=2m,delwri=2s cd uid=234,gid=120 dos \
vollabel=ignore &
The cd and dos options apply to any filesystems of those types that are mounted
(either by the automatic mounter or a later explicit mount).
You can also pass generic mount options (as described in io-blk.so) as follows:
devb-eide blk noatime dos hidden=show,noexec qnx4 ro &
This sets the ST_NOATIME mount bit for all filesystems, the ST_RDONLY bit for any
QNX 4 filesystem, and the ST_NOEXEC bit for any DOS filesystem. The mount
message also has these bits, which apply only to that mountpoint.
Files:
The devb-eide driver causes io-blk.so to adopt various block special devices

Binary Required
libcam.so Always
Exit status:
The devb-eide driver terminates only if an error occurs during startup, or if it has
background.
0 The devb-eide driver wasn’t started in the background and therefore forked
process continued.
Caveats:
mounted as:

/dev/cd0 /cd cd
/dev/hd0t6 /dos dos
While there’s no limit to the size of a disk or partition, I/O (i.e. the lseek(), read(), and


See also:
Controlling How Neutrino Starts and Connecting Hardware chapters, and

devb-fdc © 2010, QNX Software Systems GmbH & Co. KG.
Driver for floppy disk interface (QNX Neutrino)
Syntax:
devb-fdc [cam option[,option]...]
[fdc option[,option]...]
Runs on:
Neutrino
Targets:
x86
Options:
Use commas (,) to separate the options. You can put the cam, disk, fdc, and blk
groups of options in any order.
cam options
verbose Be verbose.
disk options
fdc options
The fdc options control the driver’s interface to the fdc controller. If you’ve installed
multiple controllers, you can repeat these options for each controller. Remember,
however, to specify the fdc keyword before each controller’s set of options.
ioport=port The I/O port of the interface. The default is 0x3f0.
irq=req The interrupt used by the controller. The default is 6.
dma=channel Use the specified DMA channel. The default is 2.

© 2010, QNX Software Systems GmbH & Co. KG. devb-fdc
blk options
Description:
The devb-fdc driver is for the floppy disk interface. It autodetects interfaces at
address 0x3f0, interrupt 6, dma channel 2 by default. If you have an interface at a
different address/interrupt/dma, specify them to the driver using the fdc options.
• The default cache size specified by io-blk.so is excessive for devb-fdc. You’ll
probably want to reduce it to something more reasonable:
devb-fdc blk cache=512k &
• The device enumerator (see enum-devices, as well as “Device enumeration” in

the Controlling How Neutrino Starts chapter of the QNX Neutrino User’s Guide)
doesn’t start devb-fdc by default. If your system has a floppy drive, you can start
the driver manually or uncomment the devb-fdc lines in the
/etc/system/enum/devices/block file.
Examples:
Assume an FDC interface, and list all connected devices:
devb-fdc &
Mount a floppy drive that can access QNX or DOS floppy disks:

mount -tqnx4 /dev/fd0 /qnxflop
mount -tdos /dev/fd0 /dosflop
or:
devb-fdc blk cache=128k,automount=+fd0:/qnxflop:qnx4,\

automount=+fd0:/dosflop:dos &
Files:
The devb-fdc driver causes io-blk.so to adopt various block special devices under
/dev. These devices are normally named fdn, where n is the physical unit number of
the device.

devb-fdc © 2010, QNX Software Systems GmbH & Co. KG.
Binary Required
cam-disk.so For floppy-disk access.
libcam.so Always
Exit status:
The devb-fdc driver terminates only if an error occurs during startup, or if it has
background.
0 The devb-fdc driver wasn’t started in the background and therefore forked
process continued.
Caveats:

See also:
cam-*, devb-*, fdformat, fs-*, io-blk.so
Connecting Hardware chapter, and “Filesystems and block I/O (devb-*) drivers” in
the Fine-Tuning Your System chapter of the QNX Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. devb-loopback
Pseudo block driver
In order to start this driver, you must be logged in as root.
Syntax:
devb-loopback [loopback loopback_option[,option]]
Runs on:
Neutrino
Options:
Use commas (,) to separate the options. You can put the blk and loopback groups
loopback options
fd=path Specify a filename (a path registered by your resource manager) to
be presented as a block device by devb-loopback. This
pathname must support open(), close(), read(), write(), and fstat();
for more information, see “Driver support,” below.
Each pathname will result in the creation of a corresponding
block-special device (see prefix= below), the content of which
will be mirrored over the file descriptor using standard read/write
calls. You can then mount traditional block filesystems (such as
fs-dos.so and fs-qnx4.so) on top of these pseudo devices and
use them transparently.
You can specify multiple fd= pathnames; they’re managed by a
single devb-loopback process.
prefix=name The name by which the loopback pseudo block devices are
registered. The default is lo; thus each fd= entry named on the
command line will appear as /dev/lo0, /dev/lo1, and so on.
This is a global option, and applies to all fd= instances.
rw, ro Set the reading mode with which to open the underlying file
descriptor (corresponds to O_RDWR or O_RDONLY). If you
specify read-only, then in turn you can mount only read-only
filesystems onto the corresponding devb-loopback device (the
pseudo-device is advertised up as DEV_RDONLY). The default is
rw. This option applies to all subsequent instances of fd=.
sync, async Set the synchronous write mode with which to open the underlying
file descriptor (corresponds to O_SYNC). The effect of this
depends on the resource manager responsible for each file
(typically it’s ignored).

devb-loopback © 2010, QNX Software Systems GmbH & Co. KG.
This option affects writes that are presented to the pseudo-device, and not the write
behavior of any mounted filesystems above this (that can be controlled via mount
options or blk delwri=... commit=...).
The default is sync.
denyno, denyrd, denywr, denyrw
The SH_DENY mode with which to open the underlying file
descriptor. A deny mode stops other processes from opening the
host file, thus preventing the content of it from being changed
behind the back of the devb-loopback filesystems, which will
prevent coherence issues. The default is denyrw. This option
applies to all subsequent instances of fd=.
seek, xtype Configure I/O onto the file descriptor using either an
LSEEK+READ combined message or via a
READ+XTYPE_OFFSET composite. By default,
devb-loopback probes the host filesystem as to whether it
supports the pread() and pwrite() API. The default is xtype. This
option applies to all subsequent instances of fd=.
blksz=size Override the device blocksize. This is typically probed from a

stat() or DCMD_CAM_DEVINFO devctl() call onto the resource
manager responsible for each file and the same value advertised
up, but some resource managers don’t advertise a useful blocksize
(in particular, devf-* reports 1-byte blocks).
You might also need this option in some cases where a filesystem
image was originally formatted on a device with a different sector
size to that of the hosting filesystem; it may be necessary for
correct operation or performance reasons to mimic the original
sector size.
This option applies to all subsequent instances of fd=, but you can
reset it to use the probed value with an empty option (e.g.
blksz=2048,fd=/F1,blksz=,fd=/F2).
nio=num The number of asynchronous I/O threads (which are responsible

for executing an internal block device read/write as a normal
read/write over the external file descriptor). This multi-threading is
useful if you’ve specified multiple fd= devices.
The default is 1; you can specify a value of 0 to force all I/O to be
performed synchronously in the context of the filesystem caller; it
can be higher to prevent this I/O from becoming a bottleneck to the
filesystem layers above (appropriate only when multiple fd= paths
have been specified). This is a global option; the pool of threads
services requests to all fd= files in the order of client priority.

blk options
The blk options are as for io-blk.so. If specified, they must follow the blk
keyword. For more information, see io-blk.so.
Since devb-loopback loads the standard block device DLLs, which will create a
buffer cache using the same default rules as for the disk filesystems, the cache is likely
to be too big for devb-loopback. You can reduce the cache size using blk
cache=size. Depending on the actual size of the device, and the level of caching
already implemented by its driver, a value of 128k may be sufficient.
Description:
The block filesystems in QNX Neutrino are implemented as a series of DLL modules
and a set of internal APIs. Thus it is possible to mount disk-based filesystems (such as
QNX or DOS) only onto released QNX devb-* drivers. The devb-loopback driver
implements a mapping between an arbitrary file descriptor and the block API,
allowing any resource manager to be used to host a disk filesystem.
Internal function calls, normally targeted at a SCSI/CAM driver, are translated into
standard read() and write() calls onto the host file descriptor, and are used to populate
the data content of a pseudo block device, which appears to the system as a disk.
Within this framework, any resource-manager or file-descriptor object can be viewed
as a block-special device and be mounted as a disk filesystem. For example, you can’t
normally directly use an ISO9660 image stored on a devf-* device, because devf-*
doesn’t load fs-*.so modules; by using devb-loopback to present this image file
as a block device, you can then mount it using fs-cd.so. For example:
devb-loopback fd=/devf/iso blk automount=lo0:/fs/iso:cd
This results in the following arrangement:
devb-loopback
/devf/iso /dev/lo1
User io-blk.so
resource
manager
(e.g. devf-*) /fs/iso User
applications
fs-cd.so
Other uses might be to mount images from /dev/shmem, an image filesystem (IFS),
or over NFS.
The host file needs to be pregrown. For example, assuming that /fs/flash is a
mounted devf filesystem, you’d have to do the following setup first:

devb-loopback © 2010, QNX Software Systems GmbH & Co. KG.
touch /fs/flash/q4.img
dinit -hq -S32m /fs/flash/q4.img
You could then use that file on flash as a read-write fs-qnx4.so filesystem:
devb-loopback blk cache=128k,auto=none loopback fd=/fs/flash/q4.img
mount -tqnx4 /dev/lo0 /q4flash
Using devb-loopback in this case adds functionality that a disk filesystem format
offers (access times, hard links, etc.) to the devf-* filesystem. In other cases,
devb-loopback lets you use the caching (e.g. names and sectors) that io-blk.so
supports, but that the resource manager underlying the host file might not.
Driver support
The resource manager(s) implementing the pathnames specified by fd= operands must
support the following standard interfaces:
open(), close() The device must be able to open and close a file descriptor to it.
The O_RDONLY and O_RDWR modes should be supported, as
should the SH_DENY share flags and O_SYNC modifier (if those
options are used from the devb-loopback command line); the
default libc iofunc open handler is suitable.
fstat() The device must support a stat method, which is used to
determine the size and geometry of the underlying device. The
default libc iofunc handler is suitable, provided there’s an
associated iofunc_mount_t which sets a suitable “blocksize”
(the default is 1 byte, which isn’t appropriate for use as a block
device; it must be one of 512, 1024, 2048, or 4096). See also
devctl() (below) and the loopback blksz= option (above).
read(), write() The device must support read and write callouts, which are used to
transfer “disk blocks” between the device and the filesystem buffer
cache. I/O is in units of the advertised block size and within the
bounds of the advertised device size. If the device supports the
_IO_XTYPE_OFFSET modifier (corresponding to pread() and
pwrite()), then that interface is used; otherwise a combined seek
plus normal read/write is made.
lseek() If _IO_XTYPE_OFFSET isn’t supported (above), then the device
must implement an lseek method. The default libc iofunc
callout is suitable.
devctl() The device may optionally implement the DCMD_CAM_DEVINFO
devctl() command (refer to the <sys/dcmd_cam.h> and
<sys/cam_device.h> header files). This allows the device to set
certain low-level fields to fine-tune emulation behavior. The
DCMD_ALL_GETFLAGS command is also used to probe the status
of a (removable) file descriptor. However, suitable defaults for both
these can be inferred from the fstat() query (above).

Mounting
You can mount the filesystem image via the loopback device (/dev/lo*) from the
command line with the mount command:
# devb-loopback blk cache=256k,vnode=128 \

loopback ro,blksz=2048,fd=/mnt/EFS/tts.iso &
# mount -r -tcd /dev/lo0 /mnt/tts
or via the blk automount= option:
# devb-loopback blk cache=256k,vnode=128,automount=lo0:/mnt/tts:cd \

loopback ro,blksz=2048,fd=/mnt/EFS/tts.iso &
You can use umount to unmount the filesystem. The file descriptors to the underlying
host image files aren’t closed, and /dev/lo* remain present, until devb-loopback
is terminated.
See also:
cam-*, devb-*, fs-*, io-blk.so, mount, umount
close(), devctl() fstat(). open(), pread() pwrite() read(), stat() write() in the QNX
Neutrino Library Reference
Writing a Resource Manager

devb-mvSata © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Marvell 88SX50XX SATA interfaces (QNX Neutrino)
Syntax:
devb-mvSata [cam option[,option]...]
[mvSata option[,option]...]
Runs on:
QNX Neutrino
Options:
Use commas (,) to separate the options. You can put the cam, mvSata, and blk
cam options
default is 0x00.

startup.
mvSata options
The mvSata options control the driver’s interface to the mvSata controller. If you’ve
Remember, however, to specify the mvSata keyword before each controller’s set of
options.
port=N ,device Specify options for device on port N.

© 2010, QNX Software Systems GmbH & Co. KG. devb-mvSata
timeout=timeout Set the I/O request timeout, in seconds. The default is 10.
cache_line=size Set the PCI cache line size (16, 32, 64, or 128 bytes). Default
pci config.
Specify the drive geometry.
multiblk=blks Set multiblock mode, specifying the number of blocks per

interrupt.
nonremovable Report the device as being nonremovable.
chs Use Cylinder-Head-Sector mode. The default is LBA.
blk options
Description:
The devb-mvSata driver is for Marvell 88SX50XX SATA interfaces. It supports
vendor ID 0x11ab with at least the following device IDs:
Device ID Chipset
5080 88SX5080
5081 88SX5081
5040 88SX5040
5041 88SX5041
6081 88SX6081
6041 88SX6041
Due to a chipset limitation, CD-ROM and DVD-ROM drives aren’t supported.
Examples:
Detect all SATA controllers, and list all connected devices:
devb-mvSata &

devb-mvSata © 2010, QNX Software Systems GmbH & Co. KG.
Files:
The devb-mvSata driver causes io-blk.so to adopt various block special devices
under /dev. These devices are normally named hdn, where n is the physical unit
Binary Required
libcam.so Always
Exit status:
The devb-mvSata driver terminates only if an error occurs during startup, or if it has
background.
0 The devb-mvSata driver wasn’t started in the background and therefore

forked itself. The original process terminated with a zero exit status, the
forked process continued.
Caveats:
mounted as:

/dev/hd0t6 /dos dos


© 2010, QNX Software Systems GmbH & Co. KG. devb-mvSata
See also:

devb-ram © 2010, QNX Software Systems GmbH & Co. KG.
Driver for RAM disk interface (QNX Neutrino)
Syntax:
devb-ram [cam option[,option]...]
[ram option[,option]...]
Runs on:
Neutrino
Options:
Use commas (,) to separate the options. You can put the cam, disk, ram, and blk
cam options
verbose Be verbose.
disk options
must follow the disk keyword. For more information, see cam-disk.so.
ram options
The ram options control the driver’s interface to RAM:
address=addr The physical address to overlay. The default is not to overlay.
blksize=size Set the sector size. The default is 512 bytes.
capacity=blocks Specify the capacity of the RAM drive in the blocks of the size
specified by the blksize option. The default is 4096 blocks (2
MB).
nodinit Don’t partition the RAM disk or format a QNX 4 filesystem on

it.
blk options
The blk options control io-blk.so. These options must follow the blk keyword
and must be specified after any general or disk options. For more information, see
io-blk.so.

© 2010, QNX Software Systems GmbH & Co. KG. devb-ram
Description:
The devb-ram driver creates a RAM disk interface. When the capacity option isn’t
specified, devb-ram creates a 2 MB RAM disk.
By default, devb-ram partitions the RAM disk, leaving one block for the partition
table itself, and making the remainder of the RAM disk (capacity minus 1) a t77
partition, which it then initializes (internally, not by spawning dinit) to have a blank
fs-qnx4.so filesystem on it. If you specify the nodinit option, you can later
manually format it, optionally partition the RAM disk with fdisk (but you can make
the whole thing a filesystem), and then mount it.
By default, io-blk.so allocates 15% of system RAM for cache. The devb-ram
system looks like a disk drive to io-blk.so, so it doesn’t know that the cache is
unnecessary. You should use the blk cache=512k option to reduce the cache size to
the minimum.
Because devb-ram is a block device which reads from and writes to RAM, its
operations go through a lot of layers before they actually get to RAM. For a RAM disk
with better performance, use the blk ramdisk=... option to io-blk.so. For more
information, see “RAM disks” in the Connecting Hardware chapter of the QNX
Neutrino User’s Guide.
Examples:
Create a 4 MB RAM drive:
devb-ram ram capacity=8192 &
Files:
The devb-ram driver causes io-blk.so to adopt various block special devices under
/dev. These devices are normally named hdn, where n is the physical unit number of
the device.
Binary Required
cam-disk.so For RAM disk access.
libcam.so Always
Exit status:
The devb-ram driver terminates only if an error occurs during startup, or if it has
background.

devb-ram © 2010, QNX Software Systems GmbH & Co. KG.
0 The devb-ram driver wasn’t started in the background and therefore forked
process continued.
Caveats:

See also:
cam-*, devb-*, dinit, fdisk, fs-*, io-blk.so
“RAM disks” in the Connecting Hardware chapter, and “Filesystems and block I/O
(devb-*) drivers” in the Fine-Tuning Your System chapter of the QNX Neutrino
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. devb-umass
Driver for USB Mass Storage interface
In order to start this driver, you must be logged in as root, and the USB stack
(io-usb) needs to be running.
Syntax:
devb-umass [blk option[,option]...]
[cam option[,option]...]
[umass options[,option]...]
Runs on:
Neutrino
Options:
Use commas (,) to separate the options. You can put the blk, cam, and umass groups
cam options
verbose Be verbose: display full information about units (devices) on startup.
pnp Enable CAM plug and play (i.e. don’t exit at startup when no devices
are found). The default is off.
umass options
The umass options control the driver’s interface to the USB device. If you’ve installed
multiple devices, you can repeat these options for each device. Remember, however, to
specify the umass keyword before each controller’s set of options.
path=name Connect to the specified USB stack. The default is

/dev/io-usb/io-usb.
wait=num Wait num of seconds for the USB stack. The default is 60
seconds.
vid=vid The vendor ID of the device.
did=did The device ID of the device.
busno=bus The bus number of the USB controller.
devno=dev The USB address of the device.
iface=if The particular interface number of the device.
ignore_csw Ignore the Command Status Wrapper. Some devices return
invalid data for the CSW.

devb-umass © 2010, QNX Software Systems GmbH & Co. KG.
blk options
For more information, see io-blk.so.
Description:
The devb-umass driver is the driver for a USB mass storage interface.
Examples:
Assume a USB controller, and list all connected devices:
devb-umass &
Assume a USB controller, and list/wait for all connected devices:
devb-umass cam pnp &
See also:
cam-*, devb-*, enum-usb, fs-*, io-blk.so, io-usb
Connecting Hardware chapter, and “Filesystems and block I/O (devb-*) drivers” in
the Fine-Tuning Your System chapter of the QNX Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. devc-con, devc-con-hid
Simple VGA console and keyboard I/O manager (QNX Neutrino)
You must be root to start this manager.
Syntax:
devc-con [options] &
devc-con-hid [options] &
Runs on:
Neutrino
Targets:
x86
Options:
-C size Specify the size of the canonical buffer in bytes (default 256).
-E Start in raw mode.
-e Start in edited mode (the default).
-h (devc-con-hid only) Don’t connect to the io-hid server; read

from the keyboard controller instead.
-I size Specify the size of the interrupt input buffer in bytes (default
2048).
-k (devc-con and devc-con-hid only) Disable keyboard (don’t

attach a keyboard interrupt handler).
-L [P][N][C][S] Set the initial state of the keyboard and its LEDs (default all off):
• C — turn CapsLock on.
• P — preserve the keyboard state. This overrides all the other
-L options.
• N — turn NumLock on.
• S — turn ScrollLock on.
-n num_ports (devc-con and devc-con-hid only) The number of virtual

console ports to create. The default is 4; the maximum is 9.
-O size Specify the size of the interrupt output buffer in bytes (default
2048).
-o nodaemon Don’t call procmgr_daemon() to make the driver run in the

background. Use this option if you need to know when the
devc-con or devc-con-hid device terminates.

devc-con, devc-con-hid © 2010, QNX Software Systems GmbH & Co. KG.
-r rate[,delay] Specify the initial keyboard typematic rate (in Hz) and, optionally,
the initial keyboard delay (in ms). The default values are 30 Hz
and 500 ms.
The keyboard typematic rate is the number of times per second
that a depressed key repeats. On a PC/AT-compatible system, this
ranges from 2 - 30 characters per second. If the option -r 0 is
specified, the keyboard typematic rate isn’t set by the driver.
The keyboard delay is defined as the time from when a key is first
pressed to when the start of the first repeated key is generated. On
a PC/AT-compatible system, the keyboard delay can range from
250 - 1000 milliseconds.
Description:
The devc-con manager provides an interface to the VGA console screen and
keyboard. It’s usually started as a system startup procedure (see diskboot).
For serial ports, use the appropriate devc-ser* manager.
When devc-con starts, it creates and manages the devices /dev/con1, /dev/con2,
and so on, up to the number of ports specified by the -n option.
The devc-con-hid manager is similar to devc-con, but works in conjunction with
io-hid and supports PS2, USB, and all other human-interface devices.
The devc-con-hid manager was added in QNX Momentics 6.3.0 Service Pack 3;
diskboot starts it instead of devc-con.
If you read from /dev/console, these managers return the characters typed on the
keyboard; if you write to /dev/console, the managers write to the screen.
If your application uses /dev/console, you should create a link from it to one of
/dev/con1, /dev/con2, . . . by adding a line like this to the buildfile used by mkifs:
[type=link] /dev/console = /dev/con1
The devc-con and devc-con-hid managers all emulate an 80×25 ANSI terminal.
Keyboard control
You can use the keyboard to switch between virtual consoles.
Each virtual console can run different applications that use the entire screen. The
keyboard is attached to the virtual console that’s currently visible. You can switch
from one virtual console to another — and thus from one application to another — by
entering the following keychords:

If you want to see: Press:

The next active console Ctrl-Alt-Enter or Ctrl-Alt-+ (plus)
The previous active console Ctrl-Alt-- (minus)
The + (plus) and - (minus) keys used in the console-switching keychords are those
found on the numeric keypad.
You can also jump to a specific console by using the Ctrl-Alt-n, where n is a numeric
digit that represents the console number of a virtual console. For instance:
If you want to see: Press:

/dev/con1 Ctrl-Alt-1
/dev/con2 (if available) Ctrl-Alt-2
.. ..
. .
/dev/con10 (if available) Ctrl-Alt-0
Character sets
The devc-con and devc-con-hid managers let you choose the character sets in use
from a “palette” of character sets, each of which is independently programmable to
contain one of several builtin character sets.
The in-use range of characters is divided into four regions which span character
numbers (in hexadecimal) 0x00 through 0xff. Two of these regions are fixed sets of
control characters, while the other two are configurable to contain a choice of
character sets:
Hex: Name: May be set to one of:

0x00-0x1f C0 (Control Zero) Not configurable
0x20-0x7f GL (Graphics Left) G0, G1, G2, G3
0x80-0x9f C1 (Control One) Not configurable
0xa0-0xff GR (Graphics Right) G1, G2, G3
You can set each of the GL and GR in-use character sets to a choice of several
character sets from the G0, G1, G2 and G3 character sets.
The screen control codes to set GL and GR are as follows:

To set: To: Use:

GL G0 {LS0} = {SI} (0f)
GL G1 {LS1} = {SO} (0e)
GL G2 {LS2} = {ESC n} (1b 6e) or {SS2} (8e)
GL G3 {LS3} = {ESC o} (1b 6f) or {SS3} (8f)
GR G1 {LS1R}= {ESC ˜} (1b 7e)
GR G2 {LS2R}= {ESC }} (1b 7d)
GR G3 {LS3R}= {ESC |} (1b 7c)
The {LS*} codes stand for “Locking Shift”. When character sets are selected by these
means, they remain in effect until another {LS*} code is sent.
The {SS*} codes stand for “Single Shift” and affect the next character only. After that
character, the character set in effect reverts to its previous setting. There are only two
{SS*} codes, {SS2} and {SS3} which maps G2 into GL and G3 into GL, respectively.
The G0 through G3 characters sets may each be set to any of the available builtin fonts.
The control code to do this is:
ESC g s
Where:
g: Sets:
( G0
) G1
* G2
+ G3
And:
s: Specifies:
B ASCII
0 Special (DEC Graphic)
< ISO-Latin1 Supplemental
U PC Character Set

Character set defaults
The in-use character sets are as follows:
In-use char set: Defaults to:

GR G2
GL G0
The character set codes are as follows:
Char set: Defaults to:

G0 ASCII charset
G1 Special charset (DEC Graphic)
G2 Supplemental charset (ISO-Latin 1)
G3 Special charset (DEC Graphic)
Character set example:
Set the GL in-service character set (0x20-0x7f) to the PC character set through G1,
write some characters, then switch GL back to G0:
{ESC )U} 1e 29 55 (Set G1 to be the PC character set)

{SO} 0e (Set GL to G1)
.
. (Write chars in PC graphics char set)
.
{SI} 0f (Set GL to G0)

The PC character set 0x00-0x7f.

The PC character set 0x80-0xff.

ANSI screen control codes

Note the following abbreviations used in the tables:
(220+) A VT220 Level 2 function
(NA) Not ANSI standard
(NI) Not implemented
(NFI) Not fully implemented
C0 control codes
The C0 control codes are as follows:
ASCII ANSI Mnemonic Hex Action

{NUL} 00 Null
{BEL} 07 Bell
{BS} 08 Back Space (VT100 defaults to no wrap
from left margin)
{HT} 09 Horizontal Tab (VT100 defaults to no
autowrap)
{LF} 0A Linefeed or Newline
{VT} 0B Same as LF
{FF} 0C Clears Screen (QNX Extension)
{CR} 0D Move cursor to left margin
{SO} {LS1} 0E GL is set to G1
{SI} {LS0} 0F GL is set to G0 (default)
{XON} {DC1} 11 XON
{XOFF} {DC0} 13 XOFF
{CAN} 18 Cancels ESC sequence
{SUB} 1A Cancels ESC sequence and prints ?
{ESC} 1B Start of ESC sequence
{DEL} 7F Ignored on output

ESC control sequences
The ESC control sequence codes are as follows:
String Hex Action

{ESC 7} 1B 37 Save cursor
{ESC 8} 1B 38 Restore cursor
{ESC =} 1B 3D Set application keypad mode
{ESC >} 1B 3E Set numeric keypad mode (default)
{ESC D} 1B 44 7-bit codes for {IND} (84)
{ESC E} 1B 45 7-bit codes for {NEL} (85)
{ESC H} 1B 48 7-bit codes for {HTS} (88)
{ESC M} 1B 4D 7-bit codes for {RI} (8D)
{ESC N} 1B 4E 7-bit codes for {SS2} (8E)
{ESC O} 1B 4F 7-bit codes for {SS3} (8F)
{ESC P} 1B 50 7-bit codes for {DCS} (90)
{ESC [} 1B 5B 7-bit codes for {CSI} (9B)
{ESC \} 1B 5C 7-bit codes for {ST} (9C)
{ESC ]} 1B 5D 7-bit codes for {OSC} (9D)
{ESC ˆ} 1B 5E 7-bit codes for {PM} (9E)
{ESC _} 1B 5F 7-bit codes for {APC} (9F)
{ESC Z} 1B 5A Identify terminal
{ESC c} 1B 63 Hard Reset (clears screen) (use {CSI ! P} for soft
reset)
{ESC n} 1B 6E (LS2) GL is set to G2 (220+)
{ESC o} 1B 6F (LS3) GL is set to G3 (220+)
{ESC |} 1B 7C (LS3R) GR is set to G3 (220+)
{ESC }} 1B 7D (LS2R) GR is set to G2 (220+) (default)
{ESC ˜} 1B 7E (LS1R) GR is set to G1
{ESC sp F} 1B 20 46 Keyboard generates 7-bit C1 codes (incl. CSI) (default)
{ESC sp G} 1B 20 47 Keyboard generates 8-bit C1 codes (incl. CSI) (220+)
{ESC ( 0} 1B 28 30 Set G0 to special charset
continued. . .

String Hex Action

{ESC ( <} 1B 28 3C Set G0 to supplemental charset
{ESC ( A} 1B 28 41 Set G0 to U.K. charset (Not implemented; same as
ASCII)
{ESC ( B} 1B 28 42 Set G0 to ASCII charset (default)
{ESC ( U} 1B 28 55 Set G0 to PCterm graphics
{ESC ) 0} 1B 29 30 Set G1 to special charset (default)
{ESC ) <} 1B 29 3C Set G1 to supplemental charset
{ESC ) A} 1B 29 41 Set G1 to U.K. charset (NI; same as ASCII)
{ESC ) B} 1B 29 42 Set G1 to ASCII charset
{ESC ) U} 1B 29 55 Set G1 to PCterm graphics
{ESC * 0} 1B 2A 30 Set G2 to special charset (220+)
{ESC * <} 1B 2A 3C Set G2 to supplemental charset (220+) (default)
{ESC * B} 1B 2A 42 Set G2 to ASCII charset (220+)
{ESC * U} 1B 2A 55 Set G2 to PCterm graphics
{ESC + 0} 1B 2B 30 Set G3 to special charset (220+) (default)
{ESC + <} 1B 2B 3C Set G3 to supplemental charset (220+)
{ESC + B} 1B 2B 42 Set G3 to ASCII charset (220+)
{ESC + U} 1B 2B 55 Set G3 to PCterm graphics
C1 control characters (220+)
You can do any 8-bit C1 code with 7-bit ESC followed by the 8-bit code minus 0x40
hex. For instance, you can represent the CSI (control sequence introducer) in 8-bit
mode as 0x9b, while in 7-bit mode you must express it as ESC [ (0x1b 0x5b).
The C1 control character codes are as follows:
ASCII Hex Action

{IND} 84 Move cursor down with scroll
{NEL} 85 Move to left margin on next line with scroll
{HTS} 88 Set horizontal tab
continued. . .

ASCII Hex Action

{RI} 8D Move cursor up with scroll
{SS2} 8E GL is set to G2 for 1 character
{SS3} 8F GL is set to G3 for 1 character
{DCS} 90 Start of Device control string
{CSI} 9B Control sequence introducer
{ST} 9C End of Device control string
{OSC} 9D Operating System Command
{PM} 9E Privacy Message
{APC} 9F Application Program Command
CSI control sequences
In 7-bit mode, CSI is ESC [. In 8-bit mode, CSI is (hex)0x9B. Use the ANSI
specification to represent the variable n, e.g. to print two spaces:
printf( "%c%c", 0x9b, 0x32 ) ;
The CSI control sequence codes are as follows:
ASCII Hex Action

{CSI [n] @} 9B [n] 40 Insert n spaces at cursor (default = 1
space)
{CSI [n] A} 9B [n] 41 Cursor up n rows, no wrap (default =
1 row)
{CSI [n] B} 9B [n] 42 Cursor down n rows, no wrap
(default = 1 row)
{CSI [n] C} 9B [n] 43 Cursor right n columns, no wrap
(default = 1 column)
{CSI [n] D} 9B [n] 44 Cursor left n columns, no wrap
(default = 1 column)
{CSI [n] F} 9B [n] 46 Cursor up n rows, positioned in first
column (default = 1 row)
{CSI [n] G} 9B [n] 47 Move cursor to column n (default =
column 1)
continued. . .

ASCII Hex Action

{CSI [r[;c]] H} 9B [r [3B c]] 48 Cursor position (default = row 1;
column 1)
{CSI [n] J} 9B [n] 4A Erase 0=cur-EOS 1=HOME-cur
2=screen (default = 0 (to end of
screen))
{CSI [n] K} 9B [n] 4B Erase 0=cur-EOL 1=BOL-cur 2=line
(default = 0 (to end of line))
{CSI [n] L} 9B [n] 4C Insert n lines (default = 1 line)
{CSI [n] M} 9B [n] 4D Delete n lines (default = 1 line)
{CSI [n] P} 9B [n] 50 Delete n chars (default = 1 char)
{CSI [n] S} 9B [n] 53 Scroll forward n lines (default = 1
line)
{CSI [n] T} 9B [n] 54 Scroll backward n lines (default = 1
line)
{CSI [n] X} 9B [n] 58 Erase cur for n-1 chars (default = 1
(0 chars))
{CSI Z} (9B 5A) Back tab
{c CSI [n] b} c 9B [n] 62 Repeat GR or GL character c, n
times. c is the last displayable
character; n defaults to 1 time.
{CSI 0 c} (9B 30 63) Primary device attrib request
{CSI [n] d} 9B [n] 64 Move cursor to line n (default = line
1)
{CSI [n] g} 9B [n] 67 Tab clear 0=cursor 2=all (default =
0)
{CSI [n[;n]...] h} 9B [n[3B n]...] 68 Standard Set mode (See modes
table) (default=none)
{CSI ? [n[;n]...] h} 9B 3F [n[3B n]...] 68 Private Set mode (See modes table)
(default=none)
{CSI [n[;n]...] l} 9B [n[3B n]...] 6C Standard Reset mode (See modes
{CSI ? [n[;n]...] l} 9B 3F [n[3B n]...] 6C Private Reset mode (See modes
{CSI [n[;n]...] m} 9B [n[3B n]...] 6D Select Graphic Rendition (See
below) (default = 0)
continued. . .

ASCII Hex Action

{CSI n n} 9B n 6E Device status 5=status 6=cursor/pos
{CSI [r[;c]] r} 9B [r [3B c]] 72 Set scroll region and home cursor
{CSI r} 9B 72 Disable scroll region & home cursor
{CSI s} 9B 73 Save cursor
{CSI u} 9B 75 Restore cursor
{CSI ! p} 9B 21 70 Soft reset
{CSI [n[;n]] ]} 9B [n [3B n]...] 5D Set default 1=underline
2=half-intensity 8=colorset
(default=none)
{CSI = [f [;d]] B} 9B 3D [f [3B d]] 46 Set frequency(Hz) and duration (ms)
for bell (default=100Hz, 250ms)
{CSI = [n] F} 9B 3D [n] 46 Set and Save foreground color
{CSI = [n] G} 9B 3D [n] 47 Set and Save background color
Graphic rendition
The graphic rendition codes are as follows:
Number Meaning
0 All attributes off (except charset (10, 11, 12))
1 Bold
2 Half intensity (default to cyan on color screen)
4 Underline (default to red on color screen)
5 Blink
7 Reverse
9 Invisible
10 Exit alternate char set (GR & GL are restored)
11 Enter PC-lower char set (GR & GL are ASCII; C0 & C1 are PC_LO
except for ESC)
12 Enter PC-higher char set (GR, C1 & GL, C0 are PC_HI except for ESC)
21 Normal intensity (un-Bold)
22 Normal intensity (un-Half intensity)
continued. . .

Number Meaning
24 Disable underline
25 Disable blink
27 Disable reverse
29 Visible
30-37 Set foreground color (30+color_number, see below)
39 Set foreground to saved
40-47 Set background color (40+color_number, see below)
49 Set background to saved
Color numbers
The color codes are as follows:
color_number Description
0 Black
1 Red
2 Green
3 Brown
4 Blue
5 Violet
6 Cyan
7 White
Modes
Modes are as follows:
Mode string Description

?1h cursor key = Application
?1l cursor key = ANSI (default)
?3h 132 column (Not Implemented)
continued. . .

Mode string Description

?3l 80 column (default)
?5h Reverse screen
?5l Not Reverse screen (default)
?6h Origin mode
?6l Absolute mode
?7h Auto wrap on
?7l Auto wrap off (default)
?25h Visible cursor (default)
?25l Invisible cursor
?45h Reverse wrap-around mode
?45l No reverse wrap-around
?66h keypad = Application
?66l keypad = ANSI
?67h Backspace key generates BS
?67l Backspace key generates DEL
Mapping from QNX keyboard to ANSI keys

The ANSI key mapping codes are as follows:
Key Normal Shift Ctrl Alt

Enter CR CR CR CR
Tab TAB CSI Z CSI z
BS BS RUB RUB BS
ESC ESC ESC ESC ESC
F1 SS3 P SS3 p CSI 1˜ CSI 17˜
F2 SS3 Q SS3 q CSI 2˜ CSI 18˜
F3 SS3 R SS3 r CSI 3˜ CSI 19˜
F4 SS3 S SS3 s CSI 4˜ CSI 20˜
F5 SS3 T SS3 t CSI 5˜ CSI 21˜
F6 SS3 U SS3 u CSI 6˜ CSI 22˜
continued. . .


F7 SS3 V SS3 v CSI 7˜ CSI 23˜
F8 SS3 W SS3 w CSI 8˜ CSI 24˜
F9 SS3 X SS3 x CSI 9˜ CSI 25˜
F10 SS3 Y SS3 y CSI 10˜ CSI 26˜
F11 SS3 Z SS3 z CSI 11˜ CSI 27˜
F12 SS3 A SS3 a CSI 12˜ CSI 28˜
Home CSI H CSI h CSI H
↑ CSI A CSI a CSI A
PgUp CSI V CSI v CSI V
Minus CSI S CSI s CSI S
← CSI D CSI d CSI D
kpd 5 CSI G CSI g CSI G
→ CSI C CSI c CSI C
Plus CSI T CSI t CSI T
End CSI Y CSI y CSI Y
↓ CSI B CSI b CSI B
PgDn CSI U CSI u CSI U
Ins CSI @ CSI ‘ CSI @
Del CSI P CSI p CSI P
Prt NOP NOP NOP NOP
SysRq NOP NOP NOP NOP
a a A SOH SS2 a
b b B STX SS2 b
c c C ETX SS2 c
d d D EOT SS2 d
e e E ENQ SS2 e
f f F ACK SS2 f
g g G BEL SS2 g
h h H BS SS2 h
continued. . .


i i I HT SS2 i
j j J LF SS2 j
k k K VT SS2 k
l l L FF SS2 l
m m M CR SS2 m
n n N SO SS2 n
o o O SI SS2 o
p p P DLE SS2 p
q q Q DC1 SS2 q
r r R DC2 SS2 r
s s S DC3 SS2 s
t t T DC4 SS2 t
u u U NAK SS2 u
v v V SYN SS2 v
w w W ETB SS2 w
x x X CAN SS2 x
y y Y EM SS2 y
z z Z SUB SS2 z
International keyboard layouts

The devc-con and devc-con-hid managers support international keyboard layouts.
By default, they use the original US-101 layout.
If the file /etc/kbd.tbl is present when you start devc-con or devc-con-hid,
it’s loaded and used instead. You can reload this file at runtime by pressing
Ctrl-Alt-Space. (If you’re using VMWare, you may need to press this twice).
This, like all other key combinations, is subject to configuration! However, it isn’t
possible to redefine compose sequences.
We provide the following layout files, in ${QNX_TARGET}/etc/:
kbd.tbl.de DE-102 (German) layout.
kbd.tbl.us US-101 layout (the default).

The keyboard-layout file’s structure is very simple and rigid. It must contain either
exactly 5 × 96 or exactly 6 × 96 hexadecimal entries, separated by whitespace,
newlines, or commas:
• If the file contains 5 × 96 entries, the left and right Alt keys are both treated as
regular Alt keys.
• If the file has 6 × 96 entries, the right Alt key is treated as an AltGr key, and the last
96 entries must define key codes for each key with AltGr pressed.
Entries must be no longer than 4 hex digits (16 bits) each. Comments start with a
number sign (#) and extend to the end of the line.
Each run of 96 entries defines the semantics of up to 96 different keys under certain
conditions:
Entries: Define semantics for keys:

000–095 Without any modifiers
096–191 With Shift pressed
192–287 With Ctrl pressed
288–383 With Alt pressed
384–479 With Ctrl-Alt pressed
480–575 With AltGr (right Alt) pressed
The 96 entries in a run are indexed by keyboard scan codes. You’ll need to know those
scan codes in order to make up your own keyboard definition. Given below is the
scancode/symbol-mapping for a US-101 keyboard:
0 1 2 3 4 5 6 7 8 9 A B C D E F
, Esc, ’1’, ’2’, ’3’, ’4’, ’5’, ’6’ ’7’, ’8’, ’9’, ’0’, ’-’, ’=’, Rub, Tab ; 00
’q’, ’w’, ’e’, ’r’, ’t’, ’y’, ’u’, ’i’ ’o’, ’p’, ’[’, ’]’, Ent, Ctl, ’a’, ’s’ ; 10
’d’, ’f’, ’g’, ’h’, ’j’, ’k’, ’l’, ’;’ ’’’, ’’, Shf, ’\’, ’z’, ’x’, ’c’, ’v’ ; 20
’b’, ’n’, ’m’, ’,’, ’.’, ’/’, Rsh, ’*’ Alt, SP, Cap, F1, F2, F3, F4, F5 ; 30
F6, F7, F8, F9, F10, Num, Scr, Hom Up, PgU, K-, Lft, K5, Rig, K+, End ; 40
Dwn, PgD, Ins, Del, , , , F11 F12, , , , , , , ; 50
For every scan code, two bytes of data are given by the entries. The high byte defines a
number of flags for the key (see below), while the low byte usually carries the actual
data to be given to the user when the key is pressed. For Shift, Lock, and special keys,
the low byte carries additional, function-dependent information (see below).
The entries’ high bits are as follows:
• 00 — Data key
• 01 — Function key
• 02 — Shift key:
- 0201 — Shift

- 0202 — Ctrl
- 0204 — Alt
- 0208 — Rshift
• 04 — NumLock-dependent
• 08 — Lock key:
- 0801 — ScrollLock
- 0802 — NumLock
- 0804 — CapsLock
• 10 — Dead key
• 20 — CapsLock-dependent
• 40 — Special:
- 4001 — reboot (Ctrl-Alt-Del)
- 4002 — debug (Ctrl-Alt-Esc)
- 4003 — next console (Ctrl-Alt-+ or Ctrl-Alt-Enter)
- 4004 — previous console (Ctrl-Alt--)
- 4005 — console 1 (Ctrl-Alt-1)
- 4006 — console 2 (Ctrl-Alt-2)
...
- 400C — console 8 (Ctrl-Alt-8)
- 400D — console 9 (Ctrl-Alt-9)
- 400E — console 10 (Ctrl-Alt-0)
- 400F — increase font size (Ctrl-Alt->)
- 4010 — decrease font size (Ctrl-Alt-<)
- 4011 — help (Ctrl-Alt-?)
- 4012 — break (Ctrl-Break)
- 4013 — hang up (Ctrl-Alt-End)
- 4020 — print screen (Ctrl-Alt-PrtScn)
- 4021 — hot1 (Ctrl-Alt-F1)
- 4022 — hot2 (Ctrl-Alt-F2)
...
- 402B — reload (Ctrl-Alt-Space)
• 80 — invalid key

Examples:
Typical command line:
devc-con -n4
Files:
/dev/con1, /dev/con2, . . .
Console port devices.
/etc/kbd.tbl The keyboard layout; see “International keyboard layouts,”

above.
Errors:
If an error occurs, the keyboard doesn’t work in text mode.
See also:
devc-*, io-hid, mkkbd
Using the Command Line and Controlling How Neutrino Starts in the Neutrino User’s
Guide

© 2010, QNX Software Systems GmbH & Co. KG. devc-par
Parallel port manager (QNX Neutrino)
Syntax:
devc-par [options] &
Runs on:
Neutrino
Targets:
x86
Options:
-b port Which BIOS port to use (1-4). Don’t use this option with the -p
option.
-p address Base I/O address of the parallel port. The I/O port address may be
specified in hexadecimal form (e.g. 0x140) or octal form (e.g. 0140)
as well as in decimal. Don’t use this option with the -b option.
-N name Register the parallel devices using name as the name (defaults to
par, giving /dev/par).
-O size Size of the output buffer in bytes (default 1000).

background. Use this option if you need to know when the devc-par
device terminates.
-P priority Priority of the writer agent task. Because the writer agent polls the
parallel ports, it should run at a lower priority than most other tasks.
The default priority is 9.
-s number Number of times to check a busy printer before resorting to a 100 ms

sleep. (Default is -1, always sleep if the printer is busy.)
Description:
The devc-par manager is a parallel port manager for QNX Neutrino. It can support
up to 4 parallel ports.
The devc-par driver polls the hardware to detect if a character has been sent.
If you don’t specify any ports (using the -p or -b options), devc-par tries to
interrogate the BIOS area to determine the number of parallel ports detected by the
BIOS. If no ports are found, devc-par silently exits.

devc-par © 2010, QNX Software Systems GmbH & Co. KG.
You can use the -p option to override the use of the BIOS data area (at 0040:0008).
The only translation of output is the mapping of a newline character to a CR/LF if the
OPOST flag is set.
Reading from devc-par works the same as reading from /dev/null.
Examples:
Start devc-par, defaulting for all parallel ports found by the BIOS:
devc-par &
Start devc-par with only the first parallel port:
devc-par -p 0x3f8 &
Or:
devc-par -b 1 &
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devc-pty
Pseudo-tty communications manager (QNX Neutrino)
Syntax:
devc-pty [options] &
Runs on:
Neutrino
Options:
-C size Specify the size of the canonical buffer in bytes (default 256).
-I size Size of input buffer in bytes (default 256).
-n numptys Create numptys ptys (default 8).
-O size Size of output buffer in bytes (default 3 × 512).

background. Use this option if you need to know when the devc-pty
device terminates.
Description:
The devc-pty manager is a small pseudo-tty manager for QNX Neutrino. It can
support up to 256 ptys, using the naming scheme:
• pty[p-zP-T][0-9a-f] for the master device
• tty[p-zP-T][0-9a-f] for the slave device
The master and slave device pair share the same letter and hexadecimal digit.
Examples:
Start devc-pty with 32 ptys:
devc-pty -n 32 &

devc-ser8250 © 2010, QNX Software Systems GmbH & Co. KG.
8250 serial communications manager (QNX Neutrino)
Syntax:
devc-ser8250 [[options]
[port[ˆshift][,intr]]]... &
Runs on:
Neutrino
Targets:
x86, PowerPC, and MIPS hardware with an 8250-compatible UART
Options:
The options are position-dependent and affect the subsequent ports.
-b number The initial baud rate (default 57600).
-C size The size of the canonical buffer in bytes (default 256).
-c clock[/divisor] Define a custom clock rate, in hertz, and divisor for the serial
port. The default (-c 1843200/16) is suitable for compatible
PC serial ports.
-E Start in raw mode (the default). Software flow control is

disabled by default.
-e Start in edited mode (default raw). Software flow control is

enabled by default.
-F Disable hardware flow control (default to hardware flow

control enabled). Hardware flow control is not supported in
edited mode.
-f Enable hardware flow control (default). Hardware flow control

is not supported in edited mode.
-I number The size of the interrupt input buffer in bytes (default 2048).
-O number The size of the interrupt output buffer in bytes (default 2048).

devc-ser8250 device terminates.

© 2010, QNX Software Systems GmbH & Co. KG. devc-ser8250
-S|s Disable / enable software flow control. The default depends on

the mode: in raw mode (-E, the default), it’s disabled; in edited
mode (-e), it’s enabled.
The order in which you specify the -E or -e, and -S or -s
options matters:
Options Mode Software flow control

-e Edited Enabled
-S -e Edited Enabled
-e -S Edited Disabled
-E Raw Disabled
-s -E Raw Disabled
-E -s Raw Enabled
-T number Enable the transmit FIFO and set the number of characters to
be transmitted at each TX interrupt to 1, 4, 8, or 14. The
default is 0 (FIFO disabled).
-t number Enable the receive FIFO and set its threshold to 1, 4, 8, or 14

characters. The default is 0 (trigger disabled).
-u number Append number to the device name prefix (/dev/ser). The

default is 1; additional devices are given increasing numbers.
port The hex I/O address (for x86 systems) or the physical memory
address (for PowerPC and MIPS) of a serial port.
shift The spacing of the device registers as a power of 2. For

example:
0 Registers are 1 byte apart.

1 Registers are 2 bytes apart.
...
n Registers are 2n bytes apart.
The default shift is 0.
intr The interrupt used by this port; specified in hex if prefixed with
0x, otherwise it’s decimal.

Description:
The devc-ser8250 manager is a small serial device manager for QNX Neutrino. It
can support any number of serial ports using 8250s, 14450s or 16550s. Each device
can be assigned its own interrupt, or share an interrupt if the hardware supports
interrupt sharing. If you don’t specify any I/O ports for devices on an x86 system,
devc-ser8250 assumes you want to use the standard PC ports of COM1 (3f8,4) and
COM2 (2f8,3).
The serial driver’s priority floats to the priority of the client. All internal events are
processed at priority 24 (inherited from the internal pulse). The event handling priority
is hard coded and isn’t configurable by any of the options listed. (The driver’s main.c
program would need modification in order to change the priority).
When the driver talks to a client application, it’s running at the priority of the client.
All other processing takes place either at priority 24r or at interrupt time.
Each device is given a name in the pathname space of /dev/sern, where n starts at 1
(unless changed via the -u option) and increases. If you use the default PC serial
ports, this results in:
Device Port Interrupt

/dev/ser1 3f8 4
/dev/ser2 2f8 3
/dev/ser1, /dev/ser2, . . . by adding a line like this to the buildfile used by mkifs:
[type=link] /dev/console = /dev/ser1
All devices are fully interrupt driven and by default support standard hardware flow
control on input and output (RTS/CTS). This can be disabled by the -F option.
Hardware flow control is not supported in edited mode.
A read request by default returns when at least 1 character is available. To increase

efficiency, you can control three parameters to control when a read is satisfied:
Time Return after a specified amount of time has elapsed.
Min Return when this number of characters are in the input buffer.
Char Return if this forwarding character is in the input buffer.

© 2010, QNX Software Systems GmbH & Co. KG. devc-ser8250
If the Min value is greater than the size of the input buffer, the Min value is clipped to
the size of the buffer. To avoid this, the size of the input buffer can be changed with
the -I option.
These parameters are set using library routines (see tcgetattr(), tcsetattr(), readcond()
and TimerTimeout() in the Library Reference).
The devc-ser8250 manager supports both raw and edited modes, making it a real tty
device.
The following fields and flags are supported in the termios structure:
Field Supported flags

c_cc All characters
c_iflag BRKINT ICRNL IGNBRK IXON
c_oflag OPOST
c_cflag CLOCAL CSIZE CSTOPB PARENB PARODD
c_lflag ECHO ECHOE ECHOK ECHONL ICANON IEXTEN ISIG NOFLSH
Examples:
Start devc-ser8250, defaulting for COM1 and COM2:
devc-ser8250 &
Start devc-ser8250, defaulting for COM1 and COM2, but change baud rate to
38400 from 57600 default:
devc-ser8250 -b 38400 &
Start devc-ser8250 with five ports (the last four preset to 38400 baud):
devc-ser8250 3f8,4 -b 38400 280,3 288,3 290,3 298,3 &
You can specify multiple -F and -f options; they’re position-dependent, and affect the
next serial port:
devc-ser8250 -F 3f8,4 -f 2f8,3 &
Start devc-ser8250 on an NEC 4111 eval board (MIPS):
devc-ser8250 0x1600ffc0ˆ1,0x80010007 &

See also:
devc-*

© 2010, QNX Software Systems GmbH & Co. KG. devc-serpci
Driver for serial PCIs
Syntax:
devc-serpci [vid=vid,did=did[,pci=pci]] [options] &
Runs on:
Neutrino
Targets:
x86
Options:
port. The default (-c 1843200/16) is suitable for compatible
PC serial ports.
did=did The PCI device ID, in hexadecimal (0xXXXX).
-E Set options to “raw” (default).
enabled by default.
edited mode.
-I number The size of the raw input buffer in bytes (default 2048).
-O number (“Oh”) The size of the interrupt output buffer in bytes (default
2048).
pci=pci The PCI index, in decimal (XX).
options matters:

devc-serpci © 2010, QNX Software Systems GmbH & Co. KG.

-e Edited Enabled
-E Raw Disabled
-s -E Raw Disabled
-E -s Raw Enabled
-t number Enable the receive FIFO and set its threshold to 1, 4, 8, or 14

characters. The default is 0 (trigger disabled).

-v Increase verbosity.
vid=vid The PCI vendor ID, in hexadecimal (0xXXXX).
Description:
The devc-serpci manager is a small serial device manager for QNX Neutrino. This
driver supports 16Cxxx compatible Serial PCI cards.
The boards must use PCI I/O space for the registers, and the ports must be contiguous
in memory.
See also:
devc-serusb

© 2010, QNX Software Systems GmbH & Co. KG. devc-serusb
Driver for USB-to-serial adaptors
Syntax:
devc-serusb [options]
Runs on:
Neutrino
Targets:
ARMLE, MIPSLE, PPCBE, SHLE, x86
Options:
-d args[,args ...] Device-specific options. See below.
-E Set options to “raw” (default).

enabled by default.
-F Disable hardware flow control (default to hardware flow control

enabled). Hardware flow control is not supported in edited
mode.

-I number The size of the raw input buffer in bytes (default 2048).
-O number (“Oh”) The size of the interrupt output buffer in bytes (default
2048).

options matters:

devc-serusb © 2010, QNX Software Systems GmbH & Co. KG.

-e Edited Enabled
-E Raw Disabled
-s -E Raw Disabled
-E -s Raw Enabled
The device-specific options that you can specify with the -d option are:
busno=bus The bus number of the USB controller.
devno=dev The USB address of the device.
did=did The device ID of the device.
ign_remove Specify to prevent the removal callback from being attached.
module=name Set the hardware module to use for an unknown vendor ID or

device ID.
path=name Connect to the specified USB stack. Default is

/dev/io-usb/io-usb.
pindex=idx Set the port that the index options are to be applied to.
priority=prio Set the priority of the event-processing thread. Default is 21.
query_modules Display the currently supported hardware modules.
rx_urbs=num The number of URBs for BulkIn. Default is 4.
tx_urbs=num The number of URBs for BulkOut. Default is 4.
unit=num The unit number: 1 = /dev/serusb1, 2 = /dev/serusb2,

etc. Default is the first available number, starting from 1.
vid=vid The vendor ID of the device.
wait=num Wait num seconds for the USB stack. Default is 60 seconds.

© 2010, QNX Software Systems GmbH & Co. KG. devc-serusb
Description:
The devc-serusb is a driver for USB-to-serial adaptors.
If you provide the vid, did, busno and devno arguments for device-specific options,
devc-serusb does not attach an insertion callback to detect newly inserted devices.
The driver will work only with the already-inserted device that corresponds to the
arguments specified on the command line. If you do not also specify the ign_remove
option, the driver is terminated when the device is removed.
The unit option has meaning only when the driver is started for a specific device by
using the vid, did, busno and devno arguments. If the driver is managing device
insertions, the default behavior always applies.
Because devc-serusb is a USB class driver, the USB stack (io-usb) must be
running before you start this driver.
See also:
devc-serpci, io-usb

devc-serzscc © 2010, QNX Software Systems GmbH & Co. KG.
Zilog SCC serial communications manager (QNX Neutrino)
Syntax:
devc-serzscc [[options]
[port[ˆshift][+offset][,intr]]]... &
Runs on:
Neutrino
Targets:
PPCBE, x86
Options:
The options are position-dependent and affect the subsequent ports.
-1 Enable only channel A for this device.
-2 Enable both channel A and B for this device.
port. The default is suitable for compatible serial ports.
-D delay Inter-register access delay of delay.
-E Start in raw mode (the default). Software flow control is

disabled by default.

enabled by default.

edited mode.

-I number The size of the interrupt input buffer in bytes (default 2048).
-O number The size of the interrupt output buffer in bytes (default 2048).

© 2010, QNX Software Systems GmbH & Co. KG. devc-serzscc

devc-serzscc device terminates.
options matters:

-e Edited Enabled
-E Raw Disabled
-s -E Raw Disabled
-E -s Raw Enabled

port Hex physical memory address of a serial port.
shift The spacing of the registers as a power of 2. For example:

...
The default shift is 0.
offset Offset to add to the port value.
intr Decimal interrupt used by this port.
Description:
The devc-serzscc manager is a small serial device manager for QNX Neutrino. It
supports the Zilog SCC chip.
All devices are fully interrupt driven and by default support standard hardware flow
control on input and output (RTS/CTS). This can be disabled by the -F option.

devc-serzscc © 2010, QNX Software Systems GmbH & Co. KG.
Hardware flow control is not supported in edited mode.
/dev/ser1, /dev/ser2, . . . by adding a line like this to the buildfile used by mkifs:
[type=link] /dev/console = /dev/ser1
A read request by default returns when at least 1 character is available. To increase

efficiency, you can control three parameters to control when a read is satisfied:
Time Return after a specified amount of time has elapsed.
Min Return when this number of characters are in the input buffer.
Char Return if this forwarding character is in the input buffer.
If the Min value is greater than the size of the input buffer, the Min value is clipped to
the size of the buffer. To avoid this, the size of the input buffer can be changed with
the -I option.
These parameters are set using library routines (see tcgetattr(), tcsetattr(), readcond()
and TimerTimeout() in the Library Reference).
The devc-serzscc manager supports both raw and edited modes, making it a real tty
device.
The following fields and flags are supported in the termios structure:
Field Supported flags

c_cc All characters
c_iflag BRKINT ICRNL IGNBRK IXON
c_oflag OPOST
c_cflag CLOCAL CSIZE CSTOPB PARENB PARODD
c_lflag ECHO ECHOE ECHOK ECHONL ICANON IEXTEN ISIG NOFLSH

© 2010, QNX Software Systems GmbH & Co. KG. devc-serzscc
Examples:
Start devc-serzscc in edited mode, specifying the clock rate, baud rate, and
inter-register access delay:
devc-serzscc -e -c4915200/16 -b9600 -D4000 0x81000000ˆ3+4,0x8002 &
See also:
devc-*

devf-generic © 2010, QNX Software Systems GmbH & Co. KG.
Generic flash filesystem
Syntax:
devf-generic
[-a] [-b priority] [-d log_method] [-E] [-e auto]
[-f verifylevel] [-i arrayindex[,partindex]]
[-l] [-m mountover
[-p backgroundpercent[,superlimit]] [-R] [-r]
[-s base[,wsize[,aoffset[,asize[,usize[,bwidth[,ileave]]]]]]]
[-t threads] [-u update] [-V] [-v]
[-w buffersize]
Runs on:
Neutrino
Targets:
Most flash devices
Options:
-a Don’t automount filesystem partitions present on the media. If
you specify both the -a and -R options, the driver ignores the -R
option.
-b priority Enable background reclaim at the specified priority. By default,

background reclamation is disabled.
-d log_method Control the logging from the flash driver. The possible values for
log_method are:
• 0 — log to stdout (the default).
• 1 — log to slogger.
• 2 — log to both stdout and slogger.
-E Don’t daemonize. If the driver detects a corrupt filesystem, the

exit status is that filesystem’s partition number plus 1.
-e auto Only enumerate the flash partitions, instead of doing a full scan
and mount. The flash driver automounts all partitions with a
partition number less than or equal to auto.
For example, assume we have a flash layout as follows:
• /dev/fs0p0 — raw
• /dev/fs0p1 — formatted

© 2010, QNX Software Systems GmbH & Co. KG. devf-generic
If you start the driver with -e 1, the driver creates all the raw
entries in /dev, but mounts only /dev/fs0p1 (/dev/fs0p0 is
raw, so it’s never mounted, regardless of the -e option)
-f verifylevel Enable flash verify. (default=0, 0=none, write=1, erase=2, all=3)
-i arrayindex[,partindex]
Starting socket index and first partition index; 0 ≥ index ≥15. The
default is 0,0. Use this to give multiple drivers unique IDs. The -i
option is just a suggestion for the resource database manager; the
selected indexes can be larger.
-l List the available flash databases and exit.
-m mountover Override the mountpoints assigned to the file system that are
formatted with an empty (i.e. flashctl -p/dev/fs0p0 -f
-n "") mountpoint. The mountover argument can include two %X
format specifiers (like those for printf()) that are replaced by the
socket index and the partition index.
The -m option doesn’t override a mountpoint specified with mkefs.
-p backgroundpercent[,superlimit]
Set the background-reclaim percentage trigger (stale space over
free space) and, optionally, the superseded extent limit before
reclaim. The default is 100,16.
-R Mount any automount filesystems as read-only. This option

doesn’t affect raw partition mounts, and it has an effect only at
startup and initialization. Any subsequent mounting (with either
flashctl or mount) ignores the -R option. If you also specify
the -a option, the driver ignores the -R option.
-r Enable fault recovery for dirty extents, dangling extents, and

partial reclaims.
You should always specify the -r option unless you’re trying to debug an issue
concerning flash corruption.
If you don’t specify -r, and a power failure occurs, the following
can happen:
• You can waste space. If an erasure was happening when the
power was cut off, there will be some “dangling” extents (i.e.
marked for deletion, but not actually deleted). If you specify
the -vv option, the driver prints dangle for every dangling
extent found. These extents will continue to occupy space

forever, until they’re deleted. Using the -r option will cause

them to be reclaimed.
• The system may be marked as read-only. If the driver detects
an error in the structure of the filesystem, and you haven’t
specified the -r option, the driver marks the partition as
read-only, so that it can’t be further damaged.
• If a reclaim operation is interrupted by a power loss, the spare
block may be unusable. In this case, if you specify the -vv
option, the driver prints partial to the console. The partition
is still read-write, but reclaims are turned off; if you continue to
overwrite files, you’ll eventually fill the filesystem with stale
data.
-s base[,wsize[,aoffset[,asize[,usize[,bwidth[,ileave]]]]]]
Set socket options, normally the base physical address, window
size, array offset, array size, unit size, bus width, and interleave.
The format is left flexible for socket services with customized
drivers. This option must be specified.
The arguments are:
base Physical base address of the flash part. This value is

board-specific.
wsize Size of the physically contiguous flash part.
aoffset For SRAM, the offset from the base address to the start of
the flash array.
asize For SRAM, the size of the flash array. The default is
equal to wsize.
usize The size of a physical erase sector. For SRAM, this
number can be any power of two. 64 KB should be the
minimum, for performance reasons.
bwidth The total width of the data bus, as seen from the
microprocessor’s perspective. This is the width of one
flash chip multiplied by the interleave. The value must be
a power of 2 (1, 2, 4, or 8).
ileave The number of flash chips arranged on the data bus. Two
16-bit wide chips used as the upper and lower halves of a
32-bit databus give an interleave of 2. This number must
be a power of 2 (1, 2, 4, or 8).
You can specify the base physical address, sizes, and offset in
octal (1000), hexadecimal (0x200), or decimal (512). The sizes
must be a power of two, and you can specify them with any of the
following suffixes:
• (nothing) — bytes

• k — kilobytes
• m — megabytes
-t threads The number of threads. The minimum is 1, the default is 2, and

the maximum is 100. Extra threads increase performance when
background reclaiming is enabled (with the -b option) and when
multiple chips and/or spare blocks are available.
-u update Specify the update level for timestamps. POSIX specifies that
timestamps be kept when you access, create, or modify a file.
FFSv3 is documented as not supporting the access timestamp, in
order to reduce wear on the hardware.
The values for update are:
• 0 — don’t update the modification time for files (the default).
• 1 — update the modification time for files according to the
POSIX rules.
• 2 — update the modification time for files, as well as for the
parent directory.
The -u2 option is very, very expensive and will cause many reclaims because the time
updates have to flow right up to the root directory, so one file update may cause many
directory updates.
-V Display filesystem and MTD version information, and then exit.
-v Be verbose; specify additional v characters for more verbosity.

For more information, see “Verbose output,” below.
-w buffersize Write (append) buffer size in bytes. The default buffersize is 512.
Using a larger write-buffer prevents the creation of very small
extents, reducing overhead. If buffersize is 0, appending is
disabled.
Description:
The devf-generic manager provides Flash filesystem support for any standard flash
device. Typically, all you need to do is to pass the address and size using the -s
option. The manager should detect the device automatically.
For information on creating a custom variant of devf-generic for your embedded
system, see the Customizing the Flash Filesystem chapter of Building Embedded
Systems
The default filenames are as follows (you can use the -i option to change the ID, n,
appended to /dev/fs):
/dev/fsn Default mountpoint for socket n.

/dev/fsnp0 Raw access for socket n, partition 0.
mountpoint Flash filesystem mountpoint for socket n, partition 0 with

transparent decompression.
You can specify the mountpoint above with the mount attribute of the mkefs
command, and override it with the -n option to flashctl. By default, it’s /fsnp0.
If you erase a raw partition or the raw array (socket), you might erase any boot
monitor, BIOS, or other data installed by the manufacturer. Check the documentation
for the board.
The driver probes the hardware to determine its block size. If you need to know the
block size, you can:
• Look in the documentation for the hardware.

Or:
• Start the driver in verbose mode by specifying the -v option. In the output, U:
indicates the number of units (also known as blocks or sectors), and S: indicates
the block size. Both numbers are in hexadecimal.
Or:
• Start the driver, and then run flashctl, specifying the -i option.
Verbose output
If you specify the -v option, a devf-* driver provides some useful information. This
section describes the output that you get if you specify -vvv; at higher levels of
verbosity, the output also includes messages about the use of malloc() and free(), but
these aren’t likely to be useful to you.
The output starts with something like this:
Flash Development Library - HEAD

Build: Jan 15 2010 13:00:00
MTD Build: Jan 15 2010, 13:25:55
These lines identify the source branch of the build, as well as the build times for
libfs-flash3.a and libmtd-flash.a.
The rest of the messages that the driver prints are variable; messages are printed as the
driver discovers things of interest. The general format of a message is
(devf tN ::function:line) Message string
where tN is the thread printing the message, function is the function emitting the
message, and line is the line number that emitted the message.
The standard messages include the following:

(devf t1::f3s_skt_attach:109) fs0 socket RAM (flash simulation)

The flash driver located a flash socket, number zero (fs0). This message also
indicates that the hardware identification succeeded.
(devf t1::f3s_flash_probe:248) chip total = 1, bus_width = 8,
interleave = 2
After identifying the hardware, the driver prints the geometry. The chip total is
the number of contiguous chips. The bus width is the size of the data bus, in
bytes. The interleave is the number of physical chips sharing the data bus (high
and low halves of the data bus, for example).
This particular example indicates that there are two physical chips sharing a
64-bit data bus.
(devf t1::f3s_skt_attach:135) fs0 array SRAM U: 80 S: 020000

The flash driver has allocated the flash array (i.e. the storage media) of type
SRAM, with 0x80 hardware sectors, and a sector size of 0x020000 bytes.
(devf t1::f3s_recover_boot:248) fs0p0 boot P[00] U: 80
The filesystem is now scanning for partitions. It has found a boot header, and
has named the partition /dev/fs0p0. The boot signature is located on physical
block 0, and the partition has 0x80 sectors (called “units” in devf-*
nomenclature).
(devf t1::f3s_recover_reclaim:989) fs0p0 spare P[7F]
The second phase of the startup scan is processing /dev/fs0p0, and has found
a spare block. The spare block is located on physical sector 0x7F.
(devf t3::f3s_table_find:66) fs0p1 raw U: 09
A region of flash was found that isn’t formatted. The region is given the name
/dev/fs0p1; its size is 0x09 sectors.
Examples:
Start devf-generic and automatically mount the flash filesystem partitions at the
base address 0xFF000 with a window size of 16 megabytes, with an initial fault
recovery process, most POSIX semantics enabled and background reclaim at priority
5:
devf-generic -s 0xFF000,16M -r -u2 -b5 &

Create a 32 MB flash partition, with a 64 KB unit (sector) size:
devf-generic -s0,32m,,,64k -v -r
Create a 128 MB flash partition, with large block sizes (to speed formatting):
Create a 4 MB partition:

Create a 16 MB flash partition, from a given physical address, with a 128 KB unit size,
and a 16-bit wide data bus:
devf-generic -s0xa4000000,16m,,,128k,2 -v -r
Create a 16 MB flash partition, from a given physical address, with a 256 KB unit size,
and a 32-bit-wide data bus, with an interleave of two:
devf-generic -s0,16m,,,256k,4,2 -v -r
Caveats:
You must specify the -s option when using this driver.
Although the Flash filesystem supports most POSIX semantics, some functionality
isn’t implemented in order to keep the driver simple and efficient. The unsupported
POSIX semantics include:
• Hard links, and everything related to hard links (the . and .. directories don’t
exist, struct stat’s nlink member is hard-coded, and unlink() of directories
returns ENOTSUP).
• Access times aren’t updated on the media; they’re set to the modification time.
QNX Neutrino flash filesystem version 3 no longer provides built-in decompression.

The flash filesystem’s decompression functionality has moved into the inflator
resource manager. You should now use the deflate utility to compress files.
Performance might be slow when multiple writers are writing randomly to a shared
file or to a shared directory (e.g. using unlink or rename). In these cases, the offset
pointers have to be rewound for every access. There’s no performance penalty when
appending to a file, or when creating files with open(O_CREAT), mkdir, mknod, or
link.
See also:
deflate, devf-ram, flashctl, inflator, mkefs
“Flash filesystems” in the Working With Filesystems chapter of the User’s Guide
Customizing the Flash Filesystem chapter of Building Embedded Systems

© 2010, QNX Software Systems GmbH & Co. KG. devf-ram
Simulate flash filesystem using RAM memory
Syntax:
devf-ram
[-a] [-b priority]
[-E] [-f verifylevel] [-i arrayindex[,partindex]]
[-l] [-m mountover]
[-p backgroundpercent[,superlimit]] [-R] [-r]
[-s base[,wsize[,aoffset[,asize[,usize[,bwidth[,ileave]]]]]]]
[-t threads] [-u update] [-V] [-v]
[-w buffersize]
Runs on:
Neutrino
Targets:
MIPS, PowerPC, x86, SH, and ARM
Options:
-a Don’t automount filesystem partitions present on the media. If you
specify both the -a and -R options, the driver ignores the -R
option.
-b priority Enable background reclaim at the specified priority. By default,

background reclamation is disabled.
-E Don’t daemonize. If the driver detects a corrupt filesystem, the exit

status is that filesystem’s partition number plus 1.
-f verifylevel Simulate flash verify; only provided for syntax compatibility with
real flash hardware (default=0, 0=none, write=1, erase=2, all=3).
-i arrayindex[,partindex]
Starting socket index and first partition index; 0 ≥ index ≥15. The
default is 0,0. Use this to give multiple drivers unique IDs. The -i
option is just a suggestion for the resource database manager; the
selected indexes can be larger.
-l List the available flash databases and exit.
-m mountover Override the mountpoints assigned to a file system that are

formatted with an empty (i.e. flashctl -p/dev/fs0p0 -e -f
-n "") mountpoint. The mountover argument can include two %X
format specifiers (like those for printf()) that are replaced by the
socket index and the partition index.

devf-ram © 2010, QNX Software Systems GmbH & Co. KG.
The -m option doesn’t override a mountpoint specified with mkefs.
-p backgroundpercent[,superlimit]
Set the background-reclaim percentage trigger (stale space over
free space) and, optionally, the superseded extent limit before
reclaim. The default is 100,16.
-R Mount any automount filesystems as read-only. This option

doesn’t affect raw partition mounts, and it has an effect only at
startup and initialization. Any subsequent mounting (with either
flashctl or mount) ignores the -R option. If you also specify
the -a option, the driver ignores the -R option.
-r Enable fault recovery for dirty extents, dangling extents, and

partial reclaims.
You should always specify the -r option unless you’re trying to debug an issue
concerning flash corruption.
If you don’t specify -r, and a power failure occurs, the following
can happen:
• You can waste space. If an erasure was happening when the
power was cut off, there will be some “dangling” extents (i.e.
marked for deletion, but not actually deleted). If you specify the
-vv option, the driver prints dangle for every dangling extent
found. These extents will continue to occupy space forever,
until they’re deleted. Using the -r option will cause them to be
reclaimed.
• The system may be marked as read-only. If the driver detects an
error in the structure of the filesystem, and you haven’t specified
the -r option, the driver marks the partition as read-only, so that
it can’t be further damaged.
• If a reclaim operation is interrupted by a power loss, the spare
block may be unusable. In this case, if you specify the -vv
option, the driver prints partial to the console. The partition
is still read-write, but reclaims are turned off; if you continue to
overwrite files, you’ll eventually fill the filesystem with stale
data.
-s base[,wsize[,aoffset[,asize[,usize[,bwidth[,ileave]]]]]]
Set socket options, normally the base physical address, window
size, array offset, array size, unit size, bus width, and interleave.
The format is left flexible for socket services with customized
drivers.
The arguments are:

base Physical base address of the flash part. This value is

board-specific.
For the devf-ram utility, the base argument carries a special meaning:
0 Allocate system memory.
Nonzero Use the exact physical address. You must
exercise caution here. See the caveats below.
wsize Size of the physically contiguous flash part.
aoffset For SRAM, the offset from the base address to the start of
the flash array.
asize For SRAM, the size of the flash array. The default is
equal to wsize.
usize The size of a physical erase sector. For SRAM, this
number can be any power of two. 64 KB should be the
minimum, for performance reasons.
bwidth The total width of the data bus, as seen from the
microprocessor’s perspective. This is the width of one
simulated flash chip multiplied by the interleave. This
value must be a power of 2 (1, 2, 4, or 8).
ileave The number of simulated flash chips arranged on the data
bus. This value must be a power of 2 (1, 2, 4, or 8).
You can specify the base physical address, sizes, and offset in octal
(0777), hexadecimal (0x1ff), or decimal (511). The sizes must
be a power of two, and you can specify them with any of the
following suffixes:
• (nothing) — bytes
• k — kilobytes
• m — megabytes
On ARM targets, devf-ram can’t resize the shared object /dev/shmem/fs*. If you
need to restart devf-ram with a new size, first unlink the old shared object:
rm /dev/shmem/fs*
-t threads The number of threads. The minimum is 1, the default is 2, and the
maximum is 100. Extra threads increase performance when
background reclaiming is enabled (with the -b option) and when
multiple chips and/or spare blocks are available.
-u update Specify the update level for timestamps. POSIX specifies that
timestamps be kept when you access, create, or modify a file.
FFSv3 is documented as not supporting the access timestamp, in
order to reduce wear on the hardware.

The values for update are:

• 0 — don’t update the modification time for files (the default).
• 1 — update the modification time for files according to the
POSIX rules.
• 2 — update the modification time for files, as well as for the
parent directory.
The -u2 option is very, very expensive and will cause many reclaims because the time
updates have to flow right up to the root directory, so one file update may cause many
directory updates.
-V Display filesystem and MTD version information, and then exit.
-v Be verbose; specify additional v characters for more verbosity. For

more information, see “Verbose output” in the entry for
devf-generic.
-w buffersize Write (append) buffer size in bytes. The default buffersize is 512.
Using a larger write-buffer prevents the creation of very small
extents, reducing overhead. If buffersize is 0, appending is
disabled.
Description:
The devf-ram manager simulates flash filesystem in RAM using the following
default filenames (the ID, n, appended to /dev/fs can be changed via the -i option):
/dev/fsn Default mountpoint for socket n.
/dev/fsnp0 Raw access for socket n, partition 0.
mountpoint Flash filesystem mountpoint for socket n, partition 0 with

transparent decompression.
You can specify the mountpoint above with the mount attribute of the mkefs
command, and override it with the -n option to flashctl. By default, it’s /fsnp0.
Examples:
Start devf-ram with a 16 MB partition.
devf-ram -s0,16m
Start devf-ram and automatically mount the flash filesystem partitions, with an initial
fault recovery process, most POSIX semantics enabled and background reclaim at
priority 5 (default size: 1 MB):
devf-ram -r -u2 -b5 &

Create a 32 MB flash partition, allocated from system RAM, with a 64 KB unit

(sector) size:
devf-ram -s0,32m,,,64k -v -r
Create a 128 MB flash partition in system RAM, with large block sizes (to speed
formatting):
Create a 4 MB partition from system RAM:
You must format and erase a devf-ram partition before you can mount the flash
filesystem. See the caveats below.
If you specify a block size in your buildfile for DRAM-based flash filesystems, limit
the size to the default, which is 64 KB.
Caveats:
Although the flash filesystem supports most POSIX semantics, some functionality
isn’t implemented in order to keep the driver simple and efficient. The unsupported
POSIX semantics include:
• Hard links, and everything related to hard links (the . and .. directories don’t
exist, struct stat’s nlink member is hard-coded, and unlink() of directories
returns ENOTSUP).
• Access times aren’t updated on the media; they’re set to the modification time.

Performance might be slow when multiple writers are writing randomly to a shared
file or to a shared directory (e.g. using unlink or rename). In these cases, the offset
pointers have to be rewound for every access. There’s no performance penalty when
appending to a file, or when creating files with open(O_CREAT), mkdir, mknod, or
link.
Don’t try to create a devf-ram partition at the address of a real flash memory. You
may get an error message: Unable to properly identify any flash
devices.
Don’t try to create a devf-ram partition (e.g. using nonzero value for base argument)
at the address of physical memory that is in use. It may destroy applications and crash
the operating system. The only use for specifying such nonzero base is to create a
flash filesystem for board specific memory (e.g. SRAM).
You must format and erase a devf-ram partition before you can mount the flash
filesystem. e.g.

devf-ram -s0,16m
flashctl -p /dev/fs0p0 -e -f -m
If there’s insufficient RAM, when you try to create an nM size partition with -s0
option, the devf-ram driver returns without an error message. The partition isn’t
created.
See also:
deflate, devf-generic, flashctl, inflator, mkefs
“Flash filesystems” in the Working With Filesystems chapter of the User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. devg-ati_rage128.so
Graphics driver for ATI RAGE 128/128 Pro chipsets
Syntax:
io-display [-vf]
-d vid=[0x]vendor_id,did=[0x]device_id[,deviceindex=index]
[-c config_file] [-p priority]
Runs on:
Neutrino
Targets:
x86, PowerPC, MIPS
Options:
For the io-display options that you can use with this driver, see io-display.
Description:
The devg-ati_rage128.so driver provides accelerated 2D support for the specified
graphics chipsets.
Supported chipsets
• ATI RAGE 128 GL
• ATI RAGE 128 VR
• ATI RAGE 128 Pro GL
• ATI RAGE 128 Pro VR
• ATI RAGE Mobility M3
• ATI RAGE Mobility M4
Acceleration features
Feature Provision
Solid fills Yes
Pattern fills Yes
Onscreen blitting Yes
continued. . .

devg-ati_rage128.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Offscreen blitting Yes
Chroma-keyed blitting Yes
Alpha blending No
Raster OPs Full
Bitmaps No
Video Overlay/Scaler support

Feature Provision
YUV formats Yes (packed)
RGB formats Yes (RGB 565, 555, 8888)
Up scaling Yes
Down scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
DPMS (power saving) Yes
Resolution and refresh support

Display size (pixels): Refresh rate (Hz): Color depth (bits per pixel):
640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1440x900 60, 70, 75, 85 8, 15, 16, 32
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-ati_rage128.so
1600x1200 60, 70, 75, 85 8, 15, 16, 32
Files:
This driver needs the following at run time:
libffb.so Software rasterization library.
See also:
io-display

devg-carmine.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for Fujitsu Carmine chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
SHLE, x86, PowerPC
Options:
For the general io-display options that you can use with this driver, see
io-display.
You can set configuration options that are specific to this driver by using the
modeopts setting in display.conf:
modeopts=config-file
The full path to the configuration file for the driver. For example,
carmine.conf is located in /usr/photon/config so that
modeopts=/usr/photon/config/carmine.conf.
Description:
The devg-carmine.so driver provides accelerated 2D and 3D support for the
Fujitsu Carmine graphics controller.
You can edit the configuration file to enable devg-carmine.so to run on your board.
Follow the editing instructions in the sample file,
/usr/photon/config/carmine.conf, to specify the correct configuration for the
required display mode. (For a more detailed explanation of the display settings, see the
appropriate Fujitsu documentation.)
If you use a configuration file for this driver, you must use the modeopts setting in
your display.conf configuration file to specify its location.

© 2010, QNX Software Systems GmbH & Co. KG. devg-carmine.so
Supported chipsets
• Fujitsu MB86297 Carmine
2D Acceleration features
Feature Provision
Solid fills Yes
Bresenham lines Yes
Pattern fills No
Polygons Yes
Alpha blending Yes
Raster OP’s 16
Bitmaps Yes
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture Yes
Layers supported 8

devg-carmine.so © 2010, QNX Software Systems GmbH & Co. KG.

640x480 60 15, 32
800x600 60 15, 32
1024x768 60 15, 32
Restrictions:
• You can use the configuration file to specify other resolutions and refresh rates.
The carmine.conf file

The carmine.conf file provides additional control over the driver, including
dual-head support. This file is also required for providing additional configuration for
panel displays. The file (by default located in /usr/photon/config/) contains a
description of each option, and several preconfigured command lines for various
Carmine device and display combinations.
The Carmine chipset supports two display controllers. In carmine.conf,
display-related settings may be specified independently for each display controller.
Additionally, you can use the configuration file to configure:
• memory controller initialization sequence
• layer per-pixel blending mode: inline alpha vs. separate alpha layers
• LVDS reset sequence, using the output of the GV pin
See the comments in the sample configuration file for more details.
Alpha layer support

The alpha layers work in one of two modes on the Carmine:
• In the default mode, there is a single layer supporting per-pixel alpha (compared to
four alpha layers in the second mode). The alpha values are inlined with the RGB
values in this mode, as opposed to being on a separate alpha layer. However, this
inline alpha mode is supported only on one layer, which is GF layer index 2. This
mode provides flexibility: you can, for example, use the alpha values generated by
OpenGL ES to do some interesting effects.
• In the second mode, there are 4 special-purpose alpha layers, which are in addition
to the 8 color layers.
In the GF API, the gf_alpha_t alpha map is configured for blending with an
RGB layer as follows:
gf_alpha_t alpha;
memset(&alpha, 0, sizeof(alpha));

© 2010, QNX Software Systems GmbH & Co. KG. devg-carmine.so
alpha.mode = GF_ALPHA_M1_MAP | GF_BLEND_SRC_M1 |

GF_BLEND_DST_1mM1;
alpha.map = asurf;
gf_layer_set_blending(fglayer, &alpha);
In the above example, the driver internally picks one of the four alpha layers (if
there is still one available) and uses it.
The two modes of alpha layer operation are mutually exclusive, and must be selected
via the carmine.conf configuration file. The mode of operation can’t be changed at
runtime. By default, the inline alpha mode is used. To use the other mode, specify this
option in the configuration file:
alphamap=1
Files:
See also:
io-display
/usr/photon/config/carmine.conf

devg-chips.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for Chips and Technologies graphics chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
MIPSLE, PowerPC, SHLE, x86, ARMLE
Options:
io-display.
The full path to the configuration file for the driver. For example chips.conf
is located in /usr/photon/config by default so that
modeopts=/usr/photon/config/chips.conf.
Description:
The devg-chips.so driver provides accelerated 2D support for Chips and
Technologies graphics chipsets.
You can edit the configuration file to enable devg-chips.so to run on your board.
For more information on the options available, see the sample configuration file,
/usr/photon/config/chips.conf.
your display.conf to specify its location.
Supported chipsets
• 65550
• 65554
• 65555

© 2010, QNX Software Systems GmbH & Co. KG. devg-chips.so
• 69000
• 69030
Feature Provision
Solid fills Yes
Bresenham lines No
Pattern fills Yes
Polygons No
Alpha blending No
Raster OPs Full
Bitmaps No

Feature Provision
YUV formats Yes
RGB formats Yes
Up scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No

devg-chips.so © 2010, QNX Software Systems GmbH & Co. KG.
Display size (pixels): Refresh rate(Hz): Color depth (bits per pixel):
640x480 60, 72, 75, 85 8, 15, 16, 24
800x600 60, 70, 75, 85 8, 15, 16, 24
1024x768 60, 70, 75, 85 8, 15, 16, 24
1152x864 60, 70, 75, 85 8, 15, 16, 24
1280x800 60, 72, 75, 85 8, 15, 16, 24
1280x1024 60, 72, 75, 85 8, 15, 16, 24
1440x900 60, 72, 75, 85 8, 15, 16, 24
1600x1200 60, 72, 75, 85 8, 15, 16, 24
Restrictions:
• These values are typical; the actual ones may depend on your BIOS and monitor
(x86 only).
• Higher resolution and color depths may require more video RAM.
Files:
See also:
io-display
/usr/photon/config/chips.conf

© 2010, QNX Software Systems GmbH & Co. KG. devg-coral.so
Graphics driver for Fujitsu Coral chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
ARMLE, PowerPC, SHLE, x86
Options:
io-display.
The full path to the configuration file for the driver. For example, coral.conf
is located in /usr/photon/config so that
modeopts=/usr/photon/config/coral.conf.
Description:
The devg-coral.so driver provides accelerated 2D support for the Fujitsu Coral
graphics controller.
You can edit the configuration file to enable devg-coral.so to run on your board.
/usr/photon/config/coral.conf, to specify the correct configuration for the
appropriate Fujitsu documentation.)

devg-coral.so © 2010, QNX Software Systems GmbH & Co. KG.
Supported chipsets
• Fujitsu MB86294 Coral B
• Fujitsu MB86295 Coral P
• Fujitsu MB86296 Coral PA
Feature Provision
Solid fills Yes
Bresenham lines Yes
Pattern fills No
Polygons Yes
Alpha blending Yes
Raster OPs Full
Bitmaps Yes

Feature Provision
YUV formats Yes
RGB formats Yes
Up scaling No

Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture Yes
Layers supported 6

640x480 60 8, 15
800x600 60 8, 15a
1024x768 60 8, 15a
a Requires a driver configuration file.
Restrictions:
• You can use the driver-configuration file to specify other resolutions and refresh
rates.
The coral.conf file and dual-head

The coral.conf file provides additional control over the driver, including dual-head
support (dual-head display is supported by Coral-PA-based devices only). This file is
also required for providing additional configuration for panel displays. The file (by
default located in /usr/photon/config/) contains a description of each option,
and several pre-configured command-lines for various Coral device and display
combinations.
For dual-head configurations, both displays will run at the same resolution/refresh rate
- independent control is not available.
• The Coral-PA reference card does not support dual-display on its own, a special
adapter card is necessary.
• The maximum supported resolution for dual-display is 800x480 at 66 MHz.
In coral.conf there are three parameters of note:
• dlayers — SC0en & SC1en fields for Multi-Display Control register

devg-coral.so © 2010, QNX Software Systems GmbH & Co. KG.
• dmode — Dual Display mode (0 = single display, 1 = dual parallel mode, 2 = dual
multiplexed mode)
• dcm — Display Clock. This needs to be configured to twice the value as would be
required single display. For example, to run two 640x480 displays, change
dcm=0x700 to dcm=0x300
In the Coral-PA Documentation (section 7.10 Dual Display), you’ll see that the
SC0-en field of the Multi-Display Control register defines which layers and cursors are
included in screen 0, and the SC1-en field defines which layers and cursors are
included in screen 1. A layer or cursor can be included in one or both screens.
SC0en and SC1en are 8-bit values. The dlayers parameter is 16-bit with SC1 being the
top 8-bits. A 1 indicates the layer is included in the display.
The bit layout for the dlayers parameter is as follows:
bit description
0 L0 is included in screen 0
6 Cursor0 is included in screen 0
7 Cursor1 is included in screen 0
14 Cursor 0 is included in screen 1
15 Cursor 1 is included in screen 1
To include all layers and cursors on both displays, set dlayers=0xFFFF (This is the
default). The driver default for dmode is 0 for single display.
There are two modes to output two screens. In parallel mode, one screen is output at
digital RGB while another is output at analog RGB. In multiplex mode, two screens

are multiplexed and output at digital RGB. Which version is used will depend on
hardware and requirements.
For example, to run in parallel mode with Layers 0, 1 and Cursor 0 on screen 0 and the
rest of the layers on screen 1 you would set:
dlayers=0xBC83
dmode=1
The application code needs to then connect and draw to the proper layers.
Files:
See also:
io-display
/usr/photon/config/coral.conf

devg-extreme2.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for Intel Extreme2 chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-extreme2.so driver provides 2D and 3D support for the specified
graphics chipsets.
Supported chipsets
• Intel 82852
• Intel 82854
• Intel 82855
• Intel 82865
Feature Provision
Solid fills Yes
Bresenham lines Yes
Pattern fills Yes
Polygons No
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-extreme2.so
Feature Provision
Alpha blending Yes
Raster OP’s Full
Bitmaps No
Scaled blitting Yes

None
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
Layers 4a
a Layer 1 is YUV format only.

640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1600X1200 60, 70, 75, 85 8, 15, 16, 32
Restrictions:
• BIOS capability determines which of these resolutions and color depths are
available on your system.

devg-extreme2.so © 2010, QNX Software Systems GmbH & Co. KG.
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-flat.so
Graphics driver for unaccelerated flat frame buffers
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86, PowerPC, ARMLE, MIPS, SHLE
Options:
io-display.
You can set configuration options that are specific to this driver by using the memopts
setting in display.conf:
memopts=config-file
The full path to the configuration file for the driver. For example, flat.conf is
located in /usr/photon/config and describes the supported options.
Description:
The devg-flat.so driver provides unaccelerated flat support for frame buffers.
Files:
See also:
io-display

devg-geode.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for AMD Geode and Media GX chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-geode.so driver provides accelerated 2D support for the specified
graphics chipsets.
Supported chipsets
• Media GX
• Geode GX1
• Geode GXLV
• SC1200
Feature Provision
Solid fills Yes
Pattern fills Yes
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-geode.so
Feature Provision
Chroma-keyed blitting No
Alpha blending No
Raster OPs No
Bitmaps Yes
Feature Provision
RGB formats Yes (RGB 565)
Up scaling Yes
Down scaling No
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
640x480 60 8, 15, 16
800x600 60 8, 15, 16
1024x768 60 8, 15, 16
1280x1024 60 8
Restrictions:
• These are typical values; the actual ones may depend on your video BIOS.

devg-geode.so © 2010, QNX Software Systems GmbH & Co. KG.
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-gma9xx.so
Graphics driver for Intel 945GX and 945GMx chipsets
Syntax:
io-display [-vf]
Runs on:
x86
Options:
io-display.
Description:
The devg-gma9xx.so driver provides 2D and 3D support for the specified graphics
chipsets.
Supported chipsets
• Intel 915G
• Intel 915GM
• Intel 945G
• Intel 915GM
Feature Provision
Solid fills Yes
Bresenham lines Yes
Pattern fills Yes
Polygons No
continued. . .

devg-gma9xx.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Alpha blending Yes
Raster OP’s Full
Bitmaps No
Scaled blitting Yes

None
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
Layers 4a
a Layer 1 is YUV format only.

640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1600X1200 60, 70, 75, 85 8, 15, 16, 32
Restrictions:
Files:

© 2010, QNX Software Systems GmbH & Co. KG. devg-gma9xx.so
See also:
io-display

devg-i810.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for Intel I810 and I815 chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-i810.so driver provides accelerated 2D support for the specified graphics
chipsets.
Supported chipsets
• Intel 82810
• Intel 82810 DC100
• Intel 82810E
• Intel 82815
Feature Provision
Solid fills Yes
Pattern fills Yes
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-i810.so
Feature Provision
Alpha blending No
Raster OPs Full
Bitmaps No
Feature Provision
RGB formats Yes (RGB 555, 565)
Up scaling Yes
Down scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
TV Out Yes (PAL and NTSC)
Video capture No
Restrictions:
• TV Out requires a Chrontel CH7007 chip
640x480 60, 70, 75, 85 8, 15, 16, 24
800x600 60, 70, 75, 85 8, 15, 16, 24
1024x768 60, 70, 75, 85 8, 15, 16, 24
continued. . .

1152x864 60, 70, 75, 85 8, 15, 16, 24
1280x800 60, 70, 75, 85 8, 15, 16, 24
1280x1024 60, 70, 75, 85 8, 15, 16, 24
1440x900 60, 70, 75, 85 8, 15, 16, 24
1600x1200 60, 70, 75, 85 8, 15, 16, 24
Files:
See also:
io-display

Graphics driver for Intel chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-i830.so driver provides accelerated 2D support for graphics chips.
Supported chipsets
• Intel 830
• Intel 845
• Intel 852
• Intel 855
• Intel 865
• Intel 915
• Intel 945
• Intel 965 chipset with integrated graphics

Feature Provision
Solid fills Yes
Bresenham lines No
Pattern fills Yes
Polygons No
Alpha blending No
Raster OPs Full
Bitmaps No
Feature Provision
YUV formats Yes
RGB formats No
Up scaling Yes
Down scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No

640x480 60, 72, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 72, 75, 85 8, 15, 16, 32
1280x1024 60, 72, 75, 85 8, 15, 16, 32
1440x900 60, 72, 75, 85 8, 15, 16, 32
1600x1200 60, 72, 75, 85 8, 15, 16, 32
Restrictions:
• These values are typical; the actual ones may depend on your BIOS and monitor.
• Higher resolutions and color depths may require more video RAM.
Files:
See also:
io-display

devg-intelhd.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for Intel GMA HD graphics
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-intelhd.so driver provides accelerated 2D support for Intel Graphics
Media Accelerator (GMA) High Definition (HD) chips.
Supported chipsets
• Intel Core i3, i5, and i7
Feature Provision
Solid fills Yes
Bresenham lines No
Pattern fills Yes
Polygons No
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-intelhd.so
Feature Provision
Alpha blending No
Raster OPs Full
Bitmaps No
Feature Provision
YUV formats No
RGB formats No
Up scaling No
Down scaling No
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
DPMS (power saving) No
640x480 60, 72, 75, 85 16, 32
800x600 60, 70, 75, 85 16, 32
1024x768 60, 70, 75, 85 16, 32
1152x864 60, 70, 75, 85 16, 32
1280x1024 60, 72, 75, 85 16, 32
1600x1200 60, 72, 75, 85 16, 32
Restrictions:

devg-intelhd.so © 2010, QNX Software Systems GmbH & Co. KG.
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-matroxg.so
Graphics driver for Matrox Millennium G-series chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
For the io-display options that you can use with this driver, see io-display.
Description:
The devg-matroxg.so driver provides accelerated 2D support for the specified
graphics chipsets.
Supported chipsets
• Millennium G550 (dual-head output supported on dual-headed cards)
• Millennium G450 (dual-head output supported on dual-headed cards)
• Millennium G400 (single-output only)
• Millennium G200 (single-output only)
Multiple displays are currently unsupported on quad-output cards.
Feature Provision
Solid fills Yes
Pattern fills Yes
continued. . .

devg-matroxg.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Alpha blending No
Raster OPs Partial
Bitmaps No

Feature Provision
Up scaling Yes
Down scaling No
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No

640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1440x900 60, 70, 75, 85 8, 15, 16, 32
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-matroxg.so
1600x1200 60, 70, 75, 85 8, 15, 16, 32
Files:
See also:
io-display

devg-poulsbo.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for Intel Poulsbo chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
The full path to the configuration file for the driver. For example,
poulsbo.conf is located in /usr/photon/config so that
modeopts=/usr/photon/config/poulsbo.conf.
Description:
The devg-poulsbo.so driver provides accelerated 2D and 3D support. You can edit
the configuration file to enable devg-poulsbo.so to run on your board.
Supported chipsets
• Intel Poulsbo System Controller Hub (SCH)
Feature Provision
Solid fills Yes
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-poulsbo.so
Feature Provision
Bresenham lines Yes
Pattern fills Yes
Polygons Yes
Alpha blending Yes
Raster OP’s Full
Bitmaps No
Scaled blitting Yes

None
Other features
Feature Provision
Hardware Cursor Yes
TV Out yes
Video capture No
Layers 4a
800 x 600 60 15, 16, 32
1024 x 768 60 15, 16, 32
1280 x 1024 60 15, 16, 32
Restrictions:

devg-poulsbo.so © 2010, QNX Software Systems GmbH & Co. KG.
• Other resolutions and refresh rates may be available, but may require you to modify
poulsbo.conf.
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-radeon.so
Graphics driver for ATI RADEON chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86, PowerPC
Options:
io-display.
Description:
The devg-radeon.so driver provides accelerated 2D support for the specified
graphics chipsets.
The DVI (digital video interface) is enabled by default, so you can connect LCD
panels to your Radeon cards. The only requirement is that you connect the LCD to the
DVI connector at boot time so the video BIOS can set up the digital output.
Dual-headed display is supported on cards with dual outputs (x86 only). The video
BIOS initializes both outputs at boot time. Ensure that both outputs are connected.
• If you use devg-radeon.so with two cards that have the same vendor and device
IDs, the driver fails.
• Graphics drivers run at a higher priority than applications, but they shouldn’t run at
a higher priority than the audio, or else breaks in the audio occur. You can use the
on command to adjust the priorities of the audio and graphics drivers.
Supported chipsets
• RADEON
• RADEON VE
• RADEON 7500
• RADEON 8500
• RADEON 9000
• RADEON 9200

devg-radeon.so © 2010, QNX Software Systems GmbH & Co. KG.
• RADEON 9500
• RADEON 9600
• RADEON 9700
• RADEON 9800
• RADEON x300
• RADEON x600
• RADEON MOBILITY M6
Feature Provision
Solid fills Yes
Pattern fills Yes
Alpha blending No
Raster OPs Full
Bitmaps No

Feature Provision
YUV formats Yes (packed and planar)
Up scaling Yes
Down scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-radeon.so
Feature Provision
TV Out No
Video capture No

640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1440x900 60, 70, 75, 85 8, 15, 16, 32
1600x1200 60, 70, 75, 85 8, 15, 16, 32
Restrictions:
• On RADEON MOBILITY chipsets, resolutions and refresh rates are limited by

LCD.
Files:
See also:
io-display

devg-rage.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for ATI RAGE chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-rage.so driver provides accelerated 2D support for the specified graphics
chipsets.
Supported chipsets
• Mach 64 GT
• 3D RAGE
• 3D RAGE II
• 3D RAGE II+
• 3D RAGE PRO
• 3D RAGE PRO LT
• 3D RAGE MOBILITY M/M1/P
• RAGE XL
• RAGE XC
• RAGE IIC

© 2010, QNX Software Systems GmbH & Co. KG. devg-rage.so
Feature Provision
Solid fills Yes
Pattern fills Yes
Alpha blending No
Raster OPs Partial
Bitmaps Yes
Feature Provision
YUV formats Yes (packed and planar)
Up scaling Yes
Down scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
Video capture No
Restrictions:
• TV Out provision depends on BIOS capability.

devg-rage.so © 2010, QNX Software Systems GmbH & Co. KG.
640x480 60, 72, 75, 85 8, 15, 16, 24, 32
800x600 60, 72, 75, 85 8, 15, 16, 24, 32
1024x768 60, 70, 75, 85 8, 15, 16, 24, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 24, 32
Restrictions:
Files:
This driver needs the following at runtime:
libffb.so Software rasterization library
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-s3_savage.so
Graphics driver for S3 Savage chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-s3_savage.so driver provides accelerated 2D support for the specified
graphics chipsets.
Supported chipsets
• S3 Savage4
• Integrated S3 Savage 2000
• VIA Twister T
Feature Provision
Solid fills Yes
Pattern fills No
continued. . .

devg-s3_savage.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Alpha blending No
Raster OPs Partial
Bitmaps No

Feature Provision
RGB formats Yes (RGB 565, 8888)
Up scaling Yes
Down scaling No
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No

640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1440x900 60, 70, 75, 85 8, 15, 16, 32,
1600x1200 60, 70, 75, 85 8, 15, 16, 32

© 2010, QNX Software Systems GmbH & Co. KG. devg-s3_savage.so
Files:
This driver needs the following at runtime:
libffb.so Software rasterization library
See also:
io-display

devg-sis630.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for SIS graphics chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
modeopts setting in display.conf as follows:
modeopts=BIOS
Use video BIOS to detect and set the graphics mode.
Description:
The devg-sis630.so driver provides accelerated 2D support for graphics chips.
Supported chipsets
• SiS 300
• SiS 630
Feature Provision
Solid fills Yes
Bresenham lines Yes
Pattern fills Yes
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. devg-sis630.so
Feature Provision
Polygons No
Alpha blending No
Raster OPs Full
Bitmaps Yes

Feature Provision
YUV formats No
RGB formats No
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No

640x480 60, 72, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 72, 75, 85 8, 15, 16, 32
1280x1024 60, 72, 75, 85 8, 15, 16, 32
1440x900 60, 72, 75, 85 8, 15, 16, 32
continued. . .

devg-sis630.so © 2010, QNX Software Systems GmbH & Co. KG.
1600x1200 60, 72, 75, 85 8, 15, 16, 32
Restrictions:
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-smi5xx.so
Graphics driver for Silicon Motion SM501 chipset
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
ARMLE, MIPSLE, PowerPC, SHLE, x86
Options:
io-display.
The full path to the configuration file for the driver. For example smi5xx.conf
modeopts=/usr/photon/config/smi5xx.conf.
Description:
The devg-smi5xx.so driver provides accelerated 2D support for the Silicon Motion
SM501 graphics chip.
You can edit the configuration file to enable devg-smi5xx.so to run on your board.
/usr/photon/config/smi5xx.conf, to specify the correct configuration for the
appropriate Silicon Motion documentation.)

devg-smi5xx.so © 2010, QNX Software Systems GmbH & Co. KG.
Supported chipsets
• Silicon Motion SM501 (Voyager GX)
Feature Provision
Solid fills Yes
Bresenham lines Yes
Pattern fills Yes
Polygons No
Alpha blending No
Raster OPs Full
Bitmaps Yes

Feature Provision
YUV formats Yes
RGB formats Yes
Up scaling Yes
Down scaling Yes
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
Layers supported 4
continued. . .

Feature Provision
Dual display Yes

Display size (pixels): Refresh rate(Hz): Color depth (bits
640x480 60 8, 16, 32
800x600 60 8, 16, 32a
1024x768 60 8, 16, 32a
a Requires a driver configuration file.
You can use the driver configuration file to configure other resolutions and refresh
rates.
Files:
See also:
io-display
/usr/photon/config/smi5xx.conf

Graphics driver for Silicon Motion Lynx chipset
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
ARMLE, MIPS, PowerPC, x86, SH4
Options:
io-display.
The full path to the configuration file for this driver. For example smi7xx.conf
modeopts=/usr/photon/config/smi7xx.conf.
Description:
The devg-smi7xx.so driver provides accelerated 2D support for the specified
graphics chipset.
You can edit the configuration file to enable devg-smi7xx.so to run on your board.
/usr/photon/config/smi7xx.conf, to specify the correct configuration for the
appropriate Silicon Motion documentation.)
If you use a configuration file for this driver, you must use the modeopts option in

Supported chipsets
• Lynx3DM+ (SM721/SM722)
Feature Provision
Solid fills Yes
Pattern fills No
Alpha blending No
Raster OPs Full

Feature Provision
YUV formats Yes
RGB formats Yes
Up scaling Yes
Down scaling No
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
Layer Support 3 layers
Dual display No

Display size (pixels) Refresh rate(Hz) Color depth (bits per pixel)
640x480 60 8, 15, 16, 24
800x600 60 8, 15, 16, 24a
1024x768 60 8, 15, 16, 24a
a Requires a driver configuration file for non-x86 systems.
Restrictions:
• These are typical values; the actual ones may depend on your BIOS (x86) and
monitor. You can use the configuration file to set up other resolutions and refresh
rates.
• LCD output isn’t supported by default on non-x86 platforms.
Files:
See also:
io-display
/usr/photon/config/smi7xx.conf

© 2010, QNX Software Systems GmbH & Co. KG. devg-soft3d.so
Software 3D graphics module
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
PowerPC, SHLE, x86
Options:
For the general io-display options that can be used with this driver, see
io-display.
Description:
The devg-soft3d.so module provides 3D support in software. It is used
automatically by io-display when it loads graphics drivers that don’t have 3D
accelleration in hardware. For example, it is used for the devg-vmware.so and
devg-vesabios.so drivers.
Supported chipsets
• all chipsets that don’t have 3D accelleration support
None
See also:
io-display

devg-soft3d-fixed.so © 2010, QNX Software Systems GmbH & Co. KG.
Software 3D graphics module
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
ARMLE
Options:
For the general io-display options that can be used with this driver, see
io-display.
Description:
The devg-soft3d-fixed.so module provides 3D support in software using
fixed-point math.
Supported chipsets
• all chipsets that don’t have 3D accelleration support
None
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-svga.so
Generic graphics driver (SVGA)
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-svga.so driver provides support for the specified graphics chipsets.
• This is a “safe”, generic graphics driver. However, it can negatively impact the
timing of a system and affect realtime operations. We recommended you use an
accelerated driver instead, if at all possible.
Supported chipsets
• Super VGA chipsets compliant with Vesa 1.2 (or greater)
None

None
Other features

devg-svga.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Hardware Cursor No
Video capture No
Restrictions:
640x480 60 8, 15, 16
800x600 60 8, 15, 16
1024x768 60 8, 15, 16
1152x864 60 8, 15, 16
1280x1024 60 8, 15, 16
1600X1200 60 8, 15, 16
Restrictions:
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-tnt.so
Graphics driver for NVIDIA chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-tnt.so driver provides accelerated 2D support for the specified graphics
chipsets.
Supported chipsets
• Riva 128
• Riva TNT
• Riva TNT 2
• GeForce
• GeForce2
• GeForce2 GO
Feature Provision
Solid fills Yes
continued. . .

devg-tnt.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Pattern fills Yes
Chroma-keyed blitting No
Alpha blending No
Raster OPs Full
Bitmaps No
Feature Provision
RGB formats No
Up scaling Yes
Down scaling Yes
Restrictions:
• Video overlay is supported only on GeForce and GeForce2 chipsets (not including
GeForce2 GO).
Other features
Feature Provision
Hardware Cursor Yes
TV Out No
Video capture No
DPMS (power saving) No

© 2010, QNX Software Systems GmbH & Co. KG. devg-tnt.so
640x480 60, 70, 75, 85 8, 15, 16, 32
800x600 60, 70, 75, 85 8, 15, 16, 32
1024x768 60, 70, 75, 85 8, 15, 16, 32
1152x864 60, 70, 75, 85 8, 15, 16, 32
1280x800 60, 70, 75, 85 8, 15, 16, 32
1280x1024 60, 70, 75, 85 8, 15, 16, 32
1440x900 60, 70, 75, 85 8, 15, 16, 32
1600X1200 60, 70, 75, 85 8, 15, 16, 32
Restrictions:
• For Riva 128, 16 bits-per-pixel is not supported.
• For flat panel support with GeForce2 GO, make sure the refresh rate is 60 Hz (the
default). The video BIOS capability determines which of these resolutions and
color depths are available on your system.
Files:
See also:
io-display

devg-tvia.so © 2010, QNX Software Systems GmbH & Co. KG.
Graphics driver for TVIA CyberPro chipsets
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
MIPSLE, SHLE, x86
Options:
io-display.
You can set configuration options that are specific to this driver by using the modeopts
setting in display.conf:
The full path to the configuration file for the driver. For example, tvia.conf is
located in /usr/photon/config by default so that the sample file is
/usr/photon/config/tvia.conf.
Description:
The devg-tvia.so driver provides accelerated 2D support for TVIA graphics
chipset.
On non-x86 systems, install jumper JP3 on the reference adapter.
You can edit the configuration file to enable devg-tvia.so to run on your board. For
more information on the options available, see the sample configuration file,
/usr/photon/config/tvia.conf.
If you use a configuration file for this driver, you must use the modeopts in your
display.conf to specify its location.

© 2010, QNX Software Systems GmbH & Co. KG. devg-tvia.so
Supported chipsets
• CyberPro 5200
• CyberPro 5250
• CyberPro 5300
• CyberPro 5305
• CyberPro 5350
• CyberPro 5355
Feature Provision
Solid fills Yes
Bresenham lines No
Pattern fills Yes
Polygons No
Alpha blending No
Raster OPs Full
Bitmaps Yes
Feature Provision
YUV formats Yes (Packed)
RGB formats Yes (RGB 555, 565, 888, 8888)
Up scaling Yes
Down scaling No
Other features

devg-tvia.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Hardware Cursor Yes
TV Out (PAL and NTSC) Yes
Video capture No
640x480 60, 72, 75, 85 8, 15, 16, 24, 32
800x600 60, 70, 75, 85 8, 15, 16, 24, 32
1024x768 60, 70, 75, 85 8, 15, 16, 24, 32
1152x864 60, 70, 75, 85 8, 15, 16, 24, 32
1280x800 60, 72, 75, 85 8, 15, 16, 24, 32
1280x1024 60, 72, 75, 85 8, 15, 16, 24, 32
1440x900 60, 72, 75, 85 8, 15, 16, 24, 32
1600x1200 60, 72, 75, 85 8, 15, 16, 24, 32
Restrictions:
• When using TV OUT, refresh rates are not available.
• Resolutions above 1024x768 might not display data correctly because of an issue
with memory bandwidth.
Files:
See also:
io-display
/usr/photon/config/tvia.conf

© 2010, QNX Software Systems GmbH & Co. KG. devg-vesabios.so
Generic graphics driver (VESA 2.0)
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-vesabios.so driver provides 2D support for the specified graphics
chipsets.
• This is a “safe”, generic graphics driver. However, it can negatively impact the
timing of a system and affect realtime operations. We recommended you use an
accelerated driver instead, if at all possible.
Supported chipsets
• Any video adapter compliant with VESA 2.0 (or greater)
None

None
Other features

devg-vesabios.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Hardware Cursor No
TV Out Yes (see below)
Video capture No
Restrictions:
640x480 60 8, 15, 16, 24, 32
800x600 60 8, 15, 16, 24, 32
1024x768 60 8, 15, 16, 24, 32
1152x864 60 8, 15, 16, 24, 32
1280x1024 60 8, 15, 16, 24, 32
1600X1200 60 8, 15, 16, 24, 32
Restrictions:
• Other refresh rates may be available if the BIOS is VESA 3.0.
Files:
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devg-vmware.so
Graphics driver for VMWare virtual machines
Syntax:
io-display [-vf]
Runs on:
Neutrino
Targets:
x86
Options:
io-display.
Description:
The devg-vmware.so driver provides 2D support for machines running QNX
Neutrino on a VMware virtual machine.
• VirtualPC and VMWare require a Windows session that’s operating with 32-bit
graphics.
Supported chipsets
• VMware 5.0
None

None
Other features

devg-vmware.so © 2010, QNX Software Systems GmbH & Co. KG.
Feature Provision
Hardware Cursor No
TV Out No
Video capture No
640x480 60 16, 24, 32
800x600 60 16, 24, 32
1024x768 60 16, 24, 32
1280x1024 60 16, 24, 32
1600X1200 60 16, 24, 32
Restrictions:
Files:
Caveats:
VMWare sessions default to resolution 1024x768 with color depth argb8888. This
setting is forced in the enumerator file located in the following folder:
/etc/system/enum/devices/graphics
To change the host’s default resolution setting, you can modify the value in the
enumerator file.
See also:
io-display

© 2010, QNX Software Systems GmbH & Co. KG. devh-egalax.so
Driver for USB Egalax touch devices
Syntax:
io-hid -d egalax [option[,option ...]] ... &
Runs on:
Neutrino
Options:
Use commas, not spaces, to separate the options.
device=0xXXXX Pass in an alternative device ID.
info Gather more information on the controller. This is only for

general information purposes and simply sends the information
to slogger.
noinit Don’t initialize the controller.
Don’t use this option unless you’re certain that the default protocol your controller is
using is the Egalax protocol.
upath=path The USB stack path; the default is /dev/io-usb/io-usb.
vendor=0xXXXX Pass in an alternative vendor ID.
verbose=level Be verbose and specify the level of debug information (range

1-5).
wait=num The number of seconds to wait for the USB stack to come up.
Description:
The Egalax touchscreens aren’t HID-compliant, so the devh-egalax.so DLL
converts Egalax native controller packets into generic HID packets, which devi-hid
then handles.
If you’re using this driver with the USB (devh-usb.so) module, you must specify
the igndev option to devh-usb.so, specifying the Egalax vendor and device IDs.
Examples:
Start io-hid using the Egalax driver, and then start devi-hid:
io-hid -d egalax &

devi-hid touch

devh-egalax.so © 2010, QNX Software Systems GmbH & Co. KG.
Start io-hid using the Egalax driver at high verbosity and with a new stack path:
io-hid -d egalax verbose=5,upath=/dev/payton-usb/ &
Files:
devh-egalax.so
The devh-egalax.so DLL is normally found in /lib/dll.
See also:
devh-*, devh-usb.so, devi-hid, diskboot, io-hid

© 2010, QNX Software Systems GmbH & Co. KG. devh-microtouch.so
Driver for Microtouch EXII USB touch devices
Syntax:
io-hid -d microtouch [option[,option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX The device ID.
noscaling Disable coordinate scaling. The coordinates are normally scaled

down to 14-bit values, due to an issue with the upper layers of the
input driver sharing a data type from Photon that uses signed
short values.
Since the touchscreen has a resolution of 16 bits, a short isn’t
big enough to handle the data correctly. If the client is the
resource manager interface (composition manager) and not the
Advanced Graphics or Photon system, then you can specify the
noscaling option as it bypasses the short values.
verbose=level Be verbose and specify the level of debug information (range 1-5).
vid=0xXXXX The vendor ID.
Description:
The devh-microtouch.so DLL converts Microtouch EXII packets into generic
HID packets, which devi-hid then handles.
Examples:
Start io-hid using the Microtouch driver, and then start devi-hid:
io-hid -d microtouch &
devi-hid touch
Start io-hid using the Microtouch driver at high verbosity and with a new stack path
and a new device ID:
io-hid -d microtouch did=0x1234,verbose=5,upath=/dev/huxley-usb/ &

devh-microtouch.so © 2010, QNX Software Systems GmbH & Co. KG.
Files:
devh-microtouch.so
The devh-microtouch.so DLL is normally found in /lib/dll.
See also:
devh-*, devh-usb.so, devi-hid, diskboot, io-hid

© 2010, QNX Software Systems GmbH & Co. KG. devh-ps2ser.so
Driver for serial and PS2 human interface devices (HID)
Syntax:
io-hid -d ps2ser
protocol_module[,options]:device_module[,options]
[:protocol_module[,options]:device_module[,options]]...
[opts=v[v...]]
Runs on:
Neutrino
Options:
Colons (:) separate modules; commas (,) separate module options.
opts=v[v...] Increment verbosity. The default is zero verbosity.
protocol_module[,options]
The input protocol module. You can specify multiple
protocol/device module pairs.
The protocol_module variable may be any one of the following
modules:
ps2mouse Regular PS/2 mouse. There are no options.

msoft[,options]... Mouse compatible with Microsoft/IntelliMouse
protocol (serial). Options:
• b=baud — Baud rate for serial device
(default 1200)
• 3 — Microsoft 3 button mouse
• R — Don’t reset mouse (the default is to
reset the mouse)
• i — IntelliMouse protocol (wheel mice)
msys[,options]... Mouse compatible with Mouse Systems mouse
protocol (used by Logitech). Options:
• b=baud — Baud rate for serial device
(default 1200)
• R — Don’t reset mouse (default reset mouse)
kbd[,options]... Scan codes for primary keyboard. Options:
• k=(rate[,delay]) — Keyboard rate (Hz),
delay (ms). If you continually depress a key,
after delay milliseconds, it will input data
rate times a second. The default is 30Hz
after 500ms. This only works in conjunction
with the kbddev device module.

devh-ps2ser.so © 2010, QNX Software Systems GmbH & Co. KG.
• R — Don’t reset the device while doing a

protocol reset
• r — Reset the device while doing a protocol
reset
• s — The device driver should supply valid
symbols
device_module[,options]
Device modules. The device_module variable depends on the
protocol_module specified. The following device modules are
supported:
fd[,options]... Opens a device via the open() function.

Options:
• d=device — The device to open fd() on
(default /dev/ser1)
• s — Specifies that the input interface is
serial (this allows the module to use some
devctl commands that are specific to a
serial port)
• P — The processing priority for this input
event
uart[,options]... Enables direct access to 8250, 16450, and
16550 uarts. Options:
• i=irq — IRQ number for the serial device
(default 4)
• p=ioport — The port of the serial device
(default 3f8)
• 1 — Use COM1
• 2 — Use COM2
• P — The processing priority for this input
event
kbddev[,options]... For PS2 keyboard. Options:
• f=filename — Create the named file and
collect all data passed to the protocol level
(debug only)
• i=irq — IRQ number (default 1)
• p=(ioport,add) — Port address (default
0x60), and a value to add to get the status
port address (default 4: 0x60 + 4 = 0x64)
• r — Reset the device on initiation
• P priority — The processing priority for
keyboard events

© 2010, QNX Software Systems GmbH & Co. KG. devh-ps2ser.so
mousedev[,options]...
For PS2 mouse. Options:
• f=filename — Create the named file and
collect all data passed to the protocol level
(debug only)
• i=irq — IRQ number (default 12)
• p=(ioport,add) — Port address (default
0x60), and a value to add to get the status
port address (default 4: 0x60 + 4 = 0x64)
• r — Reset the device on initiation
• P priority — The processing priority for
mouse events
Description:
The devh-ps2ser.so DLL provides io-hid with HID information. The DLL
collects raw data from a variety of legacy devices (e.g. PS2 keyboards, and PS2 and
serial mice), transforms it to unified USB HID report format, and then sends the data
to io-hid. The io-hid manager forwards the data to devi-hid.
The devh-ps2ser.so DLL is usually started by io-hid in the system startup
procedure (see diskboot).
• The devh-ps2ser.so DLL is the low-level part of the input channel. You have to
start devh-usb.so to provide any top-level services required.
• If you press several keys at once on some Microsoft keyboards, the keyboard
doesn’t produce any indication when you release the keys. As a result, the input
driver thinks you’re still holding the keys down. For more information, see
http://support.microsoft.com/kb/909528/en-us.
Examples:
Start a regular PS/2 mouse, a Microsoft/IntelliMouse serial mouse on COM1, and a
PS/2 keyboard:
io-hid -d ps2ser ps2mouse:mousedev:msoft:uart,1:kbd:kbddev
Files:
devh-ps2ser.so
The devh-ps2ser.so Dll is normally found in /lib/dll.

devh-ps2ser.so © 2010, QNX Software Systems GmbH & Co. KG.
Errors:
If an error occurs in devh-ps2ser.so, the keyboard will not work in text mode. If
you specify at least one v option, details of driver activity will be reported on the
console screen and will be appended to the system log; for more detail, increase the
verbosity level.
See also:
devh-*, devi-hid, devh-usb.so, diskboot, io-hid.

© 2010, QNX Software Systems GmbH & Co. KG. devh-touchintl.so
Driver for USB Touch International touch devices
Syntax:
io-hid -d touchintl [option[,option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX The device ID.

noinit Don’t initialize the controller.
rate=rate The coordinate output rate, in the range 1–7:
• 1 — kiosk mode; data is sent only on a touch, not on a drag.
• 2 — 30 pps (points per second)
• 3 — 50 pps
• 4 — 80 pps (the default value)
• 5 — 100 pps
• 6 — 130 pps
• 7 — 150 pps
verbose=level Be verbose and specify the level of debug information (range 1-5).
vid=0xXXXX The vendor ID.
Description:
The Touch International touchscreens aren’t HID-compliant, so the
devh-touchintl.so DLL converts touchintl native controller packets into generic
HID packets, which devi-hid then handles.
Examples:
Start io-hid using the Touch International driver, and then start devi-hid:
io-hid -d touchintl &
devi-hid touch
Start io-hid using the Touch International driver at high verbosity and with a new
stack path and a new device ID, at a data rate of 100 packets per second:
io-hid -d egalax did=0x1234,rate=4,verbose=5,upath=/dev/payton-usb/ &

devh-touchintl.so © 2010, QNX Software Systems GmbH & Co. KG.
Files:
devh-touchintl.so
The devh-touchintl.so DLL is normally found in /lib/dll.
See also:
devh-*, devi-hid, devh-usb.so, diskboot, io-hid

© 2010, QNX Software Systems GmbH & Co. KG. devh-usb.so
Driver for USB-compliant human interface devices (HID)
Syntax:
io-hid -d usb [option[,option ...]] ... &
io-hid -d usb [option[,option ...]] ...
Runs on:
Neutrino
Options:
igndev=vid[:did]
Don’t attach to the HID device matching the given vendor and device
IDs. The vid and did must be hexadecimal vendor and product IDs
(e.g. igndev=0x1234:0x5678), as reported by the usb utility.
You can use the igndev option to ignore specific USB HID devices.
This allows another USB driver to attach and manage the device. You
can specify multiple igndev options.
The did also supports pattern matching to let you specify a range for
device IDs for a particular vendor; see the examples below.
upath The USB stack path. The default is /dev/io-usb/io-usb
verbose Be verbose.
Description:
The devh-usb.so is a DLL which is used with the io-hid manager. It connects to
the USB stack to give HID clients access to USB-compliant human interface devices.
Run the USB stack first. Please refer to io-usb for further information.
Examples:
Start io-hid using the USB HID driver and manage all USB HID devices:
io-hid -d usb &
or:
io-hid &
mount -Tio-hid devh-usb.so
Ignore all devices for a specific vendor:

io-hid -dusb igndev=0x1234

devh-usb.so © 2010, QNX Software Systems GmbH & Co. KG.
Ignore a specific device for a specific vendor:
io-hid -dusb igndev=0x1234:0x5678
Ignore a range of devices for a specific vendor:
io-hid -dusb igndev=0x1234:0x5???
See also:
devh-ps2ser.so. devh-*, hidview, io-hid, io-usb, usb

© 2010, QNX Software Systems GmbH & Co. KG. devi-dyna
Dyna input manager for Photon
Syntax:
devi-dyna [general_opts]
protocol* [protocol_opts]*
device* [device_opts]*
filter* [filter_opts]*
Runs on:
Neutrino
Options:
When you use a devi-* driver for a touchscreen device, you need a calibration file.
The calibration file is generated from the output produced by the calib utility:
calib > calib_file.txt
For more information, see the calib utility in the Utilities Reference, and
Touchscreens in the Neutrino User’s Guide.
General options:
-b Prevent the use of the Ctrl-Alt-Shift-Backspace keychord to exit

Photon (permitted by default).
-d device Device (default: /dev/photon or $PHOTON).
-g input_group Input group (default: 1).
-l List the internal modules. Modules are listed in the following

format where class is one of: D — Device, P — Protocol, or F
— Filter:
module name | date compiled | revision | class
-t factor The throttle factor in ms (default 0).
-v[v]... Verbose output. More v characters cause more verbosity.
The protocol and protocol_opts are:
dyna [dyna_opts] [fd fd_opts]|[uart uart_opts]

The protocol modules and their options are:
• dyna — Dyna SC3 protocol
-b baud Baud rate (default 2400)

devi-dyna © 2010, QNX Software Systems GmbH & Co. KG.
The device modules and their options are:
• fd — open a device via open().
-d device The device to open fd on (default /dev/ser1).
• uart — access the 8250/16450/16550 UART directly.
-i irq The IRQ for the serial device (default 4).

-p ioport The port of the serial device (default 3f8).
The filter modules and their options are:
• abs — transform and compress absolute coordinate “touch” events.
-b Touching the screen is a right mouse button (default left).

-c Calibrate mode; don’t transform coordinates.
-f filename The calibration filename.
-o x,y The origin of the display region (default: the origin of the graphics
region).
-s x,y The coordinates of the lower right corner of the display region
(default: the width and height of the graphics region).
Description:
The devi-dyna command starts the Dyna input manager for Photon.
Examples:
Connect the Dyna controller to the first serial port:
devi-dyna dyna fd -d/dev/ser1 abs -b
See also:
devi-*, inputtrap

© 2010, QNX Software Systems GmbH & Co. KG. devi-elo
Elographics input manager for Photon
Syntax:
devi-elo [general_opts]
Runs on:
Neutrino
Options:
General options:

-G A graphics driver isn’t requires when starting a touchscreen

driver. This option is useful when you’re debugging.

— Filter:
smartset [smartset_opts] [fd fd_opts]|[uart uart_opts]
• smartset — Elographics smartset protocol

devi-elo © 2010, QNX Software Systems GmbH & Co. KG.

-R Don’t reset the device (default: reset it).

-s The input interface is serial (i.e. the module can use devctl()
commands that are specific to a serial port).
-1 Use COM1.
-2 Use COM2.

region).
-x Reverse the x coordinates.
-y Reverse the y coordinates.
Description:
The devi-elo command starts the Elographics input manager for Photon.
Examples:
Connect the Smartset controller to the first serial port. Use the serial manager to get
input data. Touching the screen emulates a right mouse button press:
devi-elo smartset fd -d/dev/ser1 abs -b

© 2010, QNX Software Systems GmbH & Co. KG. devi-elo
See also:
devi-*, inputtrap

devi-hid © 2010, QNX Software Systems GmbH & Co. KG.
Universal Photon input manager for keyboards and mice
Syntax:
devi-hid [general_opts]
Runs on:
Neutrino
Targets:
Any supported platform that has io-hid running.
Options:
General options:

-d device Device (default: /dev/photon or the $PHOTON environment

variable).

format where class may be P (protocol) or F (filter):
module name | date last compiled | revision | class
-P Disable Photon interface. The default is to start the Photon

interface.
-r Start resource manager interface (only use if not using Photon).
• kbd — keyboard scan codes (connected to primary keyboard)
-k rate[,delay] Keyboard rate (Hz),delay (ms). If you continually depress a key,

after delay milliseconds, it will input data rate times a second.
The default is 150Hz after 500ms.
-u device Optional, USB device number.
• mouse — common mouse protocol (no options)

© 2010, QNX Software Systems GmbH & Co. KG. devi-hid
• keyboard — translate scan codes to UNICODE
-k kbd_file The file to use to map the keyboard to support international

languages or alternate layouts, such as Dvorak. The default location
for these files is /usr/photon/keyboard; to create a keyboard
mapping, use mkkbd.
• rel — filters and compresses relative coordinates of mouse events
-a Wheel acceleration parameter (default 10); the higher this value,

the faster the mouse wheel acceleration.
-G gain Motion multiplier (default 1).
-l Swap right and left buttons.
-T threshold Speed-doubling threshold in mickeys/second. If the mouse speed
exceeds this threshold, the cursor will move twice as far as it
normally does per mickey. (A mickey is the smallest amount of
motion the mouse can detect.) The default threshold is 100.
-x Reverse X.
-y Reverse Y.
Description:
This manager is a universal Photon input daemon for keyboards and mice. It is a client
of io-hid, the HID server.
Usually, inputtrap starts devi-hid during the Photon startup procedure; for test
and other purposes, you may also start this manager in text mode as a resource
manager.
The io-hid resource manager must be running before devi-hid can start.
This manager doesn’t need information about the physical interfaces of real devices: it
relies on service from the io-hid resource manager and supplementary input
modules. The devi-hid daemon takes data in the form of HID reports, transforms
the data into Photon events, and then emits these events to Photon. It provides
multi-language support for keyboard input.
If you specify the verbosity option, activity messages are sent to the console screen
and to the system log. Data is normally sent to Photon, alternatively, in resource
manager mode (-r option), data can be sent to devices (by default,
/dev/devi/keyboard0 and /dev/devi/mouse0).

devi-hid © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Typical command line to start the keyboard and mouse manager:
devi-hid kbd mouse
Files:
devi-hid Normally in /usr/photon/bin.
libhiddi.so Used by devi-hid
Errors:
If an error occurs in starting devi-hid, the keyboard or mouse will not work in
Photon and Photon won’t be able to start. If you specify at least one v option, activity
details will be reported on the console screen and will be appended to the system log;
for more detail, increase the verbosity level.
See also:
inputtrap, mkkbd.

© 2010, QNX Software Systems GmbH & Co. KG. devi-hirun
Photon “high-runner” input manager
Syntax:
devi-hirun [-bdglPr] [-v[v]...]
protocol [protocol_opts...]
[protocol [protocol_opts...]]...
[device [device_opts...]]...
[filter [filter_opts...]]...
Runs on:
Neutrino
Options:
When you use a devi-* driver for a touchscreen, you need a calibration file. The
calibration file is generated from the output produced by the calib utility:


format:
module name | date last compiled | revision | class
where class is one of: D — Device, P — Protocol, or F — Filter:
-P Disable the Photon interface (by default, start Photon).
-r Start the resource manager interface. Use this option only if

you’re not using Photon.
protocol [protocol_opts...]
The protocols and their options are:
kbd [options] Keyboard scan codes (connected to primary keyboard).

Options:

devi-hirun © 2010, QNX Software Systems GmbH & Co. KG.
-f filename Create the given file and collect all data passed to
the filter level (for debug only).
-k rate[,delay] Keyboard rate (Hz), delay (ms). The default is
30Hz, 500ms).
The -k option works only in conjunction with the kbddev device module.
-p filename Create and open the given FIFO file and duplicate
all data passed to the filter level (for debug only)
-R Don’t reset the device while resetting the protocol.
-r Reset the keyboard (the default).
-s The device driver should supply valid symbols.
Devices supported: fd, kbddev

msoft [-3] [-b baud] [-i][-R]
Microsoft-compatible mouse protocol (serial).
Options:
-3 Microsoft 3-button mouse.

-b baud Baud rate for serial device (default: 1200).
-i Intellimouse mice with wheels.
-R Don’t reset mouse (default: reset mouse).
Devices supported: fd, uart
msys [-b baud] [-R]

Mouse Systems mouse protocol (used by Logitech).
Options:
-b baud Baud rate for serial device (default: 1200).

-R Don’t reset the mouse (default: reset it).
Devices supported: fd, uart
ps2 IBM PS/2 mouse protocol.

Devices supported: mousedev
All serial devices use 8 data bits, 1 stop bit, and no parity.

device [device_opts...]
The devices and their options are:
fd [-d device] [-s] Opens a device via open().

Options:
-d device The device to open fd on (default: /dev/ser1).

-P The processing priority of the input event.
-s The input interface is serial (i.e. the module can use
devctl() commands that are specific to a serial port).
kbddev [options] PS2 keyboard.

Options:
-i irq IRQ (default: 1).

-f filename Create the given file and collect all data passed
to the protocol level (for debug only).
-P The processing priority of the keyboard event.
-p ioport,add The port (default: 0x60) and a value to add to
get the status (default: 4).
-r Reset the keyboard port. This is useful on
hardware with no BIOS (e.g. PowerPC, MIPS).
mousedev [options] PS2 mouse.

Options:
-f filename Create the given file and collect all data passed
to the protocol level (for debug only).
-i irq IRQ (default: 12).
-P The processing priority of the mouse event.
-p ioport,add The port (default: 0x60) and a value to add to
get the status (default: 4).
-r Reset the mouse port. This is useful on
hardware with no BIOS (e.g. PowerPC, MIPS).
If you specify both kbddev and mousedev options in the command line, and you use
non-standard port numbers, you must define the same port number values for each
module.
uart [options] Accesses 8250/16450/16550 UART directly.
Options:
-1 Use COM1.

devi-hirun © 2010, QNX Software Systems GmbH & Co. KG.
-2 Use COM2.
-i irq IRQ for serial device (default: 4).
-P The processing priority of the input event.
-p ioport Port of serial device (default: 3f8).
filter [filter_opts...]
The filters and their options are:
keyboard [-k kbd_file]

Translate scan codes to Unicode.
Options:
-k kbd_file The file to use to map the keyboard to support

international languages or alternate layouts, such as
Dvorak. The default location for these files is
/usr/photon/keyboard; to create a keyboard
mapping, use mkkbd.
rel [options] Filter and compress relative coordinate “mouse” events.

Options:
-a value The wheel-acceleration parameter (default 10); the

higher this value, the faster the mouse wheel
acceleration.
-G gain Motion multiplier (default: 1).
-l (“el”) Swap the right and left buttons.
-T threshold Speed-doubling threshold in mickeys (100).
-x Reverse X.
-y Reverse Y.
Description:
The devi-hirun driver serves as the “high-runner” (i.e. the most likely) input driver
for Photon. The inputtrap utility detects drivers and starts devi-hirun.
The devi-hirun driver is responsible for taking data from an input device such as a
mouse, or keyboard, interpreting the data, and then “doing” something with it. The
default behavior is to package the data as an event and inject it into the Photon event
space.
The devi-hirun driver uses a layered approach to driver design:
• filter layer
• protocol layer

• device layer
At each layer, data is interpreted/modified and passed up to the next layer until it’s
injected as an event into the Photon event space.
For each device devi-hirun talks to, there’s a separate path through the three layers
called an event bus line. An event bus line consists of modules, one representing each
layer, linked together by a software bus. As data is passed up the layers via the bus, the
data is manipulated by each module into a format recognizable by the next layer’s
module and so on.
It’s important to note that you can run as many instances of devi-hirun as you want,
one for each device. Or you can run one devi-hirun for all the devices. Choosing
which scenario to use is mostly a matter of convenience.
Examples:
If inputtrap detects a serial Microsoft mouse and a keyboard interfaced through the
file descriptor provided by opening /dev/kbd, it invokes devi-hirun like this:
devi-hirun kbd fd -d/dev/kbd msoft fd &
If inputtrap detects a PS/2 mouse interfaced through the auxiliary port on the
keyboard controller (mousedev) and a keyboard interfaced through the primary
keyboard port on the keyboard controller (kbddev), it invokes devi-hirun like this:
devi-hirun kbd kbddev ps2 mousedev &
See also:
devi-*, inputtrap

devi-microtouch © 2010, QNX Software Systems GmbH & Co. KG.
Microtouch input manager for Photon
Syntax:
devi-microtouch [general_opts]
Runs on:
Neutrino
Options:
General options:

-G Specify that a graphics driver isn’t required when starting a

touchscreen driver. This option is useful when you’re debugging.

— Filter:
-P Disable the Photon interface (it’s started by default).
-r Start the resource manager interface (use this option only if you
aren’t using Photon).

© 2010, QNX Software Systems GmbH & Co. KG. devi-microtouch
microtouch [microtouch_opts] [fd fd_opts]

|[uart uart_opts]|[touchdev touchdev_opts]
[touchusb touchusb_opts]_
• microtouch — Microtouch (uses Tablet Format)

-R Don’t reset the device (default: reset it).

-s The input interface is serial (i.e. the module can use devctl()
commands that are specific to a serial port).
-1 Use COM1.
-2 Use COM2.
• touchdev — communicate with device via the PS2 port.
-f Work with a finger.

-l logical port The port is 0 if the device is connected to the PS2 keyboard
port; the port is 1 if the device is connected to the PS2 mouse
port (default).
If you want to specify the -l parameter in the touchdev module, you must place it
before any other parameter.
-n Work with a pen (the default).
-p ioport,add The port of the serial device (default 0x60), and a value to add
to get the status.
• touchusb — communicate with device via the USB controller.
-f Work with a finger.

-n Work with a pen (the default).
-s Use the SC protocol (SC400, SC500 & SC800 controllers).
-u device Specify the USB device number.

devi-microtouch © 2010, QNX Software Systems GmbH & Co. KG.
If you use the touchdev module, you must disable the standard mouse/keyboard
driver devi-hirun PS2 mouse module.
You can do this by creating a /etc/config/trap/input[.hostname] file with one
of the following strings:
- If you use a serial mouse, use:
kbd kbddev msoft fd -d /dev/serN
- If you don’t use a mouse, use:

kbd kbddev

region).
-x Reverse the x coordinates.
-y Reverse the y coordinates.
Description:
The devi-microtouch command starts the Microtouch input manager for Photon.
Examples:
Connect a Microtouch controller to first serial port:
devi-microtouch microtouch fd -d/dev/ser1 abs -b
See also:
devi-*, inputtrap

© 2010, QNX Software Systems GmbH & Co. KG. devi-semtech
Semtech input manager for Photon
Syntax:
devi-semtech [general_opts]
Runs on:
Neutrino
Options:
General options:

-G Don’t require the presence of a graphics driver when starting up a

touchscreen driver; useful in debug mode.

format, where class is one of: D — Device, P — Protocol, or F
— Filter:
-r Start the resource manager interface (only use if you aren’t using
Photon).
semtech [semtech_opts] [fd fd_opts]

devi-semtech © 2010, QNX Software Systems GmbH & Co. KG.
• semtech — Semtech protocol

-R Don’t reset the device (the default is to reset it).

-s The input interface is serial (being aware that the module is able to
use some devctl() commands specific to serial ports).

region).
-x Reverse X.
-y Reverse Y.
Description:
The devi-semtech command starts the Semtech input manager for Photon.
Examples:
Connect the Semtech controller to the first serial port:
devi-semtech semtech fd -d/dev/ser1 abs -b
See also:
devi-*, inputtrap

© 2010, QNX Software Systems GmbH & Co. KG. devi-zytronic
Zytronic input manager for Photon
Syntax:
devi-zytronic [general_opts]
Runs on:
Neutrino
Options:
General options:

-G Don’t require the presence of a graphics driver when starting up a

touchscreen driver; useful in debug mode.

format, where class is one of: D — Device, P — Protocol, or F
— Filter:
-r Start the resource manager interface (only use if you aren’t using
Photon).
zytronic [zytronic_opts] [fd fd_opts]

devi-zytronic © 2010, QNX Software Systems GmbH & Co. KG.
• zytronic — Zytronic protocol
-a averaging The number of frames for x-y averaging, in the range from 0
through 9. The default is 9. This effects the accuracy of each
touch (0 is less accurate, and 9 is more accurate).
-b baud Baud rate (default 9600).
-g thickness The glass thickness (0 = thin, 1 = medium, 2 = thick).
-R Don’t reset the device (the default is to reset it).
-t threshold The touch threshold (sensitivity); the range is from 0 through 44,
where 0 is very sensitive, and 44 is not sensitive. The default is
19.

-s The input interface is serial (being aware that the module is able to
use some devctl() commands specific to serial ports).

region).
-x Reverse X.
-y Reverse Y.
Description:
The devi-zytronic command starts the Zytronic input manager for Photon.
Examples:
Connect the Zytronic controller to the first serial port:
devi-zytronic zytronic fd -d/dev/ser1 abs -b

© 2010, QNX Software Systems GmbH & Co. KG. devi-zytronic
See also:
devi-*, inputtrap

devn-asix.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for the ASIX AX88172/AX88178/AX88772 USB Ethernet dongle
Syntax:
io-pkt-variant -d asix [option[,option ...]] ... &
where variant is one of v4, v4-hc, or v6-hc.
Runs on:
Neutrino
Options:
busnum=0xXX The USB bus number.
devnum=0xXX The USB device number.
did=0xXXXX The USB device ID.
duplex=0|1 Half (0) or full (1) duplex mode. The default is automatically
detected on supported hardware. If you specify duplex, specify
speed as well; if duplex alone is specified, it is ignored and both
speed and duplex are autonegotiated.
iftype=num The interface type (from <net/if_types.h>). The default is

IFT_ETHER.
lan=num The LAN number. The default is 0.
mac=XXXXXXXXXXXX
The interface address of the controller. The default is
automatically detected on supported hardware.
media=num The media type (from <hw/nicinfo.h>). The default is

NIC_MEDIA_802_3.
mru=num The maximum receive unit. The default is 1514.
mtu=num The maximum transmission unit. The default (1514) is

nomulticast Disable multicast support. By default, multicast is enabled.
path="name" Connect to the specified USB stack. The default is

/dev/io-usb/io-usb.
phy=num The address of the connected PHY device.
priority=N The priority of the driver’s event thread. The default is 21.

© 2010, QNX Software Systems GmbH & Co. KG. devn-asix.so
promiscuous Enable the driver to pass all data packets received, regardless of
the address. By default, promiscuous mode is disabled.
receive=num The number of Rx descriptors. The default is 5.
speed=10|100 The media data rate in megabits/second.
transmit=num The number of Tx descriptors. The default is 10.
uptype=name The interface name. The default is en.
verbose
verbose=N Be verbose. Specify num for more verbosity (num can be 1-4; the
higher the number, the more detailed the output). The default is
0. The output goes to slogger; invoke sloginfo to view it.
vid=0xXXXX The USB vendor ID.
wait=num The number of seconds to wait for the USB stack. The default is
60 seconds.
Description:
The devn-asix.so driver controls the ASIX AX88172/AX88178/AX88772 USB
Ethernet dongle. This is a legacy io-net driver; its interface names are in the form
enX, where X is an integer.
If the device enumerators (see enum-devices) don’t recognize your device, try
explicitly specifying the device ID with the did option when you start the driver.
Some devices support hardware checksums, although some might do so in only one
direction; to determine if your device does, type:
ifconfig enX
and look for the following in the list of supported options:
• ip4csum, ip4csum-rx, ip4csum-tx
• tcp4csum, tcp4csum-rx, tcp4csum-tx
• udp4csum, udp4csum-rx, udp4csum-tx
You can then use ifconfig to enable or disable whichever of these options your
device supports.

devn-asix.so © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Start io-pkt-v6-hc using the ASIX driver:
io-pkt-v6-hc -dasix verbose &

ifconfig en0 10.1.0.184
Files:
/dev/io-net The directory where, by default, drivers and protocol modules add
entries. For more information, see the documentation for
io-pkt*.
See also:
devn-*, devnp-*, ifconfig, io-pkt*, nicinfo

© 2010, QNX Software Systems GmbH & Co. KG. devn-crys8900.so
Driver for Crystal 89xx Ethernet adapters
Syntax:
io-pkt-variant -d crys8900 [option[,option ...]] ...
Runs on:
Neutrino
Options:
connector=0|1|2|3
Network cable connector type:
0 BNC
1 UTP
2 AUI
3 FIBER
dma=num The DMA channel.
duplex=0|1 Half (0) or full (1) duplex mode.
iftype=num Interface type (from <net/if_types.h>). The default is

IFT_ETHER.
iorange=0xXXXXXXXX
I/O base address.
irq=num IRQ of the interface. The default is automatically detected on

supported hardware (but see caution below).
lan=num LAN number. The default is 0.
mac=XXXXXXXXXXXX
MAC address of the controller. The default is automatically
detected on supported hardware.
media=num Media type (from <hw/nicinfo.h>). The default is

NIC_MEDIA_802_3.
mru=num Maximum receive unit. The default is 1514.
mtu=num Maximum transmission unit. The default (1514) is automatically


devn-crys8900.so © 2010, QNX Software Systems GmbH & Co. KG.
nomulticast Disables the driver from sending or receiving multicast packets.

By default, multicast is enabled.
priority=N Priority of the driver event-thread. The default is 21.
promiscuous Enable promiscuous mode. The default is off.
uptype=name Interface name. The default is “en”.
verbose
verbose=num Be verbose. Specify num for more verbosity (num can be 1-4, the
higher the number, the more detailed the output). The default is 0.
The output goes to slogger, invoke sloginfo to view.
Description:
The devn-crys8900.so driver controls Crystal 89xx Ethernet adapters. This is a
legacy io-net driver; its interface names are in the form enX, where X is an integer.
CAUTION: This driver can’t always detect the correct irq and ioport options,
! especially for ISA devices. To be sure, always specify irq and ioport when using
this driver.
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the Crystal 89xx driver: stack:
io-pkt-v4-hc -d crys8900

© 2010, QNX Software Systems GmbH & Co. KG. devn-crys8900.so
Files:
io-pkt*.
See also:

devn-dm9102.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Davicom DM9102 Ethernet adapters
Syntax:
io-pkt-variant -d dm9102 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
Use commas, not spaces, to separate the options. These options will override
auto-detected defaults.
did=0xXXXX Device ID.
speed and duplex are auto-negotiated.
mac=XXXXXXXXXXXX
MAC address of the controller. If no SROM is available, the
MAC will default to 00:00:00:00:00:00
nomulticast Disable multicast support.
pci=0xXXXX PCI index of the controller.
phyaddr=num Override the mii routines and use the specified phy address.
pktque=num Limit the number of packets in the queue. The default is 100.
priority Priority of the driver thread. The default is 21.
promiscuous Enable promiscuous mode.
receive=num Set the number of receive descriptors. The default is 64.
single Configure and run only the first DM9102 card that is found
(single instance).
speed=10|100 Media data rate (10 Mbit or 100 Mbit operation). The default is
automatically detected on supported hardware. If you specify
speed, specify duplex as well; if speed alone is specified, the
specified speed will be correctly set, but duplex will default to
half (0).
threshold=N The amount of packet data that must be in the TX FIFO before
transmission is initiated. The range is 0–4. The default is 3.

© 2010, QNX Software Systems GmbH & Co. KG. devn-dm9102.so
transmit=num Set the number of transmit descriptors. The default is 128.
verbose Be verbose.
vid=0xXXXX PCI vendor ID.
Description:
The devn-dm9102 driver controls Davicom DM9102 Ethernet adapters. This is a
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the DM9102 driver:
io-pkt-v4-hc -d dm9102
Files:
io-pkt*.
See also:

devn-el509.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for 3Com 509 ISA Ethernet adapters
Syntax:
io-pkt-variant -d el509 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
connector=type Network cable connector type:
0 BNC
1 UTP
2 AUI
3 FIBER
The default is automatically detected on supported hardware.

ioport=port The I/O port of the interface. The port parameter must be a hex
address (e.g. 0x320). The default is automatically detected on
irq=req The IRQ of the interface. The default is automatically detected
on supported hardware (but see caution below).
mac=XXXXXXXXXXXX
MAC address of controller. The default is automatically
mtu=X Maximum transmission unit. The default is automatically
nomulticast Disables the driver from sending or receiving multicast
packets. By default, multicast is enabled.
pcmcia Flag to indicate a PCMCIA device to the driver.
verbose
verbose=num Be verbose. Specify num for more verbosity (num can be 1-4,
the higher the number, the more detailed the output). The
output goes to slogger, invoke sloginfo to view.

© 2010, QNX Software Systems GmbH & Co. KG. devn-el509.so
Description:
The devn-el509.so driver controls 3Com 509 ISA Ethernet adapters.
this driver.
You can use ifconfig to enable hardware checksums if supported.
Examples:
Start io-pkt-v6-hc using the 509 ISA Ethernet adapter driver:
io-pkt-v6-hc -d el509 ioport=0x320,irq=11
Files:
io-pkt*.
See also:

Driver for 3Com 90x Network Interface Cards
Syntax:
io-pkt-variant -d el900 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
connector=0|1|2|3
0 BNC
1 UTP
2 AUI
3 FIBER
did=0xXXXX PCI device ID. The default is automatically detected on

supported hardware.
mac=XXXXXXXXXXXX
MAC address of controller. The default is automatically detected
on supported hardware.



© 2010, QNX Software Systems GmbH & Co. KG. devn-el900.so
verbose
higher the number, the more detailed the output). The output
goes to slogger; invoke sloginfo to view it.
vid=0xXXXX PCI vendor ID. The default is automatically detected on

supported hardware.
Description:
The devn-el900.so driver controls 3Com 90x Network Interface Cards (NICs). The
IRQ of the interface is automatically detected on supported hardware. This is a legacy
io-net driver; its interface names are in the form enX, where X is an integer.
ifconfig enX
device supports.
Examples:
Start io-pkt-v6-hc using the 90x NIC driver:
io-pkt-v6-hc -d el900 verbose
Files:
io-pkt*.

See also:

© 2010, QNX Software Systems GmbH & Co. KG. devn-epic.so
Driver for SMC 9432 (EPIC) Ethernet adapters
Syntax:
io-pkt-variant -d epic [option[,option ...]] ... &
Runs on:
Neutrino
Options:
connector=0|1|3
0 BNC
1 UTP
3 FIBER
did=0xXXXX Device ID. The default is automatically detected on supported

hardware.
speed as well; if duplex alone is specified, it is ignored and
both speed and duplex are auto-negotiated.
mac=XXXXXXXXXXXX
mmap Use memory mapped registers. The default is IO mapped.
mru=X Maximum receive unit. The default is 1514.
mtu=X Maximum transmission unit. The default (1514) is automatically


pci=0xXXXX PCI index of the controller. The default is automatically

priority Priority of the driver thread. The default is 21.

devn-epic.so © 2010, QNX Software Systems GmbH & Co. KG.
single Use this option if you have multiple Epic cards in your system
and want to configure them differently. The single option tells
the driver to stop after configuring the first Epic card it finds.
The order of the search can’t be determined because it depends
on the PCI server and PCI BIOS used. After the first card has
been configured, when the driver is invoked again, it will find
and configure the next card in order, and so on until all Epic
cards have been configured. The default is to enable all Epic
cards found.
speed=10|100 Media data rate (10Mbit or 100Mbit operation). The default is

half (0).
verbose Be verbose. The output goes to slogger; invoke sloginfo to

view it.
vid=0xXXXX Vendor ID of the controller. The default is automatically

Description:
The devn-epic.so driver controls SMC 9432 (EPIC) Ethernet adapters. This is a
ifconfig enX

© 2010, QNX Software Systems GmbH & Co. KG. devn-epic.so
device supports.
Examples:
Start io-pkt-v6-hc using the EPIC driver:
io-pkt-v6-hc -d epic verbose,speed=10,duplex=0

Files:
io-pkt*.
See also:

devn-fd.so © 2010, QNX Software Systems GmbH & Co. KG.
File descriptor interface driver
Syntax:
io-pkt-variant -d fd fd=device[,option[,option ...]] ... &
Runs on:
Neutrino
Options:
ahdlc Read or write packet data in AHDLC frame format.
fd=device The device on which to open the file descriptor to read or write
packet data. You must specify this option.
mac=XXXXXXXXXXXX
The MAC address of the controller. There is no default.

verbose
higher the number, the more detailed the output). The default is 0.
The output goes to slogger, invoke sloginfo to view.
Description:
The devn-fd.so driver uses file-descriptor based I/O (i.e. open(), read(), write(), and
so on) to receive and transmit packets. It provides the Network Manager (io-pkt*)
with reliable data transfer over any media supported by a file-descriptor-based server
process.

© 2010, QNX Software Systems GmbH & Co. KG. devn-fd.so
The devn-fd.so driver does not support multicast addresses.
For example, you could use devn-fd.so to connect two machines with a null-modem
RS-232 serial cable. By using file-descriptor I/O to the serial devices, devn-fd.so
would implicitly use a serial driver and set up a logical network link.
This is a legacy io-net driver; its interface names are in the form enX, where X is an
integer.
Examples:
Start io-pkt-v4-hc using the FD driver:
io-pkt-v4-hc -d fd fd=/dev/ser1,mac=0023456789AB,ahdlc
ifconfig en0 10.0.184
Files:
io-pkt*.
Caveats:
You must specify the fd option when using this driver.
See also:

devn-i82544.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Intel Gigabit Ethernet LAN adapters and I/O Controller Hubs
Syntax:
io-pkt-variant -d /lib/dll/devn-i82544.so
[option[,option ...]] ... &
If you don’t specify the full path to devn-i82544.so, io=pkt* starts

devnp-i82544.so.
Runs on:
Neutrino
Options:
did=0xXXXX Detect only devices with the given PCI device ID. The default is
speed as well; if you specify duplex alone, it’s ignored, and
flowcontrol=0|1
Disable (0) or enable (1) hardware flow control.
irq=N IRQ of the interface. The default is automatically detected on

supported hardware.
mac=XXXXXXXXXXXX
mtu=X Maximum transmission unit. The default (1514) is

nomulticast Disable the driver from sending or receiving multicast packets.

pauseignore Ignore pause frames with respect to full duplex flow control.
pausesuppress Suppress pause frames with respect to full duplex flow control.
pci=0xXXXX Detect devices only at this specific PCI index.

© 2010, QNX Software Systems GmbH & Co. KG. devn-i82544.so
priority=X Priority of the driver’s event-handler thread. The default is 21.

receive=num Set the number of receive descriptors. The default is 64 on PPC,
and 128 on other platforms.
speed=10|100|1000
Media data rate (10Mbit, 100Mbit, or Gigabit operation). The
default is automatically detected on supported hardware. If you
specify speed, specify duplex as well; if you specify speed
alone, the specified speed is correctly set, but duplex defaults to
half (0).
transmit=num Set the number of transmit descriptors. The default is 64 on
PPC, and 512 on other platforms.
verbose
verbose=num Be verbose. Specify num for more verbosity (num can be 1-4;
the higher the number, the more detailed the output). The output
vid=0xXXXX Detect only devices with this specific PCI vendor ID.
Description:
The devn-i82544.so driver manages the Intel 82540, 82541, 82542, 82543, 82544,
82545, 82546, 82547, 82571, 82572, and 82573 Gigabit Ethernet LAN adapters, and
the ICH8 and ICH9 I/O Controller Hubs. This is a legacy io-net driver; its interface
names are in the form enX, where X is an integer.
ifconfig enX
device supports.

devn-i82544.so © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Start io-pkt-v4-hc using the devn-i82544.so driver:
io-pkt-v4-hc -d /lib/dll/devn-i82544.so
Files:
entries. For more information, see the documentation for io-pkt*
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devn-micrel8841.so
Driver for Micrel 8841 (1 port) or 8842 (2 port) Ethernet controllers
Syntax:
io-pkt-variant -d micrel8841 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX The PCI device ID.
lan=num The LAN number of port 0 (8841 or 8842).
lan2=num The LAN number of port 1 (8842).
multicast Enable the receipt of all multicast packets, all ports. By default,
the receipt of multicast packets is disabled.
pci=0xXXXX The PCI index of the controller.
port0=num 1 means power down port 0 PHY (the default is 0, power on).
port1=num 1 means power down port 1 PHY (the default is 0, power on) on
the 8842 (2 port).
promiscuous Allow the driver to pass all data packets received, regardless of
the address. By default, promiscuous mode is disabled.
receive=num The number of Rx descriptors (and 2 KB npkts) to allocate. The

default is 256.
speed=10|100 Set the link speed (specified in Mbits/second: 10 or 100).
switch Enable switch mode on the 2-port 8842.

devn-micrel8841.so © 2010, QNX Software Systems GmbH & Co. KG.
This is very dangerous if you loop the network because of the resulting packet storms.
transmit=num The number of Tx descriptors to allocate (the default is 256).
verbose
vid=0xXXXX The PCI vendor ID.
Description:
The devn-micrel8841.so driver controls Micrel 8841 (1 port) or 8842 (2 port)
Ethernet controllers. This is a legacy io-net driver; its interface names are in the
form enX, where X is an integer.
This driver supports only PCI versions of the Micrel 8841 (1 port) and 8842 (2 port)
Ethernet controllers.
This driver supports hardware checksum calculations for both Tx and Rx of IP and
TCP packets (UDP isn’t supported). To enable hardware checksumming, use
ifconfig like this, after starting the driver:
ifconfig enX ip4csum tcp4csum
Examples:
Start io-pkt-v6-hc using the devn-micrel8841.so driver and Qnet with 1024
transmit descriptors, and 1024 receive descriptors to avoid packet loss due to
scheduling latency on slow processors:
io-pkt-v6-hc -d micrel8841 transmit=1024,receive=1024 -p qnet
Files:
io-pkt*.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devn-ne2000.so
Driver for NE-2000-compatible Ethernet adapters
Syntax:
io-pkt-variant -d ne2000 [option[,option ...]] ...
Runs on:
Neutrino
Options:
did=0xXXXX PCI device ID. The default is automatically detected on supported

hardware.
ioport=num I/O port of the interface. The port parameter must be a hex
address (e.g. 0x320). The default is automatically detected on

mac=XXXXXXXXXXXX

pci=0xXXXX PCI index of the controller. The default is automatically detected

on the supported hardware.
tmem=name Name for typed memory.
verbose
higher the number, the more detailed the output). The output goes
to slogger, invoke sloginfo to view.
vid=0xXXXX The PCI vendor ID of the controller. The default is automatically

detected on the supported hardware.
width=8|16 I/O access width (8 or 16 bits). The default is automatically


devn-ne2000.so © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The devn-ne2000.so driver controls NE-2000-compatible Ethernet adapters.
this driver.
integer.
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the NE-2000 driver:
io-pkt-v4-hc -d ne2000 ioport=0x320,irq=11

Files:
io-pkt*.

© 2010, QNX Software Systems GmbH & Co. KG. devn-ne2000.so
Caveats:
If you’re running a PCMCIA NE2000-compatible adapter, you may need to specify
the -w8 command-line option of devp-pccard.
See also:
devn-*, devnp-*, devp-pccard, ifconfig, io-pkt*, nicinfo

devn-pcnet.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for AMD PCNET (AMD-79c97x) compatible Ethernet adapters
Syntax:
io-pkt-variant -d pcnet [option[,option ...]] ...
Runs on:
Neutrino
Options:
connector=0|1|2|3
0 BNC
1 UTP
2 AUI
3 FIBER
deviceindex=0xXXXX
Only attach to device with this PCI index.

supported hardware.
hpna Use HPNA phy.

IFT_ETHER.
iorange=0xXXXXXXXX
The I/O base address.
irq=num IRQ of the interface.

© 2010, QNX Software Systems GmbH & Co. KG. devn-pcnet.so
mac=XXXXXXXXXXXX
NIC_MEDIA_802_3.
memrange=0xXXXXXXXX
Register base physical memory address.
mmap Use memory-mapped registers. The default is IO mapped.
mtu=num Maximum transmission unit. The default (1514) is
phy=num Address of the connected PHY device.
probe_phy=0|1 Select whether or not to probe the PHY at regular intervals. For
the default value of 0, the PHY is polled only at regular
intervals when the interface is down or doesn’t receive any
packets over the polling interval. If you specify 1, the PHY is
always probed at regular intervals to see if the duplex and/or
speed of the connection has changed.
receive=num Set the number of receive descriptors/buffers. The default is 64.
half (0).
transmit=num Number of transmit descriptors/buffers. The default is 128.
verbose
default is 0. The output goes to slogger; invoke sloginfo to
view it.

devn-pcnet.so © 2010, QNX Software Systems GmbH & Co. KG.
vid=0xXXXX PCI vendor ID of the controller. The default is automatically

Description:
The devn-pcnet.so driver controls AMD PCNET (AMD-79c97x) compatible
Ethernet adapters. This is a legacy io-net driver; its interface names are in the form
enX, where X is an integer.
• If the device enumerators (see enum-devices) don’t recognize your device, try
• This driver doesn’t support Fiber PCNET cards with the AM79C971KC chip.
• We don’t recommend that you use devn-pcnet.so on the BCM1250 platform,

because it can lose receive interrupts.
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the AMD PCNET driver:
io-pkt-v4-hc -d pcnet
Files:
io-pkt*.

© 2010, QNX Software Systems GmbH & Co. KG. devn-pcnet.so
See also:

devn-pegasus.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for SMC EZ Connect and other USB Ethernet adapters based on the Pegasus chipset
Syntax:
io-pkt-variant -d pegasus [option[,option ...]] ...
Runs on:
Neutrino
Options:

IFT_ETHER.
mac=XXXXXXXXXXXX
MAC address of the controller. You must set the MAC address
for this controller.

NIC_MEDIA_802_3.

path Set the device name. The default is /dev/usbenet0.
receive=num Set the number of receive descriptors/buffers. The default is 5.

© 2010, QNX Software Systems GmbH & Co. KG. devn-pegasus.so
speed=10|100 Force media data rate (10Mbit or 100Mbit operation). The

specify speed, specify duplex as well; if speed alone is
specified, the specified speed will be correctly set, but duplex
will default to half (0).
transmit=num Set the number of transmit descriptors/buffers. The default is

10.
verbose
view it.
wait=num Wait num seconds for the USB stack. The default wait time is
60 seconds.
Description:
The devn-pegasus.so driver controls the SMC EZ Connect USB Ethernet adapter
and other USB Ethernet adapters based on the Pegasus chipset. This is a legacy
io-net driver; its interface names are in the form enX, where X is an integer.
ifconfig enX
device supports.
Examples:
Start io-pkt-v6-hc using the Pegasus driver:
io-pkt-v6-hc -d pegasus

devn-pegasus.so © 2010, QNX Software Systems GmbH & Co. KG.
Files:
io-pkt*.
Caveats:
Start the USB stack before using this driver (see devu-ohci.so or devu-uhci.so)
See also:
devn-*, devnp-*, devu-ohci.so, devu-uhci.so, ifconfig, io-pkt*,
nicinfo

© 2010, QNX Software Systems GmbH & Co. KG. devn-rtl.so
Driver for Realtek 8139 PCI cards
Syntax:
io-pkt-variant -d rtl [option[,option ...]] ...
Runs on:
Neutrino
Options:
connector=0|1|2|3
0 BNC
1 UTP
2 AUI
3 FIBER
deviceindex=0xXXXX
PCI index of the controller. Only attach to device with this PCI
index.
did=0xXXXX The PCI device ID. The default is automatically detected on

supported hardware.

IFT_ETHER.
iorange=0xXXXXXXXX
The I/O base address. The 0xXXXXXXXX parameter must be a
hex address (e.g. 0x320). The default is automatically detected

supported hardware.

devn-rtl.so © 2010, QNX Software Systems GmbH & Co. KG.
mac=XXXXXXXXXXXX

NIC_MEDIA_802_3.
memrange=0xXXXXXXXX
mtu=X Maximum transmission unit. The default (1514) is



priority=N Priority of the driver-event thread. The default is 21.

half (0).
verbose
view it.

© 2010, QNX Software Systems GmbH & Co. KG. devn-rtl.so
vid=0xXXXX The PCI vendor ID of the controller. The default is

Description:
The devn-rtl.so driver controls Realtek 8139 PCI cards. This is a legacy io-net
driver; its interface names are in the form enX, where X is an integer.
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the Realtek 8139 PCI card driver:
io-pkt-v4-hc -d rtl
Files:
io-pkt*.
See also:

devn-rtl8150.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Realtek 8150 Ethernet dongle
Syntax:
io-pkt-variant -d rtl8150 [option[,option ...]] ...
Runs on:
Neutrino
Options:
busnum=0xXX The USB bus number.
devnum=0xXX The USB device number.
did=0xXXXX The USB device ID.

IFT_ETHER.
On the SH platform, the lan= option gets overridden. As a workaround, fully specify
the vendor ID, device ID, bus number, and device number to the driver when starting
(e.g. vid=0x0bda,did=0x8150,busnum=1,devnum=2,lan=2).
mac=XXXXXXXXXXXX
The MAC address of the adapter. The default is automatically

NIC_MEDIA_802_3.
mtu=X The maximum transmission unit. The default (1514) is

path=name The device name. The default is /dev/usbenet0.
priority=N The priority of the driver-event thread. The default is 21.

© 2010, QNX Software Systems GmbH & Co. KG. devn-rtl8150.so

speed=10|100 The media data rate (10Mbit or 100Mbit operation). The default
is automatically detected on supported hardware. If you specify
speed, specify duplex as well; if you specify the speed alone,
the speed is correctly set, but duplex defaults to half (0).
transmit=num Set the number of tx descriptors. The default is 10.
uptype=name The interface name. The default is “en”.
verbose
vid=0xXXXX The USB vendor ID of the adapter. The default is automatically
wait=num Wait num seconds for the USB stack. The default is 60 seconds.
Description:
The devn-rtl8150.so driver controls the Realtek 8150 Ethernet dongle, which is
included in SMC2208 USB/Ethernet adapters. This is a legacy io-net driver; its
interface names are in the form enX, where X is an integer.
• This driver doesn’t support multicast and promiscuous modes.
ifconfig enX
device supports.

devn-rtl8150.so © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Start io-pkt-v6-hc using the Realtek driver:
io-pkt-v6-hc -drtl8150 verbose &

Files:
io-pkt*.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devn-sis9.so
Driver for the SiS900 Ethernet controller and compatibles
Syntax:
io-pkt-variant -d sis9 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
connector=0|1|2|3
0 BNC
1 UTP
2 AUI
3 FIBER
deviceindex=0xXXXX
PCI index of the controller. Only attach to device with this PCI
index.
did=0xXXXX The PCI device ID. The default is automatically detected on

supported hardware.

IFT_ETHER.
iorange=0xXXXXXXXX

supported hardware.

devn-sis9.so © 2010, QNX Software Systems GmbH & Co. KG.
mac=XXXXXXXXXXXX

NIC_MEDIA_802_3.
memrange=0xXXXXXXXX




half (0).
verbose
verbose=N Be verbose. Specify num for more verbosity (num can be 1-4,
the higher the number, the more detailed the output). The default
is 0. The output goes to slogger, invoke sloginfo to view.

Description:
The devn-sis9.so driver controls the SiS900 Ethernet controller and compatibles.
You can use ifconfig to enable hardware checksums if supported.

© 2010, QNX Software Systems GmbH & Co. KG. devn-sis9.so
Examples:
Start io-pkt-v6-hc using the SiS900 driver:
io-pkt-v6-hc -d sis9
Files:
io-pkt*.
See also:

devn-smc9000.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for SMC91c9x and SMC91c1xx (SMC9000) Ethernet controllers
Syntax:
io-pkt-variant -d smc9000 [,option[,option ...]] ...
Runs on:
Neutrino
Options:
connector=0|1|2
0 BNC
1 UTP
2 AUI
The default is UTP.
detected on supported hardware. If you specify duplex,
specify speed as well; if duplex alone is specified, it is ignored
and both speed and duplex are auto-negotiated.

IFT_ETHER.
iorange=0xXXXXXXXX
on supported hardware (but see caution below).
mac=XXXXXXXXXXXX
MAC address of the controller. You must set the MAC address
for this controller.

NIC_MEDIA_802_3.


© 2010, QNX Software Systems GmbH & Co. KG. devn-smc9000.so
pktque=num Set the maximum number of packets that will be queued for
transmission in system RAM. The default is 100.
pmmparent=string Override the parent component of the path to register for Power
Management.
speed=10|100 Force media data rate (10Mbit or 100Mbit operation). The

specify speed, specify duplex as well; if speed alone is
specified, the specified speed will be correctly set, but duplex
will default to half (0).
txcap=num Set the maximum number of packets that will be queued for
transmission in on-chip SRAM. On the 91c111 the default is 1,
since the amount of on-chip memory is limited to 4 packets.
Limiting the number of transmit packets prevents packet
transmission from using up all the SRAM, and makes more
SRAM available for receive. This prevents packet overruns on
receive. For other chips with more on-chip SRAM, the limit is
32 packets.
variant=name Set up the driver for a specific board variant. Currently

supported variants are generic, assabet, dbpxa250dp,,
graphicsmaster, innovator, and pxa250tmdp.
verbose
view it.
width=8|16|32 I/O access width (8, 16, or 32 bits). The default is 16.
! CAUTION: An incorrect width size can lock up the card or the platform CPU.
If you specify the variant option, the width option may be ignored.

devn-smc9000.so © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The devn-smc9000.so driver controls SMC 91c9x/91c1xx compatible Ethernet
adapters. This is a legacy io-net driver; its interface names are in the form enX,
where X is an integer.
CAUTION: This driver can’t always detect the correct irq and iorange options,
! especially for ISA devices. To be sure, always specify irq and iorange when using
this driver.
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the SMC9000 driver:
io-pkt-v4-hc -dsmc9000 iorange=0x200,irq=5

Files:
io-pkt*.
Caveats:
You must specify the mac option when using this driver.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devn-speedo.so
Driver for Intel 82557, 82558, and 82559 Fast Ethernet LAN adapters
Syntax:
io-pkt-variant -d /lib/dll/devn-speedo.so
[[index:option[,[index:option ...]] ... &
If you don’t specify the full path to devn-speedo.so, io=pkt* starts

devnp-speedo.so.
Runs on:
Neutrino
Options:
did=0xXXXX Device ID. Only attach to device with this PCI index. The
default is automatically detected on supported hardware.

IFT_ETHER.

supported hardware.
mac=XXXXXXXXXXXX

NIC_MEDIA_802_3.


devn-speedo.so © 2010, QNX Software Systems GmbH & Co. KG.


packets over the polling interval.
If you specify 1, the PHY is always probed at regular intervals
to see if the duplex and/or speed of the connection has changed.
This results in reduced performance due to lost packets under
heavy load, but guarantees the NIC is always in sync with the
media.
speed=10|100 Media data rate (10Mbit or 100Mbit operation). The default (0)
is automatically detected on supported hardware. If you specify
half (0).
verbose
goes to slogger, invoke sloginfo to view.
vid=0xXXXX The PCI vendor ID of the controller. Only attach to devices with
this PCI vendor ID. The default is automatically detected on
supported hardware.
Description:
The devn-speedo.so driver manages the Intel 82557, 82558, and 82559 Fast
Ethernet LAN adapters. This is a legacy io-net driver; its interface names are in the
form enX, where X is an integer.

© 2010, QNX Software Systems GmbH & Co. KG. devn-speedo.so
ifconfig enX
device supports.
Examples:
Start io-pkt-v6-hc using the devn-speedo.so driver:
io-pkt-v6-hc -d /lib/dll/devn-speedo.so
For the second instance of the device in the system, start io-pkt-v6-hc using the
devn-speedo.so driver. Use increased verbosity and override the default #MAC
address:
io-pkt-v6-hc -d /lib/dll/devn-speedo.so verbose,idx1:mac=00:03:02:01:00:00

Files:
entries. For more information, see the documentation for io-pkt*
See also:

devn-tigon3.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for TIGON3 (BCM570X) Ethernet controller
Syntax:
io-pkt-variant -d tigon3 [option[,option ...]] ...&
Runs on:
Neutrino
Options:
connector=type The network cable connector type:
0 BNC
1 UTP
3 FIBER
did=0xXXXX The device ID. The default is automatically detected on

supported hardware.
duplex=dup Half (0) or full (1) duplex mode. The default is automatically
detected on supported hardware. If you specify duplex,
specify speed as well; if duplex alone is specified, it’s ignored,
and both speed and duplex are autonegotiated.
mac=XXXXXXXXXXXX
The MAC address of the controller. The default is

pci=0xXXXX The PCI index of the controller. The default is automatically

priority The priority of the driver thread. The default is 21.
promiscuous=0|1 If set to 1, enable the driver to pass all data packets received,
regardless of address. The default is 0.
single In a multiple NIC environment, stop after the first detected

card. Default is to enable all cards found.

© 2010, QNX Software Systems GmbH & Co. KG. devn-tigon3.so
speed=10|100|1000
The media data rate, in megabits per second. The default is
half (0).
verbose
output goes to slogger; invoke sloginfo to view it.
vid=0xXXXX The vendor ID of the controller. The default is automatically

Description:
The devn-tigon3.so driver is the Ethernet controller for the Broadcom BCM570X.
integer.
• This driver on the Dell PowerEdge 850 board runs only up to 100 Mbit/s, and not
1000 Mbit/s. Other boards work well at 1000 Mbit/s.
ifconfig enX
device supports.

devn-tigon3.so © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Start io-pkt-v4 using the TIGON3 driver:
io-pkt-v4 -d tigon3 verbose

Files:
io-pkt*.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devn-tulip.so
Driver for DEC 21x4x (Tulip) compatible Ethernet adapters
Syntax:
io-pkt-variant -d tulip [option[,option ...]] ... &
Runs on:
Neutrino
Options:
connector=0|1|2|3
0 BNC
1 UTP
2 AUI
3 FIBER

supported hardware.
mac=XXXXXXXXXXXX
MAC address of the controller. If no SROM is available, the
MAC will default to 00:00:00:00:00:00.

nosrom Informs the driver that there is no valid connected SROM: the
driver will default to using media independent interface (MII),
physical media interface (PHY) auto-negotiation. (A valid MAC
address must be supplied on the command line.)


devn-tulip.so © 2010, QNX Software Systems GmbH & Co. KG.
phyaddr=num Override the MII routines and use the specified PHY address.
pktque=num Limit the number of packets in the queue. The default is 100.
priority=num Priority of the driver thread. The default is 21.
promiscuous Enable the driver to pass all data packets received, regardless of
address. By default, promiscuous mode is disabled.
receive=num Number of receive descriptors/buffers. The default is 64.
single Use this option if you have multiple Tulip cards in your system
and want to configure them differently. The single option tells
the driver to stop after configuring the first Tulip card it finds.
The order of the search can’t be determined because it depends
on the PCI server and PCI BIOS used. After the first card has
been configured, when the driver is invoked again, it will find
and configure the next card in order, and so on until all Tulip
cards have been configured. The default is to enable all Tulip
cards found.

half (0).
threshold=N Amount of packet data that must be in TX FIFO before

transmission is initiated. The range is 0-4. The default is 3. If
you observe transmit underruns, set the number to 4.
verbose
vid=0xXXXX The PCI vendor ID of the controller. The default is

Description:
The devn-tulip.so driver controls DEC 21x4x (Tulip) compatible Ethernet
adapters. This is a legacy io-net driver; its interface names are in the form enX,

© 2010, QNX Software Systems GmbH & Co. KG. devn-tulip.so
When you start a single instance of the Tulip driver on a multiport board (using the
pci= option), the board might not function unless this instance is on the first interface.
On NICs with multiple interfaces sharing a single SROM, the first NIC is the only one
that can read the SROM.
ifconfig enX
device supports.
Examples:
Start io-pkt-v6-hc using the Tulip driver:
io-pkt-v6-hc -d tulip
Files:
io-pkt*.
See also:

devn-via-rhine.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for VIA Rhine Network Interface Cards
Syntax:
io-pkt-variant -d via-rhine [option[,option ...]] ...
Runs on:
Neutrino
Options:
connector=0|1|2|3
Network cable connector type.
0 BNC
1 UTP
2 AUI
3 FIBER
deviceindex=0xXXXX
Only attach to a device with this PCI index.
did=0xXXXX Device ID. The default is automatically detected on supported

hardware.
dma=num DMA channel.

IFT_ETHER.
iorange=0xXXXXXXXX
The IO base address.
mac=XXXXXXXXXXXX

© 2010, QNX Software Systems GmbH & Co. KG. devn-via-rhine.so

NIC_MEDIA_802_3
memrange=0xXXXXXXXX
mtu=X Maximum transmission unit. The default (1514) is automatically



priority=N Priority of the driver event thread. The default is 21.
promiscuous=0|1
If set to 1, enable the driver to pass all data packets received,
regardless of address. The default is 0.
receive=X Number of receive descriptors/buffers. The default is 64.

half (0).
verbose

Description:
The devn-via-rhine.so driver controls VIA Rhine Network Interface Cards
(NICs). This is a legacy io-net driver; its interface names are in the form enX, where
X is an integer.

devn-via-rhine.so © 2010, QNX Software Systems GmbH & Co. KG.
ifconfig enX
device supports.
Examples:
Start io-pkt-v4-hc using the VIA Rhine NIC driver:
io-pkt-v4-hc -d via-rhine
Files:
io-pkt*.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-ath.so
Driver for Atheros AR5210, AR5211, AR5212, and AR5213 wireless network adapters
Syntax:
io-pkt-variant -d ath ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-ath.so driver supports wireless network adapters based on the Atheros
AR5210, AR5211, AR5212, and AR5213 chips. Chip-specific support is provided by
the Atheros Hardware Access Layer (HAL) (which isn’t available in source format).
This is a ported NetBSD driver; its interface names are in the form athX, where X is
an integer.
Supported features include 802.11 and 802.3 frames, power management, BSS, IBSS,
and host-based access point operation modes. All host/device interaction is via DMA.
The devnp-ath.so driver encapsulates all IP and ARP traffic as 802.11 frames,
however it can receive either 802.11 or 802.3 frames. Transmit speed and operating
mode are selectable, depending on your hardware.
AR5210-based devices support 802.11a operation with transmit speeds of 6 Mbps, 9
Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, and 54 Mbps.
AR5211-based devices support 802.11a and 802.11b operation with transmit speeds as
above for 802.11a operation and 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps for 802.11b
operation.
AR5212-based and AR5213-based devices support 802.11a, 802.11b, and 802.11g
operation with transmit speeds appropriate to each.
The actual transmit speed used is dependent on signal quality and the “rate control”
algorithm employed by the driver. All chips support WEP encryption. AR5211 and
AR5212 support the AES, TKIP, and Michael cryptographic operations required for
WPA, but at this time the driver doesn’t support them. To enable encryption, use
ifconfig.
By default, the devnp-ath.so driver configures the card for BSS operation (also
known as infrastructure mode). This mode requires the use of an access point (base
station).
The devnp-ath.so driver also supports the standard IBSS point-to-point mode,
where stations can communicate amongst themselves without the aid of an access
point.

devnp-ath.so © 2010, QNX Software Systems GmbH & Co. KG.
You can also configure the driver to operate in hostap mode. In this mode, a host may
function as an access point (base station). Access points are different from operating
in IBSS mode. They operate in BSS mode. They allow for easier roaming and bridge
all Ethernet traffic such that machines connected via an access point appear to be on
the local Ethernet segment.
To choose the mode of operation, specify the appropriate mediaopt value to
ifconfig. To view a list of media types and options supported by the card, try
ifconfig -m device. For example, ifconfig -m ath0.
For more information on configuring this device, see ifconfig.
Native io-pkt and ported NetBSD drivers don’t put entries into the /dev/io-net
namespace, so a waitfor command for such an entry won’t work properly in
buildfiles or scripts. Use if_up -p instead; for example, instead of waitfor
/dev/io-net/ath0, use if_up -p ath0.
See also:
devn-*, devnp-*, ifconfig, io-pkt, nicinfo

© 2010, QNX Software Systems GmbH & Co. KG. devnp-axe.so
Driver for USB (2.0) Ethernet adapters based on the ASIX AX88172 chip
Syntax:
io-pkt-variant -d axe ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-axe.so driver supports USB (2.0) Ethernet adapters based on the ASIX
AX88172 chip. This is a ported NetBSD driver; its interface names are in the form
axeX, where X is an integer.
• The version of this driver that we ship is compiled for x86 only. If you want to use
it on other platforms, download the source code for it from Foundry27.
• The USB-Ethernet dongle sometimes drops packets when used on slow systems or
with UHCI. If you encounter problems with this driver, use the legacy
devn-asix.so driver instead.
The chip contains a 10/100 Ethernet MAC with MII interface and is designed to work
with both Ethernet and HomePNA transceivers. The chip also supports USB 2.0,
thereby accommodating 100 Mb/s data rates.
The devnp-axe.so driver supports the following media types:
autoselect Enable automatic selection of the media type and options.
10baseT/UTP Set 10Mbps operation. You can also use the mediaopt option to
enable full-duplex operation. Not specifying full duplex implies
half-duplex mode.
100baseTX Set 100Mbps (fast Ethernet) operation. You can also use the
mediaopt option to enable full-duplex operation. Not specifying
full duplex implies half-duplex mode.
The devnp-axe.so driver supports the following media options:
full-duplex Force full-duplex operation. The interface operates in half-duplex

mode if you don’t specify this media option.

devnp-axe.so © 2010, QNX Software Systems GmbH & Co. KG.
For more information on configuring this device, see ifconfig.
/dev/io-net/axe0, use if_up -p axe0.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-bce.so
Driver for Broadcom BCM440x 10/100 Ethernet controllers
Syntax:
io-pkt-variant -d bce ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-bce.so driver manages the Broadcom BCM440x 10/100 Ethernet
controllers. This is a ported NetBSD driver; its interface names are in the form bceX,
ifconfig bceX
device supports.
/dev/io-net/bce0, use if_up -p bce0.
Examples:
Start the v4 TCP/IP variant of io-pkt using the devnp-bce.so driver:
io-pkt-v4 -d bce
ifconfig bce0 10.184

devnp-bce.so © 2010, QNX Software Systems GmbH & Co. KG.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-bcm1250.so
Driver for Broadcom BCM1250 10/100/1000 Mbit Ethernet controllers
Syntax:
io-pkt-variant -d bcm1250 \
memrange=0xXXXXXXXX,irq=0xYYYYYYYY,\
mac=ZZZZZZZZZZZZ[,option[,option ...]] ... &
Runs on:
Neutrino
Options:
Use commas, not spaces, to separate the options. These options override the
autodetected defaults.
allmulticast Always receive all multicast packets.
cluster=X The size of the Rx descriptor data buffers, in bytes. The default
is 2048; 4096 is a good value with the appropriate io-pkt
binary.
dma64=0|1 Turn off or on 64-byte DMA transfers.
detected on supported hardware. You can also use ifconfig
-m and ifconfig bcmX media to set this.
irq=num The IRQ of the interface.
kermask=0|1 Specify the masking:

• 1 — use the kernel interrupt-masking methodology.
• 0 — manually mask the NIC in the interrupt handler.
lockcpu=N Set the CPU affinity for the Rx thread to N.
mac=XXXXXXXXXXXX
The interface address of the controller. You must specify this
option if you aren’t using the syspage option.
memrange=XXXXXXXXXXXX
probe_phy=0|1 Disable (0) or force (1) periodic PHY probing when idle.
receive=num The number of Rx buffers to internally cache. The default is

512.

devnp-bcm1250.so © 2010, QNX Software Systems GmbH & Co. KG.
speed=10|100|1000
The media data rate in megabits/second. The default is
automatically detected on supported hardware. You can also use
ifconfig -m and ifconfig bcmX media to set this.
syspage Read hardware parameters (IRQs, MAC, base register address,

and PHY address) for all devices from the system page. If you
don’t use this option, you must use the mac=X option.
transmit=num The number of Tx buffers to internally cache. The default is

1024.
tx_rd=N Set the TX_RD threshold.
tx_rl=N Set the TX_RL threshold.
verbose
verbose=N Be verbose. Specify num for more verbosity (num can be 1-4;
view it.
Description:
The devnp-bcm1250.so driver controls Broadcom BCM1250 10/100/1000 Mbit
Ethernet controllers. This is a native io-pkt driver; its interface names are in the
form bcmX, where X is an integer.
ifconfig bcmX
device supports.

© 2010, QNX Software Systems GmbH & Co. KG. devnp-bcm1250.so
/dev/io-net/bcm0, use if_up -p bcm0.
Examples:
Start the v4 TCP/IP variant of io-pkt using the devnp-bcm1250.so driver on
BCM91480A eth0:
io-pkt-v4 -d /proc/boot/devnp-bcm1250.so \
memrange=0x10064000,irq=0x80050024,mac=001122334455
ifconfig bcm0 10.184
See also:

devnp-bcm43xx.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for the Broadcom-based 43xx 802.11b/g wireless Ethernet controller
Syntax:
io-pkt-variant -d bcm43xx [option[,option ...]] ... &
Runs on:
Neutrino
Options:
Use commas (,), not spaces, to separate the options.
irq=num The IRQ of the interface. It’s automatically detected by default.
mac=XXXXXXXXXXXX
The MAC address of controller. The default is automatically
pio Run the driver in PIO mode; the default is bus master.
verbose
higher the number, the more detailed the output). The output goes
to slogger; invoke sloginfo to view it.
Description:
The devnp-bcm43xx.so driver controls the Broadcom-based 802.11b/g wireless
Ethernet controller. This is a native io-pkt driver; its interface names are in the form
bcmX, where X is an integer.
The devnp-bcm43xx.so driver is fully integrated with the 802.11 layer in the stack.
It supports both infrastructure client and access point modes of operation. For further
information, see ifconfig, wpa_supplicant, and hostapd.
ifconfig bcmX

© 2010, QNX Software Systems GmbH & Co. KG. devnp-bcm43xx.so
device supports.
/dev/io-net/bcm0, use if_up -p bcm0.
Examples:
Start the v6 variant of io-pkt using the Broadcom 43xx driver:
io-pkt-v6-hc -d bcm43xx
See also:
devn-*, devnp-*, hostapd, ifconfig, io-pkt, nicinfo, wpa_supplicant

devnp-bge.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Broadcom 57xx Tigon3 10/100/1000 Mbit Ethernet controllers
Syntax:
io-pkt-variant -d bge ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-bge.so driver manages the Broadcom 57xx Tigon3 10/100/1000 Mbit
Ethernet controllers. This is a ported NetBSD driver; its interface names are in the
form bgeX, where X is an integer.
ifconfig bgeX
device supports.
/dev/io-net/bge0, use if_up -p bge0.
Examples:
Start the v4 TCP/IP variant of io-pkt using the devnp-bge.so driver:
io-pkt-v4 -d bge
ifconfig bge0 10.184

© 2010, QNX Software Systems GmbH & Co. KG. devnp-bge.so
See also:

devnp-e1000.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Intel Gigabit Ethernet controllers
Syntax:
io-pkt-variant -d e1000 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX Detect only devices with this specific PCI Device ID. The
default is automatically detected on supported hardware.
You can also use ifconfig -m and ifconfig wmX media
to set this.
supported hardware.
mac=XXXXXXXXXXXX
The MAC address of the controller. The default is automatically
mtu=N The maximum transmission unit. The default is 1514.
pauseignore Ignore pause frames with respect to full duplex flow control.
pausesuppress Suppress pause frames with respect to full duplex flow control.
pci=0xXXXX Detect only devices at this specific PCI index.
priority=N The priority of the driver’s event-handler thread (default 21).
receive=num The number of receive descriptors; the default is 64.
speed=N Force the link speed (specified in Mbits/second). If you specify
specified speed is correctly set, but duplex defaults to half (0).
You can also use ifconfig -m and ifconfig wmX media
to set this.

© 2010, QNX Software Systems GmbH & Co. KG. devnp-e1000.so
transmit=N The number of transmit descriptors; the default is 128.
verbose
vid=0xXXXX Detect only devices with this specific PCI Vendor ID.
Description:
The devnp-e1000.so driver manages all current Intel Gigabit devices. This is a
native io-pkt driver; its interface names are in the form wmX, where X is an integer.
The devnp-e1000.so and devnp-i82544.so drivers are similar:
• devnp-i82544.so has performance optimizations (TSO and interrupt

thresholding options) that may make it a better performing candidate for some
hardware
• devnp-e1000.so likely supports more hardware
ifconfig wmX
device supports.

devnp-e1000.so © 2010, QNX Software Systems GmbH & Co. KG.
/dev/io-net/wm0, use if_up -p wm0.
The SQE (Squelch Test Errors) counter — one of the fields reported by nicinfo —
isn’t applicable to devnp-e1000.so, so this driver uses it in a non-standard way. You
can lose packets because:
• you ran out of descriptors (the NIC was able to buffer the packet, but there was no
CPU RAM available)
or:
• the NIC was unable to buffer the packet because it overran its internal Rx FIFO
Other drivers add the two together, but this driver uses the SQE counter for internal Rx
FIFO overruns, which generally indicate excessive bus latency, perhaps misconfigured
link-level flow control, or even misconfigured Rx FIFO watermarks.
Examples:
Start io-pkt using the devnp-e1000.so driver and the full TCP/IP stack:
io-pkt -d e1000
ifconfig wm0 192.168.0.10
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-i80579.so
Driver for Intel Tolapai 80579 Gigabit Ethernet controllers
Syntax:
io-pkt-variant -d i80579 [option[,option...]] ... &
Runs on:
QNX Neutrino
Options:
did=X Detect only devices with this specific PCI Device ID (e.g.
0x5041, 0x5045, or 0x5049).
poll For debugging only. Don’t use an interrupt; poll Rx instead.
probe_phy=0|1 Disable (0) or force (1) periodic PHY probing.
receive=X The number of receive descriptors (the default is 256).
transmit=X The number of transmit descriptors (the default is 256).
verbose=N Set the verbosity level. The default is zero; a larger value for N
yields more output. The output is sent to slogger; invoke
sloginfo to view it.
Description:
The devnp-i80579.so driver manages the Intel Tolapai 80579 Gigabit Ethernet
controller. This is a native io-pkt driver; its interface names are in the form gbeX,
ifconfig gbeX
device supports.

devnp-i80579.so © 2010, QNX Software Systems GmbH & Co. KG.
/dev/io-net/gbe0, use if_up -p gbe0.
Examples:
Start the v4 TCP/IP variant of io-pkt using the devnp-i80579.so driver:
io-pkt-v4 -d i80579
ifconfig gbe0 10.1
ping -n 10.2
See also:

Driver for Intel 825* Gigabit Ethernet LAN adapters
Syntax:
io-pkt-variant -d i82544 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX Detect only devices with this specific PCI Device ID. The default
is automatically detected on supported hardware.
You can also use ifconfig -m and ifconfig wmX media to
set this.

supported hardware.
irq_thresh=X The maximum number of interrupts per second to be generated.

The default is 9000. This reduces CPU consumption by limiting
how often interrupts occur, which is especially helpful on slower
processors.
mac=XXXXXXXXXXXX

pause_rx_disable
Disregard received pause (flow control) frames.
pause_rx_enable
Always act on received pause (flow control) frames.
pause_tx_disable
Never transmit pause (flow control) frames.

pause_tx_enable
Always transmit pause (flow control) frames.
pci=0xXXXX Detect only devices at this specific PCI index.
rx_abs=X The receive interrupt absolute delay time multiplier. The default
is 92, and the maximum is 200.
rx_delay=X The receive interrupt delay time multiplier (×1.024 ns). The
default is 23, and the maximum is 50.
speed=10|100|1000
The media data rate (10Mbit, 100Mbit, or Gigabit operation).
The default is automatically detected on supported hardware. If
you specify speed, specify duplex as well; if speed alone is
specified, the specified speed is correctly set, but duplex defaults
to half (0).
You can also use ifconfig -m and ifconfig wmX media to
set this.
transmit=N The number of transmit descriptors; the default is 4096.
verbose
verbose=num Be verbose. Specify num for more verbosity (num can be 1-4; the
vid=0xXXXX Detect only devices with this specific PCI Vendor ID.
Description:
The devnp-i82544.so driver manages the Intel 82540, 82541, 82544, 82545,
82546, 82547, 82571, and 82572 Gigabit Ethernet LAN adapters. This is a native
io-pkt driver; its interface names are in the form wmX, where X is an integer.
The devnp-e1000.so and devnp-i82544.so drivers are similar:
• devnp-i82544.so has performance optimizations (TSO and interrupt

thresholding options) that may make it a better performing candidate for some
hardware
• devnp-e1000.so likely supports more hardware
Transmit Segmentation Offload (TSO) allows the stack to send very large TCP buffers
down to the driver, and the driver takes care of carving them up into individual IP
packets of the right size. This can greatly reduce the CPU usage for transmitting large
amounts of data.

ifconfig wmX
device supports.
/dev/io-net/wm0, use if_up -p wm0.
The SQE (Squelch Test Errors) counter — one of the fields reported by nicinfo —
isn’t applicable to devnp-i82544.so, so this driver uses it in a non-standard way.
You can lose packets because:
• you ran out of descriptors (the NIC was able to buffer the packet, but there was no
CPU RAM available)
or:
• the NIC was unable to buffer the packet because it overran its internal Rx FIFO
Other drivers add the two together, but this driver uses the SQE counter for internal Rx
FIFO overruns, which generally indicate excessive bus latency, perhaps misconfigured
link-level flow control, or even misconfigured Rx FIFO watermarks.
Examples:
Start io-pkt using the devnp-i82544.so driver and the full TCP/IP stack:
io-pkt -d i82544 -p tcpip

ifconfig wm0 10.1.0.184

See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-mpcsec.so
Hardware Crypto Engine driver
This driver is shipped only with the BSPs that need it.
Syntax:
io-pkt-variant -d mpcsec [option[,option ...]] ... &
Runs on:
Neutrino
Options:
Use commas, not spaces, to separate the options. Use these options to override the
defaults.
irq=N IRQ of the interface. The driver will attempt to autodetect the
IRQ; if that doesn’t work, you can specify it manually using this
option. Note that the 85xx sec interrupt is 29 (decimal), and the
83xx sec interrupt is 11 (decimal).
verbose=num Be verbose. If num is 1, the driver displays configuration data; if

num is 2, it also runs initialization tests and displays diagnostic
counters periodically.
Description:
The devnp-mpcsec.so shared object is a Hardware Crypto Engine driver. This is a
native io-pkt driver; its interface names are in the form tsecX, where X is an integer.
ifconfig tsecX
device supports.

devnp-mpcsec.so © 2010, QNX Software Systems GmbH & Co. KG.
/dev/io-net/tsec0, use if_up -p tsec0.
Examples:
On the 85xx, start the v6 TCP/IP variant of io-pkt, using the devnp-mpcsec.so
SEC driver and the TSEC Ethernet driver with IPsec enabled in the stack:
io-pkt-v6-hc -d /proc/boot/devnp-mpcsec.so verbose=2 -p tcpip-v6 \
ipsec -d /proc/boot/devnp-mpc85xx.so mac=00112233AABBCC
# config the (2nd) ethernet port
ifconfig tsec1 10.42.110.239
# config md5-hmac ah and des-cbc esp for IPsec to peer 10.42.110.212
setkey -c << EOF
add 10.42.110.212 10.42.110.239 ah 9877 -A hmac-md5 "1234567890123456";
add 10.42.110.239 10.42.110.212 ah 9878 -A hmac-md5 "1234567890123456";
add 10.42.110.212 10.42.110.239 esp 9881 -E des-cbc "12345678";
add 10.42.110.239 10.42.110.212 esp 9882 -E des-cbc "12345678";
spdadd 10.42.110.239 10.42.110.212 any -P out ipsec esp/transport//use ah/transport//use;
EOF
# on peer 10.42.110.212 run this:

setkey -c << EOF
add 10.42.110.212 10.42.110.239 ah 9877 -A hmac-md5 "1234567890123456";
add 10.42.110.239 10.42.110.212 ah 9878 -A hmac-md5 "1234567890123456";
add 10.42.110.212 10.42.110.239 esp 9881 -E des-cbc "12345678";
add 10.42.110.239 10.42.110.212 esp 9882 -E des-cbc "12345678";
spdadd 10.42.110.212 10.42.110.239 any -P out ipsec esp/transport//use ah/transport//use;
EOF
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-mpc85xx.so
Driver for Freescale MPC85XX TSEC Ethernet controllers
This driver is shipped only with the BSPs that need it.
Syntax:
io-pkt-variant -d mpc85xx mac=ZZZZZZZZZZZZ
[option[,option...]] ... &
Runs on:
Neutrino
Options:
Use commas, not spaces, to separate the options. These options override the
autodetected defaults.
detected on supported hardware. You can also use ifconfig
-m and ifconfig tsecX media to set this.
etsec=0|1 Use the older TSEC (0) or newer eTSEC (1). The default is
fifo=num Set the transmit FIFO threshold to num. The default is 64 on

85xx, and 480 on 83xx. Each entry is 4 bytes.

loopback Place the MAC into loopback mode for testing purposes.
mac=XXXXXXXXXXXX
The interface address of the controller. You must specify this
option if you aren’t using the syspage option.
pauseignore Disable link-layer flow control for Rx.
pausesuppress Disable link-layer flow control for Tx.
phy_addr=X The PHY address that en0 has.
phy_incr=X The PHY address increment to add to get the address for the
next interface.

devnp-mpc85xx.so © 2010, QNX Software Systems GmbH & Co. KG.
probe_phy=0|1 Disable (0) or force (1) periodic PHY probing when idle.
receive=num The number of receive descriptors. The default is 512.
rx_delay=X Set the Rx interrupt coalescing timer threshold. Valid values are
1 through 65,535; the default is zero (disabled). If you set
rx_delay, you must also set rx_frame.
rx_frame=X Set the Rx interrupt coalescing frame threshold. Valid values

are 1 through 255; the default is zero (disabled). If you set
rx_frame, you must also set rx_delay.
speed=10|100|1000
The media data rate in megabits/second. The default is
automatically detected on supported hardware. You can also use
ifconfig -m and ifconfig tsecX media to set this.
syspage Read hardware parameters (IRQs, MAC, base register address,

and PHY address) for all devices from system page. If you
don’t use this option, you must use the mac=X option.
transmit=num The number of transmit descriptors. The default is 1024.
verbose
verbose=N Be verbose. Specify num for more verbosity (num can be 1-4;
view it.
Description:
The devnp-mpc85xx.so driver controls Freescale MPC85XX TSEC Ethernet
controllers. This is a native io-pkt driver; its interface names are in the form tsecX,
ifconfig tsecX

© 2010, QNX Software Systems GmbH & Co. KG. devnp-mpc85xx.so
device supports.
/dev/io-net/tsec0, use if_up -p tsec0.
Examples:
Start the v4 TCP/IP variant of io-pkt using the devnp-mpc85xx.so driver:
io-pkt-v4 -d mpc85xx mac=00123456789a

ifconfig tsec0 10.184
See also:

devnp-msk.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Marvell Yukon-2 based Gigabit Ethernet adapters
Syntax:
io-pkt-variant -d msk ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-msk.so driver supports the Marvell Yukon-2 based Gigabit Ethernet
adapters, including the following:
• Marvell Yukon 88E8035, copper adapter
• SK-9E21 1000Base-T single port, copper adapter
• SK-9E22 1000Base-T dual port, copper adapter
• SK-9E81 1000Base-SX single port, multimode fiber adapter
• SK-9E82 1000Base-SX dual port, multimode fiber adapter
• SK-9E91 1000Base-LX single port, single mode fiber adapter
• SK-9E92 1000Base-LX dual port, single mode fiber adapter
• SK-9S21 1000Base-T single port, copper adapter
• SK-9S22 1000Base-T dual port, copper adapter
• SK-9S81 1000Base-SX single port, multimode fiber adapter
• SK-9S82 1000Base-SX dual port, multimode fiber adapter
• SK-9S91 1000Base-LX single port, single mode fiber adapter

© 2010, QNX Software Systems GmbH & Co. KG. devnp-msk.so
• SK-9S92 1000Base-LX dual port, single mode fiber adapter
• SK-9E21D 1000Base-T single port, copper adapter
This is a ported NetBSD driver; its interface names are in the form mskX, where X is
an integer.
Support for jumbo frames is provided via the interface MTU setting. Selecting an
MTU larger than 1500 bytes with the ifconfig utility configures the adapter to
receive and transmit jumbo frames. Using jumbo frames can greatly improve
performance for certain tasks, such as file transfers and data streaming.
Hardware TCP/IP checksum offloading for IPv4 is supported.
The following media types and options (as given to ifconfig) are supported:
media autoselect
Enable the autoselection of the media type and options. You can manually
override the autoselected mode.
media 1000baseSX mediaopt full-duplex
Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode.
media 1000baseSX mediaopt half-duplex

Set 1000Mbps (Gigabit Ethernet) operation on fiber and force half-duplex mode.
media 1000baseT mediaopt full-duplex
Set 1000Mbps (Gigabit Ethernet) operation and force full-duplex mode.
For more information on configuring this device, see ifconfig. To view a list of
media types and options supported by the card, try ifconfig -m device. For
example, ifconfig -m msk0.
/dev/io-net/msk0, use if_up -p msk0.
See also:

devnp-ral.so, devnp-ural.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Ralink RT2500, RT2501, RT2600, and RT2500USB wireless adapters
Syntax:
io-pkt-variant -d ral ... &
io-pkt-variant -d ural ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-ral.so driver supports PCI/CardBus wireless adapters based on the
Ralink RT2500, RT2501, and RT2600 chipsets. The devnp-ural.so driver supports
USB 2.0 wireless adapters based on the Ralink RT2500USB chipset. These are ported
NetBSD drivers; their interface names are in the form ralX and uralX, where X is an
integer.
The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink. It
consists of two integrated chips, an RT2560 or RT2570(USB) MAC/BBP and an
RT2525 or RT2526(USB) radio transceiver.
The RT2501 chipset is the second generation of 802.11b/g adapters from Ralink. It
consists of two integrated chips, an RT2561 MAC/BBP and an RT2527 radio
transceiver. This chipset provides support for the IEEE 802.11e standard with multiple
hardware transmission queues and allows scatter/gather for efficient DMA operations.
The RT2600 chipset consists of two integrated chips, an RT2661 MAC/BBP and an
RT2529 radio transceiver. This chipset uses the MIMO (multiple-input
multiple-output) technology with multiple antennas to extend the operating range of
the adapter and to achieve higher throughput.
These drivers can operate in these modes:
BSS mode Also known as infrastructure mode, this is used when associating
with an access point, through which all traffic passes. This mode is
the default.
IBSS mode Also known as IEEE ad-hoc mode or peer-to-peer mode. This is
the standardized method of operating without an access point.
Stations associate with a service set. However, actual connections
between stations are peer-to-peer.
Host AP In this mode, the driver acts as an access point (base station) for
other cards.

© 2010, QNX Software Systems GmbH & Co. KG. devnp-ral.so, devnp-ural.so
Monitor mode In this mode, the driver is able to receive packets without
associating with an access point. This disables the internal receive
filter and enables the card to capture packets from networks which
it wouldn’t normally have access to, or to scan for access points.
The devnp-ral.so and devnp-ural.so drivers support software WEP. Wired

Equivalent Privacy (WEP) is the de facto encryption standard for wireless networks. It
can be typically configured in one of three modes: no encryption; 40-bit encryption; or
104-bit encryption. Unfortunately, due to serious weaknesses in WEP protocol it is
strongly recommended that it not be used as the sole mechanism to secure wireless
communication. WEP is not enabled by default. You can also use the driver in
conjunction with wpa_supplicant to provide WPA / WPA2 encryption.
You can use ifconfig to configure the devnp-ral.so and devnp-ural.so
drivers at runtime:
bssid bssid Set the desired BSSID.
-bssid Unset the desired BSSID. The interface automatically selects a

BSSID in this mode, which is the default.
chan n Set the channel (radio frequency) to be used by the driver based
on the given channel ID n.
-chan Unset the desired channel to be used by the driver. The driver
automatically selects a channel in this mode, which is the
default.
media media These drivers support the following media types:

• autoselect — enable autoselection of the media type and
options.
• DS1 — 802.11b DS 1Mbps operation.
• DS5 — 802.11b DS 5.5Mbps operation.
• OFDM6 — 802.11a/g OFDM 6Mbps operation.
mediaopt opts These drivers support the following media options:

devnp-ral.so, devnp-ural.so © 2010, QNX Software Systems GmbH & Co. KG.
• hostap — select Host AP operation.

• ibss — select IBSS operation.
• monitor — select monitor mode.
-mediaopt opts Disable the specified media options on the driver and return it to
the default mode of operation (BSS).
mode mode These drivers support the following modes:

• 11a — force 802.11a operation.
• 11b — force 802.11b operation.
• 11g — force 802.11g operation.
nwid id Set the network ID. The id can either be any text string up to 32
characters in length, or a series of hexadecimal digits up to 64
digits. An empty ID string (the default) allows the interface to
connect to any available access points. Note that network ID is
synonymous with Extended Service Set ID (ESSID).
nwkey key Enable WEP encryption using the specified key. The key can
either be a string, a series of hexadecimal digits (preceded by
0x), or a set of keys of the form n:k1,k2,k3,k4, where n specifies
which of the keys to use for transmitted packets, and the four
keys, k1 through k4, are configured as WEP keys. If a set of keys
is specified, a comma (,) within the key must be escaped with a
backslash.
If you use multiple keys, their order must be the same within the network. These
drivers can use both 40-bit (5 characters or 10 hexadecimal digits) or 104-bit (13
characters or 26 hexadecimal digits) keys.
-nwkey Disable WEP encryption. This is the default mode of operation.
/dev/io-net/ral0, use if_up -p ral0.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-rtl8169.so
Driver for Realtek 8169 Gigabit Ethernet controllers
Syntax:
io-pkt-variant -d rtl8169 [option[,option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX The PCI device ID.

IFT_ETHER.
iorange=0xXXXXXXXX
The I/O base address.
irq=num The IRQ of the interface.
mac=XXXXXXXXXXXX
The interface address of the controller. The default is

NIC_MEDIA_802_3.
mtu=num The maximum transmission unit. The default (1514) is

pci=0xXXXX The PCI index of the controller.

devnp-rtl8169.so © 2010, QNX Software Systems GmbH & Co. KG.
receive=num The number of Rx buffers to internally cache. The default is 5.
speed=10|100|1000
The media data rate in megabits/second.
transmit=num The number of Tx buffers to internally cache. The default is 10.
uptype=name The interface name. The default is en.
verbose
vid=0xXXXX The PCI vendor ID.
Description:
The devnp-rtl8169.so driver controls Realtek 8169 Gigabit Ethernet controllers.
This is a native io-pkt driver; its interface names are in the form rtX, where X is an
integer.
ifconfig enX
device supports.

© 2010, QNX Software Systems GmbH & Co. KG. devnp-rtl8169.so
/dev/io-net/rt0, use if_up -p rt0.
Examples:
Start io-pkt-v4 using the Realtek driver:
io-pkt-v4 -d rtl8169
ifconfig rt0 10.184
See also:

devnp-rum.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for USB 2.0 wireless adapters based on the Ralink RT2501USB and RT2601USB chipsets
Syntax:
io-pkt-variant -d rum ... &
Runs on:
Neutrino
Options:
None
Description:
The devnp-rum.so driver supports USB 2.0 wireless adapters based on the Ralink
RT2501USB and RT2601USB chipsets. This is a ported NetBSD driver; its interface
names are in the form rumX, where X is an integer.
The RT2501USB chipset is the second generation of 802.11a/b/g adapters from
Ralink. It consists of two integrated chips, an RT2571W MAC/BBP and an RT2528 or
RT5226 radio transceiver.
The RT2601USB chipset consists of two integrated chips, an RT2671 MAC/BBP and
an RT2527 or RT5225 radio transceiver. This chipset uses the MIMO (multiple-input
multiple-output) technology with multiple antennas to extend the operating range of
the adapter and to achieve higher throughput.
This driver can operate in the following modes:
BSS mode Also known as infrastructure mode, this is used when associating
with an access point, through which all traffic passes. This mode is
the default.
IBSS mode Also known as IEEE ad-hoc mode or peer-to-peer mode. This is
the standardized method of operating without an access point.
Stations associate with a service set. However, actual connections
between stations are peer-to-peer.
Host AP In this mode, the driver acts as an access point (base station) for
other cards.
Monitor mode In this mode, the driver is able to receive packets without
associating with an access point. This disables the internal receive
filter and enables the card to capture packets from networks which
it wouldn’t normally have access to, or to scan for access points.
The devnp-rum.so driver supports software WEP. Wired Equivalent Privacy (WEP)
is the de facto encryption standard for wireless networks. It can be typically

© 2010, QNX Software Systems GmbH & Co. KG. devnp-rum.so
configured in one of three modes: no encryption; 40-bit encryption; or 104-bit

encryption. Unfortunately, due to serious weaknesses in WEP protocol it is strongly
recommended that it not be used as the sole mechanism to secure wireless
communication. WEP is not enabled by default.
You can also use this driver in conjunction with wpa_supplicant to provide WPA /
WPA2 encryption.
You can use ifconfig to configure the devnp-rum.so driver at runtime:
bssid bssid Set the desired BSSID.
-bssid Unset the desired BSSID. The interface automatically selects a

BSSID in this mode, which is the default.
chan n Set the channel (radio frequency) to be used by the driver based
on the given channel ID n.
-chan Unset the desired channel to be used by the driver. The driver
automatically selects a channel in this mode, which is the
default.
media media This driver supports the following media types:

• autoselect — enable autoselection of the media type and
options.
• DS5 — 802.11b DS 5.5Mbps operation.
mediaopt opts This driver supports the following media options:

• hostap — select Host AP operation.
• ibss — select IBSS operation.
• monitor — select monitor mode.
-mediaopt opts Disable the specified media options on the driver and return it to
the default mode of operation (BSS).

devnp-rum.so © 2010, QNX Software Systems GmbH & Co. KG.
mode mode This driver supports the following modes:

• 11a — force 802.11a operation.
• 11b — force 802.11b operation.
• 11g — force 802.11g operation.
nwid id Set the network ID. The id can either be any text string up to 32
characters in length, or a series of hexadecimal digits up to 64
digits. An empty ID string (the default) allows the interface to
connect to any available access points. Note that network ID is
synonymous with Extended Service Set ID (ESSID).
nwkey key Enable WEP encryption using the specified key. The key can
either be a string, a series of hexadecimal digits (preceded by
0x), or a set of keys of the form n:k1,k2,k3,k4, where n specifies
which of the keys to use for transmitted packets, and the four
keys, k1 through k4, are configured as WEP keys. If a set of keys
is specified, a comma (,) within the key must be escaped with a
backslash.
If you use multiple keys, their order must be the same within the network. The
devnp-rum.so driver can use both 40-bit (5 characters or 10 hexadecimal digits) or
104-bit (13 characters or 26 hexadecimal digits) keys.
-nwkey Disable WEP encryption. This is the default mode of operation.
/dev/io-net/rum0, use if_up -p rum0.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devnp-shim.so
“Shim” driver for backward compatibility with io-net
Syntax:
io-pkt-variant -d shim "io-net_drvr [drvr_opt,...]"
Runs on:
Neutrino
Options:
None.
Description:
The devnp-shim.so shared object is a “shim” driver that lets io-pkt support
devn-* drivers that were written for io-net.
Explicitly loading the shim driver is usually unnecessary; io-pkt loads the shim
automatically. For example, if you type:
io-pkt -d some_driver
then io-pkt searches for devnp-some_driver.so and loads it as a native driver if

found. If not found, io-pkt tries to load devn-some_driver.so via the shim.
If you type:
io-pkt -d /lib/dll/devn-some_driver.so
then io-pkt notices that the driver is an io-net one and loads it via the shim.
• Shim drivers name their interface entries enX, but native drivers use a naming
scheme that depends on the chipset.
• You can tell if the shim has been loaded by using pidin me.
Examples:
io-pkt -d shim devn-speedo.so
io-pkt -d shim "/lib/dll/devn-speedo.so transmit=1024,receive=1024"
See also:

devnp-speedo.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Intel 82557, 82558, and 82559 Fast Ethernet LAN adapters
Syntax:
io-pkt-variant -d speedo [[index:option[,[index:option ...]] ... &
Runs on:
Neutrino
Options:
did=0xXXXX Device ID. Only attach to device with this PCI index. The default
is automatically detected on supported hardware.
detected on supported hardware. If you specify duplex, you
must also specify speed.
irq=num The IRQ of the interface. The default is automatically detected


mac=XXXXXXXXXXXX
mmap Use memory-mapped registers. The default is I/O mapped.
The mmap option is supported on all targets except x86.

pci=0xXXXX The PCI index of the controller. The default is automatically

speed=10|100 The media data rate (10 Mbit or 100 Mbit operation). The default
(0) is automatically detected on supported hardware. If you
specify speed, you must also specify duplex.

© 2010, QNX Software Systems GmbH & Co. KG. devnp-speedo.so
transmit=num The number of transmit descriptors; the default is 1024.
verbose
verbose=num Be verbose. Specify num for more verbosity (num can be 1-4; the
vid=0xXXXX Attach only to devices with this PCI vendor ID. The default is
0x8086.
Description:
The devnp-speedo.so driver manages the Intel 82557, 82558, and 82559 Fast
Ethernet LAN adapters. This is a native io-pkt driver; its interface names are in the
form fxpX, where X is an integer.
ifconfig fxpX
device supports.
/dev/io-net/fxp0, use if_up -p fxp0.
Examples:
Start io-pkt using the devnp-speedo.so driver and the full TCP/IP stack:
io-pkt -d speedo -p tcpip

ifconfig fxp0 10.1.0.184

devnp-speedo.so © 2010, QNX Software Systems GmbH & Co. KG.
For the second instance of the device in the system, start io-pkt using the
devnp-speedo.so driver and the full TCP/IP stack. Use increased verbosity and
override the default #MAC address:
io-pkt -d speedo verbose,idx1:mac=00:03:02:01:00:00 -p tcpip

ifconfig fxp0 10.1.0.184
See also:

© 2010, QNX Software Systems GmbH & Co. KG. devp-pccard
PCMCIA/CardBus (PC Card) server
Syntax:
devp-pccard [Card Services options] [ss Socket Services options]...
Runs on:
Neutrino
Options:
Card Services Options:
-a The ioport address to be assigned to a PCMCIA card. Use a colon (:) to

separate functions on multi-function cards. E.g. -a
0x300:0x320,0x340 will assign ioport 0x300 to function 1 in socket 0
and ioport 0x320 to function 2 in socket 0; ioport 0x340 will be
assigned to function 1 in socket 1.
-i irq The IRQ to be used for status interrupts. The default is no interrupts —
the adapter is polled every second for status changes (recommended).
-l (“el”) Override PCMCIA IRQ for socket(s). E.g. -l5 will assign IRQ 5
to the card in socket 0; -l5,7 will assign IRQ5 to the card in socket 0
and IRQ 7 to the card in socket 1.
-m Memory window address for reading CIS. (Default is 0xd4000)
-v Verbose output for debugging purposes.
-w Force the width for a PCMCIA socket (8 or 16 bits). E.g. -w8 will force
an 8-bit width for socket 0; -w16,8 will force a 16-bit width for socket 0
and an 8-bit width for socket 1. This is needed by some Ethernet
adapters that report themselves as 16-bit, but work only in 8-bit mode.
-x index Select the PCMCIA configuration index to use. Some PCMCIA cards
have multiple configuration indexes. This option can be used to select
one of them.
Socket Services Options:
-D Device ID Specify the PCI device ID to which devp-pccard must attach.

This option must be used in conjunction with the -V option.
-I index Specify the PCI index to which devp-pccard must attach.
-m Map ISA interrupts to PCI bus.

devp-pccard © 2010, QNX Software Systems GmbH & Co. KG.
-n Set hardware interrupt routing on PCI bus. Note: This may not
work with some BIOSes.
-p Set the IRQ mode (0 - 3) as follows:
Mode Sets
0 Parallel PCI interrupts only
1 Parallel IRQ and parallel PCI interrupts
2 IRQ serialized interrupts and parallel PCI interrupts
3 IRQ and PCI serialized interrupts
-r Value to set in multi-function routing register (chip specific).
-V Vendor ID Specify the PCI vendor ID to which devp-pccard must attach.

This option must be used in conjunction with the -D option.
-v Verbosity for socket services.
Description:
The devp-pccard server provides support under QNX Neutrino for PCMCIA and
CardBus host adapter chips. The host adapters chips currently supported are
(PCMCIA) Intel 82365, Cirrus CL-PD67xx, Vadem VG-46x, (CardBus) TI-11xx,
TI-12xx, and TI-14xx, Ricoh R5C47x, O2 Micro OZ68xx, and Toshiba Topic97. Other
CardBus adapters work only in legacy (PCMCIA) mode.
The server manages host resources (memory windows, I/O ports and IRQs) and
assigns resources to PCMCIA cards as they’re inserted. CardBus resources are
managed by the pci-bios server, which interfaces to the pccard server. The
devp-pccard server also supports dual-function PC Cards and assigns separate
resources to each function. The only common resource assigned to dual-function PC
Cards is the IRQ.
Utilities are provided to start and stop processes (as cards are inserted and removed),
display server status and display card CIS (Card Information Structure) data.
The executables involved in PC Card support are:
devp-pccard The server for PCMCIA and CardBus adapters.
pccard-launch A manager that starts and stops processes as cards are inserted
and removed.
pin A utility that displays PC Card information (CIS, status, and so

on).

© 2010, QNX Software Systems GmbH & Co. KG. devp-pccard
Resources and Server Configuration Files

The server manages separate resource pools for memory windows, IRQs and ports.
When a card is installed, the server attempts to satisfy the card’s memory window,
IRQ and port requirements by allocating resources from the various pools. PCMCIA
resources must be in the ISA range of devices, while CardBus resources must be in the
PCI range. PC Card resource pools are created as described below.
CardBus
CardBus resources are assigned by the pci-bios server, as all CardBus devices are
considered to be PCI devices. Some manufacturers’ PCI BIOSes allow separate IRQs
to be assigned to each socket on a CardBus adapter, while others allow only a single
IRQ for both sockets. When a CardBus PC Card is inserted in a socket, devp-pccard
requests the pci-bios server to rescan its bus and allocate resources to the card.
Examples:
Start devp-pccard and force the ioports to be used in each socket:
devp-pccard -a 0x300,0x340
Map IRQ interrupts to PCI and use IRQ 10:
devp-pccard -l10 ss -m
See also:
pccard-launch, pci-bios, pin

devu-ehci.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Enhanced Host Controller Interface (EHCI) USB controllers
Syntax:
io-usb -d ehci [option[,option...]] &
Runs on:
Neutrino
Targets:
x86, MIPS, ARM, PPC, and SH
Options:
int_thresh=num
Interrupt microframe threshold. Valid values are 1,2,4,8,16,32,64.
The default value is 8, which is a 1ms interrupt rate. The chip will
interrupt after a 1ms period (USB frame) if there are completed
transactions. Setting the value to 1 lets the chip interrupt after
125us (USB microframe) if there are completed transactions.
ioport=addr Register the base address. The default is to scan the PCI bus.
irq=num The interrupt request number.
nosmm Don’t disable system management. The default is to disable it.
num_ed=num The number of endpoint descriptors to preallocate.
num_td=num The number of transfer descriptors to preallocate.
pindex=num Instance of controller on PCI bus to apply argument.
verbose=num Set verbosity level.
Description:
The devu-ehci.so server provides support for computers that have Enhanced Host
Controller Interface (EHCI) USB controllers. This server creates the
/dev/io-usb/devu-ehci.so device.
Examples:
Scan PCI bus for all available controllers.
io-usb -dehci

© 2010, QNX Software Systems GmbH & Co. KG. devu-ehci.so
If you specify arguments you’ll need to include pindex arguments for all controllers
you wish to use. The value for the pindex argument should start from 0. Attach to the
1st and 3rd controller instance and set the verbose argument on the 1st, as follows:
io-usb -dehci pindex=0,verbose=4,pindex=2 &
See also:
devu-ohci.so, devu-uhci.so, io-usb, usb

devu-kbd © 2010, QNX Software Systems GmbH & Co. KG.
Class driver for USB keyboards (BOOT mode HID)
You must be logged in as root, and start a USB stack (see io-usb) before you start
this driver.
Syntax:
devu-kbd [options*] &
Runs on:
Neutrino
Options:
-n name The device name to use. The default is /dev/usbkbd0.
-s stack The name of the stack to attach to (default: /dev/io-usb/io-usb).
-v Be verbose.
-w secs Wait sec seconds for the USB stack (default: 60 seconds).
Description:
The devu-kbd class driver manages USB keyboards.
See devu-mouse for information on USB mice.
Examples:
devu-kbd &
See also:
io-usb, usb

© 2010, QNX Software Systems GmbH & Co. KG. devu-mouse
Class driver for USB mice (BOOT mode HID)
You must be logged in as root, and start a USB stack (see io-usb) before you start
this driver.
Syntax:
devu-mouse [options*] &
Runs on:
Neutrino
Options:
-n name The device name to use. The default is /dev/usbmouse0.
-s stack The name of the stack to attach to (default: /dev/io-usb/io-usb).
-v Be verbose.
-w secs Wait sec seconds for the USB stack (default: 60 seconds).
Description:
The devu-mouse class driver manages USB mice.
See devu-kbd for information on USB keyboards.
Examples:
devu-mouse &
See also:
io-usb, usb

devu-ohci.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Open Host Controller Interface (OHCI) USB controllers
Syntax:
io-usb -d ohci [option[,option...]] &
Runs on:
Neutrino
Targets:
Options:
ioport=addr Register the base address of the USB controller. The default is to
scan the PCI bus.
num_ed=num The number of endpoint descriptors to preallocate. The number
specified is added to the minimum number of endpoint
descriptors needed to set up the USB chip.
num_td=num The number of transfer descriptors to preallocate. The number
specified is added to the minimum number of transfer descriptors
needed to set up the USB chip.
verbose=num Set verbosity level.
Description:
The devu-ohci.so server provides support for computers that have Open Host
Controller Interface (OHCI) USB controllers. This server creates the
/dev/io-usb/devu-ohci.so device.
Examples:
io-usb -dohci
If you specify arguments you’ll need to include pindex arguments for all controllers
you wish to use. The value for the pindex argument should start from 0. Attach to the
1st and 3rd controller instance and set the verbose argument on the 1st, as follows:
io-usb -dohci pindex=0,verbose=4,pindex=2 &

© 2010, QNX Software Systems GmbH & Co. KG. devu-ohci.so
See also:
devu-ehci.so, devu-uhci.so, io-usb, usb

devu-prn © 2010, QNX Software Systems GmbH & Co. KG.
Class driver for USB printers
You must be logged in as root and start a USB stack (see io-usb) before you start
this driver.
Syntax:
devu-prn [-m size] [-n name] [-s stack] [-v] [-w secs] &
Runs on:
Neutrino
Targets:
ARM, MIPS, PPC, x86
Options:
-m size Specify the size, in bytes, of the maximum output buffer used to write
data to the USB stack. The default is 4096 bytes. Larger values may be
limited by the I/O buffer limits of the USB chipset you’re using.
-n name Set the device name. The default is /dev/usbpar0.
-s stack Set the USB stack name. The default is /dev/io-usb/io-usb.
-v Be verbose.
-w secs Wait up to the indicated number of seconds for /dev/stack to appear.

This is useful at boot time for slow-resetting devices. The default is 60
seconds.
Description:
The devu-prn class driver manages USB printers.
This manager terminates only upon receipt of a signal or on encountering a problem

during startup (e.g. it can’t locate the USB stack).
See devu-ohci.so or devu-uhci.so for information on USB stacks. For more

information on setting up USB printers, see the Connecting Hardware and Printing
chapters of the Neutrino User’s Guide.
Examples:
Start devu-prn with a maximum output buffer of 8192 bytes:
devu-prn -m 8192 &

© 2010, QNX Software Systems GmbH & Co. KG. devu-prn
See also:
devi-hid, devu-ohci.so, devu-uhci.so, io-usb, usb
Connecting Hardware and Printing in the Neutrino User’s Guide

devu-uhci.so © 2010, QNX Software Systems GmbH & Co. KG.
Driver for Universal Host Controller Interface (UHCI) USB controllers
Syntax:
io-usb -d uhci [option[,option...]] ... &
Runs on:
Neutrino
Targets:
Options:
ioport=addr Register the base address of the USB controller. The default is to
scan the PCI bus.
num_ed=num The number of endpoint descriptors to preallocate.
num_td=num The number of transfer descriptors to preallocate.
verbose=num Set verbosity.
Description:
The devu-uhci.so server provides support for computers that have Universal Host
Controller Interface (UHCI) USB controllers. This server creates the
/dev/io-usb/devu-uhci.so device.
Examples:
io-usb -duhci
If you specify arguments, you must include a pindex argument for all controllers you
wish to use. The value of the pindex argument starts from 0.
Attach to the 1st and 3rd controller instance and set the verbose argument on the 1st
controller instance as follows:
io-usb -duhci pindex=0,verbose=4,pindex=2 &

© 2010, QNX Software Systems GmbH & Co. KG. devu-uhci.so
See also:
devu-ehci.so, devu-ohci.so, io-usb, usb

df © 2010, QNX Software Systems GmbH & Co. KG.
Report free disk space (POSIX)
Syntax:
df [-ghknP] [device|directory|file]*
Runs on:
Neutrino
Options:
-g Display all statvfs() information.
-h Display the sizes in a “human-readable” form, using bytes, KB, MB, or GB as

the units.
-k Use 1024-byte units (the default is 512-byte).
-n Display the filesystem mountpoints and types only.
-P Display headings for the columns. (Output conforms to POSIX 1003.2/5.8.6.1

format.)
Description:
The df utility displays the amount of free disk space for the given devices, directories,
and files.
By default, df reports its figures in 512-byte units. If you specify the -k option, it uses
1024-byte units; if you specify -h, it uses bytes.
Any block counts reported by the filesystem are rounded into 512- or 1024-byte units,
and df always rounds down (i.e. to reflect whole blocks available). For a filesystem
that doesn’t use native 512-byte (or multiples thereof) blocks, this will result in
round-off errors.
Examples:
Display the sizes in 512-byte units:
$ df -P
Filesystem 512-blocks Used Available Capacity Mounted on
/dev/hd0t178 37190440 4378680 32811760 12% /
/dev/hd0t177 122881088 4198452 118682636 4% /fs/hd0-qnx6-2/
/dev/cd0 0 0 0 100% (/fs/cd0/)
/dev/hd0 160086528 160086528 0 100%
Display the sizes in 1024-byte units:

$ df -kP
Filesystem 1024-blocks Used Available Capacity Mounted on
/dev/hd0t178 18595220 2189340 16405880 12% /
/dev/hd0t177 61440544 2099226 59341318 4% /fs/hd0-qnx6-2/
/dev/cd0 0 0 0 100% (/fs/cd0/)
/dev/hd0 80043264 80043264 0 100%

© 2010, QNX Software Systems GmbH & Co. KG. df
Display the sizes in bytes:

$ df -hP
Filesystem Size Used Available Capacity Mounted on
/dev/hd0t178 18G 2.0G 16G 12% /
/dev/hd0t177 59G 2.0G 57G 4% /fs/hd0-qnx6-2/
/dev/cd0 0 0 0 100% (/fs/cd0/)
/dev/hd0 76G 76G 0 100%
See also:
statvfs() in the QNX Neutrino Library Reference

dhcp.client © 2010, QNX Software Systems GmbH & Co. KG.
TCP/IP host configuration utility
Syntax:
dhcp.client [-abdmnR] [-A num] [-D ident] [-h hostname]
[-I num] [-i interface]
[-P port] [-p port] [-s host]
[-T secs] [-t num] [-u] &
Runs on:
Neutrino
Options:
-A num The dhcp.client declines addresses if they fail an ARP probe
(see RFC 2131 and RFC 5227). This option sets the number of
consecutive ARP probe tests of the assigned address that can fail
before dhcp.client gives up. The default is 5; a value of 0 turns
off ARP probing.
-a Apply the assigned IP address as an alias instead of overwriting the

current configuration.
-b Request the DHCP server to send its response packets only to the
client where appropriate (default is to request the server to
broadcast).
-D ident Specify the client identifier. The default identifier is the MAC
address.
-d Write debugging info to the system log.
-h hostname Hostname of client (default is supplied by the server if the hostname

is available). If you set the ID for a DHCP connection in phlip,
that value is passed to dhcp.client with this option.
-I num The number of times to poll waiting for interface to be available

(default 5). Polling is done every 2 seconds.
You can use this option to make dhcp.client wait until the
interface it’s to use is available. This is useful in a boot environment
when you might not know when the driver is running and registered
with the TCPIP stack. The exit status is 2 if no interface is found.
-i interface Name of the interface to configure (e.g. en0, en1). The default is
the first interface found.

© 2010, QNX Software Systems GmbH & Co. KG. dhcp.client
-m Instead of writing the domain and nameserver data to

/etc/resolv.conf (the default), write the data to the
_CS_DOMAIN and _CS_RESOLVE memory configuration-defined
values (see confstr() in the Neutrino Library Reference):
_CS_DOMAIN Domain name.

_CS_RESOLVE Nameserver.
If you specify -m and -n together, the domain is added, but the

nameservers aren’t.
-n Don’t add the DHCP-supplied nameservers to /etc/resolv.conf

or _CS_RESOLVE. If you also specify -m, the domain is added, but
the nameservers aren’t. If you don’t specify -m, neither the domain
nor the nameservers are added.
-P port DHCP server port (default is dhcp port or port 67).
-p port DHCP client port (default is dhcpc port or port 68).
-R Don’t apply the DHCP-supplied default route. If you specify this

option, the default route supplied by the DHCP server isn’t applied,
but it’s still supplied to the dhcp-up script (see below) in case you
wish to apply it later.
-s host Accept packets from this server only; ignore responses from other
servers. If you set the Server IP for a DHCP connection in phlip,
that IP address is passed to dhcp.client with this option.
-T sec Specify the time, in seconds, to wait for the client to complete
(server ACK) its negotiation with the server. This is applied every
time the client returns to the initialize (DISCOVER) state. If a
timeout occurs, dhcp.client terminates with an exit status of 3.
-t num Attempt to reach the server num times before giving up and
terminating (the default is forever). Each attempt lasts 1 minute.
You’re likely to use this option in combination with the -u option so
that dhcp.client times out after a specified number of attempts.
-u Don’t move dhcp.client to the background until the interface is

configured.
This option is useful for spawning dhcp.client. The process
doesn’t move to the background until it has contacted a server and
applied a TCP/IP configuration. The exit status is 3 if no server
responds.

Description:
The dhcp.client obtains the TCP/IP configuration parameters dynamically from a
DHCP (Dynamic Host Configuration Protocol) server, then automatically configures
your TCP/IP host. You don’t have to provide an IP address or any configuration
parameters, or run any configuration utilities.
In a self-hosted QNX Neutrino system, dhcp.client is typically started by
netmanager; you can use phlip to specify the ID and server IP address.
If dhcp.client is terminated, it releases the DHCP address assigned by the server

back to the server. If the client is terminated with SIGPWR, the address isn’t released;
the lease will timeout or be continued at client restart (depending on server policies).
You must start io-pkt* before starting dhcp.client.
The minimum commands to run under QNX Neutrino are:
io-pkt-v4 -dne2000 -ptcpip

if_up -p enx
dhcp.client &
if_up enx
Or:
io-pkt-v4 -dne2000 -ptcpip

dhcp.client -Ix -u
If you wish dhcp.client to apply the IP address as an alias instead of overwriting
the currently assigned IP address, you must pass the -a option. This option is useful if
you wish to assign multiple IP addresses to an interface. You must pass the -a option
if you wish to use dhcp.client and AutoIP (lsm-autoip.so) on the same
interface.
By default, dhcp.client searches for an unconfigured interface to provide service.
If AutoIP is in use, an unconfigured interface will not be available, and the
dhcp.client will terminate. In order for dhcp.client to provide service to an
interface that already has an IP address assigned to it, use the -i option (in
combination with -a), and the interface will have both a DHCP and AutoIP IP address
assigned to it.
This utility obtains and implements the following information from the DHCP server:
• Broadcast address
• Domain

• Gateway (default route)
• Hostname
• IP address
• Nameserver
• Netmask
/etc/dhcp/dhcp-up
If this file exists, it is run after a DHCP server has been contacted and the
configuration options above have been applied. This file can be a binary program or a
script and must be executable (see chmod). If the file is a script, the first line must be
the command interpreter. For example:
#!/bin/sh
Environment variables, which contain the configuration that was obtained from the
server, are passed to this file. When the file is spawned, it doesn’t inherit the full
environment. For example, the PATH environment variable isn’t available. To
determine which variables are available, you can create a dhcp-up script like this:
#!/bin/sh
env > /tmp/config
The environment definitions are:
INTERFACE The interface that was configured (e.g. INTERFACE=en0).
IPADDRESS The client IP address that was obtained from the server (e.g.
IPADDRESS=10.0.0.1).
NETMASK The client netmask that was obtained from the server (e.g.
NETMASK=255.0.0.0).
HOSTNAME The hostname of the client (e.g. HOSTNAME=node1).
BROADCAST The client broadcast address that was obtained from the server
(e.g. BROADCAST=10.255.255.255).
GATEWAY The gateway that the client is to use (e.g.

GATEWAY=10.0.0.2).
SERVER The DHCP server’s ID (IP address) (e.g. SERVER=10.0.0.3).
NAMESERVER1,
NAMESERVER2 The nameserver that the client is to use (e.g.
NAMESERVER1=10.0.0.4).

LEASEOBTAINED
The time at which the lease was obtained (e.g.
LEASEOBTAINED=Mon Oct 30 16:46:10 2000).
LEASEEXPIRES The time at which the lease expires (e.g. LEASEEXPIRES=Mon

Oct 31 16:46:10 2000).
RELAYAGENT A DHCP relay agent forwards packets between dhcp.client

and the DHCP server if they’re on different networks. This is
the IP address of the relay agent if it’s present.
SERVERNAME The hostname of the DHCP server.
DOMAIN The domain supplied by the DHCP server to be added to

/etc/resolv.conf or CS_DOMAIN (configuration string).
SIADDR The next server to use in bootstrap. If a FILENAME was

supplied, it would be obtained from this server.
The following options are available but not applied by the dhcp.client process:
FILENAME The filename supplied in the server response (e.g.

FILENAME=/bootimg).
Any other options are defined as environment variables OPTIONx, where x is the
option number. If the option is known, dhcp.client tries to format it as readable
information. If the option isn’t known, dhcp.client displays each octet as
hexadecimal (e.g. OPTION200= F1 AA 56 42).
Currently, dhcp.client is aware of options 1 to 61.
/etc/dhcp/dhcp-options
This file defines the DHCP options that the client wishes to obtain from the DHCP
server. You need this file only if you’re adding custom DHCP option handling to the
/etc/dhcp/dhcp-up file. If you add code to the dhcp-up script to handle an
option, you must also add this option to /etc/dhcp/dhcp-options. The options
listed in dhcp-options file are sent to the server in addition to the options:
• 1 — subnet mask
• 6 — domain name servers
• 12 — hostname
• 15 — domain name
• 3 — gateway
• 28 — broadcast address

which the dhcp.client process itself includes.

Here’s an example of the dhcp-options file:
200
150
#This is a comment
90
Specify each option on its own line, listing them in order of priority. Comments must
be on a separate line; they can be up to 80 characters long.
Files:
The dhcp.client utility requires the libsocket.so shared library.
Exit status:
0 Success.
1 An error occurred.
2 No interface was found.
3 No server responded.
Errors:
Errors that occur during configuration are reported to the system log.
See also:
dhcp.client, dhcpd, /var/state/dhcp/dhcpd.leases, /etc/dhcpd.conf,
io-pkt*, lsm-autoip.so, netmanager, phlip, syslogd
Based on RFC 2131

dhcpd © 2010, QNX Software Systems GmbH & Co. KG.
Dynamic Host Configuration Protocol (DHCP) server
Syntax:
dhcpd [options...] &
Runs on:
QNX Neutrino
Options:
-a Apply the assigned IP address as an alias instead of overwriting the
current configuration.
-b Request the DHCP server to broadcast its response packets to the

client where appropriate. The default is off.
-D ident Specify the client identifier. The default identifier is the MAC
address.
-d Debug option. Do not move to the background and log to stderr. The
default logs errors to syslogd.
-h hostname The host name of the client. The default is supplied by server if
available.
-I num The number of times to poll waiting for the interface to become
available. Polls every 2 seconds (default 5).
-i interface The name of the interface to configure. The default is the first
interface found.
-m Write resolv.conf data as in-memory configuration strings

(Neutrino only; the default is off.)
-n Don’t apply DHCP-supplied nameservers.
-P port Specify the server port. The default is the dhcp port or port 67.
-p port Specify the client port. The default is the dhcpc port or port 68.
-r Add .node_number to the resolv.conf file name. Off by default.
-s host Specify the preferred server; accept packets only from this server.
-T sec Specify in seconds the time to wait for the client to complete (server
ACK) its negotiation with the server. This is applied every time the
client returns to the initialize (DISCOVER) state. The
dhcp.client terminates on timeout with exit status 3.

© 2010, QNX Software Systems GmbH & Co. KG. dhcpd
-t num Attempt to reach the server num times before giving up and
terminating. Each attempt lasts 1 minute. The default is to attempt
forever.
-u Don’t move to the background until the interface is configured.
Description:
The dhcpd utility normally runs as a daemon in the background. It responds to
requests for IP addresses and network information from clients on a TCP/IP network.
The utility uses Dynamic Host Configuration Protocol (DHCP) or, with some
restrictions, the Internet Bootstrap Protocol (BOOTP).
In order to support multiple interfaces, you should use io-pkt* with the
reuseport_unicast option.
IP addresses are obtained from a list kept in /etc/dhcpd.conf, the DHCP

configuration file. Editing this file enables a network administrator to assign static
configuration to known hosts and dynamic configuration to unknown hosts added to
the network. For more information on the contents of this file, see
/etc/dhcpd.conf.
On startup, dhcpd reads the /etc/dhcpd.conf file and stores a list of available
addresses on each subnet in memory. When a client requests an address using the
DHCP protocol, dhcpd allocates an address from this list.
When dhcpd assigns an IP address to a client, it stores the details (e.g. expiry time) in
the /var/state/dhcp/dhcpd.leases file. Before you start DHCP for the first
time, you must create this file:
# touch /var/state/dhcp/dhcpd.leases
For more information on the makeup of the leases file, see

/var/state/dhcp/dhcpd.leases.
Under DHCP, after the lease has expired, dhcpd reclaims the IP address by adding it
to the /etc/dhcpd.conf list.
BOOTP, however, does not allow for an associated lease expiry time, so you may have
to reclaim expired BOOTP IP address leases yourself. The DHCP configuration file
provides two parameter statements that may help you get around this problem:
• dynamic-bootp-lease-cutoff date;
• dynamic-bootp-lease-length length;
For more information, see the Parameter statements section in /etc/dhcpd.conf.

If you do change anything in /etc/dhcpd.conf, remember to restart dhcpd (the

/var/run/dhcpd.pid file contains the PID of dhcpd).
OMAPI
The DHCP server lets you modify some of its configuration while it’s running.
Without stopping the server, you can modify database files, and then restart it. This
capability is currently provided using OMAPI — an API for manipulating remote
objects. OMAPI clients connect to the server using TCP/IP, authenticate, and can then
examine the server’s current status and make changes to it.
Rather than implement the underlying OMAPI protocol directly, your programs
should use the dhcpctl() API or OMAPI (API) itself. The dhcpctl() is a wrapper that
handles some of the housekeeping chores that OMAPI doesn’t do automatically.
OMAPI exports objects, which can then be examined and modified. The DHCP server
exports the following objects: lease, host, failover-state, and group. Each object has a
number of methods: lookup, create, and destroy. In addition, it’s possible to look at
attributes that are stored on objects, and in some cases to modify those attributes.
Lease object
Leases can’t be created or destroyed, but you can examine and modify their state.
Leases have the following attributes:
state integer lookup, examine

1 Free.
2 Active.
3 Expired.
4 Released.
5 Abandoned.
6 Reset.
7 Backup.
8 Reserved.
9 Bootp.
ip-address data lookup, examine

IP address of the lease.
dhcp-client-identifier data lookup, examine, update
Client identifier that the client used when it acquired the lease.
Not all clients send client identifiers, so this may be empty.
client-hostname data examine, update
Value the client sent in the host-name option.

host handle examine Host declaration associated with this lease, if any acquired its
lease.
hardware-type integer examine, update
Type of network interface that the client reported when it
acquired its lease.
ends time examine Time when the lease’s current state ends, as understood by the
client.
tstp time examine Time when the lease’s current state ends, as understood by the
server.
tsfp time examine Time when the lease’s current state ends, as understood by the
failover peer (if there is no failover peer, this value is
undefined).
cltt time examine Time of the last transaction with the client on this lease.
Host object
Hosts can be created, destroyed, looked up, examined, and modified. If a host
declaration is created or deleted using OMAPI, that information is recorded in the
dhcpd.leases file. You can delete host declarations that are declared in the
dhcpd.conf file.
Hosts have the following attributes:
name data lookup, examine, modify

The name of the host declaration. This name must be unique among all host
declarations.
group handle examine, modify
The named group associated with the host declaration, if there is one.
hardware-address data lookup, examine, modify

The link-layer address that’ll be used to match the client, if any. Valid only if
hardware-type is also present.
hardware-type integer lookup, examine, modify

The type of the network interface that will be used to match the client,if any.
Only valid if hardware-address is also present.
dhcp-client-identifier data lookup, examine, modify

The dhcp-client-identifier option to use to match the client, if any.
ip-address data examine, modify
The fixed IP address that’s reserved for a DHCP client that matches this host
declaration.

Named groups can be created, destroyed, looked up, examined and modified. If a
group declaration is created or deleted using OMAPI, that information will be
recorded in the dhcpd.leases file. You can delete group declarations that are
declared in the dhcpd.conf file.
Named groups currently can be associated only with hosts — this lets you attach set of
statements efficiently to more than one host declaration.
Groups have the following attributes:
name data Name of the group. All groups that are created using OMAPI
must have names; the names must be unique among all groups.
statements data List of statements in the format of the dhcpd.conf file that will
be executed whenever a message from a client whose host
declaration references this group is processed.
Control object
The control object allows you to shut the server down. If the server is doing failover
with another peer, it’ll make a clean transition into the shutdown state and notify its
peer, so that the peer can go into partner down, and then record the “recover” state in
the lease file so that when the server is restarted, it’ll automatically resynchronize with
its peer.
On shutdown, the server will also attempt to cleanly shut down all OMAPI
connections. If these connections don’t go down cleanly after five seconds, they are
shut down preemptively. It can take as much as 25 seconds from the beginning of the
shutdown process to the time that the server actually exits.
To shut the server down, open its control object and set the state attribute to 2.
Failover-state object
The failover-state object tracks the state of the failover protocol as it’s being managed
for a given failover peer. The failover object has the following attributes (please also
see the description for the dhcpd.conf file)
name data examine

Indicates the name of the failover peer relationship, as described in the server’s
dhcpd.conf file.
partner-address data examine
Indicates the failover partner’s IP address.
local-address data examine
Indicates the IP address that’s being used by the DHCP server for the failover
peer.
mclt integer examine
Indicates the maximum client lead time in this failover relationship.

load-balance-max-secs integer examine

Indicates the maximum value for the seconds field in a client request before load
balancing is bypassed.
load-balance-hba data examine

Indicates the load balancing hash bucket array for this failover relationship.
local-state integer examine, modify

Indicates the present state of the DHCP server in this failover relationship.
Possible values for state are:
1 Partner down.
2 Normal.
3 Communications interrupted.
4 Resolution interrupted.
5 Potential conflict.
6 Recover.
7 Recover done.
8 Shutdown.
9 Paused.
10 Startup.
11 Recover wait.
In general it isn’t a good idea to change this state. However, in the case that the
failover partner is known to be down, it can be useful to set the DHCP server’s
failover state to partner down. At this point the DHCP server will take over
service of the failover partner’s leases as soon as possible, and will give out
normal leases, not leases that are restricted by MCLT. If you do put the DHCP
server into the partner-down state when the other DHCP server is not in that
state, but isn’t reachable, IP address assignment conflicts are possible, even
likely. Once a server has been put into partner-down mode, its failover partner
must not be brought back online until communication is possible between the
two servers.
partner-state integer examine
Indicates the present state of the failover partner.
local-stos integer examine

Indicates the time at which the DHCP server entered its present state in this
failover relationship.
partner-stos integer examine

Indicates the time at which the failover partner entered its present state.

skew integer examine

Indicates the skew between the failover partner’s clock and this DHCP server’s
clock.
max-response-delay integer examine
Indicates the time in seconds after which, if no message is received from the
failover partner, the partner is assumed to be out of communication.
cur-unacked-updates integer examine

Indicates the number of update messages that have been received from the
failover partner but not yet processed.
Examples:
Start dhcpd using defaults:
dhcpd &
Start dhcpd listening on one interface:
dhcpd -i en0
Files:
/etc/dhcpd.conf
Default configuration file.
/var/state/dhcp/dhcpd.leases
Contains information about leases.
/var/run/dhcpd.pid
Contain the PID number of the currently running dhcpd.
/var/lib/dhcp/dhcpd.leases˜
Backup of dhcpd.leases file.
Errors:
When an error occurs, dhcpd sends a description of the error to syslogd and stderr,
if dhcpd is running in the foreground.
Ted Lemon in cooperation with Vixie Enterprises.

License:
This utility is based on copyright software of The Internet Software Consortium; for
licensing information, see the Third Party License Terms List at
See also:
dhcp.client, /var/state/dhcp/dhcpd.leases, /etc/dhcpd.conf,
dhcprelay, syslogd
Based on RFC2131, RFC2132

/etc/dhcpd.conf © 2010, QNX Software Systems GmbH & Co. KG.
Specify DHCP configuration details
Name:
/etc/dhcpd.conf
Description:
The dhcpd.conf file is a free-form ASCII text file containing a list of statements that
dhcpd uses for DHCP configuration.
File format
To create a dhcpd.conf file, you enter a scope keyword first, followed by a pair of
braces ({}) enclosing the parameter and declaration statements that apply within that
scope. If there is no preceding scope keyword, the statement applies globally.
Scope
The following keywords define the scope for following statements:
• global (default)
• shared-network
• subnet
• group
• host
The group keyword is unusual in that it may be located anywhere under global. Thus
groups may contain shared-networks and subnets, as well as hosts.
The order of precedence for parameters is in reverse hierarchical order: that is from
the specific to the general. If a parameter for a machine is specified in the host section
and a different parameter is specified for the same machine in the subnet section, the
value in the host section applies. We’ll explain the scope keywords in this order of
precedence.
host keyword
The host keyword signifies that any following statements are to be applied to a
unique host machine on the network.
There must be at least one host statement for every BOOTP client that is to be served.
host statements may also be specified for DHCP clients, although this is not required
unless booting is enabled for known hosts only.
If it is desirable to be able to boot a DHCP or BOOTP client on more than one subnet
with fixed addresses, more than one address may be specified in the fixed-address
parameter, or more than one host statement may be specified.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/dhcpd.conf
If client-specific boot parameters must change based on the network to which the
client is attached, then multiple host statements should be used.
If you want to allocate a dynamic address only when it is not possible to boot with a
fixed address, a host statement must be specified without a fixed-address clause.
The host declarations are matched to actual DHCP or BOOTP clients by matching
the dhcp-client-identifier option specified in the host declaration to the one
supplied by the client, or, if the host declaration or the client does not provide a
dhcp-client-identifier option, by matching the hardware parameter in the
host declaration to the network hardware address supplied by the client. BOOTP
clients do not normally provide a dhcp-client-identifier, so the hardware
address must be used for all clients that may boot using the BOOTP protocol.
You declare a host statement like this:
host name{
[ parameters ]
[ declarations ]
}
where name is a unique host name (for an example and restrictions on use, see the
entry for use-host-decl-names flag; in the section on Parameter statements,
below)
Examples of parameters that might be assigned a value under a typical host scope are:
• hardware
• fixed-address
• filename
• server-name
group keyword
The group scope may include individual hosts, shared networks, subnets, or even
other groups.
If some machines on a subnet share common parameters but others don’t, you might
want to create a group scope to cover the similar machines without having to treat
them as a separate subnet. You do this by using the group keyword. All of the options
included within the group scope declaration apply to that group. As with subnets, this
scope can also specify individual hosts with the group.
For example, you may want to provide a large set of addresses for DHCP clients that
are registered to your DHCP server, while providing a smaller set of addresses,
possibly with shorter lease times, for unknown clients. Or, if you have a firewall, you
may be able to arrange for addresses from one group to be allowed access to the
Internet, while addresses in another group are not; thus encouraging users to register
their DHCP clients.

Within either the group or subnet declarations, you can specify parameters for
individual hosts, just as when the hosts are part of a shared network.
You can also vary the facilities afforded to members of the same group by partitioning
them within the group, like this:
group{
default-lease-time 100000;
option routers 192.168.42.1;
host fantasia { hardware ethernet 08:00:07:26:c0:a5; }
host passacaglia { hardware ethernet 0:0:c0:5d:bd:95; }
host confusia {
hardware ethernet 02:03:04:05:06:07;
}
}
All three machines in this group share the same router but, while leases for fantasia
and passacaglia last for 100,000 seconds, confusia enjoys a 200,000-second
lease.
subnet keyword
For every subnet that will be served, and for every subnet to which the DHCP server is
connected, there must be subnet declarations that tell dhcpd how to recognize that
an address is on that subnet. A subnet declaration is required for each subnet, even if
no addresses will be dynamically allocated on that subnet.
If clients on a subnet are to be assigned addresses dynamically, a range declaration
must appear within the subnet declaration. The range statement contains the pool of
IP addresses that can be allocated on this subnet. For clients with statically assigned
addresses, or for installations where only known clients will be served, each such
client must have a host declaration.
If parameters are to be applied to a group of declarations which are not related strictly
on a per-subnet basis, the group declaration can be used.
Any subnets in a shared network should be declared within a shared-network
statement.
Here’s what a subnet statement looks like:
subnet subnet-number netmask netmask-number{
[ parameters ]
[ declarations ]
}
The subnet-number variable should be an IP address or domain name that resolves to

the subnet number of the subnet being described. The netmask-number variable
should be an IP address or domain name which is applied to the subnet-number to
determine the subnet address. The subnet-number and netmask-number are used
together to determine whether any given IP address is on the specified subnet.
Although a netmask must be given with every subnet statement, if a site has different
subnet masks, you should include a subnet-mask option statement in the declaration

for each subnet to set the desired subnet mask (see Standard DHCP option statements,
below). Any such subnet-mask option statement overrides the netmask declared in
the top line of the subnet statement.
When a subnet becomes a shared network
Some installations have physical networks on which more than one IP subnet operates.
For example, if there is a site-wide requirement that 8-bit subnet masks be used, but a
department with a single physical Ethernet network expands to the point where it has
more than 254 nodes, it may be necessary to run two 8-bit subnets on the same
Ethernet until such time as a new physical network can be added. In this case, the
subnet declarations for these two networks must be enclosed in a shared-network
declaration.
For clients on more than one subnet
Some sites may have departments that have clients on more than one subnet, but you
might want to offer clients in the same department a uniform set of parameters,
regardless of the subnet they are on. For clients which will be declared explicitly with
host declarations, these declarations can be enclosed in a group declaration along with
the parameters which are common to that department.
shared-network keyword
Shared networks are separate networks that use the same physical network segment.
Uses include things like restricting certain device types to specific segments or
separating machines before moving them to a different network segment.
A shared-network can contain any combination of subnets, groups, and hosts.
You must declare all the subnets in a shared network within a shared-network
statement. Clients on these subnets are booted using the parameters specified in the
shared-network statement, unless parameters provided at the subnet or host level
override them. If any subnet in a shared network has addresses available for dynamic
allocation, those addresses are collected into a common pool for that shared network
and assigned to clients as needed. There is no way to distinguish on which subnet of a
shared network a client should boot.
The syntax for a shared-network statement is:
shared-network name {
[ parameters ]
[ declarations ]
}
You can use a valid domain name for name, but as this variable is used only when
printing debugging messages, you might want to use descriptive text (enclosed in
quotes) instead.

global keyword
The global keyword may be used on its own or inside lower scope declarations, like
subnet or group. It denotes that any following statements are to be applied globally,
either within another scope or on the whole network. Normally, the global keyword
is omitted because it is the default.
Statements
Statements cover:
• ranges
• permissions (allow and deny)
• parameters
• DHCP options to be passed to the client
Range statements
The range statement specifies the IP addresses that may be allocated to clients within
a defined scope.
For any subnet on which addresses will be assigned dynamically, there must be at least
one range statement. The range statement gives the lowest and highest IP addresses
in a range. All IP addresses in the range should be in the subnet in which the range
statement is declared. The dynamic-bootp flag may be specified if addresses in the
specified range may be dynamically assigned to BOOTP clients as well as DHCP
clients. Here’s the syntax for the range statement:
range [ dynamic-bootp ] low-address [ high-address];
When specifying a single address, the high-address variable may be omitted.
Permission statements
Allow and deny statements can be used to control the response of the DHCP server to
various sorts of requests. The allow and deny keywords have different meanings
depending on context. In a pool context, these keywords can be used to set up access
lists for address allocation pools. In other contexts, the keywords simply control
general server behavior with respect to clients, based on scope.
The following declarations work in any scope, although you shouldn’t use them in
group declarations.
allow|deny unknown-clients;
The unknown-clients flag tells dhcpd whether or not to dynamically assign
addresses to unknown clients. The default is allow. (An unknown client is
simply a client that has no host declaration.)
allow|deny bootp;
The bootp flag tells dhcpd whether or not to respond to BOOTP queries. The
default is allow.

allow|deny booting;
The booting flag is used to tell dhcpd whether or not to respond to queries from
a particular client. This keyword only has meaning when it appears in a host
declaration. By default, booting is allowed, but if it is disabled for a particular
client, then that client will not be able to get an address from the DHCP server.
Parameter statements
always-reply-rfc1048 flag;
Some BOOTP clients expect RFC1048-style responses, but do not
follow RFC1048 when sending their requests. You can tell that a
client is having this problem if it is not getting the options you have
configured for it and if you see in the server log the message “(non
rfc1048)” printed with each BOOTREQUEST that is logged.
If you want to send rfc1048 options to such a client, you can set the
always-reply-rfc1048 option in that client’s host declaration, and
the DHCP server will respond with an RFC-1048-style vendor options
field. This flag can be set in any scope, and will affect all clients
covered by that scope.
authoritative; or not authoritative;

The DHCP server will normally assume that the configuration
information about a given network segment is not known to be correct
and is not authoritative. This is so that if you install a DHCP server
while not fully understanding how to configure it, the server does not
send spurious DHCPNAK messages to clients that have obtained
addresses from a legitimate DHCP server on the network.
When setting up authoritative DHCP servers for your networks,
always write:
authoritative;
at the top of your configuration file to indicate that the DHCP server
should send DHCPNAK messages to misconfigured clients. If you
don’t do this, clients who change subnets will be unable to get a
correct IP address until their old lease has expired, which could take
quite a long time.
If you want to set up a DHCP server so that it is aware of some
networks for which it is authoritative and some networks for which it
is not, you could declare authority on a per-network-segment basis.

Note that the most specific scope for which the concept of authority makes any sense
is the physical network segment: either a shared-network statement or a subnet
statement that is not contained within a shared-network statement. It is not meaningful
to specify that the server is authoritative for some subnets within a shared network, but
not authoritative for others, nor is it meaningful to specify that the server is
authoritative for some host declarations and not others.
boot-unknown-clients flag;
If the boot-unknown-clients statement is present and flag has a value
of false or off, then clients for which there is no host declaration will
not be allowed to obtain IP addresses. If this statement is not present
or has a flag value of true or on, then clients without host declarations
will be allowed to obtain IP addresses, as long as those addresses are
not restricted by allow and deny statements within their pool
declarations.
default-lease-time time;
The time variable is the length in seconds that will be assigned to a
lease if the client requesting the lease does not ask for a specific
expiration time.
dynamic-bootp-lease-cutoff date;
This statement sets the ending time for all leases assigned
dynamically to BOOTP clients. Because BOOTP clients do not have
any way of renewing leases, and don’t know that their leases could
expire, by default dhcpd assigns infinite leases to all BOOTP clients.
However, it may make sense in some situations to set a cutoff date for
all BOOTP leases for example, the end of a school term, or the time at
night when a facility is closed and all machines are required to be
powered off.
The date variable is the date on which all assigned BOOTP leases will
end . The date is specified in the form:
W YYYY/MM/DD HH:MM:SS
Where W is the day of the week expressed as a number from zero

(Sunday) to six (Saturday). YYYY is the year, including the century. MM
is the month expressed as a number from 1 to 12. DD is the day of the
month, counting from 1. HH is the hour, from zero to 23. MM is the
minute and SS is the second. The time is always in Universal
Coordinated Time (UTC), not local time.
dynamic-bootp-lease-length length;
This statement sets the duration time for leases dynamically assigned
to BOOTP clients. At some sites, it may be possible to assume that a
lease is no longer in use if its holder has not used BOOTP or DHCP to
get its address within a certain time period. The period is specified in

length as a number of seconds. If a client reboots using BOOTP

during the timeout period, the lease duration is reset to length, so a
BOOTP client that boots frequently enough will never lose its lease.
Be very careful when adjusting length.
filename filename;
This statement can be used to specify the name of the initial boot file
that is to be loaded by a client. The filename should be a filename
recognizable to whatever file transfer protocol the client can be
expected to use to load the file.
fixed-address address[, address ... ];

This statement assigns one or more fixed IP addresses to a client. It
should only appear in a host declaration. If more than one address is
supplied when the client boots, it will be assigned the address which
corresponds to the network on which it is booting. If none of the
addresses in the fixed-address statement are on the network on which
the client is booting, that client will not match the host declaration
containing that fixed-address statement. Each address should be either
an IP address or a domain name which resolves to one or more IP
addresses.
get-lease-hostnames flag;
The get-lease-hostnames statement tells dhcpd whether or not
to look up the domain name corresponding to the IP address of each
address in the lease pool and use that address for the DHCP hostname
option. If flag is true, this lookup is done for all addresses in the
current scope. By default, or if flag is false, no lookups are done.
hardware hardware-type hardware-address;

In order for a BOOTP client to be recognized, its network hardware
address must be declared using a hardware clause in the host
statement. The hardware-type variable must be the name of a physical
hardware interface type. Currently, only the Ethernet type is
recognized. The hardware-address variable should be a set of
hexadecimal octets (numbers from 0 through ff) separated by colons.
The hardware statement may also be used for DHCP clients.
max-lease-time time;
The time variable is the maximum time in seconds that will be
assigned to a lease. The only exception to this is that Dynamic
BOOTP lease lengths, which are not specified by the client.
next-server server-name;
This statement specifies the host address of the server from which the
initial boot file (specified in the filename statement) is to be loaded.
The server-name variable is a numeric IP address or a domain name.

If no next-server parameter applies to a given client, the DHCP

server’s IP address is used.
one-lease-per-client flag;
If flag is enabled, whenever a client sends a DHCPREQUEST for a
particular lease, the server will automatically free any other leases the
client holds. This presumes that when the client sends a
DHCPREQUEST, it has forgotten any lease not mentioned in the
DHCPREQUEST: i.e. the client has only a single network interface
and it does not remember leases it’s holding on networks to which it is
not currently attached. Neither of these assumptions are guaranteed or
provable, so we urge caution in the use of this statement.
ping flag; When the DHCP server is considering dynamically allocating an IP

address to a client, it first sends an ICMP Echo request (a ping) to the
address being assigned. It waits for a second, and if no ICMP Echo
response has been heard, it assigns the address. If a response is heard,
the lease is abandoned, and the server does not respond to the client.
This flag is always true, it can’t be turned off.
server-identifier hostname;
This statement defines the value that is sent in the DHCP Server
Identifier option for a given scope. The hostname value must be an IP
address for the DHCP server, and must be reachable by all clients
served by a particular scope.
The use of the server-identifier statement is not recommended:
the only reason to use it is to force a value other than the default value
to be sent on occasions where the default value would be incorrect.
The default value is the first IP address associated with the physical
network interface on which the request arrived.
The usual case where the server-identifier statement needs to be sent is
when a physical interface has more than one IP address, and the one
being sent by default isn’t appropriate for some or all clients served by
that interface. Another common case is when an alias is defined for
the purpose of having a consistent IP address for the DHCP server,
and it is desired that the clients use this IP address when contacting
the server.
Supplying a value for the dhcp-server-identifier option is equivalent to
using the server-identifier statement.
server-name name ;
This statement can be used to to inform the client of the name of the
server from which it is booting. the name variable should be the name
that will be provided to the client.

use-host-decl-names flag;
If flag is true in a given scope, for every host declaration within that
scope the name provided for the host declaration will be supplied to
the client as its hostname. So, for example:
group {
use-host-decl-names on;
host joe {
hardware ethernet 08:00:2b:4c:29:32;
fixed-address joe.fugue.com;
}
}
is equivalent to:
host joe {
hardware ethernet 08:00:2b:4c:29:32;
fixed-address joe.fugue.com;
option host-name "joe";
}
An option host-name statement within a host declaration will override

the use of the name in the host declaration.
Most DHCP clients completely ignore the host-name option sent by the DHCP server,
and there is no way to configure them not to do this.
use-lease-addr-for-default-route flag;
If flag is true in a given scope, instead of sending the value specified in
the routers option (or sending no value at all), the IP address of the
lease being assigned is sent to the client. This causes QNX DHCP
clients to ARP for all IP addresses, which can be helpful if your router
is configured for proxy ARP.
DHCP option statements

DHCP options contain information about a network and the various services it makes
available. You direct the DHCP server to tell specified clients about some or all of this
information by declaring relevant DHCP options in your dhcpd.conf file. DHCP
option statements start with the option keyword, followed by an option name, followed
by option data, like this:
option option-name option-data
Here are the syntax rules:
• the word option always starts the statement
• option-name is one of the option names in a defined list (see Standard DHCP
options)
• option-data is a specified data type (see Data types in DHCP options)

See the section on Standard DHCP options for a list of allowed option names and
corresponding data types.
Data types in DHCP options

The variables in DHCP option statements conform to the data types shown in the
following table:
This data type: Specifies:

ip-address Numerical IP address or a domain name
resolving to a single IP address
int32 Signed 32-bit integer
uint32 Unsigned 32-bit integer
uint16 Unsigned 16-bit integer
uint8 or octet Unsigned 8-bit integer
string NVT ASCII string enclosed in double
quotes
flag Boolean value including true/false or
on/off
data-string NVT ASCII string enclosed in double
quotes, or a series of hexadecimal octets
separated by colons
Standard DHCP option statements

The standard DHCP option statements are as follows (for a sub-list of the DHCP
options that are applied by the QNX DHCP client, see dhcp.client):
option subnet-mask ip-address

Client’s subnet mask as per RFC 950. The default is as specified in the subnet
declaration for the network on which an address is assigned.
option time-offset int32
The offset of the client’s subnet in seconds from Coordinated Universal Time
(UTC).
option routers ip-address[, ip-address... ]
IP addresses for routers on the client’s subnet, in order of preference.

option time-servers ip-address[, ip-address... ]

Lists RFC 868 time servers available to the client, in order of preference.
option ien116-name-servers ip-address[, ip- address... ]

Lists IEN 116 name servers available to the client, in order of preference.
option domain-name-servers ip-address[, ip- address... ]

Lists Domain Name System (STD 13, RFC 1035) name servers available to the
client, in order of preference.
option log-servers ip-address[, ip-address... ]

Lists MIT-LCS UDP log servers available to the client, in order of preference.
option cookie-servers ip-address[, ip-address... ]

Lists RFC 865 cookie servers available to the client, in order of preference.
option lpr-servers ip-address[, ip-address... ]

The LPR server option specifies a list of RFC 1179 line printer servers available
to the client, in order of preference.
option impress-servers ip-address[, ip-address... ]

Lists Imagen Impress servers available to the client, in order of preference.
option resource-location-servers ip-address[, ip- address... ]

Lists RFC 887 Resource Location servers available to the client, in order of
preference.
option host-name string
The client’s name. We recommend that you don’t include the local domain
name; use the domain-name option to specify the domain name. See RFC 1035
for character set restrictions.
option boot-size uint16
The length (in 512-octet blocks) of the client’s default boot image.
option merit-dump string

Where to dump the client’s core image if the client crashes. Specify the
dump-file pathname string in NVT ASCII characters.
option domain-name string

The domain name that the client should use when resolving DNS hostnames.
option swap-server ip-address

The client’s swap server.
option root-path string

The pathname, in NVT ASCII characters, of the client’s root disk.

option ip-forwarding flag

Whether the client should enable IP packet forwarding (1 = enable, 0 = disable).
option non-local-source-routing flag
Whether the client should configure its IP layer to allow forwarding of
datagrams with non-local source routes (1 means allow this kind of forwarding,
0 means disallow it).
option policy-filter ip-address ip-address[, ip- address ip-address... ]

Specifies policy filters for non-local source routing. The filters consist of a list of
IP addresses and masks which specify destination/mask pairs with which to
filter incoming source routes. Any source-routed datagram whose next-hop
address does not match one of the filters should be discarded by the client. See
STD 3 (RFC1122) for further information.
option max-dgram-reassembly uint16
The maximum size datagram that the client should be prepared to reassemble
(minimum legal value is 576).
option default-ip-ttl uint8
The default time-to-live that the client should use on outgoing datagrams.
option path-mtu-aging-timeout uint32
The timeout (in seconds) to use when aging Path MTU (maximum transmission
unit) values discovered by the mechanism defined in RFC 1191.
option path-mtu-plateau-table uint16[, uint16... ]
Lists MTU sizes to use when performing Path MTU Discovery as defined in
RFC 1191, ordered from smallest to largest (minimum 68).
option interface-mtu uint16
The MTU to use on this interface (the minimum legal value is 68).
option all-subnets-local flag
If flag = 1, all subnets on the IP network to which the client is connected use the
same MTU. If flag = 0, some of these subnets may have smaller MTUs.
option broadcast-address ip-address
The broadcast address in use on the client’s subnet (see section 3.2.1.3 of STD 3
(RFC1122) for legal values).
option perform-mask-discovery flag
If flag = 1, the client should perform subnet mask discovery using ICMP
(Internet Control Message Protocol); if flag = 0, it should not.
option mask-supplier flag
If flag = 1, the client should respond to subnet mask requests using ICMP; ; if
flag = 0, it should not.

option router-discovery flag

If flag = 1, the client should solicit routers using the router discovery mechanism
defined in RFC 1256; if flag = 0, it should not.
option router-solicitation-address ip-address
The IP address to which the client should transmit router solicitation requests.
option static-routes ip-address ip-address[, ip- address ip-address... ]
Lists static routes that the client should install in its routing cache. If multiple
routes to the same destination are specified, they are listed in descending order
of priority. The list consists of IP address pairs: the first address is the
destination address; the second address is the router for the destination. The
default route (0.0.0.0) is an illegal destination for a static route. To specify the
default route, use the routers option.
option trailer-encapsulation flag

If flag = 1, the client should negotiate the use of trailers (RFC 893 [14]) when
using the ARP protocol; if flag = 0, the client should not attempt to use trailers.
option arp-cache-timeout uint32
The timeout (in seconds) for ARP cache entries.
option ieee802-3-encapsulation flag
If flag = 1, the client should use IEEE 802.3 (RFC 1042) encapsulation for an
Ethernet interface; if flag = 0, it should use Ethernet Version 2 (RFC 894).
option default-tcp-ttl uint8
The default time-to-live that the client should use when sending TCP segments.
The minimum value is 1.
option tcp-keepalive-interval uint32
The interval (in seconds) that the client TCP should wait before sending a
keepalive message on a TCP connection. A value of zero indicates that the client
should not generate keepalive messages on connections unless specifically
requested by an application.
option tcp-keepalive-garbage flag
If flag = 1, the client should send TCP keepalive messages with an octet of
garbage for compatibility with older implementations; if flag = 0, the client
should not.
option nis-domainstring
The name of the client’s NIS (Sun Network Information Services) domain, in
NVT ASCII characters.
option nis-servers ip-address[, ip-address... ]
Lists IP addresses indicating NIS servers available to the client, in order of
preference.

option ntp-servers ip-address[, ip-address... ]

Lists IP addresses indicating NTP (RFC 1035) servers available to the client, in
order of preference.
option netbios-name-servers ip-address[, ip-address... ]
Lists RFC 1001/1002 NBNS name servers listed in order of preference.
NetBIOS Name Service is currently more commonly referred to as WINS.
WINS servers can be specified using this option.
option netbios-dd-server ip-address[, ip-address... ]

Lists RFC 1001/1002 NBDD servers, in order of preference.
option netbios-node-type uint8

Allows NetBIOS over TCP/IP clients that can be configured as described in
RFC 1001/1002. The uint8 value is a single octet which identifies the client type
as follows:
A uint8 value of: Specifies:

1 B-node: Broadcast - no WINS
2 P-node: Peer - WINS only
4 M-node: Mixed - broadcast, then WINS
8 H-node: Hybrid - WINS, then broadcast
option netbios-scope string

The NetBIOS over TCP/IP scope parameter for the client as specified in RFC
1001/1002. See RFC1001, RFC1002, and RFC1035 for character-set
restrictions.
option font-servers ip-address[, ip-address... ]
Lists X Window System Font servers available to the client, in order of
preference.
option x-display-manager ip-address[, ip-address... ]
Lists systems that are running the X Window System Display Manager and are
available to the client, in order of preference.
option dhcp-client-identifier data-string
Specifies the DHCP client identifier in a host declaration, so that dhcpd can find
its matching host record.
option nisplus-domain string
The name (in NVT ASCII characters) of the client’s NIS+ domain.
option nisplus-servers ip-address[, ip-address... ]
Lists IP addresses indicating NIS+ servers available to the client, in order of
preference.

option tftp-server-name string

Identifies a TFTP server; if supported by the client, this should have the same
effect as the server-name declaration. BOOTP clients are unlikely to support this
option. Some DHCP clients will support it, and others actually require it.
option bootfile-name string
Identifies a bootstrap file. If supported by the client, it should have the same
effect as the filename declaration. BOOTP clients are unlikely to support this
option. Some DHCP clients will support it, and others actually require it.
option mobile-ip-home-agent ip-address[, ip- address... ]
Lists the IP addresses of mobile IP home agents available to the client. Agents
should be listed in order of preference, although, normally, there will be only
one such agent.
option smtp-server ip-address[, ip-address... ]
Lists the SMTP servers available to the client, in order of preference.
option pop-server ip-address[, ip-address... ]
Lists the POP3 servers available to the client, in order of preference.
option nntp-server ip-address[, ip-address... ]
Lists the NNTP servers available to the client, in order of preference.
option www-server ip-address[, ip-address... ]
Lists the WWW servers available to the client, in order of preference.
option finger-server ip-address[, ip-address... ]
Lists the Finger servers available to the client, in order of preference.
option irc-server ip-address[, ip-address... ]
Lists the IRC servers available to the client, in order of preference.
option streettalk-server ip-address[, ip-address... ]
Lists the StreetTalk servers available to the client, in order of preference.
option streetalk-directory-assistance-server ip-address[, ip-address...
]
Lists the STDA (StreetTalk Directory Assistance) servers available to the client,
in order of preference.
Troubleshooting
Finding host parameters
In a complex configuration, it can be difficult to tell which parameter applies to
any given host. It helps to remember two things:
• if there is a conflict, the parameter declaration in the lowest level of scope
takes precedence

• regardless of where they appear in the file, definitions are applied in this
order:
1 specific host configuration
2 group configuration
3 subnet configuration
4 shared-network configuration
5 global configuration
When you are troubleshooting DHCP, always start at the bottom and work your
way up.
Finding allocated leases
The dhcpd daemon writes information about the current state of all active leases
to a text file (/var/state/dhcp/dhcp.leases). The daemon rewrites this
file from time to time to keep it reasonably sized. If your server dies while
dhcpd is rewriting this file, it is possible that the file will disappear. If this
happens, you won’t be able to restart your DHCP server because dhcpd won’t
start without a leases file. Fortunately, before dhcpd changes anything in the
leases file, it creates a backup (dhcpd.leases˜) in the same directory: just
rename the backup file dhcpd.leases and you’re back in business.
The contents of the dhcpd.leases file is fairly straightforward. Each lease
declaration is identified with the keyword lease followed by the IP address and a
block of configuration information within braces .
You might have something like this:
lease 192.168.42.1 {
starts 0 2000/01/30 08:02:54;
ends 5 2000/02/04 08:02:54;
hardware ethernet
00:50:04:53:D5:57;
uid 01:00:50:04:53:D5:57;
client-hostname "PC0097";
}
The starts and ends statements tell you the period when the lease is valid.
Each entry is of the form:
weekday yyyy/mm/dd hh:mm:ss;

The weekday is the numerical value for the day of the week starting with 0 on
Sunday, as in this case. The date and time are UCT, not local time. The
hardware entry is in the same format as in the dhcpd.conf file and lists the
hardware address of the card. The uid entry is a unique identifier for the client,
using either an ASCII-string client identifier supplied by the client or the
hardware address preceded by hardware type (in this example 01).

Related issues
This section gives you some background information that might help explain a few
related issues as you create your dhcpd.conf file.
Dynamic address allocation
Address allocation is actually only done when a client is in the INIT state and has sent
a DHCPDISCOVER message. If the client thinks it has a valid lease and sends a
DHCPREQUEST to initiate or renew that lease, the server has only three choices: it
can ignore the DHCPREQUEST, send a DHCPNAK to tell the client it should stop
using the address, or send a DHCPACK, telling the client to go ahead and use the
address for a while.
If the server finds the address the client is requesting, and that address is available to
the client, the server will send a DHCPACK. If the address is no longer available, or
the client isn’t permitted to have it, the server will send a DHCPNAK. If the server
knows nothing about the address, it will remain silent, unless the address is incorrect
for the network segment to which the client has been attached and the server is
authoritative for that network segment, in which case the server will send a
DHCPNAK even though it doesn’t know about the address.
There may be a host declaration matching the client’s identification, and that host
declaration contains a fixed-address declaration that is valid for the network segment
to which the client is connected. In this case, the DHCP server will never do dynamic
address allocation. In this case, the client is required to take the address specified in
the host declaration. If the client is requesting some other address, the server will
respond with a DHCPNAK.
When the DHCP server allocates a new address for a client (remember, this only
happens if the client has sent a DHCPDISCOVER), it first looks to see if the client
already has a valid lease on an IP address, or if there is an old IP address the client had
before that hasn’t yet been reassigned. In that case, the server will take that address
and check it to see if the client is still permitted to use it. If the client is no longer
permitted to use it, the lease is freed if the server thought it was still in use: the fact
that the client has sent a DHCPDISCOVER proves to the server that the client is no
longer using the lease.
If no existing lease is found, or if the client is forbidden to receive the existing lease,
then the server will look in the list of address pools for the network segment to which
the client is attached for a lease that is not in use and that the client is permitted to
have. It looks through each pool declaration in sequence (all range declarations that
appear outside of pool declarations are grouped into a single pool with no permit list).
If the permit list for the pool allows the client to be allocated an address from that
pool, the pool is examined to see if there is an address available. If so, then the client
is tentatively assigned that address. Otherwise, the next pool is tested. If no addresses
are found that can be assigned to the client, no response is sent to the client.
If an address is found that the client is permitted to have, and that has never been
assigned to any client before, the address is immediately allocated to the client. If the

address is available for allocation but has been previously assigned to a different
client, the server will keep looking in hopes of finding an address that has never before
been assigned to a client.
Preventing IP address conflicts
If a lease has been specified in a range statement and has not been listed as being in
use by the server or its failover peer, dhcpd checks IP addresses to see if they are in
use before allocating them to clients. It does this by sending an ICMP Echo request
message to the IP address being allocated.
If no ICMP Echo reply is received within a second, the address is assumed to be free.
If a response is received, dhcpd assumes that there is a configuration error or the IP
address is in use by a network host that is not a DHCP client. In this case, the server
marks the address as abandoned, and will not assign it to clients.
If only abandoned IP addresses are available when a DHCP client makes its request,
dhcpd tries to reclaim one of the abandoned IP addresses by carrying out a new ICMP
Echo request check. If there is no answer to the ICMP Echo request, the address is
assigned to the client and the search ends; if not, dhcpd tries the next abandoned
address and so on until it finds a free one.
If the same conditions apply when the next request comes in, dhcpd starts the same
search starting at a different IP address to avoid cycling through the same sequence as
before.
Security
At first glance, there may not seem to be much to talk about in terms of security and
DHCP. However, considering the importance of DHCP, a few precautions are in order.
The first consideration is the machine itself. Although an outage of a couple of hours
might be something you can deal with, any long outage means that there may be a
number of machines without a valid configuration or even a valid IP address.
Therefore, you need to look at what other services the machine with your DHCP
server provides. Since there is very little computer power required to support DHCP,
you can easily get away with smaller machines. This might be preferable to having
dhcpd running alongside some other machines.
Another issue to consider is a denial-of-service attack. If your DHCP server were
accessible from the Internet, it would be possible for someone to gobble up all of your
IP addresses, leaving nothing for your own machines. So make sure that you stop
DHCP traffic getting through your firewall by blocking port 67 (the DHCP listen port)
and port 68 (the DHCP transmit port) on the machine running your firewall.
Examples:
An easy way to create your own dhcpd.conf file is to back up the file in
/etc/dhcpd.conf file, and then change it to suit your own needs. Here’s the file we
provide in /etc/dhcpd.conf:
# dhcpd.conf

#
# Sample configuration file for ISC dhcpd
#
# option definitions common to all supported networks...

option domain-name "fugue.com";
option domain-name-servers toccata.fugue.com;
option subnet-mask 255.255.255.224;

max-lease-time 7200;
subnet 204.254.239.0 netmask 255.255.255.224 {

range 204.254.239.10 204.254.239.20;
option broadcast-address 204.254.239.31;
option routers prelude.fugue.com;
}
# The other subnet that shares this physical network

subnet 204.254.239.32 netmask 255.255.255.224 {
range dynamic-bootp 204.254.239.10 204.254.239.20;
option routers snarg.fugue.com;
}
subnet 192.5.5.0 netmask 255.255.255.224 {

range 192.5.5.26 192.5.5.30;
option name-servers bb.home.vix.com, gw.home.vix.com;
option domain-name "vix.com";
option routers 192.5.5.1;
option subnet-mask 255.255.255.224;
max-lease-time 7200;
}
# Hosts which require special configuration options can be listed in

# host statements. If no address is specified, the address will be
# allocated dynamically (if possible), but the host-specific information
# will still come from the host declaration.
host passacaglia {
hardware ethernet 0:0:c0:5d:bd:95;
filename "vmunix.passacaglia";
server-name "toccata.fugue.com";
}
# Fixed IP addresses can also be specified for hosts. These addresses

# should not also be listed as being available for dynamic assignment.
# Hosts for which fixed IP addresses have been specified can boot using
# BOOTP or DHCP. Hosts for which no fixed address is specified can only
# be booted with DHCP, unless there is an address range on the subnet
# to which a BOOTP client is connected which has the dynamic-bootp flag
# set.
host fantasia {
hardware ethernet 08:00:07:26:c0:a5;
fixed-address fantasia.fugue.com;
}
# If a DHCP or BOOTP client is mobile and might be connected to a variety

# of networks, more than one fixed address for that host can be specified.
# Hosts can have fixed addresses on some networks, but receive dynamically
# allocated address on other subnets; in order to support this, a host
# declaration for that client must be given which does not have a fixed
# address. If a client should get different parameters depending on
# what subnet it boots on, host declarations for each such network should
# be given. Finally, if a domain name is given for a host’s fixed address
# and that domain name evaluates to more than one address, the address
# corresponding to the network to which the client is attached, if any,
# will be assigned.
host confusia {
fixed-address confusia-1.fugue.com, confusia-2.fugue.com;
filename "vmunix.confusia";
server-name "toccata.fugue.com";

host confusia {
fixed-address confusia-3.fugue.com;
server-name "snarg.fugue.com";
}
host confusia {
server-name "bb.home.vix.com";
}
See also:
dhcp.client, dhcpd, /var/state/dhcp/dhcpd.leases, dhcprelay,
syslogd.
Based on RFC 2131, RFC 2132

© 2010, QNX Software Systems GmbH & Co. KG. /var/state/dhcp/dhcpd.leases
Store information on DHCP leases
Name:
/var/state/dhcp/dhcpd.leases
Description:
When a client requests an IP address under DHCP, the dhcpd daemon assigns an
address from a pool of IP addresses stored in the /etc/dhcpd.conf file. Before
dhcpd grants the client a lease on this address, it records the details of the lease in the
leases database, a free-form ASCII file (/var/state/dhcp/dhcpd.leases) that
contains a series of lease declarations. The daemon makes sure that the contents of the
file are flushed to disk, ensuring that, even in the event of a system crash, dhcpd will
not forget about a lease that it has assigned. On startup, after reading the dhcpd.conf
file, dhcpd also reads the saved dhcpd.leases file.
Every time a lease is acquired, renewed or released, its new value is recorded at the
end of the lease file. So if more than one declaration appears for a given lease, the last
one in the file is the current one.
New leases are appended to the end of the dhcpd.leases file. From time to time,
dhcpd removes obsolete information to prevent the file becoming too large.
There is no lease database when you first install dhcpd but the daemon will not start
without one, so before you can offer DHCP services, you have to create an empty file
called /var/state/dhcpd/dhcpd.leases.
In order to prevent the lease database from growing without bound, dhcpd rewrites
the file from time to time. First, dhcpd creates a temporary lease database and dumps
all known leases to it. Then, it renames the old lease database as
/var/state/dhcpd/dhcpd.leases˜ to create a backup copy. Finally, it writes the
new lease database as /var/state/dhcpd/dhcpd.leases.
This process does have a window of vulnerability. If dhcpd is killed or the system
crashes after the old lease database has been renamed but before the new one has been
moved into place, there will be no /var/state/dhcpd/dhcpd.leases file. In this
case, dhcpd will refuse to start, and will require manual intervention. If this happens,
do not create a new lease file or you will lose all your old bindings, and your new lease
file will not match the lease information kept by the client hosts. Instead, rename
/var/state/dhcpd/dhcpd.leases˜ as /var/state/dhcpd/dhcpd.leases,
restoring the old, valid lease file, and then start dhcpd. This guarantees that a valid
lease file will be restored.
Lease descriptions are stored in a format that is parsed by the same recursive descent
parser used to read /etc/dhcpd.conf files. Currently, the only declaration that is
used in the dhcpd.leases file is the lease declaration.
Each lease declaration includes the single IP address that has been leased to the client.
The statements within the braces define the duration of the lease and to whom it is
assigned.

/var/state/dhcp/dhcpd.leases © 2010, QNX Software Systems GmbH & Co. KG.
The duration of a lease is recorded as the starts and ends statements. Dates are
specified as follows:
weekday yyyy/mm/dd hh:mm:ss;
The weekday is present to make it easy for you to tell when a lease expires: it’s
specified as a number from zero to six, with zero being Sunday. The day of week is
ignored on input. The year is specified with the century, so it should generally be four
digits except for really long leases. The month is specified as a number starting with 1
for January. The day of the month is likewise specified starting with 1. The hour is a
number between 0 and 23, the minute a number between 0 and 59, and the second also
a number between 0 and 59. Lease times are specified in UCT, not in the local time
zone.
DHCP leases can be assigned almost any length from zero seconds to infinity. What
lease length makes sense for any given subnet, or for any given installation, will vary
depending on the kinds of hosts being served. For example, in an office environment
where you add or remove systems infrequently, you might allow monthly leases
whereas in a final test environment on a manufacturing floor, you might want to
restrict leases to 30 minutes or so.
The MAC address of the network interface that was used to acquire the lease is
recorded with the hardware statement:
hardware hardware-type mac-address;
The mac-address is specified as a series of hexadecimal octets, separated by colons.

If the client used a client identifier to acquire its address, the client identifier is
recorded using the uid statement, like this:
uid client-identifier;
The client-identifier variable is recorded as a series of hexadecimal octets, regardless

of whether the client specifies an ASCII string or uses the newer hardware type/MAC
address format.
If the client sends a hostname using the Client Hostname option, as specified in
some versions of the DHCP-DNS Interaction draft, that hostname is recorded using
the client-hostname statement:
client-hostname "hostname";
If the client sends its hostname using the Hostname option, as Windows 95 does, it is
recorded using the hostname statement:
hostname "hostname";
The DHCP server may determine that a lease has been misused in some way, either
because a client that has been assigned a lease NAKs it, or because the server’s own
attempt to see if an address is in use prior to reusing it reveals that the address is in fact
already in use. In that case, the abandoned statement is used to indicate that the lease
should not be reassigned, like this:

© 2010, QNX Software Systems GmbH & Co. KG. /var/state/dhcp/dhcpd.leases
abandoned;
Abandoned leases are reclaimed automatically. When a client asks for a new address,
and the server finds that there are no new addresses, it checks to see if there are any
abandoned leases, and allocates the least recently abandoned lease. The standard
mechanisms for checking for lease address conflicts are still followed, so if the
abandoned lease’s IP address is still in use, it will be re-abandoned.
If a client requests an abandoned address, the server assumes that the reason the
address was abandoned was that the lease file was corrupted, and that the client is the
machine that responded when the lease was probed, causing it to be abandoned. In that
case, the address is immediately assigned to the client.
Examples:
Here’s an example of a typical lease entry:
lease 192.168.42.1 {
starts 0 2000/01/30 08:02:54;
ends 5 2000/02/04 08:02:54;
hardware ethernet
00:50:04:53:D5:57;
uid 01:00:50:04:53:D5:57;
client-hostname "PC0097";
}
See also:
dhcp.client, dhcpd, /etc/dhcpd.conf, dhcprelay, syslogd.

dhcprelay © 2010, QNX Software Systems GmbH & Co. KG.
DHCP relay agent
Syntax:
dhcprelay [-a] [-A value] [-d] [-D] [-q] [-i en0]
[... -i enX] [-p port] [-pf pid-file]
[-m] dhcp-server1 [... serverX]
Runs on:
Neutrino
Options:
-a Append an agent option field to each request before forwarding it to
the server.
-A value Support maximum packet size (default is 576).
-d Don’t move to the background. This is useful when running

dhcprelay under a debugger.
-D Drop packets that don’t contain a relay agent information option field
for this agent.
-i interface Specify the interface(s) that dhcprelay will service. By default,

dhcprelay listens for DHCP packets on all interfaces capable of
handling broadcast messages. If you want to prevent certain
interfaces from accessing DHCP relay services, use this option to
specify the interfaces dhcprelay will listen on.
-p port The UDP receiving port that dhcprelay will listen to. By default,
dhcprelay listens for datagrams on port 67 or as specified in
/etc/services. The port dhcprelay transmits on is the one with
the next highest number (e.g. if dhcprelay receives on port 67, it
transmits on port 68). This option is mostly used for debugging
purposes.
-pf file An alternative file to store the PID of dhcprelay. The default is
/var/run/dhcprelay.pid.
-q Quiet mode. Use when you want to avoid printing on startup (e.g.
when starting dhcprelay from a script).
-mappend|replace|forward|discard
Take action if a packet is received with the gateway address
(giaddr) set.

© 2010, QNX Software Systems GmbH & Co. KG. dhcprelay
dhcp-server1 [... serverX]

You must specify the IP address of at least one DHCP server where
client requests will be forwarded to.
Description:
The dhcprelay DHCP relay agent relays DHCP and BOOTP requests from a subnet
that doesn’t have a DHCP server to one that does.
The agent normally runs in the foreground until it has configured an interface, and
then runs as a daemon in the background.
The dhcprelay daemon listens for DHCP requests on all interfaces attached to a host
(or those specified by the -i option).
When a query is received, dhcprelay forwards it to the list of DHCP servers
specified on the command line. When a reply is received, it is broadcast or unicast on
the network where the original request came.
Relay agent information options

When you set the -a flag, the relay agent appends an agent option field to each request
before forwarding it to the server. In responses back to the client from the server, the
agent option fields are stripped.
The agent option field contains two agent options: the circuit ID suboption and the
agent ID suboption. Currently, the circuit ID is the printable name of the interface on
which the client request is received. The agent ID is the value that the relay agent
stores in the DHCP packet’s giaddr field. The client supports inclusion of a remote
ID suboption as well, but this is not used by default.
The agent ID suboption is not defined in the current relay agent information option
draft (draft-ietf-dhc-agent-options-03.txt), but has been proposed for
inclusion in the next draft.
Relay agent options are added to a DHCP packet without the knowledge of the DHCP
client. If the client has filled the DHCP packet option buffer completely, then there’s
no space to add agent options. The DHCP server, however, can handle a much larger
packet than most DHCP clients send. The current agent options draft requires that the
relay agent use a maximum packet size of 576 bytes.
With the Internet software consortium DHCP server, we recommend that you set the
maximum packet size to about 1400, allowing plenty of extra space in which the relay
agent can put the agent option field, while still fitting into the Ethernet MTU size. You
can do this by specifying the -A flag, followed by the desired maximum packet size
(e.g. 1400).
It’s reasonably safe to do even if the MTU between the server and the client is less
than 1500, as long as the hosts on which the server and client are running support IP
fragmentation (and they should). With some knowledge as to how large the agent

dhcprelay © 2010, QNX Software Systems GmbH & Co. KG.
options might get in a particular configuration, this parameter can be tuned as finely as
necessary.
It’s possible for a relay agent to receive a packet that contains an agent option field. If
this packet doesn’t have a giaddr set, the packet is discarded.
If giaddr is set, the server may handle the situation in one of four ways. It may:
• append its own set of relay options to the packet, leaving the supplied option field
intact
• replace the existing agent option field
• forward the packet unchanged
• discard it.
To do the above, use the -m flag with one of the arguments: append, replace,
forward, or discard.
The relay agent usually scans a response from a server and removes the relay agent
information option if the relay agent information option processing is enabled.
However, if it finds a relay agent information option field containing an agent ID
suboption that matches one of its IP addresses, that is recognized as its own. If no such
option is found, the relay agent can either drop the packet or relay it anyway. If the -D
option is specified, all packets that don’t contain a match are dropped.
Specifying DHCP servers

You must specify on the command line the name or IP address of at least one DHCP
server to which DHCP and BOOTP requests should be relayed.
Examples:
Start dhcprelay using defaults:
dhcprelay 10.0.0.1
Start dhcprelay in quiet mode, servicing only en0:
dhcprelay -q -i en0 10.0.0.1
Errors:
When an error occurs, dhcprelay sends a description of the error to syslogd and
stderr only if dhcprelay is running on the foreground.
Ted Lemon in cooperation with Vixie Enterprises.

© 2010, QNX Software Systems GmbH & Co. KG. dhcprelay
License:
This utility is based on copyright software of The Internet Software Consortium; for
licensing information, see the Third Party License Terms List at
See also:
dhcp.client, dhcpd, syslogd.

diff © 2010, QNX Software Systems GmbH & Co. KG.
Compare two files, line by line (GNU)
Syntax:
diff [option] file1 file2
Runs on:
Neutrino
Options:
-i
--ignore-case Ignore case differences in the contents of the files.
--ignore-file-name-case
Ignore case when comparing filenames.
--no-ignore-file-name-case
Consider case when comparing filenames.
-E
--ignore-tab-expansion
Ignore changes due to tab expansion.
-b
--ignore-space-change
Ignore changes in the amount of white space.
-w
--ignore-all-space
Ignore all white space.
-B
--ignore-blank-lines
Ignore changes whose lines are all blank.
-I RE
--ignore-matching-lines=RE
Ignore changes whose lines all match the given regular
expression.
--strip-trailing-cr
Strip trailing carriage returns from the input.
-a
--text Treat all files as text.
-c
-C num
--context[=num] Output num (default 3) lines of copied context.

© 2010, QNX Software Systems GmbH & Co. KG. diff
-u
-U num or --unified[=num]
Output num (default 3) lines of unified context.
--label label Use label instead of the filename in the output. You can specify
this option twice; the first applies to file1, and the second to
file2.
-p
--show-c-function
Show which C function each change is in.
-F RE
--show-function-line=RE
Show the most recent line that matches the given regular
expression.
-q
--brief Output only whether or not the files differ.
-e
--ed Output an ed script.
--normal Display the differences in the normal format.
-n
--rcs Display the differences in RCS format.
-y
--side-by-side Display the output in two columns.
-W num
--width=num Output at most num (default 130) print columns.
--left-column Output only the left column of common lines.
--suppress-common-lines
Don’t display any lines that are common to both files.
-D name
--ifdef=name Output merged file to show #ifdef name differences.
--GTYPE-group-format=GFMT
Use the given format to output groups of lines in an if-then-else
format. GTYPE can be old, new, changed, or unchanged.
GFMT may contain:
%< Lines from file1.

%> Lines from file2.

%= Lines common to file1 and file2.

%[-][width][.[prec]]{doxX}letter
Use the given printf -style specification for the
given letter. The letters are as follows for the
new group; use lowercase letters for the old
group:
• F — the first line number
• L — the last line number
• N — the number of lines = L-F+1
• E — F-1
• M — L+1.
%% A literal %.
%c’C’ The single character, C.
%c’\OOO’ The character with the given octal code, OOO.
--line-format=LFMT
Use the given format to output all input lines in an if-then-else
format.
--LTYPE-line-format=LFMT
Use the given format to output individual lines in an if-then-else
format. LTYPE can be old, new, or unchanged. LFMT may
contain:
%L Contents of the line.

%l Contents of the line, excluding any trailing
newline.
%[-][width][.[prec]]{doxX}n
Use the given printf -style specification for input
line numbers.
%% A literal %.
%c’C’ The single character, C.
%c’\OOO’ The character with the given octal code, OOO.
-l
--paginate Pass the output through pr to paginate it.
-t
--expand-tabs Expand tabs into spaces in the output.
-T
--initial-tab Make tabs line up by prepending a tab.
-r
--recursive Recursively compare any subdirectories found.

© 2010, QNX Software Systems GmbH & Co. KG. diff
-N
--new-file Treat absent files as being empty.
--unidirectional-new-file
Treat absent first files as being empty.
-s
--report-identical-files
Report when two files are the same.
-x pattern
--exclude=pattern
Exclude files that match the given pattern.
-X file
--exclude-from=file
Exclude files that match any pattern in file.
-S file
--starting-file=file
Start with file when comparing directories.
--from-file=file1 Compare file1 to all operands. The file1 argument can also be
the name of a directory.
--to-file=file2 Compare all operands to file2. The file2 argument can also be
the name of a directory.
--horizon-lines=num
Keep num lines of the common prefix and suffix.
-d
--minimal Try hard to find a smaller set of changes.
--speed-large-files
Assume large files and many scattered small changes.
-v
--version Output version information.
--help Display a help message.
file1, file2 Pathnames of the files to be compared. These can be in the

following forms:
• file1 file2
• directory1 directory2
• directory file...
• file... directory

If you specify the --from-file or --to-file option, there

are no restrictions on the files. If you specify a dash (-) instead
of a filename, diff reads from standard input.
Description:
The diff utility reports the differences between two files.
If you use diff to compare binary files, diff simply reports whether or not the files
are different. If you want to see the differences between two binary files, use cmp.
For any two files, there may be several correct interpretations of the differences
between them. The diff utility attempts to generate the smallest number of additions,
changes, and deletions required to convert file1 into file2. No output is produced if the
files are identical.
For detailed documentation about diff, see the GNU website at

http://www.gnu.org/.
Exit status:
0 No differences were found.
1 Differences were found.
GNU
See also:
cksum, cmp, diff3, patch, wc

© 2010, QNX Software Systems GmbH & Co. KG. diff3
Show differences among three files (GNU)
Syntax:
diff3 [options...] mine older yours
Runs on:
Neutrino
Options:
-a Treat all files as text and compare them line-by-line, even if they
do not appear to be text.
-A Incorporate all changes from older to yours into mine,

surrounding all conflicts with bracket lines. See section
“Marking conflicts”.
-e Generate an ed script that incorporates all the changes from

older to yours into mine. See section “Selecting which changes
to incorporate”. (ed is not included with the QNX distribution)
-E Like -e, but output unmerged changes, bracketing overlaps. See

section “Marking conflicts”.
-i Generate w and q commands at the end of the ed script for

System V compatibility. This option must be combined with one
of the -AeExX3 options, and may not be combined with -m. See
section “Saving the changed file”. (ed is not included with the
QNX distribution)
-L label Use the label label for the brackets output by the -A, -E and -X
options. This option may be given up to three times, one for each
input file. The default labels are the names of the input files.
Thus diff3 -L X -L Y -L Z -m A B C acts like diff3
-m A B C, except that the output looks like it came from files
named X, Y and Z rather than from files named A, B and C. See
section “Marking conflicts”.
-m Apply the edit script to the first file and send the result to
standard output. Unlike piping the output from diff3 to ed, this
works even for binary files and incomplete lines. -A is assumed
if no edit script option is specified. See section “Generating the
merged output directly”.
-T Output a tab rather than two spaces before the text of a line in
normal format. This causes the alignment of tabs in the line to
look normal.
-v Output the version number of diff3.

diff3 © 2010, QNX Software Systems GmbH & Co. KG.
-x Like -e, except output only the overlapping changes. See

section “Selecting which changes to incorporate”.
-X Like -E, except output only the overlapping changes. In other

words, like -x, except bracket changes as in -E. See section
“Marking conflicts”.
-3 Like -e, except output only the nonoverlapping changes. See

section “Selecting which changes to incorporate”.
mine older yours These are the pathnames of the files to be compared. At most
one of these three file names may be a dash (-), which tells
diff3 to read the standard input for that file.
Description:
The diff3 utility is used to compare three files and show any differences among
them. (diff3 can also merge files; see section “Merging from a common ancestor”).
The normal diff3 output format shows each hunk of differences without surrounding
context. Hunks are labeled depending on whether they are two-way or three-way, and
lines are annotated by their location in the input files.
Sample input files

Here are three sample files that we’ll use in numerous examples to illustrate the output
of diff3 and how various options can change it.
Sample file #1 — lao
This is the file lao:
The Way that can be told of is not the eternal Way;

The name that can be named is not the eternal name.
The Nameless is the origin of Heaven and Earth;
The Named is the mother of all things.
Therefore let there always be non-being,
so we may see their subtlety,
And let there always be being,
so we may see their outcome.
The two are the same,
But after they are produced,
they have different names.
Sample file #2 — tzu
This is the file tzu:

The named is the mother of all things.



They both may be called deep and profound.
Deeper and more profound,
The door of all subtleties!
Sample file #3 — tao
This is the third sample file, called tao:


so we may see their result.
-- The Way of Lao-Tzu, tr. Wing-tsit Chan
Detailed description of diff3 normal format

Each hunk begins with a line marked “====”. Three-way hunks have plain “====”
lines, and two-way hunks have “1”, “2”, or “3” appended to specify which of the three
input files differ in that hunk. The hunks contain copies of two or three sets of input
lines each preceded by one or two commands identifying where the lines came from.
Normally, two spaces precede each copy of an input line to distinguish it from the
commands. But with the -T option, diff3 uses a tab instead of two spaces; this lines
up tabs correctly.
Commands take the following forms:
file:la This hunk appears after line l of file file, and contains no lines in that file.
To edit this file to yield the other files, one must append hunk lines taken
from the other files. For example, “1:11a” means that the hunk follows
line 11 in the first file and contains no lines from that file.
file:rc This hunk contains the lines in the range r of file file. The range r is a
comma-separated pair of line numbers, or just one number if the range is a
singleton. To edit this file to yield the other files, one must change the
specified lines to be the lines taken from the other files. For example,
“2:11,13c” means that the hunk contains lines 11 through 13 from the
second file.
If the last line in a set of input lines is incomplete, it is distinguished on output from a
full line by a following line that starts with “\”.

diff3 hunks
Groups of lines that differ in two or three of the input files are called diff3 hunks, by
analogy with diff hunks. If all three input files differ in a diff3 hunk, the hunk is
called a three-way hunk; if just two input files differ, it is a two-way hunk.
As with diff, several solutions are possible. When comparing the files A, B, and C,
diff3 normally finds diff3 hunks by merging the two-way hunks output by the two
commands diff A B and diff A C. This does not necessarily minimize the size of
the output, but exceptions should be rare.
For example, suppose the file F contains the three lines “a”, “b”, “f”, the file G
contains the lines “g”, “b”, “g”, and the file H contains the lines “a”, “b”, “h”. In this
case the command diff3 F G H might produce the following output:
====2
1:1c
3:1c
a
2:1c
g
====
1:3c
f
2:3c
g
3:3c
h
because it found a two-way hunk containing “a” in the first and third files and “g” in
the second file, then the single line “b” common to all three files, then a three-way
hunk containing the last line of each file.
An example of diff3 normal format

Here is the output of the command diff3 lao tzu tao (see section “Sample input
files”, for the complete contents of the files). Notice that it shows only the lines that
are different among the three files.
====2
1:1,2c
3:1,2c
2:0a
====1
1:4c
2:2,3c
3:4,5c
====3
1:8c
2:7c
3:9c

====
1:11a
2:11,13c
3:13,14c
Merging from a common ancestor

When changes have been made to copies of the same file, diff3 can produce a
merged output that contains both sets of changes together with warnings about
conflicts.
One might imagine programs with names like diff4 and diff5 to compare more
than three files simultaneously, but in practice the need rarely arises. You can use
diff3 to merge three or more sets of changes to a file by merging two change sets at a
time.
The diff3 utility can incorporate changes from two modified versions into a common
preceding version. This lets you merge the sets of changes represented by the two
newer files. Specify the common ancestor version as the second argument and the two
newer versions as the first and third arguments, like this:
diff3 mine older yours
You can remember the order of the arguments by noting that they are in alphabetical
order.
You can think of this as subtracting older from yours and adding the result to mine, or
as merging into mine the changes that would turn older into yours. This merging is
well-defined as long as mine and older match in the neighborhood of each such
change. This fails to be true when all three input files differ or when only older differs;
we call this a conflict. When all three input files differ, we call the conflict an overlap.
The diff3 utility gives you several ways to handle overlaps and conflicts. You can
omit overlaps or conflicts, or select only overlaps, or mark conflicts with special
“<<<<<<<” and “>>>>>>>” lines.
The diff3 utility can output the merge results as an ed script that that can be applied
to the first file to yield the merged output. However, it is usually better to have diff3
generate the merged output directly; this bypasses some problems with ed. Note that
ed is not included with the QNX distribution.
Selecting which changes to incorporate

You can select all unmerged changes from older to yours for merging into mine with
the -e option. You can select only the nonoverlapping unmerged changes with -3, and
you can select only the overlapping changes with -x.
The -e, -3 and -x options select only unmerged changes, i.e. changes where mine
and yours differ; they ignore changes from older to yours where mine and yours are

identical, because they assume that such changes have already been merged. If this
assumption is not a safe one, you can use the -A option. (See section “Marking
conflicts”).
Here is the output of the command diff3 with each of these three options (see section
“Sample input files”, for the complete contents of the files). Notice that -e outputs the
union of the disjoint sets of changes output by -3 and -x.
Output of diff3 -e lao tzu tao:
11a

.
8c
.
Output of diff3 -3 lao tzu tao:
8c
.
Output of diff3 -x lao tzu tao:
11a

.
Marking conflicts
The diff3 utility can mark conflicts in the merged output by bracketing them with
special marker lines. A conflict that comes from two files A and B is marked as
follows:
<<<<<<< A
lines from A
=======
lines from B
>>>>>>> B
A conflict that comes from three files A, B and C is marked as follows:
<<<<<<< A
lines from A
||||||| B
lines from B
=======
lines from C
>>>>>>> C
The -A option acts like the -e option, except that it brackets conflicts, and it outputs
all changes from older to yours, not just the unmerged changes. Thus, given the
sample input files (see section “Sample input files”), diff3 -A lao tzu tao puts
brackets around the conflict where only tzu differs:

11a
||||||| tzu
=======

>>>>>>> tao
.
11a
<<<<<<< lao
.
8c
.
2a
>>>>>>> tao
.
0a
<<<<<<< tzu
=======
.
The -E option outputs less information than the -A option, because it outputs only
unmerged changes, and it never outputs the contents of the second file. Thus the -E
option acts like the -e option, except that it brackets the first and third files from
three-way overlapping changes. Similarly, -X acts like -x, except it brackets all its
(necessarily overlapping) changes. For example, for the three-way overlapping change
above, the -E and -X options output the following:
11a
||||||| tzu
=======

>>>>>>> tao
.
11a
<<<<<<< lao
.
8c
.
2a
>>>>>>> tao
.
0a
<<<<<<< tzu
=======
.
If you are comparing files that have meaningless or uninformative names, you can use
the -L label or --label=label option to show alternate names in the “<<<<<<<”,
“|||||||”, and “>>>>>>>” brackets. This option can be given up to three times,
once for each input file. Thus diff3 -A -L X -L Y -L Z A B C acts like diff3
-A A B C, except that the output looks like it came from files named X, Y and Z rather
than from files named A, B and C.

Generating the merged output directly

With the -m option, diff3 outputs the merged file directly. This is more efficient than
using ed to generate it, and works even with non-text files that ed would reject. If you
specify -m without an ed script option, -A (--show-all) is assumed. (Note that ed is
not included with the QNX distribution.)
For example, the command diff3 -m lao tzu tao (see section “Sample input
files” for a copy of the input files) would output the following:
<<<<<<< tzu
=======
>>>>>>> tao
<<<<<<< lao
||||||| tzu
=======

>>>>>>> tao
How diff3 merges incomplete lines

With -m, incomplete lines are simply copied to the output as they are found; if the
merged output ends in an conflict and one of the input files ends in an incomplete line,
succeeding “|||||||”, “=======”, or “>>>>>>>” brackets appear somewhere other
than the start of a line because they are appended to the incomplete line.
Without -m, if an ed script option is specified and an incomplete line is found, diff3
generates a warning and acts as if a newline had been present.
Saving the changed file

Traditional Unix diff3 generates an ed script without the trailing w and q commands
that save the changes. System V diff3 generates these extra commands. GNU diff3
normally behaves like traditional Unix diff3, but with the -i option it behaves like
System V diff3 and appends the w and q commands.
The -i option requires one of the ed script options -AeExX3, and is incompatible
with the merged output option -m.

Exit status:
0 diff3 was successful.
1 Some conflicts were found.
GNU
See also:
cmp, diff, patch

dig © 2010, QNX Software Systems GmbH & Co. KG.
DNS domain information groper lookup utility
Syntax:
dig [@server] [-b address] [-c class] [-f filename]
[-k filename] [-p port_num] [-q name] [-t type]
[-x addr] [-y [hmac:]name:key] [-4] [-6] [name]
[type] [class] [queryopt...]
dig [-h]
dig [global-queryopt...] [query...]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?dig++NetBSD-5.0 in the
NetBSD documentation.
Description:
The dig (domain information groper) utility is a flexible tool for interrogating DNS
name servers. It performs DNS lookups and displays the answers that are returned
from the name server(s) that were queried. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?dig++NetBSD-5.0 in the NetBSD
documentation.
See also:
dnssec-keygen, host, named in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. dinit
Initialize a disk for use as a QNX 4 filesystem (QNX Neutrino, QNX 4)
Syntax:
dinit [-8bpqr] [-F|h] [-B filename|-O] [-d drive_number]
[-f bootfile] [-i blocks] [-L label|-l label]
[-m message] [-N] [-R] [-r] [-S size] drive
Runs on:
Options:
-8 Use the int 13 extended loader for disks bigger than 8.4Gig.
-B filename Use the 512-byte OS loader from this file instead of the standard
QNX OS loader. Note that on a partitioned hard disk, the OS
loader is the second loader, not the primary bootstrap loader,
which is written to the first block of the hard disk by the fdisk
utility. On a nonpartitioned device, (e.g. floppy) the OS loader
is the primary (and only) bootstrap loader.
-b Don’t initialize the filesystem; just write the OS loader to disk.
You can use this option with -m, or -O.
-d drive_number The BIOS drive number to use for booting the second stage
loader (diskpc2). This enables you to set up the loader to boot
when the drive is configured as either a primary or secondary
drive. Common values for drive_number are: 00 for the first
floppy drive, 80 for the first hard drive, and 81 for the second
hard drive.
This option is required for booting from secondary hard drives
(if you specify an explicit drive number, it overrides -F or -h).
-F Initialize a floppy or LS120 disk.
-f bootfile Write the specified operating system boot image to the /.boot
file on the newly initialized disk.
-H or -h Initialize a hard or compact flash disk. You can’t initialize a
hard disk unless you specify this option.
-i blocks The initial size, in blocks, of the .inodes file. The default is
16. You don’t usually have to change this setting; for more
information, see Fine-Tuning Your System in the Neutrino
User’s Guide.
-l label (“el”) Write the given volume label to disk after initializing.
-L label Write only the given volume label to disk. You can remove a
label by using the -L option with an empty string. For example:

dinit © 2010, QNX Software Systems GmbH & Co. KG.
dinit -L "" /dev/fd0
-m message Replace the message the OS displays when booting from disk
with message.
-N Don’t create support for long filenames (more than 48

characters) on this new filesystem.
To add support for long filenames to an existing QNX 4
filesystem, log in as root and create an empty, read-only
(permissions 0444) file named .longfilenames in the root
directory of the filesystem.
-O Use the old QNX bootstrap loader. The old loader loads at (real
mode) 0x60:0, always. The newer loader looks for a signature
byte in the beginning of the OS image to determine if it’s old or
new, and loads at 0x60:00 or 0x80:00 as appropriate. The
start address for new images is 0x0 relative to the load address,
while the start address for old images is 0x20 relative to the
load address.
-p Pause for a keystroke before continuing.
-q Be quiet; don’t echo or question.
-R Create a .diskroot file in the root directory (used for

diskboot auto-mounting). For more information, see the
Controlling How Neutrino Starts chapter of the Neutrino User’s
Guide.
-r Write only the root block to disk; see “Caveats,” below.
-S size When used on a file, grow it to this size, which can include a
suffix of k, m, or g.
drive The drive on which to initialize the hard disk or diskette (e.g.
/dev/fd0, /dev/hd0t77).

Device names under Windows differ from those under QNX 4 and QNX Neutrino. For
example, under Neutrino:
dinit -f hello.ifs /dev/fd0
Under Windows:
dinit -f hello.ifs a:
Description:
The dinit utility initializes a formatted diskette or hard disk so that you can use it as
a QNX 4 filesystem, using fs-qnx4.so. The default values are determined from the
current configuration of the specified drive.
We recommend that you use dinit to initialize the QNX 4 filesystem, and dloader
to make it bootable. The dinit bootloader options are for backwards compatibility
reasons, but aren’t generally used anymore.
If the disk is a hard disk, you need to specify the -h or -H (hard) option. This option
helps protect you against typing errors that might cause dinit to initialize your hard
disk. To initialize a hard disk, you must be the superuser.
After initializing a hard disk with dinit, you should use the dcheck utility to remove
any bad blocks from the disk allocation bitmap. For example:
dinit -h /dev/hd0t77
dcheck -m /dev/hd0t77
When dinit initializes a disk, it writes a loader in the first block. If the disk is a
floppy diskette, the loader is the bootstrap loader, else it’s the secondary (or partition)
loader. If you need to rewrite the loader without reinitializing the disk, specify the -b
option.
The -m option lets you change the message the OS displays when booting from disk.
Normally, the message is:
Press ESC to boot alternate OS.
Your new message may contain up to 30 characters plus the trailing period. You can
specify the minimum message of “.” by specifying -m. for the option.

filesystems:

dinit © 2010, QNX Software Systems GmbH & Co. KG.

a Read-only.
Examples:
Initialize a hard disk:
Initialize a floppy disk:
dinit /dev/fd0
Pause before initializing hard disk:
dinit -hp /dev/hd0t77
Exit status:
0 Successful.
Caveats:
Don’t use the -r option unless you know exactly what you’re doing. You use the -r
option only after a disaster has destroyed the first few blocks of your disk (e.g. a
power failure occurred while the disk was being updated). In order for any damage to
be repaired, you must follow dinit -r with this command:
chkfsys mountpoint

See also:
chkfsys, dcheck, diskboot, dloader, fdformat, fdisk, fs-qnx4.so,
mkdosfs, mkqnx6fs
Filesystems chapter of System Architecture
QNX Neutrino User’s Guide:
• “QNX 4 filesystem” in the Working With Filesystems chapter
• “Filesystems and block I/O (devb-*) drivers” in the Fine-Tuning Your System
chapter
• “Filesystem limits” in the Understanding System Limits chapter
• Controlling How Neutrino Starts
• Backing Up and Recovering Data

dirname © 2010, QNX Software Systems GmbH & Co. KG.
Return the directory portion of a pathname (POSIX)
Syntax:
dirname string
Runs on:
Options:
None.
Description:
The dirname utility returns a portion of the string operand to standard output. The
string operand represents a valid pathname whose format is:
directory_pathname/base_filename
The dirname utility writes the directory_pathname component to standard output.

If string is //, then // is returned. Any other string consisting entirely of slash
characters causes a single slash to be returned.
You’ll use the dirname utility most often within shell scripts, where it’s normally
invoked inside back-tick (‘...‘), or contained in $(...).
Examples:
Command: Output:
dirname . .
dirname .. .
dirname ../. ..
dirname /usr/src/prog.c /usr/src
dirname /usr/src/ /usr
dirname ...//[fred] ...
Exit status:

© 2010, QNX Software Systems GmbH & Co. KG. dirname
See also:
basename

diskboot © 2010, QNX Software Systems GmbH & Co. KG.
Boot the system
Syntax:
diskboot [options]...
Runs on:
Neutrino
Options:
-b type Force the boot to a particular type; where type can be 1,2, or 3
depending on the type of boot required:
1 Boot from a hard disk.
2 Boot from a CDROM.
3 Install QNX Neutrino to a new disk partition.
-D UseDma If UseDma is 0, disable DMA for the EIDE driver. If UseDma is
1, enable DMA for the EIDE driver. By default, DMA is disabled.
-d dir The directory to search for *.qfs files on partition filesystems.
The default depends on the filesystem type:
• QNX — /boot/fs
• DOS — /Program Files/qnx/boot/fs
• Linux — /qnx/boot/fs
• cd — /boot/fs
-e Search ext2 partitions.
-f Instead of running finstall, run the installation script on the
CD.
-i Run inflator on the qnxbase.qfs file mountpoint.
-o cmd,options Provide options to use if the given command is started. For
example:
• To pass an option to a specific driver:
-o "devb-eide,blk cache=30m"
• To pass an option to all block drivers:

-o "devb-*,blk cache=30m"
• To pass the -m option to the pci-bios utility:

-o "pci-bios,-m"
You can use additional -o arguments to pass additional options.

Specifying an -o option doesn’t cause the specified command to
be started.

© 2010, QNX Software Systems GmbH & Co. KG. diskboot
-R Prevent diskboot from restarting block drivers (the restarting is

used to reduce cache RAM when no hard disks are detected).
-s Start drivers and filesystems but don’t run the sysinit file.
-u options Specify the options to pass to io-usb. The default is -duhci

-dohci -dehci.
-v[v...] Verbose output. More v characters cause more verbosity.
-x drvr Exclude the specified driver. The drvr argument must be the full
name (e.g. -x devb-eide).
Description:
The diskboot utility is built into the boot image for systems that boot from a block
device. Its purpose is to boot a QNX Neutrino system.
If the -b option isn’t set, diskboot starts by searching for all hard disks and
CDROMs on all controllers. A 10-second timeout prevents defective drivers or
hardware from locking the system. The utility then starts all filesystems on all
partitions on hard drives, magneto drives, and CDROMs. If you press the space bar
while diskboot is running, it lets you select additional options.
The diskboot process then runs the /etc/system/sysinit script, which:
• runs enum-devices to determine what devices are present
• starts any system services that would be in any monolithic UNIX kernel
• executes /etc/rc.d/rc.sysinit, which does local initialization and finishes by

running tinit, which allows logins to the system.
For a more detailed description, see the Controlling How Neutrino Starts chapter of
the Neutrino User’s Guide.
Examples:
Run diskboot:
diskboot
Files:
.diskroot A file that indicates how to mount the partitions; see the description
of .diskroot in the Controlling How Neutrino Starts chapter of the
/etc/system/sysinit
A script that sets up system services.

diskboot © 2010, QNX Software Systems GmbH & Co. KG.
See also:
enum-devices, io-usb, tinit
Controlling How Neutrino Starts in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. dispconf
Generates display configuration data
Syntax:
dispconf -i vid did index [-d drv[,mode opts]]*
[-c file] [-g name=val[ ,name=val[ ,...]]]
Runs on:
Neutrino
Options:
-i vid, did, index The vid (vendor id), did (device id) and index (device index) of
the device for which the device {} section should be added
or updated in the config file. The vid, did, index values are
numbers, if they start with 0xn, then the n is a hexadecimal
value.
-d drv[,modeopts]* Add a driver {} subsection for this device’s photon {}

subsection.
photon {
driver {
drivername=drv
modeopts=[modeopts]
}
}
This option can be used multiple times if this device is
supported by multiple drivers. Whenever the list of drivers
changes or when the device section is added for the first time
the device.drivername is set to the first driver. If no drivers
are specified, the default “svga” driver is used.
-c file Use this configuration file instead of the default.
-g name=val[,name=val[,...]]
Specify overrides of entries in the display {} section.
This option will only work when the device section is added for the first time, or when
the list of drivers changes. To override an entry in the photon {} subsection, use the
following example:
photon.name=val
The default display section is:

display {
xres=640
yres=480
refresh=60
pixel_format=rgb565

dispconf © 2010, QNX Software Systems GmbH & Co. KG.
photon {
enabled=1 # if this is the primary display card.
xoffset=0
yoffset=0
cursor=hardware
input_group=1
}
}
Description:
The dispconf utility has several options that enable you to manipulate the
configuration information for your video hardware.
Files:
/etc/system/config/display.conf
The default configuration file.
/etc/system/config/display.conf.changed
A zero length file. It is created by the dispconf if the configuration has been
changed.
/etc/system/config/crtc-settings
If /etc/system/config/crtc-settings does not exist, try to restore it
from /usr/photon/config/crtc-settings
/usr/photon/config/crtc-settings
This file is used by io-display.
See also:
io-graphics, phgrafx

© 2010, QNX Software Systems GmbH & Co. KG. dloader
Write a boot loader to a disk
Syntax:
dloader [-v] [-d drive_number] [-F|H] [device loader] ...
Runs on:
Neutrino
Targets:
x86
Options:
-d drive_number Sets the BIOS drive number for booting the second stage loader
(diskpc2). This enables you to set up the loader to boot when
the drive is configured as either a primary or secondary drive.
Common values for drive_number are: 00 for the first floppy
drive, 80 for the first hard drive, and 81 for the second hard
drive.
If you don’t specify this option or any of the other override
options (-F, -H), a heuristic based on disk size and removability
determines whether the drive is for a fixed or floppy disk. The
order of precedence used to determine the drive number to be
patched into the loader code is:
1 -d
2 -F
3 -H
4 heuristic
-F Floppy loader override.
-H Hard disk loader override.
-v Be verbose.
device The name of the raw or partition disk mountpoint.
loader The name of the loader.
Description:
The dloader utility writes a boot loader to a disk.
The dloader utility starts by looking for the loader you specified. If your loader
name contains a / (slash), dloader assumes it is a complete pathname and looks for
the loader using the path you gave; if not, dloader looks in the processor family
subdirectory of QNX_TARGET (under QNX Neutrino, this would be

dloader © 2010, QNX Software Systems GmbH & Co. KG.
$QNX_TARGET/x86/boot/sys). To see the loaders provided in the default path,

type dloader without any options.
The naming of QNX loaders provides a framework for specifying QNX and custom
loaders. This framework consists of a loader name and a method of specifying
optional variants.
Currently, QNX Neutrino provides the following two standard loader names:
pc1 This is the standard first-stage (partition) loader on a PC.
pc2 This is the standard second-stage (QNX specific) loader on a PC.
Along with these two standard loaders, we also provide loader variants named
pc1-flop and pc2-flop. These variants provide alternative loaders that are
designed to work with floppy diskettes (or a hard disk with a capacity less than 8
Gbytes in an old PC with an old BIOS).
Similarly, users who wish to create and use their own loaders can specify them using
unique variant names.
The device names for our loaders are prefixed with ipl-disk. So if you look in
/x86/boot/sys/ under QNX Neutrino, you will see the following loaders:
• ipl-diskpc1
• ipl-diskpc1-flop
• ipl-diskpc2
• ipl-diskpc2-flop
If you write your own loaders, make sure you use this ipl-disk prefix.
If the loader is in the /x86/boot/sys/ path, you don’t need to specify the ipl-disk
prefix on the command line because dloader adds it for you. If your loader is in a
different directory, you have to specify the exact path, including the prefix.
Assuming you specified a device and loader correctly, dloader opens the device in
the path you specified and, if you selected the verbose option, displays its disk and
partition information.
The specified loader data is then put together and written to the disk.
The floppy (-F] and hard disk (-H] override options let you force dloader to treat a
fixed device (e.g. a hard disk) as if it was a removable device (e.g. a floppy), and
vice-versa.

© 2010, QNX Software Systems GmbH & Co. KG. dloader
Examples:
To see a list of available disk loaders:
dloader
To write a PC partition loader to a hard disk:
dloader /dev/hd0 pc1
To write a custom partition loader to a hard disk:
dloader /dev/hd0 /home/joe/ipl-diskpc1-tst
To write a QNX-specific second-stage PC loader to a QNX partition:
dloader /dev/hd0t79 pc2
To write a QNX loader to a floppy disk :
dloader /dev/fd0 pc2-flop
QNX_TARGET The location of target backends on the host machine.
Exit status:
0 The loader was written to the disk.
Any other value An error occurred.
Errors:
When an error occurs, dloader sends a description of the error to stderr.
See also:
fdisk, dinit

dnssec-dsfromkey © 2010, QNX Software Systems GmbH & Co. KG.
DNSSEC Delegation Signer resource record generation tool
Syntax:
dnssec-dsfromkey [-v level] [-1] [-2] [-a alg] {keyfile}
dnssec-dsfromkey {-s} [-v level] [-1] [-2] [-a alg] [-c class] [-d dir]
{dnsname}
Runs on:
QNX Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-dsfromkey++NetBSD-current in the
Description:
The dnssec-dsfromkey utility outputs the Delegation Signer (DS) resource record
(RR), as defined in RFC 3658 and RFC 4509, for the given key(s). For more
information, see
http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-dsfromkey++NetBSD-current in the
See also:
dnssec-keygen, dnssec-signzone in the NetBSD documentation.

© 2010, QNX Software Systems GmbH & Co. KG. dnssec-keyfromlabel
DNSSEC key generation tool
Syntax:
dnssec-keyfromlabel {-a algorithm} {-l label} [-c class] [-f flag] [-k]
[-n nametype] [-p protocol] [-t type] [-v level] {name}
Runs on:
QNX Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-keyfromlabel++NetBSD-current in
the NetBSD documentation.
Description:
The dnssec-keyfromlabel utility gets keys with the given label from a crypto
hardware and builds key files for DNSSEC (Secure DNS), as defined in RFC 2535 and
RFC 4034. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-keyfromlabel++NetBSD-current in the
See also:
dnssec-keygen, dnssec-signzone in the NetBSD documentation.

dnssec-keygen © 2010, QNX Software Systems GmbH & Co. KG.
DNSSEC key-generation tool
Syntax:
dnssec-keygen {-a algorithm} {-b keysize} {-n nametype}
[-c class] [-e] [-f flag] [-g generator]
[-h] [-k] [-p protocol] [-r randomdev]
[-s strength] [-t type] [-v level] {name}
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-keygen++NetBSD-5.0 in the
Description:
The dnssec-keygen utility generates keys for DNSSEC (Secure DNS), as defined in
RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction
Signatures), as defined in RFC 2845. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-keygen++NetBSD-5.0 in the NetBSD
documentation.
See also:
dnssec-dsfromkey, dnssec-signzone in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. dnssec-signzone
DNSSEC zone-signing tool
Syntax:
dnssec-signzone [-a] [-c class] [-d directory] [-e end-time]
[-f output-file] [-g] [-h] [-k key] [-l domain]
[-i interval] [-I input-format] [-j jitter]
[-N soa-serial-format] [-o origin]
[-O output-format] [-p] [-r randomdev]
[-s start-time] [-t] [-v level]
[-z] {zonefile} [key...]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-signzone++NetBSD-5.0 in the
Description:
The dnssec-signzone utility signs a zone. It generates NSEC and RRSIG records
and produces a signed version of the zone. The security status of delegations from the
signed zone (that is, whether the child zones are secure or not) is determined by the
presence or absence of a keyset file for each child zone. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?dnssec-signzone++NetBSD-5.0 in the NetBSD
documentation.
See also:
dnssec-dsfromkey, dnssec-keygen in the NetBSD documentation

ds © 2010, QNX Software Systems GmbH & Co. KG.
Data server that maintains a shared state among processes
Syntax:
ds &
Runs on:
Neutrino
Options:
None.
Description:
The data server is a process that maintains a shared state among other processes — it’s
like a global environment. Processes can store or retrieve data using a set of data
server library calls. You can use it for many tasks, but specifically you can access it
from the Slinger webserver in support of dynamic HTML. The HTTP server slinger
makes use of the data server and the data server library.
Data is stored using variable names that represent buffers of data. All of the variables
are global, any process can access them (no attempt is made to restrict access), so only
one instance of the variable (name) can exist in the data server.
Data server library

The data server library consists of these functions, which are described in the Library
Reference:
ds_register() Register your application with the data server.
ds_deregister() Deregister your application with the data server.
ds_create() Create a data server variable.
ds_clear() Delete a data server variable.
ds_set() Set a data server variable.
ds_get() Get a data server variable.
ds_flags() Set the flags for a data server variable.
Examples:
Here’s a simple (and nonfunctional) example of monitoring the temperature of an oven
from a remote client:

© 2010, QNX Software Systems GmbH & Co. KG. ds
This example uses HTML as the interface to the data server, but the data server isn’t
limited to HTML.
Here’s what the qnxvar tokens on the client’s web page look like:




If the temperature of the oven is currently 500 degrees F, the output looks like:
The oven temperature is 500 degrees F.
Here’s what the application monitoring the oven looks like:

// This program obtains the temperature of an oven, and
// then updates a data variable in the data server, to
// be read by slinger if the appropriate token is in an
// html page slinger is serving.
#include <stdlib.h>
#include <stdio.h>
#include <ds.h>
#include <string.h>
#define MAXLEN 4
int main(void)
{
ds_t ds_descriptor;
char ovenID[7], oven_temp[MAXLEN], flag=0;
int length = MAXLEN;
ds_descriptor = ds_register();
if(ds_descriptor==-1){
perror("ds_register");
exit(1);
}
strcpy(ovenID,"oven1");
if(ds_create(ds_descriptor, ovenID, flag, 0)==-1){

perror("ds_create");
exit(1);
}
// Obtain the an initial temperature for the oven

// to initialize the data server variable. strcpy
// that value into oven_temp
ds_set(ds_descriptor,ovenID,oven_temp,length);
//Now let’s update the temperature at some time interval
while(1)
//you might want some kind of decision to exit the program.
{
//obtain the current temperature from the oven

ds © 2010, QNX Software Systems GmbH & Co. KG.
//strcpy that temp reading into the oven_temp variable
ds_set(ds_descriptor,ovenID,oven_temp,length);
//wait a predetermined amount of time
ds_clear(ds_descriptor,ovenID);
ds_deregister(ds_descriptor);
The output HTML page reflects the current temperature stored in the data server.
When this process exits, the data server variable is no longer available because the flag
argument passed to ds_create() was 0.
If this application needs some data passed from HTML text, another variable is
created by calling ds_create() and is used to pass information to it by using the
qnxvar write token in some HTML text. The application gets the data by calling
ds_get() and/or react to the change in data by receiving a proxy or signal.
Here’s what’s happening:
Oven Data
Slinger
control server
SSI token
5:24
Remote
client
Oven
The oven
temperature
is 350
degrees F.
HTML page
Monitoring an oven via the data server.
In summary:
• Use the qnxvar read token to display a value on the HTML page and use
ds_get() to get the data server variable.
• Use the qnxvar write token to change a variable on the data server process and
use ds_set() to set the data server variable.

© 2010, QNX Software Systems GmbH & Co. KG. ds
For information about the qnxvar token, see slinger.
See also:
slinger
ds_clear(), ds_create(), ds_deregister(), ds_flags(), ds_get(), ds_register(), ds_set()
in the Library Reference
Setting Up an Embedded Web Server in the Neutrino User’s Guide

du © 2010, QNX Software Systems GmbH & Co. KG.
Estimate disk space usage (POSIX)
Syntax:
du [-a|-s] [-kpqx] [file...]
Runs on:
Neutrino
Options:
-a Generate a report for each file in the directory tree. If you don’t specify this
option, du makes a report for each directory only. The report shows the total
space allocated to all files under the directory, including the directory itself.
-k Report the space figures in Kbytes (the default is 512-byte blocks).
-p Report the space figures in bytes (the default is 512-byte blocks). Also, ensure
that du generates error messages when it can’t process existing files (unless the
-q option is specified).
-q Be quiet; suppress error messages when du can’t provide statistics on files, or

can’t read directories.
-s Give the total figures for each of the specified files, rather than the totals for
any subdirectories.
-x Don’t span device boundaries (used to determine how much space on a

particular device is consumed by a directory tree).
file The pathname of a file whose size is to be displayed. If you don’t specify any
files, the current directory is used; du behaves as if the filename dot (.) were
given.
Description:
The du utility prints the amount of file space allocated to the specified files. If you
name a directory, all files in that directory are reported; subdirectories are traversed
recursively. If a file has multiple links, the space allocated to that file is counted only
once.
The space figures are displayed in 512-byte blocks by default. If you want du to print
the size in bytes, specify the -p option. The sizes output by du when you specify the
-p option are accurate with one exception: the numbers may be slightly higher than
expected because they include extent blocks that are part of filesystem overhead
associated with the file, but don’t contain actual data.
If you specify nondirectories, they aren’t listed unless you specify the -a option.
All results are written to the standard output. Errors may result in diagnostic messages
to the standard error. Standard input isn’t used.

© 2010, QNX Software Systems GmbH & Co. KG. du
Examples:
Estimate disk space consumed by the contents of /tmp, in kbytes:
du -k /tmp
Estimate the total space occupied by the contents of the current directory:
du -s
Exit status:
>0 An error occurred. This doesn’t include failure to read files or directories.

dumpefs © 2010, QNX Software Systems GmbH & Co. KG.
Dump an embedded filesystem
Syntax:
dumpefs [-tuv] embedded files
Runs on:
Options:
-t Dump the “text” of each extent.
-u Output a unit summary, including the size of the filesystem, and the amount
and percentage of space used.
-v Be verbose.
Description:
The dumpefs utility dumps the contents of an embedded filesystem.
See also:
dumpifs, mkefs
Making an OS Image chapter of Building Embedded Systems

© 2010, QNX Software Systems GmbH & Co. KG. dumper
Dump the postmortem state of a program (QNX)
Syntax:
dumper [-d path] [-m] [-n] [-p pid] [-s size[G|M|K]]
[-v] [-w] [-z level] &
Runs on:
Neutrino
Options:
-d path The name of the directory in which to write postmortem dump
files. The default is your home directory.
-m Don’t dump memory.
-n Save sequential dumps. Each dump is saved in a file whose name

is in the form:
executable.num.core
where num starts at 1 and increases until the filename doesn’t
already exist.
-p pid Save a dump file for this process immediately, and then exit
dumper.
-s size[G|M|K] Set the maximum core size, in bytes.
-v Be verbose.
-w Make core files world-readable.
-z level Use gzip to compress the core files. The compression level must
be in the range from 1 (fastest) through 9 (best compressed).
Description:
The dumper utility runs in the background and provides a postmortem dump service
for all processes. Whenever a program terminates abnormally, a dump of the current
state of the program is written to disk. The dump filename is the same as the program
name with a .core extension. For example, if the program name is experiment, the
dump is written to experiment.core in your home directory.
On a QNX Momentics system, dumper starts with dumper -d /var/dumps.
You can use the -d option to force all dumps into a directory other than /var/dumps.

dumper © 2010, QNX Software Systems GmbH & Co. KG.
Dump files can be large, so make sure the destination filesystem has lots of space.
The -p option lets you get a dump immediately for a particular process. If you specify
-p, dumper doesn’t run in the background, but exits right away.
You can use a debugger such as gdb to examine a dump file:
gdb program_binary program_core
For example:
gdb /usr/photon/bin/pterm /var/dumps/pterm.core
A program may terminate in one of two ways: it may exit cleanly under its own
control, returning an exit status, or it may be forcibly terminated by the receipt of a
signal that it isn’t prepared to handle. In the latter case, dumper writes a dump file for
the following set of signals:
Signal Description
SIGABRT Program-called abort function
SIGBUS Parity error
SIGEMT EMT instruction
SIGFPE Floating-point error or division by zero
SIGILL Illegal instruction executed
SIGQUIT Quit
SIGSEGV Segmentation violation
SIGSYS Bad argument to a system call
SIGTRAP Trace trap (not reset when caught)
SIGXCPU Exceeded the CPU limit
SIGXFSZ Exceeded the file size limit
You can force the dump of a running program by setting one of the preceding signals,
assuming that the program isn’t masking or handling the signal itself. For example, to
force a dump using the kill command and a process ID (pid):
kill -SIGABRT pid
To force a dump using the slay utility and the process name:
slay -s SIGABRT process_name

© 2010, QNX Software Systems GmbH & Co. KG. dumper
Examples:
Start dumper, with dump files to be written to the default directory:
dumper &
Start dumper, with dump files to be placed in the directory /home/dumps:
dumper -d /home/dumps &
Files:
/proc/dumper A special entry in the /proc filesystem (see procnto*) that
receives notification when a process terminates abnormally.
Exit status:
The dumper utility normally doesn’t terminate. However, it may terminate if it
encounters an error on startup (for instance, if it wasn’t run by root) or if it receives a
signal.
0 A signal was received and dumper shut down successfully.
1 An error was encountered on startup (not run by root or bad command-line

options).
See also:
coreinfo, gdb, kill, slay

dumpifs © 2010, QNX Software Systems GmbH & Co. KG.
Dump an image filesystem
Syntax:
dumpifs [-f file] [-m] [-vxb -u file] image [files]
Runs on:
Options:
-b When using the -x option, extract to the basenames of the files.
-f file Extract named file.
-m Display MD5 Checksum.
-u file If the image is compressed, put an uncompressed copy in file.
-v Verbose operation. Specify more than one v to display more information.
-x Extract the files specified after the image. If you also specify -b, the files
are put into the current directory; if you don’t specify -b, the files are
extracted to the pathname specified in the image.
Description:
The dumpifs utility dumps the contents of an image filesystem. It can also be used to
extract files from the image filesystem.
Examples:
$ dumpifs shell.ifs
Offset Size Name
0 288 *.boot
288 100 Startup-header flags1=0x1 paddr_bias=0
388 6008 startup.*
6390 59 Image-header mountpoint=/
63ec 1ac Image-directory
---- ---- Root-dirent
6598 8c proc/boot/data1
6624 5c proc/boot/.script
6680 14 proc/boot/data2
7000 2c02c proc/boot/procnto
34000 12ad0 proc/boot/devc-con
47000 b66c proc/boot/esh
53000 d7fc proc/boot/ls
61000 7394 proc/boot/cat
Checksums: image=0x6d5fb484 startup=0x274d7c89

© 2010, QNX Software Systems GmbH & Co. KG. dumpifs
Caveats:
This utility will not work on an image that has been built using a filter such as srec
(for more information on image filters, see mkifs). If you wanted to run dumpifs on
such an image, you would build the image omitting the filter stage in your mkifs
build file (you would then need to run the filter by hand later in order to make a viable
image for your target).
See also:
mkifs

© 2010, QNX Software Systems GmbH & Co. KG. echo
Write arguments to standard output (POSIX)
Syntax:
echo [-n] [string...]
Runs on:
Options:
-n Don’t write a trailing newline character.
string A string to be written to standard output.
Description:
The echo command is present both as a shell builtin (see the echo command for ksh)
and as a standalone executable that can operate without the availability of the system
shell. Both versions behave in a similar manner. To make sure you use the executable,
specify the full path.
The echo utility writes its arguments, followed by a newline character, to standard
output. If there are no arguments, only the newline character is written.
The echo utility supports the following escape sequences within string:
Escape Description
\a Write an alert character (the bell).
\b Write a backspace character.
\c Suppress the newline character that otherwise follows the final argument
in the output. All characters following the \c in the arguments are
ignored.
\f Write a formfeed character.
\n Write a newline character.
\r Write a carriage-return character.
\t Write a tab character.
\v Write a vertical tab character.
\\ Write a backslash character.
\0num Write an 8-bit value that’s the ASCII character represented by the
specified 1-, 2-, or 3-digit octal number num.

echo © 2010, QNX Software Systems GmbH & Co. KG.
The escape sequences listed above are extensions to POSIX. For a more versatile
utility that’s portable, see printf.
Examples:
Echo the string Hello, Mother\nHello, Father to the standard output (note that
echo appends a final trailing newline):
$ echo ’Hello, Mother\nHello, Father’

Hello, Mother
Hello, Father
$
Exit status:
See also:
cat, ksh, printf, sh

© 2010, QNX Software Systems GmbH & Co. KG. ed
Text editor
Syntax:
ed [-] [-sx] [-p string] [file]
Runs on:
QNX Neutrino
Options:
-s Suppress diagnostics. Use this option if the standard input to ed is from
a script.
-x Prompt for an encryption key that will be used for reads and writes.
-p string Specify a command prompt.
Description:
The ed utility is a text editor.
See also:
elvis, ped, qed, vi

egrep © 2010, QNX Software Systems GmbH & Co. KG.
Extended regular expression grep (UNIX)
Syntax:
egrep [-cilnqsvx]
[-e expression | -f expression_file]...
[file...]
egrep [-cilnqsvx] expression [file...]
Runs on:
Options:
See grep for a complete listing.
Description:
The egrep utility does an extended regular expression grep (equivalent to grep -E).
See the documentation for grep for details.
Exit status:
0 Lines were found matching the expression provided.
>0 An error occurred or no matching lines were found.
See also:
grep

© 2010, QNX Software Systems GmbH & Co. KG. elvis
Visual interface editor clone (UNIX)
Syntax:
elvis [options]... [+command] file...
Runs on:
Neutrino
Options:
-c command Begin editing by executing this ex command.
-e Start up in colon (ex) command mode.
-f Force nonregular files (directories or device special files) to be

opened. By default, elvis refuses to open nonregular files.
-i Start up in input mode.
-m [file] Scan file for errors and position the cursor at the offending line
number. If you don’t specify file, errlist is used.
-R Set read-only mode to prevent accidental overwriting of files.
-t tag Start editing at the given tag. (See the ctags utility.)
-v Start up in visual command mode.
+command Begin editing by executing this ex command.
file A pathname of a file to be edited.
Description:
The elvis utility is an interactive fullscreen editor that is compatible with the
Unix/POSIX vi editor. The vi utility in QNX Neutrino is a link to elvis.
In elvis, changes are buffered and are written to the file only upon request. Since a
temporary file is used for storage, elvis can edit files larger than the amount of
memory available on the machine it’s run on.
There are two major command modes:
• visual mode
• ex mode (also known as colon mode)
You can switch between modes. You’ll probably use the visual command mode most
of the time. This is the mode elvis normally starts up in.
In visual mode, the entire screen is filled with lines of text from your file (except the
last screen line, which is reserved for status). You can view text and move around the

elvis © 2010, QNX Software Systems GmbH & Co. KG.
file. Each keystroke is interpreted as part of a visual command. If you start typing text,
it isn’t inserted; instead, it’s treated as part of a command. To insert text, you must first
give an “insert text” command (see “Inserting text”).
The ex mode is quite different. In this mode, elvis displays a “:” character on the
bottom line of the screen as a prompt. You are then expected to type in a command
and press Enter. The set of commands recognized in ex mode differs from those in
visual mode, and are known as ex commands. A summary of these commands is
found at the end of this description. (A line-oriented editor, ex is a predecessor of vi,
and the two share common functionality.)
The capabilities of elvis are described throughout the following sections:
• Visual mode
- Input mode
- Operators
- Special cases
- Named buffers
• Movement commands
- Cursor movement
- Marking
- Tags
• Inserting text
- Input mode
• Deleting, yanking, putting
• Filters
• Shifting text
• Miscellaneous commands
• Searching
• Global & substitute commands
• Undo and retrieving
• Screen commands
• Writing files
• Editing other files
• Reading in a file
• Leaving elvis

• Escaping to a shell
• Macros
• Abbreviations
• Options
• ex commands
Visual mode
Most visual mode commands are one keystroke long. The following sections list the
operation performed by each keystroke, and any necessary options or operands.
Most commands may be preceded by a decimal number. Usually, this number
specifies how many times the command is to be repeated. Without this number, the
command in most cases executes just once.
Input mode
You can’t enter text into your file directly from visual command mode. Instead, you
must first give a command that puts you into input mode. The commands to do this
are:
A, C, I, O, R, S,
a, c, i, o, s
Visual command mode looks a lot like text input mode. If you forget which mode
you’re in, just press Esc. If elvis beeps, you’re in visual command mode. If elvis
doesn’t beep, you were in input mode — by pressing Esc you switch to visual
command mode. One way or another, after you press Esc, elvis is ready for a
command.
Note that if the showmode option is set (this option described in the “Options” section
below), the mode is displayed in the lower right-hand corner as either Command or
Input. Also note that each mode uses a different cursor shape.
Operators
Among its various commands, elvis has seven basic but powerful operators that let
you change, delete, cut, paste, shift, or filter text regions. Although they’re described
below in the appropriate sections, you should note that, for the most part, they all share
a common form:
op<object>
Where op can be:
c Change
d Delete

y Yank (copy)
> Shift right
< Shift left
! Filter
One operator doesn’t take an object:
p Put
The object operand specifies the range of text that the op operator acts upon. The
object can be any movement command or pattern search. (See “Movement
commands.”) In this way, you can see the power of the operators. The elvis utility
can act on words, sentences, regions up to a specified pattern — whatever range the
object operand specifies.
When you give a movement command as an operand, you can specify an optional
count [n] to multiply the effect of the operand (e.g. d2w to delete next two words).
When a count isn’t provided, it typically defaults to 1.
Special cases
Operators are frequently used with lines. So, for simplicity, a few special forms of
these commands operate only with line objects. The following list shows the syntax of
these special forms. Note the count is optional, and precedes the operator (this differs
from the above form):
[n]cc Change n lines
[n]dd Delete n lines
[n]Y
[n]yy Yank n lines
[n]<< Shift n lines to the left
[n]>> Shift n lines to the right
Named buffers
When you yank, delete, change, shift, or filter text, elvis saves the affected region in
a single unnamed cut buffer, which you can recall by the p (put) command. However,
elvis also has 26 named buffers, a to z, that you can use to save blocks of text during
an editing session. These buffers are often used when editing multiple files to move
text around.
You can prefix the previously defined operator forms by "a through "z (represented
below by "<a-z>) to indicate which cut buffer to use to store the modified text region:

"<a-z>op<object>
Normal cases.
"<a-z>[n]op Special cases.
When you use the uppercase letters to denote the named buffers, the objects are
appended to the buffer:
"<A-Z>op<object>
Normal cases.
"<A-Z>[n]op Special cases.
Movement commands
The following movement commands provide a convenient means to position the
cursor throughout the file being edited. You can precede most by an optional count to
repeat the action. More importantly, you can use these movement commands as
operands to the change, yank, delete, put commands to specify the range of action to
be performed (see “Inserting text” and “Deleting, yanking, putting” sections).
The movement commands operate on the following text objects:
Character A single character.
Sentence A sequence of text ending in one of the following characters, followed

by two spaces or a newline:
. ! ?
Paragraph A paragraph starts after an empty line or any of the pairs of characters
defined with the :set pa= option are found.
Section A section starts where any of the pairs of characters defined with the
:set se= option are found.
Cursor movement
To move the cursor, you can use the keypad arrow keys; you can also use the H, J, K,
and L keys.
[n]j
[n]down-arrow
[n]Ctrl-J
[n]Ctrl-N Move down n lines (next).
[n]k
[n]up-arrow
[n]Ctrl-P Move up n lines (previous).

[n]l
[n]right-arrow
[n]Space Move right n characters.
[n]h
[n]left-arrow
[n]Backspace Move left n characters.
[n]- Move to first nonblank character on nth line, in backward direction.
[n]+ Move to first nonblank character on nth line, in forward direction.
[n]$ Move to the end of the line.
ˆ Move to the beginning of the first word on the line.
0 Move to the left margin (first nonblank character) of current line.
[n]| Move to the column specified by n.
[n]w Move to the beginning of the next word.
[n]W Move to the beginning of the next word that follows white space.
[n]b Move to the previous word.
[n]B Move to the previous word that’s delimited by white space.
[n]e Move to the end of the word.
[n]E Move to end of the word that’s delimited by white space.
[n]G Move to the specified line (default is last line of file for a single G
command).
[n]f<char> Move to the nth occurrence of char (in forward direction) on the
current line. The cursor is placed at the matched character.
[n]F<char> Move to the nth occurrence of char (in backward direction) on the
current line. The cursor is placed at the matched character.
[n]t<char> Move to the nth occurrence of char (in forward direction) on the
current line. The cursor is placed just before the matched character.
[n]T<char> Move to the nth occurrence of char (in backward direction) on the
current line. The cursor is placed just before the matched character.
[n]; Repeat previous f, F, t, or T command, in the same direction.
[n], Repeat previous f, F, t, or T command, in the opposite search

direction.
% Move to matching parenthesis, bracket, or brace; i.e.: ( ) [ ] {

}

[n]) Move to the beginning of the next sentence.
[n]( Move to the beginning of the current sentence.
[n]} Move to the beginning of the next paragraph.
[n]{ Move to the beginning of the current paragraph.
[n]]] Move to the beginning of the next section.
[n][[ Move to the beginning of the current section.
[n]H Move to the top left position of screen. If n is specified, move the
cursor to the beginning of the line n lines from the top of the
screen.
[n]L Move to the beginning of the last line on screen. If n is specified,

move the cursor to the beginning of the line n lines from the
bottom of the screen.
M Move to the beginning of the middle line on the screen.
Marking
m<a-z> Mark the current position with the character <a-z>.
’<a-z> Move to the beginning of the marked line.
‘<a-z> Move to the exact position marked with the character <a-z>.
’’ Move back to the beginning of the line where it was before the last
“nonrelative” move.
‘‘ Move back to the exact position it was before the last nonrelative move.
Tags
Tags can’t be included as <object> operands for commands such as change, yank, put,
delete, shift, and filter.
:ta tag Edit the file containing tag. Position at tag.
Ctrl-] The word at the cursor position is taken as the tag, and the editor finds the
word as with the :ta command.
Inserting text
The following commands enter input mode, where the text you enter (until you press
Esc) is put into the file:
a Append text after the current cursor position.

A Append text at the end of current line.
i Insert text before the current cursor position.
I Insert text at beginning of current line.
o Open a new line below line cursor is on, insert text there.
O Open a new line above line cursor is on, insert text there.
c<object> Change the text between the current position and the position specified
by the <object> (movement operand or pattern). You can specify an
optional count to multiply the effect of the <object> operand (e.g. c2w
to change next two words).
If the range is within the current line, a $ is displayed at the end of the
<object> to indicate end-of-range. Otherwise, the text in the range is
deleted and you’re placed in input mode. When within a line, the
specified range of text isn’t deleted until you type Enter.
[n]cc Change n lines.
R Replace the rest of the line with text. Rather than delete the text as with
the change command, before going into insert mode, all text entered
overwrites the current line until it has been completely replaced; at that
point you’re placed in input mode.
s Substitute text for the current character (abbreviation for cl).
S Substitute text for the current line (abbreviation for cc).
Input mode
In input mode, all keystrokes are inserted into the text at the cursor’s position, except
for the following:
Esc
Ctrl-[ Exit from input mode, back to command mode.
INTR Interrupt execution (usually Ctrl-C, see stty).
erase
Ctrl-H Erase the character before the cursor.
Ctrl-W Erase the last input word.
Ctrl-A Insert a copy of the last input text.
Ctrl-D Delete one indentation character.
Ctrl-L Redraw the screen.

Ctrl-M
Enter Insert a newline.
Ctrl-P Insert the contents of the cut buffer.
Ctrl-R Redraw the screen (like Ctrl-L).
Ctrl-T Insert an indent character.
Ctrl-U Backspace to the beginning of the line.
Ctrl-V Insert the following keystroke, even if special (e.g. Ctrl-V Ctrl-L inserts a
form-feed).
Deleting, yanking, putting

As mentioned in the introduction, elvis supports very powerful operator constructs.
In this section we describe the delete, yank, and put operators.
Delete Delete the specified region and place the text into the unnamed buffer, or a
named buffer if one is specified.
Yank Make a copy of the specified region and place it into the unnamed buffer, or
a named buffer if one is specified.
Put Put the contents of the unnamed buffer, or of the named buffer if specified,
into its new location.
When you have a sequence of text you want to copy or move to a different location,
you first use the yank or delete operators to copy or delete the data into a buffer; you
then use the put command to place the data at its new location.
If you’re using named buffers, you can switch to another file before putting the text
back. Thus you can copy from one file to another.
To copy the next four lines, yank them with a command such as 4yy or y4j, move to a
new location and put the text by typing the p command.
To delete the next four lines, type 4dd or d4j.
To move the next four lines, use a command such as 4ddor d4j, then move to a new
location and put the text by typing p or :pu.
Filters
With the filter command, you can select regions of text and run them through any
command and insert the output into the file. The text in the range specified from the
current line to the delimited <object> is filtered through the command and replaces the
region specified. The text that was in the region before being replaced by the output of
the command is saved in the unnamed buffer, or in a named buffer if one was
specified. If uppercase letters are used, elvis appends text to the named buffer.

!<object>command
Delete the specified text object into a buffer (unnamed, or named if given). Pass
the specified text region to the standard input of the command, and replace it
with the command’s output. When you enter this command, the ! prompt
doesn’t appear until an <object> has been given.
Shifting text
The shift operators, < and >, shift all the lines delimited by the current line and the
<object> operand. Text is shifted by the value of the shiftwidth option (see below).
The forms of the shift command are:
><object> Shift <object> to the right.
<<object> Shift <object> to the left.
[n]>> Shift next n lines to the right.
[n]<< Shift next n lines to the left.
Named buffer prefixes don’t work with the shift operator.
Miscellaneous commands
[n]. Repeat last text modifying command n times.
[n]r<char> Replace current character with char.
D Delete to the end of the line (abbreviation for d$)
[n]J Join the next line with the current line.
:[x,y]j Join all the lines in the specified range.
[n]x Delete n chars, to the right, including cursor position.
[n]X Delete n chars to the left of the cursor.
[n]˜ Reverse the case of the n next characters.
:[x,y]p Display text in the specified range.
:[x,y]l Display text in the specified range with tab and end-of-line markers.
:[x,y]nu Display text in the specified range, with line numbers.
:so file Read and execute the commands listed in file.
:ve Display version number and compilation date of elvis.

Searching
A pattern used for searching and substituting is called a regular expression. While
most characters match themselves in a search request, some have special meaning, as
described in the table below. To be used in a search expression, these special
characters must be preceded by a backslash (\).
Character Meaning
ˆ Match “beginning of line”.
$ Match “end of line”.
. Match any single character except the newline.
\< Match the beginning of a word.
\> Match the end of a word.
[string] Match any single character in string.
[ˆstring] Match any single character not in string.
[x-y] Match any character between x and y (range).
[ˆx-y] Match any character not between x and y (range).
* Match any repeated characters.
\ Escape special characters.
The commands for searching are as follows:
/[pattern]Enter Search forward for pattern.
?[pattern]Enter Search backward for pattern.
/[pattern]/{+|-}nEnter
Go to the nth line relative to the line on which pattern is found,
in forward direction.
?[pattern]?{+|-}nEnter
Go to the nth line relative to the line on which pattern is found,
in backward direction.
/Enter Repeat the previous pattern search, in forward direction.
?Enter Repeat the previous pattern search, in backward direction.
n Repeat the previous pattern search.
N Repeat the previous pattern search, in reverse direction.
For example, to match fred1, fred2, or fred3:

/fred[1-3]
To match QNX Neutrino at the beginning of a line:
/ˆQNX Neutrino
To match QNX Neutrino at the end of a line:
/QNX Neutrino$
Global & substitute commands

The global and substitute commands can operate over a range of lines. You can
specify a range wherever [x,y] is indicated. The first element, x, indicates the first
line of the range, and the second element, y, indicates the last line. You can use line
numbers or any of the following special characters as range elements:
. The current line.

$ The last line in the file.
% Same as 1,$ (i.e. the entire file).
n Relative offset from current line.
A range element may also be a pattern specification:

/pattern/
or a marked location:
’<a-z>
For example, to print the lines from the next line containing steve until the first
subsequent blank line:
/steve,/ˆ$/!lp
Substitute command
The substitute command substitutes text matching a pattern with replacement text:
:[x,y]s/pattern/replacement_text/[c][g][p]
If none of the modifiers c, g, or p is specified, this command replaces the first
occurrence of the given pattern. You can modify this behavior by specifying any
combination of the three modifiers:
c Prompt before replacing.

g Replace all matched occurrences on a line.
p Display all lines containing the replaced text.
This command is very powerful when used in conjunction with the global command
(see below).

Global command
The global command searches through the lines of the specified range — or through
the whole file if no range ([x,y]) is specified — for lines that contain the pattern. The
command is performed on each matching line. The global command is of the
following form:
:[x,y]g/pattern/command
Execute command for every line that matches pattern.
:[x,y]g!/pattern/command
:[x,y]v/pattern/command
Execute command for every line that doesn’t match pattern.
You can combine the substitute and global commands, using the following syntax:
[x,y]g/pattern/s//replacement_text/
This command runs the substitute command on every occurrence of a matched pattern
within the given range. The null pattern specification (i.e. //) indicates to the
substitute command that it’s to use the currently matched global pattern as the text it’s
to replace.
The following variations may also be used:
[x,y]g!/pattern/s//replacement_text/
[x,y]v/pattern/s//replacement_text/
For example, substitute the word fred with the word barney in lines 1 to 10:
1,10g/fred/s//barney
Match every mary that’s at the beginning of a line and prompt the user to confirm the
substitution:
1,$g/ˆmary/s//dave/c
Undo and retrieving

On occasion, you need to undo the effects of a command:
u Undo the effects of the last command that changed the edit buffer.
U Undo the effects of all the text modifying commands performed on this line.
Return the line to its original state.
The editor saves the last nine deleted blocks of text in save buffers. You can retrieve a
buffer with the following commands:
" np Retrieve nth previous deletion (1-9). Place after the cursor.

" nP Retrieve nth previous deletion (1-9). Place before the cursor.
If you accidentally select the wrong buffer, you can use the undo command to clear it
and then try specifying a different buffer.
You can also use named buffers (see “Deleting, yanking, putting”):
"<a-z>p Retrieve the contents of the named buffer. Place after the cursor.
"<a-z>P Retrieve the contents of the named buffer. Place before the cursor.
Screen commands
The scrolling commands are as follows:
[n]Ctrl-D Scroll down n lines (default is half page). n is remembered and

becomes the default.
[n]Ctrl-U Scroll up n lines (default is half page). n is remembered and becomes

the default.
[n]Pg Dn
[n]Ctrl-F Jump forward n pages.
[n]Pg Up
[n]Ctrl-B Jump backward n pages.
[n]Ctrl-E Scroll down n lines.
[n]Ctrl-Y Scroll up n lines.
To position the current line at different positions on the screen by scrolling

forward/backward:
z. Place line at center of screen.
z- Place line at bottom of screen.

Ctrl-L
Ctrl-R
Redraw the screen.
The status commands are as follows:
Ctrl-G
:f Display status line on bottom of screen.

Writing files
The following commands write to a file. You can precede all w commands by an [x,y]
range. For example, specify 1,6w to write the first 6 lines.
:w Write changes to current file.
:w file Write changes to file.
:w >>file Append changes to file.
:w! file Force write to file.
:wq Write the file and exit.
ZZ OR :x Exit elvis. If any changes were made, the edit buffer is written to the
file.
Editing other files

:e file Edit file.
:e! Re-edit current file, discarding unsaved changes.
:e! file Edit file, discarding unsaved changes to the current file.
:e +n file Edit file, start at line n.
:e #
Ctrl-ˆ Return to the previous position in the last edited file.
:n Edit the next file in the argument list.
:n! Edit the next file, discarding unsaved changes to the current one.
:n args Use this new argument list.
:args Show list of files, [] indicate current file.
:rew Rewind list of files, re-edit first file.
:rew! Rewind the list of files, re-edit the first file, and discard any unsaved
changes to the current file.
See also the :ta (tags) movement command.
Reading in a file
:r file Read in file after the cursor.
:nr file Read in file after line n.
:r !cmd Read in the output of the named command.

Leaving elvis
ZZ or :x Exit elvis. If any changes were made, the edit buffer is written to the
file.
:wq Write the file and exit.
:q Exit from elvis.
:q! Exit from elvis and discard any unsaved changes.
:Q Escape to the ex line editor (to return, type elvis).
Escaping to a shell
To execute a single command from within elvis, you can use the following
command:
:!cmd Execute a single command, then return to elvis.
To execute more than one command, you can create a shell:
:sh Start a subshell. You can type Ctrl-D or exit to return to elvis.
Macros
Macros let you bind a single key to an arbitrary set of editing commands.
Defining a macro is simple: you define an lhs (left-hand side), which is the single
character you want translated, followed by an rhs (right hand side), which is the
sequence it is mapped into.
:map lhs rhs Create macro.
:unmap lhs Delete macro.
:map Display macros.
For example, :map q :wqCtrl-VEnterEnter maps q into :wqEnter. The Ctrl-V is

needed to quote (escape) the first Enter, while the second Enter ends the map
definition.
Abbreviations
Word abbreviations are similar to macros, but they expand a short word into a longer
word or words. If you type the abbreviation as part of a longer word, it’s left alone.
Abbreviations are used in input mode primarily to save typing.
Substitution isn’t performed until you type a nonalphanumeric character to mark the
end of the word. If you type Ctrl-V before the nonalphanumeric character, elvis
doesn’t perform the substitution.

:ab abbr replacement_text

Create an abbreviation.
:ab Display abbreviations.
:una abbr Turn off this abbreviation.
For example:
:ab woof mary had a little ram
This inserts the text mary had a little ram whenever the word woof is typed.
Options
You can set or examine options via the colon command set. The values of options
affects the operation of subsequent commands.
There are three option types:
• those that toggle on or off; these are enabled by typing :set option and disabled
by typing :set nooption.
• those that expect a numeric value
• those that expect a string value; these are used by typing :set option=value
To print all the option settings, type:
:set all
For convenience, options have both a long descriptive name and a short name (shown
in parentheses below) that’s easier to type. You may use either interchangeably.
autoindent (ai) Default: noai

In input mode, if autoindent is on, each added line begins
with the same amount of leading white space as the line above
it. Without autoindent, added lines begin at column zero.
autoprint (ap) Default: ap

This option affects only ex mode. If this option is on, and either
the cursor has moved to a different line or the previous
command modified the file, elvis prints the current line.
autowrite (aw) Default: noaw

If you’ve made modifications to the current file then try
switching to another file, (e.g. :tag, or :next...), elvis
normally prints an error message and refuses to switch. If this
option is on, elvis writes the modified version of the current
file and switches to the new file.

directory (dir) Default: dir="/tmp"

elvis stores text in temporary files. This option lets you
control which directory those temporary files appear in. The
default is /tmp.
You can set this option only in a .exrc file; once elvis is
started, the directory can’t be changed.
If your /tmp directory is on ramdisk, recovery isn’t possible if the system is rebooted.
edcompatible (ed)
Default: noed
Remember :s// options.
errorbells (eb) Default: eb

The elvis utility normally rings a bell when you do something
wrong. This option lets you disable the bell.
ignorecase (ic) Default: noic

Normally, when elvis searches for text, it distinguishes
between uppercase and lowercase letters. When this option is
on, uppercase and lowercase are seen as equivalent.
list (li) Default: noli

In nolist mode (the default), elvis displays text in a
“normal” manner — with tabs expanded to an appropriate
number of spaces, etc. However, sometimes it’s useful to have
tab characters displayed differently. In list mode, each tab is
displayed as Î, and a $ is displayed at the end of each line.
magic (ma) Default: ma

The search mechanism in elvis can accept regular expressions
— strings in which certain characters have special meaning.
The magic option is normally on, which causes these
characters to be treated specially. If you turn the magic option
off (:set noma), then all characters except ˆ and $ are treated
literally. Both ˆ and $ retain their special meanings regardless
of the setting of magic.
paragraphs (pa) Default: pa="PPppIPLPQP"

The { and } commands move the cursor forward or backward in
increments of one paragraph. Paragraphs may be separated by
blank lines or by a leading “dot” command of a text formatter.
Different text formatters use different dot commands. This
option lets you configure elvis to work with your text
formatter.

It’s assumed your formatter uses commands that start with a “.”
character at the front of a line, followed by a one- or
two-character command name.
The value of the paragraphs option is a string in which each
pair of characters is one possible form of your text formatter’s
paragraph command. For example, lines starting with .IP, .LP,
or .PP are considered new paragraphs.
readonly (ro) Default: noro

Prevent overwriting of original file. Normally, elvis lets you
write back any file for which you have write permission. If you
don’t have write permission, all you can do is write the changed
version of the file to a different file.
If you set the readonly option, elvis pretends you don’t have
write permission to any file you edit. This is useful when you
mean to use elvis only to look at a file, not to change it. This
way, you can’t change the file accidentally.
This option is normally off, unless you use the view alias of
elvis, which is like elvis except the readonly option is on.
report (re) Default: re=5

Changes, deletes, and yanks may affect many lines. For
commands affecting a lot of lines, elvis outputs a message
saying what was done and how many lines were affected. This
option lets you define what “a lot of lines” means. The default
is 5, so a message is shown on the status line for any command
affecting 5 or more lines.
scroll (sc) Default: sc=12

Scroll amount for Ctrl-U and Ctrl-D. These commands normally
scroll backward or forward by half a screenfull, but you can
adjust this. The value of this option says how many lines those
keys should scroll. You can also set this with [n]Ctrl-D and
[n]Ctrl-U.
sections (se) Default: se="NHSHSSSEse"

The [[ and ]] commands move the cursor backward or
forward in increments of one section. Sections may be
delimited by a { character in column 1 (which is useful for C
source code) or by means of a text formatter’s “dot” commands.
This option lets you configure elvis to work with your text
formatter’s section command, in exactly the same way that
the paragraphs option makes it work with the formatter’s
paragraphs command. For example, lines starting with .SH
or .NH are considered new sections.

shell (sh) Default: sh="/bin/sh"

When elvis forks a shell (perhaps for the :! or :sh
commands), this is the program it uses as a shell. The normal
default is /bin/sh. However, if you have set the SHELL
environment variable, the default value is copied from the
environment.
shiftwidth (sw) Default: sw=8
The < and > commands shift text left or right by a uniform
number of columns. The shiftwidth option defines that
uniform number. The default is 8 spaces.
showmatch (sm) Default: nosm
With showmatch set, every time you type ), }, or ] in input
mode, elvis momentarily moves the cursor to the matching
opening parenthesis or bracket.
showmode (smd) Default: nosmd
In visual mode, it’s easy to forget whether you’re in the visual
command mode, or input/replace mode. Normally, the
showmode option is off, and you aren’t informed as to which
mode you’re in. If you turn the showmode option on, a message
appears in the lower right corner of your screen, telling you
which mode you’re in.
tabstop (ts) Default: ts=8
The width of tab characters.
term (te) Default: te="$TERM"
This read-only option shows the name of the terminal entry that
elvis is using for your terminal.
warn (wa) Default: wa

If you’ve modified a file, but not yet written it back to disk,
elvis normally prints a warning before executing a :!cmd"
command. However, in nowarn mode, this warning isn’t given.
Normally, elvis also prints a message after a successful search
that wrapped at EOF. The [no]warn option also disables this
warning.
wrapmargin (wm) Default: wm=0
Wrap long lines in input mode. Normally (with
wrapmargin=0), elvis lets you type in extremely long lines.
However, with wrapmargin set to something other than 0
(wrapmargin=70 is nice), long lines are automatically
“wrapped” on a word break for lines longer than
wrapmargin’s setting.

wrapscan (ws) Default: ws

Normally, when you search for something, elvis finds it no
matter where it is in the file. elvis starts at the cursor position,
and searches forward. If elvis reaches EOF without finding
what you’re looking for, it wraps around to continue searching
from line 1, up to the current line.
If you turn off the wrapscan option (:se nows), and elvis
subsequently reaches EOF during a search, it stops and says so.
You can configure the option settings with the EXINIT environment variable:
EXINIT="set ai aw"
export EXINIT
ex commands
The following list of ex commands is intended for your convenience only. It’s beyond
the scope of this document to describe the operations of these commands in detail.
Most of these commands have been indicated as alternatives to the visual mode
commands described in the above sections.
The general form of these commands is:
:[x,y] command parameter
[Prefix] Command Short form

abbrev abbr text ab
[line] append a
args ar
[x[,y]] change c
[x[,y]] copy line co
[x[,y]] delete ["named_buffer] d
edit[!] file e
file f
[x[,y]] global /pattern/command/ g
[line] insert i
[x[,y]] join j
[x[,y]] list l
continued. . .

[Prefix] Command Short form

map lhs rhs map
[x[,y]] move line m
next[!] n
[x[,y]] number nu
[x[,y]] print p
[line] put ["named_buffer] pu
quit[!] q
[line] read file | !command r
rewind[!] rew
set [option] se
shell sh
source file so
[x[,y]] substitute /pattern/text/[c][g][p] s
tag ta
unabbrev abbr una
undo u
unmap lhs unm
version ve
visual vi
[x[,y]] write[!][[>>]file] w
xit[!] x
[x[,y]] yank ["named_buffer] ya
The following ex commands have no long version:
Command Form
escape !command
print next CR
lshift <
rshift >

Files:
/tmp/elv* During editing, text is stored in a temporary file in /tmp.
tags The tag database created by ctags and used by the :tags
command and the -t option.
$HOME/.exrc On startup, the contents of this file are executed as a series of ex

commands.
LINES, COLUMNS
Overrides the screen size values associated with your terminal type.
EXINIT Default elvis option settings. If set, the contents of this environment
variable are executed on startup as a series of ex commands.
The elvis utility requires that the TERM environment variable be set to indicate
your terminal type. For example, if elvis is running on a console, TERM should be
set as follows:
export TERM=qansi
or
export TERM=qnx
depending on the mode your console is running in (QNX vs ANSI).
Steve Kirkendall
Caveats:
When displayed, long lines scroll horizontally. On some implementations, these wrap
onto multiple rows on the screen.
Under QNX Neutrino, you must have a /tmp directory for temporary files. To use a
RAM disk as /tmp, try this:
ln -sP /dev/shmem /tmp
See also:
ctags, ed, ped, qed, sed, vi
Using Editors in the Neutrino User’s Guide
Linda Lamb, Learning the vi Editor, O’Reilly and Associates, 1990

enum-devices © 2010, QNX Software Systems GmbH & Co. KG.
Device-enumerator manager
Syntax:
enum-devices options
Runs on:
Neutrino
Options:
-c path Specify one or more configuration files. The path can either be a
single file, or the name of a directory:
• If a single file, enum-devices reads the contents of the file.
• If a directory, enum-devices reads the contents of all the files
contained in the directory.
You can repeat this option to specify multiple configuration files
and directories; you can also use a config clause in a
configuration file to include other files and directories (see below).
Before it starts processing, enum-devices concatenates the
contents of all the configuration files that you tell it to read.
-D Dump the device-lookup table.
-E enumerator Start the second-pass enumerator program.
-e enumerator Start the given enumerator command:

• enum-bootdev
• enum-legacy
• enum-par
• enum-pccard
• enum-pci
• enum-pnpbios
• enum-pnpisa
• enum-ser
-i prefix Ignore any configuration files in directories whose names start

with prefix.
-I suffix Ignore any configuration files in directories whose names end with
suffix.

© 2010, QNX Software Systems GmbH & Co. KG. enum-devices
-n Write the commands for starting the drivers to standard output

rather than executing them.
-v[v...] Operate verbosely. The more v characters, the more verbose the
output is.
Description:
This description of enum-devices includes the following sections;
• Overview
• Matching rules
• Configuration files
• Configuration file precedence
• Configuration file contents
Overview
The enum-devices manager enumerates the devices present on your computer. This
manager first reads the configuration files specified by any -c command-line options.
Next, the configuration manager queries its various enumerators to discover what
devices are on the system. It then matches these devices against the device IDs listed
in the configuration files. If the device matches, enum-devices executes the action
clauses associated with the device.
Programs that are spawned by any start and requires clauses aren’t actually
started until all processing is completed, so that any built-up command lines are
finished. If you want to perform an action regardless of what devices are present, use
the all device ID.
Matching rules
Matching behavior for enum-devices is based on the “number of matches” in the
enum-devices configuration file device statement. A secondary device statement
may be created by placing a period (“.”) in front of the match field.
This method for matching devices with entries in the enum-devices configuration
file can sometimes result in “ambiguities”: a specified device that matches more than
one entry in the enum-devices configuration file, rendering it impossible for the
enumerator to select the preferred driver for the device.
For example, with a device fully specified as:
ven=1922,dev=1234,busno=0,devno=1,
rev=100,msven=fe,mscomp=MTP,mssubcomp=0
and with the following in the enum-devices configuration file:

device(usb, ven=1922,dev=1234)
device(usb, class=08,proto=00)
the specified device matches both the entries in the configuration file.
This ambiguity can be removed by either extending the match criteria for the preferred
driver:
device(usb, ven=1922,dev=1234,class=08)
or by making one of the matching fields secondary; that is, by giving it a lower
precedence that the other fields:
device(usb, .class=08,proto=00)
A “catch all” (an action that matches any device) is produced by simply entering the
bus type for the device. For example:
device(usb)
echo("No match found for device ven=$(ven),
dev=$(dev), class=$(class), busno=$(busno),
devno=$(devno), cfg=$(cfg), iface=$(iface),
msven=$(msven), mscomp=$(mscomp),
mssubcomp=$(mssubcomp)" )
Configuration files
Configuration files in the etc/system/enum/ directory include:
• common — common drivers
etc/system/enum/devices/
Configuration files in the etc/system/enum/devices/ directory contain device

definitions; these files include:
• audio
• block
• bridge — definitions for PCI bridges

• char
• graphics
• input
• media — definitions for multimedia devices

• printer
• serial
• net

etc/system/enum/devices/usb/
Configuration files in the etc/system/enum/devices/usb/ directory include:
• default — definitions for unmatched USB devices
• net — USB net settings
• char — USB-to-serial dongles
• ipod — definitions for USB iPod devices
• mass — definitions for USB mass storage devices
etc/system/enum/include/
Configuration files in the etc/system/enum/include/ directory contain macro

definitions; they include:
• audio
• block
• isa-types
• par-class
• pccard-types
• pccard-vendors
• pci-class
• pci-vendors
• pnpbios-types
• net
• graphics
• usb-class
Configuration file precedence

The order of precedence for enum-devices configuration files is determined by one
or both of the following criteria:
• the order in which configuration files are passed via the commandline -c option
• file precedence order in the directory

If files are added to an enumeration directory after the enumeration utility has been
started, the enumerator picks up these files and assigns them a higher precedence than
currently existing files.
Given the complexity associated with adding and removing files and directories during
processing, QNX recommends that you:
• use a static directory and file configuration
• modify a single file in a higher precedence directory to override the behavior of

existing matches
Configuration file contents

A configuration file consists of statements for one or more devices. Each statement
contains clauses that you want to execute if enum-devices finds those devices on
your system.
The enum-devices configuration file is typically takes the following format:
/enum
common
/devices
default
net
mass
char
/include
usb-class
/overrides
mass
Anything after a number sign (#) until the end of the line is considered a comment.
Each statement is in this form:
device_id...
action_clause
.
.
.
The device_id is either the keyword all or any number of identifiers in this form:
device(bus_type[, specification]...)
The bus types include at least the following:
• none
• pci
• cardbus
• isa
• pcmcia

• pnpbios
• isapnp
• serenum
• lptenum
Each clause is a keyword, followed by any required arguments. The clauses include:
start Start a command.
requires Start a command if it isn’t already running.
driver Start a command as an individual driver if the device might be

removed.
mount Run the mount utility with the specified arguments.
enumerator Start a new bus enumerator.
set Set a macro.
append Add to a macro definition.
uniq Set a macro to a value that depends on whether or not a string is

found in an internal database.
waitfor Wait for a given pathname to appear.
echo Echo a string to a file.
tag Assign a name to a block of action clauses.
config Load additional configuration files or directories.
use Merge macro definitions.
The clauses are described in the sections that follow.
start clause
The start clause takes this form:

start[/wait] (system_command [, system_args] )
It runs the command and arguments specified by system_command. If you specify the
/wait option, the enumerator pauses until the command terminates.
If you specify system_args, the manager searches for a start clause with a
system_command that’s identical to this one, and appends system_args to its
command line. This is a useful way to start just one instance of a command, specifying
the arguments needed for all of the devices found.
For example, this clause:

start(spooler -d$(path), -P$(pnpstr))
says to start spooler -d$(path), but tells enum-devices that if it’s already
encountered this command, just append -P$(pnpstr) to it. (The $(...) notation is
for macro expansion; see the set clause, below.)
requires clause
The requires clause can be one of two forms:
requires[/wait] (system_command [, system_args] )

This form is similar to the start clause, but enum-devices checks to make
sure that the command isn’t already running on the system.
If you specify system_args, don’t forget the comma between system_command and
system_args; if you omit it, enum-devices doesn’t check to see if the command is
already running — it might start the command more than once.
For example, the /etc/system/enum/devices/net enumeration file
includes this line for the network devices that need io-pkt*:
requires($(IOPKT_CMD),)
requires[/wait] (@tag_string)
If you use this form, enum-devices searches all the pending action lines for
tag names of tag_name (see the tag clause) and executes them. This can be
useful when you need a certain ordering of various components.
If you specify the /wait option in either form, the enumerator pauses until the
command terminates.
driver clause
The driver clause looks like this:
driver[/wait] (system_command [, system_args] )
It’s similar to the start clause, but if the bus-enumerator process indicates that the
device might be removed, enum-devices starts an individual driver process for the
device (instead of tacking the system_args onto a previously specified driver for the
same device). If the bus enumerator indicates that the device has been removed, a
SIGTERM signal is sent to the driver process.
If you specify the /wait option, the enumerator pauses until the command terminates.

mount clause
The mount clause looks like this:

mount (mount_args [, umount_args] )
It spawns the mount command with the given mount_args arguments. If you specify
any umount_args, they’re passed to umount if or when the device is removed.
enumerator clause
The enumerator clause takes this form:

enumerator (enumerator_type)
It starts a new bus enumerator named enumerator_type.
set clause
The set clause takes this form:

set (macro_name, macro_definition)
This clause sets the definition of macro_name to be macro_definition. Whenever

enum-devices finds $(macro_name) in any of the configuration files, it substitutes
the macro_definition. For example:
set(DEVB_OPTIONS, cam quiet blk auto=partition)
You can recursively nest macros the way that you can in make.
append clause
The append clause looks like this:

append (macro_name, macro_definition)
This clause appends macro_definition to the definition of macro_name.
uniq clause
The uniq clause is in this form:

uniq (macro_name, uniq_name [, initial] )
This clause makes enum-devices search an internal database for the string
uniq_name:
• If it doesn’t find a matching entry, enum-devices adds uniq_name to the internal

database and sets macro_name to the initial value (which must be an integer).
• If enum-devices finds a matching entry, it sets macro_name to be 1 greater than
the last time it was used.
For example, you can use a uniq clause to keep track of how many instances of a
device you’ve found, so you can create a unique path for a device:
uniq(sernum, devc-ser, 1)
driver(devc-ser8250 $(SER_OPTIONS), "-u$(sernum) $(ioport),$(irq)")

waitfor clause
The waitfor clause looks like this:

waitfor (pathname [, timeout] )
This clause makes enum-devices wait for up to timeout tenths of a second for
pathname to appear. If you don’t specify timeout, enum-devices waits for 10
seconds.
echo clause
The echo clause takes this form:

echo (string [, output_file] )
It echoes string to output_file. If this is the first occurrence of an echo to the file for
this invocation of the configuration manager, enum-devices erases output_file
before doing the echo. For subsequent occurrences, enum-devices appends to the
file. If you don’t specify an output_file, the output goes to standard output.
tag clause
The tag clause looks like this:

tag (tag_string)
It gives the name, tag_string, to the subsequent block of action clauses. Use this
clause to indicate the commands to run when you use the second form of the
requires clause.
config clause
The config clause is in this form:

config (path)
It makes enum-devices load an additional configuration file or directory, as specified

by path. This clause works in the same way as the -c command-line option, except
that the specified pathname is relative to the configuration file that contains the clause.
use clause
The use clause looks like this:

use (device_list)
When enum-devices encounters this clause, it:
• merges the macro definitions in device_list with those of the device event that
caused the action clauses to be invoked (the device_list definitions have priority)
• searches the device database for a matching definition
• performs the action clauses for the matching definition.

Macros
When invoking an action-clause sequence, a number of of special macros are available
for expansion. What they are depends on the bus that the device is present on.
For PCI devices, the macros are:
$(ven) PCI vendor ID.
$(dev) PCI device ID.
$(index) PCI index.
$(busnum) PCI bus number.
$(function) PCI function number.
Bus-enumerator protocol
To handle the bus-specific aspects of device enumeration, enum-devices spawns
separate bus-enumerator programs. The standard output of these programs is
connected to a pipe that enum-devices reads from. As the bus enumerator does its
bus scan, it writes lines to standard output describing what it’s found. Each line must
be written to the pipe atomically. Each line starts with a one-character code (defined in
<hw/enumdata.h> in the form ENUMER_CODE_*) and is immediately followed by
the process ID of the bus enumerator.
Here are the lines that can be written for each C macro definition:
ENUMER_CODE_DEV_PERM
This line reports a permanently connected device (i.e one that will never be
removed while the system is running):
Dpid { macro=value }
A sequence of macro names and values follows the D code and pid. If there’s
more than one macro, separate them with spaces. These are available for
expansion in the action clauses that enum-devices invokes for the device.
You must define the following special macros because enum-devices uses
them to identify the device:
#define ENUMER_SYM_BUSTYPE "bus"
#define ENUMER_SYM_VENDOR "ven"
#define ENUMER_SYM_SUBVENDOR "dev"
#define ENUMER_SYM_CLASS "class"
#define ENUMER_SYM_SUBCLASS "subclass"
ENUMER_CODE_DEV_TEMP
This is similar to ENUMER_CODE_DEV_PERM, except that the device might be
removed while the system is running:

dpid { macro=definition }
In addition to the required macro definitions above, be sure to define:
#define ENUMER_SYM_REMOVAL_ID "removal_id"
The macro value should be a simple integer.
ENUMER_CODE_DEV_ACTIVE
This is similar to ENUMER_CODE_DEV_PERM, except that the indicated
device is already running on the system:
apid { macro=definition }
If another bus enumerator reports the device, its driver shouldn’t be started since
it’s already running.
ENUMER_CODE_DEV_REMOVED
This line is reported when a device is removed from a running system:
gpid { macro=definition }
The only required macro definition is the ENUMER_SYM_REMOVAL_ID from

above. The value should be the same integer that was used when the device was
originally reported. The enum-devices program uses it to figure out which
driver process to slay or which pathname to unmount.
ENUMER_CODE_BUS
This is used for reporting additional buses that need new enumerators started:
Bpid { macro=definition }
It has the same syntax and requirements as ENUMER_CODE_DEV_PERM.
ENUMER_CODE_SCAN_DONE
Write this line when the bus enumerator has finished scanning its bus:
Fpid
When all the bus enumerators started have written this line, enum-devices
invokes the required action clauses (note that ENUMER_CODE_BUS actions are
invoked immediately). If no devices may be added/deleted from the bus, the bus
enumerator should terminate after writing this line. If there are temporary
devices, it should remain running and write ENUMER_CODE_DEV_TEMP
and/or ENUMER_CODE_DEV_REMOVED events followed by another
ENUMER_CODE_SCAN_DONE as devices are inserted or removed.

ENUMER_CODE_ERROR
Write this line when the bus enumerator detects an error of some kind:
Epid error_message_text
The enum-devices manager displays the error_message_text displayed to the

user.
ENUMER_CODE_COMMENT
The enum-devices manager ignores this type of line. You can use it to provide
additional information when the bus enumerator is run standalone:
#pid comment_text
Examples:
Here’s a sample configuration file:
# prefixing generic commands
all
# so we can say "pci($(ATI), ....) for readability
set( ATI, 0x1234 )
echo( "starting configuration" )
# Start a hard disk driver

device(pci,1234,5678)
start( devb-ncr8 ncr8 pci=$(index) )
# Start a network driver (currently)

device(pci,0x1234,0x5678)
start( io-pkt-v4, -d speedo pci=$(index) )
# Start a network driver (with mount support)

device(cardbus,1234,5678)
requires( io-pkt-v4 )
start( mount, -T none -o pci=$(index) ne2000 /dev/if0 )
# Start a graphics driver (sorta :-)

device(pci,1234,5678)
echo( $(ven) $(dev) $(bus) $(device) $(function), /etc/devg.$(hostname) )
# postfixing generic commands

all
echo( "Completed configuration" )

• In the enum-devices configuration file, all text following a number sign (#) up to
the end of the line is a comment.
• The default enum-devices configuration files are for a standard x86 self-hosted
implementation. If you use enum-devices in another environment, you may need
to modify these default configuration files. For example, if only a subset of the
enumerators specified by the default enumerator clause are present on your target
system, you must remove from the configuration the enumerator clauses and the
associated device statements for the absent enumerators.
• The device enumerator doesn’t start devb-fdc by default. If your system has a
floppy drive, you can start the driver manually or uncomment the devb-fdc lines
in the /etc/system/enum/devices/block file.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. enum-usb
Enumerate devices on the USB bus
Syntax:
enum-usb [options]
enum-usb [options,]validate
Runs on:
Neutrino
Targets:
ARM, PowerPC, SH, x86
Options:
Options for enum-usb are separated by commas, with no whitespaces. They include:
cfg_file_path=pathname
pathname is the path to the enum-usb configuration file.
Default is /etc/enum-usb.conf.
check_MS_desc Query devices for Microsoft descriptor data. Default is off. See
“Microsoft descriptors” below.
iface_tbl_size=size
size is the maximum number of interfaces enum-usb will
manage at the same time. These interfaces can be on any
number of devices. Default is 50 interfaces.
USB_mgr_pathname=pathname
pathname is the path to the USB resource manager. Default is
/dev/io-usb/io-usb.
validate Validate the configuration file. If this option is used, enum-usb

will parse the configuration file, report any errors it encounters
in the file, then exit.
verbose=level Turn on verbose mode and output to stdout at the verbosity

level specified by level. When using enum-usb in combination
with enum-devices, you must also set the verbose options of
enum-devices for verbose statements to be available at the
console.

enum-usb © 2010, QNX Software Systems GmbH & Co. KG.
Description:
This description of enum-usb includes the following sections;
• Overview
• USB device information
• Behavior when enumerating a single USB device
• The enum-usb configuration file
• Using enum-devices with enum-usb
Overview
The enum-usb utility is a bus-enumerator program spawned by enum-devices to
handle USB-specific aspects of device enumeration.
Since enum-usb is spawned by enum-devices, enum-usb options are specified by
the enumerator clause in the enum-devices configuration files. For example:
enumerator("usb verbose=10,cfg_file_path=/etc/enum-usb.conf")
The default configuration file for the enumerator clauses is

/etc/system/enum/common.
The enum-usb utility scans the USB bus and writes a line describing each device
found to standard output (stdout). The device enumerator manager enum-devices
reads in the information from this stream and launch the drivers required to manage
the devices via the enum-devices configuration files.
When a USB device is removed from the system, enum-usb reports this removal to
enum-devices so that it can remove the drivers it launched for that device.
USB device information

enum-usb provides enum-devices the following information about interfaces on a
USB device:
• busno — the USB bus number
• cfg — the USB configuration the device is using
• class — the device or interface class
• devno — the USB device number
• did — the device ID
• iface — the USB interface number
• num_iface — the number of interfaces available for the selected USB device
configuration
• proto — the device or interface protocol

• rev — the device version

• subclass — the device or interface subclass
• vid — the vendor ID
See the enum-usb configuration file’s Set for additional information that enum-usb
can provide to enum-devices.
Microsoft descriptors
If the device (for example a PFS device) supports Microsoft descriptors, enum-usb
provides the following additional information:
• mscomp — Microsoft compatible ID

• msven — Microsoft vendor ID
• mssubcomp — Microsoft subcompatible ID
CAUTION: For the Microsoft descriptor information to be present, you must enable
! the check_MS_desc option, but enabling the check_MS_desc option may cause
some devices to become unresponsive. Disable this option unless you are using PFS
devices or have other features dependent on Microsoft descriptor data enabled on your
target.
Behavior when enumerating a single USB device

When enum-usb enumerates a single USB device, it may report more than one device
to enum-devices. Behavior is defined by the USB device’s device class, as follows:
class is other than zero (!=0)

enum-usb considers that any interfaces present on the device cannot be used
independently of the other interfaces on the device.
It reports one useable interface for this device, and expects that enum-devices
will launch a single driver to manage the device and its interfaces.
class is vendor specific (0xFF)
enum-usb considers that the device will be handled by a single driver that
knows how to handle this vendor specific device. It reports one useable interface
for this device.
class is interface specific (=0)
enum-usb reports an event for every interface present for the current device
configuration.
Each interface of this USB device can be managed independently of the other
interfaces on the device and, therefore, enum-devices can be configured to
launch a unique driver for every USB interface reported for the USB device.

The enum-usb configuration file

The enum-usb configuration file allows you to identify USB devices by vendor ID,
device ID, and serial number in order to control how the device is enumerated by
enum-usb. The default path and name of the configuration file is
/etc/enum-usb.conf. You can use the -c at startup to specify another the
configuration.
The configuration file uses the following options:
• Device — start of a device configuration definition; see Device below.
• Ignore — instruct enum-usb to ignore the USB device; see Ignore below.
• Config — specify the USB device configuration; see Config below.
• Set — specify a special tag to include in USB device reports to enum-devices;

see Set below.
Each option must be on its own, separate line. Commented lines begin with a number
sign (“#”) and are ignored by enum-usb. Blank spaces are ignored.
Sample enum-usb.conf configuration file

#Specify the configuration to use for IPOD devices
Device vid=05AC,did=12*
Config class=03
Set usr_spec_id=AppleIpod
#Do not enumerate this device

Device vid=13FE,did=1D00
Ignore
Device
The enum-usb configuration file Device option identifies the start of a device
configuration definition. All options that follow a Device option in the configuration
file are applied to that device, up to a new instance of the Device option.
The Device option identifies a USB device by its:
• device ID (did)
• vendor ID (vid)
• serial number (ser)
The statement for the Device option takes the form:
Device [vid=v],[did=d],[ser=s]
The rules for composing the Device option statement are:
• In the model above, vvvv, dddd and s represent the hexadecimal values to match,
and s represents the serial number string.

• The option statement must contain a least one parameter.
• Parameters can be in any order, separated by commas.
• If the device will be ignored, do not specify the serial ID (ser) parameter; see
Ignore below.
• The option statement supports wildcard matching (see fnmatch()), so you can
match a range of devices. For example, did=05ac,vid=12*, would match a
specific vendor and a range of devices, where 12* matches 1200 through 12FF.
• If matching strings do not contain a wildcard, they must specify the vendor ID (vid)
and the device ID (did) as four numerals, with leading zeros if necessary. The serial
number is a string with a device specific format and length.
Ignore
The Ignore option instructs enum-usb to ignore the device and to not enumerate it.
This option is useful if you have a USB device for which a driver registers for the
insertion event for the device itself and does not need to be launched by the
enumerator. Instructing enum-usb to ignore this type of device, eliminates any
possible conflict between the enumerator and the driver, which might both attempt to
attach to the device at the same time.
If you want enum-usb to Ignore a device, the Device option identifying it should
specify only the device ID and the vendor ID.
enum-usb ignores serial numbers defined in the Device option of ignored devices,
because to obtain a device’s serial number it must “attach” to the device, and attaching
to an ignored device may create a conflict with a driver attempting to get exclusive
access to the device.
Config
The Config option allows the user to specify which USB device configuration is used
when the device to be enumerated supports multiple configurations.
If the Config option is not used, the enum-usb uses the first device configuration
selected. If Config option is used but the specified configuration is not present on the
device, enum-usb logs an error and does not enumerate the device.
When enum-usb encounters the specified device, it sets the USB device’s
configuration to either the number specified (Config num=x) by the Config option,
or to the first configuration with an interface that matches the class and subclass
combination specified by the Config option.
Multiple configuration selections
If a device supports multiple configurations or interfaces from generation to

generation, in your enum-usb configuration file you can specify multiple Config

option lines for each Device, in priority order. enum-usb uses the first Config option
statement that matches the device for which it is listed.
Composing Config option statements
Statements for the Config option take the form:
Config [class=xx],[subclass=xx]
or:
Config num=x
The rules for composing Config option statements are:
• In the model above, xx represents the hexadecimal values for the class and subclass
to match, and x represents the configuration decimal value to match.
• The option statement must contain a least one parameter.
• The option statement can specify any of the following:

- only the class parameter
- only the subclass parameter
- both the class and the class parameter
• The matching strings for class and subclass must be two numerals, with a leading
zero if necessary.
• When you specifying the configuration number, you are specifying the value
reference number of the configuration, rather than its index. For example, if a
device has two configurations, they may not be referred to as configuration one and
configuration two. To determine the configuration value of a device configuration,
refer to the output of the USB utility (usb -vv).
• QNX recommends that you use the class and subclass parameters wherever
possible, rather than a configuration number (num). For some devices, the
environment in which they are used may affect which configurations they report.
This device characteristic means that in different environments, the same
configuration number may represent different configurations.
• Use the configuration number parameter for the Config option only when you are
certain that the configuration numbers you use will do not change — when you are
certain that the numbers will always represent the same configurations, in all
circumstances.

Set
The Set option allows you to specify a custom string to be passed to enum-devices.
This string can be:
• used to help enum-devices match a device to a specific enum-usbconfiguration
• applied to an enum-devices configuration; for example, as an argument applied

for launching a driver
There are currently two defined custom tags that enum-usb can pass to
enum-devices:
• user_spec_id — user-specified identifier
• inc_user_spec_id — incrementing user-specified identifier
Composing Set option statements
Set statements in the enum-usb configuration file must be specified as follows:
• If the Device section does not contain a Config statement, Set statements can be
specified after the Device statement.
• If configuration file includes Config statements, Set statements must be placed

immediately following the Config statements to which they apply.
For example:
Config class=01
Set usr_spec_id=AppleIPODwithDigitalAudio
Config class=08
Set usr_spec_id=AppleIPODUMASSmode
user_spec_id
The Set user_spec_id option is useful for associating multiple devices, or a range of
devices, with a single enum-devices configuration. It can be:
• used to confirm matching criteria, and thus launch the same driver for all the
associated devices
• passed as an argument to the matched configuration, and thus represent a common

system component comprised of several launched drivers
The statement for the Set user_spec_id option takes the form:
Set usr_spec_id=x

The rules for composing the Set user_spec_id option statement are:
• In the model above, x represents a string with no white spaces.
• The string length is limited to 40 characters.
inc_user_spec_id
The Set inc_user_spec_id option is useful for associating multiple devices, or a range
of devices, while providing a device-unique incrementing suffix appended to the user
supplied string. Because enum-devices configuration files do not support wildcards,
this option can be used only as an argument passed to the matched configuration.
The suffix appended to the user-supplied string by this option:
• is taken pulled from a shared pool
• is reserved for the name provided
• is released when the device is removed
• is reusable after release
• starts incrementing from zero
For example, behavior with the sample configuration inc_usr_spec_id=/fs/ipod

is as follows:
• When the first iPod is connected to the host system, all insertion events related to
that device include the tag inc_usr_spec_id=/fs/ipod0.
• When a second iPod is connected to the host system, all insertion events related to
that device include the tag inc_usr_spec_id=/fs/ipod1, and so on for all
further iPods connected to the system.
• If the second iPod device is removed, the 1 suffix becomes free, and will be reused
for the next iPod inserted.
• If you want the device suffix to be incremented from zero for a device entry in your
enum-usb configuration file (enum-usb.conf) instead of from a shared pool, you
must use a unique inc_ usr_spec_id for that device entry in the configuration file.
• If the inc_usr_spec_id value is a pathname, the basename is used to reserve the

suffix: inc_usr_spec_id=/fs/ipod, for example, will share the suffix pool
with inc_usr_spec_id=ipod.
The statement for the Set inc_user_spec_id option takes the form:
Set inc_usr_spec_id=x
The rules for composing the Set inc_user_spec_id option statement are:

• In the model above, x represents a string with no white spaces.
• The string length is limited to 1024 characters, including the appended suffix.
Using enum-devices with enum-usb

enum-devices launches enum-usb when it starts. To enable enum-devices to
launch enum-usb, you must add enum-usb to the common file accessed by both
enum-devices and enum-usb, as follows:
all
config(include)
config(overrides)
config(devices)
enumerator(usb)
For a complete description of the enum-devices configuration file format, as well as

more information about how to use enum-devices, see enum-devices in the
Neutrino Utilities Reference.
Examples:
Start enum-usb, specifying the path to the configuration file and setting the interface
maximum:
# enum-usb cfg_file_path=/etc/enum-usb-custom.conf,iface_tbl_size=32
enum-usb.conf
In this sample implementation, we want enum-devices to launch a driver for an
iPod, which has several different device IDs. Instead of a using a enum-devices
configuration containing an entry for every vid and did combination, we pass up a user
specified ID which represents the set of iPod devices.
#Specify the configuration to use for iPod devices

Config class=03
Set usr_spec_id=AppleIpod
enum-devices configuration file

# If the class is AUDIO and the subclass is STREAMING,
# and the AppleIpod string is present,
# launch io-audio.
device(usb, class=01, subclass=01, usr_spec_id=AppleIpod)

driver(io-audio "-dipod busno=$(busno),devno=$(devno),
cap_name=ipod-$(busno)-$(devno),
ipod_mount=/fs/ipod-$(busno)-$(devno)")

See also:
enum-devices, io-fs-media, iofs-ipod.so, iofs-pfs.so,
iofs-ser-ipod.so, iofs-usb-ipod.so

© 2010, QNX Software Systems GmbH & Co. KG. env
Set environment for command invocation (POSIX)
Syntax:
env [-i] [name=value]... [command [arguments]]
Deprecated:
env - [name=value]... [command [arguments]]
Runs on:
Options:
-i Ignore the environment that’s otherwise inherited from the current
shell. This restricts the environment for command to that specified by
any name=value pairs.
- (Deprecated) same as -i
name=value Set the environment variable name to value and add it to the
environment.
command A command to be invoked.
Description:
The env utility obtains the current environment, modifies it according to its
arguments, and executes command with the modified environment. If no command is
specified, the resulting environment is displayed.
If you have removed the PATH environment variable from the environment, you must
include the path to the command.
Examples:
Start a shell with only the SHELL and PATH environment variables:
env -i SHELL=/bin/sh PATH=/bin:/usr/bin sh
Start a daemon process with no environment:
env -i /bin/cron
Exit status:
When a command is specified on the command line, the env utility attempts to exec()
into that command. If the command is successfully launched, the exit status from env
is that of the program it exec()ed into. Otherwise, env returns an exit status as follows:

env © 2010, QNX Software Systems GmbH & Co. KG.
0 (Assuming no command was specified) the resulting environment was

successfully displayed.
>0 An error was present in the command-line parameters supplied or env was
unable to launch the command specified on the command line.

© 2010, QNX Software Systems GmbH & Co. KG. errno
Explain errno numbers (QNX Neutrino)
Syntax:
errno error_number...
Runs on:
Neutrino
Options:
error_number Error number to be explained.
Description:
The errno utility displays the string equivalent for the error_numbers supplied on the
command line. The output is written to the standard output. If the command-line
argument isn’t a valid error number, a line is written to the standard error instead.
This utility is useful in cases where a program has indicated that a numerical error
occurred and hasn’t provided the ASCII string equivalent of that errno value. Users
who don’t have access to the C header file <errno.h> don’t have the option of using:
grep error_number /usr/include/errno.h
The errno utility is more convenient and is available to all users.
Examples:
Find the string equivalent of error number 2:
$ errno 2
errno 2: ERROR ENOENT
$
Exit status:
>0 An error occurred (e.g. unknown errno value).
0 The error string was successfully written to the standard output.
See also:
use

esh © 2010, QNX Software Systems GmbH & Co. KG.
Embedded shell (QNX Neutrino)
Syntax:
esh [-c command] [-irv] [script_file]
Runs on:
Neutrino
Options:
-c command Run this command.
-i Enter interactive mode after running a script file. If you don’t

specify this option, esh terminates after running a script.
-r Run in restricted mode. In this mode, you can’t perform certain

operations. If you try to, the error message, “Operation not
permitted” is displayed.
Restricted operations include running executables that start with a
slash, exporting variables, and reattaching standard input, output and
error to another device. For more information, see the sections
“Command-line format” and “Builtin commands.”
-v Be verbose: echo each command before executing it.
script_file A file containing shell commands to execute.
Description:
The esh utility provides a subset of the functionality found in the standard shell,
/bin/sh. You should find esh useful for situations where memory requirements are
limited. For example, you could use it to run a simple system initialization file for an
embedded system.
Command-line format
In esh, command lines take this form:
command arg1 arg2 ... [redir-op file] [&]
Where:
command The command to be executed. If it doesn’t start with a slash, the

command follows the path set by the PATH environment variable. In
restricted mode, a command can’t start with a slash.
redir-op file A redirection operator. When a command is invoked, three standard

files are set up in its environment. These files, standard input,
standard output, and standard error output (stdin, stdout, stderr), are

© 2010, QNX Software Systems GmbH & Co. KG. esh
usually attached to the active terminal. You can redirect a command’s

standard input, standard output, and standard error as follows:
Specifying: Will:
<file Redirect standard input from this file.
>file Redirect standard output to this file. If the file exists, it’s
overwritten; if the file doesn’t exist, it’s created.
>>file Redirect standard output to this file. If the file exists, the
information is appended to the end of the file; if the file
doesn’t exist, it’s created.
2>file Do the same as >file, but for standard error.
2>>file Do the same as >>file, but for standard error.
& If a command contains an unquoted &, then esh doesn’t
wait for the command to complete execution but
immediately moves on to process the next command.
The standard input of the command is redirected from
/dev/null, and SIGINT and SIGQUIT are ignored.
Filename expansion
You use most commands for manipulating files in one way or another. As such, esh
has a filename “shorthand” (consisting of *, ?, [, and ]) that you can use to specify
the files that a command is to operate on. This shorthand is the same used by the
standard shell. For more information, see “Filename patterns” in ksh.
Quoting
The following characters have a special meaning in esh:
& \ " * ? [ space
To suppress the special meaning of these characters and keep their literal meaning,
you use quoting.
To quote a sequence of characters or sequence of words, enclose the sequence in
double quotes. To quote a single character, use double quotes or precede it with the
escape character (\).
Escape character (backslash)

The escape character (\) preserves the literal meaning of the next character. You can’t
obtain a single backslash by quoting \ with double quotes. To obtain a backslash,
enter \\ instead.

Double quotes
Enclosing characters and words in double quotes ("") preserves the literal meaning of
all characters within double quotes, with the exception of the \ character. For example:
"ab cd"
represents a single, five-character argument.

You can keep the literal meaning of a double quote with the \ character. For example:
ab\"cd
represents the single, five-character argument ab"cd.
Builtin commands
The following commands are built into esh (that is, esh interprets and executes them
internally):
• . (dot)
• alias
• cd
• emount
• ewaitfor
• exec
• exit
• export
• kill
• reopen
• set
• unset
. (dot) command
. file
The . (dot) command reads and executes the commands from file within the current
environment. The search path contained in the environment variable PATH is used to
find the directory containing file. This command doesn’t require that file be executable.

alias command
alias [name=value]...
Without arguments, alias lists all aliases and their values. If only the name is
specified, its value is listed. Any name specified with a value defines an alias.
Alias expansion occurs when the first word of a statement is a defined alias, except
when that alias is already being expanded.
List all aliases:
alias
Remove an alias:
alias name=
cd command
cd [directory]
Change the working directory of the current execution environment. If directory isn’t
specified, the value of the HOME environment variable becomes the new working
directory.
emount command
emount special directory [fs_type]
Mount a special device. The arguments are:
special The name of the special device.
mountpoint Where to mount the device on your system.
type The type of filesystem or manager to mount:
type: Filesystem or manager:

cd fs-cd.so
cifs fs-cifs
dos fs-dos.so
ext2 fs-ext2.so
mac fs-mac.so
nfs fs-nfs2, fs-nfs3
nt fs-nt.so
qnx4 fs-qnx4.so
qnx6 fs-qnx6.so
udf fs-udf.so

The default is qnx4.
The emount command was implemented in QNX Momentics 6.3.0 Service Pack 2.
ewaitfor command
ewaitfor path [max_seconds [delay]]
Wait until the given path exists. The arguments are:
path The path to test.
max_seconds The maximum number of seconds to wait for the file to appear. The
default is 1 second.
delay The number of milliseconds to wait between attempts. The default

is 100 ms.
The ewaitfor command was implemented in QNX Momentics 6.3.0 Service Pack 2.
exec command
exec [command [argument...]]
Execute a command and/or manipulate file descriptors.

The exec command opens, closes, or copies file descriptors as specified by any I/O
redirections given as part of argument. If a command is specified, that command is
spawned as a replacement for esh. Any specified arguments are passed to the
spawned process.
If esh is operating in restricted mode (-r), you can’t use the exec command to run a
command whose path starts with a slash.
exit command
exit [n]
Cause esh to exit with the exit status specified by n. If n isn’t specified, esh exits with
the status of the last command executed.
export command
export name[=word]...
export -p
Mark environment variables for export. This makes them be in the environment of
subsequently executed commands. If you specify the -p option, the names and values
of all exported variables are written to the standard output.
If restricted mode (-r) is set, you can’t use this command.

kill command
kill pid
Set a SIGTERM on the process with process ID pid.
reopen command
reopen [device]
Close standard input, standard output, and standard error and attach them to the
specified device. This command is often used in startup scripts. If you don’t specify a
device, /dev/con1 is used.
If restricted mode (-r) is set, you can’t use this command.
set command
set -v
Enable verbose mode; all commands are echoed to the standard output before they’re
executed.
unset command
unset variable
Unset the specified variable. If restricted mode (-r) is set, you can’t use this
command.
Examples:
Invoke a subshell:
esh
Invoke a subshell with a script file:
esh /etc/backup
Run the following command and exit:
esh -c "ls /bin"
Files:
/etc/esh ASCII text file containing shell commands, executed when esh is
started as a login shell.
HOME The pathname of the user’s home directory.
LOGNAME The user’s login name.

PATH The directory search path used by esh for locating executable
programs and esh shell scripts. To change PATH, you must use the
export command.
If PATH isn’t in the existing environment when esh is invoked, it is
set to /bin:/usr/bin. For more information on setting PATH, see
“Setting PATH and LD_LIBRARY_PATH” in the Configuring
Your Environment chapter of the Neutrino User’s Guide.
SHELL The pathname of the user’s preferred shell.
TERM The terminal type.
TMPDIR The name of a directory where utilities can create temporary files.
TZ The timezone setting.
Caveats:
The current version of esh strips out single quotes (’), which means that many
common uses of commands such as find fail.
See also:
fesh, ksh, rsh, sh, uesh
Using the Command Line and Writing Shell Scripts in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. etfsctl
Control an embedded transaction filesystem
Syntax:
etfsctl [options]
Runs on:
Neutrino
Targets:
ARM, MIPS, PowerPC, SH4, x86, and XScale processors
Options:
-c Make the filesystem on the device continue or resume operations.
-d device Connect to the specified device:
/dev/etfs1 The raw partition for user extensions (such as boot

images).
/dev/etfs2 The filesystem partition for etfs files.
-D Request a defragmentation operation on the .filetable for the ETFS

filesystem. The background processing of the ETFS filesystem does its
own defragmenting as needed. This option lets you force it to happen
on demand.
-e Erase the device. For NAND flash, factory-marked bad blocks aren’t
erased. Blocks that become bad during normal use (worn-out blocks)
are also skipped during the erasing.
If you wish, you can use the -l and -o options to specify the length and
offset for the erasure. If used, these options must preceed the -e option.
-f Erase as in -e, then format an empty filesystem. Don’t use this option
with -w, since -w assumes an erased partition with no filesystem.
-i Print info about the filesystem. See the “Description” below.
-l len The length for the subsequent -e, -R, or -r option. The len is in bytes,
but you can add a suffix of K, M, or G.
-o offset The starting offset for the subsequent -e, -R, -r, -W, or -w option. The
offset is in bytes, but you can add a suffix of K, M, or G.
-p Operate in software-update mode.
-r file Read all data from the device and save it in the specified file. The data
is saved as a series of transactions. This data can be written to another
flash part as long as that part has the same:

etfsctl © 2010, QNX Software Systems GmbH & Co. KG.
• cluster size
• block size (number of clusters in a block)
The data format is endian-neutral and free of any device-specific
characteristics such as how it stores CRCs or ECCs. You can now read
and write filesystems across different classes of devices, for example
for NAND and RAM.
If you wish, you can use the -l and -o options to specify the length
and offset for which to read. If used, these options must preceed the -r
or -R option. If you specify the -l option, etfsctl doesn’t read past
this length.
-R file Read all data from the device, including blank or erased blocks, and
save it in the specified file. This is the raw version of -r option.
-s Stop the filesystem on the device.
-S Similar to -s, but wait for the filesystem to stop before returning.
-w file Write transactions from the specified file to the device. This transaction
file can be created by reading it from this or another device via the -r
option of etfsctl or by the mketfs utility. The transactions are
block-location-independent on the device. This allows bulk
programming of devices with bad blocks in any location. The only
requirement is that enough good blocks should be available to hold all
transactions.
If you wish, you can use the -o option to specify the offset at which to
write. If used, this option must preceed the -w or -W option.
-W file Write transactions from the specified file to the device. Also, copy any
blank or erased blocks. This is a raw version of the -w option.
Description:
The etfsctl utility is used to manage an embedded transaction filesystem (ETFS).
The utility interacts with the running filesystem using devctl() messages. Using
etfsctl, you can erase and format a partition, read or write an entire transaction log
(and thus its entire filesystem) from or to the device, stop the filesystem, make it
continue or get statistical information.
Options are processed from left to right in order. The first option must be a -d device
where:
/dev/etfs1 The raw partition for user extensions (such as boot images).
/dev/etfs2 The filesystem partition for etfs files.
The raw partition is used for user extensions, such as boot images, and is always at the
start of the device. It may be zero bytes long if you don’t need it. The filesystem

partition consists of a series of transactions that together form a filesystem. You can
use the -r option to read the transactions from the device and save them to a regular
file, typically on another filesystem. You can then use the -w option to write this
transaction log to another ETFS filesystem.
CAUTION: When writing, you must erase the filesystem first; failure to do so
! corrupts the data on the device.
The -w option is most often used to write transaction logs created by the mketfs
utility.
You can request the filesystem to stop accepting new open requests by using the -s or
-S option. Once the last file currently open by any application is closed, the filesystem
enters the stopped state. A filesystem partition must be stopped in order for you to
write a transaction log to it. You can start the filesystem again using the -c option.
The -i option provides useful statistical information about a running filesystem. This
option is so common that it assumes /dev/etfs2, thus saving you from having to
enter the -d option before it. The information is displayed in following groups:
• Device
• Pools
• Counts
• Errors
Device
Name Name of the device. The name usually encodes a part number or
size.
Blocks Number of blocks on the device.
Clusters/Block Number of clusters to a block on the device.
Clustersize Size of a cluster. Typically 1 KB or 2 KB.
Totalsize Total size of the device, in bytes.
Pools
Clean Number of erased blocks immediately ready for writing.
Spare Number of spare blocks.
Filthy Number of free blocks that are waiting to be erased and made clean.
Inactive Number of clusters not being used but trapped.
Xpool Number of cache buffers.
Cache Number of cluster cache buffers.

etfsctl © 2010, QNX Software Systems GmbH & Co. KG.
Counts
Erase Number of erases on the part (while running).
Avg Average erase count per block.
Read Number of cluster reads from the device.
Cache Number of cluster reads from cache.
Write Number of cluster writes to the device.
Mine Number of mining operations to recover dead space in a block. This is

how inactive clusters create filthy blocks, which become clean after
being erased.
Copy Number of block-copy operations. Copies occur two ways: the first way
is a read in a block that has a soft ECC error, which is an indication that
the block is getting weak. The block is copied to a new fresh block and
the block with the ECC error is erased. In the second way, a block with a
low erase count is forced into service by copying its data to a new block
and erasing and putting this block into service.
Defrag Number of files defragmented.
BadBlks Number of blocks marked as bad and taken out of service
Errors
Ecc Number of CRC data errors that are corrected by ECC.
Chksum Number of CRC data errors.
Device Number of hard device errors. This is bad and usually indicates a
hardware problem.
The error statistics currently aren’t collected, so these values are always 0.
Examples:
Print information about a filesystem. If you omit the -d option, etfsctl assumes
/dev/etfs2.
etfsctl -i
etfsctl -d /dev/etfs2 -i
Format an empty filesystem:
etfsctl -d /dev/etfs2 -S -f -c
Write a filesystem built by mketfs:

etfsctl -d /dev/etfs2 -S -e -w fsys.etfs -c
Save the entire filesystem. Erase the part, and restore the filesystem:
etfsctl -d /dev/etfs2 -r debug.etfs

etfsctl -d /dev/etfs2 -S -e -w debug.etfs -c
Erase part of a raw ETFS partition, without erasing the boot monitor:
etfsctl -d /dev/etfs1 -o 3M -l 6M -e
Read part of a raw partition:
etfsctl -d /dev/etfs1 -o 3m -2k -R /temp/raw.stuff
See also:
fs-etfs-ram, mkefs, mketfs, mkifs
“Embedded transaction filesystem (ETFS)” in the Filesystems chapter of the System
Architecture guide
“Filesystem limits” in the Understanding System Limits chapter of the QNX Neutrino
User’s Guide

expand © 2010, QNX Software Systems GmbH & Co. KG.
Convert tabs to spaces (POSIX)
Syntax:
expand [-t tablist] [file...]
Runs on:
Neutrino
Options:
-t tablist Set up tab stops according to the tablist argument. This argument
consists either of a single positive decimal integer, or of multiple
positive decimal integers, in ascending order, separated by single
commas.
If no number is given, tabs stops are set eight columns apart. If a single
number is given, tab stops are set tablist columns apart. If multiple
numbers are given, tab stops are set at those columns.
file The pathname of a file whose tabs are to be converted.
Description:
The expand utility copies files or the standard input to the standard output with tab
characters replaced by the number of spaces needed to pad to the next tab stop. Any
backspace characters encountered in the input are copied to the output and cause the
column position count for the tab-stop calculations to be decremented; the count is
never decremented below zero.
The -t option lets you specify how many columns tab stops are set apart. You can also
use it to specify a multiple tab-stop list that determines where tab stops are placed. If
tab characters are present in the input past the last tab stop specified in a multiple
tab-stop list, those tabs are each replaced by a single space in the output.
Note that tabbing to position N causes the next character written to appear in the next
column position on that line (i.e. column N+1)
Examples:
For the file myfile, expand each tab to the number of spaces required to reach the
next tab stop:
expand myfile
Do the same as above, except set tab stops to every four columns rather than the
default eight:
expand -t4 myfile
Place tab stops at the specified columns. Any tab encountered past the last tab stop is
replaced by a single space:
expand -t8,12,20,24,32,36,44,48 myfile

© 2010, QNX Software Systems GmbH & Co. KG. expand
Exit status:
Caveats:
The expand utility doesn’t check to verify that the tab stops specified in the -t option
are in ascending order, as is required for proper operation.
See also:
unexpand

/etc/exports © 2010, QNX Software Systems GmbH & Co. KG.
Define remote mountpoints for NFS mount requests
Name:
/etc/exports
/etc/exports.hostname
Description:
The exports file defines remote mountpoints for the NFS mount protocol according
to the NFS server specification; see RFC 1094 (Network File System Protocol
Specification) and RFC 1813 (NFS Version 3 Protocol Specification).
There isn’t a default version of this file; you can create your own if you need it.
Each line in the file specifies one remote mountpoint. The first field contains the
mount-point directory path, followed optionally by a list of options and/or a list of
specific hosts separated by whitespace. If no specific hosts are specified, the mount
point is exported to all hosts.
Here are the export options:
-mask=netmask -match=network
Restrict access to hosts belonging to subnet defined by netmask and
network. By default, there’s no restriction. Access is determined by:
((client_ip & netmask) == network)
-norsvd Don’t check incoming requests, they’re from a reserved port. By

default, NFS requests from ports greater than IPPROTO_RESERVED
are replied to with EACCES.
-ro Export the filesystem as read-only. By default, the filesystem is

exported as read/write.
-root=uid Map root’s uid (real user ID). By default, root is mapped to -2.
Let’s now look at a sample file:
/usr -root=1 rickers snowhite.cis.uoguelph.ca

/usr/local 131.104.48.16
/u -root=5 -mask=255.255.240.0 -match=131.104.0.0
/u2 -ro -mask=255.0.0.0 -match=10.0.0.0 node11 node23
The above example specifies the following:

© 2010, QNX Software Systems GmbH & Co. KG. /etc/exports
This mountpoint: Is exported:

/usr To hosts rickers and snowhite.cis.uoguelph.ca only,
with root mapped to 1 and with read/write access.
/usr/local To host 131.104.48.16 only, with root mapped to -2 and
with read/write access.
/u To all hosts within 131.104.0.0 to 131.104.15.255,
with root mapped to 5 and with read/write access.
/u2 To hosts node11 and node23 and to hosts belonging to IP
network 10 only, with root mapped to -2 and with
read-only access.
Limitations:
1 subnet per mountpoint
10 hosts per mountpoint
See also:
nfsd, showmount
Based on:
• RFC 1094 (Network File System Protocol Specification)
• RFC 1813 (NFS Version 3 Protocol Specification)

expr © 2010, QNX Software Systems GmbH & Co. KG.
Evaluate arguments as an expression (POSIX)
Syntax:
expr operand...
Runs on:
Neutrino
Options:
operand Operand expression to evaluate.
Description:
The expr utility evaluates a single expression and writes the result to the standard
output. The expression is formed from integer and string symbols in combination with
the following operators:
( ) | & = > >= < <= != + - * / % :
In the following table, expressions are listed in order of decreasing precedence, with
equal-precedence operators grouped together. All of the operators are left-associative.
Note that a string operand is an argument that can’t be identified as an integer
argument or as one of the above operators.
Expression Description
integer An argument consisting only of an (optional) unary minus
followed by digits
string A string argument
( expr ) Grouping symbols; you can place any expression inside the
parentheses.
expr1 : expr2 Matching expression
expr1 * expr2 Integer multiplication
expr1 / expr2 Integer division, producing an integer result
expr1 % expr2 Remainder of integer division
expr1 + expr2 Integer addition
expr1 - expr2 Integer subtraction
expr1 = expr2 Equal*
expr1 > expr2 Greater than*
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. expr
Expression Description
expr1 >= expr2 Greater than or equal*
expr1 < expr2 Less than*
expr1 <= expr2 Less than or equal*
expr1 != expr2 Not equal*
expr1 & expr2 Returns the evaluation of expr1 if neither expression evaluates to
null or zero; otherwise, returns zero
expr1 | expr2 Returns the evaluation of expr1 if it’s neither null nor zero;
otherwise returns the evaluation of expr2
* Returns the result of a decimal integer comparison if both arguments are integers;
otherwise, returns the result of a string comparison. The result of each comparison is 1
if the specified relation is TRUE or 0 if FALSE.
The “:” matching operator compares the string resulting from the evaluation of expr1
with the regular expression pattern resulting from the evaluation of expr2. Usually,
this operator returns the string representing the number of characters matched (“0” on
failure). However, if the pattern contains at least one regular expression subexpression
$...$, the string corresponding to \1 is returned (see grep).
Examples:
Add 1 + 1 :
expr 1 + 1
Logical 1 or 0 :
expr 1 \| 0
Logical 1 and 0 :
expr 1 \& 0
Add 1 to $a :
expr $(expr $a + 1)
Count the characters in $var :
expr "$var" : ’.*’
Compare $a to a possible =
expr x$a = x=

expr © 2010, QNX Software Systems GmbH & Co. KG.
Exit status:
0 The expression evaluates to neither null nor zero.
1 The expression evaluates to null or zero.
2 Invalid expressions were found.
Caveats:
The syntax for expr requires special attention. Many of the operators are also shell
control operators or reserved words, so they have to be escaped on the command line.
In addition, each part of the expression is composed of separate arguments, so you
should use blanks liberally. For example:
Instead of entering: You should enter:

expr "1 + 2" expr 1 + 2
expr 1 + (2 * 3) expr 1 + $ 2 \* 3 $
expr 1+2 expr 1 + 2
In many cases, the arithmetic and string features provided as part of the shell
command language are easier to use than their equivalents in expr. However, you
may need expr to run older UNIX shell scripts.
When you want to specify the filesystem root, avoid the / character as a standalone
argument — expr interprets it as the division operator. Use // instead.
See also:
grep

© 2010, QNX Software Systems GmbH & Co. KG. false
Return false value (POSIX)
Syntax:
false
Runs on:
Options:
None.
Description:
The false utility does nothing but exit immediately with a nonzero exit code.
The shell has a builtin false command; see ksh. To make sure you use the
executable, specify the full path.
Exit status:
>0
See also:
ksh, true

fcat © 2010, QNX Software Systems GmbH & Co. KG.
Display compressed (frozen) files (UNIX)
Syntax:
fcat [filename...]
Runs on:
Neutrino
Options:
See freeze for a full listing.
Description:
The fcat command is equivalent to freeze -cd. See the freeze utility for details.
The freeze, melt, and fcat compression utilities will eventually become
deprecated in favor of the GNU zip suite, which consists of gzip, gunzip, and
zcat. The freeze suite of utilities will continue to be provided for quite some time
before being eliminated completely.
Leonid A. Broukhis
See also:
freeze, melt

© 2010, QNX Software Systems GmbH & Co. KG. fdformat
Format floppy diskettes (QNX)
Syntax:
fdformat [-aiIpqv] [-h heads] [-t tracks] [-n sectors]
[-s size] [-k skew_factor] [-z interlv] drive
Runs on:
Neutrino
Options:
-a Abort on the first error encountered.
-h heads The number of heads.
-I Ignore errors. Don’t try to verify diskette.
-i Write layout information to the diskette, but don’t format it.
-k skew_factor The number of sectors by which fdformat should offset the

starting sector of a track from the last sector of the previous track.
-n sectors The number of sectors per track.
-q Be quiet; don’t report progress as each track is formatted.
-s size The disk media: 360K, 720K, 1.2M, 1.4M, or 2.8M (overrides -h,
-t, and -n).
-t tracks The number of tracks.
-v Be verbose; display extra information as the format progresses.
-z interlv The interleave amount.
drive The name of the physical device to be formatted (i.e. /dev/fd0).
Description:
The fdformat utility formats the specified disk. Formatting refers to a process of
placing addressing marks and other control information on the disk to allow the
hardware to read it. Formatting doesn’t imply any sort of filesystem structure.
By default, fdformat uses the current mount characteristics of the drive as the drive
parameters. These parameters may be overridden by specific command-line options,
such as -t tracks.
The -s size option lets you specify the size of standard floppy disks, as in the
following:

fdformat © 2010, QNX Software Systems GmbH & Co. KG.
Size Heads Tracks Sectors Drive type

360K 2 40 9 5 14 ″ floppy
720K 2 80 9 3 12 ″ floppy
1.2M 2 80 15 5 14 ″ floppy
1.44M 2 80 18 3 12 ″ floppy
2.88M 2 80 36 3 12 ″ floppy
The first sector of QNX Neutrino floppy disks contains some information about the
layout of the diskette (heads, tracks, sectors). The -i option simply writes this layout
information to a diskette without formatting it.
The -z interlv option lets you specify the amount of interleave (spacing between
sectors). Specifying -z1 (the default) would place the sectors contiguously (e.g.
1,2,3,4,5, etc.)
Specifying -z2 would place the sectors at every second location (e.g. 1, -, 2, -, 3, -, 4,
-, 5, etc.). If there were nine sectors per track, -z2 would yield:
1, 6, 2, 7, 3, 8, 4, 9, 5
such that reading every other sector in the (circular) track would produce a contiguous
reading of the sectors. Note that the hardware makes all of this transparent; specifying
-z may optimize access for the hardware.
The -k skew_factor option affects performance when reading and writing consecutive
tracks on the disk in an ascending order. Disk drives have an inherent latency when
moving the head from one track to the next. By setting the first sector of the next track
some distance ahead of the last sector of the current track, it is possible to tune the
amount of time it takes before the head encounters the first sector of the next track
after the seek. When there is no skew, the rotation of the disk places the head past the
first sector of the next track after the time taken to seek to the next track, meaning that
to get to the first sector the disk must complete nearly a full rotation.
If the latency is, for example, five sectors, you would specify the following:
-k 5
Placing the first sector of the next track five sectors away from the current sector
minimizes the latency effects.
Examples:
Format the diskette mounted as /dev/fd0 using the current mount parameters:
fdformat /dev/fd0
Format a 1.4M diskette mounted as /dev/fd0:
fdformat -s 1.4M /dev/fd0

© 2010, QNX Software Systems GmbH & Co. KG. fdformat
Format a 1.4M diskette mounted as /dev/fd0 using an interleave of 3 because the

diskette will be used as a boot diskette:
fdformat -s 1.4M -z 3 /dev/fd0
Files:
If the -p is specified, fdformat pauses until gets a newline character from the
standard input before proceeding to format the specified disk. The standard input is
otherwise unused.
If not in quiet mode (i.e. -q isn’t specified), informational and progress messages are
written to the standard output as the formatting proceeds. The extent of this
information is influenced by the -v option. If -q is specified, this information isn’t
written. Note that -q doesn’t override the printing of the prompt for the -p (pause)
option.
Any errors which occur cause a diagnostic message to be written to the standard error.
In addition, if the -v option is specified, information relating to some of the specific
formatting steps may be written to the standard error.
The fdformat utility acts upon the block special file named on the command line. If
successful, fdformat destroys the contents of the medium represented by this file.
Exit status:
0 The disk was formatted successfully.
>0 An error occurred and a diagnostic message was written to the standard error.
Caveats:
The fdformat utility destroys any existing data on a diskette. Don’t count on this
behavior for data security — differences in physical drive characteristics and presence
of magnetic fields in fringe areas may result in the data being recoverable by use of
special instruments. If you want to destroy data, the only really safe way is to
completely destroy the media.
Note that the latency saved by tuning the disk skew factor is only realized when
reading sequentially across a track boundary. On random requests, there is no single
mechanism to minimize access time.
See also:
dcheck, devb-fdc, dinit

fdisk © 2010, QNX Software Systems GmbH & Co. KG.
Create and manage partitions on a hard disk
In order to run this utility, you must be logged in as root or have read/write
permissions for the block-special file concerned.
Syntax:
fdisk [-fpz] [-B loader] drive [cmd [args]]
Runs on:
Neutrino
Options:
-B loader Use the 512-byte file named by loader as the primary bootstrap
loader for the device when instructed to write a boot loader to the
disk. The default is to install a loader that’s built into the fdisk
utility.
-f Force the boot loader to be written on command, even if it isn’t

possible to save an existing old loader to a mounted filesystem. In
noninteractive use with the loader command, this forces the loader
to be written in cases where the command would otherwise be
aborted. In interactive mode, you’re queried about the operation if
you didn’t specify -f; the operation simply proceeds without saving
the old loader if you did specify -f.
-p Pause before starting.
-z Zero the partition table (interactive mode only).
drive The disk drive to partition. This must name a block-special file (e.g.
/dev/fd1, /dev/hd0).
[cmd [args]] An installation command, as described below.
Description:
The fdisk utility lets you create and manage partitions on a hard disk (typically a
rotating medium, but fdisk works on other devices, such as compact flash and USB
flash, if they support PC-style Master Boot Records (MBRs) and partitions). The
partition information, which is kept in the disk’s first physical block, matches that used
by DOS.
On some platforms, fdisk supports a full-screen interface; see “Interactive mode,”
below.

© 2010, QNX Software Systems GmbH & Co. KG. fdisk
CAUTION:
! • The installer for Microsoft Windows overwrites any existing Master Boot Record
with its own. If you want your disk to contain bootable DOS and bootable QNX (or
other non-DOS) partitions, you should install Windows first, and then create the
other partitions. If you create a QNX partition first and then install Windows, you
can restore the boot loader by running QNX Neutrino from the installation disk and
explicitly using dloader.
• On some x86 machines, you can boot only from OS images that are loaded from
within the first 1024 cylinders of the disk. This means that while you may be able
to initially install and boot from a partition which extends past the 1024th cylinder,
it will someday fail when you go to update the boot image because the location of
some of its blocks may change. When this happens you will have a system that’s no
longer bootable.
Avoid this problem by creating a separate partition to boot from that lies entirely
within the first 1024 cylinders of the hard drive, and use a second partition to access
the additional space on the drive. (The boot partition may be quite small — just a
few megabytes will suffice.)
Before creating a QNX 4 partition for the first time, you must first start the hard disk
driver:
devb-eide &
You should then execute the fdisk command to partition your disk:
fdisk /dev/hd0 add
The QNX 4 filesystem doesn’t automatically relearn any changes that you make to the
partition table with fdisk. You must either slay and restart the filesystem/driver
(devb-*), use mount -e /dev/hd0 to recognize the new partitions and update the
contents of /dev, or reboot.
Partition types
The fdisk utility recognizes the following partition types. If you add a partition, use
the command shown to initialize it.
Type Filesystem Shared object Initialize with: Check with:

5 DOS extended N/A N/A N/A
continued. . .

Type Filesystem Shared object Initialize with: Check with:

8 or 9 QNX 2 N/A N/A N/A
15 Windows 95 extended N/A N/A N/A
99 UNIX N/A N/A N/A
130 Linux swap N/A N/A N/A
133 or 147 Linux extended N/A N/A N/A
165 BSD N/A N/A N/A
a Read-only.
Commands
The fdisk utility supports the following commands directly from the command line:
add [args] Add a new partition entry of the size and type specified. If fdisk
can’t locate sufficient unallocated disk space to satisfy your
request, it allocates the largest available portion of the disk (if
any). Here are the arguments for add:
-b Make the added partition bootable. If another

partition was already flagged as the primary boot
partition, the flag is turned off for it.
-c start,end The start and end for the partition to use.
-p percent The percentage of the largest contiguous space the
added partition should use. The default is 100%.
If you specify the -c option, the -p option is
ignored.
-s slot The slot in the partition table to use. The default is
the first open slot.
-t type The type of partition to add (0 - 255). The default
is 77.

boot [args] Turn on the boot flag for the indicated partition. If another
partition was already flagged as the primary boot partition, the
flag is turned off for it. Here are the arguments for boot:
-s slot Boot the partition in the selected slot.

-t type Boot the partition of the selected type.
delete [args] Delete the specified partitions. Here are the arguments for
delete:
-a Delete all partitions.

-s slot Delete the partition in the selected slot.
-t type Delete this type of partition.
info Show the mount information for the raw drive.

The fdisk utility makes a devctl(DCMD_CAM_DEVINFO) call
to obtain the cylinder, head, sectors per track, and total sectors
counts. Multiplying the first three values together is the classic
method of calculating the total number of sectors.
However, some hard drives employ zoned bit recording, so it’s
impossible to precisely map the number of sectors per track and
other fields. As a result, the total number of sectors returned from
devctl() and the total number of sectors that were calculated
might not match. In this case, fdisk displays a warning.
loader Write the QNX loader to the disk.
query [args] Print the number of cylinders to standard output. Here are the
arguments for query:
-f Print the total amount of free space.

-s slot Query the partition in the selected slot.
-T Print the total amount of space.
-t type Query the partition of the selected type.
show Display the partition table.
Interactive mode
On some platforms, fdisk is a fullscreen, interactive program that’s fairly
self-explanatory. When you invoke fdisk, you’ll see a screen similar to this one
(assuming your disk is already partitioned):
FDISK
Ignore Next Prev 1 2 3 4 Change Delete Boot Unboot Restore Loader Save Quit
_____OS_____ Start End ______Number_____ Size Boot

name type Cylinder Cylinder Cylinders Blocks

--> 1. QNX6 (177) 0 7648 7649 122881122 60000 MB

2. QNX6 (178) 7649 9963 2315 37190475 18159 MB *
3. ______ (___) _______ _______ _______ _________ _____
4. ______ (___) _______ _______ _______ _________ _____
Choose a partition by typing the partition number OR moving the pointer

with the UP/DOWN arrows.
Then, choose one of the actions on the top line of the screen.
Drive : /dev/hd0 Config: 255 Heads

Size : 78159 Mbytes 63 Sectors/track
Loader: Unknown 9964 Cylinders
512 Block Size
Last cylinder is 9963
You’ll see the available commands displayed at the top of the screen. To select a
command, either type its first letter or move the cursor to the command (with the
arrow keys) and press Enter.
The commands are:
Command: Action:
Next Move the pointer to the next entry.
Prev Move the pointer to the previous entry.
1, 2, 3, or 4 Move the pointer to the indicated entry.
Change Change the selected partition (see below).
Delete Delete the selected partition.
Boot Turn on the boot flag for the selected partition. If another partition
was already flagged as the primary boot partition, the flag is turned
off for it.
Unboot Turn off the boot flag for the selected partition.
Restore Restore the previous non-QNX bootstrap loader.
Loader Change the bootstrap loader to the QNX loader.
Save Save all changes and quit. This writes to the device and is
irrevocable.
Quit Quit without saving changes.

If you’re changing a partition entry, note the following:
• Save the details about the partition (e.g. by writing them on a piece of paper),
because fdisk blanks the fields as you edit them.
• You have to enter the partition’s type number and the start and end cylinders;
fdisk calculates the other information for you. Press Enter after typing each value.
• If the partition was bootable before you changed it, use the Boot command to
make it bootable again.
Examples:
Create a QNX 4 partition that occupies half the disk, or the largest available space if
there isn’t a space big enough for a new partition that occupies half the disk:
fdisk /dev/hd0 add -t 77 -p 50
Do the same, but make the partition bootable:
fdisk /dev/hd0 add -b -t 77 -p 50
Continuing from either of the above examples, reread the partition table, set up a
QNX 4 filesystem on the new partition, and then mount it:
mount -e /dev/hd0
mount -t qnx4 /dev/hd0t77 /mnt/q4fs
Create a bootable partition for a Power-Safe filesystem, reread the partition table,
format the new partition, and then mount it:
fdisk /dev/hd0 add -b -t 179 -p 50

mount -e /dev/hd0
mkqnx6fs /dev/hd0t179
mount -t qnx6 /dev/hd0t179 /mnt/psfs
Exit status:
0 Success.
>0 An error occurred; fdisk writes error messages to standard error.
Caveats:
After changing any partition information, you must either slay and restart the
filesystem/driver (devb-*) or use mount -e to make the filesystem reread the
partition table.

See also:
chkdosfs, chkfsys, chkqnx6fs, devb-*, df, dinit, dloader, fs-dos.so,
fs-ext2.so, fs-mac.so, fs-nt.so, fs-qnx4.so, fs-qnx6.so, mkdosfs,
mkqnx6fs, mount
Filesystems chapter of the System Architecture guide
Working with Filesystems and Backing Up and Recovering Data chapters of the QNX
Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. fesh
Fat embedded shell (QNX Neutrino)
Syntax:
fesh [-c command] [-irv] [script_file]
Runs on:
Neutrino
Options:
-c command Run this command.
-i Enter interactive mode after running a script file. If you don’t

specify this option, fesh terminates after running a script.
-r Run in restricted mode. In this mode, you can’t perform certain

operations. If you try to, you’ll see the error message, “Operation
not permitted.”
Restricted operations include running executables that start with a
slash, exporting variables, and reattaching standard input, output
and error to another device. For more information, see
“Command-line format” and “Builtin commands” in the description
of esh.
-v Be verbose: echo each command before executing it.
Description:
The fesh utility is a “fat” version of the small embedded shell, esh. The fesh shell
supports all of the esh builtin commands, as well as the following extra builtin
commands:
• ecp
• edf
• eecho
• els
• emkdir
• epwd
• erm
• ermdir

fesh © 2010, QNX Software Systems GmbH & Co. KG.
If fesh doesn’t recognize the arguments to a builtin command, it searches for an

executable file.
ecp command
ecp [-v] source destination
Copy source to destination, like the cp command. The -v option gives verbose output.
edf command
edf [path]
Report the free disk space for the filesystem associated with path. If you don’t specify
a path, fesh uses the current directory.
eecho command
eecho arguments
Write arguments to standard output, like echo. No options are defined.
els command
els [-l] [path]
List the contents of a directory, like ls. The els command supports only the -l
option, and displays the permissions in octal.
emkdir command
emkdir dir
Create a directory, like mkdir. No options are defined.
epwd command
epwd
Print the name of the current working directory, like the pwd executable.
erm command
erm file...
Remove the specified file or files. No options are supported.
The erm builtin command behaves like rm -f.
ermdir command
ermdir dir...
Similar to rmdir but doesn’t support any options.

© 2010, QNX Software Systems GmbH & Co. KG. fesh
See also:
esh, ksh, rsh, sh, uesh

fgrep © 2010, QNX Software Systems GmbH & Co. KG.
Fixed string grep (UNIX)
Syntax:
fgrep [-cilnqsvx]
[file...]
fgrep [-cilnqsvx] expression [file...]
Runs on:
Options:
See grep for a complete listing.
Description:
The fgrep utility does a fixed-string grep (equivalent to grep -F). See the
documentation for grep for details.
Exit status:
See also:
diff, find, grep, sort

© 2010, QNX Software Systems GmbH & Co. KG. file
Determine file type (UNIX)
Syntax:
file [-bcLnvz] [-f namefile] [-m magicfile] file ...
Runs on:
Neutrino
Options:
-b Don’t echo the name of the file before its type.
-c Cause a checking printout of the parsed form of the magic file. This
is usually used in conjunction with -m to debug a new magic file
before installing it.
-f namefile Read the names of the files to be examined from namefile (one per
line) before the argument list. Either namefile or at least one filename
argument must be present; to test the standard input, use - as a
filename argument.
-L Cause symlinks to be followed, as the like-named option in ls.
-m file Specify an alternate file of magic numbers. The default is

/usr/share/misc/magic.
-n Echo the name of the file before its type (this is done by default).
-v Print the version of the program and exit.
-z Try to look inside compressed files.
Description:
The file utility tests each file argument in an attempt to classify it. There are three
sets of tests, performed in this order:
1 Filesystem tests
2 Magic number tests
3 Language tests
The first test that succeeds causes the file type to be printed. The type printed usually
contains one of these words:
text The file contains only ASCII characters and is probably safe to read
on an ASCII terminal.
executable The file contains the result of compiling a program in a form

understandable to some UNIX kernel or another.

file © 2010, QNX Software Systems GmbH & Co. KG.
data Meaning anything else (data is usually “binary” or nonprintable).

Exceptions are well-known file formats (core files, tar archives)
that are known to contain binary data.
When modifying the file /usr/share/misc/magic or the program itself, preserve

these keywords. People depend on knowing that all the readable files in a directory
have the word text printed.
The filesystem tests are based on examining the return from a stat() system call. The
program checks to see if the file is empty, or if it’s some sort of special file. Any
known file types appropriate to the system you’re running on (sockets, symbolic links,
or named pipes (FIFOs) on those systems that implement them) are intuited if they’re
defined in the system header file /usr/include/sys/stat.h.
The magic number tests are used to check for files with data in particular fixed
formats. These files have a “magic number” stored in a particular place near the
beginning of the file that tells the UNIX operating system that the file is a binary
executable, and which of several types thereof. The concept of “magic number” has
been applied by extension to data files. Any file with some invariant identifier at a
small fixed offset into the file can usually be described in this way. The information in
these files is read from the magic file /usr/share/misc/magic.
If an argument appears to be an ASCII file, file attempts to guess its language. The
language tests look for particular strings that can appear anywhere in the first few
blocks of a file. For example, the keyword .br indicates that the file is most likely a
troff input file, just as the keyword struct indicates a C program. These tests are
less reliable than the previous two groups, so they are performed last. The language
test routines also test for some miscellany (such as tar archives) and determine
whether an unknown file should be labeled as ascii text or data.
Files:
/usr/share/misc/magic
Default list of magic numbers.
Written by Ian F. Darwin, UUCP address {utzoo|ihnp4}!darwin!ian, Internet
address ian@sq.com, postal address: P.O. Box 603, Station F, Toronto, Ontario,
CANADA M4Y 2L8.
Altered by Rob McMahon, cudcv@warwick.ac.uk, 1989, to extend the & operator
from simple x&y != 0 to x&y op z.
Altered by Guy Harris, guy@auspex.com, 1993, to:
• Put the “old-style” & operator back the way it was, because 1) Rob McMahon’s
change broke the previous style of usage, 2) the SunOS “new-style” & operator,

© 2010, QNX Software Systems GmbH & Co. KG. file
which this version of file supports, also handles x&y op z, and 3) Rob’s change
wasn’t documented in any case;
• Put in multiple levels of >
• Put in beshort, leshort, etc. keywords to look at numbers in the file in a

specific byte order, rather than in the native byte order of the process running file.
Changes by Ian Darwin and various authors including Christos Zoulas

(christos@ee.cornell.edu), 1990-1992.
License:
Copyright © Ian F. Darwin, Toronto, Canada, 1986, 1987, 1988, 1989, 1990, 1991,
1992, 1993.
This software is not subject to and may not be made subject to any license of the
American Telephone and Telegraph Company, Sun Microsystems Inc., Digital
Equipment Inc., Lotus Development Inc., the Regents of the University of California,
The X Consortium or MIT, or The Free Software Foundation.
This software is not subject to any export provision of the United States Department of
Commerce, and may be exported to any country or planet.
Permission is granted to anyone to use this software for any purpose on any computer
system, and to alter it and redistribute it freely, subject to the following restrictions:
1 The author is not responsible for the consequences of use of this software, no
matter how awful, even if they arise from flaws in it.
2 The origin of this software must not be misrepresented, either by explicit claim
or by omission. Since few users ever read sources, credits must appear in the
documentation.
3 Altered versions must be plainly marked as such, and must not be

misrepresented as being the original software. Since few users ever read
sources, credits must appear in the documentation.
4 This notice may not be removed or altered.
A few support files (getopt(), strtok()) distributed with this package are by Henry
Spencer and are subject to the same terms as above. A few simple support files
(strtol(), strchr()) distributed with this package are in the public domain; they are so
marked.
The files tar.h and is_tar.c were written by John Gilmore from his public-domain
tar program, and are not covered by the above restrictions.
Source:
You can obtain the original author’s latest version by anonymous FTP on
tesla.ee.cornell.edu in the directory /pub/file-X.YY.tar.gz.

file © 2010, QNX Software Systems GmbH & Co. KG.
Caveats:
The file utility uses several algorithms that favor speed over accuracy, thus it can be
misled about the contents of ASCII files. The support for ASCII files (primarily for
programming languages) is simplistic, inefficient and requires recompilation to update.
See also:

© 2010, QNX Software Systems GmbH & Co. KG. find
Find files (POSIX)
Syntax:
find path... [operand_expression]
find [limited_operand_expression]
Runs on:
Options:
path... Pathnames under which find should search for files. The utility traverses
the pathname tree from these files down, looking for files that match the
search criteria specified by the operand_expression. If no paths are
specified, and the expression meets the criteria of a
limited_operand_expression (below), then a path of . is assumed.
operand_expression
An expression composed of any set of the primary expressions and
operators described below.
limited_operand_expression
An expression composed of any of the primary expressions and operators
described below, except for -exec, -ok, and -spawn.
Description:
The find utility recursively descends the directory hierarchy for each file specified by
path and seeks files that match operand_expression.
If you don’t specify an operand_expression or limited_operand_expression on the
command line, find uses -print (i.e. the utility matches every file and directory,
printing each pathname on its own line to standard output).
The operand expression follows one or more pathnames. The find utility treats as a
pathname all the arguments up to the first one starting with any of these characters:
- ! (
Everything after that is part of the operand expression.
You’ll probably have to quote some operands and patterns, depending on the shell that
you’re using.
Operand expressions are made up of primaries and operators. The following operators
are supported:

find © 2010, QNX Software Systems GmbH & Co. KG.
Operator Action
! (NOT)
-a (AND)
-o (OR)
AND operations have higher precedence than OR operators. Negation (!) has a higher
precedence than AND operators. Parentheses are supported to override the normal
precedence rules.
The rules that apply to primaries and operators are:
Expression Evaluates to
-primary True if primary is true.
( expression ) True if expression is true.
! expression (NOT) Negation of a primary or expression enclosed in
parentheses.
expression [-a] expression (AND) True if both expressions are true. If the first
expression is false, the second expression isn’t
evaluated. The -a is optional. AND is implied by the
juxtaposition of two expressions (see below).
expression -o expression (OR) True if either expression is true. If the first
expression is true, the second expression isn’t
evaluated.
As mentioned above, the -a operand is optional. If you want to match files of two
different patterns, you might be inclined to use this command:
find . -name "*˜" -o -name "*.o" -print
but this doesn’t work the way you might expect it to because of the implicit -a before
the -print expression. The rules of precedence make the above command equivalent
to this:
find . $ -name "*˜" $ -o $ -name "*.o" -a -print $
You should specify the command like this:
find . $ -name "*˜" -o -name "*.o" $ -print

Primary expressions
Note that if you don’t supply an expression, find behaves as if you specified -print.
If you specify an expression, but it doesn’t contain a -chmod, -chown, -exec, -fls,
-fprint, -fprint0, -fprintf, -ls, -ok, -print, -print0, -printf,
-rename, -remove!, or -spawn primary, the find utility operates as if you specified
the following expression:
( given_expression ) -print
Whenever a primary expression uses a number (n), you can optionally precede it by a
plus (+) or minus (-) sign, which changes the meaning as follows:
Expression Means
+n More than n
-n Less than n
n Exactly n
We’ve classified the primary expressions as follows, in case you’re interested in using
find in a portable manner:
POSIX Supported by any POSIX find implementation.
GNU Supported by the QNX Neutrino and GNU find

implementations.
QNX Neutrino Supported only by the QNX Neutrino implementation.
The primary expressions are:
-abort (QNX Neutrino) Immediately terminate the find with a

nonzero exit status.
-amin n (GNU) True if the file was last accessed n minutes ago.
-anewer file (GNU) True if the file being evaluated was accessed more
recently than file.
-atime n (POSIX) True if the file access time subtracted from the time
that the find utility started running is between n-1 and n
multiples of 24 hours. For example, find . -atime 1 finds
all files under the current directory for which the file was
accessed within the last 24 hours.
-chgrp gname (QNX Neutrino) Change the file group ownership of the file
currently being evaluated to gname. If gname is numeric and

the name doesn’t exist in the group database, gname is taken as

a group ID.
Specifying -chgrp inhibits the automatic -print when the
expression as a whole evaluates to true.
-chmod mode (QNX Neutrino) Change the permissions of the file currently
being evaluated according to the specified mode.
The mode argument represents file mode bits. It’s identical to
the symbolic_mode operand described in chmod and is
interpreted as follows.
A file mode has the form:
who{op}perm[,mode...]
where
• who may be
who Permissions for:

u The user who owns the file
g The owner’s group
o Others
a All users (equivalent to ugo)
You can combine these. For example, if you specify ug, the
subsequent op and perm arguments are applied to the user
and group permissions on the file.
• op may be:
op Action
+ Sets the appropriate mode bits
- Clears the appropriate mode bits
= Sets the appropriate mode bits, regardless of the process’s
file mode creation mask
• and perm may be any combination of
perm Meaning
r Read permission
w Write permission (create/unlink for directories)
continued. . .

perm Meaning
x Execute permissions (search for directories)
s Setuid for owner or setgid for group, sticky for
directories
For example, to remove write permission for group and other

from the file being evaluated, use -chmod go-w.
Specifying -chmod inhibits the automatic -print when the
-chown uname[:gname]
(QNX Neutrino) Change the file ownership of the file currently
being evaluated to the one specified, taking a ownership
specification similar to that accepted by the chown utility. A
user name uname must be specified, optionally followed by a
colon (:) and group name gname. The uname and gname
parameters may be either an ASCII name or the actual numeric
user or group ID.
Specifying -chown inhibits the automatic -print when the
-cmin n (GNU) True if the file status was last changed n minutes ago.
-cnewer file (GNU) True if the file being evaluated had its status changed
more recently than that of file.
-ctime n (POSIX) True if the file change of status time subtracted from
the time that the find utility started running is between n-1 and
n multiples of 24 hours.
-daystart (GNU) Always true. When used, this primitive causes find to
globally alter the behavior of the -atime, -ctime, and
-mtime primitives: instead of comparing file times to n
24-hour periods before the current time, it compares file times
to n 24-hour periods before the beginning of the current
calendar day.
-depth (POSIX) Always true; causes descent of the directory hierarchy

to be done so that all entries in the directory are acted on before
the directory itself. If no -depth primary is specified, all
entries in the directory are acted on after the directory itself. If
any -depth primary is specified, it applies to the entire
expression even if the -depth primary isn’t normally
evaluated.

-echo [text] ; (QNX Neutrino) Write the supplied text to standard output. If
the text contains any braces ({}), they’re interpreted as in the
-exec primitive to represent the pathname being evaluated.
Specifying -echo inhibits the automatic -print when the
-empty (GNU) True if the file is a regular file of size 0, or a directory

that contains no files.
-errmsg [text] ; (QNX Neutrino) Similar to -echo, except the output is written
to standard error.
Specifying -errmsg inhibits the automatic -print when the
-error (QNX Neutrino) Cause the exit status to be nonzero when the
find is completed. This primary always evaluates to false and is
typically used with -exec. For example, if you enter:
find /bin -type f $ -exec cmp {} /hd{} \; \
-o -error $
find exits with a nonzero status if any of the files in /bin

don’t compare successfully against the same files under
/hd/bin.
-exec utility_name [argument...] ;
(POSIX) True if the executed utility utility_name returns a zero
value as exit status. The end of the primary expression is
punctuated by a semicolon (;).
If a utility_name or argument contains {...}, the {...} is
replaced by the current pathname or a portion thereof as
follows:
A {} in a utility_name or argument is replaced by the
pathname being evaluated. Such arguments are used by -echo,
-errmsg, -exists, -fanewer, -fcnewer, -fmnewer,
-fnewer, -ok, -rename and -spawn in addition to -exec.
The current directory for the execution of utility_name is the
same as the current directory when the find utility was started.
Specifying -exec inhibits the automatic -print when the
There is a QNX Neutrino-only extension to the {} syntax for
stripping leading and trailing characters. You may also opt to
insert the filename stripped of a number of characters at the end
(strip) or the filename less a number of characters at the
beginning (skip). The syntax for this is
{[strip][,skip]}

So, to move all files ending in .c to the same names ending in

.C, one might use:
find . -type f -name ’*.c’ \

-exec ’mv {} {1}C’ \;
-exists filestring (QNX Neutrino) True if the file represented by filestring exists.
The filestring may be a simple filename or it may contain braces
({}) to represent the name of the file currently being evaluated,
in the same manner as used with the -exec primitive.
-false (GNU) Always false.
-fanewer filestring (QNX Neutrino) True if the file was accessed more recently
than the file represented by filestring.
-fcnewer filestring (QNX Neutrino) True if the file had its status changed more
recently than the file represented by filestring.
-fls file (GNU) Always true. Similar to -ls, but output is written to file
instead of the standard output.
Specifying -fls inhibits the automatic -print when the
-fmnewer filestring (QNX Neutrino) True if the file was modified more recently
than the file represented by filestring.
-fnewer filestring (QNX Neutrino) Synonym for -fmnewer (above).
-Fnewer file (QNX Neutrino) True if the file being evaluated was created
more recently than file.
-follow (GNU) Always true. When -follow is specified, find treats

symbolic links as being the type of the file they point to. If the
link points to a directory, find recurses into that directory. By
default, symbolic links are treated as special files of type
symbolic link. What they point to is irrelevant to find’s default
behavior.
-fprint file (GNU) Similar to -print, but output is written to file instead
of to the standard output.
Specifying -fprint inhibits the automatic -print when the
-fprint0 file (GNU) Similar to -print, but each file name is followed by a
NUL instead of a newline character, and the output is written to
file instead of to the standard output.
Specifying -fprint0 inhibits the automatic -print when the

-fprintf file format

(GNU) Always true. Write data pertaining to the file currently
being evaluated to file, according to the format specified. See
“Formatted Printing” for details on the format string.
Specifying -fprintf inhibits the automatic -print when the
-gid n|groupname (GNU) Synonym for -group.
-group gname (POSIX) True if the file belongs to the group gname. If gname
is numeric and the name doesn’t exist in the group database,
gname is taken as a group ID. Note that gname is evaluated
only once.
-ilname fpattern (GNU) Similar to -lname, but case-insensitive in the pattern

match.
-iname fpattern (GNU) Similar to -name, but case-insensitive in the pattern

match.
-inode file|n (QNX Neutrino) True if the file uses the same inode (has the
same serial number) as the named file. If the file doesn’t exist
and is numeric, the number is used as the serial number to
match. This primary is used to find links to a file.
-inum n|file (GNU) Synonym for -inode.
-ipath fpattern (GNU) Like -path, but case-insensitive when evaluating the
pattern match.
-iregex ere (GNU) Like -regex, but case-insensitive when evaluating the
regular expression match.
-level n (QNX Neutrino) True when the level down in a directory tree is
n. A file or directory specified on the command line is
considered level 0. For example, this command:
find /usr -level 1 -type d \

-print -o \
-level 2 -prune -type f \
-name .usrinit -ls
displays all the directories in /usr, and for each directory that
has a .usrinit file, displays information on that file in ls -l
format. (The -prune at level 2 prevents unnecessary
processing in walking down the directory tree. Though no files
further down could possibly match the -level 1 or -level
2 criteria, find doesn’t detect this automatically — the
command-line expression is applied against every file in the
directory tree unless a full recursion of that tree is prevented by
a -prune primitive.)

The following command:
find /usr -level 1 -ls -prune

displays information in ls -l format only on files in /usr and
doesn’t descend into any subdirectories of /usr.
-links n (POSIX) True if the file has n links.
-lname fpattern (GNU) True if -follow or -logical isn’t specified, and the
file being evaluated is a symbolic link whose target is a
pathname that matches the pattern fpattern.
-logical (QNX Neutrino) Synonym for -follow.
-ls (GNU) Similar to -print, but displays in the same format as

ls -l.
Specifying -ls inhibits the automatic -print when the
-maxdepth n (GNU) Always true. When this flag is set, find descends at
most n levels in the directory hierarchy. Files that are named on
the command line are level 0. Note: the + and - modifiers have
no meaning when used in conjunction with n in this primary.
-mindepth n (GNU) Always true. When this flag is set, find doesn’t apply
the expression to files unless the files are at least n levels down
in the directory hierarchy. Files named on the command line are
level 0. Note: the + and - modifiers have no meaning when
used in conjunction with n in this primary.
-mmin n (GNU) True if the file data was last modified n minutes ago.
-mnewer file (QNX Neutrino) True if the file being evaluated was modified
more recently than file was.
-mount (GNU) Synonym for -xdev.
-mtime n (POSIX) True if the file modification time subtracted from the
time that the find utility started running is between n-1 and n
multiples of 24 hours.
-name pattern (POSIX) True if the basename of the filename being examined
matches pattern. This follows the same pattern-matching rules
as used by fnmatch() (see the Neutrino Library Reference).
-newer file (POSIX) True if the current file has been modified more
recently than file has. Note that file is evaluated only once.
-nogroup (POSIX) True if the file belongs to a group ID that isn’t in the
group database.

-NOP (QNX Neutrino) Always true, does nothing. This primitive has
the side effect of disabling the implicit -print that occurs
when the expression as a whole evaluates to true. You can use
this primitive to benchmark the time it takes to do a walk of the
filesystem. For example:
find / -NOP
-nouser (POSIX) True if the file belongs to a userid that isn’t in the
password database.
-ok utility_name [argument...] ;
(POSIX) Similar to -exec, except that find requests
affirmation of the execution of utility_name using the current
file as an argument by writing to standard error. If the response
on standard input is affirmative, the utility is executed. If the
response isn’t affirmative, the command isn’t executed and the
value of the -ok operand is false.
Specifying -ok inhibits the automatic -print when the
-path fpattern (GNU) True for any file whose path (as would be printed by
-print) matches fpattern.
-perm [-]mode (POSIX) The mode argument represents file mode bits. It’s
identical to the symbolic_mode operand described in chmod
and is interpreted as follows. To start, a template is assumed
with all file mode bits cleared. An op symbol of:
Operator Action
+ Sets the appropriate mode bits
- Clears the appropriate mode bits
= Sets the appropriate mode bits, regardless of the
process’s file mode creation mask
An op symbol of - can’t be the first character of mode.

If the optional hyphen preceding mode is omitted, the primary
is true when the file permission bits exactly match the value of
the resulting template. In addition, the bits associated with the
perm symbol s are ignored. If the hyphen is included, the
primary is true if at least all the bits in the resulting template are
set.
-perm [-] onum (POSIX) If the optional hyphen is omitted, the primary is true
when the file permission bits exactly match the value of the

octal number onum and only the bits corresponding to the octal
mask 777 are compared.
If the hyphen is included, more flag bits, corresponding to the
octal mask 06777, are compared and the primary is true if at
least all the bits in onum are set.
-pname pattern (QNX Neutrino) Synonym for -path.
-print (POSIX) Always true; causes the current pathname to be

written to standard output, one pathname per line.
Specifying -print inhibits the automatic -print when the
-print0 (GNU) Always true. Writes the path currently being evaluated
followed by an ASCII NUL character to the standard output.
Specifying -print0 inhibits the automatic -print when the
-printf format (GNU) Always true. Write data pertaining to the file currently
being evaluated to the standard output, according to the format
specified. For more information, see “Formatted printing,”
below.
Specifying -printf inhibits the automatic -print when the
-prune (POSIX) Stops find’s descent from that point in the file
hierarchy.
-regex ere (GNU) True when the pathname of the file currently being
evaluated matches the extended regular expression specified by
ere. See the grep documentation for details on regular
expressions.
-remove! (QNX Neutrino) Removes the file being evaluated. If the file is
a directory, rmdir() is performed, otherwise an attempt is made
to unlink() the file.
If a directory isn’t empty, the attempt to remove it fails. Thus,
to recursively remove a directory tree with find, the -depth
primitive must be used in conjunction with -remove!. (Note
the simple removal of a directory tree is better and more
portably done by using the rm utility.)
This primitive evaluates to TRUE if the removal was
successful. Note that the exclamation mark (!) is a required
part of this primitive.
Specifying -remove! inhibits the automatic -print when the

-rename filestring (QNX Neutrino) Renames the file to the pathname indicated by
filestring. As with other filestring arguments, braces ({})
encountered in the string are expanded to the name of the file
currently being evaluated. A file may be renamed anywhere
within the same filesystem. If the new path lies on another
device, the rename fails. Evaluates to true if the rename
succeeds, false if it fails.
Specifying -rename inhibits the automatic -print when the
-size n[c] (POSIX) True if the file size in bytes, divided by 512 and
rounded up to the next integer, is n. If n is followed by c, the
size is in bytes.
-spawn cmd [arguments]... ;
(QNX Neutrino) Similar to -exec, except that the command is
invoked directly (i.e. not through a shell). The -spawn primary
is faster but less flexible than -exec.
Specifying -spawn inhibits the automatic -print when the
-true (GNU) Always true.
-type c (POSIX) True if the file type is c, where c is one of:
Filetype Description
b Block special file
c Character special file
d Directory
p FIFO
f Regular file
l Symbolic link
n Named special file
-uid n|userid (GNU) Synonym for -user.
-used n (GNU) True if file was last accessed n days after its status was
last changed.
-user uname (POSIX) True if the file belongs to the user uname. If uname is
numeric and the name doesn’t exist in the password database,
uname is taken as a user ID. Note that uname is evaluated only
once.

-xdev (POSIX) Always true — stops find from descending past

directories that have a different device ID. If any -xdev
primary is specified, it applies to the entire expression, even if
the -xdev primary isn’t normally evaluated.
Formatted printing (-printf and -fprintf primitives)

The -printf and -fprintf primaries require as arguments a format string similar in
appearance to that used in the C language printf() function. The format string consists
of regular ASCII characters and a set of special codes starting with percent (%) format
codes and backslash (\) escape codes.
Backslash (\) Escape Codes
\\ Literal backslash (\) character.
\a Alarm bell.
\b Backspace character.
\c Stop printing from format and flush output.
\f Form-feed character.
\n Newline character.
\r Carriage return character.
\v Vertical tab character.
Format Codes
%% Literal percent (%) character.
%p The pathname currently being evaluated.
%f The basename of the file.
%h The dirname of the file.
%P The name of the file with the root of the file tree (pathname specified on
the command line) removed from the beginning.
%H The name of the root of the file tree (pathname specified on the command
line under which the current file was found).
%g The file’s group name, or numeric group ID if no name found.
%G The file’s numeric group ID.
%u The file’s user name, or numeric userid if no name found.
%U The file’s numeric userid.

%m The file’s permissions in octal.
%k The file’s size in 1k blocks (rounded up).
%b The file’s size in 512-byte blocks (rounded up).
%s The file’s size in bytes.
%d The depth of the file in the directory tree. The files specified on the
command line have a depth of 0.
%l If the file is a symbolic link, the filename of the link object. Null if file
isn’t a symbolic link.
%i The inode number of the file.
%n The link count of the file.
%a The file’s last access date and time; equivalent to %Ac
%Afchar Partial or full representation of the file’s last access time, depending on
the format character fchar:
fchar Is replaced by:

a Abbreviated weekday name
A Full weekday name
b Abbreviated month name
B Full month name
c Locale’s appropriate date and time representation
d Day of the month as a decimal number (01-31)
D Date in the format mm/dd/yy
h Abbreviated month name
H Hour (24 hr) as a decimal number (00-23)
I Hour (12 hr) as a decimal number (01-12)
j Day of the year as a decimal number (001-366)
m Month as a decimal number (01-12)
M Minute as a decimal number
n Newline character
p AM or PM
continued. . .

fchar Is replaced by:

r 12-hr clock time (01-12) using the AM/PM notation i.e. hh:mm:ss
(AM|PM)
S Second as a decimal number (00-59)
t Tab character
T 24-hr clock time (00-23) hh:mm:ss
U Week number of the year as a decimal number (00-52), where
Sunday is the first day of the week
w Weekday as a decimal number (0-6), where 0 is Sunday
W Week number of the year as a decimal number (00-52), where
Monday is the first day of the week
x Locale’s appropriate date representation
X Locale’s appropriate time representation
y Year without century as a decimal number
Y Year with century as a decimal number
Z Timezone name, NULL if no timezone exists
QNX Neutrino currently supports only the POSIX (i.e. C) locale.
%c File’s last status change date and time — equivalent to %Cc

%Cfchar Partial or full representation of the file’s last status change time,
depending on the format character fchar. See description of %A, above for
details.
%t File’s last modification date and time — equivalent to %Tc
%Tfchar Partial or full representation of the file’s last modification time, depending
on the format character fchar. See description of %A, above for details.
Examples:
Search the filesystem for the myfile file or directory:
find / -name myfile
Remove all files named tmp or ending in .xx that haven’t been accessed for seven or
more 24-hour periods:
find / $ -name tmp -o -name ’*.xx’ $ \
-atime +7 -exec rm {} \;
Print the pathnames of all files in and below the current directory, but skip any
directories named SCCS and the files beneath them:

find . -name SCCS -prune -o -print
Note that when possible, it’s better to use find in combination with xargs than it is
to use the -exec or -spawn options to start commands. You can use xargs to start a
program once for many files; -exec or -spawn starts the program once for every file
matched. You’ll see a tremendous difference in speed between the two approaches.
For instance:
find / -name ’*.tmp’ | xargs rm
is generally preferable to:
find / -name ’*.tmp’ -exec rm {} \;
See xargs for more details.
Exit status:
0 All path operands were successfully traversed.
Caveats:
If you use -exec, -ok, or -spawn, find catches SIGINT (which you can generate, for
example, by pressing Ctrl-C or Ctrl-Break) and asks you whether the find should
continue. If these primaries aren’t used, find terminates from SIGINT.
See also:
chmod, chown, mv, pax, rm, xargs

© 2010, QNX Software Systems GmbH & Co. KG. finstall
Install a self-hosted QNX Neutrino system (QNX Neutrino)
Syntax:
finstall [-c config] [options]...
Runs on:
QNX Neutrino
Options:
See below.
Description:
The finstall utility installs a self-hosted QNX Neutrino system.
WARNING: Running this utility will destroy your current installation of QNX
Neutrino. The only reason we ship finstall is to allow customers to create a
custom installer boot image. This will likely happen only under the direction of
our support staff.

flashctl © 2010, QNX Software Systems GmbH & Co. KG.
Manage a flash filesystem
Syntax:
flashctl [-eFfimruvxz] [-A] [-a flags] [-b align]
[-c flag] [-L] [-l limit] [-n path] [-o offset]
-p path [-s num] [-U] [-u] [-v...]
Runs on:
Neutrino
Options:
The options are processed in the order given, and apply to the last partition specified
by a -p option, letting you control multiple partitions with one command.
-A Unlock the entire flash array specified by the preceding -p option.
Use this option only with a “raw” device (e.g. /dev/fs0); don’t use it with a mounted
partition. You can’t use the -l and -o options with the -A option.
-a flags The mount-attribute flags (the default is 0).
-b align Set the alignment to 2align (default 2).
-c flag Set the compression flag (default 1).
-e Erase the raw partition specified by the preceding -p option from the
offset specified by the -o option through to limit specified by the -l
option.
If you specify the -v option for verbose output, flashctl outputs a
period (.) for every partition unit that it erases. On RAM disk, the unit
size is 64K; on other devices, it varies. This output is reassuring because
it can take several minutes to erase slow flash devices.
-f Format the raw partition specified by the preceding -p option from the
offset specified by the -o option through to limit specified by the -l
option.
-F Force the driver to use the given offset and length parameters, even if the
offset and length parameters don’t fall within the bounds of the partition
specified by the preceding -p option. The range provided by the -o and
-l arguments must fit in a single partition, and can’t cross partition
boundaries.
-i Print filesystem information for the partition specified by the preceding

-p option; see “Filesystem information,” below.

© 2010, QNX Software Systems GmbH & Co. KG. flashctl
-L Lock the raw partition specified by the preceding -p option from the
offset specified by the -o option through to limit specified by the -1
option.
The -L option fails if the partition (e.g. /dev/fs0p0) is mounted.

You can use /dev/fs0 to bypass the mounted filesystem check, but we don’t
recommend that you do so, because the /dev/fs0 path bypasses all protection
mechanisms. If you use it, the flash driver doesn’t know what filesystem or partition
the locking affects. The filesystem might think the flash is writable and suddenly it
isn’t. The filesystem will get very confused, and write operations will start to fail.
Worse yet, if you lock a single block in a filesystem via /dev/fs0, most of your
writes will fail and suddenly stop working.
-l limit Specify a size limit in bytes (default 2G) for the partition specified by the
preceding -p option. The limit can include a suffix of k, K, m, M, g, or G.
-m Mount the filesystem partition specified by the preceding -p option. The
-m option doesn’t work when you use the -o offset option. You must
restart the driver for the partition to be recognized.
-n path Specify the filesystem mountpoint for the partition specified by the
preceding -p option.
This option overrides any mountpoint specified with the mount attribute
of the mkefs command.
-o offset Specify the offset in bytes (default 0 bytes). The offset can include a
suffix of k, K, m, M, g, or G.
-p path Specify the raw mountpoint for the partition.
-r Reclaim deleted blocks on the partition specified by the preceding -p
option, up to the limit specified by the -l option.
-s num Specify the number of spare blocks (default 1) on the partition specified
by the preceding -p option.
-U Unlock the raw partition specified by the preceding -p option from the
offset specified by the -o option through to limit specified by -l option.
The -U option fails if the partition (e.g. /dev/fs0p0) is mounted.

You can use /dev/fs0 to bypass the mounted filesystem check, but we don’t
recommend that you do so.
-u Unmount the filesystem partition specified by the preceding -p option.
-v... Be verbose; more v characters cause more verbosity.
-x Exit the driver.
-z Query for the compression flag.

Description:
The flashctl utility is used to manage a flash filesystem. The utility interacts with
the flash filesystem driver using devctl() messages. Using flashctl, you can erase
and format a raw partition, force a reclaim operation, and get information about flash
filesystem partitions.
• The options are processed in the order entered. For example, you must erase (-e),
format (-f), and mount (-m) a partition in this order.
• For now, use flashctl instead of mount and umount to mount and unmount flash
partitions.
The flashctl utility rounds the values of the -o and -l (“el”) options down to the
nearest block bound. If the range specified exceeds the partition size, it’s rounded
down to fit. If you use the -v option, flashctl displays what the values have been
rounded to.
Filesystem information
If you use the -i option, flashctl displays information about the partition that you
chose with the -p option; the amount of information depends on what you chose (the
raw socket, raw partition, or formatted mounted filesystem):
• /dev/fs0 points to the entire socket, which means the whole chip (or all
physically contiguous chips). This is the Array Info listed below.
• /dev/fs0pX refers to a partition, referred to as a Part.
• The erase sectors on flash are referred to as Units.
Here’s an example of the output:

Array Info
Total : 0x00800000 100%
Chip Size : 0x00800000 100%
Unit Size : 0x00020000 1%
Part Info
Total : 0x00800000 100%
Spare : 0x00020000 1%
Headers : 0x00001A34 0%
Padding : 0x00000000 0%
Overhead : 0x00021A34 1%
Free : 0x007DE5AC 98%
Stale : 0x00000000 0%
Avail. : 0x007DE5AC 98%
Reserved : 0x00000020 0%
Unit Info
Erase Stats
Average : 0
Minimum : 0
Maximum : 0
Total : 0
Here’s how to interpret the output:

© 2010, QNX Software Systems GmbH & Co. KG. flashctl
Array Info The total amount of contiguous flash at the specified base address:
• Total — the size.
• Chip Size — the size of each chip if there are multiple
physical chips (they’re assumed to all be the same size).
• Unit Size — the size of one sector, and the percentage of the
total size.
Part Info Information for the requested partition. Sizes are given in bytes and
as a percentage of the size of the partition; some fields might not be
filled in:
• Total — the partition size.
• Spare — the amount of space used for spare blocks;
Spare/Unit Size gives the number of spare blocks.
• Headers — the space used for filesystem extent headers.
• Padding — the space used for alignment padding.
• Overhead — the total of Headers + Padding.
• Free — the amount of free space (no reclaim necessary).
• Stale — the amount of stale space.
• Avail. — the total amount of usable space; this is the total of
Free + Stale.
• Reserved — internal reserved space for unlinking, etc.
Unit Info Information pertaining to individual sectors:

• Erase Stats — the average, minimum, maximum, and total
number of erasures performed within the specified partition.
Examples:
Create a flash filesystem between 1 MB and 3 MB in a 4 MB raw partition:
flashctl -p /dev/fs0p0 -o 1M -l 2M -e -f
This command line results in this organization:
/dev/fs0p0 A raw partition at 0–1 MB
/dev/fs0p1 A flash filesystem partition at 1–3 MB (mounted as /fs0p1)
/dev/fs0p2 A raw partition at 3–4 MB
Erase, format, and then mount (as /fs0p0) the flash filesystem partition
/dev/fs0p0:

flashctl -p /dev/fs0p0 -e -f -m
Mount the given flash filesystem partition as /flash:
flashctl -p /dev/fs0p0 -n /flash -m
Use the following command to format the range from 3 to 6 MB, if the layout is
unknown:
flashctl -p /dev/fs0p0 -F -o 3m -l 6m -f
For devf-ram partitions only, you must format and erase a partition before you can
mount the flash filesystem. Otherwise, you may get an error message flashctl:
mounting partition failed.
Caveats:
The mount facility (with the -m and -u options) doesn’t provide complete mount
functionality, such as read-only (mount -r) and special options (mount -o).
See also:
devf-generic, devf-ram, mkefs
“FFS3 filesystem” in the Filesystems chapter of the System Architecture.

© 2010, QNX Software Systems GmbH & Co. KG. flex
Generate programs for lexical tasks
Syntax:
flex [-bcdfhilnpstvwBFILTV78+? -C[aefFmr] -ooutput
-Pprefix -Sskeleton] [--help --version] [file ...]
Runs on:
Options:
-+ Generate C++ scanner class.
-7 Generate 7-bit scanner.
-8 Generate 8-bit scanner.
-? Display a help message.
-B Generate batch scanner (opposite of -I).
-b Generate backing-up information to lex.backup.
-C Specify the degree of table compression (default is -Cem):

• -Ca — trade off larger tables for better memory alignment.
• -Ce — construct equivalence classes.
• -Cf — don’t compress scanner tables; use -f representation.
• -CF — don’t compress scanner tables; use -F representation.
• -Cm — construct meta-equivalence classes.
• -Cr — use read() instead of standard I/O for scanner input.
-c Do-nothing POSIX option.
-d Turn on debug mode in generated scanner.
-F Use the alternative fast scanner representation.
-f Generate fast, large scanner.
-I Generate an interactive scanner (opposite of -B).
-i Generate case-insensitive scanner.
-L Suppress #line directives in scanner.
-l (“el”) Provide maximal compatibility with original lex.
-n Do-nothing POSIX option.
-ooutput Specify the output filename.

flex © 2010, QNX Software Systems GmbH & Co. KG.
-Pprefix Specify a scanner prefix other than yy.
-p Generate a performance report to stderr.
-Sskeleton Specify the skeleton file.
-s Suppress default rule to ECHO unmatched text.
-T Run flex in trace mode.
-t Write the generated scanner on stdout instead of lex.yy.c.
-V Report the flex version.
-v Write a summary of scanner statistics.
-w Don’t generate warnings.
--help Display a help message.
--version Report the flex version.
Description:
The flex command generates programs for lexical tasks.
QNX does not provide the flex library (libfl.a). If you wish to generate code that is
not dependent on this library, add the following line as the first line in your lex source
file:
%option noyywrap
Otherwise, the undefined yywrap() function will result in a link error.

For more information, see the GNU website at http://www.gnu.org/.
GNU

© 2010, QNX Software Systems GmbH & Co. KG. fmt
Format concatenated input
Syntax:
fmt [-w width] [-m maximum] [-] [file...]
Runs on:
Neutrino
Options:
-m maximum The maximum line length. The default is 75 characters.
-w width Make the lines as close to width as possible. The default width is 65
characters.
- Read from standard input
file... The file or files to be formatted.
Description:
The fmt utility concatenates the input files, formats the output as specified by the
width and maximum options, and sends the results to standard output. Non-indenting
tabs are converted to spaces; tabs are used for indentation where possible. If no input
files are given, fmt reads from standard input.

fold © 2010, QNX Software Systems GmbH & Co. KG.
Fold lines (POSIX)
Syntax:
fold [-bs] [-w width] [file...]
Runs on:
Neutrino
Options:
-b Count width in bytes rather than column positions. If -b is specified,
carriage-return, backspace and tab are treated as normal
characters. Only newline remains special.
-s If a segment of a line contains a blank within the first width column
positions, break the line after the last such blank meeting the width
constraints (i.e. avoid breaking the line in the middle of a word).
-w width Specify the maximum line length. The default is 80 characters.
Description:
The fold filter folds lines in files by breaking up lines that have a width in excess of
80 or, if specified, the width in the command-line -w option. Lines are folded by the
insertion of a newline character. All output is written to the standard output.
In all cases, the current count of line width is reset to zero when a newline character
is encountered in the input. In addition, when the -b option is not specified, the
following characters have a special meaning when encountered in the input:
carriage-return
The current count of line width is set to zero.
backspace The current count of line width is decremented by one (but it doesn’t
go below zero).
tab The current count of line width is incremented to the next count for
which count modulo 8 equals 1.
Examples:
Fold the file myfile.txt to a maximum line width of 80 characters, making the line
breaks on the last word boundary (white space) before the width was exceeded and
write the results to the standard output:
fold -s myfile.txt
Fold the file myfile.txt to a width of 40 characters, and treat all characters except
newline as occupying one character (byte) position and write the results to the
standard output:
fold -bw40 myfile.txt

© 2010, QNX Software Systems GmbH & Co. KG. fold
Files:
If no files are specified on the command line, fold reads lines to be folded from the
standard input until EOF is reached.
The fold utility writes all folded output from all input files to the standard output.
If an error occurs, a diagnostic message is written to the standard error.
The fold utility reads lines from the text files specified on the command line. If the
-b is specified, the input files need not be text files.
Exit status:
0 All files were processed successfully.
See also:
pr, sed

fontinfo © 2010, QNX Software Systems GmbH & Co. KG.
Displays information about a given font
Syntax:
fontinfo -f file [-S size] [-v] [-r] [-s dir]
[-t file] [-c ch] [-C ch]
[-u][<code|code-code> [...]]
Runs on:
Neutrino
Options:
-f file The font file to display information about. This argument must be a path to
the font file.
-S An integer defining the font size of the rendered font. The default size is
10. This applies to scalable fonts only.
-v Display more verbose information.
-r Render each character to the screen using ASCII characters.
-s dir A path to the directory of the font rendering engine.
-t file The unicode file tab to display the name of each character. See note below.
-c ch Render each character to the screen, using the supplied character to fill the
white space around the character. This option uses an asterisk to render the
font to the screen. The supplied character fills in the white space around the
glyph.
-C ch Render each character to the screen, using only the supplied character in
the rendering. This option renders the character to the screen without using
a character to fill up the white space.
-u Display the UTF8 string as a string, instead of the default hex dump.
<code|code-code> [...]
Specifies the character code or code range to process or render. This
command line option may be repeated.
Description:
The fontinfo utility returns information and metrics about each glyph in a given
font file, or for a specified code list or range(s).
You can render each glyph in the font file to the screen (using ASCII characters) by
using the -r option. You can render only a subset of glyphs in the font file by
specifing a code range.

© 2010, QNX Software Systems GmbH & Co. KG. fontinfo
The unicode tab file that is used by the -t argument must use the following format:
<Unicode hexcode>,<character description>
For example:
0021,EXCLAMATION MARK
0022,QUOTATION MARK
0023,NUMBER SIGN
0024,DOLLAR SIGN
0025,PERCENT SIGN
0026,AMPERSAND
You can obtain a unicode tab file from www.unicode.org.
Examples:
In the following example, the fontinfo utility is called using the font file webt.ttf.
Each glyph in the file is rendered to the screen using the . character. The size of each
glyph is 20 characters.
fontinfo -f web.ttf -r -C . -S 20
The output for a single glyph in the font file is shown below:
Range: 0x2030 (8240)
0x2030 (8240, utf8:0xe2 0x80 0xb0, glyph index:16):
Size: 26,22, render offset: 0,22
Metrics: Adv.=001B.0000, BearingX,Y=0000.0000,0000.0540, maxX=0000.0680
... ...
..... ..
... ... ..
.. .. ..
.. .. ..
.. .. ..
.. .. ..
.. .. ..
... ... ...
..... ..
... .. .... ...
.. ...... .....
.. ... ... ... ...
.. .. .. .. ..
.. .. .. .. ..
.. .. .. .. ..
... .. .. .. ..
.. .. .. .. ..
.. ... ... ... ...
.. ...... .....
.. .... ...
In the following example, the fontinfo utility is called using the / character to fill
the white space around the glyph. The font size is set to 15.
fontinfo -f web.ttf -r -C / -S 15

fontinfo © 2010, QNX Software Systems GmbH & Co. KG.
The output for a single glyph in the font file is shown below:
Range: 0x2030 (8240)

0x2030 (8240, utf8:0xe2 0x80 0xb0, glyph index:16):
Size: 19,17, render offset: 0,17
Metrics: Adv.=0014.0000, BearingX,Y=0000.0000,0000.0400, maxX=0000.04C0
///////////////////
////////**/////////
/***////*//////////
**/**///*//////////
*///*//*///////////
*///*//*///////////
*///*//*///////////
**/**/*////////////
/***//*////////////
//////*//***///***/
/////*//**/**/**/**
/////*//*///*/*///*
////*///*///*/*///*
////*///*///*/*///*
////*///*///*/*///*
///*////**/**/**/**
///*/////***///***/
See also:
In the Photon Programmer’s Guide see: Fonts

© 2010, QNX Software Systems GmbH & Co. KG. fpemu.so
Provide support for floating-point emulation
Syntax:
N/A
Runs on:
Neutrino
Options:
None.
Description:
The fpemu.so shared object provides support for floating-point emulation. QNX
Neutrino automatically loads this object when math operations are required on a
system with no floating-point unit.
By default, QNX Neutrino uses floating-point hardware in the CPU if present, and
emulates it in software if the CPU has no FPU. To force floating-point emulation, use
the -fe option to procnto.
Caveats:
In this version of QNX Neutrino, you can’t use the floating point emulator in statically
linked executables.
See also:
procnto

freeze © 2010, QNX Software Systems GmbH & Co. KG.
Compress and uncompress files (UNIX)
Syntax:
freeze [-cdfvVz] [[+n1,...,n8] [filename]]...
Runs on:
Neutrino
Options:
-c Write the results of the freeze/melt operation to standard output. No
files are changed.
-d Uncompress the files from the archive (melt).
-f Force creation of the .F file. This option creates the .F file, even if
one already existed, without prompting you for confirmation. The .F
file is created even if the compressed file is larger than the original.
-V Display the program’s version number and compilation options.
-v Display a counter. For each file being frozen, display a kilobytes

counter, and, after the file is frozen, print a message giving the
percentage of the input file’s size that has been saved by compression.
-z If the output of a melt (option -d) is to a tty, allocate a larger output

buffer so screen output is in fullscreen chunks.
+n1,...,n8 A list of 8 numbers separated by commas, specifying the values for

the static Huffman table.
Description:
The freeze utility compresses the specified files or the standard input. If a file
becomes smaller, it’s replaced by a file with the extension .F (you can use the -f
option to force the creation of the .F file, even if the compressed file is larger). If no
files are specified, the compression is applied to the standard input and is written to the
standard output.
If you don’t specify the -f option, and you run freeze in the foreground, you’re
prompted as to whether the file should be overwritten.
CAUTION:
! When a .F file is created, the original file is removed.
Normally there are several links set up to the freeze utility. Freeze behaves
differently when invoked under these command names:

© 2010, QNX Software Systems GmbH & Co. KG. freeze
This link: Is equivalent to:

melt freeze -d
fcat freeze -cd
You can restore compressed files to their original form by:
• Specifying the -d option to freeze.

Or
• Running melt on the .F files or on the standard input.
When you specify filenames, freeze maintains the ownership, modes, access times,
and modification times between the file and its .F version. As a result, you can use
freeze for archival purposes, yet you can still use it with make after melting.
The freeze utility uses the Lempel-Ziv algorithm on the first pass and the dynamic
Huffman algorithm on the second pass. The size of “sliding window” is 8K and the
maximum length of “matched string” is 256. The positions on the window are coded
using a static Huffman table.
A two-byte magic number is prepended to the file to ensure that neither melting of
random text nor refreezing of already frozen text is attempted. In addition, the
characteristics of the static Huffman table being used during the freeze are written to
the file so that these characteristics may be adapted to concrete conditions.
The amount of compression you obtain depends on the size of the input file and the
distribution of character substrings and their probabilities. Typically, text files (e.g. C
programs) are reduced by 60% to 75%, while executable files are reduced by 50%.
Compression is generally much better than that achieved by LZW coding or by
Huffman coding, although it takes more time to compute.
An argument preceded by a + defines the values to use for the Huffman table. You may
want to explicitly state these values in order to modify the compression algorithm.
The freeze compression utility will eventually become deprecated in favor of the
GNU zip suite, gzip/gunzip/zcat. The freeze suite of utilities will continue to be
provided for quite some time before being eliminated completely.
Examples:
Freeze all files in the current directory:
freeze *
Extract all C source and header files:
melt *.[ch].F
Or:

freeze © 2010, QNX Software Systems GmbH & Co. KG.
freeze -d *.[ch].F
View the concatenated contents of all compressed files in the current directory:
fcat *.F | more
Exit status:
0 Normal exit.
2 The last file grew after freezing.
Leonid A. Broukhis
See also:
bzip2, cpio, fcat, gunzip, gzip, melt, pax, tar, zcat

© 2010, QNX Software Systems GmbH & Co. KG. fs-cd.so
ISO-9660 filesystem support (with extensions)
Syntax:
driver ... cd cd_options ... &
Runs on:
Neutrino
Options:
Where driver is one of the devb-* drivers, and cd_options is one or more of the
following, separated by commas:
case=asis|lower|upper
Control the case used to display ISO-9660 filenames (to a readdir()
request; all pathname matching is always performed
case-insensitively on such names):
• asis — don’t convert the filename in any way; if the CD was
mastered with strict ISO-9660 compliance, the name will be in
uppercase, but more lenient utilities could produce mixed-case
filenames.
• lower — convert to lowercase (the default).
• upper — convert to uppercase.
RRIP and Joliet store case-preserving names and ignore this option.
exe Set execute permission (on all non-RRIP regular files).
gid=group Set the owning group to group for files on disks without Rock Ridge
extensions. The default is 0 (root).
hidden=hidden_mode
Specify what to do with “hidden” files. The hidden_mode can be
one of:
• ignore — ignore the hidden files; they don’t appear in the
filesystem.
• show — (the default) show hidden files in the filesystem as
normal files.
• dot — show hidden files in the filesystem with a dot (.) prefixed
to their names.
info=path The name of the information pseudo-directory (the default is

-.info.).
If the option is empty, no metadata directory is created. If the option
begins with a -, then blank metadata fields are hidden; if the option

fs-cd.so © 2010, QNX Software Systems GmbH & Co. KG.
begins with a +, then all metadata fields are presented but may have
a length of zero.
noaudio Disable audio extensions (the .info./audio control file).
nohsf Disable High Sierra format.
nojoliet Disable Microsoft Joliet extensions.
nomulti Disable multisession support (mount the first data session instead of
the last).
norrip Disable Rock Ridge extensions.
uid=user Set the owner to user for files on disks without Rock Ridge
extensions. The default is 0 (root).
umask=mask Apply this permission mask to files on disks without Rock Ridge
extensions. The default is 0 (all access permissions).
In addition, you can specify any of the filesystem options described for io-blk.so.
Description:
The fs-cd.so shared object provides support for ISO-9660 filesystems. It’s
automatically loaded by the devb-* drivers when mounting an ISO-9660 filesystem.
• This filesystem uses UTF-8 encoding for presentation of its filenames; attempts to
specify a filename not using UTF-8 encoding will fail (with an error of EILSEQ).
• We’ve deprecated fs-cd.so in favor of fs-udf.so, which now supports

ISO-9660 filesystems in addition to UDF. The default diskboot file now starts
fs-udf.so.
See also:
devb-*, fs-dos.so, fs-ext2.so, fs-qnx4.so, fs-qnx6.so, fs-udf.so,
io-blk.so, mount, umount
• “CD-ROM filesystem” in the Working With Filesystems chapter
• “CD-ROMs and DVDs” in the Connecting Hardware chapter
chapter

© 2010, QNX Software Systems GmbH & Co. KG. fs-cifs
Common Internet Filesystem or SMB client filesystem (QNX Neutrino)
Syntax:
fs-cifs [-a] [-b] [-D] [-d name] [-h] [-L|-l] [-o option[,option...]]
[-t n] [-v[v]...] [-Z n]
[[//netbiosname:]server:/share
prefix user passwd]
Runs on:
Neutrino
Options:
-a Spoof POSIX attributes; calls to chmod() and chown() return EOK
instead of ENOTSUP. Use -a to get rid of error messages from
applications that attempt to set the mode or ownership of files and
directories, such as cp.
-b Turn off buffered writes (default is on). This makes writes to the
remote filesystem slower, but safer.
-D Run in the foreground.
-d name Specify the domain name.
-h Display usage information.
-L Ask the user to provide the password (the command line doesn’t
include password).
-l (“el”) Ask the user to provide the name of the user and the password
(the command line doesn’t include user or password).
-o option[,option...]
Miscellaneous options; use commas to separate them. These options
include:
• old — don’t use 64-bit filesystem dialects. By default, fs-cifs
supports 64-bit filesystem operations.
• plainpwd — if logging in with an encrypted password fails, try to
log in by using the password unencrypted.
Sending passwords in plain text may be considered a security problem.
If fs-cifs failed to authenticate with the server using an

encrypted password, it used to then attempt to authenticate with the

fs-cifs © 2010, QNX Software Systems GmbH & Co. KG.
server using an older method while sending the password

unencrypted. In QNX Neutrino 6.3.2 and later, fs-cifs sends the
password encrypted, unless you specify the option -o plainpwd.
You might need this option when mounting shares on older versions
of Windows.
• showpwd — show the plain-text password in the log file.
Adding the password to the log file may be a security problem if unauthorized
personal have access to the log file.
• timeout=n — set the reconnection timeout to be n seconds.
-t n Allow up to n threads (default is 5). Use -t to tune resource usage;

more threads require more resources (such as memory), but decrease
filesystem latency.
-v[v...] Verbose output. Additional v characters give more verbose output.
-Z n The value of n indicates how to attach to the path:

• B or b — attach before other managers.
• A or a — attach after other managers.
The default is neither. For more information, see “Ordering
mountpoints” in the Process Manager chapter of the System
Architecture guide.
[//netbiosname:]server:/share
Specify the server name or IP address and the shared resource name of
the filesystem being mounted.
If you specify a server name, there must be some way to resolve it to an IP address.
See /etc/hosts or /etc/nsswitch.conf.
You must specify the netbiosname if:
• The server’s TCP/IP host name is different from its NetBIOS name
Or
• The server host is running a Microsoft operating system.
prefix Absolute path specifying where to mount share in the local filesystem.
user Log on to the SMB server as user.
passwd Log on to the SMB server with passwd.
If your password includes characters that the shell considers to be special, you might
have to enclose the password in quotation marks.

© 2010, QNX Software Systems GmbH & Co. KG. fs-cifs
Description:
The fs-cifs filesystem manager is an SMB (also known as CIFS — Common
Internet Filesystem) client operating over TCP/IP. SMB is a protocol for accessing
resources in a controlled fashion over a LAN.
The fs-cifs filesystem manager is primarily intended for use as a client with
Windows NT machines, although it also works with any SMB server (such as OS/2
Peer, LAN Manager, or SAMBA). To use fs-cifs, you must have an SMB server
and a valid login on that server.
The fs-cifs filesystem manager also requires a TCP/IP transport layer, such as the
one provided by io-pkt*.
You can mount SMB filesystems at the same time as you start fs-cifs; you can also
mount them separately after you have started fs-cifs using the mount command.
If you want to mount filesystems separately, start fs-cifs without arguments, as a
daemon, then create your mountpoints using mount specifying cifs as the type. See
below for an example.
If syslogd is running, fs-cifs writes any error messages to the system log.
Examples:
Start fs-cifs and mount the QNX_BIN share as /bin from an SMB server named
SMB_SERVER (with IP address 10.0.0.1) using the guest account and a password of
none:
fs-cifs SMB_SERVER:/QNX_BIN /bin guest none
Or:
fs-cifs 10.0.0.1:/QNX_BIN /bin guest none
The same as the above, but with a server, called NB_NAME, running a Microsoft
operating system:
fs-cifs //NB_NAME:SMB_SERVER:/QNX_BIN /bin guest \
none
Or:
fs-cifs //NB_NAME:10.0.0.1:/QNX_BIN /bin guest \
none
Ask the user for the password:

fs-cifs -L //NB_NAME:SMB_SERVER:/QNX_BIN /bin guest
Ask the user for the name of the user and the password:
fs-cifs -l //NB_NAME:SMB_SERVER:/QNX_BIN /bin
Mounts the server as the user in the QNX domain:

fs-cifs -d QNX //MS:10.1:/QNX_BIN /mnt user passwd

fs-cifs © 2010, QNX Software Systems GmbH & Co. KG.
Start fs-cifs as a daemon, then mount the QNX_BIN share as /bin from an SMB
server named SMB_SERVER (with IP address 10.0.0.1) using the guest account and
a password of none:
fs-cifs &
Then:
mount -t cifs -o guest,none //SMB_SERVER:10.0.0.1:/QNX_BIN /bin
or:
mount -t cifs -o user=guest,password=none \

//SMB_SERVER:10.0.0.1:/QNX_BIN /bin
Files:
/dev/log syslogd interface.
Caveats:
When the filesystem is mounted, everybody who uses the filesystem does so with the
privileges of the user specified on the command line.
The passwd argument is required on the command-line even if user doesn’t require a
password; it can be anything other than whitespace.
See also:
fs-nfs2, fs-nfs3, io-pkt*, mount, /etc/nsswitch.conf, umount, syslogd
• “CIFS filesystem” in the Working With Filesystems chapter

© 2010, QNX Software Systems GmbH & Co. KG. fs-dos.so
DOS filesystem (QNX Neutrino)
Syntax:
driver ... dos dos_options ... &
Runs on:
Neutrino
Options:
Where driver is one of the devb-* drivers, and dos_options is one or more of the
case Use case-sensitive filename matching (forces long filenames).

DOS/FAT is normally a case-preserving, case-insensitive
filesystem.
codepage=mapping
Install a DOS codepage for mapping of locale 8.3 filenames.
These names are used only when the corresponding (Unicode)
long filename is absent (created pre-Win95) or has been
disabled (using lfn=ignore) or for the volume label;
specification of the appropriate locale will also allow portability
of filenames created by fs-dos.so to older versions of DOS.
Use the “chcp” native command on a DOS system to determine
its active codepage. Supported values for mapping are: cp437,
cp850, cp852, cp866, cp1250, cp1251, and cp1252.
compat=mode Set DOS/Windows compatibility mode. Certain versions of

DOS implement minor individual peculiarities of the FAT
on-disk format, although this is unlikely to affect any normal or
typical filesystem client usage. Supported values for mode are:
dos, os2, win95, win98, win2k, and auto (the default).
exe=exec_mode Specify how to handle the POSIX x-bit for executables;

exec_mode can be one of:
all Make all files executable.

none Make no files executable.
system Use the DOS “system” attribute to indicate which
files are executable.
auto Make files ending in .exe, .bat, and .com
executable.
The default is auto.

fs-dos.so © 2010, QNX Software Systems GmbH & Co. KG.
fat=lazy|nonrmv|always
Set pre-reading of the FAT. Scanning the FAT is required to
return the count of free blocks. It also allows for improved
write() performance by creating an in-memory summary of
where free blocks might be located within the filesystem.
The value must be one of the following:
• always — always read the entire FAT at mount time
• lazy — read the FAT only when required (statvfs() query)
• nonrmv — act as always for nonremovable media, and
lazy for removable media
The default is nonrmv.
fsi=mode Set the handling of the FAT32/FSI record (this contains a count
of free clusters plus a hint at the next free cluster). The mode is
one of:
• ignore — ignore the record.
• lazy — update the record only when unmounting.
• update — update it whenever the FAT is modified.
• use — update it and use it (normally the free block count is
calculated at mounting).
The default is lazy.
gid=group Set the owning group of all files to group. The default is 0
(root).
hidden=hidden_mode
Specify what to do with files that have the DOS “hidden”
attribute; hidden_mode can be one of:
ignore The hidden files are ignored; the files don’t appear in
the filesystem.
show The hidden files appear in the filesystem as normal
files.
dot The hidden files appear in the filesystem with a dot
(.) prefixed to their names. Files created with a
leading dot have the DOS “hidden” attribute set.
The default is show.
lfn=lfn_mode Specify what to do with long filenames:
ignore Ignore long filenames. Only 8.3 filenames are

displayed or created.

show Show long filenames. Long filenames are created if

the filename is longer than 8.3 or if mixed case is
used.
always Always create both short and long filenames.
The default is show.
lnk=lnk_mode Set the handling of Windows shortcut files. The options are:
ignore Place no special meaning on these files (the default).

all Turn all shortcut files into symbolic links pointing to
their shortcut targets.
local Turn into symbolic links only those shortcut files that
point to targets within this filesystem.
notrunc Enforce short (8.3) filenames. This option is valid only with
lfn=ignore. By default, filename components beyond the 8.3
limit are silently ignored. For example, LONGFILENAME.TXT
becomes LONGFILE.TXT.
posix=posix_mode
Set POSIX check and emulation modes; posix_mode can be one
of the following:
none Disable POSIX checks and emulation.

• There are no . and .. entries in the root
directory.
• The link count of every directory is always 2.
emulate Provide the following features beyond those
provided by FAT:
• Create the . and .. entries in the root directory.
• Calculate directory size.
• Calculate the number of links per directory,
based on the subdirectories.
• Ignore modification attempts that cannot be
stored on disk or recreated by emulation, but
don’t raise errors.
strict Set stricter POSIX checks. Provide the same
features listed under emulate mode, but flag as
errors modification attempts that cannot be stored
on disk or recreated by emulation. E.g. an error of
EINVAL is flagged for attempts to do any of the
following:
• Set the userid or group ID to something other
than the default.

fs-dos.so © 2010, QNX Software Systems GmbH & Co. KG.
• Remove an r permission.
• Set an s permission.
• Set a file modification or access time to pre-1980.
The default is emulate.
sfn=mode Set the display of 8.3 filenames; mode is one of:

• lower — always user lowercase (file.c).
• upper — always use uppercase (FILE.C).
• windows — emulate WindowsNT and use all lowercase or
all uppercase according to the attributes of each filename
(e.g. file.c or FILE.C).
The default is lower.
uid=user Set the owner of all files to user. The default is 0 (root).
umask=mask Apply this permission mask to all files. The default is 0 (all
permissions).
vollabel=vollabel_mode
Specify what to do with the DOS volume name; vollabel_mode
can be one of:
ignore The volume label isn’t displayed.

show The volume label is displayed as a name-special file.
equals The volume label is displayed as a name-special file
with an = prefixed to its name.
The default is equals.
Description:
The fs-dos.so shared object lets you mount DOS filesystems (FAT12, FAT16, and
FAT32) under QNX Neutrino.
The fs-dos.so shared object is automatically loaded by the devb-* drivers when
mounting a DOS FAT filesystem.
This filesystem uses UTF-8 encoding for presentation of its filenames; attempts to


filesystems:

a Read-only.
See also:
chkdosfs, devb-*, fs-cd.so, fs-ext2.so, fs-mac.so, fs-nt.so,
fs-qnx4.so, fs-qnx6.so, fs-udf.so, io-blk.so, mkdosfs, mount, umount
• “DOS filesystem” in the Working With Filesystems chapter
chapter

fs-etfs-ram © 2010, QNX Software Systems GmbH & Co. KG.
Embedded transaction filesystem for RAM/SRAM
Syntax:
fs-etfs-ram [common-options] [-Ddriver-options]
Runs on:
ARM, MIPS, PowerPC, SH4, x86, and XScale processors
Options:
Board Support Packages may include a board-specific embedded transaction
filesystem. All fs-etfs-* filesystems use the same common options as
fs-etfs-ram; for driver-specific options, see the BSP documentation or use the -D
use option, as described in “Driver options,” below.
Common options
-a Update access times (atime). Default is to not update atime, to
reduce the number of flash writes.
-b priority Run background reclaim at this priority. Default is 8.
-B Don’t detach and run in the background. This is useful for

debugging.
-c nclusters Set the cache size. The cache holds recently read clusters in RAM,
reducing the need to access the device if the same cluster is read
again. It’s also used to combine small writes into larger writes
consisting of multicluster transactions. This reduces file
fragmentation across the device and improves filesystem startup
time. Since most devices are very fast, a small cache is usually
acceptable. Larger caches may be desirable if many files are being
written with small writes concurrently. The default value is 64
clusters, where cluster size is usually 1 KB or 2 KB, depending on
the device.
-C 0|1|2 Disable error checking/correction.
0 No CRC check, no ECC correction (RAM).

1 CRC check, no ECC correction (SRAM or NOR Flash).
2 CRC check, ECC correction (NAND Flash).
Default: use CRCs for error checking and ECCs for error
correction.
-D Specify driver options; see “Driver options,” below.

© 2010, QNX Software Systems GmbH & Co. KG. fs-etfs-ram
-e Erase the device and create an empty filesystem that is ready to

use. For NAND flash, factory-marked bad blocks are not erased.
Blocks that become bad during normal use (worn-out blocks) are
also skipped during the erasing.
-f numfiles Set maximum number of files. The default value is 4096, with a
maximum of 32,767.
-F num Defragment if the average extent is less than num clusters. The
value of num must be in the range from 0 through 16. Default is 6.
The fs-etfs-ram utility doesn’t defragment if num is 0.
-I Perform internal integrity checks of internal data structures while

the filesystem is running. This slows down the filesystem. Its main
purpose is for debugging new drivers and new versions of the
filesystem.
-m mountpoint Set the directory for fs-etfs-ram to use as its mountpoint. On

an embedded system where ETFS is the major filesystem, this is
set as -m / for taking over the root. If you don’t specify this
option, the ETFS isn’t mounted.
-o numattr Set the number of attributes to cache, which speeds up opens

slightly. Default is 8.
-r kbytes Set the size of the raw partition /dev/etfs1, in kilobytes. This
partition, if present, is typically used to hold a boot image made
using the mkifs utility. The default size is 0.
-R Reserve a percentage of the flash to avoid issues that arise when a

flash device becomes completely full. Default is 5% (of the device
size).
-S Implement transaction checksum using a fast and simple sum

calculation rather than the default polynomial CRC algorithm.
This may be faster but less robust.
-s num Set the number of flash blocks to use as spares. One spare block is
required to perform a reclaim. During normal operation, flash
devices wear, which causes flash blocks to fail. More than one
spare block provides extra redundancy. Default is 4.
-t sec Set a timer for background operations. Default is 5 seconds.
-v[v...] Set verbosity. Each -v increases verbosity.
-W erasediff Set wear-leveling span. Allow flash blocks to have erase counts
that differ by more than erasediff before attempting to either :
• force them into service if they are below erasediff
Or:

fs-etfs-ram © 2010, QNX Software Systems GmbH & Co. KG.
• give them a rest if they are above erasediff .

The default value is 50.
-x nextents Cache this number of file extent offsets. This option reduces the
processing needed to read through file extents on the device.
Default is 8.
Driver options
use Get a list of driver-specific options. This option causes the filesystem
to print a usage message and then terminate without accessing the
device.
size=nnM Set the size of the RAM disk to nn megabytes. The default is 16 MB.
Description:
The embedded transaction filesystem (ETFS) implements a high-reliability filesystem
for use with embedded solid-state memory devices with particular attention to NAND
flash memory. The filesystem supports a fully hierarchical directory structure with
POSIX semantics as shown in the table below:
POSIX capability Supported by ETFS

Access date Yes (if enabled with -a command-line option)
Modification date Yes
Status change date Yes
Max filename length 91 characters
User permission Yes
Group permissions Yes
Other permissions Yes
Directories Yes
Hard links No
Symbolic links Yes
When started, ETFS creates two devices as follows:
/dev/etfs1 Raw partition for boot image

/dev/etfs2 Filesystem partition for etfs files.
The raw partition is used for boot images and is always at the start of the device. It
may be zero bytes long if no boot image is needed. The filesystem partition is
mounted in the pathname space as specified by the -m option.

© 2010, QNX Software Systems GmbH & Co. KG. fs-etfs-ram
If you don’t specify the -m option, the filesystem isn’t mounted. You can use the
mount command to mount it later:
mount -tetfs /dev/etfs2 my_mountpoint
ETFS is a filesystem composed entirely of transactions. Every write operation,

whether of user data or filesystem metadata, consists of a transaction. A transaction
either succeeds or is treated as if it never occurred.
For more information, see “Embedded transaction filesystem (ETFS)” in the
Filesystems chapter of the System Architecture guide.
Examples:
Start ETFS to implement a temporary filesystem in RAM mounted at /tmp. Since it’s
not persistent across a reboot, and since RAM is reliable, you should disable all data
error detection and correction (-C 0). The -e option initializes an empty filesystem
ready to go upon startup. Since the filesystem is in high-speed RAM, you should
specify the smallest cache possible with the -c 0 option.
fs-etfs-ram -C 0 -e -c 0 -m /tmp
Caveats:
Although ETFS supports most POSIX semantics, some functionality isn’t
implemented in order to keep the driver simple and efficient. The unsupported POSIX
semantics include:
• Hard links, and related links. For example the . and .. directories aren’t returned
in a readdir(). Symlinks are fully supported.
• Access times aren’t updated on the media unless the -a option is specified, to
reduce flash writes.
• The parent directory’s modification time isn’t updated when the directory content
changes (files are created or deleted).
See also:
etfsctl, mketfs, mount, umount
User’s Guide

fs-ext2.so © 2010, QNX Software Systems GmbH & Co. KG.
Linux Ext2 filesystem
Syntax:
driver ... ext2 ext2_options ... &
Runs on:
Neutrino
Options:
Where driver is one of the devb-* drivers.
unfixbadver Turns off work-arounds for corrupt volumes created by the buggy
1.19 version of mke2fs.
Description:
The Ext2 filesystem (fs-ext2.so) provides transparent access to Linux disk
partitions. This implementation supports the standard set of features found in Ext2
versions 0 and 1.
Sparse file support is included in order to be compatible with existing Linux partitions.
Other filesystems can only be “stacked” read-only on top of sparse files. There are no
such restrictions on normal files.
If an Ext2 filesystem isn’t unmounted properly, a filesystem checker is usually
responsible for cleaning up the next time the filesystem is mounted. Although the
fs-ext2.so module is equipped to perform a quick test, it automatically mounts the
filesystem as read-only if it detects any significant problems (which should be fixed
using a filesystem checker).
The following features are not currently supported:
• file fragments (sub-block allocation)
• large files (> 2 GB)
• filetype extension
• compression
• b-tree directories

filesystems:

© 2010, QNX Software Systems GmbH & Co. KG. fs-ext2.so

a Read-only.
Caveats:
Although Ext2 is the main filesystem for Linux systems, we don’t recommend using
fs-ext2.so as a replacement for the QNX 4 filesystem (fs-qnx4.so). Currently,
we don’t support booting from Ext2 partitions. Also, the Ext2 filesystem relies heavily
on its filesystem checker to maintain integrity; this and other support utilities (e.g.
mke2fs) are not currently available for QNX Neutrino.
See also:
devb-*, fs-cd.so, fs-dos.so, fs-mac.so, fs-nt.so, fs-qnx4.so,
fs-qnx6.so, fs-udf.so, io-blk.so, mount, umount
• “Linux Ext2 filesystem” in the Working With Filesystems chapter
chapter

fs-mac.so © 2010, QNX Software Systems GmbH & Co. KG.
Shared object that supports Apple Macintosh HFS and HFS Plus (QNX Neutrino)
Syntax:
driver ... mac mac_options... &
Runs on:
QNX Neutrino
Options:
There are currently no mac_options defined.
Description:
The fs-mac.so shared object provides read-only support for Apple HFS
(Hierarchical File System) and HFS Plus. It’s automatically loaded by the devb-*
drivers when mounting an Apple filesystem.
The slash (/) character (which is valid in file names on the Mac but not in POSIX) is
swapped with the colon (:) (which is the Mac path separator). For example, an HFS
file called 29/1/2009 will get shown to ls as 29:1:2009, and when opened with
that name will internally match back to the 29/1/2009 on-disk name.
The fs-mac.so shared object doesn’t support access to the resource fork or hard
links.

filesystems:

continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. fs-mac.so

a Read-only.
See also:
devb-*, fs-cd.so, fs-dos.so, fs-ext2.so, fs-nt.so, fs-qnx4.so,
• “Apple Macintosh HFS and HFS Plus” in the Working with Filesystems chapter
chapter

fs-nfs2 © 2010, QNX Software Systems GmbH & Co. KG.
NFS 2 client filesystem (QNX Neutrino)
Syntax:
fs-nfs2 [-b num] [-B size] [-D] [-e] [-h]
[-i nodes] [-r] [-S] [-t] [-u] [-v[v]...]
[-Z n] [server:export] [mountpoint]
[[-erStu] [-Z n] server:export mountpoint ...]
Runs on:
Neutrino
Options:
server The name of the NFS server.
export The directory to be exported from the server.
mountpoint The name under which the exported directory is to be mounted.
The following options apply to all mountpoints:
-b num Use num buffers (default: 200).
-B size Set the buffer size to size bytes. The default is set by the first server,
and is usually 8K.
-i nodes Set the number of inodes to nodes.
-v[v]... Verbose output; add more v characters for more verbosity. In order to
capture the log messages, you need to have syslogd running.
The following options apply only to the next mountpoint specified on the command
line:
-e Set the NO EXEC flag for the mounted filesystem.
-r Set the READ ONLY flag for the mounted filesystem.
-S Don’t cache symlinks.
-t Use TCP instead of UDP. If this fails, fs-nfs2 uses UDP.
-u Use UDP (which is the default). If this fails, fs-nfs2 fails.

© 2010, QNX Software Systems GmbH & Co. KG. fs-nfs2

• O or o — make the attachment opaque; don’t resolve to mountpoints with
shorter pathname matches. The pathname resolver tries to find the
longest match against all pathnames attached.
The default is none of these. For more information, see “Ordering
mountpoints” in the Process Manager chapter of the System Architecture
guide.
Description:
The fs-nfs2 filesystem manager is an NFS 2 client operating over TCP/IP. To use it,
you must have an NFS server.
This filesystem manager requires a TCP/IP transport layer, such as the one provided
by io-pkt*. It also needs socket.so and libc.so.
By default, this utility does not set any upper limit for number of inodes.
You can also create mountpoints with the mount command by specifying nfs for the
type. You must start fs-nfs2 before creating mountpoints in this manner. If you start
fs-nfs2 without any arguments, it runs in the background so you can use mount.
Examples:
Mount the qnx_bin export as /bin from an NFS server named server_node:
fs-nfs2 server_node:/qnx_bin /bin &
Mount /nfs1 using TCP, and /nfs2 using UDP:
fs-nfs2 -t host1:/ /nfs1 host2:/ /nfs2
Mount both using TCP:
fs-nfs2 -t host1:/ /nfs1 -t host2:/ /nfs2
Caveats:
If possible, you should use fs-nfs3 instead of fs-nfs2.
See also:
fs-cifs, fs-nfs3, io-pkt*, mount, syslogd, umount
• “NFS filesystem” in the Working With Filesystems chapter


NFS 3 client filesystem (QNX Neutrino)
Syntax:
fs-nfs3 [-b num] [-B size] [-D] [-e] [-h]
[-i nodes] [-r] [-s] [-S] [-t]
[-T threads] [-u] [-v[v]...] [-w delay=sec]
[-w number=num] [-w size=num] [-w sync=hard]
[-Z n] [server:export] [mountpoint]
[[-erStu] [-Z n] server:export mountpoint ...]
Runs on:
Neutrino
Options:
server The name of the NFS server.
export The directory to be exported from the server.
mountpoint The name under which the exported directory is to be mounted.
The following options apply to all mountpoints:
-b num Use num buffers (default: 200).
-B size Set the buffer size to size bytes. The default is set by the first server,
and is usually 8K.
-i nodes Set the number of inodes to nodes.
-v[v]... Verbose output; add more v characters for more verbosity. In order to
capture the log messages, you need to have syslogd running.
The following options apply only to the next mountpoint specified on the command
line:
-e Set the NO EXEC flag for the mounted filesystem.
-r Set the READ ONLY flag for the mounted filesystem.
-S Don’t cache symlinks.
-s Use a soft mount.

© 2010, QNX Software Systems GmbH & Co. KG. fs-nfs3
-t Use TCP instead of UDP. If this fails, fs-nfs3 uses UDP.
-T num Set the number of threads. The default is 5.
-u Use UDP (which is the default). If this fails, fs-nfs3 fails.
-w delay=sec Indicate the time, in seconds, after which the data will be
flushed to the server. The default is 2 seconds.
-w number=num Number of buffers (default is 10.) Each buffer manages content

for one file. The default value indicates 10 files can be buffered
simultaneously.
-w size=num Size of the buffer, in units of 1K (default is 8.)
-w sync=hard Turn off write caching.

• O or o — make the attachment opaque; don’t resolve to
mountpoints with shorter pathname matches. The pathname
resolver tries to find the longest match against all pathnames
attached.
The default is none of these. For more information, see
“Ordering mountpoints” in the Process Manager chapter of the
System Architecture guide.
Description:
The fs-nfs3 filesystem manager is an NFS 3 client operating over TCP/IP. To use it,
you must have an NFS server.
When you use fs-nfs3 with write caching (the default), you benefit from enhanced
filesystem performance. However, there can be interoperability issues if more than one
NFS client accesses the same file on the NFS server. If fs-nfs3’s cached data hasn’t
been written to the NFS server, another NFS client attempting to read the same file
won’t see the changes to the file until they’re written to the server at a later point. If
you want fs-nfs3 to write file modifications immediately to the NFS server, use the
-w sync=hard option to turn off write caching.
This filesystem manager requires a TCP/IP transport layer, such as the one provided
by io-pkt*. It also needs socket.so and libc.so.
By default, this utility does not set any upper limit for number of inodes.
You can also create mountpoints with the mount command by specifying nfs for the
type and -o ver3 as an option. You must start fs-nfs3 before creating mountpoints
in this manner. If you start fs-nfs3 without any arguments, it runs in the background
so you can use mount. The options that you can use with mount include the following:

tcp Use TCP instead of UDP. If this fails, mount uses UDP.
udp Use UDP (which is the default). If this fails, mount fails.
nocachesymlink
Don’t cache symlinks.
ver3 Use fs-nfs3 instead of fs-nfs2.
soft Use a soft mount (i.e. break the connection if unable to reach the server).
Examples:
Mount the qnx_bin export as /bin from an NFS server named server_node:
fs-nfs3 server_node:/qnx_bin /bin &
Mount /nfs1 using TCP, and /nfs3 using UDP:
fs-nfs3 -t host1:/ /nfs1 host2:/ /nfs3
Mount both using TCP:
fs-nfs3 -t host1:/ /nfs1 -t host2:/ /nfs3
Mount an NFS filesystem (fs-nfs3 must be running first):
mount -t nfs -o ver3 server_node:/qnx_bin /bin
Mount an NFS filesystem, using TCP (fs-nfs3 must be running first):
mount -t nfs -o tcp,ver3 server:/tmp /mnt
Caveats:
If possible, you should use fs-nfs3 instead of fs-nfs2.
See also:
fs-cifs, fs-nfs2, io-pkt*, mount, syslogd, umount
• “NFS filesystem” in the Working With Filesystems chapter

© 2010, QNX Software Systems GmbH & Co. KG. fs-nt.so
Shared object that supports the Windows NT filesystem (QNX Neutrino)
Syntax:
driver ... nt nt_options... &
Runs on:
QNX Neutrino
Options:
compress=number The number of buffers to use for the dynamic decompression of
compressed files (e.g. if in a directory you set the “Compress
contents to save disk space” folder attribute). The default is 2; a
value of 0 disables support for compressed files.
dots=[off|on] Fabricate . and .. directory entries. The default is off.
Description:
The fs-nt.so shared object provides read-only support for the Microsoft Windows
NT filesystem. It’s automatically loaded by the devb-* drivers when mounting an NT
filesystem.
The fs-nt.so shared object doesn’t support encrypted files, security IDs or ACLs,
and alternate data streams.

filesystems:

continued. . .

fs-nt.so © 2010, QNX Software Systems GmbH & Co. KG.

a Read-only.
See also:
devb-*, fs-cd.so, fs-dos.so, fs-ext2.so, fs-mac.so, fs-qnx4.so,
• “Windows NT filesystem” in the Working with Filesystems chapter
chapter

© 2010, QNX Software Systems GmbH & Co. KG. fs-qnx4.so
QNX 4 compatible filesystem support
Syntax:
driver ... qnx4 qnx4_options... &
Runs on:
Neutrino
Options:
Where driver is any of the devb-* drivers, and qnx4_options is one or more of the
bitmap=when When to pre-read the .bitmap file. Scanning the bitmap is

required to return the count of free blocks. It also allows for
improved write() performance by creating an in-memory summary
of where free blocks might be located within the filesystem.
The value must be one of the following:
• always — calculate/store .bitmap details for all media.
• lazy — don’t read the bitmap for non-removable media at
mount time, but when it’s first needed (e.g. by a statvfs() call or
df). This can help speed up system boot times (since on a large
disk, the .bitmap files may be several megabytes in length,
and if read right away, can interfere with the starting of other
processes on an embedded system).
• nonrmv (the default) — act as always for nonremovable
media, and lazy for removable media
grown Allow persistent over-grown files; don’t truncate them when
they’re closed. Certain file-write access patterns (e.g O_APPEND)
are detected, and the file isn’t shrunk back at the last close. This is
useful for log files that you keep appending to, and so on.
noembed Never embed inode details; always place in fixed-size .inodes.
overalloc Enable a more aggressive file-extent over-allocation heuristic.
unbusy Attempt to repair any file marked as “busy” on the filesystem (i.e.
a file that was being grown or shrunk when the system was
improperly shutdown). The default action is to return EBADFSYS
to any attempt to open such a file; this option will instead truncate
the file to its last-known valid size, unset the “busy” indicator, and
allow access. This truncation may result in lost data and unused
blocks marked as used in the bitmap, so run chkfsys later to
ensure full filesystem consistency.

fs-qnx4.so © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The fs-qnx4.so shared object provides support for QNX 4 filesystems. It’s
automatically loaded by the devb-* drivers when mounting a QNX 4 filesystem.
filesystems:

a Read-only.
Files:
.longfilenames
To enable support for long filenames (more than 48 characters) on an existing
QNX 4 compatible filesystem, login as root and create an empty, read-only file
named .longfilenames in the root directory of that filesystem.
To enable support for long filenames on a new QNX 4 filesystem, use the -N
option to dinit.
See also:
devb-*, fs-cd.so, fs-dos.so, fs-ext2.so, fs-mac.so, fs-nt.so,
• “QNX 4 filesystem” in the Working With Filesystems chapter
chapter


Shared object that supports the Power-Safe filesystem (QNX Neutrino)
Syntax:
driver ... qnx6 qnx6_options... &
Runs on:
Neutrino
Options:
hold=allow|root|deny
Control which users (if any) can suspend the taking of snapshots
(via a flag in the DCMD_FSYS_FILEFLAGS devctl() command).
The default is root.
overalloc Enable a block overallocation heuristic for small file writes.
snapshot=freq Set the frequency of automatic snapshots; the default is 10

seconds. A filesystem snapshot is explicitly made when you call
sync() or fsync(), or from this periodic timer.
sync=mode Specify the required disk synchronization capability. The mode

mode must be one of the following:
• mandatory (the default) — the drive must support
synchronization to allow a filesystem to be mounted
read/write. If it doesn’t, the mount fails and returns EROFS. A
read-only mount (mount -r) can always be performed on any
device.
• optional — attempt synchronization, but ignore any error if
the drive doesn’t support such an operation. The driver might
be incorrectly advertising the capabilities, or the physical
media might not require explicit synchronization
(write-through).
• none — never issue a synchronization command to the disk,
and don’t drain dirty blocks from the filesystem cache (until
an explicit umount). This mode is suitable only for use with a
UPS.

CAUTION: If the drive doesn’t support synchronizing, fs-qnx6.so can’t guarantee
! that the filesystem is power-safe. You can use the sync option to override this
requirement at your own risk. Before using this filesystem on devices — such as
USB/Flash devices — other than traditional rotating hard disk drive media, check to
make sure that your device meets the filesystem’s requirements. For more information,
see “Required properties of the device,” below.
Description:
The fs-qnx6.so shared object provides support for Power-Safe
(copy-on-write/snapshot) filesystems. It’s automatically loaded by the devb-* drivers
when mounting a Power-Safe filesystem.
Required properties of the device

The Power-Safe filesystem was designed for and is intended for traditional rotating
hard disk drive media. It operates by moving the on-disk filesystem state from one
stable view to another stable view using copy-on-write (COW) to relocate modified
blocks. To finalize this transition, all dirty blocks involved in the new view must be
committed to persistent storage, and then a new filesystem superblock/root referencing
the relocated blocks is committed.
This provides power-safe robustness, because at any point in time either the old
version is completely accessible or the new version is completely accessible (with no
live data being overwritten in between). Thus to mount as read-write on a given
device, that device must have the following properties:
• one of the following:

- The device may buffer write data for performance reasons, and the return from a
WRITE may not necessarily indicate the data is committed to permanent
storage. But such a device must implement a FLUSH/SYNC command that
forces any cached or buffered write data to persistent storage, and doesn’t return
until it’s guaranteed that all data is stable across a power-loss.
or:
- The device doesn’t buffer write data, and operates in a strict write-through
manner, where return from a WRITE is a guarantee that the data was
immediately committed to persistent storage. Such a device doesn’t require an
additional FLUSH/SYNC command.
• and both of the following:
- The action of writing to one data region (an advertised device sector) can in no
way damage the contents of any other region, even under conditions such as
power-loss, vibration, temperature, etc.

and:
- Data that has previously been reported as committed to persistent storage
remains stable until explicitly overwritten. The device may implement facilities
such as bad-block remapping or wear-leveling to support this requirement,
provided that such activity never causes loss of persistent data, even under
conditions such as power-loss, etc.

filesystems:

a Read-only.
See also:
chattr, chkqnx6fs, devb-*, fs-cd.so, fs-dos.so, fs-ext2.so, fs-mac.so,
fs-nt.so, fs-qnx4.so, fs-udf.so, io-blk.so, mkqnx6fs, mount, umount
• “Power-Safe filesystem” in the Working with Filesystems chapter
chapter

© 2010, QNX Software Systems GmbH & Co. KG. fs-udf.so
Universal Disk Format and ISO 9660 filesystem support
Syntax:
driver ... udf udf_options ... &
Runs on:
Neutrino
Options:
Where driver is one of the devb-* drivers, and udf_options is one or more of the
Control the case used to display ISO 9660 filenames (to a
readdir() request; all pathname matching is always performed
case-insensitively on such names):
• asis — don’t convert the filename in any way; if the CD
was mastered with strict ISO 9660 compliance, the name
will be in uppercase, but more lenient utilities could
produce mixed-case filenames.
• lower — convert to lowercase (the default).
• upper — convert to uppercase.
RRIP, Joliet, and ISO 9660:1999 store case-preserving names
and ignore this option.
If you specify both the case and charset options for an ISO 9660 format,
fs-udf.so ignores the case option.
charset=[pvd_charset][:svd_charset]
Use a non-standard character set mapping for ISO 9660:1988
Primary Volumes and ISO 96660:1999 Supplementary
Volumes. By default, these are ISO 646 (ASCII). However a
number of CD-burning tools incorrectly use extended
characters in filenames. An appropriate charset=
specification can allow these filenames to be displayed
according to a known alternate character set; without such a
hint, fs-udf.so replaces with an underscore (_) any illegal
characters in filenames.
Enhanced SVD format allows the active character set to be
specified via ISO 2022 escape sequences, but again many
CD-burning utilities fail to do this correctly, thus separate
overrides are provided. The supported character sets include:

fs-udf.so © 2010, QNX Software Systems GmbH & Co. KG.
• IBM850
• IBM852
• IBM866
• US-ASCII
• ISO-8859-1
• ISO-8859-2
• windows-1250
• windows-1251
• windows-1252
The case in these strings doesn’t matter.
fileset=num The File Set number to mount; the default is 0.
format=list Set both the list of disk formats to support, as well as the order
in which they should be probed (for media with multiple
formats, such as UDF-Bridge/DVD-Video or ISO/Joliet).
Separate the formats with colons (:) You can use this option
to:
• set a specific order in which to probe (e.g.
format=joliet:rrip:udf)
• remove a format (e.g. format=-rrip)
• add a format, making it the first preference (e.g.
format=+udf)
The valid formats are:

• udf — OSTA/UDF, all v1.x and 2.x variants as supported.
• rrip — Rock Ridge extensions to ISO 9660; adds
permissions and long names.
• joliet — Joliet extensions to ISO 9660; adds Unicode
long names.
• iso9660e — the 1999 version of the ISO 9660 spec; adds
mixed-case filenames.
• iso9660 — the base 1988 version of the ISO 9660 spec.
• audio — create a dummy mountpoint for an
audio-only/CDDA disk.
The first matching, valid format in order from the specified list
is mounted.

Since the audio format matches any disk with audio tracks, you should usually make
it the last in the list. In addition, since many formats are extensions to a base ISO 9660
format, which is also present on the media, you should specify iso9660 itself after
those formats.
The default is
format=udf:rrip:joliet:iso9660e:iso9660:audio.
For backward compatibility, set the format to format=udf to
disable the CD/ISO formats.
gid=group The group ID to use for files with no specified group. The
default is 0.
hidden=hidden_mode
Specify what to do with “hidden” files. The hidden_mode can
be one of:
• ignore — ignore the hidden files; they don’t appear in the
filesystem.
• show — (the default) show hidden files in the filesystem as
normal files.
• dot — show hidden files in the filesystem with a dot (.)
prefixed to their names.
info=path The name of the filesystem metadata directory. The first

character can be + or -, and this controls whether empty
entries (metadata descriptors not given a value) are shown in
the directory or not, respectively. For example, if a CD doesn’t
have a abstract or bibliography, those pseudo-files can be
hidden, or left with a empty string in them.
The default is -.info..
perms=[file_permissions][:directory_permissions]
The permissions to use for ISO 9660 files, directories, or both.
The argument to this option consists of the permissions for
files, followed by a colon (:), and then the permissions for
directories. Either set of permissions is optional.
You can specify the permissions either as a simple numeric
value, or in chmod-style format. For example, to make files
executable, specify perms=+x, which is the equivalent to the
exe option to fs-cd.so. Like the uid and gid options, this
option is used only when the filesystem itself doesn’t have
explicit permissions (udf and rrip do; all others don’t).
The default is a=r:a=rx.

fs-udf.so © 2010, QNX Software Systems GmbH & Co. KG.
raw=num[:chunk] Set the number of raw CDDA/CDXA 2352-byte buffers and

optionally the number of blocks to read with one raw I/O
operation. The default is 0:16 (raw read presentation as
described below is disabled).
If you specify only num (e.g. raw=2 vs raw=2:8), then the
chunk size remains 16. The size of your raw buffer is the
product of these two numbers and 2352. Reading more sectors
per operation improves the overall read performance.
When enabled, this option supports the transparent reading of
Mode 2 Form 2 VCD and audio files:
• For Mode 2 Form 2 VCD files, a 44-byte RIFF header is
constructed and prepended to the file data, and then data
from the files’ raw 2352-byte sectors are supplied.
• Any audio tracks also get a filename in
.info./CD_TrackNN .wav, which when read yields a
similar RIFF header (but WAVE instead of CDXA format),
followed by the raw ripped audio.
If this option is disabled, such files are unreadable to POSIX
read() and fail with EINVAL.
You can use the chattr command to identify Mode 2 Form 2
or CDDA files.
uid=user The user ID to use for files with no specified owner. The
default is 0 (root).
verify=level How much of the ISO PVD or UDF tag content (tag version,
tag location, header checksum, and/or data CRC) to verify; one
of the following:
• none
• tag — all except the data CRC
• all
• ?none
• ?tag
• ?all (the default)
Some ISO 9660:1999 SVD-mastering utilities and
UDF-authoring utilities write incorrect tags, so it might be
necessary to relax the verification if problems are observed. If
you specify an option with a leading question mark (?),
fs-udf.so consults an internal blacklist of known bad
utilities and automatically skips all checks in the list; otherwise
it operates at the level given after the question mark.
volume=num The Primary Volume number to mount; the default is 0.

Description:
The fs-udf.so shared object provides support for UDF (OSTA-UDF/ECMA-167)
and ISO 9660 (base 1988 spec, 1999 spec, Joliet extensions, Rock Ridge extensions)
filesystems. It’s automatically loaded by the devb-* drivers when mounting a UDF
filesystem.
See also:
chattr, devb-*, fs-cd.so, fs-dos.so, fs-ext2.so, fs-mac.so, fs-nt.so,
fs-qnx4.so, fs-qnx6.so, io-blk.so, mount, umount
in the Working With Filesystems chapter, “Filesystems and block I/O (devb-*)
drivers” in the Fine-Tuning Your System chapter, and “Filesystem limits” in the
Understanding System Limits chapter of the QNX Neutrino User’s Guide
• “Universal Disk Format (UDF) filesystem” in the Working With Filesystems

chapter
• “CD-ROMs and DVDs” in the Connecting Hardware chapter
chapter

fsysinfo © 2010, QNX Software Systems GmbH & Co. KG.
Display filesystem statistics (QNX Neutrino)
Syntax:
fsysinfo [options]* device|filesystem
Runs on:
Neutrino
Options:
-l period Loop with the specified period (in milliseconds).
-L period Loop with the specified period (in milliseconds), displaying the
differences in the statistics between iterations.
-m Don’t add in metadata (filesystem mountpoint) disk I/O counts.
-v Display the versions of io-blk.so and the filesystem.
-z Zero (reset) the statistics after reading them.
-Z Zero (reset) the statistics, without displaying them.
Description:
The fsysinfo utility is a front end to the devctl(DCMD_FSYS_STATISTICS)
command (from <sys/fs_stats.h>), which queries a disk filesystem for its
statistics. These statistics include disk sectors read and written, the efficiency of
internal caches, the count of various system calls made from user code, and so on.
By default, the current statistics are displayed once. There’s also a looping mode, in
which the utility loops and redisplays the statistics at the specified interval (-l
displays the raw values, and -L displays the difference from the previous values).
Press Ctrl-C to exit.
You can reset the statistics to 0 by using -z or -Z (-z displays what the values were
prior to being reset, but -Z produces no output and is useful in scripts).
If you specify the -m option, fsysinfo doesn’t combine disk I/O statistics from the
specified filesystem and its host device/partition; usually this is necessary for many
filesystem implementations that internally target metadata updates against the host
device and not to a particular higher-level file. (For example, if you specify -m,
modifications to the .bitmap and .inode files for an fs-qnx4 filesystem don’t
show as I/O on the mounted filesystem.)
The output includes the following:

© 2010, QNX Software Systems GmbH & Co. KG. fsysinfo
Section Statistic Description

FILESYS Mountpoint and type of filesystem
MOUNT mounted Time that the filesystem was mounted
elapsed Time since the statistics were reset
DISK I/O write Physical sector writes to the device
read Physical sector reads from the device
r/a Predictive readaheads from the device
direct DCMD_FSYS_DIRECT_IO sectors
bad The number of bad blocks
CACHE write Sectors delayed-write to buffer cache (blk delwri=
commit=)
read Sectors reread from buffer cache
rate Ratio of (CACHE read) : (DISK IO read + r/a)
mru The size, in KB, of the Most Recently Used region
mfu The size, in KB, of the Most Frequently Used region
ratio Ratio of (CACHE mru) : (CACHE mfu)
SYSCALL open Number of open() calls
stat Number of stat() or fstat() calls
namei Number of conversions from a pathname to a file
write Number of write() calls
read Number of read() calls
devctl Number of devctl() calls
create Number of creations
delete Number of deletions
NAMES exist Filenames known to exist (avoid scan)
enoent Filenames known to not exist (avoid scan)
misses Filename unknown (have to scan directory)
unsuit Filename unsuitable for caching (too long or ambiguous)
stale Stale name entry (fsys unmounted or associated vnode
recycled)
rate Ratio of (exist + enoent) : (misses + unsuit)
continued. . .

fsysinfo © 2010, QNX Software Systems GmbH & Co. KG.
Section Statistic Description

BMAP hit Known logical to physical block mapping
miss Unknown logical to physical block mapping
rate Ratio of (hit) : (miss)
VNODES create Open of unknown file (must load/build the vnode from
the filesystem)
hit Open of a known or recently-used file
rate Ratio of (hit) : (create)
lock Number of locked vnodes
recycl Reuse of cache entry for new file (blk vnode=)
SLAB map The number of pages mapped in by the heap-allocation
subsystem
unmap The number of pages released by the heap-allocation
subsystem
active The difference of (map) − (unmap)
You can use this information to analyze the efficiency of the various io-blk.so
caches, possibly leading to fine-tuning of the driver command-line options (blk
cache= ncache= map= vnode=).
Examples:
# fsysinfo /tmp
FILESYS / (qnx6)
MOUNT mounted Mon Sep 21 06:31:21 2009 elapsed 39 secs
DISK I/O write 0 read 0 r/a 0
direct 0 bad 0
CACHE write 328 read 23696 rate 100%
mru 6792k mfu 2832k ratio 29%
SYSCALL open 1211 stat 1331 namei 2718
write 3 read 2499 devctl 579
create 3 delete 3
NAMES exist 4960 enoent 1096 misses 652
unsuit 8 stale 1 rate 90%
BMAP hit 3977 miss 464 rate 89%
VNODES create 345 hit 7698 rate 95%
lock 17391 recycl 2
SLAB map 114 unmap 2 active 112
Determine what/how many disk operations were required by an activity:

# fsysinfo -Z /fs/hd/tmp
# cd /fs/hd/tmp
...
# fsysinfo /fs/hd/tmp
Monitor disk access in realtime, updating the statistics every 500 ms:
# fsysinfo -L500 /fs/hd

© 2010, QNX Software Systems GmbH & Co. KG. fsysinfo
See also:
chattr, devb-*, fs-*, io-blk.so

/etc/fstab © 2010, QNX Software Systems GmbH & Co. KG.
File for predefined mountpoints
Name:
/etc/fstab
Description:
The /etc/fstab file contains descriptive information about filesystems. Programs
read it, but don’t write it; it’s the duty of the system administrator to properly create
and maintain this file. Each filesystem is described on a separate line; fields on each
line are separated by tabs or spaces. Lines beginning with # are comments.
If you specify the -a option to the mount command, the utility mounts the devices
that are listed in /etc/fstab. The format of the /etc/fstab used with the mount
utility is as follows:
specialdevice mountpoint type mountoptions

For example, the following entry in /etc/fstab:
/dev/hd0t77 /mnt/fs qnx4 rw

is equivalent to calling:
mount -t qnx4 /dev/hd0t77 /mnt/fs

The mountoptions field is a comma-separated list of values that must contain, at a
minimum, one of ro or rw to indicate a read-only or a read-write mount.
By default, the mount is performed with the type as if the -t option had been
specified (device and server doing the mount are the same) but to get the -T type
behavior, you should specify allservers in the options.
The following sample /etc/fstab indicates the mapping of the different
configurations:
#This is a sample file that shows the mapping of command line
#arguments to the fstab entries and how they would be invoked.
#The "implied" argument is not generally required, but some
#servers may differentiate between implied and specified entries.
# mount -b -vvv -t mytype /my/specialdev1 /my/mountpoint1

# mount -vvv /my/mountpoint1
/my/specialdev1 /my/mountpoint1 mytype rw
# mount -b -vvv -t mytype /my/specialdev2

# mount -vvv /my/specialdev2
/my/specialdev2 / mytype rw,implied
# mount -b -vvv -T mytype /my/specialdev3 /my/mountpoint3

# mount -vvv /my/mountpoint3
/my/specialdev3 /my/mountpoint3 mytype allservers,rw
# mount -b -vvv -T mytype /my/specialdev4

# mount -vvv /my/specialdev4
/my/specialdev4 / mytype allservers,implied,rw

© 2010, QNX Software Systems GmbH & Co. KG. /etc/fstab
See also:
mount
endfsent(), getfsent(), getfsfile(), getfsspec(), mount(), setfsent() in the QNX Neutrino
Library Reference

ftp © 2010, QNX Software Systems GmbH & Co. KG.
Internet file transfer program (UNIX)
Syntax:
ftp [-46AadefginpRtVv] [-N netrc] [-o output] [-P port]
[-q quittime] [-r retry] [-s srcaddr]
[-T dir,max[,inc]] [[user@]host [port]]
[[user@]host:[path][/]] [file:///path]
[ftp://[user[:password]@]host[:port]/path[/][;type=X]]
[http://[user[:password]@]host[:port]/path] [...]
ftp -u URL file [...]
Runs on:
Neutrino
Options:
See below.
Description:
The ftp utility is the user interface to the standard Internet File Transfer Protocol.
With this utility, you can transfer files to and from a remote network site. For more
information, see the NetBSD documentation at
http://netbsd.gw.com/cgi-bin/man-cgi?ftp++NetBSD-5.0.
See also:
ftpd, /etc/services, tftp
getservbyname() in the Library Reference
Based on RFC 959, RFC 1123, RFC 1738, RFC 2068, RFC 2428, and RFC 2732

© 2010, QNX Software Systems GmbH & Co. KG. /etc/ftpchroot
Access-control file for ftpd
Name:
/etc/ftpchroot
Description:
The /etc/ftpchroot file lists the users who should have their session’s root
directory changed (using chroot()). The root directory is changed accordingly:
• if set, the directory that’s specified in the /etc/ftpd.conf chroot directive
• home directory of the user.
If this file doesn’t exist, the root directory change isn’t performed.
The syntax is similar to /etc/ftpusers, except that the class argument is ignored:
userglob[:groupglob][@host] [directive]
Please refer to /etc/ftpusers for detailed descriptions for each element.

If there’s a positive match, the session’s root directory is changed. No further
comparisons are attempted after the first successful match. This syntax is
backward-compatable with the old syntax.
See also:
ftpd, /etc/ftpd.conf, /etc/ftpusers

ftpd © 2010, QNX Software Systems GmbH & Co. KG.
Internet file transfer protocol daemon (NetBSD)
Syntax:
ftpd [-46DdHlnQqrsUuWwX] [-a anondir] [-C user] [-c confdir]
[-e emailaddr] [-h hostname] [-L xferlogfile]
[-P dataport] [-V version]
Runs on:
Neutrino
Options:
In addition to the options described in the NetBSD documentation, ftpd supports the
following:
-n Don’t attempt to translate IP addresses into hostnames.
Description:
The ftpd daemon is an Internet File Transfer Protocol server. It uses the TCP
protocol. For more information, see the NetBSD documentation at
http://netbsd.gw.com/cgi-bin/man-cgi?ftpd++NetBSD-4.0.
Setting up a restricted ftp subtree

So that system security isn’t breached, it’s recommended that the ftp subtree be
constructed with care; the following rules are recommended:
˜ftp Make the home directory owned by the superuser and

unwritable by anyone.
˜ftp/bin Make this directory owned by the superuser and unwritable by

anyone. Generally, conversion commands are installed here.
The ls utility, which must be present to support the LIST
command, should have mode 111.
˜ftp/usr/lib A directory to contain shared libraries. This example uses

/usr/lib — as it is usually part of _CS_LIBPATH (see
getconf _CS_LIBPATH); however, this may vary on custom
installations. If no binaries in ˜ftp/bin use shared libraries
(all statically linked), this directory is not needed; however, the
ls utility is usually linked against the shared libc. In such a
situation:
# cd ˜ftp
# mkdir -m0555 usr
# chown root:root usr
# mkdir -m0555 usr/lib

© 2010, QNX Software Systems GmbH & Co. KG. ftpd
# chown root:root usr/lib

# cd usr/lib
# cp /lib/libc.so.3 .
# chmod 0555 libc.so.3
# chown root:root libc.so.3
# ln -s libc.so.3 ldqnx.so.2
For MIPS targets, you need to name this link ldqnx.so.3 instead of ldqnx.so.2.
˜ftp/etc Make this directory owned by the superuser and unwritable by

anyone. The /etc/passwd and /etc/group files must be
present for the LIST command to be able to produce owner
names rather than numbers. The password field in
/etc/passwd isn’t used and shouldn’t contain real encrypted
passwords. If there’s an /etc/motd file, its contents are
displayed after a successful login. The /etc/passwd and
/etc/group files should be mode 444.
˜ftp/pub Make this directory mode 777 and owned by ftp. If any files
are to be accessed via the anonymous account, the user should
place them in this directory.
˜ftp/incoming Make this directory where the anonymous users place files they
upload. The owners should be user ftp with an appropriate
group. Members of this group are the only users with access to
these files after they’ve been uploaded, so these people should
know how to deal with them appropriately. To allow anonymous
FTP users the ability to see filenames in this directory, set the
permissions to 770; otherwise, set the permissions to 370.
Anonymous users are able to upload files to this directory, but
they’re unable to download them, delete them, or overwrite
them due to the umask and disabling of the commands
mentioned above.
˜ftp/tmp This directory is used to create temporary files which contain

the error messages generated by a conversion or LIST
command. The owner should be the user ftp. The permissions
should be 300.
Don’t create this directory if you don’t want to enable
conversion commands or don’t want to allow anonymous users
uploading files here (see ˜ftp/incoming above). Error
messages from conversion or LIST commands won’t be
returned to the user. (This is the traditional behavior.) The
/etc/ftpd.conf upload directive can be used to prevent
users uploading here.
To set up “ftp-only” accounts to provide FTP only with no valid shell login, you can:

ftpd © 2010, QNX Software Systems GmbH & Co. KG.
• create a /sbin/nologin file
• copy or link /sbin/nologin to /sbin/ftplogin
• add /sbin/ftplogin to the /etc/shells file
This allows you to log in via FTP into accounts that have /sbin/ftplogin as the
login shell.
See also:
ftp, /etc/ftpchroot, /etc/ftpd.conf, ftpusers, inetd, tftpd, pipe,
syslogd
Based on RFC 959, RFC 1123, RFC 2389, RFC 2428

© 2010, QNX Software Systems GmbH & Co. KG. /etc/ftpd.conf
Configuration file for ftpd
Name:
/etc/ftpd.conf
Description:
The /etc/ftpd.conf file specifies various configuration options for ftpd that apply
once a user has authenticated their connection.
Each authenticated user is a member of a class (determined by the /etc/ftpusers
file) that associates which entries in this file apply to the user. When parsing entries
the following special classes are available:
all Match any class.
none Match no class.
The /etc/ftpd.conf file consists of a series of lines, each of which may contain a
configuration directive, a comment, or a blank line. Directives that appear later in the
file override settings by previous directives. This allows “wildcard” entries to define
defaults, and then have class-specific overrides.
A “\” is the escape character; it can be used to escape the meaning of the comment
character, or if it’s the last character on a line, extends a configuration directive across
multiple lines. A “#” is the comment character, and all characters from it to the end of
line are ignored (unless it’s escaped with the escape character).
The ftpd STAT command returns the class settings for the current user as defined by
/etc/ftpd.conf.
Each configuration line may be one of:
checkportcmd class [off]

Check the PORT command for validity. The PORT command fails
if the IP address specified doesn’t match the FTP command
connection, or if the remote TCP port number is less than
IPPORT_RESERVED. It’s strongly encouraged that this option be
used, espcially for sites concerned with potential security
problems with FTP bounce attacks. If class is none, or if off is
specified, this feature is disabled.
chroot class [pathformat]

Specify the root directory to use with chroot() at login. The
directory name is created by parsing pathformat; the following
escape strings may be used:

/etc/ftpd.conf © 2010, QNX Software Systems GmbH & Co. KG.
Escape: Description:
%c Class name
%d Home directory of user
%u Username
%% A % character
If pathformat isn’t specified, or if class is none then the default

root directory is / for REAL users, or the user’s home directory
for GUEST and CHROOT users.
classtype class type
Set the class type of class to type, where type is one of:
CHROOT chroot()ed users (as per /etc/ftpchroot). A

chroot() is performed after login.
GUEST Guests (as per the anonymous and ftp logins). A
chroot() is performed after login.
REAL Normal users.
conversion class suffix [type disable command]

Define an automatic inline file conversion. If the file to be
retrieved ends in suffix, and a real file (without a suffix) exists,
then the output of the command is returned instead of the
contents of the file.
suffix The suffix to initiate the conversion.

type A list of valid filetypes for the conversion. Valid
types are: f (file) and d (directory).
disable A file that prevents a conversion if it exists. A
filename of “.” prevents this action (that is, the
conversion is always permitted).
command Command to run for the conversion. The first word
should be the full pathname of the command as
execv() is used to execute the command. All
instances of the word %s in the command are
replaced with the requested file (without the suffix).
Conversion directives specified later on in the file override

earlier conversions with the same suffix.
display class [file]
Display the contents of file (if it exists) each time the user enters
a new directory. Escape sequences are supported; for more

information, see the “Display file escape sequences” section in

the NetBSD documentation for ftpd at
If file isn’t specified, or class is none, disable this.
limit class count [file]

Limit the maximum number of concurrent connections for class
to count, with 0 indicating unlimited connections. If the limit is
exceeded, and file is specified, display its contents to the user.
This line is ignored if class is none or if count isn’t specified.
homedir class [pathformat]

Specify the directory to change into at login, and use as the
“home” directory of the user for tilde expansion in pathnames,
etc. The pathformat argument is parsed as per the chroot
directive.
If pathformat isn’t specified, or if class is none then the default
home directory is the home directory of the user for REAL users,
or / for GUEST and CHROOT users.
maxtimeout class time
Set the maximum timeout period that a client may request
(default is 2 hours). The period can’t be less than 30 seconds, or
be equal to the value of the timeout directive. This line is
ignored if class is none or time isn’t specified.
modify class [off]

If class is none, or if off is specified, disable these commands:
CHMOD, DELE, MKD, RMD, RNFR, and UMASK. Otherwise, enable
them.
motd class [file] Display the contents of file after login as the “message of the
day.” Escape sequences are supported; for more information, see
the “Display file escape sequences” section in the NetBSD
documentation for ftpd at
If file isn’t specified, or class is none, disable this.
notify class [fileglob]

Notify the user of any files matching fileglob. each time the user
enters a new directory,
If fileglob isn’t specified, or class is none, disable this.
passive class [off]

If class is none, or if off is specified, disallow passive
(PASV/LPSV/EPSV) connections.

/etc/ftpd.conf © 2010, QNX Software Systems GmbH & Co. KG.
portrange class min max

Set the range of port numbers which are used for the passive data
port. The value of max must be greater than min, and both
numbers must be be between IPPORT_RESERVED and
IPPORT_ANONMAX.
rateget class rate

Set the maximum get (RETR) transfer rate throttle for class to
rate bytes per second. If rate is 0, the throttle is disabled.
An optional suffix may be provided, which changes the
intrepretation of rate as follows:
• b —Don’t modify (optional).
• k —Kilo. Multiply the argument by 1024.
• m —Mega. Multiply the argument by 1048576.
• g —Giga. Multiply the argument by 1073741824.
rateput class rate
Set the maximum put (STOR) transfer rate throttle for class to
rate bytes per second. The rate argument is parsed as described
in rateget.
template class [refclass]
Define refclass as the template for class. All subsequent
references to refclass in the directives also apply to members of
class. You’d define a class template so that other classes, which
share common attributes, can be easily defined without
unnecessary duplication. There can be only one template defined
at a time. If refclass isn’t specified, disable the template for
class.
timeout class time
Set the timeout period for inactivity (default is 15 minutes). It
can’t be less than 30 seconds, or greater than the value for
maxtimeout. This line is ignored if class is none or time isn’t
specified.
umask class umaskval
Set the umask to umaskval. This line is ignored if class is none
or umaskval isn’t specified.
upload class [off]
If class is none, or if off is specified: disable these commands:
APPE, STOR, STOU; and modify these: CHMOD, DELE, MKD, RMD,
RNFR, UMASK.
Otherwise, enable them.

Default settings
The following defaults are used:
checkportcmd all
classtype chroot CHROOT
classtype guest GUEST
classtype real REAL
display none
limit all -1 # unlimited connections
maxtimeout all 7200 # 2 hours
modify all
motd all motd
notify none
passive all
timeout all 900 # 15 minutes
umask all 027
upload all
modify guest off
umask guest 0707
See also:
/etc/ftpchroot, ftpd, ftpusers

/etc/ftpusers © 2010, QNX Software Systems GmbH & Co. KG.
Access-control file for ftpd
Name:
/etc/ftpusers
Description:
The /etc/ftpusers file provides user access control for ftpd by defining which
users may login.
If the /etc/ftpusers file doesn’t exist, all users are denied access.
The syntax of each line is:

userglob[:groupglob][@host] [directive [class]]
where:
userglob Match against the username. Calls fnmatch() (e.g. f*).

groupglob Match against all the groups that the user is a member of. Calls
fnmatch() (e.g. *src).
host Either a CIDR address (see inet_net_pton()) to match against the
remote address (e.g. 1.2.3.4/24), or a glob to match against the
remote hostname (e.g. *.netbsd.org).
directive Allow or deny user access.
• allow or yes — allow user access
• deny or no — deny user access
If none of the above values are specified, user access is denied.
class Use this class in /etc/ftpd.conf. If class isn’t specified, it defaults
to one of the following:
• chroot — there’s a match in /etc/ftpchroot for the user.
• guest — the user name is anonymous or ftp.
• real — neither of the above is true.
No further comparisons are attempted after the first successful match.
If no match is found, the user is granted access. This syntax is
backward-compatable with the old syntax.
If a user requests a guest login, the ftpd server checks to see that
both anonymous and ftp have access. If you deny all users by
default, you’ll need to add both anonymous allow and ftp allow
to /etc/ftpusers in order to allow guest logins.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/ftpusers
The character: Meaning:

\ Escape character. It can be used to escape the meaning of the
comment character, or if it’s the last character on a line, it
extends a configuration directive across multiple lines.
# Comment character. All characters from it to the end of line are
ignored (unless it’s escaped with the escape character).
Related files
/etc/ftpchroot
List of the normal users who should have their session’s root directory changed.
See also:
ftpd, /etc/ftpd.conf
fnmatch(), inet_net_pton() in the Library Reference

fullpath © 2010, QNX Software Systems GmbH & Co. KG.
Display network-qualified pathnames (QNX)
Syntax:
fullpath [-v] [name...]
Runs on:
Neutrino
Options:
-v Write verbose output, in this form:
name is qualified_path
By default, fullpath displays only the fully qualified name.
name A filename.
Description:
The fullpath utility resolves all prefixes and symbolic links to display a fully
qualified network path for each filename you specify. If no names are given,
fullpath displays the full pathname of the current working directory.
Examples:
$ fullpath -v /usr/bin/CC
/usr/bin/CC is /usr/bin/qcc
Exit status:
See also:
basename, dirname

© 2010, QNX Software Systems GmbH & Co. KG. g++
Compile and link a program (GNU)
We recommend you use qcc instead of invoking g++ directly. You can use the -V
option to qcc to invoke g++. For example:
qcc -Vgcc_ntoarmle my_file.cpp
Syntax:
g++_variant [ option | filename ]...
Runs on:
Options:
The g++_variant depends on the target platform, as follows:
Target platform: g++_variant:

ARM ntoarm-g++
MIPS ntomips-g++
PowerPC ntoppc-g++
SH4 ntosh-g++
x86 ntox86-g++
Description:
See gcc for details.
We recommend you use qcc or QCC instead of gcc to compile and link your programs.
For detailed documentation about gcc, see the GNU website at
If you have trouble using the default debug format (-gdwarf), switch to -gdwarf-2
or -gstabs.
Exit status:
0 Success.
33 A nonfatal compilation error was encountered.
34 A fatal compilation error was encountered.
35 Unable to open a required file.

g++ © 2010, QNX Software Systems GmbH & Co. KG.
GNU
See also:
gcov, gdb, qcc

© 2010, QNX Software Systems GmbH & Co. KG. /etc/gateways
Specify Internet routing information to routed
Name:
/etc/gateways
Description:
The /etc/gateways file identifies gateways for the routed daemon. Typically, the
routed daemon queries the network and builds routing tables based on the routing
information transmitted by other hosts that are directly connected to the network.
Gateways that the daemon can’t identify through its queries (also called distant
gateways) may be identified in this file.
When the routed daemon starts, it calls this file to:
• find distant gateways which may not be located using only the information from a
routing socket
• discover if some of the local gateways are passive
• obtain other parameters (see “Other parameter settings”).
Gateways must be marked as passive, active or external to indicate how it is to

be treated:
active Is willing to exchange RIP (Routing Information Protocol) packets —

they’re treated like network interfaces.
passive Aren’t expected to exchange routing information.
external Are to be considered passive. Another routing process will install

such a route if necessary, and other routes to that destination shouldn’t
be installed by routed.
Each entry is contained on a single line. Blank lines and lines starting with a pound
sign (#) indicates a comment. An entry may specify user preferences (see “Other
parameter settings”), or it can indicate whether the route is to a network a specific host
using one of the following formats:
net Nname[/mask] gateway Gname metric value passive|active|extern
host Hname gateway Gname metric value passive|active|extern
Gname Name or address of the gateway to which RIP (Routing

Information Protocol) responses should be forwarded.
Hname or Nname Name of the destination network or host. It may be a symbolic

network name (as used in /etc/hosts or /etc/networks) or
an Internet address specified in the conventional “.” (dot)

/etc/gateways © 2010, QNX Software Systems GmbH & Co. KG.
notation using the inet_network() routine from the internet

address manipulation functions, inet_*().
If it’s a symbolic network name, then it must either be defined
in /etc/networks or /etc/hosts, or named and must be
started before routed.
mask Optional number, between 1 and 32, that indicates the netmask
associated with Nname.
value The hop count to the destination host or network.
active Send RIP responses to the distant active gateway. As long as the
gateway is active, information about it is maintained in the
internal routing tables, and will be included with any routing
information transmitted through RIP. If the gateway doesn’t
respond for a period of time, the associated route is deleted from
the internal routing tables and the RIP responses are advertised
via other interfaces. If the distant gateway resumes sending RIP
responses, the associated route is restored.
Such gateways can be useful on media that don’t support
broadcasts or multicasts but otherwise act like classic shared
media like Ethernets such as some ATM networks. One can list
all RIP routers reachable on the HIPPI or ATM network in
/etc/gateways with a series of “host” lines. Note that it’s
usually desirable to use RIPv2 in such situations to avoid
generating lists of inferred host routes.
passive Don’t exchange RIP (Routing Information Protocol)

information. Mark the interface as not to be advertised in
updates sent via other interfaces, and turn off all RIP and router
discovery through the interface.
Routes through passive gateways are installed in the kernel’s
routing tables once at startup and aren’t included in transmitted
RIP responses.
extern Inform the routed daemon that another routing process will
install such a route and that alternative routes to that destination
shouldn’t be installed by routed. Information about external
gateways is not maintained in the internal routing tables and
isn’t transmitted through RIP. Such entries are only required
when both routers may learn of routes to the same destination.
When debugging is turned on with -T, these lines create pseudo-interfaces. When
setting parameters for remote or external interfaces, you should start the lines with:
if=alias(Hname), or if=remote(Hname), etc.

Other parameter settings

Lines that don’t start with net or host must consist of one or more of the following
parameter settings, separated by commas or blanks:
bcast_rdisc Specify that Router Discovery packets should be broadcast

instead of multicast.
fake_default=metric
Identical effect to the following with the network and mask
coming from the specified interface:
-F net[/mask][=metric]
if=ifname Indicate that the other parameters on the line apply to the
interface name ifname.
md5_passwd=XXX|KeyID[start|stop]
Specify a RIPv2 MD5 password. This keyword is similar to
passwd, except that a KeyID is required.
no_ag Turn off collection (aggregation) of subnets in RIPv1 and RIPv2

responses.
no_rdisc Disable the Internet Router Discovery Protocol.
no_rdisc_adv Disable the transmission of Router Discovery Advertisements.
no_rip Disable all RIP processing on the specified interface. If no

interfaces are allowed to process RIP packets, routed acts
purely as a router discovery daemon.
Note that turning off RIP without explicitly turning on router
discovery advertisements with rdisc_adv or -s causes routed
to act as a client router discovery daemon, not advertising.
no_rip_mcast Cause RIPv2 packets to be broadcast instead of multicast.
no_ripv1_in Ignore RIPv1 received responses.
no_solicit Disable the transmission of Router Discovery Solicitations.
no_super_ag Turn off the collection of networks into supernets in RIPv2

responses.
passwd=XXX[|KeyID[start|stop]]
Specify a RIPv2 cleartext password that’ll be included in all
RIPv2 responses sent, and checked in all RIPv2 responses
received. Any blanks, tab characters, commas, or #, |, or NULL
characters in the password must be escaped with a backslash (\).
The common escape sequences \n, \r, \t, \b, and \xxx have
their usual meanings. The KeyID must be unique but is ignored

/etc/gateways © 2010, QNX Software Systems GmbH & Co. KG.
for cleartext passwords. If present, start and stop are

timestamps in the form year/month/day@hour:minute.
They specify when the password is valid. The valid password
with the most future is used on output packets, unless all
passwords have expired, in which case the password that expired
most recently is used, or unless no passwords are valid yet, in
which case no password is output. Incoming packets can carry
any password that’s valid, will be valid within 24 hours, or that
was valid within 24 hours. To protect the secrets, the passwd
settings are valid only in the /etc/gateways file and only
when that file is readable only by root.
pm_rdisc Similar to fake_default. When RIPv2 routes are multicast, so

that RIPv1 listeners cannot receive them, this feature causes a
RIPv1 default route to be broadcast to RIPv1 listeners. Unless
modified with fake_default, the default route is broadcast
with a metric of 14. That serves as a “poor man’s router
discovery” protocol.
rdisc_adv Specify that Router Discovery Advertisements should be sent,

even on point-to-point links, which by default only listen to
Router Discovery messages.
rdisc_interval=N
Set the nominal interval with which Router Discovery
Advertisements are transmitted to N seconds and their lifetime to
3*N.
rdisc_pref=N Set the preference in Router Discovery Advertisements to the

optionally signed integer N (default preference is 0). Default
routes with smaller or more negative preferences are preferred by
clients.
redirect_ok Cause RIP to allow ICMP Redirect messages when the system is
acting as a router and forwarding packets. Otherwise, override
ICMP Redirect messages.
ripv1_mask=nname/mask1,mask2
Specify that the netmask of the network, of which nname/mask1
is a subnet, should be mask2. For example,
ripv1_mask=192.0.2.16/28,27 marks 192.0.2.16/28 as
a subnet of 192.0.2.0/27 instead of 192.0.2.0/24.
It’s better to turn on RIPv2 with ripv2_out, instead of using
this facility.
ripv2 Enable RIPv2. It’s equivalent to no_ripv1_in and

no_ripv1_out.

ripv2_out Turn on RIPv2 output and cause RIPv2 advertisements to be

multicast when possible.
send_solicit Specify that Router Discovery solicitations should be sent, even

on point-to-point links, which by default only listen to Router
Discovery messages.
subnet=nname[/mask][,metric]
Advertise a route to network nname with mask mask and the
supplied metric (default is 1). This parameter must appear by
itself on a line. The network number must specify a full, 32-bit
value, as in 192.0.2.0 instead of 192.0.2.
Although this feature may be useful for filling “holes” in CIDR
allocations, it’s a dangerous feature and shouldn’t be used unless
necessary.
trust_gateway=rname[|net1/mask1|net2/mask2|...]
Cause RIP packets from that router and other routers named in
other trust_gateway keywords to be accepted, and packets
from other routers to be ignored. If networks are specified, then
routes to other networks will be ignored from that router.
See also:
routed, rtquery

gawk © 2010, QNX Software Systems GmbH & Co. KG.
Pattern scanning and processing language (POSIX)
Syntax:
gawk [-F ere] [-v var=val] [-W GNU_extension...]
[--] program [argument]...
gawk [-F ere] -f progfile [-v var=val]

[-W GNU_extension...] [--] [argument]...
Runs on:
Neutrino
Options:
-f progfile
--file=progfile
Specifies the name of the gawk program, progfile, which contains gawk
statements. You can also specify the gawk program as a single argument
in the command line by using quotes.
-F ere
--field-separator=ere
Define the input field separator (FS) to be the extended regular
expression ere, before any input is read.
-v var=val
--assign=var=val
Assign the value val to variable var before execution of the program
begins.
-W GNU_extension[,GNU_extension]...
Specify a GNU extension. Multiple -W options may be specified, or
multiple extensions may be listed in a single -W option if they are
separated by commas (or white space if the entire option argument has
been quoted from the command line). You can also specify these
options using the GNU long options shown in parentheses below.
The GNU extended options are:
compat (--compat)
Run in compatibility mode. In compatibility mode,
GNU gawk behaves identically to UNIX awk;
none of the GNU-specific extensions are
recognized.
copyleft (--copyleft)
copyright (--copyright)
Print the short version of the GNU copyright
information message on the error output.

© 2010, QNX Software Systems GmbH & Co. KG. gawk
dump-variables[=file] (--dump-variables[==file])
Print a sorted list of global variables, their types,
and final values to file. If you don’t specify a file,
gawk prints this list to the file named
awkvars.out in the current directory.
exec=file (--exec=file)
Similar to -f: read the program text from file.
There are two differences:
• This option terminates option processing;
anything else on the command line is passed on
directly to the gawk program.
• Command-line variable assignments of the
form var=value aren’t allowed.
gen-po (--gen-po)
Analyzes the source program and generates a GNU
gettext Portable Object file on standard output for
all string constants that have been marked for
translation.
help (--help)
usage (--usage) Print a relatively short summary of the available
options on the error output.
lint[=fatal] (--lint[=fatal]
Provide warnings about constructs that are dubious
or nonportable to other awk implementations. If
you specify fatal, lint warnings become fatal
errors.
lint-old (--lint-old)
Warn about constructs that aren’t available in the
original version of awk from Version 7 Unix.
non-decimal-data (--non-decimal-data)
Enable automatic interpretation of octal and
hexadecimal values in input data.
posix Turn on compatibility mode, with the following
additional restrictions:
• \x escape sequences are not recognized.
• The synonym func for the keyword function
is not recognized.
• The operators ** and **= cannot be used in
place of ˆ and ˆ=.
profile[=file] (--profile[=file])
Enable profiling of awk programs. By default,
profiles are created in a file named awkprof.out.

The optional file argument lets you specify a

different file name for the profile file.
re-interval (--re-interval)
Allow interval expressions in regular expressions.
source=program-text (--source=program-text)
Use program-text as AWK program source code.
This option allows the easy intermixing of library
functions (used via the -f option) with source
code entered on the command line. It is intended
primarily for medium to large size AWK programs
used in shell scripts. The -W source= form of
this option uses the rest of the command-line
argument for program-text; no other options to -W
are recognized in the same argument.
traditional (--traditional)
Disable all gawk extensions.
version (--version)
Print version information for this particular copy of
gawk on the error output. This is useful mainly for
knowing if the current copy of gawk on your
system is up to date with respect to whatever the
Free Software Foundation is distributing.
-- Indicates end of options, in case subsequent item begins with dash (-)
and is not an option.
program The text of an awk program that contains awk statements, assuming no
-fprogfile option has been specified. The awk program can either be in
a file progfile or specified in the command line, taking into account the
quoting rules of the shell.
argument You can intermix either of these two types of arguments:
file The pathname of a file that contains the input to be read;

the input is matched against the set of patterns in the
program. If you don’t specify any files containing input,
or if you specify the dash character (-), the standard input
is used.
assignment You can pass expressions in the form name=value to
gawk, where each instance of name represents the name of
an gawk variable. Each such variable assignment occurs
just prior to the processing of the following file, if any.
The assignment is done before the file argument is
executed, and after the BEGIN action — if any — of that
file.

Description:
The gawk utility executes programs written in the awk programming language; this
language specializes in manipulating textual data. An awk program is a sequence of
patterns and corresponding actions. When input matching a specified pattern is read,
the action associated with that pattern is carried out. The gawk shipped with QNX is a
port of GNU awk.
The gawk utility interprets each input line as a sequence of fields, where, by default, a
field is a string of nonblank characters. You can change this default white space
delimiter by using the builtin variable, FS (see Variables), or the -F ere option. The
gawk utility denotes the first field in a line $1, the second $2, and so forth. A $0 refers
to the entire line; setting any other field causes $0 to be reevaluated.
Each input line matched by the patterns and each input line for the getline function
(see the section on Functions) is limited to 1024 bytes.
Programs in awk are composed of statements of the form:
pattern { action }
You can omit either the pattern or the action (that includes the enclosing braces). In
the following sections of this description, blank characters between operators and
reserved words are ignored, unless otherwise specified. All blank characters are
significant inside literal strings and after a function name. A missing pattern matches
any line of input, and a missing action is equivalent to an action that writes the
matched line of input to standard output.
An awk program follows this general procedure:
1 Starts by executing the actions associated with all BEGIN patterns (BEGIN
patterns are described in the section Special patterns — BEGIN and END).
2 Processes each file argument in turn — or standard input if no files are specified
— by cyclically reading and saving data from the file until a record separator is
seen, evaluating each pattern in the script and executing that action for patterns
that evaluate to true (the default record separator is the newline character).
3 Executes the actions associated with all END patterns.
Expressions:
Expressions describe computations used in patterns and actions. Expressions in awk
are constructed from such operators as conditionals, logicals, arithmetics,
assignments, subscripts, and fields. Expressions take on string or numeric values
appropriate to the context. The following table displays valid expressions in groups,
starting from the highest priority.

In this table, the abbreviation expr represents any expression. The abbreviation lvalue
represents any entity that you can assign a value to (i.e. on the left side of an
assignment operator).
Syntax Description
(expr) Grouping
$expr References field number expr
++lvalue Preincrement lvalue by 1
--lvalue Predecrement lvalue by 1
lvalue++ Postincrement lvalue by 1
lvalue-- Postdecrement lvalue by 1
expr ˆ expr Exponentiation
! expr Logical not
+ expr Unary plus
- expr Unary minus
expr * expr Multiplication
expr / expr Division
expr % expr Integer modulus
expr + expr Addition
expr - expr Subtraction
expr expr String concatenation of two exprs
expr < expr Less than
expr <= expr Less than or equal to
expr != expr Not equal to
expr == expr Equal to
expr > expr Greater than
expr >= expr Greater than or equal to
expr1 ˜ expr2 1 if expr1 matches the ERE described by expr2
expr1 !˜expr2 1 if expr2 doesn’t match the ERE described by expr2
expr in array 1 if array[expr] exists
(index) in array Handles multidimensional arrays
continued. . .

Syntax Description
expr && expr Logical AND
expr || expr Logical OR
expr?expr:expr Conditional expression — evaluates first expr and if nonzero
evaluates to the second expr; otherwise to the third expr
lvalue ˆ= expr Raise lvalue to exponent expr
lvalue %= expr Assign lvalue%expr to lvalue
lvalue *= expr Multiply lvalue by expr
lvalue /= expr Divide lvalue by expr
lvalue += expr Add expr to lvalue
lvalue -= expr Subtract expr from lvalue
lvalue = expr Assign expr to lvalue
All of the arithmetic operators are based on the C Standard. The conditional
expression returns either strings or numbers, depending on the input expressions. Only
one of the alternative expressions is evaluated.
In addition to the descriptions in the previous table, an expression can also be a
floating-point number, a literal string enclosed by double quotation marks ("), or a
variable name.
You can treat a variable or a field as a number or a string at any time, depending on its
current usage. There are no explicit conversions between numbers and strings. To
force an expression to be treated as a number, you add zero to it. To force an
expression to be treated as a string, concatenate the null string ("") to it. Variables and
fields are set by the assignment statement:
lvalue=expression
The type of expression determines the resulting variable type.

The assignment includes these arithmetic assignments:
+= -= *= /= %= ˆ= ++ --
each of which produces a numeric result. The left-hand side of an assignment and the
target of increment and decrement operators can be one of the following:
• a variable
• an array with index
• a field selector
This is indicated by the following BNF grammar:

<lvalue>: <variable>
| $expr
| <variable> [ <index> ]
;
A valid array index consists of one or more comma-separated expressions, with one
expression for each dimension of the array. Because awk arrays behave as associative
memories, an array index can be any string. Since awk arrays are really
one-dimensional, a multidimensional array index is converted to a one-dimensional
index by concatenating all expressions, each separated from the other by the value of
the SUBSEP variable (see Variables).
Thus, the following two index operations are equivalent:
var[expr1, expr2,... , exprn]

var[expr1 SUBSEP expr2 SUBSEP ... SUBSEP exprn]
A multidimensioned index used with the in operator must be parenthesized. The in

operator, which tests for the existence of a particular array element, doesn’t cause that
element to exist. But any other reference to a nonexistent array element automatically
creates it.
Comparisons are made numerically if both operands are numeric; otherwise, operands
are converted to strings as required and a string comparison is made.
In the table of awk expressions, operators of higher precedence are grouped before
those of lower precedence. In expression evaluation, higher precedence operators are
evaluated before lower precedence operators. All operators associate to the left except
for the assignment operators, the conditional operator (?:), and the exponentiation
operator (ˆ). Because the concatenation operation is represented by adjacent
expressions rather than an explicit operator, you often need to use parentheses to
enforce the proper evaluation precedence.
Variables
You can use variables in an awk program by assigning to them. They don’t need to be
declared — uninitialized variables have the value of the empty string, which has a
numeric value of zero. All variables, including fields, are treated as string variables
unless they’re used in a clearly numeric context.
Field variables are designated by a $, followed by a number or a numerical expression.
You can create new field variables by assigning a value to them. References to
nonexistent fields — i.e. fields after “$(NF )” — produce the null string. But,
assigning to a nonexistent field (e.g. $(NF +2)=5) increases the value of NF, creates
any intervening fields with the null string as their values, and causes the value of $0 to
be recomputed, with the fields being separated by the value of OFS.
This table shows other special variables that gawk sets:

Variable Meaning
ARGC The number of elements in the ARGV array
ARGV Array of command-line arguments — excluding options and the
program argument — numbered from zero to ARGC-1
FILENAME Pathname of the current input file
FNR Ordinal number of the current record in the current file
FS Input field separator regular expression; space by default
NF Number of fields in the current record
NR Ordinal number of the current record from the start of input
OFMT Print statement output format for numbers; "%.6g" by default
OFS Print statement output field separation; space by default.
ORS Print statement output record separator; newline by default
RLENGTH Length of string matched by the match function
RS The first character of the string value of RS is the input record
separator; newline by default. If RS is null, records are separated
by blank lines, and newline is always a field separator, regardless
of the value of FS
RSTART Starting position of string matched by match function, numbering
from 1. This is always equivalent to the return value of the match
function
SUBSEP Subscript separator string for multidimensional arrays; the default
value is \034
You can modify or add to the arguments in ARGV; you can alter ARGC. As each input
file ends, gawk treats the text non-NULL element of ARGV, up through the current
value of ARGC-1, as the name of the next input file. Thus, setting an element of ARGV
to null means that it isn’t treated as an input file. A dash (-) filename indicates the
standard input. If an argument contains an equals sign (=), this argument is treated as
an assignment rather than as a file argument.
Patterns
The structure of a pattern is specified by the following BNF grammar:
<pattern>: BEGIN
|END
|<simple pattern>
|<simple pattern>, <simple pattern>
;

<simple pattern>: <simple expression>

|/<ere>/
;
In other words, a pattern is any valid expression, or an extended regular expression. In

addition, a pattern can be a range specified by two of these patterns separated by a
comma, or can be one of the two special patterns BEGIN or END.
Special patterns — BEGIN and END

The gawk utility recognizes two special patterns, BEGIN and END. BEGIN is matched
once and its associated action is executed before the first line of input is read and
before command-line assignment is done. END is matched once and its associated
action is executed after the last line of input has been read. These two patterns have
associated actions.
BEGIN and END don’t combine with other patterns. Multiple BEGIN and END patterns
are allowed. The actions associated with the BEGIN patterns are executed in the order
specified in the program, as are the END actions. An END pattern can precede a BEGIN
pattern in a program.
If a program consists of: Then:

Only BEGIN blocks gawk exits without reading its input
when the last statement in the BEGIN
block is executed.
Only END blocks or only BEGIN and The input is read before the statements
END blocks in the END block(s) are executed.
Regular expressions
The gawk utility uses the extended expression notation, except that it lets you use
C-language conventions for escaping special characters within the extended regular
expressions:
Escape Meaning
\b Backspace
\f Form feed
\n Newline
\r Carriage return
\t Tab
continued. . .

Escape Meaning
\ddd 1-3 digit octal value ddd
If ere is an extended regular expression, the pattern:

/ere/
matches any line of input that contains a substring specified by the regular expression.
You can limit a regular expression comparison to a specific field or string by using one
of the two regular expression matching operators, ˜ and !˜. For example:
$4 ˜ /ere/
matches any line in which the fourth field matches the regular expression /ere/.
This pattern:
$4 !˜ /ere/
matches any line in which the fourth field doesn’t match the regular expression /ere/.
You can use an extended regular expression to separate fields by using the -F ere
option, or by assigning the expression to the builtin variable FS. The default field
separator is a single space character. The following describes the behavior of FS:
1 If FS is a single character:
1a If FS is space, skip leading and trailing blanks; fields are delimited by
sets of one or more blanks.
1b If FS is any other character c, fields are delimited by each single
occurrence of c.
2 Otherwise, if FS is more than one character, FS is considered to be an extended

regular expression. Each occurrence of the string matching the extended regular
expression delimits fields.
Pattern ranges
A pattern range consists of two patterns separated by a comma; in this case, the action
is performed for all lines between an occurrence of the first pattern and the following
occurrence of the second pattern, inclusive. At this point, the pattern range can be
repeated starting at input lines subsequent to the end of the matched range.
Expression patterns
An expression pattern is considered to match — or be true — when the expression
evaluates to a nonzero numeric value. Otherwise, the pattern is considered false.
Actions
An action is a sequence of statements. A statement can be one of the statements listed
as follows. In this list, optional elements are shown in square brackets ([ ]) and
keywords are shown in a constant-width typeface.

if ( expression ) statement [else statement]

while ( expression ) statement
do statement while ( expression )
for ( [expression];[expression]; [expression]) statement
for ( variable in array ) statement
delete array[index]
break
continue
{ [statement]... }
variable = expression
next
exit [ expression ]
return [expression]
print [(] [expression-list] [)] [redirection-expression]
printf [(] format[, expression-list] [)] [redirection-expression]
Any single statement can be replaced by a statement list enclosed in braces (i.e. {}).
The statements in a statement list are separated by newline characters or semicolons.
The symbol # anywhere in a program line — in strings or EREs — begins a comment
that is terminated by the end of the line.
Statements are terminated by semicolons or newline characters. You can split a long
statement across several lines by ending each partial line with a backslash; newline
characters without backslashes can follow:
• a comma
• an open brace
• a logical AND operator (&&)
• a logical OR operator (||)
• the do keyword
• the else keyword
• the closing parenthesis of an if, for, or while statement
For example:
{ print $1,
$2 }
String constants are surrounded by double quotes ("string"). A string expression is

created by concatenating constants, variables, field names, array elements, functions,
and other expressions.
The expression acting as the conditional in an if statement is evaluated, and if it is
nonzero and nonnull, the next statement is executed. Otherwise, if else is present, the
statement following the else is executed.

The while, do...while, for, break, and continue statements are based on the C
Standard, except in the case of for ( variable in array ), which iterates assigning
each index of array to variable in order. The for statement has a form that processes
each element in an array. The order of processing is unspecified.
The awk language supplies arrays that are used for storing numbers or strings. Arrays
don’t have to be declared, and their sizes change dynamically. The subscripts, or
element identifiers, are strings that provide a type of associative array capability.
Subscripts can’t themselves be arrays.
The delete statement removes an individual array element. Thus, the following code
deletes an entire array:
for (index in array)
delete array[index]
The next statement causes all further processing of the current input line to be
abandoned.
The exit statement invokes all END actions in the order in which they occur in the
program source. A next statement inside an END also terminates the program and can
optionally set the utility’s exit status.
Output statements
Both print and printf statements send their output to standard output by default.
The output is written to the location specified by redirection-expression, if one is
supplied, as follows:
>expression
>>expression
|expression
In all cases, the expression is evaluated to produce a string that’s used as a full
pathname to write into (for > or >>) or as a command to be executed (for |). Using the
first two forms, if the file of that name isn’t currently open, it is created if necessary,
opened, and using the first form, truncated. The output is then appended to the file.
Subsequent calls in which expression evaluates to the same name simply append
output to the file; the file remains open until closed.
The third form writes output onto a stream compatible with popen(). If no stream is
currently open, the stream is created with the same command name; the stream created
is compatible with popen() invoked with a mode of w. Subsequent calls write output to
the existing stream if, in those calls, expression evaluates to the same command name
as a stream that’s currently open. The stream is closed as if pclose() were called with
an expression that evaluates to the same command name.
The print statement writes the value of each expression argument to the indicated
output stream, separated by the current output field separator (see OFS in the table of
gawk variables), and terminated by the output record separator (see ORS in the table).
String expressions are written out as is; numeric expressions are written out as if
produced by printf using a format that is the string value of the variable OFMT. The

expression-list is a comma-separated list of expressions. An empty expression-list

stands for the whole input line ($0).
With printf, the expressions are printed according to the specified format. A format
argument is required — all other arguments in expression-list are optional. The string
value of the expression format is interpreted in a manner similar to the C function
printf(), as follows. In the format string, format specifications begin with the single
character %, and can optionally include the following three modifiers:
Modifier Meaning
- Left-justify the expression in its field
width Pad-left to this width as needed; a leading 0 pads with zeros
.prec Maximum string width, or digits to right of decimal point
Format specifications are terminated by any other character. For each format
specification that consumes an argument, the next argument from expression-list is
evaluated and converted to the appropriate type (string, integer, or floating point). Both
print and printf can output at least 1024 bytes.
The format-specification characters that gawk uses are as follows:
Character Interpretation
c If the argument is numeric, print a character; if the argument is a
string, print only the first character
d Decimal integer
e Exponential notation: [-]d.ddddddE[+-]dd
f Floating point: [-]ddd.dddddd
g Shorter of e or f notations; suppress nonsignificant zeros
o Unsigned octal number
s String
x Unsigned hexadecimal number
% Print a %; no argument consumed
Functions:
The awk language has a variety of builtin functions: arithmetic, string, input/output,
and general.

Arithmetic Functions:
The arithmetic functions, except for int, are based on the C Standard.
atan2(y,x) Return the arctangent of y/x.
cos(x) Return the cosine of x, where x is in radians.
sin(x) Return the sine of x, where x is in radians.
exp(x) Return the exponential function of x.
log(x) Return the natural logarithm of x.
sqrt(x) Return the square root of x.
int(x) Truncate its argument to an integer; truncated toward 0 when x>0.
rand() Return a random number n, such that 0<=n<1.
srand([expr]) Set the seed value for rand() to expr or to the time of day if expr is
omitted. The previous seed value is returned.
String functions:
gsub(ere,repl[,in]) Behaves like sub (see below), except that it replaces all
occurrences of the regular expression in $0 or in the in
argument, when specified.
index(s, t) Returns the position, in characters, numbering from 1, in string

s where string t first occurs, or zero if it doesn’t occur at all.
length[ (s) ] Returns the length, in characters, of its argument taken as a

string, or of the whole, $0, if there is no argument.
match(s, ere) Returns the position, in characters, numbering from 1, in string

s where the extended regular expression ere occurs, or zero if it
doesn’t occur at all. RSTART is set to the starting position
(which is the same as the returned value), zero if no match is
found; RLENGTH is set to the length of the matched string, -1
if no match is found.
split(s, a[, fs]) Splits the string s into array elements a[1], a[2],..., a[n], and
returns n. The separation is done with the extended regular
expression fs or with the field separator FS if fs isn’t given.
sprintf (fmt, expr, expr, ...)

Formats the expressions according to the printf format given by
fmt and returns the resulting string.

sub(ere, repl[, in]) Substitutes the string repl in place of the first instance of the
extended regular expression ere in string in and returns the
number of substitutions. If in is omitted, gawk uses the current
record ($0).
substr(s, m[, n]) Returns the n-character substring of s that begins at position m,
numbering from 1. If n is missing, the length of the substring is
limited by the length of the string s.
All of the preceding functions that take ere as a parameter expect a pattern or a string
valued expression that is a regular expression.
Input/Output and general functions:
close(expression) Closes the file or pipe named expression.
expression | getline [var]

Pipes the output of the command string given by expression into
getline; each successive call to getline returns the next line of
output from expression. This construct has the behavior of
popen() called with a mode of r. If var isn’t specified, $0 and
NF are set; if var is specified, var is set.
getline Sets $0 to the next input record from the current input file. This
form of getline sets NF, NR, and FNR variables.
getline < expression Sets $0 to the next record from the pathname expression. This
form of getline sets the NF variable.
getline var Sets variable var to the next input record from the current input
file. This form of getline sets FNR and NR variables.
getline var < expression
Sets var from the next record of expression, treated as a
pathname. This form of getline doesn’t set the NF, NR, and NFR
variables.
system (expression) Executes the command given by expression in a manner

consistent with the system() function and returns the exit status.
All forms of getline return 1 for successful input, zero for end of file, and -1 for an
error.
User-defined functions
The awk language also provides user-defined functions. You can define such functions
— in the pattern position of a pattern-action statement — as:
function name(args,...) {statements}

A function can be referred to anywhere in an awk program. In particular, a function

call can precede its definition. The scope of a function is global.
Function arguments are passed by value if scalar and by reference if an array name.
Argument names are local to the function; all other variable names are global. The
number of parameters in the function definition doesn’t have to match the number of
parameters in the function call. Excess formal parameters can be used as local
variables. If fewer arguments are supplied in a function call than are in the function
definition, the extra receiving parameters are left uninitialized.
When you’re invoking a function, remember that no white space is allowed between
the function name and the opening parenthesis. Function calls can be nested and can
be recursive. You can use the return statement to return a value.
In the function definition, newlines are optional before the opening brace and after
the closing brace. Function definitions can appear anywhere in the program where a
pattern-action statement is allowed. In a function call, no white space is allowed
between the function name and the opening parenthesis that begins the function
parameter list.
Sample awk programs:

Note that the following are sample awk programs, not complete command lines.
Write to the standard output all input lines for which field 3 is greater than 5:
$3 > 5
Print every tenth line:

(NR % 10) == 0
Print any line with a substring that matches the regular expression:
/(G|D) (2[0-9][[:alpha:]]*)/
Print the second to last field and the last field in each line; separate the fields by a
colon:
{OFS=":";print $(NF-1), $NF}
Print the line number and number of fields in each line. The three strings representing
the line number, the colon, and the number of fields are concatenated and the resulting
string is written to standard output:
{print NR ":" NF}
Print lines that are longer than 72 characters:

length $0 > 72
Print the first two fields in opposite order separated by the OFS:
{ print $2, $1 }
Same as above, with input fields separated by a comma or space and tab characters,
or a combination of all these:

BEGIN {FS = ",[ \t]*|[ \t]+ " }

{ print $2, $1 }
Add up the first column, and print the sum and the average:
{s += $1 }
END {print "sum is ", s, " average is ", s/NR}
Print the fields in reverse order, one field per line (i.e. many lines out for each line in):
{ for (i = NF; i > 0; --i) print $i }
Print all lines between occurrences of the strings start and stop:
/start/, /stop/
Print all lines whose first field is different from the first field of the previous line:
$1 != prev { print; prev = $1 }
Simulate echo:
BEGIN {
for (i = 1; i < ARGC; ++i)
printf "%s%s ", ARGV[i], i==ARGC-1? "\n ": " "
}
If there’s a file named myfile that contains page headers of the form:
Page #
and a file named program that contains:
/Page/{ $2 = n++; }
{ print }
then the command line:
gawk -f program n=5 myfile
would print the file myfile, filling in page numbers starting at 5.
Examples:
Print the file myfile, which contains page references, filling in page numbers starting
at 5:
gawk ’/Page/{ $2=n++; } { print }’ n=5 myfile
Files:
By default, input files are text files that are read in order. You can modify either
variable ARGV or variable ARGC to place this default file processing under program
control.
The nature of the output files depends on your awk program.

PATH Defines the search path when looking for commands executed by
system(expr), or input and output pipes.
Exit status:
0 All input files were processed successfully.
GNU
See also:
python, sed
Dale Dougherty, sed & awk, O’Reilly and Associates, 1990.
A.V. Aho, Brian W. Kernighan, and Peter J. Weinberger, The AWK Programming
Language, Addison-Wesley, 1988.

gcc © 2010, QNX Software Systems GmbH & Co. KG.
Compile and link a program (GNU)
We recommend you use qcc instead of invoking gcc directly. You can use the -V
option to qcc to invoke gcc. For example:
qcc -Vgcc_ntoarmle my_file.c
Syntax:
gcc_variant [ option | filename ]...
g++_variant [ option | filename ]...
Runs on:
Options:
The gcc_variant depends on the target platform, as follows:
Target platform: gcc_variant:

ARM ntoarm-gcc
MIPS ntomips-gcc
PowerPC ntoppc-gcc
SH4 ntosh-gcc
x86 ntox86-gcc
The g++_variant depends on the target platform, as follows:
Target platform: g++_variant:

ARM ntoarm-g++
MIPS ntomips-g++
PowerPC ntoppc-g++
SH4 ntosh-g++
x86 ntox86-g++
QNX Neutrino cross-development options

-b [ntox86 | ntomips | ntoppc | ntosh]

© 2010, QNX Software Systems GmbH & Co. KG. gcc
Overall options
-c -S -E -o file -pipe -v -x language
C language options
-ansi -fallow-single-precision -fcond-mismatch
-fno-asm -fno-builtin -ffreestanding -fhosted
-fsigned-bitfields -fsigned-char
-funsigned-bitfields -funsigned-char
-fwritable-strings -traditional -traditional-cpp
-trigraphs
C++ language options

-fall-virtual -fdollars-in-identifiers
-felide-constructors -fenum-int-equiv
-fexternal-templates -ffor-scope -fno-for-scope
-fhandle-signatures -fmemoize-lookups
-fname-mangling-version-n -fno-default-inline
-fno-gnu-keywords -fnonnull-objects -fguiding-decls
-foperator-names -fstrict-prototype -fthis-is-variable
-ftemplate-depth-n -nostdinc++ -traditional +en
Warning options
-fsyntax-only -pedantic -pedantic-errors
-w -W -Wall -Waggregate-return
-Wbad-function-cast -Wcast-align -Wcast-qual
-Wchar-subscript -Wcomment -Wconversion -Werror
-Wformat -Wid-clash-len -Wimplicit -Wimplicit-int
-Wimplicit-function-declarations -Wimport -Winline
-Wlarger-than-len -Wmain -Wmissing-declarations
-Wmissing-prototypes -Wnested-externs
-Wno-import -Wold-style-cast -Woverloaded-virtual
-Wparentheses -Wpointer-arith -Wredundant-decls
-Wreorder -Wreturn-type -Wshadow -Wsign-compare
-Wstrict-prototypes -Wswitch -Wsynth
-Wtemplate-debugging -Wtraditional -Wtrigraphs
-Wundef -Wuninitialized -Wunused -Wwrite-strings
Debugging options
-a -ax -dletters -fpretend-float
-fprofile-arcs -ftest-coverage
-g -glevel -gcoff -gdwarf -gdwarf-1 -gdwarf-1+
-gdwarf-2 -ggdb -gstabs -gstabs+ -gxcoff -gxcoff+
-p -pg -print-file-name=library
-print-libgcc-file-name -print-prog-name=program
-print-search-dirs -save-temps
QNX extension:
-MAP

Optimization options
-fbranch-probabilities
-fcaller-saves -fcse-follow-jumps -fcse-skip-blocks
-fdelayed-branch -fexpensive-optimizations
-ffast-math -ffloat-store -fforce-addr -fforce-mem
-ffunction-sections -finline-functions
-fkeep-inline-functions -fno-default-inline
-fno-defer-pop -fno-function-cse
-fno-inline -fno-peephole -fomit-frame-pointer
-frerun-cse-after-loop -fschedule-insns
-fschedule-insns2 -fstrength-reduce -fthread-jumps
-funroll-all-loops -funroll-loops
-O -O0 -O1 -O2 -O3
Preprocessor options
-Aquestion(answer) -C -dD -dM -dN
-Dmacro[=defn] -E -H
-idirafter dir
-include file -imacros file
-iprefix file -iwithprefix dir
-iwithprefixbefore dir -isystem dir
-M -MD -MM -MMD -MG -nostdinc -P -trigraphs
-undef -Umacro -Wp,option
Assembler option
-Wa,option
Linker options
object-file-name -llibrary
-nostartfiles -nodefaultlibs -nostdlib
-s -static -shared -symbolic
-Wl,option -Xlinker option
-u symbol
Directory options
-Bprefix -Idir -I- -Ldir -specs=file
Target options
-b machine -V version
Machine-dependent options
PowerPC options:
-mcpu=cpu type
-mtune=cpu type
-mpower -mno-power -mpower2 -mno-power2
-mpowerpc -mno-powerpc
-mpowerpc-gpopt -mno-powerpc-gpopt
-mpowerpc-gfxopt -mno-powerpc-gfxopt
-mnew-mnemonics -mno-new-mnemonics
-mfull-toc -mminimal-toc -mno-fop-in-toc
-mno-sum-in-toc -mxl-call -mno-xl-call -mthreads
-mpe -msoft-float -mhard-float -mmultiple

-mno-multiple -mstring -mno-string -mupdate

-mno-update -mfused-madd -mno-fused-madd
-mbit-align -mno-bit-align
-mstrict-align -mno-strict-align -mrelocatable
-mno-relocatable -mrelocatable-lib
-mno-relocatable-lib
-mtoc -mno-toc -mtraceback -mno-traceback
-mlittle -mlittle-endian -mbig -mbig-endian
-mcall-aix -mcall-sysv -mprototype -mno-prototype
-msim -mmvme -mads -myellowknife -memb
-msdata -msdata=opt -G num
MIPS options:
-mabicalls -mcpu=cpu type -membedded-data

-membedded-pic -mfp32 -mfp64 -mgas -mgp32 -mgp64
-mgpopt -mhalf-pic -mhard-float -mint64 -mips1
-mips2 -mips3 -mlong64 -mlong-calls -mmemcpy
-mmips-as -mmips-tfile -mno-abicalls
-mno-embedded-data -mno-embedded-pic
-mno-gpopt -mno-long-calls
-mno-memcpy -mno-mips-tfile -mno-rnames
-mno-stats -mrnames -msoft-float
-m4650 -msingle-float -mmad
-mstats -EL -EB -G num -nocpp
The MIPS options include the following QNX extension:
-mqnxpic
i386 options:
-mcpu=cpu type
-march=cpu type
-mieee-fp -mno-fancy-math-387
-mno-fp-ret-in-387 -msoft-float -msvr3-shlib
-mno-wide-multiply -mrtd -malign-double
-mreg-alloc=list -mregparm=num
-malign-jumps=num -malign-loops=num
-malign-functions=num
SH options:
-m1 -m2 -m3 -m3e -m4

-ml -mb
-mdalign -mbigtable -mrelax -mspace -msmall
Code-generation options
-fcall-saved-reg -fcall-used-reg
-ffixed-reg -finhibit-size-directive
-fcheck-memory-usage -fprefix-function-name
-fno-common -fno-ident -fno-gnu-linker
-fpcc-struct-return -freg-struct-return
-fshared-data -fpic -fPIC -fexceptions
-fshort-enums -fshort-double -fvolatile
-fvolatile-global -fverbose-asm -fpack-struct
-fstack-check +e0 +e1

• If you use exceptions, you must link with the -lang-c++ option to qcc. This
option is the default for QCC.
Even with exceptions disabled, the default new() operator throws a
std::out_of_memory exception if there isn’t enough memory. If you want new()
to return NULL instead of throwing an exception, overload the new() operator with
your own.
• On most platforms, the -fpic and -fPIC options are synonymous, but on PPC
they’re different and incompatible. We chose -fpic over -fPIC for performance
reasons, and our PPC OS is built that way.
If you see problems (such as relocation-truncation errors) at link time when you
build a shared object, consider splitting it into multiple shared objects.
QNX Neutrino extension:
-mno-fp-moves Prevent the code generator from using floating point registers to
move integers. Using floating point registers for this is very
slow on systems that use floating point emulation.
Description:
We recommend you use qcc or QCC instead of gcc to compile and link your programs.
For detailed documentation about gcc, see the GNU website at
If you have trouble using the default debug format (-gdwarf), switch to -gdwarf-2
or -gstabs.
Exit status:
0 Success.
33 A nonfatal compilation error was encountered.
34 A fatal compilation error was encountered.
35 Unable to open a required file.
GNU

See also:
gcov, gdb, qcc

gcov © 2010, QNX Software Systems GmbH & Co. KG.
Gather code coverage data (GNU)
Syntax:
gcov_variant [options] sourcefile
Runs on:
Options:
The gcov_variant depends on the target platform, as follows:
Target platform: gcov_variant:

ARM ntoarm-gcov
MIPS ntomips-gcov
PowerPC ntoppc-gcov
SH4 ntosh-gcov
x86 ntox86-gcov
-b or --branch-probabilities
Write branch frequencies to the output file and branch
summary info to standard output. This lets you see how often
each branch was taken.
-c or --branch-counts
Write branch frequencies as the number of branches taken
instead of the percentage of branches taken.
-f or --function-summaries
Output summaries for each function in addition to the file level
summary.
-h or --help Display gcov command-line options and exit.
-l or --long-file-names
Create long file names for included source files.
For example, if x.h was included in a.c, then running
gcov -l on a.c will produce a.c##x.h.gcov instead of
x.h.gcov. This can be useful if x.h is included in multiple
source files.
-n or --no-output Don’t create the output file.

© 2010, QNX Software Systems GmbH & Co. KG. gcov
-o directory|file or --object-directory directory, --object-file file

Specify the directory containing the gcov data files or the
object path name.
The gcov utility searches for the .bb, .bbg, and .da data files
using this option. If a directory is specified, the data files are in
that directory and named after the source file name without its
extension. If a file is specified, the data files are named after
that file without its extension. If this option isn’t specified, it
defaults to the current directory.
-p or --preserve-paths
Preserve complete path information in the names of generated
.gcov files.
Without -p only the filename component is used. With -p, all
directories are used, with / characters translated to #
characters, . directory components removed and ..
components renamed to ˆ. This is useful if source files are in
several different directories.
The -p option also affects the -l option.
-v or --version Display the gcov version number on the standard output and
exit.
Description:
The gcov utility produces code coverage data for an application compiled with the
-Wc,-fprofile-argcs -Wc,-ftest-coverage options to qcc (or the
-fprofile-arcs -ftest-coverage options to gcc). This data is interpreted
visually for you by the Code Coverage perspective in the QNX Momentics IDE.
For detailed documentation about gcov, see the gcc documentation on the GNU
website at http://www.gnu.org/.
Exit status:
0 Success.
not 0 An error occurred.
GNU
See also:
gcc, qcc

gdb © 2010, QNX Software Systems GmbH & Co. KG.
Debugger (GNU)
Syntax:
gdb_variant [options] [executable] [ core_file | pid ]
Runs on:
Options:
The gdb_variant depends on the target platform, as follows:
Target platform: gdb_variant:

ARM ntoarm-gdb
MIPS ntomips-gdb
PowerPC ntoppc-gdb
SH4 ntosh-gdb
x86 ntox86-gdb
The options are:
-[no]async Enable (disable) asynchronous version of CLI.
-b bps Set the line speed (baud rate or bits per second) of any serial
interface used by gdb for remote debugging.
-batch Run in batch mode. Exit with status 0 after processing all the
command files specified with -x (and all commands from
initialization files, if not inhibited with -n). Exit with nonzero
status if an error occurs in executing the gdb commands in the
command files.
Batch mode may be useful for running gdb as a filter, for example
to download and run a program on another computer. To make this
more useful, the message:
Program exited normally.
(which is ordinarily issued whenever a program running under

gdb control terminates) isn’t issued when running in batch mode.
-cd=directory Run gdb using directory as its working directory, instead of the
current directory.
-command=file Execute gdb commands from file. See “Command files” in the full
online GNU documentation.

© 2010, QNX Software Systems GmbH & Co. KG. gdb
-core=file Examine file as a core dump.
-dbx DBX compatibility mode.
-directory=directory
Add directory to the path to search for source files.
-epoch Output information used by epoch emacs-GDB interface.
-exec=file Use file as the executable file to execute when appropriate, and for
examining pure data in conjunction with a core dump.
-fullname GNU Emacs sets this option when it runs gdb as a subprocess. It
tells gdb to output the full filename and line number in a standard,
recognizable fashion each time a stack frame is displayed (which
includes each time your program stops). This recognizable format
looks like two \032 characters, followed by the file name, line
number and character position separated by colons, and a newline.
The Emacs-to-gdb interface program uses the two \032
characters as a signal to display the source code for the frame.
-help Display all available options and briefly describe their use.
-interpreter=file
Select a specific interpreter or user interface.
-mapped Use mapped symbol files if supported on this system.
This option depends on operating system facilities that aren’t supported on all
systems.
If memory-mapped files are available on your system through the
mmap() system call, you can use this option to have gdb write the
symbols from your program into a reusable file in the current
directory.
For example, if the program you’re debugging is called
/tmp/fred, the mapped symbol file is ./fred.syms. Future
gdb debugging sessions notice the presence of this file, and can
quickly map in symbol information from it, rather than read the
symbol table from the executable program.
The .syms file is specific to the host machine where gdb is run. It
holds an exact image of the internal gdb symbol table. It can’t be
shared across multiple host platforms.
-nw Do not use a window interface.
-nx Don’t execute commands from any initialization files (normally

called .gdbinit). If you don’t specify this option, these

gdb © 2010, QNX Software Systems GmbH & Co. KG.
.gdbinit files are executed before any command-line options

and arguments have been processed.
For more information on initialization files, see “Command files”
in the full online GNU documentation.
-quiet Don’t print the introductory and copyright messages. These

messages are also suppressed in batch mode.
-readnow Read each symbol file’s entire symbol table immediately, rather
than read it incrementally as needed. This makes startup slower,
but makes future operations faster.
The -mapped and -readnow options are typically combined in
order to build a .syms file that contains complete symbol
information. (For more information, see “Commands to specify
files” in the full online GNU documentation.)
Here’s how you can build a .syms file for future use:
gdb -batch -nx -mapped -readnow programname
-se=file Read the symbol table from file and use it as the executable file.
-symbols=file Read the symbol table from the file file.
-tty=device Run using device for your program’s standard input and output.
-version Print version information and then exit.
-w Use a window interface.
-write Set writing into executable and core files.
-xdb XDB compatibility mode.
Description:
Invoke the GNU Debugger by running gdb. Once started, gdb reads commands from
the terminal until you tell it to exit.
If you start gdb from the command line on a self-hosted QNX Neutrino system, gdb
sets the LD_BIND_NOW to 1 to force all binding to be done immediately instead of
lazily. For more information, see “Optimizing the runtime linker” in the Compiling
and Debugging chapter of the QNX Neutrino Programmer’s Guide.
You can abbreviate a gdb command to the first few letters of the command name, if
that abbreviation is unambiguous; and you can repeat certain gdb commands by
typing just Enter. You can also use the Tab key to get gdb to fill out the rest of a word
in a command (or to show you the alternatives available, if there’s more than one
possibility).

© 2010, QNX Software Systems GmbH & Co. KG. gdb
You can also run gdb with a variety of arguments and options, to specify more of your
debugging environment at the outset.
Unless you specify the -nx option, this utility runs commands in an initialization file
before running any command-line options. This file may be specific to the gdb_variant
invoked, for instance, if you invoke ntoppc-gdb, the utility runs the commands in the
${HOME}/.ntoppc-gdbinit file. If no such gdb_variant initialization file exists,
the utility runs commands found in the generic ${HOME}/.gdbinit file instead. If
you specify -command, file overrides these default files.
The command-line options described here are designed to cover a variety of situations;
in some environments, some of these options might not work.
You can start with both an executable program and a core file specified:
gdb program core
GNU
See also:
Using GDB in the QNX Neutrino Programmer’s Guide

getconf © 2010, QNX Software Systems GmbH & Co. KG.
Get system configuration values (POSIX)
Syntax:
getconf system_var
getconf path_var pathname
Runs on:
Neutrino
Options:
None.
Description:
This utility gets system configuration values, including:
• configuration strings, whose names start with _CS_
• configurable system limits, whose names start with _SC_
• configurable limits associated with a path, whose names start with _PC_
The names of these variables are in uppercase, but getconf and setconf let you use
any case, omit the leading underscore, or the entire prefix — provided that the rest of
the name is unambiguous.
The first form writes to standard output the value of the specified system variable. The
possible values of system_var are those for sysconf() and confstr() (see the Library
Reference):
_CS_ARCHITECTURE
The name of the instruction set architecture for this node’s
CPU(s).
_CS_DOMAIN The domain name.
_CS_HOSTNAME The name of this node in the network.
A hostname can consist only of letters, numbers, and hyphens, and must not start or
end with a hyphen. For more information, see RFC 952.
_CS_HW_PROVIDER
The name of the hardware manufacturer.
_CS_HW_SERIAL Serial number associated with the hardware.
_CS_LIBPATH A value similar to the LD_LIBRARY_PATH environment

variable that finds all standard libraries.

© 2010, QNX Software Systems GmbH & Co. KG. getconf
_CS_LOCALE The name of the current locale.
_CS_MACHINE This node’s hardware type.
_CS_PATH A value similar to the PATH environment variable that finds

all standard utilities.
_CS_RELEASE The current OS release level.
_CS_RESOLVE The contents of the resolv.conf file, excluding the domain

name.
_CS_SRPC_DOMAIN
The secure RPC domain.
_CS_SYSNAME The name of the operating system.
_CS_TIMEZONE Time zone string (TZ style)
_CS_VERSION The current OS version number.
_SC_AIO_PRIO_DELTA_MAX
The maximum amount by which a process can decrease its
asynchronous I/O priority level from its own scheduling
priority.
_SC_ARG_MAX Maximum length of arguments for the exec*() functions, in

bytes, including environment data.
_SC_CHILD_MAX Maximum number of simultaneous processes per real user ID.
_SC_CLK_TCK The number of intervals per second used to express the value in
type clock_t.
_SC_DELAYTIMER_MAX
The maximum number of times a timer can overrun and you
can still detect it.
_SC_GETGR_R_SIZE_MAX
If defined (not -1), the maximum size of buffer that you need to
supply to getgrgid_r() for any memory that it needs to allocate.
_SC_GETPW_R_SIZE_MAX
If defined (not -1), the maximum size of buffer that you need to
supply to getpwent_r(), getpwuid_r(), getspent_r(), or
getspnam_r() for any memory that they need to allocate.
_SC_JOB_CONTROL
If this variable is defined, then job control is supported.

_SC_NGROUPS_MAX
The maximum number of simultaneous supplementary group
IDs per process.
_SC_OPEN_MAX Maximum number of files that one process can have open at
any given time.
_SC_PAGESIZE The default size of a thread’s guard area.
_SC_SAVED_IDS If this variable is defined, then each process has a saved
set-user ID and a saved set-group ID.
_SC_SEM_NSEMS_MAX
The maximum number of semaphores that one process can
have open at a time. The getconf utility reports a value of -1
to indicate that this limit is indeterminate because it applies to
both named and unnamed semaphores. The kernel allows an
arbitrary number of unnamed semaphores (they’re kernel
synchronization objects, so the number of them is limited only
by the amount of available kernel memory).
_SC_SIGQUEUE_MAX
The maximum number of outstanding realtime signals sent per
process.
_SC_THREAD_STACK_MIN
The minimum stack size for a thread.
_SC_TZNAME_MAX
The maximum length of the names for time zones.
_SC_VERSION The current POSIX version that is currently supported. A value
of 198808L indicates the August (08) 1988 standard, as
approved by the IEEE Standards Board.
The second form writes to standard output the value of the specified path variable for
the given path. The possible values of path_var are those for pathconf() (see the
Library Reference):
_PC_ASYNC_IO Defined if asynchronous I/O is supported for the file.
_PC_CHOWN_RESTRICTED
If defined (not -1), indicates that the use of the chown function
is restricted to a process with root privileges, and to changing
the group ID of a file to the effective group ID of the process or
to one of its supplementary group IDs.
_PC_LINK_DIR Defined (not -1) if the filesystem permits the unlinking of a
directory.

© 2010, QNX Software Systems GmbH & Co. KG. getconf
_PC_LINK_MAX Maximum value of a file’s link count.
_PC_MAX_CANON Maximum number of bytes in a terminal’s canonical input

buffer (edit buffer).
_PC_MAX_INPUT Maximum number of bytes in a terminal’s raw input buffer.
_PC_NAME_MAX Maximum number of bytes in a file name (not including the

terminating null).
_PC_NO_TRUNC If defined (not -1), indicates that the use of pathname

components longer than the value given by _PC_NAME_MAX
will generate an error.
_PC_PATH_MAX Maximum number of bytes in a pathname (not including the

terminating null).
_PC_PIPE_BUF Maximum number of bytes that can be written atomically when

writing to a pipe.
_PC_PRIO_IO Defined (not -1) if prioritized I/O is supported for the file.
_PC_SYNC_IO Defined (not -1) if synchronous I/O is supported for the file.
_PC_VDISABLE If defined (not -1), this is the character value which can be used
to individually disable special control characters in the
termios control structure.
Examples:
$ getconf _CS_PATH
/bin
$ getconf _SC_ARG_MAX
61440
$ getconf _PC_LINK_MAX /bin
65535
LANG The locale to use for the locale categories.
Exit status:

See also:
setconf
confstr(), pathconf(), sysconf() in the Library Reference
“Configuration strings” in the Configuring Your Environment chapter of the Neutrino
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. getty
Set terminal modes for system access (NetBSD)
Syntax:
getty
Runs on:
QNX Neutrino
Options:
None.
Description:
The getty utility sets the terminal mode.
Files:
/etc/config/gettytab, /etc/config/gettytab.${HOSTNAME}
Terminal configuration database.
See also:
tinit

gf-calib © 2010, QNX Software Systems GmbH & Co. KG.
Advanced Graphics utility for calibrating a touchscreen
Syntax:
gf-calib [options]
Runs on:
Neutrino
Options:
-3 Use the 3-point calibration method. This is the default method.
-4 Use the 4-point calibration method.
-c Overwrite the calibration configuration file if it exists. The

default location is
/etc/system/config/calib.$(hostname).
-d device Use the specified GF device.
-D Don’t display the pointer cursor when running.
-f file The name and location of a configuration file to create instead of

the default at /etc/system/config/calib.$(hostname).
-g input_group Specify the GFI input group to attach to. The input group is
created and enumerated by a devi-* driver configured to export
input groups. The default input group is 1.
-i idx The display index. The default is 0.
-l idx (“el”) The layer index. The default is the main layer.
-m x y Set the touch screen matrix size. This is currently unused.
-o n Target offset in pixels. Used by the 4-point method only.
-O Set the touch matrix’s origin to the lower right corner. Used by
the 3-point method only.
-s n The number of repeat samples before accepting a touch input.

The default is 10.
-t n Set the new bullseye target size, in pixels. The default is 47;
suggested values are between 30 and 100.
-v Be verbose.

© 2010, QNX Software Systems GmbH & Co. KG. gf-calib
Description:
The gf-calib utility is used to calibrate a touchscreen on a GF-embedded device.
Once the touchscreen is successfully configured it must be calibrated. The calib
utility saves a configuration file at /etc/system/config/calib.$(hostname).
You can use the -f option to specify a different configuration file. For information
about this file format, see the “Calibration file format” section of the “Writing an Input
Device Driver” chapter of the Input DDK documentation.
To invoke the calibration screen:
1 Start io-display with the appropriate graphics driver.
2 Start devi-* with the appropriate command-line options for the touchscreen
device.
3 Run gf-calib.
4 Follow the on-screen instructions to complete the calibration.
See also:
calib

gns © 2010, QNX Software Systems GmbH & Co. KG.
Advertise, look up, and use (connect to) a service across a network
Syntax:
gns [-cv] [nodename ...]
gns [-sv] [nodename]
Runs on:
Neutrino
Options:
-c Run in client mode. This is the default.
-s Run in server mode.
-v Be verbose.
nodename A node running a GNS server.
Description:
The global name service (gns) manager is a standalone resource manager. With the
help of gns, an application could advertise, look up, and use (connect to) a service
across network, without knowing the detail of where the service is, or who is the
provider.
GNS runs in two different modes: server and client. A server-mode manager is a
central database that stores advertised services, and handles lookup and connect
requests. A client-mode manager relays advertise, lookup, and connect requests
between a local application and the gns server.
APIs and advertising rules

There are several functions in the Library Reference that you can use: name_attach()
to advertise, name_open() to connect to, name_close() to disconnect from a certain
service, and name_detach() to remove a name from the namespace.
An application advertises (attaches) a service (i.e. represented by a path name) either
locally or globally. If an application attaches a service locally, then applications from
another machine can’t look up this service through the gns utility. If an application
attaches its services globally, then any machine that’s on the network and is running
the gns manager can access the services.
An application can attach a service locally, but only if there isn’t another application
that’s attached locally to the same service. There’s no credential restriction for
applications that are attached as local services.
An application can attach a service globally only if the application has root
privileges.

© 2010, QNX Software Systems GmbH & Co. KG. gns
Even though attaching globally is network-wide, an application on another machine

could still attach globally with the same service name. This allows service
redundancy, since the same service is available from multiple hosts on the network.
Although we have used the name_* API for the implementation of GNS, there is
slight behavior change with respect to the previous implementation of the Neutrino
realtime operating system.
Before, when an application called name_open() to connect to a service, the server
was not aware of that. This has been changed now —an _IO_CONNECT/_IO_OPEN
message is sent to the server.
The server application has to be modified to handle a possible _IO_CONNECT
message coming in. For an example, see the documentation for name_attach() in the
Path namespace
A service is represented by a path namespace (without a leading “/”) and is registered
under /dev/name/global or /dev/name/local, depending on how it attaches
itself.
Every machine running a gns client or server on the same network has the same view
of the /dev/name/global namespace. Each machine also has a /dev/name/local
namespace that’s local to each machine, and therefore, is different.
For details, see the Examples section.
Connection rules for GNS

Applications that wish to connect to a global name service can use the name_open()
API. If the same service is registered by multiple hosts, the rules that determine which
specific instance of the service you connect to are:
• If a service provider exists in the same machine as the application that requested
the service, the gns manager tries to connect to the local service provider first. If
the connection succeeds, the application communicates with its service provider
locally, to gain better performance.
• If there’s no local service provider, or, for some reason, the local service provider
refuses to provide the service, the gns manager tries to connect to other providers.
If there are multiple remote service providers, the order of trying them (i.e. who
gets the connection first) isn’t defined.
Multiple GNS servers

It’s possible to start multiple global name service managers in server mode on
different machines.

Multiple service domains
You can set some clients to connect to server1, and some clients to server2. This
creates separate “service domains,” where clients connected to server1 (in “service
domain1”) can’t use services registered on server2 (in “service domain2”).
On some clients:
# gns -c server1
On others:
# gns -c server2
Redundant GNS servers
Since the GNS server is a central database, the loss of redundant GNS servers could
mean the interruption of service (advertise, lookup, use) across the network. To solve
this problem, you can start multiple GNS servers and point clients to all of them.
On server1:
# gns -s
On server2:
# gns -s
On all clients:
# gns -c server1 server2
In this case, every time an application tries to register a global service, the registration
is sent to both server1 and server2. Every time an application tries to connect to a
global service, the request is attempted on both server1 and server2.
The GNS on server1 doesn’t communicate with the GNS on server2. This means
that if an application on server1 wants to register a global service on client nodes,
the gns process on server1 can’t forward the request to server2, because a gns
process can’t act as a client and server at the same time. This however, doesn’t affect
the applications that try to connect to that service because both servers are attempted.
Auto-scanning client
Each GNS manager is registered under /dev/name/gns_server or
/dev/name/gns_client. If you start a GNS client without specifically assigning a
target server, it performs an auto-scan to find the GNS server(s) on the local network.
On a client:
# gns -c

An auto-scan is performed by going through the local network directory (usually

/net), and trying to see if any machine has a pathname of
/net/machine/proc/mount/dev/name/gns_server.
An auto-scan isn’t guaranteed to find a server. This is because the Qnet network isn’t
guaranteed to have all local machines under /net.
The benefit of an auto-scan client lies in the event of losing the connection to a server.
The client will rescan to find another server when this happens. This makes it easy to
start another GNS server, synchronize it with the first one (we’ll discuss synchronizing
later), and then kill the first GNS server.
If a client starts specifying specific GNS server(s) on the command line, it won’t
perform an auto-scan. If it loses the connection to its server, it tries to reestablish the
connection every time a registration, lookup, or connect request is made.
Backup server mode

A GNS manager can be started in a “backup server” mode. Simply start a GNS
manager in server mode, and pass a specific server machine on the command line.
On node1, start a normal server:
# gns -s
and, on node2, start a backup server:
# gns -s node1
The GNS manager on node2 synchronizes with the GNS manager on node1, gets all
the global service information from node1, and stores it locally.
All GNS clients that are already connected to the GNS server on node1 are notified
about the new server on node2, and they connect to it. These clients then have
multiple servers, as if they had been started as follows:
# gns -c node1 node2
GNS and tightly coupled network

For a tightly coupled network, you may start the GNS manager in server mode only.
All client nodes could prefix the server’s name space, instead of running a GNS
manager in client mode locally.
On a server:
# gns -s
On other clients:
# ln -sP /net/gsrv/dev/name/global /dev/name/global

When a service provider registers its global service name from a client node (not
running gns -c), the information is directly sent to the GNS manager on server.
Subsequently, if a service consumer tries to look up the service name, the lookup
message is sent to the GNS manager on server, which then returns the service provider
information.
If a service provider registers a local service name, it simply registers itself in the local
path manager. The local path manager serves a service consumer when it starts to look
up the local service.
You must take note of the differences of running the GNS manager in client mode
rather than using the prefixes described above. A client-mode GNS manager running
locally may cache some service provider information, such that every lookup does not
need to go to the GNS manager on the server. This ensures that a lookup usually
succeeds even if there is a period of lost connection with the GNS manager.
Also, if the path namespace is prefixed, the client can’t look at the /dev/name/net
directory to tell which node provides which services. This information is, however, not
important in normal advertise/lookup operations.
Special pathname
All GNS managers are registered as /dev/name/gns_server or
/dev/name/gns_client. This pathname can provide some statistical information
about the GNS manager. For example:
$ cat /dev/name/gns_client
Global Name Service Mode: Client
Server: xtang (connected)
Registered services:
net/netsrv.ott.qnx.com/0,1818649,1,0,-1 (No Expiration)
network/tcpip/51,20533309,1,0,12 (Fri Feb 7 13:57:39 2003)
printer/ps/techpub/0,1826845,1,0,12 (No Expiration)
From the above, we infer that the gns process is a client, it has only one server (the
machine named xtang), and it’s already connected to the server. This also lists all the
services known to the GNS manager. Note that the network/tcpip service has an
expiration time, suggesting that this is a cached entry resulting from querying the gns
server.
Examples:
A typical network with gns looks like this:
Server node:
# gns -s
Client(s) node:
# gns -c server1 server2
Here’s an example after a service called printer/ps/techpub has attached itself

globally:

$ ls -l /dev/name/global/
total 2
dr-xr-xr-x 0 root techies 1 Feb 06 16:20 net
dr-xr-xr-x 0 root techies 1 Feb 06 16:21 printer
$ ls -l /dev/name/global/printer/ps
total 1
dr-xr-xr-x 0 root techies 1 Feb 06 16:21 techpub
Notice how /dev/name/global/printer/ps/techpub is registered. The path

/dev/name/global/net is reserved by the gns manager (therefore, an application
can’t attach a service started as net/). The machines under
/dev/name/global/net represent machines that run the GNS manager. For
example, the following listing shows that there are two machines running the GNS
manager:
$ ls -l /dev/name/global/net total 2
dr-xr-xr-x 0 root techies 1 Feb 06 18:32 netsrv.ott.qnx.com
dr-xr-xr-x 0 root techies 2 Feb 06 16:20 xtang.ott.qnx.com
Multiple application servers on different machines can attach to the same service.
Therefore one pathname could represent multiple servers. In order to show that, the
GNS manager automatically creates a name in the format nd pid chid handle file_type
under the registered pathname, as follows:
$ ls /dev/name/global/printer/ps/techpub
0,16834613,1,0,12
8,1826845,1,0,12
From the above, you conclude that there are two applications attached to the
printer/ps/techpub service.
Sometimes, you may wish determine what service machine netsrv.ott.qnx.com
provides. To find that out, you can look into
/dev/name/global/net/netsrv.ott.qnx.com — it shows the services attached
by a process on netsrv.ott.qnx.com:
$ ls /dev/name/global/net/netsrv.ott.qnx.com/printer/ps/techpub
0,1826845,1,0,12
To know exactly which machine registered a service, try this:

$ ls -l /dev/name/global/printer/ps/techpub
total 0
lr-xr-xr-x 0 root techies 0 Feb 06 16:48
0,16834613,1,0,12 ->
../../../net/xtang.ott.qnx.com/printer/ps/techpub/0,16834613,1,0,12
lr-xr-xr-x 0 root root 0 Feb 06 16:28 8,1826845,1,0,12
->
../../../net/netsrv.ott.qnx.com/printer/ps/techpub/0,1826845,1,0,12
From the above, you conclude that a process on machine xtang.ott.qnx.com with
process ID 16834613 has registered the printer/ps/techpubservice; meanwhile,
process 1826845 on machine netsrv.ott.qnx.com also registered the same
service.

See also:
name_attach(), name_close(), name_open(), name_detach() in the Library Reference.
“Locating services using GNS” in the Transparent Distributed Processing Using Qnet
chapter of the Programmer’s Guide.

© 2010, QNX Software Systems GmbH & Co. KG. gprof
Code profiler (GNU)
Syntax:
gprof_variant options [executable [data-files...]] [> outfile]
Runs on:
Options:
The gprof_variant depends on the target platform, as follows:
Target platform: gprof_variant:

ARM ntoarm-gprof
MIPS ntomips-gprof
PowerPC ntoppc-gprof
SH4 ntosh-gprof
x86 ntox86-gprof
Description:
The gprof utility produces code-profiling data for an application compiled with the
-p option to qcc (or the -pg option to gcc). This data is interpreted visually for you
by the Application Profiler perspective in the QNX Momentics IDE.
For detailed documentation about gprof, see the the GNU website at
Exit status:
0 Success.
not 0 An error occurred.
GNU
See also:
gcc, qcc

grep © 2010, QNX Software Systems GmbH & Co. KG.
Search for string patterns (POSIX)
Syntax:
grep [-E|-F] [-chilnqsvx]
[file...]
grep [-E|-F] [-chilnqsvx] expression [file...]
Historical UNIX versions:
egrep [-cilnqsvx]
[file...]
egrep [-cilnqsvx] expression [file...]
fgrep [-cilnqsvx]
[file...]
fgrep [-cilnqsvx] expression [file...]
Runs on:
Options:
-c Write only a count of selected lines to standard output.
-E Use extended regular expression (ERE) syntax.
-e expression A regular expression, of type determined by the -E, -F options.

You can use more than one -e option when you need to specify
more than one expression.
-F Treat expression as a fixed string instead of a regular

expression. (Search for a fixed string or fixed strings.)
-f expression_file File containing a set of regular expressions, each separated by a

newline. The type of the expressions is determined by the -E
and -F options. This form is used when more than one
expression needs to be specified. You can specify more than
one -f option.
-h (QNX Neutrino extension to grep only) Don’t prefix matched

lines with a filename. This option applies only when you
invoke grep with more than one file to search.
-i Ignore uppercase and lowercase distinctions during

comparisons.
-l (“el”) Write only the names of files containing selected lines to

standard output.

© 2010, QNX Software Systems GmbH & Co. KG. grep
-n Before each output line, display the line’s line number in the
file.
-q Be quiet; don’t write anything to the standard output,

regardless of matching lines.
-s Suppress the error messages ordinarily written for nonexistent

or unreadable files. Other error messages aren’t suppressed.
-v Select only those lines that don’t match the specified patterns.
-x Consider as matching lines only input lines selected against an

entire fixed string or regular expression.
expression A regular expression, whose type is determined by the -E and

-F options. This form is used when only one expression is
specified on the command line. Any names specified after this
option are treated as input files.
file The text file to be input. The default is standard input.
Description:
The grep utility searches input for lines matching the expression(s) given. When an
input line matches any of the expressions, it is said to be “selected.” By default,
selected lines are written to standard output.
Numerous options allow variations upon the output format. For example, to reverse
the meaning of the output, the -v option could be used.
There are three types of regular expressions understood by grep: basic, extended, and
fixed. If you don’t specify -E or -F, the expression(s) are taken to be basic regular
expressions.
Basic and extended regular expressions are similar to arithmetic expressions in that
larger expressions are formed by combining smaller expressions and operators
according to some precedence rule.
Regular expressions have an “invisible” operator, i.e. concatenation. The
concatenation of two expressions means match the one on the left, then the one on the
right.
The smallest expression is a single character.
Basic regular expressions

The following table summarizes the Basic Regular Expressions (BRE), and the
precedence of the operators:

Expression Meaning
$ expression $ Subexpression. Match the pattern expression. Used
for back references (see below), and precedence
\N Back-reference. Match the exact string that the Nth
subexpression did
. (Dot) match any single character
[charset] Match any member of the set charset (see below)
c Match any nonspecial character
\c Match literal c. The character may not be (, ), {,
}, or any digit from 1 through 9. The \ is usually
used to escape *, $, ˆ, ., [ and ]. \\ matches a
literal “\”. \ has no special meaning inside a
bracket expression.
limited_expression* Match any number of repetitions of
limited_expression including zero.
limited_expression\{M \} Match exactly M repetitions of limited_expression
limited_expression\{,N \} Match zero to N repetitions of limited_expression
limited_expression\{M ,N \} Match M to N repetitions of limited_expression
expr0expr1 (Concatenation) match expr0 then expr1
êxpression Match expression only at beginning of line
expression$ Match expression only at end of line
A limited_expression is restricted to a a back-reference, a subexpression, or a BRE

matching a single character.
A charset is formed by concatenation of the following operators:
Expression Meaning
c Any character c
c-d Any character in the range from c to d
[:alpha:] Any alphabetic character
[:upper:] Any uppercase character
[:lower:] Any lowercase character
[:digit:] Any numeric character
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. grep
Expression Meaning
[:alnum:] Any numeric or alphabetic character
[:xdigit:] Any character used to represent a hexadecimal number
[:space:] Any character that is a whitespace
[:print:] Any printable character
[:punct:] Any character that is punctuation
[:graph:] Any character with a graphic representation
[:cntrl:] Any character used for control
If the charset begins with the caret (ˆ), the set is inverted. For example:
[ˆ[:alpha:]]
means match any nonalphabetic character. (This can also be expressed by

[â-zA-Z].)
Extended Regular Expressions

The Extended Regular Expressions (ERE) are an enriched set of regular expression
operators. In particular, the Extended Regular Expressions support an operator for
alternation, thus allowing a match of one expression or another. It is also important to
note that the parenthesis syntax is different from Basic Regular Expressions, and the
semantics are subtly different. There are no back-references in Extended Regular
Expressions.
The following list summarizes the Extended Regular Expressions:
Expression Meaning
(expression) Match expression; useful for altering precedence
. (Dot) match any single character
c Match any nonspecial character c
\c Match literal c. Normally used to escape ERE
special characters.
[charset] Match any element of charset
limited_expression* Match any number of repetitions of
limited_expression, including zero
limited_expression+ Match 1 to any number of repetitions of
limited_expression
continued. . .

Expression Meaning
limited_expression? limited_expression is optional (match 0 or 1
repetition)
limited_expression\{M \} Match exactly M repetitions of limited_expression
limited_expression\{,N \} Match zero to N repetitions of limited_expression
limited_expression\{M ,N \} Match M to N repetitions of limited_expression
expr0expr1 (Concatenation) match expr0 then expr1
expr0|expr1 (Alternation) match expr0 or expr1 (not both)
êxpression Match expression only at the beginning of a line
expression$ Match expression only at the end of a line
For extended regular expressions, a limited_expression is restricted to an expression

matching a single character or an expression enclosed in parentheses.
Fixed Regular Expressions

Fixed Regular Expressions consist of a set of strings of characters. They don’t permit
the operators of extended or basic regular expressions. The algorithm used is
extremely efficient for locating one of a set of strings within another string. Thus, if
you don’t need the various operators of basic or extended regular expressions, the
fixed expressions are a better choice.
Examples:
Display lines in Phone.List containing telephone numbers:
grep ’[[:digit:]]\{3\}-[[:digit:]]\{4\}’ Phone.List
Display all occurrences of the words “steve” and “barney” in the Phone.List file:
grep -F -e steve -e barney Phone.List
Exit status:
See also:
flex, gawk, sed

© 2010, QNX Software Systems GmbH & Co. KG. gunzip
Uncompress files (UNIX)
Syntax:
gunzip [-cfhLlNnqrtvV] [name...]
Runs on:
Options:
See gzip for a complete listing.
Description:
The gunzip utility uncompresses files that have been compressed with gzip. It’s
equivalent to gzip -d. See gzip for more details.
GNU
See also:
freeze, gzip, pax

gzip © 2010, QNX Software Systems GmbH & Co. KG.
Compress or expand files (UNIX)
Syntax:
Compress/uncompress files:
gzip [-cdfhLlNnqrtVv19] [-S suffix] [name...]

Uncompress only:
gunzip [-cfhLlNnqrtvV] [name...]

Cat compressed file:
zcat [-hLV] [name...]
Runs on:
Options:
-c Write output on standard output; keep original files unchanged. If there
are several input files, the output consists of a sequence of independently
compressed members. To obtain better compression, concatenate all
input files before compressing them.
-d Decompress.
-f Force compression or decompression even if the file has multiple links or

the corresponding file already exists. If -f isn’t given, and when not
running in the background, gzip prompts to verify whether an existing
file should be overwritten.
You need to use the -f option when compressing or expanding files in a RAM
(/dev/shmem) filesystem.
-L Display the gzip license.
-l List compressed file contents.
-N Save or restore the original name and timestamp.
-n Don’t save or restore the original name and timestamp.
-q Suppress all warnings.
-r Travel the directory structure recursively. If any of the file names

specified on the command line are directories, gzip descends into the
directory and compresses all the files it finds there (or decompresses
them in the case of gunzip).

© 2010, QNX Software Systems GmbH & Co. KG. gzip
-S suffix Use the given suffix on compressed files.

-t Test. Check the compressed file integrity.
-V Version. Display the version number and compilation options.
-v Verbose. Display the name and percentage reduction for each file
compressed.
-1
-9 Regulate the speed of compression, where -1 (the number one) indicates
the fastest compression method (less compression) and -9 indicates the
slowest compression method (optimal compression).
Description:
The gzip utility reduces the size of the named files, using Lempel-Ziv coding (LZ77).
Whenever possible, each file is replaced by one with the extension .gz, while keeping
the same ownership modes, access and modification times. (The extension is -z for
VMS, z for MSDOS, OS/2 and Atari.) If no files are specified, the standard input is
compressed to the standard output. If the new file name is too long, gzip truncates it
and keeps the original file name in the compressed file. The gzip utility attempts to
compress only regular files. In particular, it ignores symbolic links.
You can use gzip -d, gunzip, or zcat to restore compressed files to their original
form.
These utilities are subject to the GNU Public License (GPL). We’ve included them for
use on development systems.
The gunzip utility takes a list of files on its command line and replaces each file
whose name ends with .gz or .GZ or -z and which begins with the correct magic
number with an uncompressed file without the original extension. This utility also
recognizes the special extensions .tgz and .taz as shorthands for .tar.gz or
.tar.GZ.
The gunzip utility can currently decompress files created by gzip, zip, compress
or pack. The detection of the input format is automatic. When using the first two
formats, gunzip checks a 32-bit CRC. For pack, gunzip checks the uncompressed
length. The compress format wasn’t designed to allow consistency checks. However
gunzip is sometimes able to detect a bad .GZ file. If you get an error when
uncompressing a .GZ file, don’t assume that the .GZ file is correct just because the
standard uncompress doesn’t complain. This generally means that the standard
uncompress doesn’t check its input, and happily generates garbage output.
You can use gzip to uncompress files created by zip only if they have a single
member compressed with the “deflation” method. This feature is intended only to help
conversion of tar.zip files to the tar.gz format. To extract zip files with several
members, obtain and use unzip instead of gunzip. (Note that unzip isn’t shipped as
part of QNX Neutrino.)

gzip © 2010, QNX Software Systems GmbH & Co. KG.
The zcat utility is identical to gunzip -c. (On some systems, zcat may be
installed as gzcat to preserve the original link to compress.) The zcat utility
uncompresses either a list of files on the command line or its standard input and writes
the uncompressed data on standard output. It uncompresses files that have the correct
magic number whether they have a .gz suffix or not.
The gzip utility uses the Lempel-Ziv algorithm used in zip and PKZIP. The amount
of compression obtained depends on the size of the input and the distribution of
common substrings. Typically, text such as source code or English is reduced by
60-70%. Compression is generally much better than that achieved by LZW (as used in
compress), Huffman coding (as used in pack), or adaptive Huffman coding
(compact).
Compression is always performed, even if the compressed file is slightly larger than
the original. The worst case expansion is a few bytes for the gzip file header, plus 5
bytes every 32K block, or an expansion ratio of 0.015% for large files. The gzip
utility preserves the mode, ownership and timestamps of files when compressing or
decompressing.
You can concatenate multiple compressed files. In this case, gunzip extracts all
members at once. For example:
gzip -c file1 > foo.gz

gzip -c file2 >> foo.gz
Then:
gunzip -c foo
is equivalent to:
cat file1 file2

In case of damage to one member of a .gz file, other members can still be recovered
(if the damaged member is removed). However, you can get better compression by
compressing all members at once:
cat file1 file2 | gzip > foo.gz

compresses better than:
gzip -c file1 file2 > foo.gz

If you want to recompress concatenated files to get better compression, do:
zcat old.gz | gzip > new.gz
GZIP A set of default options for gzip. These options are interpreted first and
can be overwritten by explicit command line parameters. For example:
export GZIP="-8 -v"

© 2010, QNX Software Systems GmbH & Co. KG. gzip
Exit status:
2 The operation succeeded but perhaps not 100%; a warning was generated in the
process.
1 An error occurred; the operation failed.
0 The operation succeeded.
GNU
Caveats:
The .gz extension is already also used by UNIX pack. You can link gzip to pcat to
get transparent decompression for programs expecting .gz files to be in pack format.
See also:
bzip2, freeze, pax, tar

ham © 2010, QNX Software Systems GmbH & Co. KG.
High-availability manager
You must be logged in as root to start a high-availability manager.
Syntax:
ham [options]
Runs on:
Neutrino
Options:
-? Display the usage message.
-d Disable internal verbosity.
-f file The log file (the default is standard error).
-h Display the usage message.
-t none | relative | absolute | shortabs

The timestamping method to use. The default is relative.
-V level Set the level of verbosity.
-v Be verbose; extra -v options increase the verbosity.
Description:
The ham utility is the high-availability manager, which you can use to monitor and
restart critical processes in your system. When a HAM starts, it also starts the
Guardian process for itself.
To stop the HAM, you must use either the ham_stop() function (see the High
Availability Framework Developer’s Guide) or the hamctrl utility. These are the only
correct (and the only guaranteed) ways to stop the HAM.
See also:
hamctrl
High Availability Framework Developer’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. hamctrl
Control a high-availability manager
You must be logged in as root to use this utility.
Syntax:
hamctrl [options]
Runs on:
Neutrino
Options:
-node node_name
Control the high-availability manager (HAM) on the specifed node.
-stop Stop the HAM.
+|-verbose Increase or decrease the HAM’s verbosity.
=verbose Get the HAM’s current verbosity.
Description:
You can use the hamctrl utility to control or stop a high-availability manager, ham.
See also:
ham
High Availability Framework Developer’s Guide

hd © 2010, QNX Software Systems GmbH & Co. KG.
Display files in decimal, hex, octal, or ASCII (UNIX)
Syntax:
hd [-8] [-A format] [-n count] [-s skip]
[-t format[fmt_string]] [-v] [file...]
Runs on:
Options:
-8 Use 8-bit ASCII characters (default 7).
-A format Display the file offset field in the specified format. Valid formats are:
• d — decimal, 9 digits
• n — none (omit this field)
• o — octal, 10 digits
• x — hexadecimal, 7 digits.
-n count Display only count bytes of input. You can add a trailing character to
specify units of blocks (b), kilobytes (k), or megabytes (m).
-s skip Ignore the first skip bytes of data. You can add a trailing character to
-t format[fmt_string]
Use this output/display format; see “Output formats,” below.
The default format is x1.
-v Be verbose. If you don’t specify the -v option, hd folds multiple

identical lines into a single line that contains an asterisk (*).
file The pathname of an input file. If you don’t specify any files, hd reads
from standard input. If a file is a hyphen (-), hd reads from the standard
input at that point in the sequence.
Description:
The hd utility displays data in decimal, hex, octal, or ASCII. The name “hd” (hex
dump) is derived from the default output format.
The hd utility processes input in 16-byte units that are formatted into a line. In the
default output format:
• the file offset field is displayed in hex, 7 digits
• a space separates the file offset field from the data

© 2010, QNX Software Systems GmbH & Co. KG. hd
• the data is displayed as 16 space-separated bytes in hex

• the same data is also displayed in ASCII, if printable; unprintable data appears as
dots.
For example:
$ echo "abcdefghijklmnopqrstuvwxyz01234" | hd
0000000: 61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70 abcdefghijklmnop
0000010: 71 72 73 74 75 76 77 78 79 7a 30 31 32 33 34 0a qrstuvwxyz01234.
To exclude part of the input, use the -n and -s options. You can specify the arguments
to these options in hex (using a 0x prefix) or octal (using a 0 prefix). The default units
for these options are bytes, but you can specify different units as follows:
To specify: Add this suffix:

Blocks (512 bytes) b
Kilobytes (1024 bytes) k
Megabytes (1048576 bytes) m
Output formats
To specify the output format, use the -t option. The format argument — which you
can specify in decimal, hex, or octal — tells hd which format to use for presenting the
output:
a Named characters. Display printable characters as themselves,

and nonprintable characters as a single dot (.).
c Characters. Display printable characters as themselves; display all

other characters as 2-digit hex values, except for the following:
ASCII mnemonic Value Representation

NUL 00 \0
<alert> 07 \a
<backspace> 08 \b
<tab> 09 \t
<newline> 0a \n
<vertical tab> 0b \v
<formfeed> 0c \f
<carriage return> 0d \r

hd © 2010, QNX Software Systems GmbH & Co. KG.
d[1|2|4|C|S|I|L]
Decimal, in objects the size of an int by default.
f[4|8|F|D|L] Floating point, in objects the size of an float by default.
o[1|2|4|C|S|I|L]
Octal, in objects the size of an int by default.
u[1|2|4|C|S|I|L]
Unsigned decimal, in objects the size of an int by default.
x[1|2|4|C|S|I|L]
Hexadecimal, in objects the size of an int by default.
The input, processed in 16-byte units formatted into a line, is displayed according to
the size you choose:
To display input as: Choose:

Sixteen 1-byte objects 1
Eight 2-byte objects 2
Four 4-byte values per line 4
Two 8-byte values per line 8
char C
double D
float F
int I
long or long double (depending on the format) L
short S
Examples:
Display the second to eleventh sectors of the hard disk, /dev/hd0:
hd -s 1b -n 10b /dev/hd0
Exit status:

© 2010, QNX Software Systems GmbH & Co. KG. hd
See also:
od

head © 2010, QNX Software Systems GmbH & Co. KG.
Copy the first part of files (POSIX)
Syntax:
head [-l] [-number] [-c number] [-n number] [file]...
Runs on:
Neutrino
Options:
-number Deprecated; use -n number instead.
-c number The number of bytes to copy. The number argument is an unsigned

decimal integer.
-l (“el”) Measure the quantity of output in lines; this is the default unit of
measure.
-n number The number of lines to copy. The number argument is an unsigned

decimal integer.
file The pathname of an input file. If you don’t specify any files, the
The -c and -l options are QNX Neutrino extensions.
Description:
The head utility copies its input files to the standard output. The utility ends the
output for each file at a point designated by the -c or -n option. If you don’t specify
either of these options, head copies the first ten lines of the file.
If you specify multiple -c, -l, and -n options, the last one takes precedence.
If you specify multiple files, head prints an identifying header before the output for
each file.
Examples:
Display the first ten lines of all files in the current directory:
head *
Print the first 16 bytes of myfile in hex:
head -c 16 myfile | hd
(Note that in this case, the same functionality is offered through command-line options
to hd.)

© 2010, QNX Software Systems GmbH & Co. KG. head
Exit status:
See also:
cat, less, more, tail

helpviewer © 2010, QNX Software Systems GmbH & Co. KG.
Photon Helpviewer
Syntax:
helpviewer [-b color] [-f color] [-F start_page]
[-h height[%]] [-l color] [-m] [-o]
[-r topic.toc] [-S i|m|n] [-s server]
[-t topic_dir] [-u home_page]
[-w width[%]] [-x position[%][r]]
[-y position[%][r]] [url]
Runs on:
Neutrino
Options:
-b color Set background color to the hex RBG value.
-f color Set foreground (text) color to the hex RBG value.
-F start_page Force the start_page to be displayed on startup. This page must

be inside the topic root.

-l color Set link color to the hex RBG value.
-m Turn on caching (increase memory to speed up searching).
-o Keep the topics in the same order as the TOC file (default is to
sort the top two levels of topics).
-r topic.toc Display only the specified topics from the topic root. You can
specify more than one -r option.

normal).

fullpath fullpath
-t topic_dir Display the help file referred to by the topic directory.
-u home_page Set the home page. This is the page helpviewer displays when
you click the Home button, or select File→Home.

© 2010, QNX Software Systems GmbH & Co. KG. helpviewer



url Display the help file referred to by the URL.
Description:
The helpviewer application displays online help, with several navigational aids
including contents, text search, history, and bookmarks.
The helpviewer supports online help documents written in HTML. However, the
helpviewer can access only local files and therefore can’t be used as an Internet Web
browser. It also supports GIF, JPEG, and BMP image formats.
You can specify which HTML file to open using either URLs or topic paths:
• The URL specifies the filesystem path where the help text is located on the local
network. Here’s an example of a URL:
$QNX_TARGET/usr/help/product/neutrino/user_guide/examples.html
URLs are case-sensitive. These URLs are restricted in scope to the local help files;
they can’t be used to access the Web.
• A topic path comprises a number of concatenated topic titles, as defined in the

current table of contents. Here’s an example of a topic path:
/Photon microGUI/User’s Guide/Utilities/pdm
For convenience, the topic path is case-insensitive and may contain the wildcard
characters * or ?, where * matches a string and ? matches a character. The first
matching topic is selected for display.
The helpviewer loads the table of contents either from a single topic file (with a
.toc extension) or from a directory. By default the topic files are loaded from the
$QNX_TARGET/usr/help/product directory. The format of topic files is described
in “Creating topic files” below.

• If you aren’t using ksh or sh as your login shell, the environment variables that the
helpviewer uses aren’t initialized. To fix this, set QNX_HELP_HOME_PAGE
to
/usr/qnx650/target/qnx6/usr/help/product/momentics/bookset.html,
and QNX_HELP_PATH to
/usr/qnx650/target/qnx6/usr/help/product (assuming you installed
QNX SDP in the default location).
• The helpviewer might not display all the images in a document. If this happens,
click the Options button, click the Others tab, and then increase the size of the
image cache.
Creating help files:

The helpviewer supports help files written in HTML level 3.2 with some extensions.
You can create HTML help files using a text editor or special HTML editors or word
processors.
You should take care not to include features above HTML level 3.2 in your help files
(they might cause helpviewer to crash).
Supported elements
The following table shows the HTML elements and attributes supported by the
helpviewer:
Element Tags Attributes

Comment 
Document <html>...</html>
Head <head>...</head>
Title <title>...</title>
Link <link> href=url, rel=string
Body <body>...</body> id=string, bgcolor=hexvalue, link=hexvalue,
text=hexvalue
Heading 1 <h1>...</h1> id=string, align=left|center|right
continued. . .


Rule <hr>
Paragraph ...[] id=string
Linebreak id=string
Image <img> src=url, align=top|middle|bottom,
alt=string, id=string
Anchor <a>...</a> href=url, name=string, id=string
Preformatted <pre>...</pre> id=string
Blockquote <blockquote>...</blockquote> id=string
Address <address>...</address> id=string
Note <note>...</note> src=url, id=string
Definition list <dl>...</dl> compact, id=string
Term <dt>...[</dt>] id=string
Description <dd>...[</dd>] id=string
Ordered list <ol>...</ol> id=string
Unordered list <ul>...</ul> id=string
List item <li>...[</li>] id=string
Emphasis ...
Strong ...
Code <code>...</code>
Sample <samp>...</samp>
Keyboard <kbd>...</kbd>
Variable <var>...</var>
Definition <dfn>...</dfn>
Citation <cite>...</cite>
Teletype <tt>...</tt>
Bold ...
Italic ...
Underlined ...
continued. . .


Table <table>...</table> border, border=0,
align=left|center|right, id=string
Table heading <th>...[</th>] align=left|center|right, id=string
Table data <td>...[</td>] align=left|center|right, id=string
Table row <tr>...[</tr>] id=string
Supported entities
The Helpviewer also supports the standard HTML1/ISO entities for characters, plus:
Entity: Meaning: Rendered as:

Nonbreaking space Space
&emsp; Em-space Space
&ensp; En-space Space
— Em-dash Dash (-)
– En-dash Dash (-)
“ Left double quote Double quote (“)
” Right double quote Double quote (”)
‘ Left single quote ‘
’ Right single quote ’
™ Trademark TM
Creating topic files

The helpviewer uses a table of contents and directory hierarchy to organize the
online help. The table of contents is kept separate from the HTML files themselves
and is not part of the HTML definition.
Topic files must be created by hand based on your online help files. You can create
either a single topic file or a hierarchy of topic files in different directories.
Topic files must have a .toc extension. They are text files with one topic per line.
Each topic line has the following format:
level|title|HTML or TOC file
where:
level The heading level. A value of 1 represents a top-level heading,

which users can access directly from the Topics tree. Heading

levels 1 and 2 are sorted alphabetically in the Topics tree; levels

3 and lower appear in the order they occur in the TOC file.
title Text of the topic title (do not include any HTML — use plain
text only).
HTML or TOC file Either an HTML file/URL or a TOC file.
Don’t use the vertical bar (|) in topic titles, because it’s used as a delimiter in the TOC
files.
Usually there’s an entry in the topic file corresponding to each HTML heading level in
your help files. The topic title doesn’t have to be identical to the title in your help file.
Each topic can refer to an HTML file or a topic file. If the topic refers to an HTML
file, that file is displayed when the topic is selected. If the topic refers to a topic file,
helpviewer reads the subtopics from that file and displays them, but no HTML is
displayed.
If the HTML file is in a subdirectory of the parent topic, helpviewer scans the
directory for topic files (this happens up to topic level 4 only). You don’t have to
specify the topic file explicitly in this case.
You can increase the performance of the helpviewer by creating toc_index files in
directories that contain several TOC files. A toc_index simply lists the TOC files in
that directory, and is created by typing
ls *.toc > toc_index.
The helpviewer assumes that your help is maintained in a three-level directory
hierarchy. The levels and the types of files that should be kept at each level are listed
below.
Level 1
The top level help system directory.

This level contains a folder for each bookset in the help system, and a top level TOC
file for each bookset.
An example is /usr/help/product, which contains several booksets, including:
• a folder and top level TOC for the IDE help, ide_en and ide_en.toc.
• The TOC has a single level-1 entry pointing to the top level HTML file for the
bookset, com.qnx.doc.ide.userguide/topic/coverpage.html.
Level 2
The bookset level directory.

This level contains a folder and TOC file for each book in the bookset, and a top level
HTML file for the bookset.

An example is $QNX_TARGET/usr/help/product/ide_en, which contains:
• bookset.html—the base HTML page for the bookset
• user_guide—a directory for the User’s Guide book
• user_guide.toc—a TOC file with a single level-2 entry pointing to the top level
HTML file for the book, user_guide/about.html.
Level 3
The book level directory.

This level contains a TOC file and one or more topic HTML files. It may optionally
contain sub-directories to organize HTML files into chapters. The TOC file has level-3
and lower entries for every topic in the help for the book.
An example is $QNX_TARGET/usr/help/product/phindows_en/user_guide,
which contains:
• about.html—an HTML file that contains all the content for the book
• book.toc—a TOC file that contains all the help topic entries for the table of
contents.
Your help must use the same three-level hierarchy, even if there is only one book. The
helpviewer uses a combination of the topic level in the TOC file and the directory level
of the TOC file to nest topics in the contents pane.
An example
Here is an example of how .toc files can be nested. In the

$QNX_TARGET/usr/help/product directory the Photon help directory and
top-level TOC file are located:
photon_2.0_en.toc
photon_2.0_en/
The photon_2.0_en.toc file consists of the following line:
1|Photon microGUI for QNX Neutrino|./photon_2.0_en/bookset.html
The photon_2.0_en directory contains a TOC file and a directory for each book. For
example, for the Programmer’s Guide, the directory includes:
prog_guide.toc
prog_guide/
The prog_guide.toc file consists of the following line:
2|Programmer’s Guide|./prog_guide/about.html
The prog_guide directory contains the HTML files, and a book.toc file that
identifies the topic titles in the HTML files:

3|About This Guide|about.html#ABOUTTHISGUIDE

4|Assumptions|#id3
4|Changes and corrections|#ChangesAndCorrections
3|Introduction|intro.html#id1
4|Photon Application Builder - PhAB|#PhABApplications
6|Get immediate results|#id3
...
The part of the URL following the # is an anchor defined in the HTML.
If the .toc files contain non-ASCII characters, they must be in multibyte format to be
displayed correctly in the Contents pane.
The Photon ped editor allows the entry of UTF-8 characters. For more information,
see the ped man page.
Publishing your topic file
You can either include your table of contents in the default table of contents (along
with our online documentation) or keep it separate and specify where helpviewer
can find the table of contents.
Including your help in the default help
To include your help in the default table of contents, you must create a top-level topic
file and include it in the root help directory (/usr/help/product). The
helpviewer reads all topic files from the root directory and sorts the topics
alphabetically.
Keeping your help separate
Similarly, to start the helpviewer with your own table of contents and help files,
change the default help file directory using the -t option, like this:
helpviewer -t /home/user/mytopics
The helpviewer application displays your table of contents and home page only.
You won’t be able to access the default table of contents.
Searching
You can search the documentation by entering keywords in the Find field and then
pressing the Go! button. The following characters are considered to be separators:
,.:&()[]/\"#{};?-+=!\n space
Using the above characters, the helpviewer splits your input into keywords. It then
searches its database for each keyword and keeps only the results that include all the
keywords. If you haven’t checked Match Whole Words, the search is a partial match
search for each of the keywords. For example, “Toggle” will match “PtToggle”. Check
Case sensitive to match the case of the keywords.
You can use a space as an AND operator. For example, if you search for Photon
coordinate space in the document text, the helpviewer finds all the documents
that contain the words Photon, coordinate, and space. It doesn’t necessarily mean
that the listed documents include the full string Photon coordinate space.

Files:
$QNX_TARGET/usr/help/product
Default topic directory.
˜/.ph/phelp/options
Configuration file.
˜/.ph/phelp/bookmarks
Your bookmarks.
˜/.ph/phelp/history
A list of the documents you’ve viewed.
QNX_HELP_PATH
Sets the default help file directory. This has the same meaning as the -t
command line option.
QNX_HELP_HOME_PAGE
Set the default help home page. This has the same meaning as the -u command
line option.
These environment variables are set by default by the sh and ksh shells, and are
specified in /etc/profile.d/qnxsdk.sh. If you use a different shell (such as esh
or bsh), you need to explicitly set these environment variables or helpviewer will
not display the default QNX help.
See also:
“Getting help with the Helpviewer” in the Using the Photon microGUI chapter of the

© 2010, QNX Software Systems GmbH & Co. KG. hidview
Display information about human-interface devices
• You must be root to run this utility.
• You must start io-hid before you use the hidview utility.
Syntax:
hidview [-a] [-d devno] [-N name] [-r] [-R]
Runs on:
Neutrino
Options:
-a Display raw data coming from devices.
-d devno Display information about devno only.
-N name Name of the HID server to query. The default is

/dev/io-hid/io-hid.
-R Display informative report descriptor information.
-r Display raw report descriptor information.
Description:
The hidview utility displays information about human-interface devices (HID).
Examples:
Here’s a sample of output from a hidview command:
HIDD v1.00, v1.00 DDK
Device Address : 0
Vendor : 0x05c7 (QTRONIX)
Product : 0x2011 (USB Keyboard and Mouse)
Version : r1.00
Usage : Keyboard
Device Address : 1
Vendor : 0x05c7 (QTRONIX)
Product : 0x2011 (USB Keyboard and Mouse)
Version : r1.00
Usage : Mouse

hidview © 2010, QNX Software Systems GmbH & Co. KG.
See also:
devh-usb.so, devh-ps2ser.so, devh-*, io-hid

© 2010, QNX Software Systems GmbH & Co. KG. hogs
List the processes that are hogging the CPU
Syntax:
hogs [options] [pids ...]
Runs on:
Neutrino
Options:
-n Show the names of processes (hogs always displays the process IDs).
-p priority Run hogs at the given priority (default: the same as the parent
process).
-s sec Sleep this long between updates (default: 3 seconds).
-% num Show only processes that consume this percentage or more CPU. You
can use this option to reduce the amount of output.
Description:
The hogs utility displays a list of processes in descending order by percentage of CPU
usage (i.e. it shows who’s hogging the processor). It loops forever, sleeping between
updates.
The format of the output is tabular, and includes:
PID The ID of the process being reported.
NAME The name of the process (included only if you specify the -n option).
MSEC The number of milliseconds for which this process has been running
since the last iteration.
PIDS The amount of time that the process ran in this iteration, as a percentage
of the times of all the other processes running.
SYSTEM The amount of time that the process ran in this iteration, as a percentage
of the iteration time.

hogs © 2010, QNX Software Systems GmbH & Co. KG.
• The SYSTEM column is incorrect on multicore systems; the numbers in this column
will add up to (roughly) the number of processors times 100%. Use the top utility
instead.
• The numbers from hogs are approximate. For more precise data, use
tracelogger and the System Analysis Toolkit (see the SAT User’s Guide).
Examples:
Display the processes that are using 10% or more of the CPU. Include the name of the
processes:
$ hogs -n -% 10
PID NAME MSEC PIDS SYSTEM
1 2023 78% 67%
8200 devb-eide 384 14% 12%
1 2456 80% 81%

8200 devb-eide 357 11% 11%
1 2369 87% 78%
This sample includes three iterations.
See also:
pidin, ps, top, tracelogger
System Analysis Toolkit User’s Guide
Fine-Tuning Your System in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. host
DNS lookup utility
Syntax:
host [-aCdlnrsTwv] [-c class] [-N ndots] [-R number]
[-t type] [-W wait] [-m flag] [-4] [-6] {name}
[server]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?host++NetBSD-5.0 in the
Description:
The host utility is for performing DNS lookups. You normally use it to convert
names to IP addresses and vice versa. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?host++NetBSD-5.0 in the
See also:
dig, named in the NetBSD documentation

hostapd © 2010, QNX Software Systems GmbH & Co. KG.
Authenticator for IEEE 802.11 networks
Syntax:
hostapd [-BdhKtv] config-file ...
Runs on:
Neutrino
Options:
-B Detach from the controlling terminal and run as a daemon process in
the background.
-d Enable debugging messages. If this option is supplied twice, more

verbose messages are displayed.
-h Show help text.
-K Include key information in debugging output.
-t Include timestamps in debugging output.
-v Display version information on the terminal, and then exit.
config-file Use the settings in the specified configuration file; the name of the
specified wireless interface is contained in this file. See
hostapd.conf in the NetBSD documentation for a description of the
configuration file syntax.
Description:
The hostapd utility is an authenticator for IEEE 802.11 networks. It provides full
support for WPA/IEEE 802.11i and can also act as an IEEE 802.1X Authenticator
with a suitable backend Authentication Server (typically FreeRADIUS). The hostapd
utility implements the authentication protocols that piggyback on top of the normal
IEEE 802.11 protocol mechanisms.
To use hostapd as an authenticator, the underlying device must support some basic
functionality, such as the ability to set security information in the 802.11 management
frames. Beware that not all devices have this support.
The hostapd utility is designed to be a daemon program that runs in the background
and acts as the backend component controlling the wireless connection. It supports
separate front-end programs such as the text-based front-end, hostapd_cli.
You can reload changes to the configuration file by sending a SIGHUP signal to the
hostapd processor, or by using the hostapd_cli reconfigure command.

© 2010, QNX Software Systems GmbH & Co. KG. hostapd
See also:
ifconfig
hostapd.conf, hostapd_cli, in the NetBSD documentation at
http://www.netbsd.org/docs/

hostname © 2010, QNX Software Systems GmbH & Co. KG.
Set or print the name of the current host system
Syntax:
hostname [-s] [name_of_host]
Runs on:
Options:
-s Trim off any domain information from the printed name.
name_of_host The name to be given to the current host system.
Description:
When the system starts, it initializes the hostname. As superuser, you can use the
hostname utility to change the hostname.
Without a name_of_host argument, hostname prints the name of the current host.
This utility sets or gets the value of the _CS_HOSTNAME configuration string, not that
of the HOSTNAME environment variable.
See also:
gethostname() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. /etc/hosts
Hostname database (UNIX)
Name:
/etc/hosts
Description:
The /etc/hosts file contains information regarding the known hosts on the network.
For each host, a single line should be present with the following information:
internet_address official_host_name aliases
Items are separated by any number of spaces or tabs, or both; however, spaces or tabs
aren’t allowed before the IP address. A # indicates the beginning of a comment — any
characters after a #, up to the end of the line, aren’t interpreted by routines that search
the file.
If you’re using a name server, this file provides a backup when the server isn’t
running. In this case, you should include only a few addresses in this file. These
include addresses for the local interfaces that ifconfig needs at boot time and a few
machines on the local network.
Network addresses are specified in the conventional “.” (dot) notation using the
inet_addr() routine from the internet address manipulation functions. Hostnames may
contain any printable character other than a field delimiter, newline, or comment
character.
See also:
ifconfig
gethostname() in the Library Reference
DNS and BIND by Paul Albitz and Cricket Liu, O’Reilly & Associates (ISBN
1-56592-010-4)

/etc/hosts.equiv © 2010, QNX Software Systems GmbH & Co. KG.
System-wide list of trusted remote hosts
Name:
/etc/hosts.equiv
Description:
The /etc/hosts.equiv and ˜/.rhosts files provide the “remote authentication”
database for the lpd, rcp, rlogin, and rsh commands and the rcmd() function.
These files bypass the standard password-based user authentication mechanism. They
specify remote hosts and users that are considered trusted (i.e. are allowed to access
the local system without supplying a password):
• on a system-wide basis (/etc/hosts.equiv)
• by an individual user (˜/.rhosts).
The file permissions for the ˜/.rhosts file must be as follows or its contents will be
ignored:
• it must be owned by root or the user
• it cannot be writable by anyone other than the owner (e.g. rw-r--r--)
The ruserok() function sets the effective userid to that of the remote user, but doesn’t
change the effective group ID. The user must have search permissions for the
directories contained in the pathname of an .rhosts file (i.e. if the file resides in
/home/user/.rhosts, the user must have search permissions for /home/user/).
The library routine ruserok() (see also rcmd()) performs the remote authentication. It
determines whether a particular remote user from a particular remote host is allowed
to access the local system as a (possibly different) particular local user:
• For non-root users, this routine checks /etc/hosts.equiv, and then the
.rhosts file in the home directory of the local user attempting access.
• For root, access is handled as a special case to help maintain system security; only
root’s .rhosts file is checked.
The rlogind daemon doesn’t allow root to log in without a password. When rsh is
specified without command options, rlogind (not rshd) is invoked on the remote
side.
If the remote authentication fails, lpd, rcp and rsh fail, but rlogin falls back to the
standard password-based login procedure.
Both files are formatted as a list of one-line entries of the form:
hostname [username]

© 2010, QNX Software Systems GmbH & Co. KG. /etc/hosts.equiv
where hostname must be the fully qualified domain name (FQDN) of the host, not one
of its aliases.
The entries in these files are either positive, to explicitly allow access without a
password, or negative, to deny it. Authentication succeeds as soon as a matching
positive entry is found, but fails when a matching negative entry is found, or if no
matching entries are found in either file. Therefore, the order of entries is important: if
the files contain both matching positive and negative entries, the entry that appears
first prevails.
Positive entries
Positive entries take these forms:
hostname All users from the named host are trusted and may access the system
with the same user name as they have on the remote system. You can
use this form in both /etc/hosts.equiv and individual users’
.rhosts files.
hostname username
The meaning of this form depends on which file it’s in:
• .rhosts file in a local user’s home directory — the named user
from the named host can access the system as that local user.
• /etc/hosts.equiv — the named remote user can access the
system as any local user.
You can use the special character “+” as a wild card in place of either hostname or
username to match any host or user:
+ Any user from any remote host can access the system, with the same
username.
+ username The named user from any remote host can access the system.
hostname + Any user from the named host can access the system as the local user.
Negative entries
Negative entries have a “-” character preceding either the hostname or username field.
For example:
hostname -username
Deny access to the named user if they attempt to access your system from the
named host without providing a password.

/etc/hosts.equiv © 2010, QNX Software Systems GmbH & Co. KG.
Caveats:
Use extreme caution in /etc/hosts.equiv with positive entries that include a
username field (either an individual named user, a netgroup, or “+” sign). Because
/etc/hosts.equiv applies system-wide, these entries allow one or a group of
remote users to access the system as any local user without providing a password. This
can be a security hole.
ignored:
• it cannot be writable by anyone other than the owner (e.g. rw-r--r-- )
See also:
/etc/hosts, lpd, rcp, ˜/.rhosts, rlogin, rlogind, rsh
rcmd() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. id
Return user and group IDs (POSIX)
Syntax:
id [username]
id -G [-n] [username]
id -g [-nr] [username]
id -u [-nr] [username]
Runs on:
Neutrino
Options:
-G Write the real (and effective, if different) group ID only.
-g Write the effective group ID only.
-u Write the effective user ID only.
-n In combination with -G, -g, or -u, write the ID as its name instead of as an
unsigned integer.
-r In combination with -g or -u, write the real ID instead of the effective ID.
Description:
The id utility writes the current real and/or effective user ID and group ID. When no
options are specified, output is as follows:
uid=nnn(username) gid=nnn(groupname)
If the effective user ID is different from the real user ID, the effective user ID also
appears:
... euid=nnn(effective_username)
Likewise, if the effective group ID is different from the real group ID, the effective
group ID appears as well:
... egid=nnn(effective_groupname)
If no entry exists for an ID in the /etc/passwd or /etc/group files, the output
lacks the (name) after the numerical value. No error is generated.
If a username is supplied as an operand, the effective uid and gid don’t appear since
there’s no process associated with it — the information is simply looked up in the
/etc/passwd and /etc/group files.
When options are specified, the requested data is written as an unsigned integer, unless
option -n is specified, in which case the data is written as the corresponding user or
group name. With option -G, the id utility might produce two lines of output (one
value per line) if the real and effective IDs differ. In all other cases, id always
produces one line of output.

id © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Write information on current IDs (real and effective):
$ id
uid=109(eric) gid=120(techies)
Write the effective group ID as a number:
$ id -g
120
Write the effective group ID as a name:
$ id -gn
techies
Files:
/etc/passwd Password file; defines user IDs, home directories, etc.
/etc/group Group file; defines the valid group IDs for the system, also lists
user IDs who may change to each group.
Exit status:
See also:
who
Logging In, Logging Out, and Shutting Down in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. if_up
Ensure a TCP/IP interface is available
If you aren’t root, specify the full path: /usr/sbin/if_up.
Syntax:
if_up [-alp] [-r retries] [-s seconds] interface...
Runs on:
Neutrino
Options:
-a Wait until all specified interfaces are configured. The default is to wait
until a single interface is configured.
-l (“el”) Wait for the network link to be marked as being up. This causes
if_up to wait until the physical network link is up. This option may
not be supported by some drivers.
-p Wait only until the specified interfaces are present. The default is to
wait until the interfaces are both present and configured. This is useful
if you intend to configure the interface manually, after it is present
(e.g. using the ifconfig utility).
-r retries The number of times to walk the interface list. The default is 5.
-s seconds Wait this number of seconds before rewalking the interface list. The
default is 1.
interface The name of the interface to wait on (e.g. en0, en1, . . . ).
Description:
You can use this convenience utility while booting to ensure a TCP/IP interface is
available to those utilities that require one. It’s primarily intended for use with the
dhcp.client. When if_up is run in the foreground in a startup script, the script
doesn’t continue until the specified interfaces are marked as “UP” and have been
assigned an IP address, or the utility has timed out.
Examples:
See dhcp.client.
Files:
libsocket.so The if_up utility requires the libsocket.so shared library.

if_up © 2010, QNX Software Systems GmbH & Co. KG.
/usr/sbin/if_up
The if_up utility is located in the /usr/sbin/ directory, which
isn’t included in the default PATH of non-root users. If you
aren’t root, specify the full path.
Exit status:
0 Success.
See also:
dhcp.client, ifconfig

© 2010, QNX Software Systems GmbH & Co. KG. ifconfig
Configure network interface parameters
Syntax:
ifconfig interface address_family [address [dest_address]]
[parameters]
ifconfig [-hLmvz] interface [protocol_family]
ifconfig -a [-bdhLmsuvz] [protocol_family]
ifconfig -l [-b] [-d] [-u] [-s]
ifconfig -s interface
ifconfig -C
Runs on:
Neutrino
Options:
-a Display information about all of the interfaces in the system. You
can use the -d, -u, -b, and -s options with this option to limit
this display.
-b List only the broadcast interfaces.
-C List all of the interface cloners available on the system, with no

additional information. This option is mutually exclusive with all
other options and commands.
-d List only the interfaces that are down.
-h If you use this option in conjunction with -v, ifconfig prints

the byte statistics are in human-readable format.
-L Display the address lifetime for IPv6 addresses, as a time offset

string.
-l List all available interfaces on the system, with no additional

information. This option is mutually exclusive with all other
options and commands, except for -b, -d, -s, -u.
-m Display all of the supported media for all of the interfaces in the
system (used in conjunction with -a).
If you specify the -m option before an interface name, ifconfig
displays all of the supported media for the specified interface.
-s If you specify the -a option, the -s option makes ifconfig list

only the interfaces that are connected.
If you specify the -s option for a specific interface, ifconfig
queries the interface for its media status. If the interface supports
reporting media status, and it reports that it doesn’t appear to be
connected to a network, ifconfig exits with status of 1 (false);

ifconfig © 2010, QNX Software Systems GmbH & Co. KG.
otherwise, it exits with zero (true). Not all interface drivers

support media status reporting.
-u List only the interfaces which are up.
-v Print statistics on packets sent and received on the given interface.

You can use the -h in conjunction with -v to display the byte
statistics in human-readable format.
-z Similar to the -v flag, except that it zeros the interface’s input and
output statistics after printing them.
interface The name of the interface to configure. This is a string of the

form name unit (e.g. en1)
address Either a hostname present in the /etc/hosts database, or a

DARPA-Internet address expressed in the standard Internet “dot
notation.”
For the Xerox Network Systems family, addresses are in the form
net:a.b.c.d.e.f , where net is the assigned network number (in
decimal), and each of the six bytes of the host number, a through
f , are specified in hexadecimal. The host number may be omitted
on Ethernet interfaces, which use the hardware physical address,
and on interfaces other than the first.
For the ISO family, addresses are specified as a long hexadecimal
string, as in the Xerox family. However, two consecutive dots
imply a zero byte, and the dots are optional, if you wish to
(carefully) count out long strings of digits in network byte order.
address_family The address family that affects the interpretation of the remaining
parameters. Specifying an address family is recommended since
an interface can receive transmissions in differing protocols with
different naming schemes. Address or protocol families currently
supported are inet, inet6, atalk, iso, and ns.
dest_address Address of the correspondent on the other end of a point-to-point

link (for pppx interfaces only).
parameters See the “Parameters” section below.
protocol_family Report only the details specific to this protocol family.
Description:
The ifconfig utility is used to assign an address and/or configure parameters for a
network interface. This utility must be run at boot time to define the network address
of each interface present on a machine; it may also be run later on to redefine an
interface’s address or to configure other interface parameters.

When no optional parameters are specified, ifconfig displays the current

configuration for a network interface. If you specify a protocol family, ifconfig
reports only the details specific to that protocol family.
Only the superuser can modify the configuration of a network interface.
Parameters
You may set the following parameters with the ifconfig utility, if the driver supports
them. The output from ifconfig for an interface lists the supported parameters.
alias Establish an additional network address for this interface. This

is useful when someone changes network address of an
interface, or when someone wishes to accept packets addressed
to the old interface.
-alias Remove the additional network address for this interface.
anycast (inet6 only) Set the IPv6 anycast address bit.
-anycast (inet6 only) Clear the IPv6 anycast address bit.
apbridge (IEEE 802.11 devices only) When operating as an access point,
pass packets between wireless clients directly (the default).
-apbridge (IEEE 802.11 devices only) When operating as an access point,
pass packets through the system so that they can be forwarded
using some other mechanism. Disabling the internal bridging is
useful when traffic is to be processed with packet filtering.
arp Enable the use of the Address Resolution Protocol in mapping
between network-level addresses and link-level addresses
(default). This is implemented to do mapping between DARPA
Internet addresses and Ethernet addresses.
-arp Disable the use of the Address Resolution Protocol.
broadcast mask (inet only) Use this address to represent broadcasts to the
network. The default broadcast address is the address with a
host part of all 1’s.
bssid bssid (IEEE 802.11 devices only) Set the desired BSSID for IEEE
802.11-based wireless network interfaces.
-bssid (IEEE 802.11 devices only) Unset the desired BSSID for IEEE
802.11-based wireless network interfaces. The interface will
automatically select a BSSID in this mode, which is the default.
chan chan (IEEE 802.11 devices only) Select the channel (radio
frequency) to use for IEEE 802.11-based wireless network
interfaces.

-chan (IEEE 802.11 devices only) Unset the desired channel to to be

used for IEEE 802.11-based wireless network interfaces. It
doesn’t affect the channel to be created for IBSS or hostap
mode.
chanlist channels Set the channels to use when scanning for access points,
neighbors in an IBSS network, or looking for unoccupied
channels when operating as an access point.
Specify the set of channels as a comma-seperated list, with
each element in the list representing either a single channel
number of a range of the form a-b. Channel numbers must be
in the range 1 through 255 and be permissible according to the
operating characteristics of the device.
create Create the specified network pseudo-device.
debug Enable driver-dependent debugging code; usually, this turns on

extra console error logging.
-debug Disable driver-dependent debugging code.
delete Remove a specified network address. You should use this

parameter if you have incorrectly specified an alias, or you will
no longer use an alias. In the event that you have incorrectly set
an NS address which has the side effect of specifying the host
portion, you must respecify the host portion while removing all
NS addresses. Note that this parameter doesn’t work for IPv6
addresses. If you need to delete IPv6 addresses, use -alias
with an explicit IPv6 address.
deletetunnel Unconfigure the physical source and destination address for IP

tunnel interfaces previously configured with tunnel.
deprecated (inet6 only) Set the IPv6 deprecated address bit.
-deprecated (inet6 only) Clear the IPv6 deprecated address bit.
destroy Destroy the specified network pseudo-device.
dest_address Specify the address of the correspondent on the other end of a

point-to-point link.
down Mark an interface as being down. When an interface is marked

down, the system doesn’t attempt to transmit messages through
that interface. If possible, the interface is reset to disable
reception as well. This action doesn’t automatically disable
routes using the interface.
eui64 (inet6 only) Fill the interface index (the lowermost 64 bits of
an IPv6 address) automatically.

hidessid (IEEE 802.11 devices only) When operating as an access point,

don’t broadcast the SSID in beacon frames or respond to probe
request frames unless they’re directed to the access point (i.e.
they include its SSID). By default, the SSID is included in
beacon frames, and undirected probe request frames are
answered.
-hidessid (IEEE 802.11 devices only) When operating as an access point,

broadcast the SSID in beacon frames and answer and respond
to undirected probe request frames (default).
instance minst Set the media instance to minst. This is useful for devices that
have multiple physical layer interfaces (PHYs). Setting the
instance on such devices may not be strictly required by the
network interface driver because the driver may take care of
this automatically; see the driver’s documentation for more
information.
ip4csum, ip4csum-rx, ip4csum-tx
Enable hardware-assisted IPv4 header checksums, if they’re
supported. You can restrict this action to either the Rx or Tx
direction, if the hardware permits it.
-ip4csum, -ip4csum-rx, -ip4csum-tx
Disable hardware-assisted IPv4 header checksums.
ipdst Specify an Internet host that’s willing to receive IP packets

encapsulating NS packets bound for a remote network. An
apparent point-to-point link is constructed, and the address
specified is taken as the NS address and network of the
destination. IP encapsulation of CLNP packets is done
differently.
link mac [active|delete]

Dynamically modify the specified interface’s MAC addresses.
If you don’t specify active or delete, ifconfig adds the
given MAC address. The active command activates the
address, and the delete command removes it.
link[0-2] Enable special processing of the link level of the interface.

These three options are interface-specific in actual effect, but
you use them in general to select special modes of operation.
An example of this is to select the connector type for some
ethernet cards. For more information, see the documentation
for the specific driver.
-link[0-2] Disable special processing at the link level with the specified
interface.

media type Set the media type of the interface to type. Some interfaces
support the mutually exclusive use of one of several different
physical media connectors. For example, a 10 Mb/s Ethernet
interface might support the use of either AUI or twisted-pair
connectors. Setting the media type to 10base5 or AUI would
change the currently active connector to the AUI port. Setting it
to 10baseT or UTP would activate twisted pair. Refer to the
interfaces’ driver-specific documentation for a complete list of
the available types.
mediaopt opts Set the specified media options on the interface. The opts
argument is a comma-delimited list of options to apply to the
interface. For information about the available options, see the
documentation for each driver.
-mediaopt opts Disable the specified media options on the interface.
metric n Set the routing metric of the interface to n. The default is 0.
The routing metric is used by the routing protocol (routed).
Higher metrics have the effect of making a route less favorable;
metrics are counted as additional hops to the destination
network or host.
mode mode If the driver supports the media selection system, set the
specified operating mode on the interface to mode. For IEEE
802.11 wireless interfaces that support multiple operating
modes, this directive is used to select between 802.11a (11a),
802.11b (11b), and 802.11g (11g) operating modes.
mtu n Set the maximum transmission unit of the interface to n. Most
interfaces don’t support this parameter.
netmask mask (inet, inet6, and ISO) Specify how much of the address to
reserve for subdividing networks into subnetworks. The mask
includes the network part of the local address and the subnet
part, which is taken from the host field of the address. You can
specify the mask as a single hexadecimal number with a leading
0x, with a dot-notation Internet address, or with a
pseudo-network name listed in the network table, networks.
The mask contains ones for the bit positions in the 32-bit
address that are to be used for the network and subnet parts, and
zeroes for the host part. The mask should contain at least the
standard network portion, and the subnet field should be
contiguous with the network portion.
For INET and INET6 addresses, you can also give the netmask
with slash-notation after the address (e.g. 192.168.17.3/24).
nsellength n (ISO only) This specifies a trailing number of bytes for a
received NSAP used for local identification, the remaining

leading part of which is taken to be the NET (Network Entity

Title). The default value is 1, which is conformant to US
GOSIP. When an ISO address is set in an ifconfig command,
it’s really the NSAP that’s being specified. For example, in US
GOSIP, 20 hex digits should be specified in the ISO NSAP to be
assigned to the interface. There is some evidence that a number
different from 1 may be useful for AFI 37 type addresses.
nwid id A synonym for ssid.
nwkey key (IEEE 802.11 devices only) Enable WEP encryption for IEEE
802.11-based wireless network interfaces with the key. The key
can either be a string, a series of hexadecimal digits preceded
by 0x, or a set of keys in the form n:k1,k2,k3,k4, where n
specifies which of keys will be used for all transmitted packets,
and four keys, k1 through k4, are configured as WEP keys.
Note that the order must be matched within same network if
you use multiple keys. For IEEE 802.11 wireless network, the
length of each key is restricted to 40 bits, i.e. a 5-character
string or 10 hexadecimal digits, while the WaveLAN/IEEE
Gold cards accept the 104 bits (13 characters) key.
nwkey persist (IEEE 802.11 devices only) Enable WEP encryption for IEEE
802.11-based wireless network interfaces with the persistent
key written in the network card.
nwkey persist:key (IEEE 802.11 devices only) Write the key to the persistent
memory of the network card, and enable WEP encryption for
IEEE 802.11-based wireless network interfaces with the key.
-nwkey (IEEE 802.11 devices only) Disable WEP encryption for IEEE
802.11-based wireless network interfaces.
pltime n (inet6 only) Set the preferred lifetime for the address, in
seconds.
powersave (IEEE 802.11 devices only) Enable 802.11 power-saving mode.
-powersave (IEEE 802.11 devices only) Disable 802.11 power-saving

mode.
powersavesleep duration
(IEEE 802.11 devices only) Set the receiver sleep duration, in
milliseconds, for the 802.11 power-saving mode.
prefixlen n (inet and inet6 only) Similar to netmask, but you can
specify the length of the prefix.
ssid id (IEEE 802.11 devices only) Configure the Service Set Identifier
(also known as the network name) for IEEE 802.11-based

wireless network interfaces. The id can either be any text string

up to 32 characters in length, or a series of up to 64
hexadecimal digits preceded by 0x. Setting id to the empty
string allows the interface to connect to any available access
point.
tcp4csum, tcp4csum-rx, tcp4csum-tx

Enable hardware-assisted TCP/IPv4 checksums, if they’re
-tcp4csum, -tcp4csum-rx, -tcp4csum-tx

Disable hardware-assisted TCP/IPv4 checksums.
tcp6csum, tcp6csum-rx, tcp6csum-tx
Enable hardware-assisted TCP/IPv6 checksums, if they’re
-tcp6csum, -tcp6csum-rx, -tcp6csum-tx

Disable hardware-assisted TCP/IPv6 checksums.
tentative (inet6 only) Set the IPv6 tentative address bit.
-tentative (inet6 only) Clear the IPv6 tentative address bit.
tso4 Enable hardware-assisted TCP/IPv4 segmentation on interfaces

that support it.
-tso4 Disable hardware-assisted TCP/IPv4 segmentation on

interfaces that support it.
tunnel src_addr[,src_port] dest_addr[,dest_port]

(IP tunnel devices only) Configure the physical source and
destination address for IP tunnel interfaces, including gif. The
arguments, src_addr and dest_addr are interpreted as the outer
source and destination for the encapsulating IPv4/IPv6 header.
On a gre interface in UDP mode, the arguments src_port and
dest_port are interpreted as the outer source and destination
port for the encapsulating UDP header.
udp4csum, udp4csum-rx, udp4csum-tx

Enable hardware-assisted UDP4 checksums, if they’re
-udp4csum, -udp4csum-rx, -udp4csum-tx

Disable hardware-assisted UDP4 checksums.

udp6csum, udp6csum-rx, udp6csum-tx

Enable hardware-assisted UDP6 checksums, if they’re
-udp6csum, -udp6csum-rx, -udp6csum-tx

Disable hardware-assisted UDP6 checksums.
up Mark an interface as being up. You can use this to enable an

interface after an ifconfig down command. By default, an
interface is marked as “up” the first time ifconfig is run to
assign the interface an address. If the interface was reset when
previously marked down, the hardware is reinitialized.
vlan tag If the interface is a vlan pseudo-interface, set the VLAN tag to
tag. This is a 12-bit number which is used to create an 802.1Q
VLAN header for packets sent from the vlan interface. Note
that you must set vlan and vlanif at the same time.
vlanif iface If the interface is a vlan pseudo-interface, associate the

physical interface, iface, with it. Packets transmitted through
the vlan interface will be diverted to the specified physical
interface iface with 802.1Q VLAN encapsulation. Packets with
802.1Q encapsulation received by the physical interface with
the correct VLAN tag will be diverted to the associated vlan
pseudo-interface.
The VLAN interface is assigned a copy of the physical
interface’s flags and Ethernet address. If the vlan interface
already has a physical interface associated with it, this
command will fail. To change the association to another
physical interface, the existing association must be cleared first.
Note that you must set vlan and vlanif at the same time.
vltime n (inet6 only) Set the valid lifetime for the address.
The following parameters are specific to IEEE 802.11 wireless interfaces:
list active Display the list of channels available for use, taking into account
any restrictions set with the chanlist directive. See the
description of list chan for more information.
list caps Display the adaptor’s capabilities, including the operating modes
supported.
list chan Display the list of channels available for use. Channels are shown
with their IEEE channel number, equivalent frequency, and usage
modes. Channels identified as “11g” are also usable in “11b”

mode. Channels identified as “11a Turbo” may be used only for

Atheros’ Static Turbo mode (specified with mediaopt turbo).
Channels marked with a * have a regulatory constraint that they be
passively scanned. This means a station isn’t permitted to transmit
on the channel until it identifies the channel as being used for
802.11 communication, typically by hearing a beacon frame from
an access point operating on the channel. You can also use list
freq to request this information.
list mac Display the current MAC Access Control List state. Each address
is prefixed with a character that indicates the current policy applied
to it:
This character: Indicates:

+ The address is allowed access.
- The address is denied access.
* The address is present, but the current policy is
open (so the ACL isn’t consulted).
list scan Display the access points and/or ad hoc neighbors located in the
vicinity. You can use the -v option to display long SSIDs. This
information may be updated automatically by the adaptor and/or
with a scan request. You can also use list ap to request this
information.
list sta When operating as an access point, display the stations that are
currently associated. When operating in ad hoc mode, display
stations identified as neighbors in the IBSS. Capabilities advertised
by the stations are described under the scan request. Depending on
the capabilities of the stations the following flags can be included
in the output:
A Authorized. Indicates that the station is permitted to

send/receive data frames.
E Extended Rate Phy (ERP). Indicates that the station is
operating in an 802.11g network using extended transmit
rates.
P Power Save. Indicates that the station is operating in
power-saving mode.
scan Initiate a scan of neighboring stations, wait for it to complete, and

display all stations found. Only the superuser can initiate a scan.
Depending on the capabilities of the APs, the following flags can
be included in the output:

E Extended Service Set (ESS). Indicates that the station is part

of an infrastructure network (in contrast to an IBSS/ad hoc
network).
I IBSS/ad hoc network. Indicates that the station is part of an
ad hoc network (in contrast to an ESS network).
P Privacy. Data confidentiality is required for all data frames
exchanged within the BSS. This means that this BSS
requires the station to use cryptographic means such as WEP,
TKIP, or AES-CCMP to encrypt and decrypt data frames
being exchanged with others.
S Short Preamble. Indicates that the network is using short
preambles (defined in 802.11b High Rate/DSSS PHY). A
short preamble uses a 56-bit sync field, in contrast to a
128-bit field used in long preamble mode.
s The network is using a short slot time.
You can use the list scan request to show recent scan results
without initiating a new scan. You can use the -v option to prevent
the shortening of long SSIDs.
Diagnostics
Depending on the error, the utility may display messages indicating:
• the specified interface doesn’t exist
• the requested address is unknown
• the user isn’t privileged and tried to alter an interface’s configuration
Examples:
Enable hardware-assisted TCP/IPv6 checksums on an interface:
ifconfig wm0 tcp6csum
See also:
/etc/autoconnect, /etc/hosts netmanager, netstat, phlip, routed
gif, gre, vlan in the NetBSD documentation at http://www.netbsd.org/docs/
QNX Neutrino Core Networking User’s Guide

ifwatchd © 2010, QNX Software Systems GmbH & Co. KG.
Watch for addresses added to or deleted from interfaces and call up/down-scripts for them
Syntax:
ifwatchd [-hiqv] [-A arrival-script] [-c carrier-script]
[-D departure-script] [-d down-script]
[-n no-carrier-script] [-u up-script] ifname(s)
Runs on:
Neutrino
Options:
-A arrival-script Specify the command to invoke when new interfaces (such as
PCMCIA cards) arrive.
-c carrier-script Specify the command to invoke when the carrier status changes
from no carrier to carrier.
-D departure-script Specify the command to invoke when an interface departs (for
example a PCMCIA card is removed.)
-d down-script Specify the command to invoke on “interface down” events (or
on the deletion of an address from an interface).
-h Show the synopsis.
-i Inhibit a call to the up-script on startup for all watched interfaces
already marked up. If you don’t specify this option, ifwatchd
checks all watched interfaces on startup whether they’re already
marked up and, if they are, calls the up-script with appropriate
parameters.
Since ifwatchd typically is started late in the system boot
sequence, some of the monitored interfaces may already have
come up when it finally starts, but their up-scripts haven’t been
called. By default, ifwatchd calls them on startup to account
for this (and make the scripts easier.)
-n no-carrier-script
Specify the command to invoke when the carrier status
transitions from carrier to no carrier.
-q Be quiet and don’t log non-error messages to slogger.
-u up-script Specify the command to invoke on “interface up” events (or on
the addition of an address to an interface).
-v Run in verbose debug mode and don’t detach from the
controlling terminal. Output verbose progress messages, and flag
those errors that are ignored during normal operation. Don’t use
this option in /etc/rc.conf.

© 2010, QNX Software Systems GmbH & Co. KG. ifwatchd
ifname(s) The name of the interface to watch. You can specify multiple
interfaces. Events for other interfaces are ignored.
Description:
The ifwatchd utility is used to monitor dynamic interfaces (for example PPP
interfaces) for address changes, and to monitor static interfaces for carrier changes.
Sometimes these interfaces are accompanied by a daemon program, which can take
care of running any necessary scripts (such as pppd or isdnd), but sometimes the
interfaces run completely autonomously (such as pppoe).
The ifwatchd utility provides a generic way to watch these types of changes. It
works by monitoring the routing socket and interpreting RTM_NEWADDR (address
added), RTM_DELADDR (address deleted) and RTM_IFINFO (carrier detect or loss of
carrier) messages. It doesn’t need special privileges to do this. The scripts called for
up or down events are run with the same user ID as for ifwatchd.
Examples:
# ifwatchd -u /etc/ppp/ip-up -d /etc/ppp/ip-down pppoe0
If your pppoe0 interface is your main connection to the Internet, the typical use of the
up/down scripts is to add and remove a default route. This is an example of an up
script that does this:
#! /bin/sh
/sbin/route add default $5
As described below, the fifth command line parameter contains the peer address of the
pppoe link. The corresponding ip-down script is:
#! /bin/sh
/sbin/route delete default $5
This isn’t a good idea if you have pppoe0 configured to connect only on demand (via
the link1 flag), but works well for all permanent connected cases. Use:
! /sbin/route add default -iface 0.0.0.1
in your /etc/ifconfig.pppoe0 file in the on-demand case.

indent © 2010, QNX Software Systems GmbH & Co. KG.
Format C source
Syntax:
indent [input-file [output-file]] [options...]
Runs on:
QNX Neutrino
Options:
The first option of a pair is described; the second option disables the first. The second
option (disabled) is default.
-bad, -nbad Force a blank line after each block of declarations.
-bap, -nbap Force a blank line after procedure bodies.
-bbb, -nbbb Force a blank line before every block comment.
-nbc, -bc Don’t force a newline after each comma in a declaration.
-bl, -br Move the first brace ({) of a compound statement to the next line.
-cn Specify the column in which comments on code start.
-cdn Specify the column in which comments on declarations start.
-ncdb, -cdb Don’t place comment delimiters alone on blank lines.
-nce, -ce Don’t place else statements adjacent to the preceding closing brace
(}).
-cin Set the line overflow indentation to be n.
-clin Indent case labels n tab stops past the switch.
-d1 Indent code comments by themselves one tab stop.
-din Specify the column indentation of variable declarations.
-ndj, -dj Left-justify declarations.
-ei, -nei Indent an if following an else the same as the preceding if.
-nfc1, -fc1 Don’t format comments that start in column 1.
-in Specify the number of spaces for one indentation level. The default
is 4.
-nip, -ip Disable the indentation of parameter declarations.
-ln Specify the maximum length of an output line. The default is 75.

© 2010, QNX Software Systems GmbH & Co. KG. indent
-nlp, -lp Don’t line up parameters that overflowed onto the next line.
-npro Ignore the profile files ./.indent.pro and ˜/.indent.pro.
-pcs, -npcs Place a space between procedure names and the following
parenthesis (().
-npsl, -psl Don’t place column 1 procedure types on the previous line.
-nsc, -sc Disable the placement of asterisks (*) at the left edge of comments.
-sob, -nsob Remove optional blank lines.
-st Take input from stdin, and send output to stdout.
-Ttypename Add typename to the list of type keywords.
-troff Format for processing by troff. If you use this option, the output
is sent to stdout by default.
-v, -nv Be verbose; provide statistics and line-splitting information.
Description:
The indent utility formats C source code.
If you specify only input-file, it’s modified.
Files:
./.indent.pro, ˜/.indent.pro
Profile files.
See also:
unifdef

inetd © 2010, QNX Software Systems GmbH & Co. KG.
Internet super-server (UNIX)
You must be root to start this daemon.
Syntax:
inetd [-Dd] [configuration_file]
Runs on:
Neutrino
Options:
-D Force inetd to daemonize by calling procmgr_daemon() instead of calling
daemon().
You need to specify the -D option to inetd if you’re running it under the control of
the High Availability Manager. The HAM can see death messages only from tasks that
are running in session 1, and the call to daemon() doesn’t put the caller into that
session. For more information about HAM, see the High Availability Framework
Developer’s Guide.
-d Turn on debugging.
Description:
The inetd daemon listens for connections on certain well-known ports. When it finds
a connection on one of its sockets, the daemon decides what service the socket
corresponds to and invokes a program to service the request. After that program is
finished, inetd continues to listen on the socket (except in some cases, described
below). Essentially, inetd lets you run one daemon to invoke several others, reducing
load on the system.
When it starts, inetd reads its configuration information from a configuration file; by
default, this is /etc/inetd.conf.
If any errors occur, inetd sends messages to slogger; use sloginfo to view the
system log.
Internal services
The inetd daemon provides several “trivial” services internally by using routines
within itself. These services are:
echo Echo the data received.
discard Discard the data received.
chargen Generate characters.

© 2010, QNX Software Systems GmbH & Co. KG. inetd
daytime Human-readable time.
time Machine-readable time, in the form of the number of seconds since

midnight, January 1, 1900.
All of these services are UDP- or TCP-based.
Effects of SIGHUP
When it receives SIGHUP, inetd rereads its configuration file, which may cause
services to be added, deleted, or modified.
Files:
The inetd daemon requires the libsocket.so shared library.
If you use RPC-based services, the librpc.so shared library must exist.
See also:
ftpd, /etc/inetd.conf, rlogind, rshd, slogger, sloginfo, telnetd, tftpd

/etc/inetd.conf © 2010, QNX Software Systems GmbH & Co. KG.
Super-server configuration file (UNIX)
Name:
/etc/inetd.conf
Description:
The /etc/inetd.conf file is the default configuration file for the inetd
(super-server) daemon. As shipped, this file describes all currently supported QNX
Neutrino TCP/IP daemons and some nonstandard pidin services. Unless you want to
add or remove daemon definitions, you don’t need to modify this file.
The file must have an entry in each of its fields, with each field separated by a tab or a
space. Comments are denoted by a pound sign (#) at the beginning of a line.
The fields in the configuration file are:
[addr:]service-name | service-name/version
socket-type
protocol[,sndbuf=size][,rcvbuf=size]
wait|nowait[:max]
user[:group]
server-program
server program arguments
Here’s a description of the arguments:
addr The local host address that inetd uses when listening for a
service. (Not applicable to RPC-based services.) A single
asterisk character (*) indicates that it is to listen on all local
addresses (INADDR_ANY).
When a line contains an address specifier and colon only (no
service-name field is specified), the address specifier is assumed
for all further lines until another line with an explicit address
specifier appears, or until the end of the file is reached.
service-name Name of a valid service in the /etc/services file, or a valid

RPC service name from /etc/rpc.
For “internal” services (see server program arguments), the
service name must be the official name of the service (i.e. the first
entry in /etc/services).
version The RPC version number. It can simply be a single numeric

argument or a range of versions. A range is bounded by the low
version to the high version (e.g. rusers/1-3).
socket-type One of stream, dgram, or raw, depending on whether the socket

is a stream, datagram, or raw socket.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/inetd.conf
protocol A valid protocol; for example, tcp or udp from

/etc/protocols.
If you need to specify an IP version explicitly, use protocols such
as tcp4 (for IPv4) or udp6 (for IPv6). Protocols, such as tcp or
udp, default to the current IP version (currently IPv4).
For RPC-based services, you must prefix the protocol with rpc/
(e.g rpc/udp).
rcvbuf=size
sndbuf=size Size of the send or receive buffer for the listening socket. This
may be useful for the TCP protocol because the window scale
factor, that’s based on the receive socket buffer size, is advertised
when the connection handshake occurs. Therefore, the socket
buffer size for the server must be set on the listening socket. In
some situations, you may realize better TCP performances when
increasing the socket buffer sizes. The socket buffer sizes are
specified by appending their values to the protocol specification
as follows:
tcp,rcvbuf=16384
tcp,sndbuf=64k
tcp,rcvbuf=64k,sndbuf=1m
A literal value may be specified or modified using k (for

kilobytes) or m (for megabytes). Socket buffer sizes may be
specified for all services and protocols except for the TCP port
service multiplexer (TCPMUX) services.
wait|nowait Tell inetd if it should wait for the server program to return, or to
continue processing connections on the socket. Sockets other
than datagram sockets should have a nowait entry in this space.
If a datagram server connects to its peer, freeing the socket so
inetd can receive further messages on the socket, it’s said to be
a multi-threaded server and should use the nowait entry.
If a datagram server processes all incoming datagrams on a socket
and eventually times out, that server is said to be single-threaded
and should use a wait entry. The tftpd daemon is an exception;
it’s a datagram server that establishes pseudo-connections. It
must be listed as wait in order to avoid a race; the server reads
the first packet, creates a new socket, and then forks and exits to
let inetd check for new service requests to spawn new servers.
Stream servers are usually marked as nowait, but if a single
server process is to handle multiple connections, it may be
marked as wait. The master socket is passed as fd 0 to the
server, which then needs to accept the incoming connection. The
server should eventually time out and exit when no more

connections are active. The inetd daemon will continue to listen

on the master socket for connections. The identd server is
usually the only stream server marked as wait.
max Maximum number of server instances that may be spawned from

inetd within an interval of 60 seconds. If omitted, max defaults
to 40 server instances.
user Name of the user that the server runs as. This allows servers to be
given less permission than root.
group Allow servers to run with a different (primary) group ID than

specified in the password file. If a group is specified and user
isn’t root, the supplementary groups associated with that user
will still be set.
A group name is specified by appending a colon or dot (allowed
for backwards compatibility) to the user name followed by the
group name.
server-program Pathname of the program that inetd executes when a request is

found on inetd’s socket. If the desired service is provided
internally by inetd (e.g. see echo in the inetd utility page),
this field would contain the word internal.
server program arguments
Any arguments to be passed to the server program. The name of
the program is passed as argv[0]. If the server program field is
internal, you can leave this field blank.
Setting the IPsec policy

You can specify the IPsec policy setting for each socket in a special comment line. A
line that starts with the special comment “#@” identifies the policy specifier, and the
content of the comment line is treated as the IPsec policy string.
Valid policy settings for /etc/inetd.conf include:
direction bypass
direction entrust
direction ipsec request ...
See “Setting the policy” in the IPsec protocols page for detailed descriptions of the
arguments.
Multiple IPsec policy strings may be specified using semicolons as separators. If

conflicting strings are found in a single line, the last string takes effect.
When a policy specifier is set with #@, all further lines in the /etc/inetd.conf
configuration file are also affected. You can reset the IPsec policy by inserting a
comment line without a policy string (i.e. a comment line containing #@ only).

© 2010, QNX Software Systems GmbH & Co. KG. /etc/inetd.conf
If an invalid IPsec policy string appears in /etc/inetd.conf, inetd leaves error

messages using syslog(), and terminates itself.
IPv6 TCP/UDP behavior
If you want to run a server for both IPv4 and IPv6 traffic, you’ll need to run two
separate processes for the same server program. You do this by adding two separate
lines in inetd.conf, one for tcp4 and one for tcp6.
Under various combination of IPv4/v6 daemon settings, inetd behaves as follows:
If you have: IPv4 traffic: IPv6 traffic:

Only one server on tcp4 Routed to the server Isn’t accepted
Two servers: one on Routed to the server on Routed to the server on
tcp4 and one on tcp6 tcp4 tcp6
Only one server on tcp6 For certain Routed to the server on
configurations, may be tcp6.
routed to the tcp6 server
(see the IP6 protocol page
for details).
Examples:
The following is an example from a working inetd.conf file:
ftp stream tcp nowait root /usr/sbin/ftpd in.ftpd -el
where:
ftp Is the service name (see /etc/services).
stream Is the socket type.
tcp Is the protocol.
nowait Is the wait/nowait entry.
root Is the user.
/usr/sbin/ftpd
Is the server program.
in.ftpd Is argv[0] (server program arguments).
-el Is argv[1] (server program arguments).

See also:
inetd, setkey
IPsec protocol in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. inflator
Inflate previously deflated files
You must be root to start this resource manager.
Syntax:
inflator [-b num] [-v[v...]] [mountpoints...]
[!exclude...]
Runs on:
Neutrino
Options:
-b num The number of decompression buffers (default: 8).
-v[v...] Be verbose. Each additional v makes the output more verbose.
If you specify the -v option, you need to start inflator in the background. If you
don’t use this option, inflator automatically daemonizes itself.
mountpoints Directories to overlay (the default is /). If a mountpoint starts with an

exclamation mark (!), that directory is excluded.
!exclude Directories to exclude.
Description:
The inflator resource manager sits in front of other filesystems and inflates files
that were previously deflated using the deflate utility. It’s typically used when the
underlying filesystem is a flash filesystem — it can almost double the effective size of
the flash memory.
When started without arguments, inflator takes over /, placing it in front of any
existing filesystems. It then catches each open() first. If the file is being opened for
read, inflator attempts to open the file itself on an underlying filesystem. It reads
the first 16 bytes and checks for the signature of a deflated file. If the file was deflated,
inflator places itself between the application and the underlying filesystem. All
reads return the original file data before it was deflated.
From the application’s point of view, the file appears to be uncompressed. Random
seeks are also supported. If the application does a stat() on the file, the size of the
inflated file (the original size before it was deflated) is returned. If it’s necessary to
open a deflated file and see the deflated data or the deflated size, append .˜˜˜ to the
filename and open that. For example:
$ deflate file1 # Deflate a file
$ wc file1 # wc sees the contents of the original file
$ wc file1.˜˜˜ # wc sees the contents of the deflated file
$ ls -l file1 # ls reports the size of the original file
$ ls -l file1.˜˜˜ # ls reports the size of the deflated file

inflator © 2010, QNX Software Systems GmbH & Co. KG.
If a file opened for read doesn’t have the deflate signature, inflator returns
ENOENT, which gives the file to the next underlying filesystem. In this manner,
inflator gets out of the way. Likewise if a file is opened for any write mode,
inflator again returns ENOENT and gets out of the way. You can use the -v option
to monitor the opens that inflator receives and which ones it accepts. You can use
multiple -v options to obtain more verbosity.
By default, inflator maintains 8 inflation buffers that are used to decompress data.
If more than 8 files are being processed at one time, the buffers are used as a cache. If
a buffer is stolen away from a file, a subsequent read on that file requires the data to be
reread and inflated again. A single -v prints a message each time a buffer is stolen,
allowing you to tune your system. Since memory is often in short supply in embedded
systems, you should use the minimum number of buffers needed to achieve acceptable
performance.
The size of the buffers is determined by the deflate utility. It defaults to 8K, but may
be set to any of 4K, 8K, 16K or 32K. In effect, the file is broken into smaller
compression blocks instead of compressing the entire file as a whole. Without this,
random seeking in the file would be a performance nightmare. On fast processors
(200MHz), the cost of inflating the data shouldn’t be significant. On slower processors,
it may be a performance issue as the inflation code competes for processor cycles.
Some versions of the flash filesystem (devf-*) also support compression. For most
systems, inflator provides better compression and comparable, if not better,
performance.
Examples:
Take over / and inflate files that have been deflated when they’re opened for reading
by applications:
inflator
Take over / as above, but pass on any files under /tmp to any underlying filesystems
without examining them in any way:
inflator / !/tmp
Take over directories where executables are usually located. Inflate files that have been
deflated when they’re opened for reading by applications:
inflator /sbin /bin /usr/sbin /usr/bin /usr/photon/bin
Take over / as above, but output some diagnostics (note the ampersand, which is
needed to make inflator run in the background when -v is specified):
inflator -v &
Take over / as above, but output lots of diagnostics:

inflator -vvvvv &

© 2010, QNX Software Systems GmbH & Co. KG. inflator
Caveats:
You can’t run inflator twice on the same mountpoint.
See also:
deflate, devf-*

infocmp © 2010, QNX Software Systems GmbH & Co. KG.
Output the contents of a terminfo capability file (UNIX)
Syntax:
infocmp [-1CILQ] [-w width] [terminal_name]
Runs on:
Neutrino
Options:
-1 (“one”) Force the output to contain one entry per line. Without this
option, output is printed to a maximum width of 60 characters,
each line containing as many entries as can fit on that line.
-C Generate output in termcap format.
-I Generate output in terminfo format. This option is the default.
-L Use the long C variable names listed in /usr/include/term.h
-Q Use the names that map onto the QNX console capabilities.
-w width Force the output to the specified number of columns. As many

entries as fit on each line are output.
terminal_name The name of a terminal capability file to display. If the

TERMINFO environment variable is not set, the file is read from
the /usr/lib/terminfo directory in a subdirectory named by
the first letter of the terminal name. For example, the VT100
terminfo file is stored in: /usr/lib/terminfo/v/vt100. If
set, the TERMINFO environment variable defines a directory
where the compiled description file is read from. If a
terminal_name isn’t specified, the terminal named in the TERM
environment variable is used.
Description:
The infocmp utility is used to output the contents of a previously compiled
terminfo capability file in a number of formats. The default format is suitable for
editing and recompilation with the tic utility. The output is sorted such that the
Boolean capabilities are output first, followed by the integer capabilities and then the
string fields. The infocmp utility, executed without any options, produces the
terminfo description of the currently defined terminal in a form suitable for editing
and recompilation with the tic utility.
If no options are specified and zero or one terminal name is specified, the -I option is
assumed.

© 2010, QNX Software Systems GmbH & Co. KG. infocmp
See also:
tic
Strang, John, Linda Mui, and Tim O’Reilly. 1988. termcap & terminfo. Sebastopol,
CA: O’Reilly and Associates. ISBN 0937175226.

input-cfg © 2010, QNX Software Systems GmbH & Co. KG.
Configure the mouse or pointer
Syntax:
input-cfg [-s server_name] [-x position[%][r]
[-y position[%][r]
Runs on:
Neutrino
Options:

fullpath fullpath


Description:
You can use input-cfg to configure input devices, such as a mouse:

© 2010, QNX Software Systems GmbH & Co. KG. input-cfg
Configuring the mouse.
You can:
• Swap the mouse buttons.

By default, you use the left mouse button as Select, and the right as Menu. If you
control the mouse with your right hand, this arrangement is best, because you use
your index finger (which is stronger than your middle finger) for the Select button.
Most user interfaces use the Select button more than the Menu button.
If you use your left hand to control the mouse, you should swap the buttons to
avoid straining your fingers.
• Enable the mouse wheel (if the mouse has one).
• Adjust the mouse’s speed (gain) and acceleration.
See also:
devi-*, inputtrap
Using the Photon microGUI in the Neutrino User’s Guide

inputtrap © 2010, QNX Software Systems GmbH & Co. KG.
Detect input devices and optionally start the input manager
Syntax:
inputtrap [-f device] [-l device] [-s]
[-T] [-t trapfile] [-V...]
[-v[v]...] [-X class]... [-x device]...
[start] [query]
Runs on:
Neutrino
Options:
-f device Probe for device first.
-l device (“el”) Probe for device last.
-s Safe mode (probe only for a keyboard).
-T Ignore the default trapfile.
-t trapfile Specify an alternative trapfile to start the input manager from.
-V Pass a -v to the devi driver.
-v[v]... Be verbose; more v characters cause more verbosity.
-X class Exclude any devices of class from the scan.
-x device Exclude device from the scan.
start Start the driver. Once one input device from each class of device is
recognized, inputtrap starts the driver for the first device found in
each class.
query Probe for input devices. If query is specified, inputtrap gives a

printout of the command line required to start devi-hirun.
Description:
The inputtrap utility detects input devices and optionally starts the input manager.
It runs in one of the following ways:
• It probes for input devices and starts devi-hirun.

Or:
• It reads a trapfile and starts any devi-* driver.

© 2010, QNX Software Systems GmbH & Co. KG. inputtrap
Probing
If probing, inputtrap probes for input devices, and writes to slogger the
invocation commands along with the appropriate options and arguments for starting
the found devices. If you specify the query option, inputtrap also writes the
commands to standard output.
The probing order is as follows:
1 Keyboard (kbd)
2 PS/2 mouse (ps2)
3 fd-connected relative-coordinate pointing devices (fd) , conforming to the

COM Plug and Play standard.
The device names (given above) are recognized as arguments to the -f and -x options.
Using a trapfile
To override the options that inputtrap uses by default, probe the devices, using the
query option as described above, redirect the output to a file, and then edit the file.
When the options are correct, move or copy the trapfile to
/etc/system/trap/input.${HOSTNAME}.
If the /etc/system/trap/input.${HOSTNAME} file exists, inputtrap uses the
contents of this file as arguments to start a devi-* driver.
Each line of the trapfile corresponds to a separate invocation of a devi-* driver. The
first word on the line indicates the driver to start. For example:
devi-elo elo fd -d/dev/ser1
The above line tells inputtrap to start the Elographics touchscreen driver.
If the line doesn’t start with the name of a devi-* driver, inputtrap starts
devi-hirun. For example:
kbd fd -d/dev/kbd ps2 k6-2
CAUTION:
! Adding invalid information to the input.hostname file can cause the system to hang.
If your hardware changes, remember to remove the old input.hostname file.

inputtrap © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Probe for input devices, but don’t start the input driver:
inputtrap
Probe for input devices. Don’t start the input driver, but write the command line for
the driver on standard output:
inputtrap query
Probe for input devices. Once one of each class of device has been recognized, spawn
devi-hirun with an appropriate command line:
inputtrap start
See also:
devi-*, input-cfg, slogger

© 2010, QNX Software Systems GmbH & Co. KG. io-audio
Start an audio driver
Syntax:
io-audio [-d driver [driver_options]] [-o opt[,opt[,opt]]]
[v[v]...]
Runs on:
Neutrino
Options:
-d driver [driver_options]
Load the specified driver and pass it the given driver_options.
For information on the drivers and their syntax and options, see
the deva-* entries:
Driver: Shared object:

4dwave deva-ctrl-4dwave.so
audiopci deva-ctrl-audiopci.so
cs4281 deva-ctrl-cs4281.so
ess1938 deva-ctrl-ess1938.so
geode deva-ctrl-geode.so
i8x0 deva-ctrl-i8x0.so
nmg6 deva-ctrl-nmg6.so
via686 deva-ctrl-via686.so
vortex deva-ctrl-vortex.so
ymfds1 deva-ctrl-ymfds1.so
-o global_options Global options. The global_options variable can be any of the

following:
• config_write_delay=time
The time in seconds after the last change before soundcard
settings are written to disk, (a value of -1 prevents the
settings from ever being written).
• max_dma_buf_size=size
The maximum size, in kilobytes, for the DMA buffer.

io-audio © 2010, QNX Software Systems GmbH & Co. KG.
• disable_sw_mixer
On cards that have only a single channel in hardware, do not
use software techniques to increase the maximum number
of playing channels.
See the list of shared objects (below) for details about local options for specific
drivers.
-v Increase the level of verbose output.
Description:
The io-audio manager provides support for dynamically loaded audio-driver
modules. This utility enables you to load the audio drivers specified by the -d options
when you start io-audio.
• You can start more than one driver by using multiple -d command-line options, but
don’t try to start more than one instance of io-audio.
Once io-audio has started, you can dynamically load and unload drivers using the
mount and umount commands. E.g. this command:
io-audio -dvortex -daudiopci &

gives the same result as this sequence:
io-audio &
mount -T io-audio vortex
mount -T io-audio audiopci
When searching for shared objects, the io-audio manager uses the
LD_LIBRARY_PATH environment variable.
To unload a module, use a command like this:
umount /dev/snd/controlC0
Examples:
Provide support for Aureal Vortex sound card:
io-audio -vv -d vortex &

© 2010, QNX Software Systems GmbH & Co. KG. io-audio
Files:
The io-audio command can load the following shared objects:
deva-ctrl-4dwave.so
Sound driver for the Trident 4DWave!.
deva-ctrl-audiopci.so
Sound driver for the AudioPCI chip family.
deva-ctrl-cs4281.so
Sound driver for the CS4281.
deva-ctrl-ess1938.so
Sound driver for the ESS1938.
deva-ctrl-geode.so
Sound driver for the National Semiconductor Geode family of chips.
deva-ctrl-i8x0.so
Sound driver for the Intel 8X0.
deva-ctrl-nmg6.so
Sound driver for the Neomagic 6 family of chips.
deva-ctrl-via686.so
Sound driver for the VIA686.
deva-ctrl-vortex.so
Sound driver for the Vortex.
deva-ctrl-ymfds1.so
Sound driver for the Yamaha DS1.
deva-mixer-ac97.so
Mixer DLL for the AC97 codec.
deva-ak4531.so
Mixer DLL for the AK4531 codec.
deva-util-restore.so
Shared object used to restore an audio driver’s state.
See also:

io-blk.so © 2010, QNX Software Systems GmbH & Co. KG.
Block I/O support
Syntax:
driver [blk option[,option...]] [fstype [options]]
Runs on:
Neutrino
Options:
The driver is one of the devb-* drivers, such as devb-eide, and option is one of the
options described below.
The optional fstype argument is one of the filesystem drivers (fs-*); you can follow it
with options specific to the filesystem.
Suffixes for size, memory, and time arguments

You can use suffixes on the arguments to some options to specify the units. These
suffixes aren’t case-sensitive.
For size arguments, the suffixes are:
• b — bytes
• k — kilobytes
• m — megabytes
• % — percent of the total amount of cache, etc., depending on the option
For memory arguments, the suffixes also include:
• g — gigabytes
• p — pages
For time arguments, the suffixes are:
• h — hours
• m — minutes
• s — seconds
blk options
You can specify the following options only in the blk section:
alloc=mode Set the cache/memory allocation policy to one of the following:

© 2010, QNX Software Systems GmbH & Co. KG. io-blk.so
• cache — allocate all of the buffer cache (the cache=size)

at startup, but allocate all other caches (e.g. names) on
demand and let them grow to their specified limit, and then
start removing the Least Recently Used (LRU) items.
• demand — allocate the buffer cache the same way,
on-demand (it will grow from 0 to the size specified by the
cache option as you access the disk).
• upfront — pregrow all caches to their full size. This
option can be useful in RAM-tuning a system, to see how
much memory the filesystem will eventually consume
(things such as the name and vnode caches tend to grow
over time).
The default is cache.
auto=amount Set the amount of automounting to be performed; amount is

one of:
• none — only raw block devices appear.
• partition — enumerate any partition tables.
The default is partition.
automount=dev[:mountpoint[:fstype[:options]]]
automount=@filename
Create a mountpoint for dev at mountpoint. If you don’t
specify a full path for the device, io-blk.so uses the value of
its devdir option as a prefix. For example, if devdir is /dev
(the default), an option of automount=hd0t77:/disk
mounts /dev/hd0t77 at /disk.
The optional fstype specifies the filesystem type, after which
you can set options. The choices of filesystem and the
associated shared objects are:
cd fs-cd.so
dos fs-dos.so
ext2 fs-ext2.so
mac fs-mac.so
nt fs-nt.so
qnx4 fs-qnx4.so
qnx6 fs-qnx6.so (Power-Safe filesystem)
udf fs-udf.so
If not specified, the library tries to determine the filesystem

automatically.

If the @filename version of this option is used, the automounts

are as specified in the given file. The file is a list of mounts
(using the same syntax as above), separated by newline
characters or commas.
You can’t locate the filename file in the filesystem to be automounted: it has to be
available in an existing filesystem such as the image filesystem. Optionally, you could
locate it in any devb filesystem that’s already running.
To mount multiple filesystems on a (removable) device, specify
that the device is shared with a + prefix. For example,
automount=+fd0:/dos/a:dos,automount=+fd0:/fd:qnx4
For a list of common partition types, see the Filesystems

chapter of the System Architecture guide.
cache=total[:hash] Specify the total size of the disk buffer cache. The buffer cache
is used as intermediate storage for all disk I/O, as well as
providing LRU caching for dirty delayed-write blocks and
recently-read blocks.
By default, 15% of system RAM is assigned, with a minimum
of 512 KB and a maximum of 512 MB. If you specify an
explicit size, bounds of 512 KB and 3 GB are applied.
Normally this cache is allocated at startup; if you specify
alloc=demand, or the initial allocation failed, then the cache
is dynamically grown as required up to the specified size.
The optional hash argument specifies the size of the buffer
cache hash list. You can specify any of the suffixes described
above. The default is 25% of the number of entries in the
cache.

• The default cache size is excessive for devb-fdc and

devb-ram. You’ll probably want to reduce it to the
minimum:
• In QNX Neutrino 6.5 and later, io-blk.so by default

allocates the filesystem buffer cache (blk cache=) on
affected ARM platforms from a global memory region
(SHMCTL_ANON | SHMCTL_GLOBAL) to avoid the
per-process 32 MB limitation. To override this and make
the allocation from the normal devb-* process heap,
specify blk memory=sysram.
delwri=delay1[:delay2[:postpone]]
Specify the delay time for write-behinds to the media. A dirty
disk block may remain in the cache without being physically
written to the disk, to improve performance. The default is up
to 3 seconds (delay1) for fixed media, and 1 second (delay2)
for removable media. For more information, see “Controlling
writing operations,” below.
The postpone argument specifies the number of seconds for
which to keep a dirty disk block in memory if it’s being
continuously modified, before physically writing it to the disk.
This applies only to fixed media; for removable media, writes
aren’t delayed beyond the delay2 period. By default, postpone
is the same as delay1.
devdir=path The directory in which io-blk presents the physical devices

as block-special files. The default is /dev.
devno=type Controls how major device numbers are requested; type is one
of:
• name — use the name of the device (e.g. hd, cd).
• class — use the CAM class of the device (e.g. direct,
readonly).
• common — use a single class for all block devices.
The default is name.
enumpart=order Set the order for enumerating disk partitions; one of the
following:
• forward — enumerate slots 1 through 4, followed by any
extended partitions.

• reverse — enumerate slots 4 through 1, followed by any

extended partitions.
• windows — enumerate the active partition, followed by
any extended partitions, and then non-booting primary
partitions. For more information about this order, see
http://support.microsoft.com/kb/q51978/.
The default is forward.
exclusive Require/obtain exclusive access of the mount device. This

means that when a filesystem is mounted on a partition,
nothing else is allowed to open that raw partition until the
filesystem is unmounted.
fdinfo=mode Specify the storing of open file names for the iofdinfo() query.
The options for mode are:
• ncache — try to reconstruct the file name from the
contents of the directory name cache. Don’t rely on this
option to supply the names of all open files (a file’s name is
supplied only if all components of its pathname are in the
name cache).
• always — store the name used in each open() call to
ensure that this name is always available.
• never — never supply the name of an open file.
The default is always.
map=size[:hash] Set the number of entries in a cache used to map translations

from logical blocks to physical ones. If this option isn’t
specified, the size is based in the value of the vnode option.
The hash argument specifies the size of the associated hash
list; the default is 1/6 of the number of entries in the map.
memory=type1[:type2[:type3[:type4]]]
Specify the typed memory pool or pools to use. For example,
memory=sysram&below4G:sysram says to try sysram with
the below4G modifier, and if no such region exists, then try
plain sysram. (The same option works on systems with more
or less than 4 GB of RAM.)

• It’s up to the startup to set up typed memory. Use pidin

syspage=asinfo to see the list.
• Generally you don’t need to specify the memory option, in
which case io-blk.so uses the normal mmap() pool; but
on a system with more than 4 GB of RAM, it’s mandatory.
• You might have to quote this option, in order to prevent the
shell from interpreting special characters such as an
ampersand (&).
For more information about typed memory, see “Typed

memory” in the Interprocess Communication (IPC) chapter of
the System Architecture guide.
mfu=segmentation Specify the MFU:MRU segmentation (typically as a

percentage, but it can be a size). You can specify any of the
suffixes described above. The default is a 50:50 split.
The first time a sector is accessed, it goes into the MRU (Most
Recently Used) region; if it’s accessed again, it goes into the
MFU (Most Frequently Used). The oldest cache blocks are
removed from either the MRU or MFU region, so as to
preserve this ratio.
naming=scheme Set the device/partition naming scheme. The default is 0#. For
more information, see “Naming schemes,” below.
ncache=size[:hash] Specify a name cache of size entries. Using more name cache
entries speeds up path/file lookups at the expense of memory.
Setting the size to 0 disables name caching. If this option isn’t
specified, the size is determined from the vnode option.
The hash argument specifies the size of the associated hash
list; the default is 1/6 of the size of the number of entries in the
name cache.
priority=prio Set the priority of periodic filesystem callouts. The default is

21.
ra=min[:max] Set the minimum and maximum sizes of the read-ahead

buffers. You can specify any of the suffixes described above.
The default minimum is the system page size; the default
maximum is 64 times the system page size.
ramdisk=size[:sector]
Create an internal ramdisk device (/dev/ramX) of the
specified size, with the specified sector size. The size and
sector variables can use the suffixes described above. The

sector size must be power of 2 in the range from 512 through

4096 bytes; the default is 512 bytes.
The initial contents of this memory device are unspecified, so you must format it
before using it as a filesystem (for example, with dinit for a QNX 4 filesystem).
rmvpoll=period The polling period for removable media. The default is 0

seconds.
rmvto=delay Specify a removable media timeout (default: 2 seconds). After

the specified period of inactivity, a disk access prompts
validation of the media with the driver; if the driver reports that
the media has been changed, all data blocks and cached
information for that device are discarded and relearned.
This option can take a value of none, which disables
removable media relearning. This isn’t very useful for real
removable devices (e.g. CDs), but if your device is on-board
SD, or USB that isn’t removable but the driver is advertising it
as such, you can disable the verification overheads.
thread=max[:low[:high]]
Set the thread pool parameters (maximum, low water, and high
water). The default is 12:2:5.
verbose[=level] Be verbose. The output is sent to the system logger, slogger.

The optional level argument is a series of alphabetic characters
that indicates the categories of event to log:
• b — bad blocks
• c — configuration
• d — direct I/O
• f — fsys module (fs-*)
• i — input
• o — output
• r — removable
• v — virtual filesystem (VFS)
An option of blk verbose means all (bcdfiorv), blk
verbose=io means input plus output, blk verbose=!r
means everything except removable, and so on. The default is
none.
vnode=size[:max] Specify the number of vnode entries (filesystem-independent

inodes) The default is 1024 entries. Up to size vnodes may be
active. Vnodes remain in this cache when the corresponding
file is closed, making subsequent opens faster.

The max argument allows a momentary large number files to

be open at the same time; the cache tries to stay at size entries,
but grows if needed up to max entries before giving an error of
ENFILE. The default value of max is 3 times size.
Filesystem options
You can apply the following options globally (in the blk section) or to a specific
filesystem (for example, in the qnx4 section for a QNX 4 filesystem):
after Mount the filesystem so that it’s resolved after any other
filesystems mounted at the same pathname (in other words, it’s
placed behind any existing mount). When you access a file, the
system looks on this filesystem last, and only if the file wasn’t
found on any other filesystems.
before Mount the filesystem so that it’s resolved before any other
placed in front of any existing mount). When you access a file,
the system looks on this filesystem first.
commit=level Set the committing level of the filesystem, which controls how
dirty system/user blocks are written to disk. The level is one of
none, low, medium (the default), and high. If it’s none, all
writes are time-delayed (as specified by the delwri option); at
high, all writes are performed synchronously. For more
information, see “Controlling writing operations,” below.
error=action Set the action to perform when a fs-* filesystem module detects
an internal error. The action is one of:
• ebadfsys — simply return EBADFSYS to the client.
• mountro — return EBADFSYS to the client and remount the
affected filesystem as read-only.
The default is ebadfsys.
marking=mode Set the filesystem-dirty marking behavior. The mode must be

none or mount (the default). If marking is on, the filesystem is
marked as being dirty when it’s mounted, and it’s marked as
being clean when it’s unmounted. The method of marking
depends on the filesystem.
[no]atime Update/don’t update the file’s directory entry if the only change
is the access time. The noatime option isn’t strict POSIX
1003.2 behavior, but it’s faster.
[no]creat Allow/don’t allow files to be created on this filesystem.
[no]exec Allow/don’t allow file execution from this filesystem.

[no]lock Lock/don’t lock removable media. If locked, the medium is

treated as fixed.
[no]rmv Don’t/do allow invalid mounts on removable media (re-insert).
[no]suid Ignore/don’t ignore the set-user ID bit on files in this filesystem.
ro Mount all drives/filesystems as read-only.
rw Mount all drives/filesystems as read-write (if the physical media

permit). This is the default.
For more information about the before and after options, see “Ordering
mountpoints” in the Process Manager chapter of the System Architecture guide.
Description:
The io-blk.so library provides block I/O support, as used by the devb-*, drivers,
and loads filesystem drivers (fs-*) as necessary.
The default values of the map and ncache options are based on the value of the
vnode option. This arrangement lets you configure a system by specifying the cache
size and the number of files, and letting the library set the other options.
Controlling writing operations

There are various types of writing operations:
Synchronous (SYNC)
Start immediately and wait for completion.
Asynchronous (ASYNC)
Start immediately but don’t wait for completion.
Delayed (DELWRI)
Don’t start until after a timeout period and then perform as
asynchronous. The blk delwri= option controls the timeout for the
delayed format; if you set this option to 0, a delayed writing operation
is the same as asynchronous.
As required Write only if you have to.
The types of data include:
User What you read() and write().
Metadata Things associated with stat(), such as times and IDs.
Filesystem Things such as bitmaps, extents, etc.

If a file has no links, the “as required” form of write operation is used, never going to
disk unless the buffer or cache is needed (since the file has no links, the data isn’t
expected to be accessible after a power failure). If you open a file with O_SYNC, the
synchronous format is always used.
Otherwise, the blk commit level controls the type of write to use for each level of
data:
commit= Filesystem data Metadata User data

none DELWRI DELWRI DELWRI
low ASYNC DELWRI DELWRI
medium SYNC DELWRI DELWRI
high SYNC SYNC SYNC
CAUTION: If you specify commit=none, you lose all write ordering (both for single
! multiblock updates and multiple-user operations). Hence, your chances of a useful
recovery following a power failure are poor. We recommend that you use this option
only if you have a uninterruptible power supply (UPS), or if you don’t mind using
dinit on your filesystem as a recovery tool.
Calling close() might force a metadata update, but does nothing to the user data.
Calling fsync() always forces out any delayed-write blocks for the file, and so is useful
only when commit isn’t high.
Naming schemes
You can use the naming=scheme option to specify the naming scheme to use for
devices and partitions. The format of scheme is as follows:
0# (where 0 is any digit and sets the first/base number)

The raw devices are named 0, 1, and so on, and partitions are named from the
device with a t followed by the OS type of the partition (see “Partitions” in the
Filesystems chapter of the System Architecture guide). For example, a QNX
partition could be named hd0t77.
For duplicate partitions, a period (.) and sequence number are appended (e.g.
hd0t12, hd0t12.1, and hd0t12.2 for logical/extended DOS partitions). This
is the QNX Neutrino naming scheme.
0a (actually any digit and any letter; these set the first/base name)
The raw devices are named 0,1,..., and partitions are named a, b, and so on (e.g.
/dev/hd0, /dev/hd0a, /dev/hd0b, /dev/hd0c, and so on). The name
doesn’t indicate the OS type of the partitions, just the order in which they were
found.

a1 (actually any letter and any digit; these set the first/base name)
The raw devices are named a, b, and so on. Primary partitions are named 1, 2, 3,
and 4; if you don’t have four of them, the unused numbers are skipped. Any
extended partitions are numbered without gaps from 5 (e.g. /dev/hda,
/dev/hda1, /dev/hda2, /dev/hda5, and so on).
The name doesn’t indicate the OS type of the partition, just its location. This is
the Linux naming scheme.
The default naming scheme is 0#.
CAUTION: Change to a different naming scheme at your own risk:

! • Some system components could have hard-coded assumptions about disk names.
• Don’t use a different scheme unless you’re in control of the entire system (e.g.
don’t change it in a desktop installation, where diskboot scans for well-known
hd0t77-style names).
• If you use a different scheme, you’ll need some external knowledge about what
filesystem to mount on a partition, because you won’t have the tXXX naming hint.
See also:
devb-*, fs-*, mount
Working with Filesystems chapter, and “Filesystems and block I/O (devb-*) drivers”
in the Fine-Tuning Your System chapter of the QNX Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. io-display
The QNX Graphics Framework server
Syntax:
io-display [-fv] [-d device] [-c config_file]
[-p priority]
Runs on:
Neutrino
Options:
-c Specify a path to the configuration file. The default is
/etc/system/config/display.conf. See below for the
configuration file’s format.
-d device Load the graphics driver specified by the device. These options must
match an entry in the io-display configuration file (see below).
The format of the device string is:
vid=[0x]vendor_id,did=[0x]device_id[,deviceindex=index]
Where:
vendor_id The vendor ID of the graphics device.

device_id The device ID of the graphics device.
index The index of the graphics device. If not specified, the
default is 0.
For PCI devices, you can use the pci utility to display PCI information about installed
graphics devices on a machine running Neutrino.
-f Ignore requests to wait for vertical synchronization coming from the

application. This is useful when measuring frame rates for
benchmarking purposes.
-p priority Set the priority of pulses to be used by device drivers, e.g. when
delivering interrupt events; io-display inherits the priority of
received pulses, which can cause priority inversion problems for client
applications that block on io-display. The default value is 21.
-v Be verbose.
Description:
The io-display manager provides support for direct rendering to graphics devices
using the QNX Graphics Framework and OpenGL ES by loading the driver specified
by the -d option.

io-display © 2010, QNX Software Systems GmbH & Co. KG.
Once io-display has started, applications can use the QNX Graphics Framework
library (libgf) and OpenGL ES libraries to acquire a graphics context and render to
the device.
QNX Graphics Framework applications must be privileged in order to run, since they
directly access the graphics hardware when rendering. This means they either have to
be run by root, or by a member of the display group. Applications that are a
member of the display group can directly access the graphics hardware, without
having supervisor (root) privileges.
There is one restriction however, which currently only applies to x86 systems. Some
drivers for older video devices may need to perform accesses to I/O mapped registers
when rendering. In this case, the thread performing the rendering will need to have I/O
privilege. In order to obtain I/O privilege, the process must run as root. A process with
I/O privilege on an x86 system does not have full superuser privileges, however, so the
extra requirement to run as root with some graphics devices introduces minimal risk.
The io-display configuration file

By default, the io-display configuration file is located in
/etc/system/config/display.conf, but you can put it in a different location
and use the -c option.
This file specifies global options, device-specific options, and display-specific options.
The file follows these conventions:
• Only one option is permitted on a line.

• Options are specified as name=value pairs.
• The file layout is hierarchical, with each section containing zero or more options,
and zero or more subsections.
• Subsections are contained within curly braces ({}).
The top-level section is device, which describes a graphics device. It has these
options and subsections:
noautoshutdown
Set to 1 to prevent the display from being turned off when all
applications exit. If not specified, the default 0 is used.
drivername A string describing the devg-* driver that io-display loads for
this device. The string must match the name of the driver. For
example, coral matches devg-coral.so.
vid The vendor ID, in hexadecimal. In the case of a PCI device, this is
the PCI vendor ID.
did The device ID, in hexadecimal. In the case of a PCI device, this is
the PCI device ID.

© 2010, QNX Software Systems GmbH & Co. KG. io-display
deviceindex The device index.
modeopts A string passed directly to the driver. For example, in the case of
the Coral driver, it can specify a configuration file with additional
hardware-specific settings.
display A subsection that describes one or more displays supported by the

device. This subsection has the following options and subsections:
• xres — the horizontal resolution of the display.
• yres — the vertical resolution of the display.
• refresh — the refresh rate of the display, in Hz.
• pixel_format — The pixel format of the display. Possible
pixel formats are:
- pal8 — 8 bpp
- argb1555 — 16 bpp
- rgb565 — 16 bpp
- rgb888 — 24 bpp
- argb8888 — 32 bpp
• photon — a subsection that includes Photon-specific options:
- enabled — 1 if Photon is enabled for this display, or 0 if it
isn’t.
- xoffset, yoffset — the x and y offsets for the display.
- layer — the layer index for the display.
- input_group — the input group for the display.
- cursor — the type of cursor; one of hardware,
software, or none.
- phook — a Photon hook module to load; one of:
ph-rotate-90.so Rotate the display 90 degrees.
ph-rotate-180.so
Rotate the display 180 degrees.
ph-rotate-270.so
Rotate the display 270 degrees.
You can also load a hook module by calling
PgPHookRegister(). For more information, see the Photon
Library Reference.
Here is a sample file:

device {
drivername=coral
vid=0x10cf
did=0x201e
deviceindex=0
display {
xres=640

io-display © 2010, QNX Software Systems GmbH & Co. KG.
yres=480
refresh=60
pixel_format=argb1555
}
}
device {
noautoshutdown=1
drivername=coral
vid=0x10cf
did=0x201e
deviceindex=0
modeopts=/usr/photon/config/coral.conf
display {
xres=640
yres=480
refresh=60
pixel_format=argb1555
}
}
The io-display server and Photon

When you want to run both GF/OpenGL ES and Photon applications, you must start
io-display before starting the Photon graphics server, io-graphics. In this
situation, io-graphics queries io-display for the display’s settings rather than its
own command-line settings. You can start Photon using the ph script on x86 targets;
on other targets you need to start Photon manually.
To start Photon:
1 Start io-display with the appropriate device and vendor IDs.
2 Set the environment variables required by Photon.
3 Start Photon.
4 Start io-graphics, without any command-line arguments.
By default, Photon runs on the display’s main layer. Therefore you should run GF and
OpenGL ES applications on a different layer.
Examples:
Start io-display, and load and initialize the driver for the Fujitsu Coral PA chipset:
io-display -dvid=0x10cf,did=0x201e
The driver, devg-coral.so, is loaded by io-display, and the initial display

resolution is 640×480×15 at 60Hz.
See also:
io-graphics, dispconf

© 2010, QNX Software Systems GmbH & Co. KG. io-graphics
Photon graphics server subsystem
Syntax:
io-graphics [-aCehLlv] [-c file]
[-d vid=vid,did=did[,deviceindex=index]*]
[-f global|local|none ] [-n name] [-P priority]
[-p num_points] [-w size]
Runs on:
Neutrino
Options:
-a Enable anti-aliasing on polylines (currently only for diagonal lines
of width 1). This anti-aliasing is only for CRT or LCD (video)
targets, not printer targets.
-C Allocate all client-side surfaces for CPU Fast Access.

You should use this option in a system that uses a rotation module,
since access to the framebuffer is required; without this option,
access is made over the bus, introducing serious latency. Some
performance will be lost when a rotation module isn’t loaded, but
the benefits drastically outweigh the drawbacks.
-c file The configuration file to load. The default is

/etc/system/config/display.conf. For more information
about this file, see the documentation for io-display.
-d vid=<vid> did=<did> [, deviceindex=<index>]
The driver_options are:
vid=vid The PCI Vendor ID of the graphics device.

did=did The PCI Device ID of the graphics device.
deviceindex=index
The device index.
-e Don’t emit an expose event when a Photon region is created.
-f mode Set the mode of operation for the font service; one of the
following values:
global Run the global font server.

local Run the local font server.
none Connect to an existing font server. This mode is useful
if you run a standalone font server.

io-graphics © 2010, QNX Software Systems GmbH & Co. KG.
-h For HW Wait Idle calls, wait only for the specified video card; the
default behavior is to wait for all cards in use.
-L Force a PHOOK module (see the phook option in the

configuration file for io-display) to initialize, even though the
GPU driver was written with non-linear framebuffer access. Some
PHOOK modules refuse to initialize if the framebuffer isn’t linear.
There are some GPU drivers that are written with a non-linear
interface, even though the framebuffer is linear, and this option is
provided to accommodate those GPU drivers.
-l (“el”) Prevent other layers from attaching to a layer used by

Photon (lock it).
-n name Specify the Photon server name. Default is /dev/photon.
-P priority The priority at which to start io-graphics (default: 12).
-p num_points Render layer number of polygon points (default 2048).
-v Be verbose.
-w size Set the buffer size for the render library workspace (default: 300
KB). The size can include a case-insensitive suffix of K or M.
Description:
The io-graphics command starts a graphics driver.
io-graphics configuration options

The io-graphics utility configuration options are contained within the io-display.
Refer to the io-display documentation for more information about io-graphics
configuration options.
Files:
The devg-* drivers generally require libffb.so.2 and libdisputil.so.2 at
runtime.
PHFONT_USE_EXTERNAL
If this environment variable exists, io-graphics does not run an internal font
server. You should set this environment variable for systems that have remote
clients accessing font services on the host machine (e.g. phindows, phditto).

© 2010, QNX Software Systems GmbH & Co. KG. io-graphics
See also:
io-display, dispconf

io-hid © 2010, QNX Software Systems GmbH & Co. KG.
Manager for human-interface devices (HID)
Syntax:
io-hid [-n name] -d driver [driver_options]... [-v] [-V] &
Runs on:
Neutrino
Options:
Load the specified driver and pass it the given driver_options. For
information on the drivers and their syntax and options, see the devh-*
entries:
Driver Shared object

usb devh-usb.so
ps2ser devh-ps2ser.so
-n name Set the server name. The default is /dev/io-hid/io-hid.
-V Display server version.
-v Be verbose.
Description:
The io-hid manager provides support for input devices and input clients. You can
load drivers when you start io-hid by specifying the -d command-line option.
Clients such as devc-con and devi-hid connect to io-hid and interact with
human-interface devices through io-hid.
You can start more than one driver by using multiple -d command-line options.
Once io-hid has started, you can dynamically load and unload modules using the
mount and umount commands.
The io-hid manager uses the LD_LIBRARY_PATH environment variable when
searching for the shared objects. If LD_LIBRARY_PATH is not set, or the shared
object in question isn’t in one of its directories, or you want to override the default,
specify the full path in the mount command.

© 2010, QNX Software Systems GmbH & Co. KG. io-hid
Examples:
Load USB HID devices, PS/2 mouse, serial mouse on COM1 directly, and a PS/2
keyboard:
io-hid -dusb -dps2ser \

ps2mouse:mousedev:msoft:uart,1:kbd:kbddev &
or use this sequence of commands to do the same thing:
io-hid &
mount -T io-hid devh-usb.so
mount -T io-hid devh-ps2ser.so \
ps2mouse:mousedev:msoft:uart,1:kbd:kbddev
Unload a module:
umount /dev/io-hid/devh-usb
See also:
devc-con-hid, devh-usb.so, devh-ps2ser.so, devh-*, devi-hid, hidview,
mount, umount

io-pkt-v4, io-pkt-v4-hc, io-pkt-v6-hc © 2010, QNX Software Systems GmbH
& Co. KG.
Networking manager
Syntax:
io-pkt-variant [-d driver [driver_options]] [-i instance]
[-p protocol [protocol_options]] [-t threads] [-v]
Runs on:
Neutrino
Options:
Start the specified devn-* or devnp-* driver:
• You can specify driver without the devn- or devnp- prefix or the
.so extension. For example, to start the devnp-i82544.so
driver, specify -d i82544. If you specify the driver this way,
io-pkt* looks for a devnp- version first. If there isn’t one,
io-pkt* loads the legacy io-net (devn-) version, using a
special “shim” layer, devnp-shim.so.
• If you want to load a specific version of a driver, specify the full
path of the module (e.g. /lib/dll/devn-i82544.so).
The driver_options argument is a list of driver-specific options that
the stack passes to the driver.

The stack processes various driver options; for more information, see “Generic driver
options,” below.
-i instance The stack instance number, which is useful if you’re running multiple
instances of io-pkt. The io-pkt manager will service mount
requests of type io-pktX, where X is the instance number. For
example:
io-pkt-v4 -i1 -ptcpip prefix=/alt
mount -Tio-pkt1 /lib/dll/devnp-i82544.so
-p protocol [protocol_options]
The protocol to start, followed by a list of protocol-specific options.
The available protocols include:

© 2010, QNX Software Systems GmbH & Co. KG. io-pkt-v4, io-pkt-v4-hc,
io-pkt-v6-hc
Protocol Module
autoip lsm-autoip.so
qnet lsm-qnet.so
tcpip The stack includes TCP/IP; you need to specify this
protocol only if you want to pass additional parameters (e.g.
prefix=) to it. For more information about the options,
see below.
-S Don’t register a SIGSEGV handler to quiesce the hardware if a

segmentation violation occurs. This can help with debugging if it isn’t
possible to get a backtrace to the original code that generated the
SIGSEGV through the signal handler.
-t threads The number of processing threads to create. By default, one thread is

created per CPU. These threads are the packet-processing threads that
operate at Layer2 and may become the stack thread. For more
information, see the Overview chapter of the QNX Neutrino Core
Networking User’s Guide.
-v If any errors occur while loading drivers and protocols, io-pkt sends
messages to slogger. If you specify this option, io-pkt also
displays them on the console.
If you specify the -p tcpip protocol, the protocol_options list can consist of one or
more of the following, separated by commas without whitespace:
bigpage_strict If the value of the pagesize option is bigger than

sysconf(_SC_PAGESIZE), it’s used only for the mbuf and
cluster pools unless you also specify this option, in which case
the page size is used for all pools.
cache=0 Disable the caching of packet buffers. This should be needed

only as a debugging facility.
confstr_monitor Monitor changes to configuration strings, in particular

CS_HOSTNAME. By default, io-pkt gets the hostname once at
startup.
enmap Prevent automatic stack mapping of enXX interface names to

the actual interface names. By default, the stack automatically
maps the first registered interface to en0 (if a real en0 isn’t
present), the second interface to en1, and so on, in order to
preserve backwards compatibility with io-net-style command
lines.

& Co. KG.
fastforward=X Enable (1) or disable (0) fastforwarding path. This is useful for
gateways. This option enables, and is enabled by, forward; to
enable only forward, specify forward,fastforward=0.
forward Enable forwarding of IPv4 packets between interfaces; this

enables fastforward by default. The default is off.
forward6 (io-pkt-v6-hc only) Enable forwarding of IPv6 packets

between interfaces; off by default.
ipsec (io-pkt-v4-hc and io-pkt-v6-hc only) Enable IPsec

support; off by default.
mbuf_cache=X As mbufs are freed after use, rather than returning them to the
internal pool for general consumption, up to X mbufs are
cached per thread to allow quicker retrieval on the next
allocation.
mclbytes=size The mbuf cluster size. A cluster is the largest amount of

contiguous memory used by an mbuf. If the MTU is larger than
a cluster, multiple clusters are used to hold the packet. The
default cluster size is 2 KB (to fit a standard 1500-byte Ethernet
packet).
Specifying the cluster size can improve performance; for more
information, see “Jumbo packets and hardware checksumming”
in the Network Drivers chapter of the QNX Neutrino Core
Networking User’s Guide.
pagesize=X The smallest amount of data allocated each time for the internal
memory pools. This quantum is then carved into chunks of
varying size, depending on the pool.
pkt_cache=X As mbuf and cluster combinations are freed after use, rather
than return them to the internal pool for general consumption,
up to X mbufs and clusters are cached per thread to allow
quicker retrieval on the next allocation.
pkt_typed_mem=object
Allocate packet buffers from the specified typed memory
object. For example:
io-pkt -ptcpip pkt_typed_mem=ram/dma
prefix=/path The path to prepend to the traditional /dev/socket. The is

useful when running multiple stacks. Clients can target a
particular stack by using the SOCK environmental variable.
For example:

io-pkt-v6-hc
# io-pkt -ptcpip prefix=/alt
# SOCK=/alt ifconfig -a
random Use /dev/random as the source of random data. By default,

io-pkt uses a builtin pseudo-random number generator.
recv_ctxt=X Specify the size of the receive context buffer, in bytes. The
default is 65536; the minimum is 2048.
reuseport_unicast
If using the SO_REUSEPORT socket option, received unicast
UDP packets are delivered to all sockets bound to the port. The
default is to deliver only multicast and broadcast to all sockets.
rx_prio=X
rx_pulse_prio=X The priority for receive threads to use (the default is 21). A
driver-specific priority option (if supported by the driver) can
override this priority.
somaxconn=X Specify the value of SOMAXCONN, the maximum length of the

listen queue used to accept new TCP connections. The
minimum is the value in <sys/socket.h>.
stacksize=X Specify the size of each thread’s stack, in bytes. The default is
4096.
threads_incr=X If the supply of threads is exhausted, increment their number by

this amount, up to the value of threads_max. The default is
25.
threads_max=X Specify the maximum number of threads. The default is 200.
threads_min=X Specify the minimum number of threads. The default is 15, and
the minimum is 4.
Description:
The io-pkt manager provides support for Internet domain sockets, Unix domain
sockets, and dynamically loaded networking modules. It comes in several stack
variants:
io-pkt-v4 An IPv4 memory-reduced variant which doesn’t support:

• IPv6
• Crypto / IPSec
• 802.11 a/b/g WiFi
• Bridging

& Co. KG.
• GRE / GRF
• Multicast routing
• Multipoint PPP
io-pkt-v4-hc IPv4 version of the stack that has full encryption and Wi-Fi
capability built in and includes hardware accelerated
cryptography capability (Fast IPsec).
io-pkt-v6-hc IPv6 version of the stack (includes IPv4 as part of v6) that has
full encryption and Wi-Fi capability, also with hardware
accelerated cryptography.
You can use the mount command to start drivers after you’ve launched io-pkt*. If
you want to pass options to the driver, use the -o option before the name of the shared
object. For example:
mount -T io-pkt -o mac=12345678 devnp-bge.so
• You can use umount to unmount legacy io-net drivers, but not io-pkt* drivers.
Other drivers may allow you to detach the driver from the stack, by using
ifconfig’s destroy command (if the driver supports it).
• If io-pkt runs out of threads, it sends a message to slogger, and anything that
requires a thread blocks until one becomes available.
• Native io-pkt and ported NetBSD drivers don’t put entries into the
/dev/io-net namespace, so a waitfor command for such an entry won’t work
properly in buildfiles or scripts. Use if_up -p instead; for example, instead of
waitfor /dev/io-net/en0, use if_up -p en0.
• If a TCP/IP packet is smaller than the minimum Ethernet packet size, the packet
may be padded with random data, rather than zeroes.
Generic driver options

The stack processes a generic name= option that lets you override the default interface
prefix used for network drivers. For example:
io-pkt-v4 -di82544 name=en
starts the devnp-i82544.so driver with the io-net-style interface naming

convention (enXX). You can also use this option to assign interface names based on
(for example) functionality:
io-pkt-v4 -di82544 pci=0,name=wan

io-pkt-v6-hc
This option doesn’t work with legacy io-net legacy drivers. If you attempt to use this
option with a devn- driver, the driver won’t be loaded, and the log will include an
“unknown option” error.
The stack also processes the following driver options for all USB drivers using the
NetBSD-to-QNX conversion library to let you identify a particular USB device using
information obtained from running usb -v:
did=ID Device product ID.
vid=ID Device vendor ID.
devno=addr Device address, as reported by the usb utility.
busno=num Host controller, as reported by the usb utility
For example:
io-pkt-v4-hc -drum did=0x0020,vid=0x13b1,devno=1,busno=1
Examples:
Start the v4 TCP/IP variant of io-pkt using the devnp-bcm1250.so driver on
BCM91480A eth0:
io-pkt-v4 -d /lib/dll/devnp-bcm1250.so \
memrange=0x10064000,irq=0x80050024,mac=001122334455
ifconfig bcm0 10.184
See also:
devn-*, devnp-*, ifconfig, lsm-autoip.so, lsm-qnet.so, mount, umount

io-usb © 2010, QNX Software Systems GmbH & Co. KG.
Server for universal serial bus (USB)
Syntax:
io-usb [-d dll [opts] ] [-n name] [-P priority]... [-V] [-v]
Runs on:
Neutrino
Options:
-c Do not select a device configuration if the device has more than one
configuration. See “Selecting a driver configuration” below.
-d dll [opts] Load the specified host controller DLL and opts and pass it the dll.
For information on the drivers and their syntax and options, see the
devu-* entries.
-n name Set the server name. The default is /dev/io-usb/io-usb.
-P priority The priority to use for the server; the default is 21.
-V Display server version and exit.
-v Be verbose.
Description:
The io-usb server contains USB protocols and communicates with clients (class
drivers). The USB stack is a server/dll interface which the server uses to load the
DLLs that manage the USB chips. You can load drivers when you start io-usb by
specifying the -d command-line option.
You can start more than one driver by using multiple -d command-line options.
Once io-usb has started, you can dynamically load and unload modules using the
mount and umount commands.
The io-usb controller uses the LD_LIBRARY_PATH environment variable when
searching for the shared objects. If LD_LIBRARY_PATH is not set, or the shared
object in question isn’t in one of its directories, or you want to override the default,
specify the full path in the mount command.
For example, to mount the EHCI (high speed) USB driver:
mount -Tio-usb devu-ehci.so /dev/io-usb/io-usb

to mount the OHCI (full/low speed) USB driver:

© 2010, QNX Software Systems GmbH & Co. KG. io-usb
mount -Tio-usb devu-ohci.so /dev/io-usb/io-usb
to mount the UHCI (full/low speed) USB driver:
mount -Tio-usb devu-uhci.so /dev/io-usb/io-usb
Selecting a driver configuration
The -c should be used in conjunction with a launcher application, such as enum-usb,

which choose a driver’s configuration before launching the driver to manage a device’s
interfaces.
A launcher application must choose a default configuration for devices with more than
one configuration, or these devices will not function:
• If you specify the -c option, io-usb will not select a device’s configuration,
leaving the configuration selection to the launcher application.
• If you do not specify the -c option, io-usb will automatically select the device’s
first configuration.
Some devices may not be able to switch the configuration once an initial configuration
is selected.
Examples:
Start the USB 2.0 stack and USB drivers:
io-usb -dehci -dohci -duhci
or use this sequence of commands to do the same thing:
io-usb &
mount -T io-usb devu-ehci.so /dev/io-usb/io-usb
mount -T io-usb devu-ohci.so /dev/io-usb/io-usb
mount -T io-usb devu-uhci.so /dev/io-usb/io-usb
Unload a module:
umount /dev/io-usb/devu-ehci.so
See also:
devu-ehci.so, devu-ohci.so, devu-uhci.so, devu-*, mount, umount, usb

join © 2010, QNX Software Systems GmbH & Co. KG.
Merge sorted files (POSIX)
Syntax:
join [-1 n] [-2 n]
[-a file_number] [-e string]
[-j file_number n]
[-o list] [-t char] [-v file_number]
file1 file2
Runs on:
Neutrino
Options:
Options -a, -j, and -v use the file_number argument. Specify 1 to refer to file1, or 2
to refer to file2.
-1 n (One) Join on the nth field of file1. Fields are numbered, starting
with 1.
-2 n Join on the nth field of file2. Fields are numbered, starting with
1.
-a file_number In addition to the default output, produce a line for every

unpairable line in file file_number. If both -a 1 and -a 2 are
specified, both sets of information are output, and information
for -a 2 is always printed first.
-e string Replace empty output fields by the string string.
-j file_number n (Obsolescent) Join on the nth field of file file_number. If

file_number is neither 1 nor 2 (e.g. -j 0 3), use the nth field in
both files. Fields are numbered, starting with 1.
Use options -1 and -2 in place of option -j.
-o list Produce output in which each line comprises the fields specified
in list. Each entry in list has the form:
file_number.field
where field is a field number. You can use a space or a comma to
separate entries.
Output is written only for lines with matching join fields. The
join field isn’t written unless it’s included in list.
-t char Use the character char as a separator, for both input and output.
Every appearance of char in a line is significant. When this
option is specified, the collating sequence should be the same as
that produced by sort, without the -b option.
-v file_number Instead of the default output, produce a line only for every
unpairable line in file_number.

© 2010, QNX Software Systems GmbH & Co. KG. join
file1 file2 The names of the text files. If either file1 or file2 is -, the
Description:
The join utility forms a “join” of the two relations specified by the lines of file1 and
file2. The join is written to the standard output.
The files file1 and file2 are compared on the basis of a “join field” found in both files.
For every pair of lines in file1 and file2 that have identical join fields, join prints one
output line. The output line normally consists of the join field, followed by the rest of
the line from file1 and then the rest of the line from file2. By default, the join field is
the first field in each line.
Both file1 and file2 should be sorted in an increasing collating sequence on their join
fields (i.e. the same sequence performed by sort -b). Otherwise, some field matches
may not be reported. Note, however, that when option -t is specified, the collating
sequence should be the same as that produced by sort, without the -b option.
The default input field separators are blanks. In this case, multiple separators count as
one field separator; leading separators are ignored. The default output field separator is
a space.
Examples:
Join the password file and group file, matching on the numeric group ID and
outputting the login name, group name, and login directory. It’s assumed that the files
have been sorted in collating sequence on the group ID fields.
join -1 4 -2 3 -o 1.1 2.1 1.6 -t: /etc/passwd /etc/group
Exit status:
See also:
gawk, sort, uniq

kill © 2010, QNX Software Systems GmbH & Co. KG.
Terminate or signal processes (POSIX)
Syntax:
kill [-n node] [-signal_name | -signal_number] pid...
kill -l
Runs on:
QNX Neutrino
Options:
-signal_name The name of the signal to be sent to the specified process. Values
of signal_name are recognized in case-independent fashion, with
or without the SIG prefix.
-signal_number (Deprecated) A nonnegative decimal integer representing the

signal to be sent to the specified process.
-l (“el”) Don’t send signals. List possible values for signal_name.
-n node Kill the process on the specified node. This option isn’t available
in the shell builtin version of kill.
pid A decimal integer specifying a process or process group to be

signaled. A positive number pid is a process ID. A negative
number pid has its absolute value taken as a process group ID.
The signal is sent to all processes belonging to the group.
A pid of zero sends the signal to all processes owned by the user
in the current shell’s process group.
CAUTION: Don’t use a pid of zero when logged on as root. Signalling all the
! background processes owned by superuser and any current superuser foreground
processes (e.g. backups in progress) may produce unpredictable results.
Description:
The kill utility sends a signal to the process(es) specified by each pid operand. By
default, kill sends the SIGTERM signal, but you may override this default by naming
a signal to be sent.
To print the list of signals that may be sent, use kill with the -l option:
kill -l

© 2010, QNX Software Systems GmbH & Co. KG. kill
The kill command is available both as a standalone utility and as a shell builtin. To
make sure that you’re using the utility, specify the full path. For information about the
builtin command, see esh and ksh.
Examples:
Any of the commands:
kill -9 100 -16
kill -sigkill 100 -16
kill -KILL 100 -16
sends the SIGKILL signal to the process whose process ID is 100 and to all processes
whose process group ID is 16, assuming the sending process has permission to send
that signal to the specified processes, and that they exist.
Exit status:
0 At least one matching process was found for each pid option, and the specified
signal was successfully sent to each matching process.
Caveats:
Some shells include a builtin kill command. To make sure you’re using the kill
utility, specify the the full path to it.
See also:
esh, ksh, pidin

ksh © 2010, QNX Software Systems GmbH & Co. KG.
Public domain Korn shell command interpreter (UNIX)
Syntax:
ksh [+-abCefhikmnprsuvxX] [+-o option]
[ [ -c command-string [command-name]
| -s | file ] [argument...] ]
Runs on:
Options:
You can specify the following options only on the command line:
-c command-string
Execute the command(s) contained in command-string.
-i Use interactive mode.
-l Login shell; also implies interactive mode.
-s The shell reads commands from standard input; all non-option arguments are
positional parameters.
-r Use restricted mode.
In addition to the above, you can use the options described for the set builtin
command on the command line.
Description:
The ksh is a public-domain version of the Korn shell. It’s a command interpreter
that’s intended for both interactive and shell script use.
This shell isn’t the same as the standard QNX 4 shell, which was modeled after
ksh86.
Shell startup
If neither the -c nor the -s option is specified, the first non-option argument specifies
the name of a file the shell reads commands from; if there are no non-option
arguments, the shell reads commands from standard input. The name of the shell (i.e.
the contents of the $0 parameter) is determined as follows: if the -c option is used and
there’s a non-option argument, it’s used as the name; if commands are being read from
a file, the file is used as the name; otherwise the name the shell was called with (i.e.
argv[0]) is used.
A shell is interactive if the -i option is used or if both standard input and standard
error are attached to a tty. An interactive shell has job control enabled (if available),

© 2010, QNX Software Systems GmbH & Co. KG. ksh
ignores the SIGINT, SIGQUIT and SIGTERM signals, and prints prompts before
reading input (see PS1 and PS2 parameters). For noninteractive shells, the trackall
option is on by default (see the set command below).
A shell is restricted if the -r option is used or if either the basename of the name the
shell is invoked with or the SHELL parameter match the pattern *r*sh (e.g. rsh,
rksh, and so on). The following restrictions come into effect after the shell processes
any profile and $ENV files:
• The cd builtin command is disabled.

• The SHELL, ENV and PATH environment variables can’t be changed.
• Command names can’t be specified with absolute or relative paths.
• You can’t use the -p option of the command builtin command.
• Redirections that create files can’t be used (i.e. >, >>|, >>, <>).
A shell is privileged if the -p option is used or if the real userid or group ID doesn’t
match the effective userid or group ID (see getuid(), and getgid()). A privileged shell
doesn’t process $HOME/.profile or the ENV environment variable (see below);
instead it processes the /etc/suid_profile file. Clearing the privileged option
causes the shell to set its effective userid (group ID) to its real userid (group ID).
If the basename of the name the shell is called with (i.e. argv[0]) starts with - or if the
-l option is used, the shell is assumed to be a login shell, and the shell reads and
executes the contents of /etc/profile and $HOME/.profile if they exist and
are readable.
If the ENV environment variable is set when the shell starts (or, in the case of login
shells, after any profiles are processed), its value is subjected to parameter, command,
arithmetic and tilde substitution and the resulting file (if any) is read and executed. If
ENV isn’t set (and not null) and ksh was compiled with the DEFAULT_ENV macro
defined, the file named in that macro is included (after the above mentioned
substitutions have been performed).
The exit status of the shell is 127 if the command file specified on the command line
couldn’t be opened, or nonzero if a fatal syntax error occurred during the execution of
a script. In the absence of fatal errors, the exit status is that of the last command
executed, or zero, if no command is executed.
Command syntax
The shell begins parsing its input by breaking it into words. Words, which are
sequences of characters, are delimited by unquoted whitespace characters (space, tab
and newline) or meta-characters (<, >, |, ;, &, ( and )). Aside from delimiting words,
spaces and tabs are ignored, while newlines usually delimit commands. The
meta-characters are used in building the following tokens:
<, <&, <<, >, >&, >>, and so on.

Specify redirections (see “Input/output redirection,” below).

| Creates pipelines.
|& Creates coprocesses (see “Coprocesses,” below).
; Separates commands.
& Creates asynchronous pipelines.
&& and || Specify conditional execution.
;; Used in case statements.
(( .. )) Used in arithmetic expressions.
( .. ) Create subshells.
You can quote whitespace and meta-characters individually using backslash (\), or in
groups using double (") or single (’) quotes. Note that the following characters are
also treated specially by the shell and you must quote them if they’re to represent
themselves:
\, ", ’ Quoting characters.
# If used at the beginning of a word, introduces a comment — everything

after the # up to the nearest newline is ignored.
An exception occurs when # is followed by !shell. This allows you to
run a script using an alternative shell interpreter. E.g. if you have a C
shell in /bin/csh, you can tell ksh to run your scripts using the C
shell by starting the scripts with this:
#!/bin/csh
$ Introduces parameter, command and arithmetic substitutions (see

“Substitution,” below).
‘ Introduces an old-style command substitution (see “Substitution,”

below).
˜ Begins a directory expansion (see “Tilde expansion,” below);
{ and } Delimit csh-style alternations (see “Brace expansion,” below).
*, ? and [ Used in filename generation (see “Filename patterns,” below).
As words and tokens are parsed, the shell builds commands, of which there are two
basic types: simple commands, typically programs that are executed, and compound
commands, such as for and if statements, grouping constructs and function
definitions.

A simple command consists of some combination of parameter assignments (see

“Parameters,” below), input/output redirections (see “Input/output redirection,”
below), and command words; the only restriction is that parameter assignments come
before any command words. The command words, if any, define the command that’s
to be executed and its arguments. The command may be a shell builtin command, a
function or an external command, i.e. a separate executable file that’s located using the
PATH parameter (see “Command execution and builtin commands,” below). Note that
all command constructs have an exit status:
• For external commands, this is related to the status returned by wait() (if the
command couldn’t be found, the exit status is 127, if it couldn’t be executed, the
exit status is 126).
• The exit status of other command constructs (builtin commands, functions,

compound commands, pipelines, lists, and so on) are all well defined and are
described where the construct is described.
The exit status of a command consisting only of parameter assignments is that of the
last command substitution performed during the parameter assignment, or zero if there
were no command substitutions.
The ? special parameter stores the exit status of the last nonasynchronous command.
For example, you can display the exit status by typing:
echo $?
For more information, see “Parameters,” below.
You can chain commands together using the | token to form pipelines in which the
standard output of each command but the last is piped (see pipe()) to the standard input
of the following command. The exit status of a pipeline is that of its last command.
You can prefix a pipeline with the ! reserved word, which causes the exit status of the
pipeline to be logically complemented: if the original status is 0 the complemented
status is 1, and if the original status isn’t 0, then the complemented status is 0.
You can create lists of commands by separating pipelines by any of the following
tokens:
&&, || Conditional execution: cmd1 && cmd2 executes cmd2 only if the exit status
of cmd1 is zero; || is the opposite — cmd2 is executed only if the exit
status of cmd1 is nonzero.
The && and || tokens have equal precedence, which is higher than that of
&, |& and ;, which also have equal precedence.
& Causes the preceding command to be executed asynchronously, that is, the
shell starts the command, but doesn’t wait for it to complete (the shell does
keep track of the status of asynchronous commands — see “Job control,”
below). When an asynchronous command is started when job control is

disabled (i.e. in most scripts), the command is started with signals INT and
QUIT ignored and with input redirected from /dev/null (however,
redirections specified in the asynchronous command have precedence).
|& Starts a coprocess, which is special kind of asynchronous process (see

“Coprocesses,” below).
; Sequential execution: cmd1 ; cmd2 executes cmd1, and then executes

cmd2 when the first command is done.
Note that a command must follow the && and || operators, while a command need not
follow &, |& and ;. The exit status of a list is that of the last command executed, with
the exception of asynchronous lists, for which the exit status is 0.
Compound commands
Compound commands are created using the following reserved words. These words
are recognized only if they’re unquoted and are used as the first word of a command
(i.e. you can’t put any parameter assignments or redirections before them):
case else function then !

do esac if time [[
done fi in until {
elif for select while }
Some shells (but not this one) execute control structure commands in a subshell when
one or more of their file descriptors are redirected, so any environment changes inside
them may fail. To avoid problems with portability, you should use the exec statement
instead to redirect file descriptors before the control structure.
In the following compound command descriptions, command lists (denoted as list)

that are followed by reserved words must end with a semicolon, a newline or a
(syntactically correct) reserved word. For example, these are valid:
{ echo foo; echo bar; }

{ echo foo; echo bar<newline>}
{ { echo foo; echo bar; } }
but this isn’t:
{ echo foo; echo bar }
The commands are:
( list ) Execute list in a subshell. There’s no implicit way to pass

environment changes from a subshell back to its parent.
{ list } Compound construct; list is executed, but not in a subshell.

Note that { and } are reserved words, not meta-characters.

case word in [ [(] pattern [| pattern]...) list ;; ] ... esac

The case statement attempts to match word against the
specified patterns; the list associated with the first successfully
matched pattern is executed.
Patterns used in case statements are the same as those used for
filename patterns, except that the restrictions regarding . and /
are dropped. Note that any unquoted space before and after a
pattern is stripped; you must quote any space within a pattern.
Both the word and the patterns are subject to parameter,
command, and arithmetic substitution as well as tilde
substitution.
For historical reasons, you can use open and close braces
instead of in and esac (e.g. case $foo { *) echo bar;
}).
The exit status of a case statement is that of the executed list; if
no list is executed, the exit status is zero.
for name [ in word ... term ] do list done
For each word in the specified word list (where term is either a
newline or a ;), the parameter name is set to the word and list is
executed. If in isn’t used to specify a word list, the positional
parameters ($1, $2, and so on) are used instead.
instead of do and done (e.g. for i; { echo $i; }).
The exit status of a for statement is the last exit status of list; if
list is never executed, the exit status is zero.
if list then list [elif list then list] ... [else list] fi
If the exit status of the first list is zero, the second list is
executed; otherwise the list following the elif, if any, is
executed with similar consequences. If all the lists following the
if and elif clauses fail (i.e. exit with nonzero status), the list
following the else is executed.
The exit status of an if statement is that of the nonconditional
list that’s executed; if no nonconditional list is executed, the exit
status is zero.
select name [ in word ... term ] do list done
The select statement provides an automatic method of
presenting the user with a menu and selecting from it. An
enumerated list of the specified words (where term is either a
newline or a ;) is printed on standard error, followed by a
prompt (PS3, normally "#? "). A number corresponding to
one of the enumerated words is then read from standard input,
name is set to the selected word (or is unset if the selection isn’t

valid), REPLY is set to what was read (leading/trailing spaces

are stripped), and list is executed.
If you enter a blank line (i.e. zero or more IFS characters), the
menu is reprinted without executing list. If REPLY is null
when list completes, the enumerated list is printed, the prompt
is printed and so on. This process is continues until an
end-of-file is read, an interrupt is received or a break statement
is executed inside the loop. If in word . . . is omitted, the
positional parameters are used (i.e. $1, $2, and so on).
instead of do and done (e.g. select i; { echo $i; }).
The exit status of a select statement is zero if a break
statement is used to exit the loop, nonzero otherwise.
until list do list done

This works like while, except that the body is executed only
while the exit status of the first list is nonzero.
while list do list done
A while is a prechecked loop. Its body is executed as often as
the exit status of the first list is zero. The exit status of a while
statement is the last exit status of the list in the body of the loop;
if the body isn’t executed, the exit status is zero.
function name { list }

Define the function name. See “Functions,” below. Note that
redirections specified after a function definition are performed
whenever the function is executed, not when the function
definition is executed.
name () command Mostly the same as function. See “Functions,” below.
(( expression )) Evaluate the arithmetic expression expression; equivalent to

let "expression". See “Arithmetic expressions” and the let
builtin command below.
[[ expression ]] Similar to the test and [ ... ] builtin commands

(described later), with the following exceptions:
• Field splitting and filename generation aren’t performed on
arguments.
• The -a (and) and -o (or) operators are replaced with && and
||, respectively.
• You must leave operators (e.g. -f, =, !, and so on) unquoted.
• The second operand of != and = expressions are patterns
(e.g. the comparison in [[ foobar = f*r ]] succeeds).

• There are two additional binary operators, < and > that return
true if their first string operand is less than or greater than
their second string operand.
• The single argument form of test, which tests if the
argument has nonzero length, isn’t valid; you must always
use explicit operators. For example, instead of:
[ str ]
use:
[[ -n str ]]
• Parameter, command and arithmetic substitutions are

performed as expressions are evaluated and lazy expression
evaluation is used for the && and || operators. This means
that in the statement:
[[ -r foo && $(< foo) = b*r ]]
the $(< foo) is evaluated if and only if the file foo exists
and is readable.
Quoting
Quoting is used to prevent the shell from treating characters or words specially:
• A backslash (\) quotes the following character, unless it’s at the end of a line, in
which case both the backslash and the newline are stripped.
• A single quote (’) quotes everything up to the next single quote (this may span
lines).
• A double quote (") quotes all characters, except $, ‘ and \, up to the next unquoted
double quote. The $ and ‘ characters inside double quotes have their usual
meaning (i.e. parameter, command or arithmetic substitution), except no field
splitting is carried out on the results of double-quoted substitutions.
If a \ inside a double-quoted string is followed by \, $, ‘ or ", it’s replaced by the
second character; if it’s followed by a newline, both the \ and the newline are
stripped; otherwise, both the \ and the character following are unchanged.
See “POSIX mode,” below, for a special rule regarding sequences of the form
"...‘...\"...‘...".
Aliases
There are two types of aliases: normal command aliases and tracked aliases.
Command aliases are normally used as shorthand for a long or often used command.
The shell expands command aliases (i.e. substitutes the alias name for its value) when
it reads the first word of a command. An expanded alias is reprocessed to check for

more aliases. If a command alias ends in a space or tab, the following word is also
checked for alias expansion. The alias expansion process stops when a word that isn’t
an alias is found, when a quoted word is found or when an alias word that’s currently
being expanded is found.
The shell automatically defines the following command aliases:
autoload=’typeset -fu’
functions=’typeset -f’
hash=’alias -t’
history=’fc -l’
integer=’typeset -i’
local=’typeset’
login=’exec login’
newgrp=’exec newgrp’
nohup=’nohup ’
r=’fc -e -’
stop=’kill -STOP’
suspend=’kill -STOP $$’
type=’whence -v’
Tracked aliases allow the shell to remember where it found a particular command. The
first time the shell does a path search for a command that’s marked as a tracked alias, it
saves the full path of the command. The next time the command is executed, the shell
checks the saved path to see that it’s still valid, and if so, avoids repeating the path
search. You can create and list tracked aliases by using alias -t.
Changing the PATH parameter clears the saved paths for all tracked aliases.
If the trackall option is set (i.e. set -o trackall or set -h), the shell tracks
all commands. This option is set automatically for noninteractive shells. For
interactive shells, only the following commands are automatically tracked: cat, cc,
chmod, cp, date, grep, ls, make, mv, pr, rm, sed, sh, and who.
Substitution
The first step the shell takes in executing a simple command is to perform substitutions
on the words of the command. There are three kinds of substitution:
This substitution: Takes the form:

Parameter $name or ${...} (see “Parameters,” below)
Command $(command) or ‘command‘
Arithmetic $((expression))
If a substitution appears outside of double quotes, the results of the substitution are
generally subject to word or field splitting according to the current value of the IFS
(internal field separators) parameter.

The IFS parameter specifies a list of characters that are used to break a string up into
several words; any characters from the set space, tab and newline that appear in the
IFS characters are called IFS whitespace. Sequences of one or more IFS whitespace
characters, in combination with zero or one non-IFS whitespace characters delimit a
field. As a special case, leading and trailing IFS whitespace is stripped (i.e no leading
or trailing empty field is created by it); leading or trailing non-IFS whitespace does
create an empty field.
For example: if IFS is set to <space>:, the sequence of characters
<space>A<space>:<space><space>B::D contains four fields: A, B, an empty
field, and D. Note that if the IFS parameter is set to the null string, no field splitting is
done; if the parameter is unset, the default value of space, tab, and newline is used.
The results of substitution are, unless otherwise specified, also subject to brace
expansion and filename expansion (see the relevant sections below).
A command substitution is replaced by the output generated by the specified
command, which is run in a subshell. For $(command) substitutions, normal quoting
rules are used when command is parsed, however, for the ‘command‘ form, a \
followed by any of $, ‘ or \ is stripped (a \ followed by any other character is
unchanged).
As a special case in command substitutions, a command of the form < file is
interpreted to mean substitute the contents of file. For example, $(< foo) has the
same effect as $(cat foo), but the former is carried out more efficiently because no
process is started.
$(command) expressions are currently parsed by finding the matching parenthesis,

regardless of quoting. This will hopefully be fixed soon.
Arithmetic substitutions are replaced by the value of the specified expression. For
example, the command echo $((2+3*4)) prints 14. See “Arithmetic expressions”
for a description of an expression.
Parameters
Parameters are shell variables; you can assign values to them and access their values
using a parameter substitution. A parameter name is either one of the special single
punctuation or digit character parameters described below, or a letter followed by zero
or more letters or digits (the underscore (_) counts as a letter). Parameter substitutions
take the form $name or ${name}, where name is a parameter name. If substitution is
performed on a parameter that isn’t set, a null string is substituted unless the nounset
option (set -o nounset or set -u) is set, in which case an error occurs.
You can assign values to parameters in a number of ways:
• The shell implicitly sets some parameters, such as #, PWD, and so on; this is the
only way the special single character parameters are set.
• Parameters are imported from the shell’s environment at startup.

• You can assign values to parameters on the command line. For example, FOO=bar
sets the parameter FOO to bar; you can do multiple parameter assignments on a
single command line and follow them by a simple command, in which case the
assignments are in effect only for the duration of the command (such assignments
are also exported — see below for implications of this).
You must leave both the parameter name and the = unquoted for the shell to recognize
a parameter assignment.
• You can set parameters with the export, readonly, and typeset commands;
see their descriptions in “Command execution and builtin commands.”
• The for and select loops set parameters as well as the getopts, read, and set
-A commands.
• You can assign values to parameters using assignment operators inside arithmetic
expressions (see “Arithmetic expressions,” below) or using the ${name=value}
form of parameter substitution (see below).
Parameters with the export attribute (set using the export or typeset -x
commands, or by parameter assignments followed by simple commands) are put in the
environment (see environ() in the Library Reference) of commands run by the shell as
name=value pairs. The order in which parameters appear in the environment of a
command is unspecified. When the shell starts up, it extracts parameters and their
values from its environment and automatically sets the export attribute for those
parameters.
You can apply modifiers to the ${name} form of parameter substitution:
${name:-word} If name is set and not null, it’s substituted, otherwise word is
substituted.
${name:+word} If name is set and not null, word is substituted, otherwise nothing
is substituted.
${name:=word} If name is set and not null, it’s substituted, otherwise it’s assigned
word and the resulting value of name is substituted.
${name:?word} If name is set and not null, it’s substituted, otherwise word is
printed on standard error (preceded by name:) and an error
occurs (normally causing termination of a shell script, function or
.-script). If word is omitted, the string parameter null or
not set is used instead.
In the above modifiers, you can omit the :, in which case the conditions depend only
on name’s being set (as opposed to set and not null). If word is needed, parameter,
command, arithmetic and tilde substitution are performed on it; if word isn’t needed, it
isn’t evaluated.
You can also use the following forms of parameter substitution:

${#name} The number of positional parameters if name is *, @ or isn’t

specified, or the length of the string value of parameter name.
${#name[*]}
${#name[@]} The number of elements in the array name.
${name#pattern}
${name##pattern} If pattern matches the beginning of the value of parameter
name, the matched text is deleted from the result of
substitution. A single # results in the shortest match, two
results in the longest match.
${name%pattern}
${name%%pattern} Like ${...#...} substitution, but it deletes from the end of
the value.
The shell implicitly set the following special parameters; you can’t set them directly
using assignments:
! The process ID of the last background process started. If no background

processes have been started, the parameter isn’t set.
# The number of positional parameters (i.e. $1, $2, and so on).
$ The process ID of the shell, or the PID of the original shell if it’s a
subshell.
- The concatenation of the current single letter options (see the set
command below for a list of options).
? The exit status of the last nonasynchronous command executed. If the last
command was killed by a signal, $? is set to 128 plus the signal number.
0 The name the shell was invoked with (i.e. argv[0]), or the command-name
if it was invoked with the -c option and the command-name was supplied,
or the file argument, if it was supplied. If the posix option isn’t set, $0 is
the name of the current function or script.
1 ... 9 The first nine positional parameters that were supplied to the shell,
function or .-script. You can access further positional parameters by using
${number}.
* All positional parameters (except parameter 0), i.e. $1 $2 $3 and so on. If

used outside of double quotes, parameters are separate words (which are
subjected to word splitting); if used within double quotes, parameters are
separated by the first character of the IFS parameter (or the empty string if
IFS is null).

@ Same as $*, unless it’s used inside double quotes, in which case a separate
word is generated for each positional parameter — if there are no
positional parameters, no word is generated (you can use $@ to access
arguments, verbatim, without losing null arguments or splitting arguments
with spaces).
The shell sets and/or uses the following parameters:
_ (underscore) When an external command is executed by the shell, this

parameter is set in the environment of the new process to the
path of the executed command. In interactive use, this
parameter is also set in the parent shell to the last word of the
previous command. When MAILPATH messages are
evaluated, this parameter contains the name of the file that
changed (see MAILPATH parameter below).
CDPATH The search path for the cd builtin command. Works the same
way as PATH for those directories not beginning with / in cd
commands. Note that if CDPATH is set and doesn’t contain .
or an empty path, the current directory isn’t searched.
COLUMNS Set to the number of columns in the terminal or window.

Currently set to the cols value as reported by stty if that value
is nonzero. This parameter is used by the interactive line
editing modes, and by select, set -o, and kill -l
commands to format information in columns.
EDITOR If the VISUAL parameter isn’t set, this parameter controls the
command line editing mode for interactive shells. See VISUAL
parameter below for how this works.
ENV If this environment variable is found to be set after any profile

files are executed, the expanded value is used as a shell start-up
file. It typically contains function and alias definitions. People
frequently call this file .kshrc, but you can give it whatever
name you like.
EXECSHELL If set, this parameter is assumed to contain the shell that’s to be

used to execute commands that execve() fails to execute and
that don’t start with a #! shell sequence.
FCEDIT The editor used by the fc command (see below).
FPATH Like PATH, but used when an undefined function is executed

to locate the file defining the function. It’s also searched when a
command can’t be found using PATH. For more information,
see “Functions,” below.

HISTFILE The name of the file used to store history. When assigned to,
history is loaded from the specified file. Also, several
invocations of the shell running on the same machine share
their history if their HISTFILE parameters all point at the
same file.
If HISTFILE isn’t set, no history file is used. This is different from the original Korn
shell, which uses $HOME/.sh_history; in the future, ksh may also use a default
history file.
HISTSIZE The number of commands normally stored for history, default

128.
HOME The default directory for the cd command and the value
substituted for an unqualified ˜ (see “Tilde expansion,” below).
IFS Internal field separator, used during substitution and by the

read command, to split values into distinct arguments;
normally set to space, tab and newline. See “Substitution,”
above, for details.
This parameter isn’t imported from the environment when the shell is started.
KSH_VERSION The version of shell and the date the version was created
(readonly). See also the version commands in “emacs
interactive input-line editing” below.
MAIL If set, you’re told of the arrival of mail in the named file. This
parameter is ignored if the MAILPATH parameter is set.
MAILCHECK How often, in seconds, the shell checks for mail in the file(s)
specified by MAIL or MAILPATH. If 0, the shell checks
before each prompt. The default is 600 (10 minutes).
MAILPATH A list of files to be checked for mail. The list is separated by

colons, and each file may be followed by a ? and a message to
be printed if new mail has arrived. Command, parameter and
arithmetic substitution is performed on the message, and,
during substitution, the parameter $_ contains the name of the
file. The default message is you have mail in $_.
OLDPWD The previous working directory. Unset if cd hasn’t successfully

changed directories since the shell started, or if the shell
doesn’t know where it is.
OPTARG When using getopts, this parameter contains the argument for
a parsed option, if it requires one.

OPTIND The index of the last argument processed when using getopts.
Assigning 1 to this parameter causes getopts to process
arguments from the beginning the next time it’s invoked.
PATH A colon-separated list of directories that are searched when

looking for commands and .’d files. An empty string resulting
from a leading or trailing colon, or two adjacent colons is
treated as a ., the current directory. For more information on
setting PATH, see “Setting PATH and
LD_LIBRARY_PATH” in the Configuring Your Environment
chapter of the Neutrino User’s Guide.
POSIXLY_CORRECT
If set, this parameter causes the posix option to be enabled.
See “POSIX mode,” below.
PPID The process ID of the shell’s parent (read only).
PS1 The primary prompt for interactive shells. Parameter, command

and arithmetic substitutions are performed, and ! is replaced
with the current command number (see the fc command
below). You can put a literal ! in the prompt by placing !! in
PS1.
Note that since the command line editors try to figure out how
long the prompt is (so they know how far it is to the edge of the
screen), escape codes in the prompt tend to mess things up. You
can tell the shell not to count certain sequences (such as escape
codes) by prefixing your prompt with a nonprinting character
(such as Ctrl-A) followed by a carriage return and then
delimiting the escape codes with this nonprinting character. If
you don’t have any nonprinting characters, you’re out of luck. . .
BTW, don’t blame me for this hack; it’s in the original ksh.
Default is $ for non-root users, # for root.
PS2 Secondary prompt string, by default "> ", used when more
input is needed to complete a command.
PS3 Prompt used by the select statement when reading a menu

selection. Default is "#? ".
PS4 Used to prefix commands that are printed during execution

tracing (see the set -x command below). Parameter,
command and arithmetic substitutions are performed before it’s
printed. Default is "+ ".
PWD The current working directory. May be unset or null if the shell
doesn’t know where it is.

RANDOM A simple random number generator. Every time RANDOM is

referenced, it’s assigned the next number in a random number
series. You can set the point in the series by assigning a number
to RANDOM (see rand()).
REPLY Default parameter for the read command if no names are

given. Also used in select loops to store the value that’s read
from standard input.
SECONDS The number of seconds since the shell started or, if the
parameter has been assigned an integer value, the number of
seconds since the assignment plus the value that was assigned.
TMOUT If set to a positive integer in an interactive shell, it specifies the

maximum number of seconds the shell waits for input after
printing the primary prompt (PS1). If the time is exceeded, the
shell exits.
TMPDIR The directory in which to create shell temporary files. If this

parameter isn’t set, or doesn’t contain the absolute path of a
writable directory, temporary files are created in /tmp.
VISUAL If set, this parameter controls the command-line editing mode

for interactive shells. If the last component of the path specified
in this parameter contains the string emacs or gmacs, the
emacs or gmacs (Gosling emacs) editing mode is enabled,
respectively.
Tilde expansion
Tilde expansion, which is done in parallel with parameter substitution, is done on
words starting with an unquoted ˜. The characters following the tilde, up to the first
slash (/), if any, are assumed to be a login name. If the login name is empty, + or -,
the value of the HOME, PWD, or OLDPWD parameter is substituted, respectively.
Otherwise, the password file is searched for the login name, and the tilde expression is
substituted with the user’s home directory. If the login name isn’t found in the
password file or if any quoting or parameter substitution occurs in the login name, no
substitution is performed.
In parameter assignments (those preceding a simple command or those occurring in
the arguments of alias, export, readonly, and typeset), tilde expansion is done
after any unquoted colon (:), and login names are also delimited by colons.
The home directory of previously expanded login names are cached and reused. You
can use the alias -d command to list, change and add directory aliases to this cache.
For example:
alias -d fac=/usr/local/facilities; cd ˜fac/bin

Brace expansion (alternation)

Brace expressions, which take the form:
prefix{str1,...,strN}suffix
are expanded to N words, each of which is the concatenation of prefix, stri and suffix.
For example, a{c,b{X,Y},d}e expands to four words: ace, abXe, abYe, and ade).
As noted in the example, you can nest brace expressions, and the resulting words
aren’t sorted. Brace expressions must contain an unquoted comma (,) for expansion to
occur (i.e. {} and {foo} aren’t expanded). Brace expansion is carried out after
parameter substitution and before filename generation.
Filename patterns
A filename pattern is a word containing one or more unquoted ? or * characters or
[...] sequences. Once brace expansion has been performed, the shell replaces
filename patterns with the sorted names of all the files that match the pattern (if no
files match, the word is left unchanged). The pattern elements have the following
meanings:
? Matches any single character.
* Matches any sequence of characters.
[...] Matches any of the characters inside the brackets. You can specify ranges
of characters by separating two characters with a -. For example,
[a0-9] matches the letter a or any digit. In order for a - to represent
itself, you must either quote it or use it as the first or last character in the
character list. Similarly, you must quote a ] or use it as the first character
in the list if it’s to represent itself instead of the end of the list.
Also, a ! appearing at the start of the list has special meaning (see
below), so to represent itself, you must quote it or use it later in the list.
[!...] Like [...], except it matches any character not inside the brackets.
*(pattern| ... |pattern)

Matches any string of characters that matches zero or more occurrences
of the specified patterns. For example, the pattern *(foo|bar) matches
the empty string, as well as the strings foo, bar, foobarfoo, and so on.
+(pattern| ... |pattern)
Matches any string of characters that matches one or more occurrences of
the specified patterns. For example, the pattern +(foo|bar) matches the
strings foo, bar, foobarfoo, and so on.
?(pattern| ... |pattern)
Matches the empty string or a string that matches one of the specified
patterns. For example, the pattern ?(foo|bar) matches only the empty
string, foo and bar.

@(pattern| ... |pattern)

Matches a string that matches one of the specified patterns. For example,
the pattern @(foo|bar) matches only the strings foo and bar.
!(pattern| ... |pattern)
Matches any string that doesn’t match one of the specified patterns. For
example: the pattern !(foo|bar) matches all strings except foo and
bar; the pattern !(*) matches no strings; the pattern !(?)* matches all
strings (think about it).
Note that none of the above pattern elements match either a period (.) at the start of a
filename or a slash (/), even if they are explicitly used in a [...] sequence.
CAUTION: In QNX Neutrino 6.5.0 and later, the pattern .* matches the . and ..
! names. This could cause problems with scripts that assume that the shell never
matches these names.
If the markdirs option is set, any directories that result from filename generation are
marked with a trailing /.
The POSIX character classes (i.e [:class-name:] inside a [...] expression) aren’t
yet implemented.
Input/output redirection
When a command is executed, its standard input, standard output and standard error
(file descriptors 0, 1 and 2, respectively) are normally inherited from the shell. Three
exceptions to this are commands in pipelines, for which standard input and/or standard
output are those set up by the pipeline, asynchronous commands created when job
control is disabled, for which standard input is initially set to be from /dev/null,
and commands for which any of the following redirections have been specified:
> file Standard output is redirected to file. If file doesn’t exist, it’s created; if
it does exist, is a regular file and the noclobber option is set, an
error occurs, otherwise the file is truncated. Note that this means the
command cmd < foo > foo opens foo for reading and then
truncates it when it opens it for writing, before cmd gets a chance to
actually read it.
>| file Same as >, except the file is truncated, even if the noclobber option
is set.
>> file Same as >, except an existing file is appended to instead of being
truncated. Also, the file is opened in append mode, so writes always
go to the end of the file (see open()).
< file Standard input is redirected from file, which is opened for reading.

<> file Same as <, except the file is opened for reading and writing.
<< marker After reading the command line containing this kind of redirection
(called a here document), the shell copies lines from the command
source into a temporary file until a line matching marker is read.
When the command is executed, standard input is redirected from the
temporary file.
The line at the end of the “here document” must match marker exactly; it must not
have any leading or trailing whitespace characters.
If marker contains no quoted characters, the contents of the
temporary file are processed as if enclosed in double quotes each time
the command is executed, so parameter, command and arithmetic
substitutions are performed, along with backslash (\) escapes for $, ‘,
\ and \newline. If multiple here documents are used on the same
command line, they’re saved in order.
<<- marker Same as <<, except leading tabs are stripped from lines in the here
document.
<& fd Standard input is duplicated from file descriptor fd. The fd can be a
single digit, indicating the number of an existing file descriptor, the
letter p, indicating the file descriptor associated with the output of the
current coprocess, or the character -, indicating standard input is to
be closed.
>& fd Same as <&, except the operation is done on standard output.
In any of the above redirections, you can explicitly give the file descriptor that’s
redirected (i.e. standard input or standard output) by preceding the redirection with a
single digit. Parameter, command and arithmetic substitutions, tilde substitutions and
filename generation are all performed on the file, marker and fd arguments of
redirections. Note however, that the results of any filename generation are only used if
a single file is matched; if multiple files match, the word with the unexpanded filename
generation characters is used. Note that in restricted shells, you can’t use redirections
that can create files.
For simple commands, redirections may appear anywhere in the command; for
compound commands (if statements, and so on), any redirections must appear at the
end. Redirections are processed after pipelines are created and in the order they are
given, so:
cat /foo/bar 2>&1 > /dev/null | cat -n
prints an error with a line number prepended to it.

Arithmetic expressions
You can use integer arithmetic expressions with the let command, inside $((...))
expressions, inside array references (e.g. name[expr]), as numeric arguments to the
test command, and as the value of an assignment to an integer parameter.
Expressions may contain alphanumeric parameter identifiers, array references, and
integer constants. You can combine expressions with the following C operators (listed
and grouped in increasing order of precedence):
Unary operators + - ! ˜ ++ --
Binary operators ,
= *= /= %= += -= <<= >>= &= ˆ= |=
||
&&
|
ˆ
&
== !=
< <= >= >
<< >>
+ -
* / %
Ternary operator ?: (Precedence is immediately higher than assignment.)
Grouping operators
( )
You can specify integer constants with arbitrary bases by using the notation
base#number, where base is a decimal integer specifying the base, and number is a
number in the specified base.
The operators are evaluated as follows:
Unary + Result is the argument (included for completeness).
Unary - Negation.
! Logical not; the result is 1 if argument is zero, 0 if not.
˜ Arithmetic (bitwise) not.
++ Increment; you must apply it to a parameter (not a literal or other

expression) — the parameter is incremented by 1. When used as a prefix
operator, the result is the incremented value of the parameter, when used
as a postfix operator, the result is the original value of the parameter.
-- Similar to ++, except the parameter is decremented by 1.

, Separates two arithmetic expressions; the left hand side is evaluated

first, then the right. The result is value of the expression on the right
hand side.
= Assignment; the variable on the left is set to the value on the right.
*= /= %= += -= <<= >>= &= ˆ= |=

Assignment operators:
var op= expr

is the same as:
var = var op ( expr )
|| Logical OR; the result is 1 if either argument is nonzero, 0 if not. The

right argument is evaluated only if the left argument is zero.
&& Logical AND; the result is 1 if both arguments are nonzero, 0 if not. The
right argument is evaluated only if the left argument is nonzero.
| Arithmetic (bitwise) OR.
ˆ Arithmetic (bitwise) exclusive-OR.
& Arithmetic (bitwise) AND.
== Equal; the result is 1 if both arguments are equal, 0 if not.
!= Not equal; the result is 0 if both arguments are equal, 1 if not.
< Less than; the result is 1 if the left argument is less than the right, 0 if
not.
<= >= > Less than or equal, greater than or equal, greater than. See <.
<< >> Shift left (right); the result is the left argument with its bits shifted left
(right) by the amount given in the right argument.
+ - * / Addition, subtraction, multiplication, and division.
% Remainder; the result is the remainder of the division of the left

argument by the right. The sign of the result is unspecified if either
argument is negative.
arg1 ? arg2 : arg3

If arg1 is nonzero, the result is arg2, otherwise arg3.

Coprocesses
A coprocess, which is a pipeline created with the |& operator, is an asynchronous
process that the shell can both write to (using print -p) and read from (using read
-p). The input and output of the coprocess can also be manipulated using >&p and
<&p redirections, respectively. Once a coprocess has been started, another can’t be
started until the coprocess exits, or until the coprocess input has been redirected using
an exec n>&p redirection. If a coprocess’s input is redirected in this way, the next
coprocess to be started shares the output with the first coprocess, unless the output of
the initial coprocess has been redirected using an exec n<&p redirection.
Some notes concerning coprocesses:
• The only way to close the coprocess input (so the coprocess reads an end-of-file) is
to redirect the input to a numbered file descriptor and then close that file descriptor
(e.g. exec 3>&p;exec 3>&-).
• In order for coprocesses to share a common output, the shell must keep the write
portion of the output pipe open. This means that end of file won’t be detected until
all coprocesses sharing the coprocess output have exited (when they all exit, the
shell closes its copy of the pipe). You can avoid this by redirecting the output to a
numbered file descriptor (as this also causes the shell to close its copy).
This behavior is slightly different from the original Korn shell, which closes its copy
of the write portion of the coprocess’s output when the most recently started coprocess
(instead of when all sharing coprocesses) exits.
• The print -p command ignores SIGPIPE signals during writes if the signal isn’t
being trapped or ignored; the same isn’t true if the coprocess input has been
duplicated to another file descriptor and print -un is used.
Functions
Functions are defined using either Korn shell function name syntax or the
Bourne/POSIX shell name() syntax (see below for the difference between the two
forms). Functions are like .-scripts in that they are executed in the current
environment, however, unlike .-scripts, shell arguments (i.e. positional parameters, $1,
and so on) are never visible inside them. When the shell is determining the location of
a command, functions are searched after special builtin commands, and before regular
and nonregular builtins, and before the PATH is searched.
You can delete an existing function by using unset -f function-name. You can list
the functions by executing typeset +f, and list the function definitions by executing
typeset -f. You can use the autoload command (which is an alias for typeset
-fu) to create undefined functions; when an undefined function is executed, the shell
searches the path specified in the FPATH parameter for a file with the same name as
the function, which, if found is read and executed. If after executing the file, the
named function is found to be defined, the function is executed, otherwise, the normal
command search is continued (i.e. the shell searches the regular builtin command table
and PATH). Note that if a command isn’t found using PATH, the shell tries to

autoload a function using FPATH (this is an undocumented feature of the original

Korn shell).
Functions can have two attributes, trace and export, which you set with typeset -ft
and typeset -fx. When a traced function is executed, the shell’s xtrace option is
turned on for the function’s duration, otherwise the xtrace option is turned off. The
export attribute of functions is currently not used. In the original Korn shell, exported
functions are visible to shell scripts that are executed.
Since functions are executed in the current shell environment, parameter assignments
made inside functions are visible after the function completes. If this isn’t the desired
effect, you can use the typeset command inside a function to create a local
parameter. Note that special parameters (e.g. $$, $!) can’t be scoped in this way.
The exit status of a function is that of the last command executed in the function. You
can make a function finish immediately by using the return command; you can also
use this to explicitly specify the exit status.
Functions defined with the function reserved word are treated differently in the
following ways from functions defined with the () notation:
• The $0 parameter is set to the name of the function (Bourne-style functions leave
$0 untouched).
• Parameter assignments preceding function calls aren’t kept in the shell environment
(executing Bourne-style functions keeps assignments).
• OPTIND is saved/reset and restored on entry and exit from the function so you can
use getopts properly both inside and outside the function (Bourne-style functions
leave OPTIND untouched, so using getopts inside a function interferes with
using getopts outside the function).
In the future, the following differences will also be added:
• A separate trap/signal environment will be used during the execution of functions.

This will mean that traps set inside a function won’t affect the shell’s traps and
signals that aren’t ignored in the shell (but may be trapped) will have their default
effect in a function.
• The EXIT trap, if set in a function, will be executed after the function returns.
POSIX mode
The shell is intended to be POSIX compliant, however, in some cases, POSIX
behavior is contrary either to the original Korn shell behavior or to user convenience.
How the shell behaves in these cases is determined by the state of the posix option
(set -o posix); if it’s on, the POSIX behavior is followed, otherwise it isn’t. The
posix option is set automatically when the shell starts up if the environment contains
the POSIXLY_CORRECT parameter. (The shell can also be compiled so that it’s in
POSIX mode by default, however this usually isn’t desirable).
The following is a list of things that are affected by the state of the posix option:

\" inside double quoted ‘...‘ command substitutions

In POSIX mode, the \" is interpreted when the command is
interpreted; in non-POSIX mode, the backslash is stripped before
the command substitution is interpreted. For example, echo
"‘echo \"hi\"‘" produces "hi" in POSIX mode, hi in
non-POSIX mode. To avoid problems, use the $(...) form of
command substitution.
kill -l output In POSIX mode, signal names are listed one a single line; in
non-POSIX mode, signal numbers, names and descriptions are
printed in columns. In future, a new option (-v perhaps) will be
added to distinguish the two behaviors.
fg exit status In POSIX mode, the exit status is 0 if no errors occur; in

non-POSIX mode, the exit status is that of the last foregrounded
job.
getopts In POSIX mode, options must start with a -; in non-POSIX

mode, options can start with either - or +.
Brace expansion (also known as alternation)

In POSIX mode, brace expansion is disabled; in non-POSIX
mode, it’s enabled. Note that set -o posix (or setting the
POSIXLY_CORRECT parameter) automatically turns the
braceexpand option off, but you can explicitly turn it on later.
set - In POSIX mode, this doesn’t clear the verbose or xtrace

options; in non-POSIX mode, it does.
set exit status In POSIX mode, the exit status of set is 0 if there are no errors;
in non-POSIX mode, the exit status is that of any command
substitutions performed in generating the set command. For
example, set -- ‘false‘; echo $? prints 0 in POSIX
mode, 1 in non-POSIX mode. This construct is used in most
shell scripts that use the old getopt command.
Argument expansion of alias, export, readonly, and typeset commands

In POSIX mode, normal argument expansion is done; in
non-POSIX mode, field splitting, file globing, brace expansion
and (normal) tilde expansion are turned off, and assignment tilde
expansion is turned on.
Signal specification
In POSIX mode, you can specify signals as digits only if the
signal numbers match POSIX values (i.e. SIGHUP=1, SIGINT=2,
SIGQUIT=3, SIGABRT=6, SIGKILL=9, SIGALRM=14, and
SIGTERM=15); in non-POSIX mode, signals can always be
digits.

Alias expansion In POSIX mode, alias expansion is only carried out when reading
command words; in non-POSIX mode, alias expansion is carried
out on any word following an alias that ended in a space. For
example, the following for loop:
alias a=’for ’ i=’j’

a i in 1 2; do echo i=$i j=$j; done
uses parameter i in POSIX mode, but j in non-POSIX mode.
Test In POSIX mode, the expression -t (preceded by some number of

! arguments) is always true, as it’s a nonzero length string; in
non-POSIX mode, it tests if file descriptor 1 is a tty (i.e you can
leave out the fd argument to the -t test, and it defaults to 1).
Command execution and builtin commands

After evaluation of command-line arguments, redirections and parameter assignments,
the command is checked to determine its type, in this order:
1 Special builtin
2 Function
3 Regular builtin
4 Name of a file to execute found using the PATH parameter.
Special builtin commands differ from other commands in that the PATH parameter
isn’t used to find them, an error during their execution can cause a noninteractive shell
to exit and parameter assignments that are specified before the command are kept after
the command completes. Just to confuse things, if the posix option is turned off (see
set command below) some special commands are very special in that no field
splitting, file globing, brace expansion nor tilde expansion is performed on arguments
that look like assignments. Regular builtin commands are different only in that the
PATH parameter isn’t used to find them.
The original ksh and POSIX differ somewhat in which commands are considered
special or regular.
The POSIX special commands are:
. (dot) eval readonly trap

: (null) exec return unset
break exit set
continue export shift
Additional ksh special commands are:

builtin times typeset
The very special commands (non-POSIX mode) are:
alias readonly set typeset
The POSIX regular commands are:
alias false jobs umask

bg fc kill unalias
cd fg read wait
command getopts true
The additional ksh regular commands are:
[ hash pwd whence

bind let test
echo print ulimit
In the future, the additional ksh special and regular commands may be treated
differently from the POSIX special and regular commands.
Once the type of the command has been determined, any command-line parameter
assignments are performed and exported for the duration of the command.
The following sections describe the builtin commands:
. (dot) builtin command

. file [arg ...]
Execute the commands in file in the current environment. The file is searched for in
the directories of PATH. If arguments are given, you can use the positional parameters
to access them while file is being executed. If no arguments are given, the positional
parameters are those of the environment the command is used in.
: (null) builtin command

: [ ... ]
The null command. The exit status is set to zero.
alias builtin command

alias [ -d | +-t [-r] ] [+-px] [+-] [name[=value] ...]
Without arguments, alias lists all aliases. For any name without a value, the existing
alias is listed. Any name with a value defines an alias (see “Aliases,” above).
When listing aliases, one of two formats is used:
• Normally, aliases are listed as name=value, where value is quoted.

• If options were preceded with + or a lone + is given on the command line, only
name is printed.
In addition, if the -p option is used, each alias is prefixed with the string alias .
The -x option sets (+x clears) the export attribute of an alias, or, if no names are
given, lists the aliases with the export attribute (exporting an alias has no affect).
The -t option indicates that tracked aliases are to be listed/set (values specified on the
command line are ignored for tracked aliases). The -r option indicates that all tracked
aliases are to be reset.
The -d option causes directory aliases, which are used in tilde expansion, to be listed
or set (see “Tilde expansion,” above).
bg builtin command
bg [job ...]
Resume the specified stopped job(s) in the background. If no jobs are specified, %+ is
assumed. This command is only available on systems that support job control. See
“Job control,” below, for more information.
bind builtin command

bind [-m] [key[=editing-command] ...]
Set or view the current emacs command editing key bindings/macros. See “emacs
interactive input-line editing,” below, for a complete description.
break builtin command

break [level]
Exit the levelth innermost for, select, until, or while loop. The level defaults to
1.
builtin builtin command

builtin command [arg ...]
Execute the builtin command command. This is useful for explicitly executing the
builtin version of commands (such as kill) that are also available as executable files.
cd builtin command
cd [-LP] [dir]
Set the working directory to dir. If the parameter CDPATH is set, it lists the search
path for the directory containing dir. A null path means the current directory. If dir is
missing, the home directory $HOME is used. If dir is -, the previous working
directory is used (see OLDPWD parameter). If -L option (logical path) is used or if
the physical option (see the set command below) isn’t set, references to .. in dir
are relative to the path used to get to the directory. If -P option (physical path) is used
or if the physical option is set, .. is relative to the filesystem directory tree. The
PWD and OLDPWD parameters are updated to reflect the current and old working
directory, respectively.
cd [-LP] old new
The string new is substituted for old in the current directory, and the shell attempts to
change to the new directory.

command builtin command

command [-pvV] cmd [arg ...]
If neither the -v nor -V option is given, cmd is executed exactly as if the command
hadn’t been specified, with two exceptions:
• The cmd can’t be a shell function.
• Special builtin commands lose their specialness (i.e redirection and utility errors
don’t cause the shell to exit, and command assignments aren’t permanent).
If you specify the -p option, a default search path is used instead of the current value
of PATH. The actual value of the default path is system-dependent: on POSIXish
systems, it’s the value returned by:
getconf _CS_PATH
If the -v option is given, instead of executing cmd, information about what would be
executed is given (and the same is done for arg . . . ): for special and regular builtin
commands and functions, their names are simply printed, for aliases, a command that
defines them is printed, and for commands found by searching the PATH parameter,
the full path of the command is printed. If no command is found, (i.e. the path search
fails), nothing is printed and command exits with a nonzero status. The -V option is
like the -v option, except it’s more verbose.
continue builtin command

continue [level]
Jump to the beginning of the levelth innermost for, select, until, or while loop.
The level defaults to 1.
echo builtin command

echo [-neE] [arg ...]
Print the arguments (separated by spaces) followed by a newline, to standard output.

The newline is suppressed if any of the arguments contain the backslash sequence \c.
See the print command below for a list of other backslash sequences that are
recognized.
The options are provided for compatibility with BSD shell scripts: -n suppresses the
trailing newline, -e enables backslash interpretation (a no-op, since this is normally
done), and -E suppresses backslash interpretation.
This command is also available as an executable; see echo.
eval builtin command

eval command ...
Concatenate the arguments (with spaces between them) to form a single string that the
shell then parses and executes in the current environment.

exec builtin command

exec [command [arg ...]]
Execute the command without forking, replacing the shell process.

If no arguments are given, any IO redirection is permanent and the shell isn’t replaced.
Any file descriptors greater than 2 that are opened or duped in this way aren’t made
available to other executed commands (i.e. commands that aren’t builtin to the shell).
Note that the Bourne shell differs here: it does pass these file descriptors on.
exit builtin command

exit [status]
Exit from the shell with the specified exit status. If status isn’t specified, the exit status
is the current value of the ? parameter.
export builtin command

export [-p] [parameter[=value]] ...
Set the export attribute of the named parameters. Exported parameters are passed in
the environment to executed commands. If values are specified, the named parameters
also assigned.
If no parameters are specified, the names of all parameters with the export attribute are
printed one per line, unless the -p option is used, in which case export commands
defining all exported parameters, including their values, are printed.
false builtin command

false
A command that exits with a nonzero status.

This command is also available as an executable; see false.
fc builtin command
fc [-e editor | -l [-n]] [-r] [first [last]]
The first and last arguments select commands from the history. You can select
commands by history number, or a string specifying the most recent command starting
with that string. The -l option lists the command on stdout, and -n inhibits the
default command numbers. The -r option reverses the order of the list. Without -l,
the selected commands are edited by the editor specified with the -e option, or if no
-e is specified, the editor specified by the FCEDIT parameter (if this parameter isn’t
set, /bin/ed is used), and then executed by the shell.
fc [-e - | -s] [-g] [old=new] [prefix]
Reexecute the selected command (the previous command by default) after performing
the optional substitution of old with new. If -g is specified, all occurrences of old are
replaced with new. This command is usually accessed with the predefined alias r=’fc
-e -’.

fg builtin command
fg [job ...]
Resume the specified job(s) in the foreground. If no jobs are specified, %+ is assumed.
This command is available only on systems that support job control. See “Job
control,” below, for more information.
getopts builtin command

getopts optstring name [arg ...]
The getopts command is used by shell procedures to parse the specified arguments
(or positional parameters, if no arguments are given) and to check for legal options.
The optstring argument contains the option letters that getopts is to recognize. If a
letter is followed by a colon, the option is expected to have an argument. You can
group options that don’t take arguments into a single argument. If an option takes an
argument and the option character isn’t the last character of the argument it’s found in,
the remainder of the argument is taken to be the option’s argument, otherwise, the next
argument is the option’s argument.
Each time getopts is invoked, it places the next option in the shell parameter name
and the index of the next argument to be processed in the shell parameter OPTIND. If
the option was introduced with a +, the option placed in name is prefixed with a +.
When an option requires an argument, getopts places it in the shell parameter
OPTARG. When an illegal option or a missing option argument is encountered, a
question mark or a colon is placed in name (indicating an illegal option or missing
argument, respectively) and OPTARG is set to the option character that caused the
problem. An error message is also printed to standard error if optstring doesn’t begin
with a colon.
When the end of the options is encountered, getopts exits with a nonzero exit status.
Options end at the first (non-option argument) argument that doesn’t start with a -, or
when a -- argument is encountered.
You can reset option parsing by setting OPTIND to 1 (this is done automatically
whenever the shell or a shell procedure is invoked).
CAUTION: Changing the value of the shell parameter OPTIND to a value other than
! 1, or parsing different sets of arguments without resetting OPTIND may lead to
unexpected results.
hash builtin command

hash [-r] [name ...]
Without arguments, any hashed executable command pathnames are listed. The -r
option causes all hashed commands to be removed from the hash table. If you specify
any names, the shell searches for each one as if it were a command name, and adds the
name to the hash table if it’s an executable command.

jobs builtin command

jobs [-lpn] [job ...]
Display information about the specified jobs; if no jobs are specified, all jobs are
displayed. The -n option causes information to be displayed only for jobs that have
changed state since the last notification. If the -l option is used, the process ID of each
process in a job is also listed. The -p option causes only the process group of each job
to be printed. See “Job control,” below, for the format of job and the displayed job.
kill builtin command

kill [-s signame | -signum | -signame ] { job | pid | -pgrp } ...
Send the specified signal to the specified jobs, process IDs, or process groups. If no
signal is specified, the signal TERM is sent. If a job is specified, the signal is sent to
the job’s process group. See “Job control,” below, for the format of job.
kill -l [exit-status ...]
Print the name of the signal that killed a process that exited with the specified
exit-statuses. If no arguments are specified, a list of all the signals, their numbers and a
short description of them are printed.
This command is also available as an executable; see kill.
let builtin command

let [expr ...]
Evaluate each given expression (see “Arithmetic expressions,” above). If all

expressions are successfully evaluated, the exit status is:
• 0 if the last expression evaluated to nonzero

• 1 if the last expression evaluated to zero.
If an error occurs during the parsing or evaluation of an expression, the exit status is
greater than 1.
Since expressions may need to be quoted, (( expr )) is syntactic sugar for let
"expr".
print builtin command

print [-nprsun | -R [-en]] [argument ...]
Print the arguments on the standard output, separated by spaces, and terminated with a
newline. The -n option suppresses the newline. By default, certain C escapes are
translated. These include \b, \f, \n, \r, \t, \v, and \0### (# is an octal digit, of
which there may be 0 to 3). \c is equivalent to using the -n option. You can inhibit
backslash expansion by using the -r option. The -s option prints to the history file
instead of standard output, the -u option prints to file descriptor n (n defaults to 1 if
omitted), and the -p option prints to the coprocess (see “Coprocesses,” above).
The -R option is used to emulate, to some degree, the BSD echo command, which
doesn’t process \ sequences unless the -e option is given. As above, the -n option
suppresses the trailing newline.

pwd builtin command

pwd [-LP]
Print the present working directory. If -L option is used or if the physical option
(see the set command below) isn’t set, the logical path is printed (i.e. the path used to
cd to the current directory). If -P option (physical path) is used or if the physical
option is set, the path determined from the filesystem (by following .. directories to
the root directory) is printed.
This command is also available as an executable; see pwd.
read builtin command

read [-prsun] [parameter ...]
Read a line of input from standard input, separate the line into fields using the IFS
parameter (see “Substitution,” above), and assign each field to the specified
parameters. If there are more parameters than fields, the extra parameters are set to
null, or alternatively, if there are more fields than parameters, the last parameter is
assigned the remaining fields (inclusive of any separating spaces). If no parameters are
specified, the REPLY parameter is used. If the input-line ends in a backslash and the
-r option wasn’t used, the backslash and newline are stripped and more input is read.
If no input is read, read exits with a nonzero status.
The first parameter may have a question mark and a string appended to it, in which
case the string is used as a prompt (printed to standard error before any input is read) if
the input is a tty (e.g. read nfoo?’number of foos: ’).
The -un and -p options cause input to be read from file descriptor n or the current
coprocess (see “Coprocesses,” above, for comments on this), respectively. If the -s
option is used, input is saved to the history file.
readonly builtin command

readonly [-p] [parameter[=value]] ...
Set the readonly attribute of the named parameters. If values are given, parameters are
set to them before setting the attribute. Once a parameter is made readonly, it can’t be
unset and its value can’t be changed.
If no parameters are specified, the names of all parameters with the readonly attribute
are printed one per line, unless the -p option is used, in which case readonly
commands defining all readonly parameters, including their values, are printed.
return builtin command

return [status]
Return from a function or . script, with exit status status. If no status is given, the exit
status of the last executed command is used. If used outside of a function or . script, it
has the same effect as exit. Note that ksh treats both profile and $ENV files as .
scripts, while the original Korn shell only treats profiles as . scripts.

set builtin command

set [+-abCefhiklmnprsuvxX] [+-o [option]] [+-A name] [--] [arg ...]
You can use the set command to set (-) or clear (+) shell options, set the positional
parameters, or set an array parameter. You can change options by using the +-o option
syntax, where option is the long name of an option, or by using the +-letter syntax,
where letter is the option’s single letter name (not all options have a single letter
name). The following table lists both option letters (if they exist) and long names
along with a description of what the option does.
Letter Long name Description

-A Sets the elements of the array parameter name to arg
. . . ; if -A is used, the array is reset (i.e. emptied) first; if
+A is used, the first N elements are set (where N is the
number of args), the rest are left untouched.
-a allexport All new parameters are created with the export attribute
-b notify Print job notification messages asynchronously, instead
of just before the prompt. Only used if job control is
enabled (-m).
-C noclobber Prevent > redirection from overwriting existing files
(you must use >| to force an overwrite).
-e errexit Exit (after executing the ERR trap) as soon as an error
occurs or a command fails (i.e. exits with a nonzero
status). This doesn’t apply to commands whose exit
status is explicitly tested by a shell construct such as if,
until, while, && or || statements.
-f noglob Don’t expand filename patterns.
-h trackall Create tracked aliases for all executed commands (see
“Aliases,” above). On by default for noninteractive
shells.
-i interactive Enable interactive mode — this can only be set/unset
when the shell is invoked.
-k keyword Parameter assignments are recognized anywhere in a
command.
-l login The shell is a login shell — this can only be set/unset
when the shell is invoked (see “Shell startup,” above).
-m monitor Enable job control (default for interactive shells).
-n noexec Don’t execute any commands — useful for checking
the syntax of scripts (ignored if interactive).
continued. . .


-p privileged Set automatically if, when the shell starts, the read uid
or gid doesn’t match the effective uid or gid,
respectively. See “Shell startup,” above for a description
of what this means.
-r restricted Enable restricted mode — this option can only be used
when the shell is invoked. See “Shell startup,” above for
a description of what this means.
-s stdin If used when the shell is invoked, commands are read
from standard input. Set automatically if the shell is
invoked with no arguments.
When -s is used in the set command, it causes the
specified arguments to be sorted before assigning them
to the positional parameters (or to array name, if -A is
used).
-u nounset Referencing of an unset parameter is treated as an error,

unless one of the -, + or = modifiers is used.
-v verbose Write shell input to standard error as it’s read.
-x xtrace Print commands and parameter assignments when they
are executed, preceded by the value of PS4.
-X markdirs Mark directories with a trailing / during filename
generation.
bgnice Background jobs are run with lower priority.
braceexpand Enable brace expansion (also known as, alternation).
emacs Enable BRL emacs-like command line editing
(interactive shells only); see “emacs interactive
input-line editing.”
gmacs Enable gmacs-like (Gosling emacs) command line
editing (interactive shells only); currently identical to
emacs editing except that transpose (Ctrl-T) acts
slightly differently.
ignoreeof The shell won’t exit on when end-of-file is read; you
have to use exit.
nohup Don’t kill running jobs with a SIGHUP signal when a
login shell exists. Currently set by default, but this will
change in the future to be compatible with the original
Korn shell (which doesn’t have this option, but does
send the SIGHUP signal).
continued. . .


nolog No effect — in the original Korn shell, this prevents
function definitions from being stored in the history file.
physical Causes the cd and pwd commands to use physical (i.e.
the filesystem’s) .. directories instead of logical
directories (i.e. the shell handles .., which allows the
user to be oblivious of symlink links to directories).
Clear by default. Note that setting this option doesn’t
effect the current value of the PWD parameter; only the
cd command changes PWD. See the cd and pwd
commands above for more details.
posix Enable POSIX mode. See “POSIX mode,” above.
These options can also be used upon invocation of the shell. You can find the current
set of options (with single letter names) in the parameter -. The set -o command
with no option name lists all the options and whether each is on or off; set +o prints
the long names of all options that are currently on.
Remaining arguments, if any, are positional parameters and are assigned, in order, to
the positional parameters (i.e. 1, 2, and so on). If options are ended with -- and there
are no remaining arguments, all positional parameters are cleared. If no options or
arguments are given, then the values of all names are printed. For unknown historical
reasons, a lone - option is treated specially: it clears both the -x and -v options.
shift builtin command

shift [number]
The positional parameters number+1, number+2 . . . are renamed to 1, 2, and so on.

The number defaults to 1.
test builtin command

test expression
or:
[ expression ]
Evaluate the expression and return zero status if true, and 1 status if false and greater
than 1 if there was an error. It’s normally used as the condition command of if and
while statements.
Calling an executable file test is a common mistake. If you don’t specify the path to
the file, the builtin command is executed.
The following basic expressions are available:
str The str has nonzero length. Note that there is the potential for
problems if str turns out to be an operator (e.g. -r) — it’s
generally better to use a test like:

[ X"str" != X ]
instead (double quotes are used in case str contains spaces or file
globing characters).
-r file The file exists and is readable.
-w file The file exists and is writable.
-x file The file exists and is executable.
-a file The file exists.
-e file The file exists.
-f file The file is a regular file.
-d file The file is a directory.
-c file The file is a character special device.
-b file The file is a block special device.
-p file The file is a named pipe.
-u file The file’s mode has setuid bit set.
-g file The file’s mode has setgid bit set.
-k file The file’s mode has sticky bit set.
-s file The file isn’t empty.
-O file The file’s owner is the shell’s effective user-ID.
-G file The file’s group is the shell’s effective group-ID.
-h file The file is a symbolic link.
-H file The file is a context-dependent directory (useful only on HP-UX).
-L file The file is a symbolic link. This is the same as -h.
-S file The file is a socket.
-o option The shell option is set (see the set command above for list of
options). As a nonstandard extension, if the option starts with a !,
the test is negated; the test always fails if option doesn’t exist
(thus:
[ -o foo -o -o !foo ]
returns true if and only if option foo exists).
file -nt file The first file is newer than the second file.

file -ot file The first file is older than the second file.
file -ef file The first file is the same file as the second file.
-t [fd] The file descriptor is a tty device. If the posix option (set -o
posix, see “POSIX mode,” above) isn’t set, you can leave out the
fd, in which case it’s taken to be 1 (the behavior differs due to the
special POSIX rules described below).
string The string isn’t empty.
-z string The string is empty.
-n string The string isn’t empty.
string = string The strings are equal.
string == string The strings are equal.
string != string The strings aren’t equal.
number -eq number

The numbers are equal.
number -ne number

The numbers aren’t equal.
number -ge number
The first number is greater than or equal to the second.
number -gt number

The first number is greater than the second.
number -le number

The first number is less than or equal to the second.
number -lt number

The first number is less than the second.
You can combine the above basic expressions, in which unary operators have
precedence over binary operators, with the following operators (listed in increasing
order of precedence):
expr -o expr Logical OR.
expr -a expr Logical AND.
! expr Logical not.
( expr ) Grouping.

On operating systems not supporting /dev/fd/n devices (where n is a file descriptor

number), the test command attempts to fake it for all tests that operate on files
(except the -e test). That is, [ -w /dev/fd/2 ] tests if file descriptor 2 is writable.
Note that some special rules are applied (courtesy of POSIX) if the number of
arguments to test or [ ... ] is less than five: if leading ! arguments can be
stripped such that only one argument remains, then a string length test is performed
(again, even if the argument is a unary operator); if leading ! arguments can be
stripped such that three arguments remain and the second argument is a binary
operator, then the binary operation is performed (even if first argument is a unary
operator, including an unstripped !).
A common mistake is to use if [ $foo = bar ], which fails if parameter foo is

null or unset, if it has embedded spaces (i.e. IFS characters), or if it’s a unary operator
such as ! or -n. Use tests like if [ "X$foo" = Xbar ] instead.
times builtin command

times
Print the accumulated user and system times used by the shell and by processes which
have exited that the shell started.
trap builtin command

trap [handler signal ...]
Set the trap handler that’s to be executed when any of the specified signals are
received.
The handler is either a null string, indicating the signals are to be ignored, a minus (-),
indicating that the default action is to be taken for the signals (see signal()), or a string
containing shell commands to be evaluated and executed at the first opportunity (i.e.
when the current command completes, or before printing the next PS1 prompt) after
receipt of one of the signals.
The signal is the name of a signal (e.g. SIGPIPE or SIGALRM) or the number of the
signal (see the kill -l command above). There are two special signals:
• EXIT (also known as 0), which is executed when the shell is about to exit
• ERR which is executed after an error occurs (an error is something that causes the
shell to exit if the -e or errexit option is set — see the set command above).
EXIT handlers are executed in the environment of the last executed command. Note
that for noninteractive shells, the trap handler can’t be changed for signals that were
ignored when the shell started.
With no arguments, trap lists, as a series of trap commands, the current state of the
traps that have been set since the shell started.

The original Korn shell’s DEBUG trap and the handling of ERR and EXIT traps in
functions aren’t yet implemented.
true builtin command

true
A command that exits with a zero value.

This command is also available as an executable; see true.
typeset builtin command

typeset [[+-Ulprtux] [-L[n]] [-R[n]] [-Z[n]]
[-i[n]] | -f [-tux]] [name[=value] ...]
Display or set parameter attributes. With no name arguments, parameter attributes are
displayed: if no options are used, the current attributes of all parameters are printed as
typeset commands; if an option is given (or - with no option letter) all parameters
and their values with the specified attributes are printed; if options are introduced with
+, parameter values aren’t printed.
If name arguments are given, the attributes of the named parameters are set (-) or
cleared (+). Values for parameters may optionally be specified. If typeset is used
inside a function, any newly created parameters are local to the function.
When -f is used, typeset operates on the attributes of functions. As with
parameters, if no names are given, functions are listed with their values (i.e.
definitions) unless options are introduced with +, in which case only the function
names are reported.
The options are:
-Ln Left justify attribute: n specifies the field width. If n isn’t specified, the
current width of a parameter (or the width of its first assigned value) is used.
Leading white space (and zeros, if used with the -Z option) is stripped. If
necessary, values are either truncated or space padded to fit the field width.
-Rn Right justify attribute: n specifies the field width. If n isn’t specified, the
current width of a parameter (or the width of its first assigned value) is used.
Trailing white space are stripped. If necessary, values are either stripped of
leading characters or space padded to make them fit the field width.
-Zn Zero fill attribute: if not combined with -L, this is the same as -R, except zero
padding is used instead of space padding.
-in Integer attribute: n specifies the base to use when displaying the integer (if not
specified, the base given in the first assignment is used). You can use
arithmetic expressions to assign values to parameters that have this attribute.
-U Unsigned integer attribute: integers are printed as unsigned values (only
useful when combined with the -i option). This option isn’t in the original
Korn shell.

-f Function mode: display or set functions and their attributes, instead of

parameters.
-l Lower case attribute: all upper case characters in values are converted to
lower case. (In the original Korn shell, this parameter meant “long integer”
when used with the -i option).
-p Print complete typeset commands that you can use to recreate the attributes
(but not the values) of parameters. This is the default action (option exists for
ksh93 compatibility).
-r Readonly attribute: parameters with the this attribute may not be assigned to
or unset. Once this attribute is set, it can not be turned off.
-t Tag attribute: has no meaning to the shell; provided for application use.
For functions, -t is the trace attribute. When functions with the trace attribute
are executed, the xtrace (-x) shell option is temporarily turned on.
-u Upper case attribute: all lower case characters in values are converted to
upper case. (In the original Korn shell, this parameter meant “unsigned
integer” when used with the -i option, which meant uppercase letters would
never be used for bases greater than 10. See the -U option).
For functions, -u is the undefined attribute. See “Functions,” above for the
implications of this.
-x Export attribute: parameters (or functions) are placed in the environment of

any executed commands. Exported functions aren’t implemented yet.
ulimit builtin command

ulimit [-acdfHlmnpsStvw] [value]
Display or set process limits. If no options are used, the file size limit (-f) is assumed.
The value, if specified, may be either be an arithmetic expression or the word
unlimited. The limits affect the shell and any processes created by the shell after
they’re imposed. Note that some systems may not allow limits to be increased once
they are set. Also note that the types of limits available are system dependent — some
systems have only the -f limit.
The options are:
-a Display all limits; unless -H is used, soft limits are displayed.
-H Set the hard limit only (default is to set both hard and soft limits).
-S Set the soft limit only (default is to set both hard and soft limits).
-c Impose a size limit of n blocks on the size of core dumps.
-d Impose a size limit of n kilobytes on the size of the data area.

-f Impose a size limit of n blocks on files written by the shell and its child
processes (files of any size may be read).
-l Impose a limit of n kilobytes on the amount of locked (wired) physical

memory.
-m Impose a limit of n kilobytes on the amount of physical memory used.
-n Impose a limit of n file descriptors that can be open at once.
-p Impose a limit of n processes that can be run by the user at any one time.
-s Impose a size limit of n kilobytes on the size of the stack area.
-t Impose a time limit of n cpu seconds to be used by each process.
-v Impose a limit of n kilobytes on the amount of virtual memory used; on some

systems this is the maximum allowable virtual address (in bytes, not kilobytes).
-w Impose a limit of n kilobytes on the amount of swap space used. As far as

ulimit is concerned, a block is 512 bytes.
umask builtin command

umask [-S] [mask]
Display or set the file permission creation mask, or umask (see umask). If the -S
option is used, the mask displayed or set is symbolic, otherwise it’s an octal number.
This command is also available as an executable; see umask.
Symbolic masks are like those used by chmod:
[ugoa]{{=+-}{rwx}*}+[,...]
in which the first group of characters is the who part, the second group is the op part,
and the last group is the perm part. The who part specifies which part of the umask is
to be modified. The letters mean:
u The user permissions.
g The group permissions.
o The other permissions (nonuser, nongroup).
a All permissions (user, group and other).
The op part indicates how the who permissions are to be modified:
= Set.
+ Added to.
- Removed from.

The perm part specifies which permissions are to be set, added or removed:
r Read permission.
w Write permission.
x Execute permission.
When symbolic masks are used, they describe what permissions may be made
available (as opposed to octal masks in which a set bit means the corresponding bit is
to be cleared). For example, ug=rwx,o= sets the mask so files won’t be readable,
writable or executable by “others”, and is equivalent (on most systems) to the octal
mask 07.
unalias builtin command

unalias [-adt] [name ...]
Remove the aliases for the given names. If the -a option is used, all aliases are
removed. If the -t or -d option is used, the indicated operations are carried out on
tracked or directory aliases, respectively.
unset builtin command

unset [-fv] parameter ...
Unset the named parameters (-v, the default) or functions (-f). The exit status is
nonzero if any of the parameters were already unset, zero otherwise.
wait builtin command

wait [job]
Wait for the specified job(s) to finish. The exit status of wait is that of the last
specified job: if the last job is killed by a signal, the exit status is 128 + the number of
the signal (see kill -l exit-status above); if the last specified job can’t be found
(because it never existed, or had already finished), the exit status of wait is 127. See
“Job control,” below, for the format of job. The wait command returns if a signal for
which a trap has been set is received, or if a SIGHUP, SIGINT or SIGQUIT signal is
received.
If no jobs are specified, wait waits for all currently running jobs (if any) to finish and
exits with a zero status. If job monitoring is enabled, the completion status of jobs is
printed (this isn’t the case when jobs are explicitly specified).
whence builtin command

whence [-pv] [name ...]
For each name, the type of command is listed (reserved word, builtin, alias, function,
tracked alias or executable). If the -p option is used, a path search is done even if
name is a reserved word, alias, and so on. Without the -v option, whence is similar to
command -v except that whence finds reserved words and doesn’t print aliases as
alias commands; with the -v option, whence is the same as command -V. Note that
for whence, the -p option doesn’t affect the search path used, as it does for command.
If the type of one or more of the names couldn’t be determined, the exit status is
nonzero.

Job control
Job control refers to the shell’s ability to monitor and control jobs, which are processes
or groups of processes created for commands or pipelines. At a minimum, the shell
keeps track of the status of the background (i.e. asynchronous) jobs that currently
exist; you can display this information by using the jobs command. If job control is
fully enabled (using set -m or set -o monitor), as it is for interactive shells, the
processes of a job are placed in their own process group, you can stop foreground jobs
by typing the suspend character from the terminal (normally Ctrl-Z), you can restart
jobs in either the foreground or background, using the fg and bg commands, and the
state of the terminal is saved or restored when a foreground job is stopped or restarted.
Note that you can stop only commands that create processes (e.g. asynchronous
commands, subshell commands, and nonbuiltin, nonfunction commands); you can’t
stop commands such as read.
When a job is created, it’s assigned a job number. For interactive shells, this number is
printed inside [...], followed by the process IDs of the processes in the job when an
asynchronous command is run. You can refer to a job in the bg, fg, jobs, kill and
wait commands either by the process ID of the last process in the command pipeline
(as stored in the $! parameter) or by prefixing the job number with a percent sign (%).
You can also use other percent sequences to refer to jobs:
%+ The most recently stopped job, or, if there are no stopped jobs, the oldest
running job.
%%, % Same as %.
%- The job that would be the %+ job, if the latter didn’t exist.
%n The job with job number n.
%?string The job containing the string string (an error occurs if multiple jobs are
matched).
%string The job starting with string string (an error occurs if multiple jobs are
matched).
When a job changes state (e.g. a background job finishes or foreground job is
stopped), the shell prints the following status information:
[number] flag status command
The fields are:
number The job number of the job.
flag + or - if the job is the %+ or %- job, respectively, or space if it’s neither.
status The current state of the job:

Running The job has neither stopped or exited (note that

running doesn’t necessarily mean consuming CPU
time — the process could be blocked waiting for
some event).
Done [(number)] The job exited. The number is the exit status of
the job, which is omitted if the status is zero.
Stopped [(signal)] The job was stopped by the indicated signal (if no
signal is given, the job was stopped by SIGTSTP).
signal-description [(core dumped)]
The job was killed by a signal (e.g. Memory fault,
Hangup, and so on — use kill -l for a list of
signal descriptions). The (core dumped)
message indicates the process created a core file.
command The command that created the process. If there are multiple processes in
the job, then each process has a line showing its command and possibly
its status, if it’s different from the status of the previous process.
When an attempt is made to exit the shell while there are jobs in the stopped state, the
shell warns the user that there are stopped jobs and doesn’t exit. If another attempt is
immediately made to exit the shell, the stopped jobs are sent a SIGHUP signal and the
shell exits. Similarly, if the nohup option isn’t set and there are running jobs when an
attempt is made to exit a login shell, the shell warns the user and doesn’t exit. If
another attempt is immediately made to exit the shell, the running jobs are sent a
SIGHUP signal and the shell exits.
emacs interactive input-line editing

When the emacs option is set, interactive input-line editing is enabled.
CAUTION: This mode is slightly different from the emacs mode in the original Korn
! shell; the 8th bit is stripped in emacs mode.
In this mode, various editing commands (typically bound to one or more control
characters) cause immediate actions without waiting for a new-line. Several editing
commands are bound to particular control characters when the shell is invoked; you
can use the following commands to change these bindings:
bind The current bindings are listed.
bind string=[editing-command]
Bind the specified editing command to the given string, which should
consist of a control character (which you can write using caret notation
ˆX), optionally preceded by one of the two prefix characters.
After invoking the bind command, typing the string causes the editing
command to be immediately invoked. Note that although only two

prefix characters (usually ESC and Ctrl-X) are supported, some

multicharacter sequences can be supported. The following binds the
arrow keys on an ANSI terminal, or xterm (these are in the default
bindings). Of course some escape sequences won’t work out quite this
nicely:
bind ’ˆ[[’=prefix-2
bind ’ˆXA’=up-history
bind ’ˆXB’=down-history
bind ’ˆXC’=forward-char
bind ’ˆXD’=backward-char
bind -l List the names of the functions to which keys may be bound.
bind -m string=[substitute]
The specified input string is afterward immediately replaced by the
given substitute string, which may contain editing commands.
The editing commands are listed below. Each description starts with the name of the
command, a n (if you can prefix the command with a count), and any keys the
command is bound to by default (written using caret notation, e.g. ASCII ESC
character is written as ˆ[). You can enter a count prefix for a command by using the
sequence ˆ[n, where n is a sequence of 1 or more digits; unless otherwise specified, if
a count is omitted, it defaults to 1. Note that editing command names are used only
with the bind command. Furthermore, many editing commands are useful only on
terminals with a visible cursor. The default bindings were chosen to resemble
corresponding emacs key bindings. The user’s tty characters (e.g. ERASE) are bound
to reasonable substitutes and override the default bindings.
abort Key binding: ˆG

Useful as a response to a request for a search-history
pattern in order to abort the search.
auto-insert n Key binding: none
Simply causes the character to appear as literal input. Most
ordinary characters are bound to this.
backward-char n Key binding: ˆB
Moves the cursor backward n characters.
backward-word n Key binding: ˆ[B
Moves the cursor backward to the beginning of a word; words
consist of alphanumerics, underscore (_) and dollar ($).
beginning-of-history
Key binding: ˆ[<
Moves to the beginning of the history.

beginning-of-line
Key binding: Â
Moves the cursor to the beginning of the edited input line.
capitalize-word n
Key binding: ˆ[c or ˆ[C
Uppercase the first character in the next n words, leaving the
cursor past the end of the last word.
If the current line doesn’t begin with a comment character, one
is added at the beginning of the line and the line is entered (as if
return had been pressed), otherwise the existing comment
characters are removed and the cursor is placed at the
beginning of the line.
complete Key binding: ˆ[ˆ[ or Î

Automatically completes as much as is unique of the command
name or the filename containing the cursor. If the entire
remaining command or filename is unique, a space is printed
after its completion, unless it’s a directory name, in which case
/ is appended. If there is no command or filename with the
current partial word as its prefix, a bell character is output
(usually causing a audio beep).
complete-command
Key binding: ˆXˆ[
Automatically completes as much as is unique of the command
name having the partial word up to the cursor as its prefix, as in
the complete command described above.
complete-file Key binding: ˆ[ˆX

Automatically completes as much as is unique of the filename
having the partial word up to the cursor as its prefix, as in the
complete command described above.
complete-list Key binding: ˆ[=

List the possible completions for the current word.
delete-char-backward n
Key binding: ERASE, ˆ?, ˆH
Deletes n characters before the cursor.
delete-char-forward n
Key binding: none
Deletes n characters after the cursor.

delete-word-backward n
Key binding: ˆ[ERASE, ˆ[ˆ?, ˆ[ˆH, ˆ[h
Deletes n words before the cursor.
delete-word-forward n
Key binding: ˆ[d
Deletes characters after the cursor up to the end of n words.
down-history n Key binding: ˆN

Scrolls the history buffer forward n lines (later). Each input line
originally starts just after the last entry in the history buffer, so
down-history isn’t useful until either search-history or
up-history has been performed.
downcase-word n Key binding: ˆ[L, ˆ[l

Lowercases the next n words.
end-of-history Key binding: ˆ[>

Moves to the end of the history.
end-of-line Key binding: Ê

Moves the cursor to the end of the input line.
eot Key binding: ˆ_

Acts as an end-of-file; this is useful because edit-mode input
disables normal terminal input canonicalization.
eot-or-delete n Key binding: ˆD

Acts as eot if alone on a line; otherwise acts as
delete-char-forward.
error Key binding: none

Error (ring the bell).
exchange-point-and-mark
Key binding: ˆXˆX
Places the cursor where the mark is, and sets the mark to where
the cursor was.
expand-file Key binding: ˆ[*

Appends a * to the current word and replaces the word with the
result of performing file globbing on the word. If no files match
the pattern, the bell is rung.
forward-char n Key binding: ˆF

Moves the cursor forward n characters.

forward-word n Key binding: ˆ[f

Moves the cursor forward to the end of the nth word.
goto-history n Key binding: ˆ[g

Goes to history number n.
kill-line Key binding: KILL

Deletes the entire input line.
kill-region Key binding: ˆW

Deletes the input between the cursor and the mark.
kill-to-eol n Key binding: ˆK

Deletes the input from the cursor to the end of the line if n is
not specified, otherwise deletes characters between the cursor
and column n.
list Key binding: ˆ[?

Prints a sorted, columnated list of command names or
filenames (if any) that can complete the partial word containing
the cursor. Directory names have / appended to them.
list-command Key binding: ˆX?

Prints a sorted, columnated list of command names (if any) that
can complete the partial word containing the cursor.
list-file Key binding: ˆXˆY

Prints a sorted, columnated list of filenames (if any) that can
complete the partial word containing the cursor. File type
indicators are appended as described under list above.
newline Key binding: ˆJ, ˆM

Causes the current input line to be processed by the shell. The
current cursor position may be anywhere on the line.
newline-and-next
Key binding: Ô
Causes the current input line to be processed by the shell, and
the next line from history becomes the current line. This is
useful only after an up-history or search-history.
no-op Key binding: QUIT

This does nothing.
prefix-1 Key binding: ˆ[

Introduces a 2-character command sequence.

prefix-2 Key binding: ˆX, ˆ[[

Introduces a 2-character command sequence.
prev-hist-word n Key binding: ˆ[., ˆ[_

The last (nth) word of the previous command is inserted at the
cursor.
quote Key binding: ˆˆ

The following character is taken literally rather than as an
editing command.
redraw Key binding: ˆL

Reprints the prompt string and the current input line.
search-character-backward n
Key binding: ˆ[ˆ]
Search backward in the current line for the nth occurrence of
the next character typed.
search-character-forward n
Key binding: ˆ]
Search forward in the current line for the nth occurrence of the
next character typed.
search-history Key binding: ˆR

Enter incremental search mode. The internal history list is
searched backwards for commands matching the input. An
initial ˆ in the search string anchors the search. The abort key
leaves search mode. Other commands are executed after
leaving search mode. Successive search-history
commands continue searching backward to the next previous
occurrence of the pattern. The history buffer retains only a
finite number of lines; the oldest are discarded as necessary.
set-mark-command
Key binding: ˆ[Space
Set the mark at the cursor position.
stuff Key binding: none

On systems supporting it, pushes the bound character back onto
the terminal input where it may receive special processing by
the terminal handler. This is useful for the BRL ˆT mini-systat
feature, for example.
stuff-reset Key binding: none

Acts like stuff, then aborts input the same as an interrupt.

transpose-chars Key binding: ˆT

If at the end of line, or if the gmacs option is set, this
exchanges the two previous characters; otherwise, it exchanges
the previous and current characters and moves the cursor one
character to the right.
up-history n Key binding: ˆP

Scrolls the history buffer backward n lines (earlier).
upcase-word n Key binding: ˆ[U, ˆ[u

Uppercases the next n words.
version Key binding: ˆV

Display the version of ksh. The current edit buffer is restored
as soon as any key is pressed (the key is then processed, unless
it’s a space).
yank Key binding: ˆY

Inserts the most recently killed text string at the current cursor
position.
yank-pop Key binding: ˆ[y

Immediately after a yank, replaces the inserted text string with
the next previous killed text string.
Files:
• ˜/.profile
• /etc/profile
• /etc/suid_profile
This shell is based on the public domain 7th edition Bourne shell clone by Charles
Forsyth and parts of the BRL shell by Doug A. Gwyn, Doug Kingston, Ron Natalie,
Arnold Robbins, Lou Salkind and others. The first release of pdksh was created by
Eric Gisin, and it was subsequently maintained by John R. MacMillan
(chance!john@sq.sq.com), and Simon J. Gerraty (sjg@zen.void.oz.au). The
current maintainer is Michael Rendell (michael@cs.mun.ca). The
CONTRIBUTORS file in the source distribution contains a more complete list of
people and their part in the shell’s development.
Report any bugs in ksh to pdksh@cs.mun.ca. Please include the version of ksh
(echo $KSH_VERSION shows it), the machine, operating system and compiler you
are using and a description of how to repeat the bug (a small shell script that
demonstrates the bug is best). The following, if relevant (if you aren’t sure, include

them), can also helpful: options you are using (both options.h options and set -o
options) and a copy of your config.h (the file generated by the configure script).
You can get new versions of ksh from ftp.cs.mun.ca:pub/pdksh/.
See also:
chmod, esh, fesh, gawk, getconf, rsh, sed, sh, stty, uesh, umask
dup(), environ(), errno, execve(), getgid(), getopt(), getuid(), open(), pipe(), rand(),
signal(), system(), wait() in the Library Reference
“Setting PATH and LD_LIBRARY_PATH” in the Configuring Your Environment
chapter of the Neutrino User’s Guide
The Korn Shell Command and Programming Language, Morris Bolsky and David
Korn, 1989, ISBN 0-13-516972-0.
UNIX Shell Programming, Stephen G. Kochan, Patrick H. Wood, Hayden.
IEEE Standard for Information Technology — Portable Operating System Interface
(POSIX) — Part 2: Shell and Utilities, IEEE Inc, 1993, ISBN 1-55937-255-9.

© 2010, QNX Software Systems GmbH & Co. KG. ld
Linker command (POSIX)
You should use qcc instead of calling ld directly.
Syntax:
ld_variant [option...] objfile
Runs on:
Options:
The ld_variant depends on the target platform, as follows:
Target platform: ld_variant:

ARM ntoarm-ld
MIPS ntomips-ld
PowerPC ntoppc-ld
SH4 ntosh-ld
x86 ntox86-ld
Description:
The ld linker combines a number of object and archive files, relocates their data, and
ties up symbol references. Usually the last step in compiling a program is to run ld.
GNU
See also:
qcc
dlopen() in the QNX Neutrino Library Reference

ldd © 2010, QNX Software Systems GmbH & Co. KG.
List the shared objects that a program requires (Unix)
Syntax:
ldd program ...
Runs on:
Neutrino
Options:
None.
Description:
The ldd (“list dynamic dependencies”) command lists the shared objects that the
specified programs require. If you don’t specify the full path for a program, ldd looks
for it in your current directory.
You can use this utility to determine which shared objects to include in an OS image;
see the Sample Buildfiles appendix in Building Embedded Systems.
It’s worth noting that ldd is also the name of the runtime linker. In the .interp
section, it’s called ldqnx.so, and it’s in libc, which is why you need to create a
symbolic link like this:
[type=link] /usr/lib/ldqnx.so.2=/proc/boot/libc.so
in your mkifs buildfiles.
Examples:
# ldd ‘which ksh‘
/bin/ksh:
libc.so.3 => /usr/lib/ldqnx.so.2 (0xb0300000)
# ldd ‘which appbuilder‘
/usr/qnx640/host/qnx6/x86/usr/photon/appbuilder/appbuilder:
libph.so.3 => /usr/lib/libph.so.3 (0xb8200000)
libphexlib.so.3 => /usr/lib/libphexlib.so.3 (0xb8311000)
libfont.so.1 => /lib/libfont.so.1 (0xb8340000)
libimg.so.1 => /lib/libimg.so.1 (0xb8348000)
libc.so.3 => /usr/lib/ldqnx.so.2 (0xb0300000)
DL_DEBUG If this environment variable is set, the shared library loader displays
debugging information about the libraries as they’re opened.

© 2010, QNX Software Systems GmbH & Co. KG. ldd
See also:
objdump
dlopen() in the QNX Neutrino Library Reference

ldrel © 2010, QNX Software Systems GmbH & Co. KG.
Relocate an executable
Syntax:
ldrel [options] infile outfile
Runs on:
QNX Neutrino
Targets:
x86
Options:
-a hex_align Change segment alignments (default to original alignment).
-b hex_addr Program base address (default to page aligned base address).

-d hex_addr Data segment address (default to just after text segment).
-f name Filename holding debug information (default to infile).
-L The specified stacksize can be lazy. The default is non-lazy.

-l (“el”) Output LOAD segments only.
-o hex_off Assume this file will be copied to another file at this offset.
-p Pad segments so they don’t share address file data.
-r Keep relocation information in target.
-S stacksize [K|M]
Note the maximum stack size in bytes, kilobytes (suffix K), or
megabytes (suffix M) as a suggestion to the loader. Specifying -S 0
resets the note; the loader will use its stack size.
-s pattern=filename
-s [!]*
-s pattern[*]
Copy sections matching pattern, from the file (if given). The section
must not overlay segments.
-t hex_addr Text segment address (default to just after headers).
-v Be verbose.
-x Expand segments with zeros to make the file size equal to memory
size.
-Z Load the whole input file into memory.

© 2010, QNX Software Systems GmbH & Co. KG. ldrel
Description:
The ldrel utility relocates executables.

less © 2010, QNX Software Systems GmbH & Co. KG.
Display files on a page-by-page basis (UNIX)
Syntax:
less [-[+]aBcCdeEfimMnNqQrsSuUw] [-b n] [-x n]
[-[z] n] [-h n] [-j n] [-p pattern]
[-y n] [-[oO] logfile] [-t tag]
[-T tagsfile] [+ cmd] [file...]
Runs on:
Neutrino
Options:
Most options may be changed while less is running, via the dash (-) command.
Options are also taken from the LESS environment variable. The environment
variable is parsed before the command line, so command-line options override the
LESS environment variable. If an option appears in the LESS environment variable,
you can reset it to its default on the command line by using the two-character
combination -+ at the beginning of the command line.
A dollar sign ($) may be used to signal the end of an option string. This is important
only for options such as -t that take a following string.
-? Display a summary of the commands accepted by less (the same as

the h command). If this option is given, all other options are ignored,
and less exits after the help screen is viewed. (Depending on how
your shell interprets the question mark, it may be necessary to quote
the question mark, as follows: -\?)
-a Start searches after the last line displayed on the screen, thus skipping
all lines displayed on the screen. By default, searches begin at the
second line on the screen (or after the last found line; see the -j
option).
-B Disable automatic allocation of buffers, so that only the default number

of buffers is used. If more data is read than fits in the buffers, the oldest
data is discarded. By default, when data is coming from standard input,
buffers are allocated automatically as needed to avoid loss of data.
-b n Use a nonstandard number of buffers. Buffers are 1K, and by default

10 buffers are used (except if data is coming from standard input; see
the -B option). The number n specifies the number of buffers to use.
-C Clear the screen, then do fullscreen redraws from the top line down. By
default, fullscreen redraws are done by scrolling from the bottom of the
screen.
-c Do fullscreen redraws from the top line down. By default, fullscreen

redraws are done by scrolling from the bottom of the screen.

© 2010, QNX Software Systems GmbH & Co. KG. less
-d Suppress the error message normally displayed if the terminal is dumb

(i.e. lacks some important capability, such as the ability to clear the
screen or scroll backward). The -d option doesn’t otherwise change
the behavior of less on a dumb terminal.
-E Automatically exit the first time end-of-file is reached. By default, the

only way to exit less is via the q command.
-e Automatically exit the second time end-of-file is reached. By default,

the only way to exit less is via the q command.
-f Force nonregular files (directories or device special files) to be opened.

Also, suppress the warning message when a binary file is opened. By
default, less refuses to open nonregular files.
-h n Don’t scroll backward any more than n lines. If it’s necessary to scroll
backward more than n lines, the screen is redrawn in a forward
direction instead. (If the terminal can’t scroll backward, -h 0 is
implied.)
-i Ignore case; uppercase and lowercase are considered identical. Also,

you can search for text that’s overstruck or underlined. This option is
ignored if any uppercase letters appear in the search pattern.
-j n Use this line on the screen to position “target” lines. Target lines are
the object of text searches, tag searches, jumps to a line number, jumps
to a file percentage, and jumps to a marked position.
The screen line is specified by a number: the top line on the screen is 1,
the next is 2, and so on. The number may be negative to specify a line
relative to the bottom of the screen: the bottom line on the screen is -1
(the number one), the second to the bottom is -2, and so on.
With the -j option, searches begin at the line immediately after the
target line. For example, if -j4 is used, the target line is the fourth line
on the screen, so searches begin at the fifth line on the screen.
-M Prompt even more verbosely than more.
-m Prompt verbosely (like more), with the percent into the file. By default,
less prompts with a colon.
-N Display a line number at the beginning of each line.
-n Suppress line numbers. The default (to use line numbers) may cause
less to run more slowly in some cases, especially with a very large
input file. Suppressing line numbers with -n avoids this problem.
Using line numbers means that the line number is displayed in the
verbose prompt and in the = command, and the v command passes the
current line number to the editor.

-O file Copy input to the named file as it’s being viewed. This applies only
when the input file is a pipe, not an ordinary file. If the file already
exists, less doesn’t ask for confirmation before overwriting it.
If no log file has been specified, you can use the -o and -O options
from within less to specify a log file. Without a filename, they simply
report the name of the log file.
-o file Copy input to the named file as it’s being viewed. This applies only
when the input file is a pipe, not an ordinary file. If the file already
exists, less asks for confirmation before overwriting it.
-p pattern Start at the first occurrence of pattern in the file. The -p option on the
command line is equivalent to specifying +/pattern.
-Q Be totally quiet; never ring the terminal bell.
-q Be moderately quiet; don’t ring the terminal bell if an attempt is made

to scroll past the end of the file or before the beginning of the file. If
the terminal has a “visual bell,” it’s used instead. The bell is rung on
certain other errors, such as typing an invalid character. The default is
to ring the terminal bell in all such cases.
-r Display “raw” control characters. The default is to display control

characters using the caret (ˆ) notation. For example, a Ctrl-A (001
octal) is displayed as Â.
Note that when -r is used, less can’t keep track of the actual
appearance of the screen (since this depends on how the screen
responds to each type of control character). Thus, various display
problems may result, such as long lines being split in the wrong place.
-S Chop, rather than fold, lines longer than the screen width. That is, the
remainder of a long line is simply discarded. The default is to fold long
lines; that is, display the remainder on the next line.
-s Squeeze consecutive blank lines into a single blank line.
-T tagsfile Use the specified tags file in place of the tags file.
-t tag Edit the file containing the specified tag. For this to work, there must
be a file called tags in the current directory.
-U Treat backspaces and carriage returns as control characters (i.e. they’re

handled as specified by the -r option).
By default, if neither -u nor -U is given, backspaces that appear
adjacent to an underscore character are treated specially: the
underlined text is displayed using the terminal’s hardware underlining
capability. Backspaces that appear between two identical characters are
also treated specially: the overstruck text is printed using the terminal’s
hardware boldface capability. Other backspaces are deleted, along with

the preceding character. Carriage returns immediately followed by a

newline are deleted; other carriage returns are handled as specified by
the -r option.
-u Treat backspaces and carriage returns as printable characters (i.e.

they’re sent to the terminal when they appear in the input).
-w Use blank lines to represent lines past the end of the file. By default, a
tilde (˜) character is used.
-x n Set tab stops every n positions (the default is 8).
-y n The maximum number of lines to scroll forward. If it’s necessary to

scroll forward more than n lines, the screen is repainted instead. The
-c or -C option may be used to repaint from the top of the screen if
desired. By default, any forward movement causes scrolling.
-[z] n Change the default scrolling window size to n lines. The default is one
screenfull. The z and w commands can also be used to change the
window size. Note that the z may be omitted (as in - n).
+ If a command-line option begins with + (plus), the remainder of that

option is taken to be an initial command to less. For example, +G tells
less to start at the end of the file rather than the beginning; and +/xyz
tells it to start at the first occurrence of xyz in the file.
As a special case, +number acts like +numberg; that is, it starts the
display at the specified line number (note, however, that this may be
slow — see the g command. If the option starts with two plus signs
(++), the initial command applies to every file being viewed, not just
the first one. The + command (described in the “Commands” section)
may also be used to set or change an initial command for every file.
file A pathname of an input file. If no file operands are specified, less

uses the standard input. If a file operand is the dash character (-), the
standard input is read at that point of the sequence.
Description:
The less utility is a program similar to more, but less allows backward movement
in the file as well as forward movement. The less utility uses the system terminal
capability database, so it can run on a variety of terminals. There’s limited support for
hardcopy terminals (on a hardcopy terminal, lines that should be printed at the top of
the screen are prefixed with up-arrow).
The less utility displays a screenfull of information, then prompts for user input by
displaying a colon (:) prompt at the bottom of the screen. Commands can then be
entered from the keyboard.

Commands:
Commands may be preceded by a decimal number, called n in the following
descriptions. The number is used by some commands, as indicated.
[n] h Help: display a summary of these commands. If you forget all

the other commands, remember this one.
[n] Space or [n] f Scroll forward n lines; default is one window (see the -z
option). If n is more than the screen size, only the final
screenfull is displayed.
[n] z Like Space, but if n is specified, it becomes the new window

size.
[n] Enter Scroll forward n lines; the default is 1. The entire n lines are
displayed, even if n is more than the screen size.
[n] d Scroll forward (down) n lines; the default is 1/2 screen size. If
n is specified, it becomes the new default for subsequent d and
u commands.
[n] b Scroll backward n lines; the default is one window (see the -z
option). If n is more than the screen size, only the final
screenfull is displayed.
[n] w Like b, but if n is specified, it becomes the new window size.
[n] k Scroll backward n lines; the default is 1. The entire n lines are
displayed, even if n is more than the screen size.
[n] u Scroll backward (up) n lines; the default is 1/2 screen size. If n
is specified, it becomes the new default for subsequent d and u
commands.
[n] r Redraw the screen.
[n] F Scroll forward, and keep trying to read when the end of the file
is reached. Normally this command is used when already at the
end of the file. It’s a way to monitor the tail of a file which is
growing while it’s being viewed. (The behavior is similar to
the tail -f command.)
[n] g Go to line n in the file; the default is 1 (beginning of file).

(Note that this may be slow if n is large.)
[n] G Go to line n in the file; the default is the end of the file. Note
that this may be slow if n is large, or if n isn’t specified and
standard input, rather than a file, is being read.

[n] p Go to a position n percent into the file. The n argument should

be between 0 and 100. This works if standard input is being
read, but only if less has already read to the end of the file.
This is always fast, but not always useful.
[n] { If a left brace ( { ) appears in the top line displayed on the

screen, the { command goes to the matching right brace, which
is positioned on the bottom line of the screen. If there’s more
than one left brace on the top line, a number n may be used to
specify the nth brace on the line.
[n] } If a right brace ( } ) appears in the bottom line displayed on the

screen, the } command goes to the matching left brace, which
is positioned on the top line of the screen. If there’s more than
one right brace on the top line, a number n may be used to
specify the nth brace on the line.
[n] ( Like {, but applies to parentheses rather than braces.
[n] ) Like }, but applies to parentheses rather than braces.
[n] [ Like {, but applies to square brackets rather than braces.
[n] ] Like }, but applies to square brackets rather than braces.
Esc Ctrl-F charchar Acts like {, but uses the two characters as open and close
brackets, respectively. For example, ESC ˆF <> could be used
to go forward to the > that matches the < in the top displayed
line.
Esc Ctrl-B charchar Acts like }, but uses the two characters as open and close
brackets, respectively. For example, ESC ˆB <> could be used
to go backward to the < that matches the > in the bottom
displayed line.
mchar Followed by any lowercase letter, marks the current position

with that letter.
’char (Single quote) Followed by any lowercase letter, returns to the

position that was previously marked with that letter. Followed
by another single quote, returns to the position at which the
last “large” movement command was executed. Followed by a
ˆ or $, jumps to the beginning or end of the file respectively.
Marks are preserved when a new file is examined, so you can
use the ’ command to switch between input files.
[n] /pattern Search forward in the file for the nth line containing the
pattern; n defaults to 1. The pattern is a regular expression, as
recognized by sed. The search starts at the second line
displayed (but see the -a and -j options, which change this).

Certain characters are special if entered at the beginning of the

pattern for the / and ? commands; they modify the type of
search rather than become part of the pattern:
! Search for lines that don’t match the pattern.

* Search multiple files. That is, if the search reaches the
end of the current file without finding a match, the search
continues in the next file in the command-line list.
@ Begin the search at the first line of the first file in the
command-line list, regardless of what is currently
displayed on the screen or the settings of the -a or -j
options.
[n] ?pattern Search backward in the file for the nth line containing the
pattern. The search starts at the line immediately before the top
line displayed.
Certain characters are special at the beginning of the pattern;
see the / command.
[n]Esc /pattern Same as /*.
[n]Esc ?pattern Same as ?*.
[n] n Repeat the previous search, for the nth line containing the last
pattern. If the previous search was modified by !, the search is
made for the nth line not containing the pattern. If the previous
search was modified by *, the search continues in the next (or
previous) file if not satisfied in the current file. There’s no
effect if the previous search was modified by @.
[n] N Repeat previous search, but in the reverse direction.
Esc n Repeat previous search, but crossing file boundaries. The

effect is as if the previous search were modified by *.
Esc N Repeat previous search, but in the reverse direction and

crossing file boundaries.
:e [filename] Examine a new file. If the filename is missing, the “current”

file (see the :n and :p commands) from the list of files in the
command line is reexamined. A percent sign (%) in filename is
replaced by the name of the current file. A pound sign (#) is
replaced by the name of the previously examined file. The
filename is inserted into the command-line list of files so that it
can be seen by subsequent :n and :p commands. If the
filename consists of several files, they’re all inserted into the
list of files and the first one is examined.
E Same as :e.

[n] :n Examine the next file (from the list of files given in the
command line). If a number n is specified, the nth next file is
examined.
[n] :p Examine the previous file in the command-line list. If a

number n is specified, the nth previous file is examined.
[n] :x Examine the first file in the command-line list. If a number n is

specified, the nth file in the list is examined.
= Print some information about the file being viewed, including

its name and the line number and byte offset of the bottom line
being displayed. If possible, this also prints the length of the
file, the number of lines in the file, and the percent of the file
above the last displayed line.
-char Followed by one of the command-line option letters, this

command changes the setting of that option and prints a
message describing the new setting. If the option letter has a
numeric value (such as -b or -h), or a string value (such as -P
or -t), a new value may be entered after the option letter. If no
new value is entered, a message describing the current setting
is printed and nothing is changed.
-+char Followed by one of the command-line option letters, this

command resets the option to its default setting and prints a
message describing the new setting. The -+X command does
the same thing as -+X on the command line. This doesn’t work
for string-valued options.
--char Followed by one of the command-line option letters, this

command resets the option to the opposite of its default setting
and prints a message describing the new setting. The --X
command does the same thing as -X on the command line.
This doesn’t work for numeric or string-valued options.
+cmd Causes the specified cmd to be executed each time a new file is
examined. For example, +G causes less to initially display
each file starting at the end rather than the beginning.
V Print the version number of less being run.
q Exit less.
v Invoke an editor to edit the current file being viewed. The

editor is taken from the environment variable EDITOR, or
defaults to vedit.
! shell_command Invoke a shell to run the shell_command given. A percent sign

(%) in the command is replaced by the name of the current file.

A pound sign (#) is replaced by the name of the previously

examined file.
!! repeats the last shell command, and ! with no shell
command simply invokes a shell. In all cases, the shell is taken
from the environment variable SHELL, or defaults to sh.
| m shell_command The m represents any mark letter. Pipe a section of the input
file to the given shell command. The section of the file to be
piped is between the current position and the position marked
by the letter. The m may also be ˆ or $ to indicate the
beginning or end of the file. If m is a dot (.) or newline, the
current screen is piped. The current screen is the minimum
amount piped in any case.
Files:
/usr/local/lib/less.hlp
Help file for less’s help command.
COLUMNS Sets the number of columns on the screen. Takes precedence over the
number of columns specified by the TERM variable.
EDITOR The name of the editor (used for the v command).
LESS Options that are passed to less automatically.
LESSEDIT Editor prototype string (used for the v command).
LINES Sets the number of lines on the screen. Takes precedence over the
number of lines specified by the TERM variable.
SHELL The shell used to execute the ! command, as well as to expand

filenames.
TERM The type of terminal on which less is being run. TERM must be
set.
TMPDIR Overrides the default location for temporary files (/tmp). The /tmp
directory or the one specified by TMPDIR must be a writable
filesystem.
Mark Nudelman

Caveats:
The = command reports the line number of the line at the top of the screen, but the
byte and percent of the line at the bottom of the screen.
If the :e command is used to name more than one file and if one of the named files has
been viewed previously, the new files may be entered into the list in an unexpected
order.
See also:
cat, clear, ctags, head, more, tail, vi

link © 2010, QNX Software Systems GmbH & Co. KG.
Create a link to a file (POSIX)
Syntax:
link existing new
Runs on:
Neutrino
Options:
existing Pathname of an existing file.
new Pathname of the new symbolic link to be created.
Description:
The link utility creates a hard link, new, that points to another file, existing. To create
a symbolic link, use ln.
Exit status:
See also:
ln, rm, unlink

© 2010, QNX Software Systems GmbH & Co. KG. ln
Create links to (aliases for) files (POSIX)
Syntax:
ln [-f|-i] [-Psv] source_file target_file
ln [-f|-i] [-Psv] source_file... target_dir
Runs on:
Options:
-f Force existing destination pathnames to be removed before linking;
don’t prompt for confirmation.
-i (QNX Neutrino extension) Run interactively; write a prompt to the

standard error output requesting confirmation for each link that would
overwrite an existing file.
-P Create the link in the process manager’s in-memory prefix tree.
-s Create a symbolic link.
-v Verbose. Write actions performed to standard output.
source_file The pathname of a file to be linked. If -s is specified, this file need not
exist.
target_file The pathname of the new directory entry to be created.
target_dir The pathname of an existing directory in which the new directory

entries are to be created.
Description:
The ln utility has two syntax forms, as follows:
ln [-f|-i] [-s] source_file target_file

The ln utility creates a new directory entry (link) at the destination path
specified by the target_file operand which points to the source_file as a hard or
symbolic link, depending on the -s option. This syntax form is assumed when
the destination path doesn’t name an existing directory.
ln [-f|-i] [-s] source_file... target_dir

For each source_file, ln creates a new directory entry at a destination path in the
existing directory named by the target_dir operand.
The destination path for each source_file is the same as its basename (final path
component). For example:

ln © 2010, QNX Software Systems GmbH & Co. KG.
ln dir/dir/myfile /existingdir
creates /existingdir/myfile as a link to dir/dir/myfile.
This second syntax form is assumed when either the destination names an
existing directory, or when more than one source file is specified.
If the destination path exists and you have write permission for the existing destination
file, or if -f was specified, ln unlinks the destination, then creates the new link.
If you don’t have write permission for an existing directory path, and -f isn’t
specified, and if the standard input is a tty, ln prompts you for confirmation prior to
unlinking the existing file. If standard input isn’t a tty, ln writes a diagnostic message
to standard error, and goes on to the next source_file without unlinking the destination
file.
To create the new link, or replace a file with a link, you need write permissions for the
directory in which the new link is going to reside. Note that root always has this
permission regardless of the file permission settings.
Hard links are limited to within the same filesystem as the original file and aren’t
permitted on directories. With symbolic links, however, you can link any pathname to
a file. A symbolic link is a special file that has the destination pathname as its data.
For more information, see the section on symbolic links in System Architecture.
If the -P option is specified, the link is created within the pathname prefix tree
maintained in memory by the QNX Neutrino process manager, procnto. This lets
you create new pathname links without the need for a traditional filesystem. If the -s
option is specified, a symbolic redirection takes place. If -s isn’t specified, a direct
link to a named resource manager is made. The resource manager named in the source
must be of the form:
nid,pid,chid,handle
where
nid Node ID of resource manager to link to.
pid Process ID of resource manager to link to.
chid Channel ID of resource manager to link to.
handle Handle of a pathname prefix of the resource manager to link to.
Most prefix links are symbolic.
Examples:
Create a link to /home/curious/monkey called gorilla in the /home/george
directory:
ln /home/curious/monkey /home/george/gorilla

© 2010, QNX Software Systems GmbH & Co. KG. ln
Create a symbolic link to the directory /home/fred called /home/barney:
ln -s /home/fred /home/barney
Create a symbolic prefix link to /dev/shmem from /tmp. This simple link maps all
temporary files created under the /tmp directory into shared memory objects, thus
implementing a RAM disk.
ln -sP /dev/shmem /tmp
Create a symbolic prefix to /dev/ser1 from /dev/modem. Any attempt to open

/dev/modem results in an open of /dev/ser1.
ln -sP /dev/ser1 /dev/modem
Exit status:
0 All the specified files were linked successfully.
Caveats:
When creating a symbolic link, ln doesn’t check that the source_file named actually
exists, or even that it’s a valid pathname. If the file doesn’t exist or if the source_file
isn’t a valid pathname, any attempts to use the link fail.
CAUTION: If a destination path exists, and ln is interrupted before ending, the

! destination path may be removed before the new link is created.
See also:
cp, ln-w, mv

ln-w © 2010, QNX Software Systems GmbH & Co. KG.
Create a “link” on Windows
Syntax:
ln-w [-s] source [destination]
Runs on:
Microsoft Windows
Options:
-s Create a symbolic link.
Description:
The ln-w utility pretends to create a link on Windows machines; it actually copies the
given file to the specified destination. If you don’t specify a destination, ln-w copies
the specified file to the basename of the source.
See also:
basename, ln

© 2010, QNX Software Systems GmbH & Co. KG. logger
Make entries in the system log (POSIX)
If you aren’t root, specify the full path: /usr/sbin/logger.
Syntax:
logger [-is] [-f file] [-p pri] [-t tag]
[message ...]
Runs on:
Neutrino
Options:
-f file Log the specified file.
-i Log the process ID of the logger process with each line.
-p pri Enter the message with the specified priority. The priority may be
specified numerically or as a facility.level pair. For example, -p
local3.info logs the message(s) as informational level in the
local3 facility. The default is user.notice.
-s Log the message to standard error, as well as the system log.
-t tag Mark every line in the log with the specified tag.
message Write the message to log; if not specified, and the -f flag isn’t provided,
standard input is logged.
Description:
The logger command provides a shell command interface to the syslogd daemon.
Examples:
Log the message “System rebooted”:
logger System rebooted

Log the file /tmp/log tagging each line with log:
logger -f /tmp/log -t log
Files:
/usr/sbin/logger
The logger utility is located in the /usr/sbin/ directory, which is not
included in the default PATH of non-root users. If you are not root, specify the
full path.

logger © 2010, QNX Software Systems GmbH & Co. KG.
SYSLOG When defined, SYSLOG specifies which node syslogd is running on.
By default, the local node is assumed.
Exit status:
Because the syslog API doesn’t return error codes, only argument errors can be
detected.
See also:
syslogd
syslog() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. login
Log in
Syntax:
login [-fpq] [-c|u] [-h host] [-t timeout]
[username [env1 env2 ...]]
Runs on:
Neutrino
Options:
-c Use only a QNX 4-compatible encryption.
-f Skip login authentication (force). This option is used to indicate that

proper authentication has already been done and no password is
required. If you’re root, it allows you to log in as username without a
password prompt. You can use this option only if you’re logged in as
root or you’re already logged in as username.
-h host Specify for login purposes that you’re connecting from host.
-p Preserve the environment. If -p isn’t specified, the environment is

cleared, and only the following variables are set: SHELL, HOME,
LOGNAME, USERNAME (same as LOGNAME), TERM (if set in
the caller’s environment), and PATH (set to the value defined by
_CS_PATH).
The environment variables set in /etc/default/login are set
whether or not -p is specified.
-q Be quiet; disable extra output messages.
-t timeout Cancel the login if no response is received within timeout number of

seconds. A value of 0 (the default) disables the timeout facility.
-u Use only a UNIX-compatible encryption.
Description:
The login command starts a session associated with a user. It’s used when someone
either first signs on to the computer, or wishes to log in as another user. If login is
invoked without a username, it prompts for one. It always prompts for a password.

login © 2010, QNX Software Systems GmbH & Co. KG.
The login command verifies the username and password against a password database
and, if verified, starts the user session. If either the username or password is
unacceptable, login asks again for both.
For compatibility, login checks the password using two encryption methods:
qnx_crypt() Compatible with QNX 4.
crypt() Compatible with UNIX (NetBSD, Linux, Solaris).
The check succeeds if either encryption matches the password. The -c and -u options
allow slightly more security by allowing only one encryption method.
The login utility sets the user ID and group ID as well as the current working
directory, then executes a shell according to specifications found in the password
database.
If execution of the shell fails, login prints the message No Shell and exits. The
shell is started with a dash (-) prepended to its name as argument 0. This informs the
shell to perform its startup routine.
The login utility sets the SHELL, HOME, LOGNAME, USERNAME (same as
LOGNAME), TERM (if set in the caller’s environment), and PATH (set to the value
defined by _CS_PATH) environment variables. For more information on setting
PATH, see “Setting PATH and LD_LIBRARY_PATH” in the Configuring Your
Environment chapter of the Neutrino User’s Guide.
The login utility also updates system accounting information in /var/log/utmp,
/var/log/wtmp, and /var/log/lastlog if they already exist.
The login utility doesn’t create /var/log/utmp, /var/log/wtmp, and

/var/log/lastlog if they don’t already exist. These files can quickly become very
big, which isn’t good on an embedded system with limited resources.
The login utility also sets the environment variables specified in the
/etc/default/login file. This file lets you specify which environment variable
settings are to be used across login sessions. If a variable isn’t set when login is
started and this file contains a default for the variable, that default is used. If the file
doesn’t contain a default for the variable, the variable is cleared by login. If a
variable is already set when login is started and -p is specified, it’s preserved, even if
the /etc/default/login file contains a default for the variable. The -p option
allows site-specific environment variables to be passed from the system startup
processes down to applications.

© 2010, QNX Software Systems GmbH & Co. KG. login
You can set environment variables by specifying them on the command line after the
username, in the form VARIABLE[=VALUE]. For example:
login thomasf APPLES=RED TOMATOES
adds the following to the new login environment:
APPLES = RED
TOMATOES = 1
Values passed on the command line are always added to the new environment
(regardless of the -p flag) and override the existing values. The SHELL, HOME,
TERM, LOGNAME, USER values set by login override the command-line values.
You can specify which environment variables are to be preserved when the -p flag
isn’t specified, by populating an /etc/default/login file with the names of the
environment variables you want to save. For example, if /etc/default/login
contains:
SYSNAME
TZ
PHOTON
then when you run login without the -p option, the SYSNAME, TZ and PHOTON
variables (if they exist) are propagated to the new environment. The values may be
overwritten by values on the command line.
You can execute login only from the login shell, or when no session is active; you
can’t nest login commands.
If you execute login from the login shell, the shell from which it is run is terminated.
This is because, by default, login is an alias for exec login.
Files:
/bin/sh The QNX Neutrino Korn shell command interpreter.
/dev/console Refers to the system console device.
/dev/log A FIFO that receives log messages for syslogd.
/dev/tty Refers to the controlling terminal for the current process.
/etc/group Defines the known groups for the system.
/etc/default/login
Sets login environment variables.
/etc/passwd Contains the user database (username, user ID, group ID, full
name, home directory, shell).
/etc/shadow Contains encrypted login password for each userid.

login © 2010, QNX Software Systems GmbH & Co. KG.
/var/log/utmp
/var/log/wtmp
/var/log/lastlog
Accounting records are appended to these files if they already
exist.
See also:
logout, newgrp, passwd, phlogin, sh, su
crypt(), endutent(), getutent(), getutid(), getutline(), pututline(), qnx_crypt(),
setutent(), utmpname() in the Library Reference
Logging In, Logging Out, and Shutting Down and Managing User Accounts in the

© 2010, QNX Software Systems GmbH & Co. KG. logout
Terminate a session (UNIX)
Syntax:
logout
Runs on:
Neutrino
Options:
None.
Description:
The logout command terminates a session. You can execute this command only from
a shell invoked by a login command; otherwise a message is printed and the logout
command is ignored.
See also:
login

lpd © 2010, QNX Software Systems GmbH & Co. KG.
Line printer spooler daemon
Syntax:
lpd [-ln] [portnum]
Runs on:
Neutrino
Options:
-l (“el”) Log valid requests received from the network. This can be useful
for debugging purposes.
-n Don’t check to see if the job host is included in /etc/hosts.equiv or

/etc/hosts.lpd. This option allows anyone on a network to print.
portnum Although the Internet port number used to rendezvous with other
processes is normally obtained with getservbyname(), you can use this
option to change the port number.
Description:
The lpd daemon makes a single pass through the printcap database, restarting any
printers that have jobs. The daemon listens for requests to:
• print files in the queue
• transfer files to the spooling area
• display the queue
• remove jobs from the queue.
In each case, lpd forks a child to handle the request, so that the parent can continue to
listen for more requests.
Access control is provided by two means:
• All requests must come from one of the machines listed in the file
/etc/hosts.equiv or /etc/hosts.lpd.
• If the rs capability is specified in the printcap entry for the printer being
accessed, lpr requests are honored only for those users with accounts on the
machine with the printer.
The lpd daemon uses simple text files as lock files for synchronization. The parent
daemon uses the file /usr/spool/output/lpd.lock, while its children use a
.lock file within each spool directory specified in the printcap file.

© 2010, QNX Software Systems GmbH & Co. KG. lpd
Both the /usr/spool/output and /etc/printcap directories must exist, or lpd

won’t run. If these directories exist, and lpd still won’t run, remove
/usr/spool/output/lpd.lock if it exists (e.g after a power failure or system
crash).
The lock file is kept in a readable ASCII form and contains two lines. The first line is
the pid of the daemon who owns the lock. The second line of the child’s lock file
contains the current job or status.
To keep a printer from filling your hard disk, a minfree file may be created in its
spool directory. This file should contain the number of blocks (in ASCII) to leave free.
If errors occur, lpd writes messages to the system log. In order to capture the log
If errors occur, lpd doesn’t send much information to standard error, but it saves lots
of information in the system log. If you have problems with lpd, the system log will
very likely help you figure out what’s wrong.
Files:
/etc/printcap Printer description file.
/usr/spool/* Spool directories.
/usr/spool/*/minfree
Minimum free space to leave.
/etc/hosts.equiv
A list of machine names that are allowed to access the printers.
/etc/hosts.lpd A list of machine names that are allowed to access the printers,
but not under the same administrative control.
See also:
/etc/hosts.equiv, lpr, lprc, lprq, lprrm, /etc/printcap, syslogd
Printing chapter of the Neutrino User’s Guide

lpr © 2010, QNX Software Systems GmbH & Co. KG.
Print on a line printer
Syntax:
lpr [-#num] [-1234font] [-cdfghlmnprstv] [-C class]
[-i [numcols]] [-J job] [-Pprinter] [-T title]
[-U user] [-wnum] [filename...]
Runs on:
Neutrino
Options:
-#num The number of copies desired of each file named. For example:
lpr -#3 foo.c bar.c more.c
results in three copies of the file foo.c, followed by three copies of

the file bar.c, etc. On the other hand:
cat foo.c bar.c more.c | lpr -#3
gives three copies of the concatenation of the files. Often a site

disables this feature to encourage use of a photocopier instead.
-[1234]font Specifies a font to be mounted on font position i.
-C class Job classification to use on the burst page. For example:
lpr -C EECS foo.c
causes the system name (the name returned by hostname) to be

replaced on the burst page by EECS, and the file foo.c to be
printed.
-c The files are assumed to contain data produced by cifplot.
-d The files are assumed to contain data from tex.
-f Use a filter that interprets the first character of each line as a

standard FORTRAN carriage control character.
-g The files are assumed to contain standard plot data.
-h Suppress the printing of the burst page.
-i [numcols] Indent the output. If the next argument is numeric (numcols), it’s
used as the number of blanks to be printed before each line;
otherwise, 8 characters are printed.
-J job The job name to print on the burst page. Normally, the first file’s
name is used.

© 2010, QNX Software Systems GmbH & Co. KG. lpr
-l Use a filter that lets control characters be printed and suppresses

page breaks.
-m Send mail upon completion.
-n The files are assumed to contain data from ditroff.
-Pprinter Force output to a specific printer. The printer argument must be a

printer name that’s defined in /etc/printcap. Normally, lpr
uses the (site-dependent) default printer, or the one specified by the
PRINTER environment variable.
-p Use pr to format the files.
-r Remove the file upon completion.
-s Use symbolic links.
-T title The title name for pr (instead of the filename).
-t The files are assumed to contain data from troff.
-U user The user name to print on the burst page, also for accounting
purposes. This option is honored only if the real userid is daemon
(or that specified in the /etc/printcap file instead of daemon),
and is intended for those instances where print filters wish to
re-queue jobs.
-v The files are assumed to contain a raster image.
-wnum Use num as the page width for pr.
filename The name of the file to print.
Description:
The lpr utility uses the spooling daemon lpd to print the named files when facilities
become available. If no names appear, the standard input is assumed.
Diagnostics
If a user other than root prints a file and spooling is disabled, lpr prints a message
saying so and won’t put jobs in the queue.
If a connection to lpd on the local machine can’t be made, lpr says that the daemon
can’t be started.

lpr © 2010, QNX Software Systems GmbH & Co. KG.
PRINTER An alternate default printer.
DONT_USE_LINK_UNLINK
Use rename() instead of link() or unlink().
Caveats:
If you try to spool a file that’s too large, it’s truncated.
If the lpd daemon has any problems (e.g. it can’t find the spool file), it might print
some diagnostics in its log file.
See also:
lpd, lprc, lprq, lprrm, pr, /etc/printcap

© 2010, QNX Software Systems GmbH & Co. KG. lprc
Control the line printers
Syntax:
lprc [command [argument ...]]
Runs on:
Neutrino
Options:
None.
Description:
The system administrator (i.e. root) uses the lprc utility to control the operation of
the line printers that are configured in /etc/printcap. You can use lprc to:
• disable or enable a printer

• disable or enable a printer’s spooling queue
• rearrange the order of jobs in a spooling queue
• find the status of printers, and their associated spooling queues and printer
daemons.
Without any arguments, lprc prompts for commands from the standard input. If
arguments are supplied, lprc interprets the first argument as a command and the
remaining arguments as parameters to the command. You can redirect standard input
so that lprc reads commands from file. You can abbreviate the commands.
Here’s a list of recognized commands:
? [command ...]
help [command ...]
Print a short description of each command specified in the argument list. If
you don’t specify a command, lprc displays a list of the recognized
commands.
abort { all | printer }
Terminate an active spooling daemon on the local host immediately and
then disable printing (preventing new daemons from being started by lpr)
for the specified printers.
clean { all | printer }
Remove any temporary files, data files, and control files that can’t be
printed (i.e. that don’t form a complete printer job) from the specified
printer queue(s) on the local machine.
disable { all | printer }
Turn the specified printer queues off. This prevents lpr from adding new to
the queue.

lprc © 2010, QNX Software Systems GmbH & Co. KG.
down { all | printer } message ...

Turn the specified printer queue off, disable printing, and put message in the
printer status file. The message doesn’t need to be quoted; the remaining
arguments are treated like echo.
You normally use the down to take a printer down, let others know why
lprq indicates the printer is down, and print the status message.
enable { all | printer }

Enable spooling on the local queue for the listed printers. This lets lpr put
new jobs in the spool queue.
exit
quit Exit from lprc.
restart { all | printer }
Attempt to start a new printer daemon. This is useful when some abnormal
condition causes the daemon to die unexpectedly, leaving jobs in the queue.
The lprq utility reports that no daemon is present when this condition
occurs. If the user is the superuser, try to abort the current daemon first (i.e.
kill and restart a “stuck” daemon).
start { all | printer }
Enable printing and start a spooling daemon for the listed printers.
status [all | printer]

Display the status of daemons and queues. If you don’t specify a printer,
lprc displays the status of all printers defined in the /etc/printcap file.
stop { all | printer }

Stop a spooling daemon after the current job completes and disable printing.
topq printer [jobnum ... ] [user ... ]

Place the jobs in the order listed at the top of the printer queue.
up { all | printer }
Enable everything and start a new printer daemon. This command undoes
the effects of down.
Files:
Errors:
?Ambiguous command
Abbreviation matches more than one command.

© 2010, QNX Software Systems GmbH & Co. KG. lprc
?Invalid command
No match was found.
?Privileged command
The command can be executed only by root.
See also:
lpd, lpr, lprq, lprrm, /etc/printcap
Printing in the Neutrino User’s Guide

lprq © 2010, QNX Software Systems GmbH & Co. KG.
Examine a line printer’s spool queue
Syntax:
lprq [-l] [-Pprinter] [jobnum ...] [user ...]
Runs on:
Neutrino
Options:
-l Print information about each of the files comprising the job entry.
Normally, lprq displays only as much information as fits on one line.
-Pprinter The printer to query. If you don’t specify a printer, lprq queries the
default line printer (or the printer identified by the PRINTER
environment variable, if it’s set). All other arguments supplied are
interpreted as user names or job numbers to filter out only those jobs of
interest.
jobnum For each job submitted (i.e. invocation of lpr), lprq reports the user’s
name, current rank in the queue, the names of files comprising the job,
the job identifier (a number that you can give to lprrm to remove a
specific job), and the total size in bytes.
The order of the jobs depends on the algorithm used to scan the
spooling directory and is supposed to be FIFO (First in First Out).
Filenames comprising a job may be unavailable (when lpr is used as a
sink in a pipeline), in which case the file is indicated as “standard
input.”
If lprq warns that there’s no daemon present (i.e. due to some
malfunction), you can use lprc to restart the printer daemon.
user Specify a particular user name.
Description:
The lprq utility examines the spooling area used by lpd for printing files on the line
printer, and reports the status of the specified jobs or all jobs associated with a user. If
you invoke lprq without any arguments, it lists any jobs that are currently in the
queue.

© 2010, QNX Software Systems GmbH & Co. KG. lprq
Files:
Caveats:
Due to the dynamic nature of the information in the spooling directory, lprq may
report unreliably. Output formatting is sensitive to the line length of the terminal; this
can result in widely spaced columns.
See also:
lpd, lpr, lprc, lprrm, /etc/printcap

lprrm © 2010, QNX Software Systems GmbH & Co. KG.
Remove jobs from a line printer’s spooling queue
Syntax:
lprrm [-Pprinter] [-] [jobnum ...] [user ...]
Runs on:
Neutrino
Options:
-Pprinter Specify the queue associated with a specific printer; otherwise, the
default printer is used.
- Remove all of the jobs that you own. If the superuser (root) uses this
flag, lprrm empties the entire spool queue.
jobnum Remove the individual job specified by the given job number. You can
get this number from the lprq utility.
user Attempt to remove any jobs queued belonging to that user (or users).
This form of invoking lprrm is useful only to the superuser.
Description:
The lprrm utility removes one or more jobs from a printer’s spool queue. Since the
spooling directory itself is protected from users, lprrm is normally the only way that
you can remove a job. The job’s owner is determined by the user’s login name and
hostname on the machine where the lpr command was invoked.
Note that if you don’t specify any arguments or options, lprrm deletes the currently
active job if you own it.
The lprrm utility announces the names of any files it removes and is silent if the
queue contains no jobs that match the request list.
The utility kills off an active daemon, if necessary, before removing any spooling files.
If a daemon is killed, a new one is automatically restarted upon completion of file
removals.
Files:

© 2010, QNX Software Systems GmbH & Co. KG. lprrm
Errors:
Permission denied
Displayed when you try to remove print jobs that aren’t yours.
Caveats:
Since there are race conditions possible in the update of the lock file, the currently
active job may be incorrectly identified.
See also:
lpd, lpr, lprc, lprq, /etc/printcap

ls © 2010, QNX Software Systems GmbH & Co. KG.
List directory contents (POSIX)
Syntax:
ls [-1CFRacdilqrstu] [-DLSbfghnopv] [file...]
Runs on:
Options:
-1 (“One”) Force output to be one entry per line.
-a List all files, including hidden ones i.e. those that start with a dot (.). By
default, these entries aren’t listed.
-C Display multiple-column output, with entries sorted down the columns

according to the collating sequence.
-c For sorting (-t) or printing (-l), use time of last change to the file’s status
information instead of time of last modification of the file itself.
-d Treat directories like files — give information on the directory itself, not on the
files or subdirectories it contains.
-F Indicate the filetype by adding an extra character after some pathnames, as

follows:
Character Meaning
/ Directories
* Executable files
| FIFOs (named pipes)
# Named special files (QNX Neutrino extension)
@ Symbolic links (QNX Neutrino extension)
-i For each file, print the file’s serial number.
-l (“el”) List in long format. This option provides most of the relevant file
information (filetype, permissions, link count, owner/group of the file, as well
as the size, date, and name of the file), as follows:
drwxrwxrwx 7 0 0 22528 Jan 17 15:38 Csrc
-rw-rw-rw- 1 0 0 22 Feb 14 13:41 barney
-rwxrwxrwx 1 0 0 22 Feb 14 13:41 exec
-rw-rw-rw- 1 0 0 22 Feb 14 13:41 fred
drwxrwxrwx 2 0 0 23040 Feb 12 10:56 libtests
drwxrwxrwx 2 0 0 2048 Sep 28 06:39 util
To see a header above the columns, use the -h option.

© 2010, QNX Software Systems GmbH & Co. KG. ls
Note that the 10-character field (e.g. “drwxrwxrwx”) describes the filetype
and permissions (see below).
-q Force filename characters that aren’t included in the character set classification
in the current locale to be displayed as a question mark (?). This is the default
if output is to a terminal.
-R Recursively list all subdirectories encountered.
If you’re using Qnet, doing something like ls -R /net can take a very long time
because it recursively lists all the directories on all the machines on your network.
-r Reverse the order of the sort to get either oldest files first (if files are being
sorted by time) or reverse collating sequence.
-s Display the size of the file in 512-byte blocks.
-t Sort by time modified (most recently modified first) before sorting the files by
the collating sequence.
-u For sorting (-t) or printing (-l), use time of last access (i.e. last use), instead
of time of last modification of the file.
file The pathname of a file to be listed. If the file specified isn’t found, a diagnostic
message is output on standard error. Files are displayed in command-line
sequence.
QNX Neutrino extensions:

-b Use the size of the file for sorting and printing. Sort in descending order.
-D Display directories only.
-f Don’t sort the output (same as -S).
-g List in long format, as in ls -l, but don’t show owner (group is displayed).
-h Display a header for the -l (“el”) and -n options.
-L Resolve symbolic links instead of showing them.
-n Same as -l (“el”), except display group ID and user ID numbers instead of

names.
-o List in long format, as in ls -l, but don’t show group (owner is displayed).
-p Display a list of relative pathnames for all nondirectory files. The files are
listed one to a line. This option allows you to pass full pathnames of files to
programs.

-S Don’t sort the output. This option is useful for determining the order in which
entries are found in a given directory.
-v List directories first.
Description:
For each file you name that isn’t a directory, ls displays the file’s name as well as any
information requested on the file.
For each directory you name, ls displays the names of files contained within that
directory, as well as any information requested on the files. The -d option overrides
this behavior and makes ls display information on the directory itself, rather than on
its contents.
If you specify more than one file, ls displays files that aren’t directories first.
Directories and nondirectories are sorted separately.
If you don’t specify a file, ls displays the contents of the current directory.
Specifying more than one of the -C, -l (“el”), and -1 (“one”) options isn’t considered
an error. The last option specified determines the output format.
In many environments, the ls command is “aliased” to either ls -C or ls -CF, the
two most common ls display formats. Unless the POSIX_STRICT environment
variable is set, ls defaults to the multi-column output (-C option).
The -p option is useful for passing a list of all nondirectory filenames, one filename
per line, to other programs. The filenames include the full pathnames.
When displaying a timestamp for a file, ls displays the date and time, unless the file is
older or newer than the current date by six months (a “month” is defined as 30 days).
Otherwise, ls displays the date and year.
If you use the -l (“el”) or -s option — or the -n, -g, or -o options, which imply
them — and you list a directory, the output includes the total number of 512-byte
blocks that the directory occupies. This total doesn’t include the space occupied by
any subdirectories. For example:
$ ls -l /etc/rc.d
total 28
-rwxrwxr-x 1 root root 1515 Apr 30 2001 rc.devices
-rwxrwxr-x 1 root root 354 Apr 08 14:37 rc.local
-rwxrwxr-x 1 root root 321 Dec 23 2004 rc.local˜
-rwxrwxr-x 1 root root 6767 May 31 2001 rc.setup-info
-rwxrwxr-x 1 root root 2993 May 07 2002 rc.setup-once
-rwxrwxr-x 1 root root 1271 Apr 21 2002 rc.sysinit
Filetype and permissions

In the long format (-l option), the 10-character field (e.g.“drwxrwxrwx”) describes
the filetype and permissions. The first character represents the filetype; the rest of the
characters represent the read/write/executable permissions for the owner, group, and
other classes.

© 2010, QNX Software Systems GmbH & Co. KG. ls
In the first position, the following characters are used to indicate the filetype:
Character Meaning
- Regular file
b Block special file
c Character special file
d Directory
l Symbolic link
n Named special file
p FIFO (pipe)
s Unix domain socket
The remaining nine characters represent the owner, group, and other permissions; each
class has a three-character field. For each class, the characters and the first two
positions are as follows:
Position Character Meaning

First r or - The file is readable or not
Second w or - The file is writable or not
For the third position, several characters are possible:
Character Meaning
S If a file, it isn’t executable and is setuid (if in the owner field) or
setgid (if in the group field).
If a directory, it isn’t searchable. All files within that directory inherit
the permissions of the directory, not of the creator of the files.
s The file is executable or the directory is searchable. The user/group

ID modes are set, and the directory-driven inheritance is as with S.
T Sticky bit is set and x isn’t set.
t Sticky bit is set and x is set.
x The file is executable or the directory is searchable.
- None of the attributes (S, s, T, t, or x) applies.

COLUMNS If this variable contains a string representing a decimal integer,
it indicates the user’s preferred column position width for
displaying multiple-column output. The ls utility calculates
how many pathname text columns to display (see -C) based on
the width provided. If COLUMNS isn’t set or is invalid, the
number of columns displayed is determined by the type of
output device.
POSIX_STRICT Interpret options according to POSIX specifications.
TZ Determines the time zone for date and time displays.
Exit status:
0 All files were listed successfully.
See also:
chmod, find, which

© 2010, QNX Software Systems GmbH & Co. KG. lsm-autoip.so
AutoIP negotiation module for link-local addresses
Syntax:
mount -Tio-pkt [-o option,option,...] lsm-autoip.so
Runs on:
Neutrino
Options:
if =interface Specify the interface on which the AutoIP service is started. Only one
interface is supported at one time. The default is en0.
ip=address Attempt to claim address for the link-local address. If this fails, a
random address is attempted until an unused IP address is found. You
can use this option to force the AutoIP module to use a certain initial
IP address. By default, this is a random IP address based on the MAC
address of the interface. The same initial IP address would be chosen
for a specific MAC address. This option is specified in dotted numeric
notation.
debug Enable debugging in verbose mode. Debug messages are logged to

slogger.
abandon Abandon the link-local address AutoIP is using. By default, the

AutoIP module attempts to defend the link-local address it’s using.
Therefore, it challenges other hosts on its use of the address. If the
other host persists, the AutoIP module releases its IP address, and
chooses another. If you use this option, the AutoIP module releases
the IP address as soon as a conflict is detected.
delay=ms Set the delay before packets are transmitted. This affects the PROBE
packets only. The delay is specified in milliseconds. You can set this
option for a range of 8000 to 1 ms. The default is 2000 ms. You may
want to set a shorter delay if your network isn’t connected with
Ethernet switches.
force Even if interface obtained is a routable IP, force a Link Local IP

address. (default is to leave Link Local IP untouched. See the Caveats
below)
Description:
The AutoIP module (lsm-autoip.so) configures a specified interface with a
link-local IP address by negotiating with neighboring hosts. If no host on the local
network is using the IP address that the module has chosen, the interface is configured
with the chosen address.

lsm-autoip.so © 2010, QNX Software Systems GmbH & Co. KG.
The AutoIP module chooses its address from the IANA registered IP address network
of 169.254/16. Some of this network is reserved for special purposes, so the available
addresses are from 169.254.1.0 to 169.254.254.255.
Once an IP address is chosen and configured, the AutoIP module continues to monitor
the network for address conflicts, and either defends or changes the address assigned
to the interface to correct conflicts.
Only one interface can be supported at one time. The module can be loaded only once.
The interface that AutoIP is servicing, must exist before AutoIP module being loaded.
When the AutoIP module configures a TCP/IP interface with an IP address, it does so
as an alias. This way, if the interface already has an IP address, it won’t delete the
original address; the interface is assigned both addresses. This allows the module to
coexist with dhcp.client.
Examples:
These examples assume a manual configuration in combination with AutoIP.
Configuring the interface:
ifconfig en0 alias 10.0.0.1
Unconfiguring the interface:
ifconfig en0 delete 10.0.0.1
Don’t execute the following:
ifconfig en0 delete
This following command line mounts the AutoIP module to service interface en0. The
initial link-local IP address that it PROBEs for is 169.254.20.20; it has a 200 ms delay
between PROBE packets. If an IP address conflict is detected after the interface has
been configured, it releases the address immediately.
mount -T io-pkt -oif=en0,ip=169.254.20.20,debug,delay=200,abandon lsm-autoip.so
Caveats:
The dhcp.client would delete the link-local IP address on an interface, after it has
configured a routable IP address on the interface. This implies that if you already have
some connection to other hosts using your link-local IP address, those links will be cut
off. If later on dhcp.client obtained is an routable IP address.If this is a concern,
you can use the force option to force the link-local address exist.
You can manually delete your routable IP address or link-local IP address. Just make
sure you pass the address you want to delete into ifconfig. If you specify the force
option, then you won’t be able to remove link-local address.

© 2010, QNX Software Systems GmbH & Co. KG. lsm-autoip.so
See also:
dhcp.client, ifconfig, netstat

lsm-pf-v4.so, lsm-pf-v6.so © 2010, QNX Software Systems GmbH & Co. KG.
Provide IP filter services
The io-pkt-* manager looks for the correct version of this module when you mount
it (i.e. lsm-pf-v4.so with io-pkt-v4 and io-pkt-v4-hc; lsm-pf-v6.so with
io-pkt-v6-hc.
Syntax:
mount -Ttcpip lsm-pf.so
Runs on:
Neutrino
Options:
None.
Description:
The lsm-pf-v4.so and lsm-pf-v6.so shared objects are the modules that handle
IP filtering and NAT (Network Address Translation) services. You need to load these
libraries to enable filtering and NAT functionality.
IP filtering allows your host to act as a firewall, or you can provide firewall services on
your host. NAT allows multiple hosts on a subnet to share a common IP address.
You use configuration files to set the filtering and NAT rules. For more details, see the
documentation for pf.conf.
See also:
io-pkt-* pf, pf.conf, pfctl
Packet Filtering and Firewalling chapter of the Core Networking User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. lsm-qnet.so
Transparent Distributed Processing (native QNX network) module
Syntax:
io-pkt ... -p qnet [option[,option]...]
Runs on:
Neutrino
Options:
• The lsm-qnet.so DLL has many options to alter how Qnet functions (e.g.
timeouts, retries, and idle times), but Qnet is optimized to function with its default
settings. Don’t use these options unless you’re trying to overcome an issue related
to your environment. Using these options can have a negative effect if used
incorrectly.
• Use commas, not spaces, to separate the options.
auto_add=X When qnet starts up, the builtin io-pkt Ethernet (en)
resolver broadcasts its own mappings on all interfaces. This
option specifies the time interval, in ticks (see the
periodic_ticks option), after which the builtin io-pkt
Ethernet (en) resolver rebroadcasts its own mappings on all of
its interfaces. This has the effect of automatically populating
the /net directory with all of the connected nodes.
The default is 150 ticks, which represents 30 seconds. The
value 0 is special because it not only stops the broadcasted
transmissions, but it causes unsolicited received broadcasts to
be discarded. This has the effect of populating the /net
directory only with nodes that applications on the local node
specifically open.
bind=enX Specify the interface (e.g. bind=en0) to use. All

/dev/io-net/enX interfaces are used by default. When you
specify more than one bind option, Qnet uses all the specified
interfaces. This is the fastest packet transport.
The combination of bind=en and resolve=dns is invalid.
bind=ip Instead of using raw (DIX blue-book) ethernet packets,

encapsulate Qnet packets with an IP header using its registered
protocol number. This is useful on larger networks where
simple L2 switching isn’t possible, and all packets must be
routed.

lsm-qnet.so © 2010, QNX Software Systems GmbH & Co. KG.
If you use the bind=ip option, you also need to use the
resolve=dns option. The resolver is used to map the node
name to the IP address; you can’t use the default resolver with
the bind=ip option.
conn_est_retries=X
The number of times QoS should retry to establish a
connection before giving up. The default is 1.
conn_est_timeout=X
The number of periodic ticks before QoS should retransmit a
connection-establishment request. The default is 1.
conn_up_idle=X The number of periodic ticks until QoS should conclude that a
connection is idle without any traffic and should be polled with
a heartbeat. The default is 50 ticks (10 seconds).
conn_up_retries=X
The number of unanswered connection heartbeats before QoS
concludes that a connection is down. The default is 6.
do_crc=X Enable (1) or disable (0) software-level CRC checking of

packets by L4. The default is 0. When you disable CRC
checking, it yields the best performance on reliable hardware.
enforce_crc=num If you use this option in combination with do_crc, only

packets that contain a valid CRC are accepted. This option has
an effect only when do_crc is also set to 1. Setting
enforce_crc to one causes packets that are received without
a valid software-level CRC generated by the remote mode (i.e.
it’s running do_crc=0) to be discarded, because the packet
content’s integrity is unknown, and could be suspect. The
default is zero, which allows received packets without a
generated software-level CRC to be processed.
host=hostname Change the hostname of the machine.
mapany=map_uid Map any incoming user ID to map_uid and map its group ID to
that of map_uid.
maproot=map_uid If the incoming user ID is 0, map it to map_uid and map its

group ID to that of map_uid.
max_num_l4s=num Specify the number of interfaces. The default is two, and the
maximum is four.
max_tx_bufs=num The number of Tx buffers that Qnet holds in reserve before

allocating more; the default is 500. If your application sends
large messages, you may want to increase this value for
performance. If your application typically sends small

messages (most default system traffic is small messages), you

may want to decrease this value to save memory.
mount=directory[:[.]domain]]*
Specify a network directory. The default directory is /net.
The default domain is either the hostname domain, if it has
one, or the directory with the slashes changed to dots and
reversed. For example, /net/outside/canada has a domain
of canada.outside.net. The first mount is the default
directory and domain that the local hostname resolves through.
mtu_en=num Specify the maximum transmission unit (MTU) of a Qnet

packet. The num argument must be greater than 100, and all
nodes in network must use the same value. The default is 1500.
no_ack=X Whether or not to generate and expect ACK packets. These

packets are required to guarantee data delivery over networks
that may lose packets, e.g. Ethernet. The value of X can be:
0 Generate and expect ACK packets (the default).

1 Don’t generate or expect ACK packets. Specify this
value only when it isn’t possible for a packet to be lost.
Configure all hosts on the network to use the same value for the no_ack option.
no_slog=X Specifying a nonzero value to this option instructs Qnet not to

log errors or events to slogger. You can use this option to
squelch events caused by a noisy network when you’re looking
for non-network events in the sloginfo output. By default,
Qnet logs events to slogger, which corresponds to a zero
value for no_slog.
periodic_ticks=X
The number of times per seconds that QoS/L4 should wake up
to perform periodic housekeeping tasks. The value must be in
the range from 1 to 1000; the default is 5, resulting in a default
200 ms tick.
If you change the value of periodic_ticks, you’ll affect the timing of all other
options that rely on the timer tick.
probe_no_l4_time=X
The number of periodic ticks after which QoS should probe a
connection on an interface for which there is no mapping for
the remote node with a broadcasted packet. The default is the
same as the value of conn_up_idle.

qos_per_pri=num
qos_tx_pri=num The priority to use for the pulse for the QoS periodic
transmission thread and the QoS transmission thread.
We recommend that you not change these values; we supply the qos_per_pri and
qos_tx_pri options for the rare cases where you need to change the priority of the
io-pkt subsystems.
qos_verbose=X The level of verbosity of the output related to connection

management by the QoS. The default is 0; the bigger the
number, the more verbosity. This option is used for diagnosis.
res_retries=X The number of retries the Ethernet resolver will perform during
an attempted node resolution before giving up. The default is 2.
res_ticks=X The number of periodic ticks before the Ethernet resolver

retransmits a node resolution request. The default is 1.
resolve=resolver[:resolver_parameter]
Add to the resolver list for mountpoints that follow.
The following values for resolver are built into the network
manager:
• en_ionet — broadcast requests for name resolution on the
LAN (similar to the TCP/IP ARP protocol). This is the
default.
• dns — Take the node name, add a dot (.) followed by the
node domain, and send the result to the TCP/IP
gethostbyname() function.
• file — The resolver_parameter is is the name of the file
to use; the default is /etc/qnet_hosts. The format of the
file is as follows:
# This is a comment line
host.domain addr1[,addr2]
...
The host.domain represents a Qnet fully qualified domain

name (FQDN). The addr1 and optional addr2 are the
interface addresses for the FQDN. For bind=en, the format
of an address is xx:xx:xx:xx:xx:xx (the MAC address).
If you specify something else, Qnet attempts to load
nr-resolver.so. The default name resolver is en_ionet. For
queries how to create nr-resolver.so, please contact QNX
support.

The following combinations aren’t supported:

• bind=en and resolve=dns
• bind=ip and resolve=file
ret_drvr_rx_buf=X
How L4 should handle the received (rxd) packets:
• 0 — hold onto multiple rxd packets during reassembly (the
default). This results in the best performance.
• 1 — make a copy of the data in the packets and immediately
return the packet buffers to the driver. This is useful when
there’s a limited number of packet buffers provided by the
driver.
slow_mode=X The number of ticks after which to forget about the slow
transmit mode (i.e. tightly windowed) for a node. The default
is 1200, giving 240 seconds or four minutes. The value 0 is
special; it disables slow mode entirely.
tx_retries=X The number of times Qnet should retry a transmission before

giving up. The default is 25.
tx_ticks=X The number of periodic ticks before L4 retransmits a

transmission request. The default is 1.
vtag=tag_number Cause Qnet to insert a four-byte vlan tag into the packet. The
tag_number must be greater than zero. If you use this option,
Qnet accepts only packets that have a tag value that matches
the given tag_number. If the driver being used doesn’t support
1518-byte packets, you must also use the Qnet mtu_en=1496
option.
Description:
The lsm-qnet.so is the lightweight version of the QNX manager that implements
native Neutrino networking, Transparent Distributed Processing (TDP).
The QoS software layer implements the node-to-node session protocol and handles the
selection of transmission media.
L4 is a software layer beneath the QoS that implements an ISO level-4 style transport
to provide guaranteed, non-duplicate delivery of data, using the driver layer below it.

You can’t umount Qnet, but you can create an io-pkt producer module that supports
unmounting.
If you specify two or more resolve= options in a series, the resolvers form a list of
lookups for the directory specified in the subsequent mount= options.
A list of resolvers is terminated by a mount= option. Any resolve= options placed
after a mount= option form a new list — they don’t add to the previous list.
For example, the following line:
resolve=a,resolve=b,mount=x,mount=y,resolve=c,mount=z
specifies that:
• mount=x has resolvers a and b
• mount=y also has resolvers a and b
• mount=z has only resolver c
Once Qnet has a domain, you can’t set Qnet to not use a domain; you can only change
the domain.
Examples:
You can start Qnet in two ways: either you start it at the same time as io-pkt, or
afterward with the mount utility.
Start a network driver, Qnet, and TCP/IP at once, with Qnet using the default DIX blue
book ethernet packet type with no CRC checking, and 1024 descriptors for maximum
performance:
io-pkt -d speedo transmit=1024,receive=1024 -p qnet -p tcpip
Start io-pkt, and then use the mount command to start the driver and Qnet in
sequence, using the actual file names of the shared libraries:
io-pkt
mount -T io-pkt -o transmit=1024,receive=1024 devn-speedo.so
mount -T io-pkt lsm-qnet.so
These shared libraries (with the .so extension) are actually located in /lib/dll. The
mount utility automatically looks for them there. If you wish, you can give the full
pathname to the mount utility.
The following example shows how you start everything at once using IP packet
encapsulation instead of DIX blue book:
io-pkt -d speedo transmit=1024,receive=1024 -p qnet bind=ip,resolve=dns -p tcpip
See mount and io-pkt for more information.

Files:
/dev/io-net The directory where, by default, protocol modules and legacy
io-net drivers add entries. For more information, the
documentation for io-pkt.
/etc/system/config/useqnet
If this file exists, your system is using the default startup files, and
io-pkt is running when your system starts up, the system
automatically loads lsm-qnet.so. For more information, see the
Controlling How Neutrino Starts chapter of the Neutrino User’s
Guide.
/proc/qnetstats
An entry that Qnet places in the /proc filesystem. If you open this
name and read from it, the Qnet resource manager code responds
with the current statistics for Qnet.
Caveats:
Qnet doesn’t fully support communication between a big-endian machine and a
little-endian machine. However, it does work between machines of different processor
types (e.g. ARMLE, x86) that are of the same endian-ness. If you require cross-endian
networking with Qnet, please contact your QNX sales representative.
See also:
devn-*, devnp-*, io-pkt
Using Qnet for Transparent Distributed Processing in the QNX Neutrino User’s Guide
Native Networking (Qnet) in System Architecture
Transparent Distributed Processing Using Qnet in the QNX Neutrino Programmer’s
Guide

lwresd © 2010, QNX Software Systems GmbH & Co. KG.
Lightweight resolver daemon
Syntax:
lwresd [-c config-file] [-C config-file] [-d debug-level] [-f]
[-g] [-i pid-file] [-m flag] [-n num_cpus] [-P port]
[-p port] [-s] [-t directory] [-u user] [-v]
[-4] [-6]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?lwresd+8+NetBSD-5.0 in the
Description:
The lwresd utility is the daemon providing name-lookup services to clients that use
the BIND 9 lightweight resolver library. It’s essentially a stripped-down, caching-only
name server that answers queries using the BIND 9 lightweight resolver protocol
rather than the DNS protocol. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?lwresd+8+NetBSD-5.0 in the NetBSD
documentation.
See also:
named in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. m4
Macro processor (GNU)
Syntax:
m4 [options] [files]
Runs on:
Options:
See http://www.gnu.org/software/m4/manual/.
Description:
The m4 utility is a macro processor, in the sense that it copies its input to the output,
expanding macros. For detailed documentation, see
http://www.gnu.org/software/m4/manual/.

/usr/share/misc/magic © 2010, QNX Software Systems GmbH & Co. KG.
Magic-number file for the file command (UNIX)
Name:
Description:
The file command identifies the type of a file using, among other tests, a test for
whether the file begins with a certain magic number. The file
/usr/share/misc/magic specifies what magic numbers are to be tested for, what
message to print if a particular magic number is found, and additional information to
extract from the file.
Each line of the file specifies a test to be performed. A test compares the data starting
at a particular offset in the file with a 1-byte, 2-byte, or 4-byte numeric value or a
string. If the test succeeds, a message is printed. The line consists of the following
fields:
offset A number specifying the offset, in bytes, into the file of the data which is
to be tested.
type The type of the data to be tested. The possible values are:
byte A one-byte value.

short A two-byte value (on most systems) in this machine’s native
byte order.
long A four-byte value (on most systems) in this machine’s native
byte order.
string A string of bytes.
date A four-byte value interpreted as a UNIX date.
beshort A two-byte value (on most systems) in big-endian byte
order.
belong A four-byte value (on most systems) in big-endian byte
order.
bedate A four-byte value (on most systems) in big-endian byte
order, interpreted as a UNIX date.
leshort A two-byte value (on most systems) in little-endian byte
order.
lelong A four-byte value (on most systems) in little-endian byte
order.
ledate A four-byte value (on most systems) in little-endian byte
order, interpreted as a UNIX date.
The numeric types may optionally be followed by & and a numeric

value, to specify that the value is to be ANDed with the numeric value
before any comparisons are done. Prepending a u to the type indicates
that ordered comparisons should be unsigned.

© 2010, QNX Software Systems GmbH & Co. KG. /usr/share/misc/magic
test The value to be compared with the value from the file. If the type is
numeric, this value is specified in C form; if it’s a string, it’s specified as
a C string with the usual escapes permitted (e.g. \n for newline).
Numeric values may be preceded by a character indicating the operation
to be performed:
• =, to specify that the value from the file must equal the specified value
• <, to specify that the value from the file must be less than the
specified value
• >, to specify that the value from the file must be greater than the
specified value
• &, to specify that the value from the file must have set all of the bits
that are set in the specified value
• ˆ, to specify that the value from the file must have clear any of the
bits that are set in the specified value
• x, to specify that any value matches.
If the character is omitted, it’s assumed to be =.
Numeric values are specified in C form; e.g. 13 is decimal, 013 is octal,
and 0x13 is hexadecimal.
For string values, the byte string from the file must match the specified
byte string. The operators =, < and > (but not &) can be applied to
strings. The length used for matching is that of the string argument in the
/usr/share/misc/magic file. This means that a line can match any
string, and then presumably print that string, by doing >\0 (because all
strings are greater than the null string).
message The message to be printed if the comparison succeeds. If the string

contains a printf() format specification, the value from the file (with any
specified masking performed) is printed using the message as the format
string.
Some file formats contain additional information that’s to be printed along with the file
type. A line that begins with the character > indicates additional tests and messages to
be printed. The number of > characters on the line indicates the level of the test; a line
with no > at the beginning is considered to be at level 0. Each line at level n+1 is
under the control of the line at level n most closely preceding it in the magic file.
If the test on a line at level n succeeds, the tests specified in all the subsequent lines at
level n+1 are performed, and the messages printed if the tests succeed. The next line
at level n terminates this.
If the first character following the last > is a (, then the string after the parenthesis is
interpreted as an indirect offset. That means that the number after the parenthesis is
used as an offset in the file. The value at that offset is read, and is used again as an
offset in the file. Indirect offsets are of the form: ((x[.[bsl]][+-][y]). The value

/usr/share/misc/magic © 2010, QNX Software Systems GmbH & Co. KG.
of x is used as an offset in the file. A byte, short or long is read at that offset depending
on the [bsl] type specifier. To that number the value of y is added and the result is
used as an offset in the file. The default type if one isn’t specified is long.
Caveats:
The formats long, belong, lelong, short, beshort, leshort, date, bedate,
and ledate are system-dependent; perhaps they should be specified as a number of
bytes (2B, 4B, etc), since the files being recognized typically come from a system on
which the lengths are invariant.
There’s (currently) no support for specified-endian data to be used in indirect offsets.
See also:
file

© 2010, QNX Software Systems GmbH & Co. KG. make
Maintain, update, and regenerate groups of programs (POSIX)
Syntax:
make [options] [macro=name] [target]
Runs on:
Options:
-C directory Change to the given directory before doing anything.
-d Display debugging information.
-e Cause environment variables to override macro assignments within

makefiles.
-f makefile Use the description file makefile. If the pathname is the dash
character (-), standard input is used. The default file is makefile or
Makefile.
If there are multiple instances of this option, they’re processed in the
order specified.
-h Display help information.

-i Ignore error codes returned by commands. This is equivalent to the
special .IGNORE: target.
-I directory Search directory for included makefiles.

-j [N] Allow N jobs at once. The default is infinite.
-k If an unignored error occurs while executing the commands to bring

a target up-to-date, abandon work on the current target, but continue
with targets that don’t depend on the current target. This is the
opposite of -S. If both -k and -S are specified, the last one specified
is used.
-l [N] Don’t start multiple jobs unless the load is below N. If N isn’t
specified, this option removes a previous load limit.
-n No-execution mode. Print commands, but don’t execute them.
However, lines preceded by a plus sign (+) prefix or containing the
string $(make) are executed. Lines beginning with an @ are printed.
-o file Consider file to be very old and don’t remake it.

-p Write to standard output the complete set of macro definitions and
target descriptions.
-q Question mode. The make utility returns a zero or nonzero status

code, depending on whether or not the target file is up-to-date.
Targets aren’t updated if this option is specified.

make © 2010, QNX Software Systems GmbH & Co. KG.
-r Clear the suffix list and don’t use the default inference rules.
-s Be silent. Don’t print command lines before executing them. This is

equivalent to the special .SILENT: target.
-S Undo the effect of the -k option. Stop processing when a nonzero

exit status is returned by a command. If both -k and -S are
specified, the last one specified is used. This option overrides the
presence of the k flag in the MAKEFLAGS environment variable.
-t Touch the target files, changing only the file date, rather than
perform the rules to reconstruct them.
-v Print the version number of make, and then exit.
-w Print the current directory.
-W file Consider file to be infinitely new.
--no-print-directory
Turn off -w, even if it was turned on implicitly.
--warn-undefined-variables
Warn when an undefined variable is referenced.
target_name The target to bring up-to-date. If no target is specified, make uses the
first target defined in the first makefile encountered.
macro=name Macro definition. This definition remains fixed for the make
invocation. It overrides any regular definitions for the specified
macro within the makefiles and from the environment. This
definition is inherited by subordinate make sessions but acts as an
environment variable for these. That is, depending on the -e setting,
it may be overridden by a makefile definition.
Description:
The make utility is used to maintain current versions of files by resolving time
dependencies. If the file that make is examining (i.e. the target) is older than the file(s)
on which it depends (i.e. the prerequisites), then make executes a list of shell
commands associated with the target to create or update the target.
To control what make does, the utility refers to specifications (rules) consisting of a
target, prerequisites, and a list of shell commands to be executed when a prerequisite is
newer than the target. To simplify maintenance of programs, make has a collection of
default macros and inference rules allowing it to identify the proper procedures
required to update targets based on minimal information. (If the -r option is given, the
builtin rules aren’t used.)
For example, to compile myprog.c and produce the executable program myprog:

make myprog
This works even in the absence of a makefile. The alternative of using the qcc utility
produces an executable named a.out by default. Using make for compiling
single-source executables is a convenient shortcut.
When cross compiling, you can’t rely on the default rules; you need to specify the
target.
The make utility attempts to perform the actions required to ensure that the specified
target(s) are up-to-date. A target is considered out-of-date if it’s older than any of its
prerequisites. The make utility treats all prerequisites as targets themselves and
recursively ensures that they’re up-to-date. The utility examines the modified times of
files to determine whether they’re out-of-date.
After all the prerequisites of a target are ensured to be up-to-date, and if the target is
out-of-date, the shell commands associated with the target entry are executed. If no
shell commands are listed for the target, it’s treated as up-to-date.
For more information on make and writing makefiles, see the GNU website at
Examples:
make myfile.o
Typing this in the absence of a makefile (or with a makefile that doesn’t mention the
myfile.o file) uses the builtin suffixes list and inference rules to determine the name
of the source file and, if necessary, to run the proper command to create or rebuild the
myfile.o file.
Suppose you have the source files myfile1.c, myfile2.c, and myfile3.c. The
first two files include the headers <hdr1.h> and <hdr2.h>, and these files are all
linked together to produce the program myprog. Here’s what a simple makefile
describing this could look like:
# Samplemakefile1
myprog: myfile1.o myfile2.o myfile3.o
myfile1.o: hdr1.h hdr2.h
myfile2.o: hdr1.h hdr2.h
myfile3.o:
To compile and link myprog:
make myprog
Or since myprog is the first target:
make
To see what commands need to be executed without actually executing them:

make © 2010, QNX Software Systems GmbH & Co. KG.
make -n
Using macros, the myprog makefile could be simplified to:
# Samplemakefile2
OBJS=myfile1.o myfile2.o myfile3.o

HDRS=hdr1.h hdr2.h
myprog: $(OBJS)
myfile1.o: $(HDRS)
myfile2.o: $(HDRS)
This makefile is functionally identical to the previous example. It isn’t significantly
better, just slightly more generalized.
We can further simplify the makefile by using the builtin inference rules and macros,
as follows:
# Samplemakefile3
OBJS=myfile1.o myfile2.o myfile3.o

HDRS=hdr1.h hdr2.h
myprog: $(OBJS)
myfile1.o myfile2.o: $(HDRS)

As you can see, this makefile is short and to-the-point. Again, this is functionally
equivalent to the previous examples.
Using this makefile, you can customize the compilation from the make command line
by setting the appropriate macros:
make CFLAGS="-DHITHERE"
which defines the symbol HITHERE.
You can also direct the linker to produce a linkmap:
make LDFLAGS=-M
Of course, any of these macro assignments could be “hard-coded” in the makefile, but
it’s often convenient to override the defaults from the command line for special needs.
MAKEFLAGS This environment variable, if it exists, is read by the make utility,
and is treated as a set of option characters to be used as the
default options. Command-line options to make have precedence
over these options.
After make has started and the MAKEFLAGS variable has been
read, all of the options except -d, -f, and -p are added to the
MAKEFLAGS macro. The MAKEFLAGS macro is passed into the
environment as an environment variable for all child processes.
SHELL The value of the SHELL environment variable is always ignored.
All other environment variables are used as macros.

Exit status:
When the -q option has been specified:
0 Successful.
1 The target wasn’t up-to-date.
When the -q option hasn’t been specified:
0 Successful.
GNU
Caveats:
In makefiles, specify Windows pathnames using one of the following methods:
• Use a forward slash (/) as a path separator.
• Use a backslash (\) escape character before a backslash path separator.
• Enclose the entire path in quotation marks.
See also:
qcc
Conventions for Recursive Makefiles and Directories appendix of the QNX Neutrino
Programmer’s Guide
Andrew Oram and Steve Talbott, Managing Projects with make, O’Reilly and
Associates, 1991

mcd © 2010, QNX Software Systems GmbH & Co. KG.
Media Content Detector utility
Syntax:
mcd options* config_file &
Runs on:
Neutrino
Targets:
Options:
-D Set the name of the mediastore list directory; the default is .devices.
-E Set the name of the mediastore eject file; the default is .eject.
-I Set the name of the mediastore insert file; the default is .insert.
-L Run the MCD in local mode, even when Qnet is running. See “Local
mode” below.
-n Set the subsystem mountpoint; the default is /dev/mcd.
-v Increase the verbosity of messages written to sloginfo, from 0 to 7.
-V Print output messages to console, as well as sloginfo.
config_file The pathname to a required configuration file; see “Configuring the

MCD” below.
Local mode
The local mode option (-L) may permit simpler configuration when stand-alone
systems are used, as describe here.
Use local mode if a system using MCD is to be run as a stand-alone with respect to
any services that use the MCD, and Qnet is running on the system (for example, for
debugging).
When the MCD runs in local mode, the MCD:
• does not add the network prefix to paths it generates
• expects all paths it receives to already have the network prefix

© 2010, QNX Software Systems GmbH & Co. KG. mcd
Limitations
When the local mode option is used:
• The MCD configuration file may not contain network-qualified devices.
• Off-node processes can not open rule entries (for example, DISC_INSERTED), so
they are unable to read out a local-only path.
• To prevent any ambiguity between local and remote device names, off-node
processes can not open control entries (for example, .insert or .eject).
• Path names handed out to read() are local only — even if Qnet is running.
Description:
The mcd utility (media content detector, or MCD) monitors device and mediastore
insertions and removals, and the presence of specified media content.
Overview
The MCD is a stand-alone utility for detecting devices, mediastores and specified
media content. It is positioned between storage and USB device drivers, and any client
application that needs to be informed of a device or mediastore activity, or of the
presence of specified media types.
The MCD design separates the definition of actions conducted by the system from the
implementation of these actions so that the actions can be easily edited or updated
without changes to code.
MCD rules
The MCD provides a binary decision tree framework, applying rules and branching
between rules according to match/fail results. These rules are used for detecting device
and mediastore insertions and removals, and for classifying their content. They are
specified in the MCD configuration file, and implemented with user callouts.
You can write rules for the MCD instructing it to monitor the presence or absence of
any device, mediastore or file, as shown by the three examples below:
Monitor a mediastore
The rule below tells the MCD to monitor the physical insertion or removal of a
CD-ROM mediastore on a device (the hardware) at the location /dev/cd*.
[/dev/cd*]
Callout=CD_MEDIA_IOBLK

Monitor namespace changes
The rule below monitors changes (mount or unmount) of a device or mediastore (such
as a USB storage device) on the system. These sorts of changes usually indicate the
physical insertion or removal of the device (the hardware) and its filesystem mounting
or unmounting.
[/fs/usb*]
Callout=PATH_MEDIA_PROCMGR
Monitor the presence of files
The rule below polls the contents of /directory looking for files or directories that
have been created in or removed from the directory being monitored. For example,
typing touch /directory/file from a shell satisfies this rule, though no physical
device has been inserted or removed.
[/directory/*]
Callout=PATH_MEDIA_SCAN
The MCD can be used as a framework from which to build an independent content
detection system.
MCD server
The MCD server:
• monitors a user-specified set of devices and their mediastores
• attempts to determine the category of media on mediastores (for example, an audio

CD or a movie on a DVD)
• notifies clients of the presence of the media it has detected
In this documentation:
• mediastore is never a specific mediastore, but always any mediastore of the

specified type: a CD and not, for example, the CD I’m Your Man by Leonard
Cohen.
• an unformatted CD or USB stick is considered a device, because in its current state

it cannot have any media content
• a USB stick with, for example, two partitions is one device with two mediastores

Operational flow
This section describes the MCD’s operational flow at startup, and on detection of a
new device, mediastore or file.
Startup
At startup, the MCD server proceeds as follows:
1 Read the configuration file.
2 Create a single, dedicated thread to provide the resource manager interface.
3 For each mediastore listed in the configuration file:

3a Create a dedicated, device detection thread.
3b Run the notification routine in its own thread.
Multiple detection threads, each for different mediastores, may be running

concurrently.
Device or insertion
On detection of a device or mediastore insertion, or of the presence of a file of interest,

the MCD proceeds as follows:
• Create a new thread to process the content detection rules for that device,
mediastore or file.
• When the rule processing is complete, terminate the thread.
Configuring the MCD

The operation of the MCD is controlled by a configuration file. This file consists of
named sections, each section defined by a name enclosed in square brackets: [ ],
followed by parameter lines with the form key = value. These parameters apply
only to the section in which they appear.
The sample MCD configuration file 2phase.cfg is delivered with the MCD; the
sample configuration file mcd.conf provides examples for use with the Aviage
Multimedia suite (MME).
The MCD ignores blank lines and any leading or trailing white spaces. It treats lines
beginning with a “#” or a “;” character as comments and ignores them as well.
Configuration file sections
A section of the MCD configuration file can be one of:
• an entity (device, mediastore or file) description — the section name starts with a
“/” character (i.e. /dev/cd0). See “Entity descriptions” below.

• a media content rule — any name without a leading “/”. See “Media content rules”
below.
The example below presents a description: [/dev/cd0] and a rule: [DVD_AUDIO]:

[/dev/cd0]
Callout = CD_MEDIA_IOBLK
Argument = 1000,2000
Priority = 11,9
Start Rule = DVD_OR_CD
[DVD_AUDIO]
Callout = FNAME_MATCH
Argument = /AUDIO_TS/AUDIO_TS.IFO
Match Rule = DVD_VIDEO
Fail Rule = DVD_VIDEO
Entity descriptions
For entity (device, mediastore or file) description sections, the section name is the
entity the MCD monitors. This name can be a single name, such as /media/drive,
or a wildcard pattern, such as /dev/umass*. If the section name is a wildcard
pattern, the event notification routine defined by the Callout= for the section must be
capable of handling every entity that matches the wildcard pattern.
Parameters
Configuration parameters are used differently according to the type of section

(mediastore description, or content rule) in which they are used.
Parameters in an entity section of the configuration file are used as follows:
Callout= The notification routine that the MCD runs when it detects the
entity defined in the section name. Each notification routine is run
in its own thread, allowing it to either block or poll as necessary.
If you provide no Callout= routine, you should handle device,
file or mediastore transitions externally with the notification
provided through the resource manager interface.
Argument= An optional argument to pass to the notification routine defined by
the Callout= parameter.
Priority= The priorities at which to run, if applicable, for the entity defined
in the current section:
• the content detection thread
• the notification thread
Start Rule= The root of the decision tree executed to determine media content
type; that is, the first rule to apply to each entity following
insertion notification.

Stop Rule= The root of the callouts to execute when the entity is removed.
Media content rules

For media content rule sections of the mcd configuration file, the section name is the
name of the rule.
Parameters
Parameters in a media content rule section of the configuration file are used as follows:
Callout= The notification routine that the MCD runs when it detects an
entity matching the content rule in the section name. See
“Notification routine” below.
Argument= An optional argument to pass to the notification routine defined by

the Callout= parameter.
Match Rule= The branch of the decision tree to execute when media content
matches the content rule.
Fail Rule= The branch of the callouts to execute when no media content
matches the content rule.
A rule runs at the priority given in the entity section that starts the rule chain.
Notification routine
The notification routine that runs when a mediastore matches a rule produces a
match/fail result to indicate whether or not the media on the mediastore satisfies the
routine’s particular requirements. Based on the result produced by the rule, the MCD
takes a branch to another rule, as specified by the Match Rule= or Fail Rule=
parameters in the current section.
If no associated branch rule is provided for a rule’s result, the MCD considers the rule
to be terminal and content detection complete.
If a rule contains no Callout= parameter, the MCD assumes that the rule either
matches or fails, based on the presence of an associated branch rule. When debugging,
you can use this characteristic to disable a test and always make a branch to the next
rule.
Using the MCD as a filesystem automounter

The MCD can be used as a filesystem automounter by creating a set of two-phase rules
in the MCD configuration file. Two-phase rules are implemented in the MCD as
follows:

First-level entries
• The first level of entries in the MCD configuration file refers, not to mediastores,
but to devices that can be monitored using the provided MCD callouts.
• The Start Rule= parameter in a first level entry points to the MOUNT_FSYS
callout, a built-in routine that can mount filesystems based on simple mediastore
criteria.
• Mounting a filesystem uses the triggers insertion notification of the second level of
entries (for mediastores) via the PATH_MEDIA_PROCMGR built-in routine.
Second-level entries
• When they are triggered, the MCD configuration file’s second-level entries perform
the content detection algorithms on the mediastores at the filesystem mountpoint.
For an example of how to use the MCD as a filesystem automounter, see “Two-phase
filesystem mount example” in the “Examples” section below.
The mcd resource manager interface

The MCD server presents a standard QNX resource manager (filesystem-like)
interface. The default top-level directory is /dev/mcd; it includes:
• a set of S_IFNAM/name-special (.insert and .eject) files, which the MCD

uses to provide a client API to the system
• a .devices directory with an entry for each entity known to the system
To change the top-level directory, use the -n command-line option.
.insert and .eject files
The .insert and .eject files are write-only files in /dev/mcd. External programs
can trigger the MCD’s content detection process on the insertion or ejection of an
entity by writing to the appropriate file the pathname of the entity that has been
inserted or ejected; for example /dev/cd1 .
If the hardware for the device with an ejected mediastore doesn’t support removal
notification, then the MCD treats a subsequent insertion notification as an implicit
ejection event.
.devices directory
The .devices directory in /dev/mcd contains an entry for each entity (device,
mediastore and monitored file) known to the system. Each entity is represented by a
S_IFCHR/char-special file in this directory. These files hold information about
the entity in fields as follows:

• st_mtime — the time of the last state change for the entity.
• st_ino — the sequence number of the insertion. See “Sequence number” below.
An entry appears in .devices directory only for entities that have been inserted at
least once. Since entity sections can be wildcards, a full list of potential entity matches
can not be known in advance. The MCD can only know about an entity after it has
been inserted. Thus, if a client application tries to stat() a particular device and fails
with ENOENT, it should treat this failure as though the st_ino field is 0 (i.e., device
ejected).
The “Client API” section below includes an example that illustrates how to use this
interface.
Sequence number
The sequence number stored in st_ino for any entity (device, mediastore or file) can be
either zero or non-zero. A value of zero means that the entity is not present in the
system. A non-zero value means that the entity is present in the system.
At each re-insertion of the entity, the MCD increases the sequence number for that
entity. Thus, for example, for a mediastore the values of st_ino might be in sequence:
1 (first insertion), 0 (removal), 3 (re-insertion), 0 (removal), 5 (re-insertion).
A client application can use the incrementing value of st_ino at each state change to
check that it is up to date with, for example, a mediastore’s activity after a series of
rapid insertions and removals. For more information, see “Stale rules” below.
Example: Filesystem hierarchy
Below is a sample filesystem hierarchy:
$ ls -al /dev/mcd
dr-xr-xr-x 1 root root 11 Aug 02 19:46 .
n-w--w--w- 1 root root 0 Aug 02 19:46 .eject
n-w--w--w- 1 root root 0 Aug 02 19:46 .insert
nr--r--r-- 1 root root 0 Aug 02 19:46 CDDA_OR_DTS
nr--r--r-- 1 root root 0 Aug 02 19:46 CD_AUDIO
nr--r--r-- 1 root root 0 Aug 02 19:46 DVD_AUDIO
nr--r--r-- 1 root root 0 Aug 02 19:46 DVD_OR_CD
nr--r--r-- 1 root root 0 Aug 02 19:46 DVD_VIDEO
nr--r--r-- 1 root root 0 Aug 02 19:46 MIXED_AV
nr--r--r-- 1 root root 0 Aug 02 19:46 SVIDEO_CD
nr--r--r-- 1 root root 0 Aug 02 19:46 VIDEO_CD
Read-only entries for rules
The top-level /dev/mcd directory contains read-only entries for each rule defined in
the configuration file.
Client applications can read from here the name of the device that satisfied a particular
rule, with the read blocking until a device with content matching that rule is available.

A non-blocking select and notify mechanism is also available to allow the client to
wait on multiple rules, or to perform other work until a rule is triggered. Following the
notification, the client application can read the rule to determine the device.
Callout templates
The MCD server provides a framework from which you can build a content detection
system. Callout routines provide all the specific functionality in such a content
detection system.
The MCD includes some common routines available for use where required in a
static-linked library bound into the server. The MCD also supports extension routines
provided by third-parties in DLLs dynamically linked at runtime. Thus, the system is
extensible: if you require a new, unsupported detection test, you can implement it
outside the server framework and ship it as a separate library.
In the content detection system configuration file, all Callout= items refer to a
callout. These callouts are identified as internal or external by their names:
• If the function name contains an “at” (@) character (for example,

myfunc@mylib.so), it refers to an external function in the named DLL, which is
resolved at runtime.
• If the function name doesn’t contain an @ character, the callout is an internal

built-in routine.
Extension modules must include the MCD header file <sys/mcd.h> for appropriate
manifests and type definitions.
Insertion and ejection notification

The prototype for media insertion notification callouts is:
void mcd_notify( char *iomgr[2], char *device, void *arg );

The MCD creates this routine in a dedicated thread, that should continually monitor
the device. This thread should not return, except in the event of a serious error. If the
thread encounters a serious error, it should set errno appropriately and return. On the
return of an entity detection thread, the MCD will:
• log the error
• stop monitoring the entity whose monitoring thread encountered the error
• continue monitoring other entity detection threads
Arguments
iomgr An array containing the names of the interface entries where insertion and
ejection events are reported. In a default system
iomgr[0] = "/dev/mcd/.insert" and iomgr[1] = "/dev/mcd/.eject", but the
actual strings will reflect any command-line overrides.

device A pointer to the name of the device, mediastore or file to monitor.

device may be a wildcard, requiring the routine to monitor a group of
devices, files or mediastores. When a device event occurs, the routine
should write to the appropriate iomgr[] path the name of the specific
device, mediastore or file that is affected by the event.
arg A pointer to a routine-specific argument. This routine-specific argument is

provided as the Argument= parameter of the relevant device entry in the
configuration file.
Built-in notification routines
The MCD’s built-in media notification routines include:
CD_MEDIA_IOBLK
This routine interfaces the system to CD and DVD drives managed by the
devb/io-blk filesystem. It exploits the filesystem feature of automatically
invalidating open file descriptors upon media change: it opens the device
block-special file and periodically polls it, treating any EBADF result as a
transition indicator. It distinguishes between insertion and ejection by
examining the advertised size of the device.
The Argument= option sets the polling periods (in milliseconds) at which to
probe the file descriptor when the mediastore missing, and when it is present.
The default for this argument is "1000,2000", which corresponds to a
one-second interval when the mediastore is missing, and a two-second interval
when the mediastore is present.
USB_MEDIA_ENUM
Targets running QNX Neutrino 6.3.n releases only. This routine interfaces the
system to the umass-enum utility (which is replaced by enum-usb in QNX
Neutrino 6.4.0). It translates USB state change events from their native format
into the insertion and ejection events expected by the USB enumeration server
named by the Argument= option.
The Argument= option sets the name of the USB enumeration server to connect
to (typically "/dev/umass-enum").
PATH_MEDIA_PROCMGR
This routine connects the system to any device that dynamically attaches a
resource manager pathname when the resource manager is present, and detaches
the pathname when the resource manager is absent. It uses the procmgr_event()
facility (available from QNX Neutrino 6.3.0 SP2 onwards) to receive
notification of any changes to the global pathname space, then scans for the
addition and/or removal of any device mountpoints matching the pattern defined
by the callout name.
The Argument= option sets the name of the special directory where the OS
pathmgr maintains mountpoints (typically "/proc/mount").

PATH_MEDIA_SCAN
This routine scans for the presence of filenames that match the pattern defined
by the callout name. It is similar to the PATH_MEDIA_PROCMGR routine, but
since the creation and deletion of files doesn’t trigger any filesystem events, this
routine operates by scanning the specified directory at regular intervals.
The PATH_MEDIA_SCAN cause the MCD to behave differently, based on the
presence or absence of a trailing “/” character at the end of the pathname, as
follows:
• “/” present — send one notification when the pathname exists as a directory
(including as the root directory of a mounted filesystem)
• “/” absent — send a notification for every matching filename pattern in the
named directory
The Argument= option sets the poll period, in milliseconds, for scanning the
directory.
Media content determination

The prototype for content detection rule callouts is:
int mcd_content( char *device, void *arg );
Arguments
device The name of the raw device or mediastore
arg A pointer to a routine-specific argument. This routine-specific argument is

provided as the Argument= parameter of the relevant rule entry in the
configuration file.
Returns
This routine returns values as follows:
• MCD_RULE_MATCHED — the rule is matched
• MCD_RULE_NO_MATCH — there is no match for the rule
• MCD_RULE_ABORT — there is a serious error; set errno and stop the remainder of
the detection process for the device
If the routine invoked by the callout requires access to a filesystem on the device, it can
use the DCMD_FSYS_MOUNTED_BY devctl to locate the appropriate mountpoint.

Built-in content detection rules
The MCD’s built-in content detection routines include:
DVD_OR_CD This rule determines if a disk mediastore is a DVD rather than a

CD (by issuing a READ DVD STRUCT command).
It ignores The Argument= option. The rule matches only if the
media is a DVD.
CD_AUDIO This rule determines if the CD media has any audio content (by
issuing a READ TOC command). It ignores the Argument=
option. The rule matches only if the media contains audio
tracks.
To facilitate the detection of mixed-mode and enhanced CDs that contain both audio
and filesystem components, you can configure the CD_AUDIO rule as a non-terminal
state; that is, with both the Match Rule= branch and the Fail Rule= branch
provided. With the rule configured this way, after matching audio content, you can
continue on with other rules to detect data content.
BLANK_CD This rule determines if the CD media is blank or unrecorded (by

issuing a READ DISK INFORMATION command). It ignores the
Argument= option.
The READ DISK INFORMATION command and the physical detection of blank disks is
only supported by newer CD-RW hardware, and will fail on older CD-ROM hardware.
In fact, older hardware may not even detect the insertion of a blank or unrecorded disk.
FNAME_MATCH This rule uses fnmatch() to match file pathnames on a device’s

filesystem. It requires that the inserted mediastore either be a
filesystem, or have a filesystem mounted on it, because it is
implemented with access() probing. The rule will automatically
resolve to the filesystem level, if appropriate.
This behavior means that:
• If you are running this rule chain off a device that was a
filesystem (i.e. [/fs/cd*]), this filesystem is the
mountpoint at which the FNAME_MATCH rule will search
for filenames.
• If you come to the FNAME_MATCH rule from a device (i.e.
[/dev/cd0]), the rule will:
1 Work out where /dev/cd0 is mounted (probably
/fs/cd0).
2 Search that filesystem for the matching filenames.

The Argument= option is a comma-separated list of pathnames,

based from the root of the filesystem. If the MCD finds any of
the pathnames in the list on the mediastore, the rule is matched.
FNAME_PATTERN This rule uses fnmatch() to match filename patterns on a

mediastore’s filesystem. It requires that the inserted mediastore
either be a filesystem or have a filesystem mounted on it,
because it is implemented with a nftw() traversal. The rule will
automatically find any such filesystem.
The Argument= option sets a comma-separated list of patterns.
If a filename matching any of the listed patterns exists in any
directory on the filesystem, the rule is matched.
This option supports several other options that can be embedded
in the listed patterns. For example: Argument =
depth=2,*.c,*.h". These “embedded” options are:
• basedir= — set the subdirectory at which to start the scan;

the default is the root directory of the given entity
• depth= — set the maximum number of subdirectory levels
to recurse into, (i.e. the maximum depth from the root); the
default is 0, which means no depth limit
By default the scan for a pattern match is the entire target
filesystem. You can use the basedir= and depth= options to
direct and limit this scan.
MOUNT_FSYS This rule is used to mount a filesystem onto a specified device,

and is used to extend the MCD to operate as an auto-mounter.
The Argument= option sets the filename of a file of mount
rules. Since this option is opened and parsed each time the rule
is run, you should consider locating this filename on a ramdisk
or in /dev/shmem.
This rule is typically used as the Start Rule= of a two-phase
configuration, where the resulting mount operation triggers a
PATH_MEDIA_PROCMGR action. The rules are processed from
the file in order, stopping at the first (fnmatch()) match that
either succeeds or specifies to skip the device (when the rule has
only a pattern and no mount information). In order to select the
appropriate filesystem, you can specify multiple rules for a
removable device.
The file format is one rule per line, with each line containing
fields separated by white spaces. For example:
#Device_pattern Mount_point Fsys_type Mount_options

/dev/cd* /fs/cd%# udf normv,format=udf,rrip,joliet,iso9660e,iso9660,audio
/dev/umass*t1[124] /fs/usb%0 dos fsi=use
/dev/umass*t[146] /fs/usb%0 dos

/dev/hd*
The rules shown in the example above instruct the MCD to:
• Mount CD with fs-udf, specifying the preferred list of
formats to try; in order, this list will be UDF, RockRidge,
Joliet, then plain ISO9660.
• Ignore HD devices.
• Mount /dev/cdn as /fs/cd0n.
• Mount USB partitions as DOS to the first available
filesystem mountpoint.
See “MOUNT_FSYS special sequences” below for more
information about the mountpoint sequences. For more
information about UDF, see fs-udf.so.
The normv option is required to work around OS namespace race conditions if the
filesystem format is not known when trying multiple mounts with different DLLs. It is
also useful to prevent a mount if the media is ejected before the rule is scheduled to
run.
UNMOUNT_FSYS This rule unmounts the filesystem from the mediastore specified
in the rule name. It ignores the Argument= option.
This rule is typically used as the Stop Rule= of a
CD_MEDIA_IOBLK mediastore that uses the MOUNT_FSYS
action, when a mount would otherwise persist after the
mediastore ejection. If the mediastore is presented by a resmgr
that will exit or be terminated by an external manager (such as
USB), then that presentation implicitly unmounts any relevant
filesystem without the need for this rule. However, in most
instances where a MOUNT_FSYS is used, you should also
configure a matching UNMOUNT_FSYS in order to ensure that
the filesystem for an ejected mediastore is duly unmounted.
MOUNT_FSYS special sequences
The MOUNT_FSYS rule uses special sequences, as follows:
• %# expands to the major device number of the mediastore. For example, with
/fs/cd%#, /dev/cd0 will be mounted at /fs/cd0 and /dev/cd1 will be
mounted at /fs/cd1. %# does not permit multiple partitions; use %0.
• %0 expands to a sequential, unique number. It is used principally to allow multiple

USB partition rules in the mcd.mnt, all with the mountpoint names /fs/usb%0.
The %0 in the name causes the MCD to try allocate /fs/usb0, /fs/usb1,
/fs/usb2 and so on (starting form 0) until it finds a unique mountpoint name. For
example, if there are filesystems already mounted at /fs/usb0 and /fs/usb1,
then the MCD expands /fs/usb%0 to /fs/usb2.

Below is a sample mcd.mnt file that uses the %# and %0 special sequences.
#------------------------------------------------------
# Device Mountpt Type Options
#------------------------------------------------------
/dev/cd* /fs/cd%# udf normv
/dev/umass[0-9]* / enum
/dev/umass[0-9]*t1[1234] /fs/usb%0 dos
/dev/umass[0-9]*t1[1234].* /fs/usb%0 dos
/dev/umass[0-9]*t[146] /fs/usb%0 dos
/dev/umass[0-9]*t[146].* /fs/usb%0 dos
/dev/umass*t7[789] /fs/usb%0 qnx4
/dev/umass*t17[789] /fs/usb%0 qnx6 sync=optional
/dev/umass[0-9]* /fs/usb%0 dos
Client API
The MCD uses special rule entries created in the resource manager filesystem to notify
client applications of media content matches.
A client application can call open() to access the rule entry in which it is interested,
and when that rule is matched, it can then use read() to read from the entry the name
of the relevant mediastore. If QNET is active and the -L is not specified, the device
name returned from reading the MCD rule entry is a fully-qualified-path-name
(FQPN); this feature allows the string to be used as-is by any process on any node.
The read() function blocks until a match is made (unless oflag is set to
O_NONBLOCK). For non-blocking notifications, use ionotify(). To wait on multiple
rules, use select().
Maintained information
In order to inform each client once and only once of each match, the MCD server
maintains state information about each mediastore, matched rule, and client
application.
When a new mediastore is inserted, any matched rule triggers notifications to the
interested clients. If the mediastore was inserted before a client registered with the
MCD, the first read the client makes is satisfied immediately. This behavior eliminates
any start-up race conditions, such as, for example, there being media already in a drive
at system startup, and the content detection process completing before the higher-level
client applications are even started.
Example: Media player
A very simple media player might be designed as follows:

int fd, cd;
char device[_POSIX_PATH_MAX];
// Open the CD_AUDIO rule and wait for it to be matched.

fd = open("/dev/mcd/CD_AUDIO", O_RDONLY);
while (read(fd, device, sizeof(device)) != -1) {
// At this point, device contains an audio CD ...
cd = open(device, O_RDONLY);

// ... read the toc, play it, etc.

// Could monitor playback status with
// DCMD_CAM_CDROMSUBCHNL.
// If disk is ejected, this will fail.
// Can loop back waiting for next insertion.
// The rule will be re-armed for the
// next match.
close(cd);
}
close(fd);
Example: Polling
The mcd device Start Rule= and Stop Rule= rule chains are mutually exclusive:
the ejection of a device cancels out inserted rules for that device (and vice-versa).
Therefore, if you use select() or ionotify(), you should use them in conjunction with a
non-blocking read(), as there is no guarantee that the notified state and/or rules of the
trigger will remain valid (for example, if the media is ejected between the calls to
ionotify() and read()).
The code snippet below illustrates one way to use ionotify() in conjunction with a
non-blocking read():
<PRE>
fd = open(rulename, O_RDONLY | O_NONBLOCK);
SIGEV_UNBLOCK_INIT(&evt);
for (;;) {
while (ionotify(fd, _NOTIFY_ACTION_POLLARM, _NOTIFY_COND_INPUT,
&evt) != 0) {
while (read(fd, device, sizeof(device)) > 0) {
// ’device’ matched on ’rulename’
}
}
pause();
}
</PRE>
In a real application, the event would likely be a pulse, and there would be an
event-driven loop rather than a pause as in the code snippet above.
Stale Rules
Stale rules may occur if there is client decoupling, and/or a delay between the
notification and the use of inserted mediastore; for example, due to the spawning of a
separate media application.
To avoid stale rules, the MCD can include the mediastore’s insertion sequence number
with the rule notification, and applications can then match this number against the
device entry in the /dev/mcd/.devices directory. If the device has been ejected
since the rule was triggered, these values will no longer match, indicating that the rule
no longer applies to the current device content, and that new rules may have been
re-triggered.

If the client application requires an insertion sequence number, the MCD uses an
XTYPE read to return an additional uint32_t of data with the mediastore name, and
the _IO_XTYPE_MQUEUE message priority code, avoiding the need to make changes
to the global <sys/io_msg.h> header file.
// Get rule notification using an XTYPE read

int fd;
uint32_t seq1;
char device[_POSIX_PATH_MAX];
fd = open("/dev/mcd/CD_AUDIO", O_RDONLY);
_readx(fd, device, sizeof(device), _IO_XFLAG_BLOCK | _IO_XTYPE_MQUEUE,
&seq1, sizeof(seq1));
// Open and check the current version of the inserted device

int fd;
struct stat st;
uint32_t seq2;
char entry[_POSIX_PATH_MAX];
fd = open(device, O_RDONLY);
sprintf(device, "/dev/mcd/.devices/%s", device);

seq2 = (stat(device, &st) != -1) ? st.st_ino : 0;
// If these match, the CD_AUDIO rule is the same and still valid
// and ’fd’ is open on that version of the media
if (seq1 == seq2) ...
Additional Information
This section describes how to use the MCD for specific operations:
• Detecting other kinds of system media
• Detecting USB and iPod devices
• Pattern matching and case-sensitivity
• Matching a single rule
• Detecting CD insertion with non-media content
• CD-Changer controlled by external firmware
• Using the MCD as a partition enumerator
Detecting other kinds of system media
To detect system media not handled by the routines included with the MCD:
1 Determine what distinguishes your new media type from all other media types.
In many cases, the difference might simply be the presence of certain files or
directories on the mediastore. For example, a navigation update disk might be
identified by the presence of acios_db.ini or config.nfm files. In this case,

a built-in routine such as FNAME_MATCH, could perform the detection; or you

might have to write a custom routine and provide it to the MCD in an external
DLL.
2 Determine the precedence to probe for this media amongst the existing media
tests (first, last, after checking for audio content but before checking any other
data rules, etc).
3 In the configuration file, make a new rule section for this test, with the
appropriate Callout= rule, and splice it into the appropriate point of the
decision tree by editing the Match Rule= or Fail Rule= parameters of both
the preceding rule and the new rule. The name of the new rule can be used to
trigger any client application when the new content is matched.
Detecting USB and iPod devices
The MCD can manage any kind of device, provided that a notification mechanism is
available to report on insertions and start the detection process.
For USB devices, you can use the following entry in the MCD configuration file:
[/fs/usb*]
Callout = PATH_MEDIA_PROCMGR
Argument = /proc/mount
Priority = 11,10
Start Rule = ...
Targets running QNX Neutrino 6.3.n releases only. For USB devices, the
umass-enum server in conjunction with the MCD’s built-in USB_MEDIA_ENUM
routine can provide the notification mechanism and start the detection process. Invoke
umass-enum with the -r option to activate its resource manager interface, and use the
following device entry in the MCD configuration file:
[/dev/umass/*]
Callout = USB_MEDIA_ENUM
Argument = /dev/umass-enum
Priority = 11,10
Start Rule = ...
For iPod devices, the device entries dynamically attach pathnames (when these
pathnames are present), and so can be handled with the MCD’s built-in
PATH_MEDIA_PROCMGR() routine. Use the following device entry in the MCD
configuration file for iPods:
[/fs/ipod*]
Priority = 11,10
Start Rule = ...

Pattern matching and case-sensitivity
The MCD’s FNAME_MATCH routine attempts to access listed files by using the
underlying filesystem, which applies any rules appropriate for that filesystem in
conjunction with any specified mount options. Thus, case-sensitivity in pattern
matching depends on:
• the built-in routine used
• the underlying filesystem
The table below lists the case-sensitivity and case-preserving characteristics of some
common filesystems:
filesystem case-sensitive case-preserving

FAT No No
ISO-9660 No No
Joliet No Yes
QNX4 Yes Yes
RRIP Yes Yes
VFAT No Yes
Since the majority of mediastores used for multimedia storage are formatted for
DOS/Windows use, it is likely that the filesystem will be case-insensitive. This
case-insensitivity means that in any FNAME_MATCH rules the Argument= filename
list can be given in either upper or lower case.
The FNAME_PATTERN routine processes directory entries from the filesystem through
the libc fnmatch() function, which is case sensitive.
The directory output from each filesystem depends on whether it is case-preserving. If
the filesystem is not case-preserving, then default rules are used to control the filename
presentation. Refer to the cd case=lower|upper or the dos
sfn=lower|upper|windows filesystem mount options.
Since the most common multimedia formats are case-preserving and will use the exact
filename that a user or media application used to create their files, in any
FNAME_PATTERN rules the Argument= pattern list should be given in both upper and
lower case (as in the MIXED_AV rule in the Examples below.).
Matching a single rule
If you don’t want multiple media types to match and only want to match the first rule,
you can use the fact that if a matched rule has no Match Rule= branch the MCD
stops its detection process.

In the configuration file, simply arrange the rules, from the Start Rule= through the
Fail Rule= links, in priority order. Do not provide any Match Rule= branches.
The MCD detection framework will test these rules in sequence until one is matched,
then stop. For an example, see the VIDEO_CD and SVIDEO_CD entries in the
Examples below.
Detecting CD insertion with non-media content
To be notified when a CD is inserted regardless of what content it contains, simply:
• Make a dummy rule with a no Callout= routine.
• Make a Match Rule= branch (so that it will always match when tested).
• Make this rule the Start Rule= of the device (with your dummy rule branching
to the original start rule).
Your application can now block on that new rule, via the normal resource manager
interface ("/dev/mcd/DISC_INSERTED"), waiting for device insertion. For example,
one of the example configurations in this document could be modified as follows:
[/dev/cd0]
Priority = 11,9
Start Rule = DISC_INSERTED
[DISC_INSERTED]
Match Rule = DVD_OR_CD
CD-changer controlled by external firmware
To detect insertion events from a CD-changer that is controlled by external firmware

(e.g. FJ-10), you should not use any of the built-in MCD detection callouts, but trigger
the insertion notification directly from the CD-changer controller stack.
Internally, all built-in device detection callouts do their specific work, then write the
name of the device to the special /dev/mcd/.insert entry. This behavior means
that to detect insertions on changers controlled by external firmware, proceed as
follows:
• In the device driver, wait for the CD-changer to be loaded and available for use by
the system
• When the CD-changer is available, write the name of the device (as a string, i.e.
/dev/cd0) to the MCD control point. Writing the name of the device to the
control point triggers the rest of the content detection process.
In the configuration file, the relevant device entry would be like this (note that no
Callout= is specified in this situation):

[/dev/cd0]
Priority = 11
Start Rule = ...
The insertion notification code in the driver is basically this:
int notify;
notify = open("/dev/mcd/.insert", O_WRONLY);

write(notify, "/dev/cd0", 8);
close(notify);
Similar code to handle ejections can be written to /dev/mcd/.eject.
Using the MCD as a partition enumerator
The MCD’s MOUNT_FSYS rule can be used to determine if partition enumeration has
occurred on a device (USB stick). This capability can be used to try to mount a
filesystem on the raw device, if the device has not been partitioned.
In order to determine if partition has occurred, use the following configuration:
• Configure the USB enumerator to start devb-umass with the blk auto=none
option; that is, to not automatically enumerate partitions.
• Configure the MCD device rule for the USB as follows:

- it must be of the form [/dev/umass*]; that is, so that the pattern matches both
the raw device and any partitions
- its Start Rule= should be a rule that invokes MOUNT_FSYS
• Configure a second-phase set of mountpoint rules [/fs/usb*] to continue

processing once a filesystem has been mounted from either a partition or a device.
The mcd.mnt rule used by that MOUNT_FSYS should include the following:
/dev/umass[0-9]* / enum
/dev/umass[0-9]* /fs/usb%# dos
/dev/umass[0-9]*t1[124] /fs/usb%# dos fsi=use
/dev/umass[0-9]*t[146] /fs/usb%# dos
The control flow for this configuration is as follows:
1 USB stick inserted.
2 USB enumerator detects insertion and launches devb-umass.
3 devb-umass puts up /dev/umassX pathname, triggering the MCD.
4 The MCD runs the MOUNT_FSYS rule.
5 If the media is non-partitioned:

5a The enum rule is executed and fails.

5b The code falls through and attempts fs-dos mount on raw device, which
should succeed, resulting in the appearance of an /fs/usb*.
6 If the media is partitioned:

6a The enum rule enumerates partitions and, thus, succeed, terminating the
callout.
6b The enumeration makes /dev/umassX tN names appear, re-entering the
MCD device rule with a pattern that skips the enum rules, and instead tries
fs-dos mounts on a partition, resulting in appearance of an /fs/usb*.
7 Following either of the above two cases (5 or 6), MOUNT_FSYS is successful

with a mount, and the MCD continues with /fs/usb* rules, typically some
form of content detection or the triggering of a dummy INSERT rule.
X is the disk number (0, 1, 2, etc.). and N is the partition type (4, 11, 12, etc.); for
example: /dev/umass[0-9]* or /dev/umass[0-9]*t1[124]. Thus, a path with
umassX refers to a device, while a path with umassX tN refers to a partition.
Examples:
Consider the following sample configuration file for a CD-based system:
# Sample CD/DVD disk identification rules.
[/dev/cd0]
Priority = 11,9
Start Rule = DVD_OR_CD
[DVD_OR_CD]
Callout = DVD_OR_CD
Match Rule = DVD_AUDIO
Fail Rule = CD_AUDIO
[DVD_AUDIO]
Argument = /AUDIO_TS/AUDIO_TS.IFO
Match Rule = DVD_VIDEO
Fail Rule = DVD_VIDEO
[DVD_VIDEO]
Argument = /VIDEO_TS/VIDEO_TS.IFO
Fail Rule = VIDEO_CD
[CD_AUDIO]
Callout = CD_AUDIO
Match Rule = VIDEO_CD
Fail Rule = VIDEO_CD
[VIDEO_CD]
Argument = /VCD/INFO.VCD,/MPEGAV/AVSEQ01.DAT,/MPEGAV/MUSIC01.DAT
Fail Rule = SVIDEO_CD
[SVIDEO_CD]
Argument = /SVCD/INFO.SVD,/MPEGAV/AVSEQ01.MPG,/MPEG2/AVSEQ01.MPG
Fail Rule = MIXED_AV

[MIXED_AV]
Callout = FNAME_PATTERN
Argument = *.MP3,*.mp3,*.WMV,*.wmv,*.WMA,*.wma,*.AAC,*.aac,*.JPG,*.jpg,*.MPG,*.mpg
A single device, /dev/cd0, is monitored by the built-in CD_MEDIA_IOBLK()

routine:
• When media is inserted, the content detection process begins with the
DVD_OR_CD rule.
• If this rule matches (is a DVD) then the process branches to the DVD_AUDIO rule.
If this rule fails, the process branches to the CD_AUDIO rule.
The DVD_AUDIO rule assumes the existence (using the built-in FNAME_MATCH
test) of a /AUDIO_TS/AUDIO_TS.IFO file on the DVD indicating DVD audio
content.
• Since both audio and video content may be present on a DVD, both Match and Fail
branch from here to the same rule to try next: DVD_VIDEO.
This behavior is similar to the behavior of the CD_AUDIO rule, as a CD can contain
both audio and data content.
Rules for determining CD data content, such VIDEO_CD or SVIDEO_CD, have
only a Fail branch, since a match at these levels is mutually exclusive with any
further content. If these rules match, then the content detection process stops.
• The final MIXED_AV rule has no branches. Regardless of the outcome, processing
stops at this rule.
During the content detection processing phase, any clients that have registered against
any matched rules will be notified. Multiple rules, or no rules at all, might be matched
by an inserted CD: an enhanced audio CD with a bonus music video might match both
CD_AUDIO and MIXED_AV rules, whereas a data CD backup of a development
system would match none.
Two-phase filesystem mount example
Below is a configuration file involving USB devices; it requires that an external USB
enumerator invoke devb-umass blk auto=partition disk name=umass in
response to insertions.
[/dev/umass*t*]
Priority = 11,10
Start Rule = MOUNT
[MOUNT]
Callout = MOUNT_FSYS
Argument = /dev/shmem/mcd.mnt
[/fs/usb*]
Priority = 11,10
Start Rule = MIXED_AV
[MIXED_AV]

Callout = FNAME_PATTERN
Argument = *.MP3,*.mp3,*.WMV,*.wmv,*.WMA,*.wma,*.AAC,*.aac,*.JPG,*.jpg,*.MPG,*.mpg
Note that the device pattern specified in the example above avoids the raw device itself
and only applies to partition entries. The mount configuration /dev/shmem/mcd.mnt
referred to contains:
/dev/umass*t1[124] /fs/usb%# dos

/dev/umass*t[146] /fs/usb%# dos
See also:
MultiMedia Engine (MME) Configuration Guide

mcs © 2010, QNX Software Systems GmbH & Co. KG.
Manipulate the comment section of an object file
Syntax:
mcs [-cdpV] [-a string] [-n name]* file...
Runs on:
QNX Neutrino
Options:
-a string Append string to the comment section.
-c Compress the contents of the comment section.
-d Delete the comment section.
-n name Specify the name of the comment section. The default is .comment.
-p Print the contents of the comment section.
-V Print the program version.
Description:
The mcs utility manipulates the comment section of an object file.
See also:
nm, objcopy, objdump

© 2010, QNX Software Systems GmbH & Co. KG. melt
Uncompress frozen files (UNIX)
Syntax:
melt [-cfvVz] [filename...]
Runs on:
Neutrino
Options:
See freeze.
Description:
The melt utility is equivalent to freeze -d. See the freeze utility for details.
The freeze/melt/fcat compression utilities will eventually become deprecated in

favor of the GNU zip suite, gzip/gunzip/zcat. The freeze suite of utilities will
continue to be provided for quite some time before being eliminated completely.
Leonid A. Broukhis
See also:
fcat, freeze, gzip, gunzip, zcat

mesg © 2010, QNX Software Systems GmbH & Co. KG.
Enable, disable, or query broadcast messages (QNX Neutrino)
Syntax:
mesg [toggle]
Runs on:
Neutrino
Options:
Where toggle is one of:
n Disable broadcast messages on the console.
y Enable broadcast messages on the console.
The exit values are:
• 0 - Receiving messages is allowed.
• 1 - Receiving messages is not allowed.
• > 1 - An error occurred.
If no toggle is specified, mesg prints the current status.
Description:
The mesg utility enables, disables, or queries broadcast messages on the console.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/mib.txt
Format for specifying variable names for SNMP utilities
Name:
/etc/mib.txt
Description:
The mib.txt file defines the format for specifying variable names for SNMP utilities.
Each entry in the file is a variable name in ASN.1 notation for object identifiers, as
defined in RFC 1065. The format is:
[.]A.B.C.D...
where A, B, C, D... are sub-identifiers in one of these forms:
• a decimal integer
Or:
• a symbol as found in RFC 1066 MIB — the case of the symbols isn’t significant
If you don’t precede the variable name with a . (dot), SNMP utilities add the prefix
iso.org.dod.internet.mgmt.mib to the name. To fully specify the variable
name, you must place a . (dot) before the first sub-identifier.
For example, the following refer to the same variable:
1.1.0 system.sysDescr.0 1.sysDescr.0 1.3.6.1.2.1.1.1.0
iso.org.dod.internet.mgmt.mib.system.sysDescr.0 .1.3.6.1.2.1.1.sysDescr.0
SNMP utilities search for a description of the variables in the following files, in this
order:
1 the file named in the MIBFILE environment variable
2 /nodecfg/node_name/etc/mib.txt, where node_name is the value of the

3 /etc/mib.txt
See also:

mixer © 2010, QNX Software Systems GmbH & Co. KG.
Audio mixer
Syntax:
mixer [-@] [-c card] [-m device] [-o display_level]
Runs on:
Neutrino
Options:
-@ Show subchannel volumes.
-c card The card ID of the mixer; the default is 0.
-m device The device ID of the mixer; the default is 0.
-o display_level Which settings are shown when the mixer starts up;
display_level is one of:
• 1 — display the playback settings.
• 2 — display the record settings.
• 3 — display playback and open-settings.
Description:
The mixer command starts the audio-mixer-control application:

© 2010, QNX Software Systems GmbH & Co. KG. mixer
The components of the mixer window depend on your system’s hardware.
The mixer uses the device /dev/snd/mixerCcardDdevice, where card and device are
the values specified for the -c and -m options.

mixer © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Start mixer for AuReal vortex 2:
mixer &
or, specifying the card and device explicitly:
mixer -@ -c 0 -m 0 &
Files:
libasound.so The shared object for the sound library.
/etc/system/config/audio/card name.io-ado-cfg
Where card name (set by the ado_card_longname() function) is
the long name used by the driver and where mixer stores
configuration data.

© 2010, QNX Software Systems GmbH & Co. KG. mkasmoff
Create an assembler include file from an ELF or COFF file
Syntax:
mkasmoff infile outfile
Runs on:
Options:
infile The name of an input ELF or COFF file.
outfile The name of the output file.
Description:
The mkasmoff utility reads the infile ELF or COFF object file (created with the
macros in <mkasmoff.h>) and creates an assembler include file called outfile
containing the appropriate macro definitions.

mkcldr © 2010, QNX Software Systems GmbH & Co. KG.
Convert CLDR text file to binary data for libqdb_cldr.so
Syntax:
mkcldr [options]* input file output file
Runs on:
Neutrino
Targets:
Options:
-c Name of the CHARMAP file (typically posix/UTF-8.cm from CLDR).
-i Secondary weight/flag for case inversion (default 0x0080).
-n Override name of collation in output file header.
-w Set variable weight threshold for ignorables (punctuation).
Description:
The mkcldr utility converts standard CLDR language collation (or sort order) tables
into a format usable by the libqdb_cldr.so DLL. Specifically, it reads the contents
of a text input file in the CLDR (Common Locale Data Repository) POSIX format and
writes this content to an output file as binary data suitable for libqdb_cldr.so.
To use other language collation tables, you can download them from
cldr.unicode.org, then use mkcldr to convert them.
If the collation rules in the files shipped with the QNX Neutrino or in the downloaded
files do not correspond to the rules required for your locale or implementation, you
can adjust them, then use mkcldr to create the files with the binary data format
required by libqdb_cldr.so.
Examples:
The following example converts the file for German used in Switzerland:
$ cd cldr-1.4.1/posix
$ mkcldr -c UTF-8.cm de_CH.UTF-8.src /etc/cldr/de_CH
The UTF-8.cm file is simply a database that maps textual character descriptions to
their Unicode value; it is used in parsing the collation information.

© 2010, QNX Software Systems GmbH & Co. KG. mkcldr
See also:
“Customizing language sort orders for libqdb_cldr.so” in Technotes, “Configuring
Internationalization” in the MME Developer’s Guide

mkbuild © 2010, QNX Software Systems GmbH & Co. KG.
Build one or more IDE projects
Syntax:
mkbuild -ws workspace [options]
mkbuild [-project] dir [options]
mkbuild -ws workspace -projects project1[,project2, ...] [options]
Runs on:
Windows, Linux hosts
Options:
dir A full project pathname where one or more projects are built.
project The name of the projects to build for one of the project types
supported by the IDE: Makefile project, QNX project, Managed
project, and Container project.
-stopOnError Stop on the first compile error.
This option isn’t valid for a full workspace build.
-targets target1[,target2. . . ]
The make targets (the build, clean, rebuild or custom make
target).
-variant variant The build variant:

• For a Managed project, the variant is the same as the
configuration. If it’s not assigned, the default is used.
• For a QNX project, the variant is All, Enabled, or a
platform/type (e.g. x86/release).
• For a container project, the variant is any defined container
configuration.
• For a workspace, the variant isn’t used. The default variant
for each project is used.
• For multiple projects, the defined variant for each project is
used (the project must understand the variant).
No spaces are allowed in project names, nor in the list of projects or targets.
-ws workspace The name of the workspace.

© 2010, QNX Software Systems GmbH & Co. KG. mkbuild
Description:
The mkbuild utility builds one or more projects in the IDE workspace, producing the
same results as an interactive build in the IDE. Building from the command line using
mkbuild uses the IDE project setup, and it runs the IDE (without the GUI) to perform
a build for specified projects.
mkbuild doesn’t work on QNX Neutrino hosts because the IDE isn’t included on
self-hosted QNX Neutrino systems.
Use QDE=path to override the default IDE installation location

($QNX_HOST/usr/qde.)
To build to a specified location, you must have write permission.
If a project doesn’t support a target, the default target is built. By default, for make
projects, no targets are defined; make targets have to be created from the GUI in order
to use named targets.
Examples:
Build a default target and variant for the project projectA:
mkbuild /home/user/workspace/projectA
Build all projects in a specified workspace:
mkbuild -ws /home/user/workspace
Build using another IDE installation:
QDE=/home/user/IDE4.7 mkbuild ...
Build the projectA and projectB projects with clean, all targets, and the x86
variant/configuration:
mkbuild -ws /home/user/workspace -projects projectA,projectB -target clean,all -variant x86
Exit status:
>0 All the specified projects were built successfully.
See also:
chmod, mkefs, mketfs, mkifs, mkimage, mksbp, qde
“Building projects” in the Developing C/C++ Programs chapter in the IDE User’s
Guide

mkdir © 2010, QNX Software Systems GmbH & Co. KG.
Make directories (POSIX)
Syntax:
mkdir [-m mode] [-p] dir...
Runs on:
QNX Neutrino
Options:
-m mode When creating the directory, set the permission bits of the new directory
to the specified mode value.
The mode argument is a symbolic_mode string, as defined for the chmod
utility. In the symbolic_mode strings, the op characters + and - are
interpreted relative to the default file mode for that file type:
+ Add permissions to the default mode.

- Delete permissions from the default mode.
= Assign permissions.
-p Create any missing intermediate pathname components.
dir A pathname at which a directory is to be created.
If you specify both the -p and -m options, any intermediate directories you have
created have mode u+wx.
Description:
The mkdir utility creates the directories specified by the dir operands, in the order the
dir operands are specified.
To create a directory, you must have write permission on the parent directory, or be
root.
Not all filesystems support the creation of directories. For example, /dev/shmem
(which really isn’t a filesystem but looks like one) doesn’t. For more information, see
the Working with Filesystems chapter of the QNX Neutrino User’s Guide.
The default file mode for directories is a=rwx (777), with selected permissions
removed in accordance with the file mode creation mask. (see the umask utility).
For intermediate pathname components created by mkdir, the mode is the default
modified by u+wx so that the subdirectories can always be created regardless of the
file-mode creation mask. If you want to assign different ultimate permissions for the
intermediate directories, you can do so with the chmod utility.

© 2010, QNX Software Systems GmbH & Co. KG. mkdir
When using -p with -m, each intermediate directory that doesn’t exist is created with
u+wx modes, regardless of the file mode creation mask. The specified mode applies
only to the last directory specified. For example:
mkdir -p -m 777 dir/dir1/dir2
gives dir and dir1 the default permissions for intermediate directories (i.e. u+wx).
The directory dir2 is given a+rwx permission.
The default file-creation mask influences the behavior of mkdir.
Examples:
Create a directory named /home/debbie:
mkdir /home/debbie
Exit status:
0 All the specified directories were created successfully, or the -p option was
specified and all the specified directories now exist.
Caveats:
If the mkdir utility is terminated by a signal, some of the specified directories may
have already been created.
See also:
chmod, rmdir, umask

mkdosfs © 2010, QNX Software Systems GmbH & Co. KG.
Format a DOS (FAT-12/16/32) filesystem (QNX Neutrino)
Syntax:
mkdosfs [-C|c size] [-e number]
[-F type] [-f number] [-h number]
[-I vol_id] [-L vol_label] [-m media]
[-O oem_label] [-R|r] [-S size] [-s size]
device | mountpoint | file
Runs on:
Neutrino
Options:
-C size Minimum default cluster size. Don’t specify both -C and -c.
-c size Cluster size for the filesystem; the default is determined by disk
geometry. Don’t specify both -c and -C.
-e number Number of root directory entries (FAT12/16 only); the default is

512.
-F type The FAT type (12, 16, or 32).
-f number Set the number of FAT tables to write; the default is 2.
-h number The number of “hidden sectors”; the default is determined by disk

geometry.
-I vol_id Set the volume ID/serial number; the default is based on the
current time.
-L vol_label Specify a volume label; the default is none.
-m media Media descriptor byte; the default is 0xF0 or, if there are hidden
sectors, 0xF8.
-O oem_label Set the OEM label; the default is:
MSDOS5.0 For a FAT12/FAT16 filesystem.

MSWIN4.1 For a FAT32 filesystem.
-R Preserve the size and content of existing reserved sectors

(reformat).
-r The number of “reserved sectors”; the default is determined by

FAT type.
-S size Sector size for the filesystem; the default is determined by disk
geometry.

© 2010, QNX Software Systems GmbH & Co. KG. mkdosfs
-s size Set the size (number of sectors) in the filesystem; the default is
determined by disk geometry.
device The device name to host the DOS filesystem (e.g. /dev/hd0t11).
mountpoint The mountpoint of the DOS filesystem (e.g. /fs/hd0-dos).
file A regular file to contain the DOS filesystem image.
Description:
The mkdosfs utility formats a DOS filesystem on the specified target (typically a disk
device or partition).
If you don’t specify essential user options such as FAT type and cluster size, mkdosfs
formats the DOS filesystem using the most suitable options for the size and disk
geometry of the host. You can override this default auto-configuration and force a
particular format to be used by setting the options you need.

filesystems:

a Read-only.
Examples:
# mkdosfs /dev/hd0t6
Format complete: FAT16 (4096-byte clusters), 201888 kB available.

mkdosfs © 2010, QNX Software Systems GmbH & Co. KG.
Exit status:
0 The filesystem was constructed without error.
1 The filesystem wasn’t constructed. This may be due to an error or inconsistency

with the user options or because of a nonrecoverable error, such as disk I/O or
insufficient memory.
Robert Nordier
License:
This utility is based on software from Robert Nordier; for licensing information, see
the Third Party License Terms List at
Caveats:
The mkdosfs utility destroys or overwrites any existing filesystem on the target.
See also:
chkdosfs, devb-eide, dinit, fs-dos.so, mkqnx6fs mount, umount

© 2010, QNX Software Systems GmbH & Co. KG. mkefs
Build an embedded filesystem (QNX)
Syntax:
mkefs [-c cache_dir] -t ffs2 | ffs3 [-l inputline] [-nv]
[buildfile [outputfile]]
Runs on:
Options:
-c cache_dir Cache compressed files in cache_dir.
-l inputline (“el”) Process inputline before interpretation of the buildfile begins.
Input lines given to mkefs should be quoted to prevent
interpretation by the shell (as mkefs input lines often contain
spaces). Multiple -l options are processed in the order specified.
No default.
-n Don’t use timestamps in the files. Using the -n option permits
identical images in binary format. Specifying additional -n options
strips all time information from files.
-t ffs2 | -t ffs3
Set the type of output file system. Use -t ffs2 to make a version 2
flash filesystem image. Use -t ffs3 to make a version 3 flash
filesystem image. The default is ffs3.
-v Operate verbosely. Specifying additional -v options increases
verbosity. Default is quiet operation.
Description:
The mkefs utility reads a text buildfile describing an embedded filesystem and
produces a binary image file containing the embedded filesystem. You can copy this
file to flash at a later stage, or use mkimage to combine it with an OS image before
downloading.
Don’t confuse this command with mkifs, which builds an OS image filesystem, or
mketfs, which builds an embedded transaction filesystem (ETFS).
The input and output files are specified on the command line:
buildfile The filename of the buildfile that describes the contents of the embedded
filesystem; use “-” to specify standard input (the default).
outputfile The filename of the image file containing the embedded filesystem; use
“-” to specify standard output (the default). Note that you can specify
the outputfile only if you specified a buildfile.

mkefs © 2010, QNX Software Systems GmbH & Co. KG.

Buildfiles
The buildfile uses the same grammar as the mkifs command, but supports different
attributes.
The buildfile is basically just a list of files that you want to be included in the
embedded filesystem image file when it’s built by mkefs. As well as the files to be
included, you can specify various attributes that are used to set parameters of the
filesystem and the files in it. For example, you can specify the maximum size of the
filesystem, or the user and group IDs of the individual files.
You can’t use a backslash (\) to break long lines into smaller pieces.
In a buildfile, a pound sign (#) indicates a comment; anything between it and the end
of the line is ignored. There must be a space between a buildfile command and the
pound sign.
Each line is in the form:
[attributes] file_specification
where the attributes (with the enclosing square brackets) and the file specification are
both optional.
Attributes provide information about the file following the attribute. They’re enclosed
in square brackets; when combining attributes (e.g. to specify both the user ID and the
group ID), enclose both attribute tokens in the same pair of square brackets. For
example:
# correct way
[uid=5 gid=5] filename
# incorrect way
[uid=5] [gid=5] filename
There are two types of attributes:
boolean attributes Those prefixed with a plus (“+”) or minus (“-”) sign.
value attributes Those ending with an equals sign (“=”) followed by a value.
Don’t put any spaces around the equals sign.
A question mark (?) before an attribute makes the setting conditional. The attribute is
set only if it hasn’t already been set. For example, ?+bigendian sets the
+bigendian attribute only if +bigendian or -bigendian hasn’t already been set.
The file_specification takes one of the following forms:

path The path is the same on the host as in the image.
target_path=host_path
The specified file or contents of the specified directory are fetched from the
host filesystem and placed into the image.
target_path={contents}
An inline definition. The contents of the file are listed within the buildfile
itself, enclosed in braces ({ }) — the file doesn’t exist on the host system
anywhere. The contents of the inline file can’t be on the same line as the
opening or closing brace.
The mkefs utility doesn’t parse the contents of an inline file for anything but the
closing brace. For example, mkefs doesn’t interpret a pound sign (#) in an inline file
as the beginning of a comment. The syntax of the inline file depends on what it’s used
for on the target system.
Closing braces (}) and backslashes (\) in an inline file must be escaped with a
backslash.
You can enclose a filename in double quotes ("") if it includes spaces or unusual
characters.
Attributes
The mkefs command supports the following attributes:
• +|-bigendian
• block_size=bsize
• cd=filename
• dperms=dperm_spec
• filter=filter_spec
• +|-followlink
• gid=id_spec
• max_size=msize
• min_size=tsize
• mount=filename
• mountperms=perm_spec
• +|-optional
• perms=perm_spec

• prefix=prefix_spec
• search=path:path. . .
• spare_blocks=sblocks
• type=file_type
• uid=id_spec
An OR-bar indicates that either the first element or the second element must be
present, but not both (e.g. +|- bigendian means either +bigendian or
-bigendian, but not +-bigendian).
bigendian attribute (boolean)

+|-bigendian
Set the byte order for the embedded filesystem to either big (via +bigendian) or little
(via -bigendian) endian. The default is little endian.
block_size attribute
block_size=bsize
Set the block size for the embedded filesystem. The block size depends on what
memory devices you have in your target hardware and how they’re arranged. For
example, two interleaved 64K × 8-bit devices configured for a 16-bit interface have a
block size of 128K bytes. The default block size is 64K bytes.
cd attribute
cd=filename
Set the current working directory to the specified pathname before attempting to open
the host file. Default is the directory from which mkefs was invoked.
dperms attribute
dperms=dperms_spec
Set the access permissions of the directory. If specified as a number, the permissions
are set to that number (just like the chmod command). If specified as an asterisk (“*”),
the host directory’s permissions are used; for an inline directory, the permissions are
obtained from the umask of the user running mkefs. Otherwise, a symbolic mode
string (which is a subset of chmod’s) is used to delete, add, or set permissions.
The symbolic mode string consists of:
1 a combination of u, g, o, and a
2 one of -, =, or +
3 a combination of r, w, x, s, g, and t.
You can include more than one symbolic mode string, separating them with a comma
(,).
The default dperms_spec is “*”.

filter attribute
filter=filter_spec
Run the host file through the filter program specified, presenting the host file data as
standard input to the program and using the standard output from the program as the
data to be placed into the embedded filesystem. Default is no filter.
The most common filter you’re likely to use with the embedded filesystem is
deflate. This compresses the file before copying it to the embedded filesystem. For
example:
[filter="deflate"]
You can specify a filter_spec of none. This is useful if you need to override a global
filter specification.
followlink attribute (boolean)

[+|-followlink]target_path=host_path
If you specify +followlink or omit it, mkefs follows any links and makes
target_path a copy of host_path.
If you specify -followlink, mkefs creates a link called target_path that points to
whatever host_path points at. It’s up to you to make sure that the file pointed to is
placed in the image.
gid attribute
gid=id_spec
Set the group ID number for the file. The value of this attribute may be either a
number or an asterisk (*). If it’s an asterisk, the group ID is taken from the host file;
for an inline file, the group ID is the group of the user running mkefs. The default
value for this attribute is *.
max_size attribute
max_size=size
Set the maximum size of the embedded filesystem. You can set this attribute if you
don’t want the filesystem to exceed a maximum size. If this occurs while mkefs is
building the filesystem, you’ll see a warning message. The default is 4G bytes.
min_size attribute
min_size=size
Set the minimum size of the embedded filesystem. If the size of the filesystem is less
than this size after all the specified files have been added, then the filesystem is padded
to the required size. The default is unspecified, meaning that no padding occurs.
mount attribute
mount=filename
Specify the mountpoint for the embedded filesystem. You can override the mountpoint
with the -n option to the flashctl command.
The default is "", which makes the flash filesystem drivers (devf-*) use the
appropriate default, usually /fs1p1.

mountperms attribute
mountperms=perms_spec
Set the access permissions for mountpoints. If specified as a number, the permissions
are set to that number (just like the chmod command). Otherwise, a symbolic mode
2 one of -, =, or +
(,).
The default perms_spec is “0777”.
optional attribute (boolean)

+|-optional
If true, and the host file can’t be found, output a warning and continue building the
embedded filesystem. If false, and the host file can’t be found, output an error message
and exit mkefs. The default is false.
perms attribute
perms=perms_spec
Set the access permissions of the file. If specified as a number, the permissions are set
to that number (just like the chmod command). If specified as an asterisk (“*”), the
host file’s permissions are used; for an inline file, permissions of 0666 are used.
Otherwise, a symbolic mode string (which is a subset of chmod’s) is used to delete,
add, or set permissions.
2 one of -, =, or +
(,).
The default perms_spec is “*”.

When running on a Windows host, mkefs can’t get the execute (x), setuid (“set user
ID”), or setgid (“set group ID”) permissions from the file. Use the perms attribute to
specify these permissions explicitly. You might also have to use the uid and gid
attributes to set the ownership correctly. To determine whether or not a utility needs to
have the setuid or setgid permission set, see its entry in the Utilities Reference.
prefix attribute
prefix=prefix_spec
Set the prefix on the target file names. The default is the empty string.
search attribute
search=path:path:...
This attribute specifies that mkefs should search for the file in the named locations on
the host system. The search directory portion of the host file name isn’t included in the
name that’s stored in the image file system.
Colon separators and forward slashes in the paths are the standard Unix conventions,
but for Windows searches, you must use the standard Windows conventions, such as
semicolon separators and backslashes in the paths.
spare_blocks attribute
spare_blocks=sblocks
Set the number of spare blocks to be used by the embedded filesystem. If you want the
embedded filesystem to be able to reclaim the space taken up by deleted files, set the
number of spare blocks to 1 or more. The default is 1.
type attribute
type=file_type
Sets the type of the files being created in the embedded filesystem. Allowable types
are:
• link — a symbolic link
• file — a regular, everyday file (the default)
• dir — a directory.

Specifying [type=dir] tells mkefs to make the named file a directory; you don’t
need to specify the type when you’re copying the contents of a directory. For example,
this command:
[type=dir]/usr/bin=/usr/nto/x86/bin
marks all the contents of /usr/bin as directories. To copy /usr/nto/x86/bin to

/usr/bin, you just need to specify:
/usr/bin=/usr/nto/x86/bin
uid attribute
uid=id_spec
Set the user ID number for the file. The value of this attribute may be either a number
or an asterisk (*). If it’s an asterisk, the user ID is taken from the host file; for an inline
file, the user ID is the user running mkefs. The default value for this attribute is “*”.
Examples:
Here’s a sample buildfile, my_efs.bld:
# A sample buildfile for mkefs
[block_size=128k spare_blocks=1]
/home/jwall/nto_flash
In this example, we’ve specified a block size of 128K and one spare block. The files
and subdirectories from the /home/jwall/nto_flash directory on the host system
are to be recursively copied into the root directory of the embedded filesystem.
To create an embedded filesystem image file using the above buildfile, invoke mkefs
as follows:
mkefs my_efs.bld my_image.efs
This creates the my_image.efs file containing the embedded filesystem, which can
then be copied to the target system.
Exit status:
See also:
deflate, devf-*, dumpefs, flashctl, inflator, mkifs
Making an OS Image chapter of Building Embedded Systems
QNX Neutrino System Architecture

© 2010, QNX Software Systems GmbH & Co. KG. mketfs
Build an embedded transaction filesystem (QNX)
Syntax:
mketfs [-l inputline] [-nv] [buildfile [outputfile]]
Runs on:
Options:
Input lines given to mketfs should be quoted to prevent
interpretation by the shell (as mketfs input lines often contain
spaces). Multiple -l options are processed in the order specified. No
default.
-n Don’t use timestamps in the files. Using the -n option permits

identical images in binary format. Specifying additional -n options
strips all time information from files.
-v[v..] Operate verbosely. Specifying additional -v options increases

Description:
The mketfs utility reads a text buildfile describing an embedded transaction
filesystem (ETFS) and produces a binary image file containing the ETFS as a sequence
of transactions. You can copy this file to flash at a later stage, using etfsctl.
Don’t confuse this command with mkifs, which builds an OS image filesystem, or
mkefs, which builds an embedded filesystem.
The input and output files are specified on the command line:
buildfile The filename of the buildfile that describes the contents of the embedded
filesystem; use “-” to specify standard input (the default).
outputfile The filename of the image file containing the ETFS; use “-” to specify
standard output (the default). Note that you can specify the outputfile
only if you specified a buildfile.
Buildfiles
The buildfile uses the same grammar as the mkifs command, but supports different
attributes.
The buildfile is basically just a list of files that you want to be included in the ETFS
image file when it’s built by mketfs. As well as the files to be included, you can

mketfs © 2010, QNX Software Systems GmbH & Co. KG.
specify various attributes that are used to set parameters of the filesystem and the files
in it. For example, you can specify the maximum size of the filesystem, or the user and
group IDs of the individual files.
pound sign.
both optional.
Attributes provide information about the file following the attribute. They’re enclosed
in square brackets; when combining attributes (e.g. to specify both the user ID and the
group ID), enclose both attribute tokens in the same pair of square brackets. For
example:
# correct way
# incorrect way

The mketfs utility doesn’t parse the contents of an inline file for anything but the
closing brace. For example, mketfs doesn’t interpret a pound sign (#) in an inline file
backslash.
characters.
Attributes
The mketfs command supports the following attributes:
• +|-bigendian
• block_size=bsize
• cd=filename
• cluster_size=csize
• dperms=dperm_spec
• +|-followlink
• gid=id_spec
• mountperms=perm_spec
• num_blocks=num
• +|-optional
• perms=perm_spec
• search=path:path. . .
• type=file_type
• uid=id_spec

You should explicitly specify the cluster_size, block_size and num_blocks

attributes as appropriate for your flash device to ensure that the image produced is
fully compatible with your specific device.
An OR-bar indicates that either the first element or the second element must be
present, but not both (e.g. +|- bigendian means either +bigendian or
-bigendian, but not +-bigendian).

+|-bigendian
Set the byte order for the embedded filesystem to either big (via +bigendian) or little
(via -bigendian) endian. The default is little endian.
block_size attribute
block_size=bsize
Set the block size for the ETFS. The block size depends on what memory device you
have in your target hardware. The default block size is 16 KB.
cd attribute
cd=filename
the host file. Default is the directory from which mketfs was invoked.
cluster_size attribute
cluster_size=csize
Set the cluster size for the ETFS. The cluster size depends on what memory device
you have in your target hardware. The default cluster size is 1 KB.
dperms attribute
dperms=dperms_spec
Set the access permissions of the directory. If specified as a number, the permissions
are set to that number (just like the chmod command). If specified as an asterisk (*),
the host directory’s permissions are used; for an inline directory, the permissions are
obtained from the umask of the user running mketfs. Otherwise, a symbolic mode
2 one of -, =, or +
(,).
The default dperms_spec is *.

filter attribute
filter=filter_spec
standard input to the program and using the standard output from the program as the
data to be placed into the embedded filesystem. Default is no filter.

If you specify +followlink or omit it, mketfs follows any links and makes
If you specify -followlink, mketfs creates a link called target_path that points to
gid attribute
gid=id_spec
for an inline file, the group ID is the group of the user running mketfs. The default
mountperms attribute
mountperms=perms_spec
Set the access permissions for mountpoints. If specified as a number, the permissions
are set to that number (just like the chmod command). Otherwise, a symbolic mode
2 one of -, =, or +
(,).
The default perms_spec is “0775”.
num_blocks attribute
num_blocks=num
Set the number of blocks in the ETFS. If the number of blocks is specified, then the
image file will be padded out to that size.


+|-optional
embedded filesystem. If false, and the host file can’t be found, output an error message
and exit mketfs. The default is false.
perms attribute
perms=perms_spec
Set the access permissions of the file. If specified as a number, the permissions are set
to that number (just like the chmod command). If specified as an asterisk (“*”), the
host file’s permissions are used; for an inline file, permissions of 0666 are used.
Otherwise, a symbolic mode string (which is a subset of chmod’s) is used to delete,
add, or set permissions.
2 one of -, =, or +
(,).
The default perms_spec is *.
When running on a Windows host, mketfs can’t get the execute (x), setuid (“set user
prefix attribute
prefix=prefix_spec
Set the prefix on the target file names. The default is the empty string.
search attribute
search=path:path:...
This attribute specifies that mketfs should search for the file in the named locations
on the host system. The search directory portion of the host file name isn’t included in
the name that’s stored in the ETFS.

type attribute
type=file_type
Sets the type of the files being created in the ETFS. Allowable types are:
• dir — a directory.
Specifying [type=dir] tells mketfs to make the named file a directory; you don’t
need to specify the type when you’re copying the contents of a directory. For example,
this command:
[type=dir]/usr/bin=/usr/nto/x86/bin
marks all the contents of /usr/bin as directories. To copy /usr/nto/x86/bin to

/usr/bin, you just need to specify:
uid attribute
uid=id_spec
file, the user ID is the user running mketfs. The default value for this attribute is *.
Examples:
Here’s a sample buildfile, my_etfs.bld:
# A sample buildfile for mketfs
[cluster_size=1k block_size=64k num_blocks=240]

/home/jgarvey/nto_flash
In this example, we’ve specified a cluster_size of 1 KB, a block_size of 64 KB

and a total device size of 240 blocks (which is the default configuration of
fs-etfs-ram). The files and subdirectories from the /home/jgarvey/nto_flash
directory on the host system are to be recursively copied into the root directory of the
ETFS.
To create an ETFS image file using the above buildfile, invoke mketfs as follows:
mketfs my_etfs.bld my_image.etfs

This creates the my_image.etfs file containing the ETFS filesystem, which can then
be copied to the target system as follows:
etfsctl -d /dev/etfs2 -S -e -w my_image.etfs -c
Exit status:
See also:
etfsctl, fs-etfs-ram
“Embedded transaction filesystem (ETFS)” in the Filesystems chapter of the System
Architecture guide
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. mkfifo
Make FIFO special files (POSIX)
Syntax:
mkfifo [-p] [-m mode] file...
Runs on:
Neutrino
Options:
-m mode When creating the FIFO special file, set the file permission bits of the
new file to the specified mode value.
The mode option argument is a symbolic_mode string, as defined for the
chmod utility. In the symbolic_mode strings, the op characters + and -
are interpreted relative to the default file mode for that file type, as
follows:
+ Add permissions to the default mode.

- Delete permissions from the default mode.
= Assign permissions.
-p Create directories in the FIFOs pathname, if required.
file The pathname at which a FIFO special file is to be created.
Description:
The mkfifo utility creates the FIFO special files specified by the file operands in the
order they’re specified.
To create a FIFO in a directory, you must have write permission for that directory or
be logged in as root.
The default file mode for FIFO files is a=rw (666) with selected permissions removed
in accordance with the file mode creation mask (see umask). For intermediate
pathname components created by mkfifo, the mode is the default modified by u+wx
so that any subdirectories and the FIFO file can always be created regardless of the file
mode creation mask. If you wish to assign different ultimate permissions for the
intermediate directories, you can change these permissions afterward with the chmod
utility.
Exit status:
0 Success.

mkfifo © 2010, QNX Software Systems GmbH & Co. KG.
Caveats:
If the mkfifo utility is terminated by a signal, some of the specified FIFO special files
or intermediate directories might have already been created, and may not be
automatically removed.
See also:
chmod, ln, mkdir, touch

© 2010, QNX Software Systems GmbH & Co. KG. mkfontdir
Create font server index files
Syntax:
mkfontdir [options]
Runs on:
Options:
-b Backup the old fontdir file before overwriting.
-d dir Directory containing font files.
-f pattern Construct details for this font pattern only (the default is *).
-i file The name of the font index file (the default is fontdir in the font
file directory). If the name doesn’t start with any of the characters /,
./, or ../, the index file is assumed to be located in the font
directory specified by the -d option.
-m file Deprecated.
-S directory The directory containing font engines. The default is the directory
currently used by phfont.
-s Sort the resultant index file.
-v Increase verbosity.
Description:
The mkfontdir utility builds an index file for the fonts in a directory. This index
contains information such as the name and type of each font, its size and style, a
textual description of the font family, and the range of characters defined within the
font. To be available to an application, at least one font must be defined in this
configuration file.
If you’re using mkfontdir under Linux, you should make sure that your
LD_LIBRARY_PATH environment variable includes
/opt/qnx630/host/linux/x86/usr/lib. As well, because Linux has its own
version of mkfontdir, you need to start the utility with the full path,
/opt/qnx630/host/linux/x86/usr/bin/mkfontdir, to start the QNX version.
Examples:
Create an index file called my_fontdir in the current working directory:
mkfontdir -i ./my_fontdir -d ${PHOTON_PATH}/font_repository

mkfontdir © 2010, QNX Software Systems GmbH & Co. KG.
Create an index file called my_fontdir in the

${PHOTON_PATH}/font_repository directory:
mkfontdir -i my_fontdir -d ${PHOTON_PATH}/font_repository
Files:
${PHOTON_PATH}/font_repository/fontdir
The index files for the fonts.
PHOTON_PATH The name of the root directory containing Photon files.
Exit status:
0 Success.
-1 An error occurred; an error message is displayed.

© 2010, QNX Software Systems GmbH & Co. KG. mkifs
Build an OS image filesystem (QNX)
Syntax:
mkifs [-a suffix] [-l inputline] [-n[n]] [-r rootdir]
[-s section] [-v] [buildfile [imagefile]]
Runs on:
Options:
-a suffix Append a suffix to symbol files generated via [+keeplinked].

Input lines given to mkifs must be quoted to prevent interpretation
by the shell (especially since mkifs input lines often contain spaces).
Multiple -l options are processed in the order specified. No default.
-n[n] Force the modification times of all inline files to be 0. If you specify
-nn, mkifs sets the modification times of all files to 0.
When mkifs adds files to an IFS image, it uses the timestamp
information from the file on the host machine. If mkifs is creating an
inline file (which doesn’t exist on the host machine), it has to
generate its own timestamp information. By default, it’s the time that
the image is generated.
This results in different checksum values for two identical builds
(because the file’s creation or modification times are different). If you
use -n, the checksum value is the same on all identical builds.
The -nn option addresses a quirk in NTFS relating to daylight
savings time. This option forces the modification time for all files in
the IFS image to be set to 0. This ensures that subsequent builds of
the same IFS image have the same checksum.
-r rootdir Search the default paths in the rootdir directory before searching
them in the default location. Normally, mkifs searches the default
paths in the sequence shown in MKIFS_PATH below. If you specify
the -r option, mkifs first searches the same paths prefixed with the
rootdir variable instead of ${QNX_TARGET}, like this:
1 rootdir/${PROCESSOR}/sbin
2 all other default paths, similarly prefixed with rootdir
3 ${QNX_TARGET}/${PROCESSOR}/sbin
4 all other normal default paths prefixed with ${QNX_TARGET}
The structure of the directory paths under rootdir must be identical to
that of the default paths under ${QNX_TARGET}, but rootdir itself

mkifs © 2010, QNX Software Systems GmbH & Co. KG.
may be any path you choose. For example, if you wanted to include
this file:
/dev/ppcbe/sbin/pci-ppc405
you would specify the option like this:
-r /dev
Notice that you don’t include ${PROCESSOR} in rootdir.
If you set MKIFS_PATH, mkifs ignores the -r option.
-s section Don’t strip the named section from ELF executables when creating
an IFS image. You can use this option more than once to specify
additional sections.
By default, mkifs doesn’t strip the QNX_Phab (Photon resources),
QNX_usage (usage message), and QNX_info (build properties)
sections.
-v Operate verbosely. Specifying additional -v options increases

Description:
The mkifs utility is used to create an OS image filesystem from a buildfile
specification.
Don’t confuse this command with mkefs, which builds an embedded filesystem, or
mketfs, which builds an embedded transaction filesystem (ETFS).
You can specify these files on the command line:
buildfile The input buildfile that mkifs is to construct an image from; use - to
specify standard input (the default).
imagefile The file to contain the image that mkifs builds; use - to specify
standard output (the default). Note that you can specify the imagefile
only if you’ve specified the buildfile.
Buildfiles
The buildfile uses the same grammar as the mkefs command, but supports different
attributes.
The buildfile specifies a list of files of various types; these files are placed by mkifs
into the output image. As well as the files to be included, you can specify various
attributes that are used to set parameters of the files or the image as a whole.

pound sign.
both optional.
You can use an attribute:
• on the same line as a filename — the attribute modifies only that file
• on a line by itself — the attribute modifies all subsequent files
Enclose the attributes in square brackets; when combining attributes (e.g. to specify
both the user ID and the group ID), enclose both attribute tokens in the same pair of
square brackets. For example:
# correct way
# incorrect way

The mkifs utility doesn’t parse the contents of an inline file for anything but the
closing brace. For example, mkifs doesn’t interpret a pound sign (#) in an inline file
backslash.
Either class of file may be preceded by zero or more attributes. These attributes are
used to specify the characteristics of the file (e.g. the user ID that is to own the file on
the target system, the type of file, etc.).
By default, mkifs strips debugging information from executable files that you include
in the image. Doing this helps to reduce the size of the image. To keep this
information, specify the +raw attribute.
By default, mkifs doesn’t strip the QNX_Phab (Photon resources), QNX_usage (usage
message), and QNX_info (build properties) sections. You can use the -s option to
specify additional sections not to be stripped.
characters.
Attributes
The mkifs command supports the following attributes:
• +|-autolink
• +|-big_pages
• +|-bigendian
• cd=path
• chain=addr
• code=uip_spec
• +|-compress
• data=uip_spec
• dperms=perm_spec
• +|-followlink

• gid=id_spec
• image=addr_space_spec
• +|-keeplinked
• linker= [ linker_id_spec ] linker_spec
• module=module_name
• +|-optional
• +|-page_align
• pagesizes=size[,size]...
• perms=perm_spec
• phys_align=size
• physical=boot_spec
• ram=addr_space_spec
• +|-raw
• +|-script
• search=filename:filename:. . .
• type=file_type
• uid=id_spec
• virtual=[cpu_name,]bootfile_name [filter_args]
An OR-bar indicates that either the first or second element must be present, but not
both (e.g. +|- bigendian means either +bigendian or -bigendian, but not
+-bigendian).
autolink attribute (boolean)

+|-autolink
If the autolink attribute is on (which it is by default), when mkifs detects that it’s
processing a shared object, it looks inside the image for the SONAME (specified by the
linker -h option). This is typically the shared object name, including the version
number (e.g. libc.so.1). The mkifs command puts the file into the image
filesystem under the name with the version number and makes the name without the
version number into a symbolic link to the file. For example, specifying:
libc.so

in the buildfile makes libc.so.1 the name of the file and libc.so a symlink to it.
Specifying:
libc.so.1
in the buildfile gives the same results. You end up with the name with and without the
version number in the image filesystem no matter which one you specify in the
buildfile.
If the name that would be used as the symbolic link is already specified somewhere
else in the buildfile, the symbolic link isn’t created. For example:
libc.so.1
libc.so.2
[type=link] libc.so=libc.so.2
ensures that libc.so is pointing at the “proper” version of the library.

You can disable this feature by specifying the -autolink attribute.
+|-big_pages attribute (boolean)

This attribute makes mkifs attempt to align binaries and shared libraries at the
appropriate address, based on the size of the UIP text. You can use the pagesizes
attribute to indicate the page sizes that the underlying hardware supports. You can
specify these attributes in the buildfile or in the bootfile. The big_pages attribute is
off by default.
A phys_align attribute overrides the big_pages alignment hint. For example:
[+big_pages pagesizes=4k,64k]
libc.so
[-big_pages]a_binary_that_doesnt_want_bigpages
[phys_align=1m]explicit_override_for_this_file

+|-bigendian
Set the byte order for the image filesystem to either big (via +bigendian) or little
(via -bigendian) endian. This option doesn’t normally need to be specified when
building a bootable image, since the bootfile provides the required byte order. If you
aren’t building a bootable filesystem, or the bootfile doesn’t say which byte order to
use, mkifs uses the host system’s byte order in building the image filesystem.
cd attribute
cd=path
the host file. Default is the directory from which mkifs was invoked.

chain attribute
chain=addr
Set the address at which the operating system will find the next image filesystem.
Default is none.
code attribute
code=uip_spec
Set whether the code segment of an executable is used directly from the image
filesystem (uip or u) or copied (copy or c) when invoked. The default is to use the
code segment in place (uip). For more information, see “Notes on XIP versus copy,”
below.
compress attribute (boolean)

+|-compress[=algorithm]
Set whether the image is compressed. The default is false.

If you turn compression on, you can optionally specify the algorithm by number:
• 1 — ZLIB
• 2 — LZO
• 3 — UCL8 (the default)
data attribute
data=uip_spec
Set whether the data segment of an executable is used directly from the image
filesystem (uip or u) or copied (copy or c) when invoked. The default is to use the
data segment in place (uip). For more information, see “Notes on XIP versus copy,”
below.
dperms attribute
dperms=perm_spec
Set the access permissions of the directory. See the perms attribute for more
information.
filter attribute
filter=filter_spec
standard input to the program, and use the standard output from the program as the
data to be placed into the image filesystem. Default is no filter.
To illustrate the use of a filter, consider storing a compressed file in the image
filesystem, where the file exists in its uncompressed form on the host filesystem:
[filter="compress"] data.Z = data

This runs compress from a shell, passing it the contents of data as standard input.
The compress command runs and generates the compressed version of its standard
input on its standard output. The standard output is then placed into the image
filesystem as the data.Z file.

If you specify +followlink or omit it, mkifs follows any links and makes
If you specify -followlink, mkifs creates a link called target_path that points to
gid attribute
gid=id_spec
for an inline file, the group ID is the group of the user running mkifs. The default
image attribute
image=addr_space_spec
Set the base and size limits for the image filesystem. The format for this attribute
consists of an optional starting address, followed by zero or more parameters for
sizing the address space. You can use a case-insensitive suffix of k, m, or g on the
addresses and sizes.
The starting address is the base address of the image, and matters only when building
a bootable image. Its default depends on the bootfile selected. For example, on an x86
using the bios.boot file, the image address begins at 4 MB.
-end_addr A dash followed by a number represents an ending address, the last

allowable address in the image. If the output image exceeds this
address, an error is reported. The default is no limit.
,maxsize A comma followed by a number represents the maximum allowed size

of the image. If the output image becomes larger than this value, an
error is reported. The default is no limit. The maximum image size
depends on your configuration; for example, it may be limited on an
x86 system with a BIOS.
=totalsize An equals sign followed by a number represents the total size that the
output image is padded out to. The default is no padding.

%align A percent sign followed by a number represents the alignment value

used for the image. The output image size is padded out to a multiple
of this value. The default is 4.
You have to specify both image and ram file attributes if you want to create the image
in ROM/FLASH; otherwise the process manager assumes that the image is in RAM.
For more information, see “Notes on XIP versus copy,” below.
keeplinked attribute (boolean)

+|-keeplinked
If true, and mkifs has to run a linker to position the executable within the image
filesystem, the output file from the link is the basename of the host path with .sym
appended. For example, if the host name is ../foo/bar, the output name is
bar.sym. If false, a generated temporary name is used for the output file and it’s
deleted after mkifs has run. The default is false.
linker attribute
linker=[linker_id_spec]linker_spec
When building a bootable image, mkifs sometimes needs to run a linker on

relocatable objects to position them within the image. This option lets you specify
printf -like macro expansions to tell mkifs how to generate the linker command line
(see “Linker Specification,” below for details).
You don’t normally need to specify this option, since mkifs or a bootfile provides a
default. You can use different linkers for different types of ELF files.
The attribute value consists of an optional linker ID specification and a linker
specification. The linker ID specification, if present, consists of:
1 An opening parenthesis, (.
2 A list of comma-separated numbers giving the allowable ELF machine numbers

(EM_* constants from the include file <sys/elf.h>) for the linker
specification. Terminate the list of machine numbers with a semicolon.
3 A list of comma-separated numbers, giving the list of acceptable ELF file types
(ET_* constants, from <sys/elf.h>). Terminate this list with a semicolon.
4 A comma-separated list of numbers giving ELF program segment types (PT_*

constants, also from <sys/elf.h>).
5 A closing parenthesis, ).
If the ID specification is present, the linker specification is used only if the machine
number of the ELF input file matches one of the given numbers, and the ELF file type
of input file matches one of the given numbers and at least one of the program
segment types in the input file matches one of the given numbers:

• If the machine number list is empty, any machine number type in the input file is
acceptable.
• If the program segment number list is empty, any program segment number types
in the input file are acceptable.
• If the ELF file type number list is empty, ET_REL is assumed.
module attribute
module=module_name
Use this attribute to add optional modules to procnto.
For example, in order to use the adaptive partitioning scheduler, you must rebuild your
OS images with the option [module=aps] added to the PATH= statement of your
buildfile:
[module=aps] PATH=/proc/boot ./procnto -vv
You can now create partitions and launch applications within a particular partition for
the adaptive partitioning scheduler.
For information on creating a partition, see “Creating partitions” in the Setting Up and
Using the Adaptive Partitioning Scheduler chapter of the Adaptive Partitioning User’s
Guide.
For information on launching applications within a particular partition, see “Launch
processes in partitions” in the Setting Up and Using the Adaptive Partitioning
Scheduler chapter of the Adaptive Partitioning User’s Guide.
This attribute was added in the QNX Neutrino Core OS 6.3.2.

+|-optional
image filesystem. If false, and the host file can’t be found, output an error message and
exit mkifs. The default is true. You can’t set this attribute to true for bootstrap
executables (see the virtual attribute for more information).
page_align attribute (boolean)

+|-page_align
If true, align the file on a page boundary. The mkifs utility always aligns executables
and shared objects on page boundaries, so this attribute has an effect only on data files
and files that you specify +raw for.
pagesizes attribute
pagesizes=size[,size]...
This attribute defines the page sizes that the underlying hardware supports, for use
with the big_pages attribute. The sizes can be in any order, and can include a
case-insensitive suffix of k, m, or g.
You can specify these attributes in the buildfile or in the bootfile.

perms attribute
perms=perm_spec
Set the access permissions of the file. The perm_spec can be one of the following:
• a number (just as with the chmod command)
• an asterisk (*) to use the host file’s permissions (or 0666 for inline files)
• a symbolic mode string to delete, add, or set permissions. This string is a subset of
chmod’s and consists of:
2 one of -, =, or +
You can include more than one symbolic mode string, separating them with a
comma (,).
The default is *.
When running on a Windows host, mkifs can’t get the execute (x), setuid (“set user
ELF executables and shared objects are automatically marked as executable (unless
you specify [+raw]).
phys_align attribute
phys_align=size[,group]
The phys_align attribute lets you align IFS objects on specific physical address
boundaries to take advantage of large pages. The size is an integer, optionally
followed by k, m, or g in lower- or uppercase. This attribute overrides the
+|-big_pages attribute.
For example, to align a file on a 64 KB boundary, potentially allowing the use of 64
KB pages to map 64 KB chunks of the file, specify:
[phys_align=64k] some_executable
You can use the optional group option to group shared objects together based on an
alignment size. For example:
[phys_align=16M,group]
first.so
second.so
third.so
[phys_align=0] # ends alignment
In this example, first.so is aligned to 16 MB, and each successive shared object
either completely fits within that same 16 MB page, or is bumped to the next 16 MB
boundary.

physical attribute
physical=[cpu_name,]boot_filename [filter_args]
This attribute indicates that a bootable filesystem is being built. You can specify it
only once in a buildfile. The image will be run in physical memory mode.
The physical attribute isn’t currently implemented; use virtual.
For more information, see the virtual attribute.
prefix attribute
prefix=prefix_spec
Set the prefix for the target file names. Default is proc/boot when building a
bootable image, and the empty string when not.
ram attribute
ram=addr_space_spec
Set base and size limits for the read-write memory required by executables in the
image filesystem. This attribute consists of an optional starting address, followed by
zero or more parameters for sizing the address space. You can use a case-insensitive
suffix of k, m, or g on the addresses and sizes.
For more information, see “Notes on XIP versus copy,” below.
You need to specify this attribute if the actual image is going to be stored on a
read-only device such as ROM or flash memory. Use the image attribute to specify
the location.
The starting address specifies the base address of the RAM, and matters only when
building a bootable image. The default depends on the bootfile you select.
-end_addr A dash followed by a number represents an ending address, the last

allowable address for RAM. If the RAM usage exceeds this address, an
error is reported. The default is no limit.
,maxsize A comma followed by a number represents the maximum allowed size

of the RAM. If the output image requires more RAM than this value,
an error is reported. The default is no limit. The maximum RAM size
depends on your configuration.
=totalsize An equals sign followed by a number represents the total size that the
RAM usage is padded out to. The default is no padding.
%align A percent sign followed by a number represents the alignment value

used for the RAM. The RAM size is padded out to a multiple of this
value. The default is 4.

For information about how everything interacts, see “Notes on XIP versus copy,”
below.
raw attribute (boolean)

+|-raw
If the raw attribute is false (the default), mkifs strips debugging information from
executable files.
If you specify +raw for a file, the file is treated as a data file, even if it would normally
be treated as an executable and relocated.
Don’t specify the +raw attribute for shared objects; it prevents them from being
shared.
If you use the default attribute (-raw) and you specify that the data segment is to be
used in place, the file’s sticky bit will not be set. This identifies the executable to the
QNX process manager, which will prevent the program from running more than once,
avoiding the possibility of running a program with corrupted static data.
Here’s a fragment from a buildfile that demonstrates the use and scope of the raw
attribute:
...
[+raw] # Don’t strip debugging information

my_app1
[-raw] esh # Only esh is affected

pwm # Still affected by +raw flag
pfm
[-raw] # Turn off +raw, since shared objects

libphrender.so # can’t be shared if +raw is enabled
libph.so
[+raw] my_app2 # We want debugging information for this

# file only. The -raw flag is
# still in effect for other files.
libc.so # Still affected by -raw flag
...
If you use Windows tools to build your image, files specified as +raw won’t have
executable permission when the image is booted. This is because the win32 filesystem
can’t set a file’s executable bit. To make such files executable, specify perms=+x
when using +raw in the buildfile.
script attribute (boolean)

+|-script
If true, the host file is opened and processed as a script file after the process manager
has initialized itself. Each line is parsed as a command line to be run. If multiple files
are marked with +script, they’re merged sequentially into a single file in the image

filesystem; the file’s name is the first script filename in the buildfile. The filenames for
the subsequent script files are ignored, but they must be unique. See “Script Files,”
below for more details on the command-line syntax.
search attribute
search=filename:filename:...
This attribute specifies that mkifs is to search for the file in the named locations on
the host system. The search directory portion of the host file name isn’t included in the
name that’s stored in the image filesystem. The default is the contents of the
MKIFS_PATH environment variable.
type attribute
type=file_type
Set the type of the files being created in the image filesystem. Allowable types are:
• fifo — a named pipe
• dir — a directory
Specifying [type=dir] tells mkifs to create a directory on the target system; you
don’t need to specify the type when you’re copying the contents of a directory. For
example, to copy /usr/nto/x86/bin to /usr/bin, you a just need to specify:
uid attribute
uid=id_spec
file, the user ID is the user running mkifs. The default value for this attribute is *.
virtual attribute
virtual=[cpu_name,]bootfile_name [filter_args]
This attribute specifies that a virtual address system is being built.
If there’s a comma (,) or slash (/) in the value, the string in front of it is taken to be
the CPU type of the target system. If you don’t specify a CPU type, mkifs uses the
host system’s CPU type. The PROCESSOR environment variable is set to that string
(which affects the MKIFS_PATH search path for host files).

The characters after the comma or slash (or the equal sign for the attribute if there’s no
comma or slash) up to the first blank character are taken to be the name of the bootfile.
The suffix .boot is appended to the given name and MKIFS_PATH is searched for
the file. The default bootfiles are in ${QNX_TARGET}/${PROCESSOR}/boot/sys.
The bootfiles vary from one processor to another, but these are the main ones:
binary.boot Create a simple binary image (without the jump instruction that
raw.boot adds). If you build a binary image, and you want to
load it with U-Boot (or some other bootloader), you have to
execute mkifs -vvvv buildfile imagefile, so that you
can see what the actual entry address is, and then pass that entry
address to the bootloader when you start the image. If you
modify the startup code, the entry address may change, so you
have to obtain it every time. With a raw image, you can just
have the bootloader jump to the same address that you
downloaded the image to.
bios.boot Create an image that’s suitable for machines with a BIOS.

Information that’s gathered from the BIOS is put into the startup
headers.
bios16m.boot Don’t check memory above 16 MB. Use this bootfile with older
BIOSs that have trouble with such memory.
bios_nokbd.boot Don’t do anything with the keyboard controller. Use this

bootfile if the BIOS doesn’t properly support or emulate the
legacy functionality of keyboard controllers at address 0x64.
Starting in QNX Neutrino 6.5.0, bios.boot contains a test to determine whether or

not it should behave like bios_nokbd.boot; it should work for the majority of
platforms that previously required bios_nokbd.boot.
elf.boot Create an image that looks like an ELF executable.
nobios.boot Create an image that’s suitable for machines that don’t have a
BIOS.
openbios.boot Create an image for IBM’s OpenBIOS.
prepboot.boot Create an image that boots from disk off a PREP machine.
raw.boot Create a binary image with an instruction sequence at its

beginning to jump to the offset of startup_vaddr within the
startup header. The advantage is that when you download a raw
image to memory using a bootloader, you can then instruct it to
run right at the beginning of the image, rather than having to
figure out what the actual startup_vaddr is each time you
modify the startup code.

srec.boot Create an image in S-record format.
For more details on the contents of the file, see “Bootfile,” below.
Any characters in the attribute value following a blank are used as arguments to any
image filter command specified by the bootfile, like this:
[virtual="x86,srec -b"] boot = {
If the value of the virtual attribute includes a space, put quotation marks around the
string. Otherwise, mkifs will try to interpret the value as an additional buildfile
attribute placed in the same set of square brackets.
The contents of the host file that this attribute applies to are parsed to discover the
bootstrap executables used to bring up the system. Each line identifies one bootstrap
executable:
• The first executable must be the QNX Neutrino startup executable (startup-*)
that’s appropriate for the target system. For more information, see startup-*.
• The last must be procnto. Specifying the PATH and LD_LIBRARY_PATH

environment variables before procnto sets their default values in the OS image.
Script files
As mentioned above, by specifying the [+script] attribute, you’re telling mkifs
that the specified file is a script file, a sequence of commands to be executed when the
process manager has completed its startup.
In order to run a command, its executable must be available when the script is
executed. You can add the executable to the image, or get it from a filesystem that’s
started before the executable is required. The latter approach results in a smaller
image.
The bootfile typically sets the _CS_PATH configuration string, and might set
_CS_LIBPATH. You can set environment variables, such as PATH and
LD_LIBRARY_PATH, in a script file.
Script files, for the most part, look just like regular shell scripts, except that:
• there are special modifiers that you can place before the actual commands to run
• some commands are considered to be built-in
• mkifs preparses the script file contents before placing them into the image.
The script file consists of one or more lines, with each line having the following
syntax:
[modifiers] [command_line [&]]

The modifiers consist of a list, enclosed in square brackets, of blank-separated items

that modify how QNX Neutrino runs the specified command_line. If there’s a
command line following the modifiers, the modifiers affect only that one command
line. If there’s no command line, the modifiers affect all subsequent command lines.
Startup scripts support foreground and background processes. Just as in the shell,
specify an ampersand (&) on the command line to make the program run in the
background. If you run a program in the foreground, and it doesn’t exit, then the rest
of the script is never executed, and the system might not become fully operational.
The modifiers are described below. Those marked as “boolean” accept a plus (+) or
minus (-) character to enable or disable the effect; the others accept a parameter.
argv0 modifier
Sets the argv[0] element of the command argument entry. By default, this is the same
as the command name. This option is typically used to simulate invoking a command
via a different name; the classical example is the compress command, which can be
invoked as uncompress:
[argv0=uncompress] compress filename.Z
cpu modifier
Specifies the CPU on which to launch the following process (or, if the attribute is used
alone on a line without a command, sets the default CPU for all following processes).
This modifier is useful for setting up bound multiprocessing (BMP). Specify the CPU
as a zero-based processor number:
[cpu=0] my_program
A value of * allows the processes to run on all processors:

[cpu=*] my_program
At boot time, if there isn’t a processor with the given index, a warning message is
displayed, and the command is launched without any runmask restriction.
Due to a limitation in the boot image records, this syntax allows only the specification
of a single CPU and not a more generic runmask. Use the on utility to spawn a process
within a fully specified runmask.
external modifier (boolean)
Ordinarily, mkifs recognizes certain commands as internal commands, ones that

aren’t loaded from the host’s filesystem, but are understood directly by mkifs. These
commands are:
display_msg message
Causes the message immediately following the display_msg command to be
output. This is useful during startup diagnostics; often used as a checkpoint.

procmgr_symlink
Equivalent to ln -P, except that you don’t need to have ln present.
reopen [filename]
Causes standard input, standard output, and standard error to be redirected to the
specified filename. Also causes the interpretation of the script file to suspend
temporarily until a stat() on the specified pathname succeeds. The default
filename is /dev/console.
waitfor pathname [wait_time]
Causes interpretation of the script file to suspend temporarily until a stat() on the
specified pathname succeeds. Often used for synchronization, to allow a
resource manager to perform its startup functionality, and then for the process
manager to proceed with the further interpretation of the script file.
The optional wait_time specifies the maximum number of seconds to wait for
the file to appear. It can include one decimal place to specify tenths of a second.
The default is 5.0 seconds.
The +external modifier instructs mkifs to search for the specified command on the
host filesystem, rather than assume the internal meaning for the command. The default
is -external.
Using +external is a dubious practice. Specifying an external modifier on a

command that isn’t an internal command is redundant.
pri modifier
Lets you specify the command’s priority and optionally the scheduling policy. The
pri modifier accepts a numeric priority, optionally followed by one of the letters:
f FIFO scheduling policy.
r Round-robin scheduling policy.
o Other scheduling policy (currently maps to round-robin).
See the System Architecture guide for a description of the various priority levels and
scheduling algorithms.
For example, to start up the console driver, devc-con at priority 20, with FIFO
scheduling, specify:
[pri=20f] devc-con -n9 &

The default priority and policy are specified by procnto, and could change in future
versions of QNX Neutrino. If the priority and scheduling policy of the processes are
important to you, be sure to use the pri= modifier.
session modifier (boolean)
If +session is specified, make the process a session leader (as per POSIX), and make
the process’s stdin the controlling terminal (i.e. direct Ctrl-C at this process group). If
-session is specified, don’t make the process a session leader. The default is
-session.
This parameter is typically used for the shell:
[+session] esh
Bootfile
When building a bootable filesystem, you must specify a bootfile via the physical or
virtual attribute. Note that the bootfile must be the first file specification within the
buildfile. If the first character of the bootfile is a left square bracket ([), a list of
configuration attributes is given in the same syntax as the buildfile. The list of
attributes is terminated by a right square bracket (]). The allowed attributes, and their
formats, are:
attr=image_attribute
Specify an attribute to add to the image. These attributes are
processed after the -l (“el”) command-line options and the
buildfile, but you normally use the ? prefix on the
image_attribute, so that it doesn’t override anything explicitly
set by the -l option or the buildfile.
+|-big_pages Align binaries and shared libraries at the appropriate address,

based on the size of the UIP text and the sizes specified by the
pagesizes attribute. You can specify these attributes in the
buildfile or in the bootfile. For more information, see the
big_pages buildfile attribute.
default_image=addr_space_spec
Set the defaults for the image file attribute (see above).
default_ram=addr_space_spec
Set the defaults for the ram file attribute (see above).
filter=image_filter_spec
After the image has been created, run image_filter_spec. The
following formatting codes are expanded:

• %i — the name of the output image file.

• %I (uppercase i) — the name of the input file (see below).
• %s — the offset of the startup header in the image file, in hex
with a leading 0x.
• %a — any arguments from the physical or virtual
attribute.
See “Image filter,” below for an example of using the
image_filter_spec.
len=boot_length The boot_length parameter gives the amount of space to leave

at the front of the image file (before the actual image filesystem)
for system header information or boot prefix code. This is the
minimum amount of space to reserve. If the boot prefix code
following the bootfile attributes is larger than the number given
here, the size of the boot prefix code is used instead. The default
is zero.
notloaded=length In some systems (such as IBM OpenBIOS), the system header

information isn’t loaded into memory and doesn’t contribute to
the memory offsets where things are placed (the base address of
the image being set by the image attribute in the buildfile). This
attribute specifies the size of the information that isn’t going to
be loaded into memory. The default is zero.
paddr_bias=number
On some CPUs (such as MIPS), the hardware reserves a range
of virtual addresses that map one-to-one with physical address.
This attribute lets mkifs know how to translate a virtual address
to its physical location in memory via the formula:
phys_addr = virt_addr + number
The default is zero.
pagesize=size Set the size of a page in the image filesystem. The mkifs utility
aligns various structures to a multiple of this. The default is 4
KB.
pagesizes=size[,size]...
Define the page sizes for use with the big_pages attribute. You
can specify these attributes in the buildfile or in the bootfile. For
more information, see the pagesizes buildfile attribute.
vboot=addr When building a virtual system, the paging hardware is

sometimes turned on by the startup code (e.g. x86 architecture),
as opposed to procnto (e.g. MIPS architecture). In the first
case, this option tells mkifs what base virtual address to use for

the bootstrap executables. This option has no effect when

building a physical system. The default is none.
Following the closing square bracket character (]) of the bootfile attributes, mkifs
searches for the string boot. If it’s found, mkifs considers all data immediately
following, through to the end of the file, to be boot prefix code. This data is placed at
the start of the image file. If the len attribute was specified and is larger than the size
of the boot prefix code, the image file is padded out to the size given.
Image filter
You can specify an image filter within the specification for the bootfile, and optionally
specify macro expansions to it. These macro expansions are documented above, in the
filter description.
The following image filters are currently available:
mkifsf_elf Wrap the entire image in an ELF section.
mkifsf_openbios
Patch the header at the beginning of the image for IBM’s
OpenBIOS.
mkifsf_srec Convert the image into S-Record format. This filter accepts the
following options:
• -b — generate only 4-byte address records.
• -c — omit the carriage-return character at the ends of lines.
• -l — omit the linefeed character at the ends of lines.
Generally, image filters are expected to take the file specified by the %i variable and
modify it in place. If this isn’t possible (e.g. the file changes size as a result of the
filter program), specifying %I causes mkifs to store the original file in a temporary
filename (named by %I), and expect the modified file in the filename given by %i. This
happens only when the %I macro expansion is specified.
Linker specification
The linker specification lets you control how the linker command line is built when
mkifs needs to turn a relocatable object into an executable running at a particular
address. It operates much like a printf() format string, with characters being copied
from the format to the command line until a percent character (%) is found. The
following formatting codes after a percent character are supported:
%h The address to place the executable header at, in hexadecimal.
%t The address to place the text segment at, in hexadecimal. This is %h plus the
amount of space for the executable header structures.

%d The address to place the data segment at, in hexadecimal. This value may be
zero, in which case the data is placed immediately following the text segment.
%o The name of the output executable file, as a string.
%i The name of the input relocatable file, as a string.
%( Open a conditional section. Following the opening parenthesis, (, are: a single

character indicating the variable that the section is conditional on; one of the
usual conditional operators from the C language; a constant; and finally a
comma.
The contents of the variable are compared against the constant and if the result
is true, the text following the comma is included in the command string being
built. If the comparison is false, the contents of the string following the comma
are omitted.
The conditional is terminated by percent character followed by a closing
parenthesis, %). You can nest conditionals. The variables that you can test are:
Variable: Value:
e 0 == little endian 1 == big endian
d Data segment address
f 0 == startup file 1 == bootstrap file 2 == normal file
h Executable header address
m Machine number from the ELF header
v 0 == file linked physically 1 == file linked virtually
V 0 == physical system 1 == virtual system
%) Terminate a conditional section.
Here’s the default linker command specification for mkifs:

static char default_linker[] = {
"qcc"
" -bootstrap -nostdlib -Wl,--no-keep-memory -Vgcc_nto"
"%(m==3,x86%)%(m==6,x86%)"
"%(m==8,mips%)"
"%(m==20,ppc%)"
"%(m==40,arm%)"
"%(m==42,sh%)"
"%(m!=3,%(m!=6,%(e==0, -EL%)%(e==1, -EB%)%)%)"
"%(h!=0, -Wl,-Ttext -Wl,0x%t%)%(d!=0, -Wl,-Tdata -Wl,0x%d%)"
" -o%o %i"
"%[M -L%î -Wl,-uinit_%n -lmod_%n%]"
};
For the meaning of the parameters specified, see gcc.

Output image format

The image created by mkifs has the following layout:
Boot prefix
Startup header Present only in a
Startup bootable image
Startup trailer
Image header
Image directory
File 1
File 2
...
File n
Image trailer
• The boot prefix is generated based on the bootfile that you specified with the
virtual= or physical= attribute.
• The boot prefix, startup header, startup, and startup trailer are present only in a
bootable image.
• A checksum for the startup information is stored in the startup trailer.
• A checksum for the image is stored in the image trailer.
Although it isn’t necessary to have a detailed understanding of the format of an image

to make one, a general understanding is worthwhile.
Boot prefix
The first section (called the boot prefix) is controlled by the bootfile that you specified
in the virtual= or physical= attribute. For many systems this section doesn’t
occupy any space in the image. When it’s present, it’s typically used to address one of
the following issues:
• The IPL code that transfers control to the image doesn’t set up the processor state
in a way that’s compatible with startup. In this case, this section contains code that
does that work. If you’ve written your own IPL, it ensures the processor is in a
suitable state before jumping to startup, and this section is empty.
A boot on a standard x86 PC is a good example of the need for placing code here.
When a PC boots, it transfers control while in 16-bit real mode. The startup
program assumes the processor is running in 32-bit protected mode. So, an image
with a PC BIOS boot contains code here that switches the processor into 32-bit
protected mode. It also does a series of BIOS calls to gather information from the

BIOS, since the protected mode startup program is unable to make any BIOS calls
itself.
• The image is wrapped or encapsulated within another data structure used by an

IPL. To ensure proper alignment of executables on page boundaries, mkifs needs
to know how large the wrapper is at the beginning of the image. In this case, mkifs
creates a zero-filled region for the boot prefix, which an external program (the
image filter) modifies as a post-processing pass over the image.
An example of this is a network boot in which the image needs to be wrapped in
something that was loaded in its entirety into memory on the target (e.g. ELF
object file structures). In this case, an external program makes a copy of the image,
adding information to the front, and possibly the end, of the image. If the wrapper
prefix is a small fixed size, you may wish to include a boot prefix that’s zero-filled,
which an external program can overwrite. This saves you having to make a file
copy of a large image to append to the wrapper. You can always append a wrapper
directly to the end of an image file.
Startup header
This section contains information about the image, which is used by our IPL and
startup programs.
Part of this section is written to by mkifs. Another part is set to zero, and is written to
by the IPL code to pass data (determined at runtime) to startup. The data is in the form
of a set of structures (for more information, see Customizing IPL Programs in
Building Embedded Systems).
If an image isn’t bootable, this section is omitted.
Startup
This section contains the code and data for the startup program. This code must be
executed in RAM. If the image is in ROM/FLASH, our standard IPL code uses
information in the startup header to always copy the startup into RAM and transfer
control to it there.
If an image isn’t bootable, this section is omitted.
Startup trailer
A checksum for use by startup. If an image isn’t bootable, this section is omitted.
Image header
Information on the image filesystem that follows.
Image directory
A series of directory entries for each file in the image filesystem.

Files
The files within the image filesystem. Executables that are executed in place are
aligned on page boundaries. An attempt is made to fill any holes created by this
alignment with small data files that have no alignment needs.
Image trailer
A checksum for the image.
Notes on XIP versus copy

You can apply the code=copy|uip and data=copy|uip attributes to executables in
the image.
Shared objects currently assume code=uip and data=copy. To get the effect of
code=copy, manually copy the shared object to /dev/shmem and set
LD_LIBRARY_PATH as appropriate. To save ROM/Flash space, compress the
shared object in the image filesystem and decompress it into /dev/shmem.
When an executable is run, these attributes determine whether the code or data for that
executable is to be used in place or copied to RAM. An image filesystem may exist in
either RAM or linearly addressable ROM/FLASH. Images in RAM are usually loaded
from a device that isn’t linearly addressable. This includes disk boots, network boots,
and boots from bank-switched ROM/FLASH devices. It also includes any image that’s
been compressed.
For example, a compressed image may reside in linearly addressable flash, but it can’t
be used until it’s decompressed into RAM. The following combinations exist for any
image in RAM:
Code Data Comments

uip uip Run once (default)
uip copy Run multiple
copy uip Run once but wasteful
copy copy Run multiple but wasteful
The default assumes that you want to run both code and data in place. This would be
fine for an executable that has a large amount of static data and that you need to run
only once (e.g. a resource manager or driver that starts when the system boots).
Running data in place modifies the only copy of the data as the program runs, so you
can’t start the program again.

In this case, the file’s sticky bit won’t be set. This identifies the executable to the QNX
Neutrino process manager, which will prevent the program from running more than
once, thus avoiding the possibility of running a program with corrupted static data.
That’s why you have to specify data=copy if you want to run the executable multiple
times.
The two cases listed as “wasteful” fall out of the combinations but they provide no
additional capabilities and waste memory by copying the code unnecessarily. Since
the code is read-only and can’t be modified, it can always be used in place.
If you’re creating an image in ROM/FLASH, the following combinations exist:
Code Data Comments

uip uip Run once
uip copy Run multiple (default)
copy uip Run once
copy copy Run multiple (slow ROM/FLASH)
The data=copy attribute is assumed for an image in ROM/Flash.
The cases where code is copied may seem wasteful (as in the RAM image example)
but it may make sense for systems where the ROM/FLASH is slow — perhaps it has
an 8-bit interface or requires extra wait states for access to it. In that case, you may
wish to copy it to RAM, so that it executes faster.
Examples:
Here’s a very simple buildfile that specifies the operating system, a console driver, and
a shell:
[virtual=x86,bios] .bootstrap = {
startup-bios
PATH=/proc/boot procnto
}
[+script] .script = {
devc-con -n9 &
reopen /dev/con1
[+session] esh &
}
libc.so

[data=copy]
devc-con
esh
[type=link] /usr/lib/ldqnx.so.2=/proc/boot/libc.so
The runtime linker is expected to be found in a file called ldqnx.so.2, but the
runtime linker is currently contained within the libc.so file, so we make a
process-manager symbolic link to it.
For MIPS targets, you need to name this link ldqnx.so.3 instead of ldqnx.so.2.
You can now build an image from the above, like this (assuming that the buildfile is
called simple.bld, and that we want the resultant image to be called simple.ifs):
mkifs simple.bld simple.ifs
Here’s a buildfile with EIDE disk support:

[virtual=x86,bios +compress] .bootstrap = {
startup-bios
PATH=/proc/boot procnto
}
[+script] .script = {
devc-con -e &
devb-eide &
reopen /dev/con1
[+session] PATH=/proc/boot esh &
}
libc.so
libcam.so
cam-disk.so
io-blk.so
fs-qnx4.so
[data=copy]
devc-con
esh
ls
devb-eide
[type=link] /usr/lib/ldqnx.so.2=/proc/boot/libc.so.3
The following example includes an inline /etc/hosts file that’s used to resolve
addresses used at boot time by programs such as fs-nfs3; it also shows how you can
pass environment variables to different commands:
In a real buildfile, you can’t use a backslash (\) to break a long line into shorter pieces,
but we’ve done that here, just to make the buildfile easier to read.
[image=0x1f0000]
[virtual=ppcbe,raw] .bootstrap = {
startup-mtx604-smp -v -Nmtx604-5 -D0x800003f8ˆ0.9600
PATH=/proc/boot:/bin:/usr/bin:/sbin:/usr/sbin \
LD_LIBRARY_PATH=/proc/boot:/lib:/usr/lib:/lib/dll \
procnto-600-smp -v
}
[+script] startup-script = {
# To save memory, make everyone use the libc in the boot
# image! For speed (fewer symbolic lookups), we point to

# libc.so.3 instead of libc.so.
procmgr_symlink ../../proc/boot/libc.so.3 /usr/lib/ldqnx.so.2
pci-raven &
waitfor /dev/pci
io-pkt-v4 -dtulip irq=2,media=9,vid=0x1011,did=0x9 -ptcpip &

if_up -p en0
ifconfig en0 mtx604-5 up
if_up en0
fs-nfs3 -ru ra:/my_system /my_system &

waitfor /my_system/target/qnx6/ppcbe/usr/sbin/slogger 360
# setup environment variables

TZ=est05edt04
procmgr_symlink /my_system/target/qnx6/ppcbe/bin /bin

procmgr_symlink /my_system/target/qnx6/ppcbe/lib /lib
procmgr_symlink /my_system/target/qnx6/ppcbe/sbin /sbin
procmgr_symlink /my_system/target/qnx6/ppcbe/usr/bin /usr/bin
procmgr_symlink /my_system/target/qnx6/ppcbe/usr/sbin /usr/sbin
procmgr_symlink /my_system/target/qnx6/ppcbe/usr/lib /usr/lib
procmgr_symlink /my_system/target/qnx6/etc /etc
slogger &
waitfor /dev/slog
devc-ser8250 -e -c1846200 -b 9600 0x800003f8,104 0x800002f8,103 &
waitfor /dev/ser1
pipe &
waitfor /dev/pipe
devc-pty &
waitfor /dev/ptyp0
mqueue &
inetd &
tinit
}
[type=link] /tmp = /dev/shmem

[type=link] /dev/con1 = /dev/ser1
# Data files are created in the named directory

/etc/hosts = {
127.0.0.1 localhost
192.168.1.1 ra
192.168.1.111 mtx604-5
}
# Include the current libc.so. It will be created as a real

# file using its internal SONAME, with libc.so being a
# symlink to it. The symlink will point to the last libc.so.*,
# so if an earlier libc is needed (e.g. libc.so.2), add it
# before libc.so.
libc.so.2
libc.so
devn-tulip.so
libsocket.so
[data=uip]
pci-raven
io-pkt-v4
[data=copy]
if_up
ifconfig
fs-nfs3
For more examples, see ${QNX_TARGET}/${PROCESSOR}/build.

PROCESSOR Specifies the target CPU. If not set, the default is the same as the
CPU of the host system (e.g. x86).
MKIFS_PATH Specifies a colon-separated list of directories to search for host

files that to be included in the image. The default value consists
of:
1 The current working directory, if the filename contains a
slash (/) but doesn’t start with a slash.
2 ${QNX_TARGET}/${PROCESSOR}/sbin
3 ${QNX_TARGET}/${PROCESSOR}/usr/sbin
4 ${QNX_TARGET}/${PROCESSOR}/boot/sys
5 ${QNX_TARGET}/${PROCESSOR}/bin
6 ${QNX_TARGET}/${PROCESSOR}/usr/bin
7 ${QNX_TARGET}/${PROCESSOR}/lib
8 ${QNX_TARGET}/${PROCESSOR}/lib/dll
9 ${QNX_TARGET}/${PROCESSOR}/usr/lib
10 ${QNX_TARGET}/${PROCESSOR}/usr/photon/bin
Exit status:
See also:
dumpifs, gcc
Making an OS Image chapter and the Sample Buildfiles appendix of Building
Embedded Systems
Making Multiple Images technote

mkimage © 2010, QNX Software Systems GmbH & Co. KG.
Build a socket image from individual files (QNX)
Syntax:
mkimage [ -b blocksize ] -o outputfile file...
Runs on:
Options:
-b blocksize The blocksize used when padding files. The default is 64K.
-o outputfile The name of the output file.
Description:
The mkimage utility builds a socket image from individual files. The command line is
parsed, and the bootable image file(s) are placed first in the resultant output file,
followed by embedded filesystem files, then any other files on the command line.
All files are padded up to the block size specified on the command line ( padding is
done with 0xFF, the default erased state of flash). If no blocksize is specified, the
default is 64K.

© 2010, QNX Software Systems GmbH & Co. KG. mkkbd
Generate a binary keyboard table from a textual keyboard definition
Syntax:
mkkbd [-f file] [-h dir] [-i dir] [-v[v]...] source_file
Runs on:
Targets:
x86
Options:
-f file The name of the output file. The default is the name of the source_file
but with the extension .kbd instead of .kdef.
-h dir Directory in which to find .h header files (e.g. sys/usbcodes.h,

photon/PkKeyDef.h). The default is /usr/include/.
-i dir Directory in which to find .inc mapping files (e.g. common.inc).

The default is the source_file directory.
-v[v]... Increment verbosity. The default is zero verbosity.
source_file Make keyboard tables for the keyboard names that match the specified
pattern. Source files have the extension .kdef.
Description:
The mkkbd utility compiles a text file containing keyboard definitions and is capable
of creating a binary keyboard table file from each definition file. The resulting binary
file is used in devi-hid.
You need to use mkkbd only if you create or modify a keyboard definition source file.
The compiled output file is created in the current directory or according to the -f
option. For a sample keyboard definition file, see
/usr/photon/keyboard/sample.kdef.
Examples:
Create a German keyboard table (german.kbd) from the keyboard definition file
called german.kdef:
mkkbd german.kdef

mkkbd © 2010, QNX Software Systems GmbH & Co. KG.
Files:
mkkbd The mkkbd command is normally to be found in
/usr/photon/bin.
sample.kdef Sample textual keyboard definition file normally found in

/usr/photon/keyboard/
Exit status:
0 Success.
See also:
devi-hid, inputtrap
“International keyboards” in the Using the Command Line chapter of the Neutrino
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. mkqnx6fs
Format a Power-Safe filesystem (QNX Neutrino)
You must be logged in as root to run this utility.
Syntax:
mkqnx6fs [-Bq] [-b blocksize] [-e endian] [-g groups]
[-i inodes] [-n blocks] [-O options] [-o options]
[-r percent] [-T type] [-u uuid] host
Runs on:
Neutrino
Options:
-B Rewrite only the boot loader; don’t touch anything in the filesystem
(in particular don’t reformat it). You would use this to upgrade to
new boot loader code.
-b blocksize Set the logical blocksize of the filesystem. Valid values are 512,
1024, 2048, or 4096; the default is 1024. Varying the blocksize can
control various types of fragmentation as well as determine the
maximum file size supported.
-e endian Set the endian layout of the on-disk filesystem. Valid values are big
or little; by default the filesystem uses the native endian-ness of
the CPU.
-g groups Set the number of allocation groups to subdivide the filesystem; by

default a value (from 1 to 16) is selected based on filesystem size. An
allocation group is a logical concept, not a physical segregation.
-i inodes Set the maximum number of inodes in the filesystem. Each unique
file or directory requires an inode.
-n blocks Set the number of logical blocks in the filesystem. This is the total
size of the filesystem, from which space is first allocated to the
system bitmap and inodes files (so the number of user-accessible
blocks will be slightly less than the specified value).
By default, mkqnx6fs makes the filesystem fully occupy the
specified host (e.g. it determines the number of blocks from the size
of the disk partition).
-O options (“Oh”) Set(+) or unset(-) boot options:

• quiet — stop the boot loader from doing any output, disable the
boot image selection menu, and silently boot the default image.
• cls — clear the screen first (in case the BIOS didn’t do it earlier,
and there isn’t enough room for the menu).

mkqnx6fs © 2010, QNX Software Systems GmbH & Co. KG.
The default is -O-quiet,-cls.

You can use this option with -B to just update the loader and options.
-o options Set(+) or unset(-) filesystem options:
• lfncksum — enable a cksum algorithm on long filenames
(longer than 27 characters), which greatly improves their lookup
performance.
The default is -o+lfncksum.
CAUTION: This default is incompatible with the 6.4.0 version of the Power-Safe
! filesystem. If you wish to format a filesystem that can be mounted read-write by 6.4.0,
you must specify -o-lfncksum; otherwise it will allow only read-only mounting.
-q Operate quietly; don’t prompt for confirmation and don’t display the
resulting configuration of the new filesystem. Without this option,
mkqnx6fs will confirm that you meant to format if the host is a
block-special device or is currently mounted.
-r percent Set the percentage of the filesystem to reserve to prevent it from
becoming completely full. In general, filesystem performace
degrades when the disk is nearly full; this option just makes ENOSPC
happen prematurely to stop this. The default is 3%.
-T type Set the expected usage type of the filesystem; valid values are
desktop, runtime, and media. This type is used to pick the
appropriate blocksize, number of allocation groups, and number of
inodes. It’s a hint that’s intended to replace explicit -b, -g, -i, and
-r values.
-u uuid Specify a 128-bit UUID for the filesystem, in the UUID “8-4-4-4-12”
format. If you don’t specify a UUID, mkqnx6fs generates a random,
time-based (version 4 UUID) value.
host The host of the new filesystem. You can specify this as a
block-special device or partition (e.g. /dev/hd0t76), as a regular
file, or as the root directory of a mounted fs-qnx6 filesystem (which
will be resolved to the real host device).
Description:
The mkqnx6fs utility creates a fresh fs-qnx6 filesystem on the specified host
(typically a hard disk partition, although you can create an image inside a regular file).
The integer fields of the filesystem are maintained as either all little-endian or all
big-endian, as dictated by the -e option. Thus no CPU architecture pays a
byte-swapping penalty for local disks. The filesystem detects the endian-ness and
swaps if necessary, so you can move a disk across platforms (with a slight penalty in
performance).

© 2010, QNX Software Systems GmbH & Co. KG. mkqnx6fs

filesystems:

a Read-only.
Examples:
# mkqnx6fs /dev/hd0t76
All files on /dev/hd0t76 will be lost!
Confirm filesystem re-format (y) or (n): y
Format fs-qnx6: 8040524 blocks, 62816 inodes, 8 groups
Exit status:
0 The filesystem was formatted successfully.
1 An error occurred (a descriptive message is written to stderr).
See also:
chkqnx6fs, devb-*, dinit, fs-qnx6.so, mkdosfs
“Power-Safe filesystem” in the Filesystems chapter of the System Architecture guide
“Power-Safe filesystem” in the Filesystems chapter of the Neutrino User’s Guide

mkrec © 2010, QNX Software Systems GmbH & Co. KG.
Convert a binary image into ROM format (QNX)
Syntax:
mkrec [option | imagefilename] ...
Runs on:
Options:
-a align[K|M|G] Force the next file to be aligned on an align-byte boundary (the
default is 1 byte).
-f format Output format:

• binary or b — raw binary file.
• srec or s — Motorola S records.
• intel or i — Intel hex records.
• full or f — pad the file to the size specified by the -s
option (implies binary format).
The default is srec. When using binary, the file’s offset is
printed to stderr.
-l reclen (“el”) Length of data bytes per line (the default is 32).
-o offset The offset, in hexadecimal (the default is 0).
-r Suppress the reset vector record.
-s romsize[K|M|G] Size of ROM (the default is 4G). The case of the suffixes doesn’t
matter.
Description:
The mkrec utility converts a binary image into either Motorola S records or Intel hex
records, which are suitable input for most Flash/EPROM programmers. Most ICEs
also expect these formats. The format defaults to Motorola S records but may be
changed using the -f format option. Note that the Intel format is limited to 1M offsets.
By default, mkrec assumes the image contains code that is the initial program loader
(IPL), which is connected to the power-on reset vector of the processor. The mkrec
utility locates the image such that it’s placed in the address space where it will end at
the reset vector. A record is then output for the reset vector, which will do a 16-bit
relative jmp to the start of the image.
The reset vector on an Intel (e.g. 486) processor is located at linear address
0xFFFFFFF0 (16 bytes below 4 Gigabytes). The offsets used for the records by
default address this area. It’s as though you had a 4-Gigabyte ROM and needed to load

© 2010, QNX Software Systems GmbH & Co. KG. mkrec
code into the top of it. This is what most ICEs expect. If you’re sending your output to
a small Flash/EPROM programmer, it may wish the offsets to be relocated to the top
of the the Flash/EPROM alone. You can do this by using the -s size option.
If the -r option is set, it indicates that the image shouldn’t be considered a power-on
IPL. The record offsets for the image start at zero; a jmp isn’t be programmed at the
top of the device. You can use the -o option to change the record offset. Note that you
can use the -o option only if you use -r.
For compatibility with most devices that accept these records, each record is limited to
a maximum of 32 bytes. You can use the -l option to increase this limit to a maximum
of 255 bytes. Larger records have less overhead and result in slightly faster downloads.
Examples:
The following converts the binary image explr2 into Motorola S records. The offset
used in the records starts the image such that it ends at the reset vector 0xFFFFFFF0.
A 16-bit relative jmp is programmed at 0xFFFFFFF0 to jmp to the start of the image.
mkrec explr2
The following converts the binary image ipl into Intel hex records. The offset used in
the records starts the image such that it ends at the reset vector in the 256K ROM
(0x3FFF0). A 16-bit relative jmp is programmed at 0x3FFF0 to jmp to the start of the
image.
mkrec -f i -s 256k ipl
The following converts the binary image notipl into Motorola S records. The offset
used in the records starts at 0; a reset vector jmp isn’t output.
mkrec -r notipl
See also:
mkefs, mkifs

mksbp © 2010, QNX Software Systems GmbH & Co. KG.
Build a QNX System Builder project
Syntax:
mksbp project_path
mksbp workspace project_path
Runs on:
Options:
project_path The full path to the System Builder project that you want to build.
Description:
The mksbp utility builds the specified QNX System Builder project, which you must
have created in the IDE. The purpose of this utility is to build a System Builder project
from the command line or a script, for example as a part of a nightly build.
If you use the first variant of the command (with one argument), you must have
physically created the project in some IDE workspace; if the argument is
some_path\myproject, mksbp interprets some_path as the workspace location, and
myproject as a subdirectory in this workspace where the project is located.
You can optionally create any project that’s just logically linked to a workspace
(through metadata redirection — see the IDE’s project-creation wizard). The
two-argument syntax is applicable in this case: the first argument targets the
workspace location, and the second one holds the project name (just the name, not a
full path; the IDE will find its real location).
This utility uses the QNX_HOST environment variable to find the target runtime
binaries. Ensure that it’s set up (see qconfig or QWinCfg) before running this
program.
Generated output is placed in the project’s Images directory, mimicking the behavior
within the QNX Momentics IDE exactly.
See also:
qconfig, QWinCfg
IDE User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. /etc/moduli
System moduli file for sshd
Name:
/etc/moduli
Description:
The /etc/moduli file contains the system-wide Diffie-Hellman prime moduli for
sshd. For more information, see /etc/moduli in the NetBSD documentation.
See also:
scp, sftp, sftp-server, ssh, ssh-add, ssh-agent, ssh-keygen,
ssh-keyscan, ssh-keysign, ˜/.ssh/ssh_config, /etc/ssh/ssh_config,
sshd, /etc/ssh/sshd_config in the NetBSD documentation

more © 2010, QNX Software Systems GmbH & Co. KG.
Display files on a page-by-page basis (POSIX)
Syntax:
more [-ceisu] [-n number] [-p pattern]
[-/ pattern] [-t tag] [-x tabstop] [file...]
Runs on:
Neutrino
Options:
-/ pattern Same as -p pattern.
-c For each full screen of text that’s displayed, clear the screen from the
first line and display the next full screen of text.
-e Stop after displaying the last line in the file. If the next command that
displays text causes more to reach end-of-file again, more exits. If the
file is shorter than a single screen, more exits at end-of-file regardless.
-i Ignore case during searches. Uppercase and lowercase letters are

considered identical.
-n number Specify the number of lines that constitute a full screen of text. The
number argument is a positive decimal integer. The -n option
overrides any values obtained from the environment.
-p pattern Search for a line that matches pattern. The current position is set to the
first matched line. If no match is found, the first line in the file is the
current position.
-s Replace consecutive empty lines with a single empty line.
-t tag Display the file containing the tag named by the tag argument. Note
that for this to work, the file tags must reside in the current directory.
-u Always display backspaces as control characters (e.g. as the

two-character sequence ˆH) and leave carriage-return/linefeed (\r\n)
sequences alone.
By default, more makes special use of backspaces and
carriage-return/linefeed (\r\n) sequences. If a backspace appears next
to an underscore character, the character is displayed as underlined
text, provided the terminal type supports underlined text. If a
backspace appears between two identical characters, the first character
is displayed as bold text, provided the terminal type supports bold text
display.
-x tabstop Set tabs at the positions specified by tabstop. The default is four
spaces, unless the POSIX_STRICT environment variable is defined,
in which case it’s eight spaces.

© 2010, QNX Software Systems GmbH & Co. KG. more
file A pathname of an input file. If no file operands are specified, more

uses the standard input. If a file operand is the dash character (-), the
standard input is read at that point of the sequence.
Description:
The more utility lets you view text files one screenfull at a time. The utility
determines the number of lines that make a full screen by looking in the terminal
database. However, you can use the LINES environment variable to override the value
found in the database, and the -n option to override the LINES variable.
If the standard output isn’t a terminal device, the number of lines that make up a full
screen of text is considered to be infinite. In a pipeline, all input files are copied to the
standard output in their entirety. On terminals, more displays text one screen at a time.
The more command can be very useful when another utility prints more information
to the standard output than can be displayed on a single screen. By piping the output to
more, you can scroll through the displayed output at leisure. For example:
ls | more
pipes the output from the ls command to more, allowing you to scroll through the
output.
The more command is a link to less, which behaves according to the command name
it was invoked as.
EDITOR The editor to use.
LINES A decimal integer value to be used as the number of lines in a
screenfull.
MORE A string containing options described in the Options section of

this utility, preceded by hyphens and separated by blank
characters as on the command line. Command-line options
override those specified in the MORE variable. The MORE
variable takes precedence over the TERM and LINES
variables.
TERM The name of the terminal type.

POSIX_STRICT Interpret options according to POSIX specifications.
Exit status:

more © 2010, QNX Software Systems GmbH & Co. KG.
Mark Nudelman
See also:
cat, clear, ctags, head, less, tail

© 2010, QNX Software Systems GmbH & Co. KG. mount
Mount a block special device or remote filesystem
Syntax:
mount [-abwruv] [-t type [-o options] [special] mountpoint]
mount [-abwruv] [-T type [-o options] special [mountpoint]]
mount [-abwruv] -e [-t|T type] [-o options] special
[mountpoint]
mount
Runs on:
Neutrino
Options:
-a Mount all the devices listed in the /etc/fstab file (or autodetected
later on). If you also specify a type, mount only those entries. This
option is ignored if you specify special or mountpoint.
-b Prevent the lookup of the fstab file.
-e Enumerate the children of the special device.
-o options Options specific to the server doing the mounting. These options
include:
• before — Mount the filesystem so that it’s resolved before any
other filesystems mounted at the same pathname (in other words,
it’s placed in front of any existing mount). When you access a file,
the system looks on this filesystem first.
• after — Mount the filesystem so that it’s resolved after any other
placed behind any existing mount). When you access a file, the
system looks on this filesystem last, and only if the file wasn’t
found on any other filesystems.
For more information, see “Ordering mountpoints” in the Process
Manager chapter of the System Architecture guide.
-r Mount the device as read-only.
-T type . . . special [mountpoint]

The special device is a string that may specify a real device or may be
just a hint for the server. If mountpoint isn’t specified, the server will
automatically create an appropriate mountpoint.
-t type . . . [special] mountpoint
If the optional special string is given, the mount request goes to the
server which created, or is responsible for, the special device. If this
special device does not exist, the server interprets the string as a hint.
If special is not given, it is passed as NULL.

mount © 2010, QNX Software Systems GmbH & Co. KG.
-u Mount for update (remount).

-v Increase the verbosity.
-w Mount the device as read/write. This is the default (if the physical
media permit).
mountpoint Where the device is to be mounted on your system.

cd fs-cd.so
cifs fs-cifs
dos fs-dos.so
etfs Embedded Transaction Filesystem (e.g. fs-etfs-ram)
ext2 fs-ext2.so
io-audio io-audio
io-pkt io-pkt-v4, io-pkt-v4-hc, io-pkt-v6-hc
io-usb io-usb
mac fs-mac.so
nt fs-nt.so
qnx4 fs-qnx4.so
qnx6 fs-qnx6.so
udf fs-udf.so
If you don’t specify the filesystem, mount tries to determine which to

use. If it can’t figure out which to use, it uses qnx4.
Specify io-pkt for type no matter which of io-pkt-v4, io-pkt-v4-hc, or

io-pkt-v6-hc you’re mounting.
Description:
Without options, mount displays the current mountpoints. With options set, this utility
mounts the block special device or remote filesystem, special, as the specified
mountpoint. To mount a real special device, use the -t option; to specify a
special-device string (which isn’t necessarily a real device), use -T.

© 2010, QNX Software Systems GmbH & Co. KG. mount
Some servers may not support all the mount options, especially with respect to
remounting and enumerating.
The mount utility supports the /etc/fstab file.
Examples:
Mount a QNX 4 filesystem on a hard drive as /mnt/fs:
mount -t qnx4 /dev/hd0t77 /mnt/fs
Mount a device driver for io-pkt*. In this example, devn-ne2000.so is the name
of the shared object that io-pkt* needs to load for the driver, not the name of a real
device:
mount -T io-pkt devn-ne2000.so
If you want to pass options to the driver, use the -o option before the name of the
shared object:
mount -T io-pkt -o mac=12345678 devn-ne2000.so
Enumerate the hard disk partition table:
mount -e /dev/hd0
This will re-read the disk partition table for /dev/hd0, and create, update or delete
/dev/hd0tXX block-special files for each partition. This is used in the following two
scenarios:
• when the disk driver is used without any automatic enumeration (blk
auto=none), or
• when the partition table has been modified (for example, with fdisk).
Mount a CIFS filesystem (fs-cifs must be running first):
mount -T cifs -o abc,efg //node123:1.1.1.1:/C /ctest
Where your name is abc, your password is efg, your CIFS server is node123 with an
IP address of 1.1.1.1, the share you want to mount is /C, and the mountpoint you
want to use is /ctest.
Mount an NFS 2 client filesystem (fs-nfs2 must be running first):
mount -T nfs 10.1.0.22:/home /mnt/home
Mount an NFS 3 client filesystem (fs-nfs3 must be running first):
mount -T nfs -o ver3 server_node:/qnx_bin /bin
Mount the Qnet network protocol:
mount -T io-pkt /lib/dll/lsm-qnet.so

mount © 2010, QNX Software Systems GmbH & Co. KG.
Display the current mountpoints:
mount
Mount the shared object that supports Enhanced Host Controller Interface (EHCI)
USB controllers:
mount -T io-usb devu-ehci.so /dev/io-usb/io-usb
Remount the filesystem that’s currently mounted at / as read-only:
mount -ur /
Remount the filesystem that’s currently mounted at / as read-write:
mount -uw /
See also:
devb-*, fdisk, fs-cd.so, fs-cifs, fs-dos.so, fs-etfs-ram, fs-ext2.so,
fs-mac.so, fs-nfs2, fs-nfs3, fs-nt.so, fs-qnx4.so, fs-qnx6.so,
fs-udf.so, /etc/fstab, io-audio, io-blk.so, io-pkt*, io-usb, umount
mount(), mount_parse_generic_args() in the QNX Neutrino Library Reference
Working with Filesystems chapter, and “Filesystems and block I/O (devb-*) drivers”
in the Fine-Tuning Your System chapter of the QNX Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. mq
Manage message queues (QNX Neutrino)
Syntax:
mq [options] &
Runs on:
Neutrino
Options:
-m num_msgs Set the default for the maximum number of messages, for use if the
mq_attr argument to mq_open() is NULL. The default is 64
messages.
-N path Set the pathname of the directory for message queues. The default
is /dev/mq.
-s size Set the default message size, for use if the mq_attr argument to
mq_open() is NULL. The default is 256 bytes.
Description:
The mq manager implements POSIX 1003.1b message queues. When you create a
queue, it appears in the pathname space under /dev/mq.
The /dev/mq directory doesn’t appear until you actually create a queue.
You can change this directory to union over the directory exported by the mqueue
server by using the mq -N/dev/mqueue option, but we don’t recommend this,
because it may cause some user-namespace confusion.
This implementation uses the kernel’s asynchronous messaging facility to buffer the
messages within the kernel itself, and eliminates the context-switching overheads of
using an external server (i.e. mqueue) in each message-queue operation, thus greatly
improving the performance of POSIX message queues.
In order to use the mq implementation, you must link your application(s) against the
libmq library. In a manual build, specify the -l mq option; in automatic/recursive
builds, use this setting in your common.mk file:
LIBS += mq
For more information, see the Managing POSIX Message Queues technote.

mq © 2010, QNX Software Systems GmbH & Co. KG.
See also:
mqueue, procnto*
mq_close(), mq_getattr(), mq_notify(), mq_open(), mq_receive(), mq_send(),
mq_setattr(), mq_unlink() in the Neutrino Library Reference
Managing POSIX Message Queues technote

© 2010, QNX Software Systems GmbH & Co. KG. mqueue
Manage message queues (QNX Neutrino)
Syntax:
mqueue &
Runs on:
Neutrino
Options:
There are no options for the mqueue manager.
Description:
The mqueue manager implements POSIX 1003.1b message queues. When you create
a queue, it appears in the pathname space under /dev/mqueue.
The /dev/mqueue directory doesn’t appear until you actually create a queue.
The traditional POSIX message queue manager is a resource manager that uses
messages to communicate with its clients. You can access it locally or remotely,
allowing for network-wide message queues. On a self-hosted Neutrino system, the
default sysinit script starts mqueue; for more information, see the Controlling How
Neutrino Starts chapter of the Neutrino User’s Guide.
Starting with release 6.3.0, procnto manages named semaphores, which mqueue
used to do (mqueue still manages named semaphores if it detects that procnto isn’t
doing so).
For more information, see the Managing POSIX Message Queues technote.
See also:
mq, procnto*
mq_close(), mq_getattr(), mq_notify(), mq_open(), mq_receive(), mq_send(),
mq_setattr(), mq_unlink() in the Neutrino Library Reference
Managing POSIX Message Queues technote

mrouted © 2010, QNX Software Systems GmbH & Co. KG.
IP multicast routing daemon
Syntax:
mrouted [-c config_file] [-d [debug_level]] [-p]
Runs on:
Neutrino
Options:
-c config_file] Specify a configuration file (default is /etc/mrouted.conf).
-d [debug_level] Specify debug level (default is 0).
-p Start mrouted in a non-pruning mode.
Description:
The mrouted utility is an implementation of the Distance-Vector Multicast Routing
Protocol (DVMRP) (RFC 1075 specifies an earlier version of this protocol). The
utility maintains topological knowledge via a distance-vector routing protocol (like
RIP, described in RFC 1058), where it implements a multicast datagram forwarding
algorithm called Reverse Path Multicasting.
The mrouted utility forwards a multicast datagram along a shortest (reverse) path tree
rooted at the subnet on which the datagram originates. The multicast delivery tree may
be thought of as a broadcast delivery tree that has been pruned back so that it doesn’t
extend beyond those subnetworks that have members of the destination group. Hence,
datagrams aren’t forwarded along those branches which have no listeners of the
multicast group. The IP time-to-live of a multicast datagram can be used to limit the
range of multicast datagrams.
In order to support multicasting among subnets that are separated by (unicast) routers
that don’t support IP multicasting, mrouted includes support for “tunnels”, which are
virtual point-to-point links between pairs of mrouteds located anywhere in an
internet. IP multicast packets are encapsulated for transmission through tunnels, so
that they look like normal unicast datagrams to intervening routers and subnets. The
encapsulation is added on entry to a tunnel, and stripped off on exit from a tunnel. By
default, the packets are encapsulated using the IP-in-IP protocol (IP protocol number
4). Older versions of mrouted tunnel using IP source routing, which puts a heavy
load on some types of routers.
This version doesn’t support IP source route tunneling.
The tunneling mechanism allows mrouted to establish a virtual internet, for the
purpose of multicasting only, which is independent of the physical internet, and which
may span multiple Autonomous Systems. This capability is intended for experimental
support of internet multicasting only, pending widespread support for multicast

© 2010, QNX Software Systems GmbH & Co. KG. mrouted
routing by the regular (unicast) routers. The mrouted utility suffers from the
well-known scaling problems of any distance-vector routing protocol, and doesn’t
(yet) support hierarchical multicast routing.
The mrouted utility handles multicast routing only; there may or may not be unicast
routing software running on the same machine as mrouted. With the use of tunnels, it
isn’t necessary for mrouted to have access to more than one physical subnet in order
to perform multicast forwarding.
Invocation
If -d isn’t specified, or if the debug level is specified as 0, mrouted detaches from the
invoking terminal. Otherwise, it remains attached to the invoking terminal and
responsive to signals from that terminal. If -d is specified with no argument, the
debug level defaults to 2. Regardless of the debug level, mrouted always writes
warning and error messages to the system log daemon. Nonzero debug levels have the
following effects:
Level 1 All messages that are sent to the system log are also printed to stderr. In
order to capture the log messages, you need to have syslogd running.
Level 2 All level 1 messages plus notifications of significant events are printed to
stderr.
Level 3 All level 2 messages plus notifications of all packet arrivals and
departures are printed to stderr.
At startup, mrouted writes its pid to the file /var/run/mrouted.pid.
Configuring mrouted
The mrouted utility automatically configures itself to forward on all
multicast-capable interfaces, that is, interfaces that have the IFF_MULTICAST flag set
(excluding the loopback “interface”), and it finds other mrouteds directly reachable
via those interfaces. To override the default configuration, or to add tunnel links to
other mrouteds, configuration commands may be placed in /etc/mrouted.conf
(or an alternative file, specified by the -c option). There are five types of configuration
commands:
phyint local-addr [disable] [metric m]

[threshold t] [rate_limit b]
[boundary (boundary-name|scoped-addr/mask-len)]
[altnet network/mask-len]
This command can be used to disable multicast routing on the
physical interface identified by local IP address local-addr, or to
associate a nondefault metric or threshold with the specified
physical interface. The local IP address local-addr may be
replaced by the interface name (e.g le0). If a phyint is attached

to multiple IP subnets, describe each additional subnet with the

altnet keyword. The phyint configuration commands must
precede tunnel commands.
tunnel local-addr remote-addr [metric m]
[threshold t] [rate_limit b]
[boundary (boundary-name|scoped-addr/mask-len)]
This command can be used to establish a tunnel link between
local IP address local-addr and remote IP address remote-addr,
and to associate a nondefault metric or threshold with that
tunnel. The local IP address local-addr may be replaced by the
interface name (e.g. le0). The remote IP address remote-addr
may be replaced by a hostname, if and only if the hostname has a
single IP address associated with it. The tunnel must be set up
in the mrouted.conf files of both routers before it can be used.
cache_lifetime ct
The time (in seconds) that a cached multicast route stays in
kernel before timing out (the default is 300). The value of this
entry should lie between 300 (5 min) and 86400 (1 day).
pruning off/on Allow mrouted to act as a non-pruning router (default mode is

pruning-enabled). It’s also possible to start mrouted in a
non-pruning mode using the -p option on the command line. It’s
expected that a router would be configured in this manner for test
purposes only.
name boundary-name scoped-addr/mask-len
You may assign names to boundaries with this keyword, to make
configuration easier. The boundary option on phyint or
tunnel commands can accept either a name or a boundary.
The file format is free-form; whitespace (including newlines) isn’t significant.
Configuration command options
The boundary and altnet options may be specified as many times as necessary.
metric The “cost” associated with sending a datagram on the given

interface or tunnel; it may be used to influence the choice of routes
(default is 1). Metrics should be kept as small as possible, because
mrouted cannot route along paths with a sum of metrics greater
than 31.
threshold The minimum IP time-to-live required for a multicast datagram to

be forwarded to the given interface or tunnel (default is 1). It’s
used to control the scope of multicast datagrams. (The TTL of
forwarded packets is only compared to the threshold, it isn’t

decremented by the threshold.) Every multicast router decrements

the TTL by 1.
In general, all mrouteds connected to a particular subnet or tunnel
should use the same metric and threshold for that subnet or
tunnel.
rate_limit Allows the network administrator to specify a certain bandwidth in

Kbits/second that would be allocated to multicast traffic. It defaults
to 500Kbps on tunnels, and 0 (unlimited) on physical interfaces.
boundary Allows an interface to be configured as an administrative boundary

for the specified scoped address. Packets belonging to this address
won’t be forwarded on a scoped interface. The boundary option
accepts either a name or a boundary spec.
The mrouted utility won’t initiate execution if it has fewer than two enabled virtual
interfaces (vif s), where a vif is either a physical multicast-capable interface or a
tunnel. It’ll log a warning if all of its vif s are tunnels; such an mrouted
configuration would be better replaced by more direct tunnels (i.e. eliminate the
middle man).
Signals
The mrouted utility responds to the following signals:
SIGHUP Restarts mrouted. The configuration file is reread every time this
signal is evoked.
SIGINT Terminates execution gracefully (i.e. by sending goodbye messages to

all neighboring routers).
SIGTERM Same as SIGINT.
SIGUSR1 Dumps the internal routing tables to /var/tmp/mrouted.dump.
SIGUSR2 Dumps the internal cache tables to /var/tmp/mrouted.cache.
SIGQUIT Dumps the internal routing tables to stderr (only if mrouted was
invoked with a nonzero debug level).
For convenience in sending signals, on startup, mrouted writes its pid to

/var/run/mrouted.pid.
Examples:
This is an example configuration for a mythical multicast router at a big school.

# mrouted.conf example
#
# Name our boundaries to make it easier.
name LOCAL 239.255.0.0/16

name EE 239.254.0.0/16
# le1 is our gateway to compsci, don’t forward our

# local groups to them.
phyint le1 boundary EE
# le2 is our interface on the classroom net, it has four

# different length subnets on it. Note that you can use
# either an ip address or an interface name.
phyint 172.16.12.38 boundary EE altnet 172.16.15.0/26

altnet 172.16.15.128/26 altnet 172.16.48.0/24
# atm0 is our ATM interface, which doesn’t properly

# support multicasting.
phyint atm0 disable
# This is an internal tunnel to another EE subnet

# Remove the default tunnel rate limit, since this
# tunnel is over Ethernets
tunnel 192.168.5.4 192.168.55.101 metric 1 threshold 1

rate_limit 0
# This is our tunnel to the outside world.

# Careful with those boundaries, Eugene.
tunnel 192.168.5.4 10.11.12.13 metric 1 threshold 32

boundary LOCAL boundary EE
Routing tables
The routing tables look like this:
Virtual Interface Table

Vif Local-Address Metric Thresh Flags
0 36.2.0.8 subnet: 36.2 1 1 querier
groups: 224.0.2.1
224.0.0.4
pkts in: 3456
pkts out: 2322323
1 36.11.0.1 subnet: 36.11 1 1 querier

groups: 224.0.2.1
224.0.1.0
224.0.0.4
pkts in: 345
pkts out: 3456
2 36.2.0.8 tunnel: 36.8.0.77 3 1

peers: 36.8.0.77 (2.2)
boundaries: 239.0.1
: 239.1.2

pkts in: 34545433

pkts out: 234342
3 36.2.0.8 tunnel: 36.6.8.23 3 16
Multicast Routing Table (1136 entries)

Origin-Subnet From-Gateway Metric Tmr In-Vif Out-Vifs
36.2 1 45 0 1* 2 3*
36.8 36.8.0.77 4 15 2 0* 1* 3*
36.11 1 20 1 0* 2 3*
.
.
.
In the above example, there are four Vif s connecting to two subnets and two tunnels.
The vif 3 tunnel isn’t in use (no peer address). The vif 0 and vif 1 subnets have some
groups present; tunnels never have any groups. This instance of mrouted is the one
responsible for sending periodic group membership queries on the vif 0 and vif 1
subnets, as indicated by the “querier” flags. The list of boundaries indicate the scoped
addresses on that interface. A count of the number of incoming and outgoing packets
is also shown at each interface.
Associated with each subnet from which a multicast datagram can originate is the
address of the previous hop router (unless the subnet is directly-connected), the metric
of the path back to the origin, the amount of time since we last received an update for
this subnet, the incoming vif for multicasts from that origin, and a list of outgoing vif s.
A * means that the outgoing vif is connected to a leaf of the broadcast tree rooted at
the origin, and a multicast datagram from that origin is forwarded on that outgoing vif
only if there are members of the destination group on that leaf.
The mrouted utility also maintains a copy of the kernel forwarding cache table.
Entries are created and deleted by mrouted.
The cache tables look like this:
Multicast Routing Cache Table (147 entries)
Origin Mcast-group CTmr Age Ptmr IVif Forwvifs
13.2.116/22 224.2.127.255 3m 2m - 0 1
>13.2.116.19
>13.2.116.196
138.96.48/21 224.2.127.255 5m 2m - 0 1
>138.96.48.108
128.9.160/20 224.2.127.255 3m 2m - 0 1
>128.9.160.45
198.106.194/24 224.2.135.190 9m 28s 9m 0P
>198.106.194.22
Each entry is characterized by the origin subnet number and mask and the destination
multicast group.
> A “>” as the first character on an additional line is printed for each
source on the subnet. There can be many sources in one subnet.
Age The time since this cache entry was originally created. Since cache
entries get refreshed if traffic is flowing, routing entries can grow very
old.

CTmr Indicates the lifetime of the entry. The entry is deleted from the cache
table when the timer decrements to zero.
Forwvifs Shows the interfaces along which datagrams belonging to the

source-group are forwarded. A p indicates that no datagrams are being
forwarded along that interface. An unlisted interface is a leaf subnet
with no members of the particular group on that subnet. A b on an
interface indicates that it’s a boundary interface, i.e. traffic won’t be
forwarded on the scoped address on that interface.
Ivif Indicates the incoming vif for multicast packets from that origin. Each
router also keeps a record of the number of prunes received from
neighboring routers for a particular source and group. If there are no
members of a multicast group on any downward link of the multicast
tree for a subnet, a prune message is sent to the upstream router. They’re
indicated by a P after the vif number.
Ptmr The amount of time until the upstream prune times out, or simply a dash
if no prune was sent.
Files:
/etc/mrouted.conf
Default configuration file for mrouted.
/var/run/mrouted.pid
At startup, mrouted writes its pid to this file.
/var/tmp/mrouted.dump
The SIGUSR1 signal causes mrouted to dump the internal routing tables to this
file.
/var/tmp/mrouted.cache
The SIGUSR2 signal causes mrouted to dump the internal cache tables to this
file.
Steve Deering, Ajit Thyagarajan, Bill Fenner.
License:
The mrouted program is COPYRIGHT 1989 by The Board of Trustees of Leland
Stanford Junior University; for licensing information, see the Third Party License
Terms List at http://licensing.qnx.com/third-party-terms/.

See also:
syslogd
Based on RFC 1075, which specifies an earlier version of DVMRP.
DVMRP is described, along with other multicast routing algorithms, in the paper
Multicast Routing in Internet-works and Extended LANs by S. Deering, in the
Proceedings of the ACM SIGCOMM ’88 Conference.

mstrip © 2010, QNX Software Systems GmbH & Co. KG.
Strip Management Information Base (MIB) modules from an RFC
Syntax:
mstrip filename
Runs on:
Neutrino
Options:
filename Name of file to be stripped.
Description:
The mstrip utility is used to strip an RFC to obtain a Management Information Base
(MIB) module. It uses form-feed characters to determine the header and the footer
lines in a document.
Examples:
mstrip RFC1213 > rfc1213.mib
See also:
smic, snmpbulkwalk, snmpd, snmpget, snmpnetstat, snmpset, snmpstatus,
snmptest, snmptranslate, snmptrap, snmptrapd, snmpwalk
/etc/mib.txt file

© 2010, QNX Software Systems GmbH & Co. KG. mv
Move files (POSIX)
Syntax:
mv [-f|-i] [-v|-V] source_file target_file
mv [-f|-i] [-v|-V] source_file... target_dir
Runs on:
Options:
-f Force an overwrite; don’t prompt for confirmation if the destination
path exists. Overwrite even read-only files.
-i Run interactively; write a prompt to the standard error output before

moving any file that would overwrite an existing file. If confirmation is
received, overwrite the existing file. Otherwise, go on to the next file.
-V (QNX Neutrino extension) Be very verbose.
-v (QNX Neutrino extension) Be verbose.
source_file The pathname of a file or directory to be moved.
target_file The new pathname of the file or directory to be moved.
target_dir The pathname of an existing directory that the source file is to move to.
Description:
The mv command has two syntax forms:
mv [-f|-i] [-v|-V] source_file target_file

The mv utility moves source_file to the destination specified by target_file. This
first syntax form is assumed when the final operand you specify doesn’t name an
existing directory.
mv [-f|-i] [-v|-V] source_file... target_dir
The mv utility moves each source_file file to a destination file in the directory
named by target_dir. The destination’s filename under the target directory is the
same as its basename (final path component).
For example:
mv dir/dir/myfile /existingdir
moves dir/dir/myfile to existingdir/myfile.
This second syntax form is assumed when either the destination names an
existing directory, or when more than one source file is specified.

mv © 2010, QNX Software Systems GmbH & Co. KG.
By default, mv overwrites an existing file without warning or confirmation whenever

you have write permission on the file.
The mv utility asks you for confirmation if the following conditions are met:
• you haven’t specified the -f option
• you lack write permission
• the standard input is a terminal
Upon receiving confirmation, mv overwrites the target file. It can do this only if you
own the file or you’re a superuser.
If you want mv to request confirmation before overwriting any file, specify the -i
(interactive) option. If you want mv to overwrite whenever possible without asking for
confirmation, specify the -f (force) option.
As long as the input files specified by each source_file are on the same device as the
target, the source_file operand can be of any file type. If the source and target reside
on different devices, the source_file is copied to the target and then removed. If the
source_file is a directory, this means that any FIFO or character special files under the
original directory aren’t copied. Since the copy isn’t 100% successful, the original
source_file isn’t removed.
Examples:
In the current directory, rename the file orange to banana.
mv orange banana
Exit status:
0 All input files were moved successfully.
Caveats:
If the copying of a directory is prematurely terminated by a signal or error, mv may
leave a partial copy of the directory at the destination. In this case, the directory tree at
source_file isn’t modified.
When the source_file and target_file are on different filesystems (i.e. not on the same
mounted partition), the mv utility spawns the cp utility to copy the file(s), and if the cp
succeeds, spawns the rm utility to remove the originals.

© 2010, QNX Software Systems GmbH & Co. KG. mv
See also:
cp, pax, rm

© 2010, QNX Software Systems GmbH & Co. KG. named
Internet domain name server
Syntax:
named [-4] [-6] [-c config-file] [-d debug-level] [-f] [-g]
[-m flag] [-n num_cpus] [-p port] [-s] [-t directory]
[-u user] [-v] [-x cache-file]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?named++NetBSD-5.0 in the
Description:
The named daemon is a Domain Name System (DNS) server, part of the BIND 9
distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and
1035.
When invoked without arguments, named reads the default configuration file
/etc/named.conf, read any initial data, and listen for queries.
Files:
/etc/named.conf
Default name server configuration file.
/etc/namedb/named.pid
The process ID.
See also:
/etc/named.conf in the NetBSD documentation.
hostname, kill, syslogd
gethostbyname(), signal() in the QNX Neutrino Library Reference
Based on RFC 882, RFC 883, RFC 973, RFC 974, RFC 1033

named-checkconf © 2010, QNX Software Systems GmbH & Co. KG.
Tool for checking the syntax of a named configuration file
Syntax:
named-checkconf [-h] [-v] [-j] [-t directory] {filename}
[-z]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?named-checkconf++NetBSD-5.0 in the
Description:
The named-checkconf utility checks the syntax, but not the semantics, of a named
configuration file. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?named-checkconf++NetBSD-5.0 in the NetBSD
documentation.
See also:
named, /etc/named.conf in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. named-checkzone,
named-compilezone
Tools for converting and checking a zone file
Syntax:
named-checkzone [-d] [-h] [-j] [-q] [-v] [-c class]
[-f format] [-F format] [-i mode]
[-k mode] [-m mode] [-M mode] [-n mode]
[-o filename] [-s style] [-S mode]
[-t directory] [-w directory] [-D] [-W mode]
{zonename} {filename}
named-compilezone [-d] [-j] [-q] [-v] [-c class]

[-C mode] [-f format] [-F format]
[-i mode] [-k mode] [-m mode] [-n mode]
[-o filename] [-s style] [-t directory]
[-w directory] [-D] [-W mode] {zonename}
{filename}
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?named-checkzone++NetBSD-5.0 in the
Description:
The named-checkzone utility checks the syntax and integrity of a zone file. It
performs the same checks as named does when loading a zone.
The named-compilezone utility is similar to named-checkzone, but it always
dumps the zone contents to a specified file in a specified format. Additionally, it
applies stricter check levels by default, since the dump output will be used as an actual
zone file loaded by named.
For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?named-checkzone++NetBSD-5.0 in the NetBSD
documentation.
See also:
named, named-checkconf in the NetBSD documentation

/etc/named.conf © 2010, QNX Software Systems GmbH & Co. KG.
Configuration file for named
Name:
/etc/named.conf
Description:
The /etc/named.conf file is the configuration file for named. For more
information, see http://netbsd.gw.com/cgi-bin/man-cgi?named.conf++NetBSD-5.0 in
See also:
named, /etc/named.conf in the NetBSD documentation.
syslogd
syslogd() in the QNX Neutrino Library Reference
TCP/IP Network Administration
1-56592-010-4)

© 2010, QNX Software Systems GmbH & Co. KG. ndp
Control the IPv6 Neighbor Discovery Protocol
Syntax:
ndp -A wait [-ntl]
ndp -a [-ntl]
ndp -c [-nt]
ndp -d [-nt] hostname
ndp -f [-nt] filename
ndp -H
ndp -I [delete|interface]
ndp -i interface [flags...]
ndp -P
ndp -p
ndp -R
ndp -r
ndp -s [-nt] nodename ether_addr [temp] [proxy]
Runs on:
Neutrino
Options:
-A wait Repeat -a (dump NDP entries) every wait seconds.
-a Dump the existing NDP entries.
-c Erase all NDP entries.
-d hostname Delete the NDP entry for this hostname.
-f filename Parse the file specified by filename.
-H Harmonize consistency between the routing table and the default

router list; install the top entry of the list into the kernel routing table.
-I [delete|interface]
Show or specify the default interface that’s to be used as the default
route when there’s no default router.
Option: Action:
-I Show the current default interface.
-I delete Delete the current interface from the kernel.
-I interface Use this interface as the default.
-i interface [flags...]
View the neighbor discovery (ND) information for this interface. If
flags is specified, set or clear the flag(s) associated with this

ndp © 2010, QNX Software Systems GmbH & Co. KG.
interface. A flag is cleared if it starts with the special character “-”.

Possible flags are:
nud Toggle NUD (Neighbor Unreachability Detection) on the

interface (default is on).
-l Don’t truncate the numeric IPv6 addresses.
-n Don’t try to resolve a numeric address to a hostname.
-P Flush all the entries in the prefix list.
-p Show the prefix list.
-R Flush all the entries in the default router list.
-r Show the default router list.
-s nodename ether_addr [temp] [proxy]

Register a permanent NDP entry for this node (use temp to register a
temporary entry). If you specify proxy, the system acts as a proxy
NDP server that responds to requests for hostname even though the
host address is not its own.
-t Print a timestamp on each entry so that it’s possible to merge the

output with tcpdump. Typically used with -A.
Description:
This utility manipulates the address mapping table used by the Neighbor Discovery
Protocol (NDP).
Exit status:
Nonzero An error occurred.
See also:
arp

© 2010, QNX Software Systems GmbH & Co. KG. netmanager
TCP/IP Configuration Manager
Syntax:
netmanager [-f file] [-p num] [-r [interface]]
[-s] [-w [interface]]
Runs on:
Neutrino
Options:
-f file The name of the configuration file (the default is /etc/net.cfg).
-p num The number of times to poll while waiting for the interface to
become available; netmanager polls every 2 seconds for a default
of 5 times.
-r [interface] Read from the configuration file the information on this interface
(default is all) and apply it.
-s Log to stderr. The default is to log to slogger, the system logger.
-w [interface] Obtain the configuration information on this interface (default is

all) and write it in the configuration file.
Description:
The netmanager process is used to apply the TCP/IP configuration as described in
the configuration file. It’s usually run by phlip, or as part of the boot sequence (e.g.
during device enumeration on systems that use diskboot — see the Controlling How
Neutrino Starts chapter of the Neutrino User’s Guide). You won’t generally run
netmanager directly; you should use the Photon phlip application to generate the
configuration file.
The netmanager is setuid root, so that it can query the interfaces and display any
information. However, it doesn’t apply changes unless the real user is root.
The netmanager uses dhcp.client to support a DHCP configuration.

Instead of using phlip and netmanager to set TCP/IP parameters, you can use
route and ifconfig. You can also run dhcp.client from the command line.

netmanager © 2010, QNX Software Systems GmbH & Co. KG.
Don’t use both ways to configure your system.

When applying a configuration, parameters provided by a DHCP server are used
before manually configured parameters. If you need to override a configuration
parameter that’s supplied by the DHCP server (e.g. gateway), use manual mode.
The netmanager uses the _CS_RESOLVE configuration string instead of

/etc/resolv.conf, and passes options to dhcp.client and pppd.
If there’s no configuration file present, DHCP is used on unconfigured interfaces.
The netmanager can set or get TCP/IP configuration parameters related to:
• Interface Parameters:
- manual or dynamic (DHCP)
- ipaddress
- netmask
- aliases
• General Parameters:
- routing table
- domain
- nameservers
- search suffixes
Examples:
Write the information for all interfaces in a file:
netmanager -w all -f filename
If no filename is provided, the information is written in /etc/net.cfg.
Files:
/etc/net.cfg The configuration file written by phlip and read by
netmanager.
See also:
/etc/autoconnect, dhcp.client, diskboot, ifconfig, io-pkt*, phlip,
/etc/resolv.conf, route, slogger
Controlling How Neutrino Starts chapter of the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. netstat
Show network status
Syntax:
Display a list of active sockets for each protocol:
netstat [-AanT] [-f address_family]
Display the contents of one of the other network data structures:
netstat [-dgiLmnrsTv] [-f address_family]
Continuously display (as per the wait interval) the information regarding packet traffic
on the configured network interfaces:
netstat [-dnT] [-I interface] [-w wait]
Display statistics about the named protocol:
netstat [-T] [-p protocol]
Display statistics about the named protocol located at the virtual address:
netstat [-T] [-p protocol] -P pcbaddr
Display per-interface statistics for the specified protocol:
netstat [-p protocol] [-iT] [-I interface]
Display per-interface statistics for the specified address family:
netstat [-sT] [-f address_family] [-i] [-I interface]
Runs on:
Neutrino
Options:
-A Show the addresses of any protocol control blocks associated with
sockets.
-a Show the state of all sockets. Without -a, sockets used by server
processes aren’t shown.
-d Show the number of dropped packets.
-f address_family
Limit the statistics or address control block reports to those of the
specified address family.

netstat © 2010, QNX Software Systems GmbH & Co. KG.
Address family: address_family value:

AF_INET inet
AF_INET6 inet6
AF_LOCAL local or unix
AF_ARP arp
-g Show information related to multicast (group address) routing. By

default, show the IP Multicast virtual-interface and routing tables.
If -s is also specified, show the multicast routing statistics.
-I [interface] If used with -w, show information about the specifed interface
only. See “Specifying an interface” for more information.
If used with -f address_family and -s, or with -p protocol, show
per-interface statistics on the interface for address_family or
protocol, respectively.
-i Show the state of interfaces that have been auto-configured.

Interfaces statically configured into a system but not located at boot
time aren’t shown.
If you also specify -a, show multicast addresses currently in use
for each Ethernet interface and for each IP interface address.
Multicast addresses are shown on separate lines following the
interface address with which they’re associated.
If used with -f address_family and -s, or with -p protocol, show
per-interface statistics on the interface for address_family or
protocol, respectively.
-L Don’t show link-level routes (e.g., IPv4 ARP or IPv6 neighbour

cache).
-m Show statistics recorded by the memory-management routines (the
network manages a private pool of memory buffers).
-n Show network addresses as numbers (normally netstat interprets

addresses and attempts to display them symbolically).
-P pcbaddr Dump the contents of the protocol control block (PCB) located at
kernel virtual address pcbaddr. This address may be obtained using
-A. The default protocol is TCP, but may be overridden with -p.
-p protocol Show statistics about protocol, which is either a well-known name

for a protocol or an alias for it. Some protocol names and aliases
are listed in the file /etc/protocols. A null response typically
means that there are no interesting numbers to report. The utility
complains if protocol is unknown or if there’s no statistics routine
for it.

-r Show the routing tables. If -s is also specified, show the routing

statistics instead.
-s Show per-protocol statistics. If this option is repeated, counters

with a value of zero are suppressed.
-T Use TCP for name lookups (the default is UDP).
-v Show extra (verbose) detail for the routing tables (-r), or avoid
truncating long addresses.
-w wait Specify the time interval for displaying network interface statistics.
Description:
The netstat utility displays the contents of various network-related data structures.
Default display
The default display for active sockets shows the local and remote addresses, the send
and receive queue sizes (in bytes), the protocol, and the internal state of the protocol.
If a socket’s address specifies a network but no specific host address, address formats
are of the form host.port or network.port
When known, the host and network addresses are displayed symbolically according to
the databases /etc/hosts and /etc/networks, respectively. If a symbolic name
for an address is unknown, or if -n is specified, the address is printed numerically,
according to the address family. For more information regarding the Internet “dot
format,” see the inet_*() functions. Unspecified or wildcard addresses and ports
appear as *.
Interface display
The interface display (-i or -w) provides a table of cumulative statistics regarding
errors, collisions, and packets transferred. The network addresses of the interface and
the maximum transmission unit (MTU) are also displayed.
Routing table display

The routing table display (-r) indicates the available routes and the status of each.
Each route consists of a destination host or network and a gateway to use in
forwarding packets. The display includes several fields:
flags Shows the state of the route.

netstat © 2010, QNX Software Systems GmbH & Co. KG.
Valid flags: Constant: Description;

1 RTF_PROTO2 Protocol specific routing flag #1
2 RTF_PROTO1 Protocol specific routing flag #2
B RTF_BLACKHOLE Discard packets during updates
C RTF_CLONING Generate new routes on use This is
used by ARP to create the
host-specific routes of the hosts on
the Ethernet. See option L.
D RTF_DYNAMIC The route was created dynamically
by a redirect
G RTF_GATEWAY The route uses a gateway
H RTF_HOST The destination is a host
(otherwise, it’s a net)
L RTF_LLINFO The route contains a link-layer
address. The host routes that ARP
clones from the Ethernet network
routes all have the link flag set.
M RTF_MODIFIED The route has been modified by a
redirect
R RTF_REJECT Host or net unreachable
S RTF_STATIC The route has been added manually
U RTF_UP The route is up

X RTF_XRESOLVE External daemon translates the
protocol to a link address
gateway Direct routes are created for each interface attached to the local host.
For such entries, this field shows the address of the outgoing
interface.
interface Indicates the network interface used for the route.
mtu Shows the maximum transmission unit (MTU) associated with that
route. This value is used as the basis for the TCP maximum segment
size. The L flag appended to the MTU value indicates that the value
is locked, and that path MTU discovery is turned off for that route. A
- indicates that the MTU for this route hasn’t been set, and a default
TCP maximum segment size will be used.
refcnt Gives the current number of active uses of the route.

Connection-oriented protocols normally hold on to a single route for

the duration of a connection; connectionless protocols obtain a route

while sending to the same destination.
use Provides a count of the number of packets sent using the route.
Specifying an interface
When -w is specified, netstat displays a running count of statistics related to
network interfaces. This display consists of a column for the primary interface (the
first interface found during auto-configuration) and a column summarizing
information for all interfaces. Using -I, you can replace the primary interface with
another interface. The first line of each screen of information contains a summary
since the system was last rebooted. Subsequent lines of output show values
accumulated over the preceding interval.
Caveats:
The -A, -a, -d, and -s options require the presence of the /etc/protocols file.
See also:
/etc/hosts, /etc/networks, /etc/protocols, /etc/services

/etc/networks © 2010, QNX Software Systems GmbH & Co. KG.
Network name database
Name:
/etc/networks
Description:
The networks file contains information regarding the known networks that make up
the DARPA Internet. For each network, a single line should be present with the
following information:
official_network_name network_number aliases
Items are separated by any number of spaces or tabs, or both. A pound sign (#) in a
line indicates the beginning of a comment — any characters after a #, up to the end of
the line, aren’t interpreted by routines that search the file.
The network number may be specified in the conventional “.” (dot) notation using the
inet_network() routine from the internet address manipulation functions, inet_*().
Network names may contain any printable character other than a field delimiter,
newline, or comment character.
See also:
getnetent()

© 2010, QNX Software Systems GmbH & Co. KG. newgrp
Change to a new group
Syntax:
newgrp [-l|-s] [group]
Runs on:
Neutrino
Options:
-l (“el”) Change the environment to what would be expected if the user
actually logged in again.
-s Set the group ID of the parent; don’t exec() a login shell.
group A group name.
Description:
The newgrp utility starts a new shell with a new real and effective group ID. The user
remains logged in and the current directory doesn’t change, but file access permissions
are based on the new real and effective group IDs.
If no operands are specified, newgrp changes the group ID back to the group
identified in the invoking user’s entry in /etc/passwd.
If you don’t use the -l option, the environment variables remain unchanged.
Note that group passwords aren’t supported in QNX Neutrino. Only the user root
may change the group ID to a group that it doesn’t belong to.
Files:
/etc/group Contains information on the group IDs in the system. See
passwd’s “Files” section for a brief description of the format of
this file.
/etc/passwd Contains information on the user IDs in the system.
See the passwd utility “Files” section for a brief description of the format of these
files.

newgrp © 2010, QNX Software Systems GmbH & Co. KG.
See also:
passwd, su
Managing User Accounts in the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. nfsd
NFS v2 & v3 and MOUNT v1 & v3 protocol server
Syntax:
nfsd [-DFPt] [-c file] [-f n] [-H n] [-h n] [-o option] [-p n]
[-s n] [-x n] &
Runs on:
Neutrino
Options:
-c file Use file as the exports file. The default is /etc/exports.
-D Operate in debugging mode.
-F Truncate the subdirs and mntdtab files, and then exit.
-f n Set the size of the open file cache (the default is 16).
The open file cache is used to cache open files and directories (with a
5-second idle timeout). If you know nfsd services only one client that
only reads/writes to a single file, reducing this cache may save memory.
If you know nfsd services many clients that read/write many files,
increasing this cache could improve performance for read/write
operations.
Keep this cache a reasonable size, as file descriptors (open files) are a limited resource
— by default, QNX Neutrino sets a maximum of 1000 open files per process. Besides
this cache, nfsd needs file descriptors for sockets (servicing TCP consumes more than
just UDP) and internal readdir() operations.
-H n Specify the size of the file handle cache hash (the default is 997).
-h n Specify the size of the file handle cache (the default is 200).
The file handle cache is a straight memory/performance trade-off,
however it doesn’t significantly affect read/write performance. It helps
speed up ls-type operations (very useful for compiling/makefiles). To
get a rough idea of how large this cache should (optimally) be, use the
output of:
find mnt1 ... mntN | wc -l
-o option Specify an additional option, where option is one of the following:

nfsd © 2010, QNX Software Systems GmbH & Co. KG.
• nfsvers=2 — support NFS v2 only; the default is to support both

NFS v2 and NFS v3.
• run=foreground — run in the foreground; don’t fork.
-P Parse the exports file, to check for errors, and then exit.
-p n Run nfsd on port n, and don’t register with portmap. By default, the
port is 2049, and nfsd registers with portmap.
-s n Flush the cache every n idle seconds (the default is 5).
-t Service TCP transport.
-x n Specify the size of the XID cache (default is 16).

The XID cache isn’t used for performance, but rather to ensure
nonidempotent operations are responded to correctly.
Consider what happens when a client issues a remove request.
Normally, the server receives the request, removes the file, and sends
back a successful response. Suppose that, for some reason, the server
doesn’t respond fast enough for the client, and the client retransmits the
request. If the server tries to remove the file (again), it fails.
Instead, each request is assigned a transaction identifier, known as an
xid, which remains constant for retransmissions. If the client
retransmits the request, the server matches it with the previous request
and just replies with the previous status. Generally, the busier the
network and server are, the more requests are retransmitted by the
client(s), and the larger the XID cache should be.
Description:
The nfsd daemon services both NFS mount requests and NFS requests, as specified
by the exports file. When it starts, nfsd reads the /etc/exports.hostname file (if
this file doesn’t exist, nfsd reads /etc/exports instead) to determine which
mountpoints to service. Changes made to this file don’t take effect until you either
restart nfsd or you send nfsd a SIGHUP signal:
slay -s SIGHUP nfsd
There’s no direct check for root on the mount; nfsd checks only that requests come
in on a privileged port, which implies root access.
The nfsd daemon supports a maximum of 15 nested directory levels.

© 2010, QNX Software Systems GmbH & Co. KG. nfsd
The nfsd command doesn’t tolerate any parsing errors while reading the exports file.
If an error is detected, nfsd terminates. To keep downtime to a minimum if you
modify the exports file, we recommend that you either:
• Start another nfsd. If no parsing errors are detected, the second nfsd reports a
bind failure, and exits — this indicates the exports file was parsed correctly.
or:
• Start a second instance of nfsd, specifying the -P option.
Security Issues
NFS is a very unsecure protocol. Although nfsd checks each request’s origin against
restrictions specified in the exports file, this helps only in an “honest” network. It’s not
difficult to spoof NFS requests.
Configuring Caches
Fine-tuning nfsd caches may result in less memory usage and improved performance,
but these qualities are usually exclusive. Before modifying the default behavior of
nfsd, it’s important to know what its clients will demand from it. Also note that these
caches are shared across all mountpoints.
See also:
/etc/exports, fs-nfs2, fs-nfs3, io-pkt*, mount, syslogd, umount
“NFS filesystem” in the Working With Filesystems chapter of the User’s Guide

/etc/nfsstart © 2010, QNX Software Systems GmbH & Co. KG.
Start NFS server daemons
Name:
/etc/nfsstart
Description:
The nfsstart file is a shell script that you can use to start TCP/IP daemons specific
to an NFS server.
There isn’t a default version of this file; you can create your own if you need it.
Here’s a typical sample file that you should optimize on a per-system basis:
#!/bin/sh
/usr/sbin/nfsd
# NOTE: to service non-Unix clients, uncomment the next line
# (may also need to add the -norsvd option in the
# exports file)
# /usr/sbin/pcnfsd
See also:
/etc/exports, nfsd

© 2010, QNX Software Systems GmbH & Co. KG. nice
Run a program at an altered priority (POSIX)
Syntax:
nice [-nprioritylevels] command [arguments]...
Deprecated:
nice [-prioritylevels] command [arguments]...
Runs on:
Neutrino
Options:
-prioritylevels Deprecated. This is the historical method of specifying the
amount to adjust the current priority by. Specifying -1 lowers
the priority by one, while specifying --1 boosts the priority by
one.
-n prioritylevels Specify the amount to adjust the current priority by when

running the command. The command is run at a priority level of
the current priority minus prioritylevels.
command [arguments]...
The command to run at the altered priority.
Description:
The nice utility invokes the specified command with a modified priority, usually
making the command behave “more nicely” towards competing processes.
If no prioritylevels option is specified, the program is invoked at a priority that’s one
level lower than the parent’s current priority (i.e. it is invoked with a “nice increment”
of 1).
If a prioritylevels option is specified, it’s subtracted from the parent’s current priority
and the program is invoked at the resultant priority. If the resulting priority isn’t a
valid priority, nice writes a diagnostic message to the standard error and exits with a
status of 1.
If you enter: nice:

A positive value (e.g. -n2 or -n+2) Lowers the priority of the program,
making it “nice”
A negative value (e.g. -n-2) Raises the priority of the program,
making it “mean”

nice © 2010, QNX Software Systems GmbH & Co. KG.
You can adjust the priority as follows:
If you’re: You can change to any priority:

A non-root user From 1 to 63
root From 1 to 255
You can change the range of privileged priorities with the -P option for procnto.
Examples:
Run make at one priority lower than the parent’s priority (be nice):
nice make application
Run make at two priorities lower than the parent’s priority (be nicer):
nice -n2 make application
Run make at two priorities higher than the parent’s priority (be mean):
nice -n-2 make application
Exit status:
If the operation is successful, the exit status of the invoked command is returned. If an
error occurs, the exit status is as follows:
1 Invalid command-line parameters were given or the user requested an invalid

priority.
126 The command specified didn’t exist.
127 The command couldn’t be started for some other reason.
Caveats:
In contrast to other operating systems, the QNX Neutrino interpretation of the nice
value substantially affects the priority of the process. Rather than representing a
fraction of a priority, the granularity of the nice value in QNX Neutrino is of a
“whole” priority level. For example, where the following has a marginal effect on the
execution of myprog on some operating systems:
nice -n5 myprog
on QNX Neutrino it lowers the priority of myprog by five full priority levels, and
could have a significant effect on myprog’s execution time.

© 2010, QNX Software Systems GmbH & Co. KG. nice
See also:
on, renice, slay

nicinfo © 2010, QNX Software Systems GmbH & Co. KG.
Display information about a network interface controller
If you aren’t root, specify the full path: /usr/sbin/nicinfo.
Syntax:
nicinfo [-c|g|s] [-rv] [interface|device...]
Runs on:
Neutrino
Options:
-c Display information about the configuration only.
-g Display general statistics only.
-r The specified devices are relative to /dev/io-net/. This option is for

compatibility with older io-net drivers.
-s Display statistics only.
-v Be verbose.
device The device (e.g. /dev/io-net/en0) to display information about. This

is for compatibility with older io-net drivers; native io-pkt drivers
don’t create entries in /dev.
interface The network interface (e.g. fxp0) to display information about. If you
don’t specify an interface, nicinfo displays information about all
interfaces.
You should specify at most one of the -c, -g, and -s options.
Description:
This utility displays information about the given network interface connection, or all
interfaces if you don’t specify one. The information includes the number of packets
transmitted and received, collisions, and other errors.

© 2010, QNX Software Systems GmbH & Co. KG. nicinfo
• The output from nicinfo depends on what the driver supports; not all fields are
included for all drivers. However, the output always includes information about the
bytes and packets that were transmitted and received.
• NetBSD drivers don’t support nicinfo.
Examples:
# nicinfo en0
SMC9432 EPIC Ethernet Controller
Physical Node ID ........................... 00E029 3820EE

Current Physical Node ID ................... 00E029 3820EE
Current Operation Rate ..................... 100.00 Mb/s half-duplex
Active Interface Type ...................... MII
Active PHY address ....................... 3
Maximum Transmittable data Unit ............ 1514
Maximum Receivable data Unit ............... 1514
Hardware Interrupt ......................... 0x9
I/O Aperture ............................... 0xb000 - 0xb0ff
Memory Aperture ............................ 0xf1800000 - 0xf1800fff
Promiscuous Mode ........................... Off
Multicast Support .......................... Enabled
Packets Transmitted OK ..................... 1096267

Bytes Transmitted OK ....................... 1096353794
Memory Allocation Failures on Transmit ..... 0
Packets Received OK ........................ 1132010

Bytes Received OK .......................... 1201171760
Memory Allocation Failures on Receive ...... 0
Single Collisions on Transmit .............. 744536

Deferred Transmits ......................... 262485
Late Collision on Transmit errors .......... 0
Transmits aborted (excessive collisions) ... 0
Transmit Underruns ......................... 0
No Carrier on Transmit ..................... 0
Receive Alignment errors ................... 0
Received packets with CRC errors ........... 0
Packets Dropped on receive ................. 0
Get statistics on legacy io-net drivers running with the shim:
# nicinfo -r en0
Another way to do the same thing:
# nicinfo /dev/io-net/en0
Get statistics on a particular native driver:
# nicinfo wm0
Exit status:

nicinfo © 2010, QNX Software Systems GmbH & Co. KG.
See also:
devn-*, devnp-*,

© 2010, QNX Software Systems GmbH & Co. KG. nm
List symbols from object files (POSIX)
Syntax:
nm_variant [options] [objfile...]
Runs on:
Options:
The nm_variant depends on the target platform, as follows:
Target platform: nm_variant:

ARM ntoarm-nm
MIPS ntomips-nm
PowerPC ntoppc-nm
SH4 ntosh-nm
x86 ntox86-nm
Description:
The nm utility lists the symbols from the specified object files. If no object files are
listed as arguments, nm assumes a.out. For detailed documentation, see the GNU
GNU
See also:
ar, mcs

nohup © 2010, QNX Software Systems GmbH & Co. KG.
Invoke a command immune to hangups (POSIX)
Syntax:
nohup command [argument...]
Runs on:
Neutrino
Options:
argument The argument(s) for the command to be invoked.
Description:
The nohup utility invokes the specified command with arguments supplied as the
argument operands. When the command is invoked, the SIGHUP signal is set to be
ignored; thus, the command is made immune to hangups.
If the standard output is a terminal, all output written by the specified command to its
standard output is appended to the nohup.out file in the current directory. If this
nohup.out file can’t be created, or if it can’t be opened for appending, the output is
appended to the end of the nohup.out file in the directory specified by the HOME
environment variable. If neither nohup.out file can be created or opened, the
specified command isn’t invoked.
If the standard error output is a terminal, all output written by the specified command
to its standard error output is redirected to the same file descriptor as the standard
output.
It’s often desirable to apply nohup to pipelines or lists of commands. You can do this
by placing pipelines and command lists in a single file; this file can then be executed
as a command, and the “nohup” applies to everything in the file.
Alternatively, the following can be used to apply nohup to a complex command:
nohup sh -c ’complex-command-line’
Similarly, you can use the following commands to apply nohup to a shell function:
export -f func
nohup sh -c ’command line invoking func’
If you want the SIGQUIT signal to also be ignored, you can run nohup in the
background:
nohup command &
Files:
./nohup.out If possible, this file will be created and the output of the command
will be written to it.

© 2010, QNX Software Systems GmbH & Co. KG. nohup
$HOME/nohup.out
If it was not possible to open ./nohup.out, nohup will attempt
to create (if necessary) and append the output of the command to
this file. If neither file can be opened, nohup will not run the
command.
HOME If the output file nohup.out cannot be created in the current directory,
nohup uses the directory named by this variable to create the file.
PATH Contains the search path used to locate the command to be invoked.
Exit status:
The exit status of nohup cannot be relied upon.
License:

nslookup © 2010, QNX Software Systems GmbH & Co. KG.
Query Internet name servers interactively
Syntax:
nslookup [-options] [host-to-find | -[server]]
Runs on:
Neutrino
Options:
options Any option from the set command.
host-to-find The host to look up.
server The server to use for the lookup.
Description:
The nslookup utility lets you query Internet domain name servers. The utility has
two modes: interactive and noninteractive. In interactive mode, you can query name
servers for information about various hosts and domains or print a list of hosts in a
domain. In noninteractive mode, nslookup just prints the name and requested
information for a host or domain.
The utility enters interactive mode when:
• no arguments are given (the default name server is used)
• the first argument is a hyphen (-) and the second argument is the hostname or
Internet address of a name server.
The utility enters noninteractive mode when the first argument is the name or Internet
address of the host to be looked up. The optional second argument specifies the host
name or address of a name server.
You can specify the options listed under the set command below in the
.nslookuprc file in your home directory; list each one on its own line.
You can specify interactive commands on the command line if they precede the
arguments and you prefix them with a hyphen. For example, to change the default
query type to host information and the initial timeout to 10 seconds, type:
nslookup -querytype=HINFO -timeout=10
Interactive commands
To interrupt a command at any time, press Ctrl-C. To exit, press Ctrl-D (EOF) or type
exit. To treat a builtin command as a host name, place an escape character (\) before
the command.

© 2010, QNX Software Systems GmbH & Co. KG. nslookup
The length of the command line must be less than 256 characters.
Any unrecognized command is interpreted as a host name.
host [server] Look up information for host using the current default server or
using server, if specified.
If host is an Internet address and the query type is A or PTR
(see the set querytype command), the name of the host is
returned. If host is a name and doesn’t have a trailing period,
the default domain name is appended to the name. (This
behavior depends on the state of the set options domain,
srchlist, defname, and search).
To look up a host not in the current domain, append a period to
the name.
server domain
lserver domain Change the default server to domain. The lserver form uses
the initial server to look up information about domain while
server uses the current default server. If an authoritative
answer can’t be found, the names of servers that might have the
answer are returned.
root Change the default server to the server for the root of the
domain namespace. Because the host ns.nic.ddn.mil is
currently used, this command is a synonym for
lserver ns.nic.ddn.mil. You can change the name of the
root server with the set root command.
finger [name] [> filename]
finger [name] [>> filename]
Connect with the finger server on the current host. The current
host is defined when a previous lookup for a host completed
successfully and returned address information (see the
set querytype=A command). The name argument is
optional. Note that you can use > and >> in the usual manner.
ls [option] domain [> filename]

ls [option] domain [>> filename]
List the information available for domain, optionally creating or
appending to filename. If no option is given, the output contains
hostnames and their Internet addresses. The option argument
can be one of the following:
-t querytype List all records of the specified type (see

querytype below).

-a List aliases of hosts in the domain. Synonym for

-t CNAME.
-d List all records for the domain. Synonym for
-t ANY.
-h List CPU and OS information for the domain.
Synonym for -t HINFO.
-s List well-known services of hosts in the domain.
Synonym for -t WKS. When output is directed
to a file, hash marks are printed for every 50
records received from the server.
view filename Sort and list the output of previous ls commands with more.
help
? Print a brief summary of commands.
exit Exit the utility.
All of the keywords on the following pages belong to the set command.
set keyword[=value]
Change state information that affects the lookups. Valid keywords are:
all Print the current values of set’s most frequently used

options as well as information about the current default
server and host.
class=value Change the query class to one of:
IN Internet class.
CHAOS Chaos class.
HESIOD MIT Athena Hesiod class.
ANY Query for any of the above.
The class specifies the protocol group of the information
(default = IN, abbreviation = cl).
[no]debug Turn debugging mode on. A lot more information is
printed about the packet sent to the server and the resulting
answer (default = nodebug, abbreviation = [no]deb).
[no]d2 Turn exhaustive debugging mode on. All fields of every
packet are printed (default = nod2).
domain=name Change the default domain name to name. The default
domain name is appended to a lookup request depending
on the state of the defname and search options (see
below).

The domain search list contains the parents of the default

domain if the domain has at least two components in its
name. For example, if the default domain is
CC.Berkeley.EDU, the search list is CC.Berkeley.EDU
and Berkeley.EDU (default is the value from hostname,
/etc/nsswitch.conf file, or the LOCALDOMAIN
environment variable; the abbreviation is do).
To specify a different list, use set srchlist (see below);
to display the list, use set all.
srchlist=name1/name2/...
Change the default domain name to name1 and the domain
search list to name1, name2, etc. (default = value based on
hostname, /etc/nsswitch.conf file, or the
LOCALDOMAIN environment variable; abbreviation =
srchl).
You can specify a maximum of six names separated by
slashes (/). For example, this command:
set srchlist=lcs.MIT.EDU/ai.MIT.EDU/MIT.EDU
sets the domain to lcs.MIT.EDU and the search list to the

three names.
This command overrides the default domain name and
search list of the set domain command. Use the
set all command to display the list.
[no]defname Append the default domain name to a single-component
lookup request, i.e. one that doesn’t contain a period
(default = defname, abbreviation = [no]def).
[no]search If the lookup request contains at least one period but
doesn’t end with a trailing period, append the domain
names in the domain search list to the request until an
answer is received (default = search, abbreviation =
[no]sea).
port=value Change the default TCP/UDP name server port to value
(default = 53, abbreviation = po).
querytype=value
type=value Change the type of information query to one of:
A The host’s Internet address.
CNAME The canonical name for an alias.
HINFO The host CPU and OS type.
MINFO The mailbox, or mail-list information.
MX The mail exchanger.
NS The name server for the named zone.
PTR The hostname if the query is an Internet address;
otherwise the pointer to other information.

SOA The domain’s “start-of-authority” information.

TXT The text information.
UINFO The user information.
WKS The supported well-known services. Other types
(ANY, AXFR, MB, MD, MF, NULL) are described in
the RFC 1035 document.
Default = A; abbreviations = q, ty.
[no]recurse Tell the name server to query other servers if it doesn’t
have the information (default = recurse, abbreviation =
[no]rec).
retry=number Set the number of retries to number. When a reply to a
request isn’t received within a certain amount of time
(changed with set timeout), the timeout period is
doubled and the request is sent again. The number
argument controls how many times a request is resent
before nslookup gives up (default = 4, abbreviation =
ret).
root=host Change the name of the root server to host. This affects the
root command (default = ns.nic.ddn.mil.,
abbreviation = ro).
timeout=number Change the initial timeout interval for waiting for a reply to
the specified number of seconds. Each retry doubles the
timeout period (default = 5, abbreviation = ti).
[no]vc Always use a virtual circuit when sending requests to the
server (default = novc, abbreviation = [no]v).
[no]ignoretc Ignore packet truncation errors (default = noignoretc,
abbreviation = [no]ig).
Diagnostics:
If the lookup request wasn’t successful, one of the following error messages may be
printed:
Timed out The server didn’t respond to a request after a certain amount of
time (changed with set timeout=value) and a certain number
of retries (changed with set retry=value).
No response from server
No name server is running on the server machine.
No records The server doesn’t have resource records of the current query
type for the host, although the hostname is valid. The query type
is specified with the set querytype command.
Nonexistent domain
The hostname or domain name doesn’t exist.

Connection refused --- Network is unreachable

The connection to the name or finger server couldn’t be made at
the current time. This error commonly occurs with ls and
finger requests.
Server failure The name server found an internal inconsistency in its database
and couldn’t return a valid answer.
Refused The name server refused to service the request.
Format error The name server found that the request packet wasn’t in the
proper format. This may indicate an error in nslookup.
Files:
/etc/nsswitch.conf
Name-service switch configuration file.
$HOME/.nslookuprc
User’s initial options.
/etc/nslookup.help
Summary of commands.
The nslookup utility requires the libsocket.so shared library.
HOSTALIASES Contains host aliases.
LOCALDOMAIN Overrides default domain.
Andrew Cherenson
See also:
/etc/nsswitch.conf
dn_comp(), dn_expand(), res_init(), res_mkquery(), res_query(), res_querydomain(),
res_search(), res_send() in the Library Reference.
Based on:
• Domain Names — Concepts and Facilities (RFC 1034)
• Domain Names — Implementation and Specification (RFC 1035)

/etc/nsswitch.conf © 2010, QNX Software Systems GmbH & Co. KG.
Name-service switch configuration file
Name:
/etc/nsswitch.conf
Description:
The nsswitch.conf file specifies how the nsdispatch() (name-service switch
dispatcher) routines in the socket library should operate.
The configuration file controls how a process looks up various databases containing
information regarding hosts and networks. Each database comes from a source (such
as local files, and DNS ), and the order to look up the sources is specified in
nsswitch.conf.
Each entry in nsswitch.conf consists of a database name, and a space-separated list
of sources. Each source can have an optional trailing criterion that determines whether
the next listed source is used, or the search terminates at the current source. Each
criterion consists of one or more status codes, and actions to take if that status code
occurs.
Sources
The following sources are implemented:
files Local files, such as /etc/hosts.
dns Internet Domain Name System. The hosts and networks databases use
IN class entries.
Databases
The following databases are used by the following C library functions:
Database Used by
hosts getaddrinfo(), gethostbyaddr(), gethostbyname(), and getnameinfo()
networks getnetbyaddr(), getnetbyname()
Status codes
The following status codes are available:
success The requested entry was found.

notfound The entry isn’t present at this source.
tryagain The source is busy, and may respond to retries.
unavail The source isn’t responding, or the entry is corrupt.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/nsswitch.conf
Actions
For each of the status codes, one of two actions is possible:
continue Try the next source.

return Return with the current result.
Format of the file

A BNF description of the syntax of nsswitch.conf is:
<entry> ::= <database> ":" [<source> [<criteria>]]*
<criteria> ::= "[" <criterion>+ "]"
<criterion> ::= <status> "=" <action>
<status> ::= "success" | "notfound" | "unavail" | "tryagain"
<action> ::= "return" | "continue"
Each entry starts on a new line in the file. A number sign (#) delimits a comment to
the end of the line. Blank lines are ignored. A backslash (\) at the end of a line
escapes the newline, and causes the next line to be a continuation of the current line.
All entries are case-insensitive.
The default criteria is to return on success, and continue on anything else (i.e.
[success=return notfound=continue unavail=continue
tryagain=continue]).
Historically, many of the databases had enumeration functions, often of the form
getXXXent(). These made sense when the databases were in local files, but don’t make
sense or have lesser relevance when there are possibly multiple sources, each of an
unknown size. The interfaces are still provided for compatibility, but the source may
not be able to provide complete entries, or duplicate entries may be retrieved if
multiple sources that contain similar information are specified.
If, for any reason, nsswitch.conf doesn’t exist, or it has missing or corrupt entries,
nsdispatch() will default to an entry of files for the network database, and files
dns for the hosts database.
Luke Mewburn wrote this freely distributable name-service switch implementation,
using ideas from the ULTRIX svc.conf and Solaris nsswitch.conf manual pages.
Examples:
To look up hosts in /etc/hosts and then from the DNS, use:
hosts: files dns
See also:
/etc/resolv.conf, named
getaddrinfo(), gethostbyaddr(), gethostbyname(), getnameinfo(), getnetbyaddr(),
getnetbyname() in the Neutrino Library Reference
nsdispatch() in the NetBSD documentation at http://www.netbsd.org/docs/

nsupdate © 2010, QNX Software Systems GmbH & Co. KG.
Dynamic DNS update utility
Syntax:
nsupdate [-d] [[-y [hmac:]keyname:secret] | [-k keyfile]]
[-t timeout] [-u udptimeout] [-r udpretries]
[-R randomdev] [-v] [filename]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?nsupdate++NetBSD-5.0 in the NetBSD
documentation.
Description:
The nsupdate utility is used to submit Dynamic DNS Update requests as defined in
RFC2136 to a name server. This allows resource records to be added or removed from
a zone without manually editing the zone file. A single update request can contain
requests to add or remove more than one resource record. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?nsupdate++NetBSD-5.0 in the NetBSD
documentation.
See also:
dnssec-keygen, named in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. ntpd
Network Time Protocol (NTP) daemon
Syntax:
ntpd [-46aAbdgLmnNpqx] [-c conffile] [-D level]
[-f driftfile] [-i jaildir]
[-k keyfile] [-l logfile] [-p pidfile]
[-P priority] [-r broadcastdelay]
[-s statsdir] [-t key]
[-u user[:group] ] [-v variable] [-V variable]
Runs on:
Neutrino
Options:
-4 Force DNS resolution of hosts to the IP4 namespace.
-a Require cryptographic authentication for broadcast client,

multicast client, and symmetric passive associations. This is the
default.
-A Don’t require cryptographic authentication for broadcast client,

multicast client, and symmetric passive associations.
-b Enable the client to synchronize to broadcast servers.
-c conffile Specify the name and path of the configuration file; the default is
/etc/ntp/ntp.conf. For information about this file, see its
entry in the FreeBSD documentation.
-d Use debugging mode. You can specify this option more than
once, with each occurrence producing a greater amount of detail
-D level Specify the debugging level directly.
-f driftfile Specify the name and path of the frequency file; the default is as
specified by driftfile driftfile configuration command, if
present in the ntp.conf file.
-g Set the panic threshold to any value without any restriction. If the
offset exceeds the default value (1000 s) of this panic threshold,
ntpd exits with a message to the system log. You can use this
option with the -q and -x options. See the tinker command for
other options.
-i jaildir Change the server’s root directory to be jaildir. This option also
implies that the server attempts to drop root privileges at startup
(otherwise, changing the root directory gives little additional

ntpd © 2010, QNX Software Systems GmbH & Co. KG.
security), and it’s available only if the OS supports running the

server without full root privileges. You may need to also
specify the -u option.
-k keyfile Specify the name and path of the symmetric key file; the default
is /etc/ntp/ntp.keys. This is the same operation as the keys
keyfile configuration command. For information about this file,
see its entry in the FreeBSD documentation.
-l logfile Specify the name and path of the log file. The default is the
system log file. This is the same operation as the logfile logfile
configuration command.
-L Don’t listen to virtual IPs. The default is to listen.
-m Enable the client to synchronize the multicast servers at the IPv4

multicast group address 224.0.1.1.
-n Don’t fork.
-N Run the ntpd utility at the highest priority.
-p pidfile Specify the name and path of the file used to record the ntpd
process ID. This is the same operation as the pidfile pidfile
-P priority Run the ntpd utility at the given priority.
-q Exit the ntpd utility just after the first time the clock is set. You
can use the -g and -x options with this option.
-r broadcastdelay Specify the default propagation delay from the

broadcast/multicast server to this client. This is necessary if the
protocol can’t automatically compute the delay.
-s statsdir Specify the directory path for files created by the statistics
facility. This is the same operation as the statsdir statsdir
-t key Add a key number to the trusted key-list. This option can occur
more than once.
-u user[:group] Specify a user, and optionally a group, to switch to.
-v variable
-V variable Add the given system variable.
-x Set the step threshold to 600 s. The default value is 128 ms. If
the offset is less than (or above) the step threshold, the time is
adjusted (or stepped up). You can use this option with the -g and
-q options. Please also see the tinker command.

Description:
Use the ntpd utility to set and maintain the system time of day in synchronism with
the Internet standard time servers. This utility is an operating system daemon that
conforms to the NTP (Network Time Protocol) version 4 specification. It also retains
compatibility with version 3, as defined by RFC 1305, and version 1 and 2, as defined
by RFC 1059 and RFC 1119. Using the 64-bit floating point arithmetic, the ntpd
utility attempts to preserve the ultimate precision, which is about 232 picoseconds.
While the ultimate precision isn’t achievable with today’s workstations and networks,
it’s required for future gigahertz CPU clocks and gigabit LANs.
The ntpd utility normally reads the ntp.conf file for its configuration. For
information about this file, see its entry in the FreeBSD documentation.
Basic operation of the ntpd utility

The ntpd utility exchanges messages with one or more configured hosts at designated
poll intervals. This is done to groom data and set the clock. Although the default
initial poll interval is 64 seconds, the poll interval for each server is delayed by an
interval randomized over few seconds, in order to protect the network from bursts.
In order to maintain time during periods when the power is off, today’s hardware
incorporates a time-of-year (TOY) chip. When the machine is booted, the chip is used
to initialize the operating system time. After the machine has synchronized to a NTP
server, the operating system time gets synchronized and corrected from time to time.
This doesn’t set the hardware clock; you can use the rtc utility to set the time on the
chip.
Under ordinary conditions, ntpd adjusts the clock in small steps so that the time scale
is continuous. Under conditions of extreme network congestion, the ntpd algorithms
discard sample offsets exceeding 128 ms, because:
• the roundtrip delay jitter can exceed three seconds
• the synchronization distance, which is equal to one-half the roundtrip delay plus
error budget terms, can become very large.
When there is no TOY chip, and the client time is more than 1000 seconds from the
server time, you should intervene and set the clock by hand — causing the ntpd
utility to exit with a panic message to the system log.
Frequency discipline
The behavior of the ntpd utility at startup depends on the existence of ntp.drift
frequency file. This file contains the latest estimate of the clock frequency error. If this
file doesn’t exist, the ntpd utility enters a special mode designed to quickly adapt to
system clock oscillator time and frequency error. After approximately 15 minutes,
when the time and frequency are set to nominal values, the ntpd utility starts tracking
the time and frequency relative to the server. After one hour, the current frequency

ntpd © 2010, QNX Software Systems GmbH & Co. KG.
offset is written to ntp.drift frequency file. Since the ntpd frequency is initialized
from this file, the ntpd utility enters into normal mode immediately during startup.
Subsequently, the current frequency offset is written to the ntp.drift frequency file
at hourly intervals.
Operating modes
The ntpd utility operates continuously while monitoring for small changes in
frequency, trimming the clock for ultimate precision. It operates in one of several
modes:
• symmetric active/passive
• client/server
• broadcast/multicast
• manycast.
The ntpd utility also operates in one-time mode where the time is set from an external
server, and the frequency is set from a previously recorded frequency file. When a
client operates in broadcast/multicast or manycast mode, it first discovers the remote
server, and then configures itself automatically — after computing the server-client
propagation delay correction factors. You can now deploy a fleet of workstations
without specifying configuration details that are specific to your local environment.
When the ntpd utility runs in continuous mode, each of the external servers is polled
at intervals determined by an intricate state machine. The state machine determines
the poll interval using a heuristic algorithm, after measuring the incidental roundtrip
delay jitter and oscillator frequency wander. In most operating environments, the state
machine starts with intervals of 64 seconds that increase to 1024 seconds, in steps. A
small amount of random variation is also introduced, in order to avoid bunching at the
servers.
In some cases, it may not be practical for ntpd to run continuously. A common
workaround has been to run the ntpdate utility from a cron job at designated times.
This utility, however, doesn’t have the signal processing, error checking, and
mitigation algorithms of the ntpd utility. The -q option is intended for this purpose.
In QNX Neutrino, an useful feature is available to discipline the clock frequency.
First, the ntpd utility is run in continuous mode with selected servers in order to
measure and record the intrinsic clock frequency offset. This may take hours (for the
frequency and offset) to settle down. Then, the ntpd utility is stopped and run in
one-time mode as required. At each startup, ntpd reads the frequency from the file
and initializes the kernel frequency.
Poll interval control

The state machine for ntpd maintains synchronization consistent with the observed
jitter and wander. You have several ways to tailor the operation of the ntpd utility, for
example, either by reducing or increasing the poll interval. You must be careful,

however, to consider the consequences of changing the adjustment range for poll
intervals.
The default minimum for poll interval is 64 seconds, and the default maximum is
1,024 seconds.
You can change the default minimum with the tinker minpoll command to a value
not less than 16 seconds. This value is used for all configured associations, unless
overridden by the minpoll option on the configuration command. Most of the device
drivers don’t operate properly if the poll interval is less than 64 seconds.
In some cases involving dialup or toll services, you may also increase the minimum
interval to a few tens of minutes and the maximum interval to a day or so. Under
normal operating conditions, once the clock discipline loop has stabilized, the interval
is increased in steps from the minimum to the maximum value. This assumes,
however, that the intrinsic clock frequency error is small enough for the discipline loop
to correct it. The capture range of the loop is 500 PPM at an interval of 64 seconds,
decreasing by a factor of two for each doubling of interval. At a minimum of 1,024
seconds, for example, the capture range is only 31 PPM. If the intrinsic error is greater
than this, the ntp.drift drift file is specially tailored to reduce the residual error
below this limit. Once this is done, the drift file is automatically updated once every
hour and is available to initialize the frequency on subsequent daemon restarts.
The huff-n’-puff filter

Timekeeping quality may seriously degrade in certain scenarios, for example, when a
considerable amount of data is to be downloaded or uploaded over telephone modems.
This occurs because differential delays during transmission on two directions can be
quite large. Sometimes, time errors even exceed the step threshold, resulting in step
correction during and after the data transfer.
Use the huff-n’-puff filter to correct the time offset in these cases. It uses the
knowledge of the propagation delay when no other traffic is present, i.e. during other
than work hours. The filter maintains a shift register that remembers the minimum
delay over the most recent interval that is measured in hours. Under conditions of
severe delay, the filter corrects the apparent offset using the sign of the offset, and the
difference between the apparent delay and minimum delay. The name of the filter
reflects the negative (huff) and positive (puff) correction, which depends on the sign
of the offset. The filter is activated by the tinker command and huffpuff keyword.
See also:
ntpdate, ntpdc, ntpq, ntptrace, rtc
ntp.conf, ntp.keys in the FreeBSD documentation
Based on RFC 1059, RFC 1119, RFC 1305

ntpdate © 2010, QNX Software Systems GmbH & Co. KG.
Set the local time and date by polling NTP servers
Syntax:
ntpdate [-46bBdqsuv] [-a key] [-e authdelay]
[-k keyfile] [-M i=your_hostname]
[-o version] [-p samples]
[-t timeout] server [...]
Runs on:
Neutrino
Options:
-a key Enable the authentication function, where key is the key identifier.
Both keys and the key identifiers must match the client and server
key files. The default is to disable the authentication function.
-B Force the time to always be adjusted using ClockAdjust(), even if

the measured offset is larger than ±128 milliseconds. The default is
to set the time using settimeofday(). In case the offset is much
greater than ±128 milliseconds, a longer time (in hours) may be
needed to adjust the clock to the correct value. During this time, the
host is not used to synchronize clients.
-b Force the time to be stepped using the settimeofday() function call.

You should use this option when calling from a startup file at boot
time.
-d Enable the debugging mode, after going through all the steps. Don’t
adjust the local clock. Print the useful information.
-e authdelay Specify the processing delay authdelay (in seconds and fractions
thereof) to perform an authentication function. This option
improves timekeeping for slow CPUs. You may neglect it for most
purposes.
-k keyfile Specify the path for the authentication key file as the string keyfile.
The default is /etc/ntp/ntp.keys. For information about this
file, see its entry in the FreeBSD documentation.
-M i=your_hostname
Enable your host to listen broadcast and multicast messages.
-o version Specify the NTP version, which can be either 1 or 2 or 3. The

default is 3. Use this option to use ntpdate with an older NTP
version.

© 2010, QNX Software Systems GmbH & Co. KG. ntpdate
-p samples Specify the number of samples acquire from each server. The range
is 1 to 8; the default is 4.
-q Query the clock; don’t set it.
-s Divert logging output to the system syslog facility. This is

designed primarily for the convenience of cron scripts.
-t timeout Specify the maximum time for a server response — in seconds and
fractions thereof. The value is rounded to a multiple of 0.2 seconds.
The default is 1 second, a value suitable for polling across a LAN.
-u Direct ntpdate to use an unprivileged port for outgoing packets.

This is most useful when a firewall blocks incoming traffic to
privileged ports, and you want to synchronize with hosts beyond the
firewall. Note that the -d option always uses unprivileged ports.
-v Be verbose. Log the ntpdate version identification string.
Description:
Use the ntpdate utility to set the local time and date by polling NTP (Network Time
Protocol) servers. The accuracy and reliability of this utility depends on the number of
servers, the number of polls each time it is run, and the interval between runs.
Run the ntpdate utility as root on the local host.
At boot time, you may use a host startup script to run the ntpdate utility in order to
set the clock. If necessary, you can also run this utility manually. Using the host script
to set time initially is sometimes useful, e.g. set the time before you start the NTP
daemon, ntpd. You can also run ntpdate from a cron script. The accuracy of the
ntpdate utility is limited.
You use an -M option to support broadcast and multicast messages. Use -M
i=hostname to join the multicast group. You are now able to listen for broadcast and
multicast messages from an broadcast/multicast enabled server.
Use the ntpdate utility to adjust time in two ways:
• Use settimeofday() to step the time when the clock’s in error by more than 0.5
seconds.
• Use ClockAdjust() to adjust the time when the clock’s in error by less than 0.5
seconds.
The latter technique is less disruptive and more accurate when the error is small, and
works quite well when ntpdate is run by cron every hour or two.
When the ntpd utility is running on the same host, the ntpdate utility doesn’t set the
date.

ntpdate © 2010, QNX Software Systems GmbH & Co. KG.
You may force the DNS resolution to the IPv4 (or IPv6) namespace, if you use a -4
(or -6) option that precedes a host name.
Caveats:
Since the time adjustment is actually 50% larger than the measured offset, it tends to
keep a badly drifting clock more accurate. This is not good, however, for some kernel
variables such as tick or tickadj.
See also:
ntpd, ntpdc, ntpq, ntptrace
ClockAdjust(), settimeofday() in the Neutrino Library Reference
ntp.keys in the FreeBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. ntpdc
Query the NTP daemon
Syntax:
ntpdc [-46ilnps] [-c command] [host] [...]
Runs on:
Neutrino
Options:
-c command Execute the given command on the specified hosts. You can use
multiple -c options. For more information about the commands,
see below.
-i Force the ntpdc utility to operate in interactive mode. Prompts will

be written to the standard output and commands read from the
standard input.
-l Obtain a list of peers that are known to the servers. It is equivalent

to -c listpeers option.
-n Output all host addresses in dotted-quad numeric format rather than

converting to the canonical host names.
-p Print a list of the peers known to the server along with the
summary of their state. This is equivalent to the -c peers option.
-s Print a list of the peers known to the server along with the summary
of their state. It has slightly different format than the -p option.
This is equivalent to -c dmpeers command.
Description:
Use the ntpdc utility to query the ntpd daemon about its current state, and to request
changes in that state. You can run this utility is run either in interactive mode or in
command mode. It provides extensive state and statistics information. At run time, all
configuration options that are specified at startup using the ntpd utility’s configuration
file can also be specified using the ntpdc utility.
When you run the ntpdc utility by including one or more requests in the command
line, each request is sent to the NTP (Network Time Protocol) servers running on each
of the hosts. If no request option is given, the ntpdc utility attempts to read
commands from the standard input and execute them on the NTP server running on the
first host, as given on the command line. If no host is mentioned, it always defaults to
localhost. The ntpdc utility prompts for commands if the standard input is a
terminal device.

ntpdc © 2010, QNX Software Systems GmbH & Co. KG.
The ntpdc utility uses NTP mode 7 packets to communicate with the NTP server, and
hence can be used to query any compatible server on the network that permits it.
However it is somewhat unreliable, especially over large distances in a network
topology. The ntpdc utility makes no attempt to retransmit requests, and times out if
the remote host’s response isn’t received within a suitable timeout time.
NTP behaves very similar to UDP (User Datagram Protocol).
You may force the DNS resolution to the IPv4 (or IPv6) namespace, if you use a -4
(or -6) option before a host name.
Interactive commands
The interactive format commands consist of a keyword followed by zero or more
arguments. You can type only enough characters to uniquely identify the command.
The output of a command is normally sent to the standard output, but you can send
output of individual commands may be sent to a file by appending a <, followed by a
file name, to the command line. A number of interactive format commands are
executed entirely within the ntpdc utility:
? [command_keyword]
help [command_keyword]
Print a list of all the command keywords for the ntpdc utility. If
you specify a command keyword, the function and the usage
information about the command are printed.
delay milliseconds
Specify a time interval. This is to be added to timestamps for
requests that require authentication.
host hostname Set the host to which future queries will be sent. The hostname
may be either a host name or a numeric address.
hostnames [yes | no]
Print the host names in the information display when yes is
specified. Print the numeric address when no is specified. The
default is yes, unless modified using the command-line -n option.
keyid keyid Set the key number to use to authenticate configuration requests.
This must correspond to a key number that the server has been
configured to.
passwd Prompt for a password, which is not echoed, and is used to

authenticate configuration requests. The password must
correspond to the key configured for the NTP server for this
purpose.
quit Exit the ntpdc utility.

timeout milliseconds
Specify a timeout period for responses to server queries. The
default is about 8000 milliseconds. Since the ntpdc utility retries
each query once after a timeout, the total waiting time for a
timeout will be twice the timeout value set.
Control message commands

When you use the ntpdc utility to query, NTP mode 7 packets containing requests are
sent to the server. These are read-only commands in that they make no modification of
the server configuration state.
listpeers Obtain and print a brief list of the peers for which the server is
maintaining the state. These should include all configured peer
associations as well as those peers whose stratum is such that they
are considered by the server to be possible future synchronization
candidates.
peers Obtain a list of peers for which the server is maintaining the state,
along with a summary of that state. Summary information includes
the address of the remote peer, the local interface address
(0.0.0.0 if a local address has yet to be determined), the stratum
of the remote peer (a stratum of 16 indicates the remote peer is
unsynchronized), the polling interval, in seconds, the register in
octal, and the current estimated delay, offset and dispersion of the
peer, all in seconds.
The character in the left margin indicates the mode this peer entry
is operating in.
This Character: Indicates:

+ Symmetric active
- Symmetric passive
= Remote server is being polled in client mode
ˆ Server is broadcasting to this address
* Server is currently synchronizing to this peer.
The contents of the host field may be one of:

• a host name
• an IP address
• a reference clock implementation name with its parameter or
REFCLK(implementation number, parameter).
If you’ve specified no, only IP-addresses are displayed.

dmpeers Obtain peer summary list, identical to the output of the peers
command, except for the character in the leftmost column.
Characters appear only beside peers that were included in the final
stage of the clock selection algorithm. A . indicates that this peer
was cast off in the falseticker detection, while a + indicates that the
peer made it through. A * denotes the peer the server is currently
synchronizing with.
showpeer peer_address [...]

Show a detailed display of the current peer variables for one or
more peers. Most of these values are described in the NTP version
2 specification.
pstats peer_address [...]
Show per-peer statistic counters associated with the specified peers.
clockinfo clock_peer_address [...]

Obtain and print information concerning a peer clock. The values
obtained provide information on the setting of fudge factors and
other clock performance information.
kerninfo Obtain and print kernel phase-lock loop operating parameters. This
information is available only if the kernel has been specially
modified for a precision timekeeping function.
loopinfo [oneline | multiline]

Print the values of selected loop filter variables. The loop filter is
the part of NTP that deals with adjusting the local system clock.
The offset is the last offset given to the loop filter by the
packet-processing code. The frequency is the frequency error of the
local clock in parts-per-million (ppm). The time_const controls the
stiffness of the phase-lock loop and thus the speed at which it can
adapt to oscillator drift. The watchdog timer value is the number of
seconds which have elapsed since the last sample offset was given
to the loop filter. The oneline and multiline options specify
the format in which this information is to be printed, with
multiline as the default.
sysinfo Print a variety of system state variables, i.e., state related to the
local server. All except the last four lines are described in the NTP
Version 3 specification, RFC 1305.
The system flags show various system flags, some of which can be
set and cleared by the enable and disable configuration
commands, respectively. These are the auth, bclient, monitor,
pll, pps and stats flags. See the ntpd documentation for the
meaning of these flags.

There are two additional flags which are read only, the
kernel_pll and kernel_pps. These flags indicate the
synchronization status when the precision time kernel
modifications are in use. The kernel_pll indicates that the local
clock is being disciplined by the kernel, while the kernel_pps
indicates the kernel discipline is provided by the PPS signal.
The stability is the residual frequency error remaining after the
system frequency correction is applied and is intended for
maintenance and debugging. In QNX Neutrino, this value will
initially decrease from as high as 500 ppm to a nominal value in the
range .01 to 0.1 ppm. If it remains high for some time after starting
the daemon, something may be wrong with the local clock, or the
value of the kernel variable tick may be incorrect. The
broadcastdelay shows the default broadcast delay, as set by the
broadcastdelay configuration command. The authdelay
shows the default authentication delay, as set by the authdelay
sysstats Print statistic counters maintained in the protocol module.
memstats Print statistic counters related to memory-allocation code.
iostats Print statistic counters maintained in the input-output module.
timerstats Print statistic counters maintained in the timer/event queue support

code.
reslist Obtain and print the server’s restriction list. This list is (usually)
printed in sorted order and may help to understand how the
restrictions are applied.
monlist [version]
Obtain and print traffic counts collected and maintained by the
monitor facility. You don’t normally have to specify the version
number.
clkbug clock_peer_address [...]
Obtain debugging information for a reference clock driver. This
information is provided only by some clock drivers and is mostly
undecodable without a copy of the driver source in hand.
Runtime configuration requests

With the help of a configured NTP key, the server authenticates all requests.
Authenticated requests always include a timestamp in the packet data, which is
included in the computation of the authentication code. This timestamp is compared
by the server to its receive timestamp. If they differ by more than a small amount, the
request is rejected. The following commands all make authenticated requests:

addpeer peer_address [keyid] [version] [prefer]

Add a configured peer association at the given address and operating
in symmetric active mode. Note that an existing association with the
same peer may be deleted when this command is executed, or may
simply be converted to conform to the new configuration, as
appropriate.
If the optional keyid is a nonzero integer, all outgoing packets to the
remote server will have an authentication field attached encrypted
with this key. If the value is 0 (or not given) no authentication will be
done. The version number can be 1, 2 or 3, and defaults to 3. The
prefer keyword indicates a preferred peer (and thus will be used
primarily for clock synchronization if possible). The preferred peer
also determines the validity of the PPS signal; if the preferred peer is
suitable for synchronization, so is the PPS signal.
addserver peer_address [keyid] [version] [prefer]

Identical to the addpeer command, except that the operating mode is
client.
broadcast peer_address [keyid] [version] [prefer]
Identical to the addpeer command, except that the operating mode is
broadcast. In this case, a valid key identifier and key are required. The
peer_address parameter can be the broadcast address of the local
network or a multicast group address assigned to NTP. If a multicast
address, a multicast-capable kernel is required.
unconfig peer_address [...]

This command causes the configured bit to be removed from the
specified peer(s). In many cases, this causes the peer association to be
deleted. When appropriate, however, the association may persist in an
unconfigured mode if the remote peer is willing to continue in this
fashion.
fudge peer_address [time1] [time2] [stratum] [refid]
This command provides a way to set certain data for a reference clock.
enable [auth | bclient | calibrate | kernel | monitor | ntp | pps |
stats]
disable [auth | bclient | calibrate | kernel | monitor | ntp | pps |
stats]
These commands operate in the same way as the enable and
disable configuration file commands of ntpd.
restrict address mask flag [flag]

This command operates in the same way as the restrict configuration
file commands of the ntpd utility.

unrestrict address mask flag [flag]

Unrestrict the matching entry from the restriction list.
delrestrict address mask [ntpport]

Delete the matching entry from the restriction list.
readkeys Purge the current set of authentication keys and obtain a new set by
rereading the keys file (which must have been specified in the ntpd
configuration file). This allows encryption keys to be changed without
restarting the server.
trustedkey keyid [...]

untrustedkey keyid [...]
These commands operate in the same way as the trustedkey and
untrustedkey configuration file commands of ntpd.
authinfo Return information concerning the authentication module, including

known keys and counts of encryptions and decryptions that have been
done.
traps Display the traps set in the server.
addtrap [address [port] [interface]

Set a trap for asynchronous messages.
clrtrap [address [port] [interface]

Clear a trap for asynchronous messages.
reset Clear the statistics counters in various modules of the server.
Caveats:
The ntpdc utility is a crude hack. It is designed so that new (and temporary) features
were easy to hack in, at great expense to the program’s ease of use. Despite this, the
program is occasionally useful.
See also:
ntpd, ntpdate, ntpq, ntptrace

ntpq © 2010, QNX Software Systems GmbH & Co. KG.
Monitor the NTP daemon and determine its performance
Syntax:
ntpq [-46dinp] [-c command] [host] [...]
Runs on:
Neutrino
Options:
-c command Execute the given command on the specified hosts. You can use
multiple -c options.
-d Turn on the debugging mode.
-i Force ntpq to operate in interactive mode. Prompts are written to

the standard output and commands are read from the standard input.
-n Print all host addresses in dotted-quad numeric format rather than

converting them to the canonical host names.
-p Print a list of peers known to the server, and a summary of their

state. This is equivalent to the peers interactive command.
Description:
The ntpq utility monitors the ntpd daemon operations and determines its
performance. It uses the standard NTP mode 6 control message formats defined in
Appendix B of the NTPv3 specification RFC 1305. The same formats are also used
for NTPv4 specification, which has more variables, and are discussed here.
You can run this utility either in interactive mode or in command mode. Command
mode is controlled using command-line arguments. You can use both raw and
pretty-printed options when assembling requests to read or write. You can also obtain
and print a list of peers in a common format by sending multiple queries to the server.
When you run the ntpq utility by including one or more requests in the command
line, each request is sent to the NTP servers running on each of the hosts. If no request
option is given, ntpq attempts to read commands from the standard input and execute
them on the NTP server running on the first host, as given on the command line. If no
host is mentioned, it always defaults to localhost. The ntpq utility prompts for
commands if the standard input is a terminal device.
The ntpq utility uses NTP mode 6 packets to communicate with the NTP server, and
hence can be used to query any compatible server on the network that permits it.
However it is somewhat unreliable, especially over large distances in a network

© 2010, QNX Software Systems GmbH & Co. KG. ntpq
topology. The ntpq utility makes only one attempt to retransmit requests, and times
out if the remote host’s response isn’t received within a suitable timeout time.
NTP behaves very similar to UDP (User Datagram Protocol).
In contexts where a host name is expected, a -4 qualifier preceding the host name
forces DNS resolution to the IPv4 namespace, while a -6 qualifier forces DNS
resolution to the IPv6 namespace.
Specifying a command line option other than -i or -n causes the specified queries to
be sent to the indicated host(s) immediately. Otherwise, ntpq attempts to read
interactive format commands from the standard input.
Internal commands
The interactive format commands consist of a keyword followed by zero or more
arguments. You can type only enough characters to uniquely identify the command.
The output of a command is normally sent to the standard output, but you can send the
output to a file by appending a <, followed by a file name, to the command line. A
number of interactive format commands are executed entirely within the ntpq utility:
? [command_keyword]
helpl [command_keyword]
Print a list of all the command keywords for ntpq utility. If you
specify a command keyword, the function followed by a
command keyword, the function and the usage information about
the command are printed.
addvars variable_name [ = value] [...]

rmvars variable_name [...]
clearvars
Allow variables and their optional values to be added to the list
maintained internally by ntpq. If more than one variable is to be
added, the list should be comma-separated and shouldn’t contain
white space. You can use the rmvars command to remove
individual variables from the list. The clearlist command
removes all variables from the list.
cooked Cause the output from query commands to be “cooked,” i.e. it

reformats the values of the variables for useful purposes. The
ntpq utility marks those variables that aren’t decodable with a
trailing ?.
debug more | less | off

Turn debugging on and off.

delay milliseconds
Specify a time interval. This is to be added to timestamps for
requests that require authentication.
host hostname Set the host to which to send future queries. The hostname may
be either a host name or a numeric address.
hostnames [yes | no]
Print the host names in the information display when yes is
specified. Print the numeric address when no is specified. The
default is yes, unless modified using the command-line -n
option.
keyid keyid Specify the key number to use to authenticate configuration

requests. This must correspond to a key number that the server
has been configured to.
ntpversion 1 | 2 | 3 | 4
Set the NTP version number that the ntpq utility claims in
packets. The default value is 3. Mode 6 control messages (and
modes, for that matter) didn’t exist in NTP version 1.
passwd Prompt for a password, which isn’t echoed, to use to authenticate

configuration requests. The password must correspond to the key
configured for NTP server for this purpose.
quit Exit the ntpq utility.
raw Cause all output from query commands to be printed as received

from the remote server. The only formatting/interpretation done
on the data is to transform non-ASCII data into a printable (but
barely understandable) form.
timeout millseconds
Specify a timeout period for responses to server queries. The
default is about 5000 milliseconds. Since the ntpq utility retries
each query once after a timeout, the total waiting time for a
timeout will be twice the timeout value set.
Control message commands

A 16-bit (integer) association identifier is associated with an NTP server. When NTP
control messages are sent, this association identifier is always included to identify
peers. An association identifier of 0 has special meaning; it indicates that the
variables are system variables, whose names are drawn from a separate name space.
Control message commands result in one or more NTP mode 6 messages, which are
sent to the server, and data returned is always printed in some format. You will find
that most commands send a single message and expect a single response. The current

exceptions are the peers command, which sends a preprogrammed series of messages
to obtain the required data, and the mreadlist and mreadvar commands, which
iterate over a range of associations.
associations Obtain and print a list of association identifiers and status for
in-spec peers of the NTP servers you query. The list is printed
in columns. The first column is an index, numbering the
associations from 1 for internal use, the second column is the
actual association identifier returned by the server, and the third
column is the status word for the peer. The following columns
contain data decoded from the status word.
The data returned by the associations command is cached
internally in the ntpq utility. The index is useful when you
deal with some servers that have association identifiers which
are hard for humans to type. For any subsequent command that
requires an association identifier as an argument, you can use
the form and the index as an alternative.
clockvar [assocID] [variable_name [ = value [...]] [...]
cv [assocID] [variable_name [ = value [...] ][...]
Request to send a list of the server’s clock variables. Servers
that have radio clock or other external synchronization
mechanism respond positively to this. If the association
identifier is omitted or zero, the request for the variables of the
system clock gets a positive response from all servers with a
clock. If the server treats clocks as pseudo-peers, and has more
than one clock connected, referencing the appropriate peer
association identifier show the variables of a particular clock.
Omitting the variable list causes the server to return a default
variable display.
lassociations Obtain and print a list of association identifiers and status of the
peers for which the server is maintaining state. This
command differs from the associations command only for
servers that retain state for out-of-spec client associations. Such
associations are normally omitted from the display when the
associations command is used, but are included in the
output of lassociations.
lpassociations Print data for all associations, including out-of-spec client

associations, from the internally cached list of associations.
This command differs from passociations.
lpeers Print a summary of all associations for which the server is

maintaining the state. This produces a much longer list of
peers.

mreadlist assocID assocID

mrl assocID assocID
Behave like the readlist command, except the query is done
for each of a range of (nonzero) association identifiers. This
range is determined from the association list cached by the
most recent associations command.
mreadvar assocID assocID [variable_name[ = value[ ... ]
mrv assocID assocID [ variable_name [= value[ ... ]
Behave like the readvar command, except the query is done
for each of a range of (nonzero) association identifiers. This
range is determined from the association list cached by the
most recent associations command.
opeers An old form of the peers command with the reference
identifier replaced by the local interface address.
passociations Display association data concerning in-spec peers from the
internally cached list of associations. This command performs
identically to the associations command, except that it
displays the internally stored data rather than making a new
query.
peers Obtain a current list of the peers, along with the state summary.
Summary information includes the address of the remote peer,
the reference identifier (0.0.0.0 if this is unknown), the
stratum of the remote peer, and the type of the peer (local,
unicast, multicast or broadcast). It also includes the polling
interval in seconds, the register in octal, and the current
estimated delay, offset, and dispersion of the peer, all in
milliseconds. The character at the left margin of each line
shows the synchronization status of the association and is a
valuable diagnostic tool. The encoding and meaning of this
character, called the tally code, is given later in this page.
pstatus assocID Send a read-status request to the server for the given
association. Print the names and values of the peer variables
that are returned. Note that the status word from the header is
displayed preceding the variables, both in hexadecimal and in
pidgin English.
readlist [assocID]
rl [assocID]
Request to return the variables in the internal variable list of the
server. When the association identifier is omitted or 0, the
variables are treated either as system variables, or peer
variables. If the internal variable list is empty, a request is sent
without data that induces the remote server to return a default
display.

readvar assocID variable_name [=value] [...]

rv assocID [variable_name [= value ] [...]
Request to return the values of the specified variables by
sending a read variables request. If the association identifier is
omitted or 0, the variables are treated either as system variables
or peer variables that are returned of the corresponding peer.
Omitting the variable list sends a request with no data, which
induces the server to return a default display. The encoding and
meaning of the variables derived from NTPv3 are given in RFC
1305; the encoding and meaning of the additional NTPv4
variables are given later in this page.
writevar assocID variable_name [=value[ ...]
Write the specified variables. Behave like the readvar request
command.
writelist [assocID]
Write the internal list of variables. Behave like the readlist
request command.
Tally codes
The character in the left margin of the peers billboard, called the tally code, shows
the fate of each association in the clock selection process. Following is a list of these
characters, for which the peer is:
space reject Discarded as unreachable, synchronized to this server (synch

loop) or outrageous synchronization distance.
x falsetick Discarded by the intersection algorithm as a falseticker.
. excess Discarded as not among the first ten peers sorted by
synchronization distance, and probably a poor candidate for
further consideration.
- outlyer Discarded by the clustering algorithm as an outlyer.
# candidat A survivor, and a candidate for the combining algorithm.
selected A survivor, but not among the first six peers sorted by
synchronization distance. If the association is ephemeral, it may
be demobilized to conserve resources.
* sys.peer Declared as the system peer and lends its variables to the system
variables.
o pps.peer Declared as the system peer and lends its variables to the system
variables. The actual system synchronization is derived from a
pulse-per-second (PPS) signal, either indirectly via the PPS
reference clock driver or directly via the kernel interface.

System variables
The status, leap, stratum, precision, rootdelay, rootdispersion, refid, reftime, poll,
offset, and frequency variables are described in RFC 1305 specification. Additional
NTPv4 system variables include:
version Software version and generation time.
processor Processor and kernel identification string.
system Operating system version and release identifier.
state State of the clock discipline state machine. The values are described
in the architecture briefing on the NTP project page linked from
www.ntp.org.
peer Internal integer used to identify the association currently designated

as the system peer.
jitter Estimated time error of the system clock measured as an exponential

average of RMS time differences.
stability Estimated frequency stability of the system clock measured as an

exponential average of RMS frequency differences.
Additional system variables are displayed when the NTPv4 daemon
is compiled with the OpenSSL software library.
flags Current flags word bits and message digest algorithm identifier
(NID) in hexadecimal format. The high-order 16 bits of the four-byte
word contain the NID from the OpenSSL library, while the
low-order bits are interpreted as follows:
0x01 Autokey enabled

0x02 NIST leapseconds file loaded
0x10 PC identity scheme
0x20 IFF identity scheme
0x40 GQ identity scheme.
hostname Host name as returned by gethostname().
hostkey NTP filestamp of the host key file.
cert A list of certificates held by the host. Each entry includes the subject,
issuer, flags and NTP filestamp in order. The bits are interpreted as
follows, where the certificate:
0x01 Has been signed by the server.

0x02 Is trusted.

0x04 Is private.
0x08 Contains errors and shouldn’t be trusted.
leapseconds NTP filestamp of the NIST leapseconds file.
refresh NTP timestamp when the host public cryptographic values are
refreshed and signed.
signature Host digest/signature scheme name from the OpenSSL library.
tai TAI-UTC offset in seconds obtained from the NIST leapseconds

table.
Peer variables
The status, srcadr, srcport, dstadr, dstport, leap, stratum, precision, rootdelay,
rootdispersion, readh, hmode, pmode, hpoll, ppoll, offset, delay, dspersion, and reftime
variables are described in the RFC 1305 specification, as are the timestamps org, rec
and xmt. Additional NTPv4 peer variables include:
flash Flash code for the most recent packet received. The encoding and
meaning of these codes is given below.
jitter Estimated time error of the peer clock measured as an exponential

average of RMS time differences.
unreach Value of the counter which records the number of poll intervals since the
last valid packet was received.
When the NTPv4 daemon is compiled with the OpenSSL software library, additional
peer variables are displayed, as follows:
flags Current flag bits. This word is the server host status word with
additional bits used by the Autokey state machine.
hostname Server host name.
initkey Initial key used by the key list generator in the Autokey protocol.
initsequence Initial index used by the key list generator in the Autokey protocol.
signature Server message digest/signature scheme name from the OpenSSL

software library.
timestamp NTP timestamp when the last Autokey key list was generated and
signed.

Flash codes
Use the flash code to debug. It is displayed in the peer variables list and shows the
results of the original sanity checks defined in the NTP specification RFC 1305 and
additional ones added in NTPv4. There are 12 tests, designated as TEST1 through
TEST12, that perform in a certain order designed to gain maximum diagnostic
information while protecting against accidental or malicious errors. The flash variable
is initialized to zero as each packet is received. If, after each set of tests, one or more
bits are set, the packet is discarded. Use these tests for the following tasks:
TEST1 through TEST3

Check the packet timestamps from which the offset and delay are
calculated. If any bits are set, the packet is discarded; otherwise, the
packet header variables are saved.
TEST4 and TEST5

Use for access control and cryptographic authentication. If any bits are
set, the packet is discarded immediately and nothing is changed.
TEST6 through TEST8

Check the health of the server. If any bits are set, the packet is discarded;
otherwise, the offset and delay relative to the server are calculated and
saved.
TEST9 Check the health of the association itself. If any bits are set, the packet is
discarded. Otherwise, the saved variables are passed to the clock filter and
mitigation algorithms.
TEST10 through TEST12

Check the authentication state using Autokey public-key cryptography. If
any bits are set and the association has previously been marked reachable,
the packet is discarded; otherwise, the originate and receive timestamps
are saved, as required by the NTP protocol, and processing continues.
The flash bits for each test are defined as follows:
0x001 TEST1 Duplicate packet. The packet is at best a casual retransmission

and at worst a malicious reply.
0x002 TEST2 Bogus packet. The packet is not a reply to a message previously
sent. This can happen when the NTP daemon is restarted before
somebody else notices.
0x004 TEST3 Unsynchronized. One or more timestamp fields are invalid. This
normally happens when the first packet from a peer is received.
0x008 TEST4 Access is denied.

0x010 TEST5 Failure of cryptographic authentication.
0x020TEST6 Server is unsynchronized. Wind up its clock first.
0x040 TEST7 Server stratum is at the maximum of 15. It is probably

unsynchronized and its clock needs to be wound up.
0x080 TEST8 Root delay or dispersion is greater than one second, which is
highly unlikely unless the peer is unsynchronized.
0x100 TEST9 Peer delay or dispersion is greater than one second, which is
highly unlikely.
0x200 TEST10 Autokey protocol has detected an authentication failure.
0x400 TEST11 Autokey protocol has not verified the server or peer.
0x800 TEST12 A protocol or configuration error has occurred in the public key
algorithms or a possible intrusion event has been detected.
Caveats:
The peers command is nonatomic and may occasionally result in spurious error
messages about invalid associations. Also, you wait a long time for timeouts, because
the timeout time is a fixed constant, and it assumes the worst-case scenario. In
addition, the program doesn’t estimate timeout as it sends queries to a particular host.
See also:
ntpd, ntpdate, ntpdc, ntptrace

ntptrace © 2010, QNX Software Systems GmbH & Co. KG.
Trace a chain of NTP servers
Syntax:
ntptrace [-dnv] [-r retries] [-t timeout] [server]
Runs on:
Neutrino
Options:
-d Turn on debugging output.
-n Print only the host IP addresses, not the host names.
-r retries Set the number of retransmission attempts for each host. The default
value is 5.
-t timeout Set the value of retransmission timeout in seconds. The default value
is 2.
-v Print verbose information about the NTP servers.
Description:
The ntptrace utility determines the source of time for the NTP (Network Time
Protocol) servers. It follows the chain of NTP servers back to their master time source.
If you don’t specify a server, it starts with the localhost.
$ ntptrace
Here’s an example of the diagonistic output from the ntptrace utility:

localhost: stratum 4, offset 0.0019529, synch distance 0.144135
server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784
usndh.edu: stratum 1, offset 0.0019298, synch distance 0.011993, refid ’WWVB’
On each line, the fields are printed from left to right: the host name, the host stratum,
the time offset between that host and the local host, the host synchronization distance,
and the reference clock ID. Note that all times are expressed in seconds, and the time
offset mentioned is not always zero. The stratum is the server hop count to the primary
source, while the synchronization distance is the estimated error relative to the primary
source. These terms are precisely defined in RFC 1305.
Caveats:
The ntptrace utility can’t improve accuracy by doing multiple samples.

© 2010, QNX Software Systems GmbH & Co. KG. ntptrace
See also:
ntpd, ntpdate, ntpdc, ntpq
Based on RFC 1305

objcopy © 2010, QNX Software Systems GmbH & Co. KG.
Copy the contents of one object file to another (GNU)
Syntax:
objcopy_variant [options] infile [outfile]
Runs on:
Options:
The objcopy_variant depends on the target platform, as follows:
Target platform: objcopy_variant:

ARM ntoarm-objcopy
MIPS ntomips-objcopy
PowerPC ntoppc-objcopy
SH4 ntosh-objcopy
x86 ntox86-objcopy
Description:
The GNU objcopy utility copies the contents of one object file, infile, to another,
outfile. The objcopy utility uses the GNU BFD Library to read and write the object
files. It can write the destination object file in a format different from that of the source
object file. The exact behavior of objcopy is controlled by command-line options.
GNU
See also:
mcs, objdump

© 2010, QNX Software Systems GmbH & Co. KG. objdump
Display information about one or more object files (GNU)
Syntax:
objdump_variant [options] objfile...
Runs on:
Options:
The objdump_variant depends on the target platform, as follows:
Target platform: objdump_variant:

ARM ntoarm-objdump
MIPS ntomips-objdump
PowerPC ntoppc-objdump
SH4 ntosh-objdump
x86 ntox86-objdump
Description:
The objdump utility displays information about one or more object files. The options
control what particular information to display. The objfile. . . arguments identify the
object files to be examined. When you specify archives, objdump shows information
on each of the member object files.
GNU
See also:
ldd, mcs, objcopy

od © 2010, QNX Software Systems GmbH & Co. KG.
Dump a file in various formats (POSIX)
Syntax:
od [-v] [-A format] [-t fmtstr] [-N count]
[-j skip] [file]...
Runs on:
Options:
-A format Display the file offset field in one of the following formats:
• d — decimal, 9 digits
• n — none (omit this field)
• o — octal, 10 digits
• x — hexadecimal, 7 digits.
The default is o.
-j skip Ignore the first skip bytes of data. You can add a trailing character to
-N count Display only count bytes of input. You can add a trailing character to
-t format Display data field using this format specification; see “Output formats,”
below.
The default format is oS.
-v Be verbose. If you don’t specify the -v option, od folds multiple

identical lines into a single line that contains an asterisk (*).
file The pathname of an input file. If you don’t specify any files, od reads
from standard input.
Description:
Use the od utility to display a file in various forms, including decimal, hex, octal, and
ASCII. The name “od” (octal dump) is derived from the default output format.
The od utility processes input in 16-byte units that are formatted into a line. In the
default output format:
• the file offset field is displayed in octal, 10 digits
• a space separates the file offset field from the data
• the data is displayed as four space-separated objects in octal
For example:

© 2010, QNX Software Systems GmbH & Co. KG. od
$ echo "abcdefghijklmnopqrstuvwxyz01234" | od
0000000000 14430661141 15031663145 15432665151 16033667155
0000000020 16434671161 17035673165 06114075171 01215031462
0000000040
To exclude part of the input, use the -N and -j options. You can specify the arguments
to these options in hex (using a 0x prefix) or octal (using a 0 prefix). The default units
for these options are bytes, but you can specify different units as follows:
To specify: Add this suffix:

Blocks (512 bytes) b
Kilobytes (1024 bytes) k
Megabytes (1048576 bytes) m
Output formats
To specify the output format, use the -t option. The format argument — which you
can specify in decimal, hex, or octal — tells od which format to use for presenting the
output:
a Named characters. Display printable characters as themselves,

and nonprintable characters as a single dot (.).
c Characters. Display printable characters as themselves; display all

other characters as 2-digit hex values, except for the following:
ASCII mnemonic Value Representation

NUL 00 \0
<alert> 07 \a
<backspace> 08 \b
<tab> 09 \t
<newline> 0a \n
<vertical tab> 0b \v
<formfeed> 0c \f
<carriage return> 0d \r
d[1|2|4|C|S|I|L]
Decimal, in objects the size of an int by default.
f[4|8|F|D|L] Floating point, in objects the size of an float by default.

od © 2010, QNX Software Systems GmbH & Co. KG.
o[1|2|4|C|S|I|L]
Octal, in objects the size of an int by default.
u[1|2|4|C|S|I|L]
Unsigned decimal, in objects the size of an int by default.
x[1|2|4|C|S|I|L]
Hexadecimal, in objects the size of an int by default.
The input, processed in 16-byte units formatted into a line, is displayed according to
the size you choose:
To display input as: Choose:

Sixteen 1-byte objects 1
Eight 2-byte objects 2
Four 4-byte values per line 4
Two 8-byte values per line 8
char C
double D
float F
int I
long or long double (depending on the format) L
short S
Examples:
Display the second to eleventh sectors of the hard disk, /dev/hd0:
od -j 1b -N 10b /dev/hd0
Exit status:
See also:
hd

© 2010, QNX Software Systems GmbH & Co. KG. omshell
Connect, query, and change ISC DHCP server’s state
Syntax:
omshell
Runs on:
Neutrino
Options:
See the subcommands below.
Description:
The omshell utility is a command shell that provides an interactive way to connect,
query, and possibly change, the ISC DHCP Server’s state via OMAPI, the Object
Management API. By using OMAPI and omshell, you don’t have to stop, make
changes, and then restart the DHCP server; you can make the changes while the server
is running. The omshell utility provides a way of accessing OMAPI.
OMAPI is simply a communications mechanism that lets you manipulate objects. To
actually use omshell, you must understand what objects are available and how to use
them.
Documentation for OMAPI objects can be found in the description for servers that
provide them (e.g. in the documentation for dhcpd).
Opening a connection
The omshell utility is started from the command line with several commands that can
be issued:
server address The IP address of the DHCP server to connect to. The default
server is 127.0.0.1 (localhost).
port number The Port that OMAPI listens on. By default, this is 7911.
key name secret This specifies the TSIG key to use to authenticate the OMAPI
transactions. The argument name is the name of a key defined in
dhcpd.conf.
new object-type The object-type is one of group, host, or lease.

At this point, you now have an object that you can set properties
on. For example, if a new lease object was created with new
lease, any of a lease’s attributes can be set as follows:
set attribute-name = value

Attribute names are defined in dhcpd. Values should be quoted
if they are strings. So, to set a lease’s IP address, you would do
the following:

omshell © 2010, QNX Software Systems GmbH & Co. KG.
set ip-address = 192.168.4.50
Associating local and remote objects

You can use the open command to query the server for information about this lease.
open Now, the local lease object you created and set the IP address for is
associated with the corresponding lease object on the DHCP server. All of
the lease attributes from the DHCP server are also the attributes on the local
object, and are shown in omshell.
Viewing a remote object

To query a lease of address 192.168.4.50 and find out its attributes, after connecting
to the server, issue these commands:
new lease
This creates a new local lease object.
set ip-address = 192.168.4.50

This sets the local object’s IP address to 192.168.4.50
open
Now, if a lease with that IP address exists, you’ll see all the information the DHCP
server has about that particular lease. Any data that isn’t readily printable text will
show up in colon-separated hexadecimal values. In this example, the server’s output
for the entire transaction might look like this:
> new "lease"

obj: lease
> set ip-address = 192.168.4.50
obj: lease
ip-address = c0:a8:04:32
> open
obj: lease
As you can see here, the IP address is represented in hexadecimal, as are the starting
and end times of the lease.
Modifying a remote object

You can update attributes of remote objects by using the set command as before, and
then an update command. The set command sets the attributes on the current local
object; and the update command pushes those changes out to the server.
Continuing with the previous example, if a set client-hostname =
something-else is issued, followed by an update command, the output would
look like this:

> set client-hostname = "something-else"
obj: lease
state = 00:00:00:02
dhcp-client-identifier = 01:00:10:a4:b2:36:2c
client-hostname = "something-else"
subnet = 00:00:00:06
pool = 00:00:00:07
hardware-address = 00:10:a4:b2:36:2c
hardware-type = 00:00:00:01
ends = dc:d9:0d:3b
starts = 5c:9f:04:3b
tstp = 00:00:00:00
tsfp = 00:00:00:00
cltt = 00:00:00:00
<
> update
obj: lease
state = 00:00:00:02
dhcp-client-identifier = 01:00:10:a4:b2:36:2c
client-hostname = "something-else"
subnet = 00:00:00:06
pool = 00:00:00:07
hardware-address = 00:10:a4:b2:36:2c
ends = dc:d9:0d:3b
starts = 5c:9f:04:3b
tstp = 00:00:00:00
tsfp = 00:00:00:00
cltt = 00:00:00:00
New remote objects

You create new objects much in the same way as you modify existing server objects.
Create a local object using new, set the attributes as you wish them to be, and then
create the remote object with the same properties:
create
name = "some-host"
hardware-address = 00:80:c7:84:b1:94
> set hardware-type = 1
obj: host
name = "some-host"
hardware-type = 1
> set ip-address = 192.168.4.40
obj: host
name = "some-host"
hardware-type = 1
> create
obj: host

omshell © 2010, QNX Software Systems GmbH & Co. KG.
name = "some-host"
>
Your dhcpd.leases file would then have an entry like this in it:
host some-host {
dynamic;
hardware ethernet 00:80:c7:84:b1:94;
fixed-address 192.168.4.40;
}
The dynamic; line is to denote that this host entry didn’t come from dhcpd.conf,
but was created dynamically via OMAPI.
Resetting attributes
If you want to remove an attribute from an object, you can do this with the unset
command. Once you have unset an attribute, you must use the update command to
update the remote object. So, if the host somehost from the previous example
wouldn’t have a static IP address any more, the commands in omshell would look
like this:
obj: host
name = "some-host"
> unset ip-address
obj: host
name = "some-host"
ip-address = <null>
>
name = "some-host"
> remove
obj: <null>
>

In order to use the OMAPI interface, you must have the following line in your
dhcpd.conf to specify a port:
omapi-port 7911;
where 7911 is the default used by dhcpctl() library.
See also:
dhcpd, dhcp.client

on © 2010, QNX Software Systems GmbH & Co. KG.
Execute a command on another node or tty (QNX Neutrino)
Syntax:
on [-C cpunum] [-d] [-h] [-n|f nodename] [-P]
[-p priority[policy]] [-R runmask] [-s]
[-t tty] [-u user | -l user_name] [-W nsec]
[-w device] [-Xsched_command] [command [args]]
Runs on:
Neutrino
Options:
-C cpunum (QNX Neutrino Core OS 6.3.2 or later) Set the CPU affinity to
cpunum, where the first CPU is 0. You can use this option
multiple times. For more information, see “Setting the
runmask,” below.
-d Detach command from its parent (i.e. sever the parent/child

relationship). This is useful for remotely created processes that
never exit and that the shell therefore doesn’t need to wait for.
Unless this option is specified, a network connection is created
connecting the parent to the child.
-f nodename Spawn from the remote node using the remote node’s / as
prefix root (i.e. search for the executable on the remote node).
In contrast, the -n option searches for the executable on the
local node.
-h Start command in a HELD state. This option is useful for

starting up programs with the intention of debugging them.
You can also start up several commands in the HELD state,
then send them all a signal to start — they’ll all start at almost
the exact same time, since their load times will have been
eliminated.
-l user_name (“el”) Login as the given user. This option is similar to the -u
option, but also sets the LOGNAME, HOME, and SHELL
environment variables, sets the umask to 022, and changes to
the directory specified for the user in the password database.
-n nodename Execute command (as found on the local node) on the remote
nodename. In contrast, the -f option searches for the
executable on the remote node.
-P (QNX Neutrino 6.4.0 or later) Spawn the process, setting the

SPAWN_PADDR64_SAFE flag to indicate that the process is
known to operate safely with 64-bit addressing or doesn’t care
about the physical memory location.

© 2010, QNX Software Systems GmbH & Co. KG. on
-p priority[policy] Execute the command at the specified priority, optionally

changing the scheduling policy.
Priorities are in the range from 0 through 255. Priority 0 is
used for the idle thread; by default, priorities of 64 and greater
are privileged, so only processes with an effective user ID of 0
(i.e. root) can use them. Non-root (and root) processes can
use priorities from 1 through 63.
You can change the range of privileged priorities with the -P
option for procnto.
The scheduling policy must be one of:
• f — FIFO
• r — round-robin
• s — sporadic
• o — other (currently the same as round-robin).
If you don’t specify a command, the change applies to the
parent process.
-R runmask (QNX Neutrino Core OS 6.3.2 or later) Set the CPU affinity to
runmask. You can use this option multiple times to specify
masks that are more than 32 bits long. For more information,
see “Setting the runmask,” below.
-s Spawn the command in a new process group.
-t tty Open the specified terminal name as file descriptors 0, 1, and 2

for command. The command is run in a new session with tty as
its controlling terminal. If tty doesn’t contain a slash (/),
/dev/ is added to the beginning.
-u uid[:gid[,gid,. . . ]]
-u user_name
Run as the user specified by the numeric uid, in the specified
group(s), or as the given user_name.
-W nsec The number of seconds to wait for the device specified in the
following -w option. The default is forever.
-w device Wait for a stat() on the given device to succeed before

continuing. If device doesn’t contain a slash (/), /dev/ is
added to the beginning.
You can repeat the -w and -W options on the command line. They’re processed in the
order given, before any other options.
-Xsched_cmd Launch using the specified command for an external scheduler.

The possible commands include:

on © 2010, QNX Software Systems GmbH & Co. KG.
• aps=partition_name — launch the application into the

adaptive partition with the given name. For more
information, see the Adaptive Partitioning User’s Guide.
This option was added in the QNX Neutrino Core OS 6.3.2.
command [args] The command to be executed, and any arguments to be passed

to it.
Description:
The on utility extends the process creation abilities of the shell (sh). You can start a
process on a remote node, on a different controlling terminal, in a HELD state for
debugging or later synchronized starting.
If the -d option isn’t specified, a network connection is created as a local agent for the
remote child process. When the child terminates, the parent must do a wait() on the
created connection to reap the zombie process entry for the child. If the -d option is
specified, the command is detached from its parent. The parent isn’t able to do a wait()
for the child, nor is it able to control it via signals.
By default, the command is run in the current session. The -t option starts a new
session, which means the command won’t receive a SIGHUP if the current session
leader terminates.
CAUTION: The on -t command becomes the new session leader on the tty
! specified, i.e. it receives SIGHUP generated by hangups on that tty. Any processes
originally running on that tty don’t get SIGHUP, and this condition persists even when
the process started by on has terminated. For this reason, specify only ttys that aren’t
currently in use.
Setting the runmask

On a multicore system, you can use a runmask to specify which processors a thread or
process can run on. The default is all 1s (i.e. all CPUs).
The runmask is useful only on multiprocessor systems.
You can use on to set the runmask and inherit mask for a new process; to change the
masks for threads that are already running, use slay. Both commands interpret the -C
and -R options in the same way.
You can use more than one -R option to specify a runmask that’s more than 32 bits
long. The first -R option specifies bits 0 through 31, the second specifies bits 32
through 63, and so on.
If you use both the -C and -R options or multiple instances of them, the resultant mask
is the bitwise ORing of all -C and -R options. For example, on -R 0x1 is equivalent

© 2010, QNX Software Systems GmbH & Co. KG. on
to on -C0, and on -R 0x1 -C3 is equivalent to on -C0 -C3. The on command

sets the process’s runmask and inherit mask to the same value.
For more information about runmasks, see the Multicore Processing chapter of the
System Architecture guide, and the Developing Multicore Systems chapter of the
Multicore Processing User’s Guide.
Examples:
Run login on console 2:
on -t con2 login
Run who on the node named ruth:
on -n ruth who
Run sort as an orphan on the node named peterv:
on -d -n peterv sort file.dat
Run who on node george with a new session, its standard I/O connected to console 1
on node ruth:
on -t /net/ruth/dev/con1 -n george who
Exit status:
The on utility exits with the exit status of command.
See also:
nice, sh, slay
stat() in the Library Reference
Multicore Processing chapter of the System Architecture guide, the Multicore
Processing User’s Guide
Adaptive Partitioning User’s Guide

op © 2010, QNX Software Systems GmbH & Co. KG.
Run a command as someone else
Syntax:
op command
Runs on:
QNX Neutrino
Options:
None.
Description:
The op utility was designed as an easy way to run commands as root.
CAUTION: This utility is a security hole. You have to log in as root and do the
! following in order to make it do anything:
chmod +s /usr/bin/op
You should use su instead.
See also:
login, passwd, su

© 2010, QNX Software Systems GmbH & Co. KG. openssl
Command-line tool for using the OpenSSL crypto library
Syntax:
openssl command [command_opts] [command_args]
openssl [list-standard-commands |
list-message-digest-commands |
list-cipher-commands |
list-cipher-algorithms |
list-message-digest-algorithms |
list-public-key-algorithms]
openssl no-cmd [arbitrary_options]
Runs on:
QNX Neutrino
Options:
None.
Description:
OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL
v2/v3) and Transport Layer Security (TLS v1) network protocols and related
cryptography standards that they require.
The openssl program is a command-line tool for using the various cryptography
functions of OpenSSL’s crypto library from the shell. You can use it for the following:
• creation and management of private keys, public keys and parameters
• public key cryptographic operations
• creation of X.509 certificates, CSRs and CRLs
• calculation of Message Digests
• encryption and Decryption with Ciphers
• SSL/TLS Client and Server Tests
• handling of S/MIME signed or encrypted mail
• timestamp requests, generation and verification
Command summary
The openssl program provides a rich variety of commands (command in the
synopsis above), each of which often has a wealth of options and arguments
(command_opts and command_args).

openssl © 2010, QNX Software Systems GmbH & Co. KG.
The pseudo-commands list-standard-commands,

list-message-digest-commands, and list-cipher-commands output a list
(one entry per line) of the names of all standard commands, message digest
commands, or cipher commands, respectively, that are available in the present
openssl utility.
The pseudo-commands list-cipher-algorithms and
list-message-digest-algorithms list all cipher and message digest names, one
entry per line. Aliases are listed as:
from => to
The pseudo-command list-public-key-algorithms lists all supported public
key algorithms.
The pseudo-command no-cmd tests whether a command of the specified name is
available. If no command named cmd exists, openssl returns 0 (success) and prints
no-cmd; otherwise it returns 1 and prints cmd. In both cases, the output goes to
stdout, and nothing is printed to stderr. Additional command-line arguments are
always ignored. Since for each cipher there’s a command of the same name, this
provides an easy way for shell scripts to test for the availability of ciphers in the
openssl program. (The no-cmd can’t detect pseudo-commands such as quit,
list-...-commands, or no-cmd itself.)
Standard commands
asn1parse Parse an ASN.1 sequence.
ca Certificate Authority (CA) Management.
ciphers Cipher Suite Description Determination.
crl Certificate Revocation List (CRL) Management.
crl2pkcs7 CRL to PKCS#7 Conversion.
dgst Message Digest Calculation.
dh Diffie-Hellman Parameter Management; rendered obsolete by

dhparam.
dsa DSA Data Management.
dsaparam DSA Parameter Generation and Management. Superseded by

genpkey and pkeyparam.
enc Encoding with Ciphers.
errstr Error Number to Error String Conversion.
dhparam Generation and Management of Diffie-Hellman Parameters.

Superseded by genpkey and pkeyparam.

gendh Generation of Diffie-Hellman Parameters; rendered obsolete by

dhparam.
gendsa Generation of DSA Private Key from Parameters. Superseded by

genpkey and pkey.
genpkey Generation of Private Key or Parameters.
genrsa Generation of RSA Private Key. Superseded by genpkey.
ocsp Online Certificate Status Protocol utility.
passwd Generation of hashed passwords.
pkcs12 PKCS#12 Data Management.
pkcs7 PKCS#7 Data Management.
pkey Public and private key management.
pkeyutl Public key algorithm cryptographic operation utility.
pkeyparam Public key algorithm parameter management.
rand Generate pseudo-random bytes.
req PKCS#10 X.509 Certificate Signing Request (CSR) Management.
rsa RSA key management.
rsautl RSA utility for signing, verification, encryption, and decryption.

Superseded by pkeyutl.
s_client This implements a generic SSL/TLS client that can establish a

transparent connection to a remote server speaking SSL/TLS. It’s
intended for testing purposes only and provides only rudimentary
interface functionality but internally uses mostly all functionality of
the OpenSSL ssl library.
s_server This implements a generic SSL/TLS server that accepts connections

from remote clients speaking SSL/TLS. It’s intended for testing
purposes only and provides only rudimentary interface functionality
but internally uses mostly all functionality of the OpenSSL ssl
library. It provides both its own command-line-oriented protocol for
testing SSL functions and a simple HTTP response facility to emulate
an SSL/TLS-aware webserver.
s_time SSL Connection Timer.
sess_id SSL Session Data Management.
smime S/MIME mail processing.
speed Algorithm Speed Measurement.

openssl © 2010, QNX Software Systems GmbH & Co. KG.
ts Time Stamping Authority tool (client/server).
verify X.509 Certificate Verification.
version OpenSSL Version Information.
x509 X.509 Certificate Data Management.
Message digest commands

md2 MD2 Digest.
md5 MD5 Digest.
mdc2 MDC2 Digest.
rmd160 RMD-160 Digest.
sha SHA Digest.
sha1 SHA-1 Digest.
sha224 SHA-224 Digest.
Encoding and cipher commands

base64 Base64 Encoding.
bf, bf-cbc, bf-cfb, bf-ecb, bf-ofb

Blowfish Cipher.
cast, cast-cbc CAST Cipher.
cast5-cbc, cast5-cfb, cast5-ecb, cast5-ofb

CAST5 Cipher.
des, des-cbc, des-cfb, des-ecb, des-ede, des-ede-cbc, des-ede-cfb,
des-ede-ofb, des-ofb
DES Cipher.
des3, desx, des-ede3, des-ede3-cbc, des-ede3-cfb, des-ede3-ofb

Triple-DES Cipher.
idea, idea-cbc, idea-cfb, idea-ecb, idea-ofb

IDEA Cipher.

rc2, rc2-cbc, rc2-cfb, rc2-ecb, rc2-ofb

RC2 Cipher.
rc4 RC4 Cipher.
rc5, rc5-cbc, rc5-cfb, rc5-ecb, rc5-ofb

RC5 Cipher.
Pass phrase arguments

Several commands accept password arguments, typically using -passin and
-passout for input and output passwords respectively. These allow the password to
be obtained from a variety of sources. Both of these options take a single argument
whose format is described below. If no password argument is given and a password is
required, you’re prompted to enter one: this will typically be read from the current
terminal with echoing turned off.
pass:password The actual password is password. Since the password is visible

to utilities, you should use this form only where security isn’t
important.
env:var Obtain the password from the environment variable var. Since
the environment of other processes is visible on certain
platforms, you should use this option with caution.
file:pathname The first line of pathname is the password. If you supply the
same pathname argument to -passin and -passout
arguments, the first line is used for the input password, and the
next line for the output password. The pathname need not refer
to a regular file; it could, for example, refer to a device or named
pipe.
fd:number Read the password from the given file descriptor number. You
can use this, for example, to send the data via a pipe.
stdin Read the password from standard input.
Exit status:
0 Success.

/etc/party.conf © 2010, QNX Software Systems GmbH & Co. KG.
Configuration file for SNMPv2 party definitions
Name:
/etc/party.conf
Description:
The party.conf is used to define the different parties you’ll be using for your
SNMPv2 communication.
1 /nodecfg/node_name/etc/party.conf, where node_name is the value of

the CS_NODENAME configuration string (see getconf and setconf)
2 /etc/party.conf
The file uses this format:
FriendlyName PartyID
TDomain IP-address UDP-port
authProtocol privProtocol
lifetime maxmessagesize
clock
authPrivate authPublic-length authPublic
privPrivate privPublic-length privPublic
where:
FriendlyName Unique alphanumeric readable name for the context.
PartyID Unique object identifier for the context.
TDomain Transport domain.
IP-address Address of the host using the party.
UDP-port Port that the host will be listening to.
authProtocol Authentication protocol used to authenticate the other host.
privProtocol Protocol used for packet encryption.
lifetime Decimal value.
maxmessagesize Number of octets for the largest supported PDU.
clock Decimal clock offset value.
authPrivate 32 hex digits.
authPublic-length Decimal or “Null” (if “Null,” no next field).
authPublic Hex string of 2*authPublic-length digits.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/party.conf
privPrivate 32 hex digits.
privPublic-length Decimal or “Null” (if “Null”, no next field).
privPublic Hex string of 2*privPublic-length digits.
For example:
agent_party .1.3.6.1.6.3.3.1.3.10.0.0.59.5
snmpUDPDomain 10.0.0.59 161
noAuth noPriv
300 484
29F660EA
00000000000000000000000000000000 Null
00000000000000000000000000000000 Null
The agent_party using an object identifier of

.1.3.6.1.6.3.3.1.3.10.0.0.59.5 on host 10.0.0.59 is listening to port 161.
It’s using no authentication for communication and no encryption.
If TDomain (Transport domain) doesn’t list an IP address that matches the IP address
of an interface on the host running snmpd, there’ll be no ports listed in the snmpd
output when snmpd is started.
If you see the following line with no ports listed:
Opening port(s):
the IP address listed in TDomain (the agent definition entry in /etc/party.conf)

doesn’t match the IP address of an interface on the host. You must change the agent
definition to include the IP address of the interface where you wish to listen for SNMP
requests.
See also:

passwd © 2010, QNX Software Systems GmbH & Co. KG.
Change the login password or create new user names (UNIX)
Syntax:
passwd [name]
Runs on:
Neutrino
Options:
name The username whose password is to be changed or for whom an account is
to be created (root only).
Description:
You can use the passwd utility to change your login password, and if you’re logged in
as the superuser (root), you can create a new user account.
If you’re changing your password, passwd prompts for the old password and then for
the new password. The new password must be entered twice, to avoid typing mistakes.
Only the owner or the superuser may change a password.
To create a new user account, type:
passwd new_user_name
Make sure that the user name is no longer than 14 characters; otherwise, that user
won’t be able to log in.
passwd file
When creating a new user account, passwd prompts for information, such as the
user’s group list, home directory, and shell. The /etc/default/passwd file (see
“Files,” below) specifies the default values for these prompts. You can edit this file to
modify passwd’s behavior to suit local requirements.
The /etc/passwd file contains the following fields, separated by colons:
username:has_passwd:userid:groupid:misc:home_directory:initial_command
If the has_passwd field contains an x character, a password has been defined for this
user. If no character is present, no password has been defined. Use of any other
character is reserved and may cause side-effects for the user.

© 2010, QNX Software Systems GmbH & Co. KG. passwd
The groupid field contains a group number. Users may log in under the groupid listed
in their /etc/passwd file entry without being listed as a member of that group in the
/etc/group file.
The misc field stores supplemental information, with commas separating subfields.
Usually, the first subfield contains the user’s “real life” name. Some utilities use this
information.
The initial_command field contains the initial command to run after the user has
successfully logged in. This command and any arguments it takes must be separated
by tab or space characters. As the command is spawned directly (not run by a shell),
no shell expansions is performed. There is no mechanism for specifying
command-line arguments that contain space or tab characters themselves. (Quoting
isn’t supported.)
If no initial_command is specified, /bin/sh is used.
Files:
/etc/.pwlock This file is created by passwd to indicate to other instances of
passwd that the password file is currently being modified. When
passwd finishes, the file is removed. See “Caveats,” below.
/etc/group This file defines the known groups for the system. It associates
group names with a numerical ID and a list of usernames who
are members of the group.
Entries in this file appear in the following format:
groupname:x:groupid:user[,user]...
The x represents the group password; Neutrino doesn’t support

group passwords.
/etc/passwd Contains the user account entries. The format of entries in this
file are as follows:
username:has_passwd:userid:groupid:misc:home_directory:initial_command
/etc/shadow Contains encoded versions of the actual passwords for user

accounts. The passwords themselves aren’t stored in the
/etc/passwd file.
/etc/opasswd
/etc/oshadow When passwd modifies a password file, it first locks the
password files with the /etc/.pwlock file, then copies the
contents of the current /etc/passwd and /etc/shadow files to
/etc/opasswd and /etc/oshadow, respectively. If passwd is
killed before it finishes writing the updated file, the password
files may be restored from these backup versions. See “Caveats,”
below.

passwd © 2010, QNX Software Systems GmbH & Co. KG.
/etc/default/passwd
Specifies the settings that the passwd utility uses when you
create a new user account. If you’re the system administrator,
you can edit this file. The settings include the following, shown
with the value specified by default in this file:
Setting Default Description

BASEDIR=dirname /home The base directory under which user directories are created.
SHELL=progname /bin/sh The shell to use for the login shell field in new password
entries.
UIDRANGE=low-[high] 100- The valid range of values for new user IDs. You can omit
the high component, indicating no upper bound, but you still
need the dash.
GIDRANGE=low-[high] 100- The valid range of values for group IDs. As with UIDRANGE,
you can omit the high component if there’s no upper bound.
DUPDIROK Not set. If specified, passwd lets you select an existing directory as
a new user’s home directory.
DUPUIDOK Not set. If specified, passwd lets you select an existing user ID for a
new user name. This is generally discouraged, because it
allows many user names to be mapped to one user ID.
NOPASSWORDOK NOPASSWORDOK If specified, passwd lets you set up user accounts that don’t
require a password to log in.
STRICTPASSWORD Not set. If specified, passwd requires all passwords to contain at
least two types of characters (e.g. alphabetic and
punctuation).
INSISTANT=retries 6 The number of times passwd asks non-root users if they
really want to set up their account with no password. This
variable is ignored if NOPASSWORDOK is set.
PROFILE=basename .profile The name to use for the shell’s initialization file in the user’s
home directory. The file specified by DEFPROFILE (below)
is copied there when you set up a new account.
DEFPROFILE=filename /etc/skel/.profile The path to a default shell-initialization file that’s copied to
a new user’s PROFILE when you set up the account.
QNXCRYPT Not set. If this is set, passwd uses the old QNX 4 encryption
method, instead of the default UNIX encryption method.
Caveats:
The passwd utility creates the /etc/.pwlock file during updates to the password
database. If for some reason the system crashes at an inopportune moment and leaves
this file present, passwd will refuse to work until the file is removed by the system

© 2010, QNX Software Systems GmbH & Co. KG. passwd
administrator. If the password files are somehow left in an inconsistent state as a result
of the crash, the system administrator should also copy /etc/oshadow to
/etc/shadow and copy /etc/opasswd to /etc/passwd.
See also:
login, su
crypt(), qnx_crypt() in the Library Reference

paste © 2010, QNX Software Systems GmbH & Co. KG.
Merges lines of given input files, and writes the resulting lines to standard output. (POSIX)
Syntax:
paste [-s] [-d list] file
Runs on:
Neutrino
Options:
-d list Specifies that each character in the list is an element specifying a delimiter
character. Unless a backslash character appears in list, each character in list
is an element specifying a delimiter character. If a backslash character
appears in list, the backslash character and one or more characters
following it are an element specifying a special delimiter character,
described below. These elements specify one or more delimiters to use,
instead of the default tab, to replace the newline of the input lines. If the -s
option is also specified:
• The last <newline> in a file isn’t modified.
• The delimiter is reset to the first element of the list after each file
operand is processed.
If the -s option is not specified:
• The <newline>s in the file specified by the last file operand can’t be
modified.
• The delimiter is reset to the first element of the list each time a line is
processed from each file.
When a backslash character appears in list, the backslash character and the
other characters that follow it are used to represent these delimiter
characters:
• \n represents a <newline>
• \t represents a <tab>
• \\ represents a backslash character
• \0 represents an empty string, not a NULL character. If a lower case or
upper case “x” immediately follows \0, or any character defined by the
LC_CTYPE digit keyword, the results are unspecified. For more
information, see the Base Definitions volume of IEEE Std 1003.1-2001,
Chapter 7, Locale.

© 2010, QNX Software Systems GmbH & Co. KG. paste
When the escape sequences of the list argument are used in a shell script, you must use
single quotation marks; otherwise, the shell interprets the backslash character as a
special character.
The input files must be text files.
-s Concatenates all lines of each separate input file in command line order.
Except for the last line in each input file, the <newline> of every line is
replaced with <tab>, unless otherwise specified by the -d option.
file The pathname of an input file. Specifying “-” for one or more of the files
uses the standard input, which is input read one line at a time for each
instance of “-”.
Description:
For every file you name, the paste utility pastes columns or fields from each line,
concatenates them, and writes them to the standard output.
By default, paste assumes the field delimiter character to be tab. You can use the -d
option to specify another delimiter.
Examples:
The following are examples of the list argument:
• Write out a directory in three columns:

ls | paste - - -
• Combine pairs of lines from a file into single lines:

paste -s -d "\t\n" file
Exit status:
See also:
cut, grep, pr

patch © 2010, QNX Software Systems GmbH & Co. KG.
Use the output from diff et al. to update a file (GNU)
Syntax:
patch [option]... [origfile [patchfile]]
Runs on:
QNX Neutrino
Options:
Input options:
-p num
--strip= num Strip num leading components from file names.
-F lines
--fuzz lines Set the fuzz factor to lines for inexact matching.
-l
--ignore-whitespace
Ignore white space changes between the patch and the input.
-c
--context Interpret the patch as a context difference.
-e
--ed Interpret the patch as an ed script.
-n
--normal Interpret the patch as a normal difference.
-u
--unified Interpret the patch as a unified difference.
-N
--forward Ignore patches that appear to be reversed or already applied.
-R
--reverse Assume patches were created with old and new files swapped.
-i patchfile
--input=patchfile
Read the patch from patchfile instead of stdin.
Output options:
-o file
--output=file Output the patched files to file.

© 2010, QNX Software Systems GmbH & Co. KG. patch
-r file
--reject-file=file
Output rejects to file.
-D name
--ifdef=name Make merged if-then-else output using name.
-E
--remove-empty-files
Remove output files that are empty after patching.
-Z
--set-utc Set the times of patched files, assuming diff uses UTC (GMT).
-T
--set-time Likewise, assuming local time.
--quoting-style=word
Output file names using quoting style word. The values for word
are: literal, shell, shell-always, c, and escape. The
default is taken from the QUOTING_STYLE environment
variable; if this variable isn’t set, patch uses shell.
Backup and version control options:
-b
--backup Back up the original contents of each file.
--backup-if-mismatch
Back up if the patch doesn’t match exactly.
--no-backup-if-mismatch
Back up mismatches only if otherwise requested.
-V style
--version-control=style
Use style version control, where style is simple, numbered, or
existing.
-B prefix
--prefix=prefix Prepend prefix to the names of backup files.
-Y prefix
--basename-prefix=prefix
Prepend prefix to the base names of backup files.
-z suffix
--suffix=suffix Append suffix to the names of backup files.

patch © 2010, QNX Software Systems GmbH & Co. KG.
-g num
--get=num Get files from RCS etc., if num is positive; ask if it’s negative.
Miscellaneous options:
-t
--batch Ask no questions; skip bad-Prereq patches; assume reversed.
-f
--force Like -t, but ignore bad-Prereq patches, and assume unreversed.
-s
--quiet
--silent Work silently unless an error occurs.
--verbose Output extra information about the work being done.
--dry-run Don’t actually change any files; just print what would happen.
--posix Conform to the POSIX standard.
-d dir
--directory=dir
Change the working directory to dir first.
--binary Read and write data in binary mode (no effect on this platform).
-v
--version Output version info.
--help Display some help.
Description:
The patch utility use the output from diff, diff3, and cmp to update a file.
QUOTING_STYLE
The default quoting style. The possible values are: literal, shell,
shell-always, c, and escape. If QUOTING_STYLE isn’t set, patch uses
shell. You can override this variable by using the --quoting-style option.
GNU

© 2010, QNX Software Systems GmbH & Co. KG. patch
See also:
cmp, diff, diff3

pax © 2010, QNX Software Systems GmbH & Co. KG.
Portable archive interchange (POSIX)
Syntax:
List archive contents:
pax [-cimopuvy] [-f archive] [-s replstr]...

[-t device] [pattern...]
Read an archive:
pax -r [-cimnopuvy] [-f archive] [-s replstr]...

[-t device] [pattern...]
Write an archive:
pax -w [-dimuvy] [-b blocking] [-[a]f archive]

[-s replstr]... [-t device] [-x format]
[pathname...]
Copy files:
pax -rw [-ilmopuvy] [-s replstr]... [pathname...]

directory
Runs on:
Options:
-a Append the files specified by pathname to the archive specified with
-f.
-b blocking Block the output at blocking bytes per write to the archive file. A k
suffix multiplies blocking by 1024, a b suffix multiplies blocking by
512, and an m suffix multiplies blocking by 1048576 (1 megabyte). If
not specified, blocking is automatically determined on input and is
ignored for -rw (copy files).
-c Complement the match sense of the pattern operands.
-d Don’t create intermediate directories not explicitly listed in the

archive. This option is applied only if you specify the -r option.
-f archive Use archive as the pathname of the input or output archive, overriding
the default of standard input for -r or standard output for -w.
-i Interactively rename files. Substitutions specified by -s options are

performed before requesting the new filename from you. If you enter
an empty line, the file is skipped. If EOF is encountered, pax exits
with an exit status of 0.

© 2010, QNX Software Systems GmbH & Co. KG. pax
-l (“el”) When possible, link rather than copy files.
-m Don’t keep file modification times.
-n When you specify -r, but not -w, treat the pattern operands as
ordinary filenames. Only the first occurrence of each of these files in
the input archive is read. The pax utility exits with an exit status of 0
after all files in the list have been read. If it can’t find one or more of
the files in the list, pax writes a diagnostic to standard error for each
of these files and exits with a nonzero exit status. The filenames are
compared before any of the -i, -s, or -y options are applied.
-o Restore file ownership as specified in the archive. The invoking

process must have appropriate privileges to accomplish this.
-p Preserve the access time of the input files after they have been copied.
-s replstr Modify filenames according to the substitution expression. The

syntax for the expression is:
-s /old/new/[gp]
You can use any non-null character as a delimiter (a / is used here as
an example). Multiple -s expressions are applied in the order
specified terminating with the first successful substitution. The
optional trailing p causes successful mappings to be listed on standard
error. The optional trailing g causes the old expression to be replaced
each time it occurs in the source string. If a filename becomes an
empty string after applying substitutions to it, it’s ignored both on
input and output.
-t device The device argument names the input or output archive device,
overriding the default of standard input for -r and standard output for
-w.
-u Copy each file only if it is newer than a preexisting file with the same
name.
-v Be verbose; list filenames as they’re encountered. This option

produces a table of contents listing on the standard output when both
-r and -w are omitted; otherwise the filenames are printed to standard
error as they are encountered in the archive.
-x format Use this output archive format. The input format is automatically
determined when you use the -r option. The supported formats are:
cpio The extended cpio interchange format specified in POSIX

Std 1003.1-1988.
ustar The extended tar interchange format, also specified in
POSIX Std 1003.1-1988. This is the default archive format.

-y Interactively prompt for the disposition of each file. Substitutions

specified by -s options (described above) are performed before
you’re prompted for the disposition. EOF or an input line starting
with the character q causes pax to exit. Otherwise, an input line
starting with anything other than y causes the file to be ignored. You
can’t use this option in conjunction with the -i option.
Only the last -f or -t option takes effect.
directory The destination directory pathname for copies when both the -r and
-w options are specified. The directory must exist and you must have
the appropriate write permissions, or an error results.
pathname A file to be copied or a directory containing files and subdirectories to

be (recursively) copied in addition to the directory itself.
pattern A pattern given in the standard shell pattern-matching notation. If no

pattern is specified, the default is *, which selects all files.
Modes of operation:
If you don’t specify -r or -w, then pax lists the contents of the specified archive. In
this mode, pax lists normal files one per line. Hard link pathnames are listed as:
pathname == linkname
where pathname is the name of the file being extracted, and linkname is the name of a
file that appeared earlier in the archive.
Symbolic link pathnames are listed as:
pathname -> destination_path
If you specify -v, then pax lists normal pathnames in the same format used by the ls
utility with the -l (“el”) option, except for hard links, which are shown as:
<ls -l listing> == linkname
The modes of operation related to combinations of -r and -w are as follows:
-r Read an archive file from the standard input; select for extraction only those
files whose names match any of the pattern operands. The selected files are
conditionally created and copied relative to the current directory tree, subject
to the options chosen. By default, the owner and group of selected files are
those of the invoking process, and the permissions and modification times are
the same as those in the archive.
The supported archive formats are automatically detected on input.

-w Write the files and directories specified by pathname operands to the standard
output, together with the pathname and status information prescribed by the
archive format used. The default output format is tar, but you can override
this by using the -x format option described below.
A directory pathname operand refers to the files and (recursively)
subdirectories of that directory. If no pathname operands are given, then the
standard input is read to get a list of pathnames to copy, one pathname per
line. In this case, only those pathnames appearing on the standard input are
copied.
-rw Read the files and directories named in the pathname operands and copy them
to the destination directory. A directory pathname operand refers to the files
and (recursively) subdirectories of that directory. If no pathname operands
are given, the standard input is read to get a list of pathnames to copy, one
pathname per line. In this case, only those pathnames appearing on the
standard input are copied. The directory named by the directory operand must
exist and must have the proper permissions before the copy can occur.
Description:
The pax utility reads and writes archive files that conform to the archive/interchange
file format specified in POSIX Std 1003.1-1988. The utility can also read, but not
write, a number of other file formats. Support for these traditional file formats (such as
V7 tar and System V binary cpio format archives) is provided for backward
compatibility and to maximize portability.
The pax utility also supports traditional cpio and System V tar interfaces if invoked
with those names (they’re links to pax).
The pax utility is capable of reading and writing archives that span multiple physical
volumes. Upon detecting an end of medium on an archive that isn’t yet completed,
pax prompts you for the next volume of the archive and lets you specify the location
of the next volume.
If the pax archive is stored directly in a floppy disk block special file (e.g.
/dev/fd0), the archive overwrites the first block of the disk, which the floppy driver,
devb-fdc, uses to store media-type information that lets it dynamically adjust to
diskettes of differing media capacity being inserted in the drive (e.g. 720k vs 1.4M,
360k vs 1.2M etc.). If the floppy driver can’t determine the capacity, it assumes 1.4M.
Combinations of the -r and -w command-line arguments specify whether pax reads,

writes, or lists the contents of the specified archive, or moves the specified files to
another directory.
When writing to an archive, the standard input is used as a list of pathnames if no
pathname operands are specified. The format is one pathname per line. When reading,
the standard input is the archive file, which is formatted according to one of the format
specifications in POSIX Std 1003.1-1988.

The user ID and group ID of the process, together with the appropriate privileges,
affect the ability of pax to restore ownership and permissions attributes of the archived
files. (See Archive/Interchange File Format in POSIX Std 1003.1-1988.)
Note that the options -a, -c, -d, -i, -l, -p, -t, and -y are provided for functional
compatibility with the historical cpio and tar utilities. The option defaults were
chosen based on the most common usage of these options, so some of the options have
meanings different from those of the historical commands.
Examples:
Copy the contents of the current directory to the floppy drive:
pax -w -f /dev/fd0 .
Copy the contents of olddir to newdir:
mkdir newdir
cd olddir
pax -rw . ../newdir
Read the archive pax.out with all files rooted in /usr in the archive extracted
relative to the current directory (note the use of commas as pattern separators for the
-s option):
pax -r -s ",ˆ/usr/,," -f pax.out
Files:
The controlling terminal (/dev/tty) is used to prompt the user for information when
the -i or -y options are specified.
Exit status:
0 All files in the archive were processed successfully.
>0 The pax utility aborted due to errors encountered during operation.
Caveats:
Special permissions may be required to copy or extract special files.
Device, user ID, and group ID numbers larger than 65535 cause additional header
records to be output. These records are ignored by some historical versions of cpio
and tar.
The archive formats described in Archive/Interchange File Format have certain
restrictions that have been carried over from historical usage. For example, pathnames
stored in the archive can be no more than 255 characters in length.
When getting an ls -l style listing on tar format archives, link counts are listed as
zero since the ustar archive format doesn’t keep link count information.

On 16-bit architectures, including 16-bit versions of QNX 4., the largest buffer size is
32K-1. This is due, in part, to using integers in the buffer allocation schemes. On
many of these machines, however, it isn’t possible to allocate blocks of memory larger
than 32K.
See also:
bzip2, cp, cpio, find, gzip, tar

pccard-launch © 2010, QNX Software Systems GmbH & Co. KG.
Automatically start drivers when PC Cards are inserted
Syntax:
pccard-launch [-nv] ’type,command’...
Runs on:
Neutrino
Options:
-n Don’t lock the socket where the expected card is found.
-v Display verbose messages on standard output.
’type,command’ For this PC Card type, spawn command. Types may be specified
in decimal (nnnn) or hexadecimal (0xnnn), and are followed by a
comma (,) and the command to execute. For example:
pccard-launch ’0x600,io-pkt-v4 -dne2000 ioport=0x$IOPORT,\

irq=$IRQ’
You can specify multiple type/command pairs on the command

line by separating them with whitespace. If the command
specified contains whitespace, the command must be enclosed in
quotes (as shown).
Description:
The pccard-launch utility automatically starts drivers and sets environment
variables describing the ports and IRQs used by a card, thus permitting a non-PC
Card-aware driver to be started automatically when a card is inserted, and stopped
when removed.
The environment variables may be named in the command lines for the drivers to be
run, thus allowing the port and IRQ information to be passed on the command line to
the drivers, most of which aren’t aware of the environment variables set by
pccard-launch.
This utility both starts driver when cards are plugged in and stops them via a
SIGTERM signal when cards are removed.
When a card is plugged in, pccard-launch checks the card type against the list of
card types/driver commands supplied to it on its command line. If it doesn’t know
about the card type, it does nothing. If it has been provided with a command for the
card type, it does the following:
• Locks the card.

© 2010, QNX Software Systems GmbH & Co. KG. pccard-launch
• Sets up environment variables detailing I/O port locations, IRQ used, etc.
• Spawns the associated command.
When the card is removed, pccard-launch unlocks the card and signals the
previously spawned process with SIGTERM.
You can determine the card type by using the pin command. A pin con command
displays configuration information for the PC Card. Look at the config line, which
should look something like:
config = 0xNN, 0xTTTT..."
where NN is the configuration number and TTTT is the type of the card. For example,
a modem card has a type of 0x200. This is the type that you must use on the
command line for pccard-launch.
Examples:
Automatically start the ne2000 driver with the appropriate I/O port and IRQ settings,
for PC Card type 0x600:
pccard-launch ’0x600,io-pkt-v6-hc -dne2000 ioport=0x$IOPORT,irq=$IRQ’
Files:
pccard-launch This utility is located in the /usr/sbin/ directory.
The environment variables set by pccard-launch are:
IOPORT Hex address of the I/O port (e.g. 320).
IOPORTSZ Size of the I/O port (e.g. 32).
IOPORT2 Hex address of the second I/O port, if assigned.
IOPORT2SZ Size of the second I/O port, if assigned.
IRQ IRQ of the device.
SOCKET The socket where the card is inserted.
See also:
devp-pccard, pin

pci © 2010, QNX Software Systems GmbH & Co. KG.
Display PCI devices
You need to log in as root to use this utility.
Syntax:
pci [-n] [-v]
Runs on:
Neutrino
Options:
-n The maximum number of PCI buses to scan.
-v Be verbose; display all PCI devices.
Description:
The pci utility displays Peripheral Component Interconnect devices. By default, it
displays only disk, network, and graphics devices. Use the -v (verbose) option to
display all PCI devices.
CAUTION: This utility is intended for debugging purposes; running it on an active

! system may cause some devices to hang.
Examples:
Here’s some sample output from pci:
Class = Mass Storage (IDE)

Vendor ID = 8086, Intel Corporation
Device ID = 7010h, 82371SB PIIX3 IDE Interface (Triton II)
PCI index = 0
IO Address = ffa0h enabled
PCI Int Pin = NC
Interrupt line = 0
See also:
pci-bios
pci_attach(), pci_attach_device(), pci_detach(), pci_detach_device(),
pci_find_class(), pci_find_device(), pci_present(), pci_read_config(),
pci_read_config8(), pci_read_config16(), pci_read_config32(), pci_write_config(),
pci_write_config8(), pci_write_config16(), pci_write_config32() in the Library
Reference

© 2010, QNX Software Systems GmbH & Co. KG. pci-bios, pci-bios-v2
Provide support for the PCI BIOS
Syntax:
For pci-bios:
pci-bios [-b buses] [-B] [-c] [-m] [-v] [-x] [-dbios bios_options]
You must run pci-bios-v2 as pci-bios:

pci-bios [-b buses] [-B] [-c] [-D] [-M] [-m] [-P addr:size]
[-v] [-x] [-dbios bios_options]
Runs on:
Neutrino
Targets:
x86
Options:
-b buses The number of PCI buses to scan. The default is 10.
-B Force enumeration of bridges of type “OTHER”.
-c Ignore class code check.
-D (pci-bios-v2 only) Enable Message Signaled Interrupts (MSI)
and Extended MSI (MSI-X) for video.
-dbios bios_options
BIOS options, which include:
irqlist=irq1,irq2,. . .
Pass a list of IRQs to the BIOS. For example:
irqlist=5,7,9
-M (pci-bios-v2 only) Disable MSI and MSI-X (they’re enabled by

default).
-m Don’t map IRQs; some BIOSs don’t support IRQ mapping.
-P addr:size (pci-bios-v2 only) Specify the address and size of the extended
PCIe configuration space.
-v Verbose output; display detailed information on the console.
-x Don’t remove devices from the PCI bus while enumerating them.

pci-bios, pci-bios-v2 © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The pci-bios server provides PCI BIOS support. You’ll have to provide it in your
boot image for systems with a PCI BIOS. Invoke seedres before starting pci-bios.
This server creates the /dev/pci device. Wait for it to appear by specifying the
following in the buildfile used by mkifs:
pci-bios
waitfor /dev/pci
The pci-bios-v2 server is similar to pci-bios, but supports Message Signaled

Interrupts (MSI). You must use pci-bios-v2 if you’re using startup-apic.
If you’re using pci-bios-v2, you must name it pci-bios in order for the
enumerators to work correctly. In your buildfile, add pci-bios-v2 like this:
pci-bios=pci-bios-v2
See also:
seedres
pci_attach(), pci_attach_device(), pci_detach(), pci_detach_device(),
pci_find_class(), pci_find_device(), pci_present(), pci_read_config(),
pci_read_config8(), pci_read_config16(), pci_read_config32(), pci_write_config(),
pci_write_config8(), pci_write_config16(), pci_write_config32() in the Library
Reference

© 2010, QNX Software Systems GmbH & Co. KG. pcnfsd
Unix authenticator for NFS
Syntax:
pcnfsd
Runs on:
Neutrino
Options:
None.
Description:
The pcnfsd utility is used for authentication purposes by NFS clients in a PC
environment that has no concept of user/password identification (e.g. DOS).
There’s no direct check for root on the mount. The nfsd utility checks only that the
requests come from a privileged port (which implies root access). The check may be
disabled using the -norsvd option in the /etc/exports file.
If a configuration file is present ( /etc/pcnfsd.conf) pcnfsd uses the information
it contains to replace certain builtin elements.
See also:
/etc/exports, /etc/pcnfsd.conf, nfsd

/etc/pcnfsd.conf © 2010, QNX Software Systems GmbH & Co. KG.
Configuration file for pcnfsd definitions
Name:
/etc/pcnfsd.conf
Description:
The pcnfsd.conf file contains a range of acceptable user IDs. The pcnfsd utility
uses this file to authenticate users trying to log on. The default range is 101-60002.
keyword argument
where keyword and argument are as follows:
keyword argument Meaning

uidrange value-value Accepted range of user IDs
uidrange value Accepted single user ID
Format rules:
• There is a space between keyword and argument.
• Lines that start with # are comments.
• Blank lines are ignored.
For example:
To authenticate users with a uid between 100 and 200:
uidrange 100-200
To authenticate a user with a uid of 152:
uidrange 152
To authenticate several uid ranges:
uidrange 5
uidrange 150-200
uidrange 500-600
See also:
pcnfsd

© 2010, QNX Software Systems GmbH & Co. KG. pdebug
Process-level debugger
Syntax:
pdebug [-1eflsv] [-n priority_levels] device
Runs on:
Neutrino
Options:
-1 (“One”) Exit pdebug after the debugging session is done.
-e Echo the debugged program’s stdin back to the host.
-f Run pdebug as a foreground process.
-l (“el”) By default, pdebug sets the LD_BIND_NOW to 1 to

force all binding to be done immediately instead of lazily. To
permit lazy binding, specify the -l option. For more
information, see “Optimizing the runtime linker” in the
Compiling and Debugging chapter of the QNX Neutrino
-n priority_levels Be nice; set the debugged program’s priority to be

priority_levels lower than pdebug’s. Doing this can keep
pdebug from becoming unresponsive if the debugged process
misbehaves (e.g. looping in a tight loop taking lots of CPU
time).
-s Notify the host only of signals caused by faults.
-v Be verbose;
device The device to use for the remote debug protocol; one of:
- Use stdout / stdin.

/device_name[,baud]
Open and use the specified device, such as
/dev/ser1, optionally setting the baud rate.
number Accept connections on TCP/IP port number.
Description:
This utility provides access to process-level debugging from a remote host. To use
pdebug, you need to run devc-pty on the target machine (i.e. the machine being
debugged).

pdebug © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
For a 57600 baud serial connection on /dev/ser2:
pdebug /dev/ser2,57600 &
For a TCP/IP connection on port 8000:
pdebug 8000 &
See also:
devc-pty
“Debugging” in the Compiling & Debugging chapter of the Programmer’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. ped
Photon editor
Syntax:
ped [-adfr] [-c function] [-g line]
[-h height[%]] [-l locale] [-p filespec]
[-S i|m|n] [-s server] [-t space]
[-y position[%][r]]
Runs on:
Neutrino
Options:
-a Save and load files with attributes (special fonts, bold, italic,
etc.).
-c function Go to the specified function after loading.
-d Use the default locale list, which provides the following locales:
• ja_JP.euc
• ja_JP.sjis
• ja_JP.jis
• zh_CN.euc
• zh_CN.big5
• ko_KR.euc
• C
-f Forces soft newlines due to wrapping to be saved as hard

newlines.
-g line Go to the specified line after loading.

-l locale Use the given locale to encode and decode when loading and
saving files. The default is “C” for English and UTF-2.
-p filespec Use this default file specification pattern in the save/open/load

file selector.
-r Open the file in read-only (View) mode

normal).

ped © 2010, QNX Software Systems GmbH & Co. KG.

fullpath fullpath
-t space Set tab stop spacing.



Description:
The ped application is a simple editor designed to support Unicode (UTF-8) formatted
files only. It also provides simple search and replace capabilities.
Editing with ped.
The name and path of the file opened in the editor appear in the top window frame. At
the bottom of the window, the line and column indicators as well as the filename (no
path) appear.

CAUTION: Depending on the preferences you set, ped might append a block of text
! to the end of your files, which might upset any applications that read the files. With the
default preferences, ped doesn’t write this block. You can control this behavior by
choosing Preferences from the Edit menu and setting the options in the Styles &
Markers tab.
The font button in the top right corner indicates the current font of the text at the
cursor position. Clicking on this button is the same as selecting the Font option from
the Type menu (Ctrl-Alt-F). The colored rectangle beside the text field indicates the text
color at the current cursor position. Clicking on this rectangle is the same as selecting
the Color option from the Type menu (Ctrl-Alt-C).
You can use the following mouse shortcuts to select text:
If you want to: Do this:

Position the cursor Single-click
Select the word under the cursor Double-click or
Alt-click
Select the current line Triple-click
Select the current paragraph Quadruple-click
Select all Quintuple-click
Extend the highlighted region Shift-click
Select text Hold down the left mouse button and
drag.
Copy selected range to clipboard While holding down the left mouse
button, press the right mouse button.
You can use keyboard commands to select, copy, paste, and format text, as well as
select items from the menu.
Cursor movement commands

If you hold down the Shift key when using any of the following cursor movements, all
of the text covered by that movement is highlighted.

If you want to move: Press:

The cursor one position in the direction of the arrow ↑, ↓, ←, →
To the beginning of the line Home
To the beginning of the document Ctrl-Home
To the end of the line End
To the end of the document Ctrl-End
Up one page Page Up
Down one page Page Down
Forward one word Ctrl→
Back one word Ctrl←
Find the matching brace or quote for “( )”, “{ }”, “[ ]”, single quote, F10
or double quotes
Matching quotes are searched in the forward direction only.
Deletion commands
If you want to delete: Press:
The line Ctrl-U
To the end of the line Ctrl-K
The character to the right of the cursor Delete
position
The character to the left of the cursor Backspace
position
Selected text Any key that deletes or inserts text.
When you have text selected for deletion, any key that types or deletes text replaces
the selected text. The deleted text is moved to the clipboard until it’s replaced by the
next deletion or explicit clipboard loading operation.
Formatting commands

To format text as: Press:

Bold Alt-B
Italic Alt-I
If text is selected, only the selected text is formatted. If no text is selected, begin to
format text when typed.
Centering commands
To align the text: Press: Description:
Left margin Alt-L Align the line of text that
the cursor is on to the left
margin.
Center Alt-C Center the line that the
cursor is on.
Right margin Alt-R Align the line of text that
the cursor is on to the
right margin.
Clipboard commands
If you want to: Press:
Copy selected text to the clipboard. Ctrl-C
Move selected text to the clipboard (and Ctrl-X or
delete the selected text). Ctrl-Alt-X
Delete the current line. Ctrl-U
Paste the clipboard text at the current Ctrl-V or
cursor position. Ctrl-Alt-V
When you’re in overwrite mode, each character you type gets saved to the clipboard.
If a paste replaces text, the replaced text is moved to the clipboard.
Special commands
If you want to: Press: Description:
Invoke Helpviewer Ctrl-Alt-H Searches for the selected text in Helpviewer.

File menu operations
Menu item: Hotkey: Description:

File menu Alt-F Displays the File
drop-down menu.
New Ctrl-N or Alt-F-N Clears the current buffer
and filename after you
confirm the action.
Open Ctrl-O or Alt-F-O Opens a new buffer,
replacing the current
buffer after you confirm
the action.
Save Ctrl-S or Alt-F-S Saves the current buffer
to the current filename.
Save As Ctrl-A or Alt-F-A Saves the current buffer
to a specified filename.
Print Ctrl-P or Alt-F-P Prints the file.
Exit Alt-X or Alt-F-X Exits after you confirm
the action (if changes to
current buffer haven’t
been saved).
You can also open a file by dragging it from a pfm window and dropping it into ped.
Each dragged file is opened as a new buffer.
Search menu operations

Search menu Alt-S Displays the Search
drop-down menu.
Find Ctrl-F or Alt-S-F Finds the next occurrence
of the specified string.
Search & Replace Ctrl-R or Alt-S-R Finds the next occurrence
of the search string and
replaces it with the
replace string.
continued. . .


Search & Replace F2 Searches for the text that
was last entered as the
search string.
Search & Replace F3 Replaces the selected text
with the “replace” text
and repeats the search.
Goto Line Ctrl-G or Alt-S-G Goes to the specified line.
When the Find dialog is displayed, Enter finds the next occurrence when the search
field has focus. F2 repeats the search; the search window doesn’t have to be in focus or
even open.
When the Search and Replace dialog is displayed, Enter repeats the operation while
the Replace field has focus. F2 finds the next occurrence of the search string. F3
replaces the currently selected text, then finds and highlights the next instance of the
search string. Esc closes the Search window.
Options menu operations

You use this dialog to change the defaults and the file encoding operations.

Options menu Alt-O Displays the Options
drop-down menu.
Defaults Ctrl-D or Alt-O-D Brings up a dialog for
configuring the default
configuration for ped sessions.
Encoding Ctrl-E or Alt-O-E Selects the encoding to use as a
filter for the file being loaded or
saved.
With the Defaults dialog, you can set the default for background color, text color, font,
tab size, text wrap, auto indent, and the file specification to use when bringing up
load/save dialogs.
In addition, there’s a control that dictates whether or not attribute information is
preserved when loading or saving files. (The attributes are saved in a C-style comment
at the end of the file if this option is enabled.) The attribute information is saved to
.ph/pedrc.
The background and text colors are applied (updated) immediately when a color is
selected so that you can see the change without leaving the dialog box.

The specified encoding is assumed on the file. When the file is loaded, it’s converted
to UTF-8. When the file is saved, it’s converted from UTF-8. (The editor works with
UTF-8 encoded Unicode text internally.)
If the current encoding selection of the editor doesn’t match a file being loaded, the
file will likely fail to load in its entirety. You’ll have to select a new translation and try
to load the file again. To translate a file from one encoding to another:
1 Select the current file encoding.
2 Load the file (translate using the selected translation to UTF-8).
3 Select the desired encoding.
4 Save the file (translate from UTF-8 using the new translation during the save).
Type menu operations

Type menu Alt-T Displays the Type drop-down menu.
Font Ctrl-Alt-F or Alt-T-F Opens the font selection dialog.
Color Ctrl-Alt-C or Alt-T-C Opens the color selector.
In the Font dialog, you can choose the font (typeface, style, and size) for the selected
range. The selected font is used to modify the selected text range. If there’s no
selected text range, the selected font is used for the next text entered. (The font buttons
indicate the typeface and style of the text that’s inserted whenever text is entered at the
current cursor location.)
In the Color dialog, you can choose the text color for the selected range. This dialog
lets you select a foreground color for the selected text range. If there’s no selected text
range, the selected color is used for the next text entered. (The color button always
indicates the color of text that’s to be inserted when text is entered at the current cursor
location.)
Examples:
Run ped using the Photon server on node my_node:
ped -s/net/my_node/dev/photon
Run ped at initial position (10,10) with initial dimension of 200×300:
ped -x10 -y10 -h200 -w300

Edit a plain text file encoded in Japanese Shift-JIS.
ped -a -l ja_JP.sjis

Files:
${HOME}/.ph/pedrc
User’s configuration file.
See also:
ed, elvis, qed, vi

pf © 2010, QNX Software Systems GmbH & Co. KG.
Packet Filter pseudo-device
Name:
/dev/pf
Description:
Packet filtering takes place in io-pkt. A pseudo-device, /dev/pf, lets user processes
control the behavior of the packet filter through an ioctl() interface. There are
commands to enable and disable the filter, load rule sets, add and remove individual
rules or state table entries, and retrieve statistics. The most commonly used functions
are covered by pfctl.
If you’re using QNX Neutrino 6.4.1 or earlier, you should use ioctl_socket() instead of
ioctl() in your packet-filtering code. With the microkernel message-passing
architecture, ioctl() calls that have pointers embedded in them need to be handled
specially. The ioctl_socket() function uses ioctl() for functionality that doesn’t require
special handling.
In QNX Neutrino 6.5.0 and later, ioctl() handles embedded pointers, so you don’t have
to use ioctl_socket() instead.
Manipulations such as loading a rule set that involve more than a single ioctl() call
require a ticket, which prevents the occurrence of multiple concurrent manipulations.
Fields of ioctl() parameter structures that refer to packet data (such as addresses and
ports) are generally expected in network-byte order.
Rules and address tables are contained in anchors. When servicing an ioctl() request,
if the anchor field of the argument structure is empty, io-pkt uses the default anchor
(i.e. the main rule set) in operations. Anchors are specified by name and may be
nested, with components separated by slashes, similar to the way that filesystem
hierarchies are laid out. The final component of the anchor path is the anchor under
which operations will be performed.
ioctl() interface
The pf pseudo-device supports the following ioctl() commands, available through
<net/pfvar.h>:
DIOCSTART Start the packet filter.
DIOCSTOP Stop the packet filter.
DIOCSTARTALTQ Start the ALTQ bandwidth control system (see altq in the
NetBSD documentation).
DIOCSTOPALTQ Stop the ALTQ bandwidth control system.

© 2010, QNX Software Systems GmbH & Co. KG. pf
DIOCBEGINADDRS struct pfioc_pooladdr *pp

Clear the buffer address pool and get a ticket for subsequent
DIOCADDADDR, DIOCADDRULE, and DIOCCHANGERULE calls.
The pfioc_pooladdr structure is defined as follows:
struct pfioc_pooladdr {
u_int32_t action;
u_int32_t ticket;
u_int32_t nr;
u_int32_t r_num;
u_int8_t r_action;
u_int8_t r_last;
u_int8_t af;
char anchor[MAXPATHLEN];
struct pf_pooladdr addr;
};
DIOCADDADDR struct pfioc_pooladdr *pp

Add the pool address, addr to the buffer address pool to be used
in the following DIOCADDRULE or DIOCCHANGERULE call. All
other members of the structure are ignored.
DIOCADDRULE struct pfioc_rule *pr
Add the given rule at the end of the inactive rule set. The
pfioc_rule structure is defined as follows:
struct pfioc_rule {
u_int32_t action;
u_int32_t ticket;
u_int32_t pool_ticket;
u_int32_t nr;
char anchor_call[MAXPATHLEN];
struct pf_rule rule;
};
This call requires a ticket obtained through a preceding

DIOCXBEGIN call and a pool_ticket obtained through a
DIOCBEGINADDRS call. You must also call DIOCADDADDR if
any pool addresses are required.
The optional anchor name indicates the anchor in which to
append the rule. The nr and action members. are ignored.
DIOCADDALTQ struct pfioc_altq *pa
Add an ALTQ discipline or queue. The pfioc_altq structure
is defined as follows:
struct pfioc_altq {
u_int32_t action;
u_int32_t ticket;
u_int32_t nr;
struct pf_altq altq;
};

DIOCGETRULES struct pfioc_rule *pr

Get a ticket for subsequent DIOCGETRULE calls, and the number
nr of rules in the active rule set.
DIOCGETRULE struct pfioc_rule *pr
Get a rule by its number nr, using the ticket obtained through a
preceding DIOCGETRULES call.
DIOCGETADDRS struct pfioc_pooladdr *pp

Get a ticket for subsequent DIOCGETADDR calls and the number
nr of pool addresses in the rule specified with r_action, r_num,
and anchor.
DIOCGETADDR struct pfioc_pooladdr *pp
Get the pool address addr by its number nr from the rule
specified with r_action, r_num, and anchor, using the ticket
obtained through a preceding DIOCGETADDRS call.
DIOCGETALTQS struct pfioc_altq *pa

Get a ticket for subsequent DIOCGETALTQ calls and the number
nr of queues in the active list.
DIOCGETALTQ struct pfioc_altq *pa

Get the queueing discipline altq by its number nr, using the
ticket obtained through a preceding DIOCGETALTQS call.
DIOCGETQSTATS struct pfioc_qstats *pq

Get the statistics for a queue. The pfioc_qstats structure is
defined as follows:
struct pfioc_qstats {
u_int32_t ticket;
u_int32_t nr;
void *buf;
int nbytes;
u_int8_t scheduler;
};
This call fills in a pointer to the buffer of statistics buf , of length

nbytes, for the queue specified by nr.
DIOCGETRULESETS struct pfioc_ruleset *pr

Get the number nr of rule sets (i.e., anchors) directly attached to
the anchor named by path for use in subsequent
DIOCGETRULESET calls. The pfioc_ruleset structure is
defined as follows:
struct pfioc_ruleset {
u_int32_t nr;

char path[MAXPATHLEN];
char name[PF_ANCHOR_NAME_SIZE];
};
Nested anchors, since they aren’t directly attached to the given

anchor, aren’t included. This ioctl() command returns EINVAL
if the given anchor doesn’t exist.
DIOCGETRULESET struct pfioc_ruleset *pr
Get a rule set (i.e., an anchor) name by its number nr from the
given anchor path, the maximum number of which can be
obtained from a preceding DIOCGETRULESETS call. This ioctl()
command returns EINVAL if the given anchor doesn’t exist, or
EBUSY if another process is concurrently updating a rule set.
DIOCADDSTATE struct pfioc_state *ps

Add a state entry. The pfioc_state structure is defined as
follows:
struct pfioc_state {
u_int32_t nr;
struct pf_state state;
};
DIOCGETSTATE struct pfioc_state *ps

Extract the entry with the specified number nr from the state
table.
DIOCKILLSTATES struct pfioc_state_kill *psk
Remove matching entries from the state table. This ioctl()
command returns the number of killed states in psk_af . The
pfioc_state_kill structure is defined as follows:
struct pfioc_state_kill {
sa_family_t psk_af;
int psk_proto;
struct pf_rule_addr psk_src;
struct pf_rule_addr psk_dst;
char psk_ifname[IFNAMSIZ];
};
DIOCCLRSTATES struct pfioc_state_kill *psk

Clear all states. This command works like DIOCKILLSTATES,
but ignores the psk_af , psk_proto, psk_src, and psk_dst fields
of the pfioc_state_kill structure.
DIOCSETSTATUSIF struct pfioc_if *pi
Specify the interface for which to gather statistics. The
pfioc_if structure is defined as follows:

struct pfioc_if {
char ifname[IFNAMSIZ];
};
DIOCGETSTATUS struct pf_status *s

Get the internal packet filter statistics. The pf_status
structure is defined as follows:
struct pf_status {
u_int64_t counters[PFRES_MAX];
u_int64_t lcounters[LCNT_MAX];
u_int64_t fcounters[FCNT_MAX];
u_int64_t scounters[SCNT_MAX];
u_int64_t pcounters[2][2][3];
u_int64_t bcounters[2][2];
u_int64_t stateid;
u_int32_t running;
u_int32_t states;
u_int32_t src_nodes;
u_int32_t since;
u_int32_t debug;
u_int32_t hostid;
char ifname[IFNAMSIZ];
};
DIOCCLRSTATUS Clear the internal packet filter statistics.
DIOCNATLOOK struct pfioc_natlook *pnl

Look up a state table entry by source and destination addresses
and ports. The pfioc_natlook structure is defined as follows:
struct pfioc_natlook {
struct pf_addr saddr;
struct pf_addr daddr;
struct pf_addr rsaddr;
struct pf_addr rdaddr;
u_int16_t sport;
u_int16_t dport;
u_int16_t rsport;
u_int16_t rdport;
sa_family_t af;
u_int8_t proto;
u_int8_t direction;
};
DIOCSETDEBUG u_int32_t *level

Set the debug level to one of PF_DEBUG_NONE,
PF_DEBUG_URGENT, PF_DEBUG_MISC, or
PF_DEBUG_NOISY.

DIOCGETSTATES struct pfioc_states *ps

Get state table entries. The pfioc_states structure is defined
as follows:
struct pfioc_states {
int ps_len;
union {
caddr_t psu_buf;
struct pf_state *psu_states;
} ps_u;
#define ps_buf ps_u.psu_buf
#define ps_states ps_u.psu_states
};
If ps_len is zero, all states are gathered into pf_states, and

ps_len is set to the size they take in memory (i.e.
sizeof(struct pf_state) * nr). If ps_len is nonzero, as
many states that can fit into ps_len as possible are gathered, and
ps_len is updated to the size those rules take in memory.
DIOCCHANGERULE struct pfioc_rule *pcr
Add or remove the rule in the rule set specified by rule.action.
The type of operation to be performed is indicated by action,
which can be any of the following:
• PF_CHANGE_NONE
• PF_CHANGE_ADD_HEAD
• PF_CHANGE_ADD_TAIL
• PF_CHANGE_ADD_BEFORE
• PF_CHANGE_ADD_AFTER
• PF_CHANGE_REMOVE
• PF_CHANGE_GET_TICKET
You must set ticket to the value obtained with
PF_CHANGE_GET_TICKET for all actions except
PF_CHANGE_GET_TICKET. You must set pool_ticket to the
value obtained with the DIOCBEGINADDRS call for all actions
except PF_CHANGE_REMOVE and
PF_CHANGE_GET_TICKET. The anchor indicates which
anchor the operation applies to. The nr member indicates the
rule number against which to apply
PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER, or
PF_CHANGE_REMOVE actions.
DIOCCHANGEADDR struct pfioc_pooladdr *pca

Add or remove the pool address addr from the rule specified by
r_action, r_num, and anchor.

DIOCSETTIMEOUT struct pfioc_tm *pt

Set the state timeout of timeout to seconds. The pfioc_tm
struct pfioc_tm {
int timeout;
int seconds;
};
The old value is placed into seconds. For the possible values of
timeout, see the PFTM_* values in <net/pfvar.h>.
DIOCGETTIMEOUT struct pfioc_tm *pt
Get the state timeout of timeout. The value is placed into the
seconds field.
DIOCCLRRULECTRS Clear per-rule statistics.
DIOCSETLIMIT struct pfioc_limit *pl

Set the hard limits on the memory pools used by the packet
filter. The pfioc_limit structure is defined as follows:
struct pfioc_limit {
int index;
unsigned limit;
};
enum { PF_LIMIT_STATES, PF_LIMIT_SRC_NODES,

PF_LIMIT_FRAGS };
DIOCGETLIMIT struct pfioc_limit *pl

Get the hard limit for the memory pool indicated by index.
DIOCRCLRTABLES struct pfioc_table *io

Clear all tables. All the ioctl() commands that manipulate radix
tables use the same structure described below. On exit from the
DIOCRCLRTABLES command, pfrio_ndel contains the number
of tables deleted. The pfioc_table structure is defined as
follows:
struct pfioc_table {
struct pfr_table pfrio_table;
void *pfrio_buffer;
int pfrio_esize;
int pfrio_size;
int pfrio_size2;
int pfrio_nadd;
int pfrio_ndel;
int pfrio_nchange;
int pfrio_flags;
u_int32_t pfrio_ticket;
};

#define pfrio_exists pfrio_nadd

#define pfrio_nzero pfrio_nadd
#define pfrio_nmatch pfrio_nadd
#define pfrio_naddr pfrio_size2
#define pfrio_setflag pfrio_size2
#define pfrio_clrflag pfrio_nadd
DIOCRADDTABLES struct pfioc_table *io

Create one or more tables. On entry, pfrio_buffer[pfrio_size]
contains a table of pfr_table structures. On exit, pfrio_nadd
contains the number of tables effectively created. The
pfr_table structure is defined as follows:
struct pfr_table {
char pfrt_anchor[MAXPATHLEN];
char pfrt_name[PF_TABLE_NAME_SIZE];
u_int32_t pfrt_flags;
u_int8_t pfrt_fback;
};
DIOCRDELTABLES struct pfioc_table *io

Delete one or more tables. On entry, pfrio_buffer[pfrio_size]
contains a table of pfr_table structures. On exit, pfrio_nadd
contains the number of tables effectively deleted.
DIOCRGETTABLES struct pfioc_table *io
Get a list of all tables. On entry, pfrio_buffer[pfrio_size]
contains a valid writeable buffer for pfr_table structures. On
exit, pfrio_size contains the number of tables written into the
buffer. If the buffer is too small, io-pkt doesn’t store anything,
but just returns the required buffer size, without error.
DIOCRGETTSTATS struct pfioc_table *io
This call is like DIOCRGETTABLES, but is used to get an array
of pfr_tstats structures. The pfr_tstats structure is
defined as follows:
struct pfr_tstats {
struct pfr_table pfrts_t;
u_int64_t pfrts_packets
[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
u_int64_t pfrts_bytes
[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
u_int64_t pfrts_match;
u_int64_t pfrts_nomatch;
long pfrts_tzero;
int pfrts_cnt;
int pfrts_refcnt[PFR_REFCNT_MAX];
};
#define pfrts_name pfrts_t.pfrt_name
#define pfrts_flags pfrts_t.pfrt_flags

DIOCRCLRTSTATS struct pfioc_table *io

Clear the statistics of one or more tables. On entry,
pfrio_buffer[pfrio_size] contains a table of pfr_table
structures. On exit, pfrio_nzero contains the number of tables
effectively cleared.
DIOCRCLRADDRS struct pfioc_table *io

Clear all addresses in a table. On entry, pfrio_table contains the
table to clear. On exit, pfrio_ndel contains the number of
addresses removed.
DIOCRADDADDRS struct pfioc_table *io
Add one or more addresses to a table. On entry, pfrio_table
contains the table ID, and pfrio_buffer[pfrio_size] contains the
list of pfr_addr structures to add. On exit, pfrio_nadd
contains the number of addresses effectively added.
The pfr_addr structure is defined as follows:
struct pfr_addr {
union {
struct in_addr _pfra_ip4addr;
struct in6_addr _pfra_ip6addr;
} pfra_u;
u_int8_t pfra_af;
u_int8_t pfra_net;
u_int8_t pfra_not;
u_int8_t pfra_fback;
};
#define pfra_ip4addr pfra_u._pfra_ip4addr
#define pfra_ip6addr pfra_u._pfra_ip6addr
DIOCRDELADDRS struct pfioc_table *io

Delete one or more addresses from a table. On entry,
pfrio_table contains the table ID, and pfrio_buffer[pfrio_size]
contains the list of pfr_addr structures to delete. On exit,
pfrio_ndel contains the number of addresses effectively deleted.
DIOCRSETADDRS struct pfioc_table *io

Replace the content of a table by a new address list. This is the
most complicated command, which uses all the structure
members.
On entry, pfrio_table contains the table ID, and
pfrio_buffer[pfrio_size] contains the new list of pfr_addr
structures. Additionally, if pfrio_size2 is nonzero,
pfrio_buffer[pfrio_size..pfrio_size2] must be a writeable buffer,
into which io-pkt can copy the addresses that have been
deleted during the replace operation.

On exit, pfrio_ndel, pfrio_nadd, and pfrio_nchange contain the

number of addresses deleted, added, and changed by io-pkt. If
pfrio_size2 was set on entry, pfrio_size2 points to the size of the
buffer used, exactly as for DIOCRGETADDRS.
DIOCRGETADDRS struct pfioc_table *io
Get all the addresses of a table. On entry, pfrio_table contains
the table ID, and pfrio_buffer[pfrio_size] contains a valid
writeable buffer for pfr_addr structures. On exit, pfrio_size
contains the number of addresses written into the buffer. If the
buffer is too small, io-pkt doesn’t store anything, but just
returns the required buffer size, without returning an error.
DIOCRGETASTATS struct pfioc_table *io
This call is like DIOCRGETADDRS, but is used to get an array of
pfr_astats structures:
struct pfr_astats {
struct pfr_addr pfras_a;
u_int64_t pfras_packets
[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
u_int64_t pfras_bytes
[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
long pfras_tzero;
};
DIOCRCLRASTATS struct pfioc_table *io

Clear the statistics of one or more addresses. On entry,
pfrio_table contains the table ID, and pfrio_buffer[pfrio_size]
contains a table of pfr_addr structures to clear. On exit,
pfrio_nzero contains the number of addresses effectively
cleared.
DIOCRTSTADDRS struct pfioc_table *io
Test if the given addresses match a table. On entry, pfrio_table
contains the table ID, and pfrio_buffer[pfrio_size] contains a
table of pfr_addr structures to test. On exit, io-pkt updates
the pfr_addr table by setting the pfra_fback member
appropriately.
DIOCRSETTFLAGS struct pfioc_table *io
Change the PFR_TFLAG_CONST or PFR_TFLAG_PERSIST
flags of a table. On entry, pfrio_buffer[pfrio_size] contains a
table of pfr_table structures, and pfrio_setflag contains the
flags to add, while pfrio_clrflag contains the flags to remove.
On exit, pfrio_nchange and pfrio_ndel contain the number of
tables altered or deleted by io-pkt.

You can delete tables if you remove the PFR_TFLAG_PERSIST flag of an unreferenced
table.
DIOCRINADEFINE struct pfioc_table *io
Define a table in the inactive set. On entry, pfrio_table contains
the table ID, and pfrio_buffer[pfrio_size] contains the list of
pfr_addr structures to put in the table. A valid ticket must also
be supplied to pfrio_ticket. On exit, pfrio_nadd contains 0 if
the table was already defined in the inactive list, or 1 if a new
table has been created. The pfrio_naddr member contains the
number of addresses effectively put in the table.
DIOCXBEGIN struct pfioc_trans *io
Clear all the inactive rule sets specified in the pfioc_trans_e
array. The pfioc_trans structure is defined as follows:
struct pfioc_trans {
int size; /* number of elements */
int esize; /* size of each element in bytes */
struct pfioc_trans_e {
int rs_num;
u_int32_t ticket;
} *array;
};
For each rule set, a ticket is returned for subsequent “add rule”
ioctl() commands, as well as for the DIOCXCOMMIT and
DIOCXROLLBACK calls.
Rule set types, identified by rs_num, include the following:
• PF_RULESET_SCRUB — scrub (packet normalization) rules.
• PF_RULESET_FILTER — filter rules.

• PF_RULESET_NAT — NAT (Network Address Translation)
rules.
• PF_RULESET_BINAT — bidirectional NAT rules.
• PF_RULESET_RDR — redirect rules.
• PF_RULESET_ALTQ — ALTQ disciplines.
• PF_RULESET_TABLE — address tables.
DIOCXCOMMIT struct pfioc_trans *io
Atomically switch a vector of inactive rule sets to the active rule
sets. This call is implemented as a standard two-phase commit,
which either fails for all rule sets, or completely succeeds. All
tickets need to be valid. This ioctl() command returns EBUSY if
another process is concurrently updating some of the same rule
sets.

DIOCXROLLBACK struct pfioc_trans *io

Clean up io-pkt by undoing all changes that have taken place
on the inactive rule sets since the last DIOCXBEGIN.
DIOCXROLLBACK silently ignores rule sets for which the ticket
is invalid.
DIOCSETHOSTID u_int32_t *hostid
Set the host ID, which is used by pfsync to identify which host
created state table entries.
DIOCOSFPFLUSH Flush the passive OS fingerprint table.
DIOCOSFPADD struct pf_osfp_ioctl *io

Add a passive OS fingerprint to the table. The pf_osfp_ioctl
struct pf_osfp_ioctl {
struct pf_osfp_entry {
SLIST_ENTRY(pf_osfp_entry) fp_entry;
pf_osfp_t fp_os;
char fp_class_nm[PF_OSFP_LEN];
char fp_version_nm[PF_OSFP_LEN];
char fp_subtype_nm[PF_OSFP_LEN];
} fp_os;
pf_tcpopts_t fp_tcpopts;
u_int16_t fp_wsize;
u_int16_t fp_psize;
u_int16_t fp_mss;
u_int16_t fp_flags;
u_int8_t fp_optcnt;
u_int8_t fp_wscale;
u_int8_t fp_ttl;
int fp_getnum;
};
Set fp_os.fp_os to the packed fingerprint, fp_os.fp_class_nm to

the name of the class (Linux, Windows, etc.),
fp_os.fp_version_nm to the name of the version (NT, 95, 98),
and fp_os.fp_subtype_nm to the name of the subtype or patch
level. The members fp_mss, fp_wsize, fp_psize, fp_ttl,
fp_optcnt, and fp_wscale are set to the TCP MSS, the TCP
window size, the IP length, the IP TTL, the number of TCP
options, and the TCP window scaling constant of the TCP SYN
packet, respectively.
The fp_flags member is filled according to the PF_OSFP_*
definition in <net/pfvar.h>. The fp_tcpopts member
contains packed TCP options. Each option uses
PF_OSFP_TCPOPT_BITS bits in the packed value. Options
include any of PF_OSFP_TCPOPT_NOP,
PF_OSFP_TCPOPT_SACK, PF_OSFP_TCPOPT_WSCALE,
PF_OSFP_TCPOPT_MSS, or PF_OSFP_TCPOPT_TS.

This ioctl() command doesn’t use the fp_getnum member.
You must zero the structure’s slack space for correct operation; memset() the whole
structure to zero before filling and sending it to io-pkt.
DIOCOSFPGET struct pf_osfp_ioctl *io
Get the passive OS fingerprint number fp_getnum from
io-pkt’s fingerprint list. The rest of the structure members
comes back filled. Get the whole list by repeatedly incrementing
the fp_getnum number until ioctl() gives an error of EBUSY.
DIOCGETSRCNODES struct pfioc_src_nodes *psn
Get the list of source nodes kept by sticky addresses and source
tracking. The pfioc_src_nodes structure is defined as
follows:
struct pfioc_src_nodes {
int psn_len;
union {
caddr_t psu_buf;
struct pf_src_node *psu_src_nodes;
} psn_u;
#define psn_buf psn_u.psu_buf
#define psn_src_nodes psn_u.psu_src_nodes
};
You must call ioctl() once with psn_len set to 0. If ioctl()

returns without error, psn_len is set to the size of the buffer
required to hold all the pf_src_node structures held in the table.
You should then allocate a buffer of this size and place a pointer
to this buffer in psn_buf . You must then call ioctl() again to fill
this buffer with the actual source node data. After that call,
psn_len is set to the length of the buffer actually used.
DIOCCLRSRCNODES Clear the tree of source-tracking nodes.
DIOCIGETIFACES struct pfioc_iface *io

Get a list of interfaces and interface drivers known to pf. All
the ioctl() commands that manipulate interfaces use the
structure described below:
struct pfioc_iface {
char pfiio_name[IFNAMSIZ];
void *pfiio_buffer;
int pfiio_esize;
int pfiio_size;
int pfiio_nzero;
int pfiio_flags;
};
#define PFI_FLAG_GROUP 0x0001 /* gets groups of interfaces */

#define PFI_FLAG_INSTANCE 0x0002 /* gets single interfaces */
#define PFI_FLAG_ALLMASK 0x0003

If it isn’t empty, you can use pfiio_name to restrict the search to

a specific interface or driver. The pfiio_buffer[pfiio_size]
member is the user-supplied buffer for returning the data. On
entry, pfiio_size represents the number of pfi_if entries that
can fit into the buffer. The io-pkt manager replaces this value
with the real number of entries it wants to return.
You should set pfiio_esize to sizeof(struct pfi_if). You
should set pfiio_flags to PFI_FLAG_GROUP,
PFI_FLAG_INSTANCE, or both, to tell io-pkt to return a group
of interfaces (drivers, such as fxp), real interface instances (e.g.
fxp1), or both. The data is returned in the pfi_if structure
described below:
struct pfi_if {
char pfif_name[IFNAMSIZ];
u_int64_t pfif_packets[2][2][2];
u_int64_t pfif_bytes[2][2][2];
u_int64_t pfif_addcnt;
u_int64_t pfif_delcnt;
long pfif_tzero;
int pfif_states;
int pfif_rules;
int pfif_flags;
};
#define PFI_IFLAG_GROUP 0x0001 /* group of interfaces */

#define PFI_IFLAG_INSTANCE 0x0002 /* single instance */
#define PFI_IFLAG_CLONABLE 0x0010 /* clonable group */
#define PFI_IFLAG_DYNAMIC 0x0020 /* dynamic group */
#define PFI_IFLAG_ATTACHED 0x0040 /* interface attached */
DIOCICLRISTATS struct pfioc_iface *io

Clear the statistics counters of one or more interfaces. You can
use pfiio_name and pfiio_flags to select which interfaces need
to be cleared. The filtering process is the same as for
DIOCIGETIFACES. The pfiio_nzero member is set by io-pkt
to the number of interfaces and drivers that have been cleared.
DIOCSETIFFLAG struct pfioc_iface *io
Set the user-setable flags of the pf internal interface
description:
• PFI_IFLAG_SKIP — skip the interface.
The filtering process is the same as for DIOCIGETIFACES.
DIOCCLRIFFLAG struct pfioc_iface *io

Similar to DIOCSETIFFLAG, but clear the flags.

Examples:
The following example demonstrates how to use the DIOCNATLOOK command to find
the internal host/port of a NATed connection:
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <sys/fcntl.h>
#include <net/if.h>
#include <netinet/in.h>
#include <net/pfvar.h>
#include <err.h>
#include <stdio.h>
#include <stdlib.h>
u_int32_t
read_address(const char *s)
{
int a, b, c, d;
sscanf(s, "%i.%i.%i.%i", &a, &b, &c, &d);

return htonl(a << 24 | b << 16 | c << 8 | d);
}
void
print_address(u_int32_t a)
{
a = ntohl(a);
printf("%d.%d.%d.%d", a >> 24 & 255, a >> 16 & 255,
a >> 8 & 255, a & 255);
}
int
main(int argc, char *argv[])
{
struct pfioc_natlook nl;
int dev;
if (argc != 5) {
printf("%s <gwy addr> <gwy port> <ext addr> <ext port>\n",
argv[0]);
return 1;
}
dev = open("/dev/pf", O_RDWR);

if (dev == -1)
err(1, "open(\"/dev/pf\") failed");
memset(&nl, 0, sizeof(struct pfioc_natlook));

nl.saddr.v4.s_addr = read_address(argv[1]);
nl.sport = htons(atoi(argv[2]));
nl.daddr.v4.s_addr = read_address(argv[3]);
nl.dport = htons(atoi(argv[4]));
nl.af = AF_INET;
nl.proto = IPPROTO_TCP;
nl.direction = PF_IN;
if (ioctl(dev, DIOCNATLOOK, &nl))

err(1, "DIOCNATLOOK");
printf("internal host ");

print_address(nl.rsaddr.v4.s_addr);

printf(":%u\n", ntohs(nl.rsport));
return 0;
}
Caveats:
The following functionality is missing from pf in this version of NetBSD:
• The pfsync protocol isn’t supported.
• The group keyword isn’t supported.
See also:
pfctl
ioctl() in the Neutrino Library Reference
altq, bridge, pflog in the NetBSD documentation at

/etc/pf.conf © 2010, QNX Software Systems GmbH & Co. KG.
Packet filter configuration file
Name:
/etc/pf.conf
Description:
The pf packet filter modifies, drops or passes packets according to rules or definitions
specified in pf.conf. The default location of this file is /etc/pf.conf.
Statement order
The pf.conf file can include the following types of statements:
Macros User-defined variables may be defined and used later, simplifying

the configuration file. Macros must be defined before they can be
referenced in pf.conf.
Tables Tables provide a mechanism for increasing the performance and

flexibility of rules with large numbers of source or destination
addresses.
Options Options tune the behavior of the packet filtering engine.
Traffic Normalization (e.g. scrub)

Traffic normalization protects internal machines against
inconsistencies in Internet protocols and implementations.
Queueing Queueing provides rule-based bandwidth control.
Translation (Various forms of NAT)

Translation rules specify how addresses are to be mapped or
redirected to other addresses.
Packet Filtering Stateful and stateless packet filtering provides rule-based blocking
or passing of packets.
With the exception of macros and tables, the types of statements should be grouped
and appear in pf.conf in the order shown above, as this matches the operation of the
underlying packet filtering engine. By default, pfctl enforces this order (see set
require-order below).
Macros
Much as for cpp or m4, you can define macros that will later be expanded in context.
Macro names must start with a letter, and may contain letters, digits and underscores.
Macro names may not be reserved words (for example, pass, in, out). Macros aren’t
expanded inside quotes.
For example:

© 2010, QNX Software Systems GmbH & Co. KG. /etc/pf.conf
ext_if = "kue0"
all_ifs = "{" $ext_if lo0 "}"
pass out on $ext_if from any to any keep state
pass in on $ext_if proto tcp from any to any port 25 keep state
Tables
Tables are named structures that can hold a collection of addresses and networks.
Lookups against tables in pf are relatively fast, making a single rule with tables much
more efficient, in terms of processor usage and memory consumption, than a large
number of rules that differ only in IP address (either created explicitly or automatically
by rule expansion).
You can use tables as the source or destination of filter rules, scrub rules or translation
rules such as nat or rdr (see below for details on the various rule types) You can also
use tables for the redirect address of nat and rdr rules and in the routing options of
filter rules, but only for round-robin pools.
You can define tables with any of the following pfctl mechanisms. As with macros,
reserved words may not be used as table names.
Manually Persistent tables can be manually created with the add or replace
option of pfctl, before or after the rule set has been loaded.
Via pf.conf Table definitions can be placed directly in this file, and loaded at the
same time as other rules are loaded, atomically. Table definitions
inside pf.conf use the table statement, and are especially useful to
define non-persistent tables. The contents of a pre-existing table
defined without a list of addresses to initialize it isn’t altered when
pf.conf is loaded. A table initialized with the empty list, { }, is
cleared on loading.
Tables may be defined with the following attributes:
persist Force io-pkt to keep the table even when no rules refer to it. If the flag
isn’t set, io-pkt automatically removes the table when the last rule
referring to it is flushed.
const Prevent the user from altering the contents of the table once it’s been
created. Without this flag, you can use pfctl to add or remove
addresses from the table at any time, even when running with
securelevel = 2.
For example:
table <private> const { 10/8, 172.16/12, 192.168/16 }

table <badhosts> persist
block on fxp0 from { <private>, <badhosts> } to any

creates a table called private, to hold RFC 1918 private network blocks, and a table
called badhosts, which is initially empty. A filter rule is set up to block all traffic
coming from addresses listed in either table.
The private table can’t have its contents changed, and the badhosts table will exist
even when no active filter rules refer to it. Addresses may later be added to the
badhosts table, so that traffic from these hosts can be blocked by using:
# pfctl -t badhosts -Tadd 204.92.77.111
A table can also be initialized with an address list specified in one or more external
files, using the following syntax:
table <spam> persist file "/etc/spammers" file "/etc/openrelays"
block on fxp0 from <spam> to any
The files /etc/spammers and /etc/openrelays list IP addresses, one per line.
Any lines beginning with a # are treated as comments and ignored. In addition to
being specified by IP address, hosts may also be specified by their hostname. When
the resolver is called to add a hostname to a table, all resulting IPv4 and IPv6
addresses are placed into the table. IP addresses can also be entered in a table by
specifying a valid interface name or the self keyword, in which case all addresses
assigned to the interface(s) are added to the table.
Options
You can tune pf for various situations by using the set command:
set timeout arguments

Set the timeout specified by the arguments:
• interval — the interval between the purging of expired states
and fragments.
• frag — the number of seconds before an unassembled fragment
is expired.
• src.track — the length of time to retain a source-tracking entry
after the last state expires.
When a packet matches a stateful connection, the seconds to live for
the connection is updated to that of the proto.modifier that
corresponds to the connection state. Each packet that matches this
state resets the TTL. Tuning these values may improve the
performance of the firewall, at the risk of dropping valid idle
connections.
• tcp.first — the state after the first packet.
• tcp.opening — the state before the destination host ever sends
a packet.
• tcp.established — the fully established state.
• tcp.closing — the state after the first FIN has been sent.

• tcp.finwait — the state after both FINs have been exchanged

and the connection is closed. Some hosts (notably web servers on
Solaris) send TCP packets even after closing the connection.
Increasing the value of tcp.finwait (and possibly that of
tcp.closing) can prevent blocking of such packets.
• tcp.closed — the state after one endpoint sends an RST.
ICMP and UDP are handled in a fashion similar to TCP, but with a
much more limited set of states:
• udp.first — the state after the first packet.
• udp.single — the state if the source host sends more than one
packet but the destination host has never sent one back.
• udp.multiple — the state if both hosts have sent packets.
• icmp.first — the state after the first packet.
• icmp.error — the state after an ICMP error came back in
response to an ICMP packet.
Other protocols are handled similarly to UDP:
• other.first
• other.single
• other.multiple
Timeout values can be reduced adaptively as the number of state table
entries grows.
• adaptive.start — when the number of state entries exceeds
this value, adaptive scaling begins. All timeout values are scaled
linearly with factor (adaptive.end − number of states) /
(adaptive.end − adaptive.start).
• adaptive.end — when reaching this number of state entries, all
timeout values become zero, effectively purging all state entries
immediately. This value is used to define the scale factor; it
shouldn’t actually be reached (set a lower state limit, see below).
You can define these values both globally and for each rule. When
used on a per-rule basis, the values relate to the number of states
created by the rule, otherwise to the total number of states. For
example:
set timeout tcp.first 120
set timeout tcp.established 86400
set timeout { adaptive.start 6000, adaptive.end 12000 }
set limit states 10000
With 9000 state table entries, the timeout values are scaled to 50%
(tcp.first 60, tcp.established 43200).

set loginterface
Enable the collection of packet and byte count statistics for the given
interface. To view these statistics, use:
pfctl -s info
In this example, pf collects statistics on the interface named dc0:
set loginterface dc0
You can disable the log interface by using:
set loginterface none
set limit Set hard limits on the memory pools used by the packet filter. For
example:
set limit states 20000
sets the maximum number of entries in the memory pool used by state
table entries (generated by keep state rules) to 20000. This command:
set limit frags 20000
sets the maximum number of entries in the memory pool used for
fragment reassembly (generated by scrub rules) to 20000. This
command:
set limit src-nodes 2000
sets the maximum number of entries in the memory pool used for
tracking source IP addresses (generated by the sticky-address and
source-track options) to 2000.
You can combine them:
set limit { states 20000, frags 20000, src-nodes 2000 }
set optimization
Optimize the engine for one of the following network environments:
• normal — a normal network environment. Suitable for almost all
networks.
• high-latency — a high-latency environment (such as a satellite
connection).
• satellite — alias for high-latency.

• aggressive — aggressively expire connections. This can greatly

reduce the memory usage of the firewall, at the cost of dropping
idle connections early.
• conservative — extremely conservative settings. Avoid
dropping legitimate connections at the expense of greater memory
use (possibly much greater on a busy network) and slightly
increased processor utilization.
For example:
set optimization aggressive
set block-policy
Set the default behavior for the packet block action:
• drop — the packet is silently dropped.
• return — a TCP RST is returned for blocked TCP packets, an
ICMP UNREACHABLE is returned for blocked UDP packets,
and all other packets are silently dropped.
For example:
set block-policy return
set state-policy
Set the default behavior for states:
• if-bound — states are bound to interface.
• group-bound — states are bound to interface group (e.g. ppp).
• floating — states can match packets on any interfaces (the
default).
For example:
set state-policy if-bound
set require-order
By default, pfctl enforces an ordering of the statement types in the
rule set to: options, normalization, queueing, translation, and
filtering. Setting this option to no disables this enforcement.

There may be non-trivial and non-obvious implications to an out-of-order rule set.

Consider carefully before disabling the order enforcement.
set fingerprints
Load fingerprints of known operating systems from the given file
name. By default, fingerprints of known operating systems are
automatically loaded from /etc/pf.os, but you can override the
path with this option. For example:
set fingerprints "/etc/pf.os.devel"
Setting this option may leave a small period of time where the
fingerprints referenced by the currently active rule set are inconsistent
until the new rule set finishes loading.
set skip on ifspec

List the interfaces for which packets shouldn’t be filtered. Packets
passing in or out on such interfaces are passed as if pf were disabled,
i.e. pf doesn’t process them in any way. This can be useful on
loopback and other virtual interfaces, when packet filtering isn’t
desired and can have unexpected effects. For example:
set skip on lo0
set debug Set the debug level to one of the following:

• none — don’t generate debug messages.
• urgent — generate debug messages only for serious errors.
• misc — generate debug messages for various errors.
• loud — generate debug messages for common conditions.
Traffic normalization
Traffic normalization is used to sanitize packet content in such a way that there are no
ambiguities in packet interpretation on the receiving side. The normalizer does IP
fragment reassembly to prevent attacks that confuse intrusion detection systems by
sending overlapping IP fragments. Packet normalization is invoked with the scrub
directive, which has the following options:
no-df Clear the dont-fragment bit from a matching IP packet.

Some operating systems are known to generate fragmented
packets with the dont-fragment bit set. This is particularly
true with NFS. Scrub will drop such fragmented
dont-fragment packets unless you specify no-df.

Unfortunately some operating systems also generate their

dont-fragment packets with a IP identification field of zero.
Clearing the dont-fragment bit on packets with a zero IP ID
may cause deleterious results if an upstream router later
fragments the packet. Using the random-id modifier (see
below) is recommended in combination with the no-df
modifier to ensure unique IP identifiers.
min-ttl number Enforce a minimum TTL for matching IP packets.
max-mss number Enforce a maximum MSS for matching TCP packets.
random-id Replace the IP identification field with random values to

compensate for predictable values generated by many hosts.
This option applies only to packets that aren’t fragmented after
the optional fragment reassembly.
fragment reassemble
Using scrub rules, fragments can be reassembled by
normalization. In this case, fragments are buffered until they
form a complete packet, and only the completed packet is
passed on to the filter. The advantage is that filter rules have to
deal only with complete packets, and can ignore fragments. The
drawback of caching fragments is the additional memory cost.
But the full reassembly method is the only method that
currently works with NAT. This is the default behavior of a
scrub rule if no fragmentation modifier is supplied.
fragment crop The default fragment reassembly method is expensive, hence

the option to crop is provided. In this case, pf tracks the
fragments and caches a small range descriptor. Duplicate
fragments are dropped, and overlaps are cropped. Thus data
will occur only once on the wire with ambiguities resolving to
the first occurrence. Unlike the fragment reassemble
modifier, fragments aren’t buffered; they’re passed as soon as
they’re received. The fragment crop reassembly mechanism
doesn’t yet work with NAT.
fragment drop-ovl
This option is similar to the fragment crop modifier, except
that all overlapping or duplicate fragments are dropped, and all
further corresponding fragments are dropped as well.
reassemble tcp Statefully normalize TCP connections. The scrub reassemble

tcp rules may not have the direction (in/out) specified. The
reassemble tcp performs the following normalizations:
• ttl — neither side of the connection is allowed to reduce

their IP TTL. An attacker may send a packet such that it

reaches the firewall, affects the firewall state, and expires

before reaching the destination host. The reassemble tcp
command raises the TTL of all packets back up to the
highest value seen on the connection.
• timestamp modulation — modern TCP stacks send a
timestamp on every TCP packet and echo the other
endpoint’s timestamp back to them. Many operating systems
will merely start the timestamp at zero when first booted,
and increment it several times a second. The uptime of the
host can be deduced by reading the timestamp and
multiplying it by a constant. Also observing several different
timestamps can be used to count hosts behind a NAT device.
And spoofing TCP packets into a connection requires
knowing or guessing valid timestamps. Timestamps merely
need to be monotonically increasing and not derived off a
guessable base time. The reassemble tcp command will
cause scrub to modulate the TCP timestamps with a random
number.
• extended PAWS checks — there’s a problem with TCP
on long fat pipes, in that a packet might get delayed for
longer than it takes the connection to wrap its 32-bit
sequence space. In such an occurrence, the old packet would
be indistinguishable from a new packet and would be
accepted as such. The solution to this is called PAWS:
Protection Against Wrapped Sequence numbers. It protects
against it by making sure the timestamp on each packet
doesn’t go backwards. The reassemble tcp command
also makes sure the timestamp on the packet doesn’t go
forward more than the RFC allows. By doing this, pf
artificially extends the security of TCP sequence numbers by
10 to 18 bits when the host uses appropriately randomized
timestamps, since a blind attacker would have to guess the
timestamp as well.
For example:
scrub in on $ext_if all fragment reassemble
The no option prefixed to a scrub rule causes matching packets to remain unscrubbed,
much in the same way as drop quick works in the packet filter (see below). This
mechanism should be used when it is necessary to exclude specific packets from
broader scrub rules.

Queueing
Packets can be assigned to queues for the purpose of bandwidth control. At least two
declarations are required to configure queues, and later any packet filtering rule can
reference the defined queues by name. During the filtering component of pf.conf,
the last referenced queue name is where any packets from pass rules will be queued,
while for block rules it specifies where any resulting ICMP or TCP RST packets
should be queued. The scheduler defines the algorithm used to decide which packets
get delayed, dropped, or sent out immediately.
The currently supported schedulers are:
cbq Class Based Queueing. Queues attached to an interface build a tree, and thus
each queue can have further child queues. Each queue can have a priority
and a bandwidth assigned. Priority mainly controls the time packets take to
get sent out, while bandwidth has primarily effects on throughput.
The cbq scheduler achieves both partitioning and sharing of link bandwidth
by hierarchically structured classes. Each class has its own queue and is
assigned its share of bandwidth. A child class can borrow bandwidth from
its parent class, as long as excess bandwidth is available (see the option
borrow, below).
priq Priority Queueing. Queues are flat attached to the interface, and thus queues
can’t have further child queues. Each queue has a unique priority assigned,
ranging from 0 to 15. Packets in the queue with the highest priority are
processed first.
hfsc Hierarchical Fair Service Curve. Queues attached to an interface build a tree,
and thus each queue can have further child queues. Each queue can have a
priority and a bandwidth assigned. Priority mainly controls the time packets
take to get sent out, while bandwidth has primarily effects on throughput.
The hfsc scheduler supports both link-sharing and guaranteed realtime
services. It employs a service-curve-based QoS model, and its unique
feature is an ability to decouple delay and bandwidth allocation.
The interfaces on which queueing should be activated are declared using the altq on
declaration, which has the following keywords:
interface Enable queueing on the named interface.
scheduler Specify which queueing scheduler to use. Currently supported

values are:
• cbq — Class Based Queueing
• priq — Priority Queueing
• hfsc — Hierarchical Fair Service Curve

bandwidth bw The maximum bit rate for all queues on an interface. You can
specify the value as an absolute value or as a percentage of the
interface bandwidth. When using an absolute value, you can use
the suffixes b, Kb, Mb, and Gb to represent bits, kilobits, megabits,
and gigabits per second, respectively. The value mustn’t exceed
the interface bandwidth. If you don’t specify bandwidth, the
interface bandwidth is used.
qlimit limit The maximum number of packets held in the queue. The default
is 50.
tbrsize size Adjust the size, in bytes, of the token bucket regulator. If not
specified, heuristics based on the interface bandwidth are used to
determine the size.
queue list Define a list of subqueues to create on an interface.

In the following example, the interface dc0 should queue up to 5
Mbit/s in four second-level queues using Class Based Queueing.
Those four queues will be shown in a later example:
altq on dc0 cbq bandwidth 5Mb queue { std, http, mail, ssh }
Once interfaces are activated for queueing using the altq

directive, you can define a sequence of queue directives. The
name associated with a queue must match a queue defined in the
altq directive (e.g. mail), or — except for the priq scheduler
— in a parent queue declaration. You can use the following
keywords:
• on interface — the interface the queue operates on. If not
given, the queue operates on all matching interfaces.
• bandwidth bw — the maximum bit rate to be processed by
the queue. This value mustn’t exceed the value of the parent
queue, and you can specify it as an absolute value or a
percentage of the parent queue’s bandwidth. If you don’t
specify this keyword, the bandwidth defaults to 100% of the
parent queue’s bandwidth. The priq scheduler doesn’t
support bandwidth specification.
• priority level — between queues, a priority level can be set.
For cbq and hfsc, the range is 0 to 7; for priq, the range is 0
to 15. The default for all is 1. PRIQ queues with a higher
priority are always served first. CBQ and HFSC queues with a
higher priority are preferred in the case of overload.
• qlimit limit — the maximum number of packets held in the
queue. The default is 50.
The scheduler can get additional parameters with scheduler(
parameters ). The parameters are as follows:

• default — packets not matched by another queue are

assigned to this one. Exactly one default queue is required.
• red — enable RED (Random Early Detection) on this queue.
RED drops packets with a probability proportional to the
average queue length.
• rio — enable RIO on this queue. RIO is RED with IN/OUT,
so running RED two times more than RIO would achieve the
same effect. RIO isn’t currently supported in the GENERIC
kernel.
• ecn — enable ECN (Explicit Congestion Notification) on this
queue. ECN implies RED.
The CBQ scheduler supports an additional option:
• borrow — the queue can borrow bandwidth from the parent.
The HFSC scheduler supports some additional options (sc is an
acronym for service curve):
• realtime sc — the minimum required bandwidth for the
queue.
• upperlimit sc — the maximum allowed bandwidth for the
queue.
• linkshare sc — the bandwidth share of a backlogged queue.
The format for service curve specifications is (m1, d, m2). The m2
variable controls the bandwidth assigned to the queue, while m1
and d are optional and can be used to control the initial bandwidth
assignment. For the first d milliseconds, the queue gets the
bandwidth given as m1, and afterward, the value given in m2.
Furthermore, with CBQ and HFSC, child queues can be specified
as in an altq declaration, thus building a tree of queues using a
part of their parent’s bandwidth.
Packets can be assigned to queues based on filter rules by using
the queue keyword. Normally only one queue is specified; when
a second one is specified, it’s used instead for packets that have a
TOS of lowdelay and for TCP ACKs with no data payload.
To continue the previous example, the examples below specify the
four referenced queues, plus a few child queues. The queues may
then be referenced by filtering rules (see “Packet filtering,”
below).
queue std bandwidth 10% cbq(default)
queue http bandwidth 60% priority 2 cbq(borrow red) \
{ employees, developers }
queue developers bandwidth 75% cbq(borrow)
queue employees bandwidth 15%
queue mail bandwidth 10% priority 0 cbq(borrow ecn)

queue ssh bandwidth 20% cbq(borrow) { ssh_interactive, ssh_bulk }

queue ssh_interactive bandwidth 50% priority 7 cbq(borrow)
queue ssh_bulk bandwidth 50% priority 0 cbq(borrow)
block return out on dc0 inet all queue std

pass out on dc0 inet proto tcp from $developerhosts to any port 80 \
keep state queue developers
pass out on dc0 inet proto tcp from $employeehosts to any port 80 \
keep state queue employees
pass out on dc0 inet proto tcp from any to any port 22 \
keep state queue(ssh_bulk, ssh_interactive)
pass out on dc0 inet proto tcp from any to any port 25 \
keep state queue mail
Translation
Translation rules modify either the source or destination address of the packets
associated with a stateful connection. A stateful connection is automatically created to
track packets matching such a rule as long as they aren’t blocked by the filtering
section of pf.conf. The translation engine modifies the specified address and/or port
in the packet, recalculates IP, TCP and UDP checksums as necessary, and passes it to
the packet filter for evaluation.
Since translation occurs before filtering the filter engine will see packets as they look
after any addresses and ports have been translated. Filter rules will therefore have to
filter based on the translated address and port number. Packets that match a translation
rule are automatically passed only if the pass modifier is given; otherwise they’re still
subject to block and pass rules.
The state entry created permits pf to keep track of the original address for traffic
associated with that state and correctly direct return traffic for that connection.
Various types of translation are possible with pf:
binat Specifies a bidirectional mapping between an external IP netblock and an

internal IP netblock.
nat Specifies that IP addresses are to be changed as the packet traverses the
given interface. This technique allows one or more IP addresses on the
translating host to support network traffic for a larger range of machines on
an “inside” network. Although in theory any IP address can be used on the
inside, it is strongly recommended that one of the address ranges defined
by RFC 1918 be used. These netblocks are:
• 10.0.0.0–10.255.255.255 (all of net 10, i.e. 10/8)
• 172.16.0.0–172.31.255.255 (i.e., 172.16/12)
• 192.168.0.0–192.168.255.255 (i.e., 192.168/16)
rdr The packet is redirected to another destination and possibly a different

port. The rdr rules can optionally specify port ranges instead of single
ports. For example:

rdr ... port 2000:2999 -> ... port 4000
redirects ports 2000 to 2999 (inclusive) to port 4000. This command:
rdr ... port 2000:2999 -> ... port 4000:*
redirects port 2000 to 4000, 2001 to 4001, ..., 2999 to 4999.
In addition to modifying the address, some translation rules may modify source or
destination ports for TCP or UDP connections; implicitly in the case of nat rules and
explicitly in the case of rdr rules. Port numbers are never translated with a binat
rule.
For each packet processed by the translator, the translation rules are evaluated in
sequential order, from first to last. The first matching rule decides what action is taken.
The no option prefixed to a translation rule causes packets to remain untranslated,
much in the same way as drop quick works in the packet filter (see below). If no
rule matches the packet, the packet is passed to the filter engine unmodified.
Translation rules apply only to packets that pass through the specified interface, and if
no interface is specified, translation is applied to packets on all interfaces. For
instance, redirecting port 80 on an external interface to an internal web server works
only for connections originating from the outside. Connections to the address of the
external interface from local hosts aren’t redirected, since such packets don’t actually
pass through the external interface. Redirections can’t reflect packets back through the
interface they arrive on; they can only be redirected to hosts connected to different
interfaces or to the firewall itself.
Note that redirecting external incoming connections to the loopback address, as in:
rdr on ne3 inet proto tcp to port 8025 -> 127.0.0.1 port 25
effectively allows an external host to connect to daemons bound solely to the loopback
address, circumventing the traditional blocking of such connections on a real interface.
Unless this effect is desired, any of the local non-loopback addresses should be used as
redirection target instead, which allows external connections only to daemons bound
to this address or not bound to any address.
See “Translation examples,” below.
Packet filtering
The pf pseudo-device can block and pass packets based on attributes of their layer-3
(see IP and IPv6 in the Neutrino Library Reference) and layer-4 (see ICMP, ICMP6,
TCP, and UDP) headers. In addition, packets may also be assigned to queues for the
purpose of bandwidth control.
For each packet processed by the packet filter, the filter rules are evaluated in
sequential order, from first to last. The last matching rule decides what action is taken.
You can use the following actions in the filter:

block Block the packet. There are a number of ways in which a block rule can
behave when blocking a packet. The default behavior is to drop packets
silently, however you can override this or make it explicit either globally,
by setting the block-policy option, or on a per-rule basis with one of the
following options:
• drop — silently drop the packet.
• return-rst — this applies only to TCP packets, and issues a TCP
RST that closes the connection.
• return-icmp, return-icmp6 — cause ICMP messages to be
returned for packets that match the rule. By default, this is an ICMP
UNREACHABLE message, however you can override this by
specifying a message as a code or number.
• return — cause a TCP RST to be returned for TCP packets and an
ICMP UNREACHABLE for UDP and other packets.
Options returning ICMP packets currently have no effect if pf operates on
a bridge, as the code to support this feature hasn’t yet been implemented.
pass Pass the packet.
If no rule matches the packet, the default action is to pass it. To block everything by
default and pass only packets that match explicit rules, use:
block all
as the first filter rule.

See “Filter examples,” below.
Parameters
The rule parameters specify the packets to which a rule applies. A packet always
comes in on, or goes out through, one interface. Most parameters are optional. If a
parameter is specified, the rule applies only to packets with matching attributes.
Certain parameters can be expressed as lists, in which case pfctl generates all
needed rule combinations.
in or out This rule applies to incoming or outgoing packets. If you specify

neither in nor out, the rule matches packets in both directions.
log In addition to the action specified, generate a log message. All
packets for that connection are logged, unless the keep state,
modulate state or synproxy state options are specified, in
which case only the packet that establishes the state is logged.
(See keep state, modulate state and synproxy state
below). The logged packets are sent to the pflog interface. This
interface is monitored by the pflogd logging daemon, which
dumps the logged packets to the file /var/log/pflog in pcap
binary format.

log-all Used with keep state, modulate state or synproxy

state rules to force logging of all packets for a connection. As
with log, packets are logged to pflog.
quick If a packet matches a rule that has the quick option set, this rule
is considered the last matching rule, and evaluation of subsequent
rules is skipped.
on interface This rule applies only to packets coming in on, or going out
through, this particular interface. It’s also possible to simply give
the interface driver name, such as ppp or fxp, to make the rule
match packets flowing through a group of interfaces.
af This rule applies only to packets of this address family. Supported

values are inet and inet6.
proto protocol This rule applies only to packets of this protocol. Common
protocols are ICMP, ICMP6, TCP, and UDP. For a list of all the
protocol name-to-number mappings used by pfctl, see the file
/etc/protocols.
from source port source os source to dest port dest

This rule applies only to packets with the specified source and
destination addresses and ports. You can specify addresses in
CIDR notation (matching netblocks), as symbolic host names or
interface names, or as any of the following keywords:
• any — any address.
• route label — any address whose associated route has the
label specified by label. See the ROUTE protocol (in the
Neutrino Library Reference) and the route utility.
• no-route — any address that isn’t currently routable.
• table — any address that matches the given table.
Interface names can have modifiers appended:
• :network — translates to the network(s) attached to the
interface.
• :broadcast — translates to the interface’s broadcast
address(es).
• :peer — translates to the point-to-point interface’s peer
address(es).
• :0 — don’t include interface aliases.
Host names may also have the :0 option appended to restrict the
name resolution to the first of each v4 and v6 address found.
Host-name resolution and interface-to-address translation are
done when the rule set is loaded. When the address of an interface

(or host name) changes (under DHCP or PPP, for instance), the
rule set must be reloaded for the change to be reflected in io-pkt.
Surrounding the interface name (and optional modifiers) in
parentheses changes this behavior: the rule is automatically
updated whenever the interface changes its address. The rule set
doesn’t need to be reloaded. This is especially useful with nat.
You can specify ports either by number or by name. For example,
port 80 can be specified as www. For a list of all port
name-to-number mappings used by pfctl, see the file
/etc/services.
You can use these operators to specify ports and ranges of ports:
Operator Meaning
= Equal to
!= Unequal to
< Less than
<= Less than or equal to
> Greater than
>= Greater than or equal to
: Range, including boundaries
>< Range, excluding boundaries
<> Except range
The ><, <> and : operators are binary; they take two arguments.
For instance:
This: Means:
port 2000:2004 All ports ≥ 2000 and ≤ 2004; hence ports
2000, 2001, 2002, 2003 and 2004
port 2000 >< 2004 All ports > 2000 and < 2004; hence ports
2001, 2002 and 2003
port 2000 <> 2004 All ports < 2000 or > 2004; hence ports
1-1999 and 2005-65535
The operating system of the source host can be specified in the

case of TCP rules with the OS modifier. See “Operating system
fingerprinting” for more information.
The host, port and OS specifications are optional, as in the
following examples:

pass in all
pass in from any to any
pass in proto tcp from any port <= 1024 to any
pass in proto tcp from any to any port 25
pass in proto tcp from 10.0.0.0/8 port > 1024 \
to ! 10.1.2.3 port != ssh
pass in proto tcp from any os "OpenBSD" flags S/SA
pass in proto tcp from route "DTAG"
all This is equivalent to from any to any.

group group This functionality isn’t supported in this version of NetBSD.
user user This rule applies only to packets of sockets owned by the
specified user. For outgoing connections initiated from the
firewall, this is the user that opened the connection. For incoming
connections to the firewall itself, this is the user that listens on the
destination port. For forwarded connections, where the firewall
isn’t a connection endpoint, the user and group are unknown.
All packets, both outgoing and incoming, of one connection are
associated with the same user and group. Only TCP and UDP
packets can be associated with users; for other protocols these
parameters are ignored.
User and group refer to the effective (as opposed to the real) IDs,
in case the socket is created by a setuid or setgid process.
User and group IDs are stored when a socket is created; when a
process creates a listening socket as root (for instance, by
binding to a privileged port) and subsequently changes to another
user ID (to drop privileges), the credentials will remain root.
You can specify user and group IDs as either numbers or names.
The syntax is similar to the one for ports. The value unknown
matches packets of forwarded connections. You can use unknown
only with the operators = and !=. Other constructions, such as
user >= unknown, are invalid. Forwarded packets with
unknown user and group ID match only rules that explicitly
compare against unknown with the operators = or !=. For
instance, user >= 0 doesn’t match forwarded packets. The
following example allows only selected users to open outgoing
connections:
block out proto { tcp, udp } all
pass out proto { tcp, udp } all \
user { < 1000, dhartmei } keep state
flags a/b | /b This rule applies only to TCP packets that have the flags a set out
of set b. Flags not specified in b are ignored. The flags are: (F)IN,
(S)YN, (R)ST, (P)USH, (A)CK, (U)RG, (E)CE, and C(W)R. For
example:

This: Means:
flags S/S Flag SYN is set. The other flags are ignored.
flags S/SA Out of SYN and ACK, exactly SYN may be set.
SYN, SYN+PSH and SYN+RST match, but
SYN+ACK, ACK and ACK+RST don’t. This is
more restrictive than the previous example.
flags /SFRA If the first set isn’t specified, it defaults to none.
All of SYN, FIN, RST and ACK must be unset.
icmp-type type code code

icmp6-type type code code
This rule applies only to ICMP or ICMPv6 packets with the
specified type and code. Text names for ICMP types and codes
are listed in the entries for ICMP and ICMP6 in the Neutrino
Library Reference. This parameter is valid only for rules that
cover protocols ICMP or ICMP6. The protocol and the ICMP
type indicator (icmp-type or icmp6-type) must match.
tos string | number
This rule applies to packets with the specified TOS bits set. TOS
may be given as one of lowdelay, throughput, reliability,
or as either hexadecimal or decimal. For example, the following
rules are identical:
• pass all tos lowdelay
• pass all tos 0x10
• pass all tos 16
allow-opts By default, packets that contain IP options are blocked. When you
specify allow-opts for a pass rule, packets that pass the filter
based on that rule (last matching) do so even if they contain IP
options. For packets that match a state, the rule that initially
created the state is used. The implicit pass rule that’s used when
a packet doesn’t match any rules doesn’t allow IP options.
label string Add a label (name) to the rule, which you can use to identify the
rule. For instance, pfctl -s labels shows per-rule statistics
for rules that have labels.
You can use the following macros in labels:

Macro Meaning
$if The interface
$srcaddr The source IP address
$dstaddr The destination IP address
$srcport The source port specification
$dstport The destination port specification
$proto The protocol name
$nr The rule number
For example:
ips = "{ 1.2.3.4, 1.2.3.5 }"
pass in proto tcp from any to $ips \
port > 1023 label "$dstaddr:$dstport"
expands to:
pass in inet proto tcp from any to 1.2.3.4 \
port > 1023 label "1.2.3.4:>1023"
pass in inet proto tcp from any to 1.2.3.5 \
port > 1023 label "1.2.3.5:>1023"
The macro expansion for the label directive occurs only when the
configuration file is parsed, not during runtime.
queue queue | (queue, queue)
Packets matching this rule are assigned to the specified queue. If
you specify two queues, packets that have a TOS of lowdelay
and TCP ACKs with no data payload are assigned to the second
one. See “Queueing,” for setup details. For example:
pass in proto tcp to port 25 queue mail
pass in proto tcp to port 22 queue(ssh_bulk, ssh_prio)
tag string Packets matching this rule are tagged with the specified string.
The tag acts as an internal marker that can be used to identify
these packets later on. You can use this, for example, to provide
trust between interfaces and to determine if packets have been
processed by translation rules.
Tags are “sticky”, meaning that the packet is tagged even if the
rule isn’t the last matching rule. Further matching rules can
replace the tag with a new one, but don’t remove a previously
applied tag. A packet is only ever assigned one tag at a time. Any
pass rules that use the tag keyword must also use keep state,
modulate state or synproxy state.

You can tag packets during nat, rdr, or binat rules in addition
to filter rules. Tags take the same macros as labels (see above).
tagged string Used with filter or translation rules to specify that packets must
already be tagged with the given tag in order to match the rule.
You can also do inverse tag matching by specifying the ! operator
before the tagged keyword.
probability number
A probability attribute can be attached to a rule, with a value set
between 0 and 1, bounds not included. In that case, the rule is
honored using the given probability value only. For example, the
following rule drops 20% of incoming ICMP packets:
block in proto icmp probability 20%
Routing
If a packet matches a rule with a route option set, the packet filter routes the packet
according to the type of route option. When such a rule creates state, the route option
is also applied to all packets matching the same connection.
fastroute Do a normal route lookup to find the next hop for the packet.
route-to Route the packet to the specified interface with an optional address
for the next hop. When a route-to rule creates state, only packets
that pass in the same direction as the filter rule specifies are routed in
this way. Packets passing in the opposite direction (replies) aren’t
affected and are routed normally.
reply-to Similar to route-to, but routes packets that pass in the opposite
direction (replies) to the specified interface. Opposite direction is
defined only in the context of a state entry, and reply-to is useful
only in rules that create state. You can use it on systems with multiple
external connections to route all outgoing packets of a connection
through the interface the incoming connection arrived through
(symmetric routing enforcement).
dup-to Create a duplicate of the packet and route it like route-to. The
original packet gets routed as it normally would.
Pool options
For nat and rdr rules, (as well as for the route-to, reply-to and dup-to rule
options) for which there is a single redirection address that has a subnet mask smaller
than 32 for IPv4 or 128 for IPv6 (more than one IP address), you can use a variety of
different methods for assigning this address:

bitmask Apply the network portion of the redirection address to the address
to be modified (source with nat, destination with rdr).
random Select an address at random within the defined block of addresses.
source-hash Use a hash of the source address to determine the redirection

address, ensuring that the redirection address is always the same
for a given source. You can optionally specify a key after this
keyword either in hexadecimal or as a string; by default, pfctl
randomly generates a key for source-hash every time the rule
set is reloaded.
round-robin Loop through the redirection address(es).

When more than one redirection address is specified,
round-robin is the only permitted pool type.
static-port With nat rules, prevent pf from modifying the source port on
TCP and UDP packets.
Additionally, you can specify the sticky-address option to help ensure that
multiple connections from the same source are mapped to the same redirection
address. You can use this option with the random and round-robin pool options.
Note that by default, these associations are destroyed as soon as there are no longer
states that refer to them; in order to make the mappings last beyond the lifetime of the
states, increase the global options with set timeout source-track. See “Stateful
tracking options” for more ways to control the source tracking.
Stateful inspection
The pf packet filter is stateful, which means it can track the state of a connection.
Instead of passing all traffic to port 25, for instance, it’s possible to pass only the initial
packet, and then begin to keep state. Subsequent traffic will flow because the filter is
aware of the connection.
If a packet matches a pass ... keep state rule, the filter creates a state for this
connection and automatically lets pass all subsequent packets of that connection.
Before any rules are evaluated, the filter checks whether the packet matches any state.
If it does, the packet is passed without evaluation of any rules.
States are removed after the connection is closed or has timed out.
This has several advantages:
• Comparing a packet to a state involves checking its sequence numbers. If the

sequence numbers are outside the narrow windows of expected values, the packet is
dropped. This prevents spoofing attacks, such as when an attacker sends packets
with a fake source address/port but doesn’t know the connection’s sequence
numbers.

• Looking up states is usually faster than evaluating rules. If there are 50 rules, all of
them are evaluated sequentially in O(n). Even with 50000 states, only 16
comparisons are needed to match a state, since states are stored in a binary search
tree that allows searches in O(log2 n).
For instance:
block all
pass out proto tcp from any to any flags S/SA keep state
pass in proto tcp from any to any port 25 flags S/SA keep state
This rule set blocks everything by default. Only outgoing connections and incoming
connections to port 25 are allowed. The initial packet of each connection has the SYN
flag set, will be passed and creates state. All further packets of these connections are
passed if they match a state.
By default, packets coming in and out of any interface can match a state, but it’s also
possible to change that behavior by assigning states to a single interface or a group of
interfaces.
The default policy is specified by the state-policy global option, but you can adjust this
on a per-rule basis by adding one of the if-bound, group-bound, or floating
keywords to the keep state option. For example, if a rule is defined as:
pass out on ppp from any to 10.12/16 keep state (group-bound)
a state created on ppp0 would match packets an all PPP interfaces, but not packets
flowing through fxp0 or any other interface.
Keeping rules floating is the more flexible option when the firewall is in a dynamic
routing environment. However, this has some security implications, since a state
created by one trusted network could allow potentially hostile packets coming in from
other interfaces.
Specifying flags S/SA restricts state creation to the initial SYN packet of the TCP
handshake. You can also be less restrictive, and allow state creation from intermediate
(non-SYN) packets. This causes pf to synchronize to existing connections, for
instance if you flush the state table.
For UDP, which is stateless by nature, keep state creates state as well. UDP
packets are matched to states using only host addresses and ports.
ICMP messages fall into two categories: ICMP error messages, which always refer to
a TCP or UDP packet, are matched against the referred to connection. If you keep
state on a TCP connection, and an ICMP source quench message referring to this TCP
connection arrives, it will be matched to the right state and get passed.
For ICMP queries, keep state creates an ICMP state, and pf knows how to match
ICMP replies to states. For example:
pass out inet proto icmp all icmp-type echoreq keep state
allows echo requests (such as those created by ping) out, creates state, and matches
incoming echo replies correctly to states.

The nat, binat, and rdr rules implicitly create state for connections.
State modulation
Much of the security derived from TCP is attributable to how well the initial sequence
numbers (ISNs) are chosen. Some popular stack implementations choose very poor
ISNs, and thus are normally susceptible to ISN prediction exploits. By applying a
modulate state rule to a TCP connection, pf creates a high-quality random sequence
number for each connection endpoint.
The modulate state directive implicitly keeps state on the rule and is applicable
only to TCP connections. For instance:
block all
pass out proto tcp from any to any modulate state
pass in proto tcp from any to any port 25 flags S/SA modulate state
There are some caveats associated with state modulation:
• You can’t apply a modulate state rule to a pre-existing but unmodulated

connection. Such an application would desynchronize TCP’s strict sequencing
between the two endpoints. Instead, pf treats the modulate state modifier as a
keep state modifier, and the pre-existing connection is inferred without the
protection conferred by modulation.
• The other caveat affects currently modulated states when the state table is lost
(firewall reboot, flushing the state table, etc...). The pf packet filter can’t infer a
connection again after the state table flushes the connection’s modulator. When the
state is lost, the connection may be left dangling until the respective endpoints time
out the connection. It’s possible on a fast local network for the endpoints to start an
ACK storm while trying to resynchronize after the loss of the modulator. Using a
flags S/SA modifier on modulate state rules between fast networks is
suggested to prevent ACK storms.
SYN proxy
By default, pf passes packets that are part of a TCP handshake between the endpoints.
You can use the synproxy state option to cause pf itself to complete the
handshake with the active endpoint, perform a handshake with the passive endpoint,
and then forward packets between the endpoints.
No packets are sent to the passive endpoint before the active endpoint has completed
the handshake, hence so-called SYN floods with spoofed source addresses will not
reach the passive endpoint, as the sender can’t complete the handshake.
The proxy is transparent to both endpoints, they each see a single connection from/to
the other endpoint. The pf packet filter chooses random initial sequence numbers for
both handshakes. Once the handshakes are completed, the sequence number
modulators (see previous section) are used to translate further packets of the
connection. Hence, synproxy state includes modulate state and keep state.

Rules with synproxy won’t work if pf operates on a bridge.

Example:
pass in proto tcp from any to any port www flags S/SA synproxy state
Stateful tracking options

All of keep state, modulate state and synproxy state support the following
options:
max number Limit the number of concurrent states the rule may create. When
this limit is reached, further packets matching the rule that would
create state are dropped, until existing states time out.
timeout seconds Change the timeout values used for states created by this rule. For
a list of all valid timeout names, see “Options,” above.
You can specify multiple options, separated by commas:

pass in proto tcp from any to any \
port www flags S/SA keep state \
(max 100, source-track rule, max-src-nodes 75, \
max-src-states 3, tcp.established 60, tcp.closing 5)
If you specify the source-track keyword, the number of states per source IP is
tracked:
source-track rule
The maximum number of states created by this rule is limited by the rule’s
max-src-nodes and max-src-state options. Only state entries created by
this particular rule count toward the rule’s limits.
source-track global
The number of states created by all rules that use this option is limited. Each
rule can specify different max-src-nodes and max-src-states options,
however state entries created by any participating rule count towards each
individual rule’s limits.
You can set the following limits:
max-src-nodes number
Limit the maximum number of source addresses that can simultaneously have
state table entries.
max-src-states number
Limit the maximum number of simultaneous state entries that a single source
address can create with this rule.
For stateful TCP connections, limits on established connections (those that have
completed the TCP 3-way handshake) can also be enforced per source IP.

max-src-conn number
Limit the maximum number of simultaneous TCP connections that have
completed the 3-way handshake that a single host can make.
max-src-conn-rate number / seconds

Limit the rate of new connections over a time interval. The connection rate is an
approximation calculated as a moving average.
Because the 3-way handshake ensures that the source address isn’t being spoofed,
more aggressive action can be taken based on these limits. With the overload table
state option, source IP addresses that hit either of the limits on established connections
will be added to the named table. You can use this table in the rule set to block further
activity from the offending host, redirect it to a tarpit process, or restrict its bandwidth.
The optional flush keyword kills all states created by the matching rule that originate
from the host that exceeds these limits. The global modifier to the flush command
kills all states originating from the offending host, regardless of which rule created the
state.
For example, the following rules protect the web server against hosts making more
than 100 connections in 10 seconds. Any host that connects faster than this rate will
have its address added to the bad_hosts table and have all states originating from it
flushed. Any new packets arriving from this host will be dropped unconditionally by
the block rule.
block quick from bad_hosts

pass in on $ext_if proto tcp to $webserver port www flags S/SA keep state \
(max-src-conn-rate 100/10, overload bad_hosts flush global)
Operating system fingerprinting

Passive OS Fingerprinting is a mechanism to inspect nuances of a TCP con nection’s
initial SYN packet and guess at the host’s operating system. Unfortunately these
nuances are easily spoofed by an attacker so the fingerprint isn’t useful in making
security decisions. But the fingerprint is typically accurate enough to make policy
decisions upon.
The fingerprints may be specified by operating system class, by version, or by
subtype/patchlevel. The class of an operating system is typically the vendor or genre
and would be OpenBSD for the pf firewall itself. The version of the oldest available
OpenBSD release on the main ftp site would be 2.6 and the fingerprint would be
written
"OpenBSD 2.6"
The subtype of an operating system is typically used to describe the patchlevel if that
patch led to changes in the TCP stack behavior. In the case of OpenBSD, the only
subtype is for a fingerprint that was normalized by the no-df scrub option and would
be specified as:

"OpenBSD 3.3 no-df"
Fingerprints for most popular operating systems are provided by /etc/pf.os. Once
pf is running, you can get a complete list of known operating system finger listed by
running:
# pfctl -so
Filter rules can enforce policy at any level of operating system specification assuming
a fingerprint is present. Policy could limit traffic to approved operating systems or
even ban traffic from hosts that aren’t at the latest service pack.
You can also use the unknown class as the fingerprint that matches packets for which
no operating system fingerprint is known.
Examples:
pass out proto tcp from any os OpenBSD keep state
block out proto tcp from any os Doors
block out proto tcp from any os "Doors PT"
block out proto tcp from any os "Doors PT SP3"
block out from any os "unknown"
pass on lo0 proto tcp from any os "OpenBSD 3.3 lo0" keep state
Operating system fingerprinting is limited only to the TCP SYN packet. This means
that it doesn’t work on other protocols and doesn’t match a currently established
connection.
Operating system fingerprints are occasionally wrong. There are several problems:
• an attacker can trivially craft his packets to appear as any operating system he
chooses
• an operating system patch could change the stack behavior, and no fingerprints will
match it until the database is updated
• multiple operating systems may have the same fingerprint.
Blocking spoofed traffic

Spoofing is the faking of IP addresses, typically for malicious purposes. The
antispoof directive expands to a set of filter rules that block all traffic with a source
IP from the network(s) directly connected to the specified interface(s) from entering
the system through any other interface. For example, the line:
antispoof for lo0
expands to:
block drop in on ! lo0 inet from 127.0.0.1/8 to any
block drop in on ! lo0 inet6 from ::1 to any
For non-loopback interfaces, there are additional rules to block incoming packets with
a source IP address identical to the interface’s IP(s). For example, assuming the
interface wi0 has an IP address of 10.0.0.1 and a netmask of 255.255.255.0, the
line:

antispoof for wi0 inet
expands to:
block drop in on ! wi0 inet from 10.0.0.0/24 to any
block drop in inet from 10.0.0.1 to any
Rules created by the antispoof directive interfere with packets sent over loopback
interfaces to local addresses. You should pass these explicitly.
Fragment handling
The size of IP datagrams (packets) can be significantly larger than the maximum
transmission unit (MTU) of the network. In cases when it is necessary or more
efficient to send such large packets, the large packet will be fragmented into many
smaller packets that will each fit onto the wire. Unfortunately for a firewalling device,
only the first logical fragment will contain the necessary header information for the
subprotocol that allows pf to filter on things such as TCP ports or to perform NAT.
Besides the use of scrub rules as described in “Traffic normalization” above, there are
three options for handling fragments in the packet filter.
One alternative is to filter individual fragments with filter rules. If no scrub rule
applies to a fragment, it’s passed to the filter. Filter rules with matching IP header
parameters decide whether the fragment is passed or blocked, in the same way as
complete packets are filtered. Without reassembly, fragments can be filtered based
only on IP header fields (source/destination address, protocol), since subprotocol
header fields aren’t available (TCP/UDP port numbers, ICMP code/type). You can use
the fragment option to restrict filter rules to apply only to fragments, but not
complete packets. Filter rules without the fragment option still apply to fragments, if
they only specify IP header fields. For instance, the rule:
pass in proto tcp from any to any port 80
never applies to a fragment, even if the fragment is part of a TCP packet with
destination port 80, because without reassembly this information isn’t available for
each fragment. This also means that fragments can’t create new or match existing state
table entries, which makes stateful filtering and address translation (NAT, redirection)
for fragments impossible.
It’s also possible to reassemble only certain fragments by specifying source or
destination addresses or protocols as parameters in scrub rules.
In most cases, the benefits of reassembly outweigh the additional memory cost, and
it’s recommended you use scrub rules to reassemble all fragments via the fragment
reassemble modifier.
You can limit the memory allocated for fragment caching by using pfctl. Once this
limit is reached, fragments that would have to be cached are dropped until other
entries time out. You can also adjust the timeout value.
Currently, only IPv4 fragments are supported, and IPv6 fragments are blocked
unconditionally.

Anchors
Besides the main rule set, pfctl can load rule sets into anchor attachment points. An
anchor is a container that can hold rules, address tables, and other anchors.
An anchor has a name that specifies the path where you can use pfctl to access the
anchor to perform operations on it, such as attaching child anchors to it or loading
rules into it. Anchors may be nested, with components separated by slashes (/),
similar to how file system hierarchies are laid out. The main rule set is actually the
default anchor, so filter and translation rules, for example, may also be contained in
any anchor.
An anchor can reference another anchor attachment point using the following kinds of
rules:
nat-anchor name
Evaluate the nat rules in the specified anchor.
rdr-anchor name
Evaluate the rdr rules in the specified anchor.
binat-anchor name
Evaluate the binat rules in the specified anchor.
anchor name Evaluate the filter rules in the specified anchor.
load anchor name from file

Load the rules from the specified file into the anchor name.
When evaluation of the main rule set reaches an anchor rule, pf evaluates all rules
specified in that anchor.
Matching filter and translation rules in anchors with the quick option are final and
abort the evaluation of the rules in other anchors and the main rule set.
Anchor rules are evaluated relative to the anchor in which they are contained. For
example, all anchor rules specified in the main rule set reference anchor attachment
points underneath the main rule set, and anchor rules specified in a file loaded from a
load anchor rule are attached under that anchor point.
Rules may be contained in anchor attachment points that don’t contain any rules when
the main rule set is loaded, and later such anchors can be manipulated through pfctl
without reloading the main rule set or other anchors. For example:
ext_if = "kue0"
block on $ext_if all
anchor spam
pass out on $ext_if all keep state
pass in on $ext_if proto tcp from any \
to $ext_if port smtp keep state

blocks all packets on the external interface by default, then evaluates all rules in the
anchor named spam, and finally passes all outgoing connections and incoming
connections to port 25.
The following command loads a single rule into the anchor, which blocks all packets
from a specific address:
# echo "block in quick from 1.2.3.4 to any" | \

pfctl -a spam -f -
The anchor can also be populated by adding a load anchor rule after the anchor
rule:
anchor spam
load anchor spam from "/etc/pf-spam.conf"
When pfctl loads pf.conf, it also loads all the rules from the file
/etc/pf-spam.conf into the anchor.
Optionally, anchor rules can specify the parameter’s direction, interface, address
family, protocol and source/destination address/port using the same syntax as filter
rules. When parameters are used, the anchor rule is evaluated only for matching
packets. This allows conditional evaluation of anchors, like:
block on $ext_if all

anchor spam proto tcp from any to any port smtp
pass out on $ext_if all keep state
pass in on $ext_if proto tcp from any to $ext_if port smtp keep state
The rules inside the anchor spam are evaluated only for TCP packets with destination
port 25. Hence:
# echo "block in quick from 1.2.3.4 to any" | \

pfctl -a spam -f -
blocks connections only from 1.2.3.4 to port 25.

Anchors may end with the asterisk (*) character, which signifies that all anchors
attached at that point should be evaluated in the alphabetical ordering of their anchor
name. For example:
anchor "spam/*"
evaluates each rule in each anchor attached to the spam anchor. Note that it evaluates
only anchors that are directly attached to the spam anchor, and doesn’t descend to
evaluate anchors recursively.
Since anchors are evaluated relative to the anchor in which they are contained, there’s
a mechanism for accessing the parent and ancestor anchors of a given anchor. Similar
to file system path name resolution, if the sequence .. appears as an anchor path
component, the parent anchor of the current anchor in the path evaluation at that point
becomes the new current anchor. As an example, consider the following:
# echo ’ anchor "spam/allowed" ’ | pfctl -f -

# echo -e ’ anchor "../banned" \n pass’ | \
pfctl -a spam/allowed -f -

Evaluation of the main rule set leads into the spam/allowed anchor, which evaluates
the rules in the spam/banned anchor, if any, before finally evaluating the pass rule.
Since the parser specification for anchor names is a string, any reference to an anchor
name containing slash (/) characters requires double quote (") characters around the
anchor name.
Translation examples
This example maps incoming requests on port 80 to port 8080, on which a daemon is
running (because, for example, it isn’t run as root, and therefore lacks permission to
bind to port 80):
# use a macro for the interface name, so it can be changed easily

ext_if = "ne3"
# map daemon on 8080 to appear to be on 80

rdr on $ext_if proto tcp from any to any port 80 -> 127.0.0.1 port 8080
If the pass modifier is given, packets matching the translation rule are passed without
inspecting the filter rules:
rdr pass on $ext_if proto tcp from any to any port 80 -> 127.0.0.1 \
port 8080
In the example below, vlan12 is configured as 192.168.168.1; the machine

translates all packets coming from 192.168.168.0/24 to 204.92.77.111 when
they’re going out any interface except vlan12. This has the net effect of making
traffic from the 192.168.168.0/24 network appear as though it is the Internet
routable address 204.92.77.111 to nodes behind any interface on the router except
for the nodes on vlan12. (Thus, 192.168.168.1 can talk to the
192.168.168.0/24 nodes.)
nat on ! vlan12 from 192.168.168.0/24 to any -> 204.92.77.111
In the example below, the machine sits between a fake internal 144.19.74.*
network, and a routable external IP of 204.92.77.100. The no nat rule excludes
protocol AH from being translated:
# NO NAT
no nat on $ext_if proto ah from 144.19.74.0/24 to any
nat on $ext_if from 144.19.74.0/24 to any -> 204.92.77.100
In the example below, packets bound for one specific server, as well as those generated
by the system administrators aren’t proxied; all other connections are:
# NO RDR
no rdr on $int_if proto { tcp, udp } from any to $server port 80
no rdr on $int_if proto { tcp, udp } from $sysadmins to any port 80
rdr on $int_if proto { tcp, udp } from any to any port 80 -> 127.0.0.1 \
port 80
This longer example uses both a NAT and a redirection. The external interface has the
address 157.161.48.183. On the internal interface, we are running ftp-proxy,
listening for outbound ftp sessions captured to port 8021:

# NAT
# Translate outgoing packets’ source addresses (any protocol).
# In this case, any address but the gateway’s external address is mapped.
nat on $ext_if inet from ! ($ext_if) to any -> ($ext_if)
# NAT PROXYING
# Map outgoing packets’ source port to an assigned proxy port instead of
# an arbitrary port.
# In this case, proxy outgoing isakmp with port 500 on the gateway.
nat on $ext_if inet proto udp from any port = isakmp to any -> ($ext_if) \
port 500
# BINAT
# Translate outgoing packets’ source address (any protocol).
# Translate incoming packets’ destination address to an internal machine
# (bidirectional).
binat on $ext_if from 10.1.2.150 to any -> $ext_if
# RDR
# Translate incoming packets’ destination addresses.
# As an example, redirect a TCP and UDP port to an internal machine.
rdr on $ext_if inet proto tcp from any to ($ext_if) port 8080 \
-> 10.1.2.151 port 22
rdr on $ext_if inet proto udp from any to ($ext_if) port 8080 \
-> 10.1.2.151 port 53
# RDR
# Translate outgoing ftp control connections to send them to localhost
# for proxying with ftp-proxy(8) running on port 8021.
rdr on $int_if proto tcp from any to any port 21 -> 127.0.0.1 port 8021
In this example, a NAT gateway is set up to translate internal addresses using a pool of
public addresses (192.0.2.16/28) and to redirect incoming web server connections
to a group of web servers on the internal network:
# NAT LOAD BALANCE

# Translate outgoing packets’ source addresses using an address pool.
# A given source address is always translated to the same pool address by
# using the source-hash keyword.
nat on $ext_if inet from any to any -> 192.0.2.16/28 source-hash
# RDR ROUND ROBIN

# Translate incoming web server connections to a group of web servers on
# the internal network.
rdr on $ext_if proto tcp from any to any port 80 \
-> { 10.1.2.155, 10.1.2.160, 10.1.2.161 } round-robin
Filter examples
# The external interface is kue0
# (157.161.48.183, the only routable address)
# and the private network is 10.0.0.0/8, for which we are doing NAT.
# use a macro for the interface name, so it can be changed easily

ext_if = "kue0"
# normalize all incoming traffic

scrub in on $ext_if all fragment reassemble
# block and log everything by default

block return log on $ext_if all

# block anything coming from source we have no back routes for

block in from no-route to any
# block and log outgoing packets that don’t have our address as source,
# they are either spoofed or something is misconfigured (NAT disabled,
# for instance), we want to be nice and don’t send out garbage.
block out log quick on $ext_if from ! 157.161.48.183 to any
# silently drop broadcasts (cable modem noise)

block in quick on $ext_if from any to 255.255.255.255
# block and log incoming packets from reserved address space and invalid
# addresses, they are either spoofed or misconfigured, we can’t reply to
# them anyway (hence, no return-rst).
block in log quick on $ext_if from { 10.0.0.0/8, 172.16.0.0/12, \
192.168.0.0/16, 255.255.255.255/32 } to any
# ICMP
# pass out/in certain ICMP queries and keep state (ping)

# state matching is done on host addresses and ICMP ID (not type/code),
# so replies (like 0/0 for 8/0) will match queries
# ICMP error messages (which always refer to a TCP/UDP packet) are
# handled by the TCP/UDP states
pass on $ext_if inet proto icmp all icmp-type 8 code 0 keep state
# UDP
# pass out all UDP connections and keep state

pass out on $ext_if proto udp all keep state
# pass in certain UDP connections and keep state (DNS)

pass in on $ext_if proto udp from any to any port domain keep state
# TCP
# pass out all TCP connections and modulate state

pass out on $ext_if proto tcp all modulate state
# pass in certain TCP connections and keep state (SSH, SMTP, DNS, IDENT)
pass in on $ext_if proto tcp from any to any port { ssh, smtp, domain, \
auth } flags S/SA keep state
# pass in data mode connections for ftp-proxy running on this host.

# (see ftp-proxy(8) for details)
pass in on $ext_if proto tcp from any to 157.161.48.183 port >= 49152 \
flags S/SA keep state
# Don’t allow Windows 9x SMTP connections since they are typically

# a viral worm. Alternately we could limit these OSes to 1 connection each.
block in on $ext_if proto tcp from any os {"Windows 95", "Windows 98"} \
to any port smtp
# Packet Tagging
# three interfaces: $int_if, $ext_if, and $wifi_if (wireless). NAT is

# being done on $ext_if for all outgoing packets. tag packets in on
# $int_if and pass those tagged packets out on $ext_if. all other
# outgoing packets (i.e., packets from the wireless network) are only
# permitted to access port 80.
pass in on $int_if from any to any tag INTNET keep state

pass in on $wifi_if from any to any keep state
block out on $ext_if from any to any

pass out quick on $ext_if tagged INTNET keep state
pass out on $ext_if proto tcp from any to any port 80 keep state
Grammar
The syntax for pf.conf in BNF is as follows:
line = ( option | pf-rule | nat-rule | binat-rule | rdr-rule |
antispoof-rule | altq-rule | queue-rule | anchor-rule |
trans-anchors | load-anchors | table-rule )
option = "set" ( [ "timeout" ( timeout | "{" timeout-list "}" ) ] |

[ "optimization" [ "default" | "normal" |
"high-latency" | "satellite" |
"aggressive" | "conservative" ] ]
[ "limit" ( limit-item | "{" limit-list "}" ) ] |
[ "loginterface" ( interface-name | "none" ) ] |
[ "block-policy" ( "drop" | "return" ) ] |
[ "state-policy" ( "if-bound" | "group-bound" |
"floating" ) ]
[ "require-order" ( "yes" | "no" ) ]
[ "fingerprints" filename ] |
[ "debug" ( "none" | "urgent" | "misc" | "loud" ) ] )
pf-rule = action [ ( "in" | "out" ) ]

[ "log" | "log-all" ] [ "quick" ]
[ "on" ifspec ] [ route ] [ af ] [ protospec ]
hosts [ filteropt-list ]
filteropt-list = filteropt-list filteropt | filteropt

filteropt = user | flags | icmp-type | icmp6-type | tos |
( "keep" | "modulate" | "synproxy" ) "state"
[ "(" state-opts ")" ] |
"fragment" | "no-df" | "min-ttl" number |
"max-mss" number | "random-id" | "reassemble tcp" |
fragmentation | "allow-opts" |
"label" string | "tag" string | [ ! ] "tagged" string
"queue" ( string | "(" string [ [ "," ] string ] ")" ) |
"probability" number"%"
nat-rule = [ "no" ] "nat" [ "pass" ] [ "on" ifspec ] [ af ]

[ protospec ] hosts [ "tag" string ] [ "tagged" string ]
[ "->" ( redirhost | "{" redirhost-list "}" )
[ portspec ] [ pooltype ] [ "static-port" ] ]
binat-rule = [ "no" ] "binat" [ "pass" ] [ "on" interface-name ]

[ af ] [ "proto" ( proto-name | proto-number ) ]
"from" address [ "/" mask-bits ] "to" ipspec
[ "tag" string ] [ "tagged" string ]
[ "->" address [ "/" mask-bits ] ]
rdr-rule = [ "no" ] "rdr" [ "pass" ] [ "on" ifspec ] [ af ]

[ protospec ] hosts [ "tag" string ] [ "tagged" string ]
[ "->" ( redirhost | "{" redirhost-list "}" )
[ portspec ] [ pooltype ] ]
antispoof-rule = "antispoof" [ "log" ] [ "quick" ]

"for" ( interface-name | "{" interface-list "}" )
[ af ] [ "label" string ]
table-rule = "table" "<" string ">" [ tableopts-list ]

tableopts-list = tableopts-list tableopts | tableopts
tableopts = "persist" | "const" | "file" string |
"{" [ tableaddr-list ] "}"
tableaddr-list = tableaddr-list [ "," ] tableaddr-spec | tableaddr-spec
tableaddr-spec = [ "!" ] tableaddr [ "/" mask-bits ]
tableaddr = hostname | ipv4-dotted-quad | ipv6-coloned-hex |
interface-name | "self"

altq-rule = "altq on" interface-name queueopts-list

"queue" subqueue
queue-rule = "queue" string [ "on" interface-name ] queueopts-list
subqueue
anchor-rule = "anchor" string [ ( "in" | "out" ) ] [ "on" ifspec ]

[ af ] [ "proto" ] [ protospec ] [ hosts ]
trans-anchors = ( "nat-anchor" | "rdr-anchor" | "binat-anchor" ) string

[ "on" ifspec ] [ af ] [ "proto" ] [ protospec ] [ hosts ]
load-anchor = "load anchor" string "from" filename
queueopts-list = queueopts-list queueopts | queueopts

queueopts = [ "bandwidth" bandwidth-spec ] |
[ "qlimit" number ] | [ "tbrsize" number ] |
[ "priority" number ] | [ schedulers ]
schedulers = ( cbq-def | priq-def | hfsc-def )
bandwidth-spec = "number" ( "b" | "Kb" | "Mb" | "Gb" | "%" )
action = "pass" | "block" [ return ] | [ "no" ] "scrub"

return = "drop" | "return" | "return-rst" [ "( ttl" number ")" ] |
"return-icmp" [ "(" icmpcode [ [ "," ] icmp6code ] ")" ] |
"return-icmp6" [ "(" icmp6code ")" ]
icmpcode = ( icmp-code-name | icmp-code-number )
icmp6code = ( icmp6-code-name | icmp6-code-number )
ifspec = ( [ "!" ] interface-name ) | "{" interface-list "}"

interface-list = [ "!" ] interface-name [ [ "," ] interface-list ]
route = "fastroute" |
( "route-to" | "reply-to" | "dup-to" )
( routehost | "{" routehost-list "}" )
[ pooltype ]
af = "inet" | "inet6"
protospec = "proto" ( proto-name | proto-number |

"{" proto-list "}" )
proto-list = ( proto-name | proto-number ) [ [ "," ] proto-list ]
hosts = "all" |
"from" ( "any" | "no-route" | "self" | host |
"{" host-list "}" | "route" string ) [ port ] [ os ]
"to" ( "any" | "no-route" | "self" | host |
"{" host-list "}" | "route" string ) [ port ]
ipspec ="any" | host | "{" host-list "}"

host =[ "!" ] ( address [ "/" mask-bits ] | "<" string ">" )
redirhost =address [ "/" mask-bits ]
routehost =( interface-name [ address [ "/" mask-bits ] ] )
address =( interface-name | "(" interface-name ")" | hostname |
ipv4-dotted-quad | ipv6-coloned-hex )
host-list = host [ [ "," ] host-list ]
redirhost-list = redirhost [ [ "," ] redirhost-list ]
routehost-list = routehost [ [ "," ] routehost-list ]
port = "port" ( unary-op | binary-op | "{" op-list "}" )

portspec = "port" ( number | name ) [ ":" ( "*" | number | name ) ]
os = "os" ( os-name | "{" os-list "}" )
user = "user" ( unary-op | binary-op | "{" op-list "}" )
unary-op = [ "=" | "!=" | "<" | "<=" | ">" | ">=" ]

( name | number )
binary-op = number ( "<>" | "><" | ":" ) number
op-list = ( unary-op | binary-op ) [ [ "," ] op-list ]
os-name = operating-system-name
os-list = os-name [ [ "," ] os-list ]
flags = "flags" [ flag-set ] "/" flag-set

flag-set = [ "F" ] [ "S" ] [ "R" ] [ "P" ] [ "A" ] [ "U" ] [ "E" ]
[ "W" ]
icmp-type = "icmp-type" ( icmp-type-code | "{" icmp-list "}" )

icmp6-type = "icmp6-type" ( icmp-type-code | "{" icmp-list "}" )
icmp-type-code = ( icmp-type-name | icmp-type-number )

[ "code" ( icmp-code-name | icmp-code-number ) ]

icmp-list = icmp-type-code [ [ "," ] icmp-list ]
tos = "tos" ( "lowdelay" | "throughput" | "reliability" |

[ "0x" ] number )
state-opts = state-opt [ [ "," ] state-opts ]

state-opt = ( "max" number | timeout |
"source-track" [ ( "rule" | "global" ) ] |
"max-src-nodes" number | "max-src-states" number |
"max-src-conn" number |
"max-src-conn-rate" number "/" number |
"overload" "<" string ">" [ "flush" ] |
"if-bound" | "group-bound" | "floating" )
fragmentation = [ "fragment reassemble" | "fragment crop" |

"fragment drop-ovl" ]
timeout-list = timeout [ [ "," ] timeout-list ]

timeout = ( "tcp.first" | "tcp.opening" | "tcp.established" |
"tcp.closing" | "tcp.finwait" | "tcp.closed" |
"udp.first" | "udp.single" | "udp.multiple" |
"icmp.first" | "icmp.error" |
"other.first" | "other.single" | "other.multiple" |
"frag" | "interval" | "src.track" |
"adaptive.start" | "adaptive.end" ) number
limit-list = limit-item [ [ "," ] limit-list ]

limit-item = ( "states" | "frags" | "src-nodes" ) number
pooltype = ( "bitmask" | "random" |

"source-hash" [ ( hex-key | string-key ) ] |
"round-robin" ) [ sticky-address ]
subqueue = string | "{" queue-list "}"

queue-list = string [ [ "," ] string ]
cbq-def = "cbq" [ "(" cbq-opt [ [ "," ] cbq-opt ] ")" ]
priq-def = "priq" [ "(" priq-opt [ [ "," ] priq-opt ] ")" ]
hfsc-def = "hfsc" [ "(" hfsc-opt [ [ "," ] hfsc-opt ] ")" ]
cbq-opt = ( "default" | "borrow" | "red" | "ecn" | "rio" )
priq-opt = ( "default" | "red" | "ecn" | "rio" )
hfsc-opt = ( "default" | "red" | "ecn" | "rio" |
linkshare-sc | realtime-sc | upperlimit-sc )
linkshare-sc = "linkshare" sc-spec
realtime-sc = "realtime" sc-spec
upperlimit-sc = "upperlimit" sc-spec
sc-spec = ( bandwidth-spec |
"(" bandwidth-spec number bandwidth-spec ")" )
Associated files
/etc/hosts Host name database.
/etc/pf.os Default location of OS fingerprints.
/etc/protocols Protocol name database.
/etc/services Service name database.
/usr/share/examples/pf
Examples of rule sets.

See also:
/etc/hosts, pf, /etc/pf.os, pfctl, /etc/protocols, route,
/etc/services
ICMP, ICMP6, IP, IP6, ROUTE, TCP, UDP in the Neutrino Library Reference
bridge, ftp-proxy, pcap, pflog, pflogd in the NetBSD documentation at

© 2010, QNX Software Systems GmbH & Co. KG. pfctl
Control the packet filter (PF) and network address translation (NAT) device
Syntax:
pfctl [-AdeghmNnOoqRrvz] [-a anchor] [-D macro=value]
[-F modifier ] [-f file] [-i interface] [-k host]
[-p device] [-s modifier]
[-t table -T command [address ...]] [-x level]
Runs on:
Neutrino
Options:
-A Load only the queue rules present in the rule file. Other rules and
options are ignored.
-a anchor Apply the -f, -F, and -s options only to the rules in the
specified anchor. In addition to the main rule set, pfctl can load
and manipulate additional rule sets by name, called anchors. The
main rule set is the default anchor.
Anchors are referenced by name and may be nested, with the
various components of the anchor path separated by slashes (/),
similar to how file system hierarchies are laid out. The last
component of the anchor path is where rule-set operations are
performed.
Evaluation of anchor rules from the main rule set is described in
the documentation for pf.conf.
Private tables can also be put inside anchors, either by having
table statements in the pf.conf file that is loaded in the anchor,
or by using regular table commands, as in:
# pfctl -a foo/bar -t mytable -T add 1.2.3.4 5.6.7.8
When a rule referring to a table is loaded in an anchor, the rule

will use the private table if one is defined, and then fall back to
the table defined in the main rule set, if there is one. This is
similar to C rules for variable scope. It is possible to create
distinct tables with the same name in the global rule set and in an
anchor, but this is often bad design, and a warning is issued in
that case.
-D macro=value Define macro to be set to value on the command line. This

overrides the definition of macro in the rule set.
-d Disable the packet filter.
-e Enable the packet filter.

pfctl © 2010, QNX Software Systems GmbH & Co. KG.
-F modifier Flush the filter parameters specified by modifier (which you can
abbreviate):
• nat — flush the NAT rules.
• queue — flush the queue rules.
• rules — flush the filter rules.
• state — flush the state table (NAT and filter).
• Sources — flush the source tracking table.
• info — flush the filter information (statistics that aren’t
bound to rules).
• Tables — flush the tables.
• osfp — flush the passive operating system fingerprints.
• all — flush all of the above.
-f file Load the rules contained in the specified file. This file may
contain macros, tables, options, and normalization, queueing,
translation, and filtering rules. With the exception of macros and
tables, the statements must appear in that order.
Specify - for the file to use standard input.
-g Include output helpful for debugging.
-h Display some help information.
-i interface Restrict the operation to the given interface.
-k host Kill all of the state entries originating from the specified host.
You can specify a second -k option, which will kill all the state
entries from the first host to the second host. For example, to kill
all of the state entries originating from host:
# pfctl -k host
To kill all of the state entries from host1 to host2:

# pfctl -k host1 -k host2
-m Merge in explicitly given options without resetting those that are

omitted. This option lets you modify single options without
disturbing the others:
# echo "set loginterface fxp0" | pfctl -mf -
-N Load only the NAT rules present in the rule file. Other rules and

-n Don’t actually load rules; just parse them.

-O (“Oh”) Load only the options present in the rule file. Other rules
and options are ignored.
-o Enable the rule-set optimizer, which attempts to improve rule sets
by removing rule duplication and making better use of rule
ordering. Specifically, it does the following:
• removes duplicate rules
• removes rules that are a subset of another rule
• combines multiple rules into a table when advantageous
• reorders the rules to improve evaluation performance
You can specify a second -o option to use the currently loaded
rule set as a feedback profile to tailor the optimization of the
quick rules to the actual network behavior.
The rule-set optimizer modifies the rule set to improve performance. A side effect of
the ruleset modification is that per-rule accounting statistics will have different
meanings than before. If per-rule accounting is important (e.g. for billing purposes),
either you shouldn’t use the rule-set optimizer, or you should add a label field to all of
the accounting rules to act as optimization barriers.
-p device Use the device file device instead of the default, /dev/pf.
-q Print only errors and warnings.
-R Load only the filter rules present in the rule file. Other rules and
-r Perform reverse DNS lookups on states when displaying them.
-s modifier Show the filter parameters specified by modifier (which you can
abbreviate):
• nat — show the currently loaded NAT rules.
• queue — show the currently loaded queue rules. When used
together with -v, pfctl also shows per-queue statistics.
When used together with -v -v, pfctl loops and shows
updated queue statistics every five seconds, including
measured bandwidth and packets per second.
• rules — show the currently loaded filter rules. When used
together with -v, pfctl also shows the per-rule statistics
(number of evaluations, packets and bytes).
Note that the skip step optimization done automatically by
io-pkt skips the evaluation of rules where possible. Packets
passed statefully are counted in the rule that created the state
(even though the rule isn’t evaluated more than once for the
entire connection).

• Anchors — show the currently loaded anchors directly

attached to the main ruleset. If you also specify -a anchor,
the anchors loaded directly below the given anchor are shown
instead. If you specify -v, all anchors attached under the
target anchor are displayed recursively.
• state — show the contents of the state table.
• Sources — show the contents of the source-tracking table.
• info — show filter information (statistics and counters).
When used together with -v, source tracking statistics are also
shown.
• labels — show per-rule statistics (label, evaluations,
packets, bytes) of filter rules with labels. This can be useful
for accounting.
• timeouts — show the current global timeouts.
• memory — show the current pool memory hard limits.
• Tables — show the list of tables.
• osfp — show the list of operating system fingerprints.
• Interfaces — show the list of interfaces and interface
drivers available to PF. When used together with a double -v
option, pfctl also shows interface statistics. You can use the
-i option to select an interface or a group of interfaces.
• all — show all of the above, except for the lists of interfaces
and operating system fingerprints.
-T command [address ...]
Specify the command (which you can abbreviate) to apply to the
table. The commands include:
• kill — kill a table.
• flush — flush all addresses of a table.
• add — add one or more addresses in a table. Automatically
create a nonexisting table.
• delete — delete one or more addresses from a table.
• replace — replace the addresses of the table. Automatically
create a nonexisting table.
• show — show the content (addresses) of a table.
• test — test if the given addresses match a table.
• zero — clear all the statistics of a table.
• load — load only the table definitions from pf.conf. You
use this in conjunction with the -f option, as in:
# pfctl -Tl -f pf.conf

For the add, delete, replace, and test commands, you can
specify the list of addresses either directly on the command line
and/or in an unformatted text file, using the -f flag. Comments
starting with a # are allowed in the text file. With these
commands, you can also use the -v option once or twice, in
which case pfctl prints the detailed result of the operation for
each individual address, prefixed by one of the following letters:
• A — the address/network has been added.
• C — the address/network has been changed (negated).
• D — the address/network has been deleted.
• M — the address matches (test operation only).
• X — the address/network is duplicated and therefore ignored.
• Y — the address/network can’t be added/deleted due to
conflicting ! attributes.
• Z — the address/network has been cleared (statistics).
Each table maintains a set of counters that you can retrieve using
the -v option. For example, the following commands define a
wide-open firewall that keeps track of packets going to or coming
from the OpenBSD FTP server. The following commands
configure the firewall and send 10 pings to the FTP server:
# printf "table <test> { ftp.NetBSD.org }\n \
pass out to <test> keep state\n" | pfctl -f-
# ping -qc10 ftp.NetBSD.org
We can now use the table show command to output, for each
address and packet direction, the number of packets and bytes
that are being passed or blocked by rules referencing the table.
The time at which the current accounting started is also shown
with the Cleared line:
# pfctl -t test -vTshow
129.128.5.191
Cleared: Thu Feb 13 18:55:18 2003
In/Block: [ Packets: 0 Bytes: 0 ]
In/Pass: [ Packets: 10 Bytes: 840 ]
Out/Block: [ Packets: 0 Bytes: 0 ]
Out/Pass: [ Packets: 10 Bytes: 840 ]
Similarly, you can view global information about the tables by

using the -v option twice with the -s Tables command. This
displays the number of addresses on each table, the number of
rules that reference the table, and the global packet statistics for
the whole table:
# pfctl -vvsTables
--a-r- test
Addresses: 1
Cleared: Thu Feb 13 18:55:18 2003
References: [ Anchors: 0 Rules: 1 ]
Evaluations: [ NoMatch: 3496 Match: 1 ]

In/Block: [ Packets: 0 Bytes: 0 ]

In/Pass: [ Packets: 10 Bytes: 840 ]
In/XPass: [ Packets: 0 Bytes: 0 ]
Out/Block: [ Packets: 0 Bytes: 0 ]
Out/Pass: [ Packets: 10 Bytes: 840 ]
Out/XPass: [ Packets: 0 Bytes: 0 ]
In this case, only one packet — the initial ping request —

matched the table, but all packets passing as the result of the state
are correctly accounted for. Reloading the table(s) or ruleset
doesn’t affect packet accounting in any way. The two XPass
counters are incremented instead of the Pass counters when a
“stateful” packet is passed but doesn’t match the table anymore.
This will happen in our example if someone were to flush the
table while the ping command was running.
When used with a single -v, pfctl displays only the first line
containing the table flags and name. The flags are defined as
follows:
• c — constant tables, which can’t be altered outside pf.conf.
• p — persistent tables, which don’t get automatically killed
when no rules refer to them.
• a — tables that are part of the active table set. Tables without
this flag don’t really exist, can’t contain addresses, and are
listed only if you specify the -g option.
• i — tables that are part of the inactive table set. This flag can
be witnessed only briefly during the loading of pf.conf.
• r — tables that are referenced (used) by rules.
• h — a table in the main rule set is hidden by one or more
tables of the same name from anchors attached below it.
-t table Specify the name of the table.
-v Produce more verbose output. If you specify a second -v, pfctl

produces even more verbose output including rule set warnings.
See above for its effect on table commands.
-x level Set the debugging level to one of the following (which you can
abbreviate):
• none — don’t generate debug messages.
• urgent — generate debug messages only for serious errors.
• misc — generate debug messages for various errors.
• loud — generate debug messages for common conditions.
-z Clear per-rule statistics.

Description:
The pfctl utility communicates with the packet filter device using the ioctl() or
ioctl_socket() interface described in pf. It lets you configure rule sets and parameters
and retrieve status information from the packet filter.
Packet filtering restricts the types of packets that pass through network interfaces
entering or leaving the host based on filter rules as described in pf.conf. The packet
filter can also replace addresses and ports of packets. Replacing source addresses and
ports of outgoing packets is called NAT (Network Address Translation) and is used to
connect an internal network (usually reserved address space) to an external one (the
Internet) by making all connections to external hosts appear to come from the gateway.
Replacing destination addresses and ports of incoming packets is used to redirect
connections to different hosts and/or ports. A combination of both translations,
bidirectional NAT, is also supported. Translation rules are described in the
documentation for pf.conf.
The packet filter doesn’t itself forward packets between interfaces. Forwarding can be
enabled by setting the sysctl variables net.inet.ip.forwarding and/or
net.inet6.ip6.forwarding to 1. Set them permanently in /etc/sysctl.conf.
Files:
/etc/pf.conf Packet filter rules file.
/etc/pf.os Passive operating system fingerprint database.
See also:
pf, /etc/pf.conf, /etc/pf.os, sysctl
ftp-proxy in the NetBSD documentation at http://www.netbsd.org/docs/

pfm © 2010, QNX Software Systems GmbH & Co. KG.
Photon file manager
Syntax:
pfm [-h height[%]] [-S i|m|n] [-s server]
[-w width[%]] [-x position[%][r]] [-y position[%][r]]
Runs on:
Neutrino
Options:

normal).

fullpath fullpath

Description:
The pfm utility starts a graphical file manager that lets you browse directories and
files, create and edit files, and so on.
The Photon file manager represents files and folders graphically. Double-click on a
folder to open it and display its contents. Double-click on a file to open it in an
associated application (if an association exists). The file manager also supports
drag-and-drop operations — for example, you can drag a file to a folder to move it
there. You can right-click on a file or folder to view a shortcut menu, which contains a
subset of the commands that are listed below.
You can quickly jump to an item in a long list by typing in the first few letters of the
file or directory name.

© 2010, QNX Software Systems GmbH & Co. KG. pfm
Viewing and editing files
Task Menu command Shortcut

Create a new file File→New→File F3
Create a new folder File→New→Folder F4
Open a new file-manager window File→New→Window Ctrl-N
Open a selected folder File→Open Enter
Open a selected folder in a new file-manager window File→Open in Window Ctrl-Enter
View a selected file* File→View
Edit a selected file* File→Edit Ctrl-E
Open a selected file with a specific application File→Open With Shift-Enter
Open a pterm window with the path set to the current directory File→Open Terminal Ctrl-T
Refresh the file list File→Refresh F5
Print the current file File→Print Ctrl-P
Print the current directory listing File→Directory
View or change a file’s properties, including its size, owner, File→Inspect F9
read/write/execute permissions, and access mode.
Close the Photon file manager File→Exit Alt-X
* You can view or edit only file types that are associated with an application. Use the
Edit→Associations command to add or change file-type associations.
Moving, deleting, and renaming files

Cut the selected file or folder and put it in the Photon clipboard Edit→Cut Ctrl-X
Copy the selected file or folder to the Photon clipboard Edit→Copy Ctrl-C
Paste a folder or file from the Photon clipboard into the current Edit→Paste Ctrl-V
directory
Delete the currently selected file or folder Edit→Delete Delete
Rename the currently selected file or folder Edit→Rename F2
Copy a file or folder to a defined bookmark location or a location Edit→Copy To
that you specify
continued. . .

pfm © 2010, QNX Software Systems GmbH & Co. KG.

Select all files and folders in the current directory Edit→Select→All Ctrl-A
Select all files or folders in the current directory that match a Edit→Select→Pattern Ctrl-S
defined pattern
Unselect all selected files and folders Edit→Unselect→All Ctrl-U
Unselect all selected files and folders based on a defined pattern Edit→Unselect→Pattern
Invert the current selection—that is, selected files are unselected, Edit→Invert Selection Ctrl-I
and unselected files are selected
View or edit file-manager preferences, including whether to hide Edit→Preferences F10
system files, font, and prompt behavior. See Setting pfm
Preferences below.
View or edit the associations between file types and applications. Edit→Associations F11
These definitions determine whether you can view or open a file
from within file manager.
Navigating

View the last directory listing viewed Go→Back Alt-←
View the next directory listing viewed (only Go→Forward Alt-→
available after you’ve used the back command)
Move up one level in the directory tree Go→Up One Level Backspace
View the home directory for the current user Go→Home F6
Add the current directory to the bookmark list Bookmarks→Add Current Directory Ctrl-D
Remove the current directory from the Bookmarks→Remove Current Directory Ctrl-R
bookmark list
View a bookmarked directory Bookmarks→Directory
Setting pfm preferences

You can set pfm preferences by selecting Edit→Preferences. Use the Preferences
dialog to configure the following settings:

© 2010, QNX Software Systems GmbH & Co. KG. pfm
Setting Description
Filelist Options These settings allow you to show or hide
system files that begin with a period (“dot”
files), and list folders before files regardless of
alphabetical order.
Filename Encoding These settings specify how pfm displays
non-UTF8 encoded file names.
Filelist Font and Hotlist Font These settings specify the font, style, and size
to use in the file list and the bookmarks
(hotlist).
KeyFind Timeout This setting specifies the maximum time in
milliseconds between keystrokes before the
find by typing feature resets itself. Set to 0 to
disable reset.
Copy/Move Overwrite and Delete These settings configure whether pfm prompts
you before copying, moving, or deleting files.
Examples:
Run PFM using Photon server on node my_node:
pfm -s/net/my_node/dev/photon
Run PFM at initial position (10,10) with an initial dimension of 200×300:
pfm -x10 -y10 -h200 -w300
See also:
“Browsing files with the File Manager” in the Using the Photon microGUI chapter of
the Neutrino User’s Guide

ph © 2010, QNX Software Systems GmbH & Co. KG.
Launch the Photon window system
Syntax:
ph [-cNsvx] [-n name]
Runs on:
Neutrino
Options:
-c Open a terminal “dittoed” to the console.
-N Don’t explicitly load shared libraries; let the applications load them as
required.
-n name Use the device name to start Photon (defaults to /dev/photon). Use
this option if you must run more than one Photon window system on a
single node.
-s Safe mode. Use this option if Photon doesn’t display correctly on start
up. This option forces Photon to start in 16-color VGA mode.
-v Be verbose.
-x Don’t allow X11 applications in Photon.
Description:
The ph utility is a shell script that starts the Photon window system. The script starts
the following, as required:
• the font manager
• Photon (Photon server)
• inputtrap to detect the input hardware and start the input manager (see below)
• pwm (Photon Window Manager)
• shelf (Photon Shelf Manager)
• If you have a $HOME/.ph/phapps script file, Photon launches the executables

listed in this file. This is a good place to put applications that you want to start each
time Photon boots. This file must be executable (use chmod +x phapps).
If you’ve defined the PHGFX and PHINPUT environment variables, ph uses their
values to start graphics/input drivers.

© 2010, QNX Software Systems GmbH & Co. KG. ph
Examples:
Start Photon:
ph
Files:
${HOME}/.ph/phapps
Contains a user’s list of applications for Photon to launch automatically when it
starts. This file must be executable.
/etc/system/config/nophoton
If this file exists, the system doesn’t boot into Photon. The file’s contents aren’t
important; you can just touch the file to create it.
The ph command sets or uses these environment variables:
ABLPATH If a language or path to the translations directory isn’t set,

it’s assigned to PHOTON_PATH/translations.
ABLANG If this environment variable isn’t set, ph uses the setting in

/etc/photon/ABLANG. If LOGNAME is set and the
$HOME/.ph/.ABLANG file exists, the setting in this file
overrides the global setting.
LOGNAME If this environment variable isn’t set (such as when ph is run in

the sysinit file), ph runs phlogin, a login program for
Photon.
PATH Include the directories containing the Photon executables.
PHEXIT_DISABLE
Turn off phlogin’s Exit button.
PHFONT Set the registered name of the font server (e.g. /dev/phfont).
PHFONTOPTS Pass options to the font server.
PHGFX The full command that you want to use instead of the default
commands to start the graphics driver.
For example, on an Aspen/Tahoe board, you could specify:
export PHGFX="io-graphics \
-amode=/usr/photon/config/q2sd.conf \
-dldevg-q2sd.so -g640x480x16"

ph © 2010, QNX Software Systems GmbH & Co. KG.
PHINPUT The full command that you want to use instead of the default
commands to start the input driver.
PHOTON Name of the Photon device (usually /dev/photon; the -n

option overrides this.
PHOTON_PATH Name of the root directory containing Photon files (usually

/usr/photon).
PHWM Name of Photon Window Manager to start (defaults to pwm).
PHWMOPTS Specify options for pwm.
See also:
inputtrap, phlogin, Photon, pwm
Using the Photon microGUI and Configuring Your Environment in the Neutrino
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. phablang
PhAB Language editor
Syntax:
phablang [options]
Runs on:
Options:

normal).

fullpath fullpath



Description:
The phablang command starts the PhAB language editor. It’s used to translate PhAB
applications into other languages. For more information, see the International
Language Support chapter of the Photon Programmer’s Guide.
Files:
/usr/photon/appbuilder/languages.def
The currently defined set of language codes.

phablang © 2010, QNX Software Systems GmbH & Co. KG.
ABLPATH A list of directories in which an application looks for its translations.
See also:
International Language Support chapter of the Photon Programmer’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. phabmsg
Photon message database editor
Syntax:
phabmsg [filename] [-h height[%]] [--Si|m|n]
[-s server_name] [-w width[%]] [-x position[%][r]]
[-y position[%][r]]
Runs on:
Neutrino
Options:
filename The path and name of a message database to open.


normal).

fullpath fullpath



Description:
The phabmsg utility starts a graphical Photon editor for managing message databases.
Message databases are convenient places to keep strings for one or more applications,
and they provide multi-language support for PhAB applications. You must be running
Photon in order to run phabmsg.

phabmsg © 2010, QNX Software Systems GmbH & Co. KG.
To create a new message database:
1 Select File→New.
2 Add items by adding a tag, description, and value, then clicking Insert item.
You can add multiple-value items by toggling between Multi and Single.
3 Select File→Save As to save the new message database.
To change an existing database, use File→Open to open the database, then select
items, change the contents, and click Modify current.
Once a message database is populated with values, you can use the PhAB translation
editor to create translate the database into different languages. You can launch the
PhAB translation editor phablang for the current message database open in phabmsg
by selecting File→Launch Translation Editor.
For more information, see the International Language Support chapter of the Photon
Examples:
Run phabmsg using the Photon server on node my_node:
phabmsg -s/net/my_node/dev/photon
Run at initial position (10,10):
phabmsg -x10 -y10

© 2010, QNX Software Systems GmbH & Co. KG. phabmsg
Open the message database /tmp/all.mdb
phabmsg /tmp/all.mdb
See also:
ApLoadMessageDB(), ApCloseMessageDB(), ApGetMessage(), phablang, the
International Language Support chapter of the Photon Programmer’s Guide.

phcalc © 2010, QNX Software Systems GmbH & Co. KG.
Photon calculator
Syntax:
phcalc [-s server] [-x position[%][r]]
[-y position[%][r]]
Runs on:
Neutrino
Options:

fullpath fullpath


Description:
This utility starts a graphical calculator. You must be running Photon in order to run
phcalc.
Examples:
Run phcalc using the Photon server on node my_node:
phcalc -s/net/my_node/dev/photon
phcalc -x10 -y10

© 2010, QNX Software Systems GmbH & Co. KG. phdialer
Modem dialer
Syntax:
phdialer options
Runs on:
Neutrino
Options:
-a If possible, begin dialing immediately.
-d Enable verbose debugging information for pppd.
-D directory The location from which to search for/save dialup files.
-i Ignore any other instances of phdialer that are running.
-m Minimize the window when dialing starts.
-n dialup_name Make the dialup with the given name the current one.
-o Don’t minimize on successful connection
-p file Load this dialup explicitly.
-P file Similar to the -p option, but load only this dialup.
-q Quit the dialer on cancel or disconnect.
-r Don’t expand the dialup window on disconnect.
-Si|n The initial state of the main window (iconified or normal).

fullpath fullpath


phdialer © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The phdialer command starts Photon’s modem dialer (for example, so you can
access your ISP):
The phdialer is meant to be simple and small. You can change only the bare
minimum of dialup settings in its base window — just enough so you get a dialup
started. If data has been entered it and the Save changes box is checked, phdialer
asks you for a name to save the dialup as. If you cancel, the changes are lost. All
dialups in your dialup directory are listed in the combobox at the top.
The phlip, command gives you access to all information about a dialup. When you
click on Edit in phdialer, it spawns phlip and makes the dialup that was current
come up.
In addition to the system device and network settings, phlip has a dialup tab that lists
the user’s dialup configurations. There’s one panel and one configuration file per
dialup. These usually reside in the ${HOME}/.ph/dialups directory. You can copy
these files from one user’s dialup directory to another, but the password isn’t be
preserved and the new user must enter it again (even root).
If you’re not root when you run phlip, the network and device panels contain
read-only information. You can make changes only to your dialups.

© 2010, QNX Software Systems GmbH & Co. KG. phdialer
See also:
/etc/autoconnect, phlip, pppd

phditto © 2010, QNX Software Systems GmbH & Co. KG.
Access a Photon workspace on a remote node
Syntax:
phditto [-b baud] [-H time1[,time2][,time3]]
[-h height] [-i igrp] [-k]
[-M kbytes[,Mbytes]] [-m modem]
[-N number] [-n path[+]] [-o options]
[-p path]
[-s service] [-t ipaddr[:port]]
[-U userid[:password]] [-u] [-V[V]...]
[-w width] [-X offset] [-x offset]
[-Y offset] [-y offset] [host]
Runs on:
Neutrino
Options:
-b baud Specify the effective baud rate of the communication link. The
default is the current baud rate of the communication link.
-H time1 [,time2] [,time3]
Mouse holdoff times (in tenths of a second):
• time1 — normal mouse motion.
• time2 — motion with button press.
• time3 — motion with a drag cursor.
Default times are scaled, based on baud rate, yielding 1.2, 0.6,
and 0.3 seconds at 9600 baud. The default mouse holdoff is
disabled at baud rates above 115,200.
-h height The height of the window, in pixels. The default is 480 pixels.
-i igrp Specify phditto’s input group. Default is 1.
-k Start in kiosk (full-screen) mode. Pressing Ctrl-Alt-K anytime

toggles kiosk mode.
-M kbytes [,Mbytes]
Specify RAM cache (and optionally the disk cache) limits. The
default is 4096,20, which corresponds to a 4M cache and a 20M
disk cache.
-m modem Specify the name of the QNX serial device to use for remote
connect.
-N number Set the number of messages buffered to allow write-ahead draws

to phditto. The actual number used is the lesser of this option
and the -b option of phrelay. The default value is 20. Use a
lower value to save memory on the Neutrino host running

© 2010, QNX Software Systems GmbH & Co. KG. phditto
phrelay at the expense of throughput, or, if memory is not an

issue, a higher value to gain some additional throughput
performance. Adjusting this setting has the most effect when
end-to-end response time is slow compared with throughput,
such as over a modem or when there are many network hops
between the local and remote ends.
-n path[+] View and interact with Photon in the specified path, e.g. -n
/dev/photon. To create a new private Photon session on a
QNX4 host, end path with +, e.g. -n//3+.
-o options Options:
• 0 — no compression.
• 1 — BPE (Byte-Pair Encoding) compression.
• 2 — RLL (Run Length Limited) compression.
• 8 — Use CRC (Cyclic Redundancy Check) error checking.
Combine options by addition, e.g. to specify BPE and CRC,
select 9. If the selected baud rate requires it, compression will be
automatically selected unless you specify 0.
-p path Use the path for the disk cache. If not specified, the default is
/usr/photon. If you don’t have permission to write to this
location caching is disabled.
-s service Request a specific phrelay service. For more information, see

“Using predefined Photon services” in the documentation for
phrelay.
-t ipaddr[:port] Connect via TCP/IP to this IP address (with optional port).

(Specifying host does the same thing.)
-U userid[:password]
Login as this user (with optional password) when using services.
The default is $LOGNAME.
-u Unlocked mode. Allow user to navigate independently at the

remote Photon space.
-V[V...] Be verbose; more V characters cause more verbosity. Output is

sent to standard output.
-w width The width of the window, in pixels. The default is 640 pixels.
-X offset Specify the initial x offset in the local Photon event space.
-x offset Specify the x offset of the remote phditto window.
-Y offset Specify the initial y offset in the local Photon event space.

phditto © 2010, QNX Software Systems GmbH & Co. KG.
-y offset Specify the y offset of the remote phditto window.
host Connect to this TCP/IP host or IP address.
Description:
The phditto utility lets you view and interact with another Photon workspace in a
network. When you “ditto” the remote node, both you and the remote user can share
the same workspace.
You can end the phditto session by selecting Close from phditto’s window menu
(click the right mouse button on the phditto label in the Taskbar).
Remote connectivity via modem

When you specify a modem (using -m), phditto first acts as a simple text terminal
emulator so you can interact with the modem, dial up a remote QNX machine, and log
in. Once you’re logged in, you can then start up a Photon session by entering the
following command:
exec /usr/bin/phrelay
The phditto program will then synchronize with the remote phrelay program and
start to function as a Photon graphics terminal.
Remote connectivity via TCP/IP

When you specify a TCP/IP connection (using -t), the inetd program running on the
remote QNX host will automatically launch phrelay for you, provided phrelay and
inetd have been configured properly.
Examples:
Run an encapsulated Photon session (Photon within Photon) on the local machine:
phditto localhost
Start a private pfm service on host:
phditto -Spfm -t host
Connect through the modem on /dev/ser2 to a remote QNX box. Once logged into
QNX, type exec /usr/bin/phrelay:
phditto -m/dev/ser2
Connect via the Internet to an IP port on a remote QNX machine where a remote
Photon session will be automatically started:
phditto -t198.53.31.1:4869
Connect to a remote QNX machine and run an encapsulated PhAB session as user
joe:
phditto -t198.53.31.1 -sphab -Ujoe:password

© 2010, QNX Software Systems GmbH & Co. KG. phditto
Caveats:
1 To create a new private Photon session on a remote node, you must specify one
of -m, -t, or host because native QNX messaging is not currently implemented
as a transport mechanism.
You can use Qnet to connect to an existing Photon session on a remote node.
For example:
phditto -tlocalhost -n/net/remotehost/dev/photon
2 When connecting to a machine running an older version of phrelay, it’s

possible to exceed the draw buffer limit. In this case, the window title displays
the error: “[Error: Large Draw Buffers]”.
See also:
phrelay, phrelaycfg

phfind © 2010, QNX Software Systems GmbH & Co. KG.
File search utility
Syntax:
phfind [options]
Runs on:
Neutrino
Options:
-c Case-sensitive pattern match. The default is case-insensitive.
-npattern The name or pattern to find.
-r Don’t recursively search subdirectories. The default is to

recurse.
-R Recursively search symbolic links. The default is not to recurse.
-S Single-threaded operation. The default is multi-threaded.

Setting this option saves a thread, but it may reduce
responsiveness of phfind on a slow filesystem.
-t options The types of files to look for. Combine one or more of:
• a — all (the default setting)
• b — block special
• c — character special
• d — directories
• f — regular files
• l — symbolic links
• n — named special
• p — FIFOs (pipes)
• s — sockets



© 2010, QNX Software Systems GmbH & Co. KG. phfind
Description:
This utility starts a graphical file search application. You must be running Photon in
order to run phfind.
The phfind utility can find and display a maximum of 65535 files.
You can start phfind from the command line.

The main window looks like this:
Searching for files with phfind.
The application has three tabs, Name & Location, Types, and Sizes:
• The Name & Location tab lets you enter a file name, select the search path, and set
basic search options.

phfind © 2010, QNX Software Systems GmbH & Co. KG.
• The Types tab lets you set a filter for the types of files phfind looks for. For a
description of the types of files in a QNX filesystem, see “Working with files” in
the Neutrino User Guide.
• The Sizes tab lets you set a filesize range for files found by phfind.
See also:
find, pfm

© 2010, QNX Software Systems GmbH & Co. KG. phfont
Photon font server
Syntax:
phfont [-A] [-b file]
[-C[-]SANSERIF|SERIF|DECORATIVE=description[;description2[;...]]]
[-D directory]
[-d directory] [-E rule]
[-F types] [-e file] [-I] [-i file]
[-K[-]FONDRY|AFTERFOUNDRYKEYS|KEYS=key[;key2[;...]]]
[-L] [-l list]
[-mPHF|PFR|TTF=newname[=realname][;newname2=[realname2][;...]]]
[-N number]
[-O[-]keyword[;[-]keyword2[;...]]]
[-n name] [-s directory]
[-U family] [-u file]
[-X] [-Z alignment]
Runs on:
Neutrino
Options:
-A Force all text bitmaps to be anti-aliased wherever possible. Only
scalable fonts can be anti-aliased.
-b file Save font usage information to the specified file when phfont
exits.
-C[-]SANSERIF|SERIF|DECORATIVE=description[;description2[;...]]
Manage the font classification list. Font classification lists are used
to return correct information to the user’s application when fonts
(such as PHF fonts) don’t contain classification information in
them.
This option is used to add or remove a description to or from a font
class. Use the - preceding the font class name to remove
descriptions. This option could be used more than once on the
command-line.
-D directory Specify the configuration directory that holds the fontdir,

fontext, fontmap, and fontopts files. The default is
/usr/photon/font_repository.
-d directory Specify the font directory. All configuration files and font files are
assumed to be in this directory. The default is
/usr/photon/font_repository.
-E rule Specify the extension/dropout rule to use. The fontext file may
contain a number of different extension rules (e.g. language rules
that search the Chinese, Japanese, or Korean character set) of which

phfont © 2010, QNX Software Systems GmbH & Co. KG.
only one is active. By default, the first “+” rule in the fontext file
is used.
-e file Specify the font extension/dropout file. This file contains rules that
extend a base output character set to include multiple font files (e.g.
to add special symbols or languages other than English). The
default file is fontext.
-F types Print the defaults for the specified types and exit, where types is a
string containing one or more of:
• C — font classes
• K — font keys
• O — oriental keywords
• m — font mappings
-I Use strict international mapping rules.
-i file Specify the font index file. This file contains header information of
every known/usable font in the system and allows the font server to
quickly perform font mappings and character dropouts without
accessing the disk. The default file is fontdir.
-K[-]FONDRY|AFTERFOUNDRYKEYS|KEYS=key[;key2[;...]]
Font Keys are removed from the font description from the specific
location within description.
If - is used, the specified keys are removed from the specified key
location. This option could be used more than once.
-L Deny local metrics loading.
-l list Specify a list of fonts to preload and lock into cache. You can use
this to ensure fast access to common fonts. The list is formatted as a
comma-separated list of font names. For example:
helv10,phcursor,cour10b,swissi
Default is none.
-M Disable the display of missing-character symbols. By default,
whenever a character is rendered for which no definition can be
found, the font server displays an empty rectangle.
-mPHF|PFR|TTF=newname[=realname][;newname2=[realname2][;...]]
For internal use only. Entries in this file override the descriptive
name (for example, Helvetica) for a particular font stem (helv).
This option adds a new mapping to the specified font type list. If
realname is not provided, this newname is removed from the
specified font type list. This option can be used more than once on
the command-line.

-N number Specify the number of times the font manager tries to attach a
device before exiting.
Default is 15.
-n name Specify the name to register the font server with. By default the
value of the PHFONT environment variable is used; if this isn’t set,
the prefix /dev/phfont is used.
-O[-]keyword[;[-]keyword2[;...]]
Manage oriental keywords. Keywords used to identify Asian
(Oriental) font foundry names, and are used to optimize the
extension system.
If a keyword starts with a -, this keyword is removed from the list,
otherwise it is added to the list. This option can be used more than
once on the command-line.
-s dir Directory containing font engines . By default this is

/lib/dll/font.
-U family Specify the font family to use for unknown fonts. Whenever a
named font doesn’t exist and can’t be resolved by explicit mapping
entries, this default font family is used. By default the ? entry in the
fontmap file is used.
-u file Specify the unknown font-mapping table file. This file creates font
synonyms (or virtual fonts) and configuration rules for augmenting
bitmap fonts with scalable fonts. The default file is fontmap.
-X Prevent the font server from terminating after the last client
disconnects. The default is for the font server to exit once all clients
have terminated.
-Z alignment Set the bitmap alignment to 8, 32, or 64 bit. This is used in DLL
mode only. See PfSetOptionsDll().
You can pass options through the -F option to io-graphics when you aren’t running
an external font server. The format is slightly different, based on the getsubopt()
format. For example:
io-graphics -F"-d=/usr/photon/font_repository,-A,-N=10" ...
See PfSetOptionsDll() for more information.
Description:
The phfont utility provides all font services to Photon applications and drivers. This
includes the calculation of text extents and metrics and the generation of bitmaps

representing character strings. It also maintains a central cache of font metric and
bitmap data. The configuration files used by phfont are described in Files below.
When phfont is being initialized, it pre-processes the command line to find out which
configuration directory to use, then it tries to load the $HOME/.ph/font/fontopts
file. If this file doesn’t exist, it tries to load the config_dir/fontopts file. It tries
to load the [io-font] and then it tries to load the [io-font-server] sections.
The options from the loaded sections are combined with the options from the
command line and then processed, with the options in the command line taking higher
precedence in the case of conflicts. The options in the [io-font] section of the
fontopts file are used by all applications that load phfont.so. When using
PfAttachLocalDll, the option name is used to try to load the
[io-font-option_name] section from the fontopts file too.
The phfont utility loads the phfont.so DLL to provide font rendering services. The
phfont.so loads DLLs located in /lib/dll/font which provide rendering
services for specific font types, such as PHF, TTF, TTC, PFR, Stroke, etc.
If a particular type of rendering is not desired, you can remove the specific dll. To
determine which services are provided by each DLL, use the use dll_name command,
which displays the usage message for that particular DLL. If an external font server is
not started, io-graphics attempts to invoke a font server instance.
The phfont server can run as a stand alone process (we refer to this as an external
server) or as a plugin to io-graphics (which we call an internal server). We
recommend you run an external server in these conditions:
• Your system will not run io-graphics.
• Your system will be used as a server for remote photon sessions.
To run an external font server, start phfont before io-graphics. To run an internal
font server, simply start io-graphics.
Examples:
Start the server:
phfont -d /usr/photon/font_repository &
Normally the font server is started from the ph script.

Files:
The rendering DLLs used by the font server are located in /lib/dll/font/*.so.
These files support rendering for at least these font types:
• TrueType
• TrueType collections
• Bitstream TrueDoc PFR
• Photon Bitmap
• Bitstream Stroke
• Bitstream Speedo
• Bitstream T2K
• Adobe Type1
• Adobe Type2
Use the use command to view the font types supported by a DLL.
Other files used by phfont include:
• fontdir — directory of known fonts
• fontext — extension rules to handle missing characters
• fontmap — font mapping rules
• fontopts — command-line options
These files were used by previous versions of phfont, but are now deprecated:
• fontdesc — use the -C option instead.
• font-traplist
• fontdynamic
• fontkey — use the -K option instead.
• fontopt
• fontorient — use the -O option instead.
• fontpreferred
• mappings — use the -m option instead.

fontdir
Directory of known fonts — required. Each entry in this file contains information such
as the name and type of the font, its size and style, a textual description of the font
family, and the range of characters defined within the font. To be available to an
application, at least one font must be defined in this configuration file. Entries in this
file are static, they can’t be loaded dynamically.
Each line in this file contains the following comma-separated fields, in this order, for
each known font:
• stem name
• font type/location — for phf files, this is simply the string to add to the stem name
to get the filename containing the font. For others, this is in the form index@filename,
where index is the index into the font contained in filename. This value is always 0.
• textual description, i.e. PC Serif
• point size, i.e. 8
• Font style, i.e. B if bold, I if italics, or a combination
• range of characters defined within font, i.e. 0000-00FF
• special (internal) flags
• font bounding size, i.e. 8x8
• font size in K, i.e. 12K
fontext
A set of extension rules to handle character dropouts (missing characters) — required.
The format of this file is as follows:
+type = fontname [,fontname...]
Where type is the font type (normal, bold, etc.) and fontname is the font name to
search for symbols.
fontmap
A set of mapping rules — required. There are two types:
• Synonym entries, that have the form:

newfont = realfont
In this mapping rule, newfont doesn’t exist, but realfont does. If you try to use
newfont as a font name, it’s mapped to realfont.
The following special-case entry is a default mapping for any unknown font name:
? = realfont

For example, if geneva = helv, then the font geneva12 is translated to helv12.
• Scaling entries, that have the form:
font = {when}scalefont
In this mapping rule, both font and scalefont must exist. When there isn’t an exact
PHF file for font, then a scaled version of scalefont is made according to the when
character used:
* Always scale when no exact PHF file exists for font.

+ Scale only when above the largest size PHF defined for font.
- Scale only when below the smallest size PHF defined for font.
# Scale when outside the range of sizes of PHF files for font
For example, if the files helv08.phf, helv10.phf, and helv12.phf are present
and swiss is a scalable font, the following translations are made:
Rule Input font Translated font

helv = *swiss helv06 swiss06
helv11 swiss11
helv23 swiss23
helv = -swiss helv06 swiss06
helv11 helv10
helv23 helv12
helv = +swiss helv06 Missing-symbol box
helv11 helv10
helv23 swiss23
helv = #swiss helv06 swiss06
helv11 helv10
helv23 swiss23
In all cases, the fonts helv08, helv10, and helv12 (known valid fonts) are used
directly.
fontopts
Contains the command-line options, one option per line — optional. Options are
located under the appropriate schema section. For example, phfont-specific options
are located in the [io-font] section. Options targeted towards a specific rendering
DLL are divided into subsections: boolean, numeral, string. They are formatted as
follows:
[dll id-subsection-schema]

The font server may run in one of two modes: server mode, or private client DLL
mode. In order to differentiate options between the two, by default there is a "dll"
schema. If the font server is running in server mode, it searches for options under
[dll id-subsection], but if the font server is running in client DLL mode, it
searches for options under [dll id-subsection-dll]. If no options are specified,
the default values are used.
PHFONT The default name with which to register the font server.
See also:
bdftophf2, mkfontdir
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. phgrafx
Choose display preferences for your workstation
Syntax:
phgrafx [-s] [-x position[%][r]] [-y position[%][r]]
[-S i|m|n] [-c file]
[-d dir] [-K]
Runs on:
Neutrino
Options:
-s server The full path of the server or the device name.


-S i|m|n The initial state of the main window (iconified, maximized, or

normal).
-c file The display configuration file. The default location is

/etc/system/config/display.conf.
-d dir The io-display device directory. The default location is

/dev/io-display.
-K Create a keyboard region. This option should be used when a

window manager is not currently running.
Description:
You can choose the display preferences for your workstation with the phgrafx utility.

phgrafx © 2010, QNX Software Systems GmbH & Co. KG.
The list of available graphics modes displayed in the above dialog most likely is
different from those on your machine.
The initial settings are the result of a hardware scan Photon did during the installation.
The default selection is a “safe” choice based on this scan; you’ll probably want to
choose something better. The hardware detection program presents only options that
correspond to the kind of graphics card you have. To save these initial settings, click
Apply to accept the new settings, then click the Exit button.
Changing the graphics resolution

Photon supports the following settings for the color depth, depending on the
capabilities of your graphics card:
Number of colors Number of bits

16 million 32
16 million 24
64,000 16
32,000 15
256 8
16 4
Monochrome 1
Choose the best one!

© 2010, QNX Software Systems GmbH & Co. KG. phgrafx
Selecting the refresh rate

The refresh rate determines how often the image on your display is redrawn. Selecting
a higher refresh rate can produce a better screen image with less flicker, but it may
slow down some graphics cards.
WARNING:
Setting the refresh value incorrectly can damage your monitor. Consult your
monitor and video card manuals first.
Selecting hardware or software cursor rendering

You can choose to render the cursor using the video card hardware or software drivers.
Hardware cursor rendering is selected by default.
Global Options
Click Global Options, then click the No Photon on startup check box to disable
Photon on startup. This setting will take effect the next time the computer restarts.
Advanced Options
Click Advanced to edit the advanced settings for the software driver. In the Driver’s
mode options field, enter any command line arguments for the video driver.
Hardware Details
Click H/W Details to view the current hardware information for the computer.
Region Settings
Click Region Settings, then enter x and y coordinates, to define to define the position
of the graphics region on the screen. Enter an input group value to define the input
device to use.
Examples:
Run at initial position (10,10).
phgrafx -x10 -y10
See also:
enum-devices, io-graphics,

phin © 2010, QNX Software Systems GmbH & Co. KG.
Provide Photon system information
Syntax:
phin [-AhLMqW] [-C children] [-f chars] [-n name] [-P name]
[-p pid] [-R rid] [-r rid] [-T type] [command]
Runs on:
Neutrino
Options:
-A Show all regions.
-C children Show all children of this RID.
-f chars Instead of a command, use the specified string of format characters.

Valid characters are:
+ — indent by family generation
A — absolute area
a — area
B — event buffer size
b — blocked state
c — region cursor
d — node
e [isTRWcdDEBm#k] — event flags*
F — family RIDs
f [BFAIKPGMW] — region flags*
G [BTPHD] — channel flags*
g [VABHCD] — process flags*
h — handle
I — input group
i — priority
k — blocked state and pid
M — proxy
N — fullpath
n — name
O — absolute origin
o — relative origin
P — parent RID
p — Process ID (PID)
Q — max number of enqueued events
q — number of enqueued events
R [Mncmtrb] — window render flags*
r — Region ID (RID)
S [MDpIihfARF] — window state flags*
T — window title

© 2010, QNX Software Systems GmbH & Co. KG. phin
w [FBXIMRs<>fTC] — window flags*

z — region size
* See the Description section for details on these options.
-h Suppress header information.
-L Be literal: display flags fields in hex.
-M Display for manager type regions only.
-n name The name of the Photon Manager to communicate with. If the name
starts with a digit, the utility treats it as a node number and
communicates with /dev/photon on that node. If the name starts
with a slash, the utility treats it as a full path. Otherwise, the utility
looks for it in your /dev directory. The default is /dev/photon.
-P name Show information only for the process with this name.
-p pid Show information only for the process with this PID. This option
may be repeated.
-q Suppress all output; the exit value is the number of regions that would
have been listed.
-R rid Start with the region that has this region identifier (RID) and show
information about its children and the siblings behind.
-r rid Show information only for the region with this RID. This option may
be repeated.
-T type Display information only about this type of region:

G — Graphics driver type regions
I — Input group type regions
K — Keyboard driver type regions
M — Window manager type regions
P — Pointer driver type regions (mouse or touchscreen)
W — Application windows type regions
-W Show window type regions only.
command A command that lets you view specific groups of information and
provides a compact way to specify commonly used -f combinations.
Only the first two letters of a command are required:

Command Description Equivalent

all All the commonly used flags pnbrPFfehOzwST
areas Region absolute areas and origins prPOAn
channel Channel information dprPgGkMqQBn
cproc Channel and process dprPgkqQnib
default Simple process and region flags prPfenb
family Region parent, child, and brother info prPFfen
rareas Region relative areas and origins prPoan
regions Specific info about regions prPfeOz
sculpted Region and process info, indented by depth +prPibnT
window Specific info about windows rnwST
wprocess Process info about windows rpiSnT
Description:
The phin utility displays information about the state of the Photon window system.
Here’s what the options of the region flags, event flags, window flags, window render,
window state, process flags, and channel flags indicate.
Region flags: -f [BFAIKPGMW]
• B —Force boundary
• F —Force front
• A —Audio
• I —Input group
• K —Keyboard
• P —Pointer
• G —Graphics
• M —Window Manager
• W —Window Region
Event flags: -e [isTRWcdDEBm#k]
• i —Info events
• s —System events (s is low bandwidth, S is high bandwidth,
and A is all)
• T —Timer events
• R —Raw events

© 2010, QNX Software Systems GmbH & Co. KG. phin
• W —Window-Manager events
• c —Covered events
• d —Drag events
• D —Draw events
• E —Expose events
• B —Boundary events
• m —Motion flags: (m is EV_PTR_MOTION; M is
EV_PTR_MOTION_BUTTON; A is both m and M)
• # —Button flags: (1 is EV_BUT_PRESS; 2 is
EV_BUT_RELEASE; 4 is EV_BUT_REPEAT). Note that
buttons accumulate (e.g.
EV_BUT_PRESS+EV_BUT_RELEASE=3).
• k —Sensitive/opaque to key events
Window flags: -w [FBXIMRS<>fTC]
• F —Foreground
• B —Backdrop
• X —Maximize
• I —Iconify
• M —Move
• R —Resize
• s —Console switch
• < —To back
• > —To front
• f —Focus
• T —Terminate
• C —Close
Window render: -R [Mncmtrb]
• M —Maximized
• n —Minimized
• c —Close
• m —Menu
• t —Title
• r —Resize
• b —Border
Window state: -S [MDpIihfARF]
• M —Is maximized

• D —Is a backdrop
• p —Is PDM
• I —Is an icon
• i —Is iconified
• h —Is hidden
• f —Force front
• A —Accepts Alt keys
• R —Is Remote
• F —Is Focused
Process flags: -g [VABHCD]
• V —Virtual
• A —Armed
• B —Blocked
• H —Held
• C —Catch up
• D —Dynamic Buffer
Channel flags: -G [BTPHD]
• B —Block overflow
• T —Term overflow
• P —No proxy
• H —No hold
• D —Dynamic Buffer
Examples:
Display default information:
phin
Display information about windows on node my_node:
phin -n my_node window
Display information about regions on the device /net/my_node/dev/photon:
phin -n /net/my_node/dev/photon regions
Display parent, child, and brother information about regions on the device
/dev/photon:
phin -n photon family

© 2010, QNX Software Systems GmbH & Co. KG. phlip
Photon TCP/IP and dialup configuration tool
You must be logged in as root to make changes with phlip.
Syntax:
phlip [options]
Runs on:
Neutrino
Options:
-a Disable the option to create new dialups.
-c file Use this network configuration file.
-d Enable debugging. If you specify this option, phlip prints the

contents of the configuration file before and after spawning
netmanager.
-D directory The location from which to search for/save dialup files.
-n dialup_name Immediately switch to the dialup panel and make dialup_name

the current dialup.
-p file Load this dialup explicitly.
-P file Similar to the -p option, but load only this dialup.
-r Disable the option to remove dialups.

fullpath fullpath
-t Turn off the automatic resolution of the IP or netmask.
-u Don’t save the user (GUI) settings.
-v Display the version and configuration information.

phlip © 2010, QNX Software Systems GmbH & Co. KG.


Description:
The phlip command starts Photon’s TCP/IP configuration manager. It’s the front end
for netmanager; it reads and writes the /etc/net.cfg configuration file.
When phlip starts, it invokes netmanager -w all to dump the current snapshot of
all network configuration to the file /etc/net.cfg. It then reads the file and displays
the data.
If you make changes and click Apply, phlip writes all its data and spawns
netmanager -r all. If netmanager reports any errors, phlip displays them in a
popup window.
After netmanager has applied the changes, phlip spawns it again to get an
up-to-date copy of the network settings (netmanager -w all). Any inconsistencies
between the contents of the file after phlip wrote it out and asked netmanager to
apply them, and after netmanager grabbed the latest settings, are changes that for
some reason, netmanager couldn’t make. The netmanager should have reported
these problems when it ran into them. If netmanager printed those errors, phlip
should have brought up a popup window. (To check for inconsistencies, use phlip
-d.)
If you make changes and simply click Done instead of Apply, phlip writes the data
to net.cfg, runs netmanager -r all to apply the changes, reports any errors that
netmanager prints, but then exits immediately, without updating the file and
redisplaying the information.
Remember that your network configuration isn’t really a file, it’s the state of all the
network software currently running. Interfaces come up and go down, nameservers
and routes come and go. The file is only a starting point. Both phlip and
netmanager use net.cfg more as a scratch pad for communication.
If you have obtained a DHCP IP address from the DHCP server, and then you switch
from DHCP mode to manual mode, the DHCP address is released to the server.
Configuring your network interfaces

The phlip tool displays the TCP/IP Configuration window containing a set of tabbed
dialog boxes. You configure your network connections by entering information in
various fields in the dialog boxes. The following section shows the dialog boxes and
how to fill in the information required.

Devices tab
This screen gives you information about all the network interfaces detected on your
computer. The name of the interface is shown next to an icon depicting a network card
in the top right-hand corner of each pane.
The fields on this screen depend on the type of connection that you choose from the
dropdown menu:
Manual If you’re configuring a manual connection, you just have to enter your IP
address and netmask:
IP Enter either a hostname present in the /etc/hosts database

or a DARPA-Internet address expressed in the standard
Internet “dot notation.”
Netmask Enter this number in dotted decimal notation. The number
sets the subnet mask for the interface selected; it shows how
an Internet address is divided on a network. The netmask is
made up of 32 binary bits; bits set to 1 are part of the network
number and those set to 0 are part of the host number.

DHCP If you select a DHCP connection, you are given the opportunity to fill in
two optional fields, ID and Server IP:
ID Normally, you don’t need to fill in this field. Typically, a

DHCP server allocates an identity for a client and sends that
identity to the client automatically; the identity then becomes
the client machine’s hostname. Sometimes, an ISP will
provide an identity separately and a client is expected to enter
this identity as a security measure when they log in. If you
are told to use such an ID, enter it here, otherwise leave the
field blank.
If you specify an ID, it’s passed to dhcp.client with the
-h option.
Server IP Normally, you don’t need to fill in this field. If a network has
more than one DHCP server, any request for DHCP services
from a client on the network is served by the first DHCP
server available. In some situations, you might need to direct
your DHCP request to a particular server rather than the first
one available; in this case, enter the server’s IP address here,
otherwise leave the field blank.
If you specify a server IP address, it’s passed to
dhcp.client with the -s option.

Devices + advanced options tab
If you display the advanced options, you will see an additional pane showing the IP
aliases for this interface. To add an IP alias, simply fill in the IP and Netmask fields,
and then click the Add button. To remove, highlight the alias and click Remove.

Connections + Network tab
This screen displays information about all the connections you can enable. The top
pane shows the connection’s name (this name will be shown in associated applications
such as phdialer), its type, and its interface device.
If you want applications to automatically connect the system to your network or ISP,
use the Automatically Connect check box. If you don’t use this checkbox, the dialer
will be started and you will have to initiate the connection. (For more information on
automatic TCP/IP connection, see /etc/autoconnect.)
If you want to specify a default connection for applications to use, check Always Use
This Connection for that connection.
The Network pane in this screen enables you to select which login type the connection
will use:
Automatic (PAP/CHAP).
This is the type of login used most often. It does everything for you;
all you have to enter is your user name and password.

Script Select this login type if you want to enter a set of commands when
you log in. You must provide a script file containing the set of
commands and enter the name of this file in the new field labeled
Script. Login scripts enable you to set up a consistent set of variables
for each connection.
Interactive Select this option if you want to configure the network connection via
the command line.
This pane also allows you to enter optional nameservers if your server doesn’t provide
this information.
Connections + Connection tab
The options in this pane are self-explanatory.

Connections + Modem tab
This pane is shown only for modem interface connections. Most of the options are
self-explanatory.
The Baud Rate selector is provided for those cases where the modem speed isn’t
auto-negotiated; you could also use this option to set the baud rate lower than would
be auto-negotiated (you might do this for noisy connections when you want to reduce
communication errors).

Connections + Logging tab
If you enable logging in this pane, debugging information is logged to syslogd. This
pane also shows administrative information about the selected connection.

Network tab
A check box in this pane allows you to force the connection to look into the local
/etc/hosts file for hostname lookup before consulting the network server for this
information.

Network + advanced options tab
The additional panes show information such as:
• routing table entries — for more information on routing tables, see route.
• search suffixes — entries list the domains to query if a hostname is not fully
qualified. These entries override the default domain name used to search for
hostnames that don’t contain a dot.
You can add or delete gateways or search suffixes as required.
Examples:
Show the current version, build time and the files that phlip will edit (use this to
confirm that you have the latest information):
phlip -v

See also:
/etc/autoconnect, dhcp.client, ifconfig, netmanager, route

© 2010, QNX Software Systems GmbH & Co. KG. phlocale
Localization utility (timezone, language, keyboard)
Syntax:
phlocale [options]
Runs on:
Neutrino
Options:

-S i|m|n The initial state of the User’s Configuration window (iconified,

maximized, or normal).

fullpath fullpath
-t Start on Time & Date tab window.



Description:
This application is used to set/modify the user localization information such as the
timezone, language and keyboard.

phlocale © 2010, QNX Software Systems GmbH & Co. KG.
Photon must be running for this utility to work.
You can start phlocale from the command line, or by clicking on the Localization
icon in the shelf:
The window looks like this:
Localizing your configuration with phlocale.
The changes (except for the language selection) go into effect when you click on the
Apply or OK button. Any language change takes effect the next time the user logs into
the system.

© 2010, QNX Software Systems GmbH & Co. KG. phlocale
Files:
The following files are databases of the choices for keyboards, timezones, and
languages:
• /usr/photon/keyboard/uc_keyboard_t
• /usr/photon/translations/uc_language_t
• /etc/timezone/uc_tz_t
The phlocale utility creates (if the file doesn’t exist yet) and modifies the following
files:
${HOME}/.ph/uc_local_t
The main user configuration file.
/etc/country The country you’re in, based on your selection of the time zone.
/etc/TIMEZONE Timezone (TZ) information.
${HOME}/.ph/.ABLANG
The selected PhAB language identifier.
/etc/system/trap/.KEYBOARD
The keyboard file_name is inserted, so that the correct keyboard
definition file is used.
See also:
date, rtc
User’s Guide

phlogin, phlogin2 © 2010, QNX Software Systems GmbH & Co. KG.
Log into Photon
Syntax:
phlogin [options]
phlogin2 [options]
Runs on:
Neutrino
Options:
-B phlogin only.
Use slow machine screensaver mode. Forces phlogin to use a
different screensaver mode (see option -T). Normally, when
phlogin enters the screensaver mode, it moves the login dialog
smoothly around the screen. If the graphics driver doesn’t support
hardware blitting, “Slow machine” mode is used, meaning the login
dialog is moved to random locations on the screen.
-g file phlogin only.

Use the given file for the welcome image.
-i phlogin only.
Don’t wait for an input driver.
-L command Command to run (defaults to ph).
-n phlogin2 only.
Disable the user-selector icons.
-O Once: on close, terminate Photon even if $PHINSTANCE is greater

than 1. This mode is used when you run Photon remotely from
Phindows or phditto.
-P command Initialization command. For example: phlogin -P

"show_splashscreen /etc/config/splash.jpg" - p
configure_display. These commands are run in order before the
login dialog is displayed.
-p command One-time initialization command. This option is the same as -P,

except the command is run only if $PHINSTANCE is 1.
-R Repeat: don’t terminate Photon if $PHINSTANCE is greater than 1.
-S command Shutdown command.
-T time phlogin only.

Enter the “screensaver” mode after this number of seconds.

© 2010, QNX Software Systems GmbH & Co. KG. phlogin, phlogin2
-U user[:password]
phlogin only.
The user to log in as, and optionally the password to use.
If you specify both a user name and password (or the name of a user who doesn’t have
a password), the command phlogin executes runs in parallel with the script that has
just launched Photon. You should make sure that this doesn’t create dangerous race
conditions.
For example, the default command that phlogin executes is the ph script. It starts an
input driver if one isn’t running yet. It may happen that both scripts decide to run an
input driver at the same time. Instead of allowing phlogin to run the default ph
script, it’s better to use a modified version that doesn’t attempt to do things that the
script that launched Photon takes care of already.
-X Don’t display the dialog’s Exit button.
If the -L option is present, -O is the default; -R if not.
Description:
The phlogin and phlogin2 utilities are typically used for nodes that boot directly
into Photon or for users who start Photon via a phindows or phditto session.
You can’t start these utilities from the command line — Photon runs one of them
automatically if it was started with the -l option. The ph script sets that option if the
LOGNAME environment variable isn’t set, in particular when tinit is executed
with the -p option (which runs the ph script). To pass command line arguments to
phlogin or phlogin2, use Photon’s -l option. For more information on how to
start Photon without using the ph script, see Photon in Embedded Systems in
the Photon Programmer’s Guide.
The phlogin utility prompts you to enter a userid and optional password through the
Photon Login dialog. The phlogin2 utility is a simplified alternative to the phlogin
utility. In either utility, you can also click on an Exit or Shutdown button to return to
the text-mode console (this runs phlogin or phlogin2 with the -S shutdown
command). To prevent users from exiting to text mode, you can disable this button by
setting the PHEXIT_DISABLE environment variable to 1.

phlogin, phlogin2 © 2010, QNX Software Systems GmbH & Co. KG.
These utilities set the file owner on the Photon server (/dev/photon) to the userid of
the user logging on. Attempts to run Photon applications by other users who don’t
have read and write permission to the Photon server will fail.
If you want to run chmod and chown on your Photon server to allow other users
access, you can do so from the ˜/.ph/phapps script, which is run by the ph script to
initialize the new Photon session. You shouldn’t hard code /dev/photon in this
script; use the $PHOTON environment variable instead.
You can create a configuration file that specifies command line arguments for your
shell to run as a login shell. You might want to do this if you require your .profile
script to run, for example. The configuration file must have the same name as the shell,
and be located in these folders, searched in this order:
1 ˜/.ph/login/shells/
2 /etc/photon/login/shells/
The configuration file can contain any number of blank lines and comments, followed
by a single line of command-line arguments for your shell, including argv[0].
Arguments must be separated by white space. Lines starting with # are comments.
The path to ph is appended to the arguments. You can use a backslash to escape a
white space character, a backslash, or the # character.
The default is:
- -c
This is equivalent to running your shell with:
• argv[0] = -
• argv[1] = -c
• argv[2] = /usr/bin/ph
• argv[3] = NULL
There is no way to specify an empty argument.

The pathname of the ph script is always appended as a separate argument. There is no
way to glue it to some other string to form a single argument.
You can pass command line options to phlogin or phlogin2 when you start
Photon by using the -l option. For example:
Photon -l ’phlogin -S "myshutdown -v"’
will cause Photon to run phlogin -S "myshutdown -v".

© 2010, QNX Software Systems GmbH & Co. KG. phlogin, phlogin2
These environment variables affect phlogin and phlogin2:
LOGNAME If this environment variable isn’t set (such as when ph is run in

the sysinit file), ph runs the phlogin utility.
PHLOGIN_NO_FACES
If this environment variable is set, phlogin2 does not display
the the user-selector icons.
PHEXIT_DISABLE
Turn off the Exit button so that users won’t be able to exit to text
mode.
PHINSTANCE A counter that increments every time phlogin or phlogin2 is

launched. This environment variable is used by the -O option to
detect whether phlogin or phlogin2 has been run more than
once.
See also:
login, ph, tinit
Logging In, Logging Out, and Shutting Down and Managing User Accounts in the

phmenu © 2010, QNX Software Systems GmbH & Co. KG.
Photon window manager menu editor
Syntax:
phmenu [-s server][-x position[%][r]][-y position[%][r]]
Runs on:
Neutrino
Options:

fullpath fullpath



Description:
The phmenu utility starts a graphical Photon window manager menu editor that lets
you use drag-and-drop capabilities to create a customized PWM menu. The PWM
menu appears when you right-click the Photon desktop. You must be running Photon
in order to run phmenu.

© 2010, QNX Software Systems GmbH & Co. KG. phmenu
Using phmenu to change the window manager’s menu.
To add a menu item:
1 Drag the Menu Item to the menu list, dropping it in the location where you’d
like it to appear on the PWM menu.
A blank plugin appears in the list.
2 Fill in the plugin’s Label, enter its Command line, and give it an Accelerator
Key.
3 Click Save.

phmenu © 2010, QNX Software Systems GmbH & Co. KG.
Do not enter the same accelerator key for more than one menu item, or that accelerator
key will not work.
To add a submenu:
1 Drag the Sub Menu icon to the menu list, dropping it in the location where
you’d like it to appear on the PWM menu.
2 Fill in the Submenu label and Accelerator Key.
3 Open the new submenu on the list, and complete the new plugin’s information.
4 Add additional menu items to the submenu as required.
5 Click Save.
You can also:
• Add a separator to the menu list by dragging the Separator icon to the location
where you’d like a separator to appear.
• Delete a menu item by dragging it to the Delete Selection button.
• Change the order of a menu item, submenu, or separator by dragging it to a new

location in the list.
You can also perform all of these operations by right-clicking an existing item or new
item icon, and selecting an operation from the menu.
When you delete an item, it appears in a list of all recently deleted items under the
Delete Selection button. You can drag an item out of this list to a position in the menu
to un-delete it.
Examples:
Run phmenu using the Photon server on node my_node:
phmenu -s/net/my_node/dev/photon
phmenu -x10 -y10
See also:
pwm

© 2010, QNX Software Systems GmbH & Co. KG. Photon
Start Photon server
Syntax:
Photon [-b color] [-C pixels] [-D time] [-g]
[-l command] [-m timers] [-N name] [-n clients]
[-q] [-R time] [-r regions] [-s] [-t tiles]
[-T pixels] [-U pixels] [-v]
Runs on:
Neutrino
Options:
-b color Background color (hex RGB value).
-C pixels Specify the mouse multi-click threshold. This option affects only
multi-clicks and takes effect when the supplied value is larger than
the specified -T value. This option is useful for touch screens.
Default is 0 pixels.
-D time Set the mouse repeat delay in milliseconds (default is 500). This is
the amount of time before mouse repeat events (
Ph_EV_BUT_REPEAT) are generated.
-g Don’t create a new process group.
-l command (“el”) A command that’s to be executed at login.
-m timers Set the total number of timers that the Photon Server can support. If
you specify the -r option, the default is 4 times the number of
regions.
-N name Specify the name to register.
-n clients Set the maximum number of clients that can communicate with the
Photon Server (default is no limit).
-q Be quiet.
-R time Set the mouse repeat rate in milliseconds (default is 33). This is the
amount of time between mouse repeat events (
Ph_EV_BUT_REPEAT).
-r regions Set the maximum number of regions that the Photon Server can
support. Default is no limit.
-s Create a new Photon session.
-t tiles Set the total number of tiles that the Photon Server can support.
This number includes the complete rectangle set for each active
event in the event space. If you specify the -r option, the default is
12 times the number of regions. Otherwise, the default is an
unlimited number of tiles.

Photon © 2010, QNX Software Systems GmbH & Co. KG.
-T pixels Specify the mouse click threshold for drag initiation and multi
clicking. Default is 5 pixels.
-U pixels Specify the size of the area where the position of the release is
forced to be the same position of the press. This may be used to
prevent random changes in position because the size of a finger
press is larger than a pixel. Default is 0 pixels.
-v Be verbose.
Description:
The Photon server lets applications open regions from which Photon events may be
emitted and collected. Specifying the number of clients, regions, and rectangles limits
the resources available to the Photon server.
The Photon device is owned by and has the permissions associated with the user who
invoked it.
To connect with a Photon device, a user must have read permission on the device. To
emit events or to create a region, the user must also have write permission.
The Photon Server registers the name of /dev/photon by default. If the PHOTON
environment variable is defined, that name is be registered instead.
Examples:
Start the Photon server, configuring it for 5 clients that can open a maximum of 200
regions along with up to 1000 rectangles:
Photon -n 5 -r 200 -t 1000
PHOTON The name of the photon device (defaults to /dev/photon).

© 2010, QNX Software Systems GmbH & Co. KG. phrelay
Support remote connectivity with phindows and phditto clients
Syntax:
phrelay [-eGx] [-b number] [-D debugfile] [-g port]
[-k delay,interval,retry] [-V...]
Runs on:
Neutrino
Options:
-b number Set the number of messages buffered to allow write-ahead draws to
Phindows or phditto. The actual number used is the lesser of this
option and the -N option of Phindows or phditto. The default
value is 20. Use a lower value to save memory at the expense of
throughput, or, if memory isn’t an issue, a higher value to gain some
additional throughput performance. Adjusting this setting has the
most effect when end-to-end response time is slow compared with
throughput, such as over a modem or when there are many network
hops between the local and remote ends.
-D debugfile The file or device to which to send the debugging information

specified by the -V option.
-e Don’t allow unencrypted connections. If this option is specified, the

Phindows connection must provide a valid private key with the -K
option, or the connection is refused. Without this option, Phindows
can connect without encryption. For more information, see the
Encryption section below.
-G When phrelay isn’t started automatically by inetd, you can start

with this option to force phrelay to listen to socket port 4868.
-g port This is the same as -G, but you specify the port.
-k delay,interval,retry
The keepalive delay (in seconds), interval (in seconds), and retry
count. This option determines how long phrelay will stay alive
when a network connection to a client has failed (for example, if a
network cable is unplugged). The default setting is 20,5,3.
-V... Be verbose. Add more V’s for greater verbosity. Output is sent to the
file or device you specify in the -D option that’s required if you
specify -V.
-x Embed color palette information into the data stream. This option
works around a problem where some applications with many small
graphics may have incorrect palette tags, and therefore are displayed

phrelay © 2010, QNX Software Systems GmbH & Co. KG.
incorrectly on the client screen. If small graphics (such as on buttons)

appear correctly, you don’t need to use this option.
Description:
The phrelay utility supports remote user interface clients on other nodes.
Remote connectivity via modem

When you specify a modem (using the -m option to phditto or phindows), the
remote client first acts as a simple text terminal emulator so you can interact with the
modem, dial up a remote QNX machine, and log in.
Once you’re logged in, you can start a Photon session by entering the following
command:
The remote client synchronizes with phrelay and starts to function as a Photon
graphics terminal.
Remote connectivity via TCP/IP

When you specify a TCP/IP connection (using the -t option to phditto or
phindows), the inetd program running on the remote QNX host automatically
launches phrelay for you, provided phrelay and inetd have been configured
properly (see below).
Configuring for TCP/IP
There are several configuration issues that need to be taken care of before you can use
phrelay over TCP/IP.
First, the QNX host must have TCP/IP installed and running. In addition, inetd must
be running with the following items specified in the inetd configuration file
/etc/inetd.conf:
phrelay stream tcp nowait root /usr/bin/phrelay phrelay
The file /etc/services file must include the following line (it’s in the default
file):
phrelay 4868/tcp
These two entries cause inetd to listen for incoming requests to establish a new
Photon session. When a request is detected (from a remote phindows or phditto
client), inetd automatically establishes a full TCP/IP connection and launch
phrelay on that connection. The remote phindows or phditto client is then fully
connected to a local Photon session.

Connecting using a serial port

You can use phrelay to connect a machine running phindows (on Windows) or
phditto (on Neutrino) to a Neutrino self-hosted development machine acting as a
target via the machines’ serial ports.
Example serial connection
Use a null modem cable to connect COM1 on a Windows or Neutrino development

host to /dev/ser1 on a QNX6 development machine acting as a target. Here are two
similar procedures that can be used to connect phditto/phindows to phrelay:
1 On the target run on -t/dev/ser1 ksh
2 On the host run phditto -m/dev/ser1 or phindows -mcom1
3 In the phditto/phindows window, get the ksh prompt and then run stty +raw
+echoe +echoke +echoctl +imaxbel +onlcr </dev/ser1
4 In the phditto/phindows window, run the following as root: phrelay -x
You should see the phrelay connect sequence automatically resume. Another way to
connect to the target is as follows:
1 On the target, add /dev/ser1 to the list in /etc/config/ttys, and then as

root restart or run tinit.
2 On the host run phditto -m/dev/ser1 or phindows -mcom1
3 In the phditto/phindows window, get the “login” prompt, log in, and then run:
stty +raw +echoe +echoke +echoctl +imaxbel +onlcr
</dev/ser1
4 In the phditto/phindows window run the following as root: phrelay -x
Using predefined Photon services

The -s command-line option of phditto and phindows is provided to simplify the
task of creating shortcuts to Photon applications within the MS-Windows desktop.
By using the -s option, you can create an icon or shortcut on the MS-Windows
desktop to start up a Photon application automatically (within a private phindows
session). With proper specification of the remote Window Manager options, it’s
possible to make that Photon application look like it’s a native MS-Windows
application.
When phrelay runs on the QNX host machine, it looks up the Photon service
specified with the -s parameter in a configuration file
(/etc/config/phrelay[.node]). If a matching service is found, then phrelay
launches the specified Photon command instead of the default Photon desktop. You
can specify optional window-manager options, but the default mode is to start the
remote Photon application so that it looks and behaves as if it were a native
MS-Windows application.

The phditto/phindows -U option is often used with the -s option to specify a QNX
userid to use when running the remote Photon command. If no userid is given, and the
phrelay service doesn’t specify a default userid, then Photon pops up the QNX
Photon Login dialog requesting the QNX userid before proceeding. By specifying a
userid with the -U option, you can avoid this login dialog.
For example, if a MS-Windows shortcut were created as follows:
phindows -tx.x.x.x -svpoker -Ujoe
where the IP address x.x.x.x specified the TCP/IP address of QNX node 2, and the
phrelay configuration file on node 2 (/etc/config/phrelay.2) contained the
following line:
vpoker % /usr/photon/bin/vpoker
then Joe could directly launch a Photon vpoker session (running as QNX userid joe)
on his MS-Windows desktop by clicking on the shortcut icon.
phrelay configuration file format
The phrelay utility processes requests for service according to the contents of a
configuration file. If phrelay is running on QNX node n, then the file
/etc/config/phrelay.n is used. If this file doesn’t exist, then the default file
/etc/config/phrelay is used.
The format of each service entry in the phrelay configuration file is as follows:
service user [-W pwm_options] command
where:
service is the symbolic name of the Photon service (matches the -s phindows or
phditto parameter).
user defines how to process userids that may be specified on the phindows or
phditto command line (-U option).
user can be one of:
userid QNX userid (if no -U). Prompt for password if required.
userid:password QNX userid and password (if no -U).
% Prompt for user/password (if no -U).
? Always prompt for user/password (ignore -U).
! Fail (if no -U).
=userid Force this userid (ignore -U).
=userid:password Force this userid and password (ignore -U).
pwm_options can be one or more of the following Photon Window Manager options:

P Disable Taskbar, console switching, and keyboard.
W Disable Workspace menu.
R remote_option Remote Window Manager options, where remote_option can be

one or more of:
b Remove Photon Window Manager borders.

c Close Window Manager when program terminates.
f Fit. Make application always fit in phditto/phindows
window. This is the same as both s and l options
combined.
l Continually resize the application to fit the
phditto/phindows window.
m Initially resize application to fit in phditto/phindows
window.
r Initially resize phditto/phindows window to fit
application.
s Continually resize the phditto/phindows window to fit
the application.
t Send Window title to phditto/phindows.
The default Window Manager options are PWRcbtfr.
command is the Photon command to launch instead of the default command, which
starts the Photon desktop.
Data compression options

The phrelay utility supports one of three data compression options that the client can
request:
• Byte-Pair Encoding — (BPE) performs the best data compression and is

recommended for all serial connections. Although BPE is inexpensive to decode
(both in memory and CPU usage), it does require a fair amount of CPU on the host
QNX machine. When link speeds are low (such as with modem links), the extra
cost in CPU on the sending side is well worth the tradeoff.
• Run Length Limited — (RLL) provides good data compression. Although not as
highly compressed as BPE, RLL encoding is both quick to decode and encode.
RLL encoding is recommended for network TCP/IP connections because it places
less CPU load on the QNX host, yet provides fair compression.
• None — With data compression turned off, Photon draw events are transmitted “as
is.” This might make sense if the connection bandwidth is very high (say 100Mb
Ethernet), making the extra processing time involved in data compression an
unnecessary step.

Data caching options

The phrelay utility makes very extensive use of data caching techniques to minimize
the amount of data that needs to be transmitted from the host to the client machine.
Thanks to this intensive data caching, phditto/phindows can operate over
modem-link speeds as low as 9600 baud.
Most “large” static data objects in Photon are “tagged” with a unique 32-bit ID (tag).
Tagged objects include bitmap data, image data, and color palettes. These objects are
generally tagged when first created by the Photon program developers. This process is
accomplished automatically by the Photon development tools, so the program
developer is, for the most part, not even aware that this is taking place.
Photon passes these tags along with the data objects as they flow through the Photon
event space. The end result is that Photon graphics drivers (such as phrelay) almost
always have available a small, unique, precalculated tag to identify the larger Photon
graphical objects.
Encryption
The phrelay utility supports encrypted connections with Phindows versions 3.09
and later.
When Phindows requests an encrypted connection (by specifying a key using the -K
commandline option), phrelay looks for a matching key in the
/etc/config/phkeys file. Each line of the file has this format:
*|user private_key
Keys can be up to 31 characters long.
The line that starts with the * character applies to connections that don’t specify a
Photon service and user ID. For Phindows connections that specify a service (-s), a
user ID can also be specified using -U. In this case, phrelay finds the user in the
/etc/config/phkeys, and checks that the specified key matches the key sent by
Phindows. If a matching key isn’t found, phrelay doesn’t allow the connection, and
Phindows displays a “Error: Permission problem on host” message.
Security
Both Phindows and phditto allow a user to connect to an existing Photon session,
which displays the contents of the Photon session on the remote client’s screen. You
can disable this option by creating an /etc/system/config/noditto file on your
target. When this file exists, remote clients can still connect to your target machine
using their own private Photon session, but they can’t view an already running Photon
session.
Examples:
From a remote phindows or phditto session, type:

See also:
phditto, phrelaycfg

© 2010, QNX Software Systems GmbH & Co. KG. phrelaycfg
Configure remote access to Photon
Syntax:
phrelaycfg [options]
Runs on:
Neutrino
Options:

normal).

fullpath fullpath



Description:
The phrelaycfg command configures remote access to your Photon workspace. The
main window looks like this:

phrelaycfg © 2010, QNX Software Systems GmbH & Co. KG.
The phrelaycfg window.
When you uncheck the Enable remote access to your graphical environment
checkbox and click Apply, phrelaycfg creates a
/etc/system/config/noditto. The presence of this file prevents remote users
from connecting to your Photon session using phditto.
• You can achieve the same result with the command:

touch /etc/system/config/noditto
• You must also configure and run phrelay to allow remote access. If the remote
access is over a TCP/IP connection, you must configure and run inetd, which will
run phrelay.
Files:
/etc/system/config/noditto
The presence of this file prevents anyone from accessing your Photon workspace
from a remote machine.
See also:
inetd, phrelay, phditto

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-bjc
Convert .phs output for a Canon printer
Syntax:
phs-to-bjc [-A] [-B size] [-b size] [-C]
[-c colors] [-D debug_fname] [-d]
[-h height] [-M model] [-m model]
[-n name] [-ocn] [-odn] [-of] [-oh]
[-oin] [-omn] [-opn] [-oQn] [-oq]
[-orn] [-oSX,Y] [-oyn]
[-P file] [-p start[,end]] [-pr]
[-s level] [-U filename]
[-V] [-w width] [-x offset] [-y offset]
filename
Runs on:
Neutrino
Options:
-A Force anti-aliasing of fonts.
-B size Specify the size of the printer buffer in bytes. This buffer is used
if the specified input file is a FIFO.
-b size Specify the size of the slice buffer in bytes.
-C Disable the compression of output data.
-c colors The number of colors available; a value of 1 indicates 256

colors, and a value of 3 indicates 16 million colors.
-D debug_fname Send debug information to the specified file.
-d Delete the input file after processing.
-h height Specify the initial height of the source image. The default is 480
pixels.
-M model Select the model by specifying the QNX model ID, which is a
hexadecimal integer.
-m model Select the model by specifying the MicroSoft model ID, which
is a string of up to 20 ASCII characters.
-n name Specify the name of the printer.
-ocn Adjust the cyan gamma correction for Floyd-Steinberg dithering.

A negative value means less, positive means more.
-odn Set printer graphical depletion (default: 2). Ranges between 0

(disabled) and 5 (remove every fifth pixel).

phs-to-bjc © 2010, QNX Software Systems GmbH & Co. KG.
-of Enable Floyd-Steinberg dithering (default: -oq).
-oh Enable halftone dithering (default: -oq).
-oin Adjust the intensity (0-49 is dark, 50 is normal, and 51-99 is

light). The default is 50.
-omn Adjust the magenta gamma correction for Floyd-Steinberg

dithering. A negative value means less, positive means more.
-opn Specify printing type. Choices are: 1 (B/W); 3 (CMY color); 4

(CMYK).
-oQn Set the print quality (0 is draft, 1 is normal, 2 is high). The

default is 1.
-oq Use the QNX dithering method (default).
-orn Set the resolution; the default is 360 DPI unless specified by the
source file. Valid choices are 90, 180, 360, and 720.
-oSX,Y Scale the image in the X or Y dimension (e.g. -oS0.75,0.6).

The scale value may be:
Negative Scale as a multiple of the source image size. For

example, use -oS-1,-1 to print the image at exactly
its source size. Each pixel of the image will
correspond to one printed dot on the page. The size
of the printed image will vary depending on the
printer resolution (DPI).
Positive Scale as a multiple of the page size. For example, use
-oS1,1 to print the image at the full page size. In
this example, the image will be distorted if its aspect
ratio (X:Y) is different from the page’s width:height
ratio.
0 Use the maximum size while respecting the aspect
ratio of the source image. For example, -oS0,0.5
scales the image to half the height of the page and
scales the width of the image proportionately.
If you set only the X scale factor, the Y scale factor is assumed to
be the same value. For example, -oS0.5 sets both X and Y to
0.5, meaning the image will fill 14 of the page.
-oyn Adjust the yellow gamma correction for Floyd-Steinberg

-P file The name of the Photon palette file to use. The default is
default.pal.

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-bjc
-p start[,end] Specify the starting (and optionally ending) page number to

print. If start is greater than end, the pages are printed in reverse
order.
-pr Print the entire file in reverse order.
-s level Specify the reporting level, where level is an integer.
-U filename Delete this file when the print job is completed. Use for
synchronizing print-spooling operations.
-V Be verbose (-VV: be more verbose).
-w width Specify the initial width of the source image. The default is 640
pixels.
-x offset The initial x offset (default: 0).
-y offset The initial y offset (default: 0).
filename Name of a Photon draw-stream (*.phs) file.
Description:
This utility converts Photon draw-stream (.phs) output for into a form that a Canon
printer understands. The configuration file for Canon printers,
/etc/printers/bjc.cfg specifies phs-to-bjc as a filter for spooler to use.
The output is sent to stdout. Typically, this is redirected to a printer device, as shown
in the example. This utility sends any error messages to slogger; use sloginfo to
display them.
Examples:
phs-to-bjc file.phs >/dev/par
See also:
phs-to-bmp, phs-to-escp2, phs-to-ijs, phs-to-pcl, phs-to-ps, spooler
“Printing with spooler” in the Printing chapter of the Neutrino User’s Guide

phs-to-bmp © 2010, QNX Software Systems GmbH & Co. KG.
Convert .phs output to a bitmap file
Syntax:
phs-to-bmp [-A] [-B size] [-b size] [-c colors]
[-D debug_fname] [-d] [-h height]
[-n name] [-orn] [-oSX,Y]
[-P file] [-p start[,end]]
[-pr] [-s level] [-U filename]
filename
Runs on:
Neutrino
Options:
-b size Specify the size of the printer buffer, in bytes.
-c colors The number of colors available (bytes per pixel); colors must be
1 (256 colors) or 3 (16 million colors). The default is 3.

pixels.
-n name Specify the name of the printer as a string.
-orn Set the resolution; the default is 300 DPI.

ratio.

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-bmp

default.pal.

order.
-pr Print entire file in reverse order.
-U filename Delete this file when the print job is completed.
pixels.
filename Name of a Photon draw-stream (.phs) file.
Description:
This utility converts Photon draw-stream (.phs) output into a bitmap (.bmp) file.
Currently, only one page of output is supported.
The output is sent to stdout. Typically, you redirect it to a file, as shown in the
example.
The output file must be a real file.
This utility sends any error messages to slogger; use sloginfo to display them.
Examples:
phs-to-bmp file.phs >outfile.bmp

phs-to-bmp © 2010, QNX Software Systems GmbH & Co. KG.
See also:
phs-to-bjc, phs-to-escp2, phs-to-ijs, phs-to-pcl, phs-to-ps, spooler

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-escp2
Convert .phs output for an Epson ESC/P2 printer
Syntax:
phs-to-escp2 [-A] [-B size] [-b size] [-C]
[-c colors] [-D debug_fname] [-d]
[-h height] [-M model] [-m model]
[-n name] [-ocn] [-oD n] [-odn] [-of]
[-oh] [-oin] [-omn] [-opn] [-oQn]
[-oq] [-orn] [-oSX,Y] [-oyn] [-P file]
[-p start[,end]] [-pr] [-s level]
[-U filename]
filename
Runs on:
Neutrino
Options:

pixels.
-M model Select the model by specifying the QNX model ID, which is a
hexadecimal integer:
Model ID
MODEL_COLOR 0x101
MODEL_Pro 0x201
MODEL_ProXL 0x202
continued. . .

phs-to-escp2 © 2010, QNX Software Systems GmbH & Co. KG.
Model ID
MODEL_COLOR_IIs 0x203
MODEL_COLOR_II 0x204
MODEL_ProXL_Plus 0x301
STYLUS_COLOR_400 0x63C3C3D
STYLUS_COLOR_440 0x640FC3F
STYLUS_COLOR_500 0x63DFC6C
STYLUS_COLOR_600 0x63EFC9C
STYLUS_COLOR_640 0x6423C9E
STYLUS_COLOR_680 0x6463C9B (same printer as 777)
STYLUS_COLOR_740 0x643FCCF
STYLUS_COLOR_750 0x6446CCE
STYLUS_COLOR_777 0x646CE8E
STYLUS_COLOR_800 0x6403FFD
STYLUS_COLOR_820 0x6425FFC
STYLUS_COLOR_850 0x6456FFE
STYLUS_COLOR_870 0x6470FFF
STYLUS_COLOR_880 0x648FFFA
STYLUS_COLOR_900 0x641FFAC
STYLUS_COLOR_1160 0x63A69AF
STYLUS_COLOR_1200 0x63BC95C
STYLUS_COLOR_1270 0x63BF95E
STYLUS_COLOR_1500 0x63E08ED
STYLUS_COLOR_1520 0x63E68EC
STYLUS_COLOR_3000 0x63BB1FC
If model is less than 0x4000, it’s assumed to be an old-style

Epson model number (400, 500, 600. 800, ...).
The default is determined from the command name. For
example, if invoked as Pp.escp2.600, the default model is
600.
-m model Select the model by specifying the MicroSoft model ID, which
is a string of up to 20 ASCII characters.

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-escp2
-ocn Adjust the cyan gamma correction for Floyd-Steinberg dithering.

A negative value means less, positive means more.
-oDn Specify the Ink Dot size.
-odn Set printer graphical depletion (default: 2). Ranges between 0
(disabled) and 5 (remove every fifth pixel).
-of Enable Floyd-Steinberg dithering (default: -oq).
-oh Enable halftone dithering (default: -oq).
-oin Adjust the intensity (10-49 is dark, 50 is normal, and 51-99 is
light). The default is 50.
-omn Adjust the magenta gamma correction for Floyd-Steinberg
-opn Specify printing type. Choices are: 1 (B/W); 3 (CMY color); 4
(CMYK).
default is 1.
-orn Set the resolution; the default is 360 DPI unless specified by the
source file. Valid choices are 180, 360, and 720.

ratio.

phs-to-escp2 © 2010, QNX Software Systems GmbH & Co. KG.
-oyn Adjust the yellow gamma correction for Floyd-Steinberg

default.pal.

order.
pixels.
Description:
This utility converts Photon draw-stream (.phs) output into a form that an Epson
ESC/P2 printer understands. The configuration file for Epson ESC/P2 printers,
/etc/printers/epson.cfg, specifies phs-to-escp2 as a filter for spooler to
use.
The output is sent to stdout. Typically, this is redirected to a printer device, as shown
in the example. This utility sends any error messages to slogger; use sloginfo to
display them.
Examples:
phs-to-escp2 file.phs >/dev/par
See also:
phs-to-bjc, phs-to-bmp, phs-to-ijs, phs-to-pcl, phs-to-ps, spooler

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-ijs
Photon IJS printing client
Syntax:
phs-to-ijs [options] -Xoutfile phsfile
Runs on:
Neutrino
Options:
-B size Specify the size of the printer buffer in bytes. This buffer is used if
the specified input file is a FIFO.
-b size Specify the size of the slice buffer in bytes. The size can be:
• 0 — automatically determine the size, based on the page size.
• positive — use the specified fixed buffer size.
• negative — don’t allocate a buffer.
The page slice buffer must be large enough to hold at least one line
of the output image; that is:
size ≥ dots_per_inch * page_width(inches) *
bytes_per_pixel
-h height Specify the initial height of the source image, if it isn’t specified by
the input file. The default is 480 pixels.
-m model Select the printer model by specifying a string that matches the
MODEL field of the IEEE 1284 Device ID string. For example,
-m"Stylus COLOR 777".
-oPn Specify media type. The choices are: 1 (plain); 2 (photo); 3

(transparent). The default is 1.
-opn Specify printing type. The choices are: 1 (B/W); 3 (CMY color); 4
(CMYK); 6 (CcMmYK).
-orn Set the resolution; the default is 360×360 DPI.
-oSX,Y Scale the image in the X or Y dimension (e.g. -oS0.75,0.6). The

scale value may be:

phs-to-ijs © 2010, QNX Software Systems GmbH & Co. KG.

example, use -oS-1,-1 to print the image at exactly its
source size. Each pixel of the image corresponds to one
printed dot on the page. The size of the printed image
varies, depending on the printer resolution (DPI).
-oS1,1 to print the image at the full page size. In this
example, the image is distorted if its aspect ratio (X:Y)
is different from the page’s width:height ratio.
0 Use the maximum size while respecting the aspect ratio
of the source image. For example, -oS0,0.5 scales the
image to half the height of the page and scales the width
of the image proportionately.
If you set only the X scale factor, the Y scale factor is assumed to be
the same value. For example, -oS0.5 sets both X and Y to 0.5,
meaning the image fills 14 of the page.
-p start[,end] Specify the starting (and optionally ending) page number to print. If
start is greater than end, the pages are printed in reverse order.
-v Display information about the version, then exit.
-W n Specify the warning level for extensions. Choices are:

• 0 — no warnings (default)
• 1 — warn of unsupported extensions
• 2 — warn of unsupported extensions and terminate
-w width The initial width of the source image, if not specified by the input
file. The default is 640 pixels.
-Xoutfile The output device or file; for example:

• -X/dev/par1
• -X/dev/usbpar0
• -X/home/guest/print1.prn
phsfile The name of a Photon draw-stream (*.phs) file.

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-ijs
Description:
The phs-to-ijs utility is an IJS client for printing Photon draw-stream (.phs)
output using an IJS server. The configuration file for Epson IJS printers,
/etc/printers/epijs.cfg specifies phs-to-ijs as a filter for spooler to use.
If the printer model cannot be determined from the output device, then you need to use
the -m option to specify the printer model.
Currently, only certain EPSON printers are supported.
This utility sends any error messages to slogger; use sloginfo to display them.
Examples:
phs-to-ijs -oS1 -or360x720 -X/dev/par1 file.phs
See also:
phs-to-bjc, phs-to-bmp, phs-to-escp2, phs-to-pcl, phs-to-ps, spooler

phs-to-pcl © 2010, QNX Software Systems GmbH & Co. KG.
Convert .phs output for a Hewlett-Packard PCL compatible printer
Syntax:
phs-to-pcl -m model [options] filename > device
Runs on:
Neutrino
Options:
-A Force the anti-aliasing of fonts.
-B size Specify the size of the printer buffer, in bytes. This buffer is used

pixels.
-m model Select the model by specifying the HP model ID string.

Underscores in model are converted to spaces, and the ID isn’t
case-sensitive.
If you specify an unsupported printer model, the filter doesn’t produce any output. Use
a model of list_supported to get a list of the substrings of all supported printers.
-opmode Specify the color mode. The choices are 1 (black and white), 3
(color), or 4 (Color).

default is 1.



© 2010, QNX Software Systems GmbH & Co. KG. phs-to-pcl

ratio.
default.pal.

order.
pixels.
filename The name of a Photon draw-stream (*.phs) file.
Description:
This utility converts Photon draw-stream (.phs) output into a form that
Hewlett-Packard PCL-compatible printers can understand. The configuration for HP
PCL printers, /etc/printers/pcl.cfg, specifies phs-to-pcl as a filter for
spooler to use.
The phs-to-pcl filter is based on HP’s Appliance Printing Development Kit
(APDK), a library that generates PCL output for a wide range of HP printers. To

produce the correct output, it must be given the printer model, which for best results
should be extracted from the model field of the printer’s PnP string. The spooler
utility does this automatically if you start it without specifying a configuration file (
with the -c option). For example:
spooler -d /dev/usbpar0
This is the case when spooler is started by an enumerator. To get a list of all valid
printer model substrings, pass a model name of list_supported and a valid .phs
file. For example:
phs-to-pcl -m list_supported file.phs > /dev/null
This displays a list of printer model substrings accepted by the APDK. For example, if
DESKJET 85 is in the list, then a printer that identifies itself as DESKJET 850 will be
accepted. Note that some printers may not identify themselves as exactly the same
model they’re labelled with. For example, the HP Deskjet 5650 isn’t in the substring
list, but it actually identifies itself as a Deskjet 5600, which is.
According to the HP APDK documentation, the following printer models and/or
families are supported:
• Deskjet 350C
• Deskjet 400, 400L
• Deskjet 450, 460 Series
• Deskjet 500 Series, 520, 540
• Deskjet 6XX series
• Deskjet 810C, 812C, 815C, 816C, 830, 832, 840, 841, 842, 843
• Deskjet 825, 845
• Deskjet 850, 855, 870, 880, 882, 890, 895
• Deskjet 9XX Series
• Deskjet 11XX Series, 12XX Series
• Deskjet 3810, 3816, 3818, 3819, 3820 Series, 3822, 3870
• Deskjet 51XX, 55XX, 56XX, 57XX, 58XX, 59XX
• Deskjet 61XX, 65XX, 66XX, 68XX, 69XX
• Deskjet 5600 & 5100 & 5800
• Deskjet 6540 & 6520
• Deskjet 5740
• Deskjet 6840

• Deskjet 3320 & 3420 & 3325
• Deskjet 3600 & 3500
• Deskjet 3740 & 3840
• Deskjet 9300
• Deskjet 96XX
• Deskjet 98XX
• Officejet 3XX, 5XX, 6XX, 7XX
• Officejet 11XX
• Officejet 51XX, 61XX, 62XX, 63XX, 4100, 4105, 4200, 5500, 9100
• Officejet 71XX, 72XX, 73XX, 74XX
• Officejet 9x11
• Officejet d Series
• Officejet G Series
• Officejet J Series
• Officejet K Series
• Officejet Lx
• Officejet R Series
• Officejet t Series
• Officejet v Series
• Officejet Pro K Series
• Officejet Pro L Series
• PSC 500, 7XX, 9XX
• PSC 15XX, 16XX
• PSC 21XX, 22XX, 23XX, 24XX, 25XX
• PhotoSmart 1XX, 2XX, 3XX, 4XX
• PhotoSmart 11XX, 12XX, 13XX

• PhotoSmart 71XX, 72XX, 73XX, 74XX, 75XX, 76XX, 77XX, 78XX, 79XX
• PhotoSmart 80XX, 81XX, 82XX, 84XX, 87XX
• PhotoSmart A3XX, A4XX, A5XX, A6XX, A7XX
• PhotoSmart C31XX, C41XX, C51XX, C61XX, C71XX
• PhotoSmart D51XX, D61XX, D71XX, D73XX
• PhotoSmart Pro B83XX
• PhotoSmart P1000, P1100
• All Monochrome Laserjet Printers and MFPs (except LJ 1000, 1005, 1018, 1020)
• All Color LaserJet Printers and MFPs (except LJ 1600, 2600, 3500, 3550, 3600)
• Apollo P2100 & P2150
• Apollo P2200 & P2250
• E-Printer e20
• Business InkJet 1000, 1100 Series, 1200 Series, 22XX Series, 2300 Series, 2600
Series, 2800 Series, 3000 Series
• Color Inkjet cp1700 Series
• HP 2000 Series, 2500 Series
• Apollo 2200, 2500, 26XX, P2XXX
To see if your printer is supported, you can:
• Check the list above to see if your printer model is on it.
• Get the PNP model information from your printer by using the enum-par (see the
documentation for enum-devices) or usb command, and then checking it against
the substring list given by phs-to-pcl’s -mlist_supported option. If a string
in this list is a substring of your printer’s PNP model, then the printer is supported.
If there is no substring match, phs-to-pcl filter aborts when that model name
is used.
If phs-to-pcl rejects an HP printer model, you might be able to make it work by

specifying a different printer model when you invoke phs-to-pcl; if you try
different printer models, you may well get perfectly good results.
The output from phs-to-pcl is sent to stdout. You typically redirect this to a printer
device, as shown in the example. Error messages are sent to the system logger
(viewable using sloginfo), and may also be written to stderr.

Examples:
phs-to-pcl -mDeskjet_6940_series file.phs > /dev/usbpar0
See also:
phs-to-bjc, phs-to-bmp, phs-to-escp2, phs-to-ijs, phs-to-ps, spooler

phs-to-ps © 2010, QNX Software Systems GmbH & Co. KG.
Convert .phs output for PostScript
Syntax:
phs-to-ps [-D debug_fname] [-d] [-E] [-F]
[-l1] [-od] [-p start[,end]] [-pr]
[-U filename] [-V]
filename
Runs on:
Neutrino
Options:
-E Create an encapsulated PostScript file.
-F Specify a fontmap (font substitution table) file. If not set, the

utility uses the default Photon fontmap file
/etc/printers/fontmap.
This file contains one or more “entries”, or font definitions, each
on its own line (separated by the newline character \n). Each
entry has the form:
alias = fontname
Or:
fontname : regular_font_name, bold_font_name, italics_font_name, bold_italics

An alias is a way to substitute all instances of the aliased font
with another font. The font name should correspond to a font
that’s already loaded on the printer.
There are hard-coded aliases used in the default file /etc/printers/fontmap

which you shouldn’t use in your own fontmap file. All aliases should point to a
defined font name.
It is important to have a default font defined. If a font name is
not found in the fontmap file, the default font is used instead.
For example, if you’d like to map all fonts to the printer’s default
font, you just need one line in your fontmap file:
default=default
-l1 (“el one”) Postscript Level 1 (default: PostScript Level 2 which

supports color).

© 2010, QNX Software Systems GmbH & Co. KG. phs-to-ps
-od Append Ctrl-D to the end of the job.

order.
Description:
This utility converts Photon draw-stream (.phs) output into PostScript. The
configuration file for PostScript printers, /etc/printers/ps.cfg, specifies
phs-to-ps as a filter for spooler to use.
The output is sent to stdout. Typically this is redirected to a printer device, as shown in
the example. This utility sends any error messages to slogger; use sloginfo to
display them.
Examples:
phs-to-ps file.phs >/dev/par
See also:
phs-to-bjc, phs-to-bmp, phs-to-escp2, phs-to-ijs, phs-to-pcl, spooler

phshutdown © 2010, QNX Software Systems GmbH & Co. KG.
Shut down and reboot the system (QNX Neutrino)
Syntax:
phshutdown [options]
Runs on:
Neutrino
Options:
-f Shut down fast. Send a SIGTERM signal, but wait only one second
before rebooting.
-i Ignore superuser (root) privileges.
-n nodename Shut down the specified node (default is current node).
-q Be quiet.
-S type The type of shutdown, which must be one of:

• system — shut down the system.
• reboot — reboot the system.
• photon — leave Photon.
• user — same as photon
If no -S option is specified, the shutdown type is read from
$HOME/.ph/phshutdown.cfg, if it exists. This file contains the
shutdown type selected the last time phshutdown was used. If this
file doesn’t exist, phshutdown uses the default type of reboot.
-u Shut down without displaying the shutdown options dialog. This

option may be useful for using phshutdown in a script.
-v Be verbose.
Description:
In its default configuration, phshutdown allows any user to shut the system down.
This makes it easy to use in a single-user desktop environment but is not desirable in a
multi-user, networked configuration. If you want to make it more secure, restrict this
shutdown privilege to root by simply creating a new file, like this:
$ touch /usr/photon/config/phshutdown.restrict
The presence of this file allows any user to end a Photon session, but prevents users
who do not have the root password from shutting down or rebooting the machine.
If you are root, this restriction does not apply unless you pass the -i option with
phshutdown. In this case, you are treated as a non-root user and will be asked for the
root password before being allowed to shut the system down. Using this option

© 2010, QNX Software Systems GmbH & Co. KG. phshutdown
always provides a secure shutdown dialog, even from phlogin, where it’s always
root that launches phshutdown.
The phshutdown utility displays a dialog of shutdown options:
If you choose to shut down the entire system, phshutdown does it in an orderly way
by:
1 Causing a SIGTERM signal to be sent to all processes listed under /proc
2 Waiting for ten seconds (or one second if the -f option is specified)
3 Causing a SIGKILL signal to be sent to all remaining processes
4 Rebooting the system.
The ten-second interval allows processes that have elected to catch the SIGTERM
signal to perform any cleanup they need to do before the system is rebooted.
Files:
/usr/photon/config/phshutdown.restrict
The presence of this file prevents non-root users from shutting down or
rebooting the machine.
$HOME/.ph/phshutdown.cfg
This file holds the type of shut down selected the last time phshutdown was
used.

phshutdown © 2010, QNX Software Systems GmbH & Co. KG.
See also:
procnto, shutdown
Logging In, Logging Out, and Shutting Down in the QNX Neutrino User’s Guide
shutdown_system() in the QNX Neutrino Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. phuser
Manage user accounts
Syntax:
phuser [options]
Runs on:
Neutrino
Options:

normal).

fullpath fullpath



Description:
The phuser utility provides a GUI to manage user accounts on a Photon system.
Using this utility, you can:
• set the icons that phlogin2 displays for user accounts.
• create, edit, and delete users, groups, and shells

phuser © 2010, QNX Software Systems GmbH & Co. KG.
The phuser interface.
Advanced phuser options.
For information about managing user accounts, groups, and shells, see the Managing
User Accounts chapter of the Neutrino User’s Guide.
To change your icon:
1 Click the current icon box. A file selection dialog appears.
2 Select a new icon from the list. The default icon and a selection of others are
located in /usr/share/faces.
3 Click Open.
If you have root priviledges, you can also create, edit, and delete users, groups, and
shells:
1 Click Advanced.
2 If you are not a root-priviledged user, enter the root password.
3 Select the Users, Groups, or Shells tab.

© 2010, QNX Software Systems GmbH & Co. KG. phuser
4 Click the New, Edit, or Remove buttons.
See also:
login, phlogin2

phview © 2010, QNX Software Systems GmbH & Co. KG.
Display regions used on a Photon server
Syntax:
phview [-h height] [-m f|s|t] [-N server] [-S i|m|n]
[-s server] [-w width] [-x x_pos] [-y y_pos]
Runs on:
Neutrino
Options:
-h height Set initial height of window to height pixels.
-m f|s|t Initial display view (f - front, s - side, t - top).
-N server Server node to query.
-S i|m|n Specify initial window state (i - iconify, m - maximize, n - normal).
-s server Specify server node or device name.
-w width Set initial width of window to width pixels.
-x x_pos Initial x_pos position of window.
-y y_pos Initial y_pos position of window.
Description:
The phview utility displays a front, top, or side view of the regions used on a given
Photon server. Each of the main region types (e.g. windows) is displayed in a different
color. In the top or side view, click on a region to identify it.
To learn more about regions, refer to the Photon Programmer’s Guide.
Examples:
Run phview at initial position (10,10) with initial dimension of 200×300.
phview -x10 -y10 -h200 -w300
Run phview using the Photon server on the computer known as remote_server on
your network:
phview -s remote_server
Or
phview -s remote_server/dev/photon

© 2010, QNX Software Systems GmbH & Co. KG. phview
See also:
Photon Programmer’s Guide.

pidin © 2010, QNX Software Systems GmbH & Co. KG.
Display system statistics (QNX Neutrino)
Syntax:
pidin [options] shorthand
Runs on:
Neutrino
Options:
The options are:
-d delay Delay, in tenths of a second. The default is 10.
-F formats A combination of format letters, like the format string for printf().
Like printf(), you can specify the width for a field by including a
number with the format, such as "%I %60N".
Format Description
A Arguments
a Process ID
B What you’re blocked on; see “Values in the Blocked
column,” below.
b Thread ID
c Code size of the process
d Data size of the process
E Environment
e Parent PID
f Process flags (see the flags shorthand below)
H Scheduling-specific information for each thread. For
adaptive partitioning scheduling, it’s the name of the
partition that the thread is running in. For more information,
see the Adaptive Partitioning User’s Guide.
This formatting code was added in the QNX Neutrino Core
OS 6.3.2.
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. pidin
Format Description
h Thread name; if a thread doesn’t have a name, pidin
displays the thread’s ID (tid) instead.
OS 6.3.2.
I PID and TID

i Runmask and inherit mask.
OS 6.3.2.
J State of the thread; see “Thread life cycle” in the QNX

Neutrino Microkernel chapter of the System Architecture
guide
K What kernel call was executed last
l (“el”) The last CPU the thread ran on
M Memory owned by the PID
m Stack size of the process
N Short name of the process
n Long name of the process
o Connection IDs and file descriptors associated with the
process (see the fds shorthand below)
OS 6.3.2.
P (Uppercase “P”) parent group

p (Lowercase “p”) thread priority
Q Interrupt handlers
q Backtrace of calling routines. For best results, use this
format with the I format.
This formatting code was added in QNX Neutrino 6.4.0.
R Timers
S Signal ignore mask
s Signal queued mask
T Number of threads
continued. . .

Format Description
[ Lengths of the send, receive, reply and pulse queues.
This formatting code was added in QNX Neutrino 6.4.0.
If you don’t specify a format, the default is "%a %b %N %p %J %B".

The letter following the scheduling priority number stands for the
scheduling policy used, as follows:
• f — FIFO scheduling
• r — round-robin scheduling
• o — other (currently, same as round-robin scheduling)
• s — sporadic scheduling
For more information on these scheduling policies, see “Thread
scheduling” in the System Architecture guide.
-f formats The same as the -F option, but the formats parameter is a contiguous
string of format codes that gets expanded. For example, -f mbe is
expanded to -F "%m %b %e".
-h Display a brief usage message.
-k Keep printing out data for PIDs and TIDs until an error occurs, for
example, encountering a PID/TID in an unknown state (because the
PID/TID is partially alive).
-l Loop mode; display statistics every delay tenths of a second (specified

with the -d option).
-M formats A combination of format letters, like the format string for printf(), that
controls the formatting of information about memory regions. The
formats include:
Format Description
< Memory object code size
= Memory object data size
> Memory object address
? Memory object offset
M Memory owned by the PID
: (colon) Memory object name
; (semicolon) Offset

If you don’t specify a format, the default is the empty string, "".
-n node The name of the remote node from which to get the information.
-o prio Run at prio priority.
-P pid Show only the process family you’re interested in (pid may be a name
or number).
-p pid Show only the process you’re interested in (pid may be a name or
number).
If the pid is a number, it’s interpreted as a process ID; otherwise, it’s interpreted as a
name.
Don’t assign a numerical name to a process.
The shorthand name is one of the following. You need to type only as many characters
of the name as are required to uniquely identify it.
arguments Show the arguments of the displayed processes.
backtrace Display backtrace information for each thread in the displayed

processes. For example:
$ pidin -p devc-con-hid back
pid-tid backtrace
4103-01 b033ab5b:b03323cb:b03324f3:804f6ed:804c120:804a285
4103-02 b033af63:805ca60:b031f0ad
The output includes the process ID hyphenated to the thread ID,

followed by a backtrace of the addresses of the calling routines.
The backtrace shorthand was added in QNX Neutrino 6.4.0.
channels Display the lengths of the send, receive, reply and pulse queues.
This shorthand is useful if you’re trying to track pulse leaks —
that is, a process not receiving pulses. This can cause a growth in
kernel memory usage, since pulse structures are allocated in the
kernel.
The channels shorthand was added in QNX Neutrino 6.4.0.
environment Show the environment of the displayed processes.
extsched Display details of the active extended scheduler configuration.

For the adaptive partitioning scheduler, this is one line of global
configuration and then one line for each defined partition (showing

the name, budget, critical budget, and overload notifications). For

more information, see the Adaptive Partitioning User’s Guide.
The extsched shorthand was added in the QNX Neutrino Core OS 6.3.2.
family Show the sessions, process groups, parents, siblings, and children
of the displayed processes.
fds Show information about the process’s connections and file

descriptors. If you don’t have permission to access them, pidin
provides only limited information.
The fds shorthand was added in the QNX Neutrino Core OS 6.3.2.
The information for each connection and file descriptor includes

the following:
• the file descriptor, followed by s if it’s a side channel
• the ID of the process the connection is to
• open flags (r or -, followed by w or -), or MP for a mountpoint
• the offset
• the name of the file or device, if available.
flags Show the processes’ flags in hexadecimal, as follows:
Flag Value
_NTO_PF_NOCLDSTOP 0x00000001
_NTO_PF_LOADING 0x00000002
_NTO_PF_TERMING 0x00000004
_NTO_PF_ZOMBIE 0x00000008
_NTO_PF_NOZOMBIE 0x00000010
_NTO_PF_FORKED 0x00000020
_NTO_PF_ORPHAN_PGRP 0x00000040
_NTO_PF_STOPPED 0x00000080
_NTO_PF_DEBUG_STOPPED 0x00000100
_NTO_PF_BKGND_PGRP 0x00000200
_NTO_PF_NO_LIMITS 0x00000400
_NTO_PF_CONTINUED 0x00000800
continued. . .

Flag Value
_NTO_PF_CHECK_INTR 0x00001000
_NTO_PF_COREDUMP 0x00002000
_NTO_PF_PTRACED 0x00004000
_NTO_PF_RING0 0x00008000
_NTO_PF_SLEADER 0x00010000
_NTO_PF_WAITINFO 0x00020000
_NTO_PF_VFORKED 0x00040000
_NTO_PF_DESTROYALL 0x00080000
_NTO_PF_NOCOREDUMP 0x00100000
_NTO_PF_NOCTTY 0x00200000
_NTO_PF_THREADWATCH 0x80000000
info Display information about the system, such as the type of

processor(s) and the amount of free memory.
irqs Show the IRQ handlers owned by the process. For each handler,
pidin shows:
• id — the interrupt ID returned by InterruptAttach() or

InterruptAttachEvent()
• vector — the interrupt vector passed to InterruptAttach() or
InterruptAttachEvent()
• mask_count — the mask level count
• flags — the interrupt flags. Valid flags include:
- T—_NTO_INTR_FLAGS_TRK_MSK
- P—_NTO_INTR_FLAGS_PROCESS
- E—_NTO_INTR_FLAGS_END
• handler:area — the address of the interrupt handler and the
interrupt handler area
• event — a description of the sigevent to be delivered. Valid
descriptions include:
- SIGNAL— signo
- SIGNAL_CODE—signo code:value
- SIGNAL_THREAD—signo code:value
- PULSE—coid:priority code:value
- UNBLOCK
- INTR
- THREAD—code:value

mapinfo Show information about memory mappings. The output looks like
this:
4101 8 proc/boot/io-usb 10o RECEIVE 80K 424K 4096(20K)
libc.so.3 @b0300000 452K 16K
devu-uhci.so @b8200000 24K 4096
devu-ohci.so @b8207000 24K 4096
devu-ehci.so @b820e000 28K 4096
Mapped Phys Memory @40100000 (ee000000) 12K S
It includes:
• the memory object’s name, or Mapped Phys Memory for
mapped physical memory
• the memory object’s address, followed by the offset if
applicable
• the object’s code and data sizes
• the memory object’s flags, which can include:
- ANON — MAP_PRIVATE, MAP_ANON
- E — MAP_ELF
- F — MAP_FIXED
- P — MAP_PRIVATE
- S — MAP_SHARED
For more information about these flags, see mmap() in the
QNX Neutrino Library Reference.
The mapinfo shorthand was added in QNX Neutrino 6.4.0.
memory Show the memory used by the displayed processes; pidin

displays the shared memory regions, including shared objects, and
stack usage for each thread. Shared code and data regions are
removed from the size of the process.
The stack numbers represent the amount of stack currently
mapped and, in brackets, the maximum allowed for that process.
A * next to a stack size indicates that memory used in the stack
isn’t automatically returned to the system heap when the thread
exits. The memory is returned when the process exits.
Entries for /dev/mem indicate shared memory that’s mapped into
the process address space. For example:
/dev/mem @38100000 ( 0) 172K
If the entries for different processes show the same object

(@38100000 in this example), they all reference the same shared
memory object. The processes can map that shared memory
differently; the number in parentheses is the offset that was used
in the mmap() call, and the last number is the size of the mapping.

net Display system information about all the nodes on the Qnet
network.
pmem Display process memory only.
rc Show the process name and arguments of all remote nodes

connected to your machine.
regs Show the values of the registers.
rmasks Display runmasks and inherit masks.
The rmasks shorthand was added in the QNX Neutrino Core OS 6.3.2.
sched Display useful scheduling parameters for each thread. This

shorthand is a synonym for -f abNplHJ.
The sched shorthand was added in the QNX Neutrino Core OS 6.3.2.
session Sort by session ID, then process ID. By default, pidin sorts the
output by process ID.
signals Show the signal state of the displayed processes.
syspage Show the syspage entry. You can specify which section to print
by indicating a name (e.g. the command pidin
syspage=asinfo displays the asinfo section). The default is
all. For more information, see “Structure of the system page” in
the Customizing Image Startup Programs chapter of Building
Embedded Systems.
threads Show the thread name; if a thread doesn’t have a name, pidin
displays the thread’s ID (tid) instead.
timers Show the timers owned by the process. For each timer it shows:
• id — the timer ID returned by TimerCreate().
• tid — the thread ID associated with this timer (0 for the entire
process).
• overruns — the number of overruns.
• clock_type — the type of clock used. Valid descriptions
include:
- REAL — CLOCK_REALTIME
- SOFT — CLOCK_SOFTTIME
- MONO — CLOCK_MONOTONIC
• flags — the timer flag. Valid flags include:
- X — _NTO_TI_EXPIRED

- A — _NTO_TI_ABSOLUTE
- a — _NTO_TI_ACTIVE
• msec — the time left before expiry, in milliseconds.
• interval_msec — the timer interval, in milliseconds.
• event — the description of the sigevent to be delivered on
timer expiry. Valid event descriptions are listed for the irq
shorthand.
times For each process displayed, show:

• start time — the time and date that the process was started
• utime — the number of CPU seconds consumed by the
process
• stime — the number of CPU seconds consumed by the kernel
on behalf of the process
• cutime — the number of CPU seconds consumed by the
children of the process
• cstime — the number of CPU seconds consumed by the
kernel on behalf of the children of the process
The times for the child processes are added to cutime and
cstime only after the children terminate.
CPU usage is calculated by sampling. When the timer interrupt occurs, the kernel
determines which process is running, and adds the time to the total running times of
the active thread and its process. If the kernel itself is active, it also adds the time to
the system times (stime) of the active thread and its process. The utime is the total
running time minus the system time.
As a result, these times are approximate, and can be inaccurate (e.g. if a process is
driven by the timer interrupt). To determine more accurate times, use the system
profiler. For more information, see the System Analysis Toolkit User’s Guide, or the
Analyzing Your System with Kernel Tracing chapter of the IDE User’s Guide.
ttimes Show thread times.
users Display the real, effective, and saved user IDs and group IDs for
the user who launched the processes. This option doesn’t display
the user name or group name, just the numerical IDs.
Description:
The pidin utility displays statistics about the processes running on a QNX Neutrino
system.
By default, pidin displays the statistics once and then exits. If you specify the -l,
pidin loops forever, displaying statistics after the delay specified by the -d option.

If you specify the -l and -k options, pidin loops until a error occurs, displaying
statistics after the given delay. The most common error encountered is a race
condition: procnto indicates that a process exists, but the process is gone when
pidin queries it.
If you want to find out how much space the image file system (IFS) occupies in the
memory, run the following command:
pidin syspage=asinfo
and look for the lines with imagefs. See the output in the display as shown in the
example below.
Values in the Blocked column

If you specify the %B format, the output includes a Blocked column whose value
depends on the thread’s state:
State Value
CONDVAR Address of the condvar
JOIN Thread ID of the blocking thread
MUTEX The address of the mutex, or the IDs of the process and thread
blocked on, followed by the number of times locked, in the form
pid-tid #times
RECEIVE ID of the channel within the process that the thread is blocked on
REPLY Process ID
SEM Address of the semaphore
SEND Process ID
STACK Stack size
WAITPAGE Virtual address of the page
WAITTHREAD Thread ID of the blocking thread
Examples:
The pidin command prints a listing similar to this:
pid tid name prio STATE Blocked
1 1 /sys/procnto-instr 0f READY
1 3 /sys/procnto-instr 10r RUNNING
1 4 /sys/procnto-instr 12r RECEIVE 1
2 1 sbin/tinit 10o REPLY 1

3 1 proc/boot/slogger 10o RECEIVE 1

5 1 proc/boot/pci-bios 10o RECEIVE 1
6 1 roc/boot/devb-eide 10o SIGWAITINFO
6 2 roc/boot/devb-eide 21r RECEIVE 1
...
Using pidin -F "%I %60N" displays the PID and TID, along with up to 60
characters of the processes’ short name:
pid-tid name
1-01 rldbuild/cdr/qnx6/tmp/target/qnx6/x86/boot/sys/procnto-instr
2-01 sbin/tinit
3-01 proc/boot/slogger
5-01 proc/boot/pci-bios
6-01 proc/boot/devb-eide
...
The pidin mem command displays:

pid tid name prio STATE code data stack
1 1 /sys/procnto-instr 0f READY 1812K 12K 0(320)*
1 3 /sys/procnto-instr 10r RUNNING 1812K 12K 0(8192)
1 4 /sys/procnto-instr 12r RECEIVE 1812K 12K 0(8192)
procnto-instr @cfbe5000 12K 12K
2 1 sbin/tinit 10o REPLY 8192 36K 4096(516K)*
ldqnx.so.2 @b0300000 344K 16K
3 1 proc/boot/slogger 10o RECEIVE 8192 104K 4096(516K)*
ldqnx.so.2 @b0300000 344K 16K
5 1 proc/boot/pci-bios 10o RECEIVE 36K 40K 8192(516K)*
ldqnx.so.2 @b0300000 344K 16K
6 1 roc/boot/devb-eide 10o SIGWAITINFO 52K 91M 8192(516K)*
6 2 roc/boot/devb-eide 21r RECEIVE 52K 91M 4096(12K)
...
The pidin syspage=asinfo command displays:

Section:asinfo offset:0x00000568 size:0x00000240
0) 0-ffff o:ffff a:0000 p:100 n:io
20) 0-ffffffff o:ffff a:0010 p:100 n:memory
40) 0-ffffff o:0020 a:0010 p:100 n:memory/isa
a0) 0-9fbff o:0040 a:0017 p:100 n:memory/isa/ram
180) 1000-cfff o:00a0 a:0007 p:100 n:memory/isa/ram/sysram
1a0) 20f98-9fbff o:00a0 a:0007 p:100 n:memory/isa/ram/sysram
c0) 100000-ffffff o:0040 a:0037 p:100 n:memory/isa/ram
1c0) 100000-40e507 o:00c0 a:0007 p:100 n:memory/isa/ram/sysram
1e0) 5e533c-ffffff o:00c0 a:0027 p:100 n:memory/isa/ram/sysram
60) 6000000-ffefffff o:0020 a:0013 p:100 n:memory/device
100) 6000000-ffeafff o:0060 a:0017 p:100 n:memory/device/ram
220) 6000000-ffeafff o:0100 a:0007 p:100 n:memory/device/ram/sysram
80) fff00000-ffffffff o:0020 a:0005 p:100 n:memory/rom
e0) 1000000-5ffffff o:0020 a:0037 p:100 n:memory/ram
200) 1000000-5ffffff o:00e0 a:0027 p:100 n:memory/ram/sysram
120) 40e508-5e533b o:0020 a:0005 p:100 n:memory/imagefs
140) 400400-40e507 o:0020 a:0007 p:100 n:memory/startup
160) 40e508-5e533b o:0020 a:0007 p:100 n:memory/bootram

See also:
hogs, ps, showmem, top
QNX Neutrino Microkernel chapter of the System Architecture guide

pin © 2010, QNX Software Systems GmbH & Co. KG.
Display PC Card information
Syntax:
pin [-s socket] [command]
Runs on:
Neutrino
Options:
-s socket Display information about this PC Card socket only (starting at 1).
Description:
The pin utility displays useful information about PC Card resources, servers and
cards.
The command specifies the type of information to be displayed:
status Show the status of each socket. This is the default command.
config Attempt to make configuration file entries (obsolete).
cis Decode the Card Information Structure (CIS) on the card.
The QNX Neutrino PC Card server (devp-pccard) automatically configures

PCMCIA/CardBus I/O cards as they’re inserted. It also manages computer resources
such as memory windows, ports and IRQs. Resources are allocated as cards are
inserted and then freed as cards are removed.
Drivers that are PC Card-aware can be informed of card insertions and removals,
based on the type of card. These drivers can then configure themselves to use the
correct ports and IRQs (see the pccard_* functions in the Library Reference). The
pccard-launch utility automatically starts drivers and passes them command-line
arguments describing the ports and IRQs used by the card, thus permitting a non-PC
Card-aware driver to be automatically started when the card is inserted and stopped
when removed.
See also:
devp-pccard, pccard-launch

© 2010, QNX Software Systems GmbH & Co. KG. ping
Send ICMP ECHO_REQUEST packets to network hosts (UNIX)
Syntax:
ping [-aDdfLnoPQqRrv] [-c count] [-E policy] [-g gateway]
[-h host] [-I ifaddr] [-i wait] [-i interval]
[-l preload] [-p pattern] [-s packetsize] [-t tos]
[-T ttl] [-w maxwait] host
Runs on:
Neutrino
Options:
-a Emit an audible beep (by sending an ASCII BEL character to the
standard error output) after receiving each non-duplicate response.
For the sake of your sanity, this option is disabled if you use the -f
option to do a flood ping.
-c count Stop after sending (and receiving) this many ECHO_RESPONSE

packets.
-D Set the Don’t Fragment bit in the IP header. This is meant to

determine the path MTU.
-d Set the SO_DEBUG option on the socket being used.
-E policy Specify the IPsec policy for packets.
-f Do a “flood ping”: output packets either as fast as they come back or

one hundred times per second, whichever is faster.
For every ECHO_REQUEST sent, a “.” is printed; for every
ECHO_REPLY received, a backspace is printed. This quickly
shows how many packets are being dropped.
Only the superuser (root) may use the -f option; it can be very hard on a network —
use it with caution.
-g gateway Use Loose Source Routing to send the ECHO_REQUEST packets

via gateway. The default is to use the routing table.
-h host Alternate way of specifying the target host instead of as the last
argument.
-I ifaddr Send multicast datagrams on the network interface specified by the

interface’s hostname or IP address.
-i interval Wait interval seconds between sending each packet (default is one
second). For the -f option, the interval is 0.01 seconds.

ping © 2010, QNX Software Systems GmbH & Co. KG.
-l preload Send this many packets as fast as possible before returning to

normal behavior. Only the superuser may use this option.
-L Disable loopback when sending to multicast destinations, so the

transmitting host doesn’t see the ICMP requests.
-n Print numeric output only. No attempt is made to look up symbolic

names for host addresses.
-o Exit successfully after receiving one reply packet.
-P Use a pseudo-random sequence for the data instead of the default,

fixed sequence of incrementing 8-bit integers. This is useful to foil
compression on PPP and other links.
-p pattern Fill out the packet with this many “padding” bytes (maximum is
16). You should find this useful for diagnosing data-dependent
problems in a network. For example, -p ff causes the sent packet
to be filled with ones.
-Q Don’t display responses such as Network Unreachable ICMP

messages concerning the ECHO_REQUESTs sent.
-q Be quiet: display nothing except for the summary lines at startup

time and when finished.
-R Record the route.
-r Bypass the normal routing tables and send directly to a host on an

attached network. If the host isn’t on a directly attached network, an
error is returned. You can use this option to ping a local host
through an interface that has no route through it (e.g. after the
interface was dropped by routed).
-s packetsize Send this many data bytes. The default is 56, which translates into
64 ICMP data bytes when combined with the 8 bytes of ICMP
header data.
-T ttl Use the specified time-to-live. It represents how many hops the
packet can go through before being discarded (when it reaches 0).
The default is 255.
-t tos Use the specified hexadecimal type of service.
-v Verbosity (default none).
-w maxwait Specify a timeout, in seconds, before ping exits regardless of how

many packets have been sent or received.

Description:
The ping utility uses the ICMP protocol’s mandatory ECHO_REQUEST datagram to
elicit an ICMP ECHO_RESPONSE from the given host or gateway.
ECHO_REQUEST datagrams, known as pings, have an IP and ICMP header,
followed by a timeval structure and then an arbitrary number of padding bytes used
to fill out the packet.
When using ping for isolating faults, you should first run it on the local host to verify
that the local network interface is up and running. You should then ping hosts and
gateways further and further away. Round-trip times and packet-loss statistics are
computed. If duplicate packets are received, they aren’t included in the packet-loss
calculation, although the round-trip time of these packets is used in calculating the
minimum/average/maximum round-trip time numbers. When the specified number of
packets has been sent (and received), or if you terminate ping with a SIGINT, a brief
summary is displayed.
The ping utility is intended for testing, measuring, and managing networks. Because
of the load it can impose on the network, you shouldn’t use ping during normal
operations or from automated scripts.
Debugging
You can use the ping utility to determine if you have connectivity to other hosts.
Suppose you’ve configured a point-to-point link (PPP), but you haven’t specified a
default route. You can type the following to see if you’re connected to the other end of
the link:
ping isp.com
With success, ping outputs something like this:

PING isp.com (10.0.0.1): 56 data bytes
64 bytes from 10.0.0.1: icmp_seq=0 ttl=255 time=0 ms
This report continues until ping is terminated. To terminate ping, press Ctrl-C. You’ll
see a report like this:
--- isp.com ping statistics ---
7 packets transmitted, 7 packets received, 0% packet loss
round-trip min/avg/max = 0/0/0 ms

ping © 2010, QNX Software Systems GmbH & Co. KG.
The ping utility may fail for different reasons:
• If nothing is displayed, ping may be having problems resolving the hostname. Try
the IP address directly to bypass the resolver (see the /etc/nsswitch.conf file).
• If only the first line of the above successful output is displayed, then ping isn’t
receiving a response from the specified host.
• All other problems and errors result in an obvious message (e.g. “No route to
host”).
ICMP packet details

An IP header without options is 20 bytes. An ICMP ECHO_REQUEST packet
contains an additional 8 bytes worth of ICMP header followed by an arbitrary amount
of data. (Specifying a packetsize via option -s determines the size of this extra piece
of data; default is 56). Thus the amount of data received inside of an IP packet of type
ICMP ECHO_REPLY is always 8 bytes more than the requested data space (the
ICMP header).
If the size of the data space is at least 8 bytes, ping uses the first 8 bytes of this space
to include a timestamp that it uses in the computation of round-trip times. If less than
eight bytes of padding are specified (option -p), no round-trip times are given.
Duplicate and damaged packets
The ping utility reports duplicate and damaged packets.

Although they should never happen, duplicate packets can occur in many situations
and seem to be caused by inappropriate link-level retransmissions. While duplicates
are rarely (if ever) a good sign, the presence of low levels of duplicates isn’t always
cause for alarm.
Damaged packets, on the other hand, are serious and often indicate malfunctioning
hardware somewhere in the ping packet’s path (in the network or in the hosts).
Trying different data patterns
The (inter)network layer should never treat packets according to the data contained in
the data portion. Unfortunately, data-dependent problems have been known to sneak
into networks and remain undetected for long periods of time. In many cases, the
particular pattern that will have problems is something that doesn’t have sufficient
“transitions,” such as all ones or all zeros, or a pattern right at the edge, such as almost
all zeros. It isn’t necessarily enough to specify a data pattern of all zeros, for example,
on the command line because the pattern of interest is at the data-link level—the
relationship between what you type and what the controllers transmit can be
complicated.
So if you have a data-dependent problem, you’ll probably have to do a lot of testing to
find it. If you’re lucky, you may manage to find a file that either can’t be sent across

your network or that takes much longer to transfer than other similar length files. You
can then examine this file for repeated patterns that you can test using the -p option.
TTL details
The TTL value of an IP packet represents the maximum number of IP routers that the
packet can go through before being thrown away. In current practice you can expect
each router in the Internet to decrement the TTL field by exactly one. The TCP/IP
specification states that the TTL field for TCP packets should be set to 60, but many
systems use smaller values (4.3 BSD uses 30, 4.2 uses 15).
The maximum possible value of this field is 255, and most UNIX systems (including
QNX) set the TTL field of ICMP ECHO_REQUEST packets to 255. Thus you’ll find
you can “ping” some hosts, but not reach them with telnet or ftp.
In normal operation, ping prints the ttl value from the packet it receives. When a
remote system receives a ping packet, it can do one of three things with the TTL field
in its response:
• Not change it — this is what Berkeley UNIX systems did before the 4.3BSD-Tahoe
release. The TTL value in the received packet is 255 minus the number of routers
in the round-trip path.
• Set it to 255 — this is what current Berkeley UNIX systems do. The TTL value in
the received packet is 255 minus the number of routers in the path from the remote
system to the pinging host.
• Set it to some other value — some machines use the same value for ICMP packets
that they use for TCP packets; for example, either 30 or 60. Others may use
completely wild values.
Files:
The ping utility requires the libsocket.so shared library.
Exit status:
0 Success (the host is alive).
Nonzero An error occurred. The arguments are incorrect or the host isn’t
responding.

ping6 © 2010, QNX Software Systems GmbH & Co. KG.
Send ICMPv6 ECHO_REQUEST packets to network hosts (UNIX)
Syntax:
ping6 [-dfHnNqRvw] [-a addrtype] [-b bufsiz] [-c count]
[-h hoplimit] [-I interface] [-i wait] [-l preload]
[-p pattern] [-P policy] [-S sourceaddr] [-s packetsize]
[hops...] host
Runs on:
Neutrino
Options:
-a addrtype Generate an ICMPv6 Node Information Node Addresses query
(rather than ECHO_RESPONSE), where addrtype is a string
constructed from the following characters:
A Request that the responder’s anycast addresses be returned

(if not specified, return unicast addresses only). Note that the
specification doesn’t specify how to get responder’s anycast
addresses. This is an experimental option.
a Request all of the responder’s unicast addresses. If omitted,
only the addresses that belong to the interface which has the
responder’s address are requests.
c Request the responder’s IPv4-compatible and IPv4-mapped
addresses.
g Request the responder’s global-scope addresses.
l Request the responder’s link-local addresses.
s Request the responder’s site-local addresses.
-b bufsiz Set the socket buffer size.
-c count Stop after sending (and receiving) this many ECHO_RESPONSE

packets.
-d Set the SO_DEBUG option on the socket being used.
-f Do a “flood ping”: output packets either as fast as they come back

or one hundred times per second, whichever is faster. For every
ECHO_REQUEST sent, a “.” is printed; for every ECHO_REPLY
received a backspace is printed. This quickly shows how many
packets are being dropped.

© 2010, QNX Software Systems GmbH & Co. KG. ping6
Only the superuser (root) may use the -f option; it can be very hard on a network —
use it with caution.
-H Try a reverse-lookup of the IPv6 addresses.
-h hoplimit Set the IPv6 hoplimit.
-I interface Source packets with the given interface address. This flag applies
if the ping destination is a multicast address, or a
link-local/site-local unicast address.
-i wait Wait this many seconds between sending each packet (default is
one second). This option is incompatible with -f.
-l preload Send this many packets as fast as possible before returning to

normal behavior. Only the superuser (root) may use this option.
-n Print numeric output only. No attempt is made to lookup symbolic

names for host addresses.
-N Probe the node information multicast group (ff02::2:xxxx:xxxx).

The host argument must be a string hostname of the target (it can’t
be a numeric IPv6 address). The node information multicast group
is computed based on a given host, and is used as the final
destination. Since the node information multicast group is a
link-local multicast group, the destination link needs to be
specified by -I.
-p pattern Fill out the packet with this many “pad” bytes (maximum is 16).
You should find this useful for diagnosing data-dependent
problems in a network. For example, -p ff causes the sent packet
to be filled with ones. If specified with -q, any ICMP error
messages caused by its own ECHO_REQUEST messages are
printed.
-P policy Specify the IPsec policy to use for the probe.
-q Be quiet: display nothing except the summary lines at startup time

and when finished.
-R Make the kernel believe that the target host (or the first hop if you
specify hops) is reachable by injecting an upper-layer reachability
confirmation hint. The option is meaningful only if the target host
(or the first hop) is a neighbor.
-S sourceaddr Specify the source address of request packets. The source address
must be one of the unicast addresses of the sending node. If the
outgoing interface is specified by the -I option as well, sourceaddr
needs to be an address assigned to the specified interface.

-s packetsize Send this many data bytes. The default is 56, which translates into
64 ICMP data bytes when combined with the 8 bytes of ICMP
header data. You may also need to specify -b to extend socket
buffer size.
-v Verbosity. List all ICMP packets received.
-W Same as -w, but use the old packet format based on 03 draft. This
option is present for backward compatibility.
-w Generate an ICMPv6 Node Information FQDN query, rather than

ECHO_REQUEST. The -s option has no effect when -w is
specified.
hops The IPv6 addresses for intermediate nodes, which are put into a
type 0 routing header.
host The IPv6 adddress of the final destination node.
Description:
The ping6 utility uses the ICMPv6 protocol’s mandatory ICMP6_ECHO_REQUEST
datagram to elicit an ICMP6_ECHO_RESPONSE from the given host or gateway.
ICMP6_ECHO_REQUEST datagrams, known as pings, have an IPv6 header, and
ICMPv6 header formatted as documented in RFC 2463.
When using ping6 for isolating faults, you should first run it on the local host to
verify that the local network interface is up and running. You should then “ping” hosts
and gateways further and further away. Roundtrip times and packet-loss statistics are
computed. If duplicate packets are received, they aren’t included in the packet-loss
calculation, although the roundtrip time of these packets is used in calculating the
minimum/average/maximum roundtrip time numbers. When the specified number of
packets has been sent (and received), or if you terminate ping6 with a SIGINT, a brief
summary is displayed.
The ping6 utility is intended for testing, measuring, and managing networks. Because
of the load it can impose on the network, you shouldn’t use ping6 during normal
operations or from automated scripts.

© 2010, QNX Software Systems GmbH & Co. KG. ping6
Duplicate and damaged packets

The ping6 utility reports duplicate and damaged packets.
Although they should never happen when pinging a unicast address, duplicate packets
can occur in many situations and seem to be caused by inappropriate link-level
retransmissions. While duplicates are rarely (if ever) a good sign, the presence of low
levels of duplicates isn’t always cause for alarm. Duplicates are expected when
pinging a broadcast or multicast address, since they’re not really duplicates but replies
from different hosts to the same request.
Damaged packets, on the other hand, are serious and often indicate malfunctioning
hardware somewhere in the ping6 packet’s path (in the network or in the hosts).
Trying different data patterns

The (inter)network layer should never treat packets according to the data contained in
the data portion. Unfortunately, data-dependent problems have been known to sneak
into networks and remain undetected for long periods of time. In many cases, the
particular pattern that will have problems is something that doesn’t have sufficient
“transitions,” such as all ones or all zeros, or a pattern right at the edge, such as almost
all zeros. It isn’t necessarily enough to specify a data pattern of all zeros, for example,
on the command line because the pattern of interest is at the data-link level—the
relationship between what you type and what the controllers transmit can be
complicated.
So if you have a data-dependent problem, you’ll probably have to do a lot of testing to
find it. If you’re lucky, you may manage to find a file that either can’t be sent across
your network or that takes much longer to transfer than other similar length files. You
can then examine this file for repeated patterns that you can test using the -p option.
Files:
The ping6 utility requires the libsocket.so shared library.
Exit status:
0 Success (the host is alive).
Nonzero An error occurred. The arguments are incorrect or the host isn’t
responding.
See also:
ifconfig, netstat, ping, routed, traceroute, traceroute6
Based on:
• A. Conta, and S. Deering, Internet Control Message Protocol (ICMPv6) for the
Internet Protocol Version 6 (IPv6) Specification, RFC 2463, December 1998.

• Matt Crawford, IPv6 Node Information Queries,

draft-ietf-ipngwg-icmp-name-lookups-05.txt, October 22, 1999, work in progress
material.

© 2010, QNX Software Systems GmbH & Co. KG. pipe
Pipe manager (QNX Neutrino)
Syntax:
pipe [-1] [-a atomic_write_size]
[-P] [-s pipe_buffer_size] &
Runs on:
Neutrino
Options:
-1 ("One") Unblock select() for writing when _PC_PIPE_BUF bytes are
available (the default is 1 byte). See the description section to know about
_PC_PIPE_BUF.
-a atomic_write_size
Set the atomic write size for _PC_PIPE_BUF (the default is 5120 bytes). See
the description section to know about _PC_PIPE_BUF.
-P Synchronize the modification of POSIX attributes to host filesystem.
-s pipe_buffer_size
Set the total buffer size (the default is 5120 bytes).
All these options were added in the QNX Neutrino Core OS 6.3.2.
Description:
The pipe manager implements the subset of file I/O known as pipes (or anonymous
FIFOs). A simple form of interprocess communication, pipes are mostly used to
connect the output of one process to the input of another to form a series of filters.
This version of pipe is backward compatible. When you invoke pipe with no
arguments, the behavior you get is identical to that of the earlier versions of pipe.
The atomic_write_size is the size for which it’s guaranteed that a write() of data won’t
be interleaved with data from any other process; in other words the amount of data that
will be written atomically. This is required when there are multiple writers sending
data to a single reader. The POSIX maximum is referred to as PIPE_BUF, and can be
queried at runtime using fpathconf(_PC_PIPE_BUF). It isn’t recommended to
lower this value from the default 5120 bytes in case application code is using the
PIPE_BUF manifest from <limits.h> rather than a runtime fpathconf()
determination.

pipe © 2010, QNX Software Systems GmbH & Co. KG.
The pipe_buffer_size is the total buffer size of the pipe (and must be at least the
atomic write size). Effectively the pipe utility can hold this many (unread) bytes
before write() clients start to block or fail with EAGAIN (based on their
O_NONBLOCK orientation).
There is no simple mechanism (such as fpathconf()) to query the pipe-buffering
capacity, but it can be determined by writing one byte at a time to an empty
O_NONBLOCK pipe and counting how many are consumed until an EAGAIN error
(full-pipe indication) is returned. Increasing this value could make pipelines more
elastic, in terms of decoupling the writer from the reader processes, at the expense of
using extra system memory for each pipe. Across a sample of OSs, pipe-buffering
capacity is in the 4–16 KB range.
Strict POSIX conformance requires that the atime and mtime attributes of a FIFO be
updated for every read() and write() operation. As FIFOs operate by redirecting access
of the FIFO from the host filesystem to the pipe server, maintaining these attributes
requires additional synchronization messages from the pipe server back to the host
filesystem. In most cases, this level of synchronization isn’t required, and by default is
performed only at the last close() of the FIFO. For strict POSIX conformance, specify
the -P option.
The -1 option sets the behavior for select() write notification of the pipe utility. The
original behavior was to satisfy or unblock select() clients even if 1 byte of buffer
space was available. POSIX specifies a different behavior. Since the atomic write size
and the total buffer size are both equal to 5120 bytes, select() would be satisfied only
on an empty pipe, which may impact performance or establish a lock-step timing
between the writing and reading processes. If this option is enabled, consider also
increasing the -s to be larger than PIPE_BUF so that the pipe doesn’t have to
completely drain before a select() for write is satisfied.
Exit status:
The pipe utility terminates only if an error occurs during startup. If pipe fails during
startup, it prints a diagnostic message to the standard output stream and then exits with
a nonzero status.
See also:
mqueue

© 2010, QNX Software Systems GmbH & Co. KG. pppd
Point-to-Point protocol daemon
Syntax:
pppd [options]
Runs on:
Neutrino
Options:
For details about the options, see
http://netbsd.gw.com/cgi-bin/man-cgi?pppd++NetBSD-4.0 in the
NetBSD documentation. The following options are supported by NetBSD but aren’t
documented there:
+chap Require the peer to authenticate itself using CHAP

(Challenge-Handshake Authentication Protocol) authentication.
Default is no authentication required (usually a server option).
netmask n Set the interface netmask to n, a 32-bit netmask in “decimal dot”

notation (e.g. 255.255.255.0). The default depends on the class of
the IP address (usually a server option).
nologfd Don’t send log messages to any file descriptor.
+pap Require the peer to authenticate itself using PAP (Password

Authentication Protocol). The default is no authentication required
(usually a server option).
QNX Neutrino supports multilink PPP, so our pppd daemon supports the following
options, contrary to what the NetBSD documentation says:
• mp
• mpshortseq
• mrru
• multilink
• nomp
• nompshortseq
• nomultilink
• pass-filter
The following are specific to Neutrino:

pppd © 2010, QNX Software Systems GmbH & Co. KG.
confstr Write the server-supplied nameserver address to the

_CS_RESOLVE configuration string (the default).
noconfstr Don’t write the server-supplied nameserver address to the

_CS_RESOLVE configuration string.
noresconf Don’t write the server-supplied nameserver address to

/etc/resolv.conf file (the default).
resconf Write the server-supplied nameserver address to the

/etc/resolv.conf file.
+stdinsecret Read PAP or CHAP secrets from standard input. If you use this
option, you need to specify explicitly a serial device on the
command line.
usefd filedes Use this file descriptor to send or receive pppd packets instead
of opening a tty_name.
useuserdns nameserver_IP
Specify the nameserver to use. This overrides any nameservers
provided by the server.
Description:
The pppd daemon is used to establish TCP/IP serial connections using the
point-to-point protocol (PPP). For more information, see
Caveats:
The following signals have the specified effect when sent to the pppd process:
SIGINT, SIGTERM
These signals cause pppd to terminate the link (by closing LCP),
restore the serial device settings, and exit.
SIGHUP Indicates that the physical layer has been disconnected; pppd attempts
to restore the serial device settings and then exits.
MS-CHAP Authentication support is client-side only. It can be used to

authenticate ourselves, but not the peer.

© 2010, QNX Software Systems GmbH & Co. KG. pppd
If you spawn pppd from another program and specify the nodetach or updetach
option, and if a signal is dropped on pppd while it’s running a connect or disconnect
script, pppd raises the signal on the entire process group, including the parent (i.e. the
program that spawned pppd). This could cause the parent to terminate unexpectedly.
To avoid this, spawn pppd with the SPAWN_SETGROUP set in the inheritence
structure. For more information, see spawn() in the Neutrino Library Reference.
See also:
/etc/autoconnect, chat, devc-*, io-pkt*, pppoed, syslogd
Based on RFC 1144, RFC 1321, RFC 1332, RFC 1334, RFC 1549, RFC 1661, RFC
1662, RFC 1962, RFC 1990

pppoectl © 2010, QNX Software Systems GmbH & Co. KG.
Display or set parameters for a PPPOE interface
Syntax:
pppoectl [-v] ifname [parameter[=value]] [...]
pppoectl -e ethernet-ifname [-s service-name]
[-a access-concentrator-name] [-d] [-n 1 | 2] ifname
pppoectl -f config-file ifname [...]
Runs on:
Neutrino
Options:
-e ethernet-ifname The Ethernet interface to use to communicate with the access
concentrator (typically via a DSL modem).
-a access-concentrator-name
The name of the access concentrator.
-s service-name The name of the service connected to.
-d Dump the current connection state information. You typically

use this parameter alone, for informational purposes, not when
configuring an interface.
-n 1 | 2 Print the IP address of the primary or secondary DNS name

server for this PPP connection. This is available only if DNS
query is enabled; see the query-dns parameter.
-f config-file Parse config-file, ignoring lines starting with a #, for

parameter[=value] pairs, one per line, as if they had been
specified on the command line. This lets you avoid passing the
password as a command-line argument.
Description:
The pppoectl utility displays or sets parameters for a pppoe interface. There are two
basic modes of operation:
• configuring security-related parameters
• attaching a PPPOE interface to its Ethernet interface, optionally passing in

additional parameters for the PPPOE encapsulation
The latter usage is indicated by the presence of the -e option, which takes the name of
the Ethernet interface as its argument. You don’t typically specify both the access
concentrator name and the service name.

© 2010, QNX Software Systems GmbH & Co. KG. pppoectl
PPPOE drivers require a number of additional arguments or optional parameters

besides the settings that you can adjust with ifconfig. These are things such as
authentication protocol parameters, but also other tunable configuration variables. You
can use pppoectl to display the current settings or adjust these parameters as
required.
You always need to specify the ifname argument, in order to identify the interface for
which to set or display the parameters. Use ifconfig or netstat to see which
interfaces are available.
If no other parameter is given, pppoectl just lists the current settings for ifname, and
then exits. The reported settings include the current PPP phase the interface is in,
which can be one of dead, establish, authenticate, network, or terminate.
If an authentication protocol is configured for the interface, the name of the protocol to
be used, as well as the system name to be used or expected are displayed, plus any
possible options to the authentication protocol if applicable. Note that the
authentication secrets (sometimes also called keys) aren’t returned by the underlying
system call, and thus aren’t displayed.
If any additional parameter is supplied, superuser privileges are required, and the
command works in “set” mode. This is normally done quietly, unless you specify the
-v option, which causes a final printout of the settings as described above once all
other actions have been taken. Use of this mode is rejected if the interface is currently
in any other phase than dead. Note that you can force an interface into the dead phase
by calling ifconfig with the parameter down.
Supported parameters
The currently supported parameters include:
authproto=protoname
Set both his and my authentication protocol to protoname. The
protocol name can be one of chap, pap, or none. In the latter
case, the use of an authentication protocol is turned off for the
named interface. This has the side-effect of clearing the other
authentication-related parameters for this interface as well (i.e.
the system name and authentication secret will be forgotten).
myauthproto=protoname
Same as authproto, but only for my end of the link. In other
words, this is the protocol when the remote is the authenticator,
and I am the peer required to authenticate.
hisauthproto=protoname
The same as authproto, but only for his end of the link.
myauthname=name Set my system name for the authentication protocol.

hisauthname=name
Set his system name for the authentication protocol. For CHAP,
this is used only as a hint, causing a warning message if the
remote supplied a different name. For PAP, it’s the name remote
must use to authenticate itself (in connection with its secret).
myauthsecret=secret
Set my secret (key, password) for use in the authentication
phase. For CHAP, this is used to compute the response hash
value, based on remote’s challenge. For PAP, it’s transmitted as
plain text together with the system name. Don’t forget to quote
the secrets from the shell if they contain shell metacharacters
(or white space).
myauthkey=secret The same as myauthsecret.
hisauthsecret=secret
Similar to myauthsecret, to be used if we are the
authenticator, and the remote peer needs to authenticate.
hisauthkey=secret The same as hisauthsecret.
callin Require the remote to authenticate itself only when it’s calling
in, but not when we’re the caller. This is required for some
peers that don’t implement the authentication protocols
symmetrically (such as Ascend routers, for example).
always The opposite of callin. Require the remote to always

authenticate, regardless of which side is placing the call. This is
the default, and isn’t explicitly displayed in list mode.
norechallenge Meaningful only with CHAP. Don’t rechallenge a peer once the
initial CHAP handshake was successful. Use this to work
around broken peer implementations that can’t handle being
rechallenged once the connection is up.
rechallenge With CHAP, send rechallenges at random intervals while the

connection is in network phase. (The intervals are currently in
the range of 300 through approximately 800 seconds.) This is
the default, and isn’t explicitly displayed in list mode.
idle-timeout=idle-seconds
For services that are charged by connection time, the interface
can optionally disconnect after a configured idle time. If set to
0, this feature is disabled.

© 2010, QNX Software Systems GmbH & Co. KG. pppoectl
For ISDN devices, it’s preferable to use the isdnd-based timeout mechanism, as
isdnd can predict the next charging unit for ISDN connections and optimize the
timeout with this information.
lcp-timeout=timeout-value
Change the value of the LCP timeout. The default value of the
LCP timeout is currently 1 second. Specify the timeout-value
in milliseconds.
max-noreceive=sec
Set the number of seconds after the last reception of data from
the peer before the line state is probed by sending LCP echo
requests. The sec interval isn’t used verbatim; the first echo
request might be delayed up to 10 seconds after the configured
interval.
max-alive-missed=count
Set the number of unanswered LCP echo requests to tolerate
before considering a connection to be dead. LCP echo requests
are sent in 10-second intervals after the configured
max-noreceive interval has passed with no data received
from the peer.
max-auth-failure=count
Since some ISPs disable accounts after too many unsuccessful
authentication attempts, there is a maximum number of
authentication failures before we will stop retrying without
manual intervention. Manual intervention is either changing the
authentication data (name, password) or setting the maximum
retry count. If count is set to 0, this feature is disabled.
clear-auth-failure
If an authentication failure has been caused by remote
problems, and you want to retry connecting using unchanged
local settings, you can use this command to reset the failure
count to zero.
query-dns=flags During PPP protocol negotiation, we can query the peer for
addresses of two name servers. If flags is 1, only the first server
address is requested; if flags is 2, the second is requested.
Setting flags to 3 queries both.
You can retrieve the result of the negotiation with the -n option.

Examples:
The following example is the complete sequence of commands to bring a PPPOE
connection up:
# Need ethernet interface UP (or it won’t send any packets)

ifconfig ne0 up
# Create the PPPOE interface

ifconfig pppoe0 create
# Let pppoe0 use ne0 as its ethernet interface

pppoectl -e ne0 pppoe0
# Configure authentication
pppoectl pppoe0 myauthproto=pap myauthname=XXXXX \
myauthsecret=YYYYY hisauthproto=none
# Configure the pppoe0 interface itself. These addresses are magic,

# meaning we don’t care about either address and let the remote
# ppp choose them.
ifconfig pppoe0 0.0.0.0 0.0.0.1 netmask 0xffffffff up
In order to be configured as a PPPOE server, you should set the pppoe interface to use
link0 mode, so that it can wait for incoming PPPOE session requests. For example,
the following makes the interface wait for requests coming from the en0 interface:
ifconfig pppoe0 create # create an PPPOE interface

ifconfig pppoe0 link0 # set mode as link0
pppoectl -e en0 pppoe0 # link it with en0 ethernet interface
pppoectl pppoe0 hisauthproto=pap hisauthname=XXX hisauthsecret=YYY
# configure authentication
ifconfig pppoe0 inet ip_address_self ip_address_client
# assign ip addresses
ifconfig en0 up # up en0 to receive incoming data.
Files:
/dev/io-net/ppp_en
The default PPPOE device.
/etc/ppp/pppoe-down
The default downscript.
/etc/ppp/pppoe-up
The default upscript.
See also:
io-pkt, pppd
If you find pppoed has problems connecting to certain sites on the Internet, take a
look at the technote PPPOE and Path MTU Discovery.

© 2010, QNX Software Systems GmbH & Co. KG. pppoed
Shim layer for phdialer to dial up Point-to-Point Protocol Over Ethernet (PPPOE)
Syntax:
pppoed
Runs on:
Neutrino
Options:
None.
Description:
The pppoed binary is a shim layer that phdialer uses to dial up PPPOE. PPP over
Ethernet is now part of the io-pkt* stack; for more information, see the entry for
pppoectl.
See also:
io-pkt*, phdialer, pppoectl
If you find pppoed has problems connecting to certain sites on the Internet, take a
look at the technote PPPOE and Path MTU Discovery.

pps © 2010, QNX Software Systems GmbH & Co. KG.
Persistent Publish/Subscribe manager (QNX Neutrino)
Syntax:
pps [options]
Runs on:
QNX Neutrino
Options:
-b Do not run in the background. Useful for debugging.
-l argument Set the object load behavior, as follows:

• 0 — load directory names and objects on demand. Default.
• 1 — load all directory and object names on startup, but do not
load object contents. Load object contents on demand.
• 2 — load directories, objects, and object contents on startup.
-m mount Specify the mountpath for PPS. Default is /pps/
-p path Set the path for backing up the persistent storage.
-t period Specify the periodicity of the forced persistence, in milliseconds.

For example -t 5000 forces the PPS service to write to persistent
storage every five seconds. Default is no forced persistence.
-v Enable verbose mode. Increase the number of “v”s to increase

verbosity.
Description:
The pps program manages the Persistent Publish/Subscribe system, which provides a
simple method of disseminating information to interested processes.
See also:
Persistent Publish/Subscribe Developer’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. pr
Break a file into pages and/or columns for printing
Syntax:
pr [+page] [-column] [-adFmrt] [-e[char][gap]]
[-L locale] [-h header]
[-i[char][gap]] [-l lines]
[-o offset] [-s[char]] [-n[char][width]]
[-w width] [file ...]
Runs on:
Neutrino
Options:
In the following option descriptions, column, lines, offset, page, and width are positive
decimal integers, and gap is a nonnegative decimal integer.
Options -e, -i, -n, and -s, do not use spaces to separate options and arguments.
+page Print the pages starting with this page number.
-column Produce output that is columns wide (the default is 1). The text is
written vertically down each column in the order in which it is
received from the input file. The options -e and -i are assumed.
Don’t use this option with -m. If you want to display the output
using the minimum number of lines, use with -t.
-a Modify the effect of the -column option so that the columns are
filled across the page in a round-robin order (e.g. when column is
2, the first input line heads column 1, the second heads column 2,
the third is the second line in column 1, etc.). If you use this
option, you must also use the -column option.
-d Double space the output. An extra newline character is output

following every newline found in the input.
-e[char][gap] Expand each input tab to the next greater column position
specified by the formula n*gap+1, where n is an integer > 0. If
gap is zero or is omitted, the default is 8. All tab characters in the
input are expanded into the appropriate number of spaces. If char
(any nondigit character) is specified, it is used as the input tab
character.
-F Use a form-feed character for new pages, instead of the default

behavior that uses a sequence of newline characters.
-h header Use the string header to replace the file name in the header line.

pr © 2010, QNX Software Systems GmbH & Co. KG.
-i[char][gap] In the output, replace multiple spaces with tabs whenever two or
more adjacent spaces reach column positions gap+1, 2*gap+1,
etc. If gap is zero or omitted, the default tab settings are at every
eighth column position. If char (any nondigit character) is
specified, it is used as the output tab character.
-L locale Use the locale specified as argument instead of one found in the
environment. Use C to reset locale to its default.
-l lines (“el”) Override the 66-line default and reset the page length to
lines. If lines is not greater than the sum of both the header and
trailer depths (in lines), the pr utility suppresses output of both
the header and trailer, as if the -t option were in effect.
-m Merge the contents of multiple files. One line from each file
specified by a file operand is written side by side into text
columns of equal fixed widths, in terms of the number of column
positions. The number of text columns depends on the number of
file operands successfully opened. The maximum number of files
merged depends on page width and the per-process open file
limit. The options -e and -i are assumed.
-n[char][width] Provide width-digit line numbering. The default for width, if not
specified, is 5. The number occupies the first width column
positions of each text column or each line of -m output. If char
(any nondigit character) is given, it is appended to the line
number to separate it from whatever follows. The default for char
is a tab. Line numbers longer than width columns are truncated.
-o offset Each line of output is preceded by offset spaces. If the -o option
is not specified, the default is zero. The space taken is in addition
to the output line width.
-r Inhibit the warning when a file can’t be opened.
-s[char] Separate text columns by the single character char instead of by
the appropriate number of spaces (the default for char is the tab
character).
-t Print neither the five-line identifying header nor the five-line
trailer usually supplied for each page. Quit printing after the last
line of each file without spacing to the end of the page.
-w width Set the width of the line to width column positions for multiple
text-column output only. If the -w option is not specified and the
-s option is not specified, the default width is 72. If the -w
option is not specified and the -s option is specified, the default
width is 512.
file A pathname of a file to be printed. If no file operands are
specified, or if a file operand is “-”, the standard input is used.

© 2010, QNX Software Systems GmbH & Co. KG. pr
Description:
The pr utility is a printing and pagination filter for text files. When multiple input files
are specified, each is read, formatted, and written to standard output. By default, the
input is separated into 66-line pages, each with:
• A 5-line header with the page number, date, time, and the pathname of the file.
• A 5-line trailer consisting of blank lines.
If standard output is associated with a terminal, diagnostic messages are suppressed

until the pr utility has completed processing.
When multiple column output is specified, text columns are of equal width. By default
text columns are separated by at least one space. Input lines that do not fit into a text
column are truncated. Lines are not truncated under single column output.
Exit status:
0 Success.
Errors:
If pr receives an interrupt while printing to a terminal, it flushes all accumulated error
messages to the screen before terminating. Error messages are written to stderr during
the printing process (if output is redirected) or after all successful file printing is
complete (when printing to a terminal).
Keith Muller
License:
See also:
cat, fold, lpr, more

preview © 2010, QNX Software Systems GmbH & Co. KG.
Photon print preview
Syntax:
preview [-c colors] [-D debug_fname] [-d]
[-h height[%]] [-L] [-M] [-S i|m|n] [-s server]
[-U file] [-V] [-w width[%]]
[-x position[%][r]] [-y position[%][r]]
filename
Runs on:
Neutrino
Options:
-c colors Force size of color palette.
-d Delete input file after processing.

-L Enable landscape mode.
-M Don’t map fonts into scalable printer fonts.

normal).

fullpath fullpath
-U file Delete this file when the print job is completed. Use for
synchronizing print-spooling operations.



© 2010, QNX Software Systems GmbH & Co. KG. preview

Description:
View the page to be printed.
Examples:
View the file webpage.phs:
preview webpage.phs
See also:
Printing in the Neutrino User’s Guide

/etc/printcap © 2010, QNX Software Systems GmbH & Co. KG.
Printer-capability database
Name:
/etc/printcap
Description:
The printcap database is a simplified version of the termcap database for
describing printers. The spooling system accesses the printcap file every time it’s
used, so you can dynamically add or remove printers. Each entry in the database
describes one printer.
Note that you can’t replace this database — as you can for termcap — because that
might allow accounting to be bypassed.
The default printer is normally lp, although you can use the environment variable
PRINTER to override this. Each spooling utility supports a -Pprinter option to
explicitly name a destination printer.
Each entry in the printcap file describes a printer. An entry is a line consisting of a
number of fields separated by : characters. The first entry for each printer gives the
known names for the printer, separated by | characters.
The first name is conventionally a number. The second name is the most common
abbreviation for the printer; the last name should be a long name fully identifying the
printer. The second name should contain no blanks; the last name may well contain
blanks for readability. Entries may continue onto multiple lines by giving a \ as the
last character of a line. Empty fields may be included for readability.
Capabilities in printcap are all introduced by two-character codes and are of these
types:
Boolean Indicates that the printer has some particular feature. Boolean
capabilities are simply written between the : characters.
Numeric Information such as baud rate, number of lines per page, and so on.
Numeric capabilities are given by the two-character capability code
followed by the # character, followed by the numeric value. The
following example is a numeric entry stating that this printer should run
at 1200 baud:
:br#1200:
String A sequence that can be used to perform particular printer operations

such as cursor motion. String-valued capabilities are given by the
two-character capability code followed by an = sign and then a string
ending at the next following :. For example:
:rp=spinwriter:

© 2010, QNX Software Systems GmbH & Co. KG. /etc/printcap
states that the remote printer is named spinwriter.
Capabilities
Name Description Type Default

af Name of accounting file String NULL
br If lp is a tty, set the baud rate (ioctl() call) Numeric None
cf cifplot data filter String NULL
df TeX data filter (DVI format) String NULL
du Userid of user daemon String 0
fc If lp is a tty, clear flag bits Numeric 0
ff String to send for a form feed String \f
fo Print a form feed when device is opened Boolean False
fs Similar to fc but set bits Numeric 0
gf Graph data filter (plot(3X) format) String NULL
hl Print the burst header page last Boolean False
ic Driver supports (non standard) ioctl() to indent printout Boolean False
if Name of input/communication filter (created per job) String NULL
lf Error logging filename String /dev/console
lo Name of lock file String lock
lp Device name to open for output String /dev/lp
mc Maximum number of copies Numeric 0
ms List of terminal modes to set or clear String NULL
mx Maximum file size (in BUFSIZ blocks); zero = unlimited Numeric 1000
nf ditroff data filter (device independent troff) String NULL
of Name of output/banner filter (created once) String NULL
pc Price per foot or page in hundredths of cents Numeric 200
pl Page length (in lines) Numeric 66
pw Page width (in characters) Numeric 132
px Page width in pixels (horizontal) Numeric 0
py Page length in pixels (vertical) Numeric 0
continued. . .

/etc/printcap © 2010, QNX Software Systems GmbH & Co. KG.
Name Description Type Default

rf Filter for printing FORTRAN style text files String NULL
rg Restricted group — only members of group allowed access String NULL
rm Machine name for remote printer String NULL
rp Remote printer name argument String lp
rs Restrict remote users to those with local accounts Boolean False
rw Open printer device read/write instead of write-only Boolean False
sb Short banner (one line only) Boolean False
sc Suppress multiple copies Boolean False
sd Spool directory String /usr/spool/output/lpd
sf Suppress form feeds Boolean False

sh Suppress printing of burst page header Boolean False
st Status filename String status
tc Name of similar printer; must be last String NULL
tf troff data filter (C/A/T phototypesetter) String NULL
tr Trailer string to print when queue empties String NULL
vf Raster image filter String NULL
xc If lp is a tty, clear local mode bits Numeric 0
xs Like xc but set bits Numeric 0
If the local line printer driver supports indentation, the daemon must understand how
to invoke it.
Note that the fs, fc, xs, and xc fields are flag masks rather than values. Certain
default device flags are set when the device is opened by the line printer daemon if the
device is connected to a terminal port. The flags indicated in the fc field are then
cleared; the flags in the fs field are then set (or vice versa, depending on the order of
fc#nnnn and fs#nnnn in the /etc/printcap file).
The bits cleared by the fc field and set by the fs field are those in the sg_flags field
of the sgtty structure, as set by the TIOCSETP ioctl() call, and the bits cleared by the
xc field and set by the xs field are those in the “local flags” word, as set by the
TIOCLSET ioctl() call. See <sys/termio.h> for a description of these flags.
For example, to set exactly the flags 06300 in the fs field, which specifies that the
EVENP, ODDP, and XTABS modes are to be set and that all other flags are to be
cleared, do:
:fc#0177777:fs#06300:

© 2010, QNX Software Systems GmbH & Co. KG. /etc/printcap
The same process applies to the xc and xs fields. Alternatively, you can use the ms
field to specify modes to be set and cleared. These modes are specified as stty
modes; you can specify any mode supported by stty, except for the baud rate (which
you must specify with the br field).
For example, to set the terminal port (to which the printer is attached) to even parity,
TAB expansion, no NEWLINE to RETURN/LINEFEED translation, and RTS/CTS
flow control enabled, do the following:
:ms=evenp,-tabs,nl,crtscts:
The tc field must appear last in the list of capabilities. Each type of printer should
have a general entry describing common capabilities. Then an individual printer can
be defined with its particular capabilities, plus a tc field that points to the general
entry for that type of printer.
For information about setting up the printcap file, see the Printing chapter of the
See also:
lpd, lpr, lprc, lprq, lprrm

printf © 2010, QNX Software Systems GmbH & Co. KG.
Write formatted output (POSIX)
Syntax:
printf format [argument...]
Runs on:
Neutrino
Options:
format A string describing how the given arguments are to be formatted.
argument A string to be written to standard output, under control of format.
Description:
The printf utility writes formatted arguments to standard output under control of the
format control string (the syntax for format is based upon the printf() function).
The format control string contains the following types of characters:
• Ordinary characters that are written exactly as they occur in the format string
• Escape sequences that represent nongraphic characters
• Conversion specifications that specify the output format of the named arguments.
Introduce a conversion specification by the % character. To literally display this

character, encode it as %%. Immediately following the % character, you may specify
any of the following, in order:
<flags><width><precision><type len><conversion>
where:
flags Format control flags.
width Field width.
precision Numerical precision.
type len Type length modifier.
conversion Conversion character.
These components are processed from left to right.

© 2010, QNX Software Systems GmbH & Co. KG. printf
Format control flags

The format control flags modify the meaning of the conversion specification. You can
specify zero or more of these flags, in any order:
- Left justify output within the field.
+ Always begin the result of a signed conversion with a sign (+ or -).
Space If the first character of a conversion isn’t a sign, prefix a space to the result.
# Convert the value to an alternate form:
For this conversion: The result is formatted as follows:

o (octal) The first digit is zero
X or x (hex) A nonzero result has 0X or 0x prefixed to it
e, E, f, g, and G The result always has a decimal point (.), even if no
digits follow
g and G Trailing zeros aren’t removed from the result as they
usually are
c, d, i, s, and u No effect; the # is ignored
0 For all conversions, pad the field width with leading
zeros. The 0 flag is ignored for the d, i, o, u, X, and
x conversions if a precision is specified; it’s also
ignored if the - flag is given.
Field width
An optional decimal integer that specifies the minimum number of characters for
displaying the formatted item. If no field width is specified, or if the value is less than
the number of characters required to represent the converted value (subject to the
specified precision), a field of sufficient width to contain the converted value is used.
If the number of characters required to represent the converted value is less than the
field width, the value is padded on the left (or on the right if the - format control flag
is given) with spaces or “0” (zero) characters. If the field width begins with a zero, the
value is padded with zeros, otherwise spaces.
Precision
An optional decimal integer following a period character (.). The effect of the given
precision depends on the conversion character you specify (see “Conversion
character,” below).

Type length
An optional character that modifies the interpreted size of the conversion character.
The only supported type length character is l (“el”), which causes a d, i, o, u, X, or x
conversion to process a long int or unsigned long int argument.
Conversion character
A character that determines the type of conversion to be applied. For example, if d is
specified, printf treats the corresponding argument as a decimal integer. The
conversion characters are:
d i o u X x The argument is an integral value. It’s printed as one of the

following:
• signed decimal (d or i)
• unsigned octal (o)
• unsigned decimal (u)
• unsigned hexadecimal (X or x)
For each of these, the specified precision is interpreted as the
minimum number of digits to appear (defaults to 1 if no precision
is specified). In the absence of a type length specifier, these
conversions are either signed in the range -32768 to 32767 or
unsigned in the range 0 to 65535. If a type length is specified, the
conversions are either signed in the range -2147483648 to
2147483647 or unsigned in the range 0 to 4294967295. For the
hex format, the case of the specifier (X or x) implies the case of the
output.
e, E The argument is a floating-point value, and is displayed in

scientific notation. The value is printed in the style:
[-]d[.ddd]e{+|-}dd
The first part is an optional sign. The second is a single digit,

which is nonzero if the argument is nonzero. The third (optional)
part — a decimal character followed by a number of digits equal to
the specified precision — is printed if the precision is nonzero. If
the precision isn’t specified, it’s assumed to be 6. If the precision is
0, the decimal isn’t printed. The fourth part is an e or E, based
upon the case of the conversion character, followed by a signed
value. This value represents the order of magnitude.
f The argument is a floating-point value. The value is printed in the

style:
[-]ddd.ddd

© 2010, QNX Software Systems GmbH & Co. KG. printf
where the number of digits printed after the decimal character is

equal to the specified precision. If the precision isn’t specified, it’s
assumed to be 6. If the precision is 0, the decimal isn’t printed.
g, G The argument is a floating-point value. The value is printed in the

“e” style (or “E” style if a G conversion character is given) if the
exponent in this style is less than -4 or greater than or equal to the
specified precision; otherwise, the value is printed in the “f” style.
c The first character of the argument is printed.
s The argument is a string of characters and the string is printed. The

number of characters printed from the string is equal to the
precision, if specified. The string is left- or right-justified within
the specified field width. If no field width is specified, no padding
is applied.
Escape sequences
The printf utility interprets the character escape sequences within the format string
in a way similar to the C programming language. These sequences, which you
introduce via the backslash character (\), are translated as follows:
This sequence: Writes:

\a An alert character (bell)
\b A backspace character
\f A form-feed character
\n A newline character
\r A carriage return character
\t A tab character
\v A vertical tab character
\’ A single quote (’) character
\\ A backslash (\) character
\d The character specified by the one-, two-, or three-digit octal
number d
Examples:
Display the string “hello, world” on a line by itself:
printf "hello, world\n"
Do the same as above, but don’t output a newline:

printf "hello, world"
Display a value in scientific notation:
printf "n = %e\n" 3.1415926535897
Exit status:
See also:
echo, ksh’s print command

© 2010, QNX Software Systems GmbH & Co. KG. prjobs
Spool manager
Syntax:
prjobs [-h height[%]] [-r] [--Si|m|n]
[-s server_name] [-w width[%]]
[-x position[%][r]] [-y position[%][r]]
Runs on:
Neutrino
Options:
r Scan for pending jobs. If there are any, query the user as what to
do.

normal).

fullpath fullpath



Description:
This utility starts the spool manager. You can start it from the command line, or you
can click its icon in the shelf:

prjobs © 2010, QNX Software Systems GmbH & Co. KG.
You must be running Photon to start this manager.
The spool manager’s main window looks like this:
The spool manager’s main window.
You can use the spool manager to query and cancel print jobs.
The prjobs utility cancels print jobs by removing files from the relevant mount point
owned by spooler. The command line equivalent is:
rm /dev/printers/printer_name/spool/print_file
See also:
spooler

© 2010, QNX Software Systems GmbH & Co. KG. procnto*
QNX Neutrino microkernel and process manager (QNX Neutrino)
Syntax:
procnto* [-a d|e|s] [-c] [-e n|o] [-F number] [-fe]
[-h] [-H size] [-mmemmgr_configuration]
[-P priority] [-p] [-T timeout] [-u umask] [-v]
Runs on:
Neutrino
Options:
-ad Disable alignment fault emulation. The procnto manager doesn’t
attempt to make misaligned memory accesses work; they’ll cause a
SIGBUS signal for the offending thread.
-ae Enable alignment fault emulation. The procnto manager attempts to

make misaligned memory accesses work, although they’ll be slow.
This isn’t guaranteed to work; offending threads may still get a
SIGBUS signal.
-as Use the system default for alignment faults. This behavior depends on
your platform:
ARM -ad
MIPS -ad
PowerPC -ae
SH4 -ad
x86 -ae
-c (QNX Neutrino Core OS 6.3.2 or later) Prevent the adaptive

partitioning scheduler from automatically running threads that receive
events from interrupt handlers as critical.
The -c option has an effect only if:

• you’re using Adaptive Partitioning
• the thread receiving an event from an interrupt handler is running
in a partition configured with a critical budget
For more information, see the Adaptive Partitioning User’s Guide.
-e n|o (QNX Neutrino 6.4.0 or later) Specify which value to use for
EALREADY:
• -eo — use the old value, which is the same as that of EBUSY.
• -en — use the POSIX-compliant value.

procnto* © 2010, QNX Software Systems GmbH & Co. KG.
The default is -eo; it will be -en in a later release.
For more information, see “Changes to EALREADY” in the entry for

errno in the Neutrino Library Reference.
-F number The maximum number of file descriptors that can be open at the same
time. The minimum allowable value is 100. The default value is 1000,
but might be constrained by the RLIMIT_NOFILE system resource.
Sockets, named semaphores, message queues, channel IDs (chids), and connection
IDs (coids) all use file descriptors.
To determine the current limit, use the ksh builtin command,
ulimit, or call getrlimit() (see the Library Reference).
-fe Force floating-point emulation. The default is to use floating-point

hardware in the CPU if present, and to emulate it in software if the
CPU has no FPU (see fpemu.so). Use this option to simulate a
system with no FPU.
-h Disable CPU halting in idle thread. Some CPU and supporting

chipsets can lock up if the CPU halts when idle; you’ll notice the need
for the -h option right away because your system will lock up after
booting.
-H size Sets the initial heap size for procnto. If more memory is required for
procnto, it’s dynamically obtained; however, by setting a properly
calculated value this option can speed up boot time, and reduce the
amount of physical memory fragmentation.
The size parameter indicates the number of bytes to grow the heap in
advance. You can postfix this value with a multiplier character, such
as “k” (kilobyte) or “m” (megabyte). For example:
1m == 1024k == 0x100000
If the number is less than 1024 and it isn’t postfixed by a multiplier
character, it’s assumed to be in kilobytes. The default value is 64 KB
if the -H option isn’t specified.
-m memmgr_configuration
(QNX Neutrino Core OS 6.3.2 or later) Control the behavior of the
memory manager. The memmgr_configuration string is a sequence of
characters that enable (or if preceded with a ˜ character, disable)
memory-manager aspects.

If you specify more than one -m option, procnto ignores all but the last one.
The configuration options are:
a (QNX Neutrino 6.4.1 or later) Automatically mark memory

pages that have a mem_offset() performed on it as
unmovable when defragmenting physical memory. This has
an effect only if defragmenting is enabled (see the -md
option below). For more information, see “Automatically
marking memory as unmovable” in the Process Manager
ã (QNX Neutrino 6.4.1 or later) Disable the automatic
marking of memory pages as unmovable (the default).
b Enable backward compatibility (the default).
See the release notes for the current behavior.
˜b Disable backward compatibility.

d (QNX Neutrino 6.4.1 or later) Enable the defragmenting of
physical memory (the default). For more information, see
“Defragmenting physical memory” in the Process Manager
˜d (QNX Neutrino 6.4.1 or later) Disable the defragmenting of
physical memory.
i Make munmap() act as if UNMAP_INIT_REQUIRED were
specified (i.e. POSIX initialization of the page to all zeroes
is required the next time the underlying physical memory is
allocated). This is the default.
˜i Make munmap() act as if UNMAP_INIT_OPTIONAL were
specified (i.e. initialization of the underlying physical
memory to zeroes on its next allocation is optional). See
“Initializing allocated memory” in the Interprocess
Communication (IPC) chapter of the System Architecture
guide.
l (“el”) Lock all memory; act as if
mlockall(MCL_CURRENT|MCL_FUTURE) were specified
at the start of every program. For more information, see
mlockall() in the in the Neutrino Library Reference.
˜l Don’t lock all memory (the default).
L Superlock all memory; act as if
ThreadCtl(_NTO_TCTL_IO,0) were specified at the start
of every program (but only insofar as locking the memory;
programs don’t actually get I/O privileges).

˜L Don’t superlock all memory (the default).
If you enable both l and L, the L option takes priority.
P Turn on full allocation of high memory for all processes.

This is mostly useful only for testing.
˜P Make sure that all anonymous allocation occurs below the 4
GB mark (the default).
r (QNX Neutrino 6.5.0 or later; not supported by the QNX
Neutrino RTOS Safe Kernel 1.0) Enable address space
randomization. If you use this option, the kernel places
certain items (e.g. the stack, libc) at different addresses
every time you run a process. This can help prevent
someone from hacking into a program.
˜r (QNX Neutrino 6.5.0 or later; not supported by the QNX
Neutrino RTOS Safe Kernel 1.0) Disable address space
randomization (the default).
v Enable variable page sizes (the default). This automatically
allows for mapping to be performed with different page
sizes to achieve better performance.
˜v Disable variable page sizes.
x (QNX Neutrino 6.4.0 or later) Enable the PROT_EXEC flag
for system-allocated threads (the default). This option
allows gcc to generate code on the stack — which it does
when taking the address of a nested function (a GCC
extension).
˜x (QNX Neutrino 6.4.0 or later) Turn off PROT_EXEC for
system-allocated stacks, which increases security but
disallows taking the address of nested functions. You can
still do this on a case-by-case basis by doing an mprotect()
call that turns on PROT_EXEC for the required stacks.
-P priority Set the lower end of the range of privileged priorities to the given
priority; the upper end of the range is 255. Only processes with an
effective user ID of 0 (i.e. root) can use these priorities. Non-root
(and root) processes can use priorities from 1 through priority − 1.
The default value of priority is 64.
-p Disable kernel preemption. This prevents threads running in kernel

space from being preempted by a higher-priority thread. This can be
useful when debugging a system with a frequent source of
high-priority interrupts.
-T timeout (QNX Neutrino 6.4.0 or later) Specify the number of seconds to wait
for a close() to succeed in the event of a process termination.

Previously, this timeout was hard coded to be 30 seconds. The current

default is also 30 seconds; however, the -T timeout option let’s you
set this value.
When a process terminates, any outstanding connections are closed.
This means that an _IO_CLOSE message is synthesized and sent to
the resource manager responsible for that connection.
Because it is not guaranteed that the server will reply in a reasonable
amount of time (i.e, a qnet node may be down), a TimerTimeout() call
before the send guarantees that the termination process will proceed.
-u umask (QNX Neutrino 6.4.0 or later) Use the given umask when creating the
entries in /proc/pid/as. If you don’t specify this option, procnto
uses a mask of 022. You can restrict access further, but this could
break software that relies on being able to open entries in /proc. For
more information about these files, see “/proc filesystem,” below.
-v[v]... Be verbose. Specifying more v characters increases the verbosity. If

you specify this option, you’ll get more useful information when a
process is terminated by a signal.
Description:
The procnto system process contains the QNX Neutrino microkernel, process
management, memory management and pathname management. It’s required in all
bootable images made using the mkifs utility. For more information, see the QNX
Neutrino System Architecture guide.
To determine the release version of the kernel on your system, use the uname -a
command.
There are different versions of procnto for different processors (see the Board
Support Package for your board for specific information):
procnto-400 PowerPC 400 series processors.
procnto-800 PowerPC 800 series processors.
procnto-booke-smp
Power Book E SMP processors.
procnto-booke Other Power Book E processors.
procnto-600-smp Other supported PowerPC SMP processors, such as the 600 and
700 series.
procnto-600 Other supported PowerPC processors, such as the 600 and 700
series.

procnto-32 32-bit MIPS processors.
procnto-v6 ARMv6 processors.
procnto-smp All other supported multicore processors.
procnto All other supported processors.
There’s also an instrumented version of each of the above (e.g.

procnto-600-smp-instr) that you’ll use for system analysis. For more
information, see the System Analysis Toolkit User’s Guide and the Analyzing Your
System with Kernel Tracing chapter of the IDE User’s Guide.
For self-hosted Neutrino systems, the default microkernel is procnto-instr or
procnto-smp-instr.
If you’re using an SMP version of procnto, you can use the appropriate startup-*
command’s -P option to specify the maximum number of CPUs to activate.
Starting in 6.3.0, procnto also manages named semaphores, which mqueue used to
do (mqueue now manages named semaphores only if it detects that procnto isn’t
doing so). Named semaphores appear in the pathname space under /dev/sem. The
sem_* client functions handle named semaphores; for more information, see the
/proc filesystem
The Process Manager component of procnto implements a /proc filesystem that
includes the following:
/proc/pid Virtual directories that let you access and control every process
and thread running within the system. For more information, see
“Controlling processes via the /proc filesystem” in the
Processes chapter of the QNX Neutrino Programmer’s Guide.
/proc/boot/ The image filesystem that comprises the boot image. For more
information, see Making an OS Image in Building Embedded
Systems.
/proc/dumper A special entry that receives notification when a process

terminates abnormally. The dumper utility watches this entry.
/proc/mount/ Pathname-space mountpoints.
If you list the contents of the /proc directory, /proc/mount doesn’t show up, but
you can list the contents of /proc/mount.

/proc/qnetstats
If you’re using Transparent Distributed Processing (TDP), the
lsm-qnet.so module places a qnetstats entry in /proc. If
you open this name and read from it, the Qnet resource manager
code responds with the current statistics for Qnet.
/proc/self/ The address space for yourself (i.e. for the process that’s making
the query).
Examples:
To disable preemption in kernel code:
procnto -p
See also:
fpemu.so, mkifs, startup-*, uname
The QNX Neutrino Microkernel and Process Manager chapters of the System
Architecture guide
Processes chapter of the QNX Neutrino Programmer’s Guide
mlockall(), mmap(), munmap(), munmap_flags(), sem_close(), sem_getvalue(),
sem_open(), sem_post(), sem_trywait(), sem_unlink(), sem_wait(), ThreadCtl() in the
QNX Neutrino Library Reference
Analyzing Your System with Kernel Tracing chapter of the IDE User’s Guide

/etc/protocols © 2010, QNX Software Systems GmbH & Co. KG.
Protocol name database (UNIX)
Name:
/etc/protocols
Description:
The /etc/protocols file contains information regarding the known protocols used
in the DARPA Internet. For each protocol, a single line should be present with the
official_protocol_name protocol_number aliases
Items are separated by any number of blanks or tabs, or both. A # in a line indicates
the beginning of a comment — any characters after a #, up to the end of the line, aren’t
interpreted by routines that search the file.
Protocol names may contain any printable character other than a field delimiter,
See also:
getprotoent() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. ps
Report process status (POSIX)
Syntax:
ps [-aAdEfl] [-[gG] grplist] [-o format]... [-n namelist]
[-p proclist] [-t termlist] [-[uU] usrlist]
Runs on:
QNX Neutrino
Options:
-a Write information for all processes associated with terminals.
-A Write information for all processes.
-d Write information for all processes, except session leaders.
-e Write information for all processes (the same as -A).
-f Generate a full listing.
-G grplist Write information for processes whose real group ID is given in the
comma- and space-delimited list, grplist.
-g grplist Write information for processes whose session leader is given in the
comma- and space-delimited list, grplist.
-l Generate a long listing.
-n namelist The name of an alternate system namelist file. (Not supported)
-o format Write information according to the specifications given in format. If

you specify more than one -o option, ps concatenates all the format
arguments.
-p proclist Write information for processes whose ID is given in the comma and
space-delimited list, proclist.
-t termlist Write information for processes whose terminal identifier is given in

the comma and space-delimited list, termlist.
-U usrlist Write information for processes whose real user ID or login name is
given in the comma and space-delimited list, usrlist.
-u usrlist Write information for processes whose user ID or login name is given
in the comma and space-delimited list, usrlist.

ps © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The ps utility prints information about processes, subject to having the appropriate
privilege to obtain information about those processes. With no options, ps prints
information about processes associated with the current terminal. The output includes
the process ID, terminal name, cumulative execution time, and command name of
each process.
The options that use lists (-G, -g, -o, -p, -t, -U, and -u) can list multiple items
separated by commas or white space, as long as all the items are contained within a
single command-line argument. If white space is used, you’ll probably need to quote
the list when invoking ps from the shell.
The initial set of processes selected by -a, -A, or -d is intersected with the processes
selected by the -G, -g, -p, -t, -U or -u options, if any of the latter are specified. If a
process meets any of the selection criteria, its information is displayed.
If none of -a, -A, or -d is specified, ps behaves as though you specified -u your_uid.
Controlling output
The -o option controls the information that ps displays. The format argument is a
comma- or space-delimited list of field names that represent information to be
displayed about processes and threads.
You can override the header for a field by appending an equals sign and the new
header. The rest of the characters in the argument are used as the header text. The ps
utility automatically determines the width of all columns.
The ps utility recognizes the following field names:
ruser The real user name or real user ID of the process.
user The effective user name or effective user ID of the process.
rgroup The real group name or real group ID of the process.
group The effective user name or effective group ID of the process.
pid The process ID.
ppid The parent process ID.
pgid The process group ID.
pcpu The ratio of CPU time used to CPU time available in a recent period of
time.
vsz The size of the process.
nice The effective priority of the process.
etime The elapsed time since the process was started.

© 2010, QNX Software Systems GmbH & Co. KG. ps
time The cumulative CPU time of the process.
tty The name of the controlling terminal. (Currently not supported).
comm The command being executed.
args The command with all of its arguments.
The following field names are supported, even though they aren’t required by POSIX:
uid The real user name or real user ID of the process.
env The environment in a space-delimited list.
f The process flags.
pri The real priority of the process.
sid The process ID of the session leader.
suid The user ID of the session owner.
sgid The group ID of the session owner.
umask The process file creation mask.
sigign The list of signals ignored by the process.
sigpend The list of signals pending on the process and threads.
sigqueue The list of signals queued on the process.
threads The number of threads for the process.
stime The process’s start time.
cmd The command being executed.
sz The size of memory used.
Some of the above fields are thread-specific. In such cases, the value for the first
thread in the process is used.
The following field names display information about threads:
tid The thread ID.
tflags The thread flags.
dflags The thread debug flags.
tsigblk The list of signals blocked on the thread.

ps © 2010, QNX Software Systems GmbH & Co. KG.
cpu The last CPU the thread ran on.
state The state of the thread.
wchan The wait channel.
addr The wait address.
psched The process scheduling policy.
The comm, args, and env fields are the only ones that can contain blanks.
If you don’t specify a format, ps uses:
• uid,pid,ppid,c,stime,tty,time,args if you specify -f
• f,s,uid,pid,ppid,c,pri,nice,addr,sz,wchan,tty,time,cmd if you
specify -l
• pid,tty,time,cmd if you don’t specify -f or -l
Examples:
List the process ID, cumulative CPU time, and the command with arguments for all
processes, overriding the title of the last column:
ps -A -o "pid,time,args=Command (with args)"
Exit status:
-1 An error occurred.
See also:
hogs, pidin, showmem, top

© 2010, QNX Software Systems GmbH & Co. KG. pterm
Photon Terminal window
Syntax:
pterm [-ABbcEGLlnPpQqrTUvXZz] [-a font][-C path]
[-D fd] [-d path] [-F n] [-f font]
[-g RxC] [-H N] [-h height[%]]
[-K colors] [-k]
[-M RxC] [-m RxC] [-N fd] [-R prefix]
[-S i|m|n] [-s server] [-T] [-t string]
[-u opts] [-w width[%]] [-x position[%] [r]]
[-y position[%][r]] [program [argument...]]
Runs on:
Neutrino
Options:
The default values listed below are the ones coded in the pterm application; they
might be overridden by a configuration file.
-A Pass all Alt key combinations to the device.
-a font Add font to the font list.
-B Cursor always blinks (default: cursor blinks only when window

has focus).
-b Cursor never blinks.
-C path Use this configuration file.
-c Disable the Terminal Properties dialog.
-D fd Attach to the given file descriptor instead of using a pty.
-d path Open given device instead of using a pty.
-E Don’t modify environment variables (default: unset LINES and

COLUMNS; set TERM according to the protocol).
-F n Use the n-th font from list (starting from 0).
-f font Use font as the current font.
-G Pass signals to the program.
-g RxC Set the initial size to R rows, C columns.
-H N Save up to N lines in the scroll-back buffer.


pterm © 2010, QNX Software Systems GmbH & Co. KG.
-K colors Specify the foreground and background colors. The colors

argument is one or two numbers in the range 0 to 7; the first is
for the foreground and the second for the background. The
numbers are indexes into the first 8 entries in the palette for
pterm (see the “Files” section, below).
For example, this command sets the initial colors to black (0) on
white (7):
pterm -K 07
-k Enable the Ctrl+Alt+f key chord which allows you to toggle

between full screen and window mode.
-L Don’t create a new session.
-l (“el”) Start the shell as a login shell.
-M RxC Set maximum size to R rows, C columns.
-m RxC Set minimum size to R rows, C columns.
-N fd Output device name to this fd.
-n Don’t read the configuration file.
-P Increase program’s priority (default: don’t change any priority).
-p Decrease priority.
-Q Use QNX protocol (default: ANSI).
-q Never confirm before closing.
-R prefix Use prefix for the pty (default: /dev).
-r Display a scrollbar.

normal).

fullpath fullpath
-T Disable text-mode mouse.

-t string Set window title to string.
-U Don’t realize the pterm window until it receives output. This

option takes precedent over -z and -Z.
-u opts Unset given options (AaBbQv) even if set in the configuration

file.
-v Visual bell (default: use audio beep only).

-X Exit with shell’s exit status (default: always exit with zero).


-Z Wait until closed unless exit status is zero (default: close

window as soon as the command terminates).
-z Wait until closed explicitly.
program [argument...]
Name of the program that pterm starts. A shell is started if
neither program nor any of the following options are specified:
-D fd, -d path, or -N fd.
Description:
The pterm application is a terminal emulator that opens a window on the Photon
workspace and attaches itself to a character device. The device is usually a pty
(pseudo-tty) on the local node, but you can use the -R option to override the node (e.g.
if the pty driver isn’t running on the local node). Or you can use the -D or -d options
to specify a device (e.g. a serial link connected to a modem).
By default, pterm starts a shell on the “slave” side of the pty. The shell won’t be
spawned if a -D or -d option is used to override the device or if a -N option is used, in
which case it outputs the device name to the given file descriptor. In all cases, you can
use a command-line argument to force a program to be started on the device.

If the -d option specifies a pty, then the program is started on the specified device and
the other side of the pty remains unused (which is probably not the desired behavior).
Before spawning the command, pterm sets the TERM environment variable to a
value depending on the chosen terminal emulation. It’ll be one of the following:
• qnxm
• qansi-m
You can use the -E option to pass the original environment to the command.
By default, pterm closes its window as soon as the program spawned in it terminates.
The -Z or -z option overrides this default — the window remains open until the user
closes it. This option can be useful when a program is spawned that outputs a message
and then exits immediately.
The -G and -X options can also be useful for a program or script that calls pterm.
If -G is used, then whenever pterm catches a signal other than SIGTERM, SIGCHLD,
SIGILL, SIGWINCH or SIGSEGV, the signal is passed to the spawned command. This
means that a script can spawn pterm and easily kill its command with a chosen signal.
The -X option causes pterm to exit with the same exit status that the command
returned (or even to kill itself with the signal that killed the command).
If the user closes the window while the command is still running, or if pterm catches
a signal and either the -G option wasn’t specified or it is the SIGTERM signal (which
can mean that either Photon is being closed or pterm is being killed using the slay
command), pterm:
1 Sends the SIGHUP signal to the command.
2 If the command survives, sends the SIGTERM signal.
3 Exits.
If the -X option was specified and the command survives both signals, pterm
terminates with exit code 1.
If a process running on the pterm’s device is producing output very quickly, you can
increase the total throughput by running the “consumer” at a priority lower than the
“producer.” Data then arrives at the pterm in larger portions. You can further increase
the throughput by using larger buffers in the pty driver — pterm uses a 4K buffer,
while the pty driver’s default is 512 bytes.
You can use the -P or -p option either to reduce pterm’s priority or increase the
spawned command’s priority. Of course, changing the priority has other side effects: if
pterm’s priority is reduced below the default (-p option), then other processes
running at the default priority may significantly reduce the speed of pterm and, as a
result, the total throughput. On the other hand, if the process in pterm is running at an

increased priority (-P option), then it may affect the performance of other processes,
especially when it doesn’t produce much output.
You can use the -g option to set an initial terminal size, and the -m and -M options to
enforce minimum and maximum sizes. These sizes apply to the terminal, and not the
pterm window. If the window is re-sized to be smaller than the minimum size, the
terminal is clipped. If the window is re-sized to be larger than the maximum size, the
terminal is centered. If there is a conflict between the -g option and either -m or -M,
all options are adjusted to reflect the last option specified on the command-line.
Keys and keychords

You can use these rudimentary clipboard keys:

Allow text-mode applications to receive Ctrl-Alt-T
mouse events.
Copy selection to the clipboard. Ctrl-Alt-X or Ctrl-Alt-Del
Don’t allow text-mode applications to Ctrl-Alt-S
receive mouse events.
Paste contents of clipboard to the Ctrl-Alt-V or Ctrl-Alt-Ins
current cursor location.
Paste directly from the selection without Ctrl-Alt-P
using the clipboard.
Select the word under the cursor or to Ctrl-Alt-W
the left of the cursor.
Select the word under the cursor or to Ctrl-Alt-H
the left of the cursor and search for that
word in Helpviewer.
Select/Unselect current selection. Ctrl-Alt-R
The mouse supports the following user activities within pterm:

Copy selection to the clipboard. Right-click or Right-drag (selecting)
Paste the contents of the clipboard to the Ctrl-Right button
current cursor location.
Paste from the clipboard. Middle button
continued. . .


Paste selection to the current cursor Shift-Right button
location.
Pop up a menu. Alt-Right button
Pop up a menu (if mouse in text mode is Right button
disabled).
Select a block. Ctrl-Left button
Select a block (if mouse in text mode is Left button
disabled).
Select a “stream.” Shift-Left button
Select a word (C identifier). Alt-Left button, or double-click on the
word
Select the current line Triple-click on the line
Select the entire screen Quadruple-click on the screen
Several keychords are recognized by pterm:

Change font Ctrl-Alt-[ or
Ctrl-Alt-] or
Ctrl-Alt-< or
Ctrl-Alt->
Invoke the Terminal Properties dialog. Ctrl-Alt-C
Move through the scrollback buffer. Ctrl-Alt and ↑, ↓, Home, End, Pg Up, or
Pg Dn
The Ctrl-Alt-[ and Ctrl-Alt-] keychords change the font to the previous/next on the list,
without changing the terminal size (rows and columns).
Ctrl-Alt-< and Ctrl-Alt-> change the font without changing the window dimensions
(measured in pixels). If, however, the new terminal size would be smaller than the
minimal size, then the window must be grown. If the new size would be larger than the
maximum size, the window won’t be made smaller — instead, the terminal’s margins
are adjusted to fill the window.
You can store certain visible aspects of the terminal in a configuration file (see the
“Files” section) and modify them by using the Terminal Properties dialog invoked by
Ctrl-Alt-C:

Window Title area Here you can change the title or restore the default title. If you
don’t remember the escape sequences you can use in the title,
press the button marked ? to see the list.
The window title can contain special escape sequences:
Escape Meaning
%% A single % character
%$ PID of the current process
%0 Just the argv[0] argument of the current process
executing in the window
%A Arguments of the current process executing in the
window starting at the argv[0] position
%a Arguments of the current process executing in the
window starting at the argv[1] position
%d Device name (e.g. ttyp1)
%N Filename of the current process executing in the
window
%P Pathname of the current process executing in the
window
%p Device path (e.g. /dev/ttyp1)
continued. . .

Escape Meaning
%T Current time
%u User’s login name
Window Size area Here you can set the current terminal’s size, as well as the
minimum and maximum size (measured in pixels).
Font area You can choose from one of the predetermined font styles and
sizes, or you can select the custom font list. You edit the
custom font list by clicking Customize... For more information
see the section, Customizing your font list.
Terminal Preferences area

You can choose:
• Cursor blinking (equivalent to the -B and -b options)
• Whether the “general” or “command-specific”
configuration file is saved when you click the Save & Close
button.
• Visual bell (equivalent to the -v option)
• To suppress the Window Manager’s Alt-key combinations
and pass them to the device instead (equivalent to the -A
option)
• To display a scrollbar on the pterm window.
• The number of lines in the scroll-back buffer (equivalent to
the -H option).
Customizing your font list

Here you choose the required font for your custom font list:

All the fonts displayed in this dialog must have the same character encoding. By
default, pterm assumes it’s the PC character set (“IBM code page 437”). If your fonts
use a different character encoding, you’ll have to specify a charsets file (click
“Browse...”) that defines that encoding. See ptermcs for information on creating
charset files.
Examples:
Run pterm using the Photon server on node my_node:
pterm -s/net/my_node/dev/photon
Run pterm at initial position (10,10) with initial dimension of 200×300:
pterm -x10 -y10 -h200 -w300
Files:
When pterm is started, it looks for your local configuration file— if that file doesn’t
exist, a global configuration file is loaded. Whenever you click Save & Close in the
Terminal Properties dialog, the local file is saved. The configuration files have the
following pathnames:
Global ${PHOTON_PATH}/config/$0 .rc

where $0 is the name used for invoking pterm — usually it’s pterm; if
$PHOTON_PATH is unset or empty, /usr/photon is used instead.
Local • If the -C option is given, the option’s argument is used.

• Otherwise, if $PTERMRC is non-empty, its value is used.

• Otherwise, if $HOME/.ph/pterm/$0. $CMD.rc exists, it’s used

(where $CMD is the command-specific file started in pterm).
• Otherwise, $HOME/.ph/pterm/$0.rc is used.
You can use the -n option to suppress the loading of the current settings from the
configuration files. The -c option disables the Terminal Properties dialog.
You can use the -u option to restore the default behavior of the following options:
AaBbQv. This option overrides the setup in the configuration file.
-uA Use Alt key combinations for window manager commands.
-ua Suppress loading of font table from configuration file.
-uB Clear always-blink option for cursor.
-ub Clear never-blink option for cursor.
-uQ Use the ANSI protocol.
-uv Turn off the visual bell.
You can give several option characters to the -u option at one time (e.g.-uabQv). The
-ub and -uB options mean the same thing. The always-blink (-B) and the never-blink
(-b) options are two states of a three-state switch. The third state (activated with either
-uB or -ub) is “Blink when pterm has focus.”
When pterm is started, it searches for a palette file:
• If the PTERMPAL environment variable is defined, its value is assumed to be the

path to a palette file.
• Otherwise, pterm looks for $HOME/.ph/pterm/pterm.pal or

$PHOTON_PATH/pterm.pal.
The palette file can be either a binary file containing sixteen 32-bit entries or a text file
containing sixteen 8-digit hexadecimal numbers separated by newlines (and
terminated with a single newline). If the length of the file is neither 64 nor 144 bytes,
the file is assumed invalid.
The palette file is capable of displaying 16 colors: 8 “normal” colors and 8 “bright”
colors in the same way that a standard CGA/VGA does. Color numbers are indexes
into this array. The default array has 16 elements corresponding to 16 standard CGA
colors:

Index Color
0 BLACK
1 BLUE
2 GREEN
3 CYAN
4 RED
5 MAGENTA
6 BROWN
7 WHITE (light grey)
8 BRIGHT BLACK (dark grey)
9 BRIGHT BLUE
10 BRIGHT GREEN
11 BRIGHT CYAN
12 BRIGHT RED
13 BRIGHT MAGENTA
14 BRIGHT BROWN (yellow)
15 BRIGHT WHITE
PHOTON_PATH The name of the root directory containing Photon files.
PTERMPAL The path to the palette file.
PTERMRC The name of a local configuration file.
TERM Set, depending on the chosen terminal emulation, to one of:

• qnxm
• qansi-m
See also:
ptermcs
Using the Command Line and Using the Photon microGUI in the Neutrino User’s
Guide

ptermcs © 2010, QNX Software Systems GmbH & Co. KG.
Create character set files for pterm
Syntax:
ptermcs [-S i|m|n] [-s server] [-x position[%][r]]
[-y position[%][r]] filename
Runs on:
Neutrino
Options:
normal).

fullpath fullpath


filename Name of file to load.
Description:
The ptermcs utility creates files to specify character settings that pterm uses for its
custom font list.
Terminal charset setup

When you invoke ptermcs, the Terminal charset setup dialog appears. Here, you can
customize the charsets as follows:
ANSI charset Choose a character set that you want pterm to use when your
terminal emulation is set to ANSI in pterm’s Terminal Properties
dialog. The ISO 8859 character sets are a good choice for ANSI
mode because all of the printable characters are in this range
(32-127, 160-255). Default is Western European (ISO 8859-1).

© 2010, QNX Software Systems GmbH & Co. KG. ptermcs
Internal/QNX charset
Choose a character set that you want pterm to use when your
terminal emulation is set to QNX in pterm’s Terminal Properties
dialog. DOS code pages such as Cyrillic (IBM 866) or the PC
character set (“IBM code page 437”) are the best choices since they
contain all of the alphanumeric characters as well as the
line-drawing characters. Default is PC character set (“IBM code
page 437”).
Font charset Choose the character encoding that your fonts use. Default is PC
character set (“IBM code page 437”).
To save your changes, select Save on the File menu.
Examples:
Run ptermcs using the Photon server on node my_node:
ptermcs -s/net/my_node/dev/photon
ptermcs -x10 -y10
See also:
pterm

pv © 2010, QNX Software Systems GmbH & Co. KG.
Display a graphical image
Syntax:
pv [-C] [-h height[%]] [-S i|m|n] [-s server]
[-y position[%][r]] [filename]...
Runs on:
Neutrino
Options:
-C Start “clean”; don’t load the list of files previously viewed.


normal).

fullpath fullpath



filename Name of file to display.
Description:
The Photon image viewer displays bitmap image files on the Photon workspace. When
you first start the viewer (without specifying an image filename), you’ll see a File
menu and an empty image area.
The File menu provides a File Selector mechanism for loading image files.

© 2010, QNX Software Systems GmbH & Co. KG. pv
For more information about capturing screen images, see snapshot.
Examples:
Run pv using the Photon server on node my_node:
pv -s/net/my_node/dev/photon
Run pv at initial position (10,10) with initial dimension of 200×300:
pv -x10 -y10 -h200 -w300
See also:
snapshot

pwd © 2010, QNX Software Systems GmbH & Co. KG.
Print working directory name (POSIX)
Syntax:
pwd
Runs on:
Options:
None.
Description:
The pwd utility writes the pathname of the current working directory to the standard
output.
The pwd command is available both as a shell alias (equivalent to print "$PWD"),
and as a standalone utility. For information about the builtin pwd command, see ksh.
To make sure you use the executable, specify the full path.
Exit status:
See also:
cd (builtin ksh command), fullpath, ksh, ls

© 2010, QNX Software Systems GmbH & Co. KG. pwm
Photon Window Manager
Syntax:
pwm [-CcdfGKknPrSW] [-a C|L|R] [-b color]
[-g input_group] [-R [b|c|f|m|r|t]...]
[-s server] [-Xcurs[,clr]]
Runs on:
Neutrino
Options:
-a C|L|R Alignment. By default, title alignment is centered (C) in the title
bar. This option lets you change the alignment to either left (L) or
right (R) justification.
-b color Background color (hex RGB value).
-C Shut down the window manager when you close the last window
(bkgdmgr and shelf are considered windows).
-c Cursor focus. By default, focus is given to a window when you

click anywhere inside it. This option lets you change keyboard
focus so that it follows the cursor. You can toggle this behavior
within pwm using the Cursor Focus option.
-d Full window dragging. Change the default dragging from outline

to full window dragging. You can toggle this behavior within
pwm using the Full Window Dragging option.
-f Click to front. By default, a window is brought to the front only

if you click on the window title bar. This option lets you click
anywhere in a window to bring it to the front. You can also set
this behavior within pwm using the Click to Front option.
-G Enable multi-monitor placement policy.
-g input_group Set the PWM input group (default 1).
-K Disable the keyboard.
-k Always process Ctrl-Alt keychords. This option allows Ctrl-Alt to

always be recognized by PWM for keyboard navigation. By
default, each window has its own Ctrl-Alt state.
-n Disable Cursor focus. If the cursor focus is set to the default

mode in a mouse-less environment (or when the mouse doesn’t
start) a window can’t be accessed. This option provides a
override for a mouse-less environment. The ph -s command
calls pwm with this option.

pwm © 2010, QNX Software Systems GmbH & Co. KG.
-P Disable console switching, the workspace menu, and the

keyboard. This option is an alternative to specifying -KSW.
-R [b|c|f|m|r|t]
Run PWM on a remote computer (phditto/phindows).
• b — Remove borders from application window.
• c — Close PWM when there are no child windows to manage.
• f — Fit (make application always fit remote window).
• m — Maximize (initially resize application to fit remote
window).
• r — Resize remote (initially resize remote window to fit
application).
• t — Pass application window title to remote window.
-r Auto-raise window on steady cursor.
-S Disable console switching.
-s server_name The name of the Photon server. The default is /dev/photon.
-W Disable the workspace menu.
-Xcurs[,clr] Define default cursor type (E9xx code) and color (hex RGB
value)
Description:
The Photon Window Manager (pwm) provides standard window management
functions, including move, resize, minimize, maximize, raise, lower, and close. It
provides common window frame borders that applications can customize, depending
on their requirements.
Apart from the -f click-to-front option listed above, pwm also enables the following
key combinations:
• Alt-Shift-Esc — back-most window to front
• Alt-Esc — front-most window to back
• Ctrl-Alt-1-9 — switch to console number 1 to 9
• Ctrl-Alt-Return, Enter, or + — Cycle to the next console with an active window.
• Ctrl-Alt-Backspace or - — Cycle to the previous console with an active window.
• Alt-F2 — Bring the next window in the console to the front.
• Alt-F3 — Bring the previous window in the console to the front.
• Alt-F4 — Close the current application.

• Alt-F5 — Restore the current window, if it is maximized.
• Alt-F7 — Move the window. Use the arrow keys or mouse to move the window.
• Alt-F8 — Resize the window. Use the arrow keys or the mouse to resize the
window.
• Alt-F9 — Minimize the current window.
• Alt-F10 — Maximize the current window.
• Print Screen — Start snapshot to take a screen shot.
PWM Options
Selecting Desktop Config... from the Desktop Menu launches the pwmopts program,
which lets you configure the workspace.
Configuring the Desktop menu

Each user can configure the Desktop menu. The configuration file is in
$HOME/.ph/wm/wm.menu.
If you create your own menu, you won’t see new menu items when they’re added to
the default one.
Here’s a sample personal PWM menu:
= Desktop Menu
Terminal T pterm
-
Graphics Config... G phgrafx
Desktop Config... W pwmopts
Shelf Config... S shelf -c
-
Mail M pterm elm
News N pterm trn
-
Shutdown... u phshutdown
The format of the file is simple; each line describes a menu item. Menu items are
defined in the form:
MenuItemTABHotkeyTABCommandAndArguments
If the line starts with:
• an equals sign, the rest of the line is the menu title
• a hyphen, it’s a menu separator.
You can’t use environment variables because the command parsing is simple.
However, you can write the command to a shell script and specify the script as the
command to run.

pwm © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Start the window manager with left-side title alignment, cursor focus, and
click-to-front behavior:
pwm -cf -aL
Files:
$HOME/.ph/wm/wm.cfg
Holds a user’s PWM workspace configuration.
$HOME/.ph/wm/wm.menu
Holds a user’s custom PWM Workspace menu.
PHWMEXIT When set, disables the confirmation dialog when Photon exits. To
disable this dialog, add the following lines before the ph
command in your /etc/rc.d/rc.local file:
# disable confirmation dialog when Photon exits

export PHWMEXIT=1
PHWMOPTS Specifies the options to be passed automatically to pwm.
PWM_PRINTSCRN_APP
The application to start when the Print Scrn key is pressed. By
default, snapshot is started.
PH_WFRAME_STYLE
Specifies the window frame style.
By default, this is set to wframe_updated2.dll (PhAB) or
wframe_updated2.so.
This setting is included to improve performance. If you wish to
change this setting to support 6.4.0 look and feel, set:
export PH_WFRAME_STYLE=wframe_updated.so
or, for Windows/PhAB for Windows:
export PH_WFRAME_STYLE=wframe_updated.dll
before launching Photon.

See also:
pterm, pwmopts, savercfg

pwmopts © 2010, QNX Software Systems GmbH & Co. KG.
Photon Window Manager options
Syntax:
pwmopts [-s server] [-x position] [-y position]
Runs on:
Neutrino
Options:

fullpath fullpath


Description:
The pwmopts command displays a dialog for setting options that apply to the Photon
Window Manager (PWM).
You’ll see these buttons at the bottom of the window:
Cancel Quit the options configuration program without saving any changes. You
can also cancel by closing the window from the menu or by pressing the
Esc key.
Apply Apply changes and save them to the configuration file. This is useful to test
the behavior of a user interface against a variety of operating paradigms
without the need for saving and relaunching the configuration window.
Done Save any modified options. This writes the options to the user
configuration file ˜/.ph/wm/wm.cfg, and instructs PWM to reconfigure
itself to the new options. The pwmopts program also terminates.
These options apply to windows:

© 2010, QNX Software Systems GmbH & Co. KG. pwmopts
Active, Inactive, and Title colors

These buttons bring up a color-selection dialog that lets you
customize the color of the window frame when active and
inactive, and the color of the title text.
Within the color selection dialog, you can select a color by:
• picking an entry from the palette
• choosing a color from the color patch
• specifying individual RGB values in the text fields
• using the eye dropper to pick an existing color on the screen
A sample of the selected color is displayed at the top of the
dialog. To accept the new color, click the OK button.
Scheme You can also select the frame and title colors from this menu of
preset color schemes.
Title Alignment Your choice in the radio buttons specifies the alignment of the
window title within the window frame.
Full Window Dragging option
If enabled, windows are continuously redrawn as they are
dragged/moved around the screen. If disabled, only an outline of

pwmopts © 2010, QNX Software Systems GmbH & Co. KG.
the window frame is dragged and the window is redrawn at its

final position. This is useful for slow video cards or when running
over a slow phrelay link.
Cursor Focus option
If enabled, focus is given to the window under the cursor. If
disabled, focus remains with the current focus window regardless
of the cursor location. The focus window is the one that receives
all keystrokes.
Click To Front option
If enabled, a click in any part of the window brings it to the front.
If disabled, clicking in the title bar only brings a window to the
front.
Multi-Monitor Placement option
If enabled, this affects whether PWM considers the desktop to
span only the first graphics region (monitor) or all graphics
regions comprising the input group. This affects the placement of
the shelf, as well as the dimensions used when maximizing
windows.
These options apply to the background of your display:

© 2010, QNX Software Systems GmbH & Co. KG. pwmopts
Background Color buttons

These buttons let you choose the primary and secondary
background colors. They’re used if PDM isn’t displaying a
background image. You can choose a color as described for the
window options, above.
Pattern If you’re not displaying a background image, you can choose a

pattern from this list. The pattern is displayed using the current
background colors.
Use image from The directory in which to look for background images. You can
type a path in the text field, or click on the button beside it to look
for a directory.
Name The name of the background image, which you can choose from a
list of images in the current image directory.
Gravity If the image doesn’t fill the screen, you can choose where it goes.
You can also decide whether to tile or stretch the image to fill the
screen.
Files:
${HOME}/.ph/wm/wm.cfg
The file in which your window-manager options are stored.
To get the default look and feel, ensure that wframe_updated.so and wm.cfg are
installed properly on your target system.
See also:
phrelay, pwm, savercfg

python © 2010, QNX Software Systems GmbH & Co. KG.
Object-oriented programming and scripting language
Syntax:
python [option] ... [-c cmd | -m mod | file | -] [arg] ...
Runs on:
Neutrino
Options:
-c cmd Pass the cmd string as the program to run. This option terminates the
option list.
-d Display debugging output from the parser. You can also enable this by
setting PYTHONDEBUG to a nonzero value.
-E Ignore Python’s environment variables (such as PYTHONPATH).
-h Print a help message, and then exit.
-i Inspect interactively after running the script, and force prompts, even if
stdin doesn’t appear to be a terminal. You can also enable this by setting
PYTHONINSPECT to a nonzero value.
-m mod Run the specified library module as a script. This option terminates the
option list.
-O Optimize the generated byte code (a tad). You can also enable this by
setting PYTHONOPTIMIZE to a nonzero value.
-OO Remove doc-strings in addition to performing the -O optimizations.
-Q arg Control the behavior of the division (/) operator, where arg is one of the
following:
• old — use floor division for integral arguments, and true division for
floating-point or complex arguments.
• warn — generate a warning if / (instead of //) is used for integer
division.
• warnall — generate a warning whenever / is used.
• new — always perform true division.
The default is old.

© 2010, QNX Software Systems GmbH & Co. KG. python
This option will be removed in version 3.0 of Python, and the / operator will always
perform true division. For more information, see
http://www.python.org/dev/peps/pep-0238/.
-S Don’t imply import site on initialization.
-t Issue warnings about inconsistent tab usage.
-tt Issue errors about inconsistent tab usage.
-u Use unbuffered binary for stdout and stderr. See the Python
documentation for details on internal buffering related to this option. You
can also enable this by setting PYTHONUNBUFFERED to a nonzero
value.
-v Be verbose (trace import statements). You can also enable this by setting
PYTHONVERBOSE to a nonzero value.
-V Print the Python version number, and then exit.
-W arg Warning control; arg is action:message:category:module:lineno.
-x Skip the first line of source, allowing the use of non-Unix forms of #!cmd.
file Read the program from this script file.
- Read the program from stdin (the default; Python uses interactive mode if
run on a tty).
arg ... Arguments to pass to the program in sys.argv[1:].
Description:
Python is a high-level, object-oriented programming language that supports powerful
programming constructs, can be integrated with other languages such as C and C++,
and is extendible through the addition of libraries and modules. You can use Python
for programs and sophisticated scripts.
We don’t support Python on Linux or Windows. If you need Python on these hosts,
you should download it from http:www.python.org.
PYTHONCASEOK Ignore case in import statements (Windows).
PYTHONDEBUG Display debugging output from the parser.
PYTHONHOME An alternate prefix directory (or prefix:exec_prefix). The

default module search path uses prefix/pythonX.X.

python © 2010, QNX Software Systems GmbH & Co. KG.
PYTHONINSPECT
Inspect interactively after running the script, and force
prompts, even if stdin doesn’t appear to be a terminal.
PYTHONOPTIMIZE
Optimize the generated byte code (a tad).
PYTHONPATH A colon-separated list of directories prefixed to the default

module search path. The result is stored in sys.path.
PYTHONSTARTUP
The file to execute on interactive startup (no default).
PYTHONUNBUFFERED
Use unbuffered binary for stdout and stderr. See the Python
documentation for details on internal buffering.
PYTHONVERBOSE
Be verbose (trace import statements).
See also:
gawk, sed
Writing Shell Scripts chapter of the Neutrino User’s Guide
http://www.python.org/

© 2010, QNX Software Systems GmbH & Co. KG. qbinaudit
Compare binaries to the officially distributed versions (QNX Neutrino)
Syntax:
qbinaudit [options] [manifest_filename]
Runs on:
Options:
-s Be silent; don’t display dots to indicate the audit’s progress.
-v Be verbose; display the name of each file processed.
manifest_filename The name of the manifest file that describes the binaries to
audit.
You can specify the name of the manifest filename on the command line. If you don’t,
the script looks in the known installation location of the manifest files and prompts
you to select one.
Description:
The qbinaudit script parses the chosen manifest file to retreive the checksum value
and filename for each binary. It then regenerates the binary file’s CRC32 checksum
and compares it to the one in the manifest file.
If there’s a difference, the name of the binary filename is listed on stdout, indicating
that this binary doesn’t match the version from the officially distributed QNX release.
This can happen (for example) if you download the source from the Foundry27
website and modify it.
Examples:
# qbinaudit
Select a manifest file using the prefixed selection number in the square brackets.
[1]: manifest-base
[2]: manifest-sdk-host
[3]: manifest-sdk-ide
[4]: manifest-sdk-target
[5]: manifest-target-gpl
[6]: manifest-target-htmldocs
Select? 1
**** Processing /usr/qnx640//install/qnxsdp/6.4.0/manifest-base
.......................................................................
.......................
Chksum diff: 2187478658 vs 4168080167 /etc/system/config/display.conf
.......................................................................
.......................................................................
..................
Chksum diff: 1717030851 vs 3179076788 /opt/mozilla/firefox/bin/components/xpti.dat
Chksum diff: 3527685377 vs 1769584334 /opt/mozilla/firefox/bin/components/compreg.dat
.......................................................................
.......................................................................
..................
Chksum diff: 652769104 vs 452256802 /usr/lib/ldqnx.so.2
.......................................................................

qbinaudit © 2010, QNX Software Systems GmbH & Co. KG.
.......................................................................
.......................................................................
.....................
**** Completed ****
See also:
qconfig, QWinCfg, showlicense, sysinfo

© 2010, QNX Software Systems GmbH & Co. KG. QCC, qcc
Compile command (QNX Neutrino, QNX 4)
Syntax:
For C:
qcc [options] [operands]
For C++:
QCC [options] [operands]
Runs on:
Options:
-A library[.a] Build a new archive.
-a library[.a] Add to the given archive.
-ansi Compile strict ANSI code.
-Bstatic Link statically against any subsequent libraries on the command

line.
-Bdynamic Link dynamically against any subsequent libraries on the

command line.
-C Preprocessor leaves comments.
-c Compile only.
-D name[=value] Define the symbol name, optionally setting its value.
-E Preprocess to stdout.
-EB
-EL Compile for big or little endian.
-g Compile with debug.
-I path[:path ...] Set the search path for #include directives.
-L path[:path ...] Set the library search path.

QCC, qcc © 2010, QNX Software Systems GmbH & Co. KG.
The development tools have been designed to work out of their processor directories
(x86, ppcbe, etc.). This means you can use the same tool set for any target platform.
If you have development libraries for a certain platform, put them into the
platform-specific library directory (e.g. /x86/lib), which is where the compiler tools
look by default. Don’t put the libraries in /lib or /usr/lib, which are ignored.
Alternatively, use the -L option to specify the libraries’ location.
-l library (“el”) Add library to the list of libraries to link against. Omit
the lib prefix and any extension from the library’s name. For
example, to link against libsocket, specify -l socket.
You can specify more than one -l option. The qcc
configuration files might specify some libraries for you; for
example, qcc usually links against libc.
-lang-c Treat as C (the default for qcc).
-lang-c++ Treat as C++ (the default for QCC).
You need to link C++ programs with the -lang-c++ option in order for exceptions to
work.
-M Generate a mapfile called output_file.map.
-N stacksize[K] Specify the stack size, in bytes or kilobytes.
-n Don’t execute.
-nopipe Use temporary files rather than pipes between phases.
-nostartup Don’t use ld_startup_* sections.
-nostdinc Don’t include the standard C include paths.
-nostdinc++ Don’t include the standard C++ include paths.
-nostdlib Don’t use the ld_stdlib section.
-nostdlib++ Don’t use the ld_stdlib++ section.
-O Do compile-phase optimization.
-o outfile Specify the name of the output file. The default is a.out.

Note that the make utility, when used with the default settings, produces an output file
with the same name as the input file. For example:
make file1
results in the executable output file file1.
-P Preprocess to file.i (C) or file.ii (C++).
-p Compile with profiling; see “Profiling,” below.
-S Compile, leave assembly in file.s.
-set-default Set the current -V argument as the default target. For example:
qcc -V3.3.5,gcc_ntoppcbe -set-default

will set GCC 3.3.5 for PPC big-endian as the default.
You must be root to use the -set-default option. Note also that the option is
intended for use at the command line, not for makefiles.
-shared When compiling, make the object position-independent so that

it’s suitable for inclusion in a shared object. When linking,
combine the modules into a shared object.
-static Link against static libraries only.
-U name Undefine the given symbol.
-V [[compiler/ ]version,][target]
The compiler name, version number, and the target name. If
you don’t specify -V at all, qcc will use the default compiler,
version, and target.
If you specify the target, qcc looks for the target configuration
files in the following paths, according to how compiler, version,
and target are specified:
If you specify: qcc looks here:

-Vtarget ${QCC_CONF_PATH}/compiler/version (where compiler is inferred from target, and
version is the default).
-Vversion,target ${QCC_CONF_PATH}/compiler/version (where compiler is inferred from target; if that
path doesn’t exist, or if version contains a slash [/], then ${QCC_CONF_PATH}/version
is used).
continued. . .

If you specify: qcc looks here:

-Vcompiler,target ${QCC_CONF_PATH}/compiler/version (where version is the specified compiler’s
default version).
-Vcompiler/version,target ${QCC_CONF_PATH}/compiler/version
For example, this command:
qcc -Vgcc,
lists all targets in all versions of gcc. See the Examples section
below for more examples.
The targets include:
• gcc_ntoarmle
• gcc_ntomipsbe
• gcc_ntomipsle
• gcc_ntoppcbe
• gcc_ntoshle
• gcc_ntox86
For a list of supported targets, specify -V (or -Vcompiler or
-Vcompiler/version or -Vversion, provided there’s a valid
${QCC_CONF_PATH}/version directory).
-v[v] Operate verbosely (the second v turns on verbosity in the

compiler).
-W phase,arg[,arg ...]
Pass the specified option and its arguments through to a specific
phase:
• p — preprocessor
• c — compiler
• l — linker
• a — assembler.
For example, if you want to pass the -MD option to the compiler,
specify -Wc,-MD on the command line for qcc.
-w Suppress all warnings (same as -w0).
If you specify -w along with multiple warning options, all warnings are suppressed
regardless of the order of the options. In other words, -w always wins.
-w[0-9] Set the warning level (0=off). The -w9 option is the same as
gcc’s -W9 option. To generate warnings for everything, include
these options with -w9:

• -Wcast-qual
• -Wpointer-arith
• -Wshadow
• -Wwrite-strings
Note that using these options will produce warnings in the
standard C++ library headers, and possibly other system
headers.
-x extension Treat the files that follow as being of type extension. The
following values of extension are accepted:
• c
• c-header
• c++
• cpp-output
• assembler
• assembler-with-cpp
as well as valid file extensions, such as .c, .cc, .cpp, .C, .i,
.ii, .s, and .S.
Use -xnone to go back to normal suffix typing. For example,
to compile myfile.h as if it were a .c file:
qcc -xc myfile.h
-Y lib_type Select the C++ library type to be used (if available), lib_type
can be:
• _gpp — GNU C++ lib (available only for x86)
• _cpp — Dinkum C++ lib (default)
• _cpp-ne — Dinkum C++ lib (no exceptions)
• _acpp — Dinkum Abridged C++ lib
• _acpp-ne — Dinkum Abridged C++ lib (no exceptions)
• _ecpp — Embedded Dinkum C++ lib
• _ecpp-ne — Embedded Dinkum C++ lib (no exceptions)
Even with exceptions disabled, the new() operator throws a std::out_of_memory

exception if there isn’t enough memory. If you want new() to return NULL instead of
throwing an exception, overload the new() operator with your own.

Description:
QCC and qcc are the QNX compiler interface. They’re based on the POSIX c89
utility. By default, QCC considers a program to be C++, while qcc considers it to be C.
QCC and qcc take a list of source and object modules on the command line and
invokes the appropriate parser to compile each file. Object modules are passed straight
through to the linker. The file suffix determines which parser is used, as follows:
Suffix Parser
.s Assembler
.S Assembler with preprocessor directives
.c C compiler
.i Preprocessed C file
.C, .cc, .cpp C++ compiler
.ii Preprocessed C++ file
.o Object file
.a Library file
These utilities don’t allow multiple options to be specified after a dash character (-).
For example, -gc isn’t valid; you must specify -g -c instead. Operands (source and
object files) and options may be mixed and specified in any order. Some options, such
as -I and -L, are order-dependent—the order in which they appear in the command
line determines the order of the searches made. All command-line arguments are
processed before any compilation or linking begins.
The single-pass linker resolves symbols from left to right: If a module refers to a
symbol that is contained in a library, make sure you specify the library to the right of
the module.
When qcc encounters a compilation error that stops an object file from being created,
it writes a diagnostic to the standard error and continues to compile other source files,
but it bypasses the link phase and returns a nonzero exit status. If the link phase is
entered and is unsuccessful, a diagnostic is written and qcc exits with a nonzero status.
The -c option suppresses the link phase. If you have many separate source files that
you must update and modify individually, you’ll probably use the -c option frequently.
You may occasionally wish to examine the assembly code produced by the code
generator. The -S option produces an assembly file ending in .s.
If you need to specify a parameter to any of the language processors, you may use the
-W c,option. Check the documentation on each processor to determine its options.

The compiler defines various preprocessor symbols (or manifest constants) that can
help you make decisions at compile time. For more information, see the Manifests
chapter of the Library Reference.
Profiling
Here’s how to profile your application, so you can see where it’s spending its time:
1 Compile and link your application with profiling by using the -p option to qcc.
For example:
make CCOPTS+=-p LDOPTS+=-p
2 Slay qconn, or it will redirect the output.
3 Run your application as root (this is important because the timers are
privileged). The result of this run is a file called gmon.out, in your program’s
current working directory when it exits.
4 Look at the profiled output with the command:

gprof [your_app] | less
For more information, see the GNU documentation for gprof, and Profiling an
Application in the IDE User’s Guide.
Examples:
Compile myfile.c and create a 32-bit executable program for QNX Neutrino on an
Intel x86 machine in the current directory with the name a.out:
qcc -Vgcc_ntox86 myfile.c
Compile myfile.c and create a 32-bit executable program for QNX Neutrino on an
Intel x86 machine in the current directory with the name myfile:
qcc -Vgcc_ntox86 -o myfile myfile.c
Use the default compiler, version, and target:
qcc
The default compiler is gcc, the default version of the compiler is 4.2, and the default
target is ntox86.
Use the default version of the compiler, and build for an ARM little-endian target:
qcc -Vgcc_ntoarmle
Use the 3.3.5 version of the compiler, and build for a PPC big-endian target:
qcc -V3.3.5,gcc_ntoppcbe

Use make to compile myfile.c and create an executable program in the current
directory with the name myfile:
make myfile
You can’t use the default rules for make — you need to specify the target. See make.
Make a shared library:
qcc -Vgcc_ntox86 -shared -c shared.c

qcc -Vgcc_ntox86 -shared -o libshared.so shared.o
Files:
a.out The default output file. You can use the -o option to override this.
Configuration files:
${QCC_CONF_PATH}/version/*.conf
${QCC_CONF_PATH}/default
${QCC_CONF_PATH}/gcc/default
${QCC_CONF_PATH}/gcc/version/default
QCC_CONF_PATH
The name of the directory that contains the configuration files. The default
directory is ${QNX_HOST}/etc/qcc.
Exit status:
0 Success.
See also:
gcc, make
Compiling and Debugging chapter of the Neutrino Programmer’s Guide
Manifests chapter of the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. qconfig
Query and display QNX installations and configurations
Syntax:
qconfig [-abc] [-d path] [-e | -i | -l] [-h]
[-n installation_name] [-p] [-r program]
Runs on:
Options:
-a Display all installed products and updates in a machine-readable
format.
The -a option was added in QNX Neutrino Core OS 6.3.2 and an update to QNX
Momentics 6.3.0 SP1 and QNX Momentics 6.3.0 SP2.
-b Display the installed product baseline.
The -b option was added in QNX Neutrino Core OS 6.3.2 and an update to QNX
-c Print the runtime environment strings in csh style.
The -c option was added in QNX Momentics 6.3.0 SP3 and an update to QNX
-d path The name of the directory where all of the individual configuration
files are located. There’s one configuration file per installation.
-e Set up the runtime environment (see the examples). If you specify this
option, qconfig produces the commands to set these environment
variables:
• QNX_HOST
• QNX_TARGET
• PATH
• LD_LIBRARY_PATH
• MAKEFLAGS
You’ll find this option useful when setting up the environment for
building software.
-i List all installations in an easy-to-parse form. The form is:

qconfig © 2010, QNX Software Systems GmbH & Co. KG.
count: number_of_installations
name: ...
version: ...
host: ...
target: ...
There’s a set of lines for each version of software that you’ve

installed.
-l List all installations in human-readable format (the default).
-n installation_name
Select a specific installation by name. The name may be incorporated
as part of the configuration file using the <name> tag or, if not
present, it defaults to the filename.
-p Display the installed product updates.
The -p option was added in QNX Neutrino Core OS 6.3.2 and an update to QNX
-r program Run the given program in the environment.
Description:
The qconfig utility sets or queries the QNX configuration files. It supports the
coexistence of multiple versions of Neutrino on one machine.
To change the version of QNX Neutrino that you’re developing for on a Windows
machine, use QWinCfg instead of qconfig. QWinCfg changes the registry on your
machine; qconfig changes only the settings in your current shell.
Whenever you install a version of Neutrino, a configuration file is stored in a directory

that depends on the host OS. Each configuration file defines the name of the
installation and its base, host, and target directories.
The QNX_CONFIGURATION environment variable usually identifies the directory
where the configuration files are stored, but you can override it by specifying the -d
option. If neither of these produces a valid location, qconfig looks in
/etc/qnx/qconfig before giving up and returning an error.
If you don’t specify an installation with the -n option, qconfig uses the most current
installation.
You can use qconfig to query your current configuration in a human-readable format,
or you can use the -e option to set up your environment to use a certain installation.

© 2010, QNX Software Systems GmbH & Co. KG. qconfig
This utility doesn’t list the installed packages in any particular order.
Examples:
List all the QNX installations:
qconfig
Set up your shell environment for a specific installation:
eval ‘qconfig -n "QNX Momentics 6.3.0" -e‘
The syntax for evaluating the output of the -e option depends on the host OS and the
shell that you’re using. The command shown above works with ksh and bash.
Run a specific instance of qde (the IDE):
qconfig -n "QNX Momentics 6.3.0" -r qde
QNX_CONFIGURATION
The name of the directory that stores the configuration files.
See also:
qbinaudit, QWinCfg, showlicense, sysinfo
Controlling How Neutrino Starts and Configuring Your Environment in the Neutrino
User’s Guide

qconn © 2010, QNX Software Systems GmbH & Co. KG.
Provide service support to remote IDE components
Syntax:
qconn [-v] [port=portnum]
[qconn_prio=qpriority]
[child_prio=cpriority]
Runs on:
Neutrino
Options:
-v Display the version number for qconn, and then exit.
port=portnum Select a different port to bind the daemon to. The default is 8000.
If you aren’t logged in as root when you start qconn, it can’t
bind to a restricted port number.
qconn_prio=qpriority
Set the priority at which qconn runs. The default is 10.
Use this option to increase qconn’s priority if CPU-intensive
programs are running at the same or a higher priority, preventing
qconn’s clients from receiving data. For example, getting a
“Could not find target: Read timed out.” error while running the
QNX Momentics IDE’s System Profiler means that the System
Profiler is unable to receive data from qconn on the target.
child_prio=cpriority
Set the priority at which children are run. The default is 10.
Description:
The qconn daemon is a service provider that provides support, such as profiling
system information, to remote IDE components. Output is based on the services
invoked and is fed to the requesting IDE component on a remote host.
If you aren’t logged in as root when you start qconn, it can’t start resource manager
components.
The functionality comes from the service modules that are currently bound directly
into the executable.
Currently, if you want to use the debugger, you must have pdebug installed on your
system in the search path used when qconn is launched. You may also have pdebug
in /usr/bin.

© 2010, QNX Software Systems GmbH & Co. KG. qconn
Files:
Supporting files are required, depending on the service being used. For example, the
memory analysis service requires libmalloc.so installed in the user’s path.
Caveats:
The qconn daemon lets anyone run any application on your target system as the
superuser. Obviously, this is a huge security risk. Don’t include qconn on systems
being deployed to customer sites.
See also:
IDE User’s Guide

qcp © 2010, QNX Software Systems GmbH & Co. KG.
QNX communications protocol (QNX)
Syntax:
Send files:
qcp [device] se [options] src_file[,dst_file]...
[x=index_file]...
Receive files:
qcp [device] re [options] [-f filename|-p prefix]
Runs on:
Neutrino
Targets:
x86
Options:
device Pathname of serial device to use. The default is the device
connected to stdin and stdout.
-f filename Force received files to have this name.
-F Required to receive files on a flash filesystem that doesn’t support
all the POSIX file control mechanisms.
-l logfile (“el”) Append the file transfer event to the logfile.
-m Suppress making directories for received files.
-n Receive only files that are newer than existing files.
-p prefix Place this path prefix on the names of any received files.
-q Be quiet; display nothing during the transfer.
-r Relax timing; double timeouts and quadruple retry counts.
-s packet_size The size of transmitted data bursts (default is 2048 bytes).
-t Apply today’s date to received files.
-u Unlink files that lack write permission. This allows new versions
of the affected files to be received and written to disk.
-V, -v Be verbose; display the error status while transferring files.
x=index_file A list of filenames; qcp sends each file named in the list. You can
specify multiple x=index_file options specified and intermix them
with singly named files to transmit.

© 2010, QNX Software Systems GmbH & Co. KG. qcp
Description:
The qcp utility provides an error-checked file transfer protocol that qtalk uses to
transmit or receive files. This protocol is both highly efficient on packet switched
networks and highly reliable through the use of 16-bit CRCs (Cyclic Redundancy
Check).
The qcp utility automatically sends files with their pathnames, attributes, permissions,
and date fields intact. The qcp protocol is ideally suited for use over public packet
switch networks (X.25), as well as direct modem-to-modem connections. If
communication errors are encountered, portions of the file are automatically resent
until the far end acknowledges correct reception of the file.
If you’re using qtalk to communicate with a remote system, you can both send and
receive files to the remote system with the qcp utility. To cause a file to be sent from
the remote system to your local system, type a command of the following form into
the qtalk session you have connected to the remote system:
qcp se file1 file2,file3 x=file4
This causes the remote end to send the files to you; qtalk automatically starts qcp to
receive the file. The files sent are:
• file1
• file2 (file2 is received with the filename file3)
• all the files named in the index file file4.
You can create index files easily with the ls -p command.
To send a file to the remote system, type the following command into the remote shell:
qcp re
then use the Ctrl-A Ctrl-S key sequence to cause qtalk to send a file to the remote qcp
utility.
If you want qcp to send a file through an explicitly named device, use a command of
the form:
qcp /dev/ser1 se filename
where /dev/ser1 is the port to send through. To receive from a particular device, use
a command similar to:
qcp /dev/ser1 re
You can abort a qcp file transfer in progress by pressing either Esc or Space. In turn,
qcp displays a prompt asking for confirmation of the action. To confirm aborting qcp,
you enter y. If a remote qcp in a receive state must be shut down, the following
control-character sequence aborts it:

qcp © 2010, QNX Software Systems GmbH & Co. KG.
ˆVˆXˆX
Note that qcp automatically removes any partially transferred files.
When transferring files via high speed modems, the -s 16000 option is
recommended.
See also:
ls, qtalk

© 2010, QNX Software Systems GmbH & Co. KG. qde
Launch the QNX Integrated Development Environment (QNX)
Syntax:
qde [-consoleLog] [-data path] [-debug options_file]
[-nospash] [-refresh]
[-vmargs args]
Runs on:
Linux and Windows
Options:
-consoleLog Write error messages to the console.
-data path Set the IDE’s workspace to the path directory.
-debug options_file
Run QDE in debug mode, loading its options from options_file.
-nosplash Start QDE without displaying the splash screen.
-refresh Force a workspace refresh when QDE starts up.
-vmargs args Pass args unchanged to the Java VM on Windows and Linux. The
most common VM options are used to control the stack and heap
available to the VM.
• -Xmsheap_size — Set the initial Java heap size to heap_size.
• -Xmxheap_size — Set the maximum Java heap size to
heap_size.
• -Xssstack_size — Set the Java thread stack size to stack_size.
Under Windows, the default -vmargs are -Xms256m and
-Xmx512m.
The -vmargs option isn’t supported by qde on Neutrino.
Description:
On Linux and Windows development hosts, qde launches the QNX Momentics
Integrated Development Environment (IDE), a powerful set of tools based on the
Eclipse Platform. It integrates several QNX-specific plugins designed for building
projects for target systems running the QNX Neutrino RTOS.
For more information, please refer to the IDE User’s Guide.

qde © 2010, QNX Software Systems GmbH & Co. KG.
See also:
dumper, gcc, gcov, gdb, gprof, ld, make, mkefs, mkifs, mkimage, mkrec,
mksbp, objcopy, pdebug, qcc, qconfig, qconn, QWinCfg, strip,
tracelogger, usemsg

© 2010, QNX Software Systems GmbH & Co. KG. qed
QNX fullscreen Editor
Syntax:
qed [-br] [file [commands...]]
Runs on:
Neutrino
Options:
-b Browse only — don’t allow the user to write the file.
-r Restricted. Don’t give the user the ability to start a shell or run other
commands from the editor.
file The name of the file to edit. There’s no default; if the editor is started
without a file, one has to be specified within the editor before the text
may be saved.
commands A list of editor commands to execute on startup.
Description:
The qed utility is a fullscreen editor that’s been shipped with QNX since the early
days of the QNX 2 operating system. It has been ported to QNX Neutrino for the
convenience of the many people who have become accustomed to it. However, it’s no
longer the preferred editor in QNX Neutrino and its use is deprecated. The qed editor
is available only on the QNX OS, while other editors such as vi and emacs are more
universally available.
If you enter this editor by accident, the best way to get out is to press q Enter while the
cursor is on the top command line. Because it was designed for the console with full
PC keyboard capabilities, its use is more limited on terminals and many terminfo
entries don’t describe the capabilities it requires for such basic things as getting back
to its command line.
For more information on qed, you’ll find a complete HTML manual online.
This editor is provided “as is” and we don’t encourage you to use it.
Examples:
Edit the file myfile.c:
qed myfile.c
Edit the file myfile.c, moving to line 320 on startup:
qed myfile.c 320

qed © 2010, QNX Software Systems GmbH & Co. KG.
Files:
/usr/lib/ed.macros
The qed utility uses internal macros for most of its operations. These macros
are defined in this file.
/usr/lib/box.macros
This file contains a set of macros for box-drawing within qed using the PC
character set line-drawing characters. This file is optional and might not be
found on your system.
Exit status:
0 Success
See also:
ed, elvis, ped, vi

© 2010, QNX Software Systems GmbH & Co. KG. qtalk
Talk over a communications line
Syntax:
qtalk [options] [system]
Runs on:
Neutrino
Options:
-b [baud|data|parity|stop][,...]
Change the serial port to this baud, parity, stop bits, and/or data
bits. Values of 1-2 are interpreted as stop bits, 7-8 as data bits,
none, even, odd, mark and space as parity, all other numbers
as baud. Order isn’t significant e.g. -b 9600,8,n,1
-c hh Set this as the character that invokes qtalk commands. Default

is 01 (Ctrl-A).
-D delay Wait this many 1/20th sec periods before running the command
specified by the -x option.
The qtalk utility reads any data emitted by the modem during
this delay period and displays the data on your screen before the
command is started.
If you use -x without this option, qtalk doesn’t wait to start the
command. As a result, if the modem emits any information once
qtalk has emitted the dialing string, you have no way of
predicting whether qtalk or the command sees that
information.
-d hh Replace ASCII rubout with this character. Default is 7f.
-e Enable local echoing.
-h Hang up the current modem line if someone dials a new system

from within qtalk via the Ctrl-A command. By default, the
current modem device is closed but the line isn’t dropped.
-l logfile (“el”) Log a recording of the qtalk session in logfile.
-m modem[,init_string]
The name of the device to use. If you specify multiple -m
options, qtalk tries them, in order, until it finds a device that
isn’t in use.
If you specify an init_string, it’s emitted to the modem before
anything else.

qtalk © 2010, QNX Software Systems GmbH & Co. KG.
-o protocol=command
Redefine transfer-protocol options, where protocol is one of the
following:
This protocol: Does a:

qcp_se qcp send
qcp_re qcp receive
zmodem_se ZMODEM send
zmodem_re ZMODEM receive
other_se other send
other_re other receive
and where command is the command that performs the file

transfer. This command is run by the shell. The macro
$MODEM is set to the pathname of the modem device and, in
the case of a send, the macro $FILENAME is set to the
filename to be transmitted.
You can disable qtalk’s automatic invocation of a protocol by
setting command to a null string (""). For example, the
following disables automatic ZMODEM receive:
qtalk -o zmodem_re=""
For information on default protocol commands or for more
information on automatic invocation of protocols, see the section
on “Invoking qcp and ZMODEM automatically.”
The other protocol lets you configure qtalk to use your own
commands for sending and receiving files.
-P Ignore the parity bit of received characters.
-q Be quiet; suppress the banner and display only a minimal
prompt in command mode.
-s system_directory
Instead of $HOME/.qtalk, use this file to look up systems to
dial.
-t xfer_protocol Set the current transfer protocol to qcp, zmodem, or other. (To
change the command string that runs to perform the file transfer,
use -o.)
-x "command" Run this command after emitting the dialing string for the
named system (see also -D). When the command is run, the
MODEM environment variable is set to the pathname of the
selected modem device.

system The name of the system you want qtalk to call. The system
must be defined either in $HOME/.qtalk (or the file named
by -s) or in the system-wide dialing directory,
/etc/config/qtalk. For more information, see the
description of the d (dial system) command.
Description:
The qtalk utility lets QNX Neutrino users communicate with other computers via a
serial line that’s usually connected to a modem. The destination may be another host
computer, in which case qtalk lets you use your computer as a terminal. The qtalk
utility also lets two QNX Neutrino users communicate and transfer files.
The qtalk utility sends any characters you type on the keyboard to the other system
via the modem. Any characters received by the modem are displayed. In local echo
mode, typed characters are echoed on the display as well as being sent over the
modem.
Configuring default behavior

The qtalk utility lets you define new defaults for anything that you can specify with
command-line options. Define these settings by creating or modifying a system (in the
global and/or your personal dialing directory) called defaults. The first thing qtalk
does is to look up the defaults dialing entry and process it, before looking at any
command-line options. The qtalk utility looks for defaults first in
$HOME/.qtalk and, if not found there, then in /etc/config/qtalk. This allows
new system-wide defaults to be set by a system administrator, while leaving individual
users free to create their own default behavior for qtalk.
Command-line options defined in the defaults system are applied before the options
specified in the actual command line. Thus you can override the settings in your
defaults system with command-line options.
The -s command-line option doesn’t change how qtalk searches for the defaults
system.
Logging a session
You can log a recording of a qtalk session with the -l option:
qtalk -l /dev/par
or, if you want the log to go to the file /tmp/logfile:
qtalk -l /tmp/logfile

Using the command character

You can use a special command character to set special modes and options while
you’re within the qtalk environment. This special character defaults to Ctrl-A (Â)
unless you change it with the -c option when you invoke qtalk. When you enter the
command character, you’re shown some current settings and are prompted to enter a
command. If you enter the command character twice, a single command character is
echoed to the modem. This allows you to send the command character to the remote
system if you need to.
Replacing the rubout/delete character

You’ll find the -d hh option useful when communicating with computers that have a
rubout character different from the one you’re used to. Many systems use the
Backspace key (08 hex) to erase a character. QNX Neutrino systems default to the
ASCII rubout character (7F hex). If you type:
qtalk -d 08
qtalk translates your Rubout key into backspace automatically.
Enabling flow control

Using very high-speed modems, or producing a log on slow printers or floppy disks,
may cause some characters to be lost. To prevent characters from being lost in these
cases, you can enable input flow control prior to invoking qtalk (see stty). This
works only if the machine sending the data supports flow control of its output.
Transferring files
The qtalk utility lets you transfer files through either of two methods:
• You invoke the simpler method with the w (write) and l (log) commands to transfer
text files to or from another system. No error checking is performed, however, so
you should use this method only when communication lines are good (i.e. direct
connect lines or reliable modem connections), or when the other system doesn’t
support any of the file transfer methods available from qtalk.
To send a file to a host using write, you should first make the host capable of
receiving a stream of text. You could do this with an editor or the cat utility. You
can then use the write command to send the file.
To receive a file from a remote host using the l (log) command, first turn on logging
to the desired file (with the l command), then enter a command into the remote
system to make it display the file (e.g. cat filename on a UNIX-type system.)
• The second method, involves the s (send) and r (receive) commands, providing
access to more sophisticated protocols that include error checking and
retransmission when transferring files to other systems.

Invoking qcp and ZMODEM automatically

The qtalk utility attempts to detect qcp and zmodem file transfers when qtalk is on
the receiving end. If it detects one of these, qtalk automatically invokes the
appropriate receive command for the protocols being used. You can disable this
behavior; see the -o option.
When a qcp or zmodem transfer is detected, or when the receive command is given,
qtalk runs (through a shell) one of the protocol_re commands.
The corresponding protocol_se commands (to send a file) are invoked only when the
send command is given; never automatically.
Here are the default protocol commands:
qcp_re="qcp $MODEM re"

qcp_se="qcp $MODEM se $FILENAME"
zmodem_re="rz <$MODEM >$MODEM"
zmodem_se="sz $FILENAME <$MODEM >$MODEM"
other_re=""
other_se=""
You can’t automatically enable the other_re protocol. To invoke other_re or other_se,
choose send or receive from the command menu when the current file transfer
protocol has been set to other.
Interactive commands:
To specify any of the following commands, first press the command character (usually
Ctrl-A).
b (break) Send a break over the modem. You may also send breaks by
pressing the break key (Ctrl-Break on the console keyboard).
C (command character)
Change the command character. You’re prompted to enter the new
command character in hex (e.g. 0x02) or as ˆchar (e.g. ˆb).
c (change directory)
If you specify the c command, qtalk prompts you for a new
directory name, and attempts to move to that directory. If qtalk
moves successfully to the directory you specify, the directory
becomes the current working directory (see the pwd utility) for the
duration of qtalk, or until you change directory again. When
qtalk terminates, your current working directory reverts to the
directory you were in when qtalk was invoked.
d (dial system) If you specify the d command, qtalk prompts you to enter a
system name. It first looks for that name in your own dialing
directory ($HOME/.qtalk) and if it doesn’t find it there, it looks
in the system-wide dialing directory, /etc/config/qtalk.

If you enter a question mark (?) for the system name, the contents
of both dialing directories (if they exist) are displayed and you’re
prompted again for a system name. To abort the dialing command
and return to normal communications mode, press Enter without
entering a name.
Dialing is implemented by looking up the system name — which
can also be specified on the command line when qtalk is invoked
— first in your $HOME/.qtalk file, then in the
/etc/config/qtalk file. These files share the same format:
system_name [dialing_string]
[ <whitespace> command-line_options]
.
.
.
In these files, you must specify the system name at the very left of
the line with no whitespace before it. The dialing string is optional
(this string contains commands to be sent to the modem before
you’re given interactive control). If you specify a dialing string,
you must separate it from the system name by spaces or tabs, or
both.
In dialing strings, you can specify any of the following characters;
qtalk acts on these characters instead of sending them straight to
the modem:
| Send a carriage return.

˜ Delay for 1 second.
’ Delay for 100 milliseconds.
ˆ Drop DTR for 1 second (forces modem to hang up and
reset).
! End a 500-millisecond break.
\o Emit a single character represented by o, where o is an
octal number of up to three digits.
\xhh Same as above, but specified in hex.
Additional lines beneath the line that defines the system name and
dialing string may contain additional qtalk command-line
options to apply when talking to this system.
If you specify these additional lines, begin each one with at least
one tab or space character. Note that a single command-line option
can’t span multiple lines. You can, however, place just one option
per line.
D (delete character)
Change the delete character. You’re prompted to enter the new
delete character in hex (e.g. 0x08) or as ˆchar (e.g. ˆh).

e (echo) If you specify the e command, the local echo feature is toggled.
Some systems expect the “terminal” to perform local echoing (half
duplex).
h (hang up) If you specify the h command, the CTS/RTS lines are lowered for
approximately 1/2 a second. This permits modems that support
hardware hangup to do so.
l (log) Begin or end logging of this session. If no log file is open, qtalk
asks for the name of a file to log into. If logging is already in
progress, it’s terminated and the log file is closed. The l command
records every character that is sent or received in the log file.
You can use l to take “snapshots” of data from a host computer at
slow speed.
o (modify protocol options)
Prompts you for the protocol whose command string you wish to
change (qcp, ZMODEM, other). The current send and receive
command strings are displayed and you’re then prompted to enter
a new command string. To set a string to null, use "". If you don’t
want to make any changes, press Enter.
p (parity) Ignore parity (top bit) of received characters. If this option is

already set, turn it off.
q (quit with hangup)
This executes a hangup command (see h above), then causes
qtalk to exit.
r (invoke a receive)
Invoke the currently selected file transfer protocol to receive a file.
Note that qtalk automatically invokes qcp and ZMODEM if it
recognizes a received startup sequence of one of these protocols.
s (send a file) Send a file, using the currently selected file transfer protocol. This
sends a file to another system running the same protocol, which is
more secure than simply writing the file to the modem.
When the currently selected protocol is qcp, you can send more
than one file by specifying the x=index_file option when qtalk
asks for the file to send. This file contains a list of files to send, one
per line. You can also specify more than one filename, separated
by spaces.
The qcp utility lets you follow the name of the file to send with the
name of the destination file. Separate the two filenames with a
comma. This is also true for filenames within an index file (option
x=). For example:
Send file(s)? file1 main.c,new_main.c

sends the file file1 as file1 and the file main.c with the name
new_main.c. If you don’t specify a new name, qtalk creates a
file with the same name as the file that is sent.
Files received by qtalk using the qcp protocol have the same
attributes and date as the file on the sending machine.
Most transfer protocols require that the modem port be configured
for 8-bit data (Use the -b option to set the serial port to 8 data bits;
also see the stty command).
t (select transfer protocol)
Shows you which protocol is being used (e.g. qcp, ZMODEM)
and asks you to select a new one. If you press Enter, no changes
are made. This command controls the protocol used when you use
the send and receive commands from the command menu.
x (exit) Exit from qtalk without performing a hangup. It’s good practice
to use the q (quit with hangup) command for leaving qtalk,
unless you really don’t want to perform a hangup.
! (execute a shell command)

This command lets you execute any command from within qtalk.
You’ll probably find that you’ll use the ! command often to:
• Execute the ls command in order to see what files are in your
current directory prior to sending some of them.
• Execute nonnative file transfer protocols (such as XMODEM or
Kermit) from within qtalk if you don’t want to bother setting
the other protocol to the desired commands.
Examples:
Call the system named home:
qtalk home
Communicate with a machine that doesn’t echo (half duplex) and expects an ASCII
backspace (08 hex) to delete characters:
qtalk -e -d 08
Communicate with another system and print a hardcopy record:
qtalk -l /dev/par
Use the qcp -n option for qcp receives (i.e. receive only files that are newer than
existing files):
qtalk -o qcp_re="qcp $MODEM re -n"

See also:
devc-con, qcp, stty

QWinCfg © 2010, QNX Software Systems GmbH & Co. KG.
Query and display QNX installations and configurations
Syntax:
QWinCfg
Runs on:
Microsoft Windows
Options:
None.
Description:
QWinCfg is a graphical application that you can use in Microsoft Windows to set or
query the QNX configuration files. It supports the coexistence of multiple versions of
Neutrino on one machine.
QWinCfg is a graphical front end for qconfig that exists only on Windows. On other
hosts, use qconfig.
To launch this application, choose QNX Momentics 6.3.0→Configuration from the

Start menu.
Whenever you install a version of Neutrino, a configuration file is stored in a directory
that depends on the host OS. Each configuration file defines the name of the
installation and its base, host, and target directories.
QWinCfg spawns qconfig to populate its list of available installations and lets you
select one of them. You can also specify custom locations for the host and target files.
When you click OK, QWinCfg sets the QNX_HOST, QNX_TARGET, and
MAKEFLAGS environment variables and modifies the PATH appropriately. This
utility sets these values in the registry, so they become the global defaults. QWinCfg
overwrites these variables, so this utility destroys any changes that you might have
previously made to them manually.
If you select a 6.2.1 installation, QWinCfg clears MAKEFLAGS and adds
$QNX_HOST/usr/bin/cygwin_dll to the path.
QWinCfg sets MAKEFLAGS to be a path that’s relative to the target files (e.g.
$QNX_TARGET/usr/include). QWinCfg removes from PATH any elements for the
previously selected version of QNX Momentics and adds elements for the currently
selected version. These entries are relative to the new host file location (e.g.
$QNX_HOST/usr/bin).
Path separators for MAKEFLAGS are converted to forward slashes; for PATH,
they’re converted to backslashes. The separators in QNX_HOST and
QNX_TARGET aren’t changed.

© 2010, QNX Software Systems GmbH & Co. KG. QWinCfg
Click the Show Packages.. button to display a list of the QNX packages that you’ve
installed on your system.
QNX_CONFIGURATION
The name of the directory that stores the configuration files.
See also:
qbinaudit, qconfig, showlicense, sysinfo
Controlling How Neutrino Starts and Configuring Your Environment in the Neutrino
User’s Guide

racoon © 2010, QNX Software Systems GmbH & Co. KG.
IKE (ISAKMP/Oakley) key management daemon
Syntax:
racoon [-BdFv46] [-f configfile] [-l logfile] [-p isakmp-port]
Runs on:
Options:
-4 or -6 Specifies the default address family for the sockets.
-B Install security association(s) from the file that is specified in

/etc/racoon/racoon.conf.
-d Increase the debug level. Each additional d increases the debug

level.
-F Run racoon in the foreground.
-f configfile Use configfile as the configuration file instead of the default. The
default configuration file is /etc/racoon/racoon.conf.
-l logfile Use logfile as the logging file instead of syslogd.
-p isakmp-port Listen to ISAKMP key exchange on port isakmp-port instead of

the default port number, 500.
-v Specifying this option causes the packet dump to be more verbose,

with a higher debugging level.
Description:
The racoon daemon speaks IKE (ISAKMP/Oakley) key management protocol, to
establish security association with other hosts. The SPD (Security Policy Database) in
the kernel usually triggers to start racoon.
Because of encryption export laws, racoon isn’t provided in regular OS bundles.

QNX Software Systems must report to the US government, identifying customers who
have access to the encryption technology contained in the racoon daemon. If you
wish to have access to this binary, you must contact your QNX sales representative,
who can provide download access once approved.
Examples:
For examples showing how to configure racoon directives and statements, see
/etc/racoon.conf.

© 2010, QNX Software Systems GmbH & Co. KG. racoon
Files:
/etc/racoon/racoon.conf
Default configuration file for racoon
Exit status:
0 Success.
OpenSSL Project
License:
This utility is based on OpenSSL Project software; for licensing information, see the
Third Party License Terms List at
See also:
/etc/racoon.conf, setkey, syslogd, /etc/syslog.conf
IPsec protocol in the Library Reference

/etc/racoon.conf © 2010, QNX Software Systems GmbH & Co. KG.
Configuration file for racoon
Name:
/etc/racoon.conf
Description:
This file is the configuration file for the racoon ISAKMP daemon. This daemon
negotiates security associations for itself (ISAKMP SA, or phase 1 SA) and for kernel
IPsec (IPsec SA, or phase 2 SA). The file consists of a sequence of directives and
statements. Statements are enclosed by braces ({}). Lines beginning with # are
comments.
The major parameters are listed below.
number A hexadecimal (prefixed with 0x) or decimal number.
string, path, file Any string enclosed in double quotes (e.g. "string").
address IPv6 and/or IPv4 address.
port A TCP/UDP port number.
timeunit One of the following:

• sec
• secs
• second
• seconds
• min
• mins
• minute
• minutes
• hour
• hours
Path Specification
The following path specfications are allowed:
path include path

Specifies a path to include a file, see File Inclusion, below.
path pre_shared_key file

Specifies a file containing pre-shared key(s) for various ID(s), see Pre-shared
key File, below.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/racoon.conf
path certificate path

The racoon daemon will search this directory if a certificate or certificate
request is received.
path backupsa file
Specifies a file to store SA information that is negotiated by racoon. If you
specify the -B option when you start racoon, the daemon will install SA(s)
from this file.
Make sure you remove redundant data from this file to keep it to a reasonable size
because racoon simply adds SAs (you have to do this manually).
File Inclusion
include file Other configuration files can be included.
Identifier Specification
This is obsolete; it must be defined at each remote directive.
Timer Specification
timer {statements...}
Specifies various timer values, you can use statements such as:
counter number The maximum number of retries to send. The default is 5.

interval number timeunit
The interval to resend, in seconds. The default time is 10
seconds.
persend number The number of packets per send. The default is 1.
phase1 number timeunit
The maximum time it should take to complete phase 1. The
default time is 15 seconds.
phase2 number timeunit
The maximum time it should take to complete phase 2. The
default time is 10 seconds.
Listening Port Specification

listen { statements }
If you don’t specify this directive, racoon will listen on all of the available
interface addresses. Here are the valid statements:
isakmp address [port]
Tells racoon to listen only on address. The default port is
500 (specified by IANA). You can provide more than one
address definition.

strict_address Require that all addresses for ISAKMP must be bound.

This statement will be ignored if you do not specify any
addresses.
Remote Nodes Specifications

remote (address | anonymous) [port] { statements }
Specifies the parameters for IKE phase 1 for each remote node. The default port
is 500. If anonymous is specified, the statements apply to all peers that do not
match any other remote directive.
These are the valid statements:
exchange_mode (main | aggressive | base) Ic0

Defines the exchange mode for phase 1 when racoon is
the initiator. Also it means the acceptable exchange mode
when racoon is responder. More than one mode can be
specified by separating them with a comma. All of the
modes are acceptable. The first exchange mode is what
racoon uses when it is the initiator.
doi ipsec_doi Use IPSEC-DOI as specified RFC 2407. You can omit this
statement.
situation identity_only
Use SIT_IDENTITY_ONLY as specified RFC 2407. You
can omit this statement.
identifier idtype This statement is obsolete. Instead, use my_identifier.
my_identifier idtype ...
Specifies the identifier sent to the remote host and the
type to use in the phase 1 negotiation. address, fqdn,
user_fqdn, keyid and asn1dn can be used as an
idtype. They are used like this:
my_identifier address [address]
The type is the IP address. This is the default type if
you do not specify an identifier to use.
my_identifier user_fqdn string
The type is a USER_FQDN (user fully-qualified
domain name).
my_identifier fqdn string
The type is a FQDN (fully-qualified domain name).
my_identifier keyid file
The type is a KEY_ID.
my_identifier asn1dn [string]
The type is an ASN.1 distinguished name. If string
is omitted, racoon will get DN from the Subject
field in the certificate.

peers_identifier idtype ...

This statement specifies the peer’s identifier to be
received. If it is not defined then racoon will not verify
the peer’s identifier in ID payload transmitted from the
peer. If it is defined, the behavior of the verification
depends on the flag of verify_identifier. The usage
of idtype is the same as in my_identifier.
verify_identifier (on | off)
If you want to verify the peer’s identifier, set this to on. In
this case, if the value defined by peers_identifier is
not the same as the peer’s identifier in the ID payload, the
negotiation will fail. The default is off.
certificate_type certspec
This specifies a certificate specification. The certspec
variable is constructed like this:
x509 certfile privkeyfile
Where certfile is the file name of the certificate and
privkeyfile is the file name of the secret key.
peers_certfile (dnssec | certfile)
If dnssec is defined, racoon will ignore the CERT
payload from the peer, and try to get the peer’s certificate
from DNS instead. If certfile is defined, racoon will
ignore the CERT payload from the peer, and will use this
certificate as the peer’s certificate.
send_cert (on | off)
If you do not want to send a certificate for some reason,
set this to off. The default is on.
send_cr (on | off)
If you do not want to send a certificate request for some
reason, set this to off. The default is on.
verify_cert (on | off)
If you do not want to verify the peer’s certificate for some
reason, set this to off. The default is on.
lifetime time number timeunit
Define a lifetime which will be proposed in the phase 1
negotiations. Any proposal will be accepted, and
attributes will be not proposed to the peer unless you
specify them. They can be individually specified in each
proposal.
initial_contact (on | off)
Enable this to send an INITIAL-CONTACT message. The
default value is on.

passive (on | off)

If you do not want to initiate the negotiation, set this to
on. The default value is off. This is useful for a server.
proposal_check level
Specifies the action of lifetime length and PFS of the
phase 2 selection on the responder side. The default level
is strict. Here are the acceptable values for level:
obey The responder will obey the initiator anytime.
strict If the responder’s length is longer than the
initiator’s one, the responder uses the initiator’s
one; otherwise, it rejects the proposal. If PFS is
not required by the responder, the responder
will obey the proposal. If PFS is required by
both sides, and if the responder’s group is not
equal to the initiator’s one, the responder will
reject the proposal.
claim If the responder’s length is longer than the
initiator’s one, the responder will use the
initiator’s one. If the responder’s length is
shorter than the initiator’s one, the responder
uses its own length AND sends a
RESPONDER-LIFETIME notify message to an
initiator in the case of lifetime. About PFS, this
directive is same as strict.
exact If the initiator’s length is not equal to the
responder’s one, the responder will reject the
proposal. If PFS is required by both sides and if
the responder’s group is not equal to the
initiator’s one, the responder will reject the
proposal.
support_mip6 (on | off)
If this value is set on, both values of ID payloads in phase
2 exchange are always used as the addresses of end-point
of IPsec-SAs. The default is off.
generate_policy (on | off)
This directive is for the responder. Therefore you should
set passive on in order that racoon only becomes a
responder. If the responder does not have any policy in
SPD during phase 2 negotiation, and the directive is set
on, then racoon will choose the first proposal in the SA
payload from the initiator, and generate policy entries
from the proposal. It is useful to negotiate with the client
which is allocated IP address dynamically.
Note that inappropriate policy might be installed by the
initiator because the responder just installs policies as the

initiator proposes. So that other communication might fail

if such policies installed. This directive is ignored in the
initiator case. The default value is off.
nonce_size number
Define the byte size of nonce value. The racoon daemon
can send any value, although RFC2409 specifies that the
value MUST be between 8 and 256 bytes. The default
size is 16 bytes.
proposal { sub-substatements }
The substatements are as follows:
encryption_algorithm algorithm;
Specify the encryption algorithm used for the phase 1
negotiation. This directive must be defined. The
algorithm variable for oakley is one of following:
• des
• 3des
• blowfish
• cast128
This statement should not be used for other transforms.
hash_algorithm algorithm
Define the hash algorithm used for the phase 1
negotiation. This directive must be defined. The
algorithm variable for oakley is md5 or sha1.
authentication_method type
Defines the authentication method used for the phase 1
negotiation. This directive must be defined. The type
variable is one of:
• pre_shared_key
• rsasig
• gssapi_krb
dh_group group Define the group used for the Diffie-Hellman
exponentiations. This directive must be defined. The
group variable is one of following:
• modp768
• modp1024
• modp1536
Or you can define 1, 2, or 5 as the DH group number.
When you want to use aggressive mode, you must define
the same DH group in each proposal.
Define the lifetime of the phase 1 SA proposal. Refer to
the description of lifetime directive immediately defined
in the remote directive.

gssapi_id string Define the GSS-API endpoint name, to be included as an

attribute in the SA, if the gssapi_krb authentication
method is used. If this is not defined, the default value of
“ike/hostname” is used, where hostname is the FQDN of
the interface being used.
Policy Specifications
The policy directive is obsolete, policies are now in the SPD. The racoon daemon
will obey the policy configured into the kernel by setkey, and will construct phase 2
proposals by combining sainfo specifications in /etc/racoon.conf, and policies
in the kernel.
Sainfo Specifications
sainfo (source_id destination_id | anonymous) { statements }
Defines the parameters of the IKE phase 2 (IPSec-SA establishment). The
source_id and destination_id variables are constructed like this:
address address [/ prefix] [ port ] ul_proto or idtype string

Means exactly the content of ID payload. This is not like
a filter rule. For example, if you define
3ffe:501:4819::/48 as source_id,
3ffe:501:4819:1000:/64 will not match.
pfs_group group Define the group of Diffie-Hellman exponentiations. If
you do not require PFS, you can omit this directive. Any
proposal will be accepted if you do not specify one. The
group variable is one of following:
• modp768
• modp1024
• modp1536
Or you can define 1, 2, or 5 as the DH group number.
Define the amount of time to be used for IPsec-SA. Any
proposal will be accepted, and no unspecifed attributes
will be proposed to the peer. For more informantion, see
the proposal_check directive.
identifier idtype This is obsolete, use my_identifier directives instead.
my_identifier idtype ...
Specifies the ID type to use for the phase 2 negotiation.
The default is address described in the my_identifier
directive in remote. This is always for the initiator, not
the responder; as the responder, the racoon daemon can
handle only the IP address type.
The racoon daemon does not have the list of security
protocols to be negotiated. This list is passed by SPD in

the kernel. Therefore, you have to define all of the

potential algorithms in the phase 2 proposals, even if
there is a algorithm which will not be used. These
algorithms are defined by using the following three
directives with a single comma as the separator.
For algorithms that can take variable-length keys,
algorithm names can be followed by a key length, like
blowfish 448. The racoon daemon will compute the
actual phase 2 proposals by computing the permutation of
the specified algorithms, and then combining them with
the security protocol specified by the SPD. For example,
if des, 3des, hmac_md5, and hmac_sha1 are specified
as algorithms, we have four combinations for use with
ESP, and two for AH. Then, based on the SPD settings,
racoon will construct the actual proposals. If the SPD
entry asks for ESP only, there will be 4 proposals. If it
asks for both AH and ESP, there will be 8 proposals.
The kernel may not support the algorithm you have specified.
encryption_algorithm algorithms
Where algorithms may be:
• des
• 3des
• des_iv64
• des_iv32
• cast128
• blowfish
• null_enc
• rijndael (used with ESP)
authentication_algorithm algorithms
• des
• 3des
• des_iv64
• des_iv32
• hmac_md5
• hmac_sha1
• non_auth(used with ESP authentication and AH)
compression_algorithm algorithms
• deflate (used with IPComp)

Logging level
log level Define logging level. The level variable is one of the following:
• notify (default)
• debug
• debug2
If you put too high a logging level on slower machines, IKE negotiation
can fail due to timing constraint changes.
Specifying the way to pad

padding { statements }
The specified padding format. The following are valid statements:
randomize (on | off)

Enable using a randomized value for padding. The default is on.
randomize_length (on | off)
The pad length is random. The default is off.
maximum_length number
Define a maximum padding length. If randomize_length is off, this is
ignored. The default is 20 bytes.
exclusive_tail (on | off)
This puts the number of pad bytes minus one into the last part of the
padding. The default is on.
strict_check (on | off)
This constrains the peer to set the number of pad bytes. The default is off.
Special directives
complex_bundle (on | off)
Defines the interpretation of proposal in the case of SA bundle. Normally “IP
AH ESP IP payload” is proposed as “AH tunnel and ESP tunnel”. The
interpretation is more common to other IKE implementations, however, it allows
a very limited set of combinations for proposals. With the option enabled, it will
be proposed as “AH transport and ESP tunnel”. The default value is off.
Pre-shared key File

Pre-shared key file defines a pair of the identifier and the shared secret key
which are used at Pre-shared key authentication method in phase 1. The pair in each
lines are separated by some number of blanks and/or tab characters (as in
/etc/hosts). The key can include blanks because all of the words after the 2nd
column are interpreted as a secret key.
Lines starting with # are ignored. Keys which start with 0x are hexadecimal strings.

The file must be owned by the user ID running racoon (usually the privileged user),
and must not be accessible by others.
Examples:
The following example shows how the remote directive should be configured:
path pre_shared_key "/usr/local/v6/etc/psk.txt" ;

remote anonymous
{
exchange_mode aggressive,main,base;
lifetime time 24 hour;
proposal {
encryption_algorithm 3des;
hash_algorithm sha1;
authentication_method pre_shared_key;
dh_group 2;
}
}
sainfo anonymous
{
pfs_group 2;
lifetime time 12 hour ;
encryption_algorithm 3des, blowfish 448, rijndael ;
authentication_algorithm hmac_sha1, hmac_md5 ;
compression_algorithm deflate ;
}
The following is a sample of the file defined pre-shared key:
10.160.94.3 mekmitasdigoat
172.16.1.133 0x12345678
194.100.55.1 whatcertificatereally
3ffe:501:410:ffff:200:86ff:fe05:80fa mekmitasdigoat
3ffe:501:410:ffff:210:4bff:fea2:8baa mekmitasdigoat
foo@kame.net mekmitasdigoat
foo.kame.net hoge
Caveats:
The racoon daemon may not yet be able to handle some of the statements described
in this document.
See also:
racoon, setkey

random © 2010, QNX Software Systems GmbH & Co. KG.
Source of secure random data
You must be root to start this service.
Syntax:
random [options]
Runs on:
Neutrino
Options:
-h Show the usage message.
-i# Use interrupt number # as a source for collecting random data. You may
specify more than one interrupt, to a maximum of 32.
-p Poll system information from /proc for random data.
-t Use the high-performance clock as a random data source.
Description:
The random service runs in the background providing a source of secure, random data
suitable for encryption and security. The service builds its internal pool of random
data from sources specified when it is started. These sources may include timers,
interrupts, and detailed system runtime information. The service makes this random
data available by providing device entries that any application can read:
/dev/random A source of high-quality random numbers.
/dev/urandom An unlocked random source that reuses the internal pool to

produce more pseudo-random bits. This means that the call won’t
block, but the output may contain less entropy than a
corresponding read from /dev/random.
The user controls all of the sources to be used to collect random data by specifying
source options on the command line.
Using interrupts as sources imposes an overhead on system performance. When using

the i option, you might want to minimize the impact of this overhead by specifying
only one or two interrupts from low interrupt rate devices such as disk drivers and
input/serial devices.

© 2010, QNX Software Systems GmbH & Co. KG. random
Examples:
Start the random service using three PC interrupts as sources:
random -i12 -i14 -i15
From an application, read 4 bytes of random data like this:
int data;
int fd;
fd = open( "/dev/random", O_RDWR );

if( fd == -1 )
exit( 1 );
read( fd, &data, sizeof( data ) );
close( fd );
Exit status:
0 The random data is available from /dev/random and
/dev/urandom.
Any other value An error occurred; /dev/random and /dev/urandom aren’t

created.
Errors:
If an error occurs, random sends a description of the error to slogger and doesn’t
create /dev/random or /dev/urandom.
The random service uses the core algorithm from the copyright-free Yarrow
pseudo-random number generator (PRNG) from Counterpane Security
(http://www.counterpane.com/yarrow.html). Bruce Schneier and John
Kelsey designed the Yarrow PRNG.
Caveats:
The random service will not work unless you specify at least one source of random
data (options -p, -t, or -i).

ranlib © 2010, QNX Software Systems GmbH & Co. KG.
Index an archive
Syntax:
ranlib_variant [-t] [-v|-V|--version] archive
Runs on:
Options:
The ranlib_variant depends on the target platform, as follows:
Target platform: ranlib_variant:

ARM ntoarm-ranlib
MIPS ntomips-ranlib
PowerPC ntoppc-ranlib
SH4 ntosh-ranlib
x86 ntox86-ranlib
Description:
The ranlib utility generates an index to the contents of an archive and stores it in the
archive. The index lists each symbol defined by a member of an archive that is a
relocatable object file.
GNU
See also:
ar, nm

© 2010, QNX Software Systems GmbH & Co. KG. rcp
Remote file copy
Syntax:
rcp [-p] source_file target_file
rcp [-p] [-r] source_file... target_dir
Runs on:
Neutrino
Options:
-p Attempt to preserve (duplicate) the modification time and file mode of
each source file in its corresponding target file, ignoring the umask.
By default, the mode and owner of the target file are preserved if the
target file already exists; otherwise the mode of the source file
modified by the umask on the destination host is used.
-r If any of the source files are directories, copy each subtree rooted at
that name; in this case, the destination must be a directory.
source_file The pathname of a file to be copied.
target_file The pathname to which a single file is copied.
target_dir The pathname of an existing directory that’s to contain the output

file(s).
Description:
The rcp utility copies files between machines. Each file or directory argument is
either of the following:
• a remote filename of the form rname@rhost:path
• a local filename that has no “:” characters, or that has a “/” before any “:”
If the specified path isn’t a full pathname, it’s interpreted relative to the login directory
of the specified user ruser on rhost, or of your current username if no other remote
username (rname) is specified. A path on a remote host may be quoted (using \, ", or
’) so that the metacharacters are interpreted remotely.
The rcp utility doesn’t prompt for passwords; it performs remote execution via rsh,
and requires the same authorization.
The rcp utility handles third-party copies, where neither source nor target files are on
the current machine.

rcp © 2010, QNX Software Systems GmbH & Co. KG.
Files:
The rcp utility requires the libsocket.so shared library.
Caveats:
The rcp utility doesn’t always detect that the target of a copy is a file in cases where
only a directory should be legal. It’s also confused by any output generated by
commands in a .login or .profile file on the remote host.
See also:
cp, ftp, /etc/hosts.equiv, ˜/.rhosts, rlogin, rlogind, rsh

© 2010, QNX Software Systems GmbH & Co. KG. readelf
Display information about an ELF binary
Syntax:
readelf [options] elffile...
Runs on:
Options:
See the GNU website at http://www.gnu.org/.
Description:
The readelf utility displays information about one or more ELF format object files.
GNU
See also:
objdump

renice © 2010, QNX Software Systems GmbH & Co. KG.
Adjust the priorities of running processes (POSIX)
Syntax:
renice prioritylevel [-g pgrp...]
[-p pid...] [-u user...]
Runs on:
Neutrino
Options:
-g pgrp Renice processes in this process group.
-p pid Renice this process.
-u user Renice processes owned by this user.
prioritylevel The amount to adjust the priority by. Positive numbers lower the
priority by that many full priority levels, while negative numbers
raise the priority.
Description:
The renice utility adjusts the priority of all the threads in one or more running
processes. The specified prioritylevel is subtracted from the current priority of each
selected process.
If you enter a: renice:

Positive value (e.g. 2 or +2) Lowers the priority of a process, making
it “nicer” to other processes
Negative value (e.g. -2) Raises the priority of a process, making
it “meaner” to other processes
You can adjust the priority as follows:
If you’re: You can change to any priority:

A non-root user From 1 to 63
root From 1 to 255
If you don’t have the appropriate privileges, you can renice only the processes you
own. You can change the range of privileged priorities with the -P option for
procnto.

© 2010, QNX Software Systems GmbH & Co. KG. renice
Examples:
Lower the priority of process 768 by 2:
renice 2 -p 768
Exit status:
See also:
nice, slay

/etc/resolv.conf © 2010, QNX Software Systems GmbH & Co. KG.
Resolver configuration file
Name:
/etc/resolv.conf
Description:
The resolver library routines provide access to the Internet Domain Name System
(DNS). When these routines are first invoked by a process, they read information
contained in the resolver configuration file. This file contains a list of keywords with
user-specified values that provide various types of resolver information.
This file is optional. If it isn’t present:
• the resolver library routines look in /etc/hosts only to resolve the hostname
• the domain name is determined from the hostname
• the domain search path is constructed from the domain name.
Overriding /etc/resolv.conf
You can use the following confstr() configuration strings to override the data contained
in /etc/resolv.conf:
_CS_DOMAIN The domain name, without any keyword. For example:

my.domain
_CS_RESOLVE The contents of the resolv.conf file, except that the

configuration string:
• doesn’t include the domain name
• can’t include spaces; separate the keywords by underscores.
For example:
nameserver_209.226.137.53
The netmanager utility modifies the _CS_RESOLVE

configuration string.
The socket library uses the following search order to locate the resolver data:
1 confstr() configuration strings
2 resolv.conf.hostname
3 resolv.conf
Utilities such as dhcp.client and pppd can optionally set the configuration strings.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/resolv.conf
Keywords
The keyword and its associated value must appear on a single line. The line must start
with the keyword (e.g. nameserver) followed by whitespace and the value.
The domain and search keywords are mutually exclusive. If more than one instance
of these keywords is present, the last instance overrides any others.
nameserver
The Internet address (in dot notation) of a name server that the resolver should query.
Up to MAXNS (currently 3) name servers may be listed, one per keyword. If multiple
server entries are present, the resolver library queries them in the order listed. If no
server entries are present, the default is to use the name server on the local machine.
(The algorithm used is to try a name server, and if the query times out, try the next,
until out of name servers, then repeat trying all the name servers until a maximum
number of retries are made).
domain
The local domain. Most queries for names within this domain can use short names
relative to the local domain. If no domain entry is present, the domain is determined
from the local hostname returned by gethostname(); the domain part is taken to be
everything after the first dot. If the hostname doesn’t contain a domain part, the root
domain is assumed.
search
The search list used for looking up hostnames. The search list is normally determined
from the local domain name. By default, it begins with the local domain name, then
with successive parent domains that have at least two components in their names.
You can override the default list by specifying the desired domain search path and by
following the search keyword with the names. Most resolver queries are attempted
using each component of the search path in turn until a match is found.
This process may be slow and generates a lot of network traffic if the servers for the
listed domains aren’t local. Queries time out if no server is available for one of the
domains.
The search list is currently limited to six domains with a total of 256 characters.
nocache
By default, the resolv.conf data is parsed at application startup only. It is not
checked again. Specifying “nocache on” will cause the resolv.conf data to be
parsed at every lookup. If you wish to invalidate the cache at a specific time, it would
be better to call res_init() directly, or turn off the _res.options flag RES_INIT.

/etc/resolv.conf © 2010, QNX Software Systems GmbH & Co. KG.
See also:
/etc/hosts, netmanager, /etc/nsswitch.conf
dn_comp(), dn_expand(), gethostname(), res_init(), res_mkquery(), res_query(),
res_search(), res_send() in the Library Reference
TCP/IP Network Administration
1-56592-010-4)

© 2010, QNX Software Systems GmbH & Co. KG. ˜/.rhosts
Individual users’ list of trusted remote users
Name:
˜/.rhosts
Description:
The ˜/.rhosts and /etc/hosts.equiv files provide the “remote authentication”
database for the rcp, rlogin, and rsh commands and the rcmd() function. These
files bypass the standard password-based user authentication mechanism. They
specify remote hosts and users that are considered trusted (i.e. are allowed to access
the local system without supplying a password):
• on a system-wide basis (/etc/hosts.equiv)
• by an individual user (˜/.rhosts).
ignored:
The ruserok() function sets the effective userid to that of the remote user, but doesn’t
change the effective group ID. The user must have search permissions for the
directories contained in the pathname of an .rhosts file (i.e. if the file resides in
/home/user/.rhosts, the user must have search permissions for /home/user/).
The library routine ruserok() (see also rcmd()) performs the remote authentication. It
determines whether a particular remote user from a particular remote host is allowed
to access the local system as a (possibly different) particular local user:
• For non-root users, this routine checks /etc/hosts.equiv, and then the
.rhosts file in the home directory of the local user attempting access.
• For root, access is handled as a special case to help maintain system security; only
root’s .rhosts file is checked.
The rlogind daemon doesn’t allow root to log in without a password. When rsh is
specified without command options, rlogind (not rshd) is invoked on the remote
side.
If the remote authentication fails, rcp and rsh fail, but rlogin falls back to the
standard password-based login procedure.
Both files are formatted as a list of one-line entries of the form:
hostname [username]

˜/.rhosts © 2010, QNX Software Systems GmbH & Co. KG.
where hostname must be the fully qualified domain name (FQDN) of the host, not one
of its aliases.
The entries in these files are either positive, to explicitly allow access without a
password, or negative, to deny it. Authentication succeeds as soon as a matching
positive entry is found, but fails when a matching negative entry is found, or if no
matching entries are found in either file. Therefore, the order of entries is important: if
the files contain both matching positive and negative entries, the entry that appears
first prevails.
Positive entries
Positive entries take these forms:
hostname All users from the named host are trusted and may access the system
with the same user name as they have on the remote system. You can
use this form in both /etc/hosts.equiv and individual users’
.rhosts files.
hostname username
The meaning of this form depends on which file it’s in:
• .rhosts file in a local user’s home directory — the named user
from the named host can access the system as that local user.
• /etc/hosts.equiv — the named remote user can access the
system as any local user.
You can use the special character “+” as a wild card in place of either hostname or
username to match any host or user:
+ Any user from any remote host can access the system, with the same
username.
+ username The named user from any remote host can access the system.
hostname + Any user from the named host can access the system as the local user.
Negative entries
Negative entries have a “-” character preceding either the hostname or username field.
For example:
hostname -username
Deny access to the named user if they attempt to access your system from the
named host without providing a password.

© 2010, QNX Software Systems GmbH & Co. KG. ˜/.rhosts
Caveats:
Use extreme caution in /etc/hosts.equiv with positive entries that include a
username field (either an individual named user, a netgroup, or “+” sign). Because
/etc/hosts.equiv applies system-wide, these entries allow one or a group of
remote users to access the system as any local user without providing a password. This
can be a security hole.
ignored:
See also:
/etc/hosts, /etc/hosts.equiv, rcp, rlogin, rlogind, rsh
rcmd() in the Library Reference

rlogin © 2010, QNX Software Systems GmbH & Co. KG.
Remote login
Syntax:
rlogin [-8dE] [-e char] [-l username] host
Runs on:
Neutrino
Options:
-8 Allow an eight-bit input data path at all times. Without this option,
parity bits are stripped whenever the remote side’s stop and start
characters are ˆS and ˆQ.
-d Turn on socket debugging on the TCP sockets used for

communication with the remote host. See setsockopt().
-E Stop any character from being recognized as an escape character.

When used with -8, this provides a completely transparent
connection.
-e char Use the specified character as the escape character (default is ˜).
You can specify this as a literal character or as an octal value in the
form \nnn.
-l username Log in with this user ID instead of the current one.
host The official name, an alias, or the Internet address of a remote host.
Description:
The rlogin utility starts a terminal session on the specified remote host. To validate
the login ID, rlogin uses the standard Berkeley rhosts authorization mechanism.
Once you’re connected, typing:
escape_char .
disconnects you from the remote host. By default, the tilde (˜) character is the escape
character.
All echoing takes place at the remote site, so that (except for delays) the rlogin is
transparent. Flow control via ˆS and ˆQ and flushing of input and output on interrupts
are handled properly.

© 2010, QNX Software Systems GmbH & Co. KG. rlogin
Files:
The rlogin utility requires the libsocket.so shared library.
TERM Determines the user’s terminal type.
See also:
/etc/hosts.equiv, rcp, ˜/.rhosts, rlogind, rsh

rlogind © 2010, QNX Software Systems GmbH & Co. KG.
Remote login daemon
Syntax:
rlogind [-aln]
Runs on:
Neutrino
Options:
-a Ask hostname for verification.
-l Prevent any authentication based on the user’s .rhosts file, unless the user is
logging in as the superuser.
-n Disable keepalive messages.
Description:
The rlogind daemon is the server for the rlogin utility. The daemon provides a
remote login facility with authentication based on privileged port numbers from
trusted hosts.
The rlogind daemon is started when inetd receives a service request at the port
indicated by the login entry (inetd listens for service requests specified in the
inetd.conf file at a port defined in the services file). The following protocol is
initiated:
1 The server checks the client’s source port. If the port isn’t in the range
512-1023, the server aborts the connection.
2 The server checks the client’s source address and requests the corresponding
hostname (see gethostbyaddr(), the /etc/hosts file, and named). If the
hostname can’t be determined, the dot-notation representation of the host
address is used. If the hostname is in the same domain as the server (according
to the last two components of the domain name), or if the -a option is given,
rlogind requests the addresses for the hostname and verifies that the name and
address correspond. Normal authentication is bypassed if the address
verification fails.
Once the source port and address have been checked, rlogind proceeds with the
authentication process described in rshd. It then allocates a pseudo terminal, and
manipulates file descriptors so that the slave half of the pseudo terminal becomes the
standard input, standard output, and standard error for a login process.
The parent of the login process manipulates the master side of the pseudo terminal,
operating as an intermediary between the login process and the client instance of

© 2010, QNX Software Systems GmbH & Co. KG. rlogind
rlogin. In most cases, “ˆS/ˆQ” facilities are provided to propagate interrupt signals
to the remote programs. The login process propagates the client terminal’s baud rate
and terminal type, as found in the TERM environment variable. The screen or
window size of the terminal is requested from the client, and window size changes
from the client are propagated to the pseudo terminal.
Transport-level keepalive messages, which are enabled unless -n is given, allow
sessions to be timed out if the client crashes or becomes unreachable.
Diagnostics
All initial diagnostic messages are indicated by a leading byte with a value of 1, after
which any network connections are closed. If there are no errors before login is
invoked, a NULL byte is returned as an indication of success.
Try again A fork by the server failed.
Caveats:
The authentication procedure used here assumes the integrity of each client machine
and the connecting medium. This is insecure, but useful in an “open” environment.
See also:
devc-pty, /etc/hosts, /etc/hosts.equiv, inetd, login, named, rcp,
˜/.rhosts, rlogin, rsh, rshd, /etc/services
gethostbyaddr(), ruserok() in the Library Reference

rm © 2010, QNX Software Systems GmbH & Co. KG.
Remove files (POSIX)
Syntax:
rm [-Rfir] [-d] [-l n] [-v] file...
Runs on:
Options:
-d (QNX Neutrino extension) If the -R option is specified, remove the files but
leave the directory tree intact (i.e. no rmdir is performed).
-f Force each specified file to be removed without prompting for confirmation.
-i Be interactive; request confirmation before removing each existing file.
-l n (“el”) (QNX Neutrino extension) If the -R option is specified, recurse only n
levels down a directory tree.
-r Equivalent to the -R option (below).
-R Recursively remove files and subdirectories under directories given as
arguments. This process removes the directory and the entire file tree under
it.
CAUTION: Use the -R option with care, as it removes directories, subdirectories, and
! files. Using the -i option with -R adds a measure of safety by turning on interactive
prompting before each file or directory is removed.
-v (QNX Neutrino extension) Be verbose; print files and directories as they’re
removed.
file The pathname of a file to be removed.
Description:
The rm utility removes each specified file from a directory.
By default, rm refuses to remove any file that names a directory. This may be
overridden with the -R or -r options. In any case, rm always refuses to remove the
current working directory.
If a file operand has been specified but doesn’t exist and the -f option hasn’t been
given, a message is written to the standard error output. If -f has been given, the error
message isn’t written. In either case, rm goes on to any remaining files specified on the
command line.
The rm utility doesn’t necessarily remove the file itself. A file may have more than one
link; that is, it may be known by more than one name in the filesystem (see the ln
utility for information on creating links). The rm utility breaks one such link; it
dissociates the file from one name. If this is the only link, the file data becomes
inaccessible and the file space is returned to the system for reuse. Otherwise, the data
remains accessible via other names.

© 2010, QNX Software Systems GmbH & Co. KG. rm
Examples:
Remove the a.out and core files:
rm a.out core
Remove the directory junk and all its contents, without prompting:
rm -Rf junk
Exit status:
0 All the named files were removed.
See also:
rmdir, find

rmdir © 2010, QNX Software Systems GmbH & Co. KG.
Remove directories (POSIX)
Syntax:
rmdir [-p] dir...
Runs on:
Options:
-p Remove the entire directory path (consisting only of directories that are empty
except for the named pathname components) of the directories specified on the
command line. (See example.)
dir The pathname of an empty directory to be removed.
Description:
The rmdir utility removes the directory specified by each dir operand, provided the
directory is empty.
The rmdir utility processes directories in the order they’re specified on the command
line. If you specify a parent directory, you should specify its subdirectory before the
parent directory. That way, the parent directory will be empty when the rmdir utility
tries to remove it.
Examples:
Remove the subdirectory oldfiles from the /home/fred directory:
rmdir /home/fred/oldfiles
Remove the directory path dir1/dir2/dir3:
rmdir -p dir1/dir2/dir3
For this command, rmdir first removes dir1/dir2/dir3. If this is successful, it

then removes dir1/dir2. If this is also successful, it removes dir1.
Exit status:
0 Each directory specified by a dir operand referred to an empty directory and
was removed successfully.

© 2010, QNX Software Systems GmbH & Co. KG. rmdir
See also:
rm, find

rndc © 2010, QNX Software Systems GmbH & Co. KG.
Name server control utility
Syntax:
rndc [-b source-address] [-c config-file] [-k key-file] [-s server]
[-p port] [-V] [-y key_id] {command}
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?rndc++NetBSD-5.0 in the
Description:
The rndc utility controls the operation of a name server. Itcommunicates with the
name server over a TCP connection, sending commands authenticated with digital
signatures. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?rndc++NetBSD-5.0 in the
See also:
rndc.conf, rndc-confgen, named, named.conf in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. rndc-confgen
Key-generation tool for rndc
Syntax:
rndc-confgen [-a] [-b keysize] [-c keyfile] [-h] [-k keyname]
[-p port] [-r randomfile] [-s address]
[-t chrootdir] [-u user]
Runs on:
Neutrino
Options:
See http://netbsd.gw.com/cgi-bin/man-cgi?rndc-confgen+8+NetBSD-5.0 in the
Description:
The rndc-confgen utility generates configuration files for rndc. You can use it as a
convenient alternative to writing the rndc.conf file and its controls and key
statements by hand. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?rndc-confgen+8+NetBSD-5.0 in the NetBSD
documentation.
See also:
rndc, rndc.conf, named in the NetBSD documentation

rndc.conf © 2010, QNX Software Systems GmbH & Co. KG.
Configuration file for rndc
Name:
rndc.conf
Description:
The rndc.conf file is the configuration file for rndc. For more information, see
http://netbsd.gw.com/cgi-bin/man-cgi?rndc.conf+5+NetBSD-5.0 in the
See also:
rndc, rndc-confgen in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. route
Manually manipulate the routing tables
Syntax:
route [-f] [-n] [-q] [-v] command { [[modifiers] args] }
Runs on:
Neutrino
Options:
-f Remove all routes (as per flush). If used in conjunction with the add,
change, delete, or get commands, route removes the routes before
performing the command.
-n Don’t print host and network names symbolically when reporting actions.
(The process of translating between symbolic names and numerical
equivalents can be quite time consuming, and may require correct operation of
the network; thus it may be expedient to forgo this, especially when
attempting to repair networking operations.)
-q Be quiet: suppress all output.
-v Be verbose: print additional details.
command [[modifiers] args]

Valid commands are: add, change, delete, flush, and show. See the
“Description” section for the syntax and description of each command.
Description:
You use the route utility to manually manipulate the network routing tables. Because
the routing tables are usually taken care of by the routed daemon, you rarely need to
use this utility.
command options
The route utility accepts the following commands: add, change, delete, flush,
get, monitor, and show.
Here’s the syntax and the description for each command:
[-n] add [-net|-host] destination gateway

Add a route.
[-n] change [-net|-host] destination gateway
Change aspects of a route (such as its gateway).
[-n] delete [-net|-host] destination gateway

Delete a specific route.

route © 2010, QNX Software Systems GmbH & Co. KG.
[-n] flush [family]

(INET and INET6 only) Flush the routing tables of all gateway
entries. If you want to delete only routes having destinations with
addresses in a specified family, specify INET or INET6 as the
family variable.
[-n] get [-net|-host] destination gateway
Look up and display the route for a destination.
[-n] monitor Report changes to the routing information on a continuing basis.
[-n] show Display route table (similar to netstat -r).
destination The destination host or network.
gateway The next-hop gateway that packets should be addressed to.
If the keyword, default, or the network address, 0.0.0.0, is specified, then all
packets sent to a remote network that’s not defined in the routing tables, are sent to the
specified gateway.
If you have an Internet Service Provider (ISP), packets sent to hosts on the Internet are
sent to a gateway provided by the ISP. See the defaultroute option in pppd.
Routes to a particular host are distinguished from those to a network by interpreting

the Internet address associated with destination. Specifying the optional keywords
-net and -host force the destination to be interpreted as a network or a host,
respectively.
If the destination has a “local address part” of INADDR_ANY, or if the destination is
the symbolic name of a network, then the route is assumed to be to a network;
otherwise, the route is assumed to be to a host. For example:
This destination: Is interpreted as:

128.32 -host 128.0.0.32
128.32.130 -host 128.32.0.130
-net 128.32 128.32.0.0
-net 128.32.130 128.32.130.0.
If the route is via an interface rather than via a gateway, you should specify the
-interface modifier; the gateway given is the address of this host on the common
network, indicating the interface to be used for transmission.
You can use the optional -netmask modifier to specify an additional address
parameter that’s interpreted as a network mask. You can use this like an OSI ESIS

© 2010, QNX Software Systems GmbH & Co. KG. route
redirect with the netmask option, or to manually add subnet routes with netmasks
different from that of the implied network interface (as would otherwise be
communicated using the OSPF or ISIS routing protocols). After -netmask, enter the
address parameter you want interpreted as the network mask.
You can override the implicit network mask generated in the INET case by placing this
option after the destination parameter.
Similarly, you can use the -prefixlen modifier for IPv6.
Routes have associated flags which influence operation of the protocols when sending
to destinations matched by the routes. These flags may be set (or sometimes cleared)
by indicating the following corresponding modifiers:
-cloning RTF_CLONING — generates a new route on use

-xresolve RTF_XRESOLVE — emit mesg on use (for external lookup)
-iface ˜RTF_GATEWAY — destination is directly reachable
-static RTF_STATIC — manually added route
-nostatic ˜RTF_STATIC — pretend route added by kernel or daemon
-reject RTF_REJECT — emit an ICMP unreachable when matched
-blackhole RTF_BLACKHOLE — silently discard pkts (during updates)
-proto1 RTF_PROTO1 — set protocol specific routing flag #1
-proto2 RTF_PROTO2 — set protocol specific routing flag #2
-llinfo RTF_LLINFO — validly translates proto addr to link addr
The optional modifiers:
-expire
-hopcount
-mtu
-recvpipe
-rtt
-rttvar
-sendpipe
-ssthresh
provide initial values to metrics maintained in the routing entry. To lock any of these
modifiers, precede the modifier with the -lock meta-modifier; you can also specify
the -lockrest meta-modifier to lock all ensuing metrics.
All symbolic names specified for a destination or gateway are looked up first as a
hostname using gethostname(). If this lookup fails, getnetbyname() is then used to
interpret the name as that of a network.

route © 2010, QNX Software Systems GmbH & Co. KG.
The route utility uses a routing socket and the new message types RTM_ADD,
RTM_DELETE, and RTM_CHANGE. As such, only the superuser may modify the
routing tables.
Diagnostics
add [host | network ] %s: gateway %s flags %x
The specified route is being added to the tables. The values
printed are from the routing table entry supplied in the ioctl() call.
If the gateway address used isn’t the primary address of the
gateway—the first one returned by gethostname() — the gateway
address is printed numerically as well as symbolically.
delete [ host &| network ] %s: gateway %s flags %x

As above, but when deleting an entry.
%s %s done A routing table entry is being deleted by the flush command.
Network is unreachable
An attempt to add a route failed because the gateway listed wasn’t
on a directly connected network. The next-hop gateway must be
given.
not in table A delete operation was attempted for an entry not present in the
tables.
routing table overflow
An add operation was attempted, but the system was low on
resources and couldn’t allocate memory to create the new entry.
Permission denied
The attempted operation is privileged. Only root may modify the
routing tables. These privileges are enforced by the kernel.
License:
This utility is based on copyright software of the Regents of the University of
California and of Christos Zoulas; for licensing information, see the Third Party
License Terms List at http://licensing.qnx.com/third-party-terms/.
See also:
/etc/autoconnect, netmanager, phlip, pppd, routed

© 2010, QNX Software Systems GmbH & Co. KG. route6d
RIP6 routing daemon
Syntax:
route6d [-aDdhlqSs] [-A prefix/preflen,if1[,if2...]]
[-L prefix/preflen,if1[,if2...]]
[-N if1[,if2...]] [-O prefix/preflen,if1[,if2...]]
[-R routelog] [-T if1[,if2...]] [-t tag]
Runs on:
Neutrino
Options:
-A prefix/preflen,if1[,if2...]
Allow routes to be aggregated, where prefix specifies the prefix, and
preflen the prefix length, of the aggregated route. When advertising
routes, route6d filters specific routes covered by the aggregate, and
advertises the aggregated route (prefix/preflen) to the interfaces
specified in the comma-separated interface list, if1[,if2...]. route6d
creates A static route to prefix/preflen with the RTF_REJECT flag is
created in the kernel routing table.
-a Enable the aging of the statically-defined routes. Remove any

statically-defined routes unless the corresponding updates arrive as if
the routes are received at the startup of route6d.
-D Enable extensive output of debugging messages and instruct

route6d to run in the foreground (don’t become a daemon).
-d Enable the output of debugging message and instruct route6d to

run in the foreground (don’t become daemon).
-h Disable the split-horizon processing.
-L prefix/preflen,if1[,if2...]
Filter incoming routes from interfaces if1,[if2...] and accept
incoming routes that are in prefix/preflen. If you’d like to accept any
route, don’t specify this option.
If multiple -L options are specified, any routes that match one of the
options is accepted. If ::/0 is specified, it’s treated as the default
route, not “any route that has longer prefix length than, or equal to 0.”
For example, route6d accepts the default route and routes in the
6bone test address, but in no others, if you specify:
-L 3ffe::/16,if1 -L ::/0,if1
-l Exchange site-local routes as well. By default, they aren’t exchanged

because of safety reasons. The semantics of the site-local address

route6d © 2010, QNX Software Systems GmbH & Co. KG.
space is rather vague (the specification is still being worked on), and
there’s no good way to define site-local boundaries. It must not be
used on site-boundary routers, since this option assumes that all
interfaces are in the same site.
-N if1[,if2...] Don’t listen to, or advertise, routes from or to interfaces specified by

if1,[if2...].
-O prefix/preflen,if1[,if2...]
Restrict route advertisements toward interfaces specified by
if1,[if2...] and only advertise routes that match prefix/preflen.
-q Listen-only mode. Don’t send advertisements.
-R routelog Log the route change (add/delete) to the file routelog.
-S Same as -s, except that the split-horizon rule doesn’t apply.
-s Advertise the statically defined routes that exist in the kernel routing
table when route6d invoked. Announcements obey the regular
split-horizon rule.
-T if1[,if2...] Advertise only default routes toward if1,[if2...].
-t tag Attach this route tag to originated route entries. You can specify tag
in decimal, octal (prefixed by 0), or hexadecimal (prefixed by 0x).
Description:
The route6d utility is a routing daemon which supports Routing Information
Procotol (RIP) over IPv6.
When a SIGINT or SIGUSR1 signal is received, route6d dumps the current internal
state into /var/run/route6d_dump.
The route6d utility uses IPv6 advanced API, defined in RFC2292, for
communicating with peers using link-local addresses.
Internally route6d embeds the interface identifier into bits 32 to 63 of link-local
addresses (fe80::xx and ff02::xx) so they’ll be visible on the internal state dump file
(/var/run/route6d_dump).
The routing table manipulation differs from IPv6 implementation to implementation.
Currently route6d obeys WIDE Hydrangea/KAME IPv6 kernel. Currently, route6d
doesn’t reduce the rate of the triggered updates when consecutive updates arrive.
Files:
/var/run/route6d_dump
Dump internal state on SIGINT or SIGUSR1.

© 2010, QNX Software Systems GmbH & Co. KG. route6d
See also:
route
G. Malkin, and R. Minnear, RIPng for IPv6, RFC2080, January 1997.

routed © 2010, QNX Software Systems GmbH & Co. KG.
Network RIP and router discovery routing daemon
Syntax:
routed [-Adghmqstv] [-F net [/mask[,metric]]]
[-P parms] [-T tracefile]
Runs on:
Neutrino
Options:
-A Don’t ignore RIPv2 authentication if we don’t care about RIPv2
authentication. This option is required for conformance with RFC
1723. However, it makes no sense and breaks using RIP as a
discovery protocol to ignore all RIPv2 packets that carry
authentication when this machine doesn’t care about authentication.
-d Don’t run in the background (for interactive use only).
-F net[/mask][,metric]
Minimize routes in transmissions via interfaces with addresses that
match net/mask, and synthesizes a default route to this machine with
the metric. The intent is to reduce RIP traffic on slow, point-to-point
links such as PPP links by replacing many large UDP packets of RIP
information with a single, small packet containing a “fake” default
route. If metric is absent, a value of 14 is assumed to limit the spread
of the “fake” default route. This is a dangerous feature that when
used carelessly can cause routing loops. Notice also that more than
one interface can match the specified network number and mask. See
also -g.
-g This option, which is used on internetwork routers to offer a route to
the “default” destination, is typically used on a gateway:
• to the Internet
• that uses another routing protocol whose routes aren’t reported to
other local routers.
It’s equivalent to -F 0/0,1 and exists for historical reasons. Because
a metric of 1 is used, it’s very likely that you’ll create chaos with a
routing loop rather than solve your problem. We recommend that you
use -P pm_rdisc on the command line, or add pm_rdisc to your
/etc/gateways file. Because a larger metric is used, the likelihood
of spreading a potentially dangerous default route is reduced.
-h Don’t advertise host or point-to-point routes, provided there’s a
network route going in the same direction. This option is a limited
kind of aggregation, and is useful on gateways to Ethernets that have
other gateway machines connected with point-to-point links.

© 2010, QNX Software Systems GmbH & Co. KG. routed
-m Advertise a host or point-to-point route to a machine’s primary

interface. It’s useful on multi-homed machines such as NFS servers,
and should be used only when the cost of the host routes it generates
is justified by the popularity of the server. Because there’s more than
one interface, it’s effective only when the machine is supplying
routing information. If specified with -q, the host route is advertised.
-P parms Equivalent to adding the parms parameter line to /etc/gateways.
-q Don’t supply routing information (opposite of the -s option). The

default if only one interface is present.
-s Force routed to supply routing information. The default if more

than one network interfaces are present and the TCP/IP stack is set to
forward between interfaces (ipforwarding=1; see sysctl).
-T tracefile Increase the debugging level to at least 1 and append debugging

information to the trace file. Due to security concerns, it’s not
recommended that you routinely run routed when tracing is directed
to a file.
-t Increase the debugging level so that more information is logged to the

tracefile specified with -T, or to standard output. The debugging level
can be increased or decreased with the SIGUSR1 or SIGUSR2 signals
or with rtquery.
-v Display and log the version of the daemon.
logfile The name of file in which routed’s actions are to be logged. This
log contains information about any changes to the routing tables; if
-t isn’t specified to trace all packets, the log also maintains a history
of recent messages sent and received that are related to the changed
route.
Any other argument supplied is interpreted as the name of a file in which the actions of
routed should be logged. It’s better to use -T instead of appending the name of the
trace file to the command.
Description:
The routed daemon is invoked at boot time to manage the network routing tables. It
uses Routing Information Protocol (RIP), RIPv1 (RFC 1058), RIPv2 (RFC 1723), and
Internet Router Discovery Protocol (RFC 1256) to maintain the kernel routing table.
The RIPv1 protocol is based on the reference 4.3BSD daemon.
It listens on the UDP socket for the route service for Routing Information Protocol
packets. It also sends and receives multicast Router Discovery ICMP messages. If the
host is a router, routed periodically supplies copies of its routing tables to any

directly connected hosts and networks. It also advertise or solicits default routes using
Router Discovery ICMP messages.
When started (or when a network interface is later turned on), routed uses an
AF_ROUTE address family facility to find those directly connected interfaces
configured into the system and marked “up.” It adds necessary routes for the interfaces
to the kernel routing table. Soon after being first started, and provided there is at least
one interface on which RIP hasn’t been disabled, routed deletes all pre-existing
non-static routes in kernel table. Static routes in the kernel table are preserved and
included in RIP responses if they have a valid RIP metric.
If more than one interface is present (not counting the loopback interface), it is
assumed that the host should forward packets among the connected networks. After
transmitting a RIP request and Router Discovery Advertisements or Solicitations on
a new interface, the daemon enters a loop, listening for RIP request and response and
Router Discovery packets from other hosts.
When a request packet is received, routed formulates a reply based on the
information maintained in its internal tables. The response packet generated
contains a list of known routes, each marked with a “hop count” metric (a count of 16
or greater is considered “infinite”). Advertised metrics reflect the metric associated
with interface (see ifconfig), so setting the metric on an interface is an effective way
to steer traffic.
Responses don’t include routes with a first hop on the requesting network to
implement in part split-horizon. Requests from query programs such as rtquery are
answered with the complete table.
The routing table maintained by the daemon includes space for several gateways for
each destination to speed recovery from a failing router. RIP response packets
received are used to update the routing tables provided they are from one of the several
currently recognized gateways or advertise a better metric than at least one of the
existing gateways.
When an update is applied, routed records the change in its own tables and updates
the kernel routing table if the best route to the destination changes. The change in the
kernel routing table is reflected in the next batch of response packets sent. If the next
response isn’t scheduled for a while, a flash update response containing only recently
changed routes is sent.
In addition to processing incoming packets, routed also periodically checks the
routing table entries. If an entry hasn’t been updated for 3 minutes, the entry’s metric
is set to infinity and marked for deletion. Deletions are delayed until the route has been
advertised with an infinite metric to insure the invalidation is propagated throughout
the local internet. This is a form of poison reverse. Routes in the kernel table, that are
added or changed as a result of ICMP redirect messages, are deleted after a while to
minimize black-holes. When a TCP connection suffers a timeout, the kernel tells
routed, which deletes all redirected routes through the gateway involved, advances
the age of all RIP routes through the gateway to allow an alternate to be chosen, and
advances of the age of any relevant Router Discovery Protocol default routes.

© 2010, QNX Software Systems GmbH & Co. KG. routed
Hosts acting as internetwork routers gratuitously supply their routing tables every 30
seconds to all directly connected hosts and networks. These RIP responses are sent to
the broadcast address on nets that support broadcasting, to the destination address on
point-to-point links, and to the router’s own address on other networks. If RIPv2 is
enabled, multicast packets are sent on interfaces that support multicasting.
If no response is received on a remote interface, if there are errors while sending
responses, or if there are more errors than input or output (see netstat), then the
cable or some other part of the interface is assumed to be disconnected or broken, and
routes are adjusted appropriately.
The Internet Router Discovery Protocol is handled similarly. When the daemon is
supplying RIP routes, it also listens for Router Discovery Solicitations and sends
Advertisements. When it is quiet and listening to other RIP routers, it sends
Solicitations and listens for Advertisements. If it receives a good Advertisement and
it’s not multihomed, it stops listening for broadcast or multicast RIP responses. It
tracks several advertising routers to speed recovery when the currently chosen router
dies. If all discovered routers disappear, the daemon resumes listening to RIP
responses. It continues listening to RIP while using Router Discovery if multihomed
to ensure all interfaces are used.
The Router Discovery standard requires that advertisements have a default “lifetime”
of 30 minutes. That means should something happen, a client can be without a good
route for 30 minutes. It is a good idea to reduce the default to 45 seconds using
-P rdisc_interval=45
on the command line, or
rdisc_interval=45
in the /etc/gateways file.
While using Router Discovery (which happens by default when the system has a
single network interface and a Router Discover Advertisement is received), there is a
single default route and a variable number of redirected host routes in the kernel table.
On a host with more than one network interface, this default route will be via only one
of the interfaces. Thus, multi-homed hosts running with -q might need no_rdisc
described below.
See the pm_rdisc facility described below to support “legacy” systems that can
handle neither RIPv2 nor Router Discovery.
By default, neither Router Discovery advertisements nor solicitations are sent over
point to point links (e.g. PPP). The netmask associated with point-to-point links (such
as PPP with the IFF_POINTOPOINT flag) is used by routed to infer the netmask used
by the remote system when RIPv1 is used.
The routed daemon supports the notion of “distant” passive or active gateways.
When routed is started, it reads /etc/gateways to:
• find distant gateways which may not be located using only the information from a
routing socket

• discover if some of the local gateways are passive
• obtain other parameters.
For more information, see the /etc/gateways file.
Files:
/etc/gateways List of the distant gateways which may not be located using
only the information from a routing socket.
See also:
ICMP and UDP protocols
gated (an unsupported version is available on the QDN), /etc/gateways file,
rtquery
Internet Transport Protocols, XSIS 028112, Xerox System Integration Standard.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/rpc
RPC program number database
Name:
/etc/rpc
Description:
The rpc file contains user-readable names that can be used in place of rpc program
numbers. Each line has the following information:
name_of_server_for_rpc_program rpc_program_number aliases
Items are separated by any number of blanks or tabs, or both. A pound sign (#) in a
line indicates the beginning of a comment — any characters after a #, up to the end of
the line, aren’t interpreted by routines that search the file.

rpcbind © 2010, QNX Software Systems GmbH & Co. KG.
Map RPC program numbers into universal addresses
Syntax:
rpcbind [-dilLs]
Runs on:
Neutrino
Options:
-d Run in debug mode. In this mode, it doesn’t fork when it starts. Also, it prints
additional information during operation, or aborts on certain errors.
Name-to-address translation consistency checks are also shown in detail.
-i Make rpcbind insecure. You need this option to switch to nonsecure mode.
This option allows SET and UNSET from any host. Normally rpcbind
accepts these requests only from the loopback interface for security reasons.
This change is necessary for programs that were compiled with earlier versions
of the RPC library and don’t make those requests using the loopback interface.
-l Log security related events to the system log (syslog).
-L Allow old-style local connections over the loopback interface. Without this
option, local connections are only allowed over a local socket
/var/run/rpcbind.sock.
-s Cause rpcbind to change to the user daemon as soon as possible. Using the
rpcbind utility, you use nonprivileged ports for outgoing connections, and
prevent nonprivileged clients to connect to services from a privileged port.
Description:
The rpcbind server converts RPC program numbers into universal addresses. You
must run this utility on the host to make RPC calls on a server.
When an RPC service is started, it tells rpcbind the address at which it is listening
and the RPC program numbers it is prepared to serve. When a client wishes to make
an RPC call to a given program number, it first contacts rpcbind on the server
machine to determine the address where RPC requests should be sent.
The rpcbind utility should be started before any other RPC service. Normally,
standard RPC servers are started by port monitors, so rpcbind must be started before
port monitors are invoked.
When rpcbind is started, it checks that certain name-to-address translation calls
function correctly. If they fail, the network configuration databases may be corrupt.
Since RPC services cannot function correctly in this situation, rpcbind reports the
condition and terminates.

© 2010, QNX Software Systems GmbH & Co. KG. rpcbind
The rpcbind utility is secure by default, and can be started only by the superuser.
Standard RPC servers can be run by inetd, so you must start rpcbind before inetd
is invoked.
Files:
The rpcbind utility needs /etc/netconfig, as well as the following entries in
/etc/services:
sunrpc 111/tcp rpcbind portmap

sunrpc 111/udp rpcbind portmap
It also requires the librpc shared library.
Caveats:
If you restart rpcbind, you must restart all RPC servers.
See also:
rpcgen, rpcinfo

rpcgen © 2010, QNX Software Systems GmbH & Co. KG.
An RPC protocol compiler
Syntax:
rpcgen infile
rpcgen -a|-c|-h|-l|-m|-Sc|-Ss [-o outfile] [infile]

[-C] [-D macro[=value]] [-L] [-K secs]
rpcgen -s transport [-o outfile] [infile]
Runs on:
Neutrino
Options:
-a Generate all the files including sample code for client and
server side.
-C Generate ANSI C code. This option also generates code that
could be compiled with the C++ compiler.
-c Compile into XDR routines.
-D macro[=value] Define a macro. It is equivalent to the #define directive in the
source. If no value is given, value defaults to 1. This option
may be specified more than once.
-h Compile into C data definitions (a header file).
-K secs Terminate after secs seconds of idleness. The default is 120
seconds. -K 0 means exit immediately upon servicing a
request (useful if the server is started by inetd). -K -1
disables the idle timer, so the server never exits.
-L Use syslog() for error reporting. In order to capture the log
-l (“el”) Compile into client-side stubs.
-m Compile into server-side stubs, but don’t generate a main
routine. You should find this useful for doing callback routines
or for when you need to write your own main routine to do
initialization.
-o outfile Use this output file. If you don’t specify a file, rpcgen uses
the standard output (-c, -h, -l, -m, -Sc, -Ss, and -s modes
only).
-s transport Compile into server-side stubs, using this transport. The
compiler supports the transports udp and tcp (default is udp).
You can invoke this option more than once to compile a server
that serves multiple transports. The transports are chosen at
run time and not at compile time.

© 2010, QNX Software Systems GmbH & Co. KG. rpcgen
-Sc Generate client-side sample code to show the use of remote

procedure and how to bind the server before calling the
client-side stubs generated by rpcgen.
-Ss Generate skeleton code for the remote procedure on the server
side. You need to fill in the actual code for the remote
procedures.
infile Use this input file. If you don’t specify an input file in the -c,
-h, -l, -m, and -s modes, rpcgen uses the standard input.
Description:
The rpcgen compiler generates C code to implement an RPC protocol. The input
rpcgen takes is a C-like language known as Remote Procedure Call Language. For
more information about this language, we recommend Power Programming with RPC
by John Bloomer, O’Reilly & Associates, 1992. ISBN: 0937175773.
You normally use rpcgen in its first form, where it takes an input file and generates
four output files. For example, if you specify an infile called proto.x, then rpcgen
generates:
• a header file in proto.h
• XDR routines in proto_xdr.c
• server-side stubs in proto_svc.c
• client-side stubs in proto_clnt.c
When you use the -Sc option, it generates sample code to illustrate how to use remote
procedures on the client side. This code is created in proto_client.c. When you
use the -Ss option, it generates sample server code to illustrate how to write remote
procedures. This code is created in proto_server.c.
You use the other syntax forms when you want to generate only one of these output
files.
Once you create a server, it can be started by the port monitors (for example, inetd or
listen) or by itself. When it is started by a port monitor, it creates servers only for
the transport for which the file descriptor 0 was passed. The name of the transport
must be specified by setting up the environmental variable PM_TRANSPORT. When
the server, generated by rpcgen, is executed, it creates server handles for all the
transports specified in the NETPATH environment variable, or if it is unset, it creates
server handles for all the visible transports from the /etc/netconfig file.
You use the other syntax forms when you want to generate only one of these output
files. When rpcgen is executed with the -s option, it creates servers for that
particular class of transports. When executed with the -n option, it creates a server for
the transport specified by netid. If infile is not specified, rpcgen accepts the
standard input.

rpcgen © 2010, QNX Software Systems GmbH & Co. KG.
The C compiler is used to preprocess all input files before they’re actually interpreted
by rpcgen, so all the preprocessor directives are legal within an rpcgen input file.
For each type of output file, rpcgen defines a special symbol for your use:
rpcgen defines this symbol: When compiling into:

RPC_HDR Header files
RPC_XDR XDR routines
RPC_SVC Server-side stubs
RPC_CLNT Client-side stubs
In addition, rpcgen does some preprocessing of its own. It leaves any line beginning
with a % uninterpreted and passes the line directly into the output file.
You can customize some of your XDR routines by leaving associated data types
undefined. For every data type you leave undefined, rpcgen assumes a routine exists
whose name starts with xdr_ and ends with the name of the undefined type.
Caveats:
The compiler doesn’t support nesting. You can achieve the same effect, however, by
declaring structures at the top level and using their names inside other structures.
When you use program definitions, name clashes can occur since the apparent scoping
doesn’t apply. You can avoid most of these clashes by assigning unique names to
programs, versions, procedures, and types.
The server code generated with the -n option refers to the transport indicated by
netid, and hence is very site specific.
See also:
rpcbind, rpcinfo, syslogd

© 2010, QNX Software Systems GmbH & Co. KG. rpcinfo
Report RPC information
Syntax:
rpcinfo -p [host]
rpcinfo [-n portnum] -u host program [version]
rpcinfo [-n portnum] -t host program [version]
rpcinfo -b program version
rpcinfo -d program version
Runs on:
Neutrino
Options:
-b program version
Using UDP, make an RPC broadcast to procedure 0 of the
specified program and version, and report all hosts that respond.
-d program version
Delete the registration for the RPC service of the specified
program and version. Only the superuser can use this option.
-n portnum Use portnum as the port number for the -t and -u options
instead of the port number given by the portmapper.
-p [host] Probe the portmapper on host and print a list of all registered
RPC programs. If a host isn’t specified, use the standard
hostname for the current processor.
-t host program Using TCP, make an RPC call to procedure 0 of program on the
specified host and report whether a response was received.
-u host program Using UDP, make an RPC call to procedure 0 of program on the
specified host and report whether a response was received.
program A name or a number of a program, as listed by the -p option.
version A version of the specified program. If you don’t specify a

version, rpcinfo looks for all the registered version numbers
for the specified program and then tries to call each registered
version. To find all of a program’s version numbers, rpcinfo
calls version 0, which is presumed not to exist. If it does exist,
rpcinfo tries to obtain this information by calling an extremely
high version number instead.

rpcinfo © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The rpcinfo utility makes an RPC call to an RPC server and reports what it finds.
Examples:
Show all the RPC services registered on the local machine:
rpcinfo -p
Show all the RPC services registered on the machine named klaxon:
rpcinfo -p klaxon
Delete the registration for version 1 of the walld service:
rpcinfo -d walld 1
Files:
/etc/rpc RPC program number database.
See also:
/etc/rpc, rpcbind

© 2010, QNX Software Systems GmbH & Co. KG. rsh
Remote shell
Syntax:
rsh [-dn] [-l username] host [command]
Runs on:
Neutrino
Options:
-d Using setsockopt(), turn on socket debugging on the TCP sockets
used for communication with the remote host.
host An Internet address specified in dot notation, or a hostname.
-l username Use the specified remote name (the default remote name is the same
as the local username). Authorization is determined as in rlogin.
-n Redirect input from the special device /dev/null (see the

“Caveats” section below).
command The command to execute on remote host.
Description:
The rsh utility executes command on host. The standard input of rsh is copied to the
remote command, and the standard output and standard error of the remote command
are copied to rsh’s standard output and standard error. Interrupt, quit, and terminate
signals are propagated to the remote command; rsh normally terminates when the
remote command does.
If you don’t specify a command, you’re logged in on the remote host via rlogin.
Shell metacharacters that aren’t quoted are interpreted on the local machine; quoted
metacharacters are interpreted on the remote machine. For example, the command:
rsh otherhost cat remotefile >> localfile
appends remotefile to localfile, while:
rsh otherhost cat remotefile ">>" other_remotefile
appends remotefile to other_remotefile.

rsh © 2010, QNX Software Systems GmbH & Co. KG.
Files:
/etc/hosts Hostname database.
The rsh utility requires the libsocket.so shared library.
Caveats:
You can’t use rsh to run an interactive command such as vi; use rlogin instead.
See also:
esh, fesh, /etc/hosts.equiv, ksh, rcp, ˜/.rhosts, rlogin, rlogind, rshd,
sh, uesh

© 2010, QNX Software Systems GmbH & Co. KG. rshd
Remote shell daemon
Syntax:
rshd [-aln]
Runs on:
Neutrino
Options:
-a Request the address for the hostname, and verify whether the address and name
correspond.
-l Unless the user is the superuser, prevent any validation based on the user’s
.rhosts file.
-n Disable transport-level keepalive messages.
Description:
The rshd daemon is the server for the rcmd() function and, consequently, for the rsh
utility. The daemon provides remote execution facilities with authentication based on
privileged port numbers from trusted hosts.
The rshd daemon is started when inetd receives a service request at the port
indicated by the cmd entry (inetd listens for service requests specified in the
inetd.conf file at a port defined in the services file). The following protocol is
initiated:
1 The server checks the client’s source port. If the port isn’t in the range
512-1023, the server aborts the connection.
2 The server reads characters from the socket up to a NULL (\0) byte. The
resultant string is interpreted as an ASCII number, base 10.
3 If the number received in step 2 is nonzero, it’s interpreted as the port number of
a secondary stream to be used for standard error. A second connection is then
created to the specified port on the client’s machine. The source port of this
second connection is also in the range 512-1023.
4 The server checks the client’s source address and requests the corresponding
hostname (see gethostbyaddr(), the /etc/hosts file, and named). If the
hostname cannot be determined, the dot-notation representation of the host
address is used. If the hostname is in the same domain as the server (according
to the last two components of the domain name), or if the -a option is given, the
address for the hostname is requested, and the server verifies whether the

rshd © 2010, QNX Software Systems GmbH & Co. KG.
address and name correspond. If address verification fails, the connection is

aborted with the message, “Host address mismatch.”
5 A NULL-terminated username of at most 16 characters is retrieved on the initial

socket. This username is interpreted as the user ID on the client’s machine.
6 A NULL-terminated username of at most 16 characters is retrieved on the initial

socket. This username is interpreted as a user ID to use on the server’s machine.
7 A NULL-terminated command to be passed to a shell is retrieved on the initial

socket. The length of the command is limited by the upper boundary on the size
of the system’s argument list.
8 The rshd server then validates the user by means of ruserok(), which uses the
file /etc/hosts.equiv and the file .rhosts found in the user’s home
directory. The -l option prevents ruserok() from doing any validation based on
the user’s .rhosts file unless the user is the superuser.
9 A NULL byte is returned on the initial socket and the command line is passed to
the normal login shell of the user. The shell inherits the network connections
established by rshd.
Transport-level keepalive messages, which allow sessions to be timed out if the
client crashes or becomes unreachable, are enabled unless the -n option is given.
Diagnostics
Except for the last one listed below, all diagnostic messages are returned on the initial
socket, after which any network connections are closed. An error is indicated by a
leading byte with a value of 1 (0 is returned in step 9 above upon successful
completion of all the steps prior to the execution of the login shell).
Can’t fork; try again.

A fork() by the server failed.
Can’t make pipe.
The pipe needed for standard error wasn’t created.
Command too long.
The command line passed is > the size of the argument list (as configured into
the system).
Locuser too long.
The name of the user on the client’s machine is > 16 characters.
Login incorrect.
No password file entry for the username existed.
Permission denied.
The authentication procedure described above failed.

© 2010, QNX Software Systems GmbH & Co. KG. rshd
Remote directory.
The chdir command to the home directory failed.
Ruser too long.

The name of the user on the remote machine is > 16 characters.
<shellname>: ...
The user’s login shell couldn’t be started. This message, which is returned on
the connection associated with standard error, isn’t preceded by a flag byte.
Caveats:
The authentication procedure used here assumes the integrity of each client machine
and the connecting medium. Though insecure, this procedure is useful in an “open”
environment.
See also:
/etc/hosts, inetd, named, rsh
gethostbyaddr(), rcmd(), ruserok() in the Library Reference

rtadvd © 2010, QNX Software Systems GmbH & Co. KG.
Router advertisement daemon
Syntax:
rtadvd [-c configfile] [-dDfRs] interface ...
Runs on:
Neutrino
Options:
-c configfile Specify an alternate location, configfile, for the configuration file. By
default, /etc/rtadvd.conf is used.
-D Log more verbose debugging information (than the -d option) to

syslogd.
-d Log verbose debugging information to syslogd.
-f Prevent rtadvd from becoming a daemon (run in foreground mode);

this is useful when debugging.
-R Accept router renumbering requests. If you enable it, certain IPsec

setup is suggested for security reasons.
-s Do not add or delete prefixes dynamically. Only statically configured

prefixes, if any, will be advertised.
interface The interface name(s) to use when sending router advertisement

packets.
Description:
The rtadvd daemon advertises router advertisement packet to the specified interfaces.
The program will daemonize itself on invocation. It will then periodically send router
advertisement packets, as well as in response to router solicitation messages sent by
end hosts.
Router advertisements can be configured on a per-interface basis, as described in
rtadvd.conf.
If there is no configuration file or the interface doesn’t have a configuration file entry,
rtadvd sets all the parameters to their default values. In particular, rtadvd reads all
the interface routes from the routing table and advertises them as on-link prefixes.
The daemon also watches the routing table. By default, if an interface direct route is
added on an advertising interface and no static prefixes are specified by the
configuration file, rtadvd adds the corresponding prefix to its advertising list.
Similarly, if such a route is deleted, rtadvd deletes the corresponding prefix from the
list. The -s option disables this behavior. Moreover, if the status of an advertising

© 2010, QNX Software Systems GmbH & Co. KG. rtadvd
interface changes, rtadvd will start or stop sending router advertisements according
to the latest status.
Upon receipt of signal SIGUSR1, rtadvd will dump the current internal state into
/var/run/rtadvd.dump.
Use SIGTERM to kill rtadvd gracefully. In this case, rtadvd will transmit router
advertisement with router lifetime 0 to all the interfaces (according to RFC2461 6.2.5).
Examples:
Start the router advertisement daemon:
rtadvd
Run the router advertisement program as a foreground process:

rtadvd -f
Files:
/etc/rtadvd.conf
Default configuration file.
/var/run/rtadvd.pid
Contains the PID of the currently running rtadvd.
/var/run/rtadvd.dump
The file in which rtadvd dumps its internal state.
Exit status:
0 Success.
Andrey A. Chernov
License:
Caveats:
Router advertisements should only be performed downstream. Erroneous upstream
advertisements will cause ICMPv6 redirect packet storms in the subnet, as (per the
specification) the advertising router is assumed to become the default router for end
hosts in the subnet.

rtadvd © 2010, QNX Software Systems GmbH & Co. KG.
See also:
rtadvd.conf, rtsold
Based on Thomas Narten, Erik Nordmark and W. A. Simpson, Neighbor Discovery for
IP version 6 (IPv6), RFC 2461.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/rtadvd.conf
Configuration file for router advertisement daemon
Name:
/etc/rtadvd.conf
Description:
This file describes how the router advertisement packet must be constructed for each
of the interfaces.
Each line in the file describes a network interface. Fields are separated by a colon (:),
and each field contains one capability description. Lines may be concatenated by
using the backslash (\) character. The comment marker is the pound sign (#).
Capabilities
Capabilities describe the value to be filled into ICMPv6 router advertisement messages
and to control rtadvd behavior. Therefore, you are encouraged to read IETF neighbor
discovery documents if you would like to modify the sample configuration file.
Almost all items have default values. If you omit an item, the default value of the item
will be used.
The following two items control the interval of sending router advertisements:
maxinterval
This is the maximum time (in seconds) allowed between sending unsolicited multicast
router advertisements. The value must be be no less than 4 seconds and no greater than
1800 seconds. The default value is 600.
mininterval
The minimum time (in seconds) allowed between sending unsolicited multicast router
advertisements. Its value must be no less than 3 seconds and no greater than .75 * the
value of maxinterval. The default value is one third of the value of maxinterval.
The following items are for ICMPv6 router advertisement message header.
chlim
The number value for Cur Hop Limit field. The default value is 64.
raflags
A number specifying the Flags field in router advertisement message header. Bit 7
(0x80) means Managed address configuration flag bit, and Bit 6 (0x40) means Other
stateful configuration flag bit. The default value is 0.

/etc/rtadvd.conf © 2010, QNX Software Systems GmbH & Co. KG.
rltime
The number of seconds specifying the Router lifetime field. Its value must be no
greater than 3600000. The default value is 1800.
rtime
The number of milliseconds specifying the Reachable time field. The default value is
0, which means unspecified by this router.
retrans
The number of milliseconds specifying the Retrans Timer field. The default value is 0,
which means unspecified by this router.
The following items are for ICMPv6 prefix information option, which will be attached
to router advertisement header.
addrs
The number of prefixes. Its default is 0, so it must explicitly be set to positive values if
you want to specify any prefix information option. If its value is 0, rtadvd looks up
the system routing table and advertise the prefixes corresponding to interface routes on
the interface. If its value is more than 1, you must specify the index of the prefix for
each item below. Indices vary from 0 to N-1, where N is the value of addrs. Each
index shall follow the name of each item, e.g. prefixlen2.
prefixlen
A number specifying the Prefix length field. The default value is 64.
pinfoflags
A number specifying the Flags field in prefix information option. Bit 7 (0x80) means
On-link flag bit, and Bit 6 (0x40) means Autonomous address-configuration flag bit.
The default value is 0xc0, i.e. both bits are set.
addr
A string specifying the address filled into Prefix field. Since the colon character (:) is
used for IPv6 numeric address, the field must be quoted by the double-quote character
“ ”. This field cannot be omitted if the value of addrs is more than 0.
vltime
The number of seconds specifying the Valid lifetime field. The default value is
2592000 (30 days).
pltime
The number of seconds specifying the Preferred lifetime field. The default value is
604800 (7 days).
The following items are for ICMPv6 MTU option, which will be attached to router
advertisement header.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/rtadvd.conf
mtu
A number or string that specifies the MTU (maximum transmission unit) field. If 0 is
specified, it means that the option will not be included. The default value is 0. If the
special string “auto” is specified for this item, MTU option will be included and its
value will be set to the interface MTU automatically.
The following item controls ICMPv6 source link-layer address option, which will be
attached to router advertisement header.
nolladdr
A boolean expression. By default (if nolladdr is not specified), rtadvd will try to
get link-layer address for the interface from the kernel, and attach that in source
link-layer address option. If this capability exists, rtadvd(8) will not attach source
link-layer address option to router advertisement packets.
Examples:
#
# common definitions.
#
default:\
:raflags#0:rltime#3600:\
:pinfoflags#64:vltime#360000:pltime#360000:mtu#1500:
ether:\
:mtu#1280:tc=default:
#
# interfaces.
#
ef0:\
:addrs#1:\
:addr="3ffe:501:4819:1000::":tc=ether:
ef1:\
:addrs#2:addr0="3ffe:501:4819:2000::":\
:addr1="3ffe:501:4819:3000::":tc=ether:
See also:
rtadvd, rtsold
Based on Thomas Narten, Erik Nordmark and W. A. Simpson, Neighbor Discovery for
IP version 6 (IPv6), RFC 2461.

rtc © 2010, QNX Software Systems GmbH & Co. KG.
Set or get date from realtime clock (QNX Neutrino)
Syntax:
Update the current time based on the time from the specified clock:
rtc [-b [base][,[reg_shift][,[mem_map][,c_offset]]]]
[-l] [-r rate] [-S seconds] clock_type
Set the time of the specified clock to the current time:
rtc [-b [base][,[reg_shift][,[mem_map][,c_offset]]]]
-s [-l] clock_type
Runs on:
Neutrino
Options:
-b [base][,[reg_shift][,[mem_map][,c_offset]]]
The location of the RTC chip:
• base — the base address of the chip.
• reg_shift — spacing of the device registers as a power of 2. For
example:
...
The default reg_shift is 0.
• mem_map — memory or I/O space.
• c_offset — offset to the century byte in NVRAM.
-l (“el”) Set hardware time to local time, not Coordinated Universal
Time (UTC). UTC is the standard term for Greenwich Mean Time
(GMT). The -l option has no effect if the clock_type is net.
-r rate Rate at which to adjust the OS time if it’s currently within 60 seconds
(or value set by -S) of the time from the source specified by
clock_type. The rate is turned into a percentage 1/rate. The default
rate is 100 (1%).
-S seconds Specify the maximum number of seconds difference between current
time and new time before jam loading rather than slowly adjusting.
(see -r for the convergence speed). Default: 60.

© 2010, QNX Software Systems GmbH & Co. KG. rtc
-s Set hardware to current date and time.

clock_type One of the following:
Clock type Description

hw Hardware clock (automatically selects one based on
information provided by the startup)
at (deprecated) IBM PC/AT Compatible hardware clock
ds1386 Embedded Dallas Semiconductor DS1386
ps2 (deprecated) IBM PS/2 Compatible hardware clock
rtc72423 Embedded Fox RTC-72423
rtcsh4 Integrated into the Hitachi SH4 7750/7751 cpus
mc146818 IBM PC/AT Compatible hardware clock
m48t5x STMicroelectronics TIMEKEEPER Series clock
net [node] Hardware clock on a remote node
Description:
The rtc command gets or sets the date and time from a battery backed-up hardware
clock.
If your machine has a builtin clock/calendar, you should include the following
command in your startup script so QNX Neutrino automatically reads the time when
the system starts:
rtc hw
If the RTC chip has been set to the UTC timezone, startup sets the correct time of day
automatically on booting. If the RTC chip is set to local time, or for some reason
startup doesn’t know where the RTC chip is, you’ll need to include the appropriate
rtc command in the startup script specified in your mkifs buildfile.
You can use clock type net [node] to get the date from a specified node, or to set the
date on a specified node. If node isn’t specified, the default is the local machine. When
clock type net [node] is used, the -l option has no effect.
Be careful if you set the date during the period that a time zone is switching to
daylight saving time (DST). When a time zone changes to DST, the local time goes
back one hour (for example, 2:00 a.m. becomes 1:00 a.m.). The local time during this
hour is ambiguous (e.g. 1:14 a.m. occurs twice in the morning that the time zone
switches to DST). To avoid problems, use UTC time to set the date in this period.

rtc © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
Update the current date and time from the hardware clock:
rtc hw
Set hardware clock with current date and time:
rtc -s hw
Exit status:
0 Successful.
See also:
date, mkifs, phlocale

© 2010, QNX Software Systems GmbH & Co. KG. rtquery
Query routing daemons for their routing tables
Syntax:
rtquery [-1np] [-a secret] [-r addr] [-w timeout] host ...
[-t op] host ...
Runs on:
Neutrino
Options:
-1 Query using RIP version 1 instead of RIP version 2.
-a passwd=XXX
-a md5_passwd=XXX|KeyID
Send the query with the specified RIPv2 cleartext or RIPv2 MD5
password.
-n Display only the numeric network and host numbers instead of both
the numeric and symbolic values.
-p Use the poll command to request full routing information from

gated. This is an undocumented extension RIP protocol supported
only by gated.
-r addr Ask about the route to destination addr.
-w timeout Change the delay for an answer from each host. By default, each host
has 15 seconds to respond.
-t op Change the tracing settings. Requests from processes that aren’t

running with root privileges, or are on distant networks, are generally
ignored by the daemon except for having a message logged in the
system log.
on=tracefile Turn on tracing to the tracefile. The tracefile was

either specified when the daemon started, or is the
same as a fixed name, typically
/etc/routed.trace.
more Increase the debugging level.
off Turn off tracing.
dump Dump the daemon’s routing table to the current
tracefile.

rtquery © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The rtquery utility is used to query a RIP network routing daemon, routed or
gated, for its routing table by sending a request or poll command. The routing
information in any routing response packets returned is displayed numerically and
symbolically.
By default, it uses the request command. When -p is specified, rtquery uses the
poll command, an undocumented extension to the RIP protocol supported by gated.
When querying gated, the poll command is preferred over the request command
because the response is not subject to split-horizon and/or Poisoned Reverse, and
because some versions of gated do not answer the request command. Although
routed doesn’t answer the poll command, it recognizes requests coming from
rtquery and answers them completely.
The utility is also used to turn tracing on or off in routed.
See also:
gated (an unsupported version is available on the QDN), /etc/gateways, routed
Based on:
• RFC 1058 Routing Information Protocol, RIPv1
• RFC 1723 Routing Information Protocol, RIPv2

© 2010, QNX Software Systems GmbH & Co. KG. rtsold
Router solicitation daemon
Syntax:
rtsold [-1Ddfm] -a
rtsold [-1Ddfm] interface ...
rtsol [-Dd] -a
rtsol [-Dd] interface ...
Runs on:
Neutrino
Options:
-1 Perform only one probe. Send Router Solicitation packets until valid
Router Advertisement packets arrive from all the interfaces, then exit.
-a Autoprobe the outgoing interface. The rtsold daemon tries to find a

non-loopback, non-point-to-point, IPv6-capable interface. If it finds
multiple interfaces, rtsold exits with an error.
-D Increase the debugging level. Also print internal timer information.
-d Enable debugging.
-f Prevent rtsold from becoming a daemon (foreground mode). Warning

messages are generated to standard error output, instead of syslog().
-m Enable mobility support; send probing packets to the default routers that
advertised Router Advertisements when the node (re)attached to an
interface. Periodically send Router Solicitation on an interface that
doesn’t support SIOCGIFMEDIA ioctl.
interface Name of the interface(s) where messages are to be sent.
Description:
The rtsold daemon sends ICMPv6 Router Solicitation messages on the specified
interfaces. If a node (re)attaches to a link, rtsold sends some Router Solicitations on
the link destined to the link-local scope all-routers multicast address to discover new
routers and to get non link-local addresses.
If you use rtsol, probes are transmitted from the interface specified, without
becoming a daemon. It behaves the same as:
rtsold -f1 interface
The rtsold daemon sends at most three Router Solicitations on an interface after one
of the following events:
• Just after the rtsold daemon has started.

rtsold © 2010, QNX Software Systems GmbH & Co. KG.
• The interface is up after a temporary interface failure. Failures are detected by

rtsold by periodically probing the status of the interface. Some network cards
and drivers don’t allow the extraction of the link state. In these cases, rtsold
won’t be able to detect a change in the status.
• Every 60 seconds, if -m is specified and rtsold can’t get the interface status. This
feature doesn’t conform to IPv6 neighbor discovery specification, but is provided
for mobile stations. The default interval for router advertisements, which is on the
order of 10 minutes, is slightly long for mobile stations. This feature is provided
for such stations so that they can find new routers as soon as possible when they
attach to another link.
Once rtsold sends a Router Solicitation, and receives a valid Router Advertisement,
it refrains from sending additional solicitations on that interface, until the next time
one of the above events occurs.
When sending a Router Solicitation on an interface, rtsold includes a Source
Link-layer address option if the interface has its link-layer address.
When a SIGUSR1 signal is received, rtsold dumps the current internal state into
/var/run/rtsold.dump.
Files:
/var/run/rtsold.pid
The pid of the currently running rtsold.
/var/run/rtsold.dump
Dump of the current internal state.
Exit status:
Caveats:
Before this utility will work, you need to enable the TCP/IP stack to accept route
advertisements, like this:
sysctl -w net.inet6.ip6.accept_rtadv=1
See also:
rtadvd, sysctl

© 2010, QNX Software Systems GmbH & Co. KG. ruptime
Show host status of local machines
Syntax:
ruptime [-alrtu]
Runs on:
Neutrino
Options:
-a Count all users. Without -a, users who are idle for an hour or more aren’t
counted.
-l Sort by load average.
-r Reverse the sort order.
-t Sort by uptime.
-u Sort by number of users.
Description:
The ruptime utility gives a status-line-like uptime for each machine on the local
network; each uptime is formed from packets that are broadcast once a minute by each
host on the network.
Machines for which no status report has been received for 11 minutes are shown as
being down.
The default listing is sorted by hostname.
Files:
/var/rwho/whod.*
Data files
The ruptime utility requires the libsocket.so shared library.
Caveats:
QNX Neutrino doesn’t calculate load average, so only non-QNX Neutrino hosts can
have nonzero load averages.
See also:
rwho

rwho © 2010, QNX Software Systems GmbH & Co. KG.
Show who’s logged in on local machines
Syntax:
rwho [-a]
Runs on:
Neutrino
Options:
-a Count all users. Without -a, users who are idle for an hour or more aren’t
counted.
Description:
The rwho utility produces output similar to that produced by who, but for all machines
on the local network. If no report has been received from a machine for five minutes,
rwho assumes the machine is down, and doesn’t report users last known to be logged
into that machine.
If a user hasn’t typed to the system for a minute or more, rwho reports this idle time.
A user who hasn’t typed to the system for an hour or more is omitted from the output
of rwho unless you specify the -a option.
Files:
/var/rwho/whod.*
Information about other machines.
The rwho utility requires the libsocket.so shared library.
Caveats:
This utility is unwieldy when the number of machines on the local net is large. It’s
unreliable due to protocol issues.
See also:
ruptime, rwhod, who

© 2010, QNX Software Systems GmbH & Co. KG. rwhod
System status daemon
Syntax:
rwhod [-i interval] [-u user]
Runs on:
Neutrino
Options:
-i interval Specify the broadcast interval in seconds, or in minutes if interval has
a suffix of m. The default is 3 minutes; the maximum is 11 minutes
because higher values will cause ruptime to mark the host as being
down.
-u user Drop privileges and become the specified user.
Description:
The rwhod daemon is the server that maintains the database used by the rwho and
ruptime utilities. Its operation is based on the network’s ability to transmit broadcast
messages.
The rwhod daemon operates as both a producer and a consumer of status information.
As a producer of information, it periodically queries the state of the system and
constructs status messages that are broadcast on a network. As a consumer of
information, it listens for other rwhod daemons’ status messages, validating them,
then recording them in a collection of files located in the directory /var/rwho.
The daemon transmits and receives messages at the port indicated by the rwho entry
in the /etc/services file.
Messages received by the rwhod daemon are discarded unless they originated at an
rwhod daemon’s port. In addition, if the host’s name, as specified in the message,
contains any unprintable ASCII characters, the message is discarded. Valid messages
received by rwhod are placed in files named whod.hostname in the directory
/var/rwho. These files contain only the most recent message, in the format described
above.
The rwhod daemon generates status messages about every three minutes.
Files:
The rwhod daemon requires the libsocket.so shared library.

rwhod © 2010, QNX Software Systems GmbH & Co. KG.
See also:
ruptime, rwho

© 2010, QNX Software Systems GmbH & Co. KG. savercfg
Photon screensaver options
Syntax:
savercfg [-s server] [-x position] [-y position]
Runs on:
Neutrino
Options:

fullpath fullpath


Description:
The savercfg command displays a dialog for setting screensaver options, a
screensaver password, and power saver options:

savercfg © 2010, QNX Software Systems GmbH & Co. KG.

© 2010, QNX Software Systems GmbH & Co. KG. savercfg
Not all hardware configurations support Display Power Management System (DPMS)
power saving modes.
Files:
${HOME}/.ph/saver.cfg
Where your screensaver options are stored.
/usr/photon/config/saver.cfg
Global screensaver options. Options are copied from here if a
${HOME}/.ph/saver.cfg does not exist.
See also:
pwm, pwmopts

scp © 2010, QNX Software Systems GmbH & Co. KG.
Secure copy (remote file copy program)
Syntax:
scp [-1246BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]
[-l limit] [-o ssh_option] [-P port] [-S program]
[[user@]host1:]file1 ... [[user@]host2:]file2
Runs on:
QNX Neutrino
Options:
See scp in the NetBSD documentation.
Description:
The scp utility copies files between hosts on a network. It uses ssh for data transfer,
and uses the same authentication and provides the same security as ssh. For more
information, see scp in the NetBSD documentation.
NetBSD
See also:
/etc/moduli, sftp, sftp-server, ssh, ssh-add, ssh-agent, ssh-keygen,

© 2010, QNX Software Systems GmbH & Co. KG. script
Create a typescript of a terminal session
Syntax:
script [-a] [file]
Runs on:
Neutrino
Options:
-a Append the output to file or to the typescript file, retaining the prior
contents.
file Name of the file script will use to save the session output. If you don’t
specify a file, output is saved in the file typescript.
Description:
The script utility records everything printed to the terminal during a session. This is
useful, for example, if you want to record an interactive session and then save the
typescript file for later analysis, tech support, etc.
The script ends when the forked shell exits (via Ctrl-D).
Certain interactive utilities (e.g. vi) can create garbage in the typescript file. The
script command works best with utilities that don’t manipulate the screen; the
results are meant to emulate a hardcopy terminal.
Note also that script records all transactions, including linefeeds and backspaces.
See also:
ksh (for the history feature)

sed © 2010, QNX Software Systems GmbH & Co. KG.
Stream editor (POSIX)
Syntax:
sed [[-n] script [file...]
sed [-n] [-e script]... [-f script_file]... [-V]

[file...]
Runs on:
Options:
-e script
--expression=script
Use the command-line script for editing files. If you specify
multiple -e options, the scripts are applied in the order specified
to each line of the input files. If a -f option is specified in
addition to -e, lines are acted upon by scripts first.
-f script_file
--file=script-file
Use the file script_file as the script of editing instructions. If
multiple -f options are specified, the scripts are applied in the
order specified to each line of the input files. If a -e option is
specified in addition to -f, lines are acted upon by scripts first.
--help Display some help, and then exit.
-i[suffix]
--in-place[=suffix]
Edit files in place (making a backup if you specify the suffix).
-l N
--line-length=N
(“el”) Specify the desired line-wrap length for the l command.
-n
--quiet
--silent Suppress the default output, which passes each line to standard
output after it’s examined for editing. Only lines explicitly
selected for output are written.
--posix Disable all GNU extensions.
-r
--regexp-extended
Use extended regular expressions in the script.

© 2010, QNX Software Systems GmbH & Co. KG. sed
-s
--separate Consider files as separate rather than as a single continuous long
stream.
-u
--unbuffered Load minimal amounts of data from the input files and flush the
output buffers more often.
--version Display the version number, and then exit.
file The pathname of a text file whose contents are read and edited. If
you specify multiple files, the files are read in the order specified
and the concatenation is edited. If no files are specified, the
script A script consists of one or more editing instructions that you
enter on the command line.
If you don’t specify any -e, --expression, -f, or --file options, then the first
non-option argument is taken as the sed script to interpret. All remaining arguments
are names of input files; if you don’t specify any input files, then the standard input is
read.
Description:
The sed utility is a stream editor that reads one or more text files, makes editing
changes according to editing commands that you specify, and writes the results to
standard output.
The sed commands are usually stored in a program file (script_file), although you
may give simple sed commands from the command line. By default, sed copies files
from the file list to its standard output, editing the lines in the process. Conceptually,
there is one input file, which is the concatenation of all input files specified.
Lines are selected for editing based on their position within the input file, or by pattern
matching. If no files are listed, input is taken from standard input (this is the only time
standard input is used). The sed utility initially reads all the editing commands from
all specified sources and places them in an internal table in the order specified. The
utility then processes the (concatenated) input file as follows:
1 Read one line from the input file and copy to the pattern space (a work area).
2 For each command that selects the line, act on the pattern space as the edit
command specifies, cyclically placing the result into the pattern space.
3 After all commands have been checked against the pattern space, write the
pattern space to the standard output, provided -n was not specified. The pattern
space may contain zero, one, or several lines at this time.

4 Delete the contents of the pattern space.
5 Repeat from step 1 until all of the (concatenated) input file has been read and
processed.
Scripts
A script consists of editing commands, one per line, of the following form:
[address[,address]]function[arguments]
You can specify the script of editing commands in the command line, or it can be
contained in the file script_file.
In default operation, sed cyclically copies a line of input into a pattern space (unless
there is something left after a D command), applies in sequence all commands whose
addresses select that pattern space, and at the end of the script copies the pattern space
to the standard output (except under -n) and deletes the pattern space.
Some of the commands use a hold space to save all or part of the pattern space for
subsequent retrieval. The pattern and hold spaces are each limited to 20 KB.
Addresses
An address is one of the following:
• a decimal number that counts input lines cumulatively across files
• a $ token that addresses the last line of input
• a context address
• a regular expression
A command line with no address selects every pattern space. A command line with
one address selects each pattern space that matches the address.
A command line with two addresses selects the inclusive range from the first pattern
space that matches the first address through the next pattern space that matches the
second address. (If the line number of the second address is less than or equal to the
line number first selected, then only the first line is selected.) Starting at the first line
following the selected range, sed looks again for the first address. Thereafter the
process is repeated.
You can use the negation character (!) to apply editing commands to non-selected
pattern spaces. For more information, see “Editing commands,” below.
Regular expressions
The sed utility uses basic regular expressions (REs), with the following additions:
• In a context address, the construction \?RE? (where ? is any character) is mapped

to /RE/. Note that in the context address \xabc\xdefx, the second x stands for
itself, so that the regular expression is abcxdef.

• The escape sequence \n matches a newline embedded in the pattern space.
• A period (.) matches any character except the last newline of the pattern space.
Editing commands
In the following list of functions, the maximum number of permissible addresses for
each function is indicated by one of [0addr], [1addr] or [2addr] representing a
maximum of zero addresses, one address or two addresses respectively. The argument
text consists of one or more lines. Each embedded newline in the text must be
preceded by a backslash. Other backslashes in text are treated like the backslashes in
the replacement string of an s editing command; you can use them to protect initial
blanks against the stripping that’s done on every script line.
The r and w editing commands take an optional rfile (or wfile) parameter, separated
from the command letter by zero or more blanks.
The arguments rfile or wfile terminate the command line. Each wfile is created before
processing begins. There can be at most ten distinct wfile arguments in the script.
The b, r, s,t, w, y, !, and : editing commands take additional arguments. The
following synopses indicate which arguments are separated from the commands by
blanks:
[2addr] { command_list
}
Execute command_list only when the pattern space is selected.
(Note that the trailing } must be the first non-blank character in
the line.)
[1addr]a\
text Write text to the standard output after the pattern space is
written.
[2addr]b label Branch to the : (colon) command bearing the label. If label is
empty, branch to the end of the script.
[2addr]c\
text Delete the pattern space. With 0 or 1 address or at the end of a
2-address range, place text on the output.
[2addr]d Delete the pattern space and start the next cycle.
[2addr]D Delete the initial segment of the pattern space through the first
newline and start the next cycle.
[2addr]g Replace the contents of the pattern space by the contents of the
hold space.
[2addr]G Append the contents of the hold space to the pattern space.

[2addr]h Replace the contents of the hold space by the contents of the
pattern space.
[2addr]H Append the contents of the pattern space to the hold space.
[1addr]i\
text Write text to the standard output before the pattern space is
written.
[2addr]l List the pattern space on the standard output in an unambiguous

form. Nonprinting characters are listed as hexadecimal digit
pairs, with a preceding backslash, with the following
exceptions:
Character Listed as
alert \a
backslash \\
backspace \b
carriage return \r
form-feed \f
newline \n
tab \t
vertical tab \v
Long lines are folded; the length at which folding occurs is

unspecified, but should be appropriate for the output device.
[2addr]n Copy the pattern space to the standard output and replace the
pattern space with the next line of input.
[2addr]N Append the next line of input to the pattern space, using an
embedded newline to separate the appended material from the
original material. Note that the current line number changes.
[2addr]p Copy (print) the pattern space to the standard output.
[2addr]P Copy (print) the pattern space, up to the first newline, to the
standard output.
[1addr]q Branch to the end of the script and quit without starting a new
cycle.
[1addr]r rfile Read the contents of the rfile file. The contents are placed on
the output before reading the next input line.

[2addr]s/regular expression/replacement string/flags

Substitute the replacement string for instances of regular
expression in the pattern space. You can use any character
instead of /. The value of flags is zero or more of:
n n=1 to 512. Substitute for the nth occurrence only of

the regular expression found within the pattern space.
g Globally substitute for all non-overlapping instances
of the regular expression rather than just the first one.
If both g and n are specified, g takes precedence.
p Print the pattern space if a replacement was made.
w wfile Append (write) the pattern space to wfile if a
replacement was made.
[2addr]t label Test; branch to the : (colon) command bearing the label if any
substitutions have been made since the most recent reading of
an input line or execution of a t. If label is empty, branch to the
end of the script.
[2addr]w wfile Append (write) the pattern space to wfile.
[2addr]x Exchange the contents of the pattern and hold spaces.
[2addr]y/string1/string2/
Replace all occurrences of collating elements in string1 with
the corresponding collating element in string2. The lengths of
string1 and string2 should be equal.
[2addr]! function Apply the function (or command list, if function is {) only to
the lines that aren’t selected by the addresses.
[0addr]:label This command does nothing; it bears a label for the b and t
commands to branch to.
[1addr]= Place the current line number on the standard output as a line
with its own line number.
[0addr] An empty command; ignored.
[0addr]# If a # appears as the first character on any line of a script file,

that entire line is ignored (treated as a comment), with the
single exception that if the first line of the script file begins with
#n, the default output is suppressed (as when the -n option is
specified on the command line).

Examples:
In the file myfile, find and output only those lines containing the string “tom”:
sed -n -e "/tom/p" myfile
In the file myfile, replace all occurrences of the string beneath with the string
below, and output to the file newfile:
sed -e "s/beneath/below/" myfile >newfile
Files:
All files are text files. The script_files named by the -f option consist of editing
commands, one per line. Any number of additional text input files may be specified by
the r command for insertion of unedited data to the standard output at points
predetermined by editing rules. A maximum of 10 additional output files may be
specified through the use of the w command in the script.
Exit status:
Errors:
If one or more of the input files (this doesn’t include script files) can’t be opened for
reading, sed continues to process the remaining files.
GNU
See also:
gawk, python
Dale Dougherty, sed & awk, O’Reilly and Associates, 1990.
Brian W. Kernighan and Rob Pike, The UNIX Programming Environment,
Prentice-Hall, 1984.

© 2010, QNX Software Systems GmbH & Co. KG. seedres
Seed system resources on x86 platforms
Syntax:
seedres
Runs on:
Neutrino
Options:
None.
Description:
The seedres utility reads the PnP BIOS and assigns resources, such as I/O ports and
IRQs, to procnto’s resource database. You need it if you want drivers to assign
nonconflicting resources.
This utility is for x86 platforms; on other platforms, the startup code seeds the system
resources.
For more information about the resource database, see rsrcdbmr_attach() in the
Examples:
The following lines from a buildfile show how to start seedres and pci-bios on an
x86 platform:
...
seedres
pci-bios
...
See also:
pci-bios, procnto
rsrcdbmr_attach() in the Neutrino Library Reference

sendnto © 2010, QNX Software Systems GmbH & Co. KG.
Send an OS image to a target over a serial or parallel port (QNX4)
Syntax:
sendnto -d device [-b baud] [-l speed] [-eqv] filename
Runs on:
Options:
-b baud Set the serial port transfer speed to baud.
-d device Send the image over this device. You must specify this option. The form
of the device name depends on the host OS:
• Linux: /dev/ttySX
• Neutrino: /dev/serX
• Windows: comX
-e Request an echo from the target for every data record (off by default).
An echo may be needed for serial downloads at very high baud rates
(>57600 baud) to very slow machines.
-l speed (“el”) Output is to a parallel port with a LAPLINK cable. The speed
may be 1...3, with 1 being the fastest.
-q Be quiet; don’t print an ongoing percentage of image downloaded.
-v Be verbose; print an ongoing percentage of download complete.
Description:
The sendnto utility takes an OS image built with mkifs and sends it to a target
device using a fast binary protocol. The target computer needs a loader built into its
startup code in ROM or FLASH that understands this protocol. The protocol is very
simple and is designed to be implemented with minimal code in the target.
The Board Support Packages generally contain IPL source for serial targets.
The sendnto utility assumes the target has been reset and is in a state where it is
waiting for data. It sends the following sequence of records:
START
DATA DATA ...
GO
Each record has a sequence number and checksum to ensure data integrity. The GO
record transfers control to the downloaded image. The details of this protocol may be
determined by examining the source to sendnto, which is also made available for
porting to other development environments.

© 2010, QNX Software Systems GmbH & Co. KG. sendnto
Downloads over a parallel port are automatically flow-controlled. Downloads over a

serial port assume that the target is fast enough to process the data. For most targets
this is true for baud rates up to 57600 baud.
On slower targets with a baud rate of 115200, you may need to specify the -e option
to flow control sendnto with the target. This causes sendnto to insert an ECHO
record after each data record. It then pauses and waits for the target to echo of a +
before sending the next record. If the target fails to send a + within 1/10 second,
sendnto times out and sends the next record anyway. If you don’t specify the -e
option, the link need only operate in one direction (write without read from the host’s
point of view).
When used over a serial link, sendnto uses the existing baud rate and hardware flow
control set by the stty command. It programs the link to operate in raw mode. Note
that hardware flow control isn’t required on the link.
The -v option makes sendnto print a continuously updated percentage as the image
is downloaded. This provides feedback during large image downloads over slow links.
Examples:
Send the file image to the target machine through the first serial port on host machine:
sendnto -d /dev/ser1 image
Send the file image to the target machine through the second serial port on the node
named server:
sendnto -d /net/server/dev/ser2 image
Send the file image to the target machine through the parallel port on the host
machine using a regular parallel cable:
sendnto -d /dev/par image
Send the file image to the target machine through the parallel port using a LAP-LINK
cable. This cable arrangement may also be used by the wd source-level debugger for
parallel-port debugging:
sendnto -d /dev/bipar image
Exit status:
See also:
mkifs

/etc/services © 2010, QNX Software Systems GmbH & Co. KG.
Service name database (UNIX)
Name:
/etc/services
Description:
The /etc/services file contains information regarding the known services available
in the DARPA Internet. For each service, a single line should be present with the
official_service_name port_number/protocol_name aliases
For example:
ftp 21/tcp
The fields are as follows:
ftp Service name.
21 Port number.
tcp Protocol name.
Items are separated by any number of blanks, tabs, or both.

The port_number and protocol_name are considered a single item; a / is used to
separate the two (e.g. 512/tcp).
A # in a line indicates the beginning of a comment — any characters after a #, up to
the end of the line, aren’t interpreted by the routines that search the file.
Service names may contain any printable character other than a field delimiter,
See also:
inetd
getservent() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. setconf
Set a configuration string (QNX)
You must be logged in as root to use this utility.
Syntax:
setconf variable_name string ...
Runs on:
Neutrino
Options:
variable_name The variable to set; see <pathconf.h>. The most useful
variables are:
• _CS_ARCHITECTURE
• _CS_DOMAIN
• _CS_HOSTNAME
A hostname can consist only of letters, numbers, and hyphens, and must not start or
end with a hyphen. For more information, see RFC 952.
If you change this configuration string, be sure you also change the HOSTNAME
environment variable. The hostname utility always gives the value of the
_CS_HOSTNAME configuration string.
• _CS_HW_PROVIDER
• _CS_HW_SERIAL
• _CS_LIBPATH
• _CS_LOCALE
• _CS_MACHINE
• _CS_PATH
• _CS_RELEASE
• _CS_RESOLVE
• _CS_SRPC_DOMAIN
• _CS_SYSNAME
• _CS_TIMEZONE
• _CS_VERSION
string The new value for the variable.

setconf © 2010, QNX Software Systems GmbH & Co. KG.
Description:
This utility sets a variable that’s used for configuration information. For more
information, see the documentation for getconf.
See also:
getconf
confstr(), pathconf(), sysconf() in the Library Reference
“Configuration strings” in the Configuring Your Environment chapter of the Neutrino
User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. setkey
Manually manipulate the IPsec SA/SP database
Syntax:
setkey [-knrv] filename
setkey [-v] [-c]
setkey [-krv] [-f] filename
setkey [-aklPrv] -D
setkey [-Pvp] -F
setkey [-H] -x
setkey [-?V]
Runs on:
Neutrino
Options:
-a Display dead SAD (Security Association Database) entries. A SAD
entry is dead when it has expired, but it may still be referenced by
SPD (Security Policy Database) entries.
-c Specify an operation from standard input. For a list of valid

operations, see the “Operations” section, below.
-D Dump the SAD entries.
When used with: Also dump:

-a Dead entries
-P SPD entries
-F Flush the SAD entries. When specified with -P, also flush the SPD
entries.
-f filename A file that contains the operations to perform. For more information,
see the “Operations” section, below.
-h Dump entries in a hexadecimal format.
-l Loop forever with short output on -D.
-P Dump (when specified with -D) or flush (with -F) the SPD entries.
-v Be verbose. Display messages transmitted to the PF_KEY socket

(including messages sent from other processes).
-x Loop forever and dump all the messages transmitted to the PF_KEY
socket.

setkey © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The setkey utility adds, updates, dumps, or flushes the Security Association
Database (SAD) entries and the Security Policy Database (SPD) entries in the stack.
Operations
The following operations may be specified from either standard input (using -c) or
from a file (using -f filename).
Lines that start with hash marks (#) are treated as comment lines. Operations have the
following grammar:
add src dst protocol spi [extensions] algorithm... ;

Add an SAD entry. This operation can fail, for example, if the
key length doesn’t match the specified algorithm.
delete src dst protocol spi ;

Remove an SAD entry.
dump [protocol] ; Dump all SAD entries matched by this protocol (same
functionality as -D on the command line).
flush [protocol] ; Clear all SAD entries matched by this protocol (same
functionality as -F on the command line).
get src dst protocol spi ;

Show an SAD entry.
spdadd src_range dst_range upperspec policy ;

Add an SPD entry.
spddelete src_range dst_range upperspec -P direction ;

Delete an SPD entry.
spddump ; Dump all SPD entries (same functionality as -DP on the

command line).
spdflush ; Clear all SPD entries (same functionality as -FP on the

command line).
Meta-arguments for operations

The meta-arguments for the operations are as follows:
algorithm Specify an encryption, authentication, or compression algorithm.

See the “Algorithms for protocol ” section below for a list of the valid values for
aalgo, ealgo and calgo.
-A aalgo key Specify an authentication algorithm (aalgo) for the

ah and ah-old protocols.
-E ealgo key Specify an encryption algorithm (ealgo) for the esp
or esp-old protocols.
-E ealgo key -A aalgo key
Specify an encryption algorithm (ealgo) for the esp
or esp-old protocols, as well as a payload
authentication algorithm (aalgo) for esp.
-C calgo [-R] Specify a compression algorithm for IPComp (IP
Payload Compression Protocol).
If -R is specified, the value of the spi field is used as
the IPComp CPI (compression parameter index) field
on outgoing packets. The field must be smaller than
0x10000.
If -R isn’t specified, the stack uses the IPComp CPI
(compression parameter index) from the IPComp CPI
field on the packets, and the spi field is ignored.
key A double-quoted character string or series of
hexadecimal digits preceded by 0x.
dst,
src Specify the destination or source of the secure communication as an
IPv4/v6 address. The address must be in numeric form since setkey
doesn’t consult hostname-to-address for these arguments.
dst_range,
src_range Selections of the secure communication specified as an IPv4/v6
address or an IPv4/v6 address range. They may accompany TCP/UDP
port specifications. Valid forms are:
address
address/prefixlen
address[port]
address/prefixlen[port]
The values for prefixlen and port must be specified as a decimal

number; src and dst must be expressed in numeric form. The square
brackets around port are part of the syntax; they aren’t optional.
extensions Valid options are:
-f nocyclic-seq Don’t allow cyclic sequence numbers.

-f pad_option Specify the content of the esp padding, where

pad_option is one of:
• random-pad — set a series of randomized
values.
• seq-pad — set a series of sequential increasing
numbers starting from 1.
• zero-pad — set everything to zero.
-lh time Specify a hard lifetime.
-ls time Specify a soft lifetime.
-m mode Security protocol mode to be used, which is one of:
• any (the default) — use whichever security
protocol mode is available.
• transport — protect peer-to-peer
communication between end nodes.
• tunnel — include IP-in-IP encapsulation
operations. It’s designed for security gateways
like VPN configurations.
-r size The window size, in bytes, for replay prevention.
The value of size is a decimal number in a 32-bit
word. If size is zero or not specified, replay check
doesn’t take place.
-u id Specify the identifier in order to relate the policy
with the SA. The value of id must be a decimal
number between 1 and 32767.
policy Takes the form:
-P direction discard
-P direction ipsec request ...
-P direction none
See “Setting the policy” in the IPsec protocols page for detailed
descriptions of the above arguments.
protocol Valid options are:

• ah — AH (Authentication Header) based on RFC 2402.
• ah-old — AH based on RFC 1826.
• esp — ESP (Encapsulated Security Payload) based on RFC 2405.
• esp-old — ESP based on RFC 1827.
• ipcomp — IPCOMP (IP Payload Compression Protocol).
spi Security Parameter Index (SPI) for the SAD and the SPD. It’s a
decimal number, or a hexadecimal number prefixed with 0x. SPI
values between the range 0 and 255 are reserved for future use.

upperspec Specify the upper-layer protocol to use, which is one of:

• any (use any protocol)
• tcp
• udp.
Currently, upperspec doesn’t work against forwarding.
Algorithms for protocol

The following tables show the algorithm to use for each protocol parameter. The
protocol and algorithm parameters are almost orthogonal.
Authentication algorithms for aalgo include:
Algorithm: Keylen (bits): Comment:

hmac-md5 128 ah: RFC 2403,
ah-old: RFC 2085
hmac-sha1 160 ah: RFC 2404,
ah-old: 128-bit ICV (no document)
hmac-sha256 256 ah: 96-bit ICV
(draft-ietf-ipsec-ciph-sha-256-00),
hmac-sha384 384 ah: 96-bit ICV (no document),
hmac-sha512 512 ah: 96-bit ICV (no document),
hmac-ripemd160 160 ah: 96-bit ICV (RFC 2857),
Encryption algorithms for ealgo include:
Algorithm Keylen (bits) Comment

des-cbc 64 esp-old: RFC 1829, esp: RFC 2405
3des-cbc 192 RFC 2451
blowfish-cbc 40 to 448 RFC 2451
cast128-cbc 40 to 128 RFC 2451
des-32iv 64 esp-old: RFC 1829
continued. . .

Algorithm Keylen (bits) Comment

des-deriv 64 ipsec-ciph-des-derived-01 (expired)
3des-deriv 192 No document
rijndael-cbc 128/192/256 draft-ietf-ipsec-ciph-aes-cbc-00
Compression algorithms for calgo include:
Algorithm Comment
deflate RFC 2394
Examples:
add 3ffe:501:4819::1 3ffe:501:481d::1 esp 123457
-E des-cbc "ESP SA!!" ;
add 3ffe:501:4819::1 3ffe:501:481d::1 ah 123456

-A hmac-sha1 "AH SA configuration!" ;
add 10.0.11.41 10.0.11.33 esp 0x10001

-E des-cbc "ESP with"
-A hmac-md5 "authentication!!" ;
get 3ffe:501:4819::1 3ffe:501:481d::1 ah 123456 ;
flush ;
dump esp ;
spdadd 10.0.11.41/32[21] 10.0.11.33/32[any] any

-P out ipsec esp/tunnel/192.168.0.1-192.168.1.2/require ;
Exit status:
0 Success.
See also:
/etc/inetd.conf, sysctl
IPsec protocol in the Neutrino Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. setupbsp
Set up a Board Support Package (QNX Neutrino)
Syntax:
QNX Neutrino and Linux hosts:
setupbsp installation_dir archive
Windows hosts:
ksh $QNX_HOST/usr/bin/setupbsp installation_dir archive
Runs on:
All supported hosts.
Options:
installation_dir Where you’d like to install the BSP. This directory must not
already exist, and its name can’t include spaces.
archive The name of the BSP archive. This archive must be a

simplified-style BSP; for more information, see the Working with
a BSP chapter of Building Embedded Systems.
Description:
The setupbsp script opens an archive of a QNX Neutrino 6.3.2 simplified-style BSP
and installs the BSP. The setupbsp script puts two copies of the BSP on your system,
in these locations:
• in the installation_dir, for use with the command-line tools
• under $QNX_TARGET, for importing into the IDE
Decide whether to use the command-line tools or the IDE, and don’t work with the
other copy.
The setupbsp script creates various Makefiles, as well as an uninstall script.
Don’t rename the directory after running setupbsp, or else you won’t be able to build
or uninstall the BSP properly.
After you’ve installed the BSP, you’ll find some or all of the following in
installation_dir (depending on what the BSP includes):
File or directory Description

uninstall A script that will uninstall the BSP and its documentation
images/ All buildfiles and the Makefile
continued. . .

setupbsp © 2010, QNX Software Systems GmbH & Co. KG.
File or directory Description

install/ An empty directory where make installs the binaries that
it builds from the source code
prebuilt/ Prebuilt binaries, libraries, and headers
src/ Source code
Makefile Control file for building the source code
setenv.sh A script that sets up the build environment (to be included
in the Makefile)
source.xml The XML file that the IDE uses
docs/usr/help/product/bsp_BSP_name/ Documentation to be copied to
$QNX_TARGET/usr/help/product
BSP_name_rel.html Release notes
See also:
Working with a BSP chapter of Building Embedded Systems
For information about packaging a BSP, see our Foundry27 community website.

© 2010, QNX Software Systems GmbH & Co. KG. sftp
Secure file transfer program
Syntax:
sftp [-1Cv] [-B buffer_size] [-b batchfile] [-F ssh_config]
[-o ssh_option] [-P sftp_server_path] [-R num_requests]
[-S program] [-s subsystem | sftp_server] host
sftp [[user@]host[:file [file]]]
sftp [[user@]host[:dir[/]]]
sftp -b batchfile [user@]host
Runs on:
QNX Neutrino
Options:
See sftp in the NetBSD documentation.
Description:
The sftp utility is an interactive file transfer program, similar to ftp, which performs
all operations over an encrypted ssh transport. For more information, see sftp in the
NetBSD
See also:
ftp
/etc/moduli, scp, sftp-server, ssh, ssh-add, ssh-agent, ssh-keygen,

sftp-server © 2010, QNX Software Systems GmbH & Co. KG.
SFTP server subsystem
Syntax:
sftp-server [-f log_facility] [-l log_level]
Runs on:
QNX Neutrino
Options:
See sftp-server in the NetBSD documentation.
Description:
The sftp-server is a program that speaks the server side of the SFTP protocol to
stdout and expects client requests from stdin. The sftp-server program isn’t
intended to be called directly, but from sshd using the Subsystem option.
For more information, see sftp-server in the NetBSD documentation.
NetBSD
See also:
/etc/moduli, scp, sftp, ssh, ssh-add, ssh-agent, ssh-keygen,

© 2010, QNX Software Systems GmbH & Co. KG. sh
Public domain Korn shell command interpreter (UNIX)
Syntax:
sh [+-abCefhikmnprsuvxX] [+-o option]
[ [ -c command-string [command-name]
| -s | file ] [argument ...] ]
Runs on:
Options:
See ksh.
Description:
The sh shell is a public-domain version of the Korn shell. For more information, see
ksh.
See also:
esh, fesh, ksh, rsh, uesh

shelf © 2010, QNX Software Systems GmbH & Co. KG.
Photon shelf manager
Syntax:
shelf [-c] [-e] [-m] [-r] [-s server]
Runs on:
Neutrino
Options:
-c Start shelf and open the setup dialog. If shelf is already running, this
just opens the setup dialog.
-e If shelf is already running, make it exit.
-m Disable the right-click menu.
-r If shelf is already running, replace it.
-s server Run shelf on the server at the specified server path or device name.
Description:
The shelf Photon desktop utility provides an easy way to launch applications, view
system information, and switch to currently running applications.
By deafult, the shelf application loads two shelves: one on the right-hand side of the
screen, and one on the bottom. You can modify the default shelf setup by running
shelf -c. For more information on configuring shelf, see the Modifying the shelf
section of the “Using Photon” chapter in the Neutrino User’s Guide.
The shelf’s Launch Menu plugin is configured separately. For more information, see
the Modifying the Launch menu section of the the “Using Photon” chapter in the
Files:
/etc/photon/shelf/shelf.cfg
The default shelf configuration file
$HOME/.ph/shelf/shelf.cfg
When you change the default configuration, the new settings are saved in this
file, so they apply to your current user ID only.
PHSHELF_DISABLE
When set to 1, the ph script doesn’t run shelf when starting Photon.

© 2010, QNX Software Systems GmbH & Co. KG. shelf
See also:
Photon
Modifying the shelf section of the “Using Photon” chapter in the Neutrino User’s
Guide.

showlicense © 2010, QNX Software Systems GmbH & Co. KG.
Display the type of QNX license that’s currently active (QNX Neutrino)
Syntax:
showlicense
Runs on:
QNX Neutrino, Microsoft Windows, Linux
Options:
None.
Description:
The showlicense displays the type (e.g. Commercial, Evaluation) of the active
QNX license. If possible, it also displays a path to the appropriate license text.
See also:
qbinaudit, qconfig, QWinCfg, sysinfo

© 2010, QNX Software Systems GmbH & Co. KG. showmem
Display memory information
Syntax:
showmem [options]
Runs on:
QNX Neutrino
Options:
-D[lsh] Show detailed process information:
• l — libraries
• s — stack
• h — heap
-d file Dump the raw mapinfo to the specified file.
-P Show process / sharedlibrary / summary for the system.
-S Show memory summary (free/used) for the system.
Description:
One of the key stages of optimizing and finalizing your system design is determining
when, where, and how the total system memory is being used. The showmem utility
displays memory information to help you do a comprehensive and complete analysis
of a system and answer the question of “Where has the memory gone?”
See also:
pidin, ps

showmount © 2010, QNX Software Systems GmbH & Co. KG.
Show remote NFS mounts on host
Syntax:
showmount [-ade] [host]
Runs on:
Neutrino
Options:
-a List all mountpoints in this form: host:dirpath
-d Instead of printing the names of hosts, list the directory paths of mountpoints.
-e Show the host’s exports list.
host The name of a host (default is this host).
Description:
The showmount utility shows status information about the NFS server on the
specified host. By default, it prints the names of all hosts that have NFS filesystems
mounted on that host.
Caveats:
Because the NFS server is stateless, mount information is approximate. The
showmount utility displays this information as accurately as the nfsd daemon reports
it.
See also:
nfsd
Based on RFC 1094 (Appendix A: “Mount Protocol Definition”)

© 2010, QNX Software Systems GmbH & Co. KG. show_vesa
Display mode information for VESA BIOSes
You must log in as root and be in text mode — not Photon — to run this utility.
Syntax:
show_vesa
Runs on:
Neutrino (x86 only)
Options:
None.
Description:
The show_vesa utility displays information for VESA BIOSes up to VESA 3. This
information includes general information, such as the amount of video RAM, as well
as details about each supported video mode. This information is sent to stdout.
Examples:
Here’s a sample of part of the output of show_vesa:
VESA Info Block
VESA Signature :
VESA
VESA Version :
0300
OEM String Ptr :
0080:0100
OEM String :
3Dfx Interactive, Inc.
Capabilities :
00000001
DAC width switchable to 8 bits per primary color
Controller VGA compatible
Normal RAMDAC operation
No Hardware Stereoscopic Signaling support
Stereo Signaling supported via external VESA stereo connector
Video Mode Ptr : 0080:0117
Total Memory : 1000000 (16777216)
VBE Software Revision : 0100
OEM Vendor Name Ptr : 0080:015B
OEM Vendor Name String : Elpin Systems, Inc.
OEM Product Name Ptr : 0080:016F
OEM Product Name String : 3Dfx Banshee
OEM Product Rev Ptr : 0080:017C
OEM Revision String : Version 1.00
OEM Data : 3Dfx Interactive, Inc.
DPMS Services available

Virtual Screen Services available
Total Number Of Video Modes found : 33
Mode : 0x0100 information

-------------------------
Mode Attributes : 009F
Mode Supported in Hardware
TTY Output functions supported by BIOS
Color Mode
Graphics Mode
VGA compatible
VGA windowed compatible

show_vesa © 2010, QNX Software Systems GmbH & Co. KG.
Linear Frame Buffer Available

Double Scan Mode Not Available
Interlaced Mode Not Available
No Hardware Triple Buffer Support
No Hardware Stereoscopic Support
No Dual Display Start Address Support
Window A Attributes : 07
Relocatable Window(s)
Window is Readable
Window is Writeable
Window B Attributes : 00
Single-Non Relocatable Window
Window is Not Readable
Window is Not Writeable
Window Granularity : 0040
Window Size : 0040
Window A Start Segment : A000
Window B Start Segment : 0000
Window Function Pointer: C000:2DAA
Bytes Per Scanline : 0280 (640)
X Resolution : 0280 (640)
Y Resolution : 0190 (400)
X Char Size : 08 (8)
Y Char Size : 10 (16)
Number Of Planes : 01 (1)
Bits Per Pixel : 08 (8)
Number Of Banks : 01 (1)
Memory Model : 04 - Packed Pixel
Bank Size : 00
Number Of Image Pages : 40 (64)
Reserved : 01
Flat Frame Buffer Addr : E2000000
Bytes Per Scan Line (Linear) : 0280 (640)
Number of Images for Banked Modes : 40 (64)
Number of Images for Linear Modes : 40 (64)
Red Mask Size (Linear) : 00 (0)
Red Field Position (Linear) : 00 (0)
Green Mask Size (Linear) : 00 (0)
Green Field Position (Linear) : 00 (0)
Blue Mask Size (Linear) : 00 (0)
Blue Field Position (Linear) : 00 (0)
Reserved Mask Size (Linear) : 00 (0)
Reserved Field Position (Linear) : 00 (0)
Maximum Pixel Clock : 09896800 (160000000Hz)

© 2010, QNX Software Systems GmbH & Co. KG. shutdown
Shut down and reboot the system (QNX Neutrino)
Syntax:
shutdown [options]
Runs on:
Neutrino
Options:
-b Shut down but don’t reboot. You can’t use this option with -n
nodename.
-f Shut down fast. Reduce the amount of time between sending a

SIGTERM signal and a sending a SIGKILL to processes that catch
SIGTERM.
-n nodename Shut down the specified node (default is current node).
-q Be quiet.
-S type The type of shutdown, which must be one of:

• system — shut down the system.
• reboot — reboot the system.
The default is reboot.
-v Be verbose.
Description:
The shutdown utility performs an orderly system shutdown as follows:
1 It sends a SIGTERM signal to all processes listed under /proc.
2 It then waits for a period of time (reduced if you specify the -f option).
3 It sends a SIGKILL signal to all remaining processes.
4 It reboots the system (unless you specified the -b option).
The interval between the SIGTERM and SIGKILL signals allows processes that have
elected to catch the SIGTERM signal to perform any cleanup they need to do before the
system is rebooted.

shutdown © 2010, QNX Software Systems GmbH & Co. KG.
Files:
/var/log/wtmp If this file already exists, shutdown adds an entry to it before
shutting down or rebooting the system.
The shutdown utility doesn’t create /var/log/wtmp if it doesn’t already exist. This
file can quickly become very big, which isn’t good on an embedded system with
limited resources.
See also:
phshutdown, procnto
Logging In, Logging Out, and Shutting Down in the QNX Neutrino User’s Guide
shutdown_system() in the QNX Neutrino Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. size
List section and total sizes for an archive or object file (POSIX)
Syntax:
size_variant [options] [objfile...]
Runs on:
Options:
The size_variant depends on the target platform, as follows:
Target platform: size_variant:

ARM ntoarm-size
MIPS ntomips-size
PowerPC ntoppc-size
SH4 ntosh-size
x86 ntox86-size
Description:
The size utility lists the section sizes and the total size for each of the object or
archive files objfile in its argument list. By default, one line of output is generated for
each object file or each module in an archive.
GNU

slay © 2010, QNX Software Systems GmbH & Co. KG.
Kill or modify a process by name or ID (QNX Neutrino)
Syntax:
slay [options]... process_name|process_id ...
Runs on:
Neutrino
Options:
- signal_number A signal number specifying which signal to raise on the
processes matching process_name or process_id. For a list of
signal numbers, see <signal.h>.
-C cpunum (QNX Neutrino Core OS 6.3.2 or later) Set the CPU affinity to
cpunum, where the first CPU is 0. You can use this option
multiple times. For more information, see “Setting the
runmask,” below.
-f Force the action to be taken on all processes sharing the same

process_name or ID. Normally, slay prompts for confirmation
when more than one process bears the specified name or ID.
-h Set a SIGSTOP signal on a process, effectively holding its

execution.
-i (QNX Neutrino Core OS 6.3.2 or later) Set the inherit mask in

addition to the runmask, when used in conjunction with the -C
or -R option. For more information, see “Setting the runmask,”
below.
-m name|pid Restrict the match to only the process name or to only the
process ID. By default, slay matches both process IDs and
names. For example:
This command: Matches a process with:

slay 1234 ID 1234 or the name 1234
slay -m pid 1234 ID 1234
slay -m name 1234 The name 1234
-n nodename (QNX Neutrino Core OS 6.3.2 or later) Search for the specified
processes on the specified remote node nodename.
-P prio[f|r|o] Set the priority of the processes matching process_name to

prio. Non-root users are limited to a maximum priority of 63;

© 2010, QNX Software Systems GmbH & Co. KG. slay
root can specify a priority up to 255. You can change the

range of privileged priorities with the -P option for procnto.
The priority may be followed by f, r or o to change the
scheduling policy to SCHED_FIFO, SCHED_RR or
SCHED_OTHER, respectively.
SCHED_OTHER is currently the same as SCHED_RR.
If you specify -P without -T, slay sets the priority of all

threads in the specified process or processes.
-p Print the process IDs, in decimal, to standard output, with one

process ID per line. The processes aren’t slain.
-q Query before dealing with the process, even if only one process
is found with a matching name or ID (overrides option -f).
This option is useful for viewing the other process information
that slay presents.
-Q Be quiet. This option is useful when you invoke slay from a C

program.
-R runmask (QNX Neutrino Core OS 6.3.2 or later) Set the CPU affinity to
runmask. You can use this option multiple times to specify
masks that are more than 32 bits long. For more information,
see “Setting the runmask,” below.
-S Don’t kill processes that have child processes. You typically use
this option in a shell command that shuts down shells on other
devices. Setting this option prevents slay from killing shells
that have other processes (such as editors) running. If you also
specify -q, slay prompts for a forced kill even if the named
process has child processes.
-s signal_name The signal to send. This option causes the signal sig to be raised
for the processes matching the process_name or ID.
-T tid (QNX Neutrino Core OS 6.3.2 or later) Apply the action to the
thread with the given ID. You can use this option to direct a
signal to a specific thread, or to change a thread’s priority or
runmask.
-t ttyname Match only those processes whose name (or ID) is

process_name (process_id) and have ttyname as the controlling
terminal. If ttyname doesn’t begin with a slash (/), slay
assumes that it starts with the /dev/ prefix.
-u Set a SIGCONT signal on a process. If execution of the process

was being held by a SIGSTOP signal, execution begins where it

left off. If the process hadn’t previously had a SIGSTOP set

upon it, the SIGCONT signal has no effect.
-v Be verbose; display messages about processes being signaled.
process_name The name of a process to operate on.
process_id The ID of a process to operate on.
Description:
Use the slay utility to kill or modify a process by name or by ID. Process names are
specified without the path. For example, let’s say you have a process called
/bin/sleep that you want to kill. Entering sleep as the process name is sufficient
to allow slay to find and kill it.
There are many forms of this command. The simplest and most often used form is:
slay process_name|process_id
This command locates the process bearing the specified name or ID. If only one is
found, a SIGTERM signal is set on it. If more than one process bears the specified
name or ID, you’re prompted for a yes/no response for each process. When each
process is listed in this form, the process name, pid, and tty group/member numbers
are also displayed to help you make a selection.
To set a signal on a process you must either own the process or be logged in as root.
Setting the runmask

On a multicore system, you can use a runmask to specify which processors a thread or
process can run on. The default is all 1s (i.e. all CPUs).
The runmask is useful only on multiprocessor systems.
You can use slay to change the runmask, or the runmask and inherit mask, for threads
that are already running; to set the masks for a new process, use the on command.
Both commands interpret the -C and -R options in the same way.
You can use more than one -R option to specify a runmask that’s more than 32 bits
long. The first -R option specifies bits 0 through 31, the second specifies bits 32
through 63, and so on.
If you use both the -C and -R options or multiple instances of them, the resultant mask
is the bitwise ORing of all -C and -R options. For example, slay -R 0x1 is
equivalent to slay -C0, and slay -R 0x1 -C3 is equivalent to slay -C0 -C3.
When you use -R or -C without -T, all threads in the specified process or processes
are affected.

© 2010, QNX Software Systems GmbH & Co. KG. slay
If you use -R or -C, slay always changes the runmask for the specified threads or
processes. If you also specify the -i option, slay also sets the inherit mask to the
same value as the runmask.
• If the resulting runmask specifies at least one CPU that’s physically present, the
runmask is accepted, and any bits that correspond to CPUs that aren’t present are
ignored. If the resulting runmask doesn’t specify any CPU that are physically
present, an error results.
• If you change the runmask for a process, the processor for blocked threads doesn’t
change until the threads become unblocked (or never if the threads remain blocked).
For more information about runmasks, see the Multicore Processing chapter of the
System Architecture guide, and the Developing Multicore Systems chapter of the
Multicore Processing User’s Guide.
Examples:
Kill the spooler process on node peterv:
slay -n peterv spooler

As root, change priority of the my_test process to 20:
slay -P 20 my_test
Exit status:
0 No processes matched the supplied criteria, an error occurred, or the
number of processes matched and acted upon was an even multiple of
256.
1-128 The number of processes matched and acted upon modulo 256 (e.g. a
status of 1 could mean 1 process, 257 processes, 513 processes etc.)
129-160 If the exit status was gleaned through direct spawning, this is the number
of processes matched and acted upon modulo 256. If slay was run
through the shell, this is either the number of processes matched and
acted upon, or it indicates why slay died due to a signal (subtract 128
from the exit status to determine the signal number).
161-255 The number of processes matched and acted upon, modulo 256.
Caveats:
The exit status of slay is nonstandard for historical reasons. We strongly recommend
that you not use slay in any situation where the exit status is relied upon because the
status is ambiguous in some circumstances.

See also:
kill, on, pidin, ps
Multicore Processing chapter of the System Architecture guide, the Multicore
Processing User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. sleep
Suspend execution for an interval (POSIX)
Syntax:
sleep time
Runs on:
Options:
time For POSIX conformance, this must be a nonnegative decimal integer, from 0
to 4294967295, specifying the number of seconds to suspend execution.
As a QNX Neutrino extension, time can be a floating point number, so you
can specify fractions of seconds.
Description:
The sleep utility suspends execution for at least the number of seconds specified by
the time operand.
Exit status:
0 The execution was successfully suspended for at least time seconds, or a
SIGALRM signal was received.
Caveats:
The sleep utility takes the default action for all signals, except that sleep terminates
normally with a zero exit status on receipt of a SIGALRM signal.
See also:
sh

slinger © 2010, QNX Software Systems GmbH & Co. KG.
Tiny webserver
Syntax:
slinger [-a administrator] [-c] [-d] [-e]
[-i address] [-n] [-p port_number] [-s]
Runs on:
Neutrino
Options:
-a administrator Contact information of the administrator of Slinger (e.g. -a
my_admin@something.com). The information is stored in the
SERVER_ADMIN environment variable. The default is
nobody.
-c Request that HTML files with SSI not be placed in the browser
cache. Instead of using a previously downloaded version from
its local cache, the browser contacts the server whenever it
displays an HTML file containing SSI. Use this option when
you’d like the browser to display the latest version of your
dynamic SSI data.
-d Write debugging info to the system log. In order to capture the
log messages, you need to have syslogd running.
-e Enable the SSI exec command.
-i address The interface for slinger to listen on (e.g. 10.0.0.1). The
default is any.
-n Don’t move to the background.
-p port_number Set the port number.
-s Enable the SSI commands.
Description:
The slinger utility is an HTTP server for resource-constrained environments.
Slinger is compliant with the CGI 1.1 and HTTP 1.1 standards, and provides support
for dynamic HTML via Server Side Includes (SSI).
Running Slinger
To run Slinger, type:
slinger &
The slinger server listens on the TCP port 80. Since this is under 1024, slinger
needs to be run as root. As soon as it has attached to the HTTP port, it drops itself
down to user -2 (setuid (-2)).

© 2010, QNX Software Systems GmbH & Co. KG. slinger
How dynamic HTML works

Slinger supports Server Side Include (SSI) commands to provide dynamic HTML. For
example, Slinger uses the PATH and CMD_INT environment variables to provide
information to the SSI command, exec. Using dynamic HTML, clients can offer
interactive realtime features on their web pages.
Clients code dynamic HTML by placing SSI tokens in the HTML code of their web
pages. The SSI token contains an SSI command that’s handled by Slinger. While
transmitting the HTML code, Slinger replaces a token with HTML data based on the
tag contained in the SSI token.
For Slinger to process SSI tokens, the HTML file must have .shtml as its file
extension.
Syntax of an SSI token

The syntax of an SSI token is as follows:

where:
 Ending delimiter of SGML/HTML comment.
There must be a space before the ending comment delimiter.
There’s no limit to the token size (other than memory).
SSI commands
The valid SSI commands are: break, config, echo, exec, if, goto, include,
label, and qnxvar.
break
Terminate transmission of an HTML document at any point. The break command has
no arguments, so the syntax is:


config
Set certain HTML output options. The syntax is:

The variable_set may contain: cmdecho, cmdprefix, cmdpostfix, errmsg,

onerr, timefmt. For details, see the “config commands” section.
echo
Insert data from an HTML form field or an environment variable onto an HTML page.
The echo command has one argument, var. The syntax is:

where string is the value of an HTML form field or an environment variable. For
example:

Or

The echo command uses these SSI variables, as well as CGI environment variables
(for more information, see the Environment variables section in this utility):
DATE_GMT Current Greenwich Mean date and time.
DATE_LOCAL Current local date and time.
DOCUMENT_NAME
Complete local pathname of the current web page.
DOCUMENT_URI
Local pathname of the current web page referenced to the base
directory of the web space.
LAST_MODIFIED
Date and time of the last modification of the current web page.
QUERY_STRING_UNESCAPED
Unescaped query string sent by the remote client. All characters
that are special to the shell are escaped with \.
exec
Spawn an external program and print the output at the location of the exec token on
the HTML page. The external program is spawned to increase performance. The exec
command takes the following arguments:
• cgi — Path and filename of a CGI script. The syntax is:


where:
executable Name of a CGI executable.

pathinfo Path information provided to the executable. (The PATH
environment variable can also contain path information provided to
CGI scripts.)
For example, suppose you have a CGI script, othello.cgi, and the
HTTPD_SCRIPTALIAS environment variable contains the directory
/web/games/. If you put the following token on your HTML page, Slinger
searches for the othello.cgi script in the /web/games/ directory:

• cmd — Spawn a shell and run a shell executable command. The syntax is:

where:
[path/ ]executable Name of an executable command.

args List of command-line arguments.
The cmd token uses the CMD_INT environment variable to identify the command
interpreter, shell_program, and then spawns a shell using the following:
shell_program -c "string"
where string is [pathname/ ]executable [arguments].

If a full pathname isn’t provided, Slinger uses the path defined in the PATH
environment variable to locate the shell_program and the executable. You can echo
the output using:

For example:


if
Conditionally execute SSI operations and conditionally print the HTML text. The
syntax of the if command is:

where:
op1 A string that’s the first operand of a logical comparison statement.

op2 A string that’s the second operand of a logical comparison statement.
operator One of == != < > !< !> hasstring
operation Action to take if the logical comparison evaluates to TRUE, where the
possible actions are: break, error, errorbreak, goto, print, and
printbreak.
The hasstring operator returns TRUE if the character string in op2 is found in the
op1 string.
If both operands are numbers, they’re compared as numbers; otherwise, the
comparison is based on the alphabetic order of the operands.
If the logical comparison evaluates to FALSE, nothing happens. For example:

The NULL operand is defined by "". NULL may be used to check for the existence of
data in a form field.
For example, if you have a form with the field Last name and you want to ensure the
user doesn’t leave it blank, then the token is:

If the field isn’t empty, nothing happens. But if the field is empty, the message is
displayed and the HTML document terminates.
goto
Jump to a labeled token (without printing skipped text or applying skipped tokens).
The syntax of the goto command is:

where label_name is defined in a subsequent label command on the HTML page.
Remember to put a space before the equal sign.
Here’s an example of how the goto and label commands are used together:







include
Insert the contents of a file into an HTML page. The include command takes these
arguments:
• file — The syntax is:


where pathname is the path and filename of an HTML file relative to the directory
of the current web page. Don’t use absolute paths, and don’t use ../ in the
pathname (since you can’t include a pathname that begins above the current
directory).
Use the file tag when you include files that are in the same directory as the
current directory. For example, suppose you have a directory
web/support/docs/ containing two files my_doc.html and docs.html, and
the URL is www.something.com/support/docs/docs.html. To insert the
my_doc.html file into the HTML page, write the token as:

The file my_doc.html is relative to the directory (web/support/docs) of the

current document (docs.html).
• virtual — The syntax is:


where pathname is the path and filename relative to the root directory on the
Slinger server, configured in the HTTPD_ROOT_DIR environment variable.
When you use the virtual tag, Slinger begins its search for the file from the root
directory. For example, suppose you have a directory web/support/docs/ that
contains the file my_doc.html, and the HTTPD_ROOT_DIR environment
variable contains the web directory. To insert my_doc.html into the HTML page
with the URL web/support/docs/my_doc.html, write the token as:

The include command is recursive; each file inserted may contain include tokens.
Although the inserted file can’t be a CGI script, it can contain a reference to a CGI
script.
label
When Slinger encounters a goto command, jump to the label token on the HTML
page. The syntax of the label command is:


The maximum length of label_name is 60 characters. Remember to put a space before

the equal sign.
For example:

qnxvar
Get data or change data on the data server process. The qnxvar command takes the
following arguments:
• format — Set the format for subsequent displays of data obtained from the data
server process, on the HTML page. The syntax is:

where:
%s A placeholder for the value of the variable.

text Text that can contain HTML tags, for example .
The format remains in effect until the next format statement. For example:

If you want to print the % sign followed by a variable, you have to enter: \% %s. To
print %s, type \%s.
• read — Get the value of a variable on the data server process and display the result
at the location of the qnxvar token on the HTML page. The syntax is:

where len is the size in bytes.

Data is printed up to NULL or the length of the data. The format of the result is
specified with the format tag. For example:

• write — Change a variable on the data server process. The syntax is:

where data is a string. For example:



The maximum length of var_name is 60 characters. Don’t omit the space after the
var_name.
config commands
cmdecho [ON | OFF]
Set the output option of subsequent exec tokens. The default is
OFF, meaning the output isn’t parsed or printed. The cmdecho
command doesn’t apply to the output of CGI scripts.
cmdprefix Set a prefix to each line output from subsequent exec tokens. The
syntax is:

where string is any character string or HTML format tag.

If cmdecho is set to ON, the output is prefixed with string.
Otherwise, the output isn’t parsed or printed.
cmdpostfix Set the string appended to the end of each line output from exec
tokens. The syntax is:

where string is any character string or HTML format tag.

If cmdecho is set to ON, the output is appended with string.
Otherwise, the output isn’t parsed or printed.
For example, to make the output of the exec command appear on
separate lines:

errmsg Compose an error message and print it when Slinger encounters an

SSI error, such as a parsing error or unavailable required data. The
syntax is:

where string is any character string or HTML format tag. For

example:

The error message remains in effect until the next errmsg is

configured.

onerr Set the action to be taken when Slinger encounters an error. The
syntax is:

The possible values of action are:

• goto —Jump to a labeled token. The syntax is:

For example:

• break — Terminate transmission of the HTML document to the

client.
• error — Print the current error message specified by errmsg.
• errorbreak — Print the current error message specified by
errmsg and terminate transmission of the HTML document to
the client.
• print — Print text. The syntax is:

where string is any character string or HTML tag.

• printbreak — Print text and terminate transmission of the
HTML document to the client. The syntax is:

where string is any character string or HTML tag. For example:


timefmt Set the format of the date and time. The syntax is:

where string is compatible with the ANSI C library function,

strftime(). The default string is %a %b %d %T %Y.
For example:


Ways to achieve dynamic HTML

You can dynamically generate HTML in order to support changing systems. The main
components in such a system are:
• the changing element
• external applications that activate and read change
• the data server process
• Slinger
• the remote clients.
There are three ways to provide dynamic HTML:
• CGI interface. This is described in many commonly available books.
• Write an I/O manager to provide changing HTML each time the prefix is
opened/read.
• Use Server Side Includes with the data server. The rest of this section describes this
method.
The data server

The data server process, ds, stores global data. External applications can modify or
read this global state through the use of the data server API. Slinger can modify or
read the global state via the qnxvar SSI command.
Here’s a conceptual view of a device monitored and controlled by both an external
application and a remote client of Slinger:

External Data
Slinger
app server
SSI token
Remote
client
Device (e.g. a printer)
HTML page
Using the data server.
To use dynamic HTML:
1 Use the SSI tokens to manipulate the HTML page.
2 Use the qnxvar tokens to query and manipulate the global data.
3 Write an application to manipulate the global state using the data server library
functions. See the examples in the ds utility.
Executing CGI scripts

If you want your CGI script to be executed, then the script must be requested with the
URL:
http://hostname/cgi-bin/scriptfile
where:
hostname Name of the host or the IP address of the host running Slinger.
cgi-bin Execute the CGI script file specified.
scriptfile Name of the CGI script to be executed. Slinger uses the environment
variable HTTPD_SCRIPTALIAS to locate the pathname of the CGI
script file.
When Slinger executes a CGI script, it parses the output of the script for HTTP header
directives. Slinger must buffer the header directives, before transmitting the script
data, in case a header directive is passed that’ll affect the format of the default header
directives. Up to 1K of header information can be buffered. CGI scripts must provide
a valid header.

Slinger identifies the end of the header as a blank line, lines are terminated with a
<LF> or a <CR><LF>. A common HTTP header directive to provide specifies the
type of data that the CGI script provides. The default Content-Type is “text/html.” For
example:
Content-Type: text/html<LF>
<LF>
CGI script data...
Slinger supports the following CGI header directives:
Directive Description Example

Content-Type Type of data being sent back to the client. Content-Type: text/html
Location Reference a file by a URL. Location: http://www.qnx.com
Status Pass a status code and explanation back to the client. Status: 200 OK
If Slinger executes the script successfully, it passes a
status of 200 OK (unless the script changes the status).
Any other directives are just added to the HTTP header.
A script with the filename prefix nph- (e.g. nph-myscript.cgi) won’t be parsed by
Slinger; only the raw data from the script is sent. Because Slinger doesn’t add any
HTTP header content, any script that isn’t parsed must provide the entire HTTP header
in its script output.
Security precautions
When you choose the directory for your data files:
• Don’t place any sensitive files in the document directory.

• Isolate your data files directory from the system files directory. For example,
/usr/www is much safer than the root directory, /. The root directory / opens up
your whole system to be served by Slinger.
If you configure Slinger to support CGI:
• Place the CGI scripts in a directory isolated from your normal system binaries.
Don’t use /bin or /usr/bin as your CGI directory.
• Avoid setting your CGI script file permissions to “set user ID when executing”
when the file is owned by a privileged user (e.g. root).
• Keep your CGI scripts and documents in separate directories. This prevents people
from accessing your scripts.
Don’t expose your machine to undue risk. Make sure that:
• The permissions on all the files and directories are read-only.

• No files are owned by userid (-2) because Slinger runs as userid (-2) and you
don’t want Slinger to own the files.
These precautions prevent somebody from giving your machine a new password file or
tampering with your web pages.
Examples:
The right way
We recommend that you put your documents and scripts in separate directories. In this
example, the documents are in the /usr/webdoc directory, the root document is
foo.html, and the CGI scripts are in /usr/web/cgi:
export HTTPD_ROOT_DIR=/usr/webdoc
export HTTPD_ROOT_DOC=foo.html
export HTTPD_SCRIPTALIAS=/usr/web/cgi
slinger &
The “wrong” way

In this example, anyone can download the scripts because the documents and scripts
are in the same directory:
export HTTPD_ROOT_DIR=/usr/web
export HTTPD_ROOT_DOC=foo.html
export HTTPD_SCRIPTALIAS=/usr/web
slinger &
Files:
The slinger webserver requires a TCP/IP stack (included in io-pkt*) and the
libsocket.so shared libraries.
Slinger configuration
Slinger uses the following environment variables to set its configuration:
PATH The pathname of the command interpreter and shell executable

command used in the SSI command, exec. For more information,
see the exec cmd description.
CMD_INT The pathname or name of the shell program used to interpret the
string passed to the SSI command, exec cmd (e.g. /bin/sh). If the
pathname isn’t given, Slinger searches the pathname in PATH for the
shell program.
HTTPD_ROOT_DIR
The name of the directory where Slinger looks for data files. The
default is /usr/local/httpd.

HTTPD_ROOT_DOC
The name of the root document (e.g. index.html). When a web
client requests the root document, HTTPD_ROOT_DOC is
appended to HTTPD_ROOT_DIR to build the full pathname of the
root document. The default is index.html.
For example, let’s say HTTPD_ROOT_DOC is defined as
index.html and HTTPD_ROOT_DIR is defined as /usr/www.
Slinger appends index.html to /usr/www to build
/usr/www/index.html.
HTTPD_SCRIPTALIAS
The directory where Slinger looks for the CGI executables.
Note that if you define HTTPD_SCRIPTALIAS, anybody can run
scripts or processes that reside in this directory on your machine. Not
defining HTTPD_SCRIPTALIAS turns CGI off, causing all CGI
requests to fail.
For example, suppose HTTPD_SCRIPTALIAS contains
/cgi/bin as the name of the directory. If Slinger gets a request for
the resource www.qnx.com/cgi-bin/get_data.cgi/foo, the
get_data.cgi script found in /cgi/bin is executed, and foo is
sent as pathname information to get_data.cgi. The foo directory
is stored in the PATH_INFO environment variable (described
below).
CAUTION: To help keep your system secure, don’t use /bin or /usr/bin as your
! CGI directory.
Available to CGI scripts

Slinger sets the following environment variables, which can be used by CGI scripts:
ACCEPT_LANGUAGE
The languages that can be read by the remote client.
CONTENT_LENGTH
Length of attached information in the case of a POST.
CONTENT_TYPE Type of attached information in the case of a POST.
DOCUMENT_ROOT
Location of data files. (Same as HTTP_ROOT_DIR.)
FORWARDED Name of the proxy server through which the web page is being
processed.

FROM Name of the remote client user.
GATEWAY_INTERFACE
Name and version of the Common Gateway Interface served
on Slinger.
HTTP_ACCEPT MIME types that the client accepts, as given by HTTP headers.
HTTP_USER_AGENT
The browser that the client is using to send requests.
PATH Pathname of the command interpreter and shell executable

command used in the SSI command, exec.
PATH_INFO Extra path information sent.
PATH_TRANSLATED
Append the pathname in PATH_INFO to the pathname in
HTTPD_ROOT_DIR.
QUERY_STRING Raw query string sent from the remote client.
REFERER URL of the HTML page that referred the remote client to this
web page.
REMOTE_ADDR IP address of the remote client.
REMOTE_HOST Hostname of the remote client.
REMOTE_IDENT Remote username if supporting RFC 931 identification.
REMOTE_PORT Port of the remote client.
REMOTE_USER Username used to validate authentication from the remote

client.
REQUEST_METHOD
Method by which the current web page was requested (GET or
POST).
SCRIPT_NAME Name of the script being executed.
SERVER_ADMIN Contact information of the administrator of Slinger specified

by Slinger’s -a option.
SERVER_NAME Name of the computer where Slinger is running.
SERVER_PORT IP port that Slinger is answering on.
SERVER_PROTOCOL
Name and version of HTTP served on Slinger.

SERVER_SOFTWARE
Name of Slinger software.
SERVER_ROOT Current working directory of Slinger.
TZ Time zone.
Caveats:
The slinger webserver communicates over TCP sockets, so you need to have socket
runtime support. This means you need to have a TCP/IP stack running.
When configuring slinger, take care not to expose your machine to undue risk:
• The directory containing the documents shouldn’t have any sensitive files in it.
• The permissions should be read-only on all the files and directories.
• The ownership of the files shouldn’t be user -2(32767).
These precautions prevent somebody from giving your machine a new password file,
or tampering with your web pages.
If you configure slinger to support CGI, keep the following in mind:
• Anyone can run processes on your machine.
• The CGI scripts should all be in a directory isolated from your normal system
binaries. In other words, don’t use the /bin or /usr/bin directories for your CGI
directory!
Besides these precautions, you should also keep your documents and scripts in
separate areas. This prevents people from either reading or modifying your scripts.
See also:
ds, io-pkt*
Setting Up an Embedded Web Server in the Neutrino User’s Guide
Based on RFC 2068

slogger © 2010, QNX Software Systems GmbH & Co. KG.
System logger
Syntax:
slogger [-c] [-f severity] [-l logfile[,size]]
[-s size] [-v[v]...]
Runs on:
Neutrino
Options:
-c Open the log file with O_SYNC to forcibly commit the logged
events to the disk.
-f severity Log only events to the logfile with this severity or higher. This
option is useful only with the -l option; slogger always saves
all events in its internal buffers. The lowest severity is 7 and the
highest is 0. The default is 7.
-l logfile[,size] Write a copy to logfile of each event that has a severity that’s
numerically less than or equal to that specified by the -f option.
If you specify the optional size after the filename, slogger
alternates between two files, logfile0 and logfile1, as the files
reach the given size.
-s size Maintain a circular in-memory log buffer of this size (in

kilobytes) to hold system log messages. When the buffer becomes
full, the oldest messages are replaced by new ones as they arrive.
The default size is 16 KB.
-v[v]... Be verbose; more v characters cause more verbosity.
Description:
The system logger, slogger, is the central manager for logging applications’ system
messages. It maintains these messages in a circular buffer, allowing them to be read
later or in real time. When the buffer fills, new messages replace the oldest ones in the
buffer. If you use the -l and -f options, slogger also writes the messages to a log
file, as described below.
Each system message is assigned a unique major code, minor code and a severity. The
severity levels are as follows:

© 2010, QNX Software Systems GmbH & Co. KG. slogger
Manifest Name Value Description

_SLOG_SHUTDOWN 0 Shut down the system NOW (e.g. for OEM use)
_SLOG_CRITICAL 1 Unexpected unrecoverable error (e.g. hard disk
error)
_SLOG_ERROR 2 Unexpected recoverable error (e.g. need to reset a
hardware controller)
_SLOG_WARNING 3 Expected error (e.g. parity error on a serial port)
_SLOG_NOTICE 4 Warning (e.g. out of paper)
_SLOG_INFO 5 Information (e.g. printing page 3)
_SLOG_DEBUG1 6 Debug messages (e.g. normal detail)
_SLOG_DEBUG2 7 Debug messages (e.g. fine detail)
If you specify the -l logfile option, slogger creates a separate thread that saves to
the specified file each system message that’s of the severity given in the -f option.
If you use the optional size argument to the -l option, slogger alternates between
two files, logfile0 and logfile1. When one file reaches the size given, slogger closes
it and opens the other file. This file is truncated to zero length and new messages are
written to it until it fills up. The process of alternating then repeats. This way you
always have one file containing the latest messages and another file containing the
most recent history.
Applications that can’t assume that they have a standard console output that’s
viewable should use slogger for logging notices, warnings and errors. This includes
all drivers and resource managers.
The slogger manager creates these devices in the pathname space:
/dev/slog Used to read and write system log messages.
/dev/console Implements a simple console tty that saves what you write to it in
the system log. Reads always return end-of-file.
Applications wishing to post a new system log message should use the library routines
slogb(), slogf(), slogi(), and vslogf(), which properly format the data and issue a write
to /dev/slog.
To view the log, use sloginfo. Applications wishing to read system log messages
may open /dev/slog for reading and issue read() calls. Each read may return one or
more messages, but messages are never split across a read.
More than one application may open /dev/slog for reading at a time. Each sees its
own copy of the data and doesn’t affect the others. This allows multiple filters, each
looking for certain log messages, to be run in parallel. Here’s a simple filter that prints
codes and severities:

slogger © 2010, QNX Software Systems GmbH & Co. KG.
#include <stdio.h>
#include <stdlib.h>
#include <fcntl.h>
#include <time.h>
#include <errno.h>
#include <sys/slog.h>
int main(int argc, char *argv[]) {

int events[4096];
int *evp;
int n;
int wait = 0; // Set to 1 to block and print
// new events as they arrive.
int fd;
fd = open("/dev/slog",
wait ? O_RDONLY : O_RDONLY|O_NONBLOCK);
for(;;) {
int cnt;
// Read some events.

n = read(fd, events, sizeof(events));
if(n == -1) {
// Normal case for a non-blocking read
// with no events.
if(errno == EAGAIN) {
exit(EXIT_SUCCESS);
}
exit(EXIT_FAILURE);
}
// Converts bytes to ints (all events are

// composed of ints).
n /= sizeof(int);
if(n == 0)
break;
for(evp = events ; evp < &events[n] ;

evp += cnt) {
int major, minor, severity, txt;
time_t sec;
char timebuf[60];
major = _SLOG_GETMAJOR(evp[1]);
minor = _SLOG_GETMINOR(evp[1]);
cnt = _SLOG_GETCOUNT(evp[0]) +
_SLOG_HDRINTS;
severity = _SLOG_GETSEVERITY(evp[0]);
txt = _SLOG_GETTEXT(evp[0]);
sec = evp[2];
strftime(timebuf, sizeof(timebuf),
"%h %d %T", localtime(&sec));
printf("%s %d %5d %2d ", timebuf,
severity, major, minor);
if(txt)
printf("%s",
(char *) &evp[_SLOG_HDRINTS]);
}

© 2010, QNX Software Systems GmbH & Co. KG. slogger
exit(EXIT_SUCCESS);
}
You can clear the system log buffer by calling unlink("/dev/slog") from a
program, or rm /dev/slog from the shell.
The slogger manager replaces the older Unix system logger daemon, syslogd. The
Unix library routines for syslogd output their messages to /dev/console, which is
caught and logged by slogger.
You should start slogger as soon as possible after the system boots (see the
Controlling How Neutrino Starts chapter of the Neutrino User’s Guide). Otherwise,
messages from managers or drivers that were started before it may be lost. If slogger
is killed (or never started), all messages that programs send to slogger are lost. If
slogger is started or restarted, new messages go to the new slogger.
Examples:
Log system messages:
slogger
Maintain an awesome in-memory buffer for system messages:
slogger -s 100k
In addition to keeping an in-memory buffer, save in a file those system log messages
of severity 0, 1, or 2:
slogger -l /var/logs/slogs -f 2
In addition to keeping an in-memory buffer, save all system log messages in a file.
Since a size option is specified, the log file alternates between slogs0 and slogs1,
switching as each file reaches a size of 100 KB:
slogger -l /var/logs/slogs,100k
See also:
sloginfo
slogb(), slogf(), slogi(), vslogf() in the Library Reference

sloginfo © 2010, QNX Software Systems GmbH & Co. KG.
Print messages from the system log
Syntax:
sloginfo [options] [filename]
Runs on:
Neutrino
Options:
-c Clear the log buffer after displaying all waiting events.
-h Print unformatted entries in hexadecimal. By default, they’re printed in

decimal.
-m code Display events with this major code (default: display all).
-s 0..7 Display events with this severity or lower (default: 7). The lowest
severity is 7 and the highest is 0.
-t Print time for events with millisecond resolution.
-w Wait for more events to arrive.
filename The name of the file containing raw events (default: /dev/slog).
Description:
The sloginfo utility prints the contents of the system log buffer managed by
slogger, which must be running to record these messages.
By default, sloginfo prints all messages and exits. You can use the -w option to
have it wait for more messages.
You can use the -m and -s options to filter the messages to print. There are 16 million
major codes, with 4096 minor codes for each major code. Selecting a major code
displays messages with any of the minor codes for the specified major code. You can
use the major codes to display messages for a specific area, such as TCP/IP. The major
codes are defined in the file /usr/include/sys/slogcodes.h.
If a filename is specified, sloginfo takes its input from that file instead of
/dev/slog. It’s assumed that the file contains raw system log data saved by a
program or is the file specified in the -l option to slogger.
Examples:
Print out all system log messages and exit:
sloginfo
Print out all system log messages and wait for more to arrive, printing them as they do:

© 2010, QNX Software Systems GmbH & Co. KG. sloginfo
sloginfo -w
Print out all system log messages, clear the log, and exit:
sloginfo -c
Display only system log messages with a severity of 0, 1, 2, 3, or 4:
sloginfo -s 4
Display the system log messages stored in a specific file:
sloginfo /var/logs/slog0
Files:
/dev/slog The default system log file.
See also:
slogger
slogb(), slogf(), slogi(), vslogf() in the Library Reference

smic © 2010, QNX Software Systems GmbH & Co. KG.
Management Information Base (MIB) compiler
Syntax:
smic [options...] includefile
Runs on:
Neutrino
Options:
-0 Set message (and error) file to output file.
-1 Print copyright.
-2 Print version.
-3 Allow INDEX clause on objects.
-4 Allow nonstandard access for objects.
-5 Allow “optional” status.
-6 No check on table, row, sequential names.
-7 Check for all index items in sequence.
-8 Output in MOSY Format.
-9 Output in Extended MOSY Format.
-A Dump Alias names.
-B Strong check size/range of index items.
-C Check size/range.
-D Dump all.
-E Allow seq item syntax to match TC.
-F file Name of output file.
-G Turn off warnings for unused IMPORTs and textual conventions.
-J Allow DEFVAL on Counter/Gauge.
-K Dump SMI names.
-I Print names of include files.
-L Dump OID names.
-M Dump module names.

© 2010, QNX Software Systems GmbH & Co. KG. smic
-N Dump OID tree and traps.
-O Dump OID items.
-Q Dump Sequences.
-P Dump Trap names.
-R Check INDEX objects for read-only.
-S Dump string table.
-T Dump IMPORT names.
-U Print resource usage statistics.
-V Dump Textual conventions.
-W Strong check of seq item syntax.
-X Suppress strings in scanner.
-Z Output to file in intermediate format.
includefile Name of the file that contains the order of modules to be compiled.
Description:
You can use the smic Management Information Base (MIB) compiler to check the
syntax of SNMP MIB modules, using varying levels of strictness. Using the options,
you can specify the output from the smic utility:
• Internal data structures used for debugging.
• Intermediate file that can be parsed by other programs.
• MOSY and Extended MOSY output.
• List of object name to object identifier assignments.
• List of defined traps.
The MIB compiler supports:
• Concise MIB format (rfc1212).
• Concise trap format (rfc1215).
• Multiple MIB modules.
• Items in IMPORTs.
• Textual conventions.
• Alias assignments for modules and object names.

• Selective checking of MIB constructs.
• Extensive MIB syntax checking and continuation of syntax checking after syntax
errors.
• Extensive checking of MIB consistency.
To use smic, you first need to obtain the MIBs that you wish to compile (ASN.1
modules). A common place to find MIBs are in RFCs. If the text file that contains the
MIB has any text before or after the MIB module, that extra data must be stripped
from the file (see mstrip). You can sort these MIB modules into different directories.
The SMICINCL environment variable can then be used to define what directories the
MIB module files exist in. The current directory is searched first. For example:
setenv SMICINCL /usr/mibs/rfc:/usr/mibs/custom

Once you’ve collected your MIB modules, you’ll need to create a “MIB include file.”
This file is used to define what modules are to be compiled, and in what order. The
include directives must be ordered so that all IMPORTed items must be defined in a
previously included MIB. You can also define other directives (see Include File).
Once these steps are complete, you can run the smic MIB compiler as:
smic includefile
Refining syntax checking

You can use a variety of options to control how strictly the compiler does its syntax
checking, as well as what output it generates:
Print out information regarding the type of objects and files that smic has processed:
-A, -D, -I, -K, -M, -N, -O, -P, -Q, -S, -T, -V
Control how strictly the smic utility syntax checks the MIB modules:
-3, -4, -5, -6, -7, -B, -C, -E, -G, -J, -R, -W
Suppress the use of strings from the description and reference clauses in the MIB text
files. Since these elements take up a significant amount of memory when they are
being compiled, this option can be useful if you have a limited amount of memory:
-X
Print the output generated by smic to a file instead of stdout, the default:
-F
Include File
The include file can consist of the following directives. Please see the example for
layout. These directives can also be placed in the MIB files, but they can only be
placed between the MIB modules.
#help Print a list of directives.

© 2010, QNX Software Systems GmbH & Co. KG. smic
#include filename Include the filename in the compile. The filename must be in
quotes, and can contain several MIB modules.
#aliasModule [module] [alias]
The alias directives are used to define alternative names for the
items in the IMPORT statements. This includes the object and
textual convention names and the FROM module name. You
can define more than one alias for each module. For example, if
you are using a MIB module file named RFC1271 and then it
was updated to RFC9999, you can use the aliasModule
directive to avoid having to change all of your other MIB files:
#aliasModule RFC9999 RFC1271
#aliasSymbol [module] [object] [alias]

This directive is used like the aliasModule directive. If the
name of a textual convention was changed, you can define an
alias so you don’t need to change your other MIB files. You can
define more than one alias for each symbol. For example:
aliasSymbol RFC9999 OwnerStringXXX OwnerString
#pushOpt The pushOpt directive allows you to save the current set of
compile options in you wish to change the options later on for
specific MIB modules.
#popOpt The popOpt directive is used to restore the last set of saved
options.
#addOpt options The addOpt directive is used to add compile options (in
quotes) to the current set of options being used to compile a
module. For example:
addOpt "3 4 5 g"
#removeOpt options
The removeOpt directive is used to remove compile options
(in quotes from the current set of options being used to compile
a module.
removeOpt "3 4 5 j"
#printOpt You can use this directive to print out the current set of options.

Examples:
Let’s say you have six files that contain MIB modules. The first thing you would do is
specify the directories they exist in using the SMICINCL environment variable. You
can then create a MIB Include File:
#include "rfc1155.smi"
#include "rfc1213.mib"
#include "rfc1215.trp"
#pushOpt
#addOpt "c r w b 7"
#include "new.mib"
#popOpt
By using the option directives, more strict syntax checking was done on the new MIB
modules. You can then run smic, specifying any compile options and any
output-generation options.
See also:
mstrip, snmpbulkwalk, snmpd, snmpget, snmpnetstat, snmpset,
snmpstatus, snmptest, snmptranslate, snmptrap, snmptrapd, snmpwalk

© 2010, QNX Software Systems GmbH & Co. KG. snapshot
Capture a screen image
Syntax:
snapshot [-S i|n] [-s server] [-x position[%][r]]
[-y position[%][r]]
Runs on:
Neutrino
Options:

fullpath fullpath


Description:
The snapshot utility captures portions of the Photon workspace. The main window
looks like this:

snapshot © 2010, QNX Software Systems GmbH & Co. KG.
The snapshot window.
The controls across the top of the window let you choose the source of the snapshot,
which is one of:
• the entire screen
• a selected window, not including its frame
• a selected window, including its frame
• an area that you select.
You can send the image to:
• the Photon image viewer, pv
• the Photon clipboard
• ${HOME}/snap.bmp
• ${HOME}/snap.jpg
If you want a snapshot of a menu or other popup item, set the snapshot options as you
wish, and then:
1 Specify the number of seconds to wait.
2 Click on the Take Snapshot button and select the appropriate window or area.
3 Before the timer counts down, display the menu or popup item.
4 Wait for the timer to expire.
snapshot does not work within a phditto window.

© 2010, QNX Software Systems GmbH & Co. KG. snapshot
Examples:
Run using Photon server on node my_node:
snapshot -s/net/my_node/dev/photon
snapshot -x10 -y10
PWM_PRINTSCRN_APP
The application to start when the Print Scrn key is pressed. By default,
snapshot is started.
See also:
pv

snmpbulkwalk © 2010, QNX Software Systems GmbH & Co. KG.
Query for a tree of information about a network entity
Syntax:
snmpbulkwalk [-d] [-p port] -v 1 host community
[variable_name]
snmpbulkwalk [-d] [-p port] [-v 2] host noAuth

[variable_name]
snmpbulkwalk [-d] [-p port] [-v 2] host srcparty

dstparty context [variable_name]
Runs on:
Neutrino
Options:
-d Dump input and output packets.
-p port Specify the destination port number.
-v 1|2 SNMP version (default is 2).
community The community name for the transaction with the remote system.
context The collection of object resources that can be queried by the

dstparty.
dstparty The name of the party providing the information.
host An Internet address specified in dot notation or a host name.
srcparty The name of the party requesting information.
variable_name The portion of the object identifier space that’s searched using
BULK requests. The snmpbulkwalk utility queries all variables
in the subtree below the given variable and displays their values.
Specify variable_name in the format specified in the file
mib.txt.
If you don’t specify variable_name, snmpbulkwalk searches the
entire Internet MIB for host.
Description:
The snmpbulkwalk utility uses BULK requests to query for a tree of information
about a network entity (snmpwalk uses GET NEXT requests).
If you’re using SNMP version 2, the following files must be configured:
• /etc/acl.conf

© 2010, QNX Software Systems GmbH & Co. KG. snmpbulkwalk
• /etc/context.conf
• /etc/party.conf
• /etc/snmpd.conf (required only if you change the default location of your
config files)
For a description on how to configure the files please see the file page for each of the
configuration files listed above. If you wish to change the location of your
configuration files, you must include a snmpd.conf file.
Examples:
Retrieve the variables in the system subtree:
Using SNMPv1
snmpbulkwalk -v 1 netdev-kbox.cc.cmu.edu public system
Using SNMPv2
snmpbulkwalk netdev-kbox.cc.cmu.edu manager_party agent_party agent_context system
The output is similar to:

system.sysDescr.0 = "QNX 425 C, cpu: 586"
system.sysObjectID.0 = OID: enterprises.QNX-Systems.1.1
system.sysUpTime.0 = Timeticks: (8336500) 23:09:25 Current time: Wed Mar 18 14:1
6:59 1998
system.sysContact.0 = "Dave Brown"
system.sysName.0 = ""
system.sysLocation.0 = ""
system.sysServices.0 = 79
MIBFILE Specify the location of the mib.txt file. For example,
MIBFILE=path/mib.txt (the default path is /etc).
SUFFIX If SUFFIX exists in your environment, all object IDs with a symbolic
name are printed with only the last element. Examples:
This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:
udp.udpTable.udpEntry.udpLocalAddress.0.0.0.161
is printed as:
udpLocalAddress.0.0.0.161

snmpbulkwalk © 2010, QNX Software Systems GmbH & Co. KG.
Errors:
If the network entity has an error processing the request packet, an error packet is
returned and snmpbulkwalk displays a message to help pinpoint how the request was
malformed.
If snmpbulkwalk tries to search beyond the end of the MIB, it displays this message:
End of MIB
See also:
snmpd, snmpget, snmpgetnext, snmpnetstat, snmpset, snmpstatus,
snmptest, snmptranslate, snmptrap, snmptrapd
/etc/acl.conf, /etc/context.conf, /etc/mib.txt, /etc/party.conf,
/etc/snmpd.conf, /etc/view.conf files
Based on RFC 1065, RFC 1066, RFC 1067,
RFC 1441, RFC 1445, RFC 1446,
RFC 1448, RFC 1449
Marshall T. Rose, The Simple Book: An Introduction to Internet Management, Revised
2nd ed. (Prentice-Hall, 1996, ISBN 0-13-451659-1)

© 2010, QNX Software Systems GmbH & Co. KG. snmpd
Simple Network Management Protocol agent daemon
Syntax:
snmpd [-a] [-d] [-i]
Runs on:
Neutrino
Options:
-a Log the IP address of every host that sends a message to the agent.
-i Run in interactive monitoring mode.
Description:
The snmpd daemon is a server that supports both the Simple Network Management
Protocol v2 and v1. It receives and responds to SNMP messages sent to the SNMP
port on the local machine.
• /etc/acl.conf
• /etc/party.conf
• /etc/view.conf
If you’re using SNMP version 1, the /etc/party.conf file must be configured to

include a port to listen to.
If you wish to change the configuration of snmpd you should include a
/etc/snmpd.conf file.
If you see the following line with no ports listed:
Opening port(s):
the IP address listed in TDomain (the agent definition entry in /etc/party.conf)

doesn’t match the IP address of an interface on the host. You must change the agent
definition to include the IP address of the interface where you wish to listen for SNMP
requests.

snmpd © 2010, QNX Software Systems GmbH & Co. KG.
MIBFILE The location of the mib.txt file. For example,
SNMPCONFIGFILE
The location of the snmpd.conf file.
See also:
/etc/snmpd.conf, snmpget, snmpgetnext, snmpnetstat, snmpset,
snmpstatus, snmptest, snmptranslate, snmptrap, snmptrapd, snmpwalk,
/etc/view.conf
Based on ISO 8824 (ASN.1), RFC 1065, RFC 1066, RFC 1067,
RFC 1441, RFC 1445, RFC 1446, RFC 1448, RFC 1449

© 2010, QNX Software Systems GmbH & Co. KG. /etc/snmpd.conf
Default SNMP configuration file
Name:
/etc/snmpd.conf
Description:
The snmpd.conf file provides some configuration information for the snmpd agent.
The agent searches for the location of the file, in this order:
1 the file named in the SNMPCONFIGFILE environment variable
2 /nodecfg/node_name/etc/snmpd.conf, where node_name is the value of

the CS_NODENAME configuration string (see getconf and setconf)
3 /etc/snmpd.conf
For more information, see read_main_configuration_file() in the Library Reference.

Here’s an example snmpd.conf file:
## /etc/snmpd.conf:
## location of the config files:

party.conf: /etc/party.conf
acl.conf: /etc/acl.conf
view.conf: /etc/view.conf
context.conf: /etc/context.conf
## public- and private-community string (for SNMP V1):

## default is ‘‘public’’ and ‘‘private’’
public: newpublic
private: newprivate
## the entry of system.sysContact and system.sysLocation:

system contact: sysadmin
system location: systemlocation
## system.sysName is per default determined from the hostname:

system name: snmpdhost
## trap sink ipaddress (trap destination) and community string.

## authentraps contains the value of snmpEnableAuthenTraps;
## (default is ‘no’’ == disabled).
trap sink: tcp_ip
trap community: public
authentraps: no
See also:
/etc/view.conf files

snmpget © 2010, QNX Software Systems GmbH & Co. KG.
Communicate with a network entity using SNMP GET requests
Syntax:
snmpget [-d] [-p port] [-r retry] [-t timeout]
-v 1 host community variable_name
[variable_name]

[-v 2] host noAuth variable_name
[variable_name]

[-v 2] host scrparty dstparty context
variable_name [variable_name]
Runs on:
Neutrino
Options:
-r retry Specify the number of retries.
-t timeout Specify timeout (in seconds).

dstparty.
dstparty The name of the party providing information.
host An Internet address specified in dot notation or a hostname.
variable_name The variable name in the format specified in the file mib.txt.
Description:
The snmpget utility uses the GET request to query for information about a network
entity. You can specify one or more fully qualified object identifiers in the format
specified in the file mib.txt.
• /etc/acl.conf

© 2010, QNX Software Systems GmbH & Co. KG. snmpget
• /etc/party.conf
config files)
Examples:
Retrieve the variables sysDescr.0 and sysUpTime.0:
Using SNMPv1
snmpget -v 1 netdev-kbox.cc.cmu.edu public \
system.sysDescr.0 system.sysUpTime.0
Using SNMPv2
snmpget \ netdev-kbox.cc.cmu.edu manager_party \
agent_party agent_context system.sysDescr.0 \
system.sysUpTime.0

Name: system.sysDescr.0
OCTET STRING- (ascii): Kinetics FastPath2
Name: system.sysUpTime.0
Timeticks: (2270351) 6:18:23
This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:
is printed as:

snmpget © 2010, QNX Software Systems GmbH & Co. KG.
Errors:
returned and snmpget displays a message to help pinpoint how the request was
malformed. If you’ve specified other variables, snmpget resends the request without
the variable that caused the problem.
See also:
snmpd, snmpgetnext, snmpnetstat, snmpset, snmpstatus, snmptest,
snmptranslate, snmptrap, snmptrapd, snmpwalk
Based on ISO 8824 (ASN.1), RFC 1065, RFC 1066, RFC 1067
RFC 1441, RFC 1445, RFC 1446
RFC 1448, RFC 1449

© 2010, QNX Software Systems GmbH & Co. KG. snmpgetnext
Communicate with a network entity using SNMP GET NEXT requests
This utility has been deprecated in SNMP version 2.
Syntax:
snmpgetnext [-d] host community variable_name
Runs on:
Neutrino
Options:
Description:
The snmpgetnext utility uses the GET NEXT request to query for information on a
network entity. You can specify one or more fully qualified object identifiers in the
format specified in the file mib.txt. For each one, the utility returns the variable in
the network entity’s MIB that is next in alphanumeric order.
Examples:
Retrieve the variables sysDescr.0 and sysUpTime.0:
snmpgetnext netdev-kbox.cc.cmu.edu public

system.sysContact.0 system.sysName.0
system.sysName.0 = "computer"
system.sysLocation.0 = "Outer Regions"
Errors:
If the network entity has an error processing the request packet, snmpgetnext
displays an error message helping to pinpoint how the request was malformed.
Caveats:
This utility has been deprecated; it works only with SNMP version 1.

snmpgetnext © 2010, QNX Software Systems GmbH & Co. KG.
See also:
snmpd, snmpget, snmpnetstat, snmpstatus, snmptest, snmptrap,
snmptrapd, snmpwalk
/etc/mib.txt file

© 2010, QNX Software Systems GmbH & Co. KG. snmpnetstat
Show network status using SNMP
Syntax:
snmpnetstat [-d] [-p port] -v 1 host community
[-ainrs] [-P protocol] [-I interface]
[interval]
snmpnetstat [-d] [-p port] [-v 2] host noAuth

[-ainrs] [-P protocol] [-I interface]
[interval]
snmpnetstat [-d] [-p port] [-v 2] host srcparty

dstparty context [-ainrs] [-P protocol]
[-I interface] [interval]
Runs on:
Neutrino
Options:
-a Show statistics for all sockets (default is for active sockets only).
These statistics consist of the local and remote addresses, protocol,
and internal state of the protocol.
-I interface Show statistics for this interface.
-i Show statistics for all interfaces.
-n Show network addresses as numbers. By default, snmpnetstat

interprets addresses and attempts to display them symbolically.
-P protocol Show statistics for this protocol, which is either a protocol’s

well-known name or its alias. See /etc/protocols for a list of
some protocol names and aliases.
-r Show the routing statistics.
-s Show statistics for all protocols.

dstparty.

snmpnetstat © 2010, QNX Software Systems GmbH & Co. KG.
interval The number of seconds between successive updates of the interface

statistics.
Description:
The snmpnetstat utility displays network-related statistics retrieved from a remote
system using the SNMP protocol.
• /etc/acl.conf
• /etc/party.conf

config files)
Addresses
The snmpnetstat utility tries to match the host, network, and port with entries in the
TCP/IP configuration files. If one of these matches, snmpnetstat displays the
corresponding symbolic names. If none of these match or if you specify -n,
snmpnetstat displays the addresses numerically.
Interface displays
The interface display shows a table of cumulative statistics on packets transferred,
errors, and collisions. It also displays the network addresses of the interface and the
maximum transmission unit (MTU). If you specify an interval, snmpnetstat shows
a continuous display. The first line of the continuous display is a summary of statistics
accumulated since the system was last booted; subsequent lines show values
accumulated over the preceding interval.
If you specify: The interface display shows:

[-n] -i Table of cumulative stats for all interfaces.
[-n] -I interface Table of cumulative stats for interface.
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. snmpnetstat
If you specify: The interface display shows:

-I interface interval Continuous column of stats for interface and continuous
table of cumulative stats for all interfaces.
interval Continuous column of stats for the primary interface and
continuous table of cumulative stats for all interfaces.
Routing table display

The routing table display shows the available routes and the status of each. Each route
consists of a destination host or network and a gateway to use in forwarding packets.
Direct routes are created for each interface attached to the local host.
This field: Shows:

Destination Destination host or network.
Flags State of the route, where:
D = was created dynamically by a redirect
G = to a gateway
H = destination is a host
M = has been modified by a redirect
U = up
Gateway Gateway to use in forwarding packets.
Or:
Address of the outgoing interface if the route is direct.
Interface Network interface used for the route.
See also:
netstat, snmpd, snmpget, snmpgetnext, snmpstatus, snmptest,
/etc/acl.conf, /etc/context.conf, /etc/hosts, /etc/mib.txt,
/etc/networks, /etc/party.conf, /etc/protocols, /etc/services,
Based on ISO 8824 (ASN.1), RFC 1065, RFC 1066, RFC1067
RFC 1441, RFC 1445, RFC1446
RFC 1448, RFC 1449

snmpset © 2010, QNX Software Systems GmbH & Co. KG.
Communicate with a network entity using SNMP SET requests
Syntax:
snmpset [-d] [-p port] [-r retry] [-t timeout] -v 1
host community variable_name type value
[variable_name type value]
snmpset [-d] [-p port] [-r retry] [-t timeout] [-v 2]

host noAuth variable_name type value
snmpset [-d] [-p port] [-r retry] [-t timeout] [-v 2]

host scrparty dstparty context variable_name type value
Runs on:
Neutrino
Options:
-t timeout Specify timeout (in seconds).
context The collection of object resources that can be set by the dstparty.
dstparty The name of the party performing the action.
srcparty The name of the party requesting an action.
type The data type where type is one of the following:
a IPADDRESS
d DECIMAL STRING
i INTEGER
n NULLOBJ
o OBJID
s STRING
t TIMETICKS

© 2010, QNX Software Systems GmbH & Co. KG. snmpset
x HEX STRING
value The data value.
Description:
The snmpset utility uses the SET request to set information about a network entity.
You can specify one or more fully qualified object identifiers in the format specified in
the file mib.txt.
• /etc/acl.conf
• /etc/party.conf

config files)
Examples:
Set the variable sysContact.0 to “John Doe”:
Using SNMPv1
snmpset -v 1 netdev-kbox.cc.cmu.edu public system.sysContact.0 s "John Doe"
Using SNMPv2
snmpset netdev-kbox.cc.cmu.edu manager_party agent_party agent_context
system.sysContact.0 s "John Doe"
system.sysContact.0 = "John Doe"
This ID:

snmpset © 2010, QNX Software Systems GmbH & Co. KG.
system.syscontact.0
is printed as:
syscontact.0
This ID:
is printed as:
Errors:
returned and snmpset displays a message to help pinpoint how the request was
malformed.
See also:
snmpd, snmpget, snmpgetnext, snmpnetstat, snmpstatus, snmptest,
/etc/acl.conf file, /etc/context.conf file, /etc/mib.txt file,

/etc/party.conf file, /etc/snmpd.conf file, /etc/view.conf file
Based on ISO 8824 (ASN.1), RFC 1065, RFC 1066, RFC 1067,
RFC 1441, RFC 1445, RFC 1446
RFC 1448, RFC 1449

© 2010, QNX Software Systems GmbH & Co. KG. snmpstatus
Retrieve information from a network entity
This utility has been deprecated in SNMP version 2.
Syntax:
snmpstatus [-d] host [community]
Runs on:
Neutrino
Options:
community The community name for the transaction with the remote system
(default is public).
Description:
The snmpstatus utility retrieves these statistics from a network entity:
Statistic Variable
IP address of the entity -
Textual description of the entity sysDescr.0
Uptime of the entity sysUpTime.0
Sum of received packets on all ifInU - CastPkts.* + ifInNUCastPkts.*
interfaces
Sum of transmitted packets on all ifOutU - CastPkts.* +
interfaces ifOutNUCastPkts.*
Number of IP input packets ipInReceives.0
Number of IP output packets ipOutRequests.0
The snmpstatus utility also checks the operational status of all interfaces
(ifOperStatus.*), and if it finds any interfaces that aren’t running, it displays a report
similar to:
2 interfaces are down!

snmpstatus © 2010, QNX Software Systems GmbH & Co. KG.
Examples:
This command:
snmpstatus netdev-kbox.cc.cmu.edu public
produces output similar to:
[128.2.56.220]=>[Kinetics FastPath2] Up: 1 day, 4:43:31
IF recv/trans packets 262874/39867 | IP recv/trans packets

31603/15805
Errors:
returned and snmpstatus displays a message to help pinpoint how the request was
malformed. If you’ve specified other variables, snmpstatus resends the request
without the variable that caused the problem.
Caveats:
This utility has been deprecated; it works only with SNMP version 1. If you need
similar functionality with SNMPv2, you should do the snmpget commands
separately.
See also:
snmpd, snmpget, snmpgetnext, snmpnetstat, snmptest, snmptrap,
snmptrapd, snmpwalk
/etc/mib.txt file

© 2010, QNX Software Systems GmbH & Co. KG. snmptest
Monitor and manage information on a network entity
Syntax:
snmptest [-d] [-p port] [-r retry] [-t timeout]
-v 1 host community

[-v 2] host noAuth

[-v 2] host srcparty dstparty context
Runs on:
Neutrino
Options:
-t timeout Specify the timeout (in seconds).
context The collection of object resources that can be queried by the dstparty.
dstparty The name of the party providing information.
Description:
The snmptest utility enables you to monitor and manage information on a network
entity using SNMP (Simple Network Management Protocol). There are two different
versions of SNMP commonly in use: SNMPv1 and SNMPv2; future versions are
planned.
In SNMP terms, a server is called an agent and a client is called a manager. Agents
and managers exchange network information using protocol data units (PDUs). The
manager sends a PDU requesting information to the agent; the agent responds by
retrieving the information from the network’s management information database
(MIB) and sending a response PDU back to the manager. The manager can also
request changes to MIB data or ask for automatic log traps by sending the agent
different PDUs.

snmptest © 2010, QNX Software Systems GmbH & Co. KG.
The snmptest utility provides an interactive facility for generating PDUs from the
SNMP manager’s command line.
You start an agent by running snmpd on a machine in your network.
You start an interactive manager session by invoking snmptest, after which, the
utility prompts you with:
Variable:
This starts your interactive session. You can enter one or more variable names, one per
line. If you enter a blank line, snmptest sends a request for each of the variables (in a
single packet) to the network entity. See the file mib.txt for the format specification
of variable names.
For example for SNMPv1, you might enter:
snmptest -v 1 netdev-kbox.cc.cmu.edu public
or for SNMPv2:
snmptest netdev-kbox.cc.cmu.edu manager_party agent_party agent_context
If you had access to this host, you would get a prompt like this:
Variable:
Now, if you respond like this:
Variable: system.sysdescr.0
Variable:
After you enter the blank line, if your request was successful, snmptest will tell you
that is has received a Get Response and will display information about the
system.sysdescr.0 object.
By default, snmptest sends a GET request PDU but you can change this at the
Variable: prompt by entering a $ command, as follows:
Enter this command: To:

$B Send a GetBulkRequest-PDU
$D Toggle the dumping of each sent and received packet
$G Send a GetRequest-PDU
$I Send an InformRequest-PDU
$N Send a GetNextRequest-PDU
$Q Quit the utility
$S Send a SetRequest-PDU
$T Send an SNMPv2-Trap-PDU

Here’s a brief explanation of the PDUs:
GetBulkRequest-PDU ($B)
This returns information on several objects. You first specify any individual
objects you are interested in, then a number corresponding to a particular object
group, then the number of objects within that group you want to see. This is how
such a session might go:
Variable: $B
Request type is Bulk Request
Enter a blank line to terminate the list of non-repeaters
and to begin the repeating variables
Variable: system.sysDescr.0
Variable:
Now input the repeating variables
Variable: 3
Variable:
What repeat count? 4
Received Get Response from 10.7.0.55
requestid 0x7C81 errstat 0x0 errindex 0x0
system.sysObjectID.0 = OID: enterprises.QNX-Systems.1.1
at.atTable.atEntry.atIfIndex.1.1.10.0.2.51 = 1
at.atTable.atEntry.atIfIndex.1.1.10.7.0.55 = 1
at.atTable.atEntry.atPhysAddress.1.1.10.0.2.51 = Hex: 00 E0 29 34 6E 4D
at.atTable.atEntry.atPhysAddress.1.1.10.7.0.55 = Hex: 00 01 02 C1 8C 40
Variable:
There are a few things to notice about this sample session:
• After you have entered a variable, nothing happens until you enter a blank
line.
• In this case we have chosen to enter only one variable, but you may enter as
many variables as you want.
• The non-repeaters variable sends a GetNextRequest-PDU, not a
GetRequest-PDU.
• The repeating variables request asks for the number of the object
group from which you want start the bulk request (you’ll find these numbers
in the mib.txt file). In this case, it’s 3 and that correlates to the Address
Translation group (at).
• The repeat count specifies the number of contiguous MIB database objects
you want to inspect.
GetRequest-PDU ($G)
This is the default PDU. It asks the agent to send information about a network
entity. The agent responds with a Response-PDU containing the information
requested. For more information, see snmpget.
InformRequest-PDU ($I)
An SNMP manager uses this type of PDU to inform other managers about MIB
information hidden from their view. An inform request is similar to a trap in that
it can be used to send notification of an event that has occurred but, unlike a trap,

an inform request is always acknowledged. This makes it a more reliable way of

sending notifications than a trap, but also more expensive in terms of network
resources.
GetNextRequest-PDU ($N)
This is similar to the GetRequest-PDU but it requests the next object in the MIB
database.
SetRequest-PDU ($S)
This PDU changes objects in the MIB database on the agent machine. Such a
session might go like this:
Variable: $S
Request type is Set Request
Variable: system.sysName.0
Type [i|s|x|d|n|o|t|a]: s
Value: James Bond
Variable:
Received Get Response from 10.7.0.55
requestid 0x6EC5 errstat 0x0 errindex 0x0
system.sysName.0 = "James Bond"
Variable:
In this session, we are requesting a change in the system name recorded in the
MIB database on the agent machine. As long as we have permission to do this,
snmptest asks for the variable we want to change, the type of data (a string in
this case), and the new value. After we have entered the obligatory blank line,
the object is changed and the new value is returned.
SNMPv2-Trap-PDU ($T)
Managers use this PDU to request an agent to report events asynchronously.
When the specified events occur, the agent sends a trap to the requesting
manager.
Before you can send this PDU, you have to invoke snmptrapd on the machine
running the agent.
If you enter $I, $S, or $T, snmptest requests information about each variable. First,
it prompts you for the variable type:
Type [i|s|x|d|n|o|t|a]:
If the variable is: Enter:

integer i
continued. . .

If the variable is: Enter:

string s
hex string x
decimal string d
null n
object id o
timeticks t
ip address a
After you enter a character, snmptest prompts you for a value:
Value:
For this variable type: Enter:

integer Integer in decimal.
ipaddress IP address in the standard internet dot notation.
object id Object ID in dotted numeric notation.
string Whitespace-delimited decimal numbers, one per byte of
the string.
timeticks Integer in decimal.
If you’re using SNMP version 2, the following files must be configured on the
machine running the agent:
• /etc/acl.conf to associate manager, agent, and context.
• /etc/context.conf to define the MIB view for each context.
• /etc/party.conf to define details of each communicating party.

config files)
• /etc/view.conf to define the MIB data to be made available.

This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:
is printed as:
See also:
snmpd, snmpget, snmpgetnext, snmpnetstat, snmpset, snmpstatus,
RFC 1441, RFC 1445, RFC 1446
RFC 1448, RFC 1449

© 2010, QNX Software Systems GmbH & Co. KG. snmptranslate
Get the dotted numeric notation of an object ID from the symbolic name or vice versa
Syntax:
snmptranslate [-d] [-n] [-r] variable_name
Runs on:
Neutrino
Options:
-d Display the description of the object identifier from the mib.txt
file if it’s available.
-n Get the symbolic name from the dotted numeric notation (default
is to get the dotted numeric notation from the symbolic name).
-r Get the dotted numeric notation of an object identifier without

using the subidentifier.
Description:
The snmptranslate utility is used to obtain the symbolic name from the dotted
numeric notation or vice versa — to obtain the dotted numeric notation from the
symbolic name of an object identifier.
You can specify one fully qualified object identifier in the format specified in the file
mib.txt.
Examples:
Obtain the dotted numeric notation of the system subtree:
snmptranslate system
.1.3.6.1.2.1.1
Obtain the symbolic name for the object ID .1.3.6.1.2.1.1:
snmptranslate -n .1.3.6.1.2.1.1
system

snmptranslate © 2010, QNX Software Systems GmbH & Co. KG.
This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:
is printed as:
Errors:
The snmptranslate utility has an error processing the request; an error message is
returned to help pinpoint how the request was malformed.
See also:
snmpd, snmpgetnext, snmpnetstat, snmpstatus, snmptest, snmptranslate,
snmptrap, snmptrapd, snmpwalk
/etc/mib.txt file
Based on RFC 1065, RFC 1066, RFC 1067, ISO 8824 (ASN.1)
RFC 1441, RFC 1445, RFC 1446, RFC 1448, RFC 1449

© 2010, QNX Software Systems GmbH & Co. KG. snmptrap
Send an SNMP TRAP message to a host
Syntax:
snmptrap [-d] -v 1 host community trap_type
specific_type device_description
[-a agent_addr]
snmptrap [-d] [-v 2] host noAuth trap_type

specific_type device_description
[-a agent_addr]
snmptrap [-d] [-v 2] host srcparty dstparty

context trap_type specific_type
device_description [-a agent_addr]
Runs on:
Neutrino
Options:
-a agent_addr Change the address that the trap reports it’s being sent from. By
default, snmptrap uses the sending host’s address.
-d Dump the output packet.
context The collection of object resources available to the dstparty.
device_description
A textual description of the device sending this trap. The
description is used as the value of a system.sysDescr.0 variable.
dstparty The name of the party performing the action.
srcparty The name of the party requesting an action.
specific_type An integer that specifies user-defined additional information about

trap_type.
trap_type An integer that specifies the type of trap message being sent. Trap
types are defined in the table below.

snmptrap © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The snmptrap utility forms and sends an SNMP TRAP message to a host.
This trap type: Signifies that the sending protocol entity:

0 (coldStart) Is reinitializing itself—the agent’s configuration or the
protocol entity implementation may be altered.
1 (warmStart) Is reinitializing itself—neither the agent’s configuration
nor the protocol entity implementation is altered.
2 (linkDown) Recognizes a failure in one of the communication links
represented in the agent’s configuration.
3 (linkUp) Recognizes that one of the communication links
represented in the agent’s configuration has come up.
4 (authenticationFailure) Is the addressee of a protocol message that isn’t
properly authenticated.
5 (egpNeighborLoss) Had an EGP neighbor as an EGP peer, and the neighbor
has been marked down so that the peer relationship no
longer exists.
6 (enterpriseSpecific) Recognizes that some enterprise-specific event has
occurred. The specific trap field identifies the particular
trap that occurred.
If you’re using SNMP version 2, you must configure the following files:
• /etc/acl.conf
• /etc/party.conf

config files)
For a description on how to configure the files, see the documentation for each of the
Examples:
Send a cold start trap to the specified host:
Using SNMPv1
snmptrap -v 1 nic.andrew.cmu.edu public 0 0 \
’SUN 3/60: SUNOS4.0’

© 2010, QNX Software Systems GmbH & Co. KG. snmptrap
Using SNMPv2
snmptrap nic.andrew.cmu.edu manager_party \
agent_party agent_context 0 0 ’SUN 3/60: SUNOS4.0’
This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:
is printed as:
See also:
snmpd, snmpget, snmpgetnext, snmpnetstat, snmpstatus, snmpset,
snmptest, snmptranslate, snmptrapd, snmpwalk
RFC 1441, RFC 1445, RFC 1446
RFC 1448, RFC 1449

snmptrapd © 2010, QNX Software Systems GmbH & Co. KG.
Receive SNMP TRAP messages
Syntax:
snmptrapd [-d] [-p] [-p port] [-v 1|2]
Runs on:
Neutrino
Options:
-p Print messages to standard output.

By default, messages are sent to the system log. In order to capture the
log messages, you need to have syslogd running.
Description:
The snmptrapd utility receives SNMP TRAP messages sent to the snmp-trap port
on the local machine. If you specify -p, snmptrapd prints messages to standard
output. The messages are of the form:
------------------------ Notification ------------------------

10.0.0.59: Cold Start Trap (0) Uptime: 1 day, 6:11:24
system.sysDescr.0 = "SUN 3/60: SUNOS4.0"
You must have superuser privileges when you run snmptrapd.
This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:

© 2010, QNX Software Systems GmbH & Co. KG. snmptrapd
is printed as:
See also:
snmpd, /etc/snmpd.conf, snmpget, snmpgetnext, snmpnetstat, snmpset,
snmpstatus, snmptest, snmptranslate, snmptrap, snmpwalk syslogd,
/etc/view.conf
RFC 1441, RFC 1445, RFC 1446
RFC 1448, RFC 1449

snmpwalk © 2010, QNX Software Systems GmbH & Co. KG.
Query for a tree of information about a network entity
Syntax:
snmpwalk [-d] [-p port] -v 1 host community
[variable_name]
snmpwalk [-d] [-p port] [-v 2] host noAuth

[variable_name]
snmpwalk [-d] [-p port] [-v 2] host srcparty

dstparty context [variable_name]
Runs on:
Neutrino
Options:

dstparty.
variable_name The portion of the object identifier space that’s searched using
GET NEXT requests. The snmpwalk utility queries all variables
in the subtree below the given variable and displays their values.
Specify variable_name in the format specified in the file
mib.txt.
If you don’t specify variable_name, snmpwalk searches the
entire Internet MIB for host.
Description:
The snmpwalk utility uses GET NEXT requests to query for a tree of information
about a network entity (snmpbulkwalk uses BULK requests).
If you’re using SNMP version 2, you must configure the following files:
• /etc/acl.conf

© 2010, QNX Software Systems GmbH & Co. KG. snmpwalk
• /etc/party.conf
config files)
For a description on how to configure the files, see the documentation for each of the
Examples:
Retrieve the variables in the system subtree:
Using SNMPv1
snmpwalk -v 1 netdev-kbox.cc.cmu.edu public system
Using SNMPv2
snmpwalk netdev-kbox.cc.cmu.edu manager_party \
agent_party agent_context system

system.sysDescr.0 = "QNX 425 C, cpu: 586"
system.sysObjectID.0 = OID: enterprises.QNX-Systems
.1.1
system.sysUpTime.0 = Timeticks: (8336500) 23:09:25
Current time: Wed Mar 18 14:16:59 1998
system.sysContact.0 = "Dave Brown"
system.sysName.0 = ""
system.sysLocation.0 = ""
system.sysServices.0 = 79
This ID:
system.syscontact.0
is printed as:
syscontact.0
This ID:
is printed as:

snmpwalk © 2010, QNX Software Systems GmbH & Co. KG.
Errors:
returned and snmpwalk displays a message to help pinpoint how the request was
malformed.
If snmpwalk tries to search beyond the end of the MIB, it displays this message:
End of MIB
Caveats:
The snmpbulkwalk utility is more efficient.
See also:
snmpd, snmpbulkwalk, snmpget, snmpgetnext, snmpnetstat, snmpset,
snmpstatus, snmptest, snmptranslate, snmptrap, snmptrapd
RFC 1441, RFC 1445, RFC 1446
RFC 1448, RFC 1449

© 2010, QNX Software Systems GmbH & Co. KG. /etc/socks.conf
SOCKS clients configuration file
Name:
/etc/socks.conf
Description:
All SOCKS client programs use this file to:
• determine whether to use direct or proxy connection to a given destination host
• exert access control based on the destination host, the requested service (port
number on the destination host), and the effective userid of the requesting local
user.
Each line in the file may be up to 1024 characters long. Lines starting with a number
sign (#) are comments. Lines that aren’t comments must be of one of the three forms:
deny [*=userlist] dst_addr dst_mask [op dst_port] [: shell_cmd]
direct [*=userlist] dst_addr dst_mask [op dst_port] [: shell_cmd]
sockd [@=serverlist] [*=userlist] dst_addr dst_mask [op dst_port] [: shell_cmd]
A deny line tells the SOCKS clients when to reject a request.

A direct line tells when to use a direct connection.
A sockd line tells when to use a proxy connection and, optionally, which SOCKS
proxy server or servers to try.
Spaces and tabs separate the fields. Fields enclosed in square brackets are optional.
The fields are:
userlist One or more userids or filenames, separated by commas. No spaces or

tabs are allowed in the list. The userids should be of users on the local
host, not those on the destination host or the SOCKS server host.
The filenames must be full pathnames with the leading /. Inside the
specified files, userids may be listed one or several per line, with any
combination of blanks, tabs, and commas as separators.
A # at the beginning of a line marks the remainder of the line as a
comment. Each line in these files may be up to 1023 characters long. If
the *= userlist field is omitted, the line applies to all userids.
dst_addr dst_mask
These fields together specify the destination IP address or the range of
destination IP addresses. Both are given in the usual dotted form (e.g.
129.1.2.3).
Bits in dst_mask that are set to 0 indicate the bit positions to be masked
off (i.e. ignored) during comparison of dst_addr and the actual
destination IP address.

/etc/socks.conf © 2010, QNX Software Systems GmbH & Co. KG.
For example, specifying 255.255.255.255 in dst_mask demands an

exact match with dst_addr, whereas 0.0.0.0 is an address match no
matter what is specified for dst_addr. (Note that this is the same way
netmasks are interpreted, but is the direct opposite of how the address
masks are used in Cisco router access lists.)
op One of the following:
eq Equal.
neq Not equal.
lt Less than.
gt Greater than.
le Less than or equal.
ge Greater than or equal.
dst_port Either a port number (e.g. 23) or the equivalent service name as
specified in the /etc/services file (e.g. telnet for port number
23). If this pair is omitted, the line applies to all services.
serverlist Used only in a sockd line. It consists of one or more SOCKS proxy
servers that the client program should try to use (in the indicated order)
for establishing a proxy connection.
You can use only commas as separator — no spaces or tabs are allowed
in the list. Although domain names of the servers may be used in the
list, it’s probably more prudent to specify IP addresses.
If the serverlist field is omitted, the client program uses the default
SOCKS proxy server, which is determined by the environment variable
SOCKS_SERVER or by the name compiled into the SOCKS client
program.
Consider this sockd line:
sockd @=1.2.3.4 *=boss,root 11.12.13.14 255.255.255.255 eq telnet
To match the condition indicated in this line, a request must come from
a local user whose effective id is either boss or root, the destination
IP address must be 11.12.13.14 exactly, and the service requested
must be telnet. In that case, connection to host 11.12.13.14
should be done via a SOCKS proxy server on host 1.2.3.4.
Every time a SOCKS client has to make a network connection, it
checks the pending request against the /etc/socks.conf file, one
line at a time. Once the client finds a line with conditions that are
matched by the request, the action specified on that line is taken. The
remaining lines of /etc/socks.conf are skipped. If no matching
line is found throughout the file, the request is denied.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/socks.conf
The order of the lines in the file is extremely important — switch two lines and you
may have entirely different results!
shell_cmd A command string that’s executed when the conditions on that line are
satisfied. The following substitutions occur before the string is
presented to the Borne shell for execution:
These characters: Are replaced by:

%A The client host’s domain name if known; by its IP
address otherwise
%a The client host’s IP address
%c “connect” or “bind”
%p The client program’s process ID
%S The service name (e.g. ftp) if known; by the
destination port number otherwise
%s The destination port number
%U The userid at login
%u The effective userid
%Z The destination host’s domain name if known; by
its IP address otherwise
%z The destination host’s IP address
%% A single %
You can string several shell commands together in the usual way with
|, ;, etc.
Although there’s an implied “deny all” at the end of the control file, you may supply
one explicitly to take some specific action when requests are so rejected. For example:
deny 0.0.0.0 0.0.0.0 : /usr/bin/mail -s ‘SOCKS: rejected %S from %u to %Z’ root
Unlike the previous version, connection to address 127.0.0.1 (localhost) is always

done directly, so there’s no need to specify that in /etc/socks.conf.
SOCKS_SERVER
If defined, this environment variable specifies the name or IP address of the
SOCKS proxy server host to use, overriding the default server compiled into the
programs.

sockstat © 2010, QNX Software Systems GmbH & Co. KG.
List the open sockets
Syntax:
sockstat [-46clnu] [-f address_family] [-p ports]
Runs on:
QNX Neutrino
Options:
-4 Show AF_INET (IPv4) sockets.
-6 Show AF_INET6 (IPv6) sockets.
-c Show connected sockets.
-f address_family Limit the listed sockets to those of the specified

address_family. The following address families are
recognized: inet for AF_INET; inet6 for AF_INET6; and
local or unix for AF_LOCAL.
-l Show the listening sockets.
-n Numeric output only. No attempt is made to look up symbolic

names for addresses and ports.
-p ports Show only Internet sockets if either the local or foreign port
number is in the specified list. The ports argument is a
comma-separated list of port numbers and ranges specified as a
first and a last port separated by a dash.
-u Show AF_LOCAL (UNIX) sockets.
Description:
The sockstat command lists open Internet or UNIX domain sockets.
If you don’t specify any of the -4, -6, or -u options, sockstat lists the sockets in all
three domains.
If you don’t specify either of the -c or -l, sockstat lists both listening and
connected sockets, as well as those sockets that are in neither state.
The information listed for each socket is:
USER The user who owns the socket.
COMMAND The command that holds the socket.
PID The process ID of the command that holds the socket.

© 2010, QNX Software Systems GmbH & Co. KG. sockstat
FD The file descriptor number of the socket.
PROTO The transport protocol associated with the socket for Internet
sockets, or the type of socket (stream or datagram) for UNIX
sockets.
LOCAL ADDRESS For Internet sockets, this is the address to which the local end of
the socket is bound (see getsockname() in the Neutrino Library
Reference). For bound UNIX sockets, it’s the socket’s filename
or -.
FOREIGN ADDRESS The address to which the foreign end of the socket is bound (see
getpeername()), or - for unconnected UNIX sockets.
See also:
netstat
getpeername(), getsockname(), INET6, UNIX in the Neutrino Library Reference

sort © 2010, QNX Software Systems GmbH & Co. KG.
Sort, merge, or sequence-check text files (POSIX)
Syntax:
sort [-m] [-o name] [-bdfinru] [-t char]
[-k keydef ] [+oldkey] [file...]
sort [-c] [-bdfinru] [-t char] [-k keydef ]

[+oldkey] [file]
Runs on:
Options:
-c Check that the single input file is already sorted. Produce no output.
-m Merge only. It’s assumed that the input files are already sorted.
-o name The name argument is the name of an output file to be used instead of
the default, which is standard output. This file can be the same as one of
the input files.
-u Unique; suppress all but one key in each set of lines having equal keys.
The following options override the default ordering rules. When ordering options
appear independent of key field specifications, the requested field ordering rules are
applied globally to all sort keys. When attached to a specific key (see option -k), the
specified ordering options override all global ordering options for that key.
-b Ignore leading blank characters in field comparisons.

-d Sort in “dictionary order.” Only blank characters and alphanumeric
characters are significant in comparisons.
-f Fold uppercase letters into lowercase.
-i Ignore all nonprintable characters.
-k keydef Define keydef to be a sort key.

-n Interpret the field as numeric, including the sign and optional
“thousands” separator. Sort in numeric order. This implies the -b
option.
-r Reverse the sort order.
-t char Use char as the field separator character.
file The pathname of a file to be sorted, merged, or checked. If you don’t

specify any files to be sorted, or if a file operand is the dash character
(-), the standard input is used.

© 2010, QNX Software Systems GmbH & Co. KG. sort
+oldkey This is a historical key-field mechanism. For more information, see

below.
Description:
The sort utility orders lines from a set of files (or standard input if no files are
provided) and merges the output into the specified output (or standard output if no
output file is specified). The sort utility provides a number of options for controlling
the sorting mechanism. The default behavior of sort is to treat all lines as a sequence
of characters to be sorted in ascending order.
The sort utility regards files and file contents the following way:
• a file is a sequence of lines
• a line is a sequence of fields followed by a newline
• a field is a sequence of characters followed by a field separator
• a field separator, by default, is a blank, although this may be altered by the -t

option
The -t option has subtle effects. If you don’t use the option, only the first blank in a
string of blank characters is interpreted as a field separator; the remaining are
considered part of the next field. If you use the -t option, every occurrence of the field
separator character is considered a terminator for a field. Thus, four adjacent field
separators represent three empty fields.
A sort key field may be defined using the following syntax:
-k field_start [type_string] [,field_end] [type_string]

where field_start and field_end specify the beginning and end of the key field, and
type_string is used to specify attributes specific to the key.
The field_start and field_end are each specified by a pair of digits of the form m.n,
where the m refers to the field starting after the mth field separator in a line. For
field_start, the .n refers to the nth character of the specified field, and is taken as zero
if not specified. For field_end, the .n refers to the nth character after the last character
of the specified field, and is taken as zero if not specified.
The type_string may be formed from the characters bdfinr, which apply their
defined attributes to the determination of the key.
There is another mechanism (+oldkey) for defining sort keys, which remains for
historical reasons. The syntax of this mechanism is:
+field_start [type_string] -field_end [type_string]

The semantics are the same as for the -k option.
The following command sorts the password database by gid, then uid, then username:
sort -t: -k 3.0n -k 2.0n -k 0.0d /etc/passwd

sort © 2010, QNX Software Systems GmbH & Co. KG.
Notice that the type_string attached to field_string is used to determine the type of
comparison with this key.
The second type_string is solely to adjust the extent of the sort_key, thus only i and b
make any sense. Any other characters are ignored.
Examples:
The standard password file has the form:
username:password:uid:gid:misc:home:shell
Sort the password database by username:
sort -t: /etc/passwd
Exit status:
0 All input files were sorted successfully, or the option -c was specified and the
input file was already correctly sorted.
1 The -c option was used and the input file wasn’t already sorted.
See also:
diff, grep, sed, tsort

© 2010, QNX Software Systems GmbH & Co. KG. spatch
Fullscreen patch utility (QNX Neutrino)
Syntax:
spatch [-bp] file [offset]
Runs on:
Neutrino
Options:
-b Browse only; don’t allow the Save command. The file or disk is accessed
in read-only mode.
-p Pause before starting, for example to allow a floppy disk to be inserted in a

disk drive.
file The file or disk to be examined.
offset The address — in RAM, in the file, or on the disk — where the spatch is
to begin (specified in hex).
Description:
The spatch utility provides fullscreen editing of files or disk blocks. The screen
displays a 16-by-16 (256) byte image of the data being examined, similar to that
shown here:
Edit Next Prev Lastblk Home Goto Find Continue Save Addr Quit
000000000: 2E 28 6E 65 77 29 20 53 50 41 54 43 48 20 22 46 .(new) SPATCH "F
000000010: 75 6C 6C 20 73 63 72 65 65 6E 20 70 61 74 63 68 ull screen patch
000000020: 20 75 74 69 6C 69 74 79 22 1E 2E 28 73 79 6E 74 utility"..(synt
000000030: 61 78 29 1E 09 11 73 70 61 74 63 68 10 20 20 11 ax)...spatch. .
000000040: 66 69 6C 65 10 20 20 AE 66 69 6C 65 6E 61 6D 65 file. .filename

000000050: AF 1E 09 11 73 70 61 74 63 68 10 20 20 11 64 69 ....spatch. .di
000000060: 73 6B 10 20 20 AE 64 72 69 76 65 AF 20 20 AE 62 sk. .drive. .b
000000070: 6C 6F 63 6B AF 1E 09 11 73 70 61 74 63 68 10 20 lock....spatch.
000000080: 20 11 6D 65 6D 10 20 20 AE 73 65 67 6D 65 6E 74 .mem. .segment

000000090: AF 20 20 AE 6F 66 66 73 65 74 AF 1E 2E 28 65 78 . .offset...(ex
0000000a0: 61 6D 70 6C 65 73 29 1E 09 11 73 70 61 74 63 68 amples)...spatch
0000000b0: 20 20 66 69 6C 65 20 20 2F 63 6D 64 73 2F 6C 73 file /bin/ls
0000000c0: 1E 09 73 70 61 74 63 68 20 20 64 69 73 6B 20 20 ..spatch disk

0000000d0: 31 20 20 31 1E 09 73 70 61 74 63 68 20 20 6D 65 1 1..spatch me
0000000e0: 6D 20 20 62 30 30 30 20 20 30 10 1E 2E 28 73 74 m b000 0...(st
0000000f0: 61 72 74 29 1E 53 50 41 54 43 48 20 69 73 20 61 art).SPATCH is a
At the top of the screen, there’s a list of commands. To select a command, either type
its first letter or move the cursor to the command (with the arrow keys) and press Enter.
The commands are as follows:
Edit Enter the data area. Pressing Tab switches between hex and ASCII
data entry. Pressing Esc returns you to the menu. The changed data
isn’t updated on the disk or in memory.

spatch © 2010, QNX Software Systems GmbH & Co. KG.
Next Move forward 256 bytes. You can also press Pg Dn.
Prev Move backward 256 bytes. You can also press Pg Up.
Home Go to the start of the file, disk, or memory. You can also press the
Home key.
Lastblk Go to the last block of the file or disk. You can also press End.
Goto Move to a specified address. The type of address depends on the

source of the data (file or disk) and the address type.
Find Search for a specified pattern, which may consist of single characters
or hex digit pairs separated by a space. For example, the patterns 61
62 63 d e and a b c d e both match the five characters abcde.
To stop the search, press any key.
Continue Find the next occurrence of the last pattern found. You typically use
this command after a Find when searching.
Save Save the current screen back to the source. Without issuing this
command, all changes made using Edit are lost as soon as you leave
the current screen of data. The Save option is disabled if you specify
the -b (browse) option.
Addr Toggle between address types:

• Absolute (default for FILE)
• Disk Block:Offset (default for DISK)
Quit Leave the spatch utility.
If you specify a directory in the file argument, the disk is edited, but spatch moves
only through the blocks that make up the directory. This is similar to “spatching” a
file, but if you wish to make changes, the disk must be opened for exclusive use as
would any block special file.
To run spatch on a directory or a block special file, you must either be root or have
write permission for the disk’s block special file.
The offset argument lets you specify the address where spatch is to begin. If file is a
regular file, the offset is a byte offset. If file is a block special file, the offset is a
block:byte offset. If file is a block special file with a QNX filesystem on it, the offset
may be the name of a file or directory (the beginning address is the first block of the
named file). If the named file has extents, spatch doesn’t thread through those
extents, but goes to the next sequential block.
You can use spatch to recover lost files or directories. For more information, see the
Working with Filesystems and Backing Up and Recovering Data chapters of the

© 2010, QNX Software Systems GmbH & Co. KG. spatch
Examples:
Patch the contents of the file /bin/ls:
spatch /bin/ls
Patch the contents of the block-special raw disk volume /dev/hd0:
spatch /dev/hd0
TERM Interpreted as the name of the terminal type.
Exit status:
0 Success.
Caveats:
You may not use the spatch utility on a disk when there are open files on the disk,
unless you specify the -b (browse) option.
See also:
hd
Working with Filesystems and Backing Up and Recovering Data in the Neutrino
User’s Guide

split © 2010, QNX Software Systems GmbH & Co. KG.
Split files into pieces (POSIX)
Syntax:
split [-a suffix_length] [-b n[k|m]] [-l line_count]
[-p pattern] [file [name]]
Runs on:
Options:
-a suffix_length Use suffix_length letters to form the suffix of the filenames of the
split file.
-b n[k|m] Split a file into pieces that are n bytes in size. You can add the
letter k or m after n to specify units of kilobytes (1024 bytes) or
megabytes (1048576 bytes).
-l line_count (“el”)Split the files so that there are line_count lines in each
resulting file piece. The line_count argument is an unsigned
decimal integer. The default is 1000. Note that the last file might
differ in size from the other files.
-p pattern (non-POSIX extension) Split the file whenever an input line

matches pattern, which is interpreted as an extended regular
expression. The matching line will be the first line of the next
output file. Note that this option is incompatible with the -b and
-l options.
file The pathname of the file to be split. If you don’t specify any files,
or file is -, split reads from standard input.
name The prefix to be used for each of the files resulting from the split
operation. If you don’t specify a name, x is used as the prefix of
the output files. The combined length of name and suffix_length
can’t exceed 48 characters.
Description:
The split utility reads an input file and writes the data from that file into one or more
output files.
By default, the names of the output files are xaa, xab, ..., xzz, and each output file,
except possibly the last, gets 1000 lines.
The last file contains the remainder of the input file, and therefore may be smaller than
the requested size. Conversely, it may be longer than the other files if there are too few
filenames available to take all the input in chunks of the specified size.

© 2010, QNX Software Systems GmbH & Co. KG. split
Examples:
Suppose you have a file named big_file that’s 8192 lines in length. The following
command creates nine files named xaa, xab, xac, ..., xai. The first eight files all
contain 1000 lines, while the last file contains only 192:
split big_file
Again, assuming that big_file is 8192 lines in length, the following command
creates only two files: smaller_aa, which contains 8000 lines, and smaller_ab,
which contains 192 lines:
split -l 8000 big_file smaller_
Files:
You can use any file as input, but if you’re splitting a nontext file, you must specify
option -b. The output files contain portions of the original input file that are otherwise
unchanged.
Exit status:
See also:
cat, cut, gawk, head, sed, tail

spooler © 2010, QNX Software Systems GmbH & Co. KG.
Handle requests for a printer’s resources
You must be root to start spooler.
Syntax:
spooler -d device [options]
Runs on:
Neutrino
Options:
-C Calculate and print the device ID, and then exit.
-c config The name of the configuration file that defines filters and properties
for a printer.
-d device The output device (default: /dev/null).
-F Disable file spooling and connect applications to filters using FIFOs.
-f maxjobs Limit the number of simultaneous spool files to maxjobs. The default
is no limit.
-g Make the printer a global network resource.
-n name The name of the printer. If this option isn’t specified, spooler gets
the name from the PnP model or the configuration file. The Print
dialog for a Photon application uses this name in the list of available
printers.
-P PnPstr The PnP string for a printer (default: query printer).
-s spooldir The spool directory (default:

/var/spool/printers/printer-name).
-v[v...] Verbose output; each addition v increases verbosity.
Description:
The spooler allows multiple users to share the resources of a single printer. If you
have more than one printer, you can start an instance of spooler for each one.
The spooler is usually started by an enumerator, such as enum-par (see
enum-devices), as follows:
spooler -d /dev/par1

© 2010, QNX Software Systems GmbH & Co. KG. spooler
or you can start spooler (e.g. for a network printer) in your /etc/rc.d/rc.local
file — see Controlling How Neutrino Starts in the Neutrino User’s Guide.
When you start spooler, it queries the printer to determine its type. If you provide a
PnP string, spooler doesn’t query the printer for it:
spooler -d /dev/par1 -P PnPstring
You can use other options to force spooler to use a configuration file and assign a
name to the printer, but this isn’t recommended:
spooler -c pcl -n My_PCL_Printer -d /dev/par1 &
You can find configuration files for commonly used printers in /etc/printers.
These files specify the possible and default settings for the printers, as well as filters
for converting output to a form that the printers understand.
Photon applications use spooler for printing. The filters that convert Photon
draw-stream (.phs) output are named phs-to-*.
For a graphical interface to spooler, see prjobs.
See also:
enum-devices, phs-to-*, prjobs
Controlling How Neutrino Starts and Printing chapters of the Neutrino User’s Guide

ssh © 2010, QNX Software Systems GmbH & Co. KG.
OpenSSH SSH client: remote login program
Syntax:
ssh [-1246AaCfgKkMNnqsTtVvXxY] [-b bind_address]
[-c cipher_spec] [-D [bind_address:]port] [-e escape_char]
[-F configfile] [-i identity_file]
[-L [bind_address:]port:host:hostport]
[-l login_name] [-m mac_spec] [-O ctl_cmd] [-o option]
[-p port] [-R [bind_address:]port:host:hostport] [-S ctl_path]
[-w local_tun[:remote_tun]] [user@]hostname [command]
Runs on:
QNX Neutrino
Options:
See ssh in the NetBSD documentation.
Description:
The ssh (SSH client) utility is a program for logging into a remote machine and for
executing commands on a remote machine. For more information, see ssh in the
NetBSD
See also:
/etc/moduli, scp, sftp, sftp-server, ssh-add, ssh-agent, ssh-keygen,

© 2010, QNX Software Systems GmbH & Co. KG. ssh-add
Add RSA or DSA identities to the authentication agent
Syntax:
ssh-add [-cDdLlXx] [-t life] [file ...]
ssh-add -s reader
ssh-add -e reader
Runs on:
QNX Neutrino
Options:
See ssh-add in the NetBSD documentation.
Description:
The ssh-add adds RSA or DSA identities to the authentication agent, ssh-agent.
For more information, see ssh-add in the NetBSD documentation.
NetBSD
See also:
/etc/moduli, scp, sftp, sftp-server, ssh, ssh-agent, ssh-keygen,

ssh-agent © 2010, QNX Software Systems GmbH & Co. KG.
Authentication agent
Syntax:
ssh-agent [-c | -s] [-d] [-a bind_address] [-t life]
[command [arg ...]]
ssh-agent [-c | -s] -k
Runs on:
QNX Neutrino
Options:
See ssh-agent in the NetBSD documentation.
Description:
The ssh-agent is a program that holds private keys used for public key
authentication (RSA, DSA). For more information, see ssh-agent in the NetBSD
documentation.
NetBSD
See also:
/etc/moduli, scp, sftp, sftp-server, ssh, ssh-add, ssh-keygen,

© 2010, QNX Software Systems GmbH & Co. KG. ˜/.ssh/ssh_config,
/etc/ssh/ssh_config
OpenSSH SSH client configuration files
Name:
˜/.ssh/ssh_config, /etc/ssh/ssh_config
Description:
The ssh program obtains configuration data from the following sources in the
following order:
1 command-line options
2 the user’s configuration file (˜/.ssh/config)
3 the system-wide configuration file (/etc/ssh/ssh_config)
For more information, see ssh_config in the NetBSD documentation.
See also:
/etc/moduli, scp, sftp, sftp-server, ssh, ssh-add, ssh-agent,
ssh-keygen, ssh-keyscan, ssh-keysign, sshd, /etc/ssh/sshd_config in
the NetBSD documentation

ssh-keygen © 2010, QNX Software Systems GmbH & Co. KG.
Authentication key generation, management, and conversion
Syntax:
ssh-keygen [-q] [-b bits] -t type [-N new_passphrase]
[-C comment] [-f output_keyfile]
ssh-keygen -p [-P old_passphrase] [-N new_passphrase]

[-f keyfile]
ssh-keygen -i [-f input_keyfile]
ssh-keygen -e [-f input_keyfile]
ssh-keygen -y [-f input_keyfile]
ssh-keygen -c [-P passphrase] [-C comment] [-f keyfile]
ssh-keygen -l [-f input_keyfile]
ssh-keygen -B [-f input_keyfile]
ssh-keygen -D reader
ssh-keygen -F hostname [-f known_hosts_file]
ssh-keygen -H [-f known_hosts_file]
ssh-keygen -R hostname [-f known_hosts_file]
ssh-keygen -U reader [-f input_keyfile]
ssh-keygen -r hostname [-f input_keyfile] [-g]
ssh-keygen -G output_file [-v] [-b bits] [-M memory]

[-S start_point]
ssh-keygen -T output_file -f input_file [-v] [-a num_trials]

[-W generator]
Runs on:
QNX Neutrino
Options:
See ssh-keygen in the NetBSD documentation.
Description:
The ssh-keygen utility generates, manages, and converts authentication keys for
ssh. For more information, see ssh-keygen in the NetBSD documentation.

© 2010, QNX Software Systems GmbH & Co. KG. ssh-keygen
NetBSD
See also:

ssh-keyscan © 2010, QNX Software Systems GmbH & Co. KG.
Gather SSH public keys
Syntax:
ssh-keyscan [-46Hv] [-f file] [-p port] [-T timeout]
[-t type] [host | addrlist namelist] [...]
Runs on:
QNX Neutrino
Options:
See ssh-keyscan in the NetBSD documentation.
Description:
The ssh-keyscan utility gathers the public SSH host keys of a number of hosts. For
more information, see ssh-keyscan in the NetBSD documentation.
NetBSD
See also:
ssh-keygen, ssh-keysign, ˜/.ssh/ssh_config, /etc/ssh/ssh_config,

© 2010, QNX Software Systems GmbH & Co. KG. ssh-keysign
SSH helper program for host-based authentication
Syntax:
ssh-keysign
Runs on:
QNX Neutrino
Options:
None.
Description:
The ssh-keysign program is used by ssh to access the local host keys and generate
the digital signature required during host-based authentication with SSH protocol
version 2. For more information, see ssh-keysign in the NetBSD documentation.
NetBSD
See also:
ssh-keygen, ssh-keyscan, ˜/.ssh/ssh_config, /etc/ssh/ssh_config,

sshd © 2010, QNX Software Systems GmbH & Co. KG.
OpenSSH SSH daemon
Syntax:
sshd [-46Ddeiqt] [-b bits] [-f config_file]
[-g login_grace_time] [-h host_key_file] [-k key_gen_time] [-o option]
[-p port] [-u len]
Runs on:
QNX Neutrino
Options:
See sshd in the NetBSD documentation.
Description:
The sshd (OpenSSH Daemon) is the daemon program for ssh. Together, these
programs replace rlogin and rsh, and provide secure encrypted communications
between two untrusted hosts over an insecure network. For more information, see
sshd in the NetBSD documentation.
NetBSD
See also:
rlogin, rsh
ssh-keygen, ssh-keyscan, ssh-keysign, ˜/.ssh/ssh_config,
/etc/ssh/ssh_config, /etc/ssh/sshd_config in the NetBSD documentation

© 2010, QNX Software Systems GmbH & Co. KG. /etc/ssh/sshd_config
OpenSSH SSH daemon configuration file
Name:
/etc/ssh/sshd_config
Description:
The sshd daemon reads configuration data from /etc/ssh/sshd_config (or the
file specified with the -f option). For more information, see
/etc/ssh/sshd_config in the NetBSD documentation.
See also:
ssh-keygen, ssh-keyscan, ssh-keysign, ˜/.ssh/ssh_config,
/etc/ssh/ssh_config, sshd in the NetBSD documentation

startup-* options © 2010, QNX Software Systems GmbH & Co. KG.
Generic options for startup programs (QNX Neutrino)
Description:
All QNX Neutrino startup programs support the generic options described below.
There are additional options for the following architectures:
• ARM
• PowerPC
• x86
There are currently no additional options for MIPS or SH.
Individual startup programs can override these options and may support additional
board-specific options. The order of precedence is as follows:
1 board-specific options
2 architecture-specific options
3 generic options
Generic options
-A Reboot the system on any abnormal termination of the kernel.
The default is to display information about the crash, and then
halt.
-D channel[.channel_opts]
Specify an output channel for debugging information. The
format of this option and the default value vary from board to
board.
-F [˜]value Control the flags field in the cpuinfo section of the system page:
• value — OR the flags field with value
• ˜value — AND the flags field with ˜value
For more information about the flags, see “Structure of the
system page” in the Customizing Image Startup Programs
chapter of the Building Embedded Systems guide.
-f [cpu_freq][,[cycles_freq][,timer_freq]]
Specify CPU frequencies. All frequencies can be followed by
H for hertz, K for kilohertz, or M for megahertz (these suffixes
aren’t case-sensitive). If no suffix is given, the library assumes
megahertz if the number is less than 1000; otherwise it
assumes hertz.

© 2010, QNX Software Systems GmbH & Co. KG. startup-* options
If they’re specified, cpu_freq, cycles_freq, and timer_freq are

used to set the corresponding variables in the startup code:
• cpu_freq — the CPU clock frequency. It’s also used to set
the speed field in the cpuinfo section of the system page.
• cycles_freq — the frequency at which the value returned by
ClockCycles() increments. It’s also used to set the
cycles_per_sec field in the qtime section of the system page.
• timer_freq — the frequency at which the timer chip input
runs. It’s also used to set the timer_rate and timer_scale
values of the qtime section of the system page.
If a variable is zero when it comes time to set the field(s) on the
system page, the library code attempts to deduce the proper
value by using one of the other frequency variables. Which one
it uses depends on the particular CPU and hardware.
-I flag Enable kernel restoration as part of IFS restoration. The flag is

0 to disable checksum verification, or 1 to enable it.
If checksum verification is enabled and fails, the entire image
is reloaded.
Even if the IFS checksum verification is disabled, a checksum is still performed on the
IFS Restoration internal data structure (approximately 32 bytes) to ensure at least
some data integrity.
For more information, see Reloadable Image Filesystems in the
QNX Neutrino technotes.
-i ifs2_size[,flags][,paddr_src][,paddr_dst]
Enable secondary IFS restoration.
The arguments are:
ifs2_size The size of the secondary IFS (note: this can be

larger than the actual size).
flags • Not specified — load the secondary IFS but
don’t try to restore on wake-up
• R — load the secondary IFS and restore
• K or RK — load the secondary IFS and restore
with a checksum
paddr_src • Not specified — the secondary IFS is located
in flash after the primary IFS
• Specified — the secondary IFS is located at the
physical address specified
paddr_dst • Not specified — the secondary IFS will be
copied to a default location in RAM

• Specified — the secondary IFS will be copied

to the physical address specified (choose an
address in a “safe” place, such as at the end of
RAM away from where the primary image is
copied)
If the checksum is enabled and fails, the entire secondary IFS

is reloaded.
Even if the secondary IFS checksum is disabled, a checksum is still performed on the
IFS Restoration internal data structure (approximately 16 bytes) to ensure at least
some data integrity.
For more information, see Reloadable Image Filesystems in the
QNX Neutrino technotes.
-j addr For use with JTAG/hardware debuggers.

Reserve 4 bytes of RAM at the physical address specified by
addr, and copy the physical address of the location of the
system page to addr in RAM so that it can be retrieved by a
hardware debugger.
-K channel[.channel_opts]
Specify an output channel for kernel debugger information.
The format of this option and the default value vary from board
to board.
-N hostname Specify the node name. The default is the local host.
-P max_CPUs Specify the maximum number of processors to activate in a

multicore system. This is useful for testing how well your
application runs on a system with fewer CPUs. This option
requires procnto-smp instead of procnto to have an effect.
-R size[,align] Remove size memory from system use, optionally specifying

the alignment. This is useful for testing in a restricted-memory
environment. The size and and alignment are in bytes, unless
followed by one of K (kilobytes), M (megabytes), or G
(gigabytes).
-r addr,size[,flag] Remove size memory from system use starting at addr.

The flag is an optional argument used to specify if the memory
should be cleared:

© 2010, QNX Software Systems GmbH & Co. KG. startup-* options
Flag: Memory:
None Clears to 0
0 Clears to 0
1 Does not clear
-S [˜]section Turn on (or, if you use ˜section, off) output of the specified
syspage section’s information. Use this to restrict the amount
of syspage information. For more information, see the
description of print_syspage() in the Customizing Image
Startup Programs chapter of Building Embedded Systems.
-T Prevent the startup program from setting the

SYSPAGE_ENTRY(qtime)->boot_time field. If this field is
0 the first time you call ClockTime() to change the time of day,
the kernel sets it to the appropriate value. This is useful if the
RTC hardware isn’t in UTC.
-v[v]... Be verbose. More v characters cause even more verbosity.
Options for ARM startups

The following options are supported in the startup programs for ARM targets:
-w value Set the cache policy:

• -wb sets write-back, read-allocate (no write-allocate) caching
• -wa sets write-back, write-allocate caching
• -wt sets write-through caching
The actual behavior depends on the processor; not all processors
implement all 3 types of caching. If the processor doesn’t implement the
requested option, the default cache policy is used.
The supported cache policies are specified in the processor configuration
file, armv_chip_xxxx.c:
This field: Specifies PTE encodings for the:

pte Default cache policy
pte_wb Write-back (-wb) policy
pte_wa Write-allocate (-wa) policy
pte_wt Write-through (-wt) policy

The configuration must specify at least the default (pte) field. Any
unsupported policy should specify 0 in the appropriate field, and if that
policy is requested via the -w option, it’s ignored, and the default policy
is used.
Options for PowerPC startups

The following options are supported in the startup programs for PowerPC targets:
-E Save and restore the External Access Register (EAR) in the context when
switching threads. The EAR is an optional register available on some PPC600
family chips. If the chip supports it, it should be saved and restored, but the
instructions that reference it are seldom used. Accordingly, it’s left out of the
thread context for performance reasons, unless you specify the -E option.
-x Enable extended addressing. This lets you access physical addresses above 4
GB. This option is supported for backward compatibility; XAE is enabled by
default if the chip supports it.
Options for x86 startups

The following options are supported in the startup programs for x86 targets:
-B By default, x86 startups use the Advanced Control and Power Interface (ACPI)
table to determine the number of logical CPUs on hyperthreaded systems. Use
this option to avoid checking for ACPI in the case of buggy BIOSs; if ACPI
isn’t present or you specify -B, the startup uses the Intel Multiprocessor
Specification to determine the number of CPUs.
-x Enable extended addressing. This lets you access physical addresses above 4
GB.
This option has an effect only if the CPU supports more than 32 address lines. On x86
CPUs, extended addressing is supported if the X86_CPU_PAE bit is on in the
SYSPAGE_ENTRY(cpuinfo)->flags. For more information, see “Structure of the
system page” in the Customizing Image Startup Programs chapter of Building
Embedded Systems.
See also:
mkifs, procnto, startup-*
ClockTime(), SYSPAGE_ENTRY() in the QNX Neutrino Library Reference
Customizing Image Startup Programs in Building Embedded Systems
Reloadable Image Filesystems in the QNX Neutrino technotes

© 2010, QNX Software Systems GmbH & Co. KG. startup-apic
Startup for Intel Advanced Programmable Interrupt Controller (APIC) systems (QNX Neutrino)
Syntax:
startup-apic [-ABb] [-D channel[.channel_opts]]
[-F [˜]value]
[-f [cpu_freq][,[cycles_freq][,timer_freq]]]
[-I flag] [-i ifs2_size[,flags][,paddr_src][,paddr_dst]]
[-j addr] [-K channel[.channel_opts]]
[-N hostname] [-P max_cpus]
[-R size[,align]] [-r addr,size[,flag]]
[-S [˜]section] [-s size] [-T] [-v[v]...] [-x]
Runs on:
QNX Neutrino
Targets:
x86
Options:
In addition to the generic startup-* and x86-specific options, startup-apic
supports the following options:
-b Don’t reserve the bottom 4 KB of memory for virtual 8086 mode. This
provides an extra 4 KB of memory for system use.
-s size Copy the given amount of video card ROM into RAM, and set the x86
page tables to refer to the RAM copy rather than the ROM. The size is in
bytes, unless followed by one of K (kilobytes), M (megabytes), or G
(gigabytes). Specifying the -s option causes the following call:
x86_pcbios_shadow_rom( 0xc0000, size );
For more information, see “The startup library” in the Customizing Image
Debug channels
The debug channel specified with the -D and -K options can be:
8250[.port[ˆshift][.baud[.clock[.divisor]]]]
Use a generic 8250-compatible serial chip, with:
port Specify the I/O port base address for the 8250, in hexadecimal.
The default is 3f8.
shift Specify the spacing between the I/O registers, in 2shift bytes.
The default is 0.

startup-apic © 2010, QNX Software Systems GmbH & Co. KG.
baud Specify the baud rate for the debug channel. The default is
57600.
clock Specify the clock rate (in Hz) input to the chip. The default is
1843200.
divisor Specify the divisor used on the clock rate by the chip. The
default is 16.
console Use the PC console.
You can skip options by leaving out the data associated with that part. For example, if
you want to send the debugging output to an 8250 chip using 9600 baud, use:
-D 8250..9600
The default -D and -K settings are:
-D console
-K 8250.3f8ˆ0.57600.1843200.16
Description:
The startup-apic program is the startup for boards that support Intel Advanced
Programmable Interrupt Controllers (APIC). It supports Message Signaled Interrupts
(MSI) and Extended MSI (MSI-X).
If you’re running startup-apic, you must use pci-bios-v2 instead of pci-bios,

but it must still be called pci-bios in order for the enumerators to work correctly. In
your buildfile, add pci-bios-v2 like this:
pci-bios=pci-bios-v2
Examples:
Direct debug output to the console:
startup-apic -Nnode120 -vvvv -Dconsole
Direct debug output to the first serial port (making sure the baud rate was set to
115200 on the receiving side):
startup-apic -Nnode120 -vvvv -D8250..115200
Direct debug output to the serial port at 2f8:
startup-apic -Nnode120 -vvvv -D8250.2f8.115200

© 2010, QNX Software Systems GmbH & Co. KG. startup-apic
See also:
mkifs, pci-bios-v2, procnto, procnto-smp, startup-* options, startup-*

startup-bios, startup-bios-32 © 2010, QNX Software Systems GmbH & Co. KG.
Startup for PC-compatible systems with a BIOS (QNX Neutrino)
Syntax:
startup-bios [-ABb] [-D channel[.channel_opts]]
[-F [˜]value]
[-I irq] [-j addr] [-K channel[.channel_opts]] [-L]
startup-bios-32 [-ABb] [-D channel[.channel_opts]]

[-F [˜]value]
[-I irq] [-j addr] [-K channel[.channel_opts]] [-L]
Runs on:
Neutrino
Targets:
x86 with a PC-compatible BIOS
Options:
In addition to the generic startup-* and x86-specific options, startup-bios and
startup-bios-32 support the following options:
-b Don’t reserve the bottom 4 KB of memory for virtual 8086 mode. This
provides an extra 4 KB of memory for system use.
-I irq Make irq the highest-priority hardware interrupt in the system. You can
specify a number from 0 through 7 (the default is 3).
This overrides the default -I option.
-L Enable support for the Local APIC interrupts (X86_INTR_APIC_*

definitions in <x86/intr.h>).
-s size Copy the given amount of video card ROM into RAM, and set the x86
page tables to refer to the RAM copy rather than the ROM. The size is in
bytes, unless followed by one of K (kilobytes), M (megabytes), or G
(gigabytes). Specifying the -s option causes the following call:
x86_pcbios_shadow_rom( 0xc0000, size );
For more information, see “The startup library” in the Customizing Image

© 2010, QNX Software Systems GmbH & Co. KG. startup-bios, startup-bios-32
Debug channels
The debug channel specified with the -D and -K options can be:
8250[.port[ˆshift][.baud[.clock[.divisor]]]]
Use a generic 8250-compatible serial chip, with:
port Specify the I/O port base address for the 8250, in
hexadecimal. The default is 3f8.
shift Specify the spacing between the I/O registers, in 2shift bytes.
The default is 0.
baud Specify the baud rate for the debug channel. The default is
57600.
clock Specify the clock rate (in Hz) input to the chip. The default is
1843200.
divisor Specify the divisor used on the clock rate by the chip. The
default is 16.
console Use the PC console.
You can skip options by leaving out the data associated with that part. For example, if
you want to send the debugging output to an 8250 chip using 9600 baud, use:
-D 8250..9600
The default -D and -K settings are:
-D console
-K 8250.3f8ˆ0.57600.1843200.16
Description:
The startup-bios and startup-bios-32 programs are responsible for probing
PC hardware resources using the BIOS. They’re similar, except that startup-bios
uses 64-bit physical addresses, and startup-bios-32 uses 32-bit ones.
If you want to use Message Signaled Interrupts (MSI) or Extended MSI (MSI-X), use
startup-apic instead of startup-bios in your build file. You must use
startup-apic in conjunction with pci-bios-v2.
Examples:
Direct debug output to the console:
startup-bios -Nnode120 -vvvv -Dconsole
Direct debug output to the first serial port (making sure the baud rate was set to
115200 on the receiving side):
startup-bios -Nnode120 -vvvv -D8250..115200
Direct debug output to the serial port at 2f8:
startup-bios -Nnode120 -vvvv -D8250.2f8.115200
For more examples, see ${QNX_TARGET}/x86/build.

startup-bios, startup-bios-32 © 2010, QNX Software Systems GmbH & Co. KG.
See also:
mkifs, procnto, procnto-smp, startup-*

© 2010, QNX Software Systems GmbH & Co. KG. strings
Find printable strings in files (POSIX)
Syntax:
strings_variants [options] file...
Runs on:
Options:
The strings_variant depends on the target platform, as follows:
Target platform: strings_variant:

ARM ntoarm-strings
MIPS ntomips-strings
PowerPC ntoppc-strings
SH4 ntosh-strings
x86 ntox86-strings
Description:
For each file given, strings prints the printable character sequences that are at least 4
characters long (or the number given with the options) and are followed by an
unprintable character. By default, it prints only the strings from the initialized and
loaded sections of object and ELF files; for other types of files, it prints the strings
from the whole file.
The strings utility is mainly useful for determining the contents of nontext files.
GNU

strip © 2010, QNX Software Systems GmbH & Co. KG.
Remove unnecessary information from executable files (POSIX)
Syntax:
strip_variant [options] objfile...
Runs on:
Options:
The strip_variant depends on the target platform, as follows:
Target platform: strip_variant:

ARM ntoarm-strip
MIPS ntomips-strip
PowerPC ntoppc-strip
SH4 ntosh-strip
x86 ntox86-strip
Description:
The strip utility discards all symbols from object files objfile. The list of object files
may include archives. At least one object file must be given.
This utility modifies the files named in its argument instead of writing modified copies
under different names.
GNU

© 2010, QNX Software Systems GmbH & Co. KG. stty
Set tty attributes (POSIX)
Syntax:
stty [-a|-g] [operands] [< device]
Runs on:
Options:
-a Display all settings.
-g Display in “getable” form.
Description:
The stty utility sets and/or reports terminal I/O characteristics for the device that is
its standard input. If no operands are specified, stty displays the settings. If operands
are given, then stty changes the terminal state to reflect those settings.
Terminal settings fall into two major categories:
edit mode The user can edit the input data. It’s made available to programs only
when a CR is pressed. Output data is normally presented in a
human-readable format.
raw mode All data flows to and from the terminal with little extra processing.
If you’re at a shell prompt, your terminal is probably in the default system edit mode.
A full-screen program such as an editor, on the other hand, typically puts the terminal
into raw mode.
Normally, stty displays only significant settings relative to the system default
settings for edit or raw, and displays only the defined control characters. If -a or -g is
specified, then stty displays all the settings.
The stty utility manages a very large number of potential terminal attributes and
control characters. Most of these parameters are very device-specific and seldom need
to be changed by the user. Programs often change these terminal attributes in the
course of their operation, and upon occasion (such as abnormal termination) may leave
the terminal settings in an unknown state. The stty +edit option is a convenient
method of restoring a terminal to a usable state.
Supported operands
The tables below list the operands supported by stty. In these tables, the following
conventions are used:
number A decimal integer number (e.g. 9600).
name A string of characters (e.g. vt100).

stty © 2010, QNX Software Systems GmbH & Co. KG.
value A single character (e.g. ˜) or a 2-digit hexadecimal number (e.g. 1B) or

one of the following character pairs:
Char pair Hex

ˆ- 00 (undefined)
Â to ˆZ 01 to 1A
ˆ[ 1B
ˆ\ 1C
ˆ] 1D
ˆˆ 1E
ˆ_ 1F
ˆ? 7F
Some options can start with either + or -:
+ Turn the option on.
- Turn the option off.
If you don’t specify + or -, + is assumed.

Also note that the = character is optional in operands of the form keyword=value.
The following descriptions give the action taken when the option is on.
Line control parameters

Parameter Defines
baud=number Input and output baud rates
ispeed=number Input baud rate
ospeed=number Output baud rate
par=none No parity (same as -parenb)
par=odd Odd parity (same as +parenb, +parodd, -parstk)
par=even Even parity (same as +parenb, -parodd, -parstk)
par=mark Mark parity (same as +parenb,+parodd, +parstk)
par=space Space parity (same as +parenb, -parodd, +parstk)
continued. . .

Parameter Defines
bits=5 5-bit characters
stopb=2 2-stop bits
stopb=1 1-stop bits
{+|-}parenb Enable parity
+parodd Odd parity
-parodd Even parity
{+|-}parstk Stick parity
+cs5 Same as bits=5
+cs6 Same as bits=6
+cs7 Same as bits=7
+cs8 Same as bits=8
+cstopb Same as stopb=2
-cstopb Same as stopb=1
number Same as baud=number
+evenp Same as par=even, bits=7
-evenp Same as par=none, bits=8
+parity Same as par=even, bits=7
-parity Same as par=none, bits=8
+oddp Same as par=odd, bits=7
-oddp Same as par=none, bits=8
{+|-}hupcl Hangup on last close
{+|-}hup Same as hupcl
{+|-}cread Enable receiver
{+|-}clocal Assume no modem control
{+|-}ihflow Enable hardware input flow control
{+|-}ohflow Enable hardware output flow control
continued. . .

Parameter Defines
{+|-}isflow Enable software input flow control
{+|-}osflow Enable software output flow control
{+|-}ihpaged Input is paged by hardware flow control
{+|-}ohpaged Output is paged by hardware flow control
{+|-}ispaged Input is paged by software flow control
{+|-}ospaged Output is paged by software flow control
rows=value[,value] The number of rows and (optionally) columns of the terminal
Input processing parameters

Parameter Defines
{+|-}ignbrk Ignore received hardware breaks
{+|-}brkint Generate SIGINT upon break
{+|-}ignpar Ignore parity errors
[-]imaxbel Beep and don’t flush a full input buffer on a character
{+|-}parmrk Mark parity errors
{+|-}inpck Enable software parity checking
{+|-}istrip Strip 7th bit from received characters
{+|-}inlcr Map NL into CR on input
{+|-}onlcr Map NL into CR on output
{+|-}igncr Ignore received CR
{+|-}icrnl Map CR into NL on input
{+|-}ixon Same as osflow
{+|-}ixoff Same as isflow
{+|-}isig Generate signals upon receipt of special characters
{+|-}icanon Enable input line editing
{+|-}iexten Enable “extra” special characters
{+|-}echo Echo received characters
{+|-}echoctl Echo control characters in hat notation (e.g ˆc)
{+|-}echoe Erase character erases displayed character
{+|-}echok Echo a newline after a kill character
continued. . .

Parameter Defines
{+|-}echoke Kill character erases displayed line
{+|-}echonl Echo NL, even if ECHO is off
{+|-}noflsh Don’t flush I/O after INTR, QUIT, or SUSP
min=number Minimum characters required to satisfy raw input
time=number Timeout value for raw input
{+|-}tostop Send SIGTTOU for background output.
+nl Same as +icrnl
-nl Same as -icrnl, -inlcr, -igncr
+sane Reset all parameters to sane values based on current mode
(edit/raw)
+fix Same as +sane
+edit Reset parameters to system default edit mode
+flush Flush all pending input and output
+raw Reset parameters to system default raw mode
Output processing parameters

Parameter Defines
{+|-}opost Post-process output data
Special control characters

Parameter Defines
discard=value Discard character
dsusp=value Character for sending a terminal stop signal once input is flushed
eof=value End-of-file character
eol=value End-of-line character
eol2=value Alternative end-of-line character
erase=value Delete previous character
continued. . .

Parameter Defines
fwd=value Forwarding or framing character; if this character is set, then
readcond() returns when either the read length is reached or the
FWD character is found in the data stream. For more
information, see the entry for readcond() in the QNX Neutrino
Library Reference.
intr=value Generate SIGINT character
kill=value Delete entire line character
lnext=value Character for entering the next character quoted
quit=value Generate SIGQUIT character
reprint=value Character for redrawing the current line
susp=value Generate SIGTSTP character
swtch=value Character for switching to a different shell layer
stop=value Stop output
start=value Resume output
+ek Resets ERASE and KILL to system defaults
werase=value Character for erasing the last word typed
Extended line-editing character sequences

QNX Neutrino supports multicharacter sequences to support editing capabilities in
addition to the basic “erase” and “kill” functions. All of these sequences are assumed
to start with an (up to) 4-character prefix, a single-character action, followed by an (up
to) 4-character suffix. Typically, the cursor keys on your terminal are used for these
functions.
Parameter Meaning
+load Set editing keys based on currently defined terminal type
term=name Set editing keys for the specified type of terminal
pr1=value First character of prefix
pr2=value Second character of prefix
pr3=value Third character of prefix
pr4=value Fourth character of prefix
sf1=value First character of suffix
continued. . .

Parameter Meaning
sf2=value Second character of suffix
sf3=value Third character of suffix
sf4=value Fourth character of suffix
Action characters
The following are action characters when preceded by prefix (subsequent suffix are
discarded).
Parameter Meaning
up=value Recall previous line
down=value Recall next line
left=value Move cursor left
right=value Move cursor right
ins=value Toggle insert mode
del=value Delete current character
rub=value Delete previous character
can=value Delete entire line character
home=value Move cursor to beginning of line
end=value Move cursor to end of line
Examples:
Display settings of the terminal to which stty is attached:
stty
Display settings of a specified device:
stty < /dev/ser1
Change the baud rate of a specified device:
stty baud=1200 < /dev/ser1
Put terminal into a fixed, sane state:
stty +sane
Set editing keys to VT100 values:
stty term=vt100
Restore settings from a shell variable:
stty $saveterm

Exit status:
0 Success.
Caveats:
The stty utility quietly accepts all of the documented options, but some of the current
managers might not support them.

© 2010, QNX Software Systems GmbH & Co. KG. su
Switch user ID (UNIX)
Syntax:
su [-c] [[-] userid [arguments]]
Runs on:
Neutrino
Options:
-c Pass the specified list of arguments to the shell.
userid Switch to the specified user ID. If preceeded by the - argument, userid’s
login scripts will run, setting up the shell environment as if you had
actually logged in as the specified user.
Description:
The su utility lets you temporarily become another user, then return to your regular
userid.
The su utility requests the password of the given userid (root, by default) and
changes to that userid, invoking its shell but modifying only essential elements of the
environment. Only the HOME, PATH, and possibly SHELL environment variables
are changed, but the new shell has the rights and privileges of the user specified. The
new userid remains in effect until this shell exits.
Files:
/bin/sh Korn shell command interpreter.
/dev/null The bit bucket.
/etc/.pwlock This file is used to lock password files when modifications are
taking place.
/etc/acclog Logs system accounting information.
/etc/default/profile
The passwd utility copies this file as a user’s initial .profile
when it creates a new account.
/etc/group Defines the known groups for the system.
/etc/passwd Defines the valid user IDs on the system.

su © 2010, QNX Software Systems GmbH & Co. KG.
/etc/shadow Contains encoded versions of the actual passwords for user

accounts. The passwords themselves aren’t stored in the
/etc/passwd file.
/usr/adm/sulog Records all su activity.
See also:
login, passwd

© 2010, QNX Software Systems GmbH & Co. KG. sync
Update filesystems to match cached data (UNIX)
Syntax:
sync
Runs on:
Neutrino
Options:
None.
Description:
The sync utility forces the filesystem manager to begin flushing all modified
in-memory inodes and all previously unwritten system buffers to disk. This ensures
that all file modifications up to that point are scheduled to be saved.
The sync utility usually returns before the operation is complete. After executing
sync, you must allow sufficient time for the driver queues to drain before you may
assume that the data is safely on disk. This delay depends on the speed of your disk(s),
the number of buffers that must be drained, and how active your system is at the time.
It is unusual for the operation to take more than four to five seconds with typical IDE
drives and a large (2 megabyte) cache, if a large portion of the cache needs to be
flushed. With faster disks (e.g. SCSI), it usually completes in under two seconds. If
significant amounts of data are being flushed to a floppy disk, it could take many tens
of seconds.
Examples:
Synchronize the local filesystem:
sync
See also:
shutdown

sysctl © 2010, QNX Software Systems GmbH & Co. KG.
Get or set the state of the socket manager
Syntax:
sysctl [-n] name...
sysctl [-n] -w name=value...
sysctl [-n] -a|A
Runs on:
Neutrino
Options:
-a List all the currently available string or integer values.
-A List all the known MIB names, including tables. Those with
string or integer values are printed as they would be with the -a
option; for the table values, the name of the utility to retrieve
them is given.
-n Suppress the printing of the field name, and output only its value.
You’ll find this option useful when you’re setting shell variables.
For example, to save the IP TTL value in the variable ipttl, type
the following:
set ipttl=‘sysctl -n net.inet.ip.ttl‘
-w name=value Set the value for the given MIB name.
Description:
The sysctl utility retrieves the state of the socket manager and allows processes with
appropriate privilege to set the state. The variable to be retrieved or set is described
using a Management Information Base (MIB) style name, described as a dotted set of
components.
The information available from sysctl consists of integers, strings, and tables. You
can retrieve tabular information only by using special-purpose programs such as arp
and netstat.
The variables that are available to you depend on what you’re running on your
machine; the table below shows the variables that are likely of most interest. For
information about determining the meaning of other variables, see sysctl() in the
A process with appropriate privilege can change the value of all these variables except
those marked as read-only. All values are integers unless otherwise indicated.

© 2010, QNX Software Systems GmbH & Co. KG. sysctl
kern.clockrate (read only)

A struct clockinfo that contains the clock, statistics clock and
profiling clock frequencies, the number of microseconds per Hz
tick, and the clock skew rate.
kern.mbuf.mblowat
The mbuf low water mark.
kern.mbuf.mclbytes
The mbuf cluster size.
kern.mbuf.mcllowat
The mbuf cluster low water mark.
kern.mbuf.msize
The mbuf base size.
kern.mbuf.nmbclusters
The limit on the number of mbuf clusters. You can only increase
this limit, and only on machines with direct-mapped pool pages.
kern.sbmax The maximum socket buffer size.
net.inet.arp.down
The failed ARP entry lifetime.
net.inet.arp.keep
The valid ARP entry lifetime.
net.inet.arp.prune
The ARP cache pruning interval.
net.inet.arp.refresh
The ARP entry refresh interval.
net.inet.ip.allowsrcrt
Allow (1) or drop (0) all source-routed packets.
net.inet.ip.directed-broadcast
Enable (1) or disable (0) directed-broadcast.
net.inet.ip.do_loopback_cksum
Compute (1) or don’t compute (0) checksums on loopback.
net.inet.ip.forwarding
Disable (0) or enable (1) IP forwarding. If this is enabled, the host
acts as a router.

net.inet.ip.forwsrcrt
Forward source-routed packets.
net.inet.ip.maxflows
The maximum number of IP flows allowed.
net.inet.ip.mtudisc
Allow (1) or disallow (0) path MTU discovery.
net.inet.ip.redirect
Allow (1) or disallow (0) send ICMP redirections when forwarding.
This option is ignored unless the host is routing IP packets.
Normally, this option should be enabled on all systems.
net.inet.ip.subnetsarelocal
Treat (1) or don’t treat (0) subnets as local addresses.
net.inet.ip.ttl
The maximum time-to-live (hop count) value for an IP packet
sourced by the system. This value applies to normal transport
protocols, not to ICMP.
net.inet.tcp.congctl.available
A string that lists the available TCP congestion-control algorithms.
net.inet.tcp.congctl.selected
A string that contains the name of the currently selected TCP
congestion-control algorithm.
net.inet.tcp.do_loopback_cksum
net.inet.tcp.keepcnt
The keepalive count.
net.inet.tcp.keepidle
The keepalive idle time, in milliseconds.
net.inet.tcp.keepintvl
The keepalive probe interval, in milliseconds.
net.inet.tcp.mssdflt
The default maximum segment size.
net.inet.tcp.recvspace
The default size of the receive buffer.
net.inet.tcp.sack.enable
Enable (1) or disable (0) RFC 2018 Selective ACKnowledgements.

net.inet.tcp.sack.globalholes (read only)

The global number of TCP SACK holes.
net.inet.tcp.sack.globalmaxholes
The global maximum number of TCP SACK holes.
net.inet.tcp.sack.maxholes
The maximum number of TCP SACK holes allowed per connection.
net.inet.tcp.sendspace
The default size of the send buffer.
net.inet.tcp.slowhz (read only)
The units for tcp.keepidle and tcp.keepintvl; those
variables are in ticks of a clock that ticks tcp.slowhz times per
second. (That is, you must divide their values by the value of
tcp.slowhz to get times in seconds.)
net.inet.tcp.win_scale
RFC 1323 window scaling.
net.inet.udp.do_loopback_cksum
net.inet.udp.recvspace
net.inet.udp.sendspace
net.inet6.ip6.forwarding
Disable (0) or enable (1) IP forwarding. If this is enabled, the host
acts as a router.
net.inet6.ip6.redirect
Allow (1) or disallow (0) send ICMP redirections when forwarding.
This option is ignored unless the host is routing IP packets.
Normally, this option should be enabled on all systems.
net.inet6.tcp6.do_loopback_cksum
net.inet6.tcp6.keepcnt
The keepalive count.
net.inet6.tcp6.keepidle
The keepalive idle time, in milliseconds.

net.inet6.tcp6.keepintvl
The keepalive probe interval, in milliseconds.
net.inet6.tcp6.recvspace
net.inet6.tcp6.sack.enable
Enable (1) or disable (0) RFC 2018 Selective ACKnowledgements.
net.inet6.tcp6.sack.globalholes (read only)
The global number of TCP SACK holes.
net.inet6.tcp6.sack.globalmaxholes
The global maximum number of TCP SACK holes.
net.inet6.tcp6.sack.maxholes
The maximum number of TCP SACK holes allowed per connection.
net.inet6.tcp6.sendspace
net.inet6.tcp6.slowhz (read only)
The units for tcp.keepidle and tcp.keepintvl; those
variables are in ticks of a clock that ticks tcp.slowhz times per
second. (That is, you must divide their values by the value of
tcp.slowhz to get times in seconds.)
net.inet6.udp6.do_loopback_cksum
net.inet6.udp6.recvspace
net.inet6.udp6.sendspace
Examples:
Check to see if the UDP checksum is enabled:
sysctl net.inet.udp.checksum
Disabling UDP checksums is strongly discouraged.
Enable IP forwarding so that the host acts as a router:
sysctl -w net.inet.ip.forwarding=1

See also:
arp, netstat
sysctl() in the Neutrino Library Reference

sysinfo © 2010, QNX Software Systems GmbH & Co. KG.
Gather system information for troubleshooting purposes (QNX Neutrino)
You must run this script as root.
Syntax:
sysinfo [options]
Runs on:
QNX Neutrino, Microsoft Windows, Linux
Options:
-l Use logging mode (loops gathering data in a cycled mode).
-s Suppress the prompt.
-F dir Specify a target directory for output files. The default is /tmp.
-D delay Specify a delay in seconds between cycles in logging mode.
-P priority Specify the priority at which to gather the data, in the range 0–254.
The default is 10.
These options indicate what information to gather:
Option Information gathered

-A All
-a Audio
-f Filesystem
-g Graphics
-h HID
-m Modem
-n Network
-p PCCard
-u USB
Description:
The sysinfo script gathers system information based on the options you specify, and
then stores the output in a sysinfo.tar.gz file located in the target directory
specified by the -F option (the default is /tmp). QNX Technical Support might ask

© 2010, QNX Software Systems GmbH & Co. KG. sysinfo
you to use this script to gather information to help them solve a problem on your
system.
The sysinfo script offers a logging mode, which runs at the specified priority
(default 10) and logs general system information. It logs the files in a ring mode, such
that it keeps the last four entries, so that there is some system history for a problem
that’s being tracked. This is good for systems that are rebooting because of an error on
the system; a running log of what happened in the system last could give some hints as
to what went wrong.
Examples:
Fetch all system information that pertains to audio, graphics, and HID, and place it in
the default /tmp/sysinfo.tar.gz file:
sysinfo -a -g -h
See also:
qbinaudit, qconfig, QWinCfg, showlicense

/etc/syslog.conf © 2010, QNX Software Systems GmbH & Co. KG.
Configuration file for syslogd
Name:
/etc/syslog.conf
Description:
The /etc/syslog.conf file is the configuration file for the syslogd daemon. It
consists of lines with two fields:
Selector field The types of messages and priorities to which the line applies.
Action field The action to take if a message received by syslogd matches the
selection criteria.
Use one or more tab characters to separate the selector and action fields.
The selectors are encoded as a facility, a dot (.), and a level, with no intervening
whitespace. Both the facility and the level are case-insensitive.
The facility describes the part of the system generating the message, and is one of the
following keywords:
• auth
• authpriv
• cron
• daemon
• kern
• lpr
• mail
• mark
• news
• syslog
• user
• uucp
• local0 through local7.

© 2010, QNX Software Systems GmbH & Co. KG. /etc/syslog.conf
These keywords (with the exception of mark) correspond to the similar “LOG_”
values specified to the openlog() and syslog() routines.
The level describes the severity of the message, and is a keyword from the following
ordered (higher to lower) list:
• emerg
• alert
• crit
• err
• warning
• notice
• info
• debug
These keywords also correspond to the similar “LOG_” values specified to the
syslog() routine.
For further descriptions of both the facility and level keywords and their significance,
see syslog() in the Library Reference.
If a received message matches the specified facility and is of the specified (or higher)
level, then the action specified in the action field is taken.
You can specify multiple selectors for a single action by separating them with
semicolon (;) characters.
Note that each selector can modify the ones preceding it.
You can specify multiple facilities for a single level by separating them with comma
(,) characters.
You can use an asterisk (*) to specify all facilities or all levels.
The special facility mark receives a message at priority info every 20 minutes (see
syslogd).
The special level none disables a particular facility.
The action field of each line specifies the action to be taken when the selector field
selects a message. The action field can take these forms:
• a pathname (beginning with a leading slash) — the selected messages are appended
to the file
• a hostname (preceded by @) — the selected messages are forwarded to the

syslogd program on the named host

/etc/syslog.conf © 2010, QNX Software Systems GmbH & Co. KG.
Blank lines and lines whose first nonblank character is a hash (#) character are
ignored.
Examples:
A configuration file might appear as follows:
# Log all kernel messages, authentication messages of

# level notice or higher and anything of level err or
# higher to the console.
# Don’t log private authentication messages!
*.err;kern.*;auth.notice;authpriv.none /dev/console
# Log anything (except mail) of level info or higher.

# Don’t log private authentication messages!
*.info;mail.none;authpriv.none /var/log/messages
# The authpriv file has restricted access.

authpriv.* /var/log/secure
# Log all the mail messages in one place.

mail.* /var/log/maillog
# Everybody gets emergency messages, plus log them on

# another machine.
*.emerg *
*.emerg @arpa.berkeley.edu
# Root and Eric get alert and higher messages.

*.alert root,eric
# Save mail and news errors of level err and higher in a

# special file.
uucp,news.crit /var/log/spoolerr
Caveats:
The effects of multiple selectors aren’t always intuitive. For example,
mail.crit,*.err selects mail facility messages at the level of err or higher, not
at the level of crit or higher.
Logging messages to users isn’t currently implemented.
See also:
syslogd
openlog(), syslog() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. syslogd
Log system messages
You must be root to run this daemon.
Syntax:
syslogd [-f config_file] [-m mark_interval]
[-t threads]
Runs on:
Neutrino
Options:
-f config_file Specify the pathname of an alternate configuration file (the
default is /etc/syslog.conf).
-m mark_interval Select the number of minutes between “mark” messages (the

default is 20 minutes).
-t threads Set the maximum number of threads that syslogd should use
(the default is 15).
Description:
The syslogd daemon reads and logs messages to the system console, log files, and
other machines as specified by its configuration file.
The daemon reads its configuration file when it starts up and whenever it receives a
hangup signal. For information on the format of the configuration file, see
/etc/syslog.conf.
The messages sent to syslogd should consist of a single line, which may start with a
facility/priority (as defined in <syslog.h>) in angle brackets (e.g. "<5> hello"). If
the message doesn’t specify a priority, it defaults to LOG_USER|LOG_NOTICE
("<13>").
The syslog() API (and the logger utility, which uses syslog()) sends messages to
syslogd by opening and writing to /dev/log.
If a log message is submitted to /dev/log, the entry includes the string nto instead
of the local host name. If the log message is submitted via the socket interface, the
entry includes the host name. If the message is redirected from another syslogd on
another host, the entry includes the host name.
Files:
The syslogd daemon requires the following files:

syslogd © 2010, QNX Software Systems GmbH & Co. KG.
/etc/syslog.conf
This configuration file contains the selection criteria and the
action to be taken if a message received by syslogd matches the
selection criteria.
/etc/services This file specifies the Internet domain socket port that syslogd
listens to.
The syslogd daemon also requires the libsocket.so shared library.
SYSLOG Used by clients to specify which node to look for syslogd.
See also:
logger, /etc/services, /etc/syslog.conf

© 2010, QNX Software Systems GmbH & Co. KG. tail
Copy the last part of files (POSIX)
Syntax:
tail [-number] [-fl] [-c number | -n number] [file]...
Runs on:
Options:
-number Deprecated; use -n number instead.
-c number Copy the given number of bytes; see below.
-f If the input file is a regular file (i.e. not a tty or FIFO), don’t terminate
after the last line of the input file has been copied, but enter a
continuous loop. The tail utility then sleeps for approximately one
second, then attempts to read and copy further bytes from the input file.
-l (“el”) Measure the quantity of output in lines; this is the default unit of
measure. Deprecated; use -n number instead.
-n number Copy the given number of lines; see below.
file The pathname of an input file. If you don’t specify a file, the standard
input is used.
Description:
The tail utility copies its input files to the standard output, beginning at the point in
the files indicated by the -c or -n option. For both options, the number argument is a
decimal integer whose sign specifies the location in the file to begin copying:
If the sign is: Then copying starts relative to the:

+ Beginning of the file
- End of the file
Omitted End of the file
If you don’t specify a -c or -n option, the default is -n 10 (i.e. the last ten lines of
the file).

tail © 2010, QNX Software Systems GmbH & Co. KG.
If you use both -c and the deprecated -l option, the order of the options is important.
If you specify:
tail -l -c 5 my_file
then tail copies 5 bytes. If you specify:
tail -c 5 -l my_file
it copies 5 lines.
When tail is applied to a nonseekable file (e.g. a tty), tail must maintain an
internal buffer. This buffer is large enough to hold at least 10 lines of characters.
Examples:
You can use the -f option to monitor the growth of a file that is being written by a
process. For example, the command:
tail -f fred
prints the last ten lines of the file fred, followed by any lines that are appended to
fred between the time tail is initiated and terminated. As another example, the
command:
tail -f -c 15 fred
prints the last 15 bytes of the file fred, followed by any lines that are appended to
fred between the time tail is initiated and terminated.
Exit status:
See also:
cat, head, less, more

© 2010, QNX Software Systems GmbH & Co. KG. tar
Read and write tape archive files (UNIX)
Syntax:
Create a new archive:
tar -c [-b blksize] [-f file] [-vw] [filename...]
Write named files to the end of an archive:
tar -r -f file [-b blksize] [-vw] [filename...]
List all the files contained in an archive:
tar -t [-f file] [-v] [filename]
Extract named files from an archive:
tar -x [-f file] [-lmovw] [filename...]
Runs on:
Options:
-[0-7][lmh] Specify the drive and density.
-A Append tar files to an archive.
-B Reblock as we read (for 4.2BSD pipes).
-b blksize Specify the blocking factor for tape records. The default is 1; the
maximum is 20. This option should be used only with raw
magnetic tape archives. Normally, the block size is determined
automatically when reading tapes.
-C=dir Change to the directory dir.
-c Create a new archive. Writing begins at the beginning of the

archive, instead of after the last file.
-d Find the differences between the archive and the filesystem.
-F=file Run the given script at the end of each tape (implies -M).
-f file Specify the name of the archive to use instead of the default, which
is standard output. If you specify the dash character (-) as a
filename, tar writes to the standard output or reads from the
standard input, whichever is appropriate for the options given.
Thus, you can use tar as the head or tail of a pipeline.
-G Handle the old GNU-format incremental backup.

tar © 2010, QNX Software Systems GmbH & Co. KG.
-g Handle the new GNU-format incremental backup.
-h Dump instead the files that symlinks point to.
-i Ignore zeroed blocks in archive (means EOF).
-K=name Begin at file name in the archive.
-k Don’t overwrite existing files when extracting.
-L num Change tape after writing num × 1024 bytes.
-l (“el”) Report if all of the links to the files being archived cannot be
resolved. If this option isn’t specified, no error messages are
written to the standard output. This option is valid only with the
-c and -r options.
-M Create, list, or extract a multivolume archive.
-m Don’t restore modification times. The modification time of the file

is the time of extraction. This option is invalid with the -t option.
-N=date Store only the files that are newer than date.
-O (“Oh”) Extract files to standard output.
-o Write a V7 format archive.
-P Don’t strip leading slashes (/) from filenames.
-p Extract all protection information.
-R Show the block number within the archive with each message.
-r Write named files to the end of the archive specified in the required
-f file option.
-S Handle sparse files efficiently.
-s Sort the names to extract to match archive.
-T=name Get the names to extract or create from the file, name.
-t List the names of all of the files in the archive.
-U Unlink each file prior to extracting over it.
-u Append only files that are newer than the copy in the archive.
-V=name Create an archive with the volume name specified by name.
-v Be verbose. Usually, tar works silently, but the -v option causes

it to print the name of each file it processes, preceded by the option
letter. With the -t option, -v gives more information about the
archive entries than just the name.

© 2010, QNX Software Systems GmbH & Co. KG. tar
-W Attempt to verify the archive after writing it.

-w Print the action to be taken, followed by the name of the file, then
wait for the user’s confirmation. If you enter a word beginning
with y, the action is performed. Any other input means “no”. This
option is invalid with the -t option.
-X=file Exclude the globbing patterns listed in file.
-x Extract named files from the archive. If a named file matches a
directory whose contents had been written onto the archive, that
directory is recursively extracted. If a named file in the archive
doesn’t exist on the system, the file is created with the same mode
as the one in the archive, except that the set-user-id and
set-group-id modes are set only if you have appropriate privileges.
If the files exist, their modes are not changed except as described
above. The owner, group, and modification time are restored if
possible. If no filename argument is given, the entire contents of
the archive is extracted. Note that if several files with the same
name are in the archive, the last one overwrites all earlier ones.
-Z Filter the archive through compress.
-z Filter the archive through gzip.
filename The pathname of the file to be archived.
Description:
The tar utility reads and writes archive files. For more information, see the GNU
The GNU tar is incompatible with the current POSIX standard and with tar
programs that follow POSIX. For details, see the GNU documentation.
Examples:
Display a verbose listing of the archive members in dist.tar:
tar -tvf dist.tar
Copy the contents of the current directory to the floppy drive:
tar -cf /dev/fd0 .
Make an archive, backup.tar, of all the C source and header files in the current
directory:
tar -cvf backup.tar *.[ch]

tar © 2010, QNX Software Systems GmbH & Co. KG.
Files:
The controlling terminal (/dev/tty) is used to prompt the user for information when
either or both the -i or -y options are specified.
GNU
See also:
bzip2, cpio, gzip, pax

© 2010, QNX Software Systems GmbH & Co. KG. tcpdump
Dump traffic on a network
Syntax:
tcpdump [-AdDefKlLnNOpqRStuUvxX] [-c count] [-C file_size]
[-E spi@ipaddr algo:secret,...] [-F file] [-G rotate_seconds]
[-i interface] [-m module] [-M secret] [-r file]
[-s snaplen] [-T type] [-w file]
[-W filecount] [-y datalinktype] [-z postrotate-command]
[-Z user] [expression]
Runs on:
Neutrino
Options:
-A Print each packet (minus its link level header) in ASCII. Handy
for capturing web pages.
-c count Exit after receiving count packets.
-C file_size Before writing a raw packet to a savefile, check whether the file
is currently larger than file_size and, if so, close the current
savefile and open a new one. Savefiles after the first savefile
will have the name specified with the -w option, with a number
after it, starting at 1 and continuing upward. The units of
file_size are millions of bytes (1,000,000 bytes, not 1,048,576
bytes).
-d Dump the compiled packet-matching code in a human readable

form to standard output and stop.
-dd Dump packet-matching code as a C program fragment.
-ddd Dump packet-matching code as decimal numbers (preceded

with a count).
-D Print the list of the network interfaces available on the system

and on which tcpdump can capture packets. For each network
interface, a number and an interface name, possibly followed
by a text description of the interface, is printed. You can supply
the interface name or the number to the -i option to specify an
interface on which to capture.
This can be useful on systems that don’t have a command to
list them (e.g. Windows systems, or UNIX systems lacking
ifconfig -a); the number can be useful on Windows 2000
and later systems, where the interface name is a somewhat
complex string.
-e Print the link-level header on each dump line.

tcpdump © 2010, QNX Software Systems GmbH & Co. KG.
-E spi@ipaddr algo:secret,...
Use spi@ipaddr algo:secret for decrypting IPsec ESP packets
that are addressed to addr and contain Security Parameter
Index value spi. You can specify additional combinations,
separating them with commas or newlines.
Setting the secret for IPv4 ESP packets isn’t currently supported.
The algorithm can be des-cbc, 3des-cbc, blowfish-cbc,

rc3-cbc, cast128-cbc, or none. The default is des-cbc.
The secret is the ASCII text for the ESP secret key. If preceded
by 0x, then a hexadecimal value is read.
The option assumes RFC 2406 ESP, not RFC 1827 ESP. The
option is only for debugging purposes, and the use of this
option with a true “secret” key is discouraged. By presenting
the IPsec secret key onto command line, you make it visible to
others, via ps and on other occasions.
In addition to the above syntax, you can use the syntax
file_name to have tcpdump read the provided file. The file is
opened on receiving the first ESP packet, so any special
permissions that tcpdump may have been given should already
have been given up.
-f Print “foreign” IPv4 addresses numerically rather than

symbolically.
The test for “foreign” IPv4 addresses is done using the IPv4
address and netmask of the interface on which capture is being
done. If that address or netmask isn’t available, either because
the interface on which capture is being done has no address or
netmask, or because the capture is being done on the Linux
“any” interface, which can capture on more than one interface,
this option won’t work correctly.
-F file Use file as input for the filter expression. Any additional
expression given on the command line is ignored.
-G rotate_seconds If specified, rotates the dump file specified with the -w option
every rotate_seconds seconds. Savefiles have the name
specified by -w, which should include a time format as defined
by strftime(). If no time format is specified, each new file
overwrites the previous.
If used in conjunction with the -C option, file names take the
form file<count>.
-i interface Listen on interface. If unspecified, tcpdump searches the

system interface list for the lowest numbered, configured up

interface (excluding loopback). Ties are broken by choosing

the earliest match.
On Linux systems with 2.2 or later kernels, you can use an
interface argument of any to capture packets from all
interfaces. Note that captures on the any device aren’t done in
promiscuous mode.
You can use an interface number as printed by that option as
the interface argument.
-K Don’t attempt to verify TCP checksums. This is useful for
interfaces that perform the TCP checksum calculation in
hardware; otherwise, all outgoing TCP checksums are flagged
as bad.
-l (“el”) Make stdout line buffered. This is useful if you want to
see the data while capturing it. For example, tcpdump -l |
tee dat or tcpdump -l > dat & tail -f dat.
-L List the known data link types for the interface, and then exit.
-m module Load SMI MIB module definitions from file module. You can
use this option several times to load several MIB modules into
tcpdump.
-M secret Use secret as a shared secret for validating the digests found in
TCP segments with the TCP-MD5 option (RFC 2385), if
present.
-n Don’t convert addresses (i.e., host addresses, port numbers,
etc.) into names.
-N Don’t print domain name qualification of host names. For
example, if you give this option, tcpdump prints nic instead
of nic.ddn.mil.
-O (“Oh”) Don’t run the packet-matching code optimizer. This is
useful only if you suspect a bug in the optimizer.
-p Don’t put the interface into promiscuous mode. Note that the
interface might be in promiscuous mode for some other reason;
hence, you can’t use -p as an abbreviation for ether host
{local-hw-addr} or ether broadcast.
-q Be quiet; print less protocol information, so that output lines

are shorter.
-R Assume ESP/AH packets to be based on old specification
(RFC 1825 to RFC 1829). If specified, tcpdump doesn’t print
the replay prevention field. Since there is no protocol version
field in ESP/AH specification, tcpdump can’t deduce the
version of ESP/AH protocol.

-r file Read packets from file (which was created with the -w option).
If file is -, tcpdump uses standard input.
-S Print absolute, rather than relative, TCP sequence numbers.
-s snaplen Snarf snaplen bytes of data from each packet rather than the
default of 68 (with SunOS’s NIT, the minimum is actually 96).
68 bytes is adequate for IP, ICMP, TCP and UDP, but may
truncate protocol information from name server and NFS
packets (see below).
Packets truncated because of a limited snapshot are indicated
in the output with [|proto], where proto is the name of the
protocol level at which the truncation has occurred.
Taking larger snapshots both increases the amount of time it takes to process packets
and, effectively, decreases the amount of packet buffering. This may cause packets to
be lost. You should limit snaplen to the smallest number that will capture the protocol
information you’re interested in. If you set snaplen to 0, tcpdump uses the required
length to catch whole packets.
-T type Force packets selected by expression to be interpreted as the

specified type. Currently known types are:
• aodv — ad hoc On-demand Distance Vector protocol
• cnfp — Cisco NetFlow protocol
• rpc — Remote Procedure Call
• rtp — Real-Time Applications protocol
• rtcp — Real-Time Applications control protocol
• snmp — Simple Network Management Protocol
• tftp — Trivial File Transfer Protocol
• vat — Visual Audio Tool
• wb — distributed White Board
-t Don’t print a timestamp on each dump line.
-tt Print an unformatted timestamp on each dump line.
-ttt Print a delta (micro-second resolution) between current and

previous line on each dump line.
-tttt Print a timestamp in default format proceeded by date on each

dump line.
-ttttt Print a delta (micro-second resolution) between current and

first line on each dump line.
-u Print undecoded NFS handles.

-U Make output saved via the -w option packet-buffered; i.e. as

each packet is saved, write it to the output file, rather than
writing it only when the output buffer fills.
-v When parsing and printing, produce (slightly more) verbose

output. For example, the time to live, identification, total length
and options in an IP packet are printed. This option also
enables additional packet integrity checks, such as verifying
the IP and ICMP header checksum.
When writing to a file with the -w option, report, every 10
seconds, the number of packets captured.
-vv Even more verbose output. For example, additional fields are
printed from NFS reply packets, and SMB packets are fully
decoded.
-vvv Even more verbose output. For example, telnet SB ... SE

options are printed in full. With -X, telnet options are printed
in hexadecimal as well.
-w file Write the raw packets to file rather than parsing and printing
them. You can print them with the -r option. If file is -,
tcpdump uses standard output.
-W filecount Used in conjunction with the -C option, limit the number of

files created to the specified number, and begin overwriting
files from the beginning, thus creating a “rotating” buffer. In
addition, it names the files with enough leading zeroes to
support the maximum number of files, allowing you to sort
them correctly.
Used in conjunction with the -G option, this option limits the
number of rotated dump files that get created, exiting with a
status of 0 when tcpdump reaches the limit. If you use it with
-C as well, tcpdump uses cyclical files per timeslice.
-x When parsing and printing, in addition to printing the headers

of each packet, print the data of each packet (minus its
link-level header) in hexadecimal. The smaller of the entire
packet or snaplen bytes is printed. Note that this is the entire
link-layer packet, so for link layers that pad (e.g. Ethernet), the
padding bytes are also printed when the higher layer packet is
shorter than the required padding.
-xx When parsing and printing, in addition to printing the headers

of each packet, print the data of each packet, including its
link-level header, in hexadecimal.
-X When parsing and printing, in addition to printing the headers

of each packet, print the data of each packet (minus its

link-level header) in hexadecimal and ASCII. This is very

handy for analyzing new protocols.
-XX When parsing and printing, in addition to printing the headers
of each packet, print the data of each packet, including its
link-level header, in hexadecimal and ASCII.
-y datalinktype Set the data link type to use while capturing packets to
datalinktype.
-z postrotate-command
Used in conjunction with the -C or -G options, this makes
tcpdump run postrotate-command file, where file is the
savefile being closed after each rotation. For example,
specifying -z gzip or -z bzip2 compresses each savefile
using gzip or bzip2.
The tcpdump utility runs the command in parallel with the capture, using the lowest
priority so that this doesn’t disturb the capture process.
If you want to use a command that itself takes options or
different arguments, write a shell script that takes the savefile
name as the only argument, arrange the options and arguments
as required, and then execute the command that you want.
-Z user Drop privileges (if root) and change the user ID to user and
the group ID to the primary group of user. You can also enable
this behavior by default at compile time.
Description:
The tcpdump utility prints a description of the contents of packets on a network
interface that match the boolean expression. You can also run it with the -w option,
which causes it to save the packet data to a file for later analysis, and/or with the -r
option, which causes it to read from a saved packet file rather than to read packets
from a network interface. In all cases, tcpdump processes only those packets that
match expression.
For information about the expression argument, see “Expressions,” below.
The tcpdump utility, if not run with the -c option, continues capturing packets until
it’s interrupted by a SIGINT signal (generated, for example, by typing your interrupt
character, typically Control-C) or a SIGTERM signal (typically generated with the
kill command); if run with the -c option, tcpdump captures packets until it’s
interrupted by a SIGINT or SIGTERM signal, or the specified number of packets have
been processed.
When tcpdump finishes capturing packets, it reports counts of:
• packets “captured” — the number of packets that tcpdump has received and
processed.

• packets “received by filter” — the number of packets handed to the filter, not
packets that passed the filter. This includes packets later dropped because there
wasn’t enough buffer space.
• packets “dropped by kernel” — the number of packets that were dropped, due to a
lack of buffer space, by the packet-capture mechanism.
Reading packets from a network interface may require that you have special privileges:
Under SunOS 3.x or 4.x with NIT or BPF:

You must have read access to /dev/nit or /dev/bpf*.
Under Solaris with DLPI:
You must have read/write access to the network pseudo device, e.g.
/dev/le. On at least some versions of Solaris, however, this isn’t
sufficient to allow tcpdump to capture in promiscuous mode; on
those versions of Solaris, you must be root, or tcpdump must be
installed as setuid to root, in order to capture in promiscuous
mode. Note that, on many (perhaps all) interfaces, if you don’t
capture in promiscuous mode, you won’t see any outgoing packets,
so a capture not done in promiscuous mode may not be very useful.
Under HP-UX with DLPI:

You must be root, or tcpdump must be installed as setuid to
root.
Under IRIX with snoop:
You must be root, or tcpdump must be installed as setuid to
root.
Under Linux: You must be root, or tcpdump must be installed as setuid to

root (unless your distribution has a kernel that supports capability
bits such as CAP_NET_RAW, and code to allow those capability bits
to be given to particular accounts and to cause those bits to be set on
a user’s initial processes when they log in, in which case you must
have CAP_NET_RAW in order to capture, and CAP_NET_ADMIN to
enumerate network devices with, for example, the -D option).
Under ULTRIX and Digital UNIX/Tru64 UNIX:

Any user may capture network traffic with tcpdump. However, no
user (not even the superuser) can capture in promiscuous mode on
an interface unless the superuser has enabled promiscuous-mode
operation on that interface using pfconfig, and no user (not even
the superuser) can capture unicast traffic received by or sent by the
machine on an interface unless the superuser has enabled
copy-all-mode operation on that interface using pfconfig, so
useful packet capture on an interface probably requires that either

promiscuous-mode or copy-all-mode operation, or both modes of

operation, be enabled on that interface.
Under BSD (this includes Mac OS X):
You must have read access to /dev/bpf* on systems that don’t
have a cloning BPF device, or to /dev/bpf on systems that do. On
BSDs with a devfs (this includes Mac OS X), this might involve
more than just having somebody with superuser access setting the
ownership or permissions on the BPF devices; it might involve
configuring devfs to set the ownership or permissions every time the
system is booted, if the system even supports that; if it doesn’t
support that, you might have to find some other way to make that
happen at boot time.
Reading a saved packet file doesn’t require special privileges.
Expressions
The expression on the command line selects which packets to dump. If no expression
is given, all packets on the net will be dumped. Otherwise, only packets for which
expression is true are dumped.
The expression consists of one or more primitives that usually consist of an ID (name
or number) preceded by one or more qualifiers. The different kinds of qualifier are:
type The kind of thing the ID name or number refers to. Possible types are host,
net, port, and portrange. For example, host xyz, net 128.3, port
20, and portrange 6000-6008. If there’s no type qualifier, tcpdump
uses host.
dir A particular transfer direction to and/or from the ID. Possible directions are
src, dst, src or dst, and src and dst. For example, src xyz, dst
net 128.3, src or dst port ftp-data. If there is no dir qualifier,
src or dst is assumed.
For some link layers, such as SLIP and the “cooked” Linux capture mode
used for the any device and for some other device types, you can use the
inbound and outbound qualifiers to specify a desired direction.
proto Restrict the match to a particular protocol. Possible protocols are ether,
fddi, tr, wlan, ip, ip6, arp, rarp, decnet, tcp, and udp. For example,
ether src xyz, arp net 128.3, tcp port 21, and udp portrange
7000-7009.
If there’s no proto qualifier, all protocols consistent with the type are
assumed. For example, src xyz means (ip or arp or rarp) src
xyz (except the latter isn’t legal syntax), net abc means (ip or arp or
rarp) net abc, and port 53 means (tcp or udp) port 53.
The fddi protocol is actually an alias for ether; the parser treats them
identically as meaning “the data link level used on the specified network

interface.” FDDI headers contain Ethernet-like source and destination

addresses, and often contain Ethernet-like packet types, so you can filter on
these FDDI fields just as with the analogous Ethernet fields. FDDI headers
also contain other fields, but you can’t name them explicitly in a filter
expression.
Similarly, tr and wlan are aliases for ether; the previous paragraph’s
statements about FDDI headers also apply to Token Ring and 802.11
wireless LAN headers. For 802.11 headers, the destination address is the
DA field and the source address is the SA field; the BSSID, RA, and TA
fields aren’t tested.
In addition to the above, there are some special “primitive” keywords that don’t follow
the pattern:
• gateway
• broadcast
• less
• greater
and arithmetic expressions. All of these are described below.

You can build more complex filter expressions by using the words and, or, and not to
combine primitives. For example, host xyz and not port ftp and not port
ftp-data. To save typing, you can omit identical qualifier lists. For example, tcp
dst port ftp or ftp-data or domain is exactly the same as tcp dst port
ftp or tcp dst port ftp-data or tcp dst port domain.
Allowable primitives are:
dst host host True if the IPv4/v6 destination field of the packet is host,
which may be either an address or a name.
src host host True if the IPv4/v6 source field of the packet is host.
host host True if either the IPv4/v6 source or destination of the packet is
host.
You can prepend any of the above host expressions with the
keywords ip, arp, rarp, or ip6 as in:
ip host host
which is equivalent to:

ether proto \ip and host host
If host is a name with multiple IP addresses, each address is

checked for a match.

ether dst ehost True if the Ethernet destination address is ehost. The ehost
may be either a name from /etc/ethers or a number (see
ethers(3N) for numeric format).
ether src ehost True if the Ethernet source address is ehost.
ether host ehost True if either the Ethernet source or destination address is
ehost.
gateway host True if the packet used host as a gateway. That is, the Ethernet
source or destination address was host, but neither the IP
source nor the IP destination was host. The host must be a
name and must be found both by the machine’s
host-name-to-IP-address resolution mechanisms (host name
file, DNS, NIS, etc.) and by the machine’s
host-name-to-Ethernet-address resolution mechanism
(/etc/ethers, etc.). (An equivalent expression is:
ether host ehost and not host host
which can be used with either names or numbers for host /

ehost.) This syntax doesn’t work in IPv6-enabled
configuration at this moment.
dst net net True if the IPv4/v6 destination address of the packet has a
network number of net. The net may be either a name from the
networks database (/etc/networks, etc.) or a network number.
An IPv4 network number can be written as a dotted quad (e.g.,
192.168.1.0), dotted triple (e.g., 192.168.1), dotted pair
(e.g, 172.16), or single number (e.g., 10); the netmask is
255.255.255.255 for a dotted quad (which means that it’s
really a host match), 255.255.255.0 for a dotted triple,
255.255.0.0 for a dotted pair, or 255.0.0.0 for a single
number.
An IPv6 network number must be written out fully; the
netmask is ff:ff:ff:ff:ff:ff:ff:ff, so IPv6 “network”
matches are really always host matches, and a network match
requires a netmask length.
src net net True if the IPv4/v6 source address of the packet has a network
number of net.
net net True if either the IPv4/v6 source or destination address of the
packet has a network number of net.
net net mask netmask

True if the IPv4 address matches net with the specific netmask.
May be qualified with src or dst. Note that this syntax isn’t
valid for IPv6 net.

net net/len True if the IPv4/v6 address matches net with a netmask len bits
wide. May be qualified with src or dst.
dst port port True if the packet is ip/tcp, ip/udp, ip6/tcp, or ip6/udp, and has
a destination port value of port. The port can be a number or a
name used in /etc/services. (see tcp(4P) and udp(4P)).
If you use a name, both the port number and protocol are
checked. If you use a number or ambiguous name, only the
port number is checked (e.g., dst port 513 will print both
tcp/login traffic and udp/who traffic, and port domain will
print both tcp/domain and udp/domain traffic).
src port port True if the packet has a source port value of port.
port port True if either the source or destination port of the packet is
port.
dst portrange port1-port2
True if the packet is ip/tcp, ip/udp, ip6/tcp or ip6/udp and has a
destination port value between port1 and port2. The port1 and
port2 are interpreted in the same fashion as the port parameter
for port.
src portrange port1-port2
True if the packet has a source port value between port1 and
port2.
portrange port1-port2
True if either the source or destination port of the packet is
between port1 and port2.
You can prepend any of the above port or port range
expressions with the keywords tcp or udp, as in:
tcp src port port
which matches only tcp packets whose source port is port.
less length True if the packet has a length less than or equal to length.
This is equivalent to:
len <= length.
greater length True if the packet has a length greater than or equal to length.
This is equivalent to:
len >= length.

ip proto protocol True if the packet is an IPv4 packet (see ip(4P)) of protocol
type protocol. The protocol can be a number, or one of the
names icmp, icmp6, igmp, igrp, pim, ah, esp, vrrp, udp,
or tcp.
The identifiers tcp, udp, and icmp are also keywords and must be escaped via
backslash (\), which is \\ in the C shell. This primitive doesn’t chase the protocol
header chain.
ip6 proto protocol True if the packet is an IPv6 packet of protocol type protocol.
Note that this primitive doesn’t chase the protocol header
chain.
ip6 protochain protocol
True if the packet is IPv6 packet, and contains a protocol
header with the type protocol in its protocol header chain. For
example
ip6 protochain 6
matches any IPv6 packet with TCP protocol header in the

protocol header chain. The packet may contain, for example,
authentication header, routing header, or hop-by-hop option
header, between IPv6 header and TCP header. The BPF code
emitted by this primitive is complex and can’t be optimized by
BPF optimizer code in tcpdump, so this can be somewhat
slow.
ip protochain protocol
Equivalent to ip6 protochain protocol, but this is for IPv4.
ether broadcast True if the packet is an Ethernet broadcast packet. The ether
keyword is optional.
ip broadcast True if the packet is an IPv4 broadcast packet. It checks for

both the all-zeroes and all-ones broadcast conventions, and
looks up the subnet mask on the interface on which the capture
is being done.
If the subnet mask of the interface on which the capture is
being done isn’t available, either because the interface on
which capture is being done has no netmask or because the
capture is being done on the Linux “any” interface, which can
capture on more than one interface, this check doesn’t work
correctly.
ether multicast True if the packet is an Ethernet multicast packet. The ether
keyword is optional. This is shorthand for ether[0] & 1 !=
0.

ip multicast True if the packet is an IPv4 multicast packet.

ip6 multicast True if the packet is an IPv6 multicast packet.
ether proto protocol

True if the packet is of ether type protocol. The protocol can
be a number, or one of the names ip, ip6, arp, rarp, atalk,
aarp, decnet, sca, lat, mopdl, moprc, iso, stp, ipx, or
netbeui. Note these identifiers are also keywords and must
be escaped via backslash (\).
In the case of FDDI (e.g. fddi protocol arp), Token Ring
(e.g. tr protocol arp), and IEEE 802.11 wireless LANs
(e.g. wlan protocol arp), for most of those protocols, the
protocol identification comes from the 802.2 Logical Link
Control (LLC) header, which is usually layered on top of the
FDDI, Token Ring, or 802.11 header.
When filtering for most protocol identifiers on FDDI, Token
Ring, or 802.11, tcpdump checks only the protocol ID field of
an LLC header in so-called SNAP format with an
Organizational Unit Identifier (OUI) of 0x000000, for
encapsulated Ethernet; it doesn’t check whether the packet is in
SNAP format with an OUI of 0x000000. The exceptions are:
• iso — tcpdump checks the DSAP (Destination Service
Access Point) and SSAP (Source Service Access Point)
fields of the LLC header
• stp and netbeui — tcpdump checks the DSAP of the
LLC header
• atalk — tcpdump checks for a SNAP-format packet with
an OUI of 0x080007 and the AppleTalk etype.
In the case of Ethernet, tcpdump checks the Ethernet type
field for most of those protocols. The exceptions are:
• iso, stp, and netbeui — tcpdump checks for an 802.3
frame, and then checks the LLC header as it does for FDDI,
Token Ring, and 802.11
• atalk — tcpdump checks both for the AppleTalk etype in
an Ethernet frame and for a SNAP-format packet as it does
for FDDI, Token Ring, and 802.11
• aarp — tcpdump checks for the AppleTalk ARP etype in
either an Ethernet frame or an 802.2 SNAP frame with an
OUI of 0x000000
• ipx — tcpdump checks for the IPX etype in an Ethernet
frame, the IPX DSAP in the LLC header, the
802.3-with-no-LLC-header encapsulation of IPX, and the
IPX etype in a SNAP frame.

decnet src host True if the DECNET source address is host, which is in the
form 10.123.
decnet dst host True if the DECNET destination address is host.
decnet host host True if either the DECNET source or destination address is
host.
ifname interface True if the packet was logged as coming from the specified
interface (applies only to packets logged by OpenBSD’s pf).
on interface Synonymous with the ifname modifier.
rnr num True if the packet was logged as matching the specified PF rule
number (applies only to packets logged by OpenBSD’s pf).
rulenum num Synonymous with the rnr modifier.
reason code True if the packet was logged with the specified PF reason
code. The known codes are: match, bad-offset,
fragment, short, normalize, and memory (applies only to
packets logged by OpenBSD’s pf).
rset name True if the packet was logged as matching the specified PF
ruleset name of an anchored ruleset (applies only to packets
logged by pf).
ruleset name Synonymous with the rset modifier.
srnr num True if the packet was logged as matching the specified PF rule
number of an anchored ruleset (applies only to packets logged
by pf).
subrulenum num Synonymous with the srnr modifier.
action act True if PF took the specified action when the packet was
logged. Known actions are pass and block (applies only to
packets logged by OpenBSD’s pf).
ip, ip6, arp, rarp, atalk, aarp, decnet, iso, stp, ipx, netbeui
Abbreviations for:
ether proto p
where p is one of the above protocols.
lat, moprc, mopdl Abbreviations for:

ether proto p
where p is one of the above protocols. Note that tcpdump

doesn’t currently know how to parse these protocols.

type wlan_type True if the IEEE 802.11 frame type matches the specified
wlan_type. Valid wlan_types are: mgt, ctl, and data.
type wlan_type subtype wlan_subtype
True if the IEEE 802.11 frame type matches the specified
wlan_type, and frame subtype matches the specified
wlan_subtype.
If the specified wlan_type is mgt, then valid wlan_subtypes
are assoc-req, assoc-resp, reassoc-req,
reassoc-resp, probe-req, probe-resp, beacon, atim,
disassoc, auth, and deauth.
If the specified wlan_type is ctl, then valid wlan_subtypes
are ps-poll, rts, cts, ack, cf-end, and cf-end-ack.
If the specified wlan_type is data, then valid wlan_subtypes
are data, data-cf-ack, data-cf-poll,
data-cf-ack-poll, null, cf-ack, cf-poll,
cf-ack-poll, qos-data, qos-data-cf-ack,
qos-data-cf-poll, qos-data-cf-ack-poll, qos,
qos-cf-poll, and qos-cf-ack-poll.
subtype wlan_subtype
True if the IEEE 802.11 frame subtype matches the specified
wlan_subtype, and frame has the type to which the specified
wlan_subtype belongs.
vlan [vlan_id] True if the packet is an IEEE 802.1Q VLAN packet. If

[vlan_id] is specified, this is true only if the packet has the
specified vlan_id.
The first vlan keyword encountered in expression changes the decoding offsets for
the remainder of expression on the assumption that the packet is a VLAN packet. You
can use the vlan[vlan_id] expression more than once, to filter on VLAN hierarchies.
Each use of that expression increments the filter offsets by 4.
For example:
vlan 100 && vlan 200
filters on VLAN 200 encapsulated within VLAN 100, and:

vlan && vlan 300 && ip
filters IPv4 protocols encapsulated in VLAN 300 encapsulated

within any higher order VLAN.
mpls [label_num] True if the packet is an MPLS packet. If [label_num] is

specified, this is true only if the packet has the specified
label_num.

The first mpls keyword encountered in expression changes the decoding offsets for
the remainder of expression on the assumption that the packet is a MPLS-encapsulated
IP packet. You can use the mpls [label_num] expression more than once, to filter on
MPLS hierarchies. Each use of that expression increments the filter offsets by 4.
For example:
mpls 100000 && mpls 1024
filters packets with an outer label of 100000 and an inner label

of 1024, and:
mpls && mpls 1024 && host 192.9.200.1
filters packets to or from 192.9.200.1 with an inner label of

1024 and any outer label.
pppoed True if the packet is a PPP-over-Ethernet Discovery packet

(Ethernet type 0x8863).
pppoes True if the packet is a PPP-over-Ethernet Session packet

(Ethernet type 0x8864).
The first pppoes keyword encountered in expression changes the decoding offsets for
the remainder of expression on the assumption that the packet is a PPPoE session
packet.
For example:
pppoes && ip
filters IPv4 protocols encapsulated in PPPoE.
tcp, udp, icmp Abbreviations for:

ip proto p or ip6 proto p
iso proto protocol True if the packet is an OSI packet of protocol type protocol.
The Protocol can be a number, or one of the names clnp,
esis, or isis.
clnp, esis, isis Abbreviations for:

iso proto p

l1, l2, iih, lsp, snp, csnp, psnp
Abbreviations for IS-IS PDU types.

vpi n True if the packet is an ATM packet, for SunATM on Solaris,

with a virtual path identifier of n.
vci n True if the packet is an ATM packet, for SunATM on Solaris,

with a virtual channel identifier of n.
lane True if the packet is an ATM packet, for SunATM on Solaris,

and is an ATM LANE packet.
The first lane keyword encountered in expression changes the tests done in the
remainder of expression on the assumption that the packet is either a LANE emulated
Ethernet packet or a LANE LE Control packet. If lane isn’t specified, the tests are
done under the assumption that the packet is an LLC-encapsulated packet.
llc True if the packet is an ATM packet, for SunATM on Solaris,

and is an LLC-encapsulated packet.
oamf4s True if the packet is an ATM packet, for SunATM on Solaris,

and is a segment OAM F4 flow cell (VPI=0 & VCI=3).
oamf4e True if the packet is an ATM packet, for SunATM on Solaris,

and is an end-to-end OAM F4 flow cell (VPI=0 & VCI=4).
oamf4 True if the packet is an ATM packet, for SunATM on Solaris,

and is a segment or end-to-end OAM F4 flow cell (VPI=0 &
(VCI=3 | VCI=4)).
oam True if the packet is an ATM packet, for SunATM on Solaris,

and is a segment or end-to-end OAM F4 flow cell (VPI=0 &
(VCI=3 | VCI=4)).
metac True if the packet is an ATM packet, for SunATM on Solaris,

and is on a meta signaling circuit (VPI=0 & VCI=1).
bcc True if the packet is an ATM packet, for SunATM on Solaris,

and is on a broadcast signaling circuit (VPI=0 & VCI=2).
sc True if the packet is an ATM packet, for SunATM on Solaris,

and is on a signaling circuit (VPI=0 & VCI=5).
ilmic True if the packet is an ATM packet, for SunATM on Solaris,

and is on an ILMI circuit (VPI=0 & VCI=16).
connectmsg True if the packet is an ATM packet, for SunATM on Solaris,

and is on a signaling circuit and is a Q.2931 Setup, Call
Proceeding, Connect, Connect Ack, Release, or Release Done
message.
metaconnect True if the packet is an ATM packet, for SunATM on Solaris,

and is on a meta signaling circuit and is a Q.2931 Setup, Call
Proceeding, Connect, Release, or Release Done message.

expr relop expr True if the relation holds, where relop is one of >, <, >=, <=, =,
or !=, and expr is an arithmetic expression composed of
integer constants (expressed in standard C syntax), the normal
binary operators (+, -, *, /, &, |, <<, >>), a length operator,
and special packet data accessors. Note that all comparisons
are unsigned, so that, for example, 0x80000000 and
0xffffffff are greater than 0. To access data inside the
packet, use the following syntax:
proto [expr : size ]
where proto is one of ether, fddi, tr, wlan, ppp, slip,
link, ip, arp, rarp, tcp, udp, icmp, ip6, or radio, and
indicates the protocol layer for the index operation (ether,
fddi, wlan, tr, ppp, slip, and link all refer to the link
layer; radio refers to the “radio header” added to some
802.11 captures).
The tcp, udp, and other upper-layer protocol types apply only to IPv4, not IPv6 (this
will be fixed in the future).
The byte offset, relative to the indicated protocol layer, is given
by expr. The size is optional and indicates the number of bytes
in the field of interest; it can be one, two, or four, and defaults
to one. The length operator, indicated by the keyword len,
gives the length of the packet.
For example, ether[0] & 1 != 0 catches all multicast
traffic. The expression ip[0] & 0xf != 5 catches all IPv4
packets with options. The expression ip[6:2] & 0x1fff =
0 catches only unfragmented IPv4 datagrams and frag zero of
fragmented IPv4 datagrams. This check is implicitly applied to
the tcp and udp index operations. For instance, tcp[0]
always means the first byte of the TCP header, and never
means the first byte of an intervening fragment.
Some offsets and field values may be expressed as names
rather than as numeric values. The following protocol header
field offsets are available: icmptype (ICMP type field),
icmpcode (ICMP code field), and tcpflags (TCP flags
field).
The following ICMP type field values are available:
icmp-echoreply, icmp-unreach, icmp-sourcequench,
icmp-redirect, icmp-echo, icmp-routeradvert,
icmp-routersolicit, icmp-timxceed,
icmp-paramprob, icmp-tstamp, icmp-tstampreply,
icmp-ireq, icmp-ireqreply, icmp-maskreq, and
icmp-maskreply.
The following TCP flags field values are available: tcp-fin,
tcp-syn, tcp-rst, tcp-push, tcp-ack, tcp-urg.

You can combine primitives by using:
• a parenthesized group of primitives and operators (parentheses are special to the

shell and must be escaped)
• negation: ! or not
• concatenation: && or and
• alternation: || or or
Negation has highest precedence. Alternation and concatenation have equal

precedence and associate from left to right. Note that explicit and tokens, not
juxtaposition, are now required for concatenation.
If an identifier is given without a keyword, the most recent keyword is assumed. For
example:
not host vs and ace
is short for:
not host vs and host ace
which shouldn’t be confused with:
not ( host vs or ace )
You can pass expression arguments to tcpdump as either a single argument or as

multiple arguments, whichever is more convenient. Generally, if the expression
contains shell metacharacters, it’s easier to pass it as a single, quoted argument.
Multiple arguments are concatenated with spaces before being parsed.
Output format
The output of tcpdump is protocol-dependent. The following gives a brief description
and examples of most of the formats.
Link-level headers
If you specify the -e option, the link-level header is printed out. On Ethernets, the
source and destination addresses, protocol, and packet length are printed.
On FDDI networks, the -e option causes tcpdump to print the frame-control field, the
source and destination addresses, and the packet length. The frame-control field
governs the interpretation of the rest of the packet. Normal packets (such as those
containing IP datagrams) are “async” packets, with a priority value between 0 and 7;
for example, async4. Such packets are assumed to contain an 802.2 Logical Link
Control (LLC) packet; the LLC header is printed if it is not an ISO datagram or a
so-called SNAP packet.
On Token Ring networks, the -e option causes tcpdump to print the access-control
and frame-control fields, the source and destination addresses, and the packet length.
As on FDDI networks, packets are assumed to contain an LLC packet. Regardless of

whether the -e option is specified or not, the source routing information is printed for
source-routed packets.
On 802.11 networks, the -e option causes tcpdump to print the frame-control fields,
all of the addresses in the 802.11 header, and the packet length. As on FDDI networks,
packets are assumed to contain an LLC packet.
The following description assumes familiarity with the SLIP compression algorithm
described in RFC 1144.
On SLIP links, a direction indicator (I for inbound, O for outbound), packet type, and
compression information are printed out. The packet type is printed first. The three
types are ip, utcp, and ctcp. No further link information is printed for ip packets.
For TCP packets, the connection identifier is printed following the type. If the packet
is compressed, its encoded header is printed out. The special cases are printed out as
*S+n and *SA+n, where n is the amount by which the sequence number (or sequence
number and ack) has changed. If it isn’t a special case, zero or more changes are
printed. A change is indicated by U (urgent pointer), W (window), A (ack), S
(sequence number), and I (packet ID), followed by a delta (+n or -n), or a new value
(=n). Finally, the amount of data in the packet and compressed header length are
printed.
For example, the following line shows an outbound compressed TCP packet, with an
implicit connection identifier; the ack has changed by 6, the sequence number by 49,
and the packet ID by 6; there are 3 bytes of data and 6 bytes of compressed header:
O ctcp * A+6 S+49 I+6 3 (6)
ARP/RARP packets
Arp/rarp output shows the type of request and its arguments. The format is intended to
be self-explanatory. Here is a short sample taken from the start of an rlogin from
host rtsg to host csam:
arp who-has csam tell rtsg
arp reply csam is-at CSAM
The first line says that rtsg sent an arp packet asking for the Ethernet address of
Internet host csam. Csam replies with its Ethernet address (in this example, Ethernet
addresses are in uppercase, and Internet addresses are in lowercase).
This would look less redundant if we had done tcpdump -n:
arp who-has 128.3.254.6 tell 128.3.254.68
arp reply 128.3.254.6 is-at 02:07:01:00:01:c4
If we had done tcpdump -e, the fact that the first packet is broadcast and the second is
point-to-point would be visible:
RTSG Broadcast 0806 64: arp who-has csam tell rtsg
CSAM RTSG 0806 64: arp reply csam is-at CSAM
For the first packet this says the Ethernet source address is RTSG, the destination is the
Ethernet broadcast address, the type field contained hexadecimal 0806 (type
ETHER_ARP) and the total length was 64 bytes.

TCP Packets
The following description assumes familiarity with the TCP protocol described in
RFC 793. If you aren’t familiar with the protocol, neither this description nor
tcpdump will be of much use to you.
The general format of a tcp protocol line is:

src > dst: flags data-seqno ack window urgent options
Src and dst are the source and destination IP addresses and ports. Flags are some
combination of S (SYN), F (FIN), P (PUSH), R (RST), W (ECN CWR) or E
(ECN-Echo), or a single . (no flags). Data-seqno describes the portion of sequence
space covered by the data in this packet (see example below). Ack is sequence number
of the next data expected the other direction on this connection. Window is the number
of bytes of receive buffer space available the other direction on this connection. Urg
indicates there is urgent data in the packet. Options are tcp options enclosed in angle
brackets (e.g., <mss 1024>).
The src, dst, and flags are always present. The other fields depend on the contents of
the packet’s tcp protocol header and are output only if appropriate.
Here’s the opening portion of an rlogin from host rtsg to host csam:
rtsg.1023 > csam.login: S 768512:768512(0) win 4096 <mss 1024>
csam.login > rtsg.1023: S 947648:947648(0) ack 768513 win 4096 <mss 1024>
rtsg.1023 > csam.login: . ack 1 win 4096
rtsg.1023 > csam.login: P 1:2(1) ack 1 win 4096
csam.login > rtsg.1023: . ack 2 win 4096
rtsg.1023 > csam.login: P 2:21(19) ack 1 win 4096
csam.login > rtsg.1023: P 1:2(1) ack 21 win 4077
csam.login > rtsg.1023: P 2:3(1) ack 21 win 4077 urg 1
csam.login > rtsg.1023: P 3:4(1) ack 21 win 4077 urg 1
The first line says that tcp port 1023 on rtsg sent a packet to port login on csam. The
S indicates that the SYN flag was set. The packet sequence number was 768512 and it
contained no data. (The notation is first:last(nbytes), which means “sequence numbers
first up to but not including last which is nbytes bytes of user data.”) There was no
piggy-backed ack, the available receive window was 4096 bytes and there was a
max-segment-size option requesting an mss of 1024 bytes.
Csam replies with a similar packet except it includes a piggy-backed ack for rtsg’s
SYN. Rtsg then acks csam’s SYN. The . means no flags were set. The packet
contained no data so there is no data sequence number. Note that the ack sequence
number is a small integer (1). The first time tcpdump sees a TCP “conversation”, it
prints the sequence number from the packet. On subsequent packets of the
conversation, the difference between the current packet’s sequence number and this
initial sequence number is printed. This means that sequence numbers after the first
can be interpreted as relative byte positions in the conversation’s data stream (with the
first data byte each direction being 1). The -S option overrides this feature, causing
the original sequence numbers to be output.
On the sixth line, rtsg sends csam 19 bytes of data (bytes 2 through 20 in the rtsg ->
csam side of the conversation). The PUSH flag is set in the packet. On the seventh
line, csam says it’s received data sent by rtsg up to but not including byte 21. Most of

this data is apparently sitting in the socket buffer since csam’s receive window has
gotten 19 bytes smaller. Csam also sends one byte of data to rtsg in this packet. On the
eighth and ninth lines, csam sends two bytes of urgent, pushed data to rtsg.
If the snapshot was small enough that tcpdump didn’t capture the full TCP header, it
interprets as much of the header as it can and then reports “[|tcp]” to indicate the
remainder couldn’t be interpreted. If the header contains a bogus option (one with a
length that’s either too small or beyond the end of the header), tcpdump reports it as
“[bad opt]” and doesn’t interpret any further options (since it’s impossible to tell
where they start). If the header length indicates options are present but the IP datagram
length isn’t long enough for the options to actually be there, tcpdump reports it as
“[bad hdr length]”.
Capturing TCP packets with particular flag combinations (SYN-ACK, URG-ACK, etc.)
There are 8 bits in the control bits section of the TCP header:
CWR | ECE | URG | ACK | PSH | RST | SYN | FIN
Let’s assume that we want to watch packets used in establishing a TCP connection.
Recall that TCP uses a 3-way handshake protocol when it initializes a new connection;
the connection sequence with regard to the TCP control bits is
1 Caller sends SYN.

2 Recipient responds with SYN, ACK.
3 Caller sends ACK.
Now we’re interested in capturing packets that have only the SYN bit set (Step 1).
Note that we don’t want packets from step 2 (SYN-ACK), just a plain initial SYN.
What we need is a correct filter expression for tcpdump.
Recall the structure of a TCP header without options:
0 15 31
-----------------------------------------------------------------
| source port | destination port |
-----------------------------------------------------------------
| sequence number |
-----------------------------------------------------------------
| acknowledgment number |
-----------------------------------------------------------------
| HL | rsvd |C|E|U|A|P|R|S|F| window size |
-----------------------------------------------------------------
| TCP checksum | urgent pointer |
-----------------------------------------------------------------
A TCP header usually holds 20 octets of data, unless options are present. The first line
of the graph contains octets 0 - 3, the second line shows octets 4 - 7 etc.
Starting to count with 0, the relevant TCP control bits are contained in octet 13:
0 7| 15| 23| 31
----------------|---------------|---------------|----------------
| HL | rsvd |C|E|U|A|P|R|S|F| window size |
----------------|---------------|---------------|----------------
| | 13th octet | | |

Let’s have a closer look at the thirteenth octet:
| |
|---------------|
|C|E|U|A|P|R|S|F|
|---------------|
|7 5 3 0|
These are the TCP control bits we’re interested in. We have numbered the bits in this
octet from 0 to 7, right to left, so the PSH bit is bit number 3, while the URG bit is
number 5.
Recall that we want to capture packets with only SYN set. Let’s see what happens to
octet 13 if a TCP datagram arrives with the SYN bit set in its header:
|C|E|U|A|P|R|S|F|
|---------------|
|0 0 0 0 0 0 1 0|
|---------------|
|7 6 5 4 3 2 1 0|
Looking at the control bits section, we see that only bit number 1 (SYN) is set.
Assuming that octet number 13 is an 8-bit unsigned integer in network byte order, the
binary value of this octet is 00000010, and its decimal representation is:
7 6 5 4 3 2 1 0
0*2 + 0*2 + 0*2 + 0*2 + 0*2 + 0*2 + 1*2 + 0*2 = 2
We’re almost done, because now we know that if only SYN is set, the value of the
thirteenth octet in the TCP header, when interpreted as a 8-bit unsigned integer in
network byte order, must be exactly 2.
This relationship can be expressed as:
tcp[13] == 2
We can use this expression as the filter for tcpdump in order to watch packets which
have only SYN set:
tcpdump -i xl0 tcp[13] == 2
The expression says “let the thirteenth octet of a TCP datagram have the decimal value
2”, which is exactly what we want.
Now, let’s assume that we need to capture SYN packets, but we don’t care if ACK or
any other TCP control bit is set at the same time. Let’s see what happens to octet 13
when a TCP datagram with SYN-ACK set arrives:
|C|E|U|A|P|R|S|F|
|---------------|
|0 0 0 1 0 0 1 0|
|---------------|
|7 6 5 4 3 2 1 0|
Now bits 1 and 4 are set in the thirteenth octet. The binary value of octet 13 is
00010010, which translates to decimal:

7 6 5 4 3 2 1 0
0*2 + 0*2 + 0*2 + 1*2 + 0*2 + 0*2 + 1*2 + 0*2 = 18
Now we can’t just use ’tcp[13] == 18’ in the tcpdump filter expression, because that
would select only those packets that have SYN-ACK set, but not those with only SYN
set. Remember that we don’t care if ACK or any other control bit is set as long as
SYN is set.
In order to achieve our goal, we need to logically AND the binary value of octet 13
with some other value to preserve the SYN bit. We know that we want SYN to be set
in any case, so we’ll logically AND the value in the thirteenth octet with the binary
value of a SYN:
00010010 SYN-ACK 00000010 SYN

AND 00000010 (we want SYN) AND 00000010 (we want SYN)
-------- --------
= 00000010 = 00000010
We see that this AND operation delivers the same result regardless whether ACK or
another TCP control bit is set. The decimal representation of the AND value as well as
the result of this operation is 2 (binary 00000010), so we know that for packets with
SYN set the following relation must hold true:
( ( value of octet 13 ) AND ( 2 ) ) == ( 2 )
This points us to the tcpdump filter expression
tcpdump -i xl0 ’tcp[13] & 2 == 2’
Note that you should use single quotes or a backslash in the expression to hide the
AND (’&’) special character from the shell.
UDP Packets
UDP format is illustrated by this rwho packet:
actinide.who > broadcast.who: udp 84
This says that port who on host actinide sent a udp datagram to port who on host
broadcast, the Internet broadcast address. The packet contained 84 bytes of user data.
Some UDP services are recognized (from the source or destination port number) and
the higher level protocol information printed. In particular, Domain Name service
requests (RFCs 1034 and 1035) and Sun RPC calls (RFC 1050) to NFS.
UDP Name Server Requests
The following description assumes familiarity with the Domain Service protocol
described in RFC 1035.
Name server requests are formatted as:
src > dst: id op? flags qtype qclass name (len)
h2opolo.1538 > helios.domain: 3+ A? ucbvax.berkeley.edu. (37)

Host h2opolo asked the domain server on helios for an address record (qtype=A)
associated with the name ucbvax.berkeley.edu. The query ID was 3. The + indicates
the recursion desired flag was set. The query length was 37 bytes, not including the
UDP and IP protocol headers. The query operation was the normal one, Query, so the
op field was omitted. If the op had been anything else, it would have been printed
between the 3 and the +. Similarly, the qclass was the normal one, C_IN, and omitted.
Any other qclass would have been printed immediately after the A.
A few anomalies are checked and may result in extra fields enclosed in square
brackets: If a query contains an answer, authority records or additional records
section, ancount, nscount, or arcount are printed as [na], [nn], or [nau], where n is
the appropriate count. If any of the response bits are set (AA, RA or rcode) or any of
the “must be zero” bits are set in bytes two and three, [b2&3=x] is printed, where x is
the hexadecimal value of header bytes two and three.
UDP Name Server Responses
Name server responses are formatted as

src > dst: id op rcode flags a/n/au type class data (len)
helios.domain > h2opolo.1538: 3 3/3/7 A 128.32.137.3 (273)

helios.domain > h2opolo.1537: 2 NXDomain* 0/1/0 (97)
In the first example, helios responds to query ID 3 from h2opolo with 3 answer
records, 3 name server records and 7 additional records. The first answer record is
type A (address) and its data is Internet address 128.32.137.3. The total size of the
response was 273 bytes, excluding UDP and IP headers. The op (Query) and response
code (NoError) were omitted, as was the class (C_IN) of the A record.
In the second example, helios responds to query 2 with a response code of
non-existent domain (NXDomain) with no answers, one name server and no authority
records. The * indicates that the authoritative answer bit was set. Since there were no
answers, no type, class or data were printed.
Other flag characters that might appear are - (recursion available, RA, not set) and |
(truncated message, TC, set). If the question section doesn’t contain exactly one entry,
[nq] is printed.
Note that name server requests and responses tend to be large and the default snaplen
of 68 bytes may not capture enough of the packet to print. Use the -s flag to increase
the snaplen if you need to seriously investigate name server traffic. For example, -s
128.
SMB/CIFS decoding
tcpdump now includes fairly extensive SMB/CIFS/NBT decoding for data on

UDP/137, UDP/138 and TCP/139. Some primitive decoding of IPX and NetBEUI
SMB data is also done.
By default, a fairly minimal decode is done, with a much more detailed decode done if
-v is used. Be warned that with -v a single SMB packet may take up a page or more,
so only use -v if you really want all the details.

NFS Requests and Replies
Sun NFS (Network File System) requests and replies are printed as:
src.xid > dst.nfs: len op args

src.nfs > dst.xid: reply stat len op results
For example:
sushi.6709 > wrl.nfs: 112 readlink fh 21,24/10.73165

wrl.nfs > sushi.6709: reply ok 40 readlink ‘‘../var’’
sushi.201b > wrl.nfs:
144 lookup fh 9,74/4096.6878 ‘‘xcolors’’
wrl.nfs > sushi.201b:
reply ok 128 lookup fh 9,74/4134.3150
In the first line, host sushi sends a transaction with ID 6709 to wrl (note that the
number following the source host is a transaction ID, not the source port). The request
was 112 bytes, excluding the UDP and IP headers. The operation was a readlink
(read symbolic link) on file handle (fh) 21,24/10.731657119. (If you’re lucky, as in
this case, the file handle can be interpreted as a major, minor device number pair,
followed by the inode number and generation number.) The wrl host replies ok with
the contents of the link.
In the third line, sushi asks wrl to look up the name xcolors in directory file
9,74/4096.6878. Note that the data printed depends on the operation type. The format
is intended to be self explanatory if read in conjunction with an NFS protocol spec.
If you specify the -v (verbose) option, additional information is printed. For example:
sushi.1372a > wrl.nfs:

148 read fh 21,11/12.195 8192 bytes @ 24576
wrl.nfs > sushi.1372a:
reply ok 1472 read REG 100664 ids 417/0 sz 29388
(The -v optioin also prints the IP header TTL, ID, length, and fragmentation fields,
which have been omitted from this example.) In the first line, sushi asks wrl to read
8192 bytes from file 21,11/12.195, at byte offset 24576. The wrl host replies ok; the
packet shown on the second line is the first fragment of the reply, and hence is only
1472 bytes long (the other bytes will follow in subsequent fragments, but these
fragments don’t have NFS or even UDP headers and so might not be printed,
depending on the filter expression used). Because the -v flag is given, some of the file
attributes (which are returned in addition to the file data) are printed: the file type
(“REG”, for regular file), the file mode (in octal), the uid and gid, and the file size.
If you specify more than one -v option, even more details are printed.
Note that NFS requests are very large and much of the detail won’t be printed unless
snaplen is increased. Try using -s 192 to watch NFS traffic.
NFS reply packets don’t explicitly identify the RPC operation. Instead, tcpdump
keeps track of “recent” requests, and matches them to the replies using the transaction
ID. If a reply doesn’t closely follow the corresponding request, it might not be
parsable.

AFS Requests and Replies
Transarc AFS (Andrew File System) requests and replies are printed as:
src.sport > dst.dport: rx packet-type
src.sport > dst.dport: rx packet-type service call call-name args
src.sport > dst.dport: rx packet-type service reply call-name args
elvis.7001 > pike.afsfs:

rx data fs call rename old fid 536876964/1/1 ‘‘.newsrc.new’’
new fid 536876964/1/1 ‘‘.newsrc’’
pike.afsfs > elvis.7001: rx data fs reply rename
In the first line, host elvis sends a RX packet to pike. This was a RX data packet to the
fs (fileserver) service, and is the start of an RPC call. The RPC call was a rename, with
the old directory file ID of 536876964/1/1 and an old filename of .newsrc.new, and
a new directory file ID of 536876964/1/1 and a new filename of .newsrc. The host
pike responds with a RPC reply to the rename call (which was successful, because it
was a data packet and not an abort packet).
In general, all AFS RPCs are decoded at least by RPC call name. Most AFS RPCs
have at least some of the arguments decoded (generally only the “interesting”
arguments, for some definition of interesting).
The format is intended to be self-describing, but it will probably not be useful to
people who aren’t familiar with the workings of AFS and RX.
If the -v (verbose) flag is given twice, acknowledgment packets and additional header
information is printed, such as the the RX call ID, call number, sequence number,
serial number, and the RX packet flags.
If the -v flag is given twice, additional information is printed, such as the the RX call
ID, serial number, and the RX packet flags. The MTU negotiation information is also
printed from RX ack packets.
If you specify the -v option three times, the security index and service ID are printed.
Error codes are printed for abort packets, with the exception of Ubik beacon packets
(because abort packets are used to signify a yes vote for the Ubik protocol).
Note that AFS requests are very large and many of the arguments won’t be printed
unless snaplen is increased. Try using -s 256 to watch AFS traffic.
AFS reply packets don’t explicitly identify the RPC operation. Instead, tcpdump
keeps track of “recent” requests, and matches them to the replies using the call number
and service ID. If a reply doesn’t closely follow the corresponding request, it might
not be parsable.
KIP AppleTalk (DDP in UDP)
AppleTalk DDP packets encapsulated in UDP datagrams are de-encapsulated and

dumped as DDP packets (i.e., all the UDP header information is discarded). The file
/etc/atalk.names is used to translate AppleTalk net and node numbers to names.
Lines in this file have the form:
number name

1.254 ether
16.1 icsd-net
1.254.110 ace
The first two lines give the names of AppleTalk networks. The third line gives the
name of a particular host. (A host is distinguished from a net by the third octet in the
number; a net number must have two octets and a host number must have three octets.)
The number and name should be separated by whitespace (blanks or tabs). The
/etc/atalk.names file may contain blank lines or comment lines (lines starting
with a #).
AppleTalk addresses are printed in the form:
net.host.port
144.1.209.2 > icsd-net.112.220

office.2 > icsd-net.112.220
jssmag.149.235 > icsd-net.2
(If the /etc/atalk.names doesn’t exist or doesn’t contain an entry for some AppleTalk
host/net number, addresses are printed in numeric form.) In the first example, NBP
(DDP port 2) on net 144.1 node 209 is sending to whatever is listening on port 220 of
net icsd node 112. The second line is the same except the full name of the source node
is known (office). The third line is a send from port 235 on net jssmag node 149 to
broadcast on the icsd-net NBP port (note that the broadcast address (255) is indicated
by a net name with no host number; for this reason it’s a good idea to keep node names
and net names distinct in /etc/atalk.names).
NBP (name binding protocol) and ATP (AppleTalk transaction protocol) packets have
their contents interpreted. Other protocols just dump the protocol name (or number if
no name is registered for the protocol) and packet size.
NBP packets are formatted like the following examples:
icsd-net.112.220 > jssmag.2: nbp-lkup 190: ‘‘=:LaserWriter@*’’
jssmag.209.2 > icsd-net.112.220: nbp-reply 190: ‘‘RM1140:LaserWriter@*’’ 250
techpit.2 > icsd-net.112.220: nbp-reply 190: ‘‘techpit:LaserWriter@*’’ 186
The first line is a name-lookup request for laserwriters sent by net icsd host 112 and
broadcast on net jssmag. The nbp ID for the lookup is 190. The second line shows a
reply for this request (note that it has the same id) from host jssmag.209 saying that
it has a laserwriter resource named RM1140 registered on port 250. The third line is
another reply to the same request saying host techpit has laserwriter techpit
registered on port 186.
ATP packet formatting is demonstrated by the following example:
jssmag.209.165 > helios.132: atp-req 12266<0-7> 0xae030001
helios.132 > jssmag.209.165: atp-resp 12266:0 (512) 0xae040000
helios.132 > jssmag.209.165: atp-resp*12266:7 (512) 0xae040000
jssmag.209.165 > helios.132: atp-req 12266<3,5> 0xae030001


jssmag.209.165 > helios.132: atp-rel 12266<0-7> 0xae030001
jssmag.209.133 > helios.132: atp-req* 12267<0-7> 0xae030002
The jssmag.209 host initiates transaction ID 12266 with host helios by requesting
up to 8 packets (the <0-7>). The hexadecimal number at the end of the line is the
value of the userdata field in the request.
The helios host responds with 8 512-byte packets. The :digit following the
transaction ID gives the packet sequence number in the transaction and the number in
parentheses is the amount of data in the packet, excluding the ATP header. The * on
packet 7 indicates that the EOM bit was set.
The jssmag.209 host then requests that packets 3 and 5 be retransmitted; helios
resends them, and then jssmag.209 releases the transaction. Finally, jssmag.209
initiates the next request. The * on the request indicates that XO (“exactly once”)
wasn’t set.
IP Fragmentation
Fragmented Internet datagrams are printed as:
(frag id:size@offset+)
(frag id:size@offset)
The first form indicates there are more fragments. The second indicates this is the last
fragment.
Id is the fragment id. Size is the fragment size (in bytes) excluding the IP header.
Offset is this fragment’s offset (in bytes) in the original datagram.
The fragment information is output for each fragment. The first fragment contains the
higher level protocol header and the frag info is printed after the protocol info.
Fragments after the first contain no higher level protocol header and the frag info is
printed after the source and destination addresses. For example, here is part of an ftp
from arizona.edu to lbl-rtsg.arpa over a CSNET connection that doesn’t appear to
handle 576 byte datagrams:
arizona.ftp-data > rtsg.1170: . 1024:1332(308) ack 1 win 4096 (frag 595a:328@0+)
arizona > rtsg: (frag 595a:204@328)
rtsg.1170 > arizona.ftp-data: . ack 1536 win 2560
There are a couple of things to note here: First, addresses in the second line don’t
include port numbers. This is because the TCP protocol information is all in the first
fragment and we have no idea what the port or sequence numbers are when we print
the later fragments. Second, the tcp sequence information in the first line is printed as
if there were 308 bytes of user data when, in fact, there are 512 bytes (308 in the first
frag and 204 in the second). If you are looking for holes in the sequence space or
trying to match up acks with packets, this can fool you.
A packet with the IP don’t fragment flag is marked with a trailing (DF).

Timestamps
By default, all output lines are preceded by a timestamp. The timestamp is the current
clock time, in the form hh:mm:ss.frac and is as accurate as the kernel’s clock. The
timestamp reflects the time io-pkt first saw the packet. No attempt is made to
account for the time lag between when the Ethernet interface removed the packet from
the wire and when io-pkt serviced the “new packet” interrupt.
Examples:
Print all packets arriving at or departing from sundown:
tcpdump host sundown
Print traffic between helios and either hot or ace:

tcpdump host helios and $ hot or ace $
Print all IP packets between ace and any host except helios:
tcpdump ip host ace and not helios
Print all traffic between local hosts and hosts at Berkeley:

tcpdump net ucb-ether
Print all ftp traffic through Internet gateway snup (note that the expression is quoted
to prevent the shell from (mis-)interpreting the parentheses):
tcpdump ’gateway snup and (port ftp or ftp-data)’
Print traffic neither sourced from nor destined for local hosts (if you gateway to one
other net, this stuff should never make it onto your local net):
tcpdump ip and not net localnet
Print the start and end packets (the SYN and FIN packets) of each TCP conversation
that involves a non-local host:
tcpdump ’tcp[tcpflags] & (tcp-syn|tcp-fin) != 0 and not src and dst net localnet’
Print all IPv4 HTTP packets to and from port 80, i.e. print only packets that contain
data, not, for example, SYN and FIN packets and ACK-only packets (IPv6 is left as an
exercise for the reader):
tcpdump ’tcp port 80 and (((ip[2:2] - ((ip[0]&0xf)<<2)) - ((tcp[12]&0xf0)>>2)) != 0)’
Print IP packets longer than 576 bytes sent through gateway snup:
tcpdump ’gateway snup and ip[2:2] > 576’
Print IP broadcast or multicast packets that weren’t sent via Ethernet broadcast or
multicast:
tcpdump ’ether[0] & 1 = 0 and ip[16] >= 224’
Print all ICMP packets that aren’t echo requests/replies (i.e., not ping packets):
tcpdump ’icmp[icmptype] != icmp-echo and icmp[icmptype] != icmp-echoreply’

Exit status:
The original authors are Van Jacobson, Craig Leres, and Steven McCanne, all of the
Lawrence Berkeley National Laboratory, University of California, Berkeley, CA. The
tcpdump utility is currently maintained by tcpdump.org.
IPv6/IPsec support is added by WIDE/KAME project. This program uses Eric
Young’s SSLeay library, under specific configuration.
See also:
stty
bpf, pcap in the NetBSD documentation at http://www.netbsd.org/docs/

tee © 2010, QNX Software Systems GmbH & Co. KG.
Duplicate standard input (POSIX)
Syntax:
tee [-ai] [file... ]
Runs on:
Options:
-a Append output to the specified file rather than overwriting it.
-i Ignore the SIGINT signal.
file A pathname of an output file. If you don’t specify any files, tee writes to the
standard output.
Description:
The tee utility copies standard input to standard output, making a copy in zero or
more files. It doesn’t buffer its output. You usually use tee in a pipeline, in order to
make a copy of the output of a utility.
If -a is specified, the named file is opened for appending and data from tee is added
to the file’s existing data. If -a isn’t specified, the file is opened for writing and the
original data in the file is lost.
While it normally takes the default action for all signals, tee ignores SIGINT if -i is
specified.
Examples:
Look for some spots in a collection of C programs where a variable count looks like
it’s being assigned a value, and tee the output both to standard output (where you can
see it immediately) and a file output where you can look at it later (note the grep
example here isn’t sufficient for an exhaustive examination of where count might be
assigned a value):
grep ’count *[ˆ+-/\*]\{,1\}= *[!-([:alnum:]]’ | tee output
Files:
An output file is created for each file operand.
Exit status:
0 Success.

© 2010, QNX Software Systems GmbH & Co. KG. tee
Errors:
If a write to any successfully opened file fails, writes to standard output and other
successfully opened files continue. The exit status, however, is nonzero.

telnet © 2010, QNX Software Systems GmbH & Co. KG.
User interface to the TELNET protocol (UNIX)
Syntax:
telnet [-8] [-c] [-d] [-E] [-e escape_char]
[-L] [-N] [-n tracefile] [-P policy]
[-S tos] [host [port]]
Runs on:
Neutrino
Options:
-8 Allow an eight-bit input data path at all times. Without this
option, parity bits are stripped whenever the remote side’s stop
and start characters are ˆS and ˆQ.
-c Disables the reading of the user’s .telnetrc file. (See the

skiprc argument of the toggle telnet command, below.)
-d Set the initial value of the debug toggle to TRUE.
-E Disable the telnet escape character.
-e escape_char Set the initial telnet escape character to escape_char (default

is Ctrl-]). This character lets you switch to telnet’s command
mode.
-L Specifies an 8-bit data path on output. This causes the BINARY

option to be negotiated on output.
-N Numeric host address. Prevents look up of a symbolic name

when the destination host is given as an IP address.
-n tracefile Record trace information in the specified file. See the set tracefile
command, below.
-P policy Use the IPsec policy specification string policy for the
connections. For details of the IPsec policy control, see the
Library Reference.
-S tos Sets the IP type-of-service (TOS) option for the telnet connection
to the value tos, which can be a numeric TOS value or, on
systems that support it, a symbolic TOS name found in the
/etc/iptos file.
host The official name, an alias, or the Internet address of a remote

host.
port A port number (address of an application). If a number isn’t

specified, the default telnet port is used.

© 2010, QNX Software Systems GmbH & Co. KG. telnet
Description:
Use the telnet command to communicate with another host via the TELNET
protocol. If you invoke telnet without a host argument, it enters command mode and
displays this prompt:
telnet>
In command mode, telnet accepts and executes the commands listed in “Telnet
commands,” below.
If you invoke telnet with a host argument, it opens a connection to the named host
(i.e. it performs an open command).
If LINEMODE is enabled, character processing is done on the local system, under the
control of the remote system. When input editing or character echoing is to be
disabled, the remote system relays that information. The remote system also relays
changes to any special characters that happen on the remote system, so that they can
take effect on the local system.
In “character-at-a-time” mode, most text that’s typed is immediately sent to the remote
host for processing.
In “old-line-by-line” mode, all text is echoed locally, and (in most cases) only
completed lines are sent to the remote host. You can use the “local echo character”
(initially Ctrl-E) to turn off and on the local echo (you use this mostly to enter
passwords without echoing).
If the LINEMODE option is enabled, or if the localchars toggle is TRUE (the default
for “old-line-by-line”), your quit, intr, and flush characters are trapped locally
and sent as TELNET protocol sequences to the remote side.
If LINEMODE has ever been enabled, then your susp and eof are also sent as
TELNET protocol sequences, and quit is sent as a TELNET ABORT instead of as a
BREAK. There are options (see toggle autoflush and toggle autosynch
below) that cause this action to flush subsequent terminal output (until the remote host
acknowledges the TELNET sequence) and to flush previous terminal input (in the case
of quit and intr).
While you’re connected to a remote host, you can enter telnet’s command mode by
entering the telnet escape sequence (initially Ctrl-]). The normal terminal editing
conventions are available in command mode.
Telnet commands:
In the following commands, you need to type only enough of each command to
uniquely identify it; this is also true for arguments to the mode, set, toggle, unset,
environ, and display commands.
close Close a TELNET session and return to command mode.
display argument...
Display all, or some, of the set and toggle values (see below).

mode type The type argument can have one of several values, depending on
the state of the TELNET session. The remote host is asked for
permission to go into the requested mode. If the remote host can
enter that mode, the mode is entered.
character Disable the TELNET LINEMODE option; if the

remote side doesn’t understand the LINEMODE
option, enter character-at-a-time mode instead.
line Enable the TELNET LINEMODE option; if the
remote side doesn’t understand the LINEMODE
option, attempt to enter old-line-by-line mode
instead.
[-]isig Attempt to enable (disable) the TRAPSIG mode
of the LINEMODE option. LINEMODE must be
enabled.
[-]edit Attempt to enable (disable) the EDIT mode of
the LINEMODE option. LINEMODE must be
enabled.
[-]softtabs Attempt to enable (disable) the SOFT_TAB
mode of the LINEMODE option. LINEMODE must
be enabled.
[-]litecho Attempt to enable (disable) the LIT_ECHO
mode of the LINEMODE option. LINEMODE must
be enabled.
? Print help information for the mode command.
open host [[-l] user] [-port]

Open a connection to the named host. If no port number is
specified, telnet tries to contact a TELNET server at the
default port. The host may be specified either as a hostname (see
the /etc/hosts file) or as an Internet address specified in the
“dot notation” (see the Internet address manipulation routines,
inet*() in the Library Reference).
With the -l option, you can specify the username to be passed to
the remote system via the ENVIRON option.
When connecting to a nonstandard port, telnet omits any
automatic initiation of TELNET options. When port is preceded
by a minus sign, the initial option negotiation is done. Once
telnet establishes a connection, it opens the .telnetrc file
that’s in your home directory.
In this file, lines beginning with a # are comments. Blank lines
are ignored. Lines that begin without whitespace are the start of a
machine entry. The first thing on the line is the name of the
machine that’s being connected to. The rest of the line and the

successive lines that begin with whitespace are assumed to be

telnet commands; they’re processed as if you had typed them
manually at the telnet> command prompt.
quit Close any open TELNET session and exit telnet. An

end-of-file (in command mode) also closes a session and exits.
send arguments Send one or more special character sequences to the remote host.
You can specify the following arguments (more than one
argument may be specified at a time):
abort Send the TELNET ABORT (Abort processes)

sequence.
ao Send the TELNET AO (Abort Output) sequence,
which should cause the remote system to flush all
its output to the user’s terminal.
ayt Send the TELNET AYT (Are You There) sequence,
to which the remote system may or may not
choose to respond.
brk Send the TELNET BRK (Break) sequence, which
may have significance to the remote system.
ec Send the TELNET EC (Erase Character) sequence,
which should cause the remote system to erase the
last character entered.
el Send the TELNET EL (Erase Line) sequence,
which should cause the remote system to erase the
line currently being entered.
eof Send the TELNET EOF (end-of-file) sequence.
eor Send the TELNET EOR (end-of-record) sequence.
escape Send the current telnet escape character
(initially Ctrl-]).
ga Send the TELNET GA (Go Ahead) sequence, which
likely has no significance to the remote system.
getstatus If the remote side supports the TELNET STATUS
command, send the subnegotiation to request that
the server send its current option status.
ip Send the TELNET IP (Interrupt Process) sequence,
which should cause the remote system to abort the
currently running process.
nop Send the TELNET NOP (No OPeration) sequence.
susp Send the TELNET SUSP (SUSPend process)
sequence.

synch Send the TELNET SYNCH sequence. This sequence

causes the remote system to discard all previously
typed (but not yet read) input. This sequence is
sent as TCP urgent data — it might not work if the
remote system is a 4.2BSD system. If it doesn’t
work, a lowercase “r” might be echoed on the
terminal.
? Print help information for the send command.
set argument value

unset argument value
The set command sets any one of a number of telnet
variables to a specific value or to TRUE. The special value off
turns off the function associated with the variable — it’s
equivalent to using the unset command. The unset command
disables or sets to FALSE any of the specified functions.
You can query the values of variables with the display
command.
The telnet variables that can be set or unset, but not toggled,
are listed here. Note that you also explicitly set or unset any of
the toggle command’s variables.
ayt If telnet is in localchars mode, or

LINEMODE is enabled, and the status character
is typed, a TELNET AYT sequence is sent to
the remote host. The initial value for the Are
You There character is the terminal’s status
character.
echo In old-line-by-line mode, this value (initially
Ctrl-E) toggles between doing local echoing of
entered characters (for normal processing) and
it (e.g. for entering a password).
eof If telnet is operating in LINEMODE or
old-line-by-line mode, this character is sent to
the remote system if entered as the first
character on a line. The initial value of the
eof character is the terminal’s EOF character.
erase If telnet is in localchars mode (see toggle
localchars below) and in
character-at-a-time mode, then when this
character is typed, a TELNET EC sequence
(see send ec above) is sent to the remote
system. The initial value for the erase
character is the terminal’s erase character.

escape This is the telnet escape character; entering

it switches you to telnet’s command mode
when telnet is connected to a remote
system. (Initially, the character is Ctrl-] to
switch).
flushoutput If telnet is in localchars mode (see toggle
localchars below) and the flushoutput
character is typed, a TELNET AO sequence
(see send ao above) is sent to the remote
host. The initial value for the flush character is
the terminal’s flush character.
forw1 or forw2 If telnet is operating in LINEMODE, these
are the characters that, when typed, cause
partial lines to be forwarded to the remote
system. The initial value for the forwarding
characters are taken from the terminal’s eol
and eol2 characters.
interrupt If telnet is in localchars mode (see toggle
localchars below) and the interrupt
character is typed, a TELNET IP sequence
(see send ip above) is sent to the remote
host. The initial value for the interrupt
character is the terminal’s intr character.
kill If telnet is in localchars mode (see toggle
localchars below) and in
character-at-a-time mode, then when this
character is typed, a TELNET EL sequence
(see send el above) is sent to the remote
system. The initial value for the kill character
is the terminal’s kill character.
lnext If telnet is in LINEMODE or old-line-by-line
mode, then this character is the terminal’s
lnext character. The initial value for the lnext
character is the terminal’s lnext character.
quit If telnet is in localchars mode (see toggle
localchars below) and the quit character is
typed, a TELNET BRK sequence (see send
brk above) is sent to the remote host. The
initial value for the quit character is the
terminal’s quit character.
reprint If telnet is in LINEMODE or old-line-by-line
mode, then this character is the terminal’s
reprint character. The initial value for the
reprint character is the terminal’s reprint
character.

start If the TELNET TOGGLE-FLOW-CONTROL

option has been enabled, then this character is
the terminal’s start character. The initial value
for the kill character is the terminal’s start
character.
stop If the TELNET TOGGLE-FLOW-CONTROL
option has been enabled, then this character is
the terminal’s stop character. The initial value
for the kill character is the terminal’s stop
character.
susp If telnet is in localchars mode, or if
LINEMODE is enabled, and the suspend
character is typed, a TELNET SUSP sequence
(see send susp above) is sent to the remote
host. The initial value for the suspend
character is the terminal’s suspend character.
tracefile This the file to which the output is written
(when netdata or option tracing is TRUE). If
it’s set to -, tracing information is written to
standard output (the default).
worderase If telnet is operating in LINEMODE or
old-line-by-line mode, then this character is
the terminal’s word-erase character. The
initial value for the word-erase character is the
terminal’s word-erase character.
? Display the legal set (unset) commands.
environ argument...
The environ command manipulates the variables that may be
sent through the TELNET ENVIRON option. The initial set of
variables is taken from the user’s environment; only the
DISPLAY and PRINTER environment variables are exported
by default. Valid arguments are:
define variable value

Define this variable to have this value. Any
variables defined by this command aren’t
automatically exported. To include tabs
and spaces in value, enclose it in single or
double quotes.
send variable Send variable to the remote site.
undefine variable Remove variable from the list of
environment variables.
export variable Mark variable to be exported to the remote
side.

unexport variable Mark variable not to be exported unless

explicitly asked for by the remote side.
list List the current set of environment
variables. Those marked with a * are sent
automatically; other variables are sent only
if explicitly requested.
? Print help information for the environ
command.
toggle flag... Toggle between TRUE and FALSE various flags that control how
telnet responds to events. You can explicitly set these flags to
TRUE or FALSE with the set and unset commands listed above.
To query the state of these flags, use the display command.
Note that you can specify more than one flag.
Valid arguments are:
autoflush If autoflush and localchars are both TRUE,

and the ao or quit characters are recognized
(and transformed into TELNET sequences; see
set above for details), refuse to display any data
on the user’s terminal until the remote system
acknowledges (via a TELNET TIMING MARK
option) that it has processed those TELNET
sequences. If the terminal user hasn’t done an
stty noflsh, the initial value for this toggle is
TRUE; otherwise it’s FALSE. See stty.
autosynch If autosynch and localchars are both TRUE,
and either the intr or quit character is typed
(see set above), send the resulting TELNET
sequence and follow it with the TELNET SYNCH
sequence. This procedure should cause the
remote system to begin throwing away all
previously typed input until both of the TELNET
sequences have been read and acted upon. The
initial value of this toggle is FALSE.
binary Enable or disable the TELNET BINARY option on
both input and output.
inbinary Enable or disable the TELNET BINARY option on
input only.
outbinary Enable or disable the TELNET BINARY option on
output only.
crlf If this is TRUE, send carriage returns as CR LF. If
this is FALSE, send carriage returns as CR NUL.
The initial value for this toggle is FALSE.

crmod Toggle carriage-return mode. When this mode is

enabled, most carriage-return characters received
from the remote host are mapped into a carriage
return followed by a line feed. This mode doesn’t
affect characters you type, only those received
from the remote host. This mode is useful only if
the remote host sends only carriage returns and
never sends line feeds. The initial value for this
toggle is FALSE.
debug Toggle socket-level debugging (useful only to the
superuser). The initial value for this toggle is
FALSE.
localchars If this is TRUE, then the flush, interrupt,
quit, erase, and kill characters (see set
above) are recognized locally, and should be
transformed into appropriate TELNET control
sequences (respectively ao, ip, brk, ec, and el;
see send above). The initial value for this toggle
is TRUE in old-line-by-line mode, and FALSE in
character-at-a-time mode. When the LINEMODE
option is enabled, the value of localchars is
ignored and assumed to be always TRUE. If
LINEMODE has ever been enabled, then quit is
sent as abort, and eof and susp are sent as eof
and susp (see send above).
netdata Toggle the display of all network data (in hex
format). The initial value for this toggle is FALSE.
options Toggle the display of some internal telnet
protocol processing (having to do with TELNET
options). The initial value for this toggle is
FALSE.
prettydump If the netdata and prettydump toggles are
both enabled, the output from the netdata
command is formatted in a more user-readable
format. Spaces are put between each character in
the output, and the beginning of any TELNET
escape sequence is preceded by a * to aid in
locating it.
skiprc When the skiprc toggle is TRUE, telnet skips
the reading of the .telnetrc file in the users
home directory when connections are opened.
The initial value for this toggle is FALSE.
termdata Toggles the display of all terminal data (in
hexadecimal format). The initial value for this
toggle is FALSE.

? Display the legal toggle commands.
z Suspend telnet. This command works only if you’re using

csh.
! [command] Execute a single command in a subshell on the local system. If

command is omitted, an interactive subshell is invoked.
status Show the current status of telnet. This includes the peer you’re
connected to as well as the current mode.
? [command] Get help. With no arguments, telnet prints a help summary. If

a command is specified, telnet prints the help for that
command.
Files:
$HOME/.telnetrc
User-customized startup values for telnet.
The telnet utility requires the libsocket.so shared library.
The telnet utility uses at least the HOME, SHELL, DISPLAY, and TERM
environment variables. The environment variables may be propagated to the other side
via the TELNET ENVIRON option.
License:
Caveats:
On some remote systems, you have to turn echo off manually when you’re in
old-line-by-line mode.
In old-line-by-line mode or LINEMODE, the terminal’s EOF character is recognized
(and sent to the remote system) only when it’s the first character on a line.
See also:
rlogin, rsh, telnetd
Based on RFC 854

telnetd © 2010, QNX Software Systems GmbH & Co. KG.
DARPA TELNET protocol daemon (UNIX)
Syntax:
telnetd [-debug] [-D (options|report|netstat|ptydata)]
[-h] [-n] [-U] [-46] [port]
Runs on:
Neutrino
Options:
-4 or -6 The address family to use for -debug mode. During normal operation
(called from inetd), telnetd will use the file descriptor passed
from inetd.
-D modifier Print debugging information. You can specify any of the following:
options Print information about the negotiation of TELNET

options.
report Print the same information as for options, plus some
additional information about what processing is going on.
netdata Display the data stream received by telnetd.
ptydata Display data written to the pty.
-debug Normally, telnetd is started automatically through inetd; this

option lets you start telnetd manually, blocking on port, waiting for
a connection.
-h Disable the printing of host-specific information before logging in has

been completed.
-n Disable the keepalive option.
-U Refuse connections from addresses that can’t be mapped back into a

symbolic name.
port The port to use in -debug mode (must come last).
Description:
The telnetd daemon is a server that supports the DARPA-standard TELNET
virtual-terminal protocol.
The telnetd daemon is started when inetd receives a service request to connect to
the TELNET port (inetd listens for service requests specified in the inetd.conf
file at a port defined in the services file).

© 2010, QNX Software Systems GmbH & Co. KG. telnetd
By specifying the -debug option, you can start up telnetd manually instead of
through inetd. If you start telnetd this way, you can use the port argument to run
telnetd on an alternate TCP port number.
You can use the -D option for debugging. This option lets telnet print debugging
information to the connection, letting you see what telnetd is doing.
The telnetd daemon operates by allocating a pseudo-terminal device for a client,
then creating a login process that has the slave side of the pseudo-terminal as standard
input, standard output, and standard error. The telnetd daemon manipulates the
master side of the pseudo-terminal, implementing the TELNET protocol and passing
characters between the remote client and the login process.
If you get a message saying that all network ports are in use, you’ve either run out of
pseudo devices or you haven’t started devc-pty. The telnetd daemon looks only at
the pseudo-terminal devices named /dev/pty[pqrs][0-f], no matter how many
others are created.
When a TELNET session is started up, telnetd sends TELNET options to the client
side that indicate a willingness to do remote echoing of characters, to suppress
go-ahead, and to do remote flow control, as well as to receive terminal-type
information, terminal-speed information, and window-size information from the
remote client. If the remote client is willing, the remote terminal type is propagated in
the environment of the created login process. The pseudo-terminal allocated to the
client is configured to operate in cooked mode, and with XTABS and CRMOD
enabled.
The telnetd daemon is willing to do:
• echo
• binary
• suppress go ahead
• timing mark
It’s also willing to have the remote client do:
• line mode
• binary
• terminal type
• terminal speed
• window size
• toggle flow control
• environment

telnetd © 2010, QNX Software Systems GmbH & Co. KG.
• X display location
• suppress go ahead
Name resolving issues

It is not mandatory for telnetd to have access to name-resolving capabilities. If it
does have access to these capabilities, telnetd does a reverse name lookup (IP to
hostname) of the telnet client.
If you decide to use a nameserver, make sure that the nameserver configuration is
correct. If it isn’t, there could be a delay of up to 1.5 minutes a login prompt is
returned to the client, while the socket library’s name resolver attempts to resolve the
IP to a hostname.
Typical configuration for running telnetd on an embedded target

As mentioned before, in a host system environment, you run telnetd by just typing
inetd in the command line. If you want to run telnetd on an embedded target, you
need to copy the following files to your target:
• the appropriate variant of io-pkt*
• Ethernet driver shared object (i.e. devn-ne2000.so)
• libsocket.so
• devc-pty for pseudo-tty support. You should use the -n option for this daemon to
specify the number of sessions; each telnet session uses one pseudo device.
• ifconfig and route — both these utilities are used to configure your network
interface. These utilities could be replaced by dhcp.client.
• inetd — this daemon is the Internet super-server.
• inetd.conf — TCP service daemons are listed in this file.

The location of inetd and inetd.conf are /usr/sbin, and /etc respectively.
If you decide to move inetd.conf to another location, you need to tell inetd in
the command line.
The minimal inetd.conf contents to make telnetd work are as follows:

inetd.conf = {
# Internet services syntax:
# <service_name> <socket_type> <proto> <flags> <user> <server_pathname><args>
telnet stream tcp nowait root /usr/sbin/telnetd in.telnetd

telnet stream tcp6 nowait root /usr/sbin/telnetd telnetd
}
• telnetd — the location for this is usually /usr/sbin/telnetd. If you move it

to another location, modify inetd.conf accordingly.
• /etc/services — maps service names such as telnet to a port number (23).

© 2010, QNX Software Systems GmbH & Co. KG. telnetd
• /bin/login
You can link login to sh or another binary if you don’t want to actually log in, but
you must include /etc/passwd if you do want to log in.
• /etc/termcap
• /usr/lib/terminfo
• /bin/sh
• /etc/hosts or /etc/nsswitch.conf or CS_RESOLVE

For more information, see “Name resolving issues,” above.
To configure the interface from a shell prompt, either use ifconfig and route or
dhcp.client. You can then start inetd.
Files:
The telnetd daemon requires the libsocket.so shared library.
License:
This utility is based on copyright software of the WIDE project and of the Regents of
the University of California; for licensing information, see the Third Party License
Terms List at http://licensing.qnx.com/third-party-terms/.
Caveats:
Because of bugs in the original 4.2 BSD telnet, telnetd performs some protocol
exchanges to try to discover if the remote client is, in fact, a 4.2 BSD telnet.
Binary mode has no common interpretation except between similar operating systems
(UNIX in this case).
The terminal-type name received from the remote client is converted to lowercase.
The telnetd daemon never sends TELNET go-ahead commands.
See also:
/etc/hosts, ifconfig, inetd, inetd.conf, login, /etc/resolv.conf,
rlogind, route, rshd, /etc/services, sh, telnet
Based on RFC 854

textto © 2010, QNX Software Systems GmbH & Co. KG.
Convert text files to QNX 2, QNX 4, UNIX, or DOS format (QNX Neutrino)
Syntax:
textto [-c|l|r] [-qz] file...
Runs on:
Options:
-c Convert the specified files to DOS format (CR/LF).
-l (“el”) Convert the specified files to QNX 4 and UNIX format (LF). By default,
if none of the options are specified, -l is assumed.
-q Be quiet; don’t write the names of files being processed.
-r Convert the specified files to QNX 2 format (RS).
-z Strip all ˆZ codes from the file.
file The name of the file to be converted. You can use wildcards in the name.
Description:
The textto utility lets you convert text files to QNX 2, QNX 4/UNIX, or DOS
format. You can use the -z option to strip ˆZ codes from DOS-based files. Some DOS
programs use this character as an end-of-file indicator.
Examples:
Change all QNX 2 record separators in prog.c to QNX 4 line feeds:
textto -l prog.c
Change all QNX 4 line feeds in all of the .h files in the current directory to QNX 2
record separators:
textto -r *.h
Change all QNX 4 line feeds in all of the .txt files in the current directory to DOS
CR/LFs:
textto -c *.txt
See also:
tr

© 2010, QNX Software Systems GmbH & Co. KG. tftp
Trivial file transfer program
Syntax:
tftp [-e] [host] [port]
Runs on:
Neutrino
Options:
-e Use binary transfer mode and set the extended options, as if tout, tsize,
and blksize 65464 had been given.
host The host to connect to.
port The port to connect to.
Description:
The tftp utility is the user interface to the Internet TFTP (Trivial File Transfer
Protocol), which lets you transfer files to and from a remote machine. If you specify a
remote host (and an optional port) on the command line, tftp uses that host (and
port) as the default for future transfers (see the connect command below). The client
host must have an entry in the /etc/services file to provide tftp service.
Remote filenames must start with a /. If a list of directories is given to tftpd,

filenames must be in that list. To get a file, the file must have world-read privileges;
to put a file, the file must have world-write privileges on the remote machine.
Commands:
Once tftp is running, it issues a prompt and accepts the following commands:
? command_name...
Print help information.
ascii Shorthand for “mode ascii” (see mode below).
binary Shorthand for “mode binary” (see mode below).
blksize blk-size Set the blocksize to blk-size octets (8-bit bytes). Since the
number of blocks in a tftp get or put is 65535, the default
block size of 512 bytes allows only a maximum of just under 32
MB to be transferred. The value given for blk-size must be
between 8 and 65464, inclusive. Note that many servers don’t
respect this option.

tftp © 2010, QNX Software Systems GmbH & Co. KG.
connect host [port]

Set the host (and optionally port) for transfers. Note that the
TFTP protocol, unlike FTP, doesn’t maintain connections
between transfers. That is, the connect command doesn’t
actually create a connection, but merely remembers what host
to use for transfers. You don’t have to use the connect
command; you can specify the remote host as part of the get or
put commands.
get file
get remotefile localfile
get file1 file2 ... fileN
Get a file or set of files from the specified sources. The source
can be in one of two forms: a filename on the remote host (if the
host has already been specified), or a string of the form
hosts : filename to specify both a host and file at the same time.
If you use the latter form, the last hostname specified becomes
the default.
mode transfer_mode
Set the mode for transfers to either ascii or binary (default is
ascii).
put file
put localfile remotefile
put file1 file2 ... fileN remote_directory
Put a file or set of files to the specified remote file or directory.
The destination can be in one of two forms: a filename on the
remote host (if the host has already been specified), or a string
of the form hosts : filename to specify both a host and file. If
you use the latter form, the hostname specified becomes the
default; if you use the remote_directory form, the remote host is
assumed to be a Unix box.
If you need to specify IPv6 numeric addresses for the hosts,
enclose them in square brackets ([hosts]:filename) to
disambiguate the colon.
quit Exit tftp. An end-of-file also exits.
rexmt retransmission_timeout
Set the per-packet retransmission timeout (specified in seconds).
status Show the current status.
timeout total_transmission_timeout
Set the total transmission timeout (specified in seconds).

© 2010, QNX Software Systems GmbH & Co. KG. tftp
tout Toggle the timeout option. If you use this option, the client
passes its retransmission-timeout to the server. Note that many
servers don’t respect this option.
trace Toggle packet tracing.
tsize Toggle the tsize option. If you enable this option, the client
passes and requests the size of a file at the beginning of a file
transfer. Note that many servers don’t respect this option.
verbose Toggle verbose mode.
Files:
The tftp utility requires the libsocket.so shared library.
Caveats:
Since there’s no user-login or validation within the TFTP protocol, the remote site
should have some file-access restrictions — the exact methods for implementing these
vary.
See also:
/etc/services, ftp, tftpd

tftpd © 2010, QNX Software Systems GmbH & Co. KG.
DARPA trivial file transfer protocol daemon
Syntax:
tftpd [-dln] [-g group] [-p port] [-s directory]
[-u user] [directory ...]
Runs on:
Neutrino
Options:
-d Increase the debugging level.
-g group Change the group ID to that of group on startup. If you don’t specify
this option, the group ID is set to that of the user specified with the
-u option.
-l Log all requests using syslogd.
-n Suppress negative acknowledgement of requests for nonexistent

relative filenames.
-p port The UDP port to bind when running tftpd standalone.
-s directory The root directory that you want tftpd to change to on startup. This
is recommended for security reasons (so that files other than those in
the /tftpboot directory aren’t accessable). If the remote host
passes the directory name as part of the file name to transfer, you
may have to create a symbolic link from tftpboot to . under
/tftpboot.
-u user Change the user ID to that of user on startup. If you don’t specify
this option, the user defaults to nobody. If you don’t specify -g,
tftpd uses the group ID of user as well.
directory The name of the directory where files are accessed.
Description:
The tftpd daemon is a server that supports the DARPA Trivial File Transfer
Protocol.
The tftpd daemon is started when inetd receives a service request at the port
indicated by the tftp entry (inetd listens for service requests specified in the
inetd.conf at a port defined in the services file).

© 2010, QNX Software Systems GmbH & Co. KG. tftpd
Because tftp doesn’t require an account or password on the remote system, tftpd
allows only publicly readable files to be accessed. Files may be written only if they
already exist and are publicly writable.
This extends the concept of “public” to include all users on all hosts that can be
reached through the network—this may not be appropriate on all systems, and its
implications should be considered before enabling the tftp service. The daemon
should have the user ID with the lowest possible privilege.
Filenames must start with a /. If a list of directories is given to tftpd, filenames must
be in that list. To get a file, the file must have world-read privileges; to put a file, the
file must have world-write privileges.
The bootpd utility works with tftpd to provide the client with a boot image.
Files:
The tftpd daemon requires the libsocket.so shared library.
See also:
bootpd, ftpd, inetd, tftp
Based on RFC 1350

tic © 2010, QNX Software Systems GmbH & Co. KG.
Terminfo compiler (UNIX)
Syntax:
tic [-c] [-i] [-v n] file
Runs on:
Neutrino
Options:
-c Perform only a syntax check of the input file. No output file is produced.
-i Ignore errors when compiling terminfo files from other systems that describe
capabilities not currently supported in /usr/lib/terminfo.
-v n Set verbose output level. Progress information is output to stderr as tic

works though the source file. The integer argument controls the verbosity of
the report, 1 providing the least detail and 10 providing the most. The default
is 0, providing “quiet” compilation.
file The pathname of a file that contains one or more terminal descriptions in
terminfo source format. Each description in the file describes a particular
terminal. When a use=entry_name field is encountered within a terminal
description, tic reads the previously compiled description from the
/usr/lib/terminfo directory to finish the entry. This allows terminal
descriptions that are only slightly different from one previously defined to be
expressed as an extension to that previous description. If the environment
variable TERMINFO is set, the directory named is used instead of the
/usr/lib/terminfo directory.
Description:
The tic utility translates a terminfo file from the source format into the compiled
format, ready to use by applications running on the terminal type named in the
terminfo source file.
The compiled terminfo capability files are stored in single-character directories,
under the /usr/lib/terminfo directory. For example, the VT100 terminfo file is
stored in /usr/lib/terminfo/v/vt100.
You can use the infocmp utility to convert a binary, compiled terminfo file back into a
source format that you can modify, and then recompile it with tic.
Some error messages produced by tic indicate the line of the source file in error and
the terminal name being processed at that point.

© 2010, QNX Software Systems GmbH & Co. KG. tic
TERMINFO When defined, the compiled output from tic is placed under the
directory named instead of in the /usr/lib/terminfo directory.
Exit status:
0 The input file was compiled successfully.
Caveats:
The total size of a compiled terminfo description cannot exceed 4096 bytes. The name
field cannot exceed 128 bytes.
Terminal names longer than 14 characters are truncated to 14 characters.
See also:
infocmp
Strang, John, Linda Mui, and Tim O’Reilly. 1988. termcap & terminfo. Sebastopol,
CA: O’Reilly and Associates. ISBN 0937175226.

time © 2010, QNX Software Systems GmbH & Co. KG.
Determine the execution time of a command (UNIX)
Syntax:
time command
Runs on:
Neutrino
Options:
command The command, including any of its options, for which the execution
time is to be determined.
Description:
The time utility and the time shell built-in determine the execution time of command,
which must be specified. When execution of command is complete, the time utility
displays the total elapsed time for execution, the time spent in the system, and the time
spent in executing command. Times are reported in hours, minutes, and seconds.
Times aren’t always accurate to the milliseconds as displayed, depending on the tick
size.
Examples:
Time the execution of dcheck -b2048 /dev/hd0:
time dcheck -b2048 /dev/hd0
Exit status:
The time utility exits with the exit status of the command that was timed.
Caveats:
The time command doesn’t obtain execution information from a remote node. To
time remote programs, use the on command to run time on the same machine as the
program being timed, e.g.:
on -n 61 time sleep 30
NOT:
time on -n 61 sleep 30

© 2010, QNX Software Systems GmbH & Co. KG. time
See also:
date, uptime

tinit © 2010, QNX Software Systems GmbH & Co. KG.
Terminal initialization
Syntax:
tinit [-f file] [-pt] [env_var=value...]
Runs on:
Neutrino
Options:
-f file The configuration file that defines the commands to start (see
below). The default is /etc/config/ttys.
-p Start Photon.
-t Don’t mask the suspend signal (SIGTSTP) in spawned process.
env_var=value Set the environment variable env_var to value and add it to the
environment.
Description:
The tinit utility lets you bring up login (or other programs) on devices. You
normally use tinit to invoke login on the console(s) and serial terminals.
The tinit utility runs as a background process, and is nearly always started in the
/etc/rc.d/rc.sysinit file. If /etc/system/config/nophoton doesn’t exist
on your system, the default rc.sysinit starts tinit with the -p option.
After creating the specified programs as its children, tinit waits for any of them to
terminate. When one of these commands terminates, tinit re-invokes the command
on that device.
For example, let’s assume that tinit started a login on /dev/con1. After logging
in, the user is presented with a shell. Then, after executing any number of commands,
the user decides to terminate the shell. At this point, tinit detects the termination
and starts a new login on /dev/con1.
ttys configuration file

The tinit utility refers to a configuration file (/etc/config/ttys or the file you
specified with the -f option) to obtain information about your terminal devices and
the commands you want to start on them. This file contains lines of text, each line
containing four fields that give the configuration information for one device, like this:
con1 "/bin/login" qansi-m on

Here’s what the fields in this example define:
con1 The first field is the device name. Unless you define a complete
pathname, starting with / (slash), tinit adds the prefix /dev/

© 2010, QNX Software Systems GmbH & Co. KG. tinit
to the name. This example defines the device name as

/dev/con1. If you wanted to specify a terminal connected to a
serial port, this field might read ser1.
"/bin/login". The second field contains a string that specifies the pathname of
the command to be started on the device. This command can be
anything you like; most often it will be either login, as in this
default example, or photon.
qansi-m The third field describes the terminal type. You can find a list of
the terminal types you can specify in /usr/lib/terminfo.
on The fourth and last field is currently ignored by tinit. It is

there for possible future expansion.
The parsing of this file is fairly simple:
• Fields may be quoted or unquoted; quoted fields are enclosed by double quotation
marks (").
• An unquoted field is separated from the next field by one or more spaces; a quoted
field is separated from the next by its closing quote, followed by zero or more
spaces.
• There’s no escape character, so you can’t include double quotation marks in a

quoted field. You can use single quotation marks (’) inside quoted fields.
The tinit utility is the root of all logins, so any environment variables it sets will be
inherited; this makes the tinit command line a convenient place for you to set the
environment variables you need, using the env_var options.
Files:
/etc/config/ttys
The terminal configuration file used by tinit.
See also:
diskboot, login, phlogin

top © 2010, QNX Software Systems GmbH & Co. KG.
Display system usage (Unix)
Syntax:
top [-i number] [-d] [-n node] [-p priority]
Runs on:
QNX Neutrino
Options:
-d Tailor the output for a dumb terminal. By default, top refreshes its
output in place for each iteration. If you specify -d, top displays the
output for each iteration after the output from the previous one.
-n node Run top on the specified remote node.
-p priority Run at the specified priority.
-i number Run for the specified number of iterations. By default, top runs until
you terminate it.
Description:
The top utility displays the system usage. Its output looks like this:
42 processes; 119 threads;

CPU states: 67.3% idle, 29.9% user, 2.7% kernel
Memory: 0 total, 368M avail, page size 4K
PID TID PRI STATE HH:MM:SS CPU COMMAND

593962 1 10 Rcv 0:00:04 16.45% firefox-bin
278558 3 12 Rply 0:00:50 6.00% io-graphics
278558 2 10 Rcv 0:00:00 2.15% io-graphics
1 19 10 Run 0:00:03 1.52% kernel
258077 1 12 Rcv 0:00:08 1.52% Photon
1 13 10 Rcv 0:00:00 1.18% kernel
8200 11 10 Rcv 0:00:00 0.73% devb-eide
114707 2 12 Rcv 0:00:02 0.71% io-display
131092 2 21 Rcv 0:04:39 0.35% io-pkt-v4-hc
380956 1 10 Rcv 0:00:00 0.31% pwm
Min Max Average

CPU idle: 45% 98% 67%
Mem Avail: 368MB 398MB 382MB
Processes: 39 42 41
Threads: 104 119 111
See also:
hogs, pidin, ps

© 2010, QNX Software Systems GmbH & Co. KG. touch
Change file access and modification times (POSIX)
Syntax:
touch [-acm] [-r ref_file|-t time] file...
Runs on:
Options:
-a Change the access time of file to time, or to the current time if time
isn’t specified. Don’t change the modification time unless the -m
option is also specified.
-c If file doesn’t already exist, don’t create file and don’t write any
diagnostic messages concerning this condition.
-m Change the modification time of file to time, or to the current time if

time isn’t specified. Don’t change the access time unless -a is also
specified.
-r ref_file Use the specified reference file’s modification time instead of the
current time.
-t time Use the specified time instead of the current time, where time is a
decimal number of the form:
[[CC]YY]MMDDhhmm[.SS]
The two-digit pairs in time represent the following:
CC The first two digits of the year (i.e. the century).

YY The second two digits of the year.
MM The month of the year (01-12).
DD The day of the month (01-31).
hh The hour of the day (00-23).
mm The minute of the hour (00-59).
SS The second of the minute (00-61).
Both CC and YY are optional. If you specify neither of these, the

current year is assumed. If you specify YY, but you don’t specify CC,
CC is derived as follows:

touch © 2010, QNX Software Systems GmbH & Co. KG.
If YY is: CC becomes:
69-99 19
00-68 20
The resulting time is affected by the value of the TZ environment

variable (see below). If the resulting time precedes 0 hours, 0 minutes,
0 seconds, January 1, 1970 Coordinated Universal Time (i.e. the
Epoch), touch exits immediately with an error status.
The range for SS is 00-61 rather than 00-59 to allow for leap seconds.
If SS is 60 or 61, and the resulting time — as affected by the TZ
environment variable — doesn’t refer to a leap second, the resulting
time is one second after a time where SS is 59. If you don’t give a value
to SS, it’s assumed to be 0.
file The pathname of a file whose times are to be modified.
Description:
The touch utility lets you change either the modification times or access times of
files, or both.
If any file you specify doesn’t exist, the file is created unless you specify the -c
option. If no time is specified, the current time is used. The -a option changes only
the access time of the file; the -m option changes only the modification time of the file.
If you don’t specify any options, touch behaves as if you used the -a and -m options.
Examples:
Set file1’s access and modification time to the current system time:
touch file1
Change file2’s access and modification time to be the same as file1’s modification
time:
touch -r file1 file2
Set file3’s access and modification time to December 25, 12:34, using the current
year:
touch -t 12251234 file3
TZ Specifies the local time for the specified time zone.

© 2010, QNX Software Systems GmbH & Co. KG. touch
Exit status:

tr © 2010, QNX Software Systems GmbH & Co. KG.
Translate characters (POSIX)
Syntax:
tr [-cs] [-r filename] string1 string2
tr [-cs] [-r filename] string1
tr -d [-c] [-r filename] string1
tr -ds [-c] [-r filename] string1 string2
Runs on:
Options:
-c Complement the set of characters in string1 with respect to the
universe of characters from 00 through FF hex. Characters in string1
are copied unchanged while all other characters are translated.
-d Delete all input characters in string1 (or not in string1 for -dc).
-r filename (QNX Neutrino extension) Translate the named file in place (don’t
use stdin/stdout).
-s Squeeze all output strings of one or more instances of a single

character in string1 to a single instance of the corresponding
character in string2.
If you don’t specify string2, tr squeezes instances of the characters
in string1 to a single instance of that character.
string1 Translation character string (translate from).
string2 Translation character string (translate to).
If you specify both -d and -s, tr deletes instances of the characters in string1 and
squeezes instances of the characters in string2 (i.e. tr doesn’t translate in this case).
Description:
The tr utility copies the standard input to the standard output with substitution or
deletion of selected characters. The options specified and the string1 and string2
operands control translations that occur while copying characters.
The default behavior is to replace each input character found in string1 with the
character at the same position in string2, while copying characters not in string1
unchanged.

© 2010, QNX Software Systems GmbH & Co. KG. tr
When string2 is shorter than string1, string2 is extended to the length of string1 by
duplicating the last character of string2. If string2 is explicitly a string of zero length,
it’s padded with NUL characters.
The string1 and string2 operands often require quoting to avoid interpretation by the
shell. Single quotes are usually the proper quoting mechanism.
Conventions for string1 and string2

Use the following conventions in string1 or string2 or both to specify characters,
character ranges, character classes, or collating elements:
character Represents that character.
\octal A backslash followed by 1, 2, or 3 octal digits represents a character

with that encoded value.
\character A backslash followed by any character except an octal digit represents

that character.
c-c Represents the range of characters between the range endpoints,

inclusive.
[c-c]
(QNX Neutrino extension) The System V method of representing a
range of characters.
[:class:] Represents all characters belonging to the defined character class.

Allowable names for class are:
alnum, alpha, blank, cntrl, digit, graph, lower, print,
punct, space, upper, xdigit
[.cs.] Represents a collating symbol. Multicharacter collating symbols must

be represented as collating symbols to distinguish them from a string
of the same characters. This implementation allows an arbitrary string
to be treated as a collating symbol (QNX Neutrino extension).
[x*n] Represents n repeated occurrences of the character or collating

symbol x. This expression is valid only in string2. If n is omitted or is
zero, it’s interpreted as large enough to extend the string2-based
sequence to the length of the string1-based sequence. If n has a
leading zero, it’s interpreted as an octal value. Otherwise, it’s
interpreted as a decimal value.
Examples:
Convert all lowercase characters in the input to the corresponding uppercase
characters:

tr © 2010, QNX Software Systems GmbH & Co. KG.
tr ’[:lower:]’ ’[:upper:]’ <file1 >file2
Or
tr ’[a-z]’ ’[A-Z]’ <file1 >file2
Create a list of all words in file1 one per line in file2 where a word is taken to be a
maximal string of letters (octal 012 is the code for newline):
tr -cs ’[:alpha:]’ ’[\012*]’ <file 1 >file2
Convert a DOS file into a UNIX file:
tr -d ’\15’ <infile >outfile
Exit status:
0 Success
See also:
gawk, sed, textto

© 2010, QNX Software Systems GmbH & Co. KG. tracelogger
Log tracing information into an event file
• You must be root to run this utility.
• In order to log trace events, your system must be running an instrumented version
of procnto (i.e. procnto*-instr).
Syntax:
tracelogger [-cEPRrw] [-A attribute] [-b num] [-d mode]
[-F num] [-f file] [-k num] [-M -S size]
[-n num] [-s num] [-v[v...]]
Runs on:
QNX Neutrino
Targets:
x86, PPC, SH-4, ARM, and MIPS
Options:
-A attribute Specify an attribute to add to the log. The attribute is in the form
name=value, where the name and value are arbitrary strings.
You can’t use the following in the name or value:

• ::
• TRACE_
• =
If you do, tracelogger prints a message and ignores the attribute.
You can use one or more occurrences of this option to add
information to identify the scenario that you’re logging. For example:
tracelogger -s1 -A MACHINE_NAME=tx86 -A PERIOD=1s
-b num The maximum number of dynamic buffers to allocate in

tracelogger; the default is 64. Each buffer has a size of
approximately 11 KB.
-c Operate in continuous mode; the default is to run in iterations mode.
-d mode Currently, the mode is:
1 (“One”) Launch in daemon mode. Unless you also specify the -E

option, tracelogger ignores all its other options,
leaving your application to configure, start, and stop the
tracing through calls to TraceEvent().

tracelogger © 2010, QNX Software Systems GmbH & Co. KG.
-E Extend the daemon (-d1) mode by honoring the other options to

tracelogger. Your application still needs to call TraceEvent() to
start capturing trace events.
-f file The name of the file to store logged events in. The default is
/dev/shmem/tracebuffer.kev.
-F num Filtering for different num values, as follows:
0 Don’t set any filtering.

1 Disable Kernel calls class.
2 Disable Interrupt class.
3 Disable Process class.
4 Disable Thread class.
5 Disable VThread class.
6 Disable Communication class.
7 Disable System class.
You can specify more than one filter by using multiple -F options. For
example, to disable both the Interrupt and VThread classes, specify
-F2 -F5. For more information about these classes, see the Events
and the Kernel chapter of the System Analysis Toolkit User’s Guide.
-k num The number of buffers to allocate in the kernel; the default is 32. Each
buffer has a size of approximately 16 KB.
-M Map the log file directly instead of writing. If you use this option, the
log file must be in shared memory, and you must use the -S option to
specify the maximum file size.
-n num The number of iterations to log in iterations mode. The default is 32;
specify 0 for unlimited iterations.
-P Preserve the kernel instrumentation buffers in a shared memory block

in /dev/shmem. If you specify this option, then when tracelogger
exits, it doesn’t deallocate the in-kernel buffer memory; you can then
specify the -R option on subsequent runs to make tracelogger
reuse the same buffers without reallocating memory.
-R Reuse the kernel instrumentation buffers that were previously created

when you used the -P option. If there are no buffers to reuse,
tracelogger allocates the kernel buffers as usual.
-r Set the kernel buffer to ring mode. The default is linear mode.
-s num The number of seconds to log for. The default is 0, specifying an

unlimited duration.

© 2010, QNX Software Systems GmbH & Co. KG. tracelogger
-S size The maximum size of the log file. Use M for megabytes or K for
kilobytes. If you don’t use M or K, the units are assumed to be bytes.
You must specify this option if you use the -M option.
-v[v...] Be verbose; more v characters cause more verbosity.

-w Log wide events; the default is to log fast events.
Description:
The tracelogger daemon receives events from the instrumented kernel
(procnto*-instr) and saves them in a file or on a device for later analysis. By
default, tracelogger saves the events in /dev/shmem/tracebuffer.kev. The
.kev extension is short for “kernel events”; the Integrated Development Environment
opens files with this extension in the System Profiler.
You can run tracelogger in the following modes:
-n iterations The kernel logs events; tracelogger captures iterations buffers

worth of data, and then terminates. This is the default, and iterations
defaults to 32.
-r Ring mode: the kernel logs events, but tracelogger doesn’t

capture them until it gets a SIGINT signal, or an application calls
TraceEvent() with a command of _NTO_TRACE_STOP.
-d1 Daemon mode: the kernel doesn’t log events, and tracelogger
doesn’t capture them, until an application calls TraceEvent() with a
command of _NTO_TRACE_START. Logging continues until an
application calls TraceEvent() with a command of
_NTO_TRACE_STOP, or you terminate tracelogger.
-s seconds The kernel logs events; tracelogger captures them over the
specified time.
-c The kernel logs events; tracelogger captures them, and continues

to do so until terminated.
The simplest way to configure the tracing is to start tracelogger in normal or

extended daemon (-d1 -E) mode, using the command-line options to specify what to
trace. In this case, tracelogger performs all initialization and runtime control of the
instrumentation module in addition to its normal task of saving the trace buffers to the
filesystem. If you use extended daemon mode, your application needs to call
TraceEvent() to start capturing trace events.
For finer (and more flexible) control of the instrumentation, run tracelogger in
daemon (-d1) mode, and call TraceEvent() from your application to specify what to
trace, and when to start and stop tracing. Except for specifying the number of buffers,
tracelogger doesn’t perform any initialization of the instrumentation module, and
its almost exclusive task is to log the “received” trace events to the filesystem.

tracelogger © 2010, QNX Software Systems GmbH & Co. KG.
CAUTION: On a multicore system, if the clocks on all processors aren’t

! synchronized, then tracelogger will produce data with inconsistent timestamps,
and the IDE won’t be able to load the trace file. The IDE attempts to properly order
the events in the trace file, and this can go awry if the timestamp data is incorrect.
The traceprinter utility doesn’t have any issues with such traces because it doesn’t
attempt to reorder the data and interpret it; it simply dumps the contents of each event.
Examples:
Start tracelogger in wide mode and display operational information on the console
screen; store the logged data in the named file and stop logging when 12 trace buffers
are full:
#tracelogger -f /dev/shmem/my_tracebuffer.kev -n 12 -w
Start tracelogger in ring mode (background) using 5 internal buffers and wait for
an asynchronous signal (e.g. Ctrl-C) to stop it:
#tracelogger -r -b 5
Run tracelogger in continous mode for 20 seconds:
tracelogger -c -s20
Exit status:
Errors:
Severe errors cause tracelogger to terminate.
Caveats:
Run only one instance of tracelogger at a time. Similarly, don’t run tracelogger
and use qconn (under control of the IDE) to trace events at the same time.
See also:
procnto*-instr, qconn, traceprinter
TraceEvent() in the QNX Neutrino Library Reference
Analyzing Your System with Kernel Tracing chapter of the IDE User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. traceprinter
Display the contents of the instrumented kernel trace file
Syntax:
traceprinter [-nv] [-f file] [-o out_file]
Runs on:
Options:
-f file The filename of the file that stores the trace information to be
displayed. The default is /dev/shmem/tracebuffer.
-n Remove newline characters from printed argument lines.
-o out_file The name of the file in which to store the data. By default,
traceprinter sends its output to stdout.
-v Display detailed information.
Description:
The traceprinter utility displays the contents of a trace file generated by
tracelogger. The utility parses the linearly stored time events stored in the named
trace file and sends the resulting formatted stream to standard output (or to the file
identified by the -o option).
The formatted stream looks like this:
t:clk_time CPU:cpu [class: event: [P1: [P2: [P3: ... [Pn:]]]]]
The stream always shows the clk_time and cpu variables; the variables in brackets are
optional.
clk_time The time offset in CPU clock cycles when the trace event was
registered. The 64-bit variable is broken into two 32-bit
hexadecimal numbers (msb and lsb). Apart from at the start of
the trace and when the lsb rolls over, only the lsb number is
shown.
cpu A 2-digit decimal number representing the CPU that registered

the event. The variable is always 00 unless you have more than
one CPU in your system: if you have four CPUs, the CPU
numbers range from 00 to 03. The CPU numbers are assigned
to particular CPUs during initialization, when the startup
programs probe the system (see procnto*).
Optional variables The other variables are optional, depending on the tracing
information logged. The class and event variables are followed

traceprinter © 2010, QNX Software Systems GmbH & Co. KG.
by parameter variables, the number and type of parameters

depend on the associated class/event pair and whether
tracelogger used the fast or wide emitting mode. Each trace
line contains one class, one or no event, and one or more
parameter variables. The table below explains which
parameters are shown for each combination of class and event.
Class Event Parameters

CONTROL TIME P1 - msb
P2 - lsb (offset)
INT_ENTR INT_EXIT interrupt number in hexadecimal (and P1 - inkernel
decimal) notation
THREAD THDEAD P1 - PID
THRUNNING P2 - thread ID
THREADY
THSTOPPED
THSEND
THRECEIVE
THREPLY
THSTACK
THWAITTHREAD
THWAITPAGE
THSIGSUSPEND
THSIGWAITINFO
THNANOSLEEP
THMUTEX
THCONDVAR
THJOIN
THINTR
THSEM
THWAITCTXN
THNET_SEND
THNET_REPLY
THCREATE
THDESTROY
continued. . .

Class Event Parameters

VTHREAD VTHDEAD P1 - PID
VTHRUNNING P2 - vthread ID
VTHREADY
VTHSTOPPED
VTHSEND
VTHRECEIVE
VTHREPLY
VTHSTACK
VTHWAITVTHREAD
VTHWAITPAGE
VTHSIGSUSPEND
VTHSIGWAITINFO
VTHNANOSLEEP
VTHMUTEX
VTHCONDVAR
VTHJOIN
VTHINTR
VTHSEM
VTHWAITCTXN
VTHNET_SEND
VTHNET_REPLY
VTHCREATE
VTHDESTROY
PROCESS PROCCREATE P1 - parent PID
PROCCREATE_NAME P2 - PID
PROCDESTROY P3 - process name (optional)
PROCDESTROY_NAME
KER_CALL kernel call name P1 - kernel call number
P2, P3, ... Pn - kernel call arguments
KER_EXIT kernel call name P1 - kernel call number
P2, P3, ... Pn - kernel call return values
The number of arguments and return values depends on the event and whether the
trace file was produced using fast or wide tracing mode. For more information, see the
Current Trace Events and Data appendix of the System Analysis Toolkit User’s Guide.
Examples:
Here’s an example of the first few lines of output from traceprinter:
TRACEPRINTER version 0.94

-- HEADER FILE INFORMATION --
TRACE_FILE_NAME:: /scratch/quadlog
TRACE_DATE:: Fri Jun 8 13:14:40 2001
TRACE_VER_MAJOR:: 0
TRACE_VER_MINOR:: 96
TRACE_LITTLE_ENDIAN:: TRUE

traceprinter © 2010, QNX Software Systems GmbH & Co. KG.
TRACE_ENCODING:: 16 byte events

TRACE_BOOT_DATE:: Fri Jun 8 04:31:05 2001
TRACE_CYCLES_PER_SEC:: 400181900
TRACE_CPU_NUM:: 4
TRACE_SYSNAME:: QNX
TRACE_NODENAME:: x86quad.gp.qa
TRACE_SYS_RELEASE:: 6.1.0
TRACE_SYS_VERSION:: 2001/06/04-14:07:56
TRACE_MACHINE:: x86pc
TRACE_SYSPAGE_LEN:: 2440
-- KERNEL EVENTS --
t:0x1310da15 CPU:01 CONTROL :TIME msb:0x0000000f, lsb(offset):0x1310d81c
t:0x1310e89d CPU:01 PROCESS :PROCCREATE_NAME
ppid:0
pid:1
name:./procnto-smp-instr
t:0x1310eee4 CPU:00 THREAD :THCREATE pid:1 tid:1
t:0x1310f052 CPU:00 THREAD :THRUNNING pid:1 tid:1
t:0x1310f144 CPU:01 THREAD :THCREATE pid:1 tid:2
t:0x1310f201 CPU:01 THREAD :THREADY pid:1 tid:2
t:0x1310f32f CPU:02 THREAD :THCREATE pid:1 tid:3
t:0x1310f3ec CPU:02 THREAD :THREADY pid:1 tid:3
t:0x1310f52d CPU:03 THREAD :THCREATE pid:1 tid:4
t:0x1310f5ea CPU:03 THREAD :THRUNNING pid:1 tid:4
t:0x1310f7ee CPU:02 THREAD :THRECEIVE pid:1 tid:5
t:0x1310f9de CPU:03 THREAD :THRECEIVE pid:1 tid:6
t:0x1310fb0b CPU:01 THREAD :THCREATE pid:1 tid:7
t:0x1310fbc8 CPU:01 THREAD :THRECEIVE pid:1 tid:7
t:0x1310fd1d CPU:02 THREAD :THCREATE pid:1 tid:8
t:0x1310fdda CPU:02 THREAD :THRECEIVE pid:1 tid:8
t:0x1310ff35 CPU:02 THREAD :THCREATE pid:1 tid:9
t:0x1310fff2 CPU:02 THREAD :THRECEIVE pid:1 tid:9
t:0x131100cc CPU:01 THREAD :THCREATE pid:1 tid:10
t:0x13110189 CPU:01 THREAD :THRECEIVE pid:1 tid:10
t:0x131102d5 CPU:03 THREAD :THCREATE pid:1 tid:11
t:0x13110392 CPU:03 THREAD :THRECEIVE pid:1 tid:11
t:0x1311084d CPU:01 PROCESS :PROCCREATE_NAME
ppid:1
pid:2
name:proc/boot/slogger
t:0x13110c13 CPU:03 THREAD :THCREATE pid:2 tid:1
t:0x13110ce0 CPU:03 THREAD :THRECEIVE pid:2 tid:1
Exit status:
Errors:
Severe errors cause traceprinter to terminate; noncatastrophic errors are displayed
in verbose mode (if the -v option is set).

Caveats:
You must run tracelogger before running traceprinter. The tracelogger
utility creates an event file containing trace data; traceprinter parses and prints the
data in this file.
See also:
tracelogger

traceroute © 2010, QNX Software Systems GmbH & Co. KG.
Print the route packets take to network host
Syntax:
traceroute [-DdFIlnPrvx] [-a | -A as_server] [-f first_ttl]
[-g gateway] [-i iface] [-m max_ttl]
[-p port] [-q nqueries] [-s src_addr]
[-t tos] [-w wait_time] host [packetsize]
Runs on:
Neutrino
Options:
-A as_server Turn on AS lookups and use the given server instead of the default.
-a Turn on AS lookups for each hop encountered.
-D Dump the packet data to standard error before transmitting it.
-d Turn on socket-level debugging.
-F Set the “don’t fragment” bit.
-f first_ttl Set the initial time-to-live used in the first outgoing probe packet.
-g gateway Specify a loose source route gateway (8 maximum).
-I Use ICMP ECHO instead of UDP datagrams.
-i iface Specify a network interface to obtain the source IP address for

outgoing probe packets. This is normally only useful on a
multi-homed host. (See -s for an alternative way to do this.)
-l (“el”) Display the TTL (time-to-live) value of the returned packet.

This is useful for checking for asymmetric routing.
-m max_ttl Set the maximum TTL (maximum number of hops) used in

outgoing probe packets. The default is 30 hops (the same default as
is used for TCP connections).
-n Print hop addresses numerically only. By default, addresses are

printed both symbolically and numerically. This option saves a
nameserver address-to-name lookup for each gateway found on the
path.
-P Set the “don’t fragment” bit and use the next hop MTU each time a
“need fragmentation” error is received, thus probing the path MTU.
-p port The base UDP port number to be used in probes (default is 33434).
The traceroute utility hopes that nothing is listening on UDP
ports base to base + nhops -1 at the destination host (so an ICMP

© 2010, QNX Software Systems GmbH & Co. KG. traceroute
PORT_UNREACHABLE message is returned to terminate the

route tracing). If something is listening on a port in the default
range, you can use this option to pick an unused port range.
-q nqueries The number of probes per ttl to nqueries (default is three probes).

error is returned. You can use this option to “ping” a local host
through an interface that has no route through it (for example, after
the interface was dropped by routed).
-s src_addr The IP address (must be given as an IP number, not a hostname) to

be used as the source address in outgoing probe packets. If the host
has more than one IP address, you can use this option to force the
source address to be something other than the IP address of the
interface that the probe packet is sent on. If the IP address you
specify isn’t one of this machine’s interface addresses, an error is
returned and nothing is sent.
-t tos The type-of-service (TOS) to be used in probe packets (default is

zero). The value must be a decimal integer in the range 0 to 255.
You can use this option to see if different TOSs result in different
paths.
Not all TOS values are legal or meaningful. You should find the
values -t 16 (low delay) and -t 8 (high throughput) useful.
-v Be verbose. Received ICMP packets other than

TIME_EXCEEDED and UNREACHABLEs are listed.
-w wait_time The time (in seconds) to wait for a response to a probe (default is 5).
-x Toggle checksums. Normally, this prevents traceroute from

calculating checksums. In some cases, the operating system can
overwrite parts of the outgoing packet but not recalculate the
checksum (so in some cases the default is to not calculate
checksums and using -x causes them to be calcualted). Note that
checksums are usually required for the last hop when using ICMP
ECHO probes (-I).
host The destination hostname or IP number.
packetsize The probe datagram length (default is 40 bytes).
Description:
The Internet is a large and complex aggregation of network hardware, connected
together by gateways. Tracing the route your packets follow — or finding the gateway
that’s discarding your packets — can be difficult. The traceroute utility uses the IP

protocol “time-to-live” field and attempts to elicit an ICMP TIME_EXCEEDED

response from each gateway along the path to a host.
This utility attempts to trace the route an IP packet follows to an Internet host, by
launching UDP probe packets with a small ttl (time to live) and then listening for an
ICMP TIME_EXCEEDED reply from a gateway. Probes are started with a TTL of
one and increase by one until an ICMP PORT_UNREACHABLE — which means
you got to the host — is encountered or a maximum is reached. By default, this
maximum is 30 hops; you can change it with the -m option.
Three probes (you can change the number with the -q option) are sent at each TTL
setting and a line is printed showing the TTL, the address of the gateway, and the
roundtrip time of each probe. If the answers come from different gateways, the address
of each responding system is printed. If there’s no response within a 5-second timeout
interval (which you can change with the -w option), a * is printed for that probe.
Since the destination host shouldn’t process the UDP probe packets, the destination
port is set to an unlikely value. If someone on the destination is using that value, you
can change it with -p.
Here’s a sample use and output:
% traceroute nis.nsf.net.
traceroute to nis.nsf.net (35.1.1.48), 30 hops max, 56 byte packet
1 helios.ee.lbl.gov (128.3.112.1) 19 ms 19 ms 0 ms
2 lilac-dmc.Berkeley.EDU (128.32.216.1) 39 ms 39 ms 19 ms
4 ccngw-ner-cc.Berkeley.EDU (128.32.136.23) 39 ms 40 ms 39 ms
5 ccn-nerif22.Berkeley.EDU (128.32.168.22) 39 ms 39 ms 39 ms
6 128.32.197.4 (128.32.197.4) 40 ms 59 ms 59 ms
7 131.119.2.5 (131.119.2.5) 59 ms 59 ms 59 ms
8 129.140.70.13 (129.140.70.13) 99 ms 99 ms 80 ms
9 129.140.71.6 (129.140.71.6) 139 ms 239 ms 319 ms
10 129.140.81.7 (129.140.81.7) 220 ms 199 ms 199 ms
11 nic.merit.edu (35.1.1.48) 239 ms 239 ms 239 ms
Note that lines 2 and 3 are the same. This is due to a buggy kernel on the second hop
system (lbl-csam.arpa), that forwards packets with a zero TTL (a bug in the
distributed version of 4.3 BSD). Note that you have to guess what path the packets are
taking cross-country since the NSFNet (129.140) doesn’t supply address-to-name
translations for its NSSs.
This example is more interesting:
% traceroute allspice.lcs.mit.edu.
traceroute to allspice.lcs.mit.edu (18.26.0.115), 30 hops max

© 2010, QNX Software Systems GmbH & Co. KG. traceroute
6 128.32.197.4 (128.32.197.4) 59 ms 119 ms 39 ms
7 131.119.2.5 (131.119.2.5) 59 ms 59 ms 39 ms
8 129.140.70.13 (129.140.70.13) 80 ms 79 ms 99 ms
9 129.140.71.6 (129.140.71.6) 139 ms 139 ms 159 ms
10 129.140.81.7 (129.140.81.7) 199 ms 180 ms 300 ms
11 129.140.72.17 (129.140.72.17) 300 ms 239 ms 239 ms
12 * * *
13 128.121.54.72 (128.121.54.72) 259 ms 499 ms 279 ms
14 * * *
15 * * *
16 * * *
17 * * *
18 ALLSPICE.LCS.MIT.EDU (18.26.0.115) 339 ms 279 ms 279 ms
The gateways that are 12, 14, 15, 16, and 17 hops away either don’t send ICMP “time
exceeded” messages or send the messages with a TTL that’s too small to reach you.
Gateways 14 to 17 are running the MIT C Gateway code that doesn’t send “time
exceeded”s. The silent gateway 12 may be the result of a bug in the 4.[23] BSD
network code (and its derivatives): versions 4.3 or earlier send an unreachable
message using whatever TTL remains in the original datagram. Since for gateways the
remaining TTL is zero, the ICMP time exceeded is guaranteed to not make it back to
you. The behavior of this bug is slightly more interesting when it appears on the
destination system:
6 csgw.Berkeley.EDU (128.32.133.254) 39 ms 59 ms 39 ms
7 * * *
8 * * *
9 * * *
10 * * *
11 * * *
12 * * *
13 rip.Berkeley.EDU (128.32.131.22) 59 ms ! 39 ms ! 39 ms !
Notice that there are 12 “gateways” (13 is the final destination) and that exactly the
last half of them are missing. What’s really happening is that rip (a Sun-3 running
Sun OS3.5) is using the TTL from your arriving datagram as the TTL in its ICMP
reply. So, the reply timeouts on the return path (with no notice sent to anyone since
ICMPs aren’t sent for ICMPs) until you probe with a TTL that’s at least twice the path
length. That is, rip is really only 7 hops away. A reply that returns with a TTL of 1 is
a clue that this problem exists.
The traceroute utility prints a ! after the time if the TTL is less than or equal to 1.
Since vendors ship a lot of obsolete (DECs Ultrix, Sun3.x) or nonstandard (HPUX)
software, expect to see this problem frequently and/or take care when picking the
target host of your probes. Other possible annotations after the time are:
!F Fragmentation needed.

!H Host unreachable.
!N Network unreachable.
!<N> ICMP unreachable code N.
!P Protocol unreachable.
!S Source route failed.
!X Communication prohibited by the administrator.
Neither !S nor !F should ever occur — the associated gateway is broken if you see
one. If almost all the probes result in some kind of unreachable, traceroute gives
up and exits.
Intended for use in network testing, measurement, and management, traceroute
should be used primarily for manual fault isolation. Because of the load it could
impose on the network, you shouldn’t use traceroute during normal operations or
from automated scripts.
Files:
The traceroute utility requires the libsocket.so shared library.
Implemented by Van Jacobson from a suggestion by Steve Deering. Debugged by
others with suggestions and fixes from C. Philip Wood, Tim Seaver, and Ken Adelman.
See also:
netstat, ping

© 2010, QNX Software Systems GmbH & Co. KG. traceroute6
Print the route IPv6 packets take to the destination
Syntax:
traceroute6 [-dIlnrv] [-f firsthop] [-g gateway]
[-m hoplimit] [-p port] [-q probes] [-s src]
[-w waittime] target [datalen]
Runs on:
Neutrino
Options:
-d Enable debugging.
-f firsthop Specify how many hops to skip in the trace.
-g gateway Specify the intermediate gateway (traceroute6 uses the routing

header).
-I Use ICMP ECHO instead of UDP datagrams.
-l (“el”) Print both the host hostnames and numeric addresses (normally,
only hostnames are printed; or, if -n is specified, only numeric
addresses).
-m hoplimit Specify the maximum hoplimit.
-n Don’t resolve the numeric address to a hostname.
-p port Set the UDP port number to port.
-q probes Set the number of probes per hop count to probes.

error is returned. You can use this option to “ping” a local host
through an interface that has no route through it (for example, after
the interface was dropped by routed).
-s src Use this source IPv6 address.
-v Be verbose.
-w waittime Specify the delay time between probes.
target The destination hostname or IP number.
datalen Increase the packet size by this amount. By default, the size is zero
and no data is sent.

traceroute6 © 2010, QNX Software Systems GmbH & Co. KG.
Description:
This utility prints the route that the IPv6 packets take to the destination. For more
information, see traceroute.
Exit status:
See also:
ping, ping6, traceroute

© 2010, QNX Software Systems GmbH & Co. KG. true
Return true value (POSIX)
Syntax:
true
Runs on:
Options:
None.
Description:
The true utility does nothing but exit immediately with a zero exit code.
The true utility is typically used in shell scripts. One common application is to create
an infinite loop, as in:
while true
do
myprogram
sleep 300
done
which runs myprogram every five minutes (300 seconds) until the shell script is
interrupted.
The shell has a builtin true command; see ksh. To make sure you use the executable,
specify the full path.
Exit status:
0
See also:
false, ksh

tsort © 2010, QNX Software Systems GmbH & Co. KG.
Perform a topological sort of a directed graph (POSIX)
Syntax:
tsort [-l] [-q] [file]
Runs on:
QNX Neutrino
Options:
-l Search for and display the longest cycle. This can take a very long time.
-q Don’t display informational messages about cycles. This is primarily intended

for building libraries, where optimal ordering isn’t critical, and cycles occur
often.
Description:
The tsort utility takes a list of pairs of node names representing directed arcs in a
graph and prints the nodes in topological order on standard output. Input is taken from
the named file, or from standard input if no file is given.
Node names in the input are separated by white space, and there must be an even
number of node names.
The presence of a node in a graph can be represented by an arc from the node to itself.
This is useful when a node isn’t connected to any other nodes.
If the graph contains a cycle (and therefore cannot be properly sorted), one of the arcs
in the cycle is ignored, and the sort continues. Cycles are reported on standard error.
NetBSD
See also:
sort

© 2010, QNX Software Systems GmbH & Co. KG. tty
Return the user’s terminal name (POSIX)
Syntax:
tty [-s]
Runs on:
Neutrino
Options:
-s Be silent; don’t output the terminal name. This option is useful if you’re
concerned only with tty’s exit status.
Description:
The tty utility writes to the standard output the name of the terminal that’s open as
standard input. If standard input isn’t a terminal (e.g. it’s a file such as /dev/null),
the string not a tty is output instead.
The -s option is deprecated by POSIX; you can achieve the effect of this option,
simply and portably, by redirecting output to /dev/null or by using the shell builtin,
test -c.
Examples:
The following command prints /dev/con1 if run on console 1:
tty
The following command prints not a tty because /dev/null causes isatty() to
return 0:
tty </dev/null
Exit status:
0 Success.

uesh © 2010, QNX Software Systems GmbH & Co. KG.
Micro-embedded shell (QNX Neutrino)
Syntax:
uesh [script_file]
Runs on:
Neutrino
Options:
Description:
The uesh utility provides a subset of the functionality found in the standard embedded
shell, esh. You should find uesh useful for situations where memory requirements are
limited. For example, you could use it to run a simple system initialization file for an
embedded system.
The micro-embedded shell has some very significant limitations:
• no pipes
• no aliases
• no filename- or command-completion
• no set command
For applications that require greater functionality, use esh or the full shell, sh.
Command-line format
In uesh, command lines take this form:
command arg1 arg2 ... [redir-op file] [&]
Where:
command The command to be executed. If it doesn’t start with a slash, the

command follows the path set by the PATH environment variable.
redir-op file A redirection operator. When a command is invoked, three standard

files are set up in its environment. These files, standard input,
standard output, and standard error output (stdin, stdout, stderr), are
usually attached to the active terminal. You can redirect a command’s
standard input, standard output, and standard error as follows:

© 2010, QNX Software Systems GmbH & Co. KG. uesh
Specifying: Will:
<file redirect standard input from this file.
>file Redirect standard output to this file. If the file exists, it’s
overwritten; if the file doesn’t exist, it’s created.
>>file Redirect standard output to this file. If the file exists, the
information is appended to the end of the file; if the file
doesn’t exist, it’s created.
2>file Do the same as >file, but for standard error.
2>>file Do the same as >>file, but for standard error.
& If a command contains an unquoted &, then uesh
doesn’t wait for the command to complete execution but
immediately moves on to process the next command.
The standard input of the command is redirected from
/dev/null, and SIGINT and SIGQUIT are ignored.
Filename expansion
The uesh shell doesn’t support filename expansion. Such shorthands as *.c for all
files ended in .c don’t work.
Quoting
The following characters have a special meaning in uesh:
& \ " [ space
To suppress the special meaning of these characters and keep their literal meaning, use
quoting.
To quote a sequence of characters or sequence of words, enclose the sequence in
double quotes. To quote a single character, use double quotes or precede it with the
escape character (\).
Escape character (backslash)

The escape character (\) preserves the literal meaning of the next
character. You can’t obtain a single backslash by quoting \ with
double quotes. To obtain a backslash, enter \\ instead.
Double quotes Enclosing characters and words in double quotes ("") preserves the
literal meaning of all characters within double quotes, with the
exception of the \ character. For example:
"ab cd"
represents a single, five-character argument.
You can keep the literal meaning of a double quote with the \
character. For example:

ab\"cd
represents the single, five-character argument ab"cd.
Builtin commands
The following commands are built into uesh (that is, uesh interprets and executes
them internally):
• cd
• emount
• ewaitfor
• exec
• exit
• export
cd command
cd [directory]
Change the working directory of the current execution environment. If directory isn’t
specified, the value of the HOME environment variable becomes the new working
directory.
emount command
emount special directory [fs_type]
Mount a special device. The arguments are:
mountpoint Where to mount the device on your system.

cd fs-cd.so
cifs fs-cifs
dos fs-dos.so
ext2 fs-ext2.so
mac fs-mac.so
continued. . .

© 2010, QNX Software Systems GmbH & Co. KG. uesh

nt fs-nt.so
qnx4 fs-qnx4.so
qnx6 fs-qnx6.so
udf fs-udf.so
The default is qnx4.
The emount command was implemented in QNX Momentics 6.3.0 Service Pack 2.
ewaitfor command
ewaitfor path [max_seconds [delay]]
Wait until the given path exists. The arguments are:
path The path to test.
max_seconds The maximum number of seconds to wait for the file to appear. The
default is 1 second.
delay The number of milliseconds to wait between attempts. The default

is 100 ms.
The ewaitfor command was implemented in QNX Momentics 6.3.0 Service Pack 2.
exec command
exec [command [argument...]]
Execute a command and/or manipulate file descriptors.

The exec command opens, closes, or copies file descriptors as specified by any I/O
redirections given as part of argument. If a command is specified, that command is
spawned as a replacement for uesh. Any specified arguments are passed to the
spawned process.
exit command
exit [n]
Cause uesh to exit with the exit status specified by n. If n isn’t specified, uesh exits
with the status of the last command executed.

export command
export name[=word]...
export -p
Mark environment variables for export, which causes them to be in the environment of
subsequently executed commands. If you specify the -p option, the names and values
of all exported variables are written to the standard output.
Examples:
Invoke uesh:
uesh
HOME The pathname of the user’s home directory
LOGNAME The user’s login name.
PATH The directory search path used by uesh for locating executable
programs. To change PATH, you must use the export command.
If PATH isn’t in the existing environment when uesh is invoked, it’s
set to /bin:/usr/bin. For more information on setting PATH, see
“Setting PATH and LD_LIBRARY_PATH” in the Configuring
Your Environment chapter of the Neutrino User’s Guide.
SHELL The pathname of the user’s preferred shell.
TMPDIR The pathname of a directory where utilities can create temporary

files.
TZ The timezone setting.
See also:
esh, fesh, ksh, rsh, sh
“Setting PATH and LD_LIBRARY_PATH” in the Configuring Your Environment
chapter of the Neutrino User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. umask
Get or set the file mode creation mask (POSIX)
Syntax:
umask [-o|-s|mask]
Runs on:
Neutrino
Options:
-o Display the current mask, in octal.
-s Display the current mask in symbolic form. This is the default output.
mask Set the file mode creation mask to mask, which you can specify either as an
octal number or as a symbolic representation.
If you specify the mask in octal form, it replaces the current file mode
creation mask. Every bit that’s set describes a mode bit that won’t be allowed
in the file mode of created files. In other words, it says: “mask this bit off.”
The symbolic form of the mask is an expression that modifies or replaces the
current file mode creation mask. The form of the symbolic mask is similar to
that of the mode operand for the chmod utility:
[[augo] [+|-|=] [rwx]] [,symbolic_mask]
Where:
a User, group, and other access.

u User access.
g Group access.
o Other access.
+ Add these permissions to the current mask.
- Remove these permissions from the current mask.
= Replace the current mask with these permissions.
r Read permission.
w Write permission.
x Execute permission.
Once the symbolic mask expression has been applied to the current file
mode creation mask, any occurrence of [r,w, x] describes a mode bit that is
allowed in the file mode of created files. The absence of a symbol means that
permission isn’t allowed and is masked “off.”

umask © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The umask utility sets the file mode creation mask of the invoking process to the value
specified by the mask operand. The file mode creation mask affects the initial value of
the file permission bits of subsequently created files when no mode is specified.
When files are created without specifying the permission mode bits, the filesystem
assigns default permissions of 0777 (rwxrwxrwx) to directories and executable files,
thereby giving read, write, and execute privileges for user, group, and others. For files
that aren’t executable, permissions of 0666 (rw-rw-rw-) are assigned. The umask
utility is used to adjust these defaults.
The file mode creation mask is inherited by any children of the current process.
You can use either of the display forms (-o or -s) as the mask operand to a
subsequent invocation of umask.
As in the chmod utility, the use of the octal number form of mask values is deprecated.
The shell has a builtin umask command; see ksh. To make sure you use the
executable, specify the full path.
Examples:
1 Set mask to allow read, write, and execute, for user, group, and others:
$ umask a=rwx
Display the current file creation mode mask in symbolic form:

$ umask -s
u=rwx, g=rwx, o=rwx
Display the current file creation mode mask in octal:

$ umask -o
00
2 Specify that no permissions for group and others be allowed; set the mask to
allow only read and write for user only:
$ umask u=rw

$ umask
u=rw,g=,o=

$ umask -o
0177
3 Add read permissions for group and others:

$ umask go+r

© 2010, QNX Software Systems GmbH & Co. KG. umask

$ umask
u=rw,g=r,o=r

$ umask -o
0133
Exit status:
0 The file mode creation mask was successfully changed, or no mask operand
was supplied.
>0 An error occurred. The process’s file mode creation mask isn’t changed.
See also:
chmod, ksh

umount © 2010, QNX Software Systems GmbH & Co. KG.
Unmount a device
Syntax:
umount [-f] path [path ...]
Runs on:
Neutrino
Options:
-f Force an unmount, even if the device is busy.
path The root mountpoint to be unmounted.
Description:
This utility unmounts the devices that were mounted as the given paths.
If a device is busy (for example, if a file is open), umount fails. You can force the
device to be unmounted by specifying the -f option.
See also:
mount

© 2010, QNX Software Systems GmbH & Co. KG. uname
Return the name of the operating system (POSIX)
Syntax:
uname [-amnprsv] [-S name]
Runs on:
Options:
-a Behave as if the options -snrvmp were specified.
-m Write the name of the hardware type on which the system is running.
-n Write the name of this node.
-p Write the processor name.
-r Write the current release level of the operating system (indicated by a

number).
-S name Set the host name.
-s Write the name of the operating system.
-v Write the current version level of this release of the operating system
(indicated by a timestamp).
Description:
The uname utility writes to standard output information on the name and release of the
operating system being run. A portable application may use uname on any POSIX
system to determine what operating system it’s running under.
If you don’t specify any options, uname writes the operating system name (QNX).
Examples:
Write the operating system name:
uname
Write a formatted string showing the name, release level, and version level of the
operating system:
printf "OS: %s release %s version %s\n" $(uname -srv)

uname © 2010, QNX Software Systems GmbH & Co. KG.
Exit status:
0 Success
Caveats:
The pidin utility provides more detailed information than uname, but pidin is a
QNX Neutrino utility and isn’t present on other systems.
See also:
pidin
uname() in the Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. unexpand
Convert spaces to tabs (POSIX)
Syntax:
unexpand [-a] [-t tabsize] [file...]
Runs on:
Neutrino
Options:
-a In addition to the default behavior of replacing leading spaces, translate
two to eight consecutive spaces immediately preceding a tab stop into a
tab. A tab stop is a column position that’s a multiple of eight column
positions.
-t tabsize (QNX Neutrino extension) Set the tab stops tabsize columns apart
(default is 8). The tabsize argument consists of a single positive
decimal integer.
file The pathname of a text file to be used as input.
Description:
The unexpand utility copies files or the standard input to the standard output,
translating each group of eight spaces at the beginning of a line into a tab character.
Any backspace characters in the input are copied to the output, and each causes the
column position count for tab calculations to be decremented; the count is never
decremented below zero.
Examples:
For the file sourcecode, convert every run of eight spaces at the beginning of a line
into a single tab:
unexpand sourcecode
Convert every run of two to eight spaces that precedes a tab stop into a single tab:
unexpand -a sourcecode
Convert every run of two to four spaces that precedes a tab stop into a single tab:
unexpand -a -t4 sourcecode
Exit status:

unexpand © 2010, QNX Software Systems GmbH & Co. KG.
See also:
expand

© 2010, QNX Software Systems GmbH & Co. KG. unifdef
Remove ifdef’ed C/C++ lines
Syntax:
unifdef [-l] [-t] [-c] [[-Dsym] [-Usym] [-iDsym] [-iUsym]]... [file]
Runs on:
QNX Neutrino
Options:
-Dsym -Usym Specify which symbols to define or undefine respectively. The
lines inside those ifdefs are copied to the output or removed as
appropriate. The ifdef, ifndef, else, and endif lines
associated with sym are also removed. If an ifdef X occurs
nested inside another ifdef X, then the inside ifdef is treated
as if it were an unrecognized symbol.
-c Cause the operation to be complemented, i.e. the lines that would

have been removed or blanked are retained and vice versa.
-l Replace removed lines with blank lines instead of deleting them.
-t Disable parsing for C/C++ comments and quotes, which is useful

for plain text.
-iDsym -iUsym Ignore the specified ifdefs. Specifies which ifdef symbols to
parse or not to parse for quotes and comments inside
respectively. Parsing is done by default, and the -t option
overrides these options.
Description:
The unifdef utility removes ifdef’ed lines from C or C++ code. You must specify
at least one of -D, -U, -iD, and -iU. This utility copies output to stdout, and takes its
input from stdin if you don’t specify a file argument.
See also:
indent

uniq © 2010, QNX Software Systems GmbH & Co. KG.
Report or filter out repeated lines in a file (POSIX)
Syntax:
uniq [-c] [-d|-u] [-f fields] [-s chars]
[input_file [output_file]]
Deprecated syntax:
uniq [-c] [-d|-u] [-n] [+m]

[input_file [output_file]]
Runs on:
Neutrino
Options:
-n (deprecated, replaced by -f) Ignore the first n fields when doing
comparisons, where n is a number.
+m (deprecated, replaced by -s) Ignore the first m characters when doing

comparisons, where m is a number.
-c Precede each output line with the number of times the line occurred in
the input.
-d Suppress the writing of lines that aren’t repeated in the input.
-f fields Ignore the first fields on each input line when doing comparisons,
where fields is a positive decimal integer. A field is a string of
nonblank characters separated from adjacent fields by blanks.
-s chars Ignore the first chars characters when doing comparisons, where chars
is a positive decimal integer. If specified in conjunction with the -f
option, the first chars characters after the first fields fields are ignored.
-u Suppress the writing of lines that are repeated in the input.
input_file The pathname of the input file. If you don’t specify any input files, the
output_file The pathname of the output file. This name must differ from the name
of the input file. If you don’t specify an output file, the standard
output is used.
Description:
The uniq utility reads an input text file, comparing adjacent lines, and writes one copy
of each input line to the output. The second and succeeding copies of repeated
adjacent input lines aren’t written.

© 2010, QNX Software Systems GmbH & Co. KG. uniq
To obtain a report of unique lines in a file, the input file must be sorted prior to running
uniq.
Examples:
Look for repeated adjacent lines in datfile:
uniq datfile
LC_TYPE The locale for character classification, used to determine the
characters constituting a blank in the current locale.
Exit status:
0 Success
Errors:
If output_file is created, it isn’t removed when an error occurs.
See also:
sort

unlink © 2010, QNX Software Systems GmbH & Co. KG.
Call the unlink() function to delete a file
Syntax:
unlink file
Runs on:
Neutrino
Options:
file The pathname of an existing file.
Description:
The unlink utility is a command-line interface to the unlink() function:
(void)unlink( file );
You need the appropriate permissions (typically write permission in the directory that
contains file) in order to use the unlink utility. In order to unlink a directory, you need
the appropriate permissions, and the filesystem must also allow it (see _PC_LINK_DIR
in the description of pathconf() in the QNX Neutrino Library Reference).
Exit status:
See also:
link, ln, rm, rmdir
pathconf(), unlink() in the QNX Neutrino Library Reference

© 2010, QNX Software Systems GmbH & Co. KG. unzip
Extract files from a zip archive
Syntax:
unzip [-Z] [-opts[modifiers]] file[.zip] [list]
[-x xlist] [-d exdir]
Runs on:
Targets:
x86 only
Options:
The options include:
-d exdir Extract files into exdir.
-f Freshen the existing files.
-l (“el”) List archive files (short format).
-P password Use the given password to unencrypt the archive entries.
Specifying a plain-text password on the command line or in a script can be a security

problem.
-p Extract files to pipe (stdout).
-T Update the timestamp for the archive to match the latest timestamp
of the archive files.
-t Test the archive files.
-u Update existing files and create new ones if needed.
-v Be verbose or print diagnostic version information.
-x xlist Exclude the files in the xlist.
-Z ZipInfo mode. If the first option on the command line is -Z, the
remaining options are taken as ZipInfo options.
-z Display the archive comment only.
The modifiers include:
-a Automatically convert any text files.

unzip © 2010, QNX Software Systems GmbH & Co. KG.
-aa Extract all files as text files.
-C Match files case-insensitively.
-j Junk the path to the file; do not make directories.
-K Keep setuid/setgid/tacky permissions.
-L Convert some names to lowercase.
-M Pipe all output through an internal pager that’s similar to the more command.
-n Never overwrite existing files.
-o Overwrite existing files without prompting.
-q Perform operations quietly. Use -qq to make them quieter.
-U Use escapes for all non-ASCII Unicode.
-UU Ignore any Unicode fields.
-V Retain VMS file version numbers.
-X Restore user and group (UID/GID) information.
Description:
The unzip utility lists, tests, or extracts files from a ZIP archive. The default behavior
(with no options) is to extract into the current directory (and subdirectories below it)
all files from the specified ZIP archive. A companion program, zip, creates ZIP
archives; both programs are compatible with archives created by PKZIP and
PKUNZIP.
Examples:
Extract all members of the archive letters.zip into the current directory and
subdirectories below it, creating any subdirectories as necessary, using unzip:
unzip letters
Extract all members of letters.zip into the current directory only:
unzip -j letters
Test letters.zip. Use the following command to print only a summary message
indicating whether the archive is all right or not:
unzip -tq letters
Test all zipfiles in the current directory, and print only the summaries:
unzip -tq \*.zip

© 2010, QNX Software Systems GmbH & Co. KG. unzip
Extract all members of letters.zip whose names end in .tex, to standard output,
auto-convert to the local end-of-line convention, and pipe the output into more:
unzip -ca letters \*.tex | more

Extract the binary file paper1.dvi to standard output, and pipe it to a printing
program:
unzip -p articles paper1.dvi | dvips

Extract newer versions of the files already in the current directory and create any files
not already there:
unzip -uo sources

Display a diagnostic screen showing which unzip and zipinfo options are stored in
environment variables:
unzip -v
See whether decryption support was compiled with the files:
unzip -v
See the compiler that unzip used:
unzip -v
UNZIP A set of default options for unzip. For example:
export UNZIP="-qq"
Exit status:
2 A generic error in the zipfile format was detected, but processing may have
completed successfully anyway; a warning was generated in the process.
3 A severe error in the zipfile format was detected; processing probably failed
immediately.
4 unzip was unable to allocate memory for one or more buffers during program
initialization.
5 unzip was unable to allocate memory or unable to obtain a tty to read the
decryption password(s).
6 unzip was unable to allocate memory during decompression to disk.
9 The specified zipfiles were not found.

unzip © 2010, QNX Software Systems GmbH & Co. KG.
10 Invalid options were specified on the command line.
11 No matching files were found.
50 The disk is, or was, full during extraction.
51 The end of the ZIP archive was encountered prematurely.
80 The user aborted unzip prematurely with Ctrl-C or a similar command.
81 Testing or extraction of one or more files failed, due to unsupported

compression methods or unsupported decryption.
82 No files were found, due to bad decryption password(s). If even one file is
successfully processed, however, the exit status is 1.
See also:
freeze, gzip, pax, tar, zip

© 2010, QNX Software Systems GmbH & Co. KG. uptime
Display the length of time that the system has been running
Syntax:
uptime
Runs on:
Neutrino
Options:
None.
Description:
The uptime utility displays the current local time, by the length of time that the
system has been running (in days, hours, and minutes, as appropriate), and the number
of users logged in.
See also:
date, time

usb © 2010, QNX Software Systems GmbH & Co. KG.
Display USB device configuration
Syntax:
usb [-b busno -d devno -N name] [-t] [-V] [-v]
Runs on:
Neutrino
Options:
-b busno Display devices on specific busno only.
-d devno Display device devno only.
-N name Name of the USB manager to query. The default is

/dev/io-usb/io-usb.
-t Use a “tree-like” output format.
-V Display vendor-unique descriptors (at given verbosity level).
-v Be verbose. The level of detail increases as you add v’s.
Description:
The usb utility displays USB device configuration. As you repeat the number of -v
(verbose) options, you’ll get more levels of detail.
Examples:
Here’s some sample output from the command usb -vvv. Note that two USB devices
(an Ethernet card and a printer) are installed in this case.
USB (UHCI) v1.10, v1.00 DDK
Control, Interrupt, Bulk, Isoch, Low, High
Device Address : 1
Vendor : 0x0506 (3COM)
Product : 0x03e8 (3COM USB Network Interface (3C19250))
Device Release : r0.02
USB Spec Release : v1.00
Serial Number : 009004BB78F9
Class : 0x00 (Independent per interface)
Max PacketSize0 : 8
Languages : 0x0409 (English)
Configurations : 1
Configuration : 1
Attributes : 0x80 (Bus-powered)
Max Power : 110 mA
Interfaces : 1
Interface : 0 / 0
Class : 0x00 (Unknown)
Subclass : 0x00
Protocol : 0x00
Endpoints : 3 + Control

© 2010, QNX Software Systems GmbH & Co. KG. usb
Endpoint : 0
Attributes : Control
Max Packet Size: 8
Endpoint : 1
Attributes : Bulk/IN
Max Packet Size: 64
Endpoint : 2
Attributes : Bulk/OUT
Max Packet Size: 64
Endpoint : 3
Attributes : Interrupt/IN
Max Packet Size: 8
Interval : 1 ms
Device Address : 2
Vendor : 0x04a9 (Canon)
Product : 0x1055 (BJC-85)
Device Release : r0.70
USB Spec Release : v1.10
Serial Number : 44OFBr
Class : 0x00 (Independent per interface)
Max PacketSize0 : 8
Languages : 0x0409 (English)
Configurations : 1
Configuration : 1
Attributes : 0x40 (Self-powered)
Max Power : 2 mA
Interfaces : 1
Interface : 0 / 0
Class : 0x07 (Printer)
Subclass : 0x01
Protocol : 0x02
Endpoints : 2 + Control
Endpoint : 0
Attributes : Control
Max Packet Size: 8
Endpoint : 1
Attributes : Bulk/OUT
Max Packet Size: 64
Endpoint : 2
Attributes : Bulk/IN
Max Packet Size: 64
See also:
devu-ehci.so, devu-ohci.so, devu-uhci.so, io-usb

use © 2010, QNX Software Systems GmbH & Co. KG.
Print a usage message (QNX Neutrino)
Syntax:
use [-aeis] [-d directory] [-f filelist] files
Runs on:
Options:
-a Extract all usage information from the load module in its source
form, suitable for piping into usemsg.
-d directory Recursively display information for all files under directory.
-e Include only ELF files.
-f filelist Read a list of files, one per line, from the specified filelist file, and
display information for each.
-i Display build properties about a load module.
-s Display the version numbers of the source used in the executable.
files One or more executable load modules or shell scripts that contain
usage messages.
Description:
The use utility displays a usage message for the specified executable programs or
shell scripts.
Regardless of your current terminal settings specified, the use utility automatically
includes a line break after 80 characters.
The use utility searches for files, using the default command search (PATH), and
displays the usage message (if any) that it finds in the load files or shell scripts.
If the LANG environment variable is set, a usage message of that language displays, if
available. Alternate language usage messages are not available within shell scripts.
However, it’s easy to edit shell script messages. While usage messages included with
standard versions of QNX Neutrino are in English only, it’s possible to add alternate
language usage messages by placing the revised usage message in a separate file, and
using the usemsg utility to insert the usage message in the executable in question.

© 2010, QNX Software Systems GmbH & Co. KG. use
Usage messages in shell scripts

Usage messages are implemented in binary executable programs using a special form
of resource record in the load modules. Usage messages are implemented in shell
scripts using a format similar to that used in the C source code and interpreted by the
usemsg utility.
In shell scripts, the use utility scans each line from the beginning of the script,
looking for a line starting with the # character (i.e. a comment) and containing the
string __USAGE. The usage message begins on the next line and consists of all
subsequent lines up to, but not including, the first line that either starts with #endif or
starts with a character other than #.
Here’s a sample usage message in a shell script:
#ifdef __USAGE
#%C thread_id
#Where:
# thread_id is the thread ID you want to act on
#endif
If the shell script is called foo, and you invoke use foo, the following message is
displayed:
foo thread_id
Where:
thread_id is the thread ID you want to act on
In the above shell script fragment, the message starts with:
#%C thread_id
and ends with:
# thread_id is the thread ID you want to act on

Within the body of the usage message, the leading #s are stripped by the use utility
and don’t form part of the message that’s displayed. As with the C language usage
message convention (see usemsg), a %CTab at the start of a line is replaced by the
program name (or filename of the shell script) and a tab character at the start of a line
spaces over the same number of spaces as the last previous occurrence of %CTab.
You can place the usage message almost anywhere in most shell scripts. Placing it at
the beginning results in quicker response for extracting the usage message at the
expense of a very slight slowdown in execution of the shell script. If you’re running a
shell that doesn’t recognize lines beginning with # as comments, you should place the
usage message after an explicit exit.
Examples:
Display a usage message for the ls utility:
use ls

use © 2010, QNX Software Systems GmbH & Co. KG.
See also:
ksh, usemsg

© 2010, QNX Software Systems GmbH & Co. KG. usemsg
Change the usage message for a command (QNX Neutrino)
Syntax:
usemsg [-c] [-i id[=value]] [-f info_file] loadfile [msgfile]
Runs on:
Options:
-c The usage message is contained in a C source program delimited by:
#ifdef __USAGE
...
#endif
Note that there are two underscores before USAGE.
-f filename Read filename for lines containing id=value pairs to import into
loadfile.
-i id=value Add the information tag id to loadfile with the specified value.
value doesn’t need to be specified for the DATE or NAME ids.
The DATE and NAME keys will be added automatically when any
other key is added.
id is translated into upper-case.
-l Use ldrel to add the specified usage message.
-o Use objcopy to add the specified usage message. This is the default
behavior.
The -o option is required if you’re running usemsg on a binary that has its data
segment before its code segment. Without the -o option, usemsg will corrupt these
reordered binaries.
-s string Import the usage message from the #ifdef string section in a C
source file. If string is omitted, __USAGE will be used.
If multiple -s options are specified, usemsg will search for them in
order and use the first string section found.
loadfile The name of an executable program to extract or insert a usage
message. The current PATH environment variable is searched to
locate loadfile.
msgfile A text file or a C source file containing a usage message (see -c). If
the msgfile name ends in .c, a C source is assumed. If present, this
argument is used as the name of the message file to insert into the
load file. If the msgfile argument isn’t present, the usage message is
read from the load file and printed to standard output.

usemsg © 2010, QNX Software Systems GmbH & Co. KG.
Description:
The usemsg utility lets you examine or change the usage record contained within a
QNX Neutrino executable program. All utilities supplied with QNX Neutrino are
shipped with a usage message describing their options. This information is kept in a
resource record in the load file. Since this usage text isn’t loaded into memory when
the program is run, you can make it as large as 32K characters without affecting the
size of your program at runtime.
The use utility prints usage messages. For example:
use ls
use more
use pidin
Developers may use the usemsg utility to add usage messages to their programs.
Displaying help messages in ported executables

If you are porting or developing an executable that already has a help message invoked
by an argument, you can make use display the existing help message by adding one
extra line in the executable, like this:
%digit> cmd argument
Where digit is where to read the output from, either 1 (stdout) or 2 (stderr). The use
utility itself always prints to stdout but executables may print to stdout or stderr.
For example, if some_gnu_tool has an option --help that sends a help message to
stdout, add a line like this:
%1> some_gnu_tool --help
or
%1> %C --help
In this example, when someone types:
use some_gnu_tool
The use utility spawns:
some_gnu_tool --help
and then prints the output.

If the executable sends its output to stderr, add this line instead:
%2> some_gnu_tool --help

© 2010, QNX Software Systems GmbH & Co. KG. usemsg
Adding or changing a usage message

There are two forms of adding a usage message to a load file. One form assumes a
simple text file, while the other assumes that the usage message is contained in a C
source program:
usemsg program textfile

usemsg program program.c
In the second form, the C source is scanned and all text between an #ifdef __USAGE
and the next #endif is used. In both cases, any existing usage message is replaced by
the new message. Note that this utility lets you both change existing usage messages
and add usage messages to programs that have none. You don’t need the program
source.
The usemsg utility provides a simple grammar that allows it to support usage
messages in several different languages. It also supports different messages linked to
the name used to invoke the usage. For example, if less and more are links to the
same load file, they can each have their own usage within the same usage record in the
file.
The grammar consists of the special symbol % in the first column followed by an
action character as follows:
%% A single %.
%-command The start of a specific command’s usage message.
%=language The start of a new language.
%C<tab> Replace with name of command and a space.
<tab> Insert spaces equal to the length of the command + 1.
To extract the entire usage message, including all languages and the grammar control
sequences, name the loadfile and don’t specify a msgfile.
The %-command and %=language are both optional. If both are specified, the
%-command is followed by one or more %=language sections followed by another
%-command and another set of %=language sections. The following examples should
clarify the required nesting:
%C a single language message
%=english
%C an English language message
%=french
%C a French language message
%-less
%C single language message for less
%-more

usemsg © 2010, QNX Software Systems GmbH & Co. KG.
%C single language message for more
%-less
%=english
%C an English language message for less
%=french
%C a French language message for less
%-more
%=english
%C an English language message for more
%=french
%C a French language message for more
If multiple language usage messages are available, use employs the LANG
environment variable to select a language. If LANG isn’t defined or doesn’t match any
language present, then the first usage message is printed. Likewise, if multiple
command names are present, the command passed as an argument is used to select a
command. If no match occurs, the first usage message is printed.
Examples:
Insert a usage message from C source into myprog:
usemsg myprog myprog.c
Extract the entire usage message for pidin, edit the message, then reinsert the
changed message:
usemsg pidin > my_pinitmsg

vi my_pinitmsg
usemsg pidin my_pinitmsg
See also:
use

© 2010, QNX Software Systems GmbH & Co. KG. uud
Decode a file that was encoded with uue
Syntax:
uud [-n] [-d] [-s dir] [-t dir] input-file
Runs on:
Neutrino
Options:
-n Don’t check the line sequence.
-d Use debug (verbose) mode.
-s dir The source directory for all input files. You must end the name of the
directory with a directory separator (i.e. a slash).
-t dir The target directory for all output files. You must end the name of the
directory with a directory separator (i.e. a slash).
input-file The name of the file to decode. If input-file is -, read from standard
input.
Description:
The uud utility decodes a file that was encoded using uue.
If the filename is in the form input-file.uaa (i.e. you used the -n to uue to break a file
into chunks), uud automatically includes the subsequent pieces.
See also:
uue

uudecode © 2010, QNX Software Systems GmbH & Co. KG.
Decode a file that was encoded with uuencode (POSIX)
Syntax:
uudecode [-p | -o outfile] [file ...]
Runs on:
Neutrino
Options:
-o outfile Decode to outfile; otherwise uudecode recreates the original file.
-p Decode the file to stdout; otherwise uudecode recreates the original

file.
file The file(s) to decode; the default is to decode from stdin.
Description:
The uudecode utility decodes a file that was encoded using uuencode.
See also:
uud, uue, uuencode

© 2010, QNX Software Systems GmbH & Co. KG. uue
Encode a binary file into ASCII
Syntax:
uue [-n] input_file [-]
Runs on:
Neutrino
Options:
-n The number of lines to put into each file.
input_file The file that you want to encode.
Description:
The uue utility encodes a binary file as ASCII (e.g. for mailing). The encoding takes 3
bytes (24 bits) from the input file and renders them as 4 bytes in the output file.
By default, the output file is input_file.uue; if you specify a dash at the end of the
command, uue writes the encoded file to standard output.
If you want to read from standard input (e.g. a pipe), use uuencode instead of uue.
If you specify the -n option, uue writes the encoded file to input_file.uaa,
input_file.uab, and so on.
To decode the file, use uud.
See also:
uud, uudecode, uuencode

uuencode © 2010, QNX Software Systems GmbH & Co. KG.
Encode a binary file or standard input into ASCII (POSIX)
Syntax:
uuencode [-m] [file] name
Runs on:
Neutrino
Options:
-m Use the MIME Base64 encoding; otherwise use the uuencode historical
algorithm.
file The file that you want to encode. If you don’t specify a file, uuencode
reads from standard input.
name The name to embed in the encoded file for use by uudecode.
Description:
The uuencode utility encodes a binary file as ASCII (e.g. for mailing). The encoding
takes 3 bytes (24 bits) from the input file and renders them as 4 bytes in the output file.
By default, uuencode writes the encoded file to standard output. If you don’t specify
an input file, uuencode reads from standard input (unlike uue).
To decode the file, use uudecode.
See also:
uud, uudecode, uue

© 2010, QNX Software Systems GmbH & Co. KG. vi
Syntax:
vi [options]... [+command] file...
Runs on:
Neutrino
Options:
See elvis for a full listing.
Description:
The vi utility is an interactive fullscreen editor that’s compatible with the
Unix/POSIX vi editor. The vi utility in QNX Neutrino is a link to elvis.
Steve Kirkendall
See also:
ed, elvis, ctags, ped, qed, sed

view © 2010, QNX Software Systems GmbH & Co. KG.
Syntax:
view [options]... [+command] file...
Runs on:
Neutrino
Options:
See elvis for a full listing.
Description:
The view utility is an interactive fullscreen editor that’s compatible with the
Unix/POSIX vi editor. The view utility in QNX Neutrino is a link to elvis.
Steve Kirkendall
See also:
elvis, ctags, qed, sed

© 2010, QNX Software Systems GmbH & Co. KG. /etc/view.conf
View definitions for SNMPv2
Name:
/etc/view.conf
Description:
The view.conf file is used to define the views of the MIB data that’s available to the
defined parties (/etc/party.conf) via a defined context (/etc/context.conf).
1 /nodecfg/node_name/etc/view.conf, where node_name is the value of the

2 /etc/view.conf
viewindex viewsubtree viewstatus viewmask
where:
viewindex Unique number representing the view.
viewsubtree A subtree in the MIB that includes the objects that the defined parties
should have access to.
viewstatus Defines whether the subtree is to be included or excluded.
viewmask Used with the instance of subtree to determine whether the object
identifier being specified is in the family of view subtrees.
For example:
3 .iso.org.dod.internet.mgmt included NULL
All of the objects that reside under the subtree .iso.org.dod.internet.mgmt are
included in the view number 3.
See also:

waitfor © 2010, QNX Software Systems GmbH & Co. KG.
Wait until a path exists
Syntax:
waitfor pathname [wait_time]
Runs on:
Neutrino
Options:
pathname The path to test.
wait_time The maximum number of seconds to wait for the file to appear. It can
include one decimal digit to specify tenths of a second. The default is
5.0 seconds.
Description:
The waitfor utility pauses temporarily until a stat() on the specified pathname
succeeds. It’s often used for synchronization, to allow a resource manager to perform
its startup functionality, and then for the process manager to proceed with the further
interpretation of the script file.
/dev/io-net/en0, use if_up -p en0.

© 2010, QNX Software Systems GmbH & Co. KG. wc
Count words, lines, and bytes (POSIX)
Syntax:
wc [-clw] [-ht] [file...]
Runs on:
Neutrino
Options:
-c Write to the standard output the number of bytes in each input file.
-h (QNX Neutrino extension) Display headers.
-l (“el”) Write to the standard output the number of lines in each input file.
-t (QNX Neutrino extension) Don’t display the totals when counting more than
one file.
-w Write to the standard output the number of words in each input file.
file The pathname of an input file. If no files are specified, the standard input is
used.
Description:
For each input file, the wc utility counts lines, words, and characters (bytes) in the file
and writes the results to the standard output. It considers a word to be a string of
characters delimited by white space.
If you don’t specify any options, wc writes counts of lines, words and characters, in
that order. If you specify one or more of the options -l, -w, or -c, the wc utility
reports only the information selected for the specified options. The order in which you
specify these options determines the order in which the number of lines, words, and
bytes are written.
If you specify more than one input file, wc also writes a total count for all named files,
for each option. You can specify the -t option to suppress the totals.
To get its line count, wc counts newline characters. If the last line of a file lacks the
newline terminator, it isn’t counted.
Exit status:
0 Success.

which © 2010, QNX Software Systems GmbH & Co. KG.
Locate a program file (UNIX)
Syntax:
which [-afLls] program...
Runs on:
Neutrino
Options:
-a Find all occurrences of program in PATH.
-f Display the full pathname.
-L Display the long format (as in ls -l) for each program found, displaying link
information if the file is a symlink.
-l (“el”) Display the long format (as in ls -l) for each program found.
-s Search for shared objects in the directories identified by the

LD_LIBRARY_PATH environment variable and the _CS_LIBPATH
configuration string.
Description:
The which utility searches for the specified programs. By default, which searches the
directories listed by your PATH environment variable, but if you specify the -s option,
it searches the directories specified by LD_LIBRARY_PATH and _CS_LIBPATH.
Examples:
Display the full pathname and long status for all versions of the ls utility found in
PATH:
which -alf ls
Display the pathname for the which utility:
which which
Locate the devg-flat.so shared object:
which -s devg-flat.so
PATH A colon-separated list of directories to search for executables.
LD_LIBRARY_PATH
A colon-separated list of directories to search for shared libraries.

© 2010, QNX Software Systems GmbH & Co. KG. which
Exit status:
0 All input files were found.
See also:
ls, whence (builtin ksh command)

who © 2010, QNX Software Systems GmbH & Co. KG.
List the logged-in users
Syntax:
who [file]
who am I
Runs on:
Neutrino
Options:
file The file that contains information about the logged-in users. If you don’t
specify a file, the utility looks at /var/log/utmp.
Description:
The who utility displays information about the logged-in users:
• If you specify no arguments or a file, who displays a list of all logged-in users.
• If you specify who am I (or who am i), the utility displays the terminals you’re
logged into.
See also:
rwho

© 2010, QNX Software Systems GmbH & Co. KG. wpa_cli
WPA command-line client for interacting with wpa_supplicant
Syntax:
wpa_cli [-p path to ctrl sockets]
[-i ifname]
[-hvB] [-a action file]
[-P pid file] [command ... ]
Runs on:
Neutrino
Options:
-p path Change the path where control sockets should be found.
-i ifname Specify the interface that is being configured. By default, choose the
first interface found with a control socket in the socket path.
-h Help. Show a usage message.
-v Show version information.
-B Run as a daemon in the background.
-a file Run in daemon mode executing the action file based on events from
wpa_supplicant. The specified file will be executed with the first
argument set to the interface name, and the second to CONNECT or
DISCONNECT, depending on the event.
-P file Set the location of the PID file.
command Run a command; see “Supported commands,” below.
Description:
The wpa_cli utility is a text-based front-end program for interacting with
wpa_supplicant. You can use it to query the current status, change the
configuration, trigger events, and request interactive user input.
The wpa_cli utility can show the current authentication status, selected security
mode, dot11 and dot1x MIBs, etc. In addition, it can configure some variables like
EAPOL state machine parameters and trigger events like reassociation and IEEE
802.1X logoff/logon.
The wpa_cli utility provides a user interface to request authentication information,
such as user name and password, if these aren’t included in the configuration. You can
use this to implement, for example, one-time passwords or generic token card
authentication where the authentication is based on a challenge-response that uses an
external device for generating the response.

wpa_cli © 2010, QNX Software Systems GmbH & Co. KG.
You can configure the control interface of wpa_supplicant to allow non-root user
access (ctrl_interface_group in the configuration file). This makes it possible to
run wpa_cli with a normal user account.
The wpa_cli utilities supports interactive and command-line modes. Both modes
share the same command set, and the main difference is in interactive mode providing
access to unsolicited messages (event messages, user name/password requests).
If you don’t specify a command when you start wpa_cli, the utility goes into
interactive mode. You then enter commands at the wpa_cli prompt.
Supported commands
The wpa_cli utility currently supports the following commands:
add_network Add a network.
bssid network_id BSSID

Set the preferred BSSID for an SSID.
disable_network network_id
disable a network
disconnect Disconnect and wait for a reassociate command before

connecting.
enable_network network_id
Enable a network.
get_capability eap/pairwise/group/key_mgmt/proto/auth_alg
Get capabilities.
get_network network_id variable

Get network variables.
help Display usage information.
identity network_id identity

Configure the identity for an SSID.
interface [ifname]
Show interfaces or select the specified interface.
level debug_level Change the debugging level.
license Show the full wpa_cli license.
list_networks List the configured networks.
logoff IEEE 802.1X EAPOL state machine logoff.

© 2010, QNX Software Systems GmbH & Co. KG. wpa_cli
logon IEEE 802.1X EAPOL state machine logon.

mib Get MIB variables (dot1x, dot11)
new_password network_id password

Change the password for an SSID.
otp network_id password
Configure a one-time password for an SSID.
passphrase network_id passphrase
Configure a private key passphrase for an SSID.
password network_id password
Configure a password for an SSID.
pin network_id pin Configure a pin for an SSID.
pmksa Show the PMKSA cache.
preauthenticate BSSID
Force preauthentication.
quit Exit wpa_cli

reassociate Force a reassociation.
reconfigure Force wpa_supplicant to reread its configuration file.
remove_network network_id
Remove a network.
save_config Save the current configuration.
scan Request a new BSS scan.
scan_results Get the latest scan results.
select_network network_id
Select a network (disable others).
set Set variables (shows list of variables when run without

arguments).
set_network network_id variable value
Set network variables (shows list of variables when run without
arguments).
status [verbose] Get the current WPA/EAPOL/EAP status.
terminate Terminate wpa_supplicant.

wpa_cli © 2010, QNX Software Systems GmbH & Co. KG.
See also:
wpa_supplicant
WiFi Configuration Using WPA and WEP in the Core Networking User’s Guide

© 2010, QNX Software Systems GmbH & Co. KG. wpa_passphrase
Set WPA passphrase for a SSID
Syntax:
wpa_passphrase [ssid] [passphrase]
Runs on:
Neutrino
Options:
ssid The SSID whose passphrase should be derived.
passphrase Use this passphrase. If not included on the command line, it will be
read from standard input.
Description:
The wpa_passphrase utility precomputes PSK entries for network configuration
blocks of a wpa_supplicant.conf file.
See also:
wpa_supplicant

wpa_supplicant © 2010, QNX Software Systems GmbH & Co. KG.
Wi-Fi Protected Access client and IEEE 802.1X supplicant
Syntax:
wpa_supplicant [-BhKLNptuvW] [-b br_ifname]
[-C ctrl_interface] [-c config file] [-d[d]]
[-f output_file] [-g global ctrl_interface]
[-i ifname] [-P file] [-q[q]]
Runs on:
Neutrino
Options:
Most command-line options have global scope. Some are given per interface, and are
valid only if you’ve specified at least one -i option; otherwise they’re ignored. Option
groups for different interfaces must be separated by an -N option.
-B Run as a daemon in the background.
-b br_ifname Optional bridge interface name. (Per interface)
-C ctrl_interface The path to the ctrl_interface socket. (Per interface; used only if
-c is not).
-c filename Path to configuration file. (Per interface)
-d Increase debugging verbosity (specify -dd for even more).
-foutput_file Send the output to the specified file, instead of to standard

output.
-g global ctrl_interface
The path to the global ctrl_interface socket. If you specify this
option, you can omit the interface definitions.
-h Help; display a usage message.
-i ifname The interface to listen on. Multiple instances of this option can
be present, one per interface, separated by an -N option (see
below).
-K Include keys (passwords, etc.) in the debugging output.
-L Show the license (GPL and BSD).
-N Start describing a new interface.
-P file Specify the location of the PID file.
-p Driver parameters. (Per interface)

© 2010, QNX Software Systems GmbH & Co. KG. wpa_supplicant
-q Decrease debugging verbosity (specify -qq for even less).

-t Include the timestamp in debugging messages.
-u Enable the DBus control interface. If you specify this option,
you can omit the interface definitions.
-v Show version information.
-W Wait for a control interface before starting.
Description:
Wireless networks don’t require physical access to the network equipment in the same
way as wired networks. This makes it easier for unauthorized users to passively
monitor a network and capture all transmitted frames. In addition, unauthorized use of
the network is much easier. In many cases, this can happen even without the user’s
explicit knowledge, because the wireless LAN adapter may have been configured to
automatically join any available network.
Link-layer encryption can be used to provide a layer of security for wireless networks.
The original wireless LAN standard, IEEE 802.11, included a simple encryption
mechanism, WEP. However, that proved to be flawed in many areas, and networks
protected with WEP cannot be considered to be secure.
IEEE 802.1X authentication and frequently-changed dynamic WEP keys can be used
to improve the network security, but even that has inherited security issues, due to the
use of WEP for encryption. Wi-Fi Protected Access and IEEE 802.11i amendment to
the wireless LAN standard introduce a much-improved mechanism for securing
wireless networks. IEEE 802.11i-enabled networks that are using CCMP (an
encryption mechanism based on strong cryptographic algorithm AES) can finally be
called secure used for applications which require efficient protection against
unauthorized access.
The wpa_supplicant utility is an implementation of the WPA Supplicant
component, i.e., the part that runs in the client stations. It implements WPA key
negotiation with a WPA Authenticator and EAP authentication with Authentication
Server. In addition, it controls the roaming and IEEE 802.11
authentication/association of the wireless LAN driver.
The wpa_supplicant utility is designed to be a daemon that runs in the background
and acts as the backend component controlling the wireless connection. It supports
separate front-end programs and a sample text-based front-end, wpa_cli, is included
with wpa_supplicant.
Before wpa_supplicant can do its work, the network interface must be available.
That means that the physical device must be present and enabled, and the driver for the
device must have been loaded. The daemon exits immediately if the device isn’t
already available.
After wpa_supplicant has configured the network device, higher-level
configuration such as DHCP may proceed. There’s a variety of ways to integrate

wpa_supplicant into a machine’s networking scripts, a few of which are described

in the sections below.
The following steps are used when associating with an AP using WPA:
1 wpa_supplicant requests the driver to scan neighboring BSSs.
2 wpa_supplicant selects a BSS based on its configuration.
3 wpa_supplicant requests the driver to associate with the chosen BSS.
4 If WPA-EAP: integrated IEEE 802.1X Supplicant or external Xsupplicant

completes EAP authentication with the authentication server (proxied by the
Authenticator in the AP).
5 If WPA-EAP: the master key is received from the IEEE 802.1X Supplicant.
6 If WPA-PSK: wpa_supplicant uses PSK as the master session key.
7 wpa_supplicant completes WPA 4-Way Handshake and Group Key

Handshake with the Authenticator (AP).
8 wpa_supplicant configures encryption keys for unicast and broadcast.
9 Normal data packets can be transmitted and received.
Supported features
Supported WPA/IEEE 802.11i features:
• WPA-PSK (“WPA-Personal”)
• WPA with EAP (e.g., with RADIUS authentication server) (“WPA-Enterprise”)

The following authentication methods are supported with an integrated IEEE
802.1X Supplicant:
- EAP-TLS
- EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1)
- EAP-PEAP/TLS (both PEAPv0 and PEAPv1)
- EAP-PEAP/GTC (both PEAPv0 and PEAPv1)
- EAP-PEAP/OTP (both PEAPv0 and PEAPv1)
- EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1)
- EAP-TTLS/EAP-MD5-Challenge
- EAP-TTLS/EAP-GTC
- EAP-TTLS/EAP-OTP
- EAP-TTLS/EAP-MSCHAPv2
- EAP-TTLS/EAP-TLS
- EAP-TTLS/MSCHAPv2
- EAP-TTLS/MSCHAP

© 2010, QNX Software Systems GmbH & Co. KG. wpa_supplicant
- EAP-TTLS/PAP
- EAP-TTLS/CHAP
- EAP-SIM
- EAP-AKA
- EAP-PSK
- EAP-PAX
- LEAP (note: requires special support from the driver for IEEE 802.11
authentication)
The following methods are supported, but since they don’t generate keying
material, they can’t be used with WPA or IEEE 802.1X WEP keying:
- EAP-MD5-Challenge
- EAP-MSCHAPv2
- EAP-GTC
- EAP-OTP
• key management for CCMP, TKIP, WEP104, WEP40
• RSN/WPA2 (IEEE 802.11i)

- pre-authentication
- PMKSA caching
Files:
The wpa_supplicant requires the following libraries and binaries be present:
• libcrypto.so — crypto library
• libssl.so — Secure Socket Library (created from OpenSSL)
• random — executable that creates /dev/urandom for random-number generation
• libm.so — math library required by random
• libz.so — compression library required by random
The wpa_supplicant also needs a read/write filesystem for creation of a

ctrl_interface directory (see the sample wpa_supplicant.conf configuration
file).
You can’t use /dev/shmem because it isn’t possible to create a directory there.

See also:
wpa_cli, wpa_passphrase
wpa_supplicant.conf in the NetBSD documentation.

© 2010, QNX Software Systems GmbH & Co. KG. xargs
Construct argument list(s) and invoke a program (POSIX)
Syntax:
xargs [-itx] [-n numargs] [-P n] [-s size]
[program [initial-arguments]]
Runs on:
Options:
-i (QNX Neutrino extension) Execute in “insert mode.” The
program is executed once for each item in standard input. Each
occurrence of {} in initial-arguments is replaced with the
argument read from standard input. If there are no occurrences
of {} in initial-arguments, the argument is appended to the
initial list.
-n numargs The maximum number of arguments to append to the command

line. The default for numargs is 255.
-P n (QNX Neutrino extension) Use up to n concurrent commands.

The default is 1.
-s size Set the maximum command buffer to size characters, including

program and initial-argument. The default for size is 4096.
-t Trace; print each program on standard error before executing.
program The name of the program to execute. The program must be

found by searching the path using the PATH environment
variable. If you don’t specify program, the default is the echo
utility.
initial-arguments One or more arguments to program that are presented every

time program is executed.
-x Terminate if the command line is too long when using numargs

(or the default number of) arguments.
Description:
The xargs utility uses character strings, read from standard input, to construct a
command line which it executes. The specified program and initial-arguments are
placed at the beginning of the command line, followed by some number of character
strings read. This process continues until the end of the file.
The utility executes a given program with initial-arguments one or more times using
the parameters read from standard input. The number of strings appended may be

xargs © 2010, QNX Software Systems GmbH & Co. KG.
limited by the -n option; the size of the command line may be limited by the -s
option.
The strings are separated by blanks or newlines, which may be embedded in the
strings by prefixing them with \ or enclosing them in quotes ("). To use the quote
character as itself, you must prefix it with a \.
The -i option causes the command to be executed for each string read. Instead of the
normal process of appending the string to the command buffer, the initial-arguments
are scanned, and every occurrence of {} is replaced by the string. If {} doesn’t occur
in initial-arguments, the string is appended to the command line and executed.
When a program is executed, it inherits standard output and standard error from
xargs. Standard input is set to the controlling tty.
The xargs utility always limits the total command buffer size to 4096 characters. The
following example may be used to verify the integrity of data files on a floppy disk
(mounted as /fd):
find /fd -print | xargs cksum | diff check_file -
In the example above, find prints the name of each file on the mounted filesystem.
The xargs utility groups the filenames up for cksum to minimize the number of times
cksum must be executed. The diff utility is then used to verify that the calculated
checksums are the same as recorded in the check_file file.
It’s important to note that the following command:
find /fd -exec cksum {} \; | diff check_file -
achieves the same thing, but requires cksum to be reloaded once for each file in /fd.
Examples:
Use cmp to determine whether the files in the directory old_data are the same as the
files in the directory new_data:
ls old_data | xargs -i cmp old_data/{} new_data/{}
Display the files in the current working directory, and all subdirectories, in two
columns:
find . -print | xargs -n 2 echo
Exit status:
0 All invocations of program completed successfully.

© 2010, QNX Software Systems GmbH & Co. KG. xargs
See also:
find

zap © 2010, QNX Software Systems GmbH & Co. KG.
Destroy a damaged file (QNX)
Syntax:
zap [-pv] file
zap [-pv] [-l|-u] directory
Runs on:
Neutrino
Options:
-l (“el”) List previously zapped files in the directory.
-p Pause before starting (for floppy disks).
-u “Unzap” files in the directory.
-v Be verbose; report results.
file The name of the file to remove.
directory The name of the directory containing previously zapped files.
Description:
You should use zap to remove a file if:
• you know that the file contains bad disk blocks

Or:
• chkfsys has instructed you to use zap on it.
The zap utility releases a file by clearing the directory entry for that file. The disk
blocks used by the file aren’t reclaimed. Therefore, if you use zap repeatedly, you’ll
reduce the total number of disk blocks available on the disk. You can reclaim these,
however, by running chkfsys when the system is idle.
Normally, you should use the rm or rmdir commands to release files or directories.
Previously zapped files may be listed in any specified directory using the -l option.
You can “unzap” or recover zapped files by using the -u option. The utility prompts
for each file that was zapped in the specified directory.
The file to be “unzapped” must have been initially removed via a zap command. Files
removed conventionally via rm or any other process which calls unlink() can’t be
restored by means of the zap -u command.

© 2010, QNX Software Systems GmbH & Co. KG. zap
Examples:
Eliminate the directory entry for the file junk:
zap junk
Exit status:
0 Success.
Caveats:
To run zap you must have read and write permission for the block special file for the
filesystem containing the file being zapped. You must also have execute permission for
the zap utility. In a normally configured system this means you must be root to run
zap.
See also:
chkfsys, rm, rmdir

zcat © 2010, QNX Software Systems GmbH & Co. KG.
Concatenate compressed files (UNIX)
Syntax:
zcat [-hLV] [name...]
Runs on:
Options:
See gzip for a complete listing.
Description:
The zcat utility is part of the gzip suite. See gzip for a description.
GNU
See also:
gzip

© 2010, QNX Software Systems GmbH & Co. KG. zip
Archive and package files to a gzip or pkzip format
Syntax:
zip [-options] [-b path] [-t mmddyyyy] [-n suffixes]
[zipfile list] [-xi list]
Runs on:
Targets:
x86 only
Options:
-0 to -9 Regulate the speed of compression, where -0 indicates no
compression, -1 (“one”) indicates the fastest compression method
(less compression) and -9 indicates the slowest compression
method (optimal compression). The default compression level is
-6.
-@ Read names from standard input.
-A Adjust self-extracting exe.
-b path Use the specified path for the temporary zip archive.
-c Add one-line comments for each file. File operations (adding,

updating) are done first, and then the utility prompts for one-line
comments for each file.
-D Don’t create entries in the zip file for directories. Directory entries
are created by default to allow their attributes to be saved in the
zip archive.
-d Delete entries from a zip file.
-e Encrypt the archive.
-F Fix the zip file. Use this option if some portions of the file are
missing.
-FF Try harder to fix the zip file.
-f Freshen (replace) only the files that have changed.
-h2 Show more help.
-i Include only specified files. For example:

zip © 2010, QNX Software Systems GmbH & Co. KG.
zip -r foo . -i \*.c

This command includes only the files that end in .c in the current
directory and its subdirectories.
-J Strip any prepended data (i.e. a SFX stub) from the file.
-j Junk the path to the file; store just the name of the saved file.
-L Display the zip license.
-l Convert the UNIX end-of-line character LF to the MS-DOS

convention, CR LF. Use -ll to convert the CR LF convention
back to the end-of-line character, LF.
Don’t use these options on binary files.
-m Move the specified files into the zip file and delete the target
directories/files.
-n suffixes Don’t attempt to compress files named with the suffixes indicated.
You can use either colons or semicolons to separate the suffixes.
-o Set the “last modified” time on the zip file to match the “last
modified” time on the zip archive entries.
-P password Use the given password to encrypt the archive entries.
Specifying a plain-text password on the command line or in a script can be a security

problem.
-q Change to quiet mode by eliminating informational messages and

command prompts.
-R Recurse into the directories starting at the current directory.
-r Recurse into the directories.
-T Test the integrity of the new zip file.
-t mmddyyyy Don’t operate on files modified prior to the specified date, where
mm is the month, dd represents the day of the month, and yyyy is
the year.
-tt mmddyyyy Don’t operate on files modified after or at the specified date, where
mm is the month, dd represents the day of the month, and yyyy is
the year.
-u Update only changed or new files.
-v Be verbose, or print version information.

-X Don’t save extra file attributes.
-x files Explicitly exclude the files specified. For example:
zip -r foo foo -x \*.o

includes the contents of foo in foo.zip, while it excludes all the
files that end in .o.
-y Store symbolic links as links instead of as the referenced files.
-z Add a comment to the zip file.
Description:
The zip utility is a compression and file-packaging utility. A companion program
(unzip), unpacks zip archives. The zip and unzip programs can work with
archives produced by PKZIP; PKZIP and PKUNZIP can work with archives produced
by the zip utility.
The zip utility is useful for packaging a set of files for distribution, for archiving files,
and for saving disk space by temporarily compressing unused files or directories.
This utility puts one or more compressed files into a single zip archive, along with
information about the files, such as name, path, date, time of last modification,
protection, and check information to verify file integrity.
You can use a single command to pack an entire directory structure into a zip archive.
Compression ratios of 2:1 to 3:1 are common for text files. The zip utility has one
compression method (deflation) and can also store files without compression; zip
automatically chooses the better of the two for each file to be compressed.
When zip is given the name of an existing zip archive, it replaces identically named
entries in the archive or adds entries for new names.
For example, if foo.zip exists and contains foo/file1 and foo/file2, and the
directory foo contains the files foo/file1 and foo/file3, then:
zip -r foo foo

replaces foo/file1 in foo.zip and adds foo/file3 to foo.zip. Then, foo.zip
contains foo/file1, foo/file2, and foo/file3; foo/file2 remains unchanged.
Examples:
Create an archive called stuff.zip, for example, and put all the files in the current
directory in it, in compressed form:
zip stuff *
The .zip suffix is added automatically, unless the archive name given contains a dot
already; this allows the explicit specification of other suffixes.
Because of filename substitution, files starting with “.” are not included; to include
these to the file:

zip © 2010, QNX Software Systems GmbH & Co. KG.
zip stuff .* *
This command doesn’t include any subdirectories from the current directory.
Zip up an entire directory:
zip -r foo foo
This command creates the archive foo.zip, containing all the files and directories in
the directory foo that are contained within the current directory.
You may want to make a zip archive that contains the files in foo, without recording
the directory name foo. Use the -j option to leave off the paths:
zip -j foo foo/*
If you’re short on disk space, you might not have enough room to hold both the
original directory and the corresponding compressed zip archive. In this case, you can
create the archive in steps using the -m option.
For example, if foo contains the subdirectories tom, dick, and harry, you can
perform these commands:
zip -rm foo foo/tom

zip -rm foo foo/dick
zip -rm foo foo/harry
to create a directory called foo.zip. The first command creates the foo.zip
directory, and the next two commands add to it. As each zip command completes, the
last created archive is deleted, making room for the next zip command to function.
ZIPOPT A set of default options for zip. For example:
export ZIPOPT="-D"
Exit status:
2 An error occurred; the operation failed.
3 A generic error in the zipfile format was detected, but processing may have
completed successfully anyway; a warning was generated in the process.
4 zip was unable to allocate memory for one or more buffers during program
initialization.
5 A severe error in the zipfile format was detected; processing probably failed
immediately.

6 Entry too large to be split with zipsplit.
7 Invalid comment format.
8 zip -T failed or out of memory.
9 The user aborted zip prematurely with Ctrl-C or a similar command.
10 zip encountered an error while using a temporary file.
11 Read or seek error.
12 zip has nothing to do.
13 Missing or empty zip file.
14 Error writing to a file.
15 zip was unable to create a file to write to.
16 Bad command-line parameters.
18 zip could not open a specified file to read.
See also:
freeze, gzip, pax, tar, unzip

Appendix A
Commonly Used Environment Variables
June 22, 2010 Appendix: A • Commonly Used Environment Variables 1973

This appendix describes most of the environment variables that are commonly used
under QNX Neutrino.
For general information about setting environment variables, see the Configuring Your
Environment chapter of the Neutrino User’s Guide; for specific information, see the
related utilities and programs.
A
ABLANG A language code (e.g. en_CA for Canadian English) that a
multilingual Photon application uses to determine what language
to display.
For more information, see the International Language Support
chapter of the Photon Programmer’s Guide; for the currently
supported codes, see
/usr/photon/appbuilder/languages.def.
ABLPATH A list of directories where you want a multilingual Photon

application to search for translation files.
For more information, see the International Language Support
chapter of the Photon Programmer’s Guide, and ph in the
Utilities Reference.
AB_RESOVRD A path variable that lists directories to search for resource

records for applications built with PhAB. See the Photon in
Embedded Systems appendix of the Photon Programmer’s
Guide.
ACCEPT_LANGUAGE
Slinger sets this environment variable, for use by CGI scripts. It
indicates the languages that can be read by the remote client.
For more information, see slinger in the Utilities Reference.
AUTOCONNECT In order for the /etc/autoconnect to be run, this

environment variable must be defined and set to 1.
For more information, see /etc/autoconnect in the Utilities
Reference.
B
BROADCAST The dhcp.client passes this environment variable to the
/etc/dhcp/dhcp-up script. It indicates the client broadcast
address that was obtained from the server.

C
CMD_INT Slinger uses this environment variable to determine the pathname or
name of the shell program used to interpret the string passed to the
SSI command, exec cmd.
COLUMNS The number of character columns on the screen.
CONTENT_LENGTH
indicates the length of the attached information in the case of a
POST.
CONTENT_TYPE
indicates the type of the attached information in the case of a POST.
D
DISPLAY The name of the physical display on which to draw.
DL_DEBUG If this environment variable is set, the shared library loader displays
debugging information about the libraries as they’re opened. The
value can be a comma-separated list of the following:
• all — display all debug messages.
• help — display a help message, and then exit.
• reloc — display relocation processing messages.
• libs — display information about shared objects being opened.
• statistics — display runtime linker statistics.
• lazyload — print lazy-load debug messages.
• debug — print various runtime linker debug messages.
A value of 1 (one) is the same as all.
DOCUMENT_ROOT
indicates the location of data files. (Same as
HTTPD_ROOT_DIR.)
DONT_USE_LINK_UNLINK
Indicates to lpr to use rename() instead of link() or unlink().
1976 Appendix: A • Commonly Used Environment Variables June 22, 2010

E
EDITOR The path of the editor you’d like to use by default.
EXINIT Default elvis option settings. If set, the contents of this environment
variable are executed on startup as a series of ex commands.
F
FILENAME The dhcp.client passes this environment variable to the
/etc/dhcp/dhcp-up script. It indicates the filename supplied
in the server response.
FORWARDED Slinger sets this environment variable, for use by CGI scripts. It
indicates the name of the proxy server through which the web
page is being processed.
FROM Slinger sets this environment variable, for use by CGI scripts. It
indicates the name of the remote client user.
G
GATEWAY The dhcp.client passes this environment variable to the
/etc/dhcp/dhcp-up script. It indicates the gateway that the
client is to use.
GATEWAY_INTERFACE
indicates the name and version of the Common Gateway Interface
served on Slinger.
GNUTARGET Specifies the target (output file format) for GNU utilities. For
more information, see the Selecting the Target System appendix
of the Utilities Reference.
GZIP A set of default options for gzip
H
HOME Your current working directory when you first log in. It’s
specified as one of the fields for each user in /etc/passwd.
For more information, see passwd in the Utilities Reference.
HOSTALIASES The name of a file containing aliases for hosts. For more
information, see gethostbyname() in the Library Reference.

HOSTNAME The name of the host machine.
HTTPD_ROOT_DIR
The name of the directory where Slinger looks for data files.
The default is /usr/local/httpd.
HTTPD_ROOT_DOC
The name of the root document (e.g. index.html) in Slinger.
HTTPD_SCRIPTALIAS
The directory where Slinger looks for the CGI executables.
HTTP_ACCEPT Slinger sets this environment variable, for use by CGI scripts.
It indicates the MIME types that the client accepts, as given by
HTTP headers.
HTTP_USER_AGENT
Slinger sets this environment variable, for use by CGI scripts.
It indicates the browser that the client is using to send requests.
I
INTERFACE The dhcp.client passes this environment variable to the
/etc/dhcp/dhcp-up script. It indicates the interface that was
configured (e.g. en0).
IOPORT The pccard-launch utility sets this environment variable to

indicate the hex address of the I/O port (e.g. 320).
IOPORT2 The pccard-launch utility sets this environment variable to

indicate the hex address of the second I/O port, if assigned.
IOPORT2SZ The pccard-launch utility sets this environment variable to

indicate the size of the second I/O port, if assigned.
IOPORTSZ The pccard-launch utility sets this environment variable to

indicate the size of the I/O port (e.g. 32).
IPADDRESS The dhcp.client passes this environment variable to the

/etc/dhcp/dhcp-up script. It indicates the client IP address that
was obtained from the server.

IRQ The pccard-launch utility sets this environment variable to

indicate the IRQ of the device.
IVE_HOME Used by Java VM.
J
J9PLUGIN_ARGS
Arguments passed to Browser Java plugins.
L
LANG The locale to use for the locale categories.
LC_TYPE The locale for character classification, used by uniq to

determine the characters constituting a blank in the current
locale.
LDEMULATION Specifies the linker emulation. For more information, see the
Selecting the Target System appendix of the Utilities
Reference.
LD_BIND_NOW Affects lazy-load dependencies due to full symbol resolution.
Typically, it forces the loading of all lazy-load dependencies
(until all symbols have been resolved).
LD_DEBUG A synonym for DL_DEBUG. If you set both DL_DEBUG
and LD_DEBUG, then DL_DEBUG takes precedence.
LD_DEBUG_OUTPUT
The name of a file in which the dynamic linker writes its
output. By default, output is written to stderr.
LD_LIBRARY_PATH
A path to search for shared libraries for a native linker. For
more information, see ld in the Utilities Reference
LD_PRELOAD A list of full paths to the shared libraries on an ELF system
that you want to load before loading other libraries. Use a
colon (:) to separate the libraries in this list. You can use this
environment variable to add or change functionality when you
run a program. For setuid or setgid ELF binaries, only
libraries in the standard search directories that are also setuid
will be loaded. See ld in the Utilities Reference, and dlopen()
in the QNX Neutrino Library Reference.

LD_RUN_PATH A path to search for shared libraries on an ELF system. For

more information, see ld in the Utilities Reference
LEASEEXPIRES The dhcp.client passes this environment variable to the
/etc/dhcp/dhcp-up script. It indicates the time at which
the lease expires.
LEASEOBTAINED The dhcp.client passes this environment variable to the

/etc/dhcp/dhcp-up script. It indicates the time at which
the lease was obtained.
LESS Options that you want to pass to less automatically.
LESSEDIT The editor prototype string (used for the v command in less).
LINES The number of character lines on the screen.
LOCALDOMAIN The local domain name. For more information, see res_init()
in the Library Reference.
LOGNAME The userid you used to login; the same as USERNAME.
M
MAKEFLAGS A set of default options for make.
MALLOC_OPTIONS
Controls how calloc(), malloc(), and realloc() behave if you
specify a size of 0 (or a value of 0 for the n argument to calloc()).
The V (“System V”) and R (“use the realloc() behavior of QNX
Neutrino 6.4.0 and earlier”) columns below indicate how the
functions behave if the value of MALLOC_OPTIONS includes
that letter:
Function Default V R
calloc(n, 0) Non-NULL NULL No effect
malloc(0) Non-NULL NULL No effect
realloc(NULL, 0) Non-NULL NULL No effect
realloc(non-NULL, 0) Non-NULL NULL NULL
In all the above cases, if the function returns a non-NULL pointer,

it’s valid only for a corresponding call to free() or realloc().
MIBFILE The location of the mib.txt file.
MKIFS_PATH A colon-separated list of directories that mkifs should use to

search for host files to be included in an OS image.

MORE Default options for more
N
NAMESERVER1, NAMESERVER2
The dhcp.client passes these environment variables to the
/etc/dhcp/dhcp-up script. They indicate the nameservers that
the client is to use.
NAME_MAX The maximum permitted length of a component of a pathname.
NETMASK The dhcp.client passes this environment variable to the
/etc/dhcp/dhcp-up script. It indicates the client netmask that
was obtained from the server.
O
OPTIONx The dhcp.client passes these additional environment variables
(where x is the option number) to the /etc/dhcp/dhcp-up script.
P
PATH A colon-separated list of directories that are searched when the
shell looks for commands and .’d files. An empty string
resulting from a leading or trailing colon, or two adjacent
colons is treated as a ., the current directory.
For more information, see ksh in the Utilities Reference.
PATH_INFO Slinger sets this environment variable, for use by CGI scripts.
It indicates extra path information sent.
PATH_MAX The maximum permitted length of a pathname.
PATH_TRANSLATED
It’s the same as the PATH_INFO appended to the pathname in
HTTPD_ROOT_DIR.
PHEXIT_DISABLE
Set this environment variable to turn off the Photon Login
dialog’s Exit button so that users won’t be able to exit to text
mode.
For more information, see phlogin in the Utilities Reference.
PHFONT The registered name of the font server (e.g. /dev/phfont).
For more information, see ph in the Utilities Reference.

PHFONT_USE_EXTERNAL
If this environment variable exists, io-graphics runs the
font manager as a separate process (see phfont) instead of
using phfont.so. You should set this environment variable
for systems that have remote clients accessing font services on
the host machine (e.g. phindows, phditto).
PHFONTMEM The size of an area in shared memory to set up between the

task and the Photon font server for returning text bitmaps
(normally required only by graphics drivers). For more
information, see PfAttach() in the Photon Library Reference.
PHFONTOPTS Options to pass to the Photon font server. For more

information, see phfont.
PHGFX The full command that you want the ph script to use instead of
the default commands to start the graphics driver.
PHINPUT The full command that you want the ph script to use instead of
the default commands to start the input driver.
PHINSTANCE The number of times that Photon has been instantiated. For
more information, see phlogin in the Utilities Reference.
PHOTON The name of the Photon device (usually /dev/photon). For

more information, see ph in the Utilities Reference.
PHOTONOPTS (Windows-hosted version only) Additional options you want to

pass to the Photon server when it starts.
PHOTON_PATH The name of the root directory containing Photon files (usually
/usr/photon). For more information, see ph in the Utilities
Reference.
PHOTON2_PATH Internal use only.
PHSTART Internal use only.
PHTK_PATH Internal use only.
PHWM The name of the Window Manager to start when you start
Photon. For more information, see ph in the Utilities
Reference.
PHWMEXIT If you set this environment variable, Photon disables the

confirmation dialog when you exit Photon. For more
information, see pwm in the Utilities Reference.
PHWMOPTS Options you want to pass to the window manager when it

starts. For more information, see pwm in the Utilities
Reference.

POSIX_STRICT If this environment variable is set, some QNX 4 and QNX

Neutrino utilities (e.g. cp, ls, and more) interpret options
according to POSIX specifications.
POSIXLY_CORRECT
This environment variable is used by Unix-style operating
systems to alter behavior to comply with POSIX where it’s
different from the OS’s default behavior.
POSIXLY_CORRECT is a de facto standard that isn’t
defined by POSIX.
Here are some of its effects:
• If the POSIXLY_CORRECT environment variable is set,
functions that check the length of a pathname do so before
removing any redundant . and .. components. If
POSIXLY_CORRECT isn’t set, the functions check the
length after removing any redundant components.
• If the POSIXLY_CORRECT environment variable is set,
the posix option to be enabled for ksh. For more
information, see “POSIX mode” in the documentation for
ksh.
PRINTER The name of the default printer, used by lpr.
PROCESSOR Specifies the target CPU when building an image filesystem. If

not set, the default is the same as the CPU of the host system
(e.g. x86). For more information, see mkifs in the Utilities
Reference.
PTERMPAL The pathname of the palette file for pterm.
PTERMRC The name of a local configuration file for pterm.
PWMOPTS (Windows-hosted version only) Options you want to pass to

the window manager when it starts. For more information, see
pwm in the Utilities Reference.
PWM_PRINTSCRN_APP
The application to start when the Print Scrn key is pressed. The
default is snapshot.
PYTHONCASEOK Ignore case in Python import statements (Windows).
PYTHONDEBUG Display debugging output from the python parser.
PYTHONHOME An alternate prefix directory (or prefix:exec_prefix) for Python.

The default module search path uses prefix/pythonX.X.

PYTHONINSPECT
Inspect interactively after running the Python script, and force
prompts, even if stdin doesn’t appear to be a terminal.
PYTHONOPTIMIZE
Optimize the generated Python byte code.
PYTHONPATH A colon-separated list of directories prefixed to the default

module search path for Python. The result is stored in sys.path.
PYTHONSTARTUP
The file to execute on interactive startup of Python (no default).
PYTHONUNBUFFERED
Use unbuffered binary for stdout and stderr. See the Python
documentation for details on internal buffering.
PYTHONVERBOSE
Make Python be verbose (trace import statements).
Q
QCC_CONF_PATH
The name of the directory that contains the configuration files
for qcc.
QNX_HELP_PATH
The location of the top-level QNX help. This environment
variable is used by helpviewer to locate help topics.
QNX_HELP_HOME_PAGE
The location of the “home page” for helpviewer.
QNX_HOST The location of host-specific files for all development hosts.
QNX_TARGET The location of target backends on the host machine.
QUERY_STRING Slinger sets this environment variable, for use by CGI scripts. It
indicates the raw query string sent from the remote client.
R
REFERER Slinger sets this environment variable, for use by CGI scripts. It
indicates the URL of the HTML page that referred the remote client
to this web page.

REMOTE_ADDR
indicates the IP address of the remote client.
REMOTE_HOST
indicates the hostname of the remote client.
REMOTE_IDENT
indicates the remote user name if supporting RFC 931 identification.
REMOTE_PORT
indicates the port of the remote client.
REMOTE_USER
indicates the user name used to validate authentication from the
remote client.
REQUEST_METHOD
indicates the method by which the current web page was requested
(GET or POST).
RESCONF An way of overriding configuration strings in the resolv.conf file.
S
SCRIPT_NAME Slinger sets this environment variable, for use by CGI scripts.
It indicates the name of the script being executed.
SERVER The dhcp.client passes this environment variable to the

/etc/dhcp/dhcp-up script. It indicates the server’s IP
address.

SERVER_ADMIN Slinger sets this environment variable, for use by CGI scripts.
It indicates the contact information of the administrator of
Slinger specified by Slinger’s -a option.
SERVER_NAME Slinger sets this environment variable, for use by CGI scripts.
It indicates the name of the computer where Slinger is running.

SERVER_PORT Slinger sets this environment variable, for use by CGI scripts.
It indicates the IP port that Slinger is answering on.
SERVER_PROTOCOL
It indicates the name and version of HTTP served on Slinger.
SERVER_ROOT Slinger sets this environment variable, for use by CGI scripts.
It indicates Slinger’s current working directory.
SERVER_SOFTWARE
It indicates the name of the Slinger software.
SHELL The pathname of the command interpreter, or shell, that you
want to use. It’s set by login.
SMICINCL A list of directories to search for MIB modules. For more
information, see smic in the Utilities Reference.
SNMPCONFIGFILE
The pathname of the snmpd.conf file.
SOCKET The pccard-launch utility sets this environment variable to
indicate the socket where the card is inserted.
SOCKS_NS The IP address of the domain nameserver that should be used
for name resolution by SOCKS client programs.
SOCKS_SERVER The name or IP address of the SOCKS proxy server host to
use, overriding the default server for SOCKS client programs.
SUFFIX If this environment variable exists, the SNMP utilities print
only the last element of all object IDs with a symbolic name.
For more information, see snmpget in the Utilities Reference.

SYSLOG The node on which syslogd is running.
SYSNAME The name of the system.
T
TERMINFO The name of the directory for terminfo files; see tic in the Utilities
Reference.
TMPDIR The name of a directory where utilities can create temporary files.
TZ The timezone definition; see “Setting the time zone” in the

Configuring Your Environment chapter of the Neutrino User’s
Guide.
U
USER The userid you used to login; the same as LOGNAME.
USER_NAME Internal use only.

Appendix B
Selecting the Target System
In this appendix. . .
Target selection 1991
Architecture selection 1992
Linker emulation selection 1993
June 22, 2010 Appendix: B • Selecting the Target System 1989

© 2010, QNX Software Systems GmbH & Co. KG. Target selection
This appendix describes how you can specify targets and architectures for the ELF
utilities.
The development tools automatically take care of this — you’ll probably never need to
worry about it.
You can specify three aspects of the target system to the utilities that work on ELF
files, each in several ways:
• target — the object file format
• architecture — the type of CPU the target file is to run on
• linker emulation (which applies to the linker only) — a “personality” that specifies
default values for the target system.
In the following summaries, the lists of ways to specify values are in order of
decreasing precedence; the ways listed first override those listed later.
Target selection
A target is an object file format. A given target may be supported for multiple
architectures (see “Architecture selection”). A target selection may also have
variations for different operating systems or architectures.
The command to list valid target values is objdump -i (the first column of output
contains the relevant information). Some sample values are: elf32-i386,
elf32-littlemips, and elf32-powerpc.
Here’s how to specify the target for the ELF utilities:
objdump 1 -b command-line option

2 GNUTARGET environment variable
3 Deduced from the input file.
objcopy, strip Input target:

1 -I or -F command-line option
Output target:
1 -O or -F command-line option
2 Input target (see above)

Architecture selection © 2010, QNX Software Systems GmbH & Co. KG.
nm, size, and strings

1 --target command-line option
ld Input target:
1 -b command-line option
2 TARGET script command (see “Option Commands” in
Using LD in the full online GNU documentation)
4 Default target of the selected linker emulation (see “Linker
emulation selection,” below)
Output target:
1 --oformat command-line option
2 OUTPUT_FORMAT script command (see “Option
Commands” in Using LD in the full online GNU
documentation)
3 Linker input target (see above).
Architecture selection
An architecture is a type of CPU on which an object file is to run. Its name may
contain a colon, separating the name of the processor family from the name of the
particular CPU.
The command to list valid architecture values is objdump -i. Sample values include
powerpc:commonand mips.
Here’s how to specify the architecture for the GNU utilities:
objdump 1 -m command-line option

objcopy, nm, size, strings
Deduced from the input file.
ld Input architecture is deduced from the input file.

Output architecture:
1 OUTPUT_ARCH script command (see “Option Commands” in
Using LD in the full online GNU documentation)
2 Default architecture from the linker output target (see “Target
selection,” above).
1992 Appendix: B • Selecting the Target System June 22, 2010

© 2010, QNX Software Systems GmbH & Co. KG. Linker emulation selection
Linker emulation selection

A linker emulation is a “personality” of the linker; it gives the linker default values for
the other aspects of the target system. In particular, it consists of the linker script, the
target, and several “hook” functions that are run at certain stages of the linking process
to do special things that some targets require.
The command to list valid linker emulation values is ld -V. Sample values include
i386nto, elf32mipnto, and elf32ppcnto.
Ways to specify:
1 -m command-line option
2 LDEMULATION environment variable
3 Compiled-in DEFAULT_EMULATION from Makefile, which comes from EMUL

in config/target.mt.

Appendix C
What’s New in this Reference?
In this appendix. . .
What’s new in the QNX Neutrino Core OS 6.3.2? 2035
June 22, 2010 Appendix: C • What’s New in this Reference? 1995

© 2010, QNX Software Systems GmbH & Co. KG. What’s new in the QNX Software Development Platform 6.5.0?
This appendix describes the updates to this document in the following releases:
Release New Deprecated Changed Errata

QNX SDP 6.5.0 New Deprecated Changed Errata
QNX Momentics 6.3.2 New Changed Errata
QNX Neutrino Core OS 6.3.2 New Changed Errata
QNX Momentics 6.3.0 Service Pack 2 New Changed Errata
QNX Momentics 6.3.0 Service Pack 1 New Changed
QNX Momentics 6.3.0 New Deleted Changed Errata
QNX Momentics 6.2.1 New Deleted Changed Errata
What’s new in the QNX Software Development Platform

6.5.0?
The changes in the QNX Software Development Platform 6.5.0 include the following:
• New entries
• Deprecated content
• Changed content
• Errata
New entries
bison General-purpose parser generator (GNU)
devb-loopback Pseudo block device
devb-mvSata Driver for Marvell 88SX50XX SATA interface (QNX Neutrino)
devg-intelhd.so Graphics driver for Intel GMA HD graphics
devh-microtouch.so
Driver for Microtouch EXII USB touch devices
devnp-bce.so Driver for Broadcom BCM440x 10/100 Ethernet controllers
devnp-i80579.so Driver for Intel Tolapai 80579 Gigabit Ethernet controllers
dnssec-dsfromkey
DNSSEC Delegation Signer resource record generation tool

What’s new in the QNX Software Development Platform 6.5.0? © 2010, QNX Software Systems GmbH & Co. KG.
dnssec-keyfromlabel
DNSSEC key generation tool
fontinfo A utility for displaying information about a font family.
m4 Macro processor (GNU)
mkbuild Build one or more IDE projects
mkcldr Convert CLDR text file to binary data for libqdb_cldr.so
/etc/moduli System moduli file for sshd
pci-bios-v2 Provide support for the PCI BIOS and Message Signaled
Interrupts (MSI).
pps Persistent Publish/Subscribe manager (QNX Neutrino)
scp Secure copy (remote file copy program)
sftp Secure file transfer program
sftp-server SFTP server subsystem
ssh OpenSSH SSH client: remote login program
ssh-add Add RSA or DSA identities to the authentication agent
ssh-agent Authentication agent
ssh-keygen Authentication key generation, management, and conversion
ssh-keyscan Gather SSH public keys
ssh-keysign SSH helper program for host-based authentication
˜/.ssh/ssh_config, /etc/ssh/ssh_config
OpenSSH SSH client configuration files
sshd OpenSSH SSH daemon
/etc/ssh/sshd_config
OpenSSH SSH daemon configuration file
startup-* options Generic options for startup programs (QNX Neutrino)
startup-apic Startup for Intel Advanced Programmable Interrupt Controller

(APIC) systems
startup-bios-32 Startup for PC-compatible systems with a BIOS, using 32-bit
physical addresses.
sysinfo Gather system information for troubleshooting purposes
tsort Perform a topological sort of a directed graph (POSIX)
uptime Display the length of time that the system has been running
1998 Appendix: C • What’s New in this Reference? June 22, 2010

Deprecated content
• deva-ctrl-cs46xx.so
• rftp
• rtelnet
Changed content
applypatch By default, applypatch now installs the host-side files only
for the current host OS. There’s a new -H option that makes
applypatch install the host-side files for all host OSs.
cp We’ve renamed the -n option to be -u, to be consistent with

other platforms. The -n option is still recognized.
cut This utility now supports the POSIX -b and -n options.
deva-*, devg-*, io-audio

Graphics drivers run at a higher priority than applications, but
they shouldn’t run at a higher priority than the audio, or else
breaks in the audio occur. You can use the on command to
adjust the priorities of the audio and graphics drivers.
devb-fdc • Because of updates to io-blk.so, the minimum disk buffer

cache is now 512 KB.
• The device enumerator no longer starts devb-fdc by
default. If your system has a floppy drive, you can start the
driver manually or uncomment the devb-fdc lines in the
/etc/system/enum/devices/block file.
devb-ram Because of updates to io-blk.so, the minimum disk buffer

cache is now 512 KB.
devc-pty The pseudo-tty manager can now support up to 256 ptys, using
the naming scheme:
• pty[p-zP-T][0-9a-f] for the master device
• tty[p-zP-T][0-9a-f] for the slave device
devc-serpci The boards that this driver supports must use PCI I/O space for
the registers, and the ports must be contiguous in memory.
devf-generic, devf-ram
• We’ve added more information about controlling timestamps
with the -u option.
• The entry for devf-generic now includes a section that
describes the information that the driver produces when you
ask for verbose output.

devg-flat.so The memopts option now specifies the name of the

configuration file for this driver. This file includes the options
that you formerly set with the memopts option, along with a
bigendian option that tells the driver that the memory is
byte-swapped.
devg-radeon.so If you use devg-radeon.so with two cards that have the same
vendor and device IDs, the driver fails.
devg-svga.so, devg-vesabios.so
These are “safe”, generic graphics drivers. However, they can
negatively impact the timing of a system and affect realtime
operations. We recommended you use an accelerated driver
instead, if at all possible.
devg-vmware.so A caveat was added describing the default resolution for

VMWare images.
devh-egalax.so The following options are new:

• device
• info
• noinit
• vendor
If you’re using this driver with the USB (devh-usb.so)
module, you must specify the igndev option to devh-usb.so,
specifying the Egalax vendor and device IDs.
devh-ps2ser.so If you press several keys at once on some Microsoft keyboards,

the keyboard doesn’t produce any indication when you release
the keys. As a result, the input driver thinks you’re still holding
the keys down. For more information, see
http://support.microsoft.com/kb/909528/en-us.
devh-usb.so We’ve documented the igndev option.
devi-microtouch We’ve added -P and -r to the general options, -f and -n to the

touchdev options, and -f, -n, -s, and -u to the touchusb
options.
devn-asix.so This driver now supports the AX88178 chip.

devn-dm9102.so, devn-el509.so, devn-el900.so, devn-epic.so,
devn-fd.so, devn-i82544.so, devn-ne2000.so, devn-tigon3.so,
devn-tulip.so
We’ve added the lan option.
devn-micrel8841.so
• We’ve added the lan and lan2 options.

• This driver supports only PCI versions of the Micrel 8841 (1

port) and 8842 (2 port) Ethernet controllers.
devn-pcnet.so We’ve added the following notes to the documentation:

• This driver doesn’t support Fiber PCNET cards with the
AM79C971KC chip.
• We don’t recommend that you use devn-pcnet.so on the
BCM1250 platform, because it can lose receive interrupts.
devn-rtl8150.so We’ve added the following notes to the documentation:
• On the SH platform, the lan= option gets overridden. As a

workaround, fully specify the vendor ID, device ID, bus
number, and device number to the driver when starting (e.g.
vid=0x0bda,did=0x8150,busnum=1,devnum=2,lan=2).
• This driver doesn’t support multicast and promiscuous
modes.
devn-tigon3.so This network driver on the Dell PowerEdge 850 board runs only
up to 100 Mbit/s, and not 1000 Mbit/s. Other boards work well
at 1000 Mbit/s.
devnp-* Native io-pkt and ported NetBSD drivers don’t put entries
into the /dev/io-net namespace, so a waitfor command for
such an entry won’t work properly in buildfiles or scripts. Use
if_up -p instead; for example, instead of waitfor
/dev/io-net/en0, use if_up -p en0.
devnp-axe.so • The version of this driver that we ship is compiled for x86
only. If you want to use it on other platforms, download the
source code for it from Foundry27.
• The USB-Ethernet dongle sometimes drops packets when
used on slow systems or with UHCI. If you encounter
problems with this driver, use the legacy devn-asix.so
driver instead.
devnp-bcm1250.so, devnp-e1000.so, devnp-mpc85xx.so,
devnp-rtl8169.so, devnp-speedo.so
These drivers no longer accept the promiscuous option
because promiscuous mode is controlled by the stack itself. To
enable promiscuous mode, use a BIOCPROMISC ioctl()
command; there’s currently no way to do this from the
command line.
devnp-e1000.so, devnp-i82544.so
The SQE (Squelch Test Errors) counter isn’t applicable to these
drivers, so they use it to track the number of internal Rx FIFO
overruns, instead of counting them with the number of packets
lost because they ran out of descriptors.

dhcp.client • The dhcp.client now declines addresses if they fail an

ARP probe (see RFC 2131 and RFC 5227). You can use the
new -A option to set the number of consecutive ARP probe
tests of the assigned address that can fail before
dhcp.client gives up.
• If you set the ID for a DHCP connection in phlip, that
value is passed to dhcp.client with the -h option; if you
set the server IP for a DHCP connection in phlip, that IP
address is passed to dhcp.client with the -s option.
• We’ve documented the following options:
-D ident Specify the client identifier.
-R Don’t apply the DHCP-supplied default route.
diskboot We’ve documented the -f, -i, and -R options.
etfsctl This command controls all embedded transaction filesystems,
not just those in RAM or SRAM.
New options include:
• -l len — the length for the subsequent -e, -R, or -r option.
• -o offset — the starting offset for the subsequent -e, -R, -r,
-W, or -w option.
• -p — operate in software-update mode.
fs-cifs We’ve documented the -o option, which you can use to specify
various miscellaneous options concerning the handling of
passwords, reconnection timeouts, and the handling of 64-bit
filesystems.
fs-dos.so The fatchk option is no longer supported.
fs-etfs-* All embedded transaction filesystems use the same common
options as fs-etfs-ram.
fs-qnx6.so We’ve changed the ignore value for the sync option to none,
in order to make its meaning clearer. If you specify
sync=none, the filesystem never issues a synchronization
command to the disk, and doesn’t drain dirty blocks from the
filesystem cache (until an explicit umount). The filesystem still
supports the ignore value too.
fs-udf.so New options include:
• charset — specify a non-standard character set mapping
for ISO 9660:1988 Primary Volumes and ISO 96660:1999
Supplementary Volumes.
• raw (replaces vcd) — set the number of raw CDDA/CDXA
2352-byte buffers and optionally the number of blocks to
read with one raw I/O operation.

The blacklist for the verify option now includes some bad
ISO9660:1999 SVD-mastering utilities.
fsysinfo Some of the statistics that this utility displays have changed,
because of the changes to io-blk.so (see below).
gawk We’ve updated the options to reflect version 3.1.5.
gcc On most platforms, the -fpic and -fPIC options are

synonymous, but on PPC they’re different and incompatible.
We chose -fpic over -fPIC for performance reasons, and our
PPC OS is built that way.
gdb If you start it from the command line on a self-hosted QNX

Neutrino system, gdb sets LD_BIND_NOW to 1 to force the
loading of all lazy-load dependencies.
getconf We’ve described the following variables:

• _SC_AIO_PRIO_DELTA_MAX
• _SC_DELAYTIMER_MAX
• _SC_GETGR_R_SIZE_MAX
• _SC_GETPW_R_SIZE_MAX
• _SC_PAGESIZE
• _SC_SEM_NSEMS_MAX
• _SC_SIGQUEUE_MAX
• _SC_THREAD_STACK_MIN
• _SC_TZNAME_MAX
• _PC_ASYNC_IO
• _PC_LINK_DIR
• _PC_PRIO_IO
• _PC_SYNC_IO
gf-calib • There’s a new -g option that lets you specify the GFI input
group to attach to.
ham To stop the HAM, you must use either the ham_stop() function
(see the High Availability Framework Developer’s Guide) or the
hamctrl utility.
head In order to conform to POSIX, we’ve changed the -n option so

that it always specifies the number of lines to copy. The -c
option now takes an argument that specifies the number of bytes
to copy. Note that the -c and -l options are QNX Neutrino
extensions.

helpviewer • If you aren’t using ksh or sh as your login shell, the

environment variables that the helpviewer uses aren’t
initialized.
• The helpviewer might not display all the images in a
document.
hogs This utility gives you a rough idea of what’s happening in your
system. The documentation now describes the limitations on the
data.
if_up We’ve documented the -l option, which causes if_up to wait

until the physical network link is up.
inetd If any errors occur, inetd sends messages to slogger; use

sloginfo to view the system log.
io-blk.so We’ve redesigned the buffer cache subsystem of io-blk.so, to

help improve performance. The following options are no longer
supported:
• bufsz — this is now hard-coded, with 512 bytes as the
minimum device sector size, and 4096 as the maximum (i.e.
bufsz=512:4096)
• hash — now part of the cache option
• postpone — now part of the delwri option
• noaiod
• protect — replaced by the mfu option
• wipe — replaced by the mfu option
The following options are new:
• memory
• mfu
Other changes include:
• You can specify a suffix of g (gigabytes) for memory
arguments.
• The default delay time for delayed writes for fixed media
(delay1 for the delwri option) is now 3 seconds.
• You can now specify the sector size for the ramdisk option;
the sector size was formerly 4 KB.
• You can now specify a hash size to use for the map and
ncache options.
• The default minimum for the ra option is the system page
size; the default maximum is 64 times the system page size.

• The rmvto option can take a value of none, which disables

removable media relearning.
• You can now specify a maximum value for the vnode option.
• The default disk buffer cache is still 15% of system RAM,
but the minimum is 512 KB, and the maximum is 512 MB. If
you specify an explicit size, bounds of 512 KB and 3 GB are
applied.
• By default, io-blk.so now allocates the filesystem buffer
cache (blk cache=) on affected ARM platforms from a
global memory region (SHMCTL_ANON |
SHMCTL_GLOBAL) to avoid the per-process 32 MB
limitation. To override this and make the allocation from the
normal devb-* process heap, specify blk
memory=sysram.
io-display The photon subsection of the display section now supports a

phook option that you can use to load a Photon hook module,
such as the ones that rotate the display.
io-graphics The following options are new:

• -a — enable anti-aliasing on polylines (currently only for
diagonal lines of width 1). This anti-aliasing is only for CRT
or LCD (video) targets, not printer targets.
• -C — allocate all client-side surfaces for CPU Fast Access.
• -L — force a PHOOK module (see the phook option in the
configuration file for io-display) to initialize, even though
the GPU driver was written with non-linear framebuffer
access.
io-pkt-v4, io-pkt-v4-hc, io-pkt-v6-hc
• If a TCP/IP packet is smaller than the minimum Ethernet
packet size, the packet may be padded with random data,
rather than zeroes.
• There’s a new TCP/IP pkt_typed_mem option that you can
use to specify a typed memory object to allocate packet
buffers from.
ksh The pattern .* now matches the . and .. names.
! CAUTION: This could cause problems with scripts that assume that the shell never
matches these names.
link This utility now creates a hard link instead of a symbolic one.
lsm-qnet.so Once Qnet has a domain, you can’t set Qnet to not use a
domain; you can only change the domain.

mcd New -L option to run the MCD in local mode.
mkdir Note that not all filesystems support the creation of directories.
mkefs, mketfs These utilities now support a mountperms attribute that you
can use in a buildfile to specify the permissions to use for
mountpoints. The default permissions are 0777 for mkefs, and
0755 for mketfs.
mkifs • This utility supports the following new attributes:

- +|-big_pages — attempt to align binaries and shared
libraries at the appropriate address, based on the size of
the UIP text.
- pagesizes=size[,size]... — define the page sizes that the
underlying hardware supports, for use with the
big_pages attribute.
You can specify these attributes in the buildfile or in the
bootfile.
• We’ve also documented the following:
- phys_align — specify the physical alignment of
objects.
• The default scheduling priority and policy for processes
launched from a script file are specified by procnto, and
could change in future versions of QNX Neutrino. If the
priority and scheduling policy of the processes are important
to you, be sure to use the pri= modifier.
• The kernel now reaps zombies, even if you run a foreground
process that doesn’t exit in your OS image’s startup script.
However, running a foreground process that never exits still
prevents the rest of the script from being executed.
• The bios.boot file now contains a test to determine
whether or not it should behave like bios_nokbd.boot; it
should work for the majority of platforms that previously
required bios_nokbd.boot.
mount We’ve added some examples that show how to remount a

filesystem as read-only and read-write.
nfsd We’ve documented the following options:

• -c file — use file as the exports file.
• -D — operate in debugging mode.
• -F — truncate the subdirs and mntdtab files, and then
exit.
• -H n — specify the size of the file handle cache hash.
• -o run=foreground — run in the foreground; don’t fork.

• -p n — run nfsd on port n, and don’t register with

portmap.
Note that nfsd supports a maximum of 15 nested directory

levels.
pci This utility is intended for debugging purposes; running it on an

active system may cause some devices to hang.
pdebug We’ve documented the following options:
-1 (“One”) Exit pdebug after the debugging

session is done.
-f Run pdebug as a foreground process.
-n priority_levels Be nice; set the debugged program’s
priority to be priority_levels lower than
pdebug’s.
By default, pdebug now sets LD_BIND_NOW to 1 to force

the loading of all lazy-load dependencies. You can prevent
pdebug from setting LD_BIND_NOW by specifying the new
-l (“el”) option.
pf We’ve made ioctl() compatible with other UNIX-based systems

by enabling support for embedded pointers. This means that
you no longer have to change calls to ioctl() into calls to
ioctl_socket() in networking applications. As a result of this
change, ioctl() can now indicate an error of ENOBUFS if there
isn’t enough memory available to copy the data that the
embedded pointers refer to.
phlip If you specify an ID for a DHCP connection, it’s passed to

dhcp.client with the -h option; if you specify a server IP
address, it’s passed to dhcp.client with the -s option.
phs-to-* These utilities send any error messages to slogger; some may
also send messages to standard error.
phs-to-escp2 This entry now lists the models of printers that the utility
supports.
procnto* • This entry now describes procnto-booke-smp.

• There are new -mr and -m˜r options that enable and disable
address space randomization. Address space randomization
is off by default; if you enable it, the kernel places certain
items (e.g. the stack, libc) at different addresses every time
you run a process. The QNX Neutrino RTOS Safe Kernel
1.0 doesn’t support address space randomization.

qconn We’ve documented the -v option, which makes qconn display

its version number and then exit.
qcp The qcp utility works only on x86 platforms.
sed We’ve updated the options to reflect version 4.1.5.
shelf The -m option was added.
sleep As a QNX Neutrino extension, the time argument can be a

floating point number, so you can specify fractions of seconds.
startup-* (including startup-bios and startup-bios-32)

There’s a new -T option that prevents the startup program from
setting the SYSPAGE_ENTRY(qtime)->boot_time field. If
this field is 0 the first time you call ClockTime() to change the
time of day, the kernel sets it to the appropriate value. This is
useful if the RTC hardware isn’t in UTC.
We’ve documented the -B option, which you can use (if the
BIOS is buggy) to prevent the startup from using the ACPI table
to determine the number of logical CPUs. All x86 startups
support this option.
stty We’ve documented the following options:

• echoke
• echoctl
• imaxbel
• eol2
• swtch
• dsusp
• reprint
• discard
• werase
• lnext
• fwd
• rows
• par
• bits
• stopb
syslogd The documentation now explains when the log entry includes a
host name, and when it includes nto (indicating the local host).
tail If you use both -c and the deprecated -l option, the order of
the options is important.

telnetd New options:

• -h — disable the printing of host-specific information before
logging in has been completed.
• -U — refuse connections from addresses that can’t be
mapped back into a symbolic name.
tftp Remote filenames must start with a /. If a list of directories is

given to tftpd, filenames must be in that list. To get a file, the
file must have world-read privileges; to put a file, the file must
have world-write privileges on the remote machine.
tracelogger • We’ve expanded the description of the modes in which you

can run tracelogger.
• On a multicore system, if the clocks on all processors aren’t
synchronized, then tracelogger will produce data with
inconsistent timestamps, and the IDE won’t be able to load
the trace file.
traceroute We’ve documented the -A and -a options.
traceroute6 We’ve documented the -I option.
unzip, zip We’ve updated zip to Info-Zip version 3.0, and unzip to
version 6.0. These versions provide large file support.
We’ve documented the -P option, which you can use to specify
a password to use to encrypt and unencrypt archive entries.
The versions of these utilities that we ship are for x86 targets
only. We don’t ship them for Linux hosts.
Errata
applypatch Invoke this utility as applypatch, not applypatch.py.
devb-umass, devh-egalax.so, devh-microtouch.so, devh-touchintl.so,
devh-usb.so, devn-asix.so, devu-kbd, devu-mouse, devu-prn
The default USB stack is /dev/io-usb/io-usb, not
/dev/usb.
devg-flat.so We’ve corrected the name of the memopts option.
enum-usb We’ve corrected the name of the cfg_file_path option in the

example.
fs-dos.so The default value of the fat option is nonrmv.
gf-calib The option for specifying the layer index is -l (“el”), not -I.
ifconfig A VLAN tag is a 12-bit number, not a 16-bit number.

mkdir The syntax for this utility isn’t the same on Windows as on QNX
Neutrino.
mkifs • We’ve corrected the example for the raw attribute: you don’t
need to specify this attribute in order to keep PhAB resources
in an executable.
• For MIPS targets, you need to create a symbolic link to
/proc/boot/libc.so.3 called ldqnx.so.3 instead of
ldqnx.so.2.
procnto* We’ve corrected the name of the _NTO_TCTL_IO command for

ThreadCtl().
ps We’ve corrected the options and field names.
unlink In order to unlink a file, you need the appropriate permissions,

but you don’t have to be root.

6.4.1?
• New entries
• Changed content
• Errata
New entries
applypatch Install or uninstall a patch (QNX Neutrino)
devb-ahci Driver for AHCI SATA interfaces (QNX Neutrino)
devg-poulsbo.so Graphics driver for the Poulsbo chipset
devnp-e1000.so Driver for Intel Gigabit Ethernet controllers
devnp-rtl8169.so
Driver for Realtek 8169 Gigabit Ethernet controllers
dig DNS domain information groper lookup utility
dnssec-keygen DNSSEC key-generation tool
dnssec-signzone DNSSEC zone-signing tool
ed Text editor

finstall Install a self-hosted QNX Neutrino system (QNX Neutrino)
WARNING: Running this utility will destroy your current installation of QNX
Neutrino. The only reason we ship finstall is to allow customers to create a
custom installer boot image. This will likely happen only under the direction of
our support staff.
fs-mac.so Shared object that supports Apple Macintosh HFS (Hierarchical
File System) and HFS Plus (QNX Neutrino)
fs-nt.so Shared object that supports the Windows NT filesystem (QNX
Neutrino)
getty Set terminal modes for system access (NetBSD)
host DNS lookup utility
indent Format C source
ldd List the shared libraries that a program requires (Unix)
ln-w Create a “link” on Windows
lwresd Lightweight resolver daemon
mcs Manipulate the comment section of an object file
named-checkconf Tool for checking the syntax of a named configuration file
named-checkzone Tool for checking a zone file
named-compilezone
Tool for converting a zone file
nsupdate Dynamic DNS update utility
op Run a command as someone else
patch Use the output from diff et al. to update a file (GNU)
qbinaudit Compare binaries to the officially distributed versions (QNX
Neutrino)
rndc Name server control utility
rndc-confgen Key-generation tool for rndc
rndc.conf Configuration file for rndc
showlicense Display the type of QNX license that’s currently active (QNX
Neutrino)
top Display system usage (Unix)
unifdef Remove ifdef’ed C/C++ lines

Deprecated content
devn-rtl8169.so
Replaced by devnp-rtl8169.so.
fs-cd.so The fs-udf.so shared object now supports ISO-9660 filesystems

in addition to UDF filesystems. You should use it instead of
fs-cd.so.
procnto-900 Microkernel for PowerPC 900 series processors.
procnto-900-smp
Microkernel for PowerPC 900 series SMP processors.
psin Use pidin instead.
named-xfer Ancillary agent for inbound zone transfers
ap Use aps instead.
Changed content
cam-disk.so It’s possible to specify a starting device number in the name=
option.
CAUTION: Specify device numbers only on a closed system where you know all the
! devices and indexes.
cam-optical.so The arguments of the timeout and verbose options have

changed, and there’s a new rmb option.
chkfsys There’s a new -x option that makes chkfsys exit with detailed
error codes. Without this option, an exit status of 0 doesn’t
indicate that no problems were found with the filesystem(s).
cron There’s a new -s option that makes cron poll for jobs every
minute (to compensate for clock skew).
devb-ram The default amount of cache for a block I/O driver (15% of
system RAM) is too high for devb-ram; you should use the blk
cache=... option to reduce it.
devc-con, devc-con-hid
These managers support international keyboard layouts. You can
use the supplied US-101 or DE-102 (German) layout, or you can
define your own layout.
devf-generic New options:
-d log_method Control the logging from the flash driver.

-e auto Only enumerate the flash partitions, instead of

doing a full scan and mount.
devg-vmware.so VirtualPC and VMWare require a Windows session that’s

operating with 32-bit graphics.
df There’s a new -h option that makes df display the sizes in a

“human-readable” form, using bytes, KB, MB, or GB as the
units.
diskboot There’s a new -u option that you can use to override the options
passed to io-usb.
fdisk • The fdisk info command displays a warning if the number

of sectors reported by the device doesn’t match the product of
the number of cylinders, the sectors per track, and the number
of heads. This is expected for hard drives that use zoned bit
recording.
• We’ve added more information about partition types, the
corresponding filesystems, and the commands you use to
initialize the filesystems.
fs-cd.so, fs-dos.so, fs-ext2.so, fs-qnx6.so, fs-udf.so

All our disk filesystems except fs-qnx4.so use UTF-8
encoding for presentation of their filenames; attempts to specify a
filename not using UTF-8 encoding will fail (with an error of
EILSEQ) on these filesystems.
fs-qnx6.so The Power-Safe filesystem was designed for and is intended for
traditional rotating hard disk drive media. It can’t guarantee
power-safe robustness if the drive can’t ensure that data is flushed
to the storage medium. For more information, see “Required
properties of the device” in the entry for fs-qnx6.so.
fs-udf.so In addition to supporting UDF (OSTA-UDF/ECMA-167)

filesystems, fs-udf.so now supports ISO-9660 (base 1998
spec, 1999 spec, Joliet extensions, Rock Ridge extensions). As a
result, it has the following new options:
Control the case used to display ISO-9660
filenames.
format=list Set both the list of disk formats to support, as well
as the order in which they should be probed.
info=path The first character of the path can be + or -, and
this controls whether empty entries (metadata
descriptors not given a value) are shown in the
directory or not, respectively.

perms=[file_permissions][:directory_permissions]
The permissions to use for ISO9660 files,
directories, or both.
This filesystem also has a new vcd=num option that you can use
to set the number of raw VCD 2352-byte deblocking buffers.
fsysinfo The output now includes statistics about the number of pages
mapped in and released by the heap-allocation subsystem.
ftp We’re using a newer version of ftp, so we’ve updated the link to
ftpd We’ve restored the “Setting up a restricted ftp subtree” section

that was removed from the documentation for QNX SDP 6.4.0.
gcc • The -mno-fp-moves option (a QNX Neutrino extension)

prevents the code generator from using floating point registers
to move integers. Using floating point registers for this is very
slow on systems that use floating point emulation.
• Even with exceptions disabled, the new() operator throws a
std::out_of_memory exception if there isn’t enough
memory. If you want new() to return NULL instead of
throwing an exception, overload the new() operator with your
own.
inetd Use the -D option to force inetd to daemonize by calling

procmgr_daemon() instead of calling daemon(). You need to
specify the -D option to inetd if you’re running it under the
control of the High Availability Manager.
io-blk.so • We now explain how you can use the naming= option to
specify the naming scheme for devices and partitions.
! CAUTION: Use something other than the default (0#) scheme only on closed
systems, and at your own risk.
• We’ve updated the options:
- delwri — now specifies the delay time for delayed writes
on fixed and removable media.
- enumpart — set the order for enumerating disk partitions.
- hash — removed.
- nora — replaced by ra.
- priority — set the priority of periodic filesystem
callouts.
- ra — set the minimum and maximum size of the
read-ahead buffers.
- [no]rmv — don’t/do allow invalid mounts on removable
media (re-insert).

io-pkt-v4, io-pkt-v4-hc, io-pkt-v6-hc

• The stack processes a generic name= option that lets you
override the default interface prefix used for network drivers.
• The stack processes the following driver options for all USB
drivers using the NetBSD-to-QNX conversion library to let
you identify a particular USB device using information
obtained from running usb -v:
- did=ID — device product ID
- vid=ID — device vendor ID
- devno=addr — device address, as reported by the usb
utility
- busno=num — host controller, as reported by the usb
utility
io-usb You can use the -P option to specify the priority of the server.
ls If you’re using Qnet, doing something like ls -R /net can take

a very long time because it recursively lists all the directories on
all the machines on your network.
mkefs • You can specify a value of none for the filter attribute.
• You can use the -c option to specify a directory in which to
cache compressed files.
mketfs You can specify a value of none for the filter attribute.
mkifs • You can specify a value of none for the filter attribute.
• If you turn compression on with the +compress attribute, you
can optionally specify the algorithm by number.
mkqnx6fs New options:

• -O options — specify boot options.
• -o options — specify filesystem options.
The -T option is intended to replace explicit -b, -g, -i, and -r
values.
mksbp This entry now describes how to build a System Builder project
that’s inside a workspace or just logically linked to one.
mount By default, filesystems are mounted as read-write (if the physical

media permit it), but you can use the -r option to mount them as
read-only.
named Updated to reflect BIND9.
/etc/named.conf
Updated to reflect BIND9.

nfsd If you change the exports file, you can make nfsd aware of the
changes by either restarting it, or by sending it a SIGHUP signal.
ntpd, ntpdate For information about the associated configuration files, see
ntp.conf and ntp.keys in the FreeBSD documentation.
on We’ve documented the -P option, which spawns the process,

setting the SPAWN_PADDR64_SAFE flag to indicate that the
process is known to operate safely with 64-bit addressing or
doesn’t care about the physical memory location.
pci-bios All PCI servers have an -x option that prevents the server from
removing devices from the PCI bus while enumerating them.
phlocale This utility creates or updates /etc/country to indicate the

country you’re in, based on your selection of the time zone.
phs-to-bjc, phs-to-bmp, phs-to-escp2, phs-to-ijs, phs-to-pcl,
phs-to-ps
The -L option was removed from these utilities.
pidin • This utility now supports the following shorthand names:

- backtrace — display a backtrace of the calling routines
for each thread in the displayed processes.
- channels — display the lengths of the send, receive,
reply and pulse queues.
- mapinfo — show information about memory mappings.
• We’ve added more details about the output of the memory
argument.
• The pidin syspage command now displays the
CPU-dependent, mdriver, and pminfo sections of the system
page.
pppd The ccp option is no longer supported because CCP

(Compression Control Protocol) negotiation is enabled by
default. The vj option (for enabling Van jacobson style TCP/IP
header compression) is also no longer supported. QNX Neutrino
supports multilink PPP.
procnto* • The Process Manager component of procnto implements a

/proc filesystem that lets you access and control every
process and thread running within the system. For more
information, see “Controlling processes via the /proc
filesystem” in the Processes chapter of the QNX Neutrino
• New options controlling the defragmentation of physical
memory:

-ma Automatically mark memory pages that have a

mem_offset() performed on it as unmovable when
defragmenting physical memory.
-mã Disable the automatic marking of memory pages as
unmovable (the default).
-md Enable the defragmenting of physical memory (the
default).
-m˜d Disable the defragmenting of physical memory.
For more information, see “Defragmenting physical memory”
in the Process Manager chapter of the System Architecture
guide.
QCC Even with exceptions disabled, the new() operator throws a

std::out_of_memory exception if there isn’t enough memory.
If you want new() to return NULL instead of throwing an
exception, overload the new() operator with your own.
qconfig We’ve explained why you should use QWinCfg instead of

qconfig on Windows.
QWinCfg Click the Show Packages.. button to display a list of the QNX
packages that you’ve installed on your system.
setkey We’ve updated the list of supported algorithms. This utility now
supports the 3des-deriv encryption algorithm.
tail The options for this utility now conform to POSIX; to copy a
given number of bytes, use the -c number option.
tftp There’s a new -e option and port argument, and several new
commands:
• blksize blk-size
• tout
• tsize
tr You can specify ranges of characters with or without square

brackets.
traceroute The documentation now includes these options:

• -d — turn on socket-level debugging.
• -P — set the “don’t fragment” bit and use the next hop MTU
each time a “need fragmentation” error is received, thus
probing the path MTU.
wpa_supplicant We’ve updated the documentation to reflect the NetBSD version

5.0 of this daemon.

GNU binutils ( addr2line, ar, c++filt, gprof, ld, nm, objcopy, objdump,
ranlib, readelf, size, strings, strip)
For detailed documentation about these utilities, see the GNU
We once again support MIPSBE and MIPSLE targets.
Errata
arp We’ve updated the documentation to reflect the currant usage
message.
cam-optical.so We’ve corrected the syntax of the retries and translation

options.
devc-con, devc-con-hid, devc-par, devc-serpci

These drivers are for x86 targets only.
devc-serzscc This driver is for PPCBE and x86 targets only.
devn-* Legacy io-net drivers create entries under /dev/io-net, not

under /dev/io-pkt.
devn-el509.so, devn-sis9.so
You can use these drivers with any variant of io-pkt, not just
io-pkt-v4.
devnp-i82544.so
• The default for the irq_thresh option is 9000.
• The default for the transmit option is 4096.
• This driver doesn’t support the promiscuous option; the
only way to enable promiscuous mode is by issuing an ioctl()
command.
devnp-mpc85xx.so, devnp-mpcsec.so
These drivers are shipped only with the BSPs that need them.
dhcp.client We’ve updated the documentation to reflect the currant usage

message.
dloader We’ve updated the description of QNX_TARGET.
enum-devices When specifying a device, vend should actually be ven.
fs-qnx6.so We’ve corrected the description of the sync option.
/etc/inetd.conf
A server doesn’t need to explicitly leave the master socket open
when it exits.

ld We’ve corrected the description of the LD_PRELOAD

environment variable.
ldrel The -S option adds a note that specifies the maximum (not
minimum) stack size. If you don’t specify -L, the stack is
specified as non-lazy.
mkifs We’ve removed a reference to vmware.boot, which we no

longer ship.
ntomulti-* variants
We’ve removed references to the ntomulti-* variants (which
we no longer ship) of addr2line, ar, gprof, nm, objcopy,
objdump, size, strings, and strip.
pf Although the NetBSD documentation talks about ioctl(), you

should use ioctl_socket() instead in your packet-filtering code.
With the microkernel message-passing architecture, ioctl() calls
that have pointers embedded in them need to be handled
specially. The ioctl_socket() function will default to ioctl() for
functionality that doesn’t require special handling.
pppd Some of the options aren’t specific to QNX Neutrino, but aren’t
described in the NetBSD documentation.
uesh Starting in QNX SDP 6.4.0, uesh can accept a script file as an
argument. The micro-embedded shell doesn’t support filename
expansion, so * and ? aren’t special characters.

6.4.0?
• New entries
• Changed content
• Errata
New entries
ap Create, modify, and query adaptive partitions for the thread
scheduler and memory allocator.
brconfig Configure network bridge parameters
chattr Manipulate the attributes of a file (QNX Neutrino)

chkqnx6fs Check an entire Power-Safe filesystem for consistency (QNX

Neutrino)
deva-ctrl-intel_hda.so
Sound driver for the Intel High Definition Audio controllers
deva-mixer-hda.so
Mixer DLL for High Definition Audio codecs
devc-serpci Driver for serial PCIs
devc-serusb Driver for USB-to-serial adaptors
devg-gma9xx.so Graphics driver for Intel 945GX and 945GMx chipsets
devg-soft3d.so Software 3D graphics module
devh-egalax.so Driver for USB Egalax touch devices
devh-touchintl.so
Driver for USB Touch International touch devices
devi-semtech Semtech input manager for Photon
devi-zytronic Zytronic input manager for Photon
devn-asix.so Driver for the ASIX AX88172/AX88772 USB Ethernet dongle
devn-micrel8841.so
Driver for Micrel 8841 (1 port) or 8842 (2 port) Ethernet
controllers
devn-rtl8169.so Driver for Realtek 8169 Gigabit Ethernet controllers
devnp-ath.so Driver for wireless network adapters based on the Atheros

AR5210, AR5211, AR5212, and AR5213 chips
devnp-axe.so Driver for USB (2.0) Ethernet adapters based on the ASIX
AX88172 chip
devnp-bcm1250.so
Driver for Broadcom BCM1250 10/100/1000 Mbit Ethernet
controllers
devnp-bcm43xx.so
Driver for the Broadcom-based 802.11b/g wireless Ethernet
controller
devnp-bge.so Driver for Broadcom 57xx Tigon3 10/100/1000 Mbit Ethernet

controllers

devnp-i82544.so Driver for Intel 82540, 82544, 82545, 82546, and 82547 Gigabit
Ethernet LAN adapters
devnp-mpc85xx.so
Driver for Freescale MPC85XX TSEC Ethernet controllers
devnp-mpcsec.so Hardware Crypto Engine driver
devnp-msk.so Driver for Marvell Yukon-2 based Gigabit Ethernet adapters
devnp-ral.so, devnp-ural.so
Driver for wireless adapters based on the Ralink RT2500,
RT2501, RT2600, and RT2500USB chipsets
devnp-rum.so Driver for USB 2.0 wireless adapters based on the Ralink
RT2501USB and RT2601USB chipsets
devnp-shim.so “Shim” driver for backward compatibility with io-net
devnp-speedo.so Driver for Intel 82557, 82558, and 82559 Fast Ethernet LAN
adapters
dispconf Generate display configuration data
enum-usb Enumerate devices on the USB bus
fs-qnx6.so Shared object that supports the Power-Safe filesystem (QNX

Neutrino)
fs-udf.so Shared object that supports Universal Disk Format

(OSTA-UDF/ECMA-167) filesystems
fsysinfo Display filesystem statistics (QNX Neutrino)
gf-calib Calibrate a GF touchscreen (QNX Neutrino)
ham High-availability manager
hamctrl Control a high-availability manager
hostapd Authenticator for IEEE 802.11 networks
ifwatchd Watch for addresses added to or deleted from interfaces and call
up/down-scripts for them
io-display QNX Advanced Graphics server
lsm-autoip.so AutoIP negotiation module for link-local addresses
lsm-pf-v4.so, lsm-pf-v6.so

lsm-qnet.so Transparent Distributed Processing (native QNX network)

module
We added the following options:
• enforce_crc — discard packets that don’t have a valid
software-level CRC generated by the remote node.
• max_num_l4s — the number of interfaces.
• max_tx_bufs — the number of npkts to cache internally
for transmission.
• mtu_en — the maximum transmission unit (MTU) of a Qnet
packet.
• no_slog — don’t send error messages to slogger
• qos_per_pri, qos_tx_pri — the priority of the pulses
for the QoS periodic transmission thread and the QoS
transmission thread.
• res_retries — the number of times the Ethernet resolver
retries to resolve a node.
• res_ticks — the number of periodic ticks before the
Ethernet resolver retransmits a node-resolution request.
• vtag — insert a four-byte vlan tag into a packet.
The combination of bind=ip and resolve=file isn’t
supported.
mcd Media Content Detector utility
mkqnx6fs Format a Power-Safe filesystem (QNX Neutrino)
/etc/nsswitch.conf
Name-service switch configuration file. This file replaces the
lookup keyword in /etc/resolv.conf.
openssl Command-line tool for using the OpenSSL crypto library
paste Merges lines of input files, and writes the resulting lines to
standard output. (POSIX)
pf Packet Filter pseudo-device
pf.conf Configuration file for pf
pfctl Control the packet filter (PF) and network address translation
(NAT) device
phrelaycfg Configure remote access to your Photon session
pppoectl Display or set parameters for a PPPOE interface
python Object-oriented programming and scripting language

shelf Photon shelf manager
showmem Display memory information
showmount Display memory information
sockstat List the open sockets
tcpdump Dump traffic on a network
tracelogger We’ve added the -A, -c, -P, and -R options and updated the
descriptions of the other options.
traceprinter We’ve added the -o option.
uudecode Decode a file that was encoded with uuencode
uuencode Encode a binary file or standard input into ASCII
who List the logged-in users
wpa_cli WPA command-line client
wpa_passphrase Set WPA passphrase for a SSID
wpa_supplicant Wi-Fi Protected Access client and IEEE 802.1X supplicant
Deprecated content
Instead of using: Use:

crttrap N/A
flashcmp deflate and inflator
fontadmin See phfont
fontsleuth N/A
fontview N/A
gri-photon.so N/A
icc N/A; no longer shipped
info N/A; no longer shipped
io-net io-pkt*
ipf, ipfs, ipfstat, ipmon, ipnat pf, pf.conf, pfctl
lsm-ipfilter-v4.so, lsm-ipfilter-v4.so lsm-pf-v4.so, lsm-pf-v6.so
continued. . .

Instead of using: Use:

lsm-sctp.so N/A; not currently supported by io-pkt*
mmplay QNX Aviage Multimedia Suite
netfront Web Browser TDK
nfm-autoip.so lsm-autoip.so
npm-pppmgr.so Now included in io-pkt*
npm-pppoe.so Now included in io-pkt*
npm-qnet.so, npm-qnet-l4_lite.so lsm-qnet.so
npm-qnet-compat.so N/A
npm-tcpip.so N/A
npm-tcpip-v4.so, npm-tcpip-v6.so Now included in io-pkt*
npm-ttcpip.so N/A
phplay QNX Aviage Multimedia Suite
phrecord QNX Aviage Multimedia Suite
playaudio QNX Aviage Multimedia Suite
playaudiocd QNX Aviage Multimedia Suite
psin pidin, sin
qnxplayer QNX Aviage Multimedia Suite
voyager Web Browser TDK
vserver Web Browser TDK
• For information about the replacement for packagebsp, see

http://community.qnx.com/sf/wiki/do/viewPage/projects.bsp/wiki/Packaging_BSP
on our Foundry27 community website.
• We’ve deleted the entries for the following drivers, some of which are for
unsupported or obsolete boards:
- deva-ctrl-cyberpro5.so
- deva-ctrl-tahoe.so
- devb-aha2
- devb-aha4
- devb-aha7
- devb-amd
- devb-ncr8

- devc-amctap, devc-tamctap
- devc_amctap_host
- devc-hspi
- devc-netrom540, devc-tnetrom540
- devc-ser2681, devc-tser2681
- devc-ser403, devc-tser403
- devc-ser8250-ixp2400, devc-tser8250-ixp2400
- devc-serdsiu, devc-tserdsiu
- devc-sergt64260
- devc-serppc800, devc-tserppc800
- devc-serpsc
- devc-sersci
- devc-tcon
- devc-tser8250
- devc-tserzscc
- devg-banshee.so
- devg-igs5000.so
- devg-mach64.so
- devg-matrox.so
- devg-mq200.so
- devg-neomagic.so
- devg-orchid.so
- devg-pxa250.so
- devg-q2sd.so
- devg-ravin.so
- devg-rotate90.so
- devg-rotate270.so
- devg-rpxlite.so
- devg-s3.so
- devg-sa1110.so
- devg-stpc.so
- devg-vga.so
- devgt-iographics
- devi-ahl
- devi-carrol
- devn-artesyn.so
- devn-bcm43xx.so

- devn-cpci-mcp750.so
- devn-eepro.so
- devn-el589.so
- devn-gt64260.so
- devn-klsi.so
- devn-lance.so
- devn-ne2000-403.so
- devn-ns83815.so
- devn-orinoco.so
- devn-ppc405.so
- devn-ppc800-ads.so
- devn-ppc800-cllf.so
- devn-ppc800-mbx.so
- devn-ppc800-rpxlite.so
- devn-ppc8260.so
- devn-ppc860_mii.so
- devn-prism.so
- devn-rlan2.so
- devn-tulip-p5064.so
- devn-wd.so
- pci-artesyn440
- pci-artesyn750fx
- pci-brh
- pci-cpc700
- pci-ixc1100
- pci-ixp2400
- pci-mpc8266
- pci-p5064
- pci-ppc440rb
- pci-raven
- pci-sandpoint
- pci-yellowknife
- startup-403evb
- startup-603evb
- startup-79s465
- startup-800fads
- startup-8260ads

- startup-artesyn
- startup-artesyn750fx
- startup-aspen
- startup-bigsur
- startup-cpci-6750
- startup-ddb-vrc5074
- startup-integrator
- startup-malta
- startup-mbx800
- startup-mcp750
- startup-mcpn765
- startup-mtx600
- startup-mvme
- startup-mvp
- startup-p5064
- startup-rpx-lite
- startup-sa1100-mm
- startup-sa1110-db
- startup-sandpoint
- startup-sengine
- startup-vme603
- startup-vr41xx
- startup-walnut
• We’ve removed the entries for board-specific devf-* drivers. All the flash
filesystem drivers use the same options as devf-generic.
• We’ve removed the entries related to the package filesystem:

- fs-pkg
- packager
- pkgctl
- qnxinstall
• We no longer support ARMBE, MIPSBE, and MIPSLE targets.

Changed content
cam-cdrom.so, cam-disk.so, cam-optical.so
We’ve documented the retries, timeout, and verbose
options.
devf-generic, devf-ram
The maximum number of threads that you can specify with the
-t option has increased from 4 to 100.
devn-* We’ve added some information about hardware checksumming.
devn-i82544.so We’ve documented the pauseignore and pausesuppress

options and updated the default values for the receive and
transmit options.
devn-speedo.so We’ve added the probe_phy option, which you can use to
enable or disable the probing of the PHY device.
df This utility rounds its figures into 512- or 1024-byte blocks

(depending on the options), and it always rounds down. If the
filesystem doesn’t use a block size that’s a multiple of 512 bytes,
some rounding errors will occur.
dinit We recommend that you use dinit to initialize a QNX 4

filesystem, and dloader to make it bootable. The dinit
bootloader options are for backwards compatibility reasons, but
aren’t generally used anymore.
dumper There’s a new -z option that makes dumper compress the core
files.
enum-devices • The start, requires, and driver clauses now support a

/wait option that makes the enumerator pause until the
command associated with the clause terminates.
• The macro for starting core networking is now IOPKT_CMD.
flashctl There’s now a section that describes the information that’s

displayed if you specify the -i option.
fs-cd.so We’ve added these options:

• case — control how ISO-9660 filenames should be
displayed. The case option can now have a value of asis.
• exe — set execute permission (on all non-RRIP regular files).
• nohsf — disable High Sierra format.
fs-dos.so The following options have changed:

• case — new

• codepage — these names are also used for the volume label
• compat — supports a value of os2
• fat — new
fs-etfs-ram An ETFS filesystem is no longer mounted by default; you can

use the -m option or mount -tetfs /dev/etfs2
my_mountpoint.
fs-qnx4.so We’ve added the following options:

• bitmap — when to pre-read .bitmap files.
• grown — allow persistent over-grown files (sticky
O_APPEND allocation).
We’ve deprecated the rmvbmap option; it’s equivalent to bitmap=always.
ftp, ftpd We now use the NetBSD 4.0 version of these programs, although
ftpd also supports the -n option that was added after version
4.0.
gzip You can now use gzip to compress or expand files in a RAM
filesystem (/dev/shmem), but you need to specify the -f option.
ifconfig Updated to work with io-pkt*.
io-blk.so • The alloc option now specifies an allocation mode instead of

an amount of memory to allocate.
The default values of the following options have changed:
- bufsz — now 512:8K
- fdinfo — now always
- thread — now 12:2:5
• The optional level argument to the verbose option indicates
which categories of events to log.
• We’ve added the marking option.
ksh You can now use the Tab key to complete the names of files and
commands.
mkifs • We’ve added the cpu modifier to the description of script files.
• The /usr/lib/ldqnx.so.2 symbolic link should now
point to /proc/boot/libc.so.3, and you should include
libc.so.2 in the list of binaries before libc.so.
• The documentation now describes the -s option and the
+|-page_align attribute.
• We’ve updated the default linker specification.
mount We’ve documented the -a option.

mq The /dev/mq directory doesn’t appear until you actually create a

queue.
mqueue The /dev/mqueue directory doesn’t appear until you actually

create a queue.
nicinfo This utility has been updated to work with io-pkt*.

The documentation now describes the -c, -g, and -s options.
pppd For information about this daemon (including exit codes), see the
NetBSD documentation. We’ve documented the options that are
specific to Neutrino.
pidin We’ve added more details about the information that the fds
shorthand gives.
photon We’ve added the -U, -C, and -T options.
ping This utility has been updated to work with io-pkt*.

If a name server isn’t responding, there’s a timeout of 1.5 minutes
per name server.
phs-to-pcl We’ve updated this filter to be based on HP’s Appliance Printing

Development Kit (APDK), a library that generates PCL output
for a wide range of HP printers. The -m model command-line
option is now mandatory. The command-line options have
changed; phs-to-pcl ignores those are no longer applicable.
pppoed This binary is now simply a shim layer that phdialer uses to
dial up PPPOE.
procnto* • If you’re using an SMP version of procnto, you can use the
appropriate startup-* command’s -P option to specify the
maximum number of CPUs to activate.
• There’s a new procnto-v6 version of the kernel that
supports ARMv6 processors.
• There are new procnto-900 and procnto-900-smp
versions of the kernel that support PowerPC 900 series
processors.
• New options:
- -en and -eo — control the value of EALREADY, which is
changing so that it will be POSIX-compliant. For more
information, see “Changes to EALREADY” in the entry for
errno in the Neutrino Library Reference.
- -mP — turn on full allocation of high memory for all
processes. This is mostly useful only for testing.
- -m˜P — make sure that all anonymous allocation occurs
below the 4 GB mark (the default).

- -m[˜]v — enable or disable variable page sizes. They’re

enabled by default.
- -m[˜]x — enable or disable the PROT_EXEC flag for
system-allocated threads. It’s enabled by default.
- -T — specify the number of seconds to wait for a close() to
succeed in the event of process termination.
- -u — specify the umask to use when creating the entries in
/proc/pid/as.
qcc The -M option to qcc isn’t changing to -Map as we warned in

earlier releases; qcc continues to use -M for generating a mapfile.
qconfig This utility doesn’t list the installed packages in any particular
order.
qde We no longer ship the Neutrino-hosted IDE, so qde now runs

only on Linux and Windows development hosts.
random This utility creates /dev/urandom as well as /dev/random.
rtsold This daemon now has an -a option that lets you autoprobe the
outgoing interface.
ruptime, rwho, rwhod

The data files that these programs use are now in /var/rwho
instead of /usr/spool/rwho, to conform to the Filesystem
Hierarchy Standard.
rwhod This daemon now has -i and -u options for setting the broadcast
interval and the user to run as.
setkey Updated to work with io-pkt*.
slay If you change the runmask for a process, the processor for
blocked threads doesn’t change until the threads become
unblocked (or never if the threads remain blocked).
slogger There’s a new -c option that you can use to open the log file with
O_SYNC to forcibly commit the logged events to the disk.
sysctl The available variables depend on what you’re running on your

machine; we’ve described the ones that you’re most likely to be
interested in.
tftpd We now use the NetBSD 3.0 version of this daemon, so the
options have changed.
tinit • We’ve added the -f and -t options.

• We’ve described the way that tinit parses its configuration
file.

which We’ve added the -s option, which makes the utility search for
shared objects in the directories identified by the
LD_LIBRARY_PATH environment variable and the
_CS_LIBPATH configuration string.
Errata
calib We’ve corrected the list of options.
chkfsys This utility doesn’t prevent itself from operating when files are open
for writing on the drive.
crontab If you want the output from your commands, redirect it to a file.
devf-* • If you specify the -V option, the driver displays the filesystem and
MTD version information, and then exits.
• The bwidth and ileave values for the -s option must be powers of
2, but you don’t specify them as powers of 2. For example, if the
width of the data bus is 8, specify a bwidth of 8, not 3 (for 23 ).
etfsctl Existing IPLs and bootloaders can’t boot from an image in an

embedded transaction filesystem.
find We’ve corrected the description of the %a and %A formatting codes.
lpr The printer argument to the -P option must be a printer name that’s
defined in /etc/printcap.
mkifs • You can use mkifs to build nonbootable images. For an example,
see the Making Multiple Images technote.
• You have to specify both image and ram file attributes if you want
to create the image in ROM/FLASH; otherwise the process
manager assumes that the image is in RAM.
• The mkifs utilities no longer strips the QNX_Phab (Photon
resources), QNX_usage (usage message), and QNX_info (build
properties) sections by default. You can use the -s option to
specify additional sections not to be stripped.
• Startup code can be decompressed in place.
• Attributes that you specify with attr=image_attribute in the
bootfile are processed after the -l (“el”) command-line options
and the buildfile, but you normally use the ? prefix on the
image_attribute, so that it doesn’t override anything explicitly set
by the -l option or the buildfile.
ntpd After the machine has synchronized to a NTP server, the operating
system time gets synchronized and corrected from time to time. This
doesn’t set the hardware clock; you can use the rtc utility to set the
time on the chip.

© 2010, QNX Software Systems GmbH & Co. KG. What’s new in QNX Momentics 6.3.2?
pidin If you use pidin thread or pidin -F%h to display the thread
names, and a thread doesn’t have a name, pidin displays the thread’s
ID (tid) instead.
procnto* • The example implied that using the -p option disables

preemption; it actually disables preemption only in the kernel
code.
• Specifying the -as option on SH platforms is the same as
specifying -ad, not -ae.
random If an error occurs, random sends a message to slogger, not to

stderr.
renice This utility changes the priority of all the threads in the specified
process or processes.
slogger We’ve corrected the description of /dev/console, what happens

when multiple applications open /dev/slog for reading, and the
example of alternating between files.
startup-* The -R option can include an alignment as well as a size.
What’s new in QNX Momentics 6.3.2?

The changes in QNX Momentics 6.3.2 include the following:
• New entries
• Changed content
• Errata
New entries
devb-umass • There’s a new iface= option for specifying the interface
• There’s a new ignore_csw option that makes the driver
ignore the Command Status Wrapper.
devc-con-hid This console and keyboard I/O manager is similar to devc-con,

but works in conjunction with io-hid and supports PS2, USB,
and all other human-interface devices.
devc-serpsc PSC UART serial communications manager for MPC5200
devg-carmine.so
Graphics driver for Fujitsu Carmine chipsets
devg-extreme2.so
Graphics driver for Intel Extreme2 chipsets

What’s new in QNX Momentics 6.3.2? © 2010, QNX Software Systems GmbH & Co. KG.
devg-vmware.so Graphics driver for VMWare virtual machines
devn-rtl8150.so
Driver for SMC2208 USB/Ethernet adapters
packagebsp Package a board support package (QNX Neutrino)
setupbsp Set up a Board Support Package (QNX Neutrino)
startup-bios The -I option is now documented. You can use this option to
specify the highest-priority hardware interrupt.
use There’s a new -s option that you can use to display the version
numbers of the source used in the executable.
Changed content
devc-sersci Added the default values for the -r option for SH7770 and
SH7780.
devu-prn Added the -m option.
flashctl This utility rounds the values of the -o and -l (“el”) options down
to the nearest block bound. If the range specified exceeds the
partition size, it’s rounded down to fit. If you use the -v option,
flashctl displays what the values have been rounded to.
io-blk.so • Added the before and after options.

• If you specify the verbose option, the extra information is sent
to the system logger. The optional level argument indicates
which categories of events to log.
mkifs This entry now describes the main bootfiles, including raw.boot,
elf.boot, binary.boot, and srec.boot; see the “Bootfile”
section.
You might need to use the perms attribute to specify execute,
setuid, and setgid permissions if you’re running mkifs on a
Windows host.
mount Added the before and after options, and added io-usb to the
table of mount types.
qconfig Added the -c option.
pidin The CPU usage that pidin times reports are approximate, and
can be inaccurate.
rpcbind This utility needs /etc/netconfig, the librpc shared library,

as well as some specific entries in /etc/services.

© 2010, QNX Software Systems GmbH & Co. KG. What’s new in the QNX Neutrino Core OS 6.3.2?
setuid utilities The following utilities need to have the setuid bit set in their
permissions: crontab; dhcp.client; fontsleuth;
input-cfg; inputtrap; login; lpr; lprq; lprrm; netstat;
newgrp; passwd; phfont; phgrafx; phlocale; Photon;
phshutdown; phuser; ping; ping6; pppd; pppoed;
qnxinstall; rcp; rlogin; rsh; su; traceroute;
traceroute6.
Errata
devf-* We’ve corrected the description of the -r option for the devf-*
drivers. You should always specify this option, unless you’re
debugging a problem concerning filesystem corruption.
grep Only grep supports the -h option (which is a Neutrino extension);

egrep and fgrep don’t.
mkefs, mketfs, mkifs

The description of the perms is now correct; for an inline file, the
default permissions are 0666.
show_vesa You must log in as root and be in text mode — not Photon — to run
this utility. This utility doesn’t have any options.
stty The stty under Neutrino doesn’t support the lkhflow or lksflow
option.
What’s new in the QNX Neutrino Core OS 6.3.2?

The changes in the QNX Neutrino Core OS 6.3.2 include the following:
• New entries
• Changed content
• Errata
New entries
aps Manage adaptive scheduler partitions
Changed content
devb-ram Added address, blksize, and nodinit to the list of ram options.
mkifs Now includes the module attribute for loading optional modules into
procnto.
on Now includes -C, -i, and -R options for specifying the runmask for
the new process.

What’s new in QNX Momentics 6.3.0 Service Pack 2? © 2010, QNX Software Systems GmbH & Co. KG.
pidin Now includes H, h, i, and o formatting codes, and extsched, fds,

regs, sched, and threads shorthand names.
procnto Now includes -m and -c options.

slay Now includes -C, -i, and -R options for manipulating the runmask,
and -T for identifying the thread that you want to send a signal to or
whose runmask or priority you want to change. Also includes -m
option to restrict the match.
-P without -T now affects all threads in the specified process or
processes. Previously it affected only thread 1.
This utility now matches process IDs or names; you can use the new
-m option to limit which it matches.
startup-* Now include a -F option to control the flags field in the cpuinfo
section of the system page.
qconfig Added the -a, -b, and -p options.
Errata
dcheck Corrected the name of the .bad_blks file.
passwd The second field of entries in the /etc/passwd file is an x. It represents
the group password, which Neutrino doesn’t support.
What’s new in QNX Momentics 6.3.0 Service Pack 2?

The changes in QNX Momentics 6.3.0 SP2 include the following:
• New entries
• Changed content
• Errata
New entries
addr2line Convert addresses into line number/file name pairs
bindres Bind widget resources into an executable
c++filt Demangle C++ and Java symbols
g++ Compile a program
mq A new server to manage POSIX message queues. This is an alternate
implementation that uses asynchronous messages
phfind Photon file search utility
ranlib Index an archive

© 2010, QNX Software Systems GmbH & Co. KG. What’s new in QNX Momentics 6.3.0 Service Pack 1?
Changed content
devg-* Changed the -amode option in all the devg-* driver docs to
mode_opt
devu-kbd Reinstated class driver for USB keyboards
devu-mouse Reinstated class driver for USB mice
esh, fesh Added the emount and ewaitfor builtin commands.
nto*-* variants Added synopsis information for the ntoarm-*, ntomips-*,

ntomulti-*, ntoppc-*, ntosh-*, ntox86-* variants of: ar,
gcc, gcov, gdb, gprof, ld, nm, objcopy, objdump, size,
strings, and strip.
qcc The -w9 option’s behavior is specifically documented, with

additional options necessary to report all warnings.
qconn Added more description to the qconn_prio= option to prevent

errors when the system is under heavy load.
sendnto Documented -b option.
su Documented - userid argument.
tracelogger Now accepts control commands through its device, devctl() and
pulses, and has a new option (-c).
uesh Added the emount and ewaitfor builtin commands.
usemsg %1> and %2> macros fixed (were previously documented as %0>
and %1>).
usemsg also uses objcopy by default instead of ldrel.
Errata
io-blk.so If you don’t specify a full path for the device in the automount
option, io-blk.so uses the value of its devdir option as a prefix.
What’s new in QNX Momentics 6.3.0 Service Pack 1?

The changes in QNX Momentics 6.3.0 SP1 include the following:
• New entries
• Changed content

What’s new in QNX Momentics 6.3.0 Service Pack 1? © 2010, QNX Software Systems GmbH & Co. KG.
New entries
dumpefs Dump an embedded filesystem
gcov Gather code coverage data
gprof Code profiler
lsm-sctp.so SCTP service module
qde Launch QNX development environment
unzip Extract zip files
zip Compress and package files
Changed content
bootpd Now included in the Neutrino runtime.
devb-ncr8 Added the did option.
devf-* Removed references to ffs2 and removed mountpoint/.cmp from

all the devf-* drivers.
devg-matroxg.so
Added more information to the supported chipsets and a note
about multiple displays on quad-output cards.
devg-radeon.so
Removed the -amode=TV option and added information about
dual-headed display.
dhcp.client Added the -T option and a description of the

/etc/dhcp/dhcp-options file.
getconf Added _CS_LOCALE to the list of configuration strings.
io-net The /dev/io-net directory doesn’t appear until a driver or

protocol module adds an entry to it.
npm-qnet-l4_lite.so
Qnet is designed to work using its default settings; don’t use the
options to npm-qnet-l4_lite.so unless you have a specific
problem with your environment.
pppd Added a caveat about spawning pppd with the nodetach or

updetach option.
phfont Added the new -b option to save font usage information to a file.
setconf Corrected the list of configuration strings.


• New entries
• Deleted entries
• Changed content
• Errata
New entries
bkgdmgr Photon background manager
devb-adpu320 Adaptec 7901/7902-based SCSI adapters
devb-umass Driver for USB mass storage interface
devc-hspi Serial driver for Renesas protocol interface
devc-ser8250-ixp2400
Serial driver for Intel IXP425 BSP
devc-sergt64260 Serial driver for Artesyn PM/PPC 750FX BSP
devf-brh Driver for ADI BRH BSP
devf-ixdp425 Driver for Intel XScale IXDP425 BSP
devg-chips.so Graphics driver for Chips and Technologies graphics
devg-coral.so Graphics driver for Fujitsu Coral chipsets
devg-flat.so Graphics driver for unaccelerated flat frame buffers.
devg-i830.so Graphics driver for Intel I830 and I845 chipsets
devg-sis630.so Graphics driver for SIS graphics chipsets
devg-tvia.so Graphics driver for TVIA CyberPro chipsets
devg-smi5xx.so Graphics driver for Silicon Motion SM501 chipset
devg-smi7xx.so Graphics driver for Silicon Motion Lynx controller
devg-rotate90.so
Transform module used for graphics rotation
devg-rotate270.so
Transform module used for graphics rotation
devn-dm9102.so Driver for Davicom DM9102 Ethernet controllers

devn-tigon3.so Driver for Broadcom BCM570X Ethernet controllers
devu-ehci.so Driver for Enhanced Host Controller Interface (EHCI) for USB
2.0
devu-ohci.so Driver for Open Host Controller Interface (OHCI) for USB 2.0
devu-uhci.so Driver for Universal Host Controller Interface (UHCI) for USB
2.0
fontview Font viewer utility
gri-photon.so Photon plugin
gns Global Name Service Manager
hogs List the processes that are hogging the CPU
icc Intel C and C++ compiler
io-usb Server for Universal Serial Bus (USB)
ipf Alter packet filtering lists
ipfs Save and restore information for NAT and stat tables
ipfstat Report on packet filter statistics and filter list
ipmon Monitor /dev/ipl for logged packets
ipnat User interface to NAT
lsm-ipfilter-*.so
mksbp Build a QNX System Builder project
mmplay Multimedia player
netfront NetFront web server
nfm-autoip.so AutoIP negotiation module for link-local address
npm-qnet-compat.so
Native QNX Neutrino network manager — compatible version
npm-qnet-l4_lite.so
Lightweight version of native QNX Neutrino network manager
npm-tcpip-v4.so The original full TCP/IP stack (QNX Neutrino)
npm-tcpip-v6.so The full TCP/IP stack for IPv6 packets (QNX Neutrino)
ntpd Network Time Protocol (NTP) daemon

ntpdate Set the local time and date by polling NTP servers
ntpdc Query the NTP daemon
ntpq Monitor NTP daemon and determine its performance
ntptrace Trace a chain of NTP servers
od Dump a file in various formats (POSIX)
omshell Connect, query and change ISC DHCP server’s state
pci-brh PCI controller for ADI BRH BSP
pci-ixc1100 PCI controller for IXDP425 BSP
pci-ixp2400 PCI controller for IXP2400 BSP
pci-ppc440rb PCI controller for PPC 440GP BSP
phlogin2 Photon login utility
phmenu Photon window menu editor
phs-to-ijs Photon IJS printing client
phuser Photon user account manager
playaudio Play an audio stream
qconfig Query and display QNX installations and configurations
qnxplayer CD and audio file player
QWinCfg Query and display QNX installations and configurations on

Windows
rpcbind Map RPC program numbers into universal addresses
rpcgen An RPC protocol compiler
script Create a typescript of a terminal session
startup-artesyn750fx
Startup for the Artesyn PM/PPC 750FX evaluation board
uud Decode a file that was encoded with uue
uue Encode a binary file into ASCII

Deleted entries
cl-installer Use qnxinstall instead.
devu-kbd Class driver for USB keyboards
devu-mouse Class driver for USB mice
devu-ohci USB manager for OHCI controllers
devu-uhci USB managers for UHCI controllers
phflash Shockwave Flash player
phfontFA Photon Font Server (full font support)
phfontFF Photon Font Server (Bitmap and FontFusion support)
phfontpfr Photon Font Server (TrueDoc font support)
phfontphf Photon Font Server (no scalable font support)
plaympegaudio_noph
Deprecated; replaced by playaudio
playsound_noph Deprecated; replaced by playaudio
portmap Deprecated; replaced by rpcbind utility.
startup-sc400 Deprecated; replaced by startup-bios.
devg-chips-hiqv.so
This driver is deprecated.
devg-igs5300.so This driver is deprecated.
Changed content
devp-pccard Added new options to the documentation.
diff Updated the documentation to reflect the GNU version of diff

instead of the POSIX version.
dumper Added the -s and -w options.
fontadmin Added description of the new font options schema.
io-graphics There are several changes to the documentation for this utility,
including a description of crtc-settings file support, a new
command line syntax, and a description of the configuration file
and multiple display support.
io-net Added option and drivers.

mkdir Removed the -s option.
mkfontdir Removed the -c option.
on The -p option now supports sporadic scheduling.
ped Added description of drag and drop behavior from pfm.
pfm Added a description of preferences, including the new alternate

encoding feature.
phabmsg Added filename command line option.
phfont Changed options to support new font architecture.
phlocale The interface is changed, and ABLANG is now handled

differently.
phlogin Described a configuration file for your shell to run as a login shell.
pterm New -r option.
qnxinstall New options and functionality.
savercfg Added new GUI, which includes the option to use the system
password, and power saver options. The location of the
saver.cfg file has also changed.
sin The output of the register command now includes the

instruction pointer as the first register.
snapshot Added note that snapshot doesn’t work in a phditto window.
voyager New list of keyboard shortcuts, and updated with netfront

information.
Errata
ksh Deleted the -F option.

• New entries
• Deleted entries
• Changed content
• Errata

New entries
addvariant Add a new OS/CPU/VARIANT directory structure to a source
tree
devc-amctap Serial communications manager for AMC WireTAP/PowerTAP
devc_amctap_host
Windows host server for devc-amctap
devf-bigsur SH4 7751 Big Sur eval board
devg-pxa250.so Graphics driver for Intel PXA250 LCD controller
devh-usb.so Driver for USB-compliant human-interface devices (HID)
devh-ps2ser.so Driver for serial and PS2 human-interface devices (HID)
devi-hid Universal Photon input manager for keyboards and mice
devn-i82544.so Network driver for Intel Gigabit Ethernet LAN adapters
devn-ppc405.so Network driver for IBM PPC405 on-chip Ethernet controller
devn-prism.so Network driver for PRISM-based wireless Ethernet controller
hidview Display HID device information
io-hid Start a manager for HID input devices
qnxinstall GUI-based QNX Software Installer (QSI)
startup-aspen Startup the Renesas Aspen evaluation board (SH)
waitfor Wait until a path exists
Deleted entries
ci Check in RCS revisions (UNIX)
co Check out RCS revisions (UNIX)
pkg-installer Use qnxinstall instead.
rcs Change RCS file attributes (UNIX)
rcsclean Clean up working files (UNIX)
rcsdiff Compare RCS revisions (UNIX)
rcsmerge Merge RCS revisions (UNIX)

Changed content
devb-eide Added the lba48 option.
devb-ncr8 Added the nosync and nowide options.
devg-radeon.so
The DVI (digital video interface) is enabled by default, so you can
connect LCD panels to your Radeon cards. The only requirement is
that you connect the LCD to the DVI connector at boot time so the
video BIOS can set up the digital output.
devn-* The verbose option has been standardized and its output now goes
to slogger (view using sloginfo).
diskboot Removed -f option
dumper Clarified home directory behavior
flashctl Added example to clarify partition organization.
login Clarified the behavior of the -f option
mkifs Clarified the type note and added the dperms attribute
mkkbd Changes due to new input architecture.
ph You can now use the PHGFX and PHINPUT environment variables
to specify the commands that you want to use to start the graphics
and input drivers.
pidin Added the irqs, net, rc, and timers shorthand names.
ping Added many new options
qconn Added *_prio options
sendnto General updates, clarifications and corrections
sin Explained side-channels
startup-* Added the -x option for PowerPC and x86 boards.
telnet Removed -a, -l, and -K options
Errata
phshutdown, shutdown
Corrected SIGPWR to SIGTERM

Glossary
June 22, 2010 Glossary 2047

A20 gate
On x86-based systems, a hardware component that forces the A20 address line on the
bus to zero, regardless of the actual setting of the A20 address line on the processor.
This component is in place to support legacy systems, but the QNX Neutrino OS
doesn’t require any such hardware. Note that some processors, such as the 386EX,
have the A20 gate hardware built right into the processor itself — our IPL will disable
the A20 gate as soon as possible after startup.
adaptive
Scheduling policy whereby a thread’s priority is decayed by 1. See also FIFO, round
robin, and sporadic.
adaptive partitioning
A method of dividing, in a flexible manner, CPU time, memory, file resources, or
kernel resources with some policy of minimum guaranteed usage.
asymmetric multiprocessing (AMP)

A multiprocessing system where a separate OS, or a separate instantiation of the same
OS, runs on each CPU.
atomic
Of or relating to atoms. :-)
In operating systems, this refers to the requirement that an operation, or sequence of
operations, be considered indivisible. For example, a thread may need to move a file
position to a given location and read data. These operations must be performed in an
atomic manner; otherwise, another thread could preempt the original thread and move
the file position to a different location, thus causing the original thread to read data
from the second thread’s position.
attributes structure
Structure containing information used on a per-resource basis (as opposed to the
OCB, which is used on a per-open basis).
This structure is also known as a handle. The structure definition is fixed
(iofunc_attr_t), but may be extended. See also mount structure.
bank-switched
A term indicating that a certain memory component (usually the device holding an
image) isn’t entirely addressable by the processor. In this case, a hardware component
manifests a small portion (or “window”) of the device onto the processor’s address
bus. Special commands have to be issued to the hardware to move the window to
different locations in the device. See also linearly mapped.

base layer calls

Convenient set of library calls for writing resource managers. These calls all start with
resmgr_*(). Note that while some base layer calls are unavoidable (e.g.
resmgr_pathname_attach()), we recommend that you use the POSIX layer calls
where possible.
BIOS/ROM Monitor extension signature

A certain sequence of bytes indicating to the BIOS or ROM Monitor that the device is
to be considered an “extension” to the BIOS or ROM Monitor — control is to be
transferred to the device by the BIOS or ROM Monitor, with the expectation that the
device will perform additional initializations.
On the x86 architecture, the two bytes 0x55 and 0xAA must be present (in that order)
as the first two bytes in the device, with control being transferred to offset 0x0003.
block-integral
The requirement that data be transferred such that individual structure components are
transferred in their entirety — no partial structure component transfers are allowed.
In a resource manager, directory data must be returned to a client as block-integral
data. This means that only complete struct dirent structures can be returned —
it’s inappropriate to return partial structures, assuming that the next _IO_READ
request will “pick up” where the previous one left off.
bootable
An image can be either bootable or nonbootable. A bootable image is one that
contains the startup code that the IPL can transfer control to.
bootfile
The part of an OS image that runs the startup code and the Neutrino microkernel.
bound multiprocessing (BMP)

A multiprocessing system where a single instantiation of an OS manages all CPUs
simultaneously, but you can lock individual applications or threads to a specific CPU.
budget
In sporadic scheduling, the amount of time a thread is permitted to execute at its
normal priority before being dropped to its low priority.
buildfile
A text file containing instructions for mkifs specifying the contents and other details
of an image, or for mkefs specifying the contents and other details of an embedded
filesystem image.
2050 Glossary June 22, 2010

canonical mode
Also called edited mode or “cooked” mode. In this mode the character device library
performs line-editing operations on each received character. Only when a line is
“completely entered” — typically when a carriage return (CR) is received — will the
line of data be made available to application processes. Contrast raw mode.
channel
A kernel object used with message passing.
In QNX Neutrino, message passing is directed towards a connection (made to a
channel); threads can receive messages from channels. A thread that wishes to receive
messages creates a channel (using ChannelCreate()), and then receives messages from
that channel (using MsgReceive()). Another thread that wishes to send a message to
the first thread must make a connection to that channel by “attaching” to the channel
(using ConnectAttach()) and then sending data (using MsgSend()).
chid
An abbreviation for channel ID.
CIFS
Common Internet File System (aka SMB) — a protocol that allows a client
workstation to perform transparent file access over a network to a Windows 95/98/NT
server. Client file access calls are converted to CIFS protocol requests and are sent to
the server over the network. The server receives the request, performs the actual
filesystem operation, and sends a response back to the client.
CIS
Card Information Structure — a data block that maintains information about flash
configuration. The CIS description includes the types of memory devices in the
regions, the physical geometry of these devices, and the partitions located on the flash.
coid
An abbreviation for connection ID.
combine message
A resource manager message that consists of two or more messages. The messages are
constructed as combine messages by the client’s C library (e.g. stat(), readblock()),
and then handled as individual messages by the resource manager.
The purpose of combine messages is to conserve network bandwidth and/or to provide
support for atomic operations. See also connect message and I/O message.

connect message
In a resource manager, a message issued by the client to perform an operation based
on a pathname (e.g. an io_open message). Depending on the type of connect
message sent, a context block (see OCB) may be associated with the request and will
be passed to subsequent I/O messages. See also combine message and I/O message.
connection
A kernel object used with message passing.
Connections are created by client threads to “connect” to the channels made available
by servers. Once connections are established, clients can MsgSendv() messages over
them. If a number of threads in a process all attach to the same channel, then the one
connection is shared among all the threads. Channels and connections are identified
within a process by a small integer.
The key thing to note is that connections and file descriptors (FD) are one and the
same object. See also channel and FD.
context
Information retained between invocations of functionality.
When using a resource manager, the client sets up an association or context within the
resource manager by issuing an open() call and getting back a file descriptor. The
resource manager is responsible for storing the information required by the context
(see OCB). When the client issues further file-descriptor based messages, the resource
manager uses the OCB to determine the context for interpretation of the client’s
messages.
cooked mode
See canonical mode.
core dump
A file describing the state of a process that terminated abnormally.
critical section
A code passage that must be executed “serially” (i.e. by only one thread at a time).
The simplest from of critical section enforcement is via a mutex.
deadlock
A condition in which one or more threads are unable to continue due to resource
contention. A common form of deadlock can occur when one thread sends a message
to another, while the other thread sends a message to the first. Both threads are now
waiting for each other to reply to the message. Deadlock can be avoided by good
design practices or massive kludges — we recommend the good design approach.

device driver
A process that allows the OS and application programs to make use of the underlying
hardware in a generic way (e.g. a disk drive, a network interface). Unlike OSs that
require device drivers to be tightly bound into the OS itself, device drivers for QNX
Neutrino are standard processes that can be started and stopped dynamically. As a
result, adding device drivers doesn’t affect any other part of the OS — drivers can be
developed and debugged like any other application. Also, device drivers are in their
own protected address space, so a bug in a device driver won’t cause the entire OS to
shut down.
discrete (or traditional) multiprocessor system

A system that has separate physical processors hooked up in multiprocessing mode
over a board-level bus.
DNS
Domain Name Service — an Internet protocol used to convert ASCII domain names
into IP addresses. In QNX native networking, dns is one of Qnet’s builtin resolvers.
dynamic bootfile
An OS image built on the fly. Contrast static bootfile.
dynamic linking
The process whereby you link your modules in such a way that the Process Manager
will link them to the library modules before your program runs. The word “dynamic”
here means that the association between your program and the library modules that it
uses is done at load time, not at linktime. Contrast static linking. See also runtime
loading.
edge-sensitive
One of two ways in which a PIC (Programmable Interrupt Controller) can be
programmed to respond to interrupts. In edge-sensitive mode, the interrupt is
“noticed” upon a transition to/from the rising/falling edge of a pulse. Contrast
level-sensitive.
edited mode
See canonical mode.
EOI
End Of Interrupt — a command that the OS sends to the PIC after processing all
Interrupt Service Routines (ISR) for that particular interrupt source so that the PIC can
reset the processor’s In Service Register. See also PIC and ISR.

EPROM
Erasable Programmable Read-Only Memory — a memory technology that allows the
device to be programmed (typically with higher-than-operating voltages, e.g. 12V),
with the characteristic that any bit (or bits) may be individually programmed from a 1
state to a 0 state. To change a bit from a 0 state into a 1 state can only be accomplished
by erasing the entire device, setting all of the bits to a 1 state. Erasing is accomplished
by shining an ultraviolet light through the erase window of the device for a fixed
period of time (typically 10-20 minutes). The device is further characterized by having
a limited number of erase cycles (typically 10e5 - 10e6). Contrast flash and RAM.
event
A notification scheme used to inform a thread that a particular condition has occurred.
Events can be signals or pulses in the general case; they can also be unblocking events
or interrupt events in the case of kernel timeouts and interrupt service routines. An
event is delivered by a thread, a timer, the kernel, or an interrupt service routine when
appropriate to the requestor of the event.
FD
File Descriptor — a client must open a file descriptor to a resource manager via the
open() function call. The file descriptor then serves as a handle for the client to use in
subsequent messages. Note that a file descriptor is the exact same object as a
connection ID (coid, returned by ConnectAttach()).
FIFO
First In First Out — a scheduling policy whereby a thread is able to consume CPU at
its priority level without bounds. See also adaptive, round robin, and sporadic.
flash memory
A memory technology similar in characteristics to EPROM memory, with the
exception that erasing is performed electrically instead of via ultraviolet light, and,
depending upon the organization of the flash memory device, erasing may be
accomplished in blocks (typically 64 KB at a time) instead of the entire device.
Contrast EPROM and RAM.
FQNN
Fully Qualified Node Name — a unique name that identifies a QNX Neutrino node on
a network. The FQNN consists of the nodename plus the node domain tacked together.
garbage collection
Aka space reclamation, the process whereby a filesystem manager recovers the space
occupied by deleted files and directories.

HA
High Availability — in telecommunications and other industries, HA describes a
system’s ability to remain up and running without interruption for extended periods of
time.
handle
A pointer that the resource manager base library binds to the pathname registered via
resmgr_attach(). This handle is typically used to associate some kind of per-device
information. Note that if you use the iofunc_*() POSIX layer calls, you must use a
particular type of handle — in this case called an attributes structure.
hard thread affinity

A user-specified binding of a thread to a set of processors, done by means of a
runmask. Contrast soft thread affinity.
image
In the context of embedded QNX Neutrino systems, an “image” can mean either a
structure that contains files (i.e. an OS image) or a structure that can be used in a
read-only, read/write, or read/write/reclaim FFS-2-compatible filesystem (i.e. a flash
filesystem image).
inherit mask
A bitmask that specifies which processors a thread’s children can run on. Contrast
runmask.
interrupt
An event (usually caused by hardware) that interrupts whatever the processor was
doing and asks it do something else. The hardware will generate an interrupt whenever
it has reached some state where software intervention is required.
interrupt handler
See ISR.
interrupt latency
The amount of elapsed time between the generation of a hardware interrupt and the
first instruction executed by the relevant interrupt service routine. Also designated as
“Til ”. Contrast scheduling latency.
interrupt service routine

See ISR.

interrupt service thread

A thread that is responsible for performing thread-level servicing of an interrupt.
Since an ISR can call only a very limited number of functions, and since the amount
of time spent in an ISR should be kept to a minimum, generally the bulk of the
interrupt servicing work should be done by a thread. The thread attaches the interrupt
(via InterruptAttach() or InterruptAttachEvent()) and then blocks (via
InterruptWait()), waiting for the ISR to tell it to do something (by returning an event of
type SIGEV_INTR). To aid in minimizing scheduling latency, the interrupt service
thread should raise its priority appropriately.
I/O message
A message that relies on an existing binding between the client and the resource
manager. For example, an _IO_READ message depends on the client’s having
previously established an association (or context) with the resource manager by
issuing an open() and getting back a file descriptor. See also connect message,
context, combine message, and message.
I/O privileges
A particular right, that, if enabled for a given thread, allows the thread to perform I/O
instructions (such as the x86 assembler in and out instructions). By default, I/O
privileges are disabled, because a program with it enabled can wreak havoc on a
system. To enable I/O privileges, the thread must be running as root, and call
ThreadCtl().
IPC
Interprocess Communication — the ability for two processes (or threads) to
communicate. QNX Neutrino offers several forms of IPC, most notably native
messaging (synchronous, client/server relationship), POSIX message queues and pipes
(asynchronous), as well as signals.
IPL
Initial Program Loader — the software component that either takes control at the
processor’s reset vector (e.g. location 0xFFFFFFF0 on the x86), or is a BIOS extension.
This component is responsible for setting up the machine into a usable state, such that
the startup program can then perform further initializations. The IPL is written in
assembler and C. See also BIOS extension signature and startup code.
IRQ
Interrupt Request — a hardware request line asserted by a peripheral to indicate that it
requires servicing by software. The IRQ is handled by the PIC, which then interrupts
the processor, usually causing the processor to execute an Interrupt Service Routine
(ISR).

ISR
Interrupt Service Routine — a routine responsible for servicing hardware (e.g. reading
and/or writing some device ports), for updating some data structures shared between
the ISR and the thread(s) running in the application, and for signalling the thread that
some kind of event has occurred.
kernel
See microkernel.
level-sensitive
One of two ways in which a PIC (Programmable Interrupt Controller) can be
programmed to respond to interrupts. If the PIC is operating in level-sensitive mode,
the IRQ is considered active whenever the corresponding hardware line is active.
Contrast edge-sensitive.
linearly mapped
A term indicating that a certain memory component is entirely addressable by the
processor. Contrast bank-switched.
message
A parcel of bytes passed from one process to another. The OS attaches no special
meaning to the content of a message — the data in a message has meaning for the
sender of the message and for its receiver, but for no one else.
Message passing not only allows processes to pass data to each other, but also
provides a means of synchronizing the execution of several processes. As they send,
receive, and reply to messages, processes undergo various “changes of state” that
affect when, and for how long, they may run.
microkernel
A part of the operating system that provides the minimal services used by a team of
optional cooperating processes, which in turn provide the higher-level OS
functionality. The microkernel itself lacks filesystems and many other services
normally expected of an OS; those services are provided by optional processes.
mount structure
An optional, well-defined data structure (of type iofunc_mount_t) within an
iofunc_*() structure, which contains information used on a per-mountpoint basis
(generally used only for filesystem resource managers). See also attributes structure
and OCB.
mountpoint
The location in the pathname space where a resource manager has “registered” itself.
For example, the serial port resource manager registers mountpoints for each serial

device (/dev/ser1, /dev/ser2, etc.), and a CD-ROM filesystem may register a

single mountpoint of /cdrom.
multicore system
A chip that has one physical processor with multiple CPUs interconnected over a
chip-level bus.
mutex
Mutual exclusion lock, a simple synchronization service used to ensure exclusive
access to data shared between threads. It is typically acquired (pthread_mutex_lock())
and released (pthread_mutex_unlock()) around the code that accesses the shared data
(usually a critical section). See also critical section.
name resolution
In a QNX Neutrino network, the process by which the Qnet network manager converts
an FQNN to a list of destination addresses that the transport layer knows how to get to.
name resolver
Program code that attempts to convert an FQNN to a destination address.
nd
An abbreviation for node descriptor, a numerical identifier for a node relative to the
current node. Each node’s node descriptor for itself is 0 (ND_LOCAL_NODE).
NDP
Node Discovery Protocol — proprietary QNX Software Systems protocol for
broadcasting name resolution requests on a QNX Neutrino LAN.
network directory
A directory in the pathname space that’s implemented by the Qnet network manager.
Neutrino
Name of an OS developed by QNX Software Systems.
NFS
Network FileSystem — a TCP/IP application that lets you graft remote filesystems (or
portions of them) onto your local namespace. Directories on the remote systems
appear as part of your local filesystem and all the utilities you use for listing and
managing files (e.g. ls, cp, mv) operate on the remote files exactly as they do on your
local files.

NMI
Nonmaskable Interrupt — an interrupt that can’t be masked by the processor. We
don’t recommend using an NMI!
Node Discovery Protocol

See NDP.
node domain
A character string that the Qnet network manager tacks onto the nodename to form an
FQNN.
nodename
A unique name consisting of a character string that identifies a node on a network.
nonbootable
A nonbootable OS image is usually provided for larger embedded systems or for small
embedded systems where a separate, configuration-dependent setup may be required.
Think of it as a second “filesystem” that has some additional files on it. Since it’s
nonbootable, it typically won’t contain the OS, startup file, etc. Contrast bootable.
OCB
Open Control Block (or Open Context Block) — a block of data established by a
resource manager during its handling of the client’s open() function. This context
block is bound by the resource manager to this particular request, and is then
automatically passed to all subsequent I/O functions generated by the client on the file
descriptor returned by the client’s open().
package filesystem
A virtual filesystem manager that presents a customized view of a set of files and
directories to a client. The “real” files are present on some medium; the package
filesystem presents a virtual view of selected files to the client.
partition
A division of CPU time, memory, file resources, or kernel resources with some policy
of minimum guaranteed usage.
pathname prefix
See mountpoint.
pathname space mapping

The process whereby the Process Manager maintains an association between resource
managers and entries in the pathname space.

persistent
When applied to storage media, the ability for the medium to retain information across
a power-cycle. For example, a hard disk is a persistent storage medium, whereas a
ramdisk is not, because the data is lost when power is lost.
Photon microGUI
The proprietary graphical user interface built by QNX Software Systems.
PIC
Programmable Interrupt Controller — hardware component that handles IRQs. See
also edge-sensitive, level-sensitive, and ISR.
PID
Process ID. Also often pid (e.g. as an argument in a function call).
POSIX
An IEEE/ISO standard. The term is an acronym (of sorts) for Portable Operating
System Interface — the “X” alludes to “UNIX”, on which the interface is based.
POSIX layer calls

Convenient set of library calls for writing resource managers. The POSIX layer calls
can handle even more of the common-case messages and functions than the base layer
calls. These calls are identified by the iofunc_*() prefix. In order to use these (and we
strongly recommend that you do), you must also use the well-defined POSIX-layer
attributes (iofunc_attr_t), OCB (iofunc_ocb_t), and (optionally) mount
(iofunc_mount_t) structures.
preemption
The act of suspending the execution of one thread and starting (or resuming) another.
The suspended thread is said to have been “preempted” by the new thread. Whenever
a lower-priority thread is actively consuming the CPU, and a higher-priority thread
becomes READY, the lower-priority thread is immediately preempted by the
higher-priority thread.
prefix tree
The internal representation used by the Process Manager to store the pathname table.
priority inheritance
The characteristic of a thread that causes its priority to be raised or lowered to that of
the thread that sent it a message. Also used with mutexes. Priority inheritance is a
method used to prevent priority inversion.

priority inversion
A condition that can occur when a low-priority thread consumes CPU at a higher
priority than it should. This can be caused by not supporting priority inheritance, such
that when the lower-priority thread sends a message to a higher-priority thread, the
higher-priority thread consumes CPU on behalf of the lower-priority thread. This is
solved by having the higher-priority thread inherit the priority of the thread on whose
behalf it’s working.
process
A nonschedulable entity, which defines the address space and a few data areas. A
process must have at least one thread running in it — this thread is then called the first
thread.
process group
A collection of processes that permits the signalling of related processes. Each process
in the system is a member of a process group identified by a process group ID. A
newly created process joins the process group of its creator.
process group ID
The unique identifier representing a process group during its lifetime. A process group
ID is a positive integer. The system may reuse a process group ID after the process
group dies.
process group leader

A process whose ID is the same as its process group ID.
process ID (PID)
The unique identifier representing a process. A PID is a positive integer. The system
may reuse a process ID after the process dies, provided no existing process group has
the same ID. Only the Process Manager can have a process ID of 1.
pty
Pseudo-TTY — a character-based device that has two “ends”: a master end and a
slave end. Data written to the master end shows up on the slave end, and vice versa.
These devices are typically used to interface between a program that expects a
character device and another program that wishes to use that device (e.g. the shell and
the telnet daemon process, used for logging in to a system over the Internet).
pulses
In addition to the synchronous Send/Receive/Reply services, QNX Neutrino also
supports fixed-size, nonblocking messages known as pulses. These carry a small
payload (four bytes of data plus a single byte code). A pulse is also one form of event
that can be returned from an ISR or a timer. See MsgDeliverEvent() for more
information.

Qnet
The native network manager in QNX Neutrino.
QoS
Quality of Service — a policy (e.g. loadbalance) used to connect nodes in a
network in order to ensure highly dependable transmission. QoS is an issue that often
arises in high-availability (HA) networks as well as realtime control systems.
RAM
Random Access Memory — a memory technology characterized by the ability to read
and write any location in the device without limitation. Contrast flash and EPROM.
raw mode
In raw input mode, the character device library performs no editing on received
characters. This reduces the processing done on each character to a minimum and
provides the highest performance interface for reading data. Also, raw mode is used
with devices that typically generate binary data — you don’t want any translations of
the raw binary stream between the device and the application. Contrast canonical
mode.
replenishment
In sporadic scheduling, the period of time during which a thread is allowed to
consume its execution budget.
reset vector
The address at which the processor begins executing instructions after the processor’s
reset line has been activated. On the x86, for example, this is the address 0xFFFFFFF0.
resource manager
A user-level server program that accepts messages from other programs and,
optionally, communicates with hardware. QNX Neutrino resource managers are
responsible for presenting an interface to various types of devices, whether actual (e.g.
serial ports, parallel ports, network cards, disk drives) or virtual (e.g. /dev/null, a
network filesystem, and pseudo-ttys).
In other operating systems, this functionality is traditionally associated with device
drivers. But unlike device drivers, QNX Neutrino resource managers don’t require
any special arrangements with the kernel. In fact, a resource manager looks just like
any other user-level program. See also device driver.
RMA
Rate Monotonic Analysis — a set of methods used to specify, analyze, and predict the
timing behavior of realtime systems.

round robin
A scheduling policy whereby a thread is given a certain period of time to run. Should
the thread consume CPU for the entire period of its timeslice, the thread will be placed
at the end of the ready queue for its priority, and the next available thread will be made
READY. If a thread is the only thread READY at its priority level, it will be able to
consume CPU again immediately. See also adaptive, FIFO, and sporadic.
runmask
A bitmask that indicates which processors a thread can run on. Contrast inherit mask.
runtime loading
The process whereby a program decides while it’s actually running that it wishes to
load a particular function from a library. Contrast static linking.
scheduling latency
The amount of time that elapses between the point when one thread makes another
thread READY and when the other thread actually gets some CPU time. Note that this
latency is almost always at the control of the system designer.
Also designated as “Tsl ”. Contrast interrupt latency.
scoid
An abbreviation for server connection ID.
session
A collection of process groups established for job control purposes. Each process
group is a member of a session. A process belongs to the session that its process group
belongs to. A newly created process joins the session of its creator. A process can alter
its session membership via setsid(). A session can contain multiple process groups.
session leader
A process whose death causes all processes within its process group to receive a
SIGHUP signal.
soft thread affinity

The scheme whereby the microkernel tries to dispatch a thread to the processor where
it last ran, in an attempt to reduce thread migration from one processor to another,
which can affect cache performance. Contrast hard thread affinity.
software interrupts
Similar to a hardware interrupt (see interrupt), except that the source of the interrupt
is software.

sporadic
A scheduling policy whereby a thread’s priority can oscillate dynamically between a
“foreground” or normal priority and a “background” or low priority. A thread is given
an execution budget of time to be consumed within a certain replenishment period.
See also adaptive, FIFO, and round robin.
startup code
The software component that gains control after the IPL code has performed the
minimum necessary amount of initialization. After gathering information about the
system, the startup code transfers control to the OS.
static bootfile
An image created at one time and then transmitted whenever a node boots. Contrast
dynamic bootfile.
static linking
The process whereby you combine your modules with the modules from the library to
form a single executable that’s entirely self-contained. The word “static” implies that
it’s not going to change — all the required modules are already combined into one.
symmetric multiprocessing (SMP)

A multiprocessor system where a single instantiation of an OS manages all CPUs
simultaneously, and applications can float to any of them.
system page area

An area in the kernel that is filled by the startup code and contains information about
the system (number of bytes of memory, location of serial ports, etc.) This is also
called the SYSPAGE area.
thread
The schedulable entity under QNX Neutrino. A thread is a flow of execution; it exists
within the context of a process.
tid
An abbreviation for thread ID.
timer
A kernel object used in conjunction with time-based functions. A timer is created via
timer_create() and armed via timer_settime(). A timer can then deliver an event,
either periodically or on a one-shot basis.

timeslice
A period of time assigned to a round-robin or adaptive scheduled thread. This period
of time is small (on the order of tens of milliseconds); the actual value shouldn’t be
relied upon by any program (it’s considered bad design).
TLB
An abbreviation for translation look-aside buffer. To maintain performance, the
processor caches frequently used portions of the external memory page tables in the
TLB.
TLS
An abbreviation for thread local storage.

Index
! _CS_LOCALE 795, 1661

_CS_MACHINE 795, 1661
*.kdef files 1127 _CS_PATH 795, 994, 1661
-- (end of options) 5 _CS_RELEASE 795, 1661
. _CS_RESOLVE 487, 795, 1166, 1468, 1586,
esh, fesh builtin 630 1661
ksh builtin 945 _CS_SRPC_DOMAIN 795, 1661
.ABLANG 1393 _CS_SYSNAME 795, 1661
.devices directory _CS_TIMEZONE 795, 1661
mcd 1042 _CS_VERSION 795, 1661
.diskroot 551 _NTO_PF_* 1446
.eject file _NTO_TCTL_IO 1495
mcd 1042 _NTO_TI_* 1449
.insert file _PC_ASYNC_IO 796
mcd 1042 _PC_CHOWN_RESTRICTED 77, 95, 796
.kbd file (mkkbd) 1127 _PC_LINK_DIR 796
.kev extension 1891 _PC_LINK_MAX 797
.KEYBOARD. 1393 _PC_MAX_CANON 797
.kshrc 932 _PC_MAX_INPUT 797
.longfilenames 728 _PC_NAME_MAX 797
.nslookuprc 1188, 1193 _PC_NO_TRUNC 797
.profile 921 _PC_PATH_MAX 797
.rhosts 846, 1589, 1594, 1625, 1626 _PC_PIPE_BUF 797
/dev, /etc, /proc, /usr, /var directories _PC_PRIO_IO 797
See individual files _PC_SYNC_IO 797
/etc/system/config/noditto 1408 _PC_VDISABLE 797
: (ksh builtin) 945 _SC_AIO_PRIO_DELTA_MAX 795
$PHOTON _SC_ARG_MAX 795
permissions 1396 _SC_CHILD_MAX 795
_CS_ARCHITECTURE 794, 1661 _SC_CLK_TCK 795
_CS_DOMAIN 487, 794, 1586, 1661 _SC_DELAYTIMER_MAX 795
_CS_HOSTNAME 794, 844, 1661 _SC_GETGR_R_SIZE_MAX 795
_CS_HW_PROVIDER 794, 1661 _SC_GETPW_R_SIZE_MAX 795
_CS_HW_SERIAL 794, 1661 _SC_JOB_CONTROL 795
_CS_LIBPATH 794, 1661, 1948 _SC_NGROUPS_MAX 796
June 22, 2010 Index 2067

Index © 2010, QNX Software Systems GmbH & Co. KG.
_SC_OPEN_MAX 796 8X0, audio driver for (deva-ctrl-i8x0.so)

_SC_PAGESIZE 796 160
_SC_SAVED_IDS 796 90x NIC (devn-el900.so) 382
_SC_SEM_NSEMS_MAX 796 91c92/91c100 compatible Ethernet adapter
_SC_SIGQUEUE_MAX 796 (devn-smc9000.so) 414
_SC_THREAD_STACK_MIN 796 945GX/945GMx graphics controller driver
_SC_TZNAME_MAX 796 (devg-gma9xx.so) 289
_SC_VERSION 796
[] (ksh builtin) 954
˜ 935
˜/.ph/phapps script 1396 A
0 or 0x, leading 4
3Com ABLANG 1975
509 ISA Ethernet adapter ABLPATH 1345, 1348, 1975
(devn-el509.so) 380 AC’97 mixer (deva-mixer-ac97.so) 174
90x NIC (devn-el900.so) 382 ACCEPT_LANGUAGE 1703, 1975
3D graphics driver (devg-soft3d-fixed.so) access times for files, changing (touch) 1883
326 acl.conf 10
3D graphics driver (devg-soft3d.so) 325 ACPI (Advanced Control and Power Interface)
4DWave, audio driver for 1784
(deva-ctrl-4dwave.so) 150 active license, displaying the type of
509 ISA Ethernet adapter (devn-el509.so) (showlicense) 1676
380 active routes 1171
57xx Tigon3 10/100/1000 Mbit Ethernet Adaptec drivers
controllers (devnp-bge.so) 440 7901/7902-based SCSI adapters
64-bit addressing, processes and 1234 (devb-adpu320) 178
8139 PCI card driver (devn-rtl.so) 405 AIC-7870/7880 based SCSI adapters
8150 Ethernet dongle driver (devb-aha8) 182
(devn-rtl8150.so) 408 adaptive partitioning
8169 Gigabit Ethernet controllers averaging window, setting size of 22
(devnp-rtl8169.so) 461 budgets
8250 serial communications manager displaying 1446
devc-ser8250 240 setting 20
82540, 82541, 82542, 82543, 82544, 82545, partitions
82546, 82547, 82571, 82572, and 82573 displaying for a thread 1442
Gigabit Ethernet LAN controller information about, displaying 1446
(devn-i82544.so) 390 managing 20
82540, 82541, 82544, 82545, 82546, 82548, processes, starting in 1236
82571, 82572 Gigabit Ethernet LAN security, setting 21
controller (devnp-i82544.so) 447 addr2line 12
82557, 82558, 82559 Fast Ethernet LAN Address Resolution Protocol See ARP
controller (devn-speedo.so) 417 address space randomization 1496
82557, 82558, 82559 Fast Ethernet LAN address, converting to line number/file name
controller (devnp-speedo.so) 468 (addr2line) 12
8841 or 8842 Ethernet controllers addresses, changes to 864
(devn-micrel8841.so) 393 addressing, enabling extended for physical
addresses above 4 GB 1784
2068 Index June 22, 2010

© 2010, QNX Software Systems GmbH & Co. KG. Index
addvariant 13 instruction set (_CS_ARCHITECTURE)

Advanced Control and Power Interface (ACPI) 794, 1661
1784 selection 1992
Advanced Programmable Interrupt Controller archives
(APIC), startup for (startup-apic) Archive/Interchange file format (cpio)
1785 112
advertisement, router creating and reading
configuration (rtadvd.conf 1631 ar 24
daemon (rtadvd) 1628 cpio 112
AHCI SATA interface (devb-ahci) 186 pax 1256
AK4531 mixer (deva-mixer-ak4531.so) tar 1819
175 indexing 1580
alias size of (size) 1683
esh, fesh builtin 631 arguments
ksh builtin 927, 945 constructing lists of and invoking a program
expansion 944 (xargs) 1961
alignment fault emulation 1493 displaying for processes 1442
AMD evaluating as an expression
PCNET (AMD-79c97x) compatible Ethernet eval (ksh builtin) 947
adapter (devn-pcnet.so) 398 expr 644
American (US-101) keyboard layout 233 maximum length (_SC_ARG_MAX) 795
anchors 1280 mutually exclusive 3
anonymous ftp 747 writing to standard output
ANSI protocol 1506 echo 575
anti-aliasing echo (ksh builtin) 947
printing 1413, 1416, 1419, 1423, 1426 print (ksh builtin) 950
screen 1363 printf 1486
API arithmetic, evaluating
MCD for client application 1050 bc 31
APIC (Advanced Programmable Interrupt ksh 939
Controller), startup for let (ksh builtin) 950
(startup-apic) 1785 ARM startup options 1783
appbuilder 16 arp 25
Apple Macintosh HFS and HFS Plus ARP 26
(fs-mac.so) 718 enabling use in mapping network- and
applications link-level addresses 855
code coverage (gcov) 788 ASAHI KASEI AK4531
files, associations with 1341 (deva-mixer-ak4531.so) 175
graphical, developing (appbuilder) 16 ASCII
applypatch 18 converting files to and from EBCDIC 145
aps 20 file transfer
ar 24 tftp 1871, 1872
AR5210, AR5211, AR5212, and AR5213 chips ASIX
(devnp-ath.so) 429 AX88172 USB Ethernet adapters
architecture (devnp-axe.so) 431
June 22, 2010 Index 2069

ASIX AX88172/AX88178/AX88772 USB state of, restoring

Ethernet dongle (devn-asix.so) (deva-util-restore.so) 177
372 Terratec ESS1938
assembler include file, creating (mkasmoff) (deva-ctrl-ess1938.so) 156
1067 Trident 4DWave
asynchronous I/O (deva-ctrl-4dwave.so) 150
priority for VIA686 (deva-ctrl-via686.so) 168
(_SC_AIO_PRIO_DELTA_MAX) 795 Yamaha DS1 (deva-ctrl-ymfds1.so)
support for (_PC_ASYNC_IO) 796 172
ATA/IDE disk interface, driver (devb-eide) audio files 736
194 audio mixers
ATAPI CD-ROM interface, driver (devb-eide) AC’97 (deva-mixer-ac97.so) 174
194 AK4531 (deva-mixer-ak4531.so) 175
Atheros AR5210, AR5211, AR5212, and High Definition Audio
AR5213 chips (devnp-ath.so) 429 (deva-mixer-hda.so) 176
ATI AudioPCI, audio driver for
RADEON chipsets, graphics driver for (deva-ctrl-audiopci.so) 152
(devg-radeon.so) 307 auditing binaries 1533
RAGE 128 chipsets, graphics driver for Aureal Vortex, audio driver for
(devg-ati_rage128.so) 267 (deva-ctrl-vortex.so) 170
RAGE chipsets, graphics driver for authentication agent (ssh-agent) 1772
(devg-rage.so) 310 authentication key generation, management, and
attributes of a file, manipulating (chattr) 75 conversion (ssh-keygen) 1774
audio authenticator for IEEE 802.11 networks 842
configuration file 604 autoconnect 27
audio AUTOCONNECT 27, 1975
mixer (mixer) 1064 AutoIP negotiation module 1015
audio drivers automated conversational script with a modem
AudioPCI (deva-ctrl-audiopci.so) (chat) 70
152 automounter
Aureal Vortex (deva-ctrl-vortex.so) filesystem 1041
170 awk See gawk
Cirrus Logic CS4281 AX88172 USB Ethernet adapters
(deva-ctrl-cs4281.so) 154 (devnp-axe.so) 431
Creative Sound Blaster 16
(deva-ctrl-sb.so) 166
Intel 8X0 (deva-ctrl-i8x0.so) 160
Intel High Definition Audio controllers B
(deva-ctrl-intel_hda.so) 162
manager for (io-audio) 885 background
National Semiconductor color 1521, 1529
Geode family (deva-ctrl-geode.so) manager (bkgdmgr) 42
158 running jobs in 946
NeoMagic 6 family bad blocks
(deva-ctrl-nmg6.so) 164 checking for (dcheck) 142
patching (spatch) 1763
BASEDIR 1248
2070 Index June 22, 2010

basename 29 binding
bc 31 resources
BCM1250 10/100/1000 Mbit Ethernet controllers bindres 40
(devnp-bcm1250.so) 435 bindres 40
BCM440x 10/100 Ethernet controllers BIOS
(devnp-bce.so) 433 PCI support for (pci-bios,
BCM570X pci-bios-v2) 1265
network driver (devn-tigon3.so) 420 resources, seeding (seedres) 1657
BDF fonts, converting to Photon (bdftophf2) startup for PC-compatible systems with
39 (startup-bios,
bdftophf2 39 startup-bios-32) 1788
bench calculator (bc) 31 bios_nokbd.boot 1111
Berkeley Packet Filter (BPF) bios.boot 1111
usingioctl_socket() instead ofioctl() 1280 bios16m.boot 1111
bg (ksh builtin) 946 bison 41
binaries, comparing to official QNX versions bitmap printer driver (phs-to-bmp) 1416
1533 bkgdmgr 42
Binary Data Format See BDF block
binary.boot 1111 configuration file 604, 605
bind (ksh builtin) 946 block I/O support (io-blk.so) 888
BIND 9 blocked threads 1442
DNS Secure blocks
Delegation Signer resource record checking for bad (dcheck) 142
generation tool (dnssec-dsfromkey) patching (spatch) 1763
558 board support packages
key generation tool setting up (setupbsp) 1669
(dnssec-keyfromlabel) 559 bookmarks 836
key-generation tool (dnssec-keygen) boot image 1498
560 boot loader, writing to a disk 555
zone-signing tool (dnssec-signzone) boot time
561 improving 1494
dynamic update utility (nsupdate) 1196 setting 1783
lightweight resolver daemon (lwresd) bootfiles 1110, 1115
1026 booting
lookup utilities time since (uptime) 1929
dig 542 booting (diskboot) 550
host 841 bootpd 44
name server control utility (rndc) 1600 bootptab 46
configuration file (rndc.conf) 1602 bound multiprocessing (BMP) 1113, See also
key-generation tool (rndc-confgen) runmasks
1601 BPF (Berkeley Packet Filter)
server (named) 1159 usingioctl_socket() instead ofioctl() 1280
configuration file 1162 brackets, meaning of in syntax line 3
syntax checker for named configuration files brconfig 51
(named-checkconf) 1160 break (ksh builtin) 946
zone files, named 1161 bridge
June 22, 2010 Index 2071

configuration file 604 calculator

bridge parameters, configuring 51 bc 31
BROADCAST 489, 1975 ksh 939
broadcast address 855 phcalc 1352
broadcast messages (mesg) 1062 calib 59
Broadcom callout templates
43xx 802.11b/g wireless Ethernet controller mcd 1044
(devnp-bcm43xx.so) 438 cam-cdrom.so 61
57xx Tigon3 10/100/1000 Mbit Ethernet cam-disk.so 63
controllers (devnp-bge.so) 440 cam-optical.so 65
BCM1250 10/100/1000 Mbit Ethernet Canon print driver (phs-to-bjc) 1413
controllers (devnp-bcm1250.so) canonical input buffer (_PC_MAX_CANON)
435 797
BCM440x 10/100 Ethernet controllers Cardbus server (devp-pccard) 471
(devnp-bce.so) 433 Carmine graphics controller driver
BSPs (devg-carmine.so) 270
setting up (setupbsp) 1669 case-sensitivity
buffers in pattern matching 1054
canonical input (_PC_MAX_CANON) 797 cat 66
raw input (_PC_MAX_INPUT) 797 CC, cc 68, See also QCC, qcc
building cd
project 1070 esh, fesh builtin 631
builtin (ksh builtin) 946 ksh builtin 946
bunzip2 54, 56 uesh builtin 1910
BusLogic/Mylex Multimaster host adapters, CD_MEDIA_IOBLK 1045
drivers (devb-btmm) 190 CD-changer
bytes detecting events when controlled by external
counting (wc) 1947 firmware 1055
swapping in a file 145 CD-ROM
bz2cat 55, 56 common access method (cam-cdrom.so)
bzip2 56 61
interface driver (devb-eide) 194
CDPATH 932
channel IDs (chids), maximum number of 1494
C CHAP (Challenge-Handshake Authentication
Protocol) 1384, 1467
C char
compiling 68, 782, 1535 configuration file 604, 605
ifdef’ed lines, removing (unifdef) characters
1921 control, disabling (_PC_VDISABLE) 797
source, formatting (indent) 866 counting (wc) 1947
tags from (ctags) 121 translating (tr) 1886
C++ chat 70
compiling 68, 757, 782, 1535 chattr 75
exceptions, enabling 786, 1536 checksums, calculating (cksum) 96
ifdef’ed lines, removing (unifdef) chgrp 77
1921
2072 Index June 22, 2010

chids, maximum number of 1494 depth 1372

Chips and Technologies graphics chipsets driver COLUMNS 601, 932, 984, 1014, 1976
(devg-chip.so) 274 columns, formatting files into (pr) 1477
chkdosfs 79 command (ksh builtin) 947
chkfsys 82 command interpreters See shells
chkqnx6fs 87 command line
chmod 90 editing 963
chown 94 prompts (PS1, PS2, PS3, PS4) 934
restricting use of commands
(_PC_CHOWN_RESTRICTED) 95, executing on another node (on) 1234
796 executing, replacing the shell process (exec
CIFS client filesystem (fs-cifs) 703 ksh builtin) 948
Cirrus Logic preventing hangups (nohup) 1186
CS4281, audio driver for running as someone else (op) 1238
(deva-ctrl-cs4281.so) 154 scheduling
cksum 96 cron 115
CLDR 1068 crontab 117
clear 98 common access method
click to front, windows 1521, 1528 cam-cdrom.so 61
client cam-disk.so 63
MCD API 1050 cam-optical.so 65
clipboard keys (pterm) 1509 Common Internet Filesystem client filesystem
CLOCK_MONOTONIC 1449 (fs-cifs) 703
CLOCK_REALTIME 1449 Common Locale Data Repository See CLDR
CLOCK_SOFTTIME 1449 communications line, talking over (qtalk)
clock_t 795 1555
clock server (cron) 115 compiling
clock ticks (_SC_CLK_TCK) 795 CC, cc 68
ClockTime() 1783 gcc 782
CMD_INT 1691, 1693, 1702, 1976 QCC, qcc 1535
cmp 99 concurrent version control (cvs) 126
code coverage (gcov) 788 CONDVAR (thread state) 1451
code size, displaying for a process 1442 config/target.mt 1993
codecs, mixers for configuration files
AC’97 (deva-mixer-ac97.so) 174 DNS
AK4531 (deva-mixer-ak4531.so) 175 resolv.conf 1586
High Definition Audio services 1660
(deva-mixer-hda.so) 176 enum directory 602
coexistence of OS versions 1543, 1564 enum-usb 618
COFF files, converting to assembler include file enum-usb.conf 618
(mkasmoff) 1067 enum/common 604
coids enum/devices
displaying for a process 1442, 1446 audio 604
maximum number of 1494 block 604
color bridge 604
background 1521, 1529 char 604
June 22, 2010 Index 2073

input 604 hosts 845

media 604 hosts.equiv 846
net 604 inetd.conf 870
printer 604 mib.txt 1063
serial 604 named 1160, 1162
enum/devices/usb networks 1172
char 605 protocols 1500
default 605 racoon.conf 1568
ipod 605 rpc 1615
mass 605 rtadvd.conf 1631
net 605 socks.conf 1755
enum/include useqnet 1025
block 605 configuration values, system
graphics 605 getting (getconf) 794
isa-types 605 setting (setconf) 1661
net 605 configuring
par-class 605 mcd 1039
pccard-types 605 connection IDs (coids)
pccard-vendors 605 displaying for a process 1442, 1446
pci-class 605 maximum number of 1494
pci-vendors 605 consistency check
pnpbios-types 605 DOS (chkdosfs) 79
usb-class 605 Power-Safe filesystem (chkqnx6fs) 87
magic 1028 QNX 4 (chkfsys) 82
mcd 1039 console and keyboard I/O manager
NFS devc-con, devc-con-hid 217
exports 642 consoles 1344, 1395
nfsstart 1178 switching 1406
pcnfsd 1267 preventing 1522
printcap 1482 content
SNMP determination callout prototype 1046
context.conf 101 CONTENT_LENGTH 1703, 1976
party.conf 1244 CONTENT_TYPE 1703, 1976
snmpd.conf 1725 context.conf 101
view.conf 1945 continue (ksh builtin) 947
syslog.conf 1812 control characters, disabling (_PC_VDISABLE)
TCP/IP 797
.rhosts 1589 controllers, USB I/O support (io-usb) 914
acl.conf 10 conventions
autoconnect 27 double dash, as command-line delimiter 5
bootptab 46 typographical xxiii
dhcpd.conf 500 utility syntax 3
ftpchroot 745 coprocesses 941
ftpd.conf 749 Coral graphics controller driver
ftpusers 754 (devg-coral.so) 277
gateways 759 core files, information about (coreinfo) 103
2074 Index June 22, 2010

coreinfo 103 DATE_LOCAL 1692

country 1393 Davicom DM9102 Ethernet adapter
cp 104 (devn-dm9102) 378
cpio 112 dcheck 142
CPU dd 145
halting, disabling in idle thread 1494 DE-102 (German) keyboard layout 233
usage, displaying debugging See also troubleshooting
(times ksh builtin) 957 ftp session 746
hogs 839 gdb 790
pidin 1450 inetd session 868
top 1882 JTAG/hardware debuggers 1782
CRC, performing on Qnet packets 1020 name servers (nslookup) 1188
Creative Sound Blaster 16, audio driver for network 1167
(deva-ctrl-sb.so) 166 ping 1457
cron 115 ping6 1462
crontab 117 traceroute 1898
crypt() 994 traceroute6 1903
Crypto Engine driver (devnp-mpcsec.so) process-level (pdebug) 1269
451 routing tables 1610
cryptography 1239 shared objects 1976
Crystal 89xx Ethernet adapter sockets
(devn-crys8900.so) 375 rlogin 1592
CS4281, audio driver for rsh 1623
(deva-ctrl-cs4281.so) 154 telnet session 1856
ctags 121 DEC 21x4x (Tulip) compatible Ethernet adapter
Ctrl-Alt-Shift-Backspace, disabling 359 (devn-tulip.so) 423
Ctrl-Alt keychords 1521 decimal integers, in utility syntax 4
cursor focus 1521, 1528 default
cut 123 configuration file 605
cvs 126 DEFAULT_EMULATION 1993
CyberPro chipsets driver (devg-tvia.so) deflate 148
332 DEFPROFILE 1248
desktop
background 42, 1521, 1529
menu, customizing 1523
D detecting
devices 1036
data iPods 1053
caching 1408 mediastores 1036
compressing 1407 USB mediastores 1053
data server (ds) 562, 1699 deva-ctrl-4dwave.so 150
data size, displaying for a process 1442 deva-ctrl-audiopci.so 152
date deva-ctrl-cs4281.so 154
displaying and setting (date) 137 deva-ctrl-ess1938.so 156
setting or getting from realtime clock (rtc) deva-ctrl-geode.so 158
1634 deva-ctrl-i8x0.so 160
DATE_GMT 1692
June 22, 2010 Index 2075

deva-ctrl-intel_hda.so 162 devg-sis630.so 316

deva-ctrl-nmg6.so 164 devg-smi5xx.so 319
deva-ctrl-sb.so 166 devg-smi7xx.so 322
deva-ctrl-via686.so 168 devg-soft3d-fixed.so 326
deva-ctrl-vortex.so 170 devg-soft3d.so 325
deva-ctrl-ymfds1.so 172 devg-svga.so 327
deva-mixer-ac97.so 174 devg-tnt.so 329
deva-mixer-ak4531.so 175 devg-tvia.so 332
deva-mixer-hda.so 176 devg-vesabios.so 335
deva-util-restore.so 177 devg-vmware.so 337
devb-adpu320 178 devh-egalax.so 339
devb-aha8 182 devh-microtouch.so 341
devb-ahci 186 devh-ps2ser.so 343
devb-btmm 190 devh-touchintl.so 347
devb-eide 194 devh-usb.so 349
devb-fdc 200 devi-dyna 351
devb-loopback 203 devi-elo 353
devb-mvSata 208 devi-hid 356
devb-ram 212 devi-hirun 359
devb-umass 215 devi-microtouch 364
devc-con 217 devi-semtech 367
devc-con-hid 217 devi-zytronic 369
devc-par 237 devices
devc-pty 239 enumerator manager (enum-devices)
devc-ser8250 240 602
devc-serpci 245 insertion 1036
devc-serusb 247 mounting (mount) 1139
devc-serzscc 250 removal 1036
devf-generic 254 unmounting (umount) 1916
devf-ram 261 USB, displaying 1930
devg-ati_rage128.so 267 devn-asix.so 372
devg-carmine.so 270 devn-crys8900.so 375
devg-chip.so 274 devn-dm9102 378
devg-coral.so 277 devn-el509.so 380
devg-extreme2.so 282 devn-el900.so 382
devg-flat.so 285 devn-epic.so 385
devg-geode.so 286 devn-fd.so 388
devg-gma9xx.so 289 devn-i82544.so 390
devg-i810.so 292 devn-micrel8841.so 393
devg-i830.so 295 devn-ne2000.so 395
devg-intelhd.so 298 devn-pcnet.so 398
devg-matroxg.so 301 devn-pegasus.so 402
devg-poulsbo.so 304 devn-rtl.so 405
devg-radeon.so 307 devn-rtl8150.so 408
devg-rage.so 310 devn-sis9.so 411
devg-s3_savage.so 313 devn-smc9000.so 414
2076 Index June 22, 2010

devn-speedo.so 417 diff 528

devn-tigon3.so 420 diff3 533
devn-tulip.so 423 dig 542
devn-via-rhine.so 426 dinit 543
devnp-ath.so 429 DIOCADDADDR 1281
devnp-axe.so 431 DIOCADDALTQ 1281
devnp-bce.so 433 DIOCADDRULE 1281
devnp-bcm1250.so 435 DIOCADDSTATE 1283
devnp-bcm43xx.so 438 DIOCBEGINADDRS 1281
devnp-bge.so 440 DIOCCHANGERULE 1285
devnp-e1000.so 442 DIOCCLRIFFLAG 1293
devnp-i80579.so 445 DIOCCLRRULECTRS 1286
devnp-i82544.so 447 DIOCCLRSRCNODES 1292
devnp-mpc85xx.so 453 DIOCCLRSTATUS 1284
devnp-mpcsec.so 451 DIOCGETADDR 1282
devnp-msk.so 456 DIOCGETADDRS 1282
devnp-ral.so 458 DIOCGETALTQ 1282
devnp-rtl8169.so 461 DIOCGETALTQS 1282
devnp-rum.so 464 DIOCGETQSTATS 1282
devnp-shim.so 467 DIOCGETRULE 1282
devnp-speedo.so 468 DIOCGETRULES 1282
devnp-ural.so 458 DIOCGETRULESET 1283
devp-pccard 471 DIOCGETRULESETS 1282
devu-ehci.so 474 DIOCGETSRCNODES 1292
devu-kbd 476 DIOCGETSTATE 1283
devu-mouse 477 DIOCGETSTATES 1285
devu-ohci.so 478 DIOCGETSTATUS 1284
devu-prn 480 DIOCGETTIMEOUT 1286
devu-uhci.so 482 DIOCICLRISTATS 1293
df 484 DIOCIGETIFACES 1292
DHCP DIOCKILLSTATES 1283
configuration (dhcpd.conf) 500 DIOCNATLOOK 1284
hosts, configuring 486 DIOCOSFPADD 1291
leases (dhcpd.leases) 521 DIOCOSFPFLUSH 1291
relay agent (dhcprelay) 524 DIOCOSFPGET 1292
server (dhcpd) 492 DIOCRADDADDRS 1288
state, changing (omshell) 1229 DIOCRADDTABLES 1287
dhcp-options 490 DIOCRCLRADDRS 1288
dhcp-up 489 DIOCRCLRASTATS 1289
dhcp.client 486 DIOCRCLRTABLES 1286
dhcpd 492 DIOCRCLRTSTATS 1288
dhcpd.conf 500 DIOCRDELADDRS 1288
dhcpd.leases 521 DIOCRDELTABLES 1287
dhcprelay 524 DIOCRGETADDRS 1289
dialup connector (phdialer) 1353 DIOCRGETASTATS 1289
dialups 1354 DIOCRGETTABLES 1287
June 22, 2010 Index 2077

DIOCRGETTSTATS 1287 patching (spatch) 1763

DIOCRINADEFINE 1290 consistency check
DIOCRSETADDRS 1288 DOS (chkdosfs) 79
DIOCRSETTFLAGS 1289 Power-Safe filesystem (chkqnx6fs) 87
DIOCRTSTADDRS 1289 QNX 4 (chkfsys) 82
DIOCSETDEBUG 1284 floppy, driver (devb-fdc) 200
DIOCSETHOSTID 1291 hard, common access method
DIOCSETIFFLAG 1293 (cam-disk.so) 63
DIOCSETLIMIT 1286 initializing (dinit) 543
DIOCSETSTATUSIF 1283 optical, common access method
DIOCSETTIMEOUT 1286 (cam-optical.so) 65
DIOCSTART 1280 partitions, managing (fdisk) 652
DIOCSTARTALTQ 1280 RAM, driver (devb-ram) 212
DIOCSTOP 1280 space
DIOCSTOPALTQ 1280 free, reporting (df) 484
DIOCXBEGIN 1290 usage, estimating (du) 566
DIOCXCOMMIT 1290 dispconf 553
DIOCXROLLBACK 1291 DISPLAY 1976
directed graphs, topological sorting of 1906 display preferences (phgrafx) 1371, See also
directories screen
creating 1072, 1341 color depth 1372
current (working) graphics resolution 1372
changing 946 refresh rate 1373
printing (pwd ksh builtin) 951 display, rotating 901
printing (pwd utility) 1520 display.conf 900
deleting example 901
pfm 1341 Distance-Vector Multicast Routing Protocol
rmdir 1598 (DVMRP) 1146
extracting from pathnames (dirname) 548 dittoing 1358
home DL_DEBUG 972, 1976
default 1248 dloader 555
going to 946 DM9102 (Davicom) Ethernet adapter
listing contents of 1010, 1341 (devn-dm9102) 378
moving or renaming DNS
mv 1155 dynamic update utility (nsupdate) 1196
pfm 1341 lightweight resolver daemon (lwresd)
ownership, changing (chown) 94 1026
unlinking lookup utilities
support for (_PC_LINK_DIR) 796 dig 542
unlinking (unlink) 1924 host 841
dirname 548 name-service switch configuration 1194
diskboot 550 resolver configuration 1586, 1661
diskettes, formating (fdformat) 649 Secure
disks Delegation Signer resource record
blocks generation tool (dnssec-dsfromkey)
bad, checking for (dcheck) 142 558
2078 Index June 22, 2010

key generation tool ATA/IDE disk interface and ATAPI

(dnssec-keyfromlabel) 559 CD-ROM interface (devb-eide) 194
key-generation tool (dnssec-keygen) BusLogic/Mylex Multimaster host adapters
560 (devb-btmm) 190
zone-signing tool (dnssec-signzone) floppy disk (devb-fdc) 200
561 io-net, compatibility with io-pkt 467
server Marvell 88SX50XX SATA interface
configuration file 1160 (devb-mvSata) 208
server (named) 1159 Microtouch EXII USB touch devices
configuration file 1162 (devh-microtouch.so) 341
services file 1660 printer
syntax checker for named configuration files bitmap (phs-to-bmp) 1416
(named-checkconf) 1160 Canon (phs-to-bjc) 1413
dnssec-dsfromkey 558 Epson ESC/P2 (phs-to-escp2) 1419
dnssec-keyfromlabel 559 Hewlett-Packard PCL (phs-to-pcl)
dnssec-keygen 560 1426
dnssec-signzone 561 IJS (phs-to-ijs) 1423
DOCUMENT_NAME 1692 PostScript (phs-to-ps) 1432
DOCUMENT_ROOT 1703, 1976 PS2 HID (devh-ps2ser.so) 343
DOCUMENT_URI 1692 pseudo block (devb-loopback) 203
domain information groper (dig) 542 RAM disk (devb-ram) 212
Domain Name Service See DNS serial HID (devh-ps2ser.so) 343
domains USB Egalax touch devices
names (devh-egalax.so) 339
_CS_DOMAIN 487, 794, 1586, 1661 USB HID (devh-usb.so) 349
server (named) 1159 USB mass storage interface (devb-umass)
Secure RPC (_CS_SRPC_DOMAIN) 795, 215
1661 USB Touch International touch devices
DONT_USE_LINK_UNLINK 1002, 1976 (devh-touchintl.so) 347
DOS filesystem (fs-dos.so) 707 ds 562
dot command DS1, audio driver for
esh, fesh builtin 630 (deva-ctrl-ymfds1.so) 172
ksh builtin 945 DSA identities, adding (ssh-add) 1771
dot notation (IP address) 1858 du 566
double dash, as command-line delimiter 5 dump files, information about (coreinfo) 103
drag-and-drop 1340 dumpefs 568
dragging, window 1521, 1528 dumper 569, 1498
driver dumpifs 572
serial PCI 245 dumps directory 569
serial-to-USB adaptors 247 DUPDIROK 1248
drivers DUPUIDOK 1248
Adaptec 7901/7902-based SCSI adapters DVMRP (Distance-Vector Multicast Routing
(devb-adpu320) 178 Protocol) 1146
Adaptec AIC-7870/7880 based SCSI Dvorak keyboard layout 357, 362
adapters (devb-aha8) 182 Dyna input manager (devi-dyna) 351
AHCI SATA interface (devb-ahci) 186
June 22, 2010 Index 2079

Dynamic Host Configuration Protocol See elvis 579

DHCP emacs interactive input-line editing
963
dynamic HTML 1691, 1702 embedded filesystems
dynamic interfaces, monitoring 864 building (mkefs) 1077
dynamically linked libraries, debugging 1976 dumping (dumpefs) 568
embedded shell (esh) 628
embedded systems See OS images
embedded transaction filesystems
E building (mketfs) 1085
controlling (etfsctl) 635
EALREADY, specifying the value of 1493 RAM/SRAM (fs-etfs-ram) 712
EBCDIC, converting files to and from emkdir (fesh builtin) 660
ASCII 145 emount
echo esh, fesh builtin 631, 1910
ksh builtin 947 EMUL 1993
utility 575 emulation, floating-point
ecp (fesh builtin) 660 forcing 1494
ed 577 support for (fpemu.so) 697
edf (fesh builtin) 660 encryption
EDITOR 932, 984, 1137 exchanging keys
editors racoon 1566
ed 577 racoon.conf 1568
elvis 579 passwords 1248
patching files and disk blocks (spatch) phrelay 1408
1763 random data for 1578
ped 1271 end of options (--) 5
PhAB language (phablang) 1347 Enhanced Host Controller Interface See EHCI
qed 1553 entity descriptions
stream (sed) 1650 in mcd configuration file 1040, 1041
vi 1943 enum-devices
view 1944 enum-usb 623
eecho (fesh builtin) 660 file precedence 605
Egalax touch devices (devh-egalax.so) 339 matching rules 603
egrep 810 enum-usb 615
EHCI, USB support for (devu-ehci.so) 474 Config option 619
EIDE disk interface and ATAPI CD-ROM configuration file 618
interface, driver (devb-eide) 194 Device option 618, 619
ELF enum-devices 615, 623
files, converting to assembler include file information provided 616
(mkasmoff) 1067 Microsoft descriptors 617
images, creating 1111 Set option 621
linker specifications for mkifs 1105 enum/common configuration file 604
load module information (use) 1932 enumerator
elf.boot 1111 USB 615
ellipsis (...), meaning of in syntax line 3 enumerator manager, devices (enum-devices)
Elographics input manager (devi-elo) 353 602
els (fesh builtin) 660
2080 Index June 22, 2010

env 625 HTTPD_SCRIPTALIAS 1703, 1978

ENV 921, 932 IFS 933
environment variables INTERFACE 489, 1978
ABLANG 1975 IOPORT 1263, 1978
ABLPATH 1345, 1348, 1975 IOPORT2 1263, 1978
ACCEPT_LANGUAGE 1703, 1975 IOPORT2SZ 1263, 1978
AUTOCONNECT 27, 1975 IOPORTSZ 1263, 1978
BROADCAST 489, 1975 IPADDRESS 489, 1978
CDPATH 932 IRQ 1263, 1979
CMD_INT 1691, 1693, 1702, 1976 KSH_VERSION 933
COLUMNS 601, 932, 984, 1014, 1976 LANG 797, 1932, 1938, 1979
CONTENT_LENGTH 1703, 1976 LAST_MODIFIED 1692
CONTENT_TYPE 1703, 1976 LC_TYPE 1923, 1979
DATE_GMT 1692 LD_BIND_NOW 792, 1269, 1979
DATE_LOCAL 1692 LD_DEBUG 1979
DISPLAY 1976 LD_DEBUG_OUTPUT 1979
displaying for a process 1442 LD_LIBRARY_PATH 906, 914, 1543,
DL_DEBUG 972, 1976 1948, 1979
DOCUMENT_NAME 1692 LD_RUN_PATH 1980
DOCUMENT_ROOT 1703, 1976 LDEMULATION 1979, 1993
DOCUMENT_URI 1692 LEASEEXPIRES 490, 1980
DONT_USE_LINK_UNLINK 1002, LEASEOBTAINED 490, 1980
1976 LESS 976, 984, 1980
EDITOR 932, 984, 1137 LESSEDIT 984, 1980
ENV 921 LINES 601, 984, 1137, 1980
EXECSHELL 932 LOCALDOMAIN 1190, 1193, 1980
EXINIT 599, 601, 1977 LOGNAME 633, 994, 1345, 1397, 1912,
exporting 948 1980
FCEDIT 932 MAIL 933
FILENAME 490, 1977 MAILCHECK 933
FORWARDED 1703, 1977 MAILPATH 933
FPATH 932 MAKEFLAGS 1543, 1564, 1980
FROM 1704, 1977 MALLOC_OPTIONS 1980
GATEWAY 489, 1977 MIBFILE 1063, 1724, 1733
GATEWAY_INTERFACE 1704, 1977 MKIFS_PATH 1110, 1125, 1980
GNUTARGET 1977, 1991, 1992 MODEM 1556
GZIP 818, 1970, 1977 MORE 1137, 1981
HISTFILE 933 NAMESERVER1, NAMESERVER2
HISTSIZE 933 489, 1981
HOME 631, 633, 933, 994, 1557, 1912 NETMASK 489, 1981
HOSTALIASES 1193, 1977 OLDPWD 933
HOSTNAME 489, 844 OPTARG 933
HTTP_ACCEPT 1704, 1978 OPTIND 934
HTTP_USER_AGENT 1704, 1978 OPTIONx 490
HTTPD_ROOT_DIR 1695, 1702, 1978
HTTPD_ROOT_DOC 1703, 1978
June 22, 2010 Index 2081

PATH 628, 630, 634, 934, 994, 1543, QNX_CONFIGURATION 1545, 1565
1564, 1691, 1693, 1702, 1704, 1912, QNX_HOST 1543, 1564, 1984
1932, 1935, 1948, 1961, 1981 QNX_TARGET 557, 1543, 1564, 1984
PATH_INFO 1704, 1981 QUERY_STRING 1704, 1984
PATH_TRANSLATED 1704, 1981 QUERY_STRING_UNESCAPED 1692
PH_WFRAME_STYLE 1524 QUOTING_STYLE 1253, 1254
PHEXIT_DISABLE 1345, 1395, 1981 RANDOM 935
PHFONT 1345, 1365, 1370, 1981 REFERER 1704, 1984
PHFONT_USE_EXTERNAL 1982 REMOTE_ADDR 1704, 1985
PHFONTMEM 1982 REMOTE_HOST 1704, 1985
PHFONTOPTS 1345, 1982 REMOTE_IDENT 1704, 1985
PHGFX 1345, 1982 REMOTE_PORT 1704, 1985
PHINPUT 1346, 1982 REMOTE_USER 1704, 1985
PHINSTANCE 1982 REPLY 935
PHOTON 1346, 1402, 1982 REQUEST_METHOD 1704, 1985
PHOTON_PATH 1096, 1346, 1513, RESCONF 1985
1515, 1982 SCRIPT_NAME 1704, 1985
PHOTON2_PATH 1982 SECONDS 935
PHOTONOPTS 1982 SERVER 489, 1985
PHSTART 1982 SERVER_ADMIN 1690, 1704, 1986
PHTK_PATH 1982 SERVER_NAME 1704, 1986
PHWM 1346, 1982 SERVER_PORT 1704, 1986
PHWMEXIT 1524, 1982 SERVER_PROTOCOL 1704, 1986
PHWMOPTS 1346, 1524, 1982 SERVER_ROOT 1705, 1986
POSIX_STRICT 106, 110, 1012, 1014, SERVER_SOFTWARE 1705, 1986
1136, 1137, 1983 setting (env) 625
POSIXLY_CORRECT 934, 1983 SHELL 598, 634, 984, 994, 1912, 1986
PPID 934 SMICINCL 1716, 1986
PRINTER 1002, 1983 SNMPCONFIGFILE 1724, 1986
PROCESSOR 1110, 1125, 1983 SOCKET 1263, 1986
PS1, PS2, PS3, PS4 934 SOCKS_NS 1986
PTERMPAL 1514, 1515, 1983 SOCKS_SERVER 1756, 1757, 1986
PTERMRC 1513, 1515, 1983 SUFFIX 1986
PWD 934 SYSLOG 992, 1816, 1987
PWM_PRINTSCRN_APP 1524, 1719, SYSNAME 1987
1983 TERM 601, 634, 984, 994, 1137, 1508,
PYTHONCASEOK 1531 1515, 1593, 1765, 1912, 1987
PYTHONDEBUG 1531 TERMINFO 1877, 1987
PYTHONHOME 1531 TMOUT 935
PYTHONINSPECT 1532 TMPDIR 634, 935, 984, 1912, 1987
PYTHONOPTIMIZE 1532 TZ 140, 634, 1014, 1705, 1884, 1912,
PYTHONPATH 1532 1987
PYTHONSTARTUP 1532 UNZIP 1927
PYTHONUNBUFFERED 1532 USER 1987
PYTHONVERBOSE 1532 USERNAME 994
QCC_CONF_PATH 1542, 1984 VISUAL 935
2082 Index June 22, 2010

EPIC (SMC 9432) Ethernet adapter SMC 91c92/91c100 compatible

(devn-epic.so) 385 (devn-smc9000.so) 414
Epson ESC/P2 print driver (phs-to-escp2) SMC 9432 (EPIC) (devn-epic.so) 385
1419 SMC2208 (devn-rtl8150.so) 408
epwd (fesh builtin) 660 Ethernet controllers
erm (fesh builtin) 660 Broadcom 57xx Tigon3 10/100/1000 Mbit
ermdir (fesh builtin) 660 (devnp-bge.so) 440
errno 627 Broadcom BCM1250 10/100/1000 Mbit
errors, conventions for 6 (devnp-bcm1250.so) 435
escape sequences Broadcom BCM440x 10/100
pterm 1511 (devnp-bce.so) 433
rlogin 1592 Freescale MPC85XX TSEC
telnet 1856, 1857, 1859, 1861 (devnp-mpc85xx.so) 453
esh 628 Intel Tolapai 80579 Gigabit
ESS1938, audio driver for (devnp-i80579.so) 445
(deva-ctrl-ess1938.so) 156 Micrel 8841 or 8842
etfsctl 635 (devn-micrel8841.so) 393
Ethernet Realtek 8169 Gigabit
and IP address translation 25 (devnp-rtl8169.so) 461
Ethernet adapters TIGON3 (devn-tigon3.so) 420
3Com 509 (devn-el509.so) 380 Ethernet dongles
AMD PCNET (AMD-79c97x) compatible ASIX AX88172/AX88178/AX88772
(devn-pcnet.so) 398 (devn-asix.so) 372
ASIX AX88172 chip (devnp-axe.so) Realtek 8150 (devn-rtl8150.so) 408
431 eval (ksh builtin) 947
Broadcom (devnp-bcm43xx.so) 438 events, instrumented kernel
Crystal 89xx (devn-crys8900.so) 375 displaying (traceprinter) 1893
DEC 21x4x (Tulip) compatible storing (tracelogger) 1889
(devn-tulip.so) 423 events, Photon 1374, 1401, 1407
DM9102 (Davicom) (devn-dm9102) 378 bus line 363
Intel 82540, 82541, 82542, 82543, 82544, ewaitfor
82545, 82546, 82547, 82571, 82572, esh, fesh builtin 632, 1911
and 82573 (devn-i82544.so) 390 exceptions, C++, enabling 786, 1536
Intel 82540, 82541, 82544, 82545, 82546, exec
82548, 82571, 82572 esh, fesh builtin 632
(devnp-i82544.so) 447 ksh builtin 948
Intel 82557, 82558, 82559 uesh builtin 1911
(devn-speedo.so) 417 EXECSHELL 932
Intel 82557, 82558, 82559 executables, relocating (ldrel) 974
(devnp-speedo.so) 468 execution, suspending (sleep) 1689
Intel Gigabit (devnp-e1000.so) 442 EXINIT 599, 601, 1977
Marvell Yukon-2 based Gigabit exit
(devnp-msk.so) 456 esh, fesh builtin 632
NE-2000-compatible (devn-ne2000.so) ksh builtin 948
395 uesh builtin 1911
SiS900 compatibles (devn-sis9.so) 411 exit status for utilities 5, 923, 931
June 22, 2010 Index 2083

expand 640 enum-devices 605

export FILENAME 490, 1977
esh, fesh builtin 632 files
ksh builtin 948 access times, changing (touch) 1883
uesh builtin 1912 applications, associations with 1341
exports 642, 1175, 1267 asynchronous I/O, support for
expr 644 (_PC_ASYNC_IO) 796
Ext2 filesystem attributes, manipulating (chattr) 75
(fs-ext2.so) 716 audio 736
extended addressing, enabling for physical checksums, calculating (cksum) 96
addresses above 4 GB 1784 columns, formatting into (pr) 1477
Extended Message Signaled Interrupts (MSI-X) comparing
1266, 1786 cmp 99
external schedulers 1235 diff 528
Extreme 2 graphics controller driver diff3 533
(devg-extreme2.so) 282 to official QNX versions 1533
compressing
bzip2 56
freeze 698
F gzip 816
zip 1967
false compressing for flash filesystems
ksh builtin 948 deflate 148
utility 647 concatenating (cat) 66
family, displaying for a process 1446 concatenating compressed
fat embedded shell (fesh) 659 bz2cat 55, 56
fc (ksh builtin) 948 fcat 648
fcat 648 zcat 816
FCEDIT 932 converting
fdformat 649 to QNX 2, QNX 4, UNIX, or DOS format
fdisk 652 (textto) 1870
fesh 659 while copying (dd) 145
fg (ksh builtin) 949 copying
fgrep 810 converting while (dd) 145
fields, cutting from files (cut) 123 cp 104
fields, paste from files (paste) 1251 first part of (head) 826
FIFO last part of (tail) 1817
manager (pipe) 1465 remotely (rcp) 1581
scheduling policy 1444 securely (scp) 1648
special files, creating (mkfifo) 1093 creating 1341
file 663 damaged, destroying (zap) 1964
file descriptors decoding (uud) 1939
displaying for a process 1442, 1446 decoding (uudecode) 1940
interface driver (devn-fd.so) 388 decompressing
maximum open 1494 bunzip2 54, 56
file manager (pfm) 1340 bzip2 56
file precedence
2084 Index June 22, 2010

decompressing for flash filesystems modification times, changing (touch)

(inflator) 875 1883
deleting modification times, comparing
pfm 1341 find -fmnewer 673
rm 1596 ksh test -nt and -ot 955
unlink 1924 moving or renaming
displaying in decimal, hex, octal, or other mv 1155
formats 822, 1226 pfm 1341
displaying with pagination names
less 976 enabling long 544, 728
more 1136 extracting from pathnames (basename)
editing 1341 29
encoding (uue) 1941 maximum length (_PC_NAME_MAX)
encoding (uuencode) 1942 797
expanding maximum length in a command line 5
bunzip2 54, 56 patterns 936
bzip2 56 object
freeze 698 copying (objcopy) 1224
gunzip 816 displaying information (objdump) 1225
gzip 816 manipulating (mcs) 1060
melt 1061 size of (size) 1683
extracting symbols, listing (nm) 1185
unzip 1925 ownership, changing (chown) 94
fields, cutting (cut) 123 pages, formatting into (pr) 1477
finding (find) 667 patching (spatch) 1763
formatting (fmt) 691 permissions
group ownership, changing (chgrp) 77 changing (chmod) 90
lines creation mask (umask) 1913
padding 145 creation mask (umask ksh builtin) 960
lines, folding (fold) 692 restricting the changing of
link count, maximum (_PC_LINK_MAX) (_PC_CHOWN_RESTRICTED) 95,
797 796
links to, creating printing 1341
cp 105, 110 prioritized I/O, support for
fs-dos.so 709 (_PC_ASYNC_IO) 797
link 986 processes, maximum files per
ln 987 (_SC_OPEN_MAX) 796
ln-w 990 remotely copying (rcp) 1581
mkefs 1083 removing (rm) 1596
mkifs 1101, 1110 repeated lines, reporting or filtering out
listing (ls) 1010 (uniq) 1922
locating a program (which) 1948 searching
maintaining current versions (make) 1031 phfind 1360
merging (join) 916 sizes (cksum) 96
Mode 2 Form 2 VCD 736 sorting, merging, or sequence-checking
(sort) 1760
June 22, 2010 Index 2085

splitting (split) 1766 image

synchronous I/O, support for building (mkifs) 1097
(_PC_ASYNC_IO) 797 dumping (dumpifs) 572
text, pasting (paste) 1251 ISO 9660 support
timestamps, changing (touch) 1883 fs-udf.so 733
timestamps, comparing ISO-9660 support
find -fmnewer 673 fs-cd.so 701
ksh test -nt and -ot 955 Linux Ext2 (fs-ext2.so) 716
transfer protocol daemon (ftpd) 746 mounting (mount) 1139
transferring mounts, showing 1678
ftp 744 NFS 2 client (fs-nfs2) 720
qcp 1548 NFS 3 client (fs-nfs3) 722
sftp 1671 Power-Safe
tftp 1871 checking consistency of (chkqnx6fs)
type, determining 87
file 663 shared object (fs-qnx6.so) 730
magic-number file (magic) 1028 QNX 4
uncompressing checking consistency of (chkfsys) 82
freeze 698 long filenames, enabling 728
gunzip 816 shared object (fs-qnx4.so) 727
gzip 816 SMB client (fs-cifs) 703
melt 1061 statistics, displaying (fsysinfo) 738
unlinking (unlink) 1924 synchronizing with disks (sync) 1803
updating (patch) 1252 Universal Disk Format support
viewing 1341 (fs-udf.so) 733
words, lines, and bytes, counting (wc) unmounting (umount) 1916
1947 Windows NT (fs-nt.so) 725
filesystems find 667
/proc 1498 finstall 683
Apple Macintosh HFS and HFS Plus firewall
(fs-mac.so) 718 lsm-pf-*.so 1018
automounter 1041 flags, displaying for a process 1446
CIFS client (fs-cifs) 703 flash filesystems
descriptive information (/etc/fstab) files, compressing for
742 deflate 148
DOS files, decompressing for (inflator) 875
consistency check (chkdosfs) 79 generic (devf-generic) 254
formatting (mkdosfs) 1074 managing (flashctl) 684
fs-dos.so 707 RAM disk (devf-ram) 261
embedded flashctl 684
building (mkefs) 1077 flex 690
dumping (dumpefs) 568 floating-point emulation
embedded transaction forcing 1494
building (mketfs) 1085 support for (fpemu.so) 697
controlling (etfsctl) 635 floppy disks
RAM/SRAM (fs-etfs-ram) 712 driver (devb-fdc) 200
2086 Index June 22, 2010

formating (fdformat) 649 ftp 744

fmt 691 ftpchroot 745
focus, cursor 1521, 1528 ftpd
fold 692 access-control file 745, 754
font configuring (ftpd.conf) 749
rendering(fontinfo) 694 daemon 746
font_repository 1363 ftpd.conf 749
font usage ftpusers 754
saving 1363 Fujitsu
fontinfo 694 Carmine graphics controller driver
fonts (devg-carmine.so) 270
BDF, converting to Photon (bdftophf2) Coral graphics controller driver
39 (devg-coral.so) 277
choosing styles 1510 fullpath 756
index files, creating (mkfontdir) 1095
manager 1345
server (phfont) 1363
foreground, running jobs in 949 G
formatted
C code (indent) 866 g++ See gcc
output, writing GATEWAY 489, 1977
print ksh builtin 950 GATEWAY_INTERFACE 1704, 1977
printf 1486 gateways
FORWARDED 1703, 1977 next-hop 1604
FPATH 932 gateways file 759
fpemu.so 697 gawk 764
free disk space, reporting (df) 484 gcc 782, See also QCC, qcc
Freescale gcov 788
MPC85XX TSEC Ethernet controllers gdb 790
(devnp-mpc85xx.so) 453 forces the loading of all lazy-load
freeze 698 dependencies 792
FROM 1704, 1977 GeForce graphics chipsets driver
fs-cd.so 701 (devg-tnt.so) 329
fs-cifs 703 Geode
fs-dos.so 707 audio driver for (deva-ctrl-geode.so)
fs-etfs-ram 712 158
fs-ext2.so 716 Geode GX chipsets
fs-mac.so 718 driver (devg-geode.so) 286
fs-nfs2 720 German (DE-102) keyboard layout 233
fs-nfs3 722 getconf 794
fs-nt.so 725 getopts (ksh builtin) 949
fs-qnx4.so 727 getrlimit() 1494
fs-qnx6.so 730 getty 799
fs-udf.so 733 gf-calib 800
fstab 742 GIDRANGE 1248
fsysinfo 738 gns (Global Name Service) 802
GNUTARGET 1977, 1991, 1992
June 22, 2010 Index 2087

gprof 809 range 1248

graphics returning (id) 849
configuration file 605 ownership of files, changing (chgrp) 77
graphics drivers passwords (not supported) 1246
ATI RADEON chipsets 307 set-group ID (_SC_SAVED_IDS) 796
ATI RAGE 128 chipsets 267 supplementary
ATI RAGE chipsets 310 maximum per process
Chips and Technologies graphics chipsets (_SC_NGROUPS_MAX) 796
274 guard area 796
flat frame buffers 285 guidelines for running utilities 4
Fujitsu Carmine chipsets 270 gunzip 816
Fujitsu Coral chipsets 277 gzip 816
Intel 945GX, 945GMx 289 GZIP 818, 1977
Intel Extreme 2 282
Intel Graphics Media Accelerator High
Definition 298
Intel I810 and I815 chipsets 292 H
Intel I830 and I845 chipsets 295
Intel Poulsbo chipsets 304 halting See also phshutdown, shutdown
Matrox Millennium G-series disabling in idle thread 1494
(devg-matroxg.so) 301 ham 820, 821, 868
National Semiconductor Geode and Media hangups, preventing in commands (nohup)
GX chipsets 286 1186
NVIDIA chipsets 329 hard disk devices, common access method
S3 Savage chipsets 313 (cam-disk.so) 63
Silicon Motion Lynx chipset 322 hard links
Silicon Motion SM501 chipset 319 creating
SIS graphics chipsets 316 cp 105
software 3D 325, 326 ln 987
starting (io-graphics) 903 ln-w 990
Super VGA 327 deleting
TVIA CyberPro chipsets 332 rm 1596
VESA 2.0 335 unlink 1924
VMWare 337 hardware
Graphics Media Accelerator High Definition debuggers 1782
driver (devg-intelhd.so) 298 input, changing 883
graphics resolution 1372 manufacturer (_CS_HW_PROVIDER) 794,
graphics server 1661
io-display 899 serial number (_CS_HW_SERIAL) 794,
graphs, topological sorting of directed 1906 1661
grep 810 type (_CS_MACHINE) 795, 1661
groups Hardware Crypto Engine driver
changing 1173 (devnp-mpcsec.so) 451
IDs hash (ksh builtin) 949
displaying for a process 1450 hd 822
mapping 1020 head 826
header
2088 Index June 22, 2010

ICMP 1458 going to 946

IP 1458 host 841
HELD state, starting programs in (on) 1234 host status of local machines, showing
help (ruptime) 1641
online (helpviewer) 829 HOSTALIASES 1193, 1977
TOC files 832 hostapd 842
topic files 832 hostname 844
Universal Resource Locator (URL) 835 HOSTNAME 489, 844
helpviewer 828 hostnames
HTML1/ISO entities 832 database (hosts) 845
Hewlett-Packard PCL print driver getting and setting
(phs-to-pcl) 1426 _CS_HOSTNAME 794
hex records, converting binary image to (mkrec) hostname 844
1132 setting
hexadecimal numbers on the command line 4 setconf 1661
HFS and HFS Plus (fs-mac.so) 718 valid characters 794, 1661
HID hosts 845
I/O support (io-hid) 906 hosts
Microtouch EXII driver domain name
(devh-microtouch.so) 341 _CS_DOMAIN 487, 794, 1586, 1661
Photon input manager (devi-hid) 356 names
PS2 driver (devh-ps2ser.so) 343 _CS_HOSTNAME 844
serial driver (devh-ps2ser.so) 343 hosts, trusted
USB driver (devh-usb.so) 349 .rhosts 1589
USB Egalax driver (devh-egalax.so) hosts.equiv 846
339 hosts.equiv 846, 999, 1589, 1626
USB Touch International driver hosts.lpd 999
(devh-touchintl.so) 347 HTML
viewing data (hidview) 837 anchors 835
hidview 837 displaying 829
High Definition Audio controllers, audio driver dynamic 562
for (deva-ctrl-intel_hda.so) HTTP_ACCEPT 1704, 1978
162 HTTP_USER_AGENT 1704, 1978
High Definition Audio mixer HTTPD_ROOT_DIR 1695, 1702, 1978
(deva-mixer-hda.so) 176 HTTPD_ROOT_DOC 1703, 1978
high-availability HTTPD_SCRIPTALIAS 1703, 1978
manager 820, 868 human-interface devices See HID
controlling 821
HISTFILE 933
history 836
history, commands 948 I
HISTSIZE 933
hogs 839 I/O
HOME 631, 633, 933, 994, 1557, 1912 asynchronous
home directory priority for
default 1248 (_SC_AIO_PRIO_DELTA_MAX) 795
June 22, 2010 Index 2089

I/O Controller Hubs, Intel ICH8 and ICH9 if_up 851

(devn-i82544.so) 390 ifconfig 853
I/O support ifdef’ed lines, removing (unifdef) 1921
asynchronous (_PC_ASYNC_IO) 796 IFF_MULTICAST 1147
block (io-blk.so) 888 IFS 933
HID (io-hid) 906 ifwatchd 864
prioritized (_PC_ASYNC_IO) 797 IJS print driver (phs-to-ijs) 1423
synchronous (_PC_ASYNC_IO) 797 IKE (ISAKMP/Oakley)
USB (io-usb) 914 key management
I810 and I815 chipsets configuration (racoon.conf) 1568
driver (devg-i810.so) 292 daemon (racoon) 1566
I830 and I845 chipsets image
driver (devg-i830.so) 295 converting from binary (mkrec) 1132
ICMP filesystem
ECHO_REQUEST packets, sending to building (mkifs) 1097
network hosts determining which shared objects to
ping 1455 include (ldd) 972
ping6 1460 dumping (dumpifs) 572
header 1458 restoration 1781
packets 1458, See also packets microkernel (procnto*) 1493
id 849 sending to target (sendnto) 1658
IDE (Integrated Development Environment) socket, building (mkimage) 1126
launching 1551 images, graphical
QNX System Builder projects, building capturing (snapshot) 1717
(mksbp) 1134 displaying (pv) 1518
remote support (qconn) 1546 inc_user_spec_id
IDE disk interface and ATAPI CD-ROM enum-usb Set option attribute 622
interface, driver (devb-eide) 194 indent 866
idle thread, disabling CPU halting in 1494 inetd 1358
IDs inetd daemon 868
channel (chids) 1494 inetd.conf 44, 870
connection (coids) 1494 inflator 875
group 1248 infocmp 878
displaying for a process 1450 information, system
mapping 1020 hogs 839
groups pidin 1442
saved (_SC_SAVED_IDS) 796 top 1882
process 1442 inherit masks
thread 1442 setting 1236, 1686
user 1248 input
displaying for a process 1450 configuration file 604
mapping 1020 input devices
users configuring (input-cfg) 880
saved (_SC_SAVED_IDS) 796 probing for (inputtrap) 882
IEEE 802.11 networks input group 1521
authenticator 842 input manager
2090 Index June 22, 2010

“high runner” (devi-hirun) 359 8X0, audio driver for

Dyna (devi-dyna) 351 (deva-ctrl-i8x0.so) 160
Elographics (devi-elo) 353 945GX/945GMx graphics controller driver
HID (devg-extreme2.so) 289
devh-egalax.so 339 Extreme 2 graphics controller driver
devh-microtouch.so 341 (devg-extreme2.so) 282
devh-ps2ser.so 343 Gigabit Ethernet controllers
devh-touchintl.so 347 (devnp-e1000.so) 442
devh-usb.so 349 Graphics Media Accelerator High Definition
devi-hid 356 driver (devg-intelhd.so) 298
Microtouch (devi-microtouch) 364 hex records, converting binary image to
Semtech (devi-semtech) 367 (mkrec) 1132
Zytronic (devi-zytronic) 369 I810 and I815 chipsets driver
input, standard (devg-i810.so) 292
duplicating (tee) 1854 ICH8, ICH9 I/O Controller Hubs
reading from (read ksh builtin) 951 (devn-i82544.so) 390
input-cfg 880 Poulsbo chipsets driver (devg-geode.so)
input.hostname file 883 304
inputtrap 882 Tolapai 80579 Gigabit Ethernet controllers
insertion (devnp-i80579.so) 445
notification callout prototype 1044 Intel Advanced Programmable Interrupt
INSISTANT 1248 Controller (APIC), startup for
installations, coexistence 1543, 1564 (startup-apic) 1785
instruction set architecture Intel High Definition Audio controllers, audio
(_CS_ARCHITECTURE) 794, 1661 driver for
instrumented kernel (deva-ctrl-intel_hda.so) 162
procnto*-instr 1493 Intel Poulsbo chipsets
trace support driver (devg-poulsbo.so) 304
tracelogger 1889 interactive paginator
traceprinter 1893 less 976
integers, decimal, in utility syntax 4 more 1136
Intel INTERFACE 489, 1978
82540, 82541, 82542, 82543, 82544, 82545, interface
82546, 82547, 82571, 82572, and 82573 mcd resource manager 1042
Gigabit Ethernet LAN controller internal field separator 933
(devn-i82544.so) 390 international languages
82540, 82541, 82544, 82545, 82546, 82548, keyboard layouts 233
82571, 82572 Gigabit Ethernet LAN keyboard mapping 357, 362
controller (devnp-i82544.so) 447 PhAB editor (phablang) 1347
82557, 82558, 82559 Fast Ethernet LAN setting (phlocale) 1391
controller (devn-speedo.so) 417 Internet Boot Protocol server (bootpd) 44
82557, 82558, 82559 Fast Ethernet LAN configuration file (bootptab) 46
controller (devnp-speedo.so) 468 Internet name servers, querying (nslookup)
828xx graphics chipsets driver 1188
(devg-i830.so) 295 Internet super-server (inetd) 868
interprocess communication
June 22, 2010 Index 2091

pipe 1465 racoon.conf 1568

pps 1476 IPsec (secure Internet Protocol)
interrupt handlers, displaying for a process Security Association and Security Policy
1442 databases, manipulating 1663
io-audio 885 IPv6
loadable drivers 885 -prefixlen 1605
io-blk.so 888 NDP 1163
io-display 899 packets, route of (traceroute6) 1903
configuration file 900 IRQ 1263, 1979
io-graphics 903 IRQ handlers, displaying for a process 1442
io-hid 906 isa-types
io-net configuration file 605
drivers ISO 9660 filesystem support
compatibility with io-pkt 467 fs-udf.so 733
io-pkt 908 ISO-9660 filesystem support
io-usb 914 fs-cd.so 701
selecting driver configurations 915
ioctl_socket()
using instead ofioctl() for pf and bpf
1280 J
ioctl()
usingioctl_socket() for pf and bpf 1280 job control 962
IOPORT 1263, 1978 _SC_JOB_CONTROL 795
IOPORT2 1263, 1978 jobs (ksh builtin) 950
IOPORT2SZ 1263, 1978 join 916
IOPORTSZ 1263, 1978 JOIN (thread state) 1451
IP JTAG debuggers 1782
addresses
and Ethernet addresses 25
broadcast address 855
dot notation 1858
K
finding your 854 kbd.tbl* 233
mappings for hostnames 845 kernel See microkernel
filtering (lsm-pf-*.so) 1018 keyboard 357, 362
header 1458 keyboards
multicasting (mrouted) 1146 .kdef definition file 1127
IPADDRESS 489, 1978 bindings 946
ipod detecting (inputtrap) 882
configuration file 605 disabling 1407, 1521
iPod I/O manager
authentication chip 615 devc-con, devc-con-hid 217
detecting 1053 devi-hid 356
launcher 615 in ped 1273
IPSec international 233
bulk encryption keys managing
racoon 1566 devh-ps2ser.so 343
2092 Index June 22, 2010

devh-usb.so 349 ldrel 974

devi-hirun 359 LEASEEXPIRES 490, 1980
mappings LEASEOBTAINED 490, 1980
defining (mkkbd) 1127 leases, DHCP 521
selecting 357, 362 less 976
type, setting (phlocale) 1391 LESS 976, 984, 1980
USB support for (devu-kbd) 476 LESSEDIT 984, 1980
keychords let (ksh builtin) 950
Ctrl-Alt 1521 lexical tasks, generating programs for (flex)
Ctrl-Alt-Shift-Backspace, disabling 359 690
pterm 1510 libdisputil.so.2 904
keys, gathering public (ssh-keyscan) 1776 libffb.so.2 904
kill 918 libqdb_cldr.so 1068
esh, fesh builtin 633 converting from POSIX 1068
ksh builtin 950 libraries
Korn shell, public domain (ksh) 920 linking against 1536
ksh 920 locating
KSH_VERSION 933 _CS_LIBPATH 794, 1661, 1948
shared, required by a program (ldd) 972
using random addresses for 1496
licenses
L displaying the type of the active
(showlicense) 1676
LANG 797, 1932, 1938, 1979 information about xxiii
language lightweight resolver daemon (lwresd) 1026
sort order 1068 limits
languages, international files
keyboard mapping 357, 362 link count (_PC_LINK_MAX) 797
PhAB editor (phablang) 1347 maximum per process
setting (phlocale) 1391 (_SC_OPEN_MAX) 796
languages.def 1347 names, length of (_PC_NAME_MAX)
LAST_MODIFIED 1692 797
lastlog 994 path names, length of (_PC_PATH_MAX)
launcher 797
iPod 615 pipes, number of bytes written atomically
LC_TYPE 1923, 1979 (_PC_PIPE_BUF) 797
ld 1993, See also qcc processes
LD_BIND_NOW 792, 1269, 1979 argument lists (_SC_ARG_MAX) 795
LD_DEBUG 1979 files, number open (_SC_OPEN_MAX)
LD_DEBUG_OUTPUT 1979 796
LD_LIBRARY_PATH 906, 914, 1543, 1948, getting and setting (ulimit ksh builtin)
1979 959
LD_RUN_PATH 1980 maximum per real user ID
ldd 972 (_SC_CHILD_MAX) 795
LDEMULATION 1979, 1993 supplementary group IDs
ldqnx.so.2 1123 (_SC_NGROUPS_MAX) 796
ldqnx.so.3 (for MIPS) 1123
June 22, 2010 Index 2093

terminals loader, boot, writing to a disk 555

canonical input buffer size local machines
(_PC_MAX_CANON) 797 host status of (ruptime) 1641
raw input buffer size (_PC_MAX_INPUT) who’s logged in (rwho) 1642
797 local mode
LINES 601, 984, 1137, 1980 MCD 1036
lines LOCALDOMAIN 1190, 1193, 1980
counting (wc) 1947 locale
folding (fold) 692 current (_CS_LIBPATH) 795, 1661
repeated, reporting or filtering out (uniq) localization (phlocale) 1391
1922 log, system
sorting, merging, or sequence-checking configuration (syslog.conf) 1812
(sort) 1760 daemon (syslogd) 1815
link 986 examining (sloginfo) 1710
linker, runtime 1123 manager (slogger) 1706
linking logger 991
CC, cc 68 logging in
emulation selection 1993 listing logged-in users (who) 1950
gcc 782 login 993
ld 971 on 1234
QCC, qcc 1535 phlogin 1395
links login 993
creating login
cp 105, 110 remote (rlogin) 1592
fs-dos.so 709 shell, default 1248
link 986 showing who’s logged in locally (rwho)
ln 987 1642
ln-w 990 login file 994
mkefs 1083 LOGNAME 633, 994, 1345, 1397, 1912, 1980
mkifs 1101, 1110 logout 997
deleting long filenames, enabling 544, 728
rm 1596 loopback driver (devb-loopback) 203
unlink 1924 lowercase, converting files to and from 145
ignored by gzip 817 lpd 998
resolving lpr 1001
find 673, 675, 678, 680 lprc 1003
fullpath 756 lprq 1006
ls 1011 lprrm 1008
testing for (test ksh builtin) 955 ls 1010
Linux Ext2 filesystem lsm-autoip.so 1015
(fs-ext2.so) 716 lsm-pf-v4.so, lsm-pf-v6.so 1018
ln 987 lsm-qnet.so 1019
ln-w 990 lwresd 1026
loadable shared modules Lynx chipsets driver (devg-smi7xx.so) 322
AutoIP negotiation 1015
Qnet 1019
2094 Index June 22, 2010

M detecting other system media 1052

device configuration 1039
m4 1027 entities 1040
MAC addresses, modifying 857 notification routine 1041
Macintosh HFS and HFS Plus (fs-mac.so) operation flow 1039
718 overview 1037
macro processor (m4) 1027 pattern matching 1054
magic 1028 resource manager interface 1042
MAIL 933 rules 1037
MAILCHECK 933 sequence number 1043
MAILPATH 933 server 1038, 1042
make 1031 st_ino 1043
recursive, directory structure for 13 threads 1039
MAKEFLAGS 1543, 1564, 1980 two-phase processing 1041
MALLOC_OPTIONS 1980 using as partition enumerator 1056
Management Information Base See MIB MCD See mcd
mappings local mode 1036
memory, displaying information mcd_content()
about 1448 mcdcallout prototype 1046
mappings, keyboard mcd_notify()
defining (mkkbd) 1127 mcdcallout prototype 1044
selecting 357, 362 MCL_CURRENT 1495
Marvell MCL_FUTURE 1495
88SX50XX SATA interface mcs 1060
(devb-mvSata) 208 media
Yukon-2 based Gigabit Ethernet adapters configuration file 604
(devnp-msk.so) 456 media
mass detecting other system with MCD 1052
configuration file 605 Media Content Detector See mcd
mass storage interface, USB, driver for Media GX chipsets
(devb-umass) 215 driver (devg-geode.so) 286
matching rules mediastore
enum-devices 603 configuring mcd 1039
Matrox mediastores
Millennium G-series graphics chipsets driver detecting 1036
(devg-matroxg.so) 301 melt 1061
mcd 1036 memory
.devices directory 1042 amount free, displaying 1447
.eject file 1042 displaying information about 1677
.insert file 1042 extended addressing for physical addresses
callout templates 1044 above 4 GB 1784
CD-changer controlled by external initializing to all zeroes 1495
firmware 1055 locking 1495
client API 1050 mappings, displaying information about
configuring 1039 1448
detecting CD with non-media content 1055 owned by a process, displaying 1442
June 22, 2010 Index 2095

removing from system use 1782 High Definition Audio

superlocking 1495 (deva-mixer-hda.so) 176
variable page size 1496 mkasmoff 1067
menus mkbuild 1070
desktop, customizing 1523 mkcldr 1068
workspace, disabling 1522 mkdir 1072
mesg 1062 mkdosfs 1074
message database, editing 1349 mkefs 1077
message queues mketfs 1085
manager (mq, mqueue) 1143, 1145 mkfifo 1093
maximum number of 1494 mkfontdir 1095
Message Signaled Interrupts (MSI) 1266, 1786 mkifs 1097
messages, broadcast (mesg) 1062 MKIFS_PATH 1110, 1125, 1980
MIB mkifsf_elf 1117
compiler (smic) 1712 mkifsf_openbios 1117
data, defining views of (view.conf) 1945 mkifsf_srec 1117
environment variables 1063 mkimage 1126
stripping modules from an RFC 1154 mkkbd 1127
system state 1804 mkqnx6fs 1129
mib.txt 1063, 1733 mkrec 1132
MIBFILE 1063, 1724, 1733 mksbp 1134
mice, USB support for (devu-mouse) 477 mkxfs See mkefs, mkifs
Micrel mode
8841 or 8842 Ethernet controllers MCD
(devn-micrel8841.so) 393 local 1036
micro-embedded shell (uesh) 1908 Mode 2 Form 2 VCD files 736
microkernel MODEM 1556
instrumented 1889, 1893 modems 1358, 1404
preemption, disabling 1496 automated conversational script with
procnto* 1493 (chat) 70
restoration 1781 dialer (phdialer) 1353
version of, determining 1497 modes
Microsoft descriptors file, changing (chmod) 90
reported by enum-usb 617 terminal, setting (getty) 799
Microtouch modeswitchers (dispconf) 553
EXII USB touch devices modification times for files
(devh-microtouch.so) 341 changing (touch) 1883
input manager (devi-microtouch) 364 comparing
Millennium G-series graphics chipsets driver find -fmnewer 673
(devg-matroxg.so) 301 ksh test -nt and -ot 955
MIPS startup options 1780 moduli 1135
mixer 1064 monitoring
mixers, audio device insertion 1036
AC’97 (deva-mixer-ac97.so) 174 device removal 1036
AK4531 (deva-mixer-ak4531.so) 175 monotonic clock 1449
more 1136
2096 Index June 22, 2010

MORE 1137, 1981 Mylex Multimaster host adapters, drivers

Motorola (devb-btmm) 190
S records, converting binary image to
(mkrec) 1132
mount 1139
predefined mountpoints (/etc/fstab) N
742
mount directory name server control utility (rndc) 1600
pathname-space mountpoints 1498 configuration file (rndc.conf) 1602
mounts, remote NFS, showing 1678 key-generation tool (rndc-confgen)
mouse 1601
configuring (input-cfg) 880 name servers
detecting (inputtrap) 882 backup file when server isn’t running 845
in ped 1273 querying interactively (nslookup) 1188
in pterm 1509 Name-service switch configuration
managing nsswitch.conf 1194
devh-ps2ser.so 343 named
devh-usb.so 349 configuration file 1162
devi-hid 356 syntax checker (named-checkconf)
devi-hirun 359 1160
repeat delay, setting 1401 daemon 1159
repeat rate, setting 1401 zone files 1161
speed (gain), setting 362, 881 named semaphores
MPC85XX TSEC Ethernet controllers manager (procnto*) 1493
(devnp-mpc85xx.so) 453 maximum number of 1494
mq 1143, 1145 named-checkconf 1160
mqueue 1143, 1145 named-checkzone 1161
mrouted 1146 named-compilezone 1161
mrouted.cache 1152 named.conf 1159, 1162
mrouted.conf 1152 syntax checker (named-checkconf)
mrouted.dump 1152 1160
mrouted.pid 1152 named.pid 1159
MS-CHAP 1468 names See also hostnames
MSI (Message Signaled Interrupts) 1266, 1786 domain,_CS_DOMAIN 487, 794, 1586,
MSI-X (Extended Message Signaled Interrupts) 1661
1266, 1786 hostname database (hosts) 845
mstrip 1154 service name database (services) 1660
multicore microkernel and process manager NAMESERVER1, NAMESERVER2 489,
(procnto-smp) 1493 1981
Multimaster host adapters, drivers (devb-btmm) NAT
190 controlling 1333
multimonitor placement 1521, 1528 services, providing (lsm-pf-*.so) 1018
MUTEX (thread state) 1451 National Semiconductor
mutually exclusive arguments 3 Geode and Media GX chipsets driver
mv 1155 (devg-geode.so) 286
Geode, audio driver for
(deva-ctrl-geode.so) 158
June 22, 2010 Index 2097

native networking 1019 based on Pegasus chip set

ndp 1163 (devn-pegasus.so) 402
NE-2000-compatible Ethernet adapter VIA Rhine (devn-via-rhine.so) 426
(devn-ne2000.so) 395 Network Time Protocol See NTP
Neighbor Discovery Protocol See NDP network traffic, dumping 1823
NeoMagic networking manager 908
NeoMagic 6, audio driver for networks 1169, 1172
(deva-ctrl-nmg6.so) 164 newgrp 1173
net next-hop gateway 1604
configuration file 604, 605 NFS
net.cfg 1165, 1379 exporting filesystems 642
netmanager 1165 as read-only 642
NETMASK 489, 1981 in a PC environment
netmask authenticator (pcnfsd) 1267
route 1605 configuration (pcnfsd.conf) 1268
netstat 1167 remote mounts, showing 1678
network server daemons, starting (nfsstart)
debugging 1167 1178
host status of machines, showing status of server, querying 1678
(ruptime) 1641 NFS 2 client filesystem (fs-nfs2) 720
interface controller, displaying information NFS 3 client filesystem (fs-nfs3) 722
about (nicinfo) 1182 nfsd 1175
local machines, showing who’s logged in nfsstart 1178
(rwho) 1642 nice 1179
managing and troubleshooting nicinfo 1182
ping 1457 nm 1185
ping6 1462 nobios.boot 1111
traceroute 1898 nohup 1186
traceroute6 1903 non-media content
name database 1172 detecting CD with 1055
services file (services) 1660 NOPASSWORDOK 1248
statistics nophoton 1345, 1880
netstat 1167 nslookup 1188
troubleshooting 1167 nslookup.help 1193
network adapters nsswitch.conf 1194, 1458
Atheros AR5210, AR5211, AR5212, and nsupdate 1196
AR5213 chips (devnp-ath.so) 429 NTFS (fs-nt.so) 725
Network Address Translation See NAT ntoarm-addr2line See addr2line
network interface ntoarm-ar See ar
aliases 855 ntoarm-gcc See gcc
configuring 853 ntoarm-gcov See gcov
enabling 861 ntoarm-gdb See gdb
querying 1168, 1169, 1171 ntoarm-gprof See gprof
network interface cards (NICs) ntoarm-ld See ld
3Com 90x (devn-el900.so) 382 ntoarm-nm See nm
USB Ethernet adapters ntoarm-objcopy See objcopy
2098 Index June 22, 2010

ntoarm-objdump See objdump ntosh-strip See strip

ntoarm-ranlib See ranlib ntox86-addr2line See addr2line
ntoarm-size See size ntox86-ar See ar
ntoarm-strings See strings ntox86-gcc See gcc
ntoarm-strip See strip ntox86-gcov See gcov
ntomips-addr2line See addr2line ntox86-gdb See gdb
ntomips-ar See ar ntox86-gprof See gprof
ntomips-gcc See gcc ntox86-ld See ld
ntomips-gcov See gcov ntox86-nm See nm
ntomips-gdb See gdb ntox86-objcopy See objcopy
ntomips-gprof See gprof ntox86-objdump See objdump
ntomips-ld See ld ntox86-ranlib See ranlib
ntomips-nm See nm ntox86-size See size
ntomips-objcopy See objcopy ntox86-strings See strings
ntomips-objdump See objdump ntox86-strip See strip
ntomips-ranlib See ranlib NTP
ntomips-size See size daemon (ntpd) 1197
ntomips-strings See strings monitoring (ntpq) 1212
ntomips-strip See strip querying (ntpdc) 1205
ntoppc-addr2line See addr2line servers, tracing chains of (ntptrace)
ntoppc-ar See ar 1222
ntoppc-gcc See gcc time, setting (ntpdate) 1202
ntoppc-gcov See gcov ntpd 1197
ntoppc-gdb See gdb ntpdate 1202
ntoppc-gprof See gprof ntpdc 1205
ntoppc-ld See ld ntpq 1212
ntoppc-nm See nm ntptrace 1222
ntoppc-objcopy See objcopy null command (ksh builtin) 945
ntoppc-objdump See objdump numerical operands, in utility syntax 4
ntoppc-ranlib See ranlib NVIDIA
ntoppc-size See size RIVA and GeForce graphics chipsets driver
ntoppc-strings See strings (devg-tnt.so) 329
ntoppc-strip See strip
ntosh-addr2line See addr2line
ntosh-ar See ar
ntosh-gcc See gcc O
ntosh-gcov See gcov
ntosh-gdb See gdb O_SYNC 1706
ntosh-gprof See gprof objcopy 1224
ntosh-ld See ld objdump 1225
ntosh-nm See nm object files
ntosh-objcopy See objcopy copying (objcopy) 1224
ntosh-objdump See objdump displaying information (objdump) 1225
ntosh-ranlib See ranlib manipulating (mcs) 1060
ntosh-size See size size of (size) 1683
ntosh-strings See strings symbols, listing (nm) 1185
octal numbers on the command line 4
June 22, 2010 Index 2099

od 1226 dumping (dumpifs) 572

OHCI, USB support for (devu-ohci.so) 478 name (_CS_SYSNAME) 795, 1661
OLDPWD 933 name, returning (uname) 1917
omshell 1229 release level (_CS_RELEASE) 795, 1661
on 1234 version (_CS_VERSION) 795, 1661
online help (helpviewer) 829 version number (uname) 1917
op 1238 other scheduling policy 1444
Open Host Controller Interface See OHCI output, writing formatted (print ksh builtin)
openbios.boot 1111 950
OpenSSH output, writing formatted (printf) 1486
authentication agent (ssh-agent) 1772 ownership, changing (chown) 94
authentication key generation, management,
and conversion (ssh-keygen) 1774
file transfer program (sftp) 1671
public keys, gathering (ssh-keyscan) P
1776
remote login program (ssh) 1770 packet filter
RSA or DSA identities, adding (ssh-add) configuration file 1296
1771 controlling 1333
secure copy (scp) 1648 pseudo-device 1280
SFTP server subsystem (sftp-server) usingioctl_socket() instead ofioctl() 1280
1672 packets 1458
SSH client configuration files dropped packets, displaying 1167
(ssh-config) 1773 duplicate & damaged 1458, 1463
SSH daemon (sshd) 1778 logging bad packets 1610
configuration file 1779 tracing
SSH helper program for host-based routed 1611
authentication (ssh-keysign) 1777 tftp 1873
system moduli file (/etc/moduli) 1135 traceroute 1898
openssl 1239 traceroute6 1903
OPTARG 933 TTL details 1459
optical disk devices, common access method page size (memory), variable 1496
(cam-optical.so) 65 pages, formatting files into (pr) 1477
OPTIND 934 paginator, interactive
OPTIONx 490, 1981 less 976
options 836 more 1136
options PAP (Password Authentication Protocol) 1384,
parsing 949 1467
syntax conventions for 3 par-class
OS configuration file 605
coexistence of multiple versions 1543, parallel port manager (devc-par) 237
1564 parser generator (bison) 41
image partition
building (mkifs) 1097 using mcd as enumerator 1056
determining which shared objects to partitions, adaptive
include (ldd) 972 averaging window, setting size of 22
displaying for a thread 1442
2100 Index June 22, 2010

information about, displaying 1446 starting drivers (pccard-launch) 1262

managing 20 PC-compatible systems with a BIOS, startup for
processes, starting in 1236 (startup-bios,
security, setting 21 startup-bios-32) 1788
partitions, managing (fdisk) 652 pccard-launch 1262
party.conf 1244 pccard-types
passwd 1246 configuration file 605
passwd file 995, 1246 pccard-vendors
passwords configuration file 605
allowing none 1248 pci 1264
changing (passwd) 1246 PCI
encryption 1248 cards
groups (not supported) 1246 Realtek 8139 (devn-rtl.so) 405
strict 1248 devices, displaying (pci-bios) 1264
paste 1251 serial driver 245
patch 1252 pci-bios, pci-bios-v2 1265
patches, installing and uninstalling pci-class
(applypatch) 18 configuration file 605
PATH 628, 630, 634, 934, 994, 1543, 1564, pci-vendors
1691, 1693, 1702, 1704, 1912, 1932, configuration file 605
1935, 1948, 1961, 1981 PCMCIA server (devp-pccard) 471
PATH_INFO 1704, 1981 PCNET (AMD-79c97x) compatible Ethernet
PATH_MEDIA_PROCMGR 1045 adapter (devn-pcnet.so) 398
PATH_MEDIA_SCAN 1045 pcnfsd 1267
PATH_TRANSLATED 1704, 1981 pcnfsd.conf 1268
pathname delimiter in QNX pdebug 1269
documentation xxiv forces the loading of all lazy-load
pathnames dependencies 1269
extracting directory names (dirname) 548 ped 1271
extracting filenames (basename) 29 pedrc 1279
maximum length (_PC_PATH_MAX) 797 Pegasus chipset driver (devn-pegasus.so)
network-qualified (fullpath) 756 402
testing for (waitfor) 1946 permissions, changing (chmod) 90
truncating (_PC_NO_TRUNC) 797 Persistent Publish/Subscribe manager (pps)
pattern matching 1476
and processing (gawk) 764 pf 1280
and processing (python) 1530 PF_CHANGE_* 1285
case-sensitivity 1054 PF_DEBUG_* 1284
extended (egrep) 810 PF_OSFP_* 1291
fixed string (fgrep) 810 pf_osfp_ioctl 1291
grep 810 PF_RULESET_* 1290
with the MCD 1054 pf_status 1284
pax 1256 pf.conf 1296
PC Cards pfctl 1333
resources, information about (pin) 1454 pfi_if 1293
server (devp-pccard) 471 PFI_IFLAG_SKIP 1293
June 22, 2010 Index 2101

pfioc_altq 1281 phin 1374

pfioc_if 1283 PHINPUT 1346, 1982
pfioc_iface 1292 PHINSTANCE 1982
pfioc_limit 1286 phlip 1379
pfioc_natlook 1284 phlocale 1391
pfioc_pooladdr 1281 phlogin, phlogin2 1395
pfioc_qstats 1282 exit button 1395
pfioc_rule 1281 user icons 1437
pfioc_ruleset 1282 phmenu 1398
pfioc_src_nodes 1292 PHOTON 1346, 1402, 1982
pfioc_state 1283 Photon
pfioc_state_kill 1283 accessing from a remote node (phditto)
pfioc_states 1285 1356
pfioc_table 1286 Application Builder (appbuilder) 16
pfioc_tm 1286 booting into, preventing 1345
pfioc_trans 1290 configuration files 1344
pfm 1340 connecting to a remote session 1358
“dot” files 1343 Ctrl-Alt-Shift-Backspace, disabling 359
find by typing 1343 desktop background 42, 1521, 1529
prompts 1343 dialup connector (phdialer) 1353
UTF8 encoding 1343 display options (phgrafx) 1371
pfr_addr 1288 display, rotating 901
pfr_astats 1289 dittoing 1358
pfr_table 1287 editor (ped) 1271
pfr_tstats 1287 exiting 1395, 1434
ph 1344, 1395 file manager (pfm) 1340
PH_WFRAME_STYLE 1524 fonts
ph-rotate-180.so 901 converting from BDF (bdftophf2) 39
ph-rotate-270.so 901 server (phfont) 1363
ph-rotate-90.so 901 graphics drivers, starting (io-graphics)
PhAB (appbuilder) 16 903
phablang 1347 input manager
phabmsg 1349 “high runner” (devi-hirun) 359
phapps 1345 Dyna (devi-dyna) 351
phcalc 1352 Elographics (devi-elo) 353
phdialer 1353 keyboards and mice (devi-hid) 356
phditto 1356, 1403 Microtouch (devi-microtouch) 364
PHEXIT_DISABLE 1345, 1395, 1981 Semtech (devi-semtech) 367
phfind 1360 Zytronic (devi-zytronic) 369
phfont 1363 language editor (phablang) 1347
PHFONT 1345, 1365, 1370, 1981 launching (ph) 1344
PHFONT_USE_EXTERNAL 904, 1982 launching automatically (tinit) 1880
PHFONTMEM 1982 login dialog 1395
PHFONTOPTS 1345, 1982 message database 1349
PHGFX 1345, 1982 phrelay options (phrelaycfg) 1411
phgrafx 1371 predefined services 1405
2102 Index June 22, 2010

print drivers PHWMOPTS 1346, 1524, 1982

bitmap (phs-to-bmp) 1416 pidin 1442
Canon (phs-to-bjc) 1413 pin 1454
Epson ESC/P2 (phs-to-escp2) 1419 ping 1455
Hewlett-Packard PCL (phs-to-pcl) ping6 1460
1426 pipe 1465
IJS (phs-to-ijs) 1423 pipes
PostScript (phs-to-ps) 1432 bytes, writing atomically (_PC_PIPE_BUF)
printing (preview) 1480 797
PWM menu 1398 coprocesses 941
regions, displaying (phview) 1440 placement, multimonitor 1521, 1528
remote pnpbios-types
connectivity 1358, 1403, 1404 configuration file 605
sessions 1358, 1404, 1408 Point-to-Point Protocol See PPP
screensaver options (savercfg) 1645 Point-to-Point Protocol Over Ethernet See
security 1402 PPPOE
server (Photon) 1401 pointer 1375
shelf 1674 port, parallel, manager for (devc-par) 237
system information POSIX
phin 1374 conventions for utility syntax 3
TCP/IP configuration (phlip) 1379 converting to binary for libqdb_cldr.so
terminal window (pterm) 1505 1068
window manager (pwm) 1521 ksh behavior 942
options (pwmopts) 1526 version supported (_SC_VERSION) 796
PHOTON_PATH 1096, 1346, 1513, 1515, POSIX_STRICT 106, 110, 1012, 1014, 1136,
1982 1137, 1983
Photon server POSIXLY_CORRECT 934, 1983
access permissions 1396 postmortem state of a program, dumping
PHOTON2_PATH 1982 (dumper) 569
PHOTONOPTS 1982 Power-Safe filesystem (fs-qnx6.so) 730
phrelay 1358, 1403 checking consistency of (chkqnx6fs) 87
encryption 1408 formatting (mkqnx6fs) 1129
phrelaycfg 1411 PowerPC startup options 1784
phs-to-bjc 1413 PPID 934
phs-to-bmp 1416 PPP
phs-to-escp2 1419 daemon (pppd) 1467
phs-to-ijs 1423 ppp_en 1474
phs-to-pcl 1426 PPPOE
phs-to-ps 1432 parameters, displaying and setting 1470
phshutdown 1434 shim layer (pppoed) 1475
PHSTART 1982 pppoe-down 1474
PHTK_PATH 1982 pppoe-up 1474
phuser 1437 pppoectl 1470
phview 1440 pps 1476
PHWM 1346, 1982 pr 1477
PHWMEXIT 1524, 1982 preemption, kernel, disabling 1496
June 22, 2010 Index 2103

prefixes, resolving (fullpath) 756 processes See also programs

prepboot.boot 1111 64-bit addressing 1234
preview 1480 adaptive partitions, starting in 1236
print (ksh builtin) 950 address space randomization 1496
print drivers arguments
bitmap (phs-to-bmp) 1416 maximum length (_SC_ARG_MAX) 795
Canon (phs-to-bjc) 1413 asynchronous I/O, priority of
Epson ESC/P2 (phs-to-escp2) 1419 (_SC_AIO_PRIO_DELTA_MAX) 795
Hewlett-Packard PCL (phs-to-pcl) communication between
1426 pipe 1465
IJS (phs-to-ijs) 1423 pps 1476
PostScript (phs-to-ps) 1432 CPU usage, displaying
printable strings, finding in files (strings) hogs 839
1791 pidin 1450
printcap 999, 1482 top 1882
printer detaching from child (on) 1234
configuration file 604 dumping postmortem state of (dumper)
PRINTER 1002, 1983 569
printers, USB support for (devu-prn) 480 dynamically linked libraries, debugging
printf 1486 1976
printing execution time (time) 1878
anti-aliasing 1413, 1416, 1419, 1423, 1426 files, maximum per (_SC_OPEN_MAX)
capability database (printcap) 1482 796
control (lprc) 1003 information, displaying
daemon (lpd) 998 pidin 1442
jobs killing or modifying by name (slay) 1684
removing (lprrm) 1008 limits, getting and setting (ulimit ksh
removing (prjobs) 1492 builtin) 959
submitting (lpr) 1001 manager (procnto*) 1493
preview 1480 maximum per real user ID
querying (lprq) 1006 (_SC_CHILD_MAX) 795
spooler (spooler) 1768 parent, determining (pidin) 1446
spooler manager (prjobs) 1491 priority, adjusting while running
priorities renice 1584
adjusting for running processes slay 1685
renice 1584 profiling
slay 1685 compiling for 1541
privileged 1496 gprof) 809
running programs at set-group ID (_SC_SAVED_IDS) 796
nice 1179 set-user ID (_SC_SAVED_IDS) 796
on 1235 signals
prioritized I/O, support for (_PC_ASYNC_IO) maximum outstanding
797 (_SC_SIGQUEUE_MAX) 796
prjobs 1491 state, sharing among (ds) 562
proc filesystem 1498 supplementary group IDs, maximum
process-level debugging (pdebug) 1269 (_SC_NGROUPS_MAX) 796
2104 Index June 22, 2010

terminating or signaling control blocks, displaying 1167

information about (procnto -v) 1497 statistics, displaying 1168, 1169
kill 918 PS1, PS2, PS3, PS4 934
kill (ksh builtin) 950 PS2 HID (devh-ps2ser.so) 343
slay 1684 pseudo block I/O driver (devb-loopback)
timers, displaying 1442 203
PROCESSOR 1110, 1125, 1983 pseudo-devices
processors pf 1280
number to activate 1782 pseudo-random data 1578
type, displaying 1447 pseudo-tty communications manager
usage, displaying (devc-pty) 239
hogs 839 pterm 1505
pidin 1450 escape sequences 1511
top 1882 pterm.rc 1513, 1514
procnto* 1493, See also microkernel ptermcs 1516
profiles PTERMPAL 1514, 1515, 1983
default 1248 PTERMRC 1513, 1515, 1983
ksh 921 pty communications manager (devc-pty) 239
profiling public keys, gathering (ssh-keyscan) 1776
compiling for 1541 pulse queue, displaying the length of 1445
gprof 809 pv 1518
system 1889 pwd
programs See also processes ksh builtin
951
comparing to official QNX versions 1533 utility 1520
constructing argument lists and invoking PWD 934
(xargs) 1961 pwm 1521
detaching from parent (on) 1234 PWM_PRINTSCRN_APP 1524, 1719, 1983
HELD state, starting in (on) 1234 PWM menu
locating (which) 1948 editing 1398
priority, running at pwmopts 1526
nice 1179 python 1530
on 1235 PYTHONCASEOK 1531
python 1530 PYTHONDEBUG 1531
running as someone else (op) 1238 PYTHONHOME 1531
shared objects, required (ldd) 972 PYTHONINSPECT 1532
prompts, command-line (PS1, PS2, PS3, PS4) PYTHONOPTIMIZE 1532
934 PYTHONPATH 1532
PROT_EXEC 1496 PYTHONSTARTUP 1532
protocol names database 1500 PYTHONUNBUFFERED 1532
protocol server PYTHONVERBOSE 1532
MOUNT v1 and v3 1175
NFS v2 and v3 1175
protocols 871, 1168, 1500, 1731
protocols Q
connection-oriented 1171
connectionless 1171 qbinaudit 1533
QCC, qcc 1535
June 22, 2010 Index 2105

QCC_CONF_PATH 1542, 1984 RAGE chipsets, graphics driver for

qconfig 1543, 1564 (devg-rage.so) 310
qconn 1546 Ralink
qcp 1548 RT2500, RT2501, and RT2600 wireless
qde 1551 adapters (devnp-ral.so) 458
qed 1553 RT2500USB USB 2.0 wireless adapters
Qnet 1019 (devnp-ural.so) 458
system information, displaying 1449 RT2501USB and RT2601USB wireless
qnetstats 1025 adapters (devnp-rum.so) 464
QNX 4 RAM disk flash filesystem (devf-ram) 261
disk partitions, managing (fdisk) 652 RAM disks
encryption 1248 driver (devb-ram) 212
filesystem (fs-qnx4.so) 727 RAM filesystem (/dev/shmem), using gzip in
checking consistency of (chkfsys) 82 816
long filenames, enabling 544, 728 random 1578
QNX 6 filesystem See Power-Safe filesystem RANDOM 935
QNX_CONFIGURATION 1545, 1565 ranlib 1580
qnx_crypt() 994 raw input mode
QNX_HOST 1543, 1564, 1984 buffer (_PC_MAX_INPUT) 797
QNX_TARGET 557, 1543, 1564, 1984 raw.boot 1111
QNX binaries, comparing to 1533 rc.sysinit 1880
QNX protocol 1506 rcp 1581
QNX System Builder projects, building (mksbp) read (ksh builtin) 951
1134 readonly (ksh builtin) 951
QNXCRYPT 1248 Realtek
qnxvar tokens 563, 564 8139 PCI card driver (devn-rtl.so) 405
qtalk 1555 8150 Ethernet dongle driver
QUERY_STRING 1704, 1984 (devn-rtl8150.so) 408
QUERY_STRING_UNESCAPED 1692 8169 Gigabit Ethernet controllers
queues, message (devnp-rtl8169.so) 461
manager (mq, mqueue) 1143, 1145 realtime clock
maximum number of 1494 setting or getting date from (rtc) 1634
queues, send, receive, reply and pulse 1445 timers 1449
quoting 927 rebooting See phshutdown, shutdown
QUOTING_STYLE 1253, 1254 RECEIVE (thread state) 1451
QWinCfg 1564 receive queue, displaying the length of 1445
recurse.mk 13
redirection 937
REFERER 1704, 1984
R refresh rate 1373
registers, displaying for a process 1449
racoon 1566 regular expressions
racoon.conf 1568 extended (egrep) 810
RADEON chipsets, graphics driver for fixed string (fgrep) 810
(devg-radeon.so) 307 grep 810
RAGE 128 chipsets, graphics driver for relational database operator (join) 916
(devg-ati_rage128.so) 267
2106 Index June 22, 2010

remote rlogin 1592

connectivity rlogind 1594
via modem 1358, 1404 rm 1596
via serial 1405 rmdir 1598
via TCP/IP 1358, 1404 rndc 1600
with phindows 1403 configuration file (rndc.conf) 1602
IDE support (qconn) 1546 key-generation tool (rndc-confgen)
login (rlogin) 1592 1601
login daemon (rlogind) 1594 rndc-confgen 1601
nodes, displaying information about 1449 rndc.conf 1602
Photon sessions 1358 root
shell (rsh) 1623 command-line prompt 934
shell (ssh) 1770 privileged priorities 1496
shell daemon (rshd) 1625 remote authentication 1589
REMOTE_ADDR 1704, 1985 running commands as (op) 1238
REMOTE_HOST 1704, 1985 round-robin scheduling policy 1444
REMOTE_IDENT 1704, 1985 route 1603
REMOTE_PORT 1704, 1985 route6d 1607
REMOTE_USER 1704, 1985 routed 1610
remote access Internet routing information, specifying
Photon options (phrelaycfg) 1411 (gateways) 759
remounting (mount -u) 1140 router
renice 1584 advertisement
reopen configuration (rtadvd.conf 1631
esh, fesh builtin 633 daemon (rtadvd) 1628
REPLY 935 solicitation daemon (rtsold) 1639
REPLY (thread state) 1451 routers 1610
reply queue, displaying the length of 1445 routes
REQUEST_METHOD 1704, 1985 active 1171
RESCONF 1985 next-hop 1604
resolution 1372 tracing (traceroute) 1898
resolv.conf 1586 tracing (traceroute6) 1903
storing in_CS_RESOLVE 487, 795, 1166, routing
1468, 1586 querying (rtquery) 1637
resolver configuration routing tables
_CS_RESOLVE 1661 managing 1610
lsm-qnet.so 1022 manipulating 1603, 1607
resolv.conf 1586 querying 1169
resolver daemon, lightweight (lwresd) 1026 rpc 1615, 1622
resources (bindres) 40 RPC
resources, seeding (seedres) 1657 program number database (rpc) 1615
restarting See phshutdown, shutdown program numbers, mapping into universal
return (ksh builtin) 951 addresses (rpcbind) 1616
Rhine NIC (devn-via-rhine.so) 426 reporting RPC information (rpcinfo)
RIVA graphics chipsets driver (devg-tnt.so) 1622
329 rpcgen protocol compiler 1618
June 22, 2010 Index 2107

secure (SRPC) domain scheduling information, displaying for a thread

(_CS_SRPC_DOMAIN) 795, 1661 1444, 1449
rpcbind 1616 scp 1648
rpcgen 1618 screen See also display
rpcinfo 1622 anti-aliasing 1363
RSA identities, adding (ssh-add) 1771 clearing (clear) 98
rsh 1623 image of, capturing (snapshot) 1717
security issues 1627 screensaver options (savercfg) 1645
rshd 1625 script 1649
rtadvd 1628 SCRIPT_NAME 1704, 1985
rtadvd.conf 1631 searching (phfind) 1360
rtc 1634 SECONDS 935
rtquery 1637 Secure RPC domain (_CS_SRPC_DOMAIN)
rtsold 1639 795, 1661
rules Secure Sockets Layer (SSL) 1239
for media content detection 1037 security 1402
mcd two-phase 1041 adaptive partitioning 21
runmasks DHCP 518
setting 1113, 1236, 1686 don’t use op 1238
runtime linker 1123 IKE (ISAKMP/Oakley) key management
ruptime 1641 protocol 1566
rwho 1642 logging in (login) 993
rwhod daemon 1643 NFS 1177
phrelay 1408
random data for 1578
remote authentication 846
S rshd daemon 1627
slinger 1701
S records tftp 1873
converting binary image to (mkrec) 1132 tftpd daemon 1875
images, creating 1112 Security Association and Security Policy
S3 databases, manipulating 1663
Savage chipsets driver sed 1650
(devg-s3_savage.so) 313 seedres 1657
SATA interface self 1499
AHCI (devb-ahci) 186 SEM (thread state) 1451
Marvell 88SX50XX (devb-mvSata) 208 semaphores, named
Savage chipsets driver (devg-s3_savage.so) manager (procnto*) 1493
313 maximum number of 1494
saver.cfg 1647 _SC_SEM_NSEMS_MAX 796
savercfg 1645 Semtech input manager (devi-semtech) 367
SCC serial communications manager SEND (thread state) 1451
(devc-serzscc) 250 send queue, displaying the length of 1445
scheduler information, displaying 1446 sendnto 1658
schedulers, external 1235 sequence number
scheduling information, displaying 1442 mcd 1043
2108 Index June 22, 2010

serial listing those required by a program (ldd)

configuration file 604 972
serial communications manager shelf 1674
8250 (devc-ser8250) 240 SHELL 598, 634, 984, 994, 1912, 1986
Zilog SCC (devc-serzscc) 250 shells
serial connection 1405 embedded (esh) 628
serial input HID (devh-ps2ser.so) 343 fat embedded (fesh) 659
serial number (_CS_HW_SERIAL) 794, 1661 login, default 1248
SERVER 489, 1985 micro-embedded (uesh) 1908
server public domain Korn (ksh) 920
mcd 1038 remote (rsh) 1623
SERVER_ADMIN 1690, 1704, 1986 remote (ssh) 1770
SERVER_NAME 1704, 1986 sh 1673
SERVER_PORT 1704, 1986 shift (ksh builtin) 954
SERVER_PROTOCOL 1704, 1986 shim driver (devnp-shim.so) 467
SERVER_ROOT 1705, 1986 shmem, using gzip in 816
SERVER_SOFTWARE 1705, 1986 show_vesa 1679
Server Side Includes (SSI) 1691 showlicense 1676
servers showmem 1677
PC Card (devp-pccard) 471 showmount 1678
Photon 1401 shutdown 1681
Photon, displaying regions 1440 SIGABRT 570
services 1660 SIGBUS 570, 1493
services SIGCHLD 1508
across a network 802 SIGEMT 570
database (services) 1660 SIGFPE 570
starting via inetd 868 SIGHUP 1149, 1508
well-known, listing (nslookup) 1190, SIGILL 570, 1508
1192 SIGINT 1149
sessions SIGKILL 1434, 1681
displaying for a process 1446 signals
starting (login) 993 alignment fault 1493
terminating (logout) 997 dump file written for 570
set masks, displaying for a process 1442
esh, fesh builtin 633 maximum outstanding for a process
ksh builtin 952 (_SC_SIGQUEUE_MAX) 796
setconf 1661 pterm and 1508
setkey 1663 sending to processes
setupbsp 1669 information about (procnto -v) 1497
sftp 1671 kill 918
sftp-server 1672 kill (ksh builtin) 950
sh 1673 slay 1684
SH startup options 1780 state, displaying for a process 1449
shadow 995 utility conventions 5
shared objects SIGQUIT 570, 1149
debugging 1976 SIGSEGV 570, 1508
June 22, 2010 Index 2109

SIGSYS 570 daemon 1723

SIGTERM 1149, 1434, 1508, 1681 environment variables 1724
SIGTRAP 570 MIB
SIGTSTP 1880 compiler (smic) 1712
SIGUSR1 1149 data, defining views of (view.conf)
SIGUSR2 1149 1945
SIGWINCH 1508 network entities
SIGXCPU 570 GET requests 1726, 1729
SIGXFSZ 570 information about 1720, 1737, 1739,
Silicon Motion 1752
Lynx chipsets driver (devg-smi7xx.so) SET requests 1734
322 network status, showing (snmpnetstat)
SM501 chipsets driver (devg-smi5xx.so) 1731
319 object identifiers, translating
Simple Network Management Protocol See (snmptranslate) 1745
SNMP party definitions (party.conf) 1244
SIS graphics controller driver permitted operations, specifying 10
(devg-sis630.so) 316 symbolic names, translating
SiS900 Ethernet controller (devn-sis9.so) (snmptranslate) 1745
411 TRAP messages
size 1683 receiving (snmptrapd) 1750
slay 1684 sending (snmptrap) 1747
sleep 1689 variable names, specification for 1063
slinger 562, 1690 snmpbulkwalk 1720
slogger 1706 SNMPCONFIGFILE 1724, 1986
sloginfo 1710 snmpd daemon 1723
SM501 chipsets driver (devg-smi5xx.so) snmpd.conf 1725
319 snmpget 1726
SMB client filesystem (fs-cifs) 703 snmpgetnext 1729
SMC snmpnetstat 1731
91c92/91c100 compatible Ethernet adapter snmpset 1734
(devn-smc9000.so) 414 snmpstatus 1737
SMC 9432 (EPIC) Ethernet adapter snmptest 1739
(devn-epic.so) 385 snmptranslate 1745
SMC EZ Connect USB Ethernet adaptor snmptrap 1747
(devn-pegasus.so) 402 snmptrapd daemon 1750
SMC2208 USB/Ethernet adapter driver snmpwalk 1752
(devn-rtl8150.so) 408 SO_REUSEPORT 911
smic 1712 SOCKET 1263, 1986
SMICINCL 1716, 1986 socket image, building (mkimage) 1126
SMP microkernel and process manager sockets
(procnto-smp) 1493 active, displaying 1169
snapshot 1717 debugging
SNMP rlogin 1592
configuration (snmpd.conf) 1725 rsh 1623
context definitions (context.conf) 101
2110 Index June 22, 2010

manager, getting and setting state of st_ino

(sysctl) 1804 mcd 1043
maximum number of 1494 stack
protocol control blocks, displaying 1167 size
state, displaying 1167 displaying for a process 1442
sockets, listing open 1758 minimum for a thread
SOCKS (_SC_THREAD_STACK_MIN) 796
configuration file (socks.conf) 1755 using random addresses for 1496
SOCKS_NS 1986 STACK (thread state) 1451
SOCKS_SERVER 1756, 1757, 1986 standard input
socks.conf 1755 duplicating (tee) 1854
sockstat 1758 reading from (read ksh builtin) 951
soft links See symbolic links startup-* options 1780
solicitation daemon, router (rtsold) 1639 startup-apic 1785
sort 1760 startup-bios, startup-bios-32 1788
sort order states
customizing for different languages 1068 CONDVAR 1451
sorting, topological of directed graphs 1906 JOIN 1451
Sound Blaster 16, audio driver for MUTEX 1451
(deva-ctrl-sb.so) 166 RECEIVE 1451
source code REPLY 1451
C, formatting (indent) 866 SEM 1451
ifdef’ed lines, removing (unifdef) SEND 1451
1921 STACK 1451
space, reporting free disk (df) 484 WAITPAGE 1451
spaces, converting to tabs (unexpand) 1919 WAITTHREAD 1451
spatch 1763 statistics
SPAWN_PADDR64_SAFE 1234 filesystems 738
split 1766 network 1167
spool directory 999 protocols 1168, 1169
spool manager (prjobs) 1491 system
spooler 1768 hogs 839
sporadic scheduling policy 1444 pidin 1442
srec.boot 1112 top 1882
SRPC domain (_CS_SRPC_DOMAIN) 795, stream editor (sed) 1650
1661 STRICTPASSWORD 1248
ssh 1770, See also OpenSSH strings 1791
ssh-add 1771 strings
ssh-agent 1772 evaluating as an expression
ssh-config 1773 eval (ksh builtin) 947
ssh-keygen 1774 expr 644
ssh-keyscan 1776 extracting directory names (dirname) 548
ssh-keysign 1777 extracting filenames (basename) 29
sshd 1778 manipulating
sshd_config 1779 gawk 764
SSI (Server Side Includes) 1691 python 1530
June 22, 2010 Index 2111

sed 1650 listing (nm) 1185

tr 1886 removing from object files (strip) 1792
matching symmetric multiprocessing microkernel and
elvis 589 process manager (procnto-smp)
grep, egrep, fgrep 810 1493
printable, finding in files (strings) 1791 sync 1803
repeated, reporting or filtering out (uniq) synchronous I/O, support for (_PC_ASYNC_IO)
1922 797
sorting (sort) 1760 syntax, conventions for 3
words, lines, and bytes, counting (wc) sysctl 1804
1947 sysinfo 1810
writing to standard output SYSLOG 992, 1816, 1987
echo 575 syslog.conf 1812
echo (ksh builtin) 947 syslogd 1815
print (ksh builtin) 950 SYSNAME 1987
printf 1486 syspage
strip 1792 displaying entries 1449
stty 1793 system
su 1801 amount of time running (uptime) 1929
SUFFIX 1986 booting (diskboot) 550
super-server configuration file (inetd.conf) configuration values
870 getting (getconf) 794
supplicant, WPA 1956 setting (setconf) 1661
support, technical xxiv information, displaying
gathering system information (sysinfo) phin 1374
1810 sysinfo 1810
SVGA (Super VGA) driver (devg-svga.so) instruction set architecture
327 (_CS_ARCHITECTURE) 794, 1661
symbolic links logger
creating configuration (syslog.conf) 1812
cp 110 daemon (syslogd) 1815
fs-dos.so 709 examining (sloginfo) 1710
ln 987 making entries (logger) 991
ln-w 990 manager (slogger) 1706
mkefs 1083 name, returning (uname) 1917
mkifs 1101, 1110 profiling 1889
deleting resources, seeding (seedres) 1657
rm 1596 shutting down
unlink 1924 phshutdown 1434
ignored by gzip 817 shutdown 1681
resolving statistics, displaying
find 673, 675, 678, 680 hogs 839
fullpath 756 pidin 1442
ls 1011 top 1882
testing (test ksh builtin) 955 status daemon (rwhod) 1643
symbols
2112 Index June 22, 2010

time, synchronizing with IP servers (ntpd) tcpdump 1823

1197 technical support xxiv
System Builder projects, building (mksbp) gathering system information (sysinfo)
1134 1810
system moduli file (/etc/moduli) 1135 tee 1854
telnet 1856
telnetd 1866
TERM 601, 634, 984, 994, 1137, 1508, 1515,
T 1593, 1765, 1912, 1987
terminals
tabs, converting to spaces (expand) 640 canonical input buffer
tags from C source 121 (_PC_MAX_CANON) 797
tail 1817 capability files
tape archives, creating and reading (tar) 1819 compiling (tic) 1876
tar 1819 displaying (infocmp) 878
target selection 1991 character sets (ptermcs) 1516
ld 1992 configuration (tinit) 1880
listing valid 1991 emulator 1507
mkifs 1110, 1125 initializing (tinit) 1880
nm 1992 mode, setting (getty) 799
objcopy 1991 name, returning (tty) 1907
objdump 1991 options 1510
QCC, qcc 1538 pty 1507
size 1992 raw input buffer (_PC_MAX_INPUT) 797
strings 1992 sessions, transcripts of (script) 1649
strip 1792, 1991 width (COLUMNS) 932
Taskbar 1406 window (pterm) 1505
TCP/IP 1358, 1404 TERMINFO 1877, 1987
automatic connection-configuration script Terratec ESS1938, audio driver for
27 (deva-ctrl-ess1938.so) 156
CIFS client filesystem (fs-cifs) 703 test (ksh builtin) 954
configuration manager (netmanager) text fonts (pterm) 1510
1165 textto 1870
DHCP tftp 1871
configuration (dhcpd.conf) 500 tftpd daemon 1874
leases (dhcpd.leases) 521 third-party licenses xxiii
relay agents (dhcprelay) 524 threads
server (dhcpd) 492, 1229 adaptive partition, displaying 1442
dynamic host configuration guard area, size of 796
dhcp.client 486 ID, displaying 1442
dhcpd 492 idle, disabling CPU halting in 1494
omshell 1229 name, displaying 1442, 1449
ensuring an interface is available (if_up) priority
851 changing 1584, 1685
NFS 2 client filesystem (fs-nfs2) 720 displaying 1442
NFS 3 client filesystem (fs-nfs3) 722
Photon configuration (phlip) 1379
June 22, 2010 Index 2113

scheduling information, displaying 1442, TMPDIR 634, 935, 984, 1912, 1987
1444, 1446, 1449 TOC files (helpviewer) 832
stack size, minimum Tolapai 80579 Gigabit Ethernet controllers
(_SC_THREAD_STACK_MIN) 796 (devnp-i80579.so) 445
state, displaying 1442 top 1882
times, displaying 1450 topic files (helpviewer) 832, 835
tic 1876 topological sorting of directed graphs 1906
tick size, changing 22 touch 1883
tickets 1280 touch devices
TIGON3 (BCM570X) Ethernet controller managing
(devn-tigon3.so) 420 devh-egalax.so 339
time 1878 devh-microtouch.so 341
time of day devh-touchintl.so 347
displaying and setting (date) 137 Touch International touch devices
setting (ntpdate) 1202 (devh-touchintl.so) 347
setting or getting from realtime clock (rtc) touchscreens
1634 calibrating (calib) 59
synchronizing with IP servers (ntpd) 1197 calibrating (gf-calib) 800
time since booting (uptime) 1929 input manager
time zone Dyna (devi-dyna) 351
_CS_TIMEZONE 795, 1661 Elographics (devi-elo) 353
name, maximum length of 796 Microtouch (devi-microtouch) 364
setting Semtech (devi-semtech) 367
phlocale 1391 Zytronic (devi-zytronic) 369
setconf 1661 tr 1886
time, execution, displaying for a process or thread TraceEvent() 1889
pidin 1450 tracelogger 1889
time 1878 traceprinter 1893
times (ksh builtin) 957 traceroute 1898
timers traceroute6 1903
displaying for a process 1442 traces, instrumented kernel
flags 1449 displaying (traceprinter) 1893
maximum number of overruns storing (tracelogger) 1889
(_SC_DELAYTIMER_MAX) 795 transcript of a terminal session (script) 1649
times (ksh builtin) 957 Transmit Segmentation Offload (TSO) 448
timestamps Transparent Distributed Processing (TDP) 1019
changing (touch) 1883 Transport Layer Security (TLS) 1239
comparing trap (ksh builtin) 957
find -fmnewer 673 Trident 4DWave, audio driver for
ksh test -nt and -ot 955 (deva-ctrl-4dwave.so) 150
TIMEZONE 1393 troubleshooting See also debugging
tinit 1880 network 1167
tiny ping 1457
webserver (slinger) 1690 ping6 1462
titles, alignment in window frames 1521, 1527 traceroute 1898
TMOUT 935 traceroute6 1903
2114 Index June 22, 2010

system problems uniq 1922

input.hostname file 883 Universal Disk Format filesystem support
sysinfo 1810 (fs-udf.so) 733
video driver (dispconf) 553 Universal Host Controller Interface See UHCI
true Universal Resource Locator (URL) 835
ksh builtin 958 Universal Serial Bus See USB
utility 1905 unlink 1924
TSIG (Transaction Signatures), key-generation UNMAP_INIT_OPTIONAL 1495
tool (dnssec-keygen) 560 UNMAP_INIT_REQUIRED 1495
TSO (Transmit Segmentation Offload) 448 unset
tsort 1906 esh, fesh builtin 633
tty 1907 ksh builtin 961
tty attributes, setting (stty) 1793 unzip 1925, 1967
ttys configuration file 1880 UNZIPOPT 1927
Tulip (DEC 21x4x) compatible Ethernet adapter uppercase, converting files to and from 145
(devn-tulip.so) 423 uptime 1929
TVIA urandom 1578
CyberPro chipsets driver (devg-tvia.so) US-101 keyboard layout 233
332 usage message
two-phase processing changing (usemsg) 1935
mcd 1041 displaying (use) 1932
typescript of a terminal session (script) 1649 usb 1930
typeset (ksh builtin) 958 USB
typographical conventions xxiii adapters
TZ 140, 634, 1014, 1705, 1884, 1912, 1987 ASIX AX88172 chip (devnp-axe.so)
431
Pegasus (devn-pegasus.so) 402
SMC2208 (devn-rtl8150.so) 408
U devices, displaying 1930
enumerator 615
uc_keyboard_t 1393 HID (devh-usb.so) 349
uc_language_t 1393 I/O support (io-usb) 914
uc_local_t 1393 managers
uc_tz_t 1393 EHCI controllers (devu-ehci) 474
UDF filesystem support (fs-udf.so) 733 keyboards (devu-kbd) 476
uesh 1908 mice (devu-mouse) 477
UHCI, USB support for (devu-uhci.so) 482 OHCI controllers (devu-ohci.so) 478
UIDRANGE 1248 printers (devu-prn) 480
ulimit (ksh builtin) 959, 1494 UHCI controllers (devu-uhci.so) 482
umask mass storage
ksh builtin 960 interface, driver (devb-umass) 215
utility 1913 Photon high-runner input manager
umount 1916 (devi-hid) 356
unalias (ksh builtin) 961 to serial adaptors 247
uname 1917 USB_MEDIA_ENUM 1045
unexpand 1919 USB mediastores
unifdef 1921
June 22, 2010 Index 2115

detecting 1053 VESA BIOS information, displaying 1679

usb-class VGA console and keyboard I/O manager
configuration file 605 devc-con, devc-con-hid 217
use 1932 vi 1943
usemsg 1935 VIA Rhine NIC (devn-via-rhine.so) 426
useqnet 1025 VIA686, audio driver for
USER 1987 (deva-ctrl-via686.so) 168
user_spec_id video
enum-usb Set option attribute 621 cards, displaying information about 1679
user IDs drivers, starting (dispconf) 553
creating (passwd) 1246 hardware, detecting (dispconf) 553
displaying for a process 1450 view.conf 1945
icons for, choosing 1437 VISUAL 935
mapping 1020 visual interface editor clone
range 1248 elvis 579
returning (id) 849 vi 1943
setting temporarily (su) 1801 view 1944
USERNAME 994 VMWare graphics driver (devg-vmware.so)
users 337
IDs Vortex, audio driver for
set-user (_SC_SAVED_IDS) 796 (deva-ctrl-vortex.so) 170
logged-in, listing (who) 1950
processes, maximum per real user ID
(_SC_CHILD_MAX) 795
UTF8 W
pfm displaying 1343
utilities, locating wait (ksh builtin) 961
_CS_PATH 795, 994, 1661 waitfor 1946
PATH 934 WAITPAGE (thread state) 1451
which 1948 WAITTHREAD (thread state) 1451
utmp 994, 1950 wc 1947
uud 1939 webserver, tiny (slinger) 1690
uudecode 1940 well-known services, listing (nslookup) 1190,
uue 1941 1192
uuencode 1942 whence (ksh builtin) 961
which 1948
who 1950
window manager (pwm) 1521
V options (pwmopts) 1526
windows
variable page sizes (memory) 1496 click to front 1521, 1528
variant, adding new directory (addvariant) configuring 1510
13 dragging 1521, 1528
VCD files 736 frames, colors of 1527
version control (cvs) 126 Photon window system (ph) 1344
VESA 2.0 graphics driver titles, alignment of 1521, 1527
(devg-vesabios.so) 335 width (COLUMNS) 932
2116 Index

Utilities Reference

Uploaded by

Utilities Reference

Uploaded by

® ®

QNX Neutrino Realtime Operating System

For QNX ® Neutrino® 6.5.0

© 2010, QNX Software Systems GmbH & Co. KG.

About This Reference xxi

June 22, 2010 Contents iii

iv Contents June 22, 2010

June 22, 2010 Contents v

vi Contents June 22, 2010

June 22, 2010 Contents vii

viii Contents June 22, 2010

June 22, 2010 Contents ix

x Contents June 22, 2010

June 22, 2010 Contents xi

xii Contents June 22, 2010

June 22, 2010 Contents xiii

xiv Contents June 22, 2010

June 22, 2010 Contents xv

xvi Contents June 22, 2010

June 22, 2010 Contents xvii

A Commonly Used Environment Variables 1973

B Selecting the Target System 1989

C What’s New in this Reference? 1995

xviii Contents June 22, 2010

Deprecated content 2012

June 22, 2010 Contents xix

June 22, 2010 About This Reference xxi

For information about: See:

For information about licensing, see:

• the QNX Development Suite License Guide at

• the Third Party License Terms List at

• the matrix of all the versions of all our legal documents at

June 22, 2010 About This Reference xxiii

You’ll find the Other... menu item under Perspective→Show View.

We use notes, cautions, and warnings to highlight important messages:

Notes point out something important or useful.

WARNING: Warnings tell you about commands or procedures that could be

Note to Windows users

xxiv About This Reference June 22, 2010

June 22, 2010 Utility Conventions 1

Interpreting utility syntax

June 22, 2010 Utility Conventions 3

• Integer numerical operands and option arguments must be in the range 0 to

4 Utility Conventions June 22, 2010

• Most utilities that accept filenames as operands (and sometimes as option

Exit status conventions

June 22, 2010 Utility Conventions 5

6 Utility Conventions June 22, 2010

June 22, 2010 Utilities 7

June 22, 2010 Utilities 9

1 /nodecfg/node_name/etc/acl.conf, where node_name is the value of the

The file is in the format:

targetParty Party that a request is sent to (agent).

The privileges that you can specify are:

10 Utilities June 22, 2010

June 22, 2010 Utilities 11

Target platform: addr2line_variant:

12 Utilities June 22, 2010

-P Create initial directories for a PhAB application.

variant_name The name of the variant to add (e.g. o, a.be)

June 22, 2010 Utilities 13

Dealing with GNU projects

Creating the initial files

Creating the subdirectories and files

• LIST=OS (if three levels are specified)

• LIST=CPU (if two levels are specified)

• LIST=VARIANT (if one level is specified)

The utility then decides whether to create a subdirectory by looking at the:

If needed, addvariant then creates an appropriately named subdirectory containing

addvariant -i OS/CPU/VARIANT nto x86 o

14 Utilities June 22, 2010

LIST=OS CPU VARIANT

and then creates a single subdirectory called nto-x86-o.

addvariant -i OS/CPU nto x86 o

Create the opposite two-level scheme, nto/x86-o:

addvariant -i OS nto x86/o