39 lines
2.4 KiB
Markdown
39 lines
2.4 KiB
Markdown
# chalk - a line based text editor
|
|
|
|
Chalk is a line based text editor for the terminal. It was originally an integrated part of _colorsh_, a custom shell used for ssh accounts at [Colorfield Space](gopher://colorfield.space:70/). This repo adds features and develops it into a more full and usable application.
|
|
|
|
I tend to think about chalk as a simpler ed, similar to how some people use nano as simpler terminal editor than vi. It is far less powerful than ed, but functions in a similar line by line style with easy commands that walk you through the actions you are wanting to perform.
|
|
|
|
|
|
## Requirements
|
|
|
|
Requires Python 3.6+. No other Python dependencies, standard library only.
|
|
Copy the file `chalk` to anywhere on your system path and make sure it is executable. Then just run `chalk [path to file]`.
|
|
|
|
|
|
## Commands
|
|
|
|
Commands are entered as the only text on their row. Enter the command and press enter.
|
|
|
|
| Command | Action |
|
|
|:-------:|:------------------------------------------------------------------------------:|
|
|
| !? | Print the command list |
|
|
| !g | Print the GUIDE (ruler) |
|
|
| !d | DISPLAY the whole file |
|
|
| !v | VIEW a portion of the file |
|
|
| !# | EDIT a line (eg. "!23" to edit line 23) |
|
|
| !i | INSERT blank rows (will prompt for location and count) |
|
|
| !x | CUT rows (will prompt for range and then add the cut data to the paste buffer) |
|
|
| !c | COPY rows to the paste buffer (will prompt for range) |
|
|
| !p | PASTE from the paste buffer (will prompt for location) |
|
|
| !b | Print the contents of the paste BUFFER |
|
|
| !s | SAVE any unsaved changes to the document |
|
|
| !a | Save AS (will prompt for new path) |
|
|
| . | Quit chalk (will prompt for save if there are unsaved changes) |
|
|
|
|
|
|
## Notes
|
|
|
|
This application uses the python readline bindings to allow for hotkey line navigation (ex. Ctrl-a to go to the beginning of the line).
|
|
|