changeset 971:425b8a051c58

Reference pages for new commands
author roug
date Fri, 31 Jan 2003 23:35:18 +0000
parents c0ce05d144a9
children 2ccaf038d1c6
files docs/nitros9guide/chap7.chapter docs/nitros9guide/cputype.refentry docs/nitros9guide/ded.refentry docs/nitros9guide/devs.refentry docs/nitros9guide/disasm.refentry docs/nitros9guide/dmode.refentry docs/nitros9guide/irqs.refentry docs/nitros9guide/os9guide.docbook
diffstat 8 files changed, 261 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/nitros9guide/chap7.chapter	Fri Jan 31 23:03:25 2003 +0000
+++ b/docs/nitros9guide/chap7.chapter	Fri Jan 31 23:35:18 2003 +0000
@@ -90,23 +90,30 @@
 &cobblerref;
 &configref;
 &copyref;
+&cputyperef;
 &dateref;
 &dcheckref;
 &debugref;
+&dedref;
 &delref;
 &deldirref;
+&devsref;
+&dmoderef;
 &dirref;
+&disasmref;
 &displayref;
 &dsaveref;
 &dumpref;
 &echoref;
 &exref;
+&exmoderef;
 &formatref;
 &freeref;
 &go51ref;
 &helpref;
 &identref;
 &inizref;
+&irqsref;
 &killref;
 &linkref;
 &listref;
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/cputype.refentry	Fri Jan 31 23:35:18 2003 +0000
@@ -0,0 +1,22 @@
+<refentry id="cputype">
+<refnamediv>
+<refname>CPUTYPE</refname>
+<refpurpose>Identify 6809 or 6309</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>CPUTYPE</command>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Identify 6809 or 6309
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<screen>
+</screen>
+</refsect1>
+</refentry>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/ded.refentry	Fri Jan 31 23:35:18 2003 +0000
@@ -0,0 +1,49 @@
+<refentry id="ded">
+<refnamediv>
+<refname>DED</refname>
+<refpurpose>Disk Editor</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DED</command>
+<arg choice="plain">&replstart;pathlist&replend;</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+dEd  is a screen-oriented disk  editor  utility.
+It was originally conceived as a floppy
+disk  editor, so the display is organized around individual 
+sectors. It performs most of the functions of Patch, from 
+Computerware, but is faster, more compact, and
+screen-oriented rather than line-oriented. Individual files 
+or the disk itself (hard, floppy, ram) can be examined and 
+changed, sectors  can  be  written   to an output file, and 
+executable  modules can be located, linked to and verified. 
+With   simple changes, it will run on any CoCo Level I OS-9 
+and possibly others (CoCo Level II OS-9).
+</para><para>
+To use, type:
+<screen>
+dEd &lt;pathlist&gt;
+</screen>
+where &lt;pathlist&gt; is of the form:  filename or dirname
+or  /path/filename
+or  /D0@  (edits entire disk) 
+</para><para>
+dEd will read in and display the first 256 bytes in the file
+(disk). This  is Logical Sector Number (LSN) zero. You move 
+through  the   file sector (LSN) by sector using the up and 
+down arrow keys. The current LSN number is displayed in Hex 
+and  Decimal in the upper left corner of the screen. If the 
+disk itself was accessed (by appending '@' to it's name when
+dEd   was called), the LSN is the disk sector number. If an 
+individual file is being editted, however, the LSN displayed
+refers  to the file, not to the disk. All numbers requested 
+by  dEd must be in Hex format. All commands are accessed by 
+simply pressing the desired key.
+</para>
+</refsect1>
+</refentry>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/devs.refentry	Fri Jan 31 23:35:18 2003 +0000
@@ -0,0 +1,19 @@
+<refentry id="devs">
+<refnamediv>
+<refname>DEVS</refname>
+<refpurpose>Show device table entries</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DEVS</command>
+<arg choice="opt">-?</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Show device table entries
+</para>
+</refsect1>
+</refentry>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/disasm.refentry	Fri Jan 31 23:35:18 2003 +0000
@@ -0,0 +1,81 @@
+<refentry id="disasm">
+<refnamediv>
+<refname>DISASM</refname>
+<refpurpose>OS9 Module Disassembler</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DISASM</command>
+<group>
+<arg choice="opt">-m &replstart;module name&replend;</arg>
+<arg choice="plain">&replstart;filename&replend;</arg>
+</group>
+<arg choice="opt">options</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Disasm was written to hack apart OS9 system modules,command modules,
+file managers and device drivers/descriptors either from memory or disk.
+Unlike most other disassemblers,DISASM is a two pass disassembler, creating
+output using only referenced labels. This output can be redirected to a file
+and (after modifications if desired) then re-assembled.
+</para>
+<para>
+Disasm provides completely commented disassembly of Device Descriptors...
+very useful for building a customized boot file.
+</para>
+</refsect1>
+<refsect1><title>Options</title>
+<variablelist>
+<varlistentry>
+<term>disasm -m &replstart;module name&replend;</term>
+<listitem>
+<para>
+will link to module in memory - if not found,will load module from exec
+directory and then link to it...after disassembly,it will attempt to
+unlink the module.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>disasm &replstart;pathlist/module name&replend;</term>
+<listitem>
+<para>
+will 'read' the module from the specified path without loading.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>other options:</term>
+<listitem>
+<para>
+o = display line number,address,object code &amp; source code... useful for 
+hard to crack modules with data embedded in the middle.
+</para>
+<para>
+x = look for module in execution directory.
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+<para>
+ANY combination of options is allowed (upper or lower case) but they *must*
+immediately follow the '-' and there must be no spaces separating the options.
+</para>
+</refsect1>
+<refsect1><title>OS9 Level I Users</title>
+<para>
+by changing relative address $17 from $64 to $30 will cause the output
+source to reference /d0/defs instead of /dd/defs
+</para><para>
+also,if you are not using a driver which supports level II display codes,
+you *MUST* change relative address $15 from 01 to 00 to avoid problems
+in the event of an error message being printed out.
+</para>
+</refsect1>
+</refentry>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/dmode.refentry	Fri Jan 31 23:35:18 2003 +0000
@@ -0,0 +1,58 @@
+<refentry id="dmode">
+<refnamediv>
+<refname>DMODE</refname>
+<refpurpose>Disk descriptor Editor</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>DMODE</command>
+<group>
+<arg choice="plain">&replstart;devicename&replend;</arg>
+<arg choice="plain">-&replstart;filename&replend;</arg>
+</group>
+<arg choice="opt">options</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This new version allows any combination of upper or lower
+case options to be specified.
+</para><para>
+Also, current parameters are displayed with a "$" preceding
+to remind the user that the values are HEXADECIMAL.
+</para><para>
+Options may be prefixed with a "$". It is simply ignored.
+</para>
+</refsect1>
+<refsect1><title>Examples</title>
+<para>
+Typical DMODE output:
+<screen>
+OS9: dmode /dd  {enter}
+
+ drv=$00 stp=$00 typ=$80 dns=$01 cyl=$0334 sid=$06
+ vfy=$00 sct=$0021 tos=$0021 ilv=$00 sas=$20
+</screen>
+
+Now, let's say we want to change the number of cylinders
+this descripter shows. The following command lines would
+all be valid and accepted by the new DMODE:
+
+<screen>
+OS9:  dmode /dd CYL=276
+-or-  dmode /dd Cyl=$276
+-or-  dmode /dd cYL=276
+</screen>
+
+Lastly, you may now specify either "TOS" or "T0S" to setup
+the number of sectors per track in track zero. Example:
+
+<screen>
+OS9:  dmode /dd tos=21
+-or-  dmode /dd t0s=21
+</screen>
+</para>
+</refsect1>
+</refentry>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/irqs.refentry	Fri Jan 31 23:35:18 2003 +0000
@@ -0,0 +1,18 @@
+<refentry id="irqs">
+<refnamediv>
+<refname>IRQS</refname>
+<refpurpose>Show interrupt polling table</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>IRQS</command>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+Show interrupt polling table.
+</para>
+</refsect1>
+</refentry>
--- a/docs/nitros9guide/os9guide.docbook	Fri Jan 31 23:03:25 2003 +0000
+++ b/docs/nitros9guide/os9guide.docbook	Fri Jan 31 23:35:18 2003 +0000
@@ -32,23 +32,30 @@
   <!ENTITY cobblerref    SYSTEM "cobbler.refentry">
   <!ENTITY configref     SYSTEM "config.refentry">
   <!ENTITY copyref       SYSTEM "copy.refentry">
