chirp/README.developers
Dan Smith ed2368a638 Allow specification of the hexdump address format
This allows developers to override the address format used during
whole-diff (and potentially other) hexdump operations.

Idea and much of the implementation borrowed from Dan Drogichen

Related to #1767
2014-07-18 07:58:00 -07:00

54 lines
2 KiB
Text

This file describes some features in the Chirp Developer's Functions
that allow some customization of their behavior, but are only
accessible through editing the chirp.config file before starting
Chirp, and are not accessible through the GUI.
The Developer Functions are enabled in the GUI by checking the box
in the "Help" tab. They enable the Image Browser tab in the left
sidebar, and several tools under the View -> Developer tab.
These directives are similar to other chirp.config entries in syntax.
They reside in the [developer] section in chirp.config.
This section, and all the directives, are not required to be present;
all the options have defaults.
Here is an example [developer] section listing all the directives,
followed by an explanation of each directive:
===================================
[developer]
diff_fontsize = 16
browser_fontsize = 13
hexdump_addrfmt = %(addr)03i
===================================
diff_fontize = <integer>
This specifies the fontsize used in the hex dump/diff display which is
invoked by selecting View -> Developer -> Diff tabs, and then in the
"Diff Radios" popup, selecting < 0 for either or both memory locations.
The default size is 11. Values less than 4, greater than 144, or not
recognized as an integer will result in a log message and the default
size will be used.
========
browser_fontsize = <integer>
This specifies the fontsize used in the file browser, invoked by selecting
the "Browser" tab in the left sidebar, which is visible when the Developer
tools are enabled.
The default size is 10. Values less than 4, greater than 144, or not
recognized as an integer will result in a log message and the default
size will be used.
========
hexdump_addrfmt = %(addr)03i
This specifies the format of the address used during some hexdump
operations. You can specify an alternate format, such as the following
for hex:
hexdump_addrfmt = 0x%(addr)04x
Any of the variables in local scope of chirp/util.py::hexdump.py are
valid for substitution, including block and block_size.