| 1 |
1. OVERVIEW |
| 2 |
=========== |
| 3 |
e3 is a micro text editor with an executable code size between |
| 4 |
3800 and 35000 bytes, depending on used assembler options, |
| 5 |
platform and self compressor. |
| 6 |
Except for 'syntax highlighting', the e3 binary supports all of the basic |
| 7 |
functions one expects plus built in arithmetic calculations. If you have |
| 8 |
installed the stream editor 'sed' you can use these tools as sub-processes, |
| 9 |
getting the full power of regular expressions. |
| 10 |
|
| 11 |
e3 can use Wordstar-, EMACS-, Pico, Nedit or vi-like key bindings, |
| 12 |
whichever the user chooses. |
| 13 |
Also the user can calculate arithmetics inside the text. |
| 14 |
|
| 15 |
e3's assembler version is available on 9 important OS, |
| 16 |
using 16/32/64 bit CPUs. |
| 17 |
|
| 18 |
Beginning in version 2.6.0 e3 does support UTF-8 coding of unicode |
| 19 |
characters like this: α ( <---should be a greek alpha ) |
| 20 |
|
| 21 |
|
| 22 |
2. BUILD on Linux, *BSD |
| 23 |
================================================ |
| 24 |
|
| 25 |
Also the Makefile destinations are reduced to: |
| 26 |
make # same as make 32 (needs NASM) |
| 27 |
make 32 # e3 of 32 bit |
| 28 |
make 64 # e3 of 64 bit |
| 29 |
make install |
| 30 |
make clean |
| 31 |
|
| 32 |
Some other options exist by editing the Makefile: |
| 33 |
DEBUG=false # or true |
| 34 |
NASM_OR_YASM=nasm # or yasm |
| 35 |
|
| 36 |
Editing e3.h opens some other choices, most important |
| 37 |
the choice between default UTF-8 and 7bit-only support. |
| 38 |
|
| 39 |
About more changes, see top of ChangeLog file. |
| 40 |
|
| 41 |
|
| 42 |
3. BUILD on Win/DOS |
| 43 |
=================== |
| 44 |
A. For assembling of e3 you need NASM assembler nasm-0.99.05 |
| 45 |
and ALINK (Anthony's Linker) and Win32 Import Library (win32.lib) |
| 46 |
Both are available for free on the net. |
| 47 |
|
| 48 |
B. Type 'make' , i.e. run make.bat, and move e3.exe, e3-16.com |
| 49 |
and e3*.bat wherever you want. |
| 50 |
|
| 51 |
C. Optional: some more editable options are on top of e3.h: |
| 52 |
for example, if you don't like WS mode, choice an other default mode |
| 53 |
by setting DEFAULT_MODE to one of EM, NE, PI or VI . In this |
| 54 |
case you would not need to call one of the batches to run |
| 55 |
your favourite mode. |
| 56 |
|
| 57 |
|
| 58 |
4. BASIC USAGE |
| 59 |
============== |
| 60 |
* All versions of e3 accept a filename as argument; see the man page. |
| 61 |
|
| 62 |
* There is a status and input line, where you can enter filenames, |
| 63 |
find-texts, line numbers etc. In the lower right corner you will find |
| 64 |
a code like "WS" showing the selected editor mode and a help |
| 65 |
pointer (EXCEPT vi). |
| 66 |
|
| 67 |
* e3 changes the appearance of the cursor (to reverse) depending on |
| 68 |
insert/overwrite mode (on Linux text console only). |
| 69 |
|
| 70 |
* For details on key bindings read each e3xx's initial page or |
| 71 |
type Alt-H during edit (for vi use ESC:h). |
| 72 |
|
| 73 |
* On some computers (BeOS, QNX etc.) Alt-key combinations won't work: |
| 74 |
press <ESC> followed by the key, e.g. press ESC and H instead of Alt-H. |
| 75 |
|
| 76 |
* e3 shows a dot for characters below ASCII 20h and greater 7Fh |
| 77 |
(except on win9x and except on UTF-8 version). |
| 78 |
|
| 79 |
* At the end of an edit cycle, e3 asks you something like "SAVE? Ynl". Press |
| 80 |
"n" to NOT save, "l" for SAVE and LOAD new, any other for SAVE and EXIT. |
| 81 |
|
| 82 |
|
| 83 |
5. ARITHMETICS |
| 84 |
============== |
| 85 |
You can do some simple arithmetic calculations inside your text. |
| 86 |
For example: |
| 87 |
1234+56*78= |
| 88 |
place cursor here^ and press one of: |
| 89 |
|
| 90 |
^KN for WSTAR mode |
| 91 |
^QC for PICO mode |
| 92 |
^X^N for EMACS mode |
| 93 |
# for VI command mode |
| 94 |
^K for NEDIT mode |
| 95 |
This should insert the result of 5602 into text. |
| 96 |
|
| 97 |
|
| 98 |
Use values -999999999999.999999 ... -0.000001, 0, 0.000001 up to |
| 99 |
999999999999.999999 and operators +-*/ and ( ) . |
| 100 |
|
| 101 |
Some more examples: |
| 102 |
2+4*8=34 |
| 103 |
2/3*3=2 |
| 104 |
-4*-3--5*-4=-8 |
| 105 |
4-3--4-3=2 |
| 106 |
-5*-(13+-2*(3+4))+2=-3 |
| 107 |
(7*(((((6+2+(((((1)))))))))))=63 |
| 108 |
(13120-9972)/9972=0.315684 |
| 109 |
100000000+0.000001=100000000.000001 |
| 110 |
10000000000+1=10000000001 |
| 111 |
1+1*2*3*4*5*6*7*8*9*10=3628801 |
| 112 |
7.627891*2.643189=20.161958 |
| 113 |
10000000000/8=1250000000 |
| 114 |
|
| 115 |
Some problems: |
| 116 |
100000000000+1.00001=99999997953.00001 <--loss of precision! |
| 117 |
8/0= <--not possible. You know. |
| 118 |
(e3 says "beep") |
| 119 |
100000000*100000000= <--overflow |
| 120 |
|
| 121 |
Two specials: |
| 122 |
12*p=37.699112 <--p is PI 3.14..... |
| 123 |
r+20=57.699112 <--r is result of last calculation |
| 124 |
|
| 125 |
This arithmetic calculator is the smallest and simplest I could write. |
| 126 |
It takes only some hundred byte in the executable because it does NOT use |
| 127 |
precise BCD arithmetics, but built in x87-coprocessor features. So please |
| 128 |
do NOT expect very high precision. |
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
6. MIXED HINTS |
| 133 |
============== |
| 134 |
* The emacs-mode version has currently a kill buffer but no kill ring, |
| 135 |
so be careful about that. I'm sure, inside some 1000 byte you won't |
| 136 |
expect a complete Emacs key set, but IMHO you get the most important part. |
| 137 |
|
| 138 |
* The Pico mode is both: extended and incomplete compared to some Pico options, |
| 139 |
new are some ^J (delete) and ^Q (quick_move) keys. |
| 140 |
|
| 141 |
* The win9x version does no accept any filename on the command line if this |
| 142 |
filename contains blank spaces. |
| 143 |
|
| 144 |
* You can choose inside the edit session (w/o leaving e3) between the |
| 145 |
different edit modes, for example: |
| 146 |
-start e3em <filename> |
| 147 |
---> now using Emacs style keys. |
| 148 |
-type altX |
| 149 |
-type e3vi |
| 150 |
---> welcome in the land of vi! |
| 151 |
-type <ESC>; |
| 152 |
-type e3ws |
| 153 |
---> you are entering Wordstar emulation sector! |
| 154 |
....etc.... |
| 155 |
This VERY hot keys are ^KM (for WS), ^QM (for Pico), altX (for Emacs), |
| 156 |
^E (for Nedit) and <ESC>; (for vi-mode). |
| 157 |
|
| 158 |
Note: on some computers press ESC X instead of altX. |
| 159 |
|
| 160 |
* Everytime if e3vi does not recognize a vi-mode ex command, e3vi will pipe |
| 161 |
the whole editor text buffer through /bin/sed or /bin/ex. I.e. you can use |
| 162 |
pure sed or ex commands like: |
| 163 |
1,6 s/foo/bar/ |
| 164 |
2,$ d |
| 165 |
8,$ w filecopy |
| 166 |
/remove_me/d |
| 167 |
***TAKE CARE***: "sed" or "ex" won't know your current cursor position in e3! |
| 168 |
What call to subprogram (either ex or sed) is compiled in |
| 169 |
you can find in helptext: |
| 170 |
"pipe buffer through /bin/sed" |
| 171 |
vs. |
| 172 |
"pipe buffer through /bin/ex" |
| 173 |
You should know this because the syntax is not equal: |
| 174 |
s/./\./ <--sed syntax |
| 175 |
1,$ s/./\./g <-- ex syntax |
| 176 |
Also you should know what "sed" version you have installed, |
| 177 |
because sed 2.x and sed 3.x are quite different. |
| 178 |
You can use this new buffer pipe features also from WS-, Pico- and Emacs modes |
| 179 |
by pressing ^KP (Wordstar), or ^JP (Pico), or ^X^P (Emacs). |
| 180 |
|
| 181 |
* There is no predefined UNDO level count. You can expect to UNDO at least |
| 182 |
one last insert-, delete-, overwrite- or sed_pipe-operation, but in most |
| 183 |
cases there are lots of UNDO stages available. e3 has a fixed size undo buffer |
| 184 |
and will use an external helper file if some deleted data is bigger sized |
| 185 |
than the undo buffer. This buffer is organized as a ring, overwriting |
| 186 |
older UNDO information if neccessary. So one never can say exactly |
| 187 |
how many UNDO operations are possible. |
| 188 |
For using the UNDO press one of: |
| 189 |
^U for WSTAR mode |
| 190 |
^QU for PICO mode |
| 191 |
^_ for EMACS mode |
| 192 |
u for VI command mode |
| 193 |
^U for NEDIT mode |