aboutsummaryrefslogtreecommitdiff
path: root/man/c8dump.1
blob: d79f723d9f6ada1572ab700ab48b4d67747fb213 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.Dd 26 February, 2024
.Dt U8DUMP 1
.Os Ahoy 1.0.0
.Sh NAME
.Nm c8dump
.Nd disassemble CHIP-8 binaries
.Sh SYNOPSIS
.Nm
.Op Ar
.Nm
.Fl h
.Sh DESCRIPTION
The
.Nm
utility disassembles CHIP-8 binaries into the assembly dialect understood
by the
.Xr c8asm 1
assembler.
It reads the binaries provided as command-line arguments and writes the
corresponding assembly code to the standard output.
If no command-line arguments are provided or the special
.Sq \-
filename is given,
input is read from the standard input.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl h , Fl Fl help
Display help information by opening this manual page.
.El
.Pp
As a result of the CHIP-8 binary format it is quite common that sprite
data and other sequences of byte-literals will be translated by
.Nm
into instructions.
As a minimal reproducable example, the following sprite data would get
disassembled into a
.Ql stor v0 .
.Pp
.Dl sprite: db 0xF0 0x55
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Disassemble a binary:
.Pp
.Dl $ c8dump space-invaders.bin
.Pp
Disassemble output from the
.Xr c8asm 1
assembler:
.Pp
.Dl $ c8asm tetris.s | c8dump
.Sh SEE ALSO
.Xr ahoy 1 ,
.Xr c8asm 1 ,
.Xr c8asm 5
.Sh AUTHORS
.An Thomas Voss Aq Mt mail@thomasvoss.com