Bug#466486: patches to the doc files

[G. Milde]

On 21.02.08, G. Milde wrote:
> I updated the README files to fix bug 466486, however I can no longer commit
> them (probabely due to the SVN -> git change).

Paul pointed me to an error in my fix to README.Debian so the attached file
should replace the earlier attachment.

> Could someone with write acces commit the attached file?

GM
-------------- next part --------------
============================================================================
                  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 at 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)


ATTENTION: If "~/.jed/" exists, Jed will not find a "~/.jedrc" startup file.
The user needs to move an eventually existing "~/.jedrc" to "~/.jed/jed.rc".


Some frequently asked questions
-------------------------------

(see also txt/jed_faq.txt)

Q: I define keybindings in jed.rc but they are not working. What is wrong?
A: Jed will load a fallback keybinding-file if you do not specify an
   emulation in jed.rc overwriting your bindings (see also
   README.Debian-startup).
   
   Either select an emulation in jed.rc (as in the example files),
   or put your keybindings inside a keybindings_hook(), e.g.::
   
     define keybindings_hook(emulation)
     {
        setkey("menu_select_menu(\"Global.&Help\")", Key_F1);
        % ...
     }
   
   If you define all your keybindings without ressorting to an emulation
   mode, set the variable _Jed_Emulation (e.g. _Jed_Emulation = "cool") to
   prevent loading the _Jed_Default_Emulation fallback.

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".

Q: When I paste indented text into Jed, it misaligns everything (i.e. every 
   succeeding line is indented more than the previous, yielding horizontally 
   cascading text).
A: In Jed, carriage return is bound to `newline_and_indent'. While this
   auto-indention is a great help in normal editing, it stands in the way
   when text is pasted via the mouse. Unfortunately, Jed cannot tell whether
   its input comes from a keyboard, another program, or the mouse (XJed can).

Q: How can I prevent this?
A: There are several options:

   a) Use xjed.
   b) Use the `paste' function
      1. M-x paste  (or bind "paste" to a key)
      2. Now paste your text...
   c) Install jed-extra and use newline_indent(). 
      See Help>Describe_Function newline_indent for details.
   d) Bind "newline_and_indent" to a different key. 
      In jed.rc do e.g.:

         #ifndef XWINDOWS IBMPC_SYSTEM
         % Fix staircase effect with mouse-pasting in an x-terminal
         setkey("newline", "^M");
	 setkey("newline_and_indent", "\eM"); % Alt_Return
         % Some modes overwrite the Key_Return binding. Restore it: 
         define global_mode_hook (hook)
         {
            if (wherefirst(what_keymap() == ["C", "DCL", "IDL", "perl", "PHP"]) 
                != NULL)
               local_setkey("newline", "^M");   
         }
         #endif   

Q: TAB does not generate a TAB! Why?
A: It does something more useful: indenting the line according to the
   mode's rules. Use `quoted_insert' for a hard TAB. For the full story,
   see /usr/share/doc/jed-common/jed_faq.txt.gz, question #13.

Q: When running Jed in an xterm, alt is not sending meta (and meta is not
   sending escape) so that alt-f and alt-b e.g. don't skip words forwards and
   backwards respectively.
A: According to Thomas Dickey (do a google search to see that there is NO
   arguing here :) this is normal for xterm.  To have alt "work", add
   'xterm*metaSendsEscape: true' to your .Xresources (or equivalent) and
   make sure 'xmodmap -e "keysym Alt_L = Meta_L Alt_L"' is executed
   somewhere at X-startup (modify e.g. ~/.Xmodmap).

Q: Jed makes a difference between a single '/' and multiple '/'
   in pathnames - e.g. '/usr//bin/' is *not* equal to '/usr/bin/' ! Why?
A: According to John E. Davis, the author, this is like Emacs behaves, too.

Q: My SLang scripts do no longer work.
Q: After upgrading jed (or xjed), some jed-extra modes are broken.
A: Since version 0.99.18, jed uses S-Lang 2. See "S-Lang 2 Interpreter NEWS"
   of /usr/share/doc/libslang2/slang.txt for further explanation.

Q: Why is copy/paste not working on the console?
A: First, be sure that the gpm package is installed and correctly
   configured. Copying and pasting in a JED window on the console should
   then work like in X-Window (with a three button mouse, for instance,
   select with left button and paste with middle button).  However, for
   inserting text selected outside the JED window, you should press down
   the Alt key when pasting with the mouse.

Q: How do I cancel a command that prompts me with "y/n" choices, without a
   "cancel" otpion?
A: In Jed, (almost all) actions can be aborted by pressing a configurable
   "abort character" or calling the function kbd_quit().  The most used
   default abort character is `Ctrl-G'. Some emulations use a different
   default:
    CUA:      `Ctrl-D' (and optional ESC, see cua_escape_cmd())
    Wordstar: `Ctrl-6'

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

   Last update 2008-02-21 Guenter Milde