home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 4 / CDPD_IV.bin / fish / 931-950 / ff945 / emacsstarter / starter.doc < prev    next >
Lisp/Scheme  |  1993-12-22  |  9KB  |  261 lines
  1.  
  2.  
  3.  
  4.         #### #   #   #    ###  ### 
  5.         #    ## ##  # #  #    #
  6.         ##   # # # #   # #     ##
  7.         #    #   # ##### #       #
  8.         #### #   # #   #  ### ### 
  9.  
  10.               ###  #####   #   ###  ##### #### ###
  11.              #       #    # #  #  #   #   #    #  #
  12.               ###    #   #   # ###    #   ##   ###
  13.                  #   #   ##### # #    #   #    # #
  14.               ###    #   #   # #  #   #   #### #  #
  15.  
  16.                         ***  **** *    *  * *   * ****
  17.                         *  * *    *    *  *  * *  *
  18.                            *  * **   *    *  *   *   **
  19.                        *  * *    *    *  *  * *  *
  20.                            ***  **** **** **** *   * ****
  21.  
  22.  
  23.     ------------------------------------------------------
  24.                   Release 1
  25.                    
  26.                  Written by:
  27.                Anders Lindgren
  28.                  Bo Liljegren
  29.                    
  30.          A (in our humble opinion) good Emacs starter
  31.     ------------------------------------------------------
  32.                   FEATURING
  33.  
  34.     o Load files into a running Emacs.
  35.  
  36.     o Option to use a public screen (requiers ScreenManager).
  37.  
  38.     o Full WB support; double-click icons into a running Emacs.
  39.  
  40.     o New icon creating scheme, use different icons depending on what
  41.       type of file you are editing.
  42.  
  43.     o Sticky flag, the script doesn't terminate until the requested
  44.       buffers are terminated.
  45.  
  46.  
  47.                    LICENSE
  48.  
  49.         Copyright (C) 1993  Anders Lindgren  and  Bo Liljegren
  50.  
  51.      This program is free software; you can redistribute it and/or modify
  52.      it under the terms of the GNU General Public License as published by
  53.      the Free Software Foundation; either version 2 of the License, or
  54.      (at your option) any later version.
  55.  
  56.      This program is distributed in the hope that it will be useful,
  57.      but WITHOUT ANY WARRANTY; without even the implied warranty of
  58.      MERCHANTABILITY of FITNESS FOR A PARTICULAR PURPOSE. See the
  59.      GNU General Public License for more details.
  60.  
  61.      You should have received a copy of the GNU General Public License
  62.      along with this program; if not, write to the Free Software
  63.      Foundation, Inc., 675 Mass Ave, Cambridge, Ma 02139, USA.
  64.  
  65.  
  66.  
  67.                    CONTENTS
  68.  
  69. The following files are contained in the archive:
  70.  
  71. COPYING            -- The Gnu General Public License
  72. starter.doc         -- This file
  73. Emacs.info        -- A nice Emacs icon drawn by Bo Liljegren
  74. rexx/emacs.rexx V1.06    -- The main starter script
  75. lisp/sticky.el    V1.00    -- ELisp code used when a buffer is started with
  76.                the "-sticky" flag
  77. lisp/newicon.el    V1.00    -- The ELisp code for the new icon creating scheme
  78. lisp/#?.elc        -- Bytecompiled versions of the above files
  79. wbarg/wbarg    V1.00    -- A utility which converts WB arguments 
  80.                to shell dito
  81. wbarg/wbarg.c        -- Source code for the above utility
  82. wbarg/makefile        -- Rules for building the above with SAS/C 6.x.
  83. icons/def_#?.info    -- Icons. All but def_el drawn by Christian A. Weber.
  84.  
  85.  
  86.  
  87.  
  88.  
  89.                   NEWSFLASH
  90.  
  91. SUGA, Swedish User Group of Amiga is a non-profit nation wide club for
  92. Amiga-freaks in Sweden. It has been operating for many years (I joined
  93. in around -87, and have been more or less active ever since.) A
  94. newspaper with 16 to 20 pages is beeing distrubuted quaterly. A BBS is
  95. runed using the command line program NiKom, which is written by a
  96. member of the club. (Too bad for you non swedish speaking people that
  97. it isn't translated yet.) For the members in Stockholm we have a
  98. meeting every sunday between 11am and 3pm.
  99.  
  100. Join by inserting only 150:- (less than $20) into the PostGiro account
  101. 13 43 32-2. You can also just show up at the "Verksta'n" to see what
  102. it's all about!
  103.  
  104.     Address: SUGA
  105.          Disponentvillan, Verkstan
  106.          Norrtullsgatan 12k
  107.          S-113 27 Stockholm
  108.  
  109.     SUGA BBS:+46 (0)8 34 85 23
  110.          +46 (0)8 34 32 76  
  111.  
  112.  
  113.                  INSTALLATION
  114.  
  115. Copy the files in the "lisp" directory into a directory in the
  116. Emacs load path, for example GnuEmacs:lisp.
  117.  
  118. Copy the file in the "rexx" directory to REXX:
  119.  
  120. Copy the file "wbarg/wbarg" into the GnuEmacs:etc directory.
  121.  
  122.  
  123. If you would like to use the new icon creating scheme then
  124. create a directory named GnuEmacs:icons and copy the contents
  125. of the "icons" to it and add the following line to your 
  126. s:.emacs file.
  127.  
  128.     (load "newicon")
  129.     (setq amiga-create-icons t)
  130.  
  131. Older revisions of the script Emacs.rexx required that the command
  132. (amiga-set-geometry ) were executed in s:.emacs. This is no longer the
  133. case, hence the line should be removed.
  134.  
  135. If the -screen option should be used, the program ScreenManager must
  136. be installed. The program is not included in this archive since its
  137. license does not allow it to be fully freely distributable, it can be
  138. found one ONE (yes, ONE I understood the license correctly) PD disk
  139. serie, and on AmiNet. If you can't find it you can order it from the
  140. author (you can also inform him of the existence of the Gnu General
  141. Public License):
  142.  
  143.     Bernhard Möllemann
  144.     Luisenstraße 17
  145.     D-7500 Karlsruhe 1
  146.     Germany
  147.  
  148. In the future we might rewrite Emacs.rexx so it uses some other screen
  149. opener, if it turns out that ScreenManager is too difficult to find.
  150.  
  151.  
  152.                   EMACS.REXX
  153.  
  154. The heart of the Emacs Starter Deluxe is the script emacs.rexx. It loads
  155. files into a running Emacs or starts a new Emacs. It is capable of opening
  156. a public screen by the help of the utility ScreenManager. The resolution
  157. and color of the screen is cloned from the Workbench, although the depth 
  158. will always be two bitplanes.
  159.  
  160.  
  161.     Usage:   [rx] emacs [options|+linenumber] [filenames]
  162.  
  163.  
  164.     -[not]tofront    Bring the Emacs window and screes to the front.
  165.             Default is -tofront.
  166.  
  167.     -[not]sticky    Wait until the filenames requested are killed by
  168.             Emacs. Default is -notsticky.
  169.  
  170.     -[no]screen        Open a public screen and place Emacs on it.
  171.             This option requiers the program "ScreenManager".
  172.             Default is -screen.
  173.  
  174. The script also handles standard Emacs options, even though some are
  175. implemented as no-ops when loading files into a running Emacs.
  176.  
  177. The meaning of the standard option "-kill" is extended; if a running Emacs
  178. exists it is terminated.
  179.  
  180.  
  181.               WORKBENCH SUPPORT
  182.  
  183. The Emacs Starter Deluxe has full Workbench support. This means that a
  184. file conneted to an icon can be loaded into a running Emacs.
  185.  
  186. This feature requiers a project icon with the default tool set to
  187. "GnuEmacs:etc/wbarg" and the tooltype:
  188.     COMMAND=sys:rexxc/rx emacs
  189.  
  190. A number of icons with this setup can be found in the icons directory
  191. of this archive.
  192.  
  193. If no file is connected to an icon which is double-clicked Emacs will
  194. be started, or brought to front, but no file would be loaded.
  195.  
  196. Note that the icons Emacs normally creates does NOT have the tool and
  197. tooltype set correctly. But, gentle reader, a solution to this problem
  198. can be found in the next section.
  199.  
  200.  
  201.                NEW ICON SCHEME
  202.  
  203. To make as life simple as possible for workbench users a new icon
  204. creating scheme has been invented. To activate it please place the
  205. following lines in your s:.emacs file:
  206.  
  207.     (load "newicon")
  208.     (setq amiga-create-icons t)
  209.  
  210. The new scheme checks the extension of the file edited and tries to
  211. find an icon with the name "def_<extension>.el" in the icon path. If
  212. no one is found an icon named "GnuEmacs:icons/def_emacs.el" is used.
  213. As an emergency exit, the old icon creation routine is called.
  214.  
  215. The icon path is defined to be the directories contained in the list
  216. "amiga-icon-path" and in the directory "GnuEmacs:Icons". Note that the
  217. directories in the list must end in a colon or slash.
  218.  
  219. Example: If the user would like to use the icons supplied by the SAS
  220. C-complier and the icons supplied by DefaultIcon, the following lines
  221. could be placed in his or hers .emacs file:
  222.     (setq amiga-icon-path '("sc:Icons/" "Env:Icons/"))
  223.  
  224.  
  225.                SO WHAT'S THE DARK SIDE?
  226.  
  227. All programs must have something which isn't working properly, and yes,
  228. there is one thing we don't recomend:
  229. Don't iconify Emacs, since the screen closes automatically when the Emacs
  230. window is closed. There is a way around it though; execute the emacs.rexx
  231. script again to open a new screen and then deiconify Emacs.
  232.  
  233. If for some reason Emacs fails to start but the screen shows up it must
  234. be closed before the next attempt to start Emacs. This is done by issuing
  235. the command "ScreenManager CLOSE Emacs".
  236.  
  237.  
  238.               HOW TO CONTACT US
  239.  
  240. If you would like new features to be added to Emacs Starter Deluxe, or if
  241. you whould discover a bug, don't hesitate to contact us:
  242.  
  243. email:   d91ali@csd.uu.se        bo-lilje@dsv.su.se
  244.      
  245. mail:    Anders Lindgren        Bo Liljegren
  246.          Kantorsg. 2-331        Skogvaktarg. 12
  247.          S-754 24 Uppsala        115 42 Stockholm
  248.  
  249. voice:   Scream  Anders or Bosse  LOUD
  250.  
  251.  
  252.                  OTHER TITLES
  253.  
  254. The following Emacs applications has been written by Anders Lindgren:
  255.  
  256. rexx-mode        -- A Complete editing mode and a source level 
  257.                debugger for REXX. (Machine independent, but 
  258.                it works on the Amiga.)
  259. sas-c-mode        -- A minor mode for communication with the SAS/C
  260.                6.x message browser SCMSG and more.
  261.