ANNOUNCE: cle-0.3 a Command Line Editor

From: Erick Gallesio <Erick.Gallesio_at_unice.fr>
Date: Thu, 21 Oct 1999 00:00:39 +0200 (CEST)

This is the announce of cle-0.3 a small command line editor which can be
useful when using STk in a n xterm. It provides the
editing/history/completion of the GNU readline package to any
line-oriented Unix command (and hence stk). To add editing commands to
STk. Just type,
     $ cle stk
et voila.

You can download cle from kaolin.unice.fr and I have also place it on
sunsite/metalab. Since this is the first release I'm not sure to its
definitive place on sunsite.

cle is far from perfect but I hope that you'll like it. Tell me what
you think of this approach rather than integrating readline inside of
STk as it was asked before here.

Hereafter is the complete README of the package.


                                CLE 0.3

PURPOSE
-------

Cle is a Command Line Editor. It provides the editing/history/completion
of the GNU readline package to any line-oriented Unix command.
For instance,

        $ cle ftp foo.bar.org

adds editing/history/completion commands to the ftp command.

Since most modern shells allow you to define aliases, you can define
a simple alias such as
        $ alias ftp="cle \ftp" (bash or zsh syntax)
or
        $ alias ftp cle ftp (tcsh or csh syntax)
to always uses cle with the ftp command.

BUILD
-----

To build cle, run the following commands

        $ configure; make; make install

configure accepts only one non-generic parameter: "--with-curses".

Using this parameter allows to build the readline library with curses
instead of termcap. A list of the generic configure parameters can be found
in the INSTALL file.

INITIALIZATION FILES
--------------------

Since cle uses the readline package, it can be customized by the file
"~/.inputrc". When cle is run it initializes the readline package and
gives it the name of the application it controls. This can be used to
define different bindings for different commands. An example is given
below:

        $if ftp
        "\C-xl": "dir\C-m"
        $endif
        $if stk
        "\C-xl": "(system \"ls -ls\")\C-m"
        $endif
        $if ed
        "\C-xl": "!ls -l\C-m"
        $endif

See the file "etc/sample-inputrc" file for a more complete example.
See also standard readline documentation package for details on the
available "bindable" functions and on the format of this file.

When a cle'ed application leaves, the state of the history is saved in
a file whose name is ~/.XXX-history, where XXX is the name of the
application. The history size defaults to 100 lines but it can be
changed by the --size option of cle. See cle(1) for more details.


PARENTHESIS FLASHING
--------------------

The readline version compiled with cle uses parentheses flashing
(i.e when you type a closing parenthesis, the corresponding opening
parenthesis flashes). Rebind the closing parentheses is with
"self-insert" to get rid of this feature.
Example:
         $if ftp
         ")": self-insert
         "]": self-insert
         "}": self-insert
         $end

RELATED PACKAGES
----------------

ILE and FEP are two similar packages which also provide command line
editing. These packages don't seem to be maintained anymore and their
command line editing functions are less extensive than those provided
by the readline package.

DISTRIBUTION
------------

Cle is distributed under the terms of the GPL (see file COPYING for
license terms) and is available from http://kaolin.unice.fr/Cle


                -- Erick
Received on Thu Oct 21 1999 - 00:00:07 CEST

This archive was generated by hypermail 2.3.0 : Mon Jul 21 2014 - 19:38:59 CEST