============================
Kaa - console text editor
Kaa is a small and easy text editor for console environment.
.. DANGER:: Kaa is still in the very early stage of the development. Don't use kaa for other purpose than evaluation.
.. contents::
Requirements
-
Python 3.3 or later
-
Headers and libraries for ncurses with wide character support. Consult documentation of your platform for details. For Debian/Ubuntu, you can install ncurses library by ::
$ sudo apt-get install libncurses5 libncurses5-dev libncursesw5 libncursesw5-dev
-
UTF-8 locales
-
(optional) Cython
Installation
-
Get source from github ::
$ git clone https://github.com/kaaedit/kaa.git
-
Install kaa ::
$ cd kaa $ python3.3 setup.py install
Command line options
To start kaa, type ::
$ kaa [FILE]...
Usage
Using kaa is intuitive. Typing alphabet keys will update file as you expected. Functional keys like arrow or delete keys also works.
Using menu
To display menu, type F1 key or alt+/ (type slash key with alt key). Each items in the menu has one underlined character. The menu item is execused by typing the underlined key.
Typing escape key hides menu.
File menu ++++++++++
New Create new file.
Open Open existing file.
File info Show file information. Also update per file editor settings of tab/indentation.
Save Save current file.
Save As Save current file as new file.
Close Close current frame.
Quit Terminate kaa.
Edit menu +++++++++
Cut Cut selected text.
Copy Copy selected text.
Paste Paste from clipboard.
Undo Undo last modification.
Redo Redo last undo.
Convert Show text convert menu
Text convert menu
Upper
Convert selected text to upper case.
Lower
Convert selected text to lower case.
Normalization
Convert selected text to Unicode Normalization Forms(NFKC).
Full-width
Convert alphabet and numbers in the selected text to full-width character.
Macro menu
++++++++++
Start record
Start macro recording.
End record
End macro recording.
Run macro
Run last macro.
Tools menu
++++++++++
Paste lines
Insert lines of text without auto indentation.
Shell command
Execute external shell command and insert the output.
Window menu
+++++++++++
Frame list
Show list of frame windows. Use left/right arrow key to change active frame.
Split vert
Split current window vertically.
Split horz
Split current window horizontally.
Move separator
Move window separator. Use left/right arrow key to move separator.
Next window
Activate next window.
Join window
Join splitted window.
Switch file
Switch content of active window.
Key bindings
------------
Input mode
+++++++++++
Escape
Enter command mode.
F1, alt+/
Show menu.
Arrow keys(up, down, left, right)
Move cursor.
Shift+arrow keys
Select text.
Control+left/right arrow keys
Move cursor to next/prev word boundary.
Control+b, Control+f, Control+p, Control+n
Move cursor to left/right/up/down.
Alt+b, Alt+f
Move cursor to next/prev word boundary.
Control+v, Alt+v
Page down/up
Home, Shift+Home
Move cursor to top of line. Shift+Home selects text to top of line.
End, Shift+End
Move cursor to end of line. Shift+Home selects text to end of line.
Control+Home, Control+Shift+Home
Move cursor to top of file. Control+Shift+Home selects text to top of file.
Control+End, Control+Shift+End.
Move cursor to end of file. Control+Shift+End selects text to end of file.
Backspace, Control+h
Delete the character to the left.
Delete, Control+d
Delete the character at the cursor.
Control+backspace, Alt+h
Delete the word to the left.
Control+Delete, Alt+d
Delete the word to the right.
Control+k
Delete the line to the right.
Alt+k
Delete the current line.
Control+y
Paste selection
Control+w
Cut selection
Alt+w
Copy selection
Control+u
Undo last change.
Alt+u
Redo last undo.
F6
Toggle macro recording on/off.
F5
Run macro.
Alt+.
Run last execused edit command again.
Control+s
Search text.
Alt+s
Replace text.
Tab, Shift+Tab
Indent/dedent selection
Alt-M v
Show text conversion menu.
Ctrl+u Alt+!
Execute command and insert the output.
Customization
==================
Kaa executes a Python script file at `~/.kaa/__kaa__.py` on startup. You can write Python script to customize Kaa as you like.
Sample - Show line numbers
----------------------------------
.. code:: python
from kaa.filetype.default import defaultmode
defaultmode.DefaultMode.SHOW_LINENO = True
`defaultmode.DefaultMode` is base class of all text file types. Line number is diplayed if `Defaultmode.SHOW_LINENO` is True. If you want to show line number of paticular file types, you can update SHOW_LINENO attribute of each file type classes.
.. code:: python
# Show line number in HTML mode
from kaa.filetype.html import htmlmode
htmlmode.HTMLMode.SHOW_LINENO = True
Sample - Customize key binding
----------------------------------
Assign same keyboard shortcut of splitting windows command as Emacs.
.. code:: python
from kaa.keyboard import *
from kaa.filetype.default.defaultmode import DefaultMode
DefaultMode.KEY_BINDS.append({
((ctrl, 'x'), '2'): 'editor.splithorz' # Assign C-x 2
})
In this example, key sequence C-x 2 (control+x followed by 2) is assigned to 'editor.splithorz' command.
Copyright
=========================
Copyright (c) 2013 Atsuo Ishimoto
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.