Appendix A
Find a command
You remember the job, or you remember the name. Start with either. The spellings below describe the prepared NitrOS-9 Level Two image in VCC Plus. A different boot disk can supply a different shell, command set or edition of a tool.
Start with the job
| I want to… | Start here |
|---|---|
| Find a file or figure out which directory the shell is using | Working and execution directories, then dir, pwd, pxd, chd, chx |
| Save several commands and run them together | Shell procedures, then build, list, shell |
| Send the same text to the screen and a file | Paths and pipes, then tee |
| Compare two versions before replacing a file | Recover a copy, then copy, cmp, rename |
| See who's using the CPU or holding memory | Processes, modules and address maps |
| Identify a disk or change a terminal option | Devices, terminals, then devs, dmode, tmode |
| Run my own program inside OS-9 | BASIC09, assembly and the language guide |
How to read a command form
Words in italics stand for your own names. Square brackets enclose optional operands. A device is a guest name such as /h1. A path can also name a file or directory on that device. A module is identified by its internal name. For example, ident /h1/beacon reads a file, while link beacon asks for a module by name. The module chapter explains when that name becomes available.
Shell+ interprets operators before it starts the command. A single > creates a new output file, ! connects two programs, and & starts a background job. A procedure is text read by a shell. A command can also be built into the shell or supplied by an executable module, including one loaded at boot. Looking only in /DD/CMDS will miss some names the shell accepts.
The compact forms below cover the guest help catalog. A lookup entry identifies an operation. The linked lessons give inputs and visible results for the operations used in the book. For edition-specific switches, use the guest’s HELP entry for the named command. Names such as GFX and INKEY belong inside a BASIC09 procedure.
Alphabetical finder A–D
| Name and form | What it does |
|---|---|
| ASM source [o=module] | Translate assembler source. Read the reported error count before attempting to execute the output. |
| ATTR path [permissions] | Inspect or change permission bits. Adding e gives the owner permission to execute a file. |
| BACKUP [source-device destination-device] | Duplicate a volume at the device level. The destination contents are replaced. See the working-image recovery exercise for a Mac-side alternative. |
| BASIC09 | Open the programming workspace at its B: prompt. |
| BINEX input output | Convert binary data to Motorola S-record text for transfer. EXBIN performs the reverse conversion. |
| BUILD path | Make a short text file from lines you enter. A blank Return ends entry. |
| CHD directory · CHX directory | Change the current data directory or the command execution directory respectively. |
| CMP first second | Compare files byte by byte and report differences. |
| COBBLER device · CONFIG | Construct boot media. Work on a spare image with an independently bootable original. |
| COPY source destination | Duplicate a file under a fresh name. |
| CPUTYPE · DATE | Report the guest processor or the guest date. |
| DCHECK device | Check the relationships among a disk’s allocation map, directories and files. |
| DEBUG · DED device | Inspect machine execution or edit raw disk sectors. A raw write can change several directory entries at once. |
| DEINIZ device | Release a device attachment. INIZ acquires one. |
| DEL path · DELDIR directory | Remove a file, or remove a directory tree and its contents. |
| DEVS | Show the active devices and their drivers and file managers. |
| DIR [-e] [path] | List a directory. The extended listing shows ownership, attributes and sizes. |
| DIRSORT [directory] | Reorder entries in the directory itself. Use a copy if the original order matters. |
| DISASM [path] · DISPLAY codes | Decode instructions, or emit character values such as terminal controls. |
| DMEM [block] offset [length] | Inspect bytes from a guest memory block. |
| DMODE device [settings] | Read or change an RBF disk descriptor’s settings. |
| DSAVE [destination] | Generate a procedure that copies a directory hierarchy. Inspect the generated commands before running them. |
| DUMP file | Show the offset, hexadecimal bytes and printable characters side by side. |
Alphabetical finder E–M
| Name and form | What it does |
|---|---|
| ECHO words | Write a line on standard output. The shell can redirect it. |
| EDIT [file] · MINTED [file] | Edit text using the editor supplied by the guest. BUILD suffices for all required source entry here. |
| ERROR number | Look up a guest error number. Read it alongside the command that produced it. |
| EX module | Replace the current shell process with the named program. |
| EXBIN input output | Decode an S-record file into binary. |
| FORMAT device | Initialize a filesystem. An existing directory and its data can be lost. |
| FREE device | Report the volume’s geometry and available storage. |
| GFX · GFX2 · GRFDRV | The first two are BASIC09 graphics interfaces. GRFDRV supplies lower-level window drawing services. |
| GREP pattern | Select matching input lines. The pipe exercise supplies its input. |
| HELP [topic] | Consult the help text installed on the guest disk. |
| IDENT module-file | Read module identity, revision, length and CRC information from a file. |
| INIZ device | Attach a device so that the system can keep it initialized. |
| INKEY | Read a keystroke through a BASIC09 subroutine. |
| IRQS | Inspect the guest interrupt service table. |
| KILL process-ID | Send an abort signal to the selected process. Use the ID from the current PROCS display. |
| LINK module · UNLINK module | Acquire or release a reference to a module already known to the kernel. |
| LIST path | Send a text file’s contents to standard output. |
| LOAD path | Bring one or more modules from a file into memory. |
| LOGIN | Start a login dialogue using the guest account configuration. |
| MAKDIR path | Create a directory entry and its directory file. |
| MDIR | Enumerate the modules the kernel currently knows. |
| MEGAREAD | Measure sustained reads from a supplied source. |
| MERGE file … | Send the files’ contents in sequence to standard output. |
| MFREE · MMAP | Report available physical memory or map the system’s memory blocks. |
| MODPATCH patch-file | Apply a prepared set of module changes. |
| MONTYPE · MPI | Inspect or select monitor type, or inquire about a Multi-Pak. These guest utilities have their own hardware assumptions. |
Alphabetical finder O–X
| Name and form | What it does |
|---|---|
| OS9GEN device | Construct a disk bootstrap. Match the boot track and modules to the target hardware. |
| PADROM size file · PARK device | Prepare a padded ROM file, or park heads on a compatible physical drive. VCC Plus VHDs have no mechanical heads. |
| PMAP · PROC · PROCS | Inspect a process’s memory map or the system’s process list. |
| PROMPT message | In the supplied help, the PROMPT utility displays a message and waits for a key. |
| PWD · PXD | Print the full path of the shell’s data or execution directory. |
| REBOOT | Restart the guest. Allow writable media to finish saving first. |
| RENAME old-path new-name | Change the final name of a directory entry. |
| RUNB procedure-name | Run a packed BASIC09 procedure. See the Night procedure. |
| SAVE file module … | Write named resident modules to a file. |
| SETIME [date/time] · SETPR ID priority | Set guest time or change the scheduling priority of a process. |
| SHELL [procedure] | Start an interactive child shell or have it interpret a procedure file. |
| SLEEP ticks | Suspend the caller for a specified interval. Used as an identifiable background child in this book. |
| SMAP | Display a system memory map. |
| TEE path | Copy standard input to standard output and another destination. |
| TELNET host port | Connect a guest terminal session. See the Mac permission dialogue. |
| TMODE [options] | Inspect or change an open terminal path’s options. |
| TOUCH file | Update the date associated with a file. |
| TSMON [terminal] · TUNEPORT device | Manage waiting terminal sessions or adjust a supported serial port. |
| VERIFY [options] | Check module integrity. Inspect update options before applying them to a file. |
| WCREATE [options] · XMODE device [settings] | Set up guest windows or inspect/change the defaults in an SCF device descriptor. |
Explore the rest of /DD/CMDS
The supplied image contains 398 named directory entries here. A filename alone cannot tell you whether the entry is a shell command, an application, a data file or a bundle of modules. For instance, DIR, DIR.NEW and DIR.ORIG are three different entries. The system help catalog includes names that live elsewhere or are built into a shell. Use the finder above for that catalog. Use the directory below when an unfamiliar name turns up on this particular disk.
The following groups locate additional entries by task. Presence in this inventory means the name was read from the prepared filesystem. An executable module still needs compatible hardware, any companion files and the correct invocation. For an unfamiliar file, use the extended listing to check its type and permissions, and IDENT to inspect a module header. Consult the guest’s /SYS/MAN and /SYS/helpmsg for available instructions.
| Look under | Additional names on this image |
|---|---|
| File handling, conversion and disk tools | ar, bfre, bfree, bigfile, cat, copy2, cp, d, ddmaker, dir.new, dir.orig, dloadx, dloady, dname, exttran, filepick, filer, files, fixtext, fmap, gcpy, ln, lof, ls, mscopy, mv, pcdos, pcsave, readdisto, rescue, rsdos, rssave, sdc, sortdir, tar, transfer, trscopy, unzip, vdisk_mods |
| Text, tabulation, editing and formatting | adj, cut, cuts, dict, diff, fgrep, gsort, lninput, lower, macro, maketxt, more, mroff, nroff, qsort, scred, sled, sort, spell, split, strings, tail, text, tsed, tsedit, txt80x25, ul, uniq, unwords, upper, wc, words |
| Assembling, compiling, linking and debugging | basecon, c, c.opt, c.pass1, c.pass2, c.prep, cc, cmdgen, crcoff, crcon, ipatch, make, makpatch, modbuster, rlink, rma, sleuth, syscall |
| Pascal and other language systems | kcbasic, pacos9, Pascal, Pascal_Compiler, PascalE, PascalErrs, PascalN, PascalS, PascalT.MODL, PascalT.PRUN, PCODEF |
| System, boot, accounts and configuration | adduser, alias, at, bios, bios3, chown, config.desk, config.desk.save, control, cron, date.orig, datetime, drivewire_mods, dtime, expire, fix, fstat, getclock, ide_ff50_mods, ide_ff60_mods, initsub, l2initsub, logname, mkdir, mkopt, multistart, os, os9gen.orig, ostart, printer_mods, profile, reset, setime.orig, setype, shell_21, sysdev, turnkey, user, utilpak1 |
| Windows, graphics, fonts and printing | artist, bpix, cls, cm32vef, cocopr, color, desk, desk.old, desk.patch.scr, fixpix, g320c16, g640c2, g640c4, gclock, gif2vef, gport, gprint, gshell, guib, lpic, lpr, make80, makegshell, makegw, paint, pix, play, rleconv, rleview, scrn, vef2gif, vefio, view, viewgif, window, window.glr4, window.t32, window.t80b, window.t80s, wpix |
| Communications, mail and file transfer | accdata, area, areacode, autodial, crypt, httpd, inetd, kermit, mail, osterm, pop, postnews, readnews, remctrl, rmail, rnews, supercomm, telecom, uploadx, uucico, uucp, uudecode, uuencode, uuxqt, xmodemup, xymodem |
| DeskMate, calendar and office software | calendar, dm3, dmalt, dmalt.hlp, dmapps, dmbackup, dmcaln, dmcaln.hlp, dmcards, dmcards.hlp, dmdskini, dmhelp, dmledger, dmledger.hlp, dmload, dmmenu, dmmenu.hlp, dmpaint, dmterm, dmterm.hlp, dmtext, dmtext.hlp, dynacalc, gcal, gcalc, jdate, ledger, month, zone |
| Games, music and demonstrations | ball, banner, Bounce, cave, caveman, cookie, cursive, demo, des1, des2, des3, des4, des5, des6, dungeon, flight, Fran, ICONS, klondike, koronas, lander, maze, meep, MIDI.dddr, play.orig, playmus, quest, questdvr, questm, rogue, SerMIDI, sound, spals, speech, tank |
| Other historical applications, scripts and companion files | autoex.count, automode, dmpaint.hlp, dmtim, dw, ed, ezgen, gost, hdlns, hisub, lha, mgt, movsub, pag, pak, pmpts, PROCTAB, qtip, rep, rsb, savsub, sdcdriver, show, solution, Support, Support1, Support2, swread, tree, tspars, UBox3, Um3B, Um3D, Um3E, Um3K, Um3L, Um3M, Um3P, Um3S, Um3T, Um3U, Um3W, UMusE3, vu, xcom9, xlh |
For a new system disk, inspect its own command directory and module list. Historical program collections often package multiple editions together. The tested command in a lesson is always identified by the guest and its visible result.