gomacs.1.in

.\" https://linux.die.net/man/7/groff_mdoc
.Dd $Mdocdate: July 10 2017 $
.Dt GOMACS 1
.Os
.Sh NAME
.Nm gomacs
.Nd emacs-like text editor
.Sh SYNOPSIS
.Nm
.Op Fl dDs
.Op Fl cpuprofile Ns = Ns Ar file
.Op Ar
.Sh DESCRIPTION
.Nm
is an emacs-like text editor. It accepts most of the standard emacs bindings,
and supports a good subset of GNU Emacs commands. The reasoning behind its
creation is a recognition of how emacsen generally do not conform to the
vim-philosophy of leaning on the shell with short editor sessions broken up by
lots of shell editing. In the design and implementation of
.Nm
much care has been taken towards making an editor that performs well in the
terminal while using emacs bindings, having usable defaults, and being as
intuitive as possible.
.Sh OPTIONS
.Pp
.Bl -tag -width xx
.It Fl s
Disable syntax highlighting. Syntax files are still loaded, for major mode
support.
.It Fl d
Enable dumping of crash logs.
.It Fl D
Dump default keybindings to stdout and exit immediately.
.It Fl cpuprofile Ns = Ns Ar file
Write a cpu profile out to given file.
.Sh KEYBINDINGS
These are the default keybindings; they can be overridden (see the
.Sx FILES
section below)
.Pp
.Bl -tag -width xxxxxxxxxxxx -offset indent -compact
<<BINDINGS>>
.El
.Pp
.Sh FILES
.Bl -tag -width ~/.config/japanoise/gomacs/rc.zy -compact
.It Pa ~/.config/japanoise/gomacs/rc.zy
rc file.
.Nm
will execute all lisp code in this file on startup. If XDG_CONFIG_HOME is set,
.Nm
will look there instead of ~/.config for the rc file.
.El
.Sh BUGS
Please report all bugs to me at the upstream repository:
https://github.com/japanoise/gomacs
.Sh AUTHOR
.Nm
by japanoise/chameleon and ixtenu, with a lot of indirect help from Zachary
Yedidia et al (the authors of Micro and highlight) and nsf, the author of
termbox and godit.
.Sh COPYRIGHT
.Nm
is Copyright © 2017-2022 japanoise/chameleon, Copyright 2022 ixtenu, licensed
under the MIT license.