"SfR Fresh" - the SfR Freeware/Shareware Archive 
Member "vil96w32/README.PC" of archive vile-w32.zip:
As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers.
Alternatively you can here view or download the uninterpreted source code file.
That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field.
1 --------------------
2 Running vile on a PC
3 --------------------
4
5 vile can be built for DOS, OS/2, Windows NT/2K/XP or Win9x/ME.
6 additionally, precompiled binaries are available at vile's ftp sites
7 (refer to the README file for URLs).
8
9 the precompiled binaries have an obvious advantage: you don't build vile,
10 which avoids the hassle of acquiring an "exotic" and/or expensive compiler.
11 on the flip side, some PC environments include multiple build options that
12 configure major editor features. consequently, if you don't build vile,
13 you have no control of the resultant feature set.
14
15 General installation instructions
16 ---------------------------------
17 installation of vile's PC components is the responsibility of the end user.
18 put another way, _none_ of the PC makefiles include install targets and
19 _none_ of the precompiled binaries include self-extracting setup programs.
20
21 Installing the precompiled binaries
22 -----------------------------------
23 1) unpack the appropriate compressed archive obtained from an ftp site.
24 2) copy all executables and the file vile.hlp to a directory in your PATH.
25
26 Installing after a build
27 ------------------------
28 1) build the editor using the hints/information supplied below.
29 2) copy all resultant executables (except mktbls.exe) and the file vile.hlp
30 to a directory in your PATH.
31
32 Creating a startup file
33 -----------------------
34 most users will configure the editor. this is accomplished by creating a
35 startup file, called "vile.rc", and adding various settings and macros as
36 described in vile.hlp . vile searches for the startup file in these
37 locations (and in the order listed):
38
39 1 - current working directory
40 2 - directory specified by $HOME
41 3 - vile executable directory
42 4 - each directory specified in $VILE_STARTUP_PATH. If
43 this environment variable is not set, the following
44 defaults are internally assumed:
45
46 /sys/public;/usr/bin;/bin;/
47
48 5 - each directory specified in:
49
50 $PATH
51 $VILE_LIBDIR_PATH
52
53 Syntax coloring
54 ---------------
55 syntax coloring works well on win32 hosts and everyone wants it :-) .
56 configuration of this feature is described step-by-step in these vile.hlp
57 topics: "Color basics" and "Syntax coloring" .
58
59 the remainder of this file describes build requirements for various PC
60 environments.
61
62 DOS information
63 ---------------
64 under DOS, you're best off using a DOS extender of some kind. either
65 the Watcom or DJGPP compiler suites may be used -- DJGPP gives you a
66 faster executable, but the Watcom compiler is about 10 times faster.
67 you can use Turbo or Borland C as well, but neither of those support an
68 extender, so you end up only being able to edit files that fit in memory.
69 if you do this, be sure to '#define SMALLER 1' in estruct.h, to save as
70 much code space as possible.
71
72 if you build with Watcom, you'll need to have both vile.exe and dos4gw.exe
73 in your path to run vile.
74
75 if you build with DJGPP, you'll need to have both vile.exe and go32.exe
76 in your path to run vile. newer versions of DJGPP may rely on DPMI, and
77 you might need cwsdpmi.exe instead of go32. experiment. have fun!
78
79 let me know about bugs/oddities when you use vile on a PC -- i probably don't
80 use it as much as you do.
81
82 (it's quite possible that the DOS makefiles are a little out of date --
83 refer to the UNIX makefile (makefile.in) for correct current list of source
84 and object files.)
85
86 oh -- there are three possible screen drivers in the source distribution
87 that should work, with varying degrees of success:
88
89 borland.c (need #define BORLAND in estruct.h or makefile): this
90 uses the "conio" routines that come with Turbo C or Borland
91 C++. Again, the trouble with this under DOS is that the
92 Borland compilers don't produce a dos-extender 32 bit app,
93 so you're _severely_ limited as to filesize. but the DJGPP
94 libraries emulate the borland screen i/o routines, so this
95 screen driver is used there as well.
96
97 ansi.c (need #define ANSI in estruct.h or makefile): uses ANSI.SYS.
98 it relies on the ansi driver for its cursor/scrolling/color
99 services. if you can change the resolution of your screen (to
100 43 or 50 line mode) with your ansi driver, just use the
101 "screen-rows" and/or "screen-columns" vile commands to make its
102 idea of the size match your physical screen, and you'll be all
103 set. (i've only tested it with a free/public replacement
104 program called NNANSI. i got my copy from a simtel mirror. i
105 can probably find you a copy if you need it.)
106
107
108 OS/2 information
109 ----------------
110 i believe vile can be built with the Borland compiler, or IBM CSET. be
111 aware that vile is NOT a PM program. the two builds use the borland.c
112 or os2vio.c screen drivers, respectively. with vile 7.3, an EMX port
113 is supported (for comparison, since OS/2 VIO performs much better).
114
115 we build the VIO version for the ftp downloads with IBM CSET, and the
116 associate nmake utility.
117
118 the makefile.emx (and associated config.emx file) are used for building
119 with a minimal EMX environment. you need gcc for this. however, for
120 best results in EMX, you should build with the autoconf version and
121 ncurses. this requires a number of tools:
122
123 + you will have to regenerate the configure script, using
124 autoconf 2.13, with the patches from
125
126 http://invisible-island.net/autoconf/autoconf.html
127
128 + you'll need ksh (build or obtain a copy of pdksh 5.2.13 or
129 better).
130
131 + GNU m4 (needed for autoconf), and sed.
132
133 the termcap library distributed with EMX does not work well. use ncurses:
134
135 + ncurses 4.2 or later, with patches through September 1998, from
136
137 http://invisible-island.net/ncurses/ncurses.faq.html
138 ftp://invisible-island.net/ncurses/
139
140 + use '$TERM=ansi', or start customizing from that.
141
142 WIN32 information (Windows NT/2K/XP and 9x/ME)
143 ----------------------------------------------
144 either Visual C++ (4.x or later) or the Borland compiler can be used. use
145 makefile.wnt with VC++ and makefile.blc with Borland's compiler. with
146 respect to the console-mode port (vile.exe), the screen driver is
147 ntconio.c . Both makefiles build vile.exe by default.
148
149 additionally, makefile.wnt builds a handful of C-based syntax coloring
150 filters. many additional filters can be compiled and linked if lex or flex
151 are available, as described below. refer to the help file topic "Syntax
152 coloring" for a description of these filters and their integration with the
153 editor.
154
155 as of vile 7.3, a gui called "winvile" is provided (screen driver is
156 ntwinio.c), which continues to improve with successive releases of the
157 editor. currently, winvile may only be built with makefile.wnt (i.e.,
158 only with VC++).
159
160 as of vile 8.0, an embedded perl interpreter may be optionally included
161 with the console or gui versions of the editor. again, this feature is
162 only accessible via makefile.wnt . if perl has been installed on your
163 desktop, vile's perl API documentation can be extracted from the source
164 distribution with this nmake command:
165
166 nmake -f makefile.wnt vile-perl-api.doc
167
168 as of vile 8.1, winvile may be built with optional OLE automation support,
169 which is described in the file doc/oleauto.doc . additionally, a DLL called
170 visvile.dll can be built and installed as a Developer Studio add-in. this
171 add-in substitutes winvile as the default Developer Studio editor for
172 many common editing tasks. refer to the file doc/visvile.doc for further
173 information, including build instructions.
174
175 the following table summarizes the most significant makefile.wnt build
176 options:
177
178 component option(s) required nmake command-line [1]
179 ========= ========= ===============================
180 vile <none> nmake -f makefile.wnt
181 vile perl [2] nmake -f makefile.wnt CFG=vile-with-perl
182 winvile <none> nmake -f makefile.wnt CFG=winvile
183 winvile perl nmake -f makefile.wnt CFG=winvile-with-perl
184 winvile ole nmake -f makefile.wnt CFG=winvile OPT=ole-auto
185 winvile perl,ole[2] nmake -f makefile.wnt CFG=winvile-with-perl OPT=ole-auto
186
187 [1] by default, all builds cd into the filters subdirectory and compile and
188 link a handful of C-based syntax coloring filters. to build _all_ of
189 the editor's supported filters, acquire a copy of flex (or lex),
190 install it in a directory located in your PATH and add the following
191 command-line option:
192
193 nmake -f makefile.wnt <OPTIONS_FROM_ABOVE> FLT=1 LEX=flex # or LEX=lex
194
195 take note that flex is a component of cygwin's GNU emulation package
196 and works quite well for this purpose. cygwin can be obtained from
197 Redhat at http://sources.redhat.com/cygwin. the FLT option binds
198 all syntax coloring filters into the resultant [win]vile executable.
199
200 [2] this option requires prior installation of perl. refer to the section
201 entitled "Perl preconditions" below.
202
203
204 More about makefile.wnt
205 -----------------------
206 this makefile builds the editor from the command-line, _not_ from Developer
207 Studio. however, selected environment variables _must_ be set before
208 any VC++ tool can be used (this includes nmake, cl, link, etc.).
209 fortunately, microsoft supplies the file vcvars32.bat, in the Dev Studio
210 bin directory, to set these variables. you'll probably want to examine and
211 edit this .bat file before using it for the first time because it usually
212 modifies the PATH to include the PC's CD-ROM drive (not nice at all!).
213 given all of this information, here's how to build the editor using the
214 MS developer tools:
215
216 a) open a dos box
217 b) cd to the vile source directory
218 c) run this command to initialize Dev Studio env vars:
219
220 <devstudio_root>\bin\vcvars32
221
222 d) use one of the nmake command-lines shown above
223
224 Perl preconditions
225 ------------------
226 before building vile with an embedded perl interpreter:
227
228 1) install a complete Win32 perl distribution[*] from this URL:
229
230 http://www.perl.com/CPAN-local/ports/win32/Standard/x86/
231
232 Included in this distribution, among many other items, is a required DLL
233 (perl.dll) and the usual perl packages.
234
235 2) initialize the environment variable VILE_LIBDIR_PATH to point to a
236 writable "root" directory where vile's perl scripts will be installed.
237
238 [*] Choose either a precompiled version of perl or build it yourself from
239 source. In this context, a "complete" distribution includes the perl
240 interpreter and all "standard" packages, modules, and libraries.
241
242 note 1: one of CPAN's popular perl binary releases did not export an
243 important symbol. this omission has been handled in vile's sources, but
244 there is a nontrivial performance impact associated with the workaround.
245 search for the symbol HAVE_BROKEN_PERL_RS in makefile.wnt to see if your
246 version of perl is affected.
247
248 note 2: the ActiveState port of perl is not compatible with vile's
249 internal perl API--older versions won't link/compile and newer versions
250 crash the editor.
251
252 --------------------------------------------------------
253 tom dickey, dickey@invisible-island.net
254
255 --------------------------------------------------------
256 paul fox, pgf@foxharp.boston.ma.us (home)
257
258 ------------------------
259 $Header: /usr/build/vile/vile/RCS/README.PC,v 1.33 2005/11/30 01:32:30 tom Exp $
260 ------------------------