diff docs/nitros9guide/ident.refentry @ 138:d9631713b7cd

Split up the commands into individual files.
author roug
date Sun, 07 Jul 2002 08:58:56 +0000
parents
children c565a4700689
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/ident.refentry	Sun Jul 07 08:58:56 2002 +0000
@@ -0,0 +1,115 @@
+<refentry id="ident">
+<refnamediv>
+<refname>IDENT</refname>
+<refpurpose>Print OS-9 module identification</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>IDENT</command>
+<arg choice="opt">
+  <option>-opts</option>
+</arg>
+<arg choice="plain">
+  &replstart;path&replend;
+</arg>
+<arg choice="opt">
+  <option>-opts</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+This command is used to display header information from OS-9 memory
+modules. IDENT displays the module size, CRC bytes (with verification), and for
+program and device driver modules, the execution
+offset and the permanent storage requirement bytes. IDENT will
+print and interpret the type/language and attribute/revision bytes.
+In addition, IDENT displays the byte immediately following the
+module name since most Microware-supplied modules set this byte to
+indicate the module edition.
+</para>
+<para>
+IDENT will display all modules contained in a disk file. If the
+&quot;-m&quot; option appears, &replstart;path&replend; is assumed to be a module in memory.
+</para>
+<para>
+If the &quot;-v&quot; option is specified, the module CRC is not verified.
+</para>
+<para>
+The &quot;-x&quot; option implies the pathlist begins in the execution
+directory.
+</para>
+<para>
+The &quot;-s&quot; option causes IDENT to display the. following module
+information on a single line:
+</para>
+<simplelist>
+<member>
+Edition byte (first byte after module name)
+</member>
+<member>
+Type/Language byte
+</member>
+<member>
+Module CRC
+</member>
+<member>
+A &quot;.&quot; if the CRC verifies correctly, &quot;?&quot; if incorrect.
+(IDENT will leave this field blank if the &quot;-v&quot; option appears.)
+</member>
+<member>
+Module name
+</member>
+</simplelist>
+</refsect1>
+
+<refsect1><title>Examples</title>
+<screen>
+OS9: ident -m  ident
+Header for:  Ident               &lt;Module name&gt;
+Module size: $06A5    #1701      &lt;Module size&gt;
+Module CRC:  $1CE78A (Good)      &lt;Good or Bad&gt;
+Hdr parity:  $8B                 &lt;Header parity&gt;
+Exec. off:   $0222    #546       &lt;Execution offset&gt;
+Data size:   $0CA1    #3233      &lt;Permanent storage requirement&gt;
+Edition:     $05      #5         &lt;First byte after module name&gt;
+Ty/La At/Rv: $11 $81             &lt;Type/Language Attribute/Revision&gt;
+Prog mod, 6809 obj, re-en        &lt;Module type, Language, Attribute&gt;
+</screen>
+<screen>
+OS9: ident /d0/os9boot -s
+    1 $C0 $A366DC . OS9p2
+   83 $C0 $7FC336 . Init
+    1 $11 $39BA94 . SysGo
+    1 $C1 $402573 . IOMan
+    3 $D1 $EE937A . REF
+   82 $F1 $526268 . D0
+   82 $F1 $D65245 . D1
+   82 $F1 $E32FFE . D2
+    1 $D1 $F944D7 . SCF
+    2 $E1 $F9FE37 . ACIA
+   83 $F1 $765270 . TERM
+   83 $F1 $B4396C . T1
+   83 $F1 $63B73B . T2
+   83 $F1 $0F9B78 . T3
+   83 $F1 $F83EB9 . T4
+   83 $F1 $D6DD9A . T5
+    3 $E1 $3EE015 . PIA
+   83 $F1 $12A43B . P
+    2 $D1 $BBC1EE . PipeMan
+    2 $E1 $5B2B56 . Piper
+   80 $F1 $CC06AF . Pipe
+    2 $C1 $248B2C . Clock
+    ^  ^     ^    ^ ^
+    |  |     |    | |
+    |  |     |    | Module name
+    |  |     |    CRC check &quot; &quot; if -v, &quot;.&quot; if OK, &quot;?&quot; if bad
+    |  |     CRC value
+    |  Type/Language byte
+    Edition byte (first byte after name)
+</screen>
+</refsect1>
+</refentry>
+