[Pkg-jed-commit] [SCM] Debian packaging of JED branch, master, updated. 283547838f92ce67a8400a022ca079f7cd4ff476

Rafael Laboissiere rafael at debian.org
Mon Apr 21 10:15:25 UTC 2008


The following commit has been merged in the master branch:
commit 283547838f92ce67a8400a022ca079f7cd4ff476
Author: Rafael Laboissiere <rafael at debian.org>
Date:   Mon Apr 21 12:15:17 2008 +0200

    Update startup info and some FAQs (on behalf of Günter Milde)

diff --git a/debian/README.Debian b/debian/README.Debian
index 5dc1587..3b532aa 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -24,16 +24,15 @@ the Debian JED Group:
 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.
+files in /etc/jed.d/ for site-wide configuration. 
 
+See README.Debian-startup for details.
 
 Jed_Home_Directory
 ------------------
@@ -42,21 +41,30 @@ 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.
+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/         personal extension scripts (home-made or downloaded)
-               also for "personalized versions" of standard scripts
+  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)
 
@@ -68,71 +76,83 @@ The user needs to move an eventually existing "~/.jedrc" to "~/.jed/jed.rc".
 Some frequently asked questions
 -------------------------------
 
-(see also txt/jed_faq.txt.gz)
-
-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: When I paste text into Jed, it misaligns everything (i.e. every succeeding
-   line is indented more than the previous, yielding horizontally cascading
-   text).
+(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?
-A0: Use xjed.
-A1: Use the `paste' function
+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...
-A2: Temporarily change the keybinding by doing:
-      1. M-X local_setkey("newline","^M") (Alt-Shift-X: the S-Lang prompt)
-      3. Now paste your text...
-      4. M-X local setkey("newline_and_indent","^M")
-A3: Bind "newline_and_indent" to a different key. In jed.rc do e.g.:
-         setkey("newline_and_indent", "\e^M");   % Key_Alt_Return
+   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");
-A4: Use the fact that Jed can tell whether there is input pending after the
-    carriage return. Define in your jed.rc (or any other file evaluated at
-    startup):
-         public define newline_indent ()
+	 setkey("newline_and_indent", "\eM"); % Alt_Return
+         % Some modes overwrite the Key_Return binding. Restore it: 
+         define global_mode_hook (hook)
          {
-           if (input_pending(0))
-              newline();
-           else
-              call ("newline_and_indent");
+            if (wherefirst(what_keymap() == ["C", "DCL", "IDL", "perl", "PHP"]) 
+                != NULL)
+               local_setkey("newline", "^M");   
          }
-         setkey("newline_indent","^M");
-    On a slow terminal (remote login or heavy load) this might fail by
-    non-indenting after fast typing of CR and the first character of the new
-    line.
+         #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: I have a colour scheme which does NOT modify the background and
-   foreground colours, yet Jed is still changing this, thus overriding the
-   default colours of the terminal it's running in.  What's wrong?
-A: If you're only using set_color() calls but never call set_color_scheme(),
-   Jed uses the _Jed_Default_Color_Scheme. So, to fix your problem, put
-   "_Jed_Default_Color_Scheme = NULL;" in your ~/.jedrc.
-
-Q: Why is jed linked against libncurses when it uses slang?
-A: Because it has GPM mouse support and these libraries need ncurses.
-
 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"
@@ -146,16 +166,16 @@ A: First, be sure that the gpm package is installed and correctly
    inserting text selected outside the JED window, you should press down
    the Alt key when pasting with the mouse.
 
-Q: How do a cancel a command that prompts me with "y/n" choices, without a
+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, if activated, ESC, see cua_escape_cmd())
+    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 2007-01-18 Guenter Milde
+   Last update 2008-02-21 Guenter Milde
diff --git a/debian/README.Debian-startup b/debian/README.Debian-startup
new file mode 100644
index 0000000..f215de1
--- /dev/null
+++ b/debian/README.Debian-startup
@@ -0,0 +1,75 @@
+Debian JED startup scheme
+=========================
+
+JED on Debian has a startup scheme that will help packages providing add-on
+support to get their code automatically loaded in a site-wide manner.
+
+Config Directory
+----------------
+
+Instead of a config file, we use a config directory: At startup, JED will
+evaluate all "*.sl" scripts in /etc/jed.d/:
+
+* The files will be parsed in alphabetical order, i.e. files whose name
+  starts with "00" will be loaded first and with "99" last. 
+
+* Evalutation of /etc/jed.d/ can be suppressed by the --skip-debian-startup
+  command line option.
+
+* /etc/jed.d/ is not evaluated if Jed is started as `jed-script`.
+  
+  If a script depends on the Debian configuration, it can call the function
+  debian_startup() defined in defaults.sl.
+  
+* Files in /etc/jed.d/ are configuration files. The system administrator can
+  modify them or add scripts for site-wide Jed configuration.
+
+* Every package has the right to place files into /etc/jed.d/.  
+  Use names like NN<name>.sl (where "NN" is a two-digit number).  
+  (See Debian-Jed-Policy.txt for details).
+
+Start-up Files
+-------------
+
+The order of evaluating the JED config settings is thus as follows:
+
+1) /usr/share/jed/lib/site.sl     % upstream basic setup that also triggers
+   				  % all further evaluations
+
+2) /usr/share/jed/lib/defaults.sl % Debian provided code for evaluation of 
+                                  % the "jed.d" directory contents.
+
+%  no call to /etc/jed.conf
+                                 
+3) /etc/jed.d/*.sl                % package configuration files
+
+4) ~/.jed/jed.rc or ~/.jedrc      % user config file,
+                                  % skipped if it does not exist or with 
+				  % the -n command line option.
+				  
+5) _Jed_Default_Emulation         % key-bindings file 
+   				  % skipped if jed.rc loads an emulation, i.e.
+				  % if (_Jed_Emulation != NULL)
+				  % default is "emacs", set in 
+				  % /etc/jed.d/05jed-common.sl
+
+6) _Jed_Default_Color_Scheme      % colour settings
+   				  % skipped jed.rc loads a colour scheme, i.e.
+				  if (_Jed_Color_Scheme != NULL)
+
+7) command_line_options           % -l FILE loads FILE as S-Lang code.
+
+Only now, files given on the command line are loaded into a buffer (each)
+which may trigger evaluation of more S-Lang files providing the editing mode.
+
+All evaluated files might call other S-Lang files either directly
+(evalfile(), require(), set_color_scheme) or at a later stage (autoload()).
+
+
+-- Rafael Laboissiere <rafael at debian.org> Thu Oct 21 18:28:39 CEST 1999
+-- Updated by Charl P. Botha <cpbotha at debian.org> Sun Jun 3 02:14:58 CEST 2001
+-- and again by cpbotha with Rafael's new scheme Tue Nov 13 22:00:49 CET 2001
+-- updated by G. Milde, 2006-05-16, 2008-02-21
+
+Last update 2008-02-21 Guenter Milde
+
diff --git a/debian/changelog b/debian/changelog
index ab272a8..f5c98ef 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,14 +1,16 @@
 jed (1:0.99.18+dfsg.1-10) UNRELEASED; urgency=low
 
   * debian/control:
-    + Added Homepage field
+    + Added Homepage field 
     + Use the now official Vcs-* fields instead of the obsolete XS-Vcs-*
     + Dropped the Homepage pseudo-field for the extended description
     + Bumped Standards-Version to 3.7.3
   * debian/po/fi.po: Add Finnish translation of the debconf templates,
     thanks to Esko Arajärvi (closes: #476637)
+  * debian/README.Debian, debian/README.Debian-startup: Updated to make
+    clear the startup scheme in Debian (closes: #466486) [GM]  
 
- -- Rafael Laboissiere <rafael at debian.org>  Sun, 20 Apr 2008 14:44:01 +0200
+ -- Rafael Laboissiere <rafael at debian.org>  Mon, 21 Apr 2008 12:01:11 +0200
 
 jed (1:0.99.18+dfsg.1-9) unstable; urgency=low
 

-- 
Debian packaging of JED



More information about the Pkg-jed-commit mailing list