1README_zOS.txt for version 7.3 of Vim: Vi IMproved.
2
3This readme explains how to build Vim on z/OS.  Formerly called OS/390.
4See "README.txt" for general information about Vim.
5
6Most likely there are not many users out there using Vim on z/OS. So chances
7are good, that some bugs are still undiscovered.
8
9Getting the source to z/OS:
10==========================
11
12First get the source code in one big tar file and ftp it a binary to z/OS. If
13the tar file is initially compressed with gzip (tar.gz) or bzip2 (tar.bz2)
14uncompress it on your PC, as this tools are (most likely) not available on the
15mainframe.
16
17To reduce the size of the tar file you might compress it into a zip file. On
18z/OS Unix you might have the command "jar" from java to uncompress a zip. Use:
19        jar xvf <zip file name>
20
21Unpack the tar file on z/OS with 
22        pax -o from=ISO8859-1,to=IBM-1047 -rf vim.tar
23
24Note: The Vim source contains a few bitmaps etc which will be destroyed by
25this command, but these files are not needed on zOS (at least not for the
26console version).
27
28
29Compiling:
30==========
31
32Vim can be compiled with or without GUI support. For 7.3 only the compilation
33without GUI was tested. Below is a section about compiling with X11 but this
34is from an earlier version of Vim.
35
36Console only:
37-------------
38
39If you build VIM without X11 support, compiling and building is nearly
40straightforward. 
41
42Change to the vim directory and do:
43
44    # Don't use c89!
45    # Allow intermixing of compiler options and files.
46
47    $ export CC=cc
48    $ export _CC_CCMODE=1
49    $./configure --with-features=big --without-x --enable-gui=no
50    $ cd src
51    $ make
52
53      There may be warnings:
54        - include files not found (libc, sys/param.h, ...)
55        - Redeclaration of ... differs from ...
56        -- just ignore them.
57
58    $ make test
59
60      This will produce lots of garbage on your screen (including error
61      messages). Don't worry.
62
63      If the test stops at one point in vim (might happen in test 11), just
64      press :q!
65
66      Expected test failures:
67        11: If you don't have gzip installed
68        24: test of backslash sequences in regexp are ASCII dependent
69        42: Multibyte is not supported on z/OS
70        55: ASCII<->EBCDIC sorting
71        57: ASCII<->EBCDIC sorting
72        58: Spell checking is not supported with EBCDIC
73        71: Blowfish encryption doesn't work
74
75    $ make install
76
77
78With X11:
79---------
80
81WARNING: This instruction was not tested with Vim 7.3.
82
83There are two ways for building VIM with X11 support. The first way is simple
84and results in a big executable (~13 Mb), the second needs a few additional
85steps and results in a much smaller executable (~4.5 Mb). This examples assume
86you want Motif.
87
88  The easy way:
89    $ export CC=cc
90    $ export _CC_CCMODE=1
91    $ ./configure --enable-max-features --enable-gui=motif
92    $ cd src
93    $ make
94
95    With this VIM is linked statically with the X11 libraries.
96
97  The smarter way:
98    Make VIM as described above. Then create a file named 'link.sed' with the
99    following content (see src/link.390):
100
101	s/-lXext  *//g
102	s/-lXmu  *//g
103	s/-lXm	*/\/usr\/lib\/Xm.x /g
104	s/-lX11  */\/usr\/lib\/X11.x /g
105	s/-lXt	*//g
106	s/-lSM	*/\/usr\/lib\/SM.x /g
107	s/-lICE  */\/usr\/lib\/ICE.x /g
108
109    Then do:
110    $ rm vim
111    $ make
112
113    Now Vim is linked with the X11-DLLs.
114
115    See the Makefile and the file link.sh on how link.sed is used.
116
117
118