<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is to be uploaded as project page according to "http://sourceforge.net/p/forge/documentation/Project%20Web%20Services" -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<title>javahexeditor User Guide</title>
</head>
<body>
<div class="content" style="float:left; width:20%">
<img src="images/javahexeditor-48x48.png" alt="Java Hex Editor Logo"/>
<ul class="menu">
<li class="leaf">
<a href="http://sourceforge.net/projects/javahexeditor/">Home</a>
</li>
<li class="leaf">
<a href="http://sourceforge.net/project/showfiles.php?group_id=165536">Download</a>
</li>
<li class="leaf">
<a href="http://sourceforge.net/forum/?group_id=165536">Mailing Lists</a>
</li>
</ul>
</div>
<div style="float:right; width:80%; padding-left:20">
<h1>
<em>javahexeditor</em>
User Guide
</h1>
<h2>Introduction</h2>
<p>
<em>javahexeditor</em>
is a
<a href="http://en.wikipedia.org/wiki/Hex_editor" target="_blank">hex editor</a>
written in
<a href="http://java.sun.com" target="_blank">Java</a>
.
It is available as a stand-alone application using
<a href="http://www.eclipse.org/swt" target="_blank">SWT</a>
widgets and as
<a href="http://www.eclipse.org" target="_blank">Eclipse</a>
plugin. It offers:
</p>
<ul>
<li>Support for very large files</li>
<li> Hex, ASCII and Unicode find</li>
<li>Overwrite/insert modes</li>
<li>Binary and text cut/copy/paste</li>
<li>Undo/redo</li>
</ul>
<h2>Download and Installation</h2>
<p>
There are different different possible ways to run
<em>javahexeditor</em>
</p>
<ul>
<li>
For Windows users there is a
<a href="http://sourceforge.net/projects/javahexeditor/files/javahexeditor/current/javahexeditor-win32-x86.zip/download">32-bit</a>
version and a
<a href="http://sourceforge.net/projects/javahexeditor/files/javahexeditor/current/javahexeditor-win32-x86_64.zip/download">64-bit version</a>
in the form of a single executable file named "JavaHexEditor.exe".
</li>
<li>
For Linux users there is a
<a href="http://sourceforge.net/projects/javahexeditor/files/javahexeditor/current/javahexeditor-win32-x86.zip/download">32-bit</a>
version and a
<a href="http://sourceforge.net/projects/javahexeditor/files/javahexeditor/current/javahexeditor-win32-x86_64.zip/download">64-bit version</a>
in the form of a shell start script "JavaHexEditor.sh" and a single "JavaHexEditor.jar".
</li>
<li>
For Eclipse 3.x or 4.x users there is a plugin available via the update site
<a href="http://javahexeditor.sourceforge.net/update" target="_blank">http://javahexeditor.sourceforge.net/update</a>
</li>
</ul>
<h2>Usage</h2>
<h3>Eclipse Editor</h3>
Any file currently in the workspace (but not part of a jar file) with one of the extensions listed below can be opened with
<em>javahexeditor</em>
by right clicking on the file name, expanding the "Open With" menu item, and selecting
<em>javahexeditor</em>
:
<br/>
<code>a, bin, cab,
class, com, dat, data, drv, dll, exe, hex, iso, jar, lib, o, out,
part, pdf, png, ram, res, rom, sys, txt, zip
</code>
.
<br/>
Other file extensions can be added in the preferences
dialog via "Window / Preferences... / General / Editors / File Associations".
<h3>Stand-alone Editor</h3>
<p>The standlone editor comes with its own main window and menu bar. All important menu items are bound to a standard keyboard shortcut. The keyboard shortcut is displayed in the respective menu item. You can use the "File / Open File..." (CTRL-O) menu
item to open a file or drag the file you want to open and drop it inside the editor area.
To start editing a new file from scratch use the "File / New" (CTRL-N) menu item.
</p>
<p>You can also specify the file to editor as command line parameter for the "JavaHexEditor.exe" executable or the "JavaHexEditor.sh" shell start script.
</p>
<h3>Browsing the File Content</h3>
<p>You can move around the file as you would in any other text editor. To change from hex to text,
or vice versa, press the [Tab] key, or click the mouse in the appropriate area.
</p>
<p>
To locate a specific position within the file use the Goto dialog. The dialog can be opened via the menu item "Edit / Go to Location.." (CTRL-L).
This kind of positioning is especially useful when editing very big files and the scroll bar is not
accurate
enough.
</p>
<p>
To select text move the cursor to the selection start and then press the SHIFT key when changing the cursor to the selection end.
</p>
<h3>Editing the File Content</h3>
<p>There are two modify modes: insert and overwrite. You can switch between insert/overwrite modes
with the INSERT key in your keyboard (as in some text editors, for instance).
</p>
<p>You can insert/delete/trim bytes in insert mode only. In overwrite mode the file length never
changes and you cannot paste things bigger than the space left in the file.
</p>
<p>
You can insert other files by copying by copying them to the clipboard.
This can be achieve for example via "Edit / Copy" (CTRL-C) in Windows and
and pasting it in
<em>javahexeditor</em>
via "Edit / Paste" (CTRL-V).
Copying to a text editor has a limit of 4 MB. Binary copying (from
<em>javahexeditor</em>
to
<em>javahexeditor</em>
) is limited by the free disk space only.
</p>
<p>
Modified text is displayed in blue, so it is easier to see the changes made to the file.
</p>
<h2>Screen Shots</h2>
This is how the Eclipse plugin looks like. Here the find and replace dialog is currently open.<br/>
<img src="images/screenshot-01.png" alt="Find and Replace Dialog"/>
<br/><br/>
This is how the stand-alone application looks like. Here the block selection dialog is currently open.<br/>
<img src="images/screenshot-02.png" alt="Block Selection Dialog"/>
</body>
</html>
