summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/DOC.txt115
1 files changed, 115 insertions, 0 deletions
diff --git a/doc/DOC.txt b/doc/DOC.txt
new file mode 100644
index 0000000..ad5ae54
--- /dev/null
+++ b/doc/DOC.txt
@@ -0,0 +1,115 @@
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+ IHE DOC VERSION 0.0.1 (EARLY ALFA)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+ ihe - interactive hex editor multi purpose hex editor basicaly to edit files
+containes experimental features and not suppose to become mainstream.
+Philosophy of editor is to be minimal and simple without any depencecies on
+third party libraries. Not suppose to be mutli-OS multi-ARCH multi-PLATFORM.
+Not suppouse to be user-friendly but suppose to be file-freindly and
+old-school friendly.
+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+COMMANDS SUPPORTED
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+-- version
+
+ Show current program version
+
+-- quit
+
+ Quit programm without freeing resources
+
+-- help
+
+ Print avaliable commands
+
+-- ?
+
+ Same as HELP
+
+-- open
+
+ open file
+
+ EXAMPLE:
+ >open test/test1
+
+-- close
+
+ close currently opened file
+
+ EXAMPLE:
+ >close
+
+-- info
+
+ show various info about programm resource usage
+
+-- seek
+
+ change file cursor position. dont do anything after changing file position.
+ minimal value 0 and maximal is file size value.
+
+ EXAMPLE:
+ move cursor to +1000 positions
+ >seek 1000
+
+ go back 10 positions
+ >seek -10
+
+-- pos
+
+ show current position of file cursor
+
+-- size
+
+ show opened file size
+
+-- blk
+
+ show currently used block size
+
+-- read
+
+ read from openede file. read from current cursor position reading block size.
+ block size could be checked with BLK command.
+
+-- dump
+
+ show currently readed data in buffer. just hex in one row.
+
+-- dumpx
+
+ show buffer data as hex values like hexdump stuff
+
+-- write
+
+ supports 1 argument. write hex values at currently opened file. at current
+ buffer and write that buffer back to file. maximal write amount is maximal
+ buffer size. file cursor position stays same.
+
+ EXAMPLE:
+ write 0x00 0x11 0x22 0x33 at current position at file
+ >write 00112233
+
+-- writes
+
+ write string to current file buffer and to current file position. Support
+ only one word to write.
+
+ EXAMPLE:
+ write "Hello" to file
+ >writes Hello
+
+
+-- flags
+
+ file opening flags. now is supported R/W/RW
+
+ EXAMPLE:
+ show currently supported flags
+ >flags ?
+ show current flag mask
+ >flags
+