Mercurial > hg > Members > kono > nitros9-code
changeset 1014:d9ed9d44b70c
Some character entities had missing semicolons. It's &CPU;
The os9l1guide and os9l2guide are now much more modular simply because
the sections that are not to be included in one of them is defined as
the empty string in the <!ENTITY declaration
Split exbin and binex pages so the occur at the right place in the manual.
Got the content for wcreate from the Internet.
author | roug |
---|---|
date | Tue, 04 Mar 2003 20:05:50 +0000 |
parents | 15a1a20b70ab |
children | 08fcfa9b150a |
files | docs/nitros9guide/binex.refentry docs/nitros9guide/chap1.chapter docs/nitros9guide/chap2.chapter docs/nitros9guide/chap4.chapter docs/nitros9guide/chap5.chapter docs/nitros9guide/chap7.chapter docs/nitros9guide/deiniz.refentry docs/nitros9guide/devs.refentry docs/nitros9guide/display.appendix docs/nitros9guide/exbin.refentry docs/nitros9guide/intro.preface docs/nitros9guide/irqs.refentry docs/nitros9guide/nitros9guide.book docs/nitros9guide/nitros9l1guide.docbook docs/nitros9guide/nitros9l2guide.docbook docs/nitros9guide/wcreate.refentry |
diffstat | 16 files changed, 203 insertions(+), 117 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/nitros9guide/binex.refentry Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/binex.refentry Tue Mar 04 20:05:50 2003 +0000 @@ -1,7 +1,7 @@ <refentry id="binex"> <refnamediv> -<refname id="binexname">BINEX / EXBIN</refname> -<refpurpose>Convert Binary To S-Record File / Convert S-Record To Binary File</refpurpose> +<refname id="binexname">BINEX</refname> +<refpurpose>Convert Binary To S-Record File</refpurpose> </refnamediv> <refsynopsisdiv> @@ -10,11 +10,6 @@ <arg choice="plain"><replaceable>path1</replaceable></arg> <arg choice="plain"><replaceable>path2</replaceable></arg> </cmdsynopsis> -<cmdsynopsis> - <command>EXBIN</command> - <arg choice="plain"><replaceable>path2</replaceable></arg> - <arg choice="plain"><replaceable>path1</replaceable></arg> -</cmdsynopsis> </refsynopsisdiv> <refsect1><title>Description</title> @@ -52,22 +47,6 @@ <screen> list scanner.S1 >/T1 </screen> -<para> -EXBIN is the inverse operation; "path1" is assumed to be a -S-Record format text file which EXBIN converts to pure binary form on -a new file called "path2". The load addresses of each data record -must describe continguous data in ascending order. -</para> -<para> -EXBIN does not generate or check for the proper OS-9 module -headers or CRC check value required to actually load the binary -file. The IDENT or VERIFY commands can be used to check the -validity of the modules if they are to be loaded or run. -Example: -</para> -<screen> -exbin program.S1 cmds/program -</screen> </refsect1> </refentry>
--- a/docs/nitros9guide/chap1.chapter Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/chap1.chapter Tue Mar 04 20:05:50 2003 +0000 @@ -4,10 +4,10 @@ <section> <title>What You Need to Run OS-9</title> <para> -&os9level &os9version has been tailored to run on the &make;. To use it you'll need the following things: +&os9level; &os9version; has been tailored to run on the &make;. To use it you'll need the following things: </para> <itemizedlist mark="bullet"> - <listitem><para>A &minmem &make; </para></listitem> + <listitem><para>A &minmem; &make; </para></listitem> <listitem><para>A Disk Drive With Contoller Cartridge</para></listitem> <listitem><para>An OS-9 &make; System Disk</para></listitem> </itemizedlist> @@ -34,7 +34,7 @@ <listitem><para>Insert the OS-9 System Disk in drive zero and close the door.</para></listitem> -<listitem><para>Type "&DOSCMD". After a few seconds of disk activity you should +<listitem><para>Type "&DOSCMD;". After a few seconds of disk activity you should see a screen with the words "OS9 BOOT".</para></listitem> <listitem><para>OS-9 will then begin @@ -50,15 +50,15 @@ <title>In Case You Have Problems Starting OS-9</title> <itemizedlist> <listitem><para>If BASIC gives an error message after you -type "&DOSCMD", remove the +type "&DOSCMD;", remove the disk, turn the computer off and on, then try again. If this repeatedly fails your OS-9 diskette may be bad.</para></listitem> <listitem><para>Did you remember to turn the disk drive power switch on?</para></listitem> -<listitem><para>Does your &make; have &minmem RAM? This is a must!</para></listitem> +<listitem><para>Does your &make; have &minmem; RAM? This is a must!</para></listitem> -<listitem><para>If your &make; doesn't seem to understand the &DOSCMD command, your controller has DOS 1.0. You will need to upgrade to +<listitem><para>If your &make; doesn't seem to understand the &DOSCMD; command, your controller has DOS 1.0. You will need to upgrade to DOS 1.1.</para></listitem> <listitem><para>If the "OS9 BOOT message is displayed but nothing else happens, @@ -113,7 +113,7 @@ <screen> OS9Boot startup CMDS SYS DEFS </screen> -The file "OS9Boot" contains the OS-9 program in &CPU machine +The file "OS9Boot" contains the OS-9 program in &CPU; machine language, which was loaded into memory during the bootstrap operation. </para>
--- a/docs/nitros9guide/chap2.chapter Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/chap2.chapter Tue Mar 04 20:05:50 2003 +0000 @@ -83,7 +83,7 @@ <section> <title>Sending Output to the Printer</title> <para> -Normally, most commands and programs display output on the &make video display. The output of these programs can +Normally, most commands and programs display output on the &make; video display. The output of these programs can alternatively be printed by specifying output redirection on the command line. This is done by including the following modifier to at the end of any command line: @@ -289,7 +289,7 @@ <para> Two keys are used in combination with other keys to change their meaning. The SHIFT KEY selects between upper case and lower case -letters or punctuation, and the &ctrlkey key can be used to generate +letters or punctuation, and the &ctrlkey; key can be used to generate control characters. </para> <para> @@ -310,9 +310,9 @@ <para> There are a number of useful control functions that can be generated from the keyboard. Many of these functions use "control -keys" which are generated by simultaneously depressing the &ctrlkey key +keys" which are generated by simultaneously depressing the &ctrlkey; key plus some other key. For example, to generate the character for -CONTROL D press the &ctrlkey and D keys at the same time. +CONTROL D press the &ctrlkey; and D keys at the same time. </para> <variablelist> <varlistentry>
--- a/docs/nitros9guide/chap4.chapter Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/chap4.chapter Tue Mar 04 20:05:50 2003 +0000 @@ -644,7 +644,7 @@ <title>Running Compiled Intermediate Code Programs</title> <para> Before the shell executes a program, it checks the program -module's language type. If its type is not &CPU machine language, +module's language type. If its type is not &CPU; machine language, shell will call the appropriate run-time system for that module. Versions of the shell supplied for various systems are capable of calling different run-time systems. Most versions of shell call
--- a/docs/nitros9guide/chap5.chapter Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/chap5.chapter Tue Mar 04 20:05:50 2003 +0000 @@ -295,7 +295,7 @@ When performing a fork operation, OS-9's first step is to attempt to locate the requested program module by searching the "module directory", which has the address of every module present in memory. -The &CPU instruction set supports a type of program called +The &CPU; instruction set supports a type of program called "reentrant code" which means the exact same "copy" of a program can be shared by two or more different processes simultaneously without affecting each other, provided that each "incarnation" of the @@ -400,7 +400,7 @@ specific, predetermined memory addresses to work correctly, and can therefore be loaded at different memory addresses at different times. PIC programs require special types of machine language instructions -which few computers have. The ability of the &CPU +which few computers have. The ability of the &CPU; microprocessor to use this type of program is one of its most powerful features. </para>
--- a/docs/nitros9guide/chap7.chapter Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/chap7.chapter Tue Mar 04 20:05:50 2003 +0000 @@ -79,6 +79,7 @@ <section> <title>Commands</title> +&asmref; &attrref; &backupref; &binexref; @@ -104,6 +105,7 @@ &dumpref; &echoref; &exref; +&exbinref; &exmoderef; &formatref; &freeref; @@ -121,6 +123,7 @@ &mergeref; &mfreeref; &os9genref; +&procref; &procsref; &pwdref; &renameref; @@ -130,12 +133,14 @@ &setprref; &shellref; &sleepref; +&smapref; &teeref; &tmoderef; &tsmonref; &tuneportref; &unlinkref; &verifyref; +&wcreateref; &xmoderef; </section>
--- a/docs/nitros9guide/deiniz.refentry Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/deiniz.refentry Tue Mar 04 20:05:50 2003 +0000 @@ -36,7 +36,7 @@ </variablelist> </refsect2> <refsect2> -<title>Notes:</title> +<title>Notes</title> <para> Do not deiniz a module unless you have explicitly iniz-ed it. If you do deiniz a device that you have not @@ -46,7 +46,7 @@ </refsect2> </refsect1> <refsect1> -<title>Example:</title> +<title>Example</title> <literallayout> DEINIZ P T2 [ENTER] </literallayout>
--- a/docs/nitros9guide/devs.refentry Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/devs.refentry Tue Mar 04 20:05:50 2003 +0000 @@ -12,7 +12,45 @@ <refsect1><title>Description</title> <para> -Show device table entries. +Devs displays a list of the system's device table. The device table contains an +entry for each active device known to OS-9. devs does not display information +for uninitialized devices. The devs display header lists the system name, +the OS-9 version number, and the maximum number of devices allowed in the device table. +</para> +<para> +Each line in the devs display contains five fields: </para> +<informaltable frame="none"> +<tgroup cols="2"> +<thead> +<row> +<entry>Name</entry><entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>Device</entry><entry>Name of the device descriptor</entry> +</row> +<row> +<entry>Driver</entry><entry>Name of the device driver</entry> +</row> +<row> +<entry>File Mgr</entry><entry>Name of the file manager</entry> +</row> +<row> +<entry>Data Ptr</entry><entry>Address of the device driver's static storage</entry> +</row> +<row> +<entry>Links</entry><entry>Device use count</entry> +</row> +</tbody> +</tgroup> +</informaltable> +<note> +<para> +Each time a user executes a chd to an RBF device, the use count of that device +is incremented by one. Consequently, the Links field may be artificially high. +</para> +</note> </refsect1> </refentry>
--- a/docs/nitros9guide/display.appendix Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/display.appendix Tue Mar 04 20:05:50 2003 +0000 @@ -4,7 +4,7 @@ <section> <title>The Video Display Generator</title> <para> -&os9level allows the VDG display to be used in +&os9level; allows the VDG display to be used in alphanumeric, semigraphic, and graphics modes. There are many built-in functions to control the display, which are activated by used of various ASCII control character. Thus, these functions are
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/exbin.refentry Tue Mar 04 20:05:50 2003 +0000 @@ -0,0 +1,44 @@ +<refentry id="exbin"> +<refnamediv> +<refname id="exbinname">EXBIN</refname> +<refpurpose>Convert S-Record To Binary File</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> + <command>EXBIN</command> + <arg choice="plain"><replaceable>path2</replaceable></arg> + <arg choice="plain"><replaceable>path1</replaceable></arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Description</title> +<para> +S-Record files are a type of text file that contains records that +represent binary data in hexadecimal character form. This +Motorola-standard format is often directly accepted by commercial PROM +programmers, emulators, logic analyzers and similar devices that are +interfaced RS-232 interfaces. It can also be useful for +transmitting files over data links that can only handle character-type +data; or to convert OS-9 assembler or compiler-generated +programs to load on non-OS-9 systems. +</para> +<para> +"Path1" is assumed to be an +S-Record format text file which EXBIN converts to pure binary form on +a new file called "path2". The load addresses of each data record +must describe continguous data in ascending order. +</para> +<para> +EXBIN does not generate or check for the proper OS-9 module +headers or CRC check value required to actually load the binary +file. The IDENT or VERIFY commands can be used to check the +validity of the modules if they are to be loaded or run. +Example: +</para> +<screen> +exbin program.S1 cmds/program +</screen> +</refsect1> +</refentry> +
--- a/docs/nitros9guide/intro.preface Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/intro.preface Tue Mar 04 20:05:50 2003 +0000 @@ -3,7 +3,7 @@ <titleabbrev>Introduction</titleabbrev> <para> The heart of your &make; is an amazing device: the -&CPU microprocessor chip. This advanced microcomputer can run the +&CPU; microprocessor chip. This advanced microcomputer can run the kind of sophisticated software normally found only on much larger and costly computers. Because the OS-9 operating system was designed by the same people who designed the 6809 microprocessor, together
--- a/docs/nitros9guide/irqs.refentry Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/irqs.refentry Tue Mar 04 20:05:50 2003 +0000 @@ -12,7 +12,13 @@ <refsect1><title>Description</title> <para> -Show interrupt polling table. +Irqs displays a list of the system's IRQ polling table. The IRQ polling table contains a +list of the service routines for each interrupt handler known by the system. +</para> +<para> +The irqs display header lists the system name, the OS-9 version number, the maximum +number of devices allowed in the device table, and the maximum number of entries in +the IRQ table. </para> </refsect1> </refentry>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/nitros9guide.book Tue Mar 04 20:05:50 2003 +0000 @@ -0,0 +1,41 @@ +<bookinfo> + <title>&os9level; Operating System User's Guide</title> + <subtitle>&os9version;</subtitle> + +<copyright> + <year>2003</year> + <holder>&vendor;</holder> +</copyright> + + <legalnotice> + <para>All Rights Reserved.</para> + </legalnotice> + +<revhistory> + <revision> + <revnumber>Org.</revnumber> + <date>1983</date> + <revremark>Original OS-9 Level One Guide</revremark> + </revision> + <revision> + <revnumber>A</revnumber> + <date>March 2003</date> + <revremark>Updated with the changes made by Boisy Pitre</revremark> + </revision> +</revhistory> + +</bookinfo> + +&preface; +&chap1; +&chap2; +&chap3; +&chap4; +&chap5; +&chap6; +&chap7; +&errorcodesapp; +&displayapp; +&keysapp; +&acia51app; +
--- a/docs/nitros9guide/nitros9l1guide.docbook Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/nitros9l1guide.docbook Tue Mar 04 20:05:50 2003 +0000 @@ -11,6 +11,7 @@ <!ENTITY minmem "64K"> <!ENTITY DOSCMD "DOS"> <!ENTITY ctrlkey "CLEAR"> + <!ENTITY os9guide SYSTEM "os9guide.book"> <!ENTITY preface SYSTEM "intro.preface"> <!ENTITY chap1 SYSTEM "chap1.chapter"> <!ENTITY chap2 SYSTEM "chap2.chapter"> @@ -22,9 +23,9 @@ <!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 asmref ""> <!ENTITY attrref SYSTEM "attr.refentry"> <!ENTITY backupref SYSTEM "backup.refentry"> <!ENTITY basic09ref SYSTEM "basic09.refentry"> @@ -52,6 +53,7 @@ <!ENTITY dumpref SYSTEM "dump.refentry"> <!ENTITY echoref SYSTEM "echo.refentry"> <!ENTITY exref SYSTEM "ex.refentry"> + <!ENTITY exbinref SYSTEM "exbin.refentry"> <!ENTITY exmoderef SYSTEM "exmode.refentry"> <!ENTITY formatref SYSTEM "format.refentry"> <!ENTITY freeref SYSTEM "free.refentry"> @@ -71,6 +73,7 @@ <!ENTITY mfreeref SYSTEM "mfree.refentry"> <!ENTITY os9genref SYSTEM "os9gen.refentry"> <!ENTITY printerrref SYSTEM "printerr.refentry"> + <!ENTITY procref ""> <!ENTITY procsref SYSTEM "procs.refentry"> <!ENTITY pwdref SYSTEM "pwd.refentry"> <!ENTITY renameref SYSTEM "rename.refentry"> @@ -80,50 +83,16 @@ <!ENTITY setprref SYSTEM "setpr.refentry"> <!ENTITY shellref SYSTEM "shell.refentry"> <!ENTITY sleepref SYSTEM "sleep.refentry"> + <!ENTITY smapref ""> <!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 wcreateref ""> <!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 One</subtitle> - -<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> - -<revhistory> -<revision> -<revnumber>C</revnumber> -<date>March 2003</date> -<revremark>Updated with the changes made by Boisy Pitre</revremark> -</revision> -</revhistory> - -</bookinfo> - -&preface; -&chap1; -&chap2; -&chap3; -&chap4; -&chap5; -&chap6; -&chap7; -&errorcodesapp; -&displayapp; -&keysapp; -&acia51app; - +&os9guide; </book>
--- a/docs/nitros9guide/nitros9l2guide.docbook Tue Mar 04 15:18:51 2003 +0000 +++ b/docs/nitros9guide/nitros9l2guide.docbook Tue Mar 04 20:05:50 2003 +0000 @@ -11,6 +11,7 @@ <!ENTITY minmem "128K"> <!ENTITY DOSCMD "DOS"> <!ENTITY ctrlkey "CTRL"> + <!ENTITY os9guide SYSTEM "os9guide.book"> <!ENTITY preface SYSTEM "intro.preface"> <!ENTITY chap1 SYSTEM "chap1.chapter"> <!ENTITY chap2 SYSTEM "chap2.chapter"> @@ -22,6 +23,7 @@ <!ENTITY errorcodesapp SYSTEM "errorcodes.appendix"> <!ENTITY displayapp SYSTEM "display.appendix"> <!ENTITY keysapp SYSTEM "keys.appendix"> + <!ENTITY acia51app ""> <!ENTITY asmref SYSTEM "asm.refentry"> <!ENTITY attrref SYSTEM "attr.refentry"> @@ -53,6 +55,7 @@ <!ENTITY echoref SYSTEM "echo.refentry"> <!ENTITY error SYSTEM "error.refentry"> <!ENTITY exref SYSTEM "ex.refentry"> + <!ENTITY exbinref SYSTEM "exbin.refentry"> <!ENTITY exmoderef SYSTEM "exmode.refentry"> <!ENTITY formatref SYSTEM "format.refentry"> <!ENTITY freeref SYSTEM "free.refentry"> @@ -74,7 +77,7 @@ <!ENTITY os9genref SYSTEM "os9gen.refentry"> <!ENTITY pmapref SYSTEM "pmap.refentry"> <!ENTITY procref SYSTEM "proc.refentry"> - <!ENTITY procsref SYSTEM "procs.refentry"> + <!ENTITY procsref ""> <!ENTITY pwdref SYSTEM "pwd.refentry"> <!ENTITY rebootref SYSTEM "reboot.refentry"> <!ENTITY renameref SYSTEM "rename.refentry"> @@ -96,39 +99,5 @@ <!ENTITY xmoderef SYSTEM "xmode.refentry"> ]> <book id="os9guide" lang="en"> -<bookinfo> - <title>&os9level Operating System User's Guide</title> - <subtitle>&os9version</subtitle> - -<copyright> - <year>2003</year> - <holder>&vendor</holder> -</copyright> - - <legalnotice> - <para>All Rights Reserved.</para> - </legalnotice> - -<revhistory> -<revision> -<revnumber>A</revnumber> -<date>March 2003</date> -<revremark>Updated with the changes made by Boisy Pitre</revremark> -</revision> -</revhistory> - -</bookinfo> - -&preface; -&chap1; -&chap2; -&chap3; -&chap4; -&chap5; -&chap6; -&chap7; -&errorcodesapp; -&displayapp; -&keysapp; - +&os9guide; </book>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/nitros9guide/wcreate.refentry Tue Mar 04 20:05:50 2003 +0000 @@ -0,0 +1,35 @@ +<refentry id="wcreate"> +<refnamediv> +<refname>WCREATE</refname> +<refpurpose>Initialize and create windows</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>WCREATE</command> +<group> +<arg choice="opt">opts</arg> +</group> +<sbr/> +<group> +<arg choice="plain">/wX</arg> +<arg choice="opt">-s=type</arg> +<arg choice="plain"><replaceable>xpos</replaceable></arg> +<arg choice="plain"><replaceable>ypos</replaceable></arg> +<arg choice="plain"><replaceable>xsiz</replaceable></arg> +<arg choice="plain"><replaceable>ysiz</replaceable></arg> +<arg choice="plain"><replaceable>fcol</replaceable></arg> +<arg choice="plain"><replaceable>bcol</replaceable></arg> +<arg choice="opt"><replaceable>bord</replaceable></arg> +</group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Options</title> +<literallayout> + -? = display help + -z = read command lines from stdin + -s=type = set screen type for a window on a new screen +</literallayout> +</refsect1> +</refentry>