Back to files

Yet Another Easy Editor

README

fix release 0.7.6

February 26th, 2004

TABLE OF CONTENTS

        General
        Licensing and copying
        Goal
        Missing/incomplete features
        Installing from source
        Running yaee
        Default keys
        Nice features (tips)

GENERAL

        Yaee is a simple general purpose text editor for POSIX systems.
        roject was started on November 10th, 2002 to create an easy to use
        and efficent general purpose console text editor for UNIX systems.

        Yaee uses ncurses and dialog libraries. Yaee is programmed in POSIX C
        on a FreeBSD-CURRENT system.

        Yaee is available at -=Die LocalWarez=- WWW page (www.dielocalwarez.com)
        in source form. Support can be obtained or by contacting the author
        Markus Niemistö <markus.niemisto@iki.fi>.

LICENSE AND COPYING

        Yaee is released under MIT license and is freely distributable. See
        file COPYING for full license information.

        Included libdialog is licensed under terms of GPL and is not
        modified anyway (except the new Makefile) by the author.

        This software is OSI Certified Open Source Software.
        OSI Certified is a certification mark of the Open Source Initiative.

GOAL

        The goal of yaee is to be an easy to use, fast, portable (standards
        compliant), quite powerful, customizable and extensible (through
        scripts) text editor. Shortly put: to provide an easy alternative for
        vi(m) and emacs.

        Yaee is developed on my spare time and I add features and fix bugs
        as I need or encounter them.

MISSING/INCOMPLETE FEATURES

• Replace is not working
• No menus yet and GUI is still somewhat limited

INSTALLING FROM SOURCE

Source is available as a gzipped tar archive at www.dielocalwarez.com.

yaee-yymmdd.tar.gz

Next you must extract the archive by typing in the command:

tar xvzf yaee-yymmdd.tar.gz

        This creates a directory 'yaee' in current directory. Change into that
        directory and type:

                make distclean
                make depend
                make

        In order to install yaee you must have root priviliges. As root you
        can type:

                make install

        to install yaee. Yaee gets installed in directory $(PREFIX)/bin and
        manual page in $(PREFIX)/man/man1. $(PREFIX) is defined near the top
        of file "Makefile". There are few other system dependant variables
        defined in Makefile but yaee should compile on just about every UNIX
        with no modifications.

RUNNING YAEE

After building and installing yaee it can be run by typing yaee.

DEFAULT KEYS

        F10     Menu
        F5      Redraw
        F4      Settings

        Ctrl-N  New buffer.
        Ctrl-Q  Close buffer.
        F6      Previous buffer.
        F7      Next buffer.
        F8      Buffer list.

        Ctrl-S  Save current buffer.
        Ctrl-O  Load file into current window.

        Ctrl-F  Search.
        Ctrl-R  Replace.
        F3      Search/replace again.

        Ctrl-E  Change ruler type (file and position, position, full file name)

        Ctrl-D  Enter/leave selection mode.
        Ctrl-C  Copy selection.
        Ctrl-X  Cut selection.
        Ctrl-V  Paste from clipboard.

        Ctrl-B  Go to the botton of the buffer.
        Ctrl-T  Go to the top of the buffer.
        Ctrl-G  Jump to the given line.

        Ctrl-Z  Undo

        Cursor keys move cursor, as expected, as do Home, End, PgUp and PgDn.
        Shift-End moves cursor to the end of the previous line and Shift-Home
        moves cursor to the beginning of the next line.

NOTE! That most terminals do not support shifted keys or they are not defined

        in the /etc/termcap file. This file may be a link. Be sure to modify
        original. Required capalities are key_send *7 and key_shome #2. See
        termcap(5).

        To make Shift+End/Home work under XTerm make sure that *7 and #2 are
        defined in termcap file under xterm-basic entry. If not add the line:

                :*7=\E[1;2F:#2=\E[1;2H:\

        to the end of the entry. Make sure the line before this addition ends
        with \. After you have made this change you have to run cap_mkdb in
        the directory in which real termcap file is (/usr/share/misc on
        FreeBSD).

NICE FEATURES (TIPS)

        When you press PgUp it doesn't scroll the view right away. Instead
        it first moves to the first visible line. When cursor is on the
        first line and PgUp is pressed it scrolls the screen. PgDown works
        in the same way.

        When cursor is already in the end of the line, End moves cursor to
        the end of the next line. Shift+End is like end but instead of moving
        down it moves up. Home and Shift+Home works in similiar way.

        A forth scripting support (a bit like eLisp in EMACS) is under
        construction.

NOTE! To be able to use the 'del' key in xterm the DeleteIsDEL

        resource must be set to 'true'. This can be done by
        Control-Clicking the xterm and selecting 'Delete is DEL'
        from the menu or by adding the line "VT100DeleteIsDEL: true"
        to the file ( (XRoot)/lib/X11/app-defaults/XTerm).

        There is known to be problems with END key in xterm.