+  <!ENTITY cputyperef    SYSTEM "cputype.refentry">
   <!ENTITY dateref       SYSTEM "date.refentry">
   <!ENTITY dcheckref     SYSTEM "dcheck.refentry">
   <!ENTITY debugref      SYSTEM "debug.refentry">
+  <!ENTITY dedref        SYSTEM "ded.refentry">
   <!ENTITY delref        SYSTEM "del.refentry">
   <!ENTITY deldirref     SYSTEM "deldir.refentry">
+  <!ENTITY devsref       SYSTEM "devs.refentry">
   <!ENTITY dirref        SYSTEM "dir.refentry">
+  <!ENTITY disasmref     SYSTEM "disasm.refentry">
   <!ENTITY displayref    SYSTEM "display.refentry">
+  <!ENTITY dmoderef      SYSTEM "dmode.refentry">
   <!ENTITY dsaveref      SYSTEM "dsave.refentry">
   <!ENTITY dumpref       SYSTEM "dump.refentry">
   <!ENTITY echoref       SYSTEM "echo.refentry">
   <!ENTITY exref         SYSTEM "ex.refentry">
+  <!ENTITY exmoderef     SYSTEM "exmode.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 irqsref       SYSTEM "irqs.refentry">
   <!ENTITY killref       SYSTEM "kill.refentry">
   <!ENTITY linkref       SYSTEM "link.refentry">
   <!ENTITY listref       SYSTEM "list.refentry">