home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / me34src.zip / me3 / readme.os2 < prev   
Text File  |  1995-01-21  |  6KB  |  144 lines
  1.                                 -*-text-*-
  2.  
  3. The is the README for an OS/2 port of ME3.  It contains sources and
  4. patches for
  5.     ME3 (the Mutt Editor v3.4)
  6.     MC2 (the Mutt Compiler v2.6)
  7.     Mutt extensions to ME3 (v1.4)
  8.  
  9. The package has the full, unpatched Unix distribution, including the
  10. compute server, which doesn't work under OS/2.
  11.  
  12. See the README file for more information.
  13. See the file me34exe.zip (uploaded to hobbes.nmsu.edu along with these
  14. sources) for pre-compiled binaries.
  15.  
  16. To exit any emacs-style editor, press Ctrl-X Ctrl-C.
  17.  
  18. This port was done using the EMX version of the GNU C compiler.  You will
  19. have to change some of the code if you want to compile with another
  20. compiler (I've given some hints below).  The supplied makefiles are
  21. set up to build three configurations:
  22.     emx-mt  builds an OS/2-only executable.  C library functions are
  23.         taken from emxlibc.dll, which makes the executable a little
  24.         smaller.  emx.dll and emxlibc.dll are both required to run.
  25.         Get them from emxrt.zip, which should be somewhere at hobbes.
  26.         The editor and macro-compiler are in the bin directory of
  27.         this distribution.
  28.     emx-st  builds an OS/2-only executable.  The executable is about 30K
  29.         bigger than the emx-mt one, but emx and emxlibc aren't
  30.         required, so this will take less space if you don't have the
  31.         .dlls already.  The editor and macro compiler are in the
  32.         bin/static directory of this distribution.
  33.     emx-dos builds an executable which can run under both DOS and OS/2.
  34.         DOS requires emx.exe, and OS/2 requires emx.dll.  In a DPMI
  35.         environment (eg, Windows or OS/2 DOS box), use rsx.exe
  36.         instead of emx.exe for the DOS extender.  The video in this
  37.         version is a bit slower than the OS/2-only versions (with
  38.         RSX, the video in this version is a bit of a joke -- get
  39.         rsxwin and see if that's any better).  The editor and macro
  40.         compiler are in the dos directory of this distribution.
  41.  
  42. The original OS/2 port of ME was done by John Burnell.  This port was done
  43. by Patrick TJ McPhee, ptjm@io.org  (Toronto  Canada)
  44.  
  45. ME expects to find .mco (compiled macros) files in a directory called
  46. c:/me3.  You can set an environment variable to change its idea of where
  47. to look:
  48.  ME3=c:/tools/me3;c:/projects/me3;t:/editors/macros/me3
  49.  
  50. Under DOS, with emx.exe, you need to set another environment variable:
  51.  EMXOPT=-acm
  52. I tried binding it into the executable, but that makes rsx.exe blow up.
  53. Put emx.exe (or rsx.exe) somewhere in your path. ME will load it
  54. automatically.  You need to use rsx.exe to run ME under Windows.  RSX
  55. doesn't seem to use direct-memory IO, and the screen updates are pretty
  56. poor.  I use a 16 bit version of ME when I'm working under Windows, and
  57. load up the 32 bit version when I want to look at several large files
  58. all at once.
  59.  
  60. I'd like to publicly express my gratitude to C Durland for the work he's
  61. done making ME such a versatile and pleasant-to-use tool.  I should add
  62. that this port wouldn't be possible without the work of E Mattes on the
  63. EMX environment.
  64.  
  65.  
  66.             How to Compile ME for OS/2
  67.             --- -- ------- -- --- ----
  68.  
  69. Compiling
  70. ---------
  71.  
  72. The OS/2 port is provided as a set of files which are not in the
  73. original distribution, and a set of patches to files from the original
  74. distribution.  After unzipping the original sources (me34src.zip) and
  75. the port sources, you need to apply the patches.  Get Larry Wall's patch
  76. program, and use it.  As I recall, with version 1.2, all you had to do
  77. was type
  78.  patch patches.os2
  79. and all the patches would be applied.  With the current version, it
  80. seems you have to type
  81.  patch me/config.h patches.os2
  82. and all the patches will be applied.
  83.  
  84. Once you've patched the sources, you need to copy emx1io.c, emx2io.c,
  85. and os2kmap.c from me/misc to me.  After that, you should be able to
  86. type, eg,
  87.  make -f makefile.emx emx-mt
  88. to build the emxlibc.dll version of editor.  Unfortunately, none of the
  89. makes that I've tried can change directories, so I've provided batch
  90. files to build the editor in case your make can't cd.  The command is
  91.  buildmt
  92. to build the emx-mt version.  If you don't use dmake, you'll have to
  93. change the batch files to start your make program.
  94.  
  95. You might want to change me/config.h.  In particular, if you don't want
  96. to put your .mco files in c:/me3, change the definition of
  97. DEFAULT_MUTT_SEARCH_PATH.
  98.  
  99. If you don't use the EMX compiler, this port probably won't help you too
  100. much.  emx1io.c is just John Burnell's os2io.c, with some changes to
  101. reflect changes in ME, and some functions that EMX doesn't support
  102. dropped.  Either emx1io or os2io is a reasonable starting point for
  103. another compiler.  emx2io.c uses a video library which is peculiar to
  104. EMX, so don't bother even looking at it.
  105.  
  106. I use a few function calls which are peculiar to EMX.  _fnlwr takes a
  107. filename as its argument.  It determines whether the file is on a drive
  108. that supports mixed-case filenames, and converts it to all lower-case if
  109. it isn't.  _chdir2 changes both the current working directory and drive.
  110. _getcwd1 gets the current working directory on a drive.  I depend on
  111. several Unix functions which EMX provides, but many commercial compilers
  112. don't.  Good luck.
  113.  
  114.  
  115.               How to Install ME
  116.               --- -- ------- --
  117.  
  118. "make install" doesn't work.  You have to
  119.     Copy me/me3 and mc/mc2 to a directory in your PATH.
  120.     Copy mutt/package/*.mco to c:/me3 or where you specified
  121.       in config.h.  Or leave them where they are and use the ME3
  122.       environment variable (which is what CD does).  See "load" in
  123.       me/doc/me3.doc for more about this var.
  124.     If you want the online help system to work, copy doc/*.doc and
  125.       doc/web.idx to the same place as the .mco files. (but you have to
  126.       get me34src.zip to get the docs).
  127.  
  128. As a quick test, run me, hit Escape x load <return> ganoi <return> and
  129. use 4 disks.  If you get the towers of hanoi, things are probably
  130. working pretty good.
  131.  
  132. Read the documentation.  Try typing Alt-X help <return> in the editor,
  133. and follow the menu.
  134.  
  135. Since the OS/2 port is not part of the official distribution, please
  136. send problem reports concerning this port to me, rather than to Craig
  137. Durland.  On the other hand, if the bug seems to be with code not
  138. touched by the port, send the report to him.
  139.  
  140.  
  141. Patrick TJ McPhee
  142. ptjm@io.org
  143. Toronto  Canada
  144.