home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / wps / editor / epmtools / epmmac / read.me < prev    next >
Text File  |  1992-09-09  |  12KB  |  258 lines
  1. There are three sample configuration files included in this directory.
  2. MYCNF.SMP is a simple example MYCNF.E.  EPMGCNF.SMP is the configuration
  3. file used to build the .ex files shipped with the OS/2 2.0 Enhanced Editor.
  4. OS2TOOLS.CFG is the MYCNF.E used to build the .ex files included with the
  5. EPM package as shipped internally to IBM.
  6.  
  7. Note that in order to be as general as possible, many features are made
  8. switchable at runtime in the shipped .ex files so that users who don't
  9. want to recompile the macros needn't.  If you *do* recompile, then
  10. the switchability will be lost unless you explicitly enable it.  For
  11. example, line vs. stream mode:  people used to line based editors will
  12. prefer line mode; people used to word processors will prefer stream mode,
  13. and few people will want to dynamically change between the two paradigms.
  14. So it makes more sense to configure it the way you prefer, and not waste
  15. the overhead of run-time checks and extra code.
  16.  
  17. Also note that you should recompile both EPM and EXTRA when changing any
  18. configuration constants related to the menu choices, as the menus are
  19. contained in EXTRA.EX but the commands used are (mostly) defined in
  20. EPM.EX, so if the two files are not in synch, you might get "Unknown command".
  21.  
  22. A description of each file in E_MACROS is appended at the end of this file.
  23.  
  24. Answers to some common questions:
  25.  
  26. :QUESTION.
  27.   While trying to recompile the macros, I got the error message:
  28.      EX code size too large
  29.  
  30. :ANSWER.
  31.   The current set of macros won't fit into a single .ex file, which is
  32.   limited to 64k of code.  We've split EPM.EX into EPM.EX and EXTRA.EX.
  33.   If you add to your MYCNF.E
  34.      const
  35.         EXTRA_EX = 1
  36.  
  37.   and recompile both EPM.E and EXTRA.E, then EXTRA.EX will automatically
  38.   be linked in at run time.  (EXTRA.E includes a MYEXTRA.E if it exists,
  39.   so if space is still tight you can move any DEFCs or DEFPROCs from
  40.   MYSTUFF.E to MYEXTRA.E.  DEFLOADs, DEFSELECTs, DEFMODIFYs and key
  41.   definitions should stay where they are.)
  42.  
  43. :QUESTION.
  44.   What is OK to place in MYCNF.E?
  45.  
  46. :ANSWER.
  47.   MYCNF.E is a configuration file that is included by many .E files.
  48.   Therefore, it should contain *nothing* other than CONST, SET and DEFINE
  49.   statements.  If you placed executable code in MYCNF.E, at best you
  50.   would be wasting space since the code would be duplicated in all your
  51.   .ex files; at worst, you'd break various things depending on what code
  52.   you included.
  53.  
  54. :QUESTION.
  55.   I am writing some C source code in the EPM editor and am
  56.   getting a bit tired of erasing EPM's C add-ons.  How can I
  57.   turn this off?
  58.  
  59. :ANSWER.
  60.   You can turn it on and off dynamically by entering the command
  61.      EXPAND OFF
  62.   on the EPM command line.  If you're using EPM (or the Enhanced Editor)
  63.   as shipped, and don't want to recompile the macros, you can make this
  64.   the default by doing the following:
  65.      1.  Create a PROFILE.ERX in your EPMPATH (or PATH) containing:
  66.          /* EPM profile */
  67.          'expand off'
  68.      2.  On the EPM command line, enter:  PROFILE ON
  69.      3.  Select Options / Save Options.
  70.  
  71.   If you're compiling the macros, then you can make the syntax expansion
  72.   start out turned off by adding to your MYCNF.E:
  73.    const
  74.       my_EXPAND_ON = 0  -- Start out off; default is on.
  75.  
  76.   or you can omit the support for any language completely by including
  77.   one of:
  78.    const
  79.       C_SYNTAX_ASSIST = 0              -- Default for C is 1
  80.       E_SYNTAX_ASSIST = 0              -- Default for E is 1
  81.       P_SYNTAX_ASSIST = 0              -- Default for Pascal is 1
  82.       REXX_SYNTAX_ASSIST = 0           -- Default for Rexx is 0
  83.  
  84.   or, if you don't have a MYKEYSET.E, you can omit support for all of
  85.   them by including:
  86.    const
  87.       ALTERNATE_KEYSETS = 0            -- Default is 1
  88.  
  89.   Then recompile the macros, as described in the EPM User's Guide
  90.   (enter VIEW EPMUSERS to see it).
  91.  
  92. :QUESTION.
  93.   When I try WYSIWYG printing, I get no output or a blank page.
  94.  
  95. :ANSWER.
  96.   Two things to check:
  97.    - If you're printing to a LAN printer, your machine and the LAN server
  98.      must be using exactly the same printer driver, or things might not
  99.      work.  (I believe this is documented in the LAN pubs.)
  100.    - WYSIWYG stands for "What You See Is What You Get".  If you have a
  101.      white or light foreground color, it won't show up on the default
  102.      background color.  Try selecting black on white.
  103.  
  104. :QUESTION.
  105.   Why are buttons greyed in the print dialog?
  106.  
  107. :ANSWER.
  108.   EPM prints to a queue for WYSIWYG printing, and to a device (e.g.,
  109.   LPT1) when printing in draft mode.  If one of these is not defined
  110.   for a printer, then the corresponding button will not be selectable.
  111.  
  112. :QUESTION.
  113.   When I invoke EPM I get an icon in the Window Viewer, but when I
  114.   select it nothing happens.  Any thoughts?
  115.  
  116. :ANSWER.
  117.   It's the fault of the viewer.  They subclass the icon, and don't give
  118.   us anything that a "nicely behaved" icon isn't supposed to get.
  119.  
  120.   You can configure the system so that all icons minimize to the desktop,
  121.   or you can configure just EPM.
  122.  
  123.   If you open "OS/2 System", then open "System Setup", then open "Settings"
  124.   you'll see a Window page that lets you specify whether minimized windows
  125.   should appear on the desktop (as they do in OS/2 1.3), or in the
  126.   "Minimized Window Viewer", or just be hidden.  This sets the default
  127.   action for the system.  Some objects have a separate setting that can
  128.   override the default.  If you open the Settings for the real program as
  129.   found via the Drives object, you won't see this (no Window page on the
  130.   Settings notebook), but if you create a Program object that points to
  131.   EPM.EXE you will.
  132.  
  133. :QUESTION.
  134.   How can I edit host files on other than the 'A' session?
  135.  
  136. :ANSWER.
  137.   The default host interface (SAVELOAD.E) only accesses the first host
  138.   session.  E3EMUL will let you access any host session.  Add the
  139.   following to MYCNF.E and then recompile:
  140.      const
  141.         HOST_SUPPORT = 'EMUL'
  142.         USING = 'CM'         -- (or 'IBM', or whatever.  See E3EMUL SCRIPT.)
  143.         my_HOSTCOPY = 'AC'   -- (for example; the default is ALMCOPY)
  144.  
  145.   USING = 'CM' uses ALMCOPY.EXE (or the value of my_HOSTCOPY) as the file
  146.   transfer command; USING = 'IBM' uses SEND/RECEIVE.  You must use the
  147.   latter for MVS files.
  148.  
  149.   If you don't have room for E3EMUL, you could elect to have it linked in
  150.   externally.  Add the following line to your MYCNF.E, then recompile
  151.   both EPM and E3EMUL:
  152.      LINK_HOST_SUPPORT = 1
  153.  
  154. :QUESTION.
  155.   I am unable to edit any files on my H: drive.  Why is this?
  156.  
  157. :ANSWER.
  158.   By default, H: is used to refer to the host system.  If you do not edit
  159.   host files, then add the following to MYCNF.E:
  160.      const
  161.         HOST_SUPPORT = ''      -- Omit host support
  162.  
  163.   If you wish to be able to load and save host files directly from your E
  164.   session, then you can change the drive letter used to refer to the host.
  165.   If you use the standard SAVELOAD routines, then you can do this by adding
  166.   the following to MYCNF.E:
  167.      const
  168.         HOSTDRIVE = 'V:'      -- Use V: to refer to VM files
  169.  
  170.   If you use the enhanced host support of E3EMUL, (HOST_SUPPORT = 'EMUL'
  171.   in your MYCNF.E) then you can do this by adding the following to MYCNF.E:
  172.      const
  173.         my_HOSTDRIVE = 'V'      -- Use V: to refer to VM files
  174.  
  175.   Note:  For SAVELOAD, you set HOSTDRIVE to 'x:' (it needs the colon); for
  176.   E3EMUL you set my_HOSTDRIVE to 'x' (it doesn't take the colon).
  177.  
  178.   If you use E3EMUL, instead of changing the host drive letter, you may
  179.   choose to make the host logical terminal ID required, by adding to MYCNF.E:
  180.      const
  181.         HOST_LT_REQUIRED = 1
  182.  
  183.   This means that H: will refer to the local H drive on the workstation,
  184.   and HA:, HB:, etc. will refer to the VM or MVS host.
  185.  
  186. -------------------------------------------------------------------------------
  187. List of files included in E_MACROS:
  188.  
  189. ALL.E        - The ALL macro; displays all instances of a given string.
  190. ASSIST.E     - The bracket-matching code used by Ctrl+left bracket.
  191. BOOKMARK.E   - Bookmark support, Workframe support, & code to load and
  192.                save EPM attributes as an enhanced attribute.
  193. BOX.E        - The BOX macro; draw a box in various styles.
  194. BUFF.E       - Test macros for the buffer() opcode; not actually used.
  195. CALLREXX.E   - The Rexx macro interface code.
  196. CHAROPS.E    - Support for character mark operations.
  197. CKEYS.E      - C language syntax assist.
  198. CKEYSEL.E    - (Not used by EPM.)
  199. CLIPBRD.E    - Support for the clipboard and for copying marks between windows.
  200. COLORS.E     - Constant definitions for color names.
  201. DOSUTIL.E    - OS-specific code (DATE, TIME, DIR, etc.).
  202. DRAW.E       - The DRAW macro; lets you draw figures with the cursor keys.
  203. DRAWKEY.E    - F6 definition.
  204. E.E          - The main file that includes most of the others.
  205. E3EMUL.E     - Advanced host file editing support
  206. EKEYS.E      - E macro language syntax assist.
  207. EKEYSEL.E    - (Not used by EPM.)
  208. ENGLISH.E    - Messages; included separately for NLS support.
  209. EPM.E        - Front-end for E.E.
  210. EPMDBCS.E    - DBCS support
  211. EPMGCNF.SMP  - The MYCNF.E used to build the Enhanced Editor.
  212. EPMLEX.E     - Spell-checking support.
  213. EPMSHELL.E   - EPM Shell support.
  214. EPM_EA.E     - Enhanced attribute support.
  215. EXTRA.E      - Used to split EPM.EX in two.
  216. GET.E        - The GET macro; get a copy of a file into the current file.
  217. HELP.E       - Builds the stand-alone HELP.EX used by the help browser.
  218. KWHELP.E     - Keyword help support (Ctrl+H or Ctrl+double-click MB1).
  219. LINKCMDS.E   - Linking-related commands.
  220. LOAD.E       - The default DEFLOAD (executed every time a file is loaded).
  221. MAIN.E       - The default DEFMAIN (processes the command line arguments).
  222. MARKFILT.E   - Procedures for filtering a block,line or character mark.
  223. MATH.E       - MATHx, ADD, and MULT commands.
  224. MATHLIB.E    - Support for MATH.E; separately linkable.
  225. MENUHELP.H   - Help panel numbers; used by STDMENU.E
  226. MODIFY.E     - The default DEFMODIFY (called when .modify status changes and
  227.                for autosaving.
  228. MOUSE.E      - Mouse support.
  229. MYCNF.SMP    - A simple sample MYCNF.E.
  230. MYSTUFF.SMP  - A sample MYSTUFF.E.
  231. OS2TOOLS.CFG - The MYCNF.E used to build the .ex files distributed within IBM.
  232. PKEYS.E      - P language syntax assist.
  233. PKEYSEL.E    - (Not used by EPM.)
  234. PUT.E        - The PUT macro; copy the marked area or current file into a
  235.                new file, or append it to the end of an existing file.
  236. READ.ME      - (This file.)
  237. REXXKEYS.E   - Rexx language syntax assist.
  238. RKEYSEL.E    - (Not used by EPM.)
  239. SAVELOAD.E   - The default host file editing support.
  240. SELECT.E     - The default DEFSELECT (called whenever the current file changes).
  241. SLNOHOST.E   - Save / Load file support with no host support.
  242. SMALL.E      - Used to compile a smaller .ex file; untested with the current EPM.
  243. SORTDLL.E    - The SORT command that uses sorting code in a DLL; limited to
  244.                sorting 64k (65,535 bytes) of data.
  245. SORTE.E      - A SORT command that just uses macro code.  Slower, but no size
  246.                limit.
  247. STDCMDS.E    - Most of the macro-defined commands are defined here.
  248. STDCNF.E     - Standard configuration file; sets defaults for options not
  249.                set in MYCNF.E.
  250. STDCONST.E   - Sets various constants.
  251. STDCTRL.E    - Code for interacting with various PM and EPM controls.
  252. STDKEYS.E    - Most of the keys are defined here.
  253. STDMENU.E    - The standard EPM action bar is defined here.
  254. STDPROCS.E   - Most of the standard macro procedures are defined here.
  255. USERAPP.SMP  - A sample user application, written for sharing with other users.
  256.                It shows how to include the MYCNF.E to determine the user's
  257.                defaults.
  258.