Update 2024 Nov 14: gemacs was made module compatible. It can be installed with, for example (using go1.23.3 or later):
go install github.com/glycerine/gemacs@latest
That said, I don't have time to maintain or add features to gemacs. You probably want an editor that is actively maintained, such as https://micro-editor.github.io/ Notice also our open bug about Ctrl-z (and pasting more than 11 characters from the terminal) which we don't know how to fix #4 ... Also it uses an antiquated and hacked up version of tcell.
Now back to our regularly scheduled README...
gemacs is derived from godit, https://github.com/nsf/godit,
and adapted to use https://github.com/gdamore/tcell for portability.
Terminal based, it works anywhere.
In addition to using tcell, release v1.0 improves
upon godit by: (a) improving file auto-completion with tab and enter;
(b) Ctrl-x Ctr-w does write file, as in traditional emacs -- now
view operations is rebound to Ctrl-x Ctrl-v; (c) Ctrl-x o cycles
through all visible views.
Extensibility being the hallmark of emacsen, gemacs
gets its extensibility by being both small and written in Go.
The fast compilation, superior typechecking, and sparse
design of Go mean that extensibility is actually improved
compared to the awkward two language approach. Two languages
were needed in the time of C with its slow compilation, but that time
has passed. Keeping with the Go philosophy of minimalism and simplicity,
there are no plans to add an embedded scripting language
to gemacs. Being MIT licensed, you are welcome to
fork and derive from it however you like, of course.
A description translated from the godit readme:
Gemacs is an emacs-ish lightweight text editor.
Gemacs uses many of the emacs key
bindings and operates using a notion of "micromodes". It's easier to explain
what a micromode is by a simple example. Let's take the keyboard macros feature
from both emacs and gemacs. You can start recording a macro using C-x ( key
combination and then when you're ready to start repeating it, you do the
following: C-x e (e...). Not only C-x e ends the recording of a macro, it
executes the macro once and enters a micromode, where typing e again, will
repeat that action. But as soon as some other key was pressed you quit this
micromode and everything is back to normal again. The idea of micromode is used
in gemacs a lot.
Basic things:
C-g - Universal cancel button
C-x C-c - Quit from the gemacs
C-x C-s - Save file [prompt maybe]
C-x S - Save file (raw) [prompt maybe]
C-x M-s - Save file as [prompt]
C-x M-S - Save file as (raw) [prompt]
C-x C-w - Save file as (raw) [prompt] *
C-x C-f - Open file
M-g - Go to line [prompt]
C-_ - Undo
C-x C-_ (C-_...) - Redo
View/buffer operations:
C-x C-v - View operations mode *
C-x 0 - Kill active view
C-x 1 - Kill all views but active
C-x 2 - Split active view vertically
C-x 3 - Split active view horizontally
C-x o - Cycle through views
C-x b - Switch buffer in the active view [prompt]
C-x k - Kill buffer in the active view
View operations mode:
v - Split active view vertically
h - Split active view horizontally
k - Kill active view
C-f, <right> - Expand/shrink active view to the right
C-b, <left> - Expand/shrink active view to the left
C-n, <down> - Expand/shrink active view to the bottom
C-p, <up> - Expand/shrink active view to the top
1, 2, 3, 4, ... - Select view
Cursor/view movement and text editing:
C-f, <right> - Move cursor one character forward
M-f - Move cursor one word forward
C-b, <left> - Move cursor one character backward
M-b - Move cursor one word backward
C-n, <down> - Move cursor to the next line
C-p, <up> - Move cursor to the previous line
C-e, <end> - Move cursor to the end of line
C-a, <home> - Move cursor to the beginning of the line
C-v, <pgdn> - Move view forward (half of the screen)
M-v, <pgup> - Move view backward (half of the screen)
C-l - Center view on line containing cursor
C-s - Search forward [interactive prompt]
C-r - Search backward [interactive prompt]
C-j - Insert a newline character and autoindent
<enter> - Insert a newline character
<backspace> - Delete one character backwards
C-d, <delete> - Delete one character in-place
M-d - Kill word
M-<backspace> - Kill word backwards
C-k - Kill line
M-u - Convert the following word to upper case
M-l - Convert the following word to lower case
M-c - Capitalize the following word
<any other key> - Insert character
Mark and region operations:
C-<space> - Set mark
C-x C-x - Swap cursor and mark locations
C-x > (>...) - Indent region (lines between the cursor and the mark)
C-x < (<...) - Deindent region (lines between the cursor and the mark)
C-x C-r - Search & replace (within region) [prompt]
C-x C-u - Convert the region to upper case
C-x C-l - Convert the region to lower case
C-w - Kill region (between the cursor and the mark)
M-w - Copy region (between the cursor and the mark)
C-y - Yank (aka Paste) previously killed/copied text
M-q - Fill region (lines between the cursor and the mark) [prompt]
Advanced:
M-_ - Local words autocompletion
C-x C-a - Invoke buffer specific autocompletion menu [menu]
C-x ( - Start keyboard macro recording
C-x ) - Stop keyboard macro recording
C-x e (e...) - Stop keyboard macro recording and execute it
C-x = - Info about character under the cursor
C-x ! - Filter region through an external command [prompt]
License: MIT License.