Mercurial > hg > Members > kono > nitros9-code
changeset 18:03b151a3243c Microware_Docs-branch
I'm removing some refentries from the branch containing the original
Microware docs.
| author | roug |
|---|---|
| date | Fri, 17 Jan 2003 17:32:16 +0000 |
| parents | b304b9aab9f0 |
| children | d72a2e08b094 |
| files | docs/nitros9guide/chap7.chapter docs/nitros9guide/makefile docs/nitros9guide/os9guide.docbook |
| diffstat | 3 files changed, 332 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/chap7.chapter Fri Jan 17 17:32:16 2003 +0000 @@ -0,0 +1,135 @@ +<chapter> +<title>System Command Descriptions</title> +<para> +This section contains descriptions for each of the command +programs that are supplied with OS-9. These programs are usually +called using the shell, but can be called from most other OS-9 +family programs such as BASIC09, Interactive Debugger, Macro Text +Editor, etc. Unless otherwise noted, these programs are designed to +run as individual processes. +</para> +<para> +<emphasis>WARNING</emphasis> +- ALTHOUGH MANY OS-9 COMMANDS MAY WORK ON LEVEL ONE OR LEVEL +TWO SYSTEMS, THERE ARE DIFFERENCES. TAKE CARE NOT TO MIX COMMAND +FILES FROM LEVEL ONE SYSTEMS ON LEVEL TWO, OR THE REVERSE. +</para> +<section> +<title>Formal Syntax Notation</title> +<para> +Each command description includes a syntax definition which +describes how the command sentence can be constructed. These are +symbolic descriptions that use the following notation: +</para> + +<informaltable frame="none"> +<tgroup cols="2"> +<colspec colwidth="1in"/> +<colspec colwidth="4in"/> +<tbody> +<row> + <entry>[ ]</entry> + <entry>= Brackets indicate that the enclosed item(s) are optional.</entry> +</row> +<row> + <entry>&repeatst; &repeaten;</entry> + <entry>= Braces indicate that the enclosed item(s) can be + either omitted or repeated multiple times.</entry> +</row> +<row> + <entry>&replstart;path&replend;</entry> + <entry>= Represents any legal pathlist.</entry> +</row> +<row> + <entry>&replstart;devname&replend;</entry> + <entry>= Represents any legal device name.</entry> +</row> +<row> + <entry>&replstart;nodname&replend;</entry> + <entry>= Represents any legal memory module name.</entry> +</row> +<row> + <entry>&replstart;procID&replend;</entry> + <entry>= Represents a process number.</entry> +</row> +<row> + <entry>&replstart;opts&replend;</entry> + <entry>= One or more options defined in the command description.</entry> +</row> +<row> + <entry>&replstart;arglist&replend;</entry> + <entry>= a list of arguments (parameters).</entry> +</row> +<row> + <entry>&replstart;text&replend;</entry> + <entry>= a character string terminated by end-of-line.</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<para> +NOTE: The syntax of the commands given does not include the shell's +built in options such as alternate memory size, I/O redirection, +etc. This is because the shell will filter its options out of the +command line before it is passed to the program being called. +</para> +</section> + +<section> +<title>Commands</title> + +&attrref; +&backupref; +&binexref; +&buildref; +&chdref; +&cmpref; +&cobblerref; +&configref; +©ref; +&dateref; +&dcheckref; +&delref; +&deldirref; +&dirref; +&displayref; +&dsaveref; +&dumpref; +&echoref; +&exref; +&formatref; +&freeref; +&go51ref; +&helpref; +&identref; +&inizref; +&killref; +&linkref; +&listref; +&loadref; +&loginref; +&makdirref; +&mdirref; +&mergeref; +&mfreeref; +&os9genref; +&printerrref; +&procsref; +&pwdref; +&renameref; +&saveref; +&setimeref; +&setprref; +&shellref; +&sleepref; +&teeref; +&tmoderef; +&tsmonref; +&tuneportref; +&unlinkref; +&verifyref; +&xmoderef; + +</section> +</chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/makefile Fri Jan 17 17:32:16 2003 +0000 @@ -0,0 +1,83 @@ +BOOK = os9guide +STYLESHEET = docbook-utils.dsl + +all: $(BOOK).pdf + +$(BOOK).pdf: $(BOOK).docbook $(SRCS) + docbook2pdf -d docbook-utils-a4.dsl#print $(BOOK).docbook + +$(BOOK).ps: $(BOOK).docbook $(SRCS) + docbook2ps -d docbook-utils-a4.dsl#print $(BOOK).docbook +# docbook2ps -d $(STYLESHEET) $(BOOK).docbook + +$(BOOK).html: $(BOOK).docbook $(SRCS) + $(RM) *.htm *.html +# jade -t sgml -V html-index -d /usr/share/sgml/docbook/dsssl-stylesheets-1.64/html/docbook.dsl $(BOOK).docbook +# collateindex.pl -p -o index.docbook HTML.index + docbook2html -d docbook-utils-a4.dsl#html $(BOOK).docbook + +print: $(BOOK).ps + psnup -2 $(BOOK).ps | lpr + +clean: + $(RM) *.htm *.html $(BOOK).pdf $(BOOK).ps +SRCS = $(CHAPS) $(APXS) $(REFS) +CHAPS = intro.preface \ + chap1.chapter chap2.chapter chap3.chapter chap4.chapter \ + chap5.chapter chap6.chapter chap7.chapter +APXS = acia51.appendix display.appendix errorcodes.appendix keys.appendix +REFS = attr.refentry \ + backup.refentry \ + binex.refentry \ + build.refentry \ + chd.refentry \ + cmp.refentry \ + cobbler.refentry \ + config.refentry \ + copy.refentry \ + date.refentry \ + dcheck.refentry \ + deiniz.refentry \ + deldir.refentry \ + del.refentry \ + dir.refentry \ + display.refentry \ + dsave.refentry \ + dump.refentry \ + echo.refentry \ + error.refentry \ + ex.refentry \ + format.refentry \ + free.refentry \ + go51.appendix \ + go51.refentry \ + help.refentry \ + ident.refentry \ + iniz.refentry \ + kill.refentry \ + link.refentry \ + list.refentry \ + load.refentry \ + login.refentry \ + makdir.refentry \ + mdir.refentry \ + merge.refentry \ + mfree.refentry \ + os9gen.refentry \ + park.refentry \ + printerr.refentry \ + procs.refentry \ + pwd.refentry \ + rename.refentry \ + save.refentry \ + setime.refentry \ + setpr.refentry \ + shell.refentry \ + sleep.refentry \ + tee.refentry \ + tmode.refentry \ + tsmon.refentry \ + tuneport.refentry \ + unlink.refentry \ + verify.refentry \ + xmode.refentry
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/os9guide.docbook Fri Jan 17 17:32:16 2003 +0000 @@ -0,0 +1,114 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + <!ENTITY replstart "<"> + <!ENTITY replend ">"> + <!ENTITY repeatst "{"> + <!ENTITY repeaten "}"> + <!ENTITY vendor "OS9 Consortium"> + <!ENTITY make "Dragon/Color"> + <!ENTITY preface SYSTEM "intro.preface"> + <!ENTITY chap1 SYSTEM "chap1.chapter"> + <!ENTITY chap2 SYSTEM "chap2.chapter"> + <!ENTITY chap3 SYSTEM "chap3.chapter"> + <!ENTITY chap4 SYSTEM "chap4.chapter"> + <!ENTITY chap5 SYSTEM "chap5.chapter"> + <!ENTITY chap6 SYSTEM "chap6.chapter"> + <!ENTITY chap7 SYSTEM "chap7.chapter"> + <!ENTITY errorcodesapp SYSTEM "errorcodes.appendix"> + <!ENTITY displayapp SYSTEM "display.appendix"> + <!ENTITY keysapp SYSTEM "keys.appendix"> + <!ENTITY go51app SYSTEM "go51.appendix"> + <!ENTITY acia51app SYSTEM "acia51.appendix"> + + <!ENTITY attrref SYSTEM "attr.refentry"> + <!ENTITY backupref SYSTEM "backup.refentry"> + <!ENTITY binexref SYSTEM "binex.refentry"> + <!ENTITY buildref SYSTEM "build.refentry"> + <!ENTITY chdref SYSTEM "chd.refentry"> + <!ENTITY cmpref SYSTEM "cmp.refentry"> + <!ENTITY cobblerref SYSTEM "cobbler.refentry"> + <!ENTITY configref SYSTEM "config.refentry"> + <!ENTITY copyref SYSTEM "copy.refentry"> + <!ENTITY dateref SYSTEM "date.refentry"> + <!ENTITY dcheckref SYSTEM "dcheck.refentry"> + <!ENTITY delref SYSTEM "del.refentry"> + <!ENTITY deldirref SYSTEM "deldir.refentry"> + <!ENTITY dirref SYSTEM "dir.refentry"> + <!ENTITY displayref SYSTEM "display.refentry"> + <!ENTITY dsaveref SYSTEM "dsave.refentry"> + <!ENTITY dumpref SYSTEM "dump.refentry"> + <!ENTITY echoref SYSTEM "echo.refentry"> + <!ENTITY exref SYSTEM "ex.refentry"> + <!ENTITY formatref SYSTEM "format.refentry"> + <!ENTITY freeref SYSTEM "free.refentry"> + <!ENTITY go51ref SYSTEM "go51.refentry"> + <!ENTITY helpref SYSTEM "help.refentry"> + <!ENTITY identref SYSTEM "ident.refentry"> + <!ENTITY inizref SYSTEM "iniz.refentry"> + <!ENTITY killref SYSTEM "kill.refentry"> + <!ENTITY linkref SYSTEM "link.refentry"> + <!ENTITY listref SYSTEM "list.refentry"> + <!ENTITY loadref SYSTEM "load.refentry"> + <!ENTITY loginref SYSTEM "login.refentry"> + <!ENTITY makdirref SYSTEM "makdir.refentry"> + <!ENTITY mdirref SYSTEM "mdir.refentry"> + <!ENTITY mergeref SYSTEM "merge.refentry"> + <!ENTITY mfreeref SYSTEM "mfree.refentry"> + <!ENTITY os9genref SYSTEM "os9gen.refentry"> + <!ENTITY printerrref SYSTEM "printerr.refentry"> + <!ENTITY procsref SYSTEM "procs.refentry"> + <!ENTITY pwdref SYSTEM "pwd.refentry"> + <!ENTITY renameref SYSTEM "rename.refentry"> + <!ENTITY saveref SYSTEM "save.refentry"> + <!ENTITY setimeref SYSTEM "setime.refentry"> + <!ENTITY setprref SYSTEM "setpr.refentry"> + <!ENTITY shellref SYSTEM "shell.refentry"> + <!ENTITY sleepref SYSTEM "sleep.refentry"> + <!ENTITY teeref SYSTEM "tee.refentry"> + <!ENTITY tmoderef SYSTEM "tmode.refentry"> + <!ENTITY tsmonref SYSTEM "tsmon.refentry"> + <!ENTITY tuneportref SYSTEM "tuneport.refentry"> + <!ENTITY unlinkref SYSTEM "unlink.refentry"> + <!ENTITY verifyref SYSTEM "verify.refentry"> + <!ENTITY xmoderef SYSTEM "xmode.refentry"> + ]> +<book id="os9guide" lang="en"> +<bookinfo> + <title>OS-9 Operating System User's Guide</title> + <subtitle>for OS-9 Level I</subtitle> + + <publisher> + <publishername>Cleglen Publishing Limited</publishername> + <address> + <city>Cardiff</city> + </address> + </publisher> + +<copyright> + <year>1983</year> + <holder>Dragon Data Ltd., and Microware Systems Corporation.</holder> +</copyright> + + <legalnotice> + <para>All Rights Reserved. Reproduced under license from +Microware Systems Corporation.</para> + </legalnotice> + + +</bookinfo> + +&preface; +&chap1; +&chap2; +&chap3; +&chap4; +&chap5; +&chap6; +&chap7; +&errorcodesapp; +&displayapp; +&keysapp; +&acia51app; + +</book>