hermes/hermes.1

128 lines
3.2 KiB
Groff

.TH "hermes" 1 "01 JAN 2020" "" "General Operation Manual"
.SH NAME
\fBhermes\fP
.SH SYNOPSIS
.nf
.fam C
\fBhermes\fP [\fBfilepath\fP]
.fam T
.fi
.SH DESCRIPTION
\fBhermes\fP is a minimalist modal text editor with support for some vi-like key commands. \fBhermes\fP supports basic syntax highlighting and filetype detection.
.SH USAGE
Most of the key bindings that follow are only available in command mode (the exceptions being any Ctrl based key combinations, the arrow keys, home, and end). In addition to the listed keys, while in command mode you may enter numbers that will modify the following action keys in some way. For example 10w would move the cursor forward 10 words. 10<enter> would move the cursor to the 10th row of the file. The d key is also special, as it modifies a key that follows it. For example 10dw would delete the next ten words.
.TP
.B
a
Go from command mode to input mode after the current character.
.TP
.B
<Ctrl-a>
Save as. Like save, but will query for a new filename.
.TP
.B
b
Move to the beginning of the previous word.
.TP
.B
d
Delete. Used as a leader key that is followed by another command (ex. dw to delete until the next word). When used twice in a row, deletes the current line.
.TP
.B
<Ctrl-d> or <PgDn>
Move down one visual page worth of rows.
.TP
.B
e
Move cursor to the end of the current word, or the next word if cursor is currently on a whitespace character.
.TP
.B
<enter>
If there is a numerical value in the command buffer then pressing enter will move the cursor to the row represented by that value (ex. 15<enter> would move the cursor to row 15).
.TP
.B
<escape>
Go from input mode to command mode.
.TP
.B
g
Move cursor to the beginning of the document.
.TP
.B
G
Move cursor to the end of the document.
.TP
.B
h or left arrow
Move one character to the left.
.TP
.B
i
Enter input mode. While in input mode all keys are taken literally and entered into the document. Ctrl key commands still work as normal. Press escape to go back to command mode.
.TP
.B
j or <down arrow>
Move cursor one row down.
.TP
.B
k or< up arrow>
Move cursor one row up.
.TP
.B
l or <right arrow>
Move cursor one character to the right.
.TP
.B
o
Add a row below the current row and enter input mode with the cursor on the new row.
.TP
.B
O
Add a row above the current row and enter input mode with the cursor on the new row.
.TP
.B
r
Replace the character under the cursor with the next character typed.
.TP
.B
<Ctrl-q>
Quit \fBhermes\fP.
.TP
.B
<Ctrl-s>
Save the current document. Will query for filename if there is no current filename.
.TP
.B
<Ctrl-u> or <PgUp>
Move up one visual page worth of rows.
.TP
.B
w
Move cursor to the beginning of the next word.
.TP
.B
x
Delete the character at the current cursor location.
.TP
.B
$ or end
Move cursor toathe end of the current row.
.TP
.B
^ or home
Move cusror to the beginning of the current row.
.SH BUGS
There are very likely bugs.
.SH LINKS
\fBhermes\fP maintains a presence in the following locations:
.TP
.B
Source Code Repository
https://tildegit.org/sloum/hermes
.TP
.B
Gopher Homepage
gopher://colorfield.space/1/hermes/
.SH AUTHORS
\fBhermes\fP is based on \fBkilo\fP by Salvatore Sanfilippo (aka antirez) and acquired via a code walkthrough by Pailey Quilts. The bits not by either of those authors are by sloum.