ElScreen-GF 1.4.0 README file

This is the distribution of ElScreen-GF 1.4.0, released November 2005.
It is an Emacs interface to 'GNU id-utils'.  It works inside the
ElScreen environment, and will work only on GNU Emacs 21.3.1 or later.

'GNU id-utils' is language-independent identifier database tool, which
stores tokens, literal numbers, or words of human-readable text.

With ElScreen-GF, you can search keyword, list entries, and jump to
them more easily.  It will help you to hack source codes.  Enjoy!


Files
-----
This package should contain the following files:

    elscreen-gf.el          ElScreen-GF version 1.4.0 main file
    read-directory-name.el  read-directory-name function, only for
                            GNU Emacs 21.3.1 or earlier (21.3.50
                            or later has its own function).
			    borrowed from GNU Emacs 21.3.50.
    README                  Introduction to ElScreen-GF 1.4.0
                            (this file)
    QuickStart              Quick Start Guide


Installation
------------
To use ElScreen-GF, install ElScreen and GNU id-utils, put
elscreen-gf.el (and read-directory-name.el if your Emacssen does not
have its own function) in this directory to your load-path, and put
following line just next to ElScreen entry:

(load "elscreen-gf" "ElScreen-GF" t)


Usage
-----
The following sequences may valid on ElScreen:

    C-z C-g         ElScreen-GF prefix key
    C-z C-g G       Run grep
    C-z C-g g       Run gid
    C-z C-g m       Run mkid
    C-z C-g v       Show ElScreen-GF version

In addition, you may use following keys in ElScreen-GF mode:

    n               Move the current entry vertically down
    p               Move the current entry vertically up
    SPC             Scroll entries upward full screen
    DEL             Scroll entries downward full screen
    <               Move the current entry to the beginning of the
                    entries
    >               Move the current entry to the end of the entries
    N               Move the current entry to the next file
    P               Move the current entry to the previous file
    t               Toggle truncated lines
    o               Jump to the current entry
    v               Show ElScreen-GF version


Setup
-----
You can set the following variables to configure ElScreen-GF.  These
can be set in .emacs (or .emacs.d/init.el) file directly or "Options"
in your menu bar.

    elscreen-gf-truncate-lines

        If non nil, each line of result in the ElScreen-GF mode is
        truncated by default.  The default value is `t'.

    elscreen-gf-selected-entry-face

        Face used for the selected entry in ElScreen-GF mode.

    elscreen-gf-filename-face

        Face used for filename in ElScreen-GF mode.

    elscreen-gf-line-number-face

        Face used for line number in ElScreen-GF mode.

    elscreen-gf-pattern-face

        Face used to emphasize the specified keyword in ElScreen-GF mode.

    elscreen-gf-emphasis-after-jump-face

        Face used to emphasize the selected line after jump.


Where Can I Get ElScreen-GF?
----------------------------
ElScreen-GF (and ElScreen) is available from the following anonymous
ftp site.

       ftp://ftp.morishima.net/pub/morishima.net/naoto/ElScreen/


Bug Reports
-----------
ElScreen-GF is maintained by Naoto Morishima.  Please mail bug
reports and any comments to:

       naoto@morishima.net
