annotate docs/nitros9guide/dump.refentry @ 2322:61fb37b19edd

Edition #3 - for vtio instead of cc3io Willard Goosey
author aaronwolfe
date Mon, 11 Jan 2010 04:20:41 +0000
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="dump">
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>DUMP</refname>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
4 <refpurpose>Formatted File Data Dump in Hexadecimal and ASCII</refpurpose>
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: 975
diff changeset
9 <command>dump</command>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
10 <arg choice="opt">
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
11 <replaceable>-h -m -x</replaceable>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
12 </arg>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
13 <arg choice="opt">
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 </cmdsynopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
17 </refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
18
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
19 <refsect1><title>Description</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
20 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
21 This command produces a formatted display of the physical data
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
22 contents of the path specified which may be a mass storage file or
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
23 any other I/O device. If a pathlist is omitted, the standard input
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
24 path is used. The output is written to standard output. This command is
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
25 commonly used to examine the contents of non-text files.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
26 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
27 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
28 The data is displayed 16 bytes per line in both hexadecimal and
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
29 ASCII character format. Data bytes that have non-displayable values
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
30 are represented by periods in the character area.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
31 </para>
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 The addresses displayed on the dump are relative to the beginning of
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
34 the file. Because memory modules are position-independent and stored
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
35 on files exactly as they exist in memory, the addresses shown on the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
36 dump correspond to the relative load addresses of memory-module
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
37 files.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
38 </para>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
39 <informaltable frame="none">
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
40 <tgroup cols="2">
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
41 <colspec colwidth="1in"/>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
42 <colspec colwidth="4in"/>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
43 <tbody>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
44 <row>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
45 <entry>-h</entry>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
46 <entry>prevent dump from printing its header every 256 bytes</entry>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
47 </row>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
48 <row>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
49 <entry>-m</entry>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
50 <entry>names on the command line are modules in memory</entry>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
51 </row>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
52 <row>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
53 <entry>-x</entry>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
54 <entry>names on the command line are files relative to the execution directory</entry>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
55 </row>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
56 </tbody>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
57 </tgroup>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
58 </informaltable>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
59 </refsect1>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
60
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
61 <refsect1><title>Examples</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
62 <screen>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
63 dump (display keyboard input in hex)
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
64 dump myfile &gt;/p (dump myfile to printer)
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
65 dump -m kernel (dump the kernel module in memory)
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
66 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
67 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
68
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
69 <refsect1><title>Sample Output</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
70 <screen>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
71 Address 0 1 2 3 4 5 6 7 8 9 A B C D E F 0 2 4 6 8 A C E
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
72 -------- ---- ---- ---- ---- ---- ---- ---- ---- ----------------
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
73 00000000 87CD 0038 002A P181 2800 2E00 3103 FFE0 .M.8.*q.(...1..'
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
74 00000010 0418 0000 0100 0101 0001 1808 180D 1B04 ................
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
75 00000020 0117 0311 0807 1500 002A 5445 S2CD 5343 .........*TERMSC
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
76 00000030 C641 4349 C10E 529E FACIA.R.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
77
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
78 ^ ^ ^
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
79
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
80 starting data bytes in hexadecimal data bytes in
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1093
diff changeset
81 address format ASCII format
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
82 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
83 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
84 </refentry>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
85