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