Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Documentation/Readme.md and add documentation for Kilo #633

Merged
merged 1 commit into from
May 15, 2020
Merged

Update Documentation/Readme.md and add documentation for Kilo #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Documentation/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
133 changes: 133 additions & 0 deletions Documentation/html/user/kilo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<title></title>
<meta name="generator" content="LibreOffice 6.3.3.2.0 (Linux)"/>
<meta name="created" content="2020-05-12T00:00:00.021243300"/>
<meta name="changed" content="2020-05-15T22:05:38.407556227"/>
<style type="text/css">
@page { size: 21cm 29.7cm; margin: 2cm }
p { margin-bottom: 0.25cm; background: transparent; line-height: 115%; background: transparent }
h3 { margin-top: 0.25cm; margin-bottom: 0.21cm; background: transparent; background: transparent; page-break-after: avoid }
h3.western { font-family: "Liberation Serif", serif; font-size: 14pt; font-weight: bold }
h3.cjk { font-family: "SimSun"; font-size: 14pt; font-weight: bold }
h3.ctl { font-family: "Lucida Sans"; font-size: 14pt; font-weight: bold }
td p { background: transparent; background: transparent }
code { font-family: "Liberation Mono", monospace }
a:link { color: #000080; so-language: zxx; text-decoration: underline }
a:visited { color: #800000; so-language: zxx; text-decoration: underline }
</style>
</head>
<body lang="de-DE" link="#000080" vlink="#800000" dir="ltr"><p align="center">
<br/>
<br/>

</p>
<table width="643" cellpadding="4" cellspacing="0">
<col width="635"/>

<tr>
<td width="635" valign="top" style="border: none; padding: 0cm"><p align="center" style="margin-bottom: 0.5cm">
<font face="Arial, sans-serif"><font size="5" style="font-size: 18pt"><b>The
Kilo editor</b></font></font></p>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">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 </font><code><font face="Arial, sans-serif">vi</font></code>
<font face="Arial, sans-serif">or </font><code><font face="Arial, sans-serif">emacs</font></code>
<font face="Arial, sans-serif">commands non-intuitive. </font>
</p>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">Unlike
</font><code><font face="Arial, sans-serif">vi</font></code><font face="Arial, sans-serif">,
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.</font> <font face="Arial, sans-serif">The
most important commands available are displayed in a status line
at the bottom of the terminal window. </font>
</p>
<h3 class="western"><font face="Arial, sans-serif">Opening and
Creating Files </font>
</h3>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">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. </font>
</p>
<h3 class="western"><img src="../../img/kilo.png" name="Bild1" align="left" width="635" height="407" border="0"/>
<font face="Arial, sans-serif">Search
Text</font></h3>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">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.</font></p>
<h3 class="western"><a name="save"></a><font face="Arial, sans-serif">Save</font></h3>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">To
save your work, use CTRL+s. This will save the document and leave
kilo open for you to continue working.</font></p>
<h3 class="western"><a name="exit"></a><font face="Arial, sans-serif">Exit</font></h3>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">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.</font></p>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">A
screencast is available here:
<a href="https://asciinema.org/a/90r2i9bq8po03nazhqtsifksb">https://asciinema.org/a/90r2i9bq8po03nazhqtsifksb</a></font></p>
<h3 class="western"><font face="Arial, sans-serif">Development</font></h3>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">Kilo
does not depend on any library (not even curses). It uses fairly
standard VT100 (and similar terminals) escape sequences. </font>
</p>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">Kilo
was written by Salvatore Sanfilippo aka antirez and is released
under the BSD 2 clause license. It is available on GitHub:
<a href="https://github.com/antirez/kilo">https://github.com/antirez/kilo</a>
Here is a blog post by Salvatore Sanfilippo about the development
of kilo: <a href="http://antirez.com/news/108">http://antirez.com/news/108</a></font></p>
<p style="margin-bottom: 0.5cm"><font face="Arial, sans-serif">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:<br/>
<a href="https://viewsourcecode.org/snaptoken/kilo/">https://viewsourcecode.org/snaptoken/kilo/</a><br/>
<a href="https://web.archive.org/web/20200122083220/https://viewsourcecode.org/snaptoken/kilo/">https://web.archive.org/web/20200122083220/https://viewsourcecode.org/snaptoken/kilo/</a><br/>
Also
the openemacs editor is based on Kilo.</font></p>
<h3 class="western"><font face="Arial, sans-serif">ELKS port of
Kilo</font></h3>
<p><font face="Arial, sans-serif">Greg Haerr ported Kilo to ELKS.
Here are notes from his original commit:<br/>
<br/>
Runs on
console and serial port with terminal emulator.<br/>
Fix ANSI
color display on console. (ESC [ 30-47 m ] )<br/>
Fix ANSI delayed
column 80 auto-wrap on console.<br/>
Fix low-level keyboard CR -&gt;
LF conversion bug.<br/>
Send ANSI escape sequences for console
Home, End, PgUp, PgDn keys.<br/>
Add /etc/termcap entries for
above keys to allow </font><code><font face="Arial, sans-serif">vi</font></code>
<font face="Arial, sans-serif">to use them.<br/>
Add </font><code><font face="Arial, sans-serif">getline</font></code>
<font face="Arial, sans-serif">and </font><code><font face="Arial, sans-serif">getdelim</font></code>
<font face="Arial, sans-serif">stdio libc routines.<br/>
Plus
fixed a bug with the delete key.<br/>
<br/>
15th of May 2020 Georg
Potthast</font></p>
</td>
</tr>
</table>
<p><br/>
<br/>

</p>
</body>
</html>
Binary file added Documentation/img/kilo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions Documentation/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ <h2 class="western">User guide</h2>
<li><p style="margin-bottom: 0cm"><a href="html/user/cron.html">The
cron job scheduler</a>
</p>
<li><p style="margin-bottom: 0cm"><a href="html/user/kilo.html">The
Kilo editor</a>
</p>
<li><p style="margin-bottom: 0cm"><a href="html/user/writing_apps_in_C.html">Writing
applications for ELKS in C</a>
</p>
Expand Down