annotate docs/nitros9guide/ident.refentry @ 3116:174eb9eda7b1

New port "mc09" for Multicomp09, an FPGA-based 6809 machine Include new commands/descriptor for mc09 clock and SD controller
author Neal Crook <foofoobedoo@gmail.com>
date Sat, 17 Oct 2015 21:21:11 +0100
parents b00cf13c9f61
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
1 <refentry id="ident">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
2 <refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
3 <refname>IDENT</refname>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
4 <refpurpose>Print NitrOS-9 module identification</refpurpose>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
5 </refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
6
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
7 <refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
8 <cmdsynopsis>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
9 <command>ident</command>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
10 <arg choice="opt">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
11 <option>-opts</option>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
12 </arg>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
13 <arg choice="plain">
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
14 <replaceable>path</replaceable>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
15 </arg>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
16 <arg choice="opt">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
17 <option>-opts</option>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
18 </arg>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
19 </cmdsynopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
20 </refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
21
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
22 <refsect1><title>Description</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
23 <para>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
24 This command is used to display header information from NitrOS-9 memory
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
25 modules. <command>Ident</command> displays the module size, CRC bytes (with verification), and for
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
26 program and device driver modules, the execution
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
27 offset and the permanent storage requirement bytes. <command>ident</command> will
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
28 print and interpret the type/language and attribute/revision bytes.
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
29 In addition, <command>ident</command> displays the byte immediately following the
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
30 module name since most Microware-supplied modules set this byte to
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
31 indicate the module edition.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
32 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
33 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
34 <command>Ident</command> will display all modules contained in a disk file. If the
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
35 &quot;-m&quot; option appears, <replaceable>path</replaceable> is assumed to be a module in memory.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
36 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
37 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
38 If the &quot;-v&quot; option is specified, the module CRC is not verified.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
39 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
40 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
41 The &quot;-x&quot; option implies the pathlist begins in the execution
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
42 directory.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
43 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
44 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
45 The &quot;-s&quot; option causes <command>ident</command> to display the. following module
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
46 information on a single line:
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
47 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
48 <simplelist>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
49 <member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
50 Edition byte (first byte after module name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
51 </member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
52 <member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
53 Type/Language byte
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
54 </member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
55 <member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
56 Module CRC
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
57 </member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
58 <member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
59 A &quot;.&quot; if the CRC verifies correctly, &quot;?&quot; if incorrect.
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
60 (<command>Ident</command> will leave this field blank if the &quot;-v&quot; option appears.)
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
61 </member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
62 <member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
63 Module name
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
64 </member>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
65 </simplelist>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
66 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
67
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
68 <refsect1><title>Examples</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
69 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
70 OS9: ident -m ident
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
71 Header for: Ident &lt;Module name&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
72 Module size: $06A5 #1701 &lt;Module size&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
73 Module CRC: $1CE78A (Good) &lt;Good or Bad&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
74 Hdr parity: $8B &lt;Header parity&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
75 Exec. off: $0222 #546 &lt;Execution offset&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
76 Data size: $0CA1 #3233 &lt;Permanent storage requirement&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
77 Edition: $05 #5 &lt;First byte after module name&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
78 Ty/La At/Rv: $11 $81 &lt;Type/Language Attribute/Revision&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
79 Prog mod, 6809 obj, re-en &lt;Module type, Language, Attribute&gt;
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
80 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
81 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
82 OS9: ident /d0/os9boot -s
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
83 1 $C0 $A366DC . KernelP2
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
84 83 $C0 $7FC336 . Init
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
85 1 $11 $39BA94 . SysGo
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
86 1 $C1 $402573 . IOMan
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
87 3 $D1 $EE937A . RBF
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
88 82 $F1 $526268 . DD
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
89 82 $F1 $526268 . D0
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
90 82 $F1 $D65245 . D1
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
91 82 $F1 $E32FFE . D2
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
92 1 $D1 $F944D7 . SCF
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
93 2 $E1 $F9FE37 . VDGInt
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
94 83 $F1 $765270 . Term
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
95 2 $D1 $BBC1EE . PipeMan
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
96 2 $E1 $5B2B56 . Piper
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
97 80 $F1 $CC06AF . Pipe
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
98 2 $C1 $248B2C . Clock
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
99 2 $C1 $248B2C . Clock2
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
100 ^ ^ ^ ^ ^
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
101 | | | | |
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
102 | | | | Module name
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
103 | | | CRC check &quot; &quot; if -v, &quot;.&quot; if OK, &quot;?&quot; if bad
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
104 | | CRC value
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
105 | Type/Language byte
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
106 Edition byte (first byte after name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
107 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
108 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
109 </refentry>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
110