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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# dz6
Fast Vim-inspired TUI hex editor
## Features
- Fast, even when editing large files
- Runs in the terminal / Text User Interface (TUI)
- Vim-like key bindings
- Configurable options
- Edit in hex or ASCII
- String list with regex filtering
- Multiple smart ways to navigate through a file
- Find strings and hex bytes
- Cross-platform
- Open source
## Demo
[](https://asciinema.org/a/801539)
## Installation
### Rust package manager (all operating systems)
Follow the instructions [here](https://rust-lang.org/tools/install/) to install **cargo**. Then, open up
a terminal and type:
cargo install dz6
### FreeBSD
pkg install dz6
### Windows
If you have [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/), install dz6 with:
winget install mentebinaria.dz6
Alternatively, download the [release](https://github.com/mentebinaria/dz6/releases) package for your system.
## Usage
```
Usage: dz6 [OPTIONS] <FILE>
Arguments:
<FILE> File to open
Options:
-o, --offset <OFFSET> Initial cursor offset (hex default; `t` suffix = decimal) [default: 0]
-r, --readonly Set read-only mode
-h, --help Print help
-V, --version Print version
```
Once you load a file in **dz6**, you can use the commands below.
### Global key bindings
| Key | Action | Tips |
| ------- | ---------------- | ------------------------- |
| `Enter` | Switch views | Currently Hex and Text |
| `Alt+l` | Open log window | |
| `:` | Open command bar | See [Commands](#commands) |
#### Commands
| Command | Action | Parameters | Tips/Examples |
| ---------------- | ---------------------------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------- |
| `<number>` | Go to offset | | hex default; `t` suffix = decimal; `+` prefix = incremental jump; `-` prefix = decremental jump |
| `cmt` | Add `<comment>` to `<offset>` | `<offset>` `<comment>` | `cmt 1000 "my comment"` (comment at offset 0x1000; offset obeys the same rules above) |
| `sel` | Select `<length>` bytes from `<offset>` | `<offset>` `<length>` | `sel 40 10t` (select 10 bytes from offset 0x40) |
| `set byteline` | Set the number of bytes per line | `<number> or `auto` | `set byteline 8` (default is 16; `auto` enables automatic setting based on screen width) |
| `set ctrlchar` | Set the character shown in the ASCII dump for non-graphic values | `<char>` | `set ctrlchar " "` would set a blankspace (default: `.`) |
| `set db` | Turn on database file saving/loading (default) | | A database file with a `.dz6` extension will be used to store bookmarks and comments for the file |
| `set nodb` | Turn off database file saving/loading | | |
| `set dimzero` | Dim (gray out) null bytes only (default) | | |
| `set dimctrl` | Dim all control characters | | All non-graphic characters will be dimmed |
| `set nodim` | Turn off byte dimming | | |
| `set theme` | Set the theme | `dark` or `light` | `set theme light` (default: `dark`) |
| `set wrapscan` | Enable search results wrap | | |
| `set nowrapscan` | Disable search results wrap | | |
| `w` | Write changes to file | | |
| `wq` or `x` | Write changes to file and quit | | |
| `q` | Quit without saving changes | | In replace mode, `T` (truncate) is an exception because it modifies the file immediately. |
If you need permanent settings, create a `$HOME/.dz6init` file containing any of the commands above, one per line. dz6 will load that at startup.
### Hex view
| Key | Action | Tips |
| ----------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| Arrow keys | Navigation | Vim-like `h`, `j`, `k`, `l` also work |
| `w` `d` `q` | Advance by a word (2 bytes), a dword (4 bytes), or a qword (8 bytes), respectively | Use the capital letters `W`, `D`, and `Q` to move backwards |
| `o` | Go to the next other byte (the one that differs from the byte under the cursor) | `O` goes backwards |
| `Home` or `0` | Set the cursor to the beginning of the current line | |
| `End` or `$` | Set the cursor to the end of the current line | |
| `Ctrl+Home` or `g` | Go to the first offset | |
| `Ctrl+End` or `G` | Go to the last offset in the file | |
| `Ctrl+f` or `Page Down` | Move down one page | |
| `Ctrl+b`or `Page Up` | Move up one page | |
| `r` | Enter [replace mode](#hex-replace-mode) | |
| `z` | Set the byte under the cursor zero | |
| `~` | Change case if applicable | Only works with bytes within the ASCII alphabetic range |
| `Ctrl+a` | Increment byte under the cursor | |
| `Ctrl+x` | Decrement byte under the cursor | |
| `v` | Enter [select mode](#hex-selection-mode) | |
| `u` | Undo the last change made to the buffer | Use it _before_ writing to the file (`:w`) |
| `/` | Search (forward) | Search the entire file. `Tab` cycles between ASCII and hex search |
| `n` | Search next (forward) | |
| `?` | Search (backward) | Search the entire file. `Tab` cycles between ASCII and hex search |
| `N` | Search next (backward) | |
| `s` | Open [Strings](#strings) window | |
| `Backspace` | Go to the previously visited offset | This is useful after a Go to command, for example |
| `+` | Add current offset to bookmarks | |
| `-` | Go to the last added bookmark | |
| `Alt+1..8` | Go to bookmark | |
| `Alt+-` | Remove the last added bookmark | The cursor must be at the bookmarked offset |
| `Alt+0` | Clear bookmarks | |
| `Alt+h` | Toggle byte highlight | |
| `;` | Add a comment to the selected offset | |
| `Ant+n` | Open [Names](#names) window. Added comments will be there. | |
| `=` | Open [Calculator](#calculator) | |
#### Hex selection mode
| Key | Action | Tips |
| ---------- | -------------------------------- | -------------------------------------------------------------------------------- |
| Arrow keys | Navigation | Vim-like `h`, `j`, `k`, `l` also work |
| `~` | Change case if applicable | Only works with bytes within the ASCII alphabetic range |
| `n` | Fill selected bytes with NOPs | This puts dz6 in replace mode; press `Enter` to save the buffer; `Esc` to cancel |
| `z` | Fill selected bytes with zeroes | Same as above |
| `y` | Copy bytes to system's clipboard | There is no paste command yet |
| `Esc` | Go back to normal mode | |
#### Hex replace mode
| Key | Action | Tips |
| ----------- | ---------------------------------------------------------- | -------------------------------------------------------- |
| Arrow keys | Navigation | |
| `Backspace` | The same as navigating left | |
| `~` | Change case if applicable | Only works with bytes within the ASCII alphabetic range |
| `z` | Set byte to zero | |
| `Ctrl+a` | Increment byte | |
| `Ctrl+x` | Decrement byte | |
| `Esc` | Go back to normal mode | Changes are saved to buffer, but not written to file yet |
| `Tab` | Cycle through hex and ASCII dump to edit the file in ASCII | |
| `T` | Truncate the file at the selected offset | Be aware this can't be undone |
#### Names
| Key | Action | Tips |
| ----------- | ------------------------------------------------ | ------------ |
| Arrow keys | Navigation | Up/Down only |
| `f` | Filter names using a regular expression | |
| `D` | Delete all names | |
| `Esc` | Close | |
| `End` | Select the last item shown | |
| `Ctrl+End` | Select the last item on the list | |
| `Home` | Select the first item shown | |
| `Ctrl+Home` | Select the first item on the list | |
| `Page Down` | Go down one page | |
| `Page Up` | Go up one page | |
| `Enter` | Follow the name in hex dump and close the window | |
#### Strings
| Key | Action | Tips |
| ----------- | -------------------------------------------------- | ------------------------------ |
| Arrow keys | Navigation | Up/Down only |
| `f` | Filter strings using a regular expression | |
| `R` | Re-read strings from file | Useful if you changed the file |
| `Esc` | Close | |
| `End` | Select the last item shown | |
| `Ctrl+End` | Select the last item on the list | |
| `Home` | Select the first item shown | |
| `Ctrl+Home` | Select the first item on the list | |
| `Page Down` | Go down one page | |
| `Page Up` | Go up one page | |
| `Enter` | Follow the string in hex dump and close the window | |
#### Calculator
64-bit calculator. Default base is decimal, but you can prefix hex numbers with 0x. Pre-defined variables:
| Variable | Value | Length |
| -------- | --------------------------- | --------------------------------------------------------- |
| `@x` | Signed value under cursor | `x` is `b` (byte), `w` (word), `d` (dword) or `q` (qword) |
| `@X` | Unsigned value under cursor | `X` is `B` (byte), `W` (word), `D` (dword) or `Q` (qword) |
| `@o` | Current offset | dword on 32-bit systems; qword on 64 |
| `@O` | Previously visited offset | same as above |
Use the up and down arrow keys to navigate through the history.
### Text view
> This view hasn’t received much attention yet. This view still has several issues.
| Key | Action |
| --- | ------------------------------ |
| `e` | Open encoding selection dialog |
## FAQ
**1. I'm on a Mac. How am I supposed to use `Alt` key?!**
iTerm2 users: go to `Settings → Profiles → (your profile) → Keys` and set the `Left Option key` to `Esc+`. This will make the `Option` key work like `Alt`.
**2. Do all Vim commands work in dz6?**
No. Some key bindings behave similarly, but dz6 is not meant to be 100% compatible with Vim. For example, `o` in dz6 moves to the next other byte, while the same key in Vim opens a new line below the current one.
**3. Is dz6 stable yet?**
No. Stability is expected only at v1.0.0. Until then, breaking changes are expected.