home *** CD-ROM | disk | FTP | other *** search
/ Plex 2 / Plex2.mdf / o_progrm / e25read.me < prev    next >
Text File  |  1994-06-14  |  58KB  |  1,608 lines
  1. ===============================================================================
  2. GNU Emacs 19.25.1 for emx (OS/2 2.0 and 2.1)                        08-Jun-1994
  3. ===============================================================================
  4.  
  5. Introduction
  6. ============
  7.  
  8. This is GNU Emacs 19.25 for emx on OS/2 2.0 or 2.1.  The port was done
  9. by Eberhard Mattes based on ideas of the port of GNU Emacs for OS/2
  10. done by Joerg Viola.  This port of GNU Emacs also works with emx on
  11. MS-DOS, but that hasn't been tested.
  12.  
  13. See \emacs\19.25\etc\FAQ for a list of frequently asked questions with
  14. answers for GNU Emacs.  That file is contained in e25more.zip.
  15. However, etc/FAQ is somewhat out of date.
  16.  
  17. See \emacs\19.25\emx\FAQ for a list of frequently asked questions with
  18. answers specific to this port of GNU Emacs.  That file is contained in
  19. e25min.zip.
  20.  
  21. GNU Emacs is free software.  See \emacs\19.25\etc\COPYING for details.
  22. Note that you are not allowed to distribute GNU Emacs without source
  23. code.
  24.  
  25.  
  26. Distribution files
  27. ==================
  28.  
  29. The "GNU Emacs 19.25 for emx" distribution consists of the following
  30. files:
  31.  
  32.   README                this file (/emacs/19.25/emx/README)
  33.   e25el1.zip            Emacs Lisp files (source), part 1
  34.   e25el2.zip            Emacs Lisp files (source), part 2
  35.   e25info.zip           info files (on-line help)
  36.   e25lib1.zip           Emacs Lisp library (base set, compiled)
  37.   e25lib2.zip           Emacs Lisp library (remaining files, compiled)
  38.   e25man.zip            documentation files (mostly for TeX)
  39.   e25min.zip            minimal set of files for running GNU Emacs
  40.   e25more.zip           additional files
  41.   e25rest.zip           remaining files
  42.   e25src.zip            sources
  43.  
  44. The "25" in e25*.zip is the minor version number.  For example,
  45. e83*.zip will be used for Emacs 19.83.
  46.  
  47.  
  48. Other files of interest
  49. =======================
  50.  
  51. GNU Emacs 19.25 for emx requires emx 0.8h or later -- if you have an
  52. older version of emx.dll, emxbind.exe, and termcap.dat, get emxrt.zip
  53. from
  54.  
  55.   ftp.uni-stuttgart.de [129.69.8.13]: /pub/systems/os2/emx-0.8h
  56.   ftp-os2.cdrom.com:  [192.153.46.2]: /os2/2_x/unix/emx08h
  57.   src.doc.ic.ac.uk     [146.169.2.1]: /pub/packages/os2/2_x/unix/emx08h
  58.   ftp.informatik.tu-muenchen.de [131.159.0.198]:
  59.                                       /pub/comp/os/os2/gnu/emx+gcc
  60.  
  61. Also get the latest emxfix??.zip (only the latest one is required).
  62.  
  63. You might want to also get the following files:
  64.  
  65.   ftp-os2.cdrom.com:             os2/all/graphics/smallfnt.zip
  66.   ftp-os2.cdrom.com:             os2/all/graphics/small.zip
  67.   ftp-os2.cdrom.com:             os2/all/unix/shells/ms_sh22.zip
  68.   ftp-os2.cdrom.com:             os2/2_x/unix/shells/bash.zip
  69.   ftp-os2.cdrom.com:             os2/2_x/unix/unixutils/isp3009b.zip
  70.   ftp.informatik.tu-muenchen.de: pub/comp/os/os2/gnu/systools/gnufutil.zip
  71.   prep.ai.mit.edu:               pub/gnu/elisp-manual-19-2.3.tar.gz
  72.  
  73. smallfnt.zip or small.zip contains a small fixed-width bitmapped font
  74. for the Presentation Manager.  See below on how to fix a bug of
  75. smallfnt.zip (small.zip is a fixed version).
  76.  
  77. ms_sh22.zip contains the Data Logic shell, a Unix-like shell.  Version
  78. 2.3 should be available soon; it fixes some important bugs.  bash.zip
  79. contains bash, another Unix-like shell.
  80.  
  81. isp3009b.zip contains Ispell, a spelling checker, which can be used
  82. with GNU Emacs.
  83.  
  84. gnufutil.zip contains the GNU file utilities.  ls.exe is required for
  85. dired and for recover-file.
  86.  
  87. elisp-manual-19-2.3.tar.gz contains the Emacs Lisp documentation.
  88.  
  89.  
  90. Installing the emx runtime package
  91. ==================================
  92.  
  93. Install the emx runtime package emxrt.zip (version 0.8h or later) if
  94. not already installed.  First, unpack the files of the emx runtime
  95. package to your hard disk:
  96.  
  97.   cd \
  98.   unzip a:emxrt
  99.  
  100. Installation of the emx runtime package involves changing the LIBPATH
  101. statement of your config.sys file and setting the following
  102. environment variables in config.sys:
  103.  
  104.   TERMCAP  name of termcap file, defaults to /emx/etc/termcap.dat
  105.  
  106.   TERM     name of the terminal, possible values include rmono,
  107.            ansi-color-2, and ansi-color-3
  108.  
  109.   PATH     include \emx\bin in your PATH
  110.  
  111. Example (the emx runtime package is installed on drive C):
  112.  
  113.   LIBPATH=C:\OS2\DLL;[...];c:\emx\dll
  114.   SET PATH=C:\OS2;C:\OS2\SYSTEM;[...];c:\emx\bin
  115.   SET TERMCAP=c:/emx/etc/termcap.dat
  116.   SET TERM=ansi-color-3
  117.  
  118. See \emx\doc\emxrt.doc and \emx\book\emxrt.inf for details on
  119. installing the emx runtime package.
  120.  
  121.  
  122. Installing GNU Emacs
  123. ====================
  124.  
  125. This section describes how to install the compiled version of GNU
  126. Emacs 19.25 for emx on OS/2 2.0 and 2.1.
  127.  
  128. GNU Emacs is installed in the \emacs directory of an HPFS drive.
  129.  
  130. 1.  Get lots of disk space on an HPFS partition.  As this version of
  131.     GNU Emacs doesn't bother about 8.3 file names, you can't install
  132.     it on a FAT partition.  (Well, probably you can, but it has not
  133.     been tested.)  However, you can edit files on FAT partitions.
  134.  
  135.     If you haven't installed the REXX component of OS/2, you may want
  136.     to install it now.  REXX is required by instemacs.cmd.
  137.  
  138. 2.  Set appropriate environment variables (set them in config.sys):
  139.  
  140.       SHELL          name of the command processor, defaults to
  141.                      /bin/sh.  If you have a Unix-like shell (such as
  142.                      bash or the Data Logic shell), you should use the
  143.                      pathname of that shell.  Otherwise, use the path
  144.                      name of cmd.exe
  145.  
  146.       SYSTEMNAME     initializes system-name, the name of the
  147.                      machine.  The default value is "my-system"
  148.  
  149.       HOME           the pathname of your home directory, replaces ~
  150.                      in pathnames.  Emacs tries to load .emacs, for
  151.                      instance, from that directory
  152.  
  153.       TMP            directory for temporary files.  The default is
  154.                      the current working directory
  155.  
  156.       TMPDIR         another directory for temporary files.  The ediff
  157.                      packages uses this; the directory must be on an
  158.                      HPFS drive for ediff
  159.  
  160.     Example (Emacs will be installed on drive C):
  161.  
  162.       SET PATH=C:\OS2;[...];C:\EMACS\19.25\BIN
  163.       SET SHELL=c:/bin/bash.exe
  164.       SET SYSTEMNAME=vergil
  165.       SET HOME=c:/home
  166.       SET TMP=c:/tmp
  167.       SET TMPDIR=c:/tmp
  168.  
  169.     Note that EMACSLOADPATH, EMACSDATA, EMACSPATH, and INFOPATH are no
  170.     longer required -- please delete them unless you want to override
  171.     or supplement the default directories, or put emacs.exe into a
  172.     directory not related to the Emacs directory hierarchy.  The
  173.     default directories are now relative to the directory from which
  174.     emacs.exe is run.
  175.  
  176. 3.  Reboot your computer to activate the new config.sys settings.
  177.  
  178. 4.  To install a minimal version of GNU Emacs, change to the target
  179.     drive (which should be formatted with HPFS) and unpack the file
  180.     e25min.zip by typing
  181.  
  182.       cd \
  183.       unzip a:e25min
  184.  
  185.     Note that you cannot use PKUNZIP to unpack the ZIP files.
  186.  
  187. 5.  Create a preloaded version of GNU Emacs by typing
  188.  
  189.       cd \emacs\19.25\bin
  190.       dump
  191.  
  192.     Required disk space: 5 MByte, total.  In case you are short of disk
  193.     space, you can delete the files \emacs\19.25\bin\temacs and
  194.     \emacs\19.25\etc\DOC now.  If you want to dump Emacs again,
  195.     restore these files from e25min.zip.
  196.  
  197. 6.  Now you can run GNU Emacs by typing
  198.  
  199.       emacs                   (run Emacs in text mode)
  200.       emacs -d                (run Emacs in PM mode)
  201.  
  202. 7.  The minimal version of GNU Emacs installed now is hardly usable.
  203.     For instance, there is no on-line help.  You should install
  204.     additional files:
  205.  
  206.       cd \
  207.       unzip a:e25lib1
  208.       unzip a:e25more
  209.       unzip a:e25info
  210.  
  211.     Required disk space: 10.5 MByte, total.  You can save some disk
  212.     space by compressing all files but `dir' in \emacs\19.25\info with
  213.     `compress' or `gzip'.
  214.  
  215. 8.  To unpack all the .el files, type
  216.  
  217.       cd \
  218.       unzip a:e25el1
  219.       unzip a:e25el2
  220.  
  221.     For running GNU Emacs, only the compiled (.elc) files are
  222.     required. You need the .el files if you need documentation about
  223.     the various Emacs Lisp packages or want to change them.  Required
  224.     disk space: 18 Mbyte, total.
  225.  
  226.     Additional files are packaged in the remaining ZIP files:
  227.  
  228.       cd \
  229.       unzip a:e25lib2
  230.       unzip a:e25rest
  231.       unzip a:e25man
  232.  
  233.     These files are usually not required for running GNU Emacs under
  234.     emx.  Required disk space: 23 MByte, total.
  235.  
  236. 9.  You might want to add program objects for the programs
  237.  
  238.       c:\emacs\19.25\bin\emacs.exe
  239.       c:\emacs\19.25\bin\emacsclient.exe
  240.  
  241.     to an appropriate folder.  There is a REXX program called
  242.     instemacs.cmd to do this for you.  Type
  243.  
  244.       instemacs
  245.  
  246.     to get a list of options.  To simply create the program objects,
  247.     type
  248.  
  249.       instemacs install
  250.  
  251.     This creates a folder called "New Things" on your desktop which
  252.     contains the new objects.  If you would like to create a shadow of
  253.     Emacs in your startup folder, you can additionally use the
  254.     "startup" option.  To automatically associate Emacsclient with
  255.     plain text files, use the "associate" option.  instemacs.cmd will
  256.     copy the current associatations of the OS/2 System Editor for
  257.     Emacsclient.  For Emacsclient to work, an instance of Emacs must
  258.     be running and the server must be active.  You will probably want
  259.     to put the line
  260.  
  261.       (server-start)
  262.  
  263.     in your site-start.el file (see below) and use the "startup"
  264.     option.
  265.  
  266.     In a standard OS/2 installation, the OS/2 System Editor is
  267.     automatically associated with text files so that double clicking a
  268.     text file opens the System Editor.  You can specify the
  269.     "makedefault" option when calling instemacs.cmd to make
  270.     Emacsclient the default "view" for text files.
  271.  
  272.     NOTE: The "makedefault" option of instemacs.cmd manipulates the
  273.     Workplace Shell associations in an undocumented way by directly
  274.     accessing certain values in OS2.INI.  This has only been tested
  275.     under OS/2 2.1 GA (US version).  There is no guarantee that this
  276.     will work on any other version of OS/2.  But then there is no
  277.     guarantee that any of the programs in this package will work at
  278.     all, anyway :-).
  279.  
  280.     Note that instemacs.cmd creates the program objects in such a way
  281.     that emacs.exe is started as a Presentation Manager program,
  282.     although it is actually a text mode program.  This is because
  283.     emacs.exe actually calls pmemacs.exe to provide the PM interface.
  284.     If emacs.exe were started as a text mode program, it would have
  285.     its own VIO window, which is usually useless.
  286.  
  287.     Starting emacs.exe as a PM program has two known disadvantages:
  288.  
  289.     (a)  You don't see the standard output of emacs.exe.  If Emacs
  290.          crashes for any reason, you won't see any diagnostics or
  291.          error messages and you can't tell Emacs to auto-save (if it
  292.          happens to ask).
  293.  
  294.     (b)  If you double click on the Emacs object when Emacs is already
  295.          running and a session bond between emacs.exe and pmemacs.exe
  296.          has not been established (see pm-session-bond below), you
  297.          will not bring the Emacs window to the foreground but
  298.          something else, usually the Window List.  Double clicking on
  299.          Emacs in the Window List works, of course.
  300.  
  301.     If you feel you would like a more conventional program object for
  302.     Emacs, you can use the "keepvio" option of instemacs.cmd.  This
  303.     causes the Emacs object to start emacs.exe in a minimized VIO
  304.     window.  This solves problem (a) and changes problem (b) to the
  305.     problem (b') that double clicking on the Emacs object shows the VIO
  306.     window of emacs.exe, not the PM Window you are really interested
  307.     in.
  308.  
  309.     If all this sounds too complicated to you, simply try
  310.     instemacs.cmd with and without the "keepvio" option and see which
  311.     way you like it better.  Calling instemacs.cmd again does not
  312.     create new objects but updates the existing objects according to
  313.     the options.  You can also use this feature if you accidentally
  314.     change the settings of the Emacs object or lose the icon.
  315.  
  316.  
  317. Customizing GNU Emacs
  318. =====================
  319.  
  320. You should customize \emacs\19.25\lisp\site-start.el, the startup file
  321. of GNU Emacs.  The statements in that file are executed automatically
  322. each time GNU Emacs is started.  Moreover, you can put personal
  323. settings into a file named .emacs file in your home directory (set by
  324. the HOME environment variable).
  325.  
  326. Sample site-start.el file:
  327.  
  328. ---------------------------------------------------------------------
  329. (set-input-mode nil nil 1)                            ; [1]
  330. (setq default-frame-alist                             ; [2]
  331.       (append '((altgr-modifier . meta))
  332.               default-frame-alist))
  333. (standard-display-8bit 128 254)                       ; [3]
  334. (aset standard-display-table 256 16)                  ; [4]
  335. (aset standard-display-table 257 31)
  336. (aset standard-display-table 259 24)
  337. (add-hook 'server-request-hook                        ; [5]
  338.           '(lambda ()
  339.              (make-frame-visible)
  340.              (focus-frame (selected-frame))))
  341. (add-hook 'dired-load-hook 'emx-dired-kur-ls-setup)   ; [6]
  342.  
  343. (autoload 'os2help "os2help" "OS/2 on-line help" t)   ; [7]
  344. (setq os2help "/emx/book/emxdoc.ndx")
  345. (global-set-key [C-f1] 'os2help)
  346.  
  347. (if window-system                                     
  348.     (progn
  349.       (pm-edit-menu)                                  ; [8]
  350.       (pm-file-menu)                                  ; [9]
  351.       ;;(remove-from-window-list)                     ; [10]
  352.       (pm-session-bond t)                             ; [11]
  353.       (set-face-background 'modeline "red")           ; [12]
  354.       (set-face-foreground 'modeline "yellow")))
  355. ---------------------------------------------------------------------
  356.  
  357. Notes:
  358.  
  359. [1]   Enable 8-bit input.  set-input-mode must be called when running
  360.       Emacs -- calling it before dumping doesn't work
  361.  
  362. [2]   Use the right ALT key of non-US keyboards as META key.  This
  363.       does not work for all key combinations.  Note that the right ALT
  364.       key of US keyboards is equivalent to the left ALT key.  Add new
  365.       parameters to the front of the list
  366.  
  367. [3]   Display characters 128 through 254 as-is.  Without this
  368.       statement, octal notation is used for these characters
  369.  
  370. [4]   Use special symbols (which are not displayed as-is when
  371.       occurring in a buffer) for truncated screen lines (256),
  372.       continued lines (257), and for displaying control characters
  373.       notation (259)
  374.  
  375. [5]   Raise frame to the foreground if emacsclient requests a buffer
  376.  
  377. [6]   Use Kai Uwe Rommel's OS/2 port of GNU ls (GNU file utilities)
  378.       for dired.  If you are using a version of ls where the output of
  379.       `ls -l' is Unix-compatible, you should not use that line
  380.  
  381. [7]   Use C-f1 to invoke OS/2 on-line help.  You have to set the
  382.       os2help variable to point to an EPM index file.  See os2help.el
  383.       for details
  384.  
  385. [8]   Modify the Edit menu of the menu bar to use the OS/2 clipboard
  386.       for Cut, Copy, and Paste
  387.  
  388. [9]   Modify the File menu of the menu bar to use OS/2's standard file
  389.       dialog for `Open File...' and `Save Buffer As...'
  390.  
  391. [10]  Remove emacs.exe from the Window List.  See below for a
  392.       discussion of advantages and disadvantages.  In the default
  393.       site-start.el file, this statement is disabled.  You might want
  394.       to uncomment this statement if you use the PM interface and
  395.       don't run Emacs manually.  If you enable
  396.       remove-from-window-list, you should disable pm-session-bond
  397.  
  398. [11]  Establish a bond between emacs.exe (the VIO window) and
  399.       pmemacs.exe (the PM windows).  If you select emacs.exe, for
  400.       instance by using the Window List, one of the PM windows will be
  401.       selected instead of emacs.exe
  402.  
  403. [12]  Make the mode line yellow on red
  404.  
  405.  
  406. About file names
  407. ================
  408.  
  409. All file names are translated to lower case.  This is required as GNU
  410. Emacs thinks that non-equality of file names implies non-identity of
  411. files.  Under OS/2 and DOS, however, letter case does not matter in
  412. file names.  To keep the letter case in file names on HPFS, see
  413. `Choosing the backup type'.
  414.  
  415. Better use forward slashes (/) instead of backslashes (\) in path
  416. names as some places where Emacs checks for / might have slipped my
  417. attention.
  418.  
  419. Emacs doesn't know that trailing dots in file names are ignored by
  420. OS/2.  It believes that "foo" and "foo." are different files, a belief
  421. it probably shares with quite a few OS/2 users.
  422.  
  423.  
  424. Choosing a PM font
  425. ==================
  426.  
  427. A font is specified by size (printer's points), simulated appearance
  428. (bold or italic, optional) and name:
  429.  
  430.   SIZE[.bold][.italic]NAME
  431.  
  432. Alternatively, you can use the "Host Portable Character
  433. Representation" for font names, for instance
  434.  
  435.   -*-Courier-medium-r-normal--*-100-*-*-m-*-cp850
  436.  
  437. Examples of fixed-spaced bitmap fonts:
  438.  
  439.   8.Courier
  440.   10.Courier
  441.   10.System Monospaced
  442.   12.bold.Courier                 (Simulated bold font)
  443.   12.Courier Bold                 (Real bold font)
  444.   8.System VIO                    (OS/2 2.1)
  445.   6.Small                         (see below)
  446.  
  447. As the plain, bold, and italic variations of the PM fonts have
  448. different character widths, mixing fonts in a frame isn't a good
  449. idea.  The character widths of all fonts are forced to the character
  450. width of the default font.  When defining a face with a font which is
  451. wider than the default font, there will be problems: some characters
  452. will be displayed only partially and characters may overlap.  Fonts
  453. which are smaller than the default font, however, can be used without
  454. problems.  For instance, you can use "8.bold.System Monospaced" as
  455. bold font when using "10.Courier" as default font ("10.bold.Courier"
  456. is too wide).  Using italic fonts is not recommended.
  457.  
  458. Simulated italic fonts are much slower than real italic fonts.  Only
  459. "12.Courier Italic" and "12.Courier Bold Italic" are real italic
  460. fixed-width bitmap fonts.
  461.  
  462. The smallest fixed-width VGA bitmap font of OS/2 2.0 ("8.Courier") is
  463. rather big.  A small font ("6.Small") is available for anonymous ftp:
  464.  
  465.   ftp-os2.cdrom.com: os2/all/graphics/smallfnt.zip    -- or --
  466.   ftp-os2.cdrom.com: os2/all/graphics/small.zip
  467.  
  468. Unfortunately, the first release of that font (smallfnt.zip) has a bug
  469. in the font metrics: the maximum ascender height is wrong.  This bug
  470. has been fixed on 15-Jun-1992, but the old version of small.fon is
  471. still widely available.  After unpacking and before installing
  472. small.fon, you should use the following command to fix that bug:
  473.  
  474.   patch \emacs\19.25\emx\small.pat /a
  475.  
  476. Use the OS/2 program named PATCH.EXE, not the Unix tool of the same
  477. name.  If the patch cannot be applied, you probably have a fixed
  478. version.
  479.  
  480. Using outline fonts (such as "9.Courier") is not recommended because
  481. that's too slow.  Proportional fonts (such as "10.Tms Rmn") cannot be
  482. used.
  483.  
  484. To set the default font of a frame, set the `font' frame parameter.
  485. Example:
  486.  
  487.   (setq default-frame-alist
  488.         (append '((font . "8.Courier")) default-frame-alist))
  489.  
  490. If the font does not exist, "10.Courier" is used instead as default
  491. font.  If you use the "Host Portable Character Representation" for the
  492. name of the default font, Emacs automatically chooses (simulated) bold
  493. and italic variants of that font.  Example:
  494.  
  495.   emacs -d -fn -*-Courier-medium-r-normal--*-100-*-*-m-*-cp850
  496.  
  497. You can use a popup menu to select the default font: Click mouse
  498. button 3 (that's the middle mouse button, by default) while depressing
  499. the CONTROL key (C-down-mouse-3).  The menu contains all fixed-width
  500. bitmap fonts of OS/2 2.1, plus "6.Small".
  501.  
  502. To change the font of a face, use set-face-font.  However, you can use
  503. only fonts reported by the pm-list-fonts function.  Examples:
  504.  
  505.   (set-face-font 'bold "10.bold.Courier")
  506.   (set-face-font 'italic "10.italic.Courier")  ; NOT RECOMMENDED!
  507.  
  508.  
  509. The keyboard
  510. ============
  511.  
  512. In text mode, the ALT keys generate the A- modifier (alt).  Load
  513. emx-meta.el to use the ALT keys to generate the M- modifier (meta):
  514. Put
  515.  
  516.   (load "emx-meta.el")
  517.  
  518. into your .emacs or site-start.el file.  This works only for a subset
  519. of the keys.  It does not work with the CTRL key.
  520.  
  521. The rest of this section applies to PM mode.
  522.  
  523. The modifiers generated by the ALT keys are configurable.  There are
  524. two ALT keys, the left ALT key and the right ALT key.  The right ALT
  525. key is called AltGr or AltCar on most non-US keyboards.  On these
  526. keyboards, the right ALT key is used for entering special symbols.  On
  527. the US keyboard, the right ALT key is equivalent to the left ALT key.
  528.  
  529. We'll use the term `ALT key' for both ALT keys of the US keyboard.
  530. For keyboards which have an AltGr or AltCar key, we'll call the left
  531. ALT key `ALT key' and the right ALT key `ALTGR key'.
  532.  
  533. The modifier for the ALT key (both ALT keys on the US keyboard, that
  534. is) is set with the `alt-modifier' frame parameter.  For instance, use
  535. the following code to use the ALT key for generating the A- (alt) modifier:
  536.  
  537.   (setq default-frame-alist
  538.         (append '((alt-modifier . alt)) default-frame-alist))
  539.  
  540. By default, the ALT key is used for generating the M- (meta)
  541. modifier.
  542.  
  543. The modifier for the ALTGR key (which isn't present on the US
  544. keyboard) is set with the `altgr-modifier' frame parameter.  For
  545. instance, use the following code to use the ALTGR key for generating
  546. the A- (alt) modifier:
  547.  
  548.   (setq default-frame-alist
  549.         (append '((altgr-modifier . alt)) default-frame-alist))
  550.  
  551. As ALTGR is treated specially by the operating system, you cannot use
  552. it with arbitrary keys.  Usually you can use it together with a subset
  553. of the letter and digit keys to generate the modifier set with
  554. altgr-modifier.  If the CTRL key is down, ALTGR is ignored for most
  555. keys.
  556.  
  557. Suppose that '((alt-modifier . meta) (altgr-modifier . hyper)) is in
  558. effect.  Then, you'll get the following table of keys vs. events:
  559.  
  560.   Left ALT │ Right ALT │ CTRL │ Key ││ US keyboard │ German keyboard
  561.   ─────────┼───────────┼──────┼─────┼┼─────────────┼─────────────────
  562.      X     │     -     │  -   │  a  ││   M-a       │   M-a
  563.      X     │     -     │  X   │  a  ││   M-C-a     │   M-C-a
  564.      -     │     X     │  -   │  a  ││   M-a       │   H-a
  565.      -     │     X     │  X   │  a  ││   M-C-a     │   C-a
  566.      -     │     X     │  -   │  f2 ││   M-f2      │   f2
  567.      -     │     X     │  -   │  q  ││   M-q       │   @
  568.      -     │     X     │  -   │  q  ││   M-C-q     │   C-@
  569.  
  570. The locations of the keys C-[ C-] C-\ etc. on non-US keyboards depend
  571. on whether you are using the PM version or the text mode version of
  572. Emacs: With the PM version, you can type those keys with
  573. CTRL+ALTGR+<whatever> (example: C-] is on CTRL+ALTGR+<9> of the German
  574. keyboard), where ALTGR is the right ALT key.  With the text mode
  575. version, pretend that you have a US keyboard (example: C-] is on
  576. CTRL+<+> of the German keyboard).
  577.  
  578. If you want to bind keys depending on the keyboard layout, use the
  579. keyboard-type function.
  580.  
  581.  
  582. Changing the window size
  583. ========================
  584.  
  585. To change the window size in text mode, type
  586.  
  587.     mode co80,x
  588.  
  589. where x is the number of lines.  Example: mode co80,40
  590.  
  591. To change the window size in PM mode, simply resize the window using
  592. the mouse or the keyboard (Alt+F8).  You can set the default size with
  593. the `width' and `height' frame parameters in site-init.el or .emacs:
  594.  
  595.   (setq default-frame-alist
  596.         (append '((width . 80) (height . 40))
  597.                 default-frame-alist))
  598.  
  599. You can set the default position with the `top' and `left' frame
  600. parameters.  See the documentation of set-frame-position for details.
  601.  
  602.  
  603. Choosing the backup type
  604. ========================
  605.  
  606. You might want to use
  607.  
  608.   (setq backup-by-copying t)
  609.  
  610. This has three advantages under OS/2:
  611.  
  612. -  the letter case of the name of the file is retained (normally, GNU
  613.    Emacs for emx uses lower-case file names)
  614.  
  615. -  the extended attributes of the file are retained
  616.  
  617. -  when editing .CMD files, the Workplace Shell does not change
  618.    program objects to point to the backup of the edited file
  619.  
  620. There are two known disadvantages under OS/2:
  621.  
  622. -  the extended attributes of the backup file are lost
  623.  
  624. -  the letter case of the file name is lost for the backup file
  625.  
  626. You can choose: Either keep the extended attributes and the letter
  627. case of the file name of the new file or of the backup file.
  628.  
  629.  
  630. Text mode vs. binary mode
  631. =========================
  632.  
  633. This port of GNU Emacs supports two types of files: binary files and
  634. text files.  As GNU Emacs is a text editor, you'll work with text
  635. files most of the time.  Therefore, you don't have to know the ugly
  636. details unless you want to edit a binary file.
  637.  
  638. When reading a text file, each CR/LF pair is converted to a LF.  If
  639. the last character of the file is a Ctrl-Z, that character is
  640. removed.
  641.  
  642. When writing a text file, each LF is replaced with a CR/LF pair.  A
  643. Ctrl-Z is not appended as that has been obsolete for years.
  644.  
  645. No conversion is done when reading or writing a binary file.
  646.  
  647. The emx-add-binary-mode function is used to define an additional
  648. regular expression for files which should be read and written in
  649. binary mode.  Example:
  650.  
  651.   (emx-add-binary-mode "\\.exe$")
  652.   (emx-add-binary-mode "\\.gz$")
  653.   (emx-add-binary-mode "\\.[Zz]$")
  654.  
  655. This example will make Emacs use binary mode for file names ending
  656. with .exe, .gz, .z or .Z.  Initially, binary mode is used for file
  657. names matching the following regular expressions:
  658.  
  659.   \.elc$
  660.   \.tar$
  661.   \.gz$
  662.   \.[zZ]$
  663.  
  664. You can use emx-remove-binary-mode to remove an entry from the list of
  665. regular expressions for identifying binary files.  For instance,
  666.  
  667.   (emx-remove-binary-mode "\\.[Zz]$")
  668.  
  669. cancels
  670.  
  671.   (emx-add-binary-mode "\\.[Zz]$")
  672.  
  673. Note that the spelling of the regular expression must exactly match
  674. the spelling of the regular expression to be removed.
  675.  
  676. The buffer-local variable emx-binary-mode controls whether to use text
  677. mode or binary mode.  If the variable is nil (which is the initial
  678. value), text mode is used.  If the variable is t, binary mode is used.
  679.  
  680. When inserting a binary file (i.e., a file whose name matches one of
  681. the regular expressions defined by emx-add-binary-mode) into a buffer,
  682. emx-binary-mode is set to t.  The value of emx-binary-mode of that
  683. buffer will stay t until changed.  This also applies to visiting a
  684. file.  In other words, a buffer is switched to binary mode when
  685. visiting or inserting a binary file.  A file is read in binary mode if
  686. the target buffer is in binary mode or if the file is a binary file.
  687.  
  688. When writing a file (e.g., by saving the buffer or by calling
  689. write-region), binary mode is used if the source buffer is in binary
  690. mode or if the file is a binary file (i.e., the name matches one of
  691. the regular expressions defined by emx-add-binary-mode).  The
  692. emx-binary-mode variable of the buffer is set temporarily while
  693. writing the file and reverts to the previous value after writing the
  694. file.
  695.  
  696. To insert a text file into a buffer which is in binary mode, manually
  697. set the emx-binary-mode variable to nil.
  698.  
  699. You can use find-file-binary to visit a file in binary mode.
  700.  
  701.  
  702. Code pages
  703. ==========
  704.  
  705. cp850.el, which is loaded by default, defines a syntax table and a
  706. case table for code page 850.
  707.  
  708. To enter accented characters which are not supported by your keyboard,
  709. load cp850acc and invoke cp850-accents-mode.
  710.  
  711. Emacs uses the default code page for keyboard input and for display.
  712. Use the current-code-page function to get the current code page.  The
  713. list-code-pages function returns a list of available code pages.
  714.  
  715. Use the set-code-page command to set the code page for keyboard input
  716. and for display.  Note that the process code page is not changed;
  717. therefore set-code-page does not affect translation of file names and
  718. the code page of child processes.  Moreover, the syntax tables and
  719. case translation tables of Emacs are not affected by set-code-page.
  720.  
  721. In PM mode, there are additional code pages available, such as 1004
  722. (Windows) and several EBCDIC code pages.  Better don't use the EBCDIC
  723. code pages, because Emacs talks ASCII.  All buffers, windows, and
  724. frames share the same code page.  Note that the `cp850' part of font
  725. names is ignored; the current code page is used for all fonts.
  726.  
  727.  
  728. Using shell mode
  729. ================
  730.  
  731. GNU Emacs uses the shell (command processor) pointed to by the SHELL
  732. environment variable.  I recommend using a Unix-like shell, like bash
  733. or the Data Logic shell, which are available for anonymous ftp:
  734.  
  735.   ftp-os2.cdrom.com: os2/2_x/unix/shells/bash.zip
  736.   ftp-os2.cdrom.com: os2/all/unix/shells/ms_sh22.zip  (or later)
  737.  
  738. To run an OS/2 command prompt (using cmd.exe as shell) in an Emacs
  739. window, use the cmd command defined in emx-cmd.el.
  740.  
  741.  
  742. Using the clipboard
  743. ===================
  744.  
  745. To use the OS/2 clipboard, the following functions are provided:
  746.  
  747.   Function │ Default key │ Description
  748.   ─────────┼─────────────┼───────────────────────────────────────
  749.   pm-copy  │ C-insert    │ Copy the region to the clipboard
  750.   pm-cut   │ S-delete    │ Copy the region to the clipboard,
  751.            │             │ then delete the region
  752.   pm-paste │ S-insert    │ Paste text from the clipboard at point
  753.  
  754. Note that several OS/2 programs cannot handle more than 64KB of text
  755. in the clipboard.  Therefore you should avoid copying more than 64KB
  756. of text.
  757.  
  758. You can let the Cut, Copy, and Paste choices of the Edit menu of the
  759. menu bar use the clipboard.  This is done by calling the pm-edit-menu
  760. function, as done by the default site-init.el file.  If you want the
  761. original Edit menu, remove the invocation of pm-edit-menu from
  762. site-init.el.
  763.  
  764.  
  765. Using emacsclient
  766. =================
  767.  
  768. emacsclient has two new command line options:
  769.  
  770.   -s   Don't switch the focus back to emacsclient when saying "Done"
  771.        for a buffer (C-x #).  This option is ignored if -w is used
  772.  
  773.   -w   Don't wait for saying "Done" (C-x #)
  774.  
  775. When using emacsclient as default OS/2 editor (by associating it with
  776. various file types as explained in the OS/2 documentation), you should
  777. use either the -s or the -w option.
  778.  
  779.  
  780. Using Ispell
  781. ============
  782.  
  783. You can get an emx port of the spelling checker Ispell by anonymous
  784. ftp:
  785.  
  786.   ftp-os2.cdrom.com: os2/2_x/unix/unixutils/isp3009b.zip
  787.  
  788. It is no longer required to patch ispell.el of isp3009b.zip -- you
  789. should use the ispell.elc file that comes with GNU Emacs.  To use
  790. Ispell, add the following statement to your .emacs or site-start.el
  791. file, using correct pathnames:
  792.  
  793. ---------------------------------------------------------------------
  794. (setq ispell-program-name "c:/ispell/ispell.exe")
  795. ---------------------------------------------------------------------
  796.  
  797.  
  798. Using AUC TeX
  799. =============
  800.  
  801. 1. Unpack the AUC TeX files (of auctex_9_0v.tar.gz or later) into
  802.    \emacs\auctex
  803.  
  804. 2. Modify tex-site.el by copying the following Emacs Lisp code to
  805.    tex-site.el.  Some of the variables need customization: Modify the
  806.    variable `TeX-lisp-directory' to point to the directory where you
  807.    have put the AUC TeX files.  Modify the variable `TeX-macro-global'
  808.    to point to the TeX inputs directory.  Modify `emx-TeX-command' if
  809.    you do not use tex386 or if you want to use command line options
  810.    such as `-mt16000' for all invocations of TeX.  Add your printer to
  811.    `TeX-printer-list'.  Modify `LaTeX-command-style' for your LaTeX
  812.    format files.  For instance, you can insert command line options
  813.    such as `-mt16000' before the `&' character.
  814.  
  815.    Alternatively, you can set `LaTeX-command-style' as indicated in
  816.    tex-site.el if you prefer to invoke TeX by running batch files such
  817.    as latex.cmd.
  818.  
  819. ---------------------------------------------------------------------
  820. (setq emx-TeX-command "tex386")
  821. (setq TeX-shell (if (eq emx-system-type 'os2) "cmd.exe" "command.com"))
  822. (setq TeX-lisp-directory "c:/emacs/auctex/")
  823. (setq TeX-macro-global '("c:/emtex/texinput/"))
  824. (setq TeX-print-command "prthplj %s")
  825. (setq TeX-printer-list '(("lj" "prthplj %s")
  826.                          ("fx" "prtfx %s")
  827.                          ("ps" "dvips -o lpt1 %s")))
  828. (setq TeX-view-style
  829.       (list (list "." (if (eq emx-system-type 'os2)
  830.                           "vp %d" "v %d"))))
  831. (setq TeX-command-list
  832.       (list (list "TeX" "tex386 \\nonstopmode\\input %t" 'TeX-run-TeX nil t)
  833.             (list "TeX Interactive" "tex386 %t" 'TeX-run-interactive nil t)
  834.             (list "LaTeX" "%l \\nonstopmode\\input{%t}" 'TeX-run-LaTeX nil t)
  835.             (list "LaTeX Interactive" "%l %t" 'TeX-run-interactive nil t)
  836.             (list "LaTeX2e" (emx-make-TeX-command
  837.                              "&latex2e \\nonstopmode\\input{%t}")
  838.                   'TeX-run-LaTeX nil t)
  839.             (list "View" "%v " 'TeX-run-background t nil)
  840.             (list "Print" "%p " 'TeX-run-command t nil)
  841.             (list "BibTeX" "bibtex %s" 'TeX-run-BibTeX nil nil)
  842.             (list "Index" "makeindx %s" 'TeX-run-command nil t)
  843.             (list "Check" "lacheck %s" 'TeX-run-compile nil t)
  844.             (list "Spell" "<ignored>" 'TeX-run-ispell nil nil)
  845.             (list "Other" "" 'TeX-run-command t t)
  846.             ;; Not part of standard TeX.
  847.             (list "Makeinfo" "makeinfo %t" 'TeX-run-compile nil t)
  848.             (list "AmSTeX" "tex386 ^&amstex \\nonstopmode\\input %t"
  849.                   'TeX-run-TeX nil t)))
  850.  
  851. (setq LaTeX-command-style
  852.       (mapcar (function (lambda (arg)
  853.                           (list (car arg)
  854.                                 (emx-make-TeX-command (nth 1 arg)))))
  855.               '(("^ams" "&amslatex")
  856.                 ("^foils$" "&foiltex")
  857.                 ("^slides$" "&splain")
  858.                 ("^plfonts\\|plhb$" "&platex")
  859.                 ("." "&lplain"))))
  860. ---------------------------------------------------------------------
  861.  
  862. 3. Change to the directory \emacs\auctex and run instauctex:
  863.  
  864.      cd \emacs\auctex
  865.      instauctex
  866.  
  867.    The instauctex script assumes that the command "emacs" runs
  868.    emacs.exe.  It does not work with emacs.cmd, for instance, if you
  869.    happen to have such a thing in your PATH.
  870.  
  871. 4. Add the following lines to your .emacs or site-start file:
  872.  
  873.      (setq load-path (append '("c:/emacs/auctex") load-path))
  874.      (setq Info-default-directory-list
  875.            (append Info-default-directory-list
  876.                    '("j:/emacs/auctex/doc")))
  877.      (require 'tex-site)
  878.  
  879. 5. Add the following line to the `dir' file in \emacs\19.25\info or to
  880.    your private `dir' file:
  881.  
  882.      * AUC TeX: (auctex).  A much enhanced LaTeX mode for GNU Emacs.
  883.  
  884. 6. Kill and restart GNU Emacs.
  885.  
  886.  
  887. Sending and receiving mail
  888. ==========================
  889.  
  890. No setup is required for receiving mail with IBM TCP/IP 2.0 for OS/2.
  891. For sending mail with IBM TCP/IP 2.0 for OS/2, you should add the lines
  892.  
  893.   # errors: mail
  894.   Oem
  895.  
  896. to your \tcpip\etc\sendmail.cf file, after the heading
  897.  
  898.   ###############
  899.   #   Options   #
  900.   ###############
  901.  
  902. That option makes sendmail mail back errors.
  903.  
  904.  
  905. Removing the VIO window from the Window List
  906. ============================================
  907.  
  908. Call the remove-from-window-list function to remove the session in
  909. which emacs.exe is running (a VIO window, usually) from the Window
  910. List.  The advantage of this is having fewer entries in the Window List
  911. -- it will be simpler to locate the PM windows of Emacs.
  912.  
  913. On the other hand, double-clicking on the Emacs icon will start
  914. another instance of Emacs instead of bringing the current instance to
  915. the foreground.
  916.  
  917. You should not call remove-from-window-list when running Emacs
  918. manually (not by double-clicking on the Emacs icon) or when using
  919. Emacs in text mode (without -d option).
  920.  
  921. If you created your Emacs icon using instemacs.cmd without the
  922. "keepvio" option, calling remove-from-window-list is not necessary.
  923. The Emacs icon starts emacs.exe in a PM session so that it doesn't
  924. appear in the window list anyway.
  925.  
  926. Instead of calling remove-from-window-list, you might want to call
  927. pm-session-bond with a non-nil argument (t, for instance) to establish
  928. a bond between emacs.exe (the VIO window) and pmemacs.exe (the PM
  929. windows).  If you select emacs.exe, for instance by double clicking
  930. the Window List, one of the PM windows will be selected instead of
  931. emacs.exe.  After establishing the bond, you can select emacs.exe by
  932. clicking on the titlebar, by using the `Tile' or `Cascade' choice of
  933. the Window List, or by using the `Restore' choice of the Minimized
  934. Window Viewer.  You can break the bond by calling pm-session-bond with
  935. a nil argument.
  936.  
  937. Note: By default, site-start.el calls pm-session-bond to establish a
  938. bond between emacs.exe and pmemacs.exe.
  939.  
  940.  
  941. More environment variables
  942. ==========================
  943.  
  944. The user-name variable is initialized from the value of the USER
  945. environment variable.  If USER is not set, the LOGNAME environment
  946. variable is used.  If both USER and LOGNAME are not set, user-name is
  947. set to "unknown".
  948.  
  949. The user-full-name variable is initialized from the value of the
  950. USERFULLNAME environment variable.  If USERFULLNAME is not set,
  951. user-full-name is set to "unkown".
  952.  
  953.  
  954. Printing the manual
  955. ===================
  956.  
  957. Do you really want to print it?  It's 474 pages and does not contain
  958. more information than the on-line manual.  Here's how to print the
  959. manual:
  960.  
  961. 1. Get and install emTeX, including texb11.zip (see the emx
  962.    documentation for ftp locations)
  963.  
  964. 2. Get and install the gnuinfo.zip package for emx 0.8h
  965.  
  966. 3. Unpack e25man (see above)
  967.  
  968. 4. If you use an older version of emTeX, rename the texinfo files for
  969.    8.3 (emTeX supports long file names since beta 9):
  970.  
  971.      cd \emacs\19.25\man
  972.      ren *.texi *.tex
  973.      ren *.texinfo *.tex
  974.  
  975. 5. Typeset the manual:
  976.  
  977.      cd \emacs\19.25\man
  978.      texi2dvi emacs.texi                <-- using emTeX beta 9 or later
  979.      texi2dvi emacs.tex                 <-- using an ancient emTeX version
  980.  
  981. 6. Print the manual (this example is for the HP LaserJet).  See the
  982.    dvidrv documentation on how to print on both sides of the paper:
  983.  
  984.      cd \emacs\19.25\man
  985.      prthplj emacs
  986.  
  987.  
  988. Miscellaneous hints
  989. ===================
  990.  
  991. -   For best results, run emacs.exe from the drive where it is
  992.     installed -- you can change the drive in GNU Emacs.  If you run
  993.     Emacs from a drive different from the drive where it is installed,
  994.     you'll get the benign warning message
  995.  
  996.       Warning: lisp library (/emacs/19.25/lisp) does not exist.
  997.  
  998.     Ignore this message.
  999.  
  1000. -   Emacs is designed to be started once and never terminated.
  1001.     Therefore, you should add Emacs to the startup folder (use the
  1002.     startup option of instemacs.cmd) and never start it manually.  If
  1003.     you want to enter an OS/2 command to edit a file, use
  1004.     emacsclient.
  1005.  
  1006. -   To change the cursor size in text mode, put
  1007.  
  1008.       cursor -80 -100
  1009.  
  1010.     into a batch file which runs emacs.exe (unfortunately, cmd.exe
  1011.     changes the cursor size when displaying a prompt).  Negative
  1012.     cursor command line arguments are percentages -- the above example
  1013.     makes the cursor use the bottom 20% of the character cell.
  1014.  
  1015. -   The character `-' is not allowed in filenames on CDROM, `_' is
  1016.     used instead.  To let `load' automatically turn `-' into `_' and
  1017.     try again if a file is not found, set emx-cdrom-load to t.  When
  1018.     pre-installing Emacs on CDROM, it should be dumped with
  1019.     emx-cdrom-load set to t.
  1020.  
  1021. -   Don't put .el files into \emacs\19.25\lisp -- you'll have to move
  1022.     them when upgrading Emacs.  Instead, create a new directory, say
  1023.  
  1024.       \emacs\locallisp
  1025.  
  1026.     and add it to `load-path'.  This also applies to .info files.
  1027.  
  1028. -   Load the Lisp package "mldrag" for resizing windows by dragging
  1029.     the mode line with the mouse (see mldrag.el for details).
  1030.  
  1031.  
  1032. Additional features of GNU Emacs 19.25 for emx
  1033. ==============================================
  1034.  
  1035. Additional functions (see on-line help for details):
  1036.  
  1037.   current-code-page
  1038.   emacs-priority
  1039.   emx-add-binary-mode
  1040.   emx-remove-binary-mode
  1041.   file-name-valid-p
  1042.   filesystem-type
  1043.   get-ea
  1044.   get-ea-list
  1045.   get-ea-string
  1046.   keyboard-type
  1047.   list-code-pages
  1048.   pm-file-dialog
  1049.   pm-session-bond
  1050.   put-ea
  1051.   put-ea-list
  1052.   put-ea-string
  1053.   remove-ea
  1054.   remove-all-eas
  1055.   remove-from-window-list
  1056.   set-code-page
  1057.  
  1058. Additional variables (see on-line help for details):
  1059.  
  1060.   binary-process-input
  1061.   binary-process-output
  1062.   emx-binary-mode
  1063.   emx-binary-mode-list
  1064.   emx-system-type
  1065.   min-skip-run
  1066.   pm-align-menu-key-descriptions
  1067.   pm-popup-menu-align-top
  1068.   pm-color-alist
  1069.   process-priority
  1070.   program-name-handler-alist
  1071.  
  1072. Additional command line options for PM:
  1073.  
  1074.   -d                    Use windowing system (note: no argument!)
  1075.   -name NAME            Set name of frame (displayed in the titlebar)
  1076.   -font FONT            Select font
  1077.   -background COLOR     Select default background color
  1078.   -foreground COLOR     Select default foreground color
  1079.   -T NAME               See -name
  1080.   -fn FONT              See -font
  1081.   -fg COLOR             See -foreground
  1082.   -bg COLOR             See -background
  1083.  
  1084. Example:
  1085.  
  1086.   emacs -d -fg white -bg os2darkblue -fn 8.Courier myfile.c
  1087.  
  1088. Fonts:
  1089.  
  1090.   A font is specified by size (printer's points) and name:
  1091.  
  1092.    SIZE.NAME
  1093.  
  1094. Colors:
  1095.  
  1096.   See pm-color-alist in term/pm-win.el
  1097.  
  1098. Additional frame parameters for modify-frame-parameters and
  1099. default-frame-alist:
  1100.  
  1101.   Frame parameter  │ Type    │ Default    │ Description
  1102.   ─────────────────┼─────────┼────────────┼──────────────────────────────
  1103.   name             │ String  │            │ Window title
  1104.   font             │ String  │"10.Courier"│ Font
  1105.   background-color │ String  │ "white"    │ Default background color
  1106.   foreground-color │ String  │ "black"    │ Default foreground color
  1107.   alt-modifier     │ Symbol  │ meta       │ Modifier generated by left Alt key
  1108.   altgr-modifier   │ Symbol  │ alt        │ Modifier generated by AltGr key
  1109.   cursor-type      │ Symbol  │ box        │ Cursor type
  1110.   cursor-blink     │ Boolean │ t          │ Blinking cursor
  1111.   shortcuts        │ List    │ t          │ Enable F1, F10, A-f4, A-space etc.
  1112.   mouse-buttons    │ String  │ "132"      │ Swap mouse buttons
  1113.   height           │ Integer │ 25         │ Height of window, in lines
  1114.   width            │ Integer │ 80         │ Widtht of window, in columns
  1115.   left             │ Integer │            │ horizontal position, in pixels
  1116.   top              │ Integer │            │ vertical position, in pixels
  1117.   menu-bar-time-out│ Integer │ 5000       │ Time-out for menu bar updates (ms)
  1118.  
  1119. The value of a frame parameter of type Boolean should be either `t' to
  1120. enable the feature or `nil' to disable the feature.
  1121.  
  1122. Alt modifiers:
  1123.  
  1124.   alt           The ALT key generates the A- modifier
  1125.   meta          The ALT key generates the M- modifier
  1126.   hyper         The ALT key generates the H- modifier
  1127.   super         The ALT key generates the s- modifier
  1128.  
  1129.   
  1130. Cursor types:
  1131.  
  1132.   bar            A thin vertical bar
  1133.   box            A filled box (default)
  1134.   frame          The outline of a box
  1135.   underline      A horizontal line below the characters
  1136.   halftone       A filled box (gray)
  1137.  
  1138. Shortcuts:
  1139.  
  1140.   The Presentation Manager uses the keys F1, F10, Alt, AltGr,
  1141.   Alt+Space, and Alt+F4 through Alt+F11 as accelerator keys
  1142.   (shortcuts).  If you want to bind Emacs commands to those keys, you
  1143.   have to disable that special interpretation of those keys.  This is
  1144.   done with the `shortcuts' frame parameter.  The argument of
  1145.   `shortcuts' is either nil (all accelerator keys are disabled), t
  1146.   (all accelerator keys are enabled -- this is the default), or a list
  1147.   of keys to be enabled (all other accelerator keys are disabled).  To
  1148.   disable the accelerator keys Alt and AltGr (which can be quite
  1149.   annoying) while keeping all other accelerators, use the following
  1150.   cons (pair) in the list of frame parameters:
  1151.  
  1152.         (shortcuts . (f1 f10 alt-space alt-f4 alt-f5 alt-f6
  1153.                       alt-f7 alt-f8 alt-f9 alt-f10 alt-f11))
  1154.  
  1155.   Note that `alt' and `altgr' are missing in the list.
  1156.  
  1157. Mouse buttons:
  1158.  
  1159.   The argument of the mouse-buttons parameter is a string of 3
  1160.   characters.  The first character defines the event generated by the
  1161.   left mouse button, the second character defines the event generated
  1162.   by the middle mouse button (which doesn't exist on two-button mice),
  1163.   the third character defines the event generated by the right mouse
  1164.   button.  Each character is either 1 (mouse-1), 2 (mouse-2), 3
  1165.   (mouse-3) or a space (no event).  The default is "132", according to
  1166.   OS/2 conventions.  With this value, a two-button mouse cannot
  1167.   generate a mouse-3 event.
  1168.  
  1169. Time-out for menu bar updates:
  1170.  
  1171.   The Presentation Manager is blocked while pmemacs.exe waits for
  1172.   emacs.exe to compute a menu for the menu bar.  To avoid blocking the
  1173.   Presentation Manager for an excessive period of time, there is a
  1174.   time-out, after which pmemacs.exe creates a dummy menu, consisting
  1175.   of the disabled entry `(time-out)'.  You can adjust the time-out
  1176.   with the menu-bar-time-out frame parameter.  The value is given in
  1177.   milliseconds, the default value is 5000 (5 seconds).
  1178.  
  1179.   Note that menus can take quite a long time the first time they are
  1180.   invoked because keyboard equivalents have to be computed.  After a
  1181.   time-out, simply try again.  Increase the time-out value only if it
  1182.   is not appropriate for further invokations of the menus.
  1183.  
  1184. Example:
  1185.  
  1186.   (setq default-frame-alist
  1187.         (append '((background-color . "os2darkblue")
  1188.                   (foreground-color . "white")
  1189.                   (alt-modifier . alt)
  1190.                   (altgr-modifier . hyper)
  1191.                   (font . "8.Courier")
  1192.                   (mouse-buttons . "123")
  1193.                   (menu-bar-time-out . 2000)
  1194.                   (shortcuts . (alt-f4 alt-space)))
  1195.                 default-frame-alist))
  1196.  
  1197.  
  1198. Missing features, misfeatures, bugs
  1199. ===================================
  1200.  
  1201. - The emacs-priority variable is ignored.  Use the emacs-priority
  1202.   function instead.  Note that lisp/term/pm-win.el calls
  1203.   emacs-priority.
  1204.  
  1205. - interrupt-process doesn't work unless the process is an immediate
  1206.   child of Emacs or is an emx program.  Therefore,
  1207.   comint-interrupt-subjob (C-c C-c) doesn't work.
  1208.  
  1209. - Extended attributes are not preserved in files edited or copied.
  1210.  
  1211. - The timestamps of most events are always 0.  For some events, the
  1212.   timestamp is misused for internal purposes.  The timestamp is valid
  1213.   only for mouse button events.
  1214.  
  1215. - Scrollbars are not implemented.
  1216.  
  1217. - Several functions specific to X Windows are missing.
  1218.  
  1219. - OS/2 does not support all three-button mice.  Therefore, you can use
  1220.   only two buttons with certain mice.  RODENT.SYS, a shareware mouse
  1221.   driver written by Michael Lee Finney (m.finney@genie.geis.com)
  1222.   supports additional three-button mice.  Look for RODENT.ZIP or
  1223.   RODNT100.ZIP.  Unfortunately, the registration cost is likely to
  1224.   exceed the cost of a new mouse...
  1225.  
  1226. - Emacs doesn't know that trailing dots in file names are ignored by
  1227.   OS/2.  It believes that "foo" and "foo." are different files, a
  1228.   belief it probably shares with quite a few OS/2 users.
  1229.  
  1230. - ange-ftp doesn't work due to ftp's buffering of stdout and Emacs'
  1231.   prepending a drive letter.
  1232.  
  1233. - The client windows are not repainted while a popup menu is active.
  1234.  
  1235. - Coordinates reported for mouse events and used by x-popup-menu are
  1236.   character coordinates, not pixel coordinates.  However, characters
  1237.   are of size 1 by 1.  In consequence, menus usually appear in the
  1238.   correct location.
  1239.  
  1240. - OS/2's standard file dialog rejects file names starting with a dot.
  1241.  
  1242.  
  1243. Compiling GNU Emacs
  1244. ===================
  1245.  
  1246. The following programs are required for compiling GNU Emacs 19 for emx:
  1247.  
  1248.   - dmake 3.8
  1249.  
  1250.   - emx 0.8h with emxfix07 (or later), GCC 2.5.7 (or later), etc. for emx
  1251.  
  1252.   - GNU Bison 1.19 (or later)
  1253.  
  1254.   - GNU sed 1.16 (or later)
  1255.  
  1256.   - cat (GNU text utilities 1.9 or later)
  1257.  
  1258.   - cp, mv, rm, chmod (GNU file utilities 1.4 or later)
  1259.  
  1260. You can find all these programs on ftp.informatik.tu-muenchen.de,
  1261. somewhere under pub/comp/os/os2.
  1262.  
  1263. To compile GNU Emacs, you have to install the source code:
  1264.  
  1265.   cd \
  1266.   unzip a:e25src
  1267.  
  1268. To compile GNU Emacs, type
  1269.  
  1270.   cd \emacs\19.25
  1271.   configure
  1272.   cd lib-src
  1273.   make
  1274.   cd ..\src
  1275.   make
  1276.  
  1277. If emx-patch.el and emx-funcs.el have not been byte-compiled
  1278. (emx-patch.elc and emx-funcs.elc don't exist), the message
  1279.  
  1280.   Pure Lisp storage exhausted
  1281.  
  1282. may be displayed in the make step in the src directory.  Type
  1283.  
  1284.   temacs -batch -l emx-bc
  1285.  
  1286. to byte-compile these files.  Ignore the warning messages which start
  1287. with **.  Then, restart make.  IMPORTANT: emx-bc.el assumes that the
  1288. .el files are in ../lisp.
  1289.  
  1290. Before running the new emacs.exe in \emacs\19.25\src, you should type
  1291.  
  1292.   xcopy ..\etc\DOC ..\data\
  1293.  
  1294. To install GNU Emacs in \emacs\19.25\bin, run install.cmd.
  1295.  
  1296. If the GNU Emacs version number changes (e.g., from 19.83 to 19.84)
  1297. you have to edit the following files, replacing the old version number
  1298. with the new one:
  1299.  
  1300.   emx/FAQ
  1301.   emx/README
  1302.   emx/emx1.sed
  1303.   emx/emx4.sed
  1304.   src/dist.cmd
  1305.   src/install.cmd
  1306.  
  1307. To debug GNU Emacs, type
  1308.  
  1309.   gdb -s temacs -e emacs.exe
  1310.   source .gdbinit
  1311.   set args -d
  1312.  
  1313. Note that .gdbinit changes the command line arguments.  Therefore, you
  1314. should use "set args" after loading .gdbinit.
  1315.  
  1316. To do post-mortem debugging, type
  1317.  
  1318.   gdb -s temacs -e emacs.exe -c core
  1319.  
  1320. Note that emx.dll versions prior to revision index 14 don't create
  1321. usable core dump files for emacs.exe: the stack object is missing in
  1322. the core dump.
  1323.  
  1324. To make new distribution ZIP files, type
  1325.  
  1326.   cd \emacs\19.25\src
  1327.   install
  1328.   dist
  1329.   cd ..\emx
  1330.   make-dist
  1331.  
  1332.  
  1333. History
  1334. =======
  1335.  
  1336. Only changes specific to the emx port of GNU Emacs are listed here.
  1337. See etc/NEWS for more news.
  1338.  
  1339. 19.25 (08-Jun-1994)
  1340. -------------------
  1341.  
  1342. - Note that you should now use the variant of ispell.elc which comes
  1343.   with GNU Emacs.  If you are using Ispell, remove the Ispell-related
  1344.   statements from .emacs, default.el, and site-start.el, and set
  1345.   ispell-program-name instead
  1346.  
  1347. - The EMACSLOADPATH, EMACSDATA, and EMACSPATH environment variables
  1348.   are no longer required -- please delete them unless you want to
  1349.   override the or supplement the defaults directories, or put
  1350.   emacs.exe into a directory not related to the Emacs directory
  1351.   hierarchy.  The default directories are now relative to the
  1352.   directory from which emacs.exe is run
  1353.  
  1354. - Do not use AUC TeX 8.0 because powerkey.el won't work with GNU Emacs
  1355.   19.25.  Upgrade to AUC TeX 9.0!
  1356.  
  1357. - Support e-mail and news (NNTP) with IBM TCP/IP 2.0 for OS/2
  1358.  
  1359. - Drag & drop support has been added: you can now drop file objects on
  1360.   a PM Emacs window.  Up to 8 objects can be dropped at a time
  1361.  
  1362. - The emx-shell-regexp variable no longer exists.  A new variable,
  1363.   program-name-handler-alist, is now used instead.  See
  1364.   lisp/emx-patch.el and on-line help for program-name-handler-alist
  1365.   for details
  1366.  
  1367. - The last (third) version number is used to indicate the version
  1368.   number of the emx port: 19.25.1 is the first release of the emx port
  1369.   of GNU Emacs 19.25, 19.25.2 is the second release of the emx port of
  1370.   GNU Emacs 19.25, and so on.  The last version number is no longer
  1371.   incremented when dumping a new emacs.exe
  1372.  
  1373. - The `shortcuts' frame parameter can now enable accelerator keys
  1374.   individually
  1375.  
  1376. - Add `menu-bar-time-out' frame parameter
  1377.  
  1378. - Add `pm-align-menu-key-descriptions' variable for controlling the
  1379.   formatting of keyboard equivalents in submenus of the menu bar
  1380.  
  1381. - Add `pm-popup-menu-align-top' variable for controlling the
  1382.   positioning of popup menus.  The default is now to position the top
  1383.   item at the mouse position
  1384.  
  1385. - Add `pm-file-dialog' and `pm-file-menu' for using OS/2's standard
  1386.   file dialog
  1387.  
  1388. - Fix `oscillating frame' bug
  1389.  
  1390. - `~' in a menu is now visible (though underlined)
  1391.  
  1392. - Rename `pm-defined-color' to `pm-color-defined-p'
  1393.  
  1394. - Support UNC, again
  1395.  
  1396. - Add functions for selecting the code page
  1397.  
  1398. - jka-compr works now (on HPFS drives only)
  1399.  
  1400. - Bind `iconify-frame' to C-z in PM mode
  1401.  
  1402. - Files to be read and written in binary mode now include also those
  1403.   whose names end in .gz, .z, and .Z
  1404.  
  1405. - New functions: find-file-binary, emx-remove-binary-mode
  1406.  
  1407. - Add `binary-process-input' and `binary-process-output' variables
  1408.  
  1409. - `emx-binary-mode' is no longer reset to nil when changing the major
  1410.   mode of a buffer (`kill-all-local-variables').  The default value of
  1411.   `emx-binary-mode' can no longer be set with `set-default'
  1412.  
  1413. - The BACKTAB key (Shift+TAB) now generates a `backtab' event instead
  1414.   of `S-backtab'
  1415.  
  1416. - Modifying large buffers is now much faster
  1417.  
  1418. - Input is no longer echoed in CMD.EXE Shell mode (`cmd' command)
  1419.  
  1420. - Fix problems with expand-file-name and abbreviate-file-name
  1421.  
  1422. - The old-style menu bar is no longer supported; the command
  1423.   `pm-menu-bar-mode' is no longer available (use `menu-bar-mode'
  1424.   instead).  The `pm-menu-bar' frame parameter is no longer available
  1425.   (use `menu-bar-lines' instead)
  1426.  
  1427. - emacs-priority now supports another priority class: idle-time
  1428.  
  1429. - The priority of child processes is controlled by the
  1430.   process-priority variable
  1431.  
  1432. - make-temp-name no longer truncates the prefix on HPFS drives
  1433.  
  1434. - Add functions for retrieving, attaching, and removing extended
  1435.   attributes
  1436.  
  1437.  
  1438. 19.22 (25-Jan-1994)
  1439. -------------------
  1440.  
  1441. - Use the -O option (optimize) for compiling Emacs (the -O option got
  1442.   lost in version 19.20)
  1443.  
  1444. - Change instauctex.cmd for AUC TeX 8.0
  1445.  
  1446. - Align file names in the Buffers menu
  1447.  
  1448. - Simplify dump.cmd -- emxl.exe is now in emxrt.zip
  1449.  
  1450. - Apply patch for fixing the slowness of describe-bindings (C-h b)
  1451.  
  1452. - Disable the code which incorrectly set exec-directory
  1453.  
  1454. - New variable: emx-system-type
  1455.  
  1456. - Fix bug: the documentation of the functions defined in emx-patch.el
  1457.   and emx-funcs.el wasn't available
  1458.  
  1459. - The default value of emx-shell-regexp now includes COMMAND.COM and
  1460.   4DOS.COM.  Only lower-case letters should be used in emx-shell-regexp
  1461.   because `downcase' is applied to the file name
  1462.  
  1463. - Replace - with _ on CDROM for the `load' function, see emx-cdrom-load
  1464.  
  1465.  
  1466. 19.22
  1467. -----
  1468.  
  1469. - vc-register (C-x v i) now works again (vc-find-binary adapted)
  1470.  
  1471. - vc-version-other-window (C-x v ~) now works
  1472.  
  1473. - Add yet another key sequence for goto-line: f9 g
  1474.  
  1475. - Don't pass "-i" to cmd.exe in shell mode.  This solves the `error
  1476.   SYS1034' problem
  1477.  
  1478. - Attempt at fixing the `core dump while resizing' problem.  However,
  1479.   the echo area is now sometimes a few pixels too high
  1480.  
  1481. - Fix incompatibility with `FeelX 1.0'
  1482.  
  1483. - Use /emacs/19.22/data/DOC instead of /emacs/19.22/data/DOC-19.22.x.
  1484.   This simplifies installation on FAT and CDROM
  1485.  
  1486. - cp850acc.el added
  1487.  
  1488.  
  1489. 19.21
  1490. -----
  1491.  
  1492. - Fix mouse event bug: a wrong mouse position was reported in some
  1493.   cases
  1494.  
  1495. - Fix problem with (shortcuts . nil) in default-frame-alist being
  1496.   ignored for the inital frame
  1497.  
  1498. - Fix bug in handling of double clicks
  1499.  
  1500. - Fix bug in face management: Now each frame can have its own default
  1501.   font
  1502.  
  1503. - New function: emx-toggle-truncate-lines (f9 t)
  1504.  
  1505. - emacsserver now uses two threads instead of two processes
  1506.  
  1507.  
  1508. 19.19
  1509. -----
  1510.  
  1511. - Add FAQ file
  1512.  
  1513. - Fix instemacs.cmd bugs
  1514.  
  1515. - Fix documentation errors
  1516.  
  1517. - Fix multi-line PM menu bar bug
  1518.  
  1519. - Fix bug in window resizing logic.  This solves the problem of
  1520.   windows not repainting
  1521.  
  1522. - Make emx-binary-mode a buffer-local variable and replace file name
  1523.   handler with C code.  This avoids conflicts with other file name
  1524.   handlers
  1525.  
  1526. - Add emx-meta.el
  1527.  
  1528. - Support visible-bell
  1529.  
  1530. - Support popup menus created by functions invoked through the PM menu
  1531.   bar
  1532.  
  1533. - set-frame-position now sets the position of the client area instead
  1534.   of the position of the frame window
  1535.  
  1536. - Add remove-from-window-list and pm-session-bond
  1537.  
  1538. - Define more colors, rename OS/2 colors to avoid conflicts with X
  1539.   colors
  1540.  
  1541. - Automatically redefine some colors for 16-color displays
  1542.  
  1543. - Ignore blanks in color names
  1544.  
  1545. - pm-display-planes now returns the correct value
  1546.  
  1547. - Support of outline fonts improved
  1548.  
  1549. - Clip text output to reduce problems with italic fonts
  1550.  
  1551. - Use the face name instead of the family name for pm-list-fonts.
  1552.   Now, you can use the font "12.Courier Bold Italic", for instance, to
  1553.   get a real bold italic font instead of a simulated one
  1554.  
  1555. - Examples for setting default-frame-alist fixed: the new value should
  1556.   be added to the front of the list
  1557.  
  1558. - Support .inf file name extension for info files, run "gzip -d"
  1559.   instead of "gunzip"
  1560.  
  1561. - The default value of emx-shell-regexp now includes 4OS2.
  1562.  
  1563. - Add optional palette manager support.  If you want to play with the
  1564.   palette manager, define the constant USE_PALETTE_MANAGER when
  1565.   compiling pmemacs.c.  However, there are several drawbacks.  For
  1566.   instance, the cursor isn't displayed properly.  Therefore, palette
  1567.   manager support is disabled by default
  1568.  
  1569.  
  1570. Who did the emx port of GNU Emacs 19?
  1571. =====================================
  1572.  
  1573.   Eberhard Mattes
  1574.   Teckstrasse 81                                      (TeX: Teckstra{\ss}e)
  1575.   D-71696 Moeglingen                                  (TeX: M\"oglingen)
  1576.   Germany
  1577.  
  1578.   Internet: mattes@azu.informatik.uni-stuttgart.de
  1579.  
  1580. No telephone calls please! Include return postage (international
  1581. postal reply coupons for those outside Germany) and a self-addressed
  1582. envelope if you expect a reply.  GNU Emacs for emx is not available on
  1583. diskettes from the address given above.
  1584.  
  1585. An emx-related mailing list has been created: emx-list.  The address
  1586. for people to request to be added to or removed from the list is:
  1587.  
  1588.   listserv@eb.ele.tue.nl
  1589.  
  1590. To subscribe, send a message containing
  1591.  
  1592.   sub emx-list Joe User
  1593.  
  1594. to listserv@eb.ele.tue.nl.  Of course, you should use your name instead
  1595. of Joe User's name.  To unsubscribe, send a message containing
  1596.  
  1597.   unsub emx-list
  1598.  
  1599. to listserv@eb.ele.tue.nl.
  1600.  
  1601. As there is currently no mailing list for the emx port of GNU Emacs,
  1602. you can use the emx mailing list.  However, you should use the general
  1603. GNU Emacs mailing lists for general GNU Emacs questions.
  1604.  
  1605. No warranty, see COPYING for details.
  1606.  
  1607. ---------------------------------- END ---------------------------------------
  1608.