diff --git a/Documentation/Readme.md b/Documentation/Readme.md index 2d3a6bd9a..40793b7a2 100644 --- a/Documentation/Readme.md +++ b/Documentation/Readme.md @@ -13,11 +13,13 @@ This section contains some HOWTOs to help using ELKS. * [ELKS One Page Manual](https://htmlpreview.github.io/?https://github.com/jbruchon/elks/blob/master/Documentation/html/user/ELKS_OPM.html) -* [Shell command line editing and Tab completion](https://raw.githubusercontent.com/jbruchon/elks/master/Documentation/html/user/shell.html) +* [Shell command line editing and Tab completion](https://htmlpreview.github.io/?https://github.com/jbruchon/elks/master/Documentation/html/user/shell.html) -* [The screen window manager](https://raw.githubusercontent.com/jbruchon/elks/master/Documentation/html/user/screen.html) +* [The screen window manager](https://htmlpreview.github.io/?https://github.com/jbruchon/elks/master/Documentation/html/user/screen.html) -* [The cron job scheduler](https://raw.githubusercontent.com/jbruchon/elks/master/Documentation/html/user/cron.html) +* [The cron job scheduler](https://htmlpreview.github.io/?https://github.com/jbruchon/elks/master/Documentation/html/user/cron.html) + +* [The Kilo editor](https://htmlpreview.github.io/?https://github.com/jbruchon/elks/master/Documentation/html/user/kilo.html) * [Writing applications for ELKS in C](https://htmlpreview.github.io/?https://github.com/jbruchon/elks/blob/master/Documentation/html/user/writing_apps_in_C.html) diff --git a/Documentation/html/user/kilo.html b/Documentation/html/user/kilo.html new file mode 100644 index 000000000..e610a7846 --- /dev/null +++ b/Documentation/html/user/kilo.html @@ -0,0 +1,133 @@ + + + + + + + + + + +

+
+
+ +

+ + + + + + +

+ The + Kilo editor

+

Kilo + is is an easy to use command line text editor that is included in + ELKS. Its interface is comparable to GUI-based text editors, which + makes it a good choice for those who find vi + or emacs + commands non-intuitive. +

+

Unlike + vi, + there is no need to enter Edit Mode before inputting text; you can + begin typing as soon as the window opens. Use the arrow keys to + move the cursor. Or use Home and End to set it at the beginning or + end of the current line. You can also use the PageUp or PageDown + keys to move through the file. The + most important commands available are displayed in a status line + at the bottom of the terminal window. +

+

Opening and + Creating Files +

+

To + open an existing file or to create a new file, type kilo followed + by the file name. This opens a new editor window, and you can + start editing the file. +

+

+Search + Text

+

To + search for text in a document, use CTRL+f. This will open a search + prompt where you can enter the search string. Do not press enter, + use the cursor keys to move to the next occurrence of the string + or move back to the previous one. Press ESC to exit the search + function.

+

Save

+

To + save your work, use CTRL+s. This will save the document and leave + kilo open for you to continue working.

+

Exit

+

Use + CTRL+q to exit kilo. If you have not saved your work, you will be + prompted to enter CTRL+q several times to exit.

+

A + screencast is available here: + https://asciinema.org/a/90r2i9bq8po03nazhqtsifksb

+

Development

+

Kilo + does not depend on any library (not even curses). It uses fairly + standard VT100 (and similar terminals) escape sequences. +

+

Kilo + was written by Salvatore Sanfilippo aka antirez and is released + under the BSD 2 clause license. It is available on GitHub: + https://github.com/antirez/kilo + Here is a blog post by Salvatore Sanfilippo about the development + of kilo: http://antirez.com/news/108

+

If + you want to get to know the code of Kilo in detail and develop + additional features for it, here is an extensive tutorial covering + the Kilo + code:
+https://viewsourcecode.org/snaptoken/kilo/
+https://web.archive.org/web/20200122083220/https://viewsourcecode.org/snaptoken/kilo/
+Also + the openemacs editor is based on Kilo.

+

ELKS port of + Kilo

+

Greg Haerr ported Kilo to ELKS. + Here are notes from his original commit:
+
+Runs on + console and serial port with terminal emulator.
+Fix ANSI + color display on console. (ESC [ 30-47 m ] )
+Fix ANSI delayed + column 80 auto-wrap on console.
+Fix low-level keyboard CR -> + LF conversion bug.
+Send ANSI escape sequences for console + Home, End, PgUp, PgDn keys.
+Add /etc/termcap entries for + above keys to allow vi + to use them.
+Add getline + and getdelim + stdio libc routines.
+Plus + fixed a bug with the delete key.
+
+15th of May 2020 Georg + Potthast

+
+


+
+ +

+ + \ No newline at end of file diff --git a/Documentation/img/kilo.png b/Documentation/img/kilo.png new file mode 100644 index 000000000..8999b0ac3 Binary files /dev/null and b/Documentation/img/kilo.png differ diff --git a/Documentation/index.html b/Documentation/index.html index d9ca9a923..eb7b28ff4 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -53,6 +53,9 @@

User guide

  • The cron job scheduler

    +

  • The + Kilo editor +

  • Writing applications for ELKS in C