============================================================================
                  Readme for the Debian Jed packages
============================================================================

Jed is a highly customizable editor for programmers by John E. Davis. It's
small, fast and mighty and extensible in the C-like "S-Lang" language.
Find out more about Jed on its homepage http://www.jedsoft.org/jed/ .

Jed for Debian comes in four packages

  jed          console version of Jed
  xjed         stand-alone X application
               (failsave: falls back to console app if DISPLAY is not set)
  jed-common   Files used by both jed and xjed
  jed-extra    User provided extensions, mainly from http://jedmodes.sf.net/

Jed was debianized by Charl P. Botha and is now maintained by
the Debian JED Group:

  http://pkg-jed.alioth.debian.org/
  email: <pkg-jed-devel@lists.alioth.debian.org>


Particular features of Debian Jed
=================================

Startup scheme
--------------

Debian Jed's startup scheme provides for startup code from other packages.
Instead of a config file, we use a config directory: At startup, Jed will
evaluate all "*.sl" scripts in /etc/jed.d/. The sysadmin can modify or add
files in /etc/jed.d/ for site-wide configuration.

See README.Debian-startup for details.

Jed_Home_Directory
------------------

Debian Jed supports a per-user "~/.jed/" application directory in accordance
with the file hierarchy standard (FHS 2.3). However, Jed will not create
such a directory. Users are encouraged to create the directory ".jed/" in
their home directory. It will become the `Jed_Home_Directory'
for personal Jed-related files, e.g.

  jed.rc       user startup configuration (move the jed.rc from the
               examples/ here and modify to your needs)

  .jedrecent   last opened files (autogenerated by recent.sl)

  lib/         library of personal extension scripts (home-made or
  	       downloaded) and customised versions of standard scripts

               To use this library dir, you need to add it to the
               jed library path in jed.rc with e.g.::

                 set_jed_library_path(path_concat(Jed_Home_Directory, "lib")
                                     + "," + get_jed_library_path()

               or (with jed-extra installed)::

	         add_libdir(path_concat(Jed_Home_Directory, "lib"));

	       You can use it also for DFA highlight cache files setting::

	         Jed_Highlight_Cache_Dir = path_concat(Jed_Home_Directory, "lib");


  templates/   optional dir for templates (with jed-extra)

Default binding for the backquote (`) key
-----------------------------------------

By default, JED binds the backquote key to the quoted_insert command.
This is confusing for new users, who do not know how to configure JED.
At any rate, in Debian, JED starts in Emacs emulation, in which the
quoted_insert function is bound to ^Q. In Debian, the backquote key
simply inserts a backquote character, by default.

In order to restore the original behavior, users can put the following
code in their ~/.jedrc:

    setkey ("quoted_insert", "`");

Some frequently asked questions
===============================

(see also txt/jed_faq.txt)

Q: My color settings are not working. What's wrong?
A: If you're using set_color() calls without loading a pre-defined scheme
   with set_color_scheme(), Jed falls back to the _Jed_Default_Color_Scheme.
   To fix your problem, you can set _Jed_Color_Scheme, like
   _Jed_Color_Scheme = "cool".

.. Copyright © 2006 the Debian JED Group
   Released under the terms of the GNU General Public License (ver. 2 or later)

   Last update 2021-09-26 Rafael Laboissière
