1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
|
<!--
$Id: config.html,v 1.23 2020/08/31 08:18:08 tom Exp $
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for HTML5 for Linux version 5.2.0">
<title>Configuring vile and xvile</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii">
<link rel="author" href="mailto:dickey@invisible-island.net">
<link rel="SHORTCUT ICON" href="/img/icons/vile.ico" type=
"image/x-icon">
<link rel="stylesheet" href="/css/simplestyle.css" type=
"text/css">
</head>
<body>
<hr>
<p><a href="/">http://invisible-island.net/</a><a href=
"/vile/">vile/</a><a href="/vile/vile-toc.html">vile-toc</a><br>
</p>
<hr>
<h1 id="toplevel-toc"><a name="toplevel" id=
"toplevel">Configuring vile and xvile</a></h1>
<p>This file describes the steps which are needed to configure
and make either vile or xvile. See the file README for a blurb on
what (x)vile is and how great it is :-). The file INSTALL
contains generic information on the process of configuring and
building programs which (more or less) conform to the GNU coding
standards. You might want to consult that document for more
information.</p>
<h2 id="building-toc"><a name="building" id="building">Building
vile</a></h2>
<p>To build vile, enter the following command from your
shell:</p>
<pre>
./configure; make
</pre>
<p>If you'd like to examine makefile and config.h prior to
making, split these steps up as follows:</p>
<pre>
./configure
make
</pre>
<p>If you are unfortunate enough to be running on a platform in
which some part of the above process does not work perfectly, you
might well want to modify makefile to add references to obscure
libraries or non-standard library locations.</p>
<p>[ At least one version of bash running on Linux (and perhaps
other) systems will cause the configure script to produce invalid
results. Specifically, if you're running version 1.14.3 of bash
consider upgrading to a newer one. ]</p>
<p>Modifying makefile is not recommended because your changes
will be lost should you run configure again. Many configuration
options can be set externally to the configure script or the
makefile. For instance, if you'd like to change some of the flags
passed to the C compiler, try doing it like this:</p>
<pre>
make CFLAGS=-O2
</pre>
<p>Or, this can be done when running the configure script instead
-- try:</p>
<pre>
CFLAGS=-O2 ./configure (sh, ksh, bash)
</pre>
<p>or:</p>
<pre>
(setenv CFLAGS -O2 ; ./configure) (csh)
</pre>
<p>Then again, a configure script argument is shell-agnostic:</p>
<pre>
./configure --with-cflags=-O2
</pre>
<p>If you need to suppress your optimizer (which is invoked as -O
by default), because it's known to be buggy, use CFLAGS=" ". [
One combination thought to be buggy is AIX 3.2.5 with gcc 2.6.0.
]</p>
<p>The configure script will favor using gcc on your system if
available. This is usually fine, but if gcc was not installed
correctly (or your environment isn't quite right), it can be
disastrous. You can override the choice of compiler with:</p>
<pre>
CC=cc ./configure (sh, ksh, bash)
</pre>
<p>or:</p>
<pre>
(setenv CC cc ; ./configure) (csh)
</pre>
<p>Likewise, extra link libraries can be added by setting them in
LIBS before running configure.</p>
<h2 id="screentypes-toc"><a name="screentypes" id=
"screentypes">Screen Types</a></h2>
<p>Vile is configured and built with a terminal driver. At this
time, only one driver is built with vile at a time. Some other
editors attempt to combine more than one driver in the default
configuration, making the resulting program much larger and
slower. We will ultimately modify vile to support multiple
drivers, but the default configuration will be the smallest and
fastest.</p>
<p>There are several types of terminal driver:</p>
<ul>
<li>text terminals</li>
<li>X Window displays</li>
<li>Win32 displays, when building in MSYS for MinGW</li>
<li>Special displays, e.g., for OS/2</li>
</ul>
<p>The configure script provides an option for selecting a text,
X Window or even Win32 display. Use the "--with-screen" option to
specify the driver type, e.g.,</p>
<pre>
./configure --with-screen=tcap
</pre>
<p>Some of the choices use mixed-case, e.g., "Athena". The
configure script also recognizes the lowercase form of each of
those names, in this instance "athena".</p>
<h3 id="textdrivers-toc"><a name="textdrivers" id=
"textdrivers">Text Terminal Drivers</a></h3>
<p>There are several choices, listed here in their order of
capabilities:</p>
<p>--with-screen=ncursesw<br>
--with-screen=tcap (default)<br>
--with-screen=ncurses<br>
--with-screen=curses<br>
--with-screen=ansi</p>
<p>The default configuration for vile uses termcap (or terminfo,
depending on what your system has available). That is the default
because it is the most widely available. The "ncursesw"
configuration provides better optimization of the terminal's
capabilities, e.g., for scrolling and combining video attributes.
Most users would not see a difference between the two
choices.</p>
<p>The configuration script tests several possibilities for each
choice. Your system may have more than one library to link
against, e.g., on Linux you may have both termcap and ncurses (a
terminfo-based system). If you wish to use color, you are
generally better off using terminfo, since termcap descriptions
usually are limited to a fixed size, and some features are
omitted. The termcap databases also tend to not be as
well-maintained as their terminfo counterparts.</p>
<p>In addition to "ncursesw", two other forms of "curses" driver
are supported:</p>
<ul>
<li>curses</li>
<li>ncurses</li>
</ul>
<p>They both use the same driver source, but "ncurses" tells the
configure script to look for the ncurses library, which may not
be the default curses implementation on your machine. Like
"ncursesw", these can provide better optimization of the terminal
than the termcap/terminfo driver.</p>
<blockquote>
<p><strong>However</strong>, the "ncursesw" driver is more
likely to support multibyte encodings such as UTF-8 than the
other choices. The <a href=
"macros.html#modevar-term-encoding">$term-encoding</a> variable
shows at runtime what the driver is actually doing, whether
"locale" (capable of switching), "utf8" or "8bit".</p>
</blockquote>
<p>The "ansi" driver is the least capable. It uses built-in ANSI
escape sequences.</p>
<p>The "--with-ncurses" option is used as a special case of the
default termcap/terminfo driver, to ensure that it uses the
ncurses library rather than a termcap-only library.</p>
<h3 id="x11drivers-toc"><a name="x11drivers" id="x11drivers">X
Window Drivers</a></h3>
<p>There are several choices, again listed in</p>
<p>--with-screen=Motif<br>
--with-screen=Athena<br>
--with-screen=Xaw<br>
--with-screen=Xaw3d<br>
--with-screen=neXtaw<br>
--with-screen=X11</p>
<p>The Motif display has the nicest appearance. The one drawback
(relative to Athena) is that dragging the separator between
window panes is done on the scrollbar. The Athena interface
allows you to drag the separator by clicking on the status-line
of a window, and moving the mouse.</p>
<p>"Athena" and "Xaw" are the same; the two values are given to
make the script simpler to use. The "Xaw", "Xaw3d" and "neXtaw"
choices are almost the same, choosing libraries that have the
same capabilities but different appearances.</p>
<h3 id="w32drivers-toc"><a name="w32drivers" id=
"w32drivers">Win32 Drivers</a></h3>
<p>If you are building vile in the MSYS environment, i.e.,
compiling for MinGW, you can build "convile" or "minvile" instead
of the text- or X-choices:</p>
<p>--with-screen=DOS<br>
--with-screen=Windows</p>
<p>The "DOS" and "Windows" choices are comparable in
functionality to the executables built using Visual C++.</p>
<h2 id="utf8drivers-toc"><a name="utf8drivers" id=
"utf8drivers">UTF-8 Support versus Driver</a></h2>
<p>vile supports UTF-8 in two ways:</p>
<ul>
<li>it edits UTF-8 data as characters rather than bytes
and</li>
<li>it can display UTF-8 data.</li>
</ul>
<p>The ability to manipulate UTF-8 data depends on the operating
system and your locale settings. The ability to display UTF-8
data depends on the terminal driver. If the terminal driver is
unable to render UTF-8 data, vile displays it using "\u"
sequences.</p>
<p>In the choices for <a href="#textdrivers">text-drivers</a>,
ncursesw is before tcap and ncurses after because of their
support for UTF-8 The "ncurses" library supports 8-bit encodings,
and cannot display UTF-8. Both "ncursesw" and the
termcap/terminfo drivers can display UTF-8, as long as your
locale settings support it.</p>
<p>The X Window drivers all support UTF-8. Currently that is for
single-width characters (in contrast to the text- and Win32
drivers). There is no support (yet) for combining characters.</p>
<p>Win32 drivers support UTF-8. But they display based on font
selection. The "Lucida Console" font is widely available, and can
be used for this purpose. To have complete support for UTF-8, you
need the fonts provided with Microsoft Office.</p>
<h2 id="syntaxopts-toc"><a name="syntaxopts" id=
"syntaxopts">Syntax coloring options</a></h2>
<p>Adding syntax coloring to the editor can be simple or not.</p>
<h3 id="fastsyntax-toc"><a name="fastsyntax" id=
"fastsyntax">Fast, simple syntax coloring</a></h3>
<p>Maximally efficient syntax coloring can be selected by
specifying this configure command line:</p>
<pre>
--with-builtin-filters
</pre>
<p>An ensuing build binds _all_ of the editor's syntax coloring
filters into the resultant executable. On the plus side, the
build options are simple and since no filters are invoked
externally (via a pipe), syntax coloring is executed with minimal
overhead. On the minus side, this configure option generates a
much larger executable.</p>
<h3 id="simplesyntax-toc"><a name="simplesyntax" id=
"simplesyntax">Slower, simple syntax coloring</a></h3>
<p>Omitting any variant of the --with-builtin-filters option or
specifying "--with-builtin-filters=none" ensures that all of the
editor's syntax coloring filters are created as separate,
external executables. On the plus side, this choice minimizes the
editor's footprint. However, external filters are invoked via a
pipe, which is substantially slower than the direct execution
model.</p>
<h3 id="complexsyntax-toc"><a name="complexsyntax" id=
"complexsyntax">Complex syntax coloring</a></h3>
<p>vile also supports a mix of both internal and external
filters, which facilitates configuration of the editor with as
few or as many internal filters as desired. But before describing
how this is achieved, note the breadth of the following table of
editor filter names and language mappings:</p>
<table border="0" summary="Command Prefixes">
<colgroup>
<col width="100px">
<col width="100px">
</colgroup>
<tr>
<th valign="top" align="left">Builtin Filter Name</th>
<th valign="top" align="left">External Filter Name</th>
<th valign="top" align="left">Colors These
Language(s)/Files</th>
</tr>
<tr>
<td>ada</td>
<td>vile-ada-filt</td>
<td>ada</td>
</tr>
<tr>
<td>as</td>
<td>vile-as-filt</td>
<td>GNU assembler (x86)</td>
</tr>
<tr>
<td>asm</td>
<td>vile-asm-filt</td>
<td>Microsoft ASM (x86)</td>
</tr>
<tr>
<td>au3</td>
<td>vile-au3-filt</td>
<td>au3</td>
</tr>
<tr>
<td>awk</td>
<td>vile-awk-filt</td>
<td>awk</td>
</tr>
<tr>
<td>basic</td>
<td>vile-basic-filt</td>
<td>basic and visual basic (vb, vbs)</td>
</tr>
<tr>
<td>bat</td>
<td>vile-bat-filt</td>
<td>Windows .bat files</td>
</tr>
<tr>
<td>bnf</td>
<td>vile-bnf-filt</td>
<td>BNF files</td>
</tr>
<tr>
<td>c</td>
<td>vile-c-filt</td>
<td>c, cpp, java, and javascript (js)</td>
</tr>
<tr>
<td>cfg</td>
<td>vile-cfg-filt</td>
<td>lynx config files</td>
</tr>
<tr>
<td>conf</td>
<td>vile-conf-filt</td>
<td>ordinary config files</td>
</tr>
<tr>
<td>css</td>
<td>vile-css-filt</td>
<td>cascading style-sheets</td>
</tr>
<tr>
<td>cweb</td>
<td>vile-cweb-filt</td>
<td>cweb and cwebx</td>
</tr>
<tr>
<td>dcl</td>
<td>vile-dcl-filt</td>
<td>VMS DCL scripts</td>
</tr>
<tr>
<td>def</td>
<td>vile-def-filt</td>
<td>Windows .def files</td>
</tr>
<tr>
<td>diff</td>
<td>vile-diff-filt</td>
<td>output of diff command</td>
</tr>
<tr>
<td>ecl</td>
<td>vile-ecl-filt</td>
<td>Prolog/ECLiPSe</td>
</tr>
<tr>
<td>erl</td>
<td>vile-erl-filt</td>
<td>Erlang</td>
</tr>
<tr>
<td>esql</td>
<td>vile-esql-filt</td>
<td>embedded SQL with C/C++.</td>
</tr>
<tr>
<td>est</td>
<td>vile-est-filt</td>
<td>Enscript syntax-descriptions</td>
</tr>
<tr>
<td>fdl</td>
<td>vile-fdl-filt</td>
<td>forms definition language</td>
</tr>
<tr>
<td>html</td>
<td>vile-html-filt</td>
<td>HTML, JSP</td>
</tr>
<tr>
<td>imake</td>
<td>vile-imake-filt</td>
<td>imake files</td>
</tr>
<tr>
<td>info</td>
<td>vile-info-filt</td>
<td>GNU info files</td>
</tr>
<tr>
<td>ini</td>
<td>vile-ini-filt</td>
<td>Windows .ini, .reg, .vbp files</td>
</tr>
<tr>
<td>iss</td>
<td>vile-iss-filt</td>
<td>InnoSetup</td>
</tr>
<tr>
<td>key</td>
<td>vile-key-filt</td>
<td>vile .keyword files</td>
</tr>
<tr>
<td>latex</td>
<td>vile-latex-filt</td>
<td>LaTeX</td>
</tr>
<tr>
<td>lex</td>
<td>vile-lex-filt</td>
<td>flex and lex</td>
</tr>
<tr>
<td>lisp</td>
<td>vile-lisp-filt</td>
<td>lisp, scheme</td>
</tr>
<tr>
<td>lua</td>
<td>vile-lua-filt</td>
<td>Lua</td>
</tr>
<tr>
<td>m4</td>
<td>vile-m4-filt</td>
<td>autoconf and m4</td>
</tr>
<tr>
<td>mail</td>
<td>vile-mail-filt</td>
<td>messages</td>
</tr>
<tr>
<td>make</td>
<td>vile-make-filt</td>
<td>make and nmake files</td>
</tr>
<tr>
<td>mcrl</td>
<td>vile-mcrl-filt</td>
<td>mCRL/mCRL2 modeling language.</td>
</tr>
<tr>
<td>midl</td>
<td>vile-midl-filt</td>
<td>Microsoft IDL</td>
</tr>
<tr>
<td>mms</td>
<td>vile-mms-filt</td>
<td>VMS make files</td>
</tr>
<tr>
<td>nr</td>
<td>vile-nr-filt</td>
<td>nroff/troff files</td>
</tr>
<tr>
<td>pas</td>
<td>vile-pas-filt</td>
<td>Pascal, Delphi</td>
</tr>
<tr>
<td>php</td>
<td>vile-php-filt</td>
<td>PHP</td>
</tr>
<tr>
<td>pl</td>
<td>vile-pl-filt</td>
<td>Perl</td>
</tr>
<tr>
<td>pot</td>
<td>vile-pot-filt</td>
<td>gettext (.po) files</td>
</tr>
<tr>
<td>ps</td>
<td>vile-ps-filt</td>
<td>PostScript</td>
</tr>
<tr>
<td>py</td>
<td>vile-py-filt</td>
<td>python</td>
</tr>
<tr>
<td>rc</td>
<td>vile-rc-filt</td>
<td>Windows resource (.rc) files</td>
</tr>
<tr>
<td>rcs</td>
<td>vile-rcs-filt</td>
<td>RCS archives</td>
</tr>
<tr>
<td>rexx</td>
<td>vile-rexx-filt</td>
<td>REXX</td>
</tr>
<tr>
<td>rpm</td>
<td>vile-rpm-filt</td>
<td>RPM .spec files</td>
</tr>
<tr>
<td>rtf</td>
<td>vile-rtf-filt</td>
<td>Rich Text Format</td>
</tr>
<tr>
<td>rb</td>
<td>vile-ruby-filt</td>
<td>Ruby</td>
</tr>
<tr>
<td>sccs</td>
<td>vile-sccs-filt</td>
<td>SCCS files</td>
</tr>
<tr>
<td>sed</td>
<td>vile-sed-filt</td>
<td>sed scripts</td>
</tr>
<tr>
<td>sh</td>
<td>vile-sh-filt</td>
<td>csh, sh, PCLI</td>
</tr>
<tr>
<td>sml</td>
<td>vile-sml-filt</td>
<td>SML input text</td>
</tr>
<tr>
<td>spell</td>
<td>vile-spell-filt</td>
<td>highlight misspelled words using ispell or spell (see
filters/spell.rc)</td>
</tr>
<tr>
<td>sql</td>
<td>vile-sql-filt</td>
<td>SQL</td>
</tr>
<tr>
<td>tags</td>
<td>vile-tags-filt</td>
<td>tags files (see ctags(1)).</td>
</tr>
<tr>
<td>tbl</td>
<td>vile-tbl-filt</td>
<td>vile's modetbl and cmdtbl files</td>
</tr>
<tr>
<td>tc</td>
<td>vile-tc-filt</td>
<td>termcap and printcap files</td>
</tr>
<tr>
<td>tcl</td>
<td>vile-tcl-filt</td>
<td>tcl/tk scripts</td>
</tr>
<tr>
<td>tex</td>
<td>vile-latex-filt</td>
<td>TeX</td>
</tr>
<tr>
<td>texi</td>
<td>vile-texi-filt</td>
<td>texinfo</td>
</tr>
<tr>
<td>ti</td>
<td>vile-ti-filt</td>
<td>terminfo files</td>
</tr>
<tr>
<td>txt</td>
<td>vile-txt-filt</td>
<td>various flavors of text files</td>
</tr>
<tr>
<td>vile</td>
<td>vile-vile-filt</td>
<td>vile and vim macros</td>
</tr>
<tr>
<td>vlog</td>
<td>vile-vlog-filt</td>
<td>verilog</td>
</tr>
<tr>
<td>wbt</td>
<td>vile-wbt-filt</td>
<td>WinBatch</td>
</tr>
<tr>
<td>xml</td>
<td>vile-html-filt</td>
<td>XML, DocBook</td>
</tr>
<tr>
<td>xpm</td>
<td>vile-xpm-filt</td>
<td>X resource files</td>
</tr>
<tr>
<td>xres</td>
<td>vile-xres-filt</td>
<td>X resource files</td>
</tr>
<tr>
<td>xs</td>
<td>vile-xs-filt</td>
<td>Perl extension source files</td>
</tr>
<tr>
<td>yacc</td>
<td>vile-yacc-filt</td>
<td>yacc and bison</td>
</tr>
</table>
<p>As you might expect, when the "--with-builtin-filters" option
is selected, all of the internal filters listed above are bound
into the editor. "Hey, wait a minute", you say, "I'll never use
some of those filters--not in a hundred years." In that case, use
this configure syntax:</p>
<pre>
--with-builtin-filters="<filter_list>"
</pre>
<p>For example:</p>
<pre>
./configure --with-cflags=-O2 \
--with-builtin-filters="awk c key lex m4 perl sed tags
diff html mail make pl rcs sh sql tbl tcl txt vile yacc"
make
make install
</pre>
<p>The above commands:</p>
<ul>
<li>compile vile [1],</li>
<li>compile and link 21 filters into the final editor
image,</li>
<li>create the remaining, non-builtin filters as external
executable images, and</li>
<li>copy the editor and external filters to an to an install
tree [2].</li>
</ul>
<p>Assuming the editor's startup file initiates syntax coloring
[3], then at vile run time, the macro file filters/filters.rc
preferentially selects and executes internal filters when
coloring a supported language or file format. If a required
internal filter is not available, filters.rc starts a pipe and
applies color attributes via the corresponding external filter
listed in the table above.</p>
<p>[1] Or xvile if you prefer. See next topic.<br>
[2] Described below in the topic "Installing x(vile)".<br>
[3] Refer to the topics "Color basics" and "Syntax coloring" in
vile.hlp</p>
<h2 id="buildxvile-toc"><a name="buildxvile" id=
"buildxvile">Building xvile</a></h2>
<p>You must decide which version of xvile you want to build. To a
certain degree this decision may be forced upon you by which
libraries you have on your machine. There are three different
versions you can build.</p>
<ol>
<li>X toolkit version: This version uses only the X toolkit to
implement scrollbars and the window resize grips (meaning
_vile_ windows, not X windows). As a consequence, it should
only require the X toolkit library (-lXt) and the Xlib library
(-lX11). (Don't worry if you don't know what these are or where
these are; the configuration script will probably be able to
find them.) The scrollbars in this version look much like those
found in a standard xterm. We recommend that you try this
version out first as it is superior in some respects to the
other versions which use fancy widget sets. To configure this
version, enter the following command:
<pre>
./configure --with-screen=x11
</pre>
<p>A minor variation using the Athena widgets supports
menus:</p>
<pre>
./configure --with-screen=Xaw
</pre>
<p>Two other variations on the Athena widgets are
provided:</p>
<pre>
./configure --with-Xaw3d
</pre>
<p>to link with Xaw 3d library</p>
<pre>
./configure --with-neXtaw
</pre>
<p>to link with neXT Athena library. There's little
functional difference between the three versions of Athena
libraries, they provide different appearance. You can also
configure with the corresponding scrollbars from the Athena
library (though we are not as satisfied with their
performance, particularly with resizing):</p>
<pre>
./configure --with-Xaw-scrollbars
</pre>
<p>to use Xaw scrollbars rather than our own (applies to all
variations of Athena library). You can also use Kevin's
dragging/scrolling logic with the Athena library:</p>
<pre>
./configure --with-drag-extension
</pre>
</li>
<li>Motif version: This version uses the Motif widget set to
implement the scrollbars and (vile) window resize pane. To
configure the Motif version, enter one of the following
commands (several variations are recognized for each screen
value to simplify integration with other scripts):
<pre>
./configure --with-screen=motif
./configure --with-screen=Xm
</pre>
</li>
</ol>
<p>The Athena and Motif versions support a menubar, with pulldown
menus. The configure option <code>--enable-colored-menus</code>
compiles-in resource values which simplify coloring the menubar
and menus with the same foreground and background colors. The
corresponding resource values are <code>menuForeground</code> and
<code>menuBackground</code>.</p>
<p>There are also options for configuring the icon used, using
option values:</p>
<dl>
<dt>--with-xpm</dt>
<dd>use this to check for, and use the Xpm library which
supports colored options (".xpm" in contrast to the monochrome
".xbm").</dd>
<dt>--with-icon-name=XXX</dt>
<dd>
allows you to override the icon name. Normally this is the
"vile" icon, which shows a representation of an editing
screen. The other choices are
<ul>
<li>--with-icon-name=pumpkin</li>
<li>--with-icon-name=sink</li>
</ul>
<p>There is a "mini" icon used in a few special cases which
consists only of the tilde's from the "vile" icon. That is
unaffected by this configure option.</p>
</dd>
<dt>--with-pixmapdir=XXX</dt>
<dd>
specify the directory in which to install pixmaps, e.g.,
/usr/share/pixmaps.
<p>The special value "auto" tells the configure script to
check for the existence of (fairly standard) locations.</p>
</dd>
<dt>--with-icondir=XXX</dt>
<dd>
specify the directory in which to install icons for desktop,
e.g., /usr/share/icons.
<p>The special value "auto" tells the configure script to
check for the existence of (fairly standard) locations.</p>
</dd>
<dt>--with-icon-theme=XXX</dt>
<dd>install icons into desktop theme (default "hicolor"). Vile
provides ".svg" and ".png" flavors of the icons which are used
for this option. If you use the icon-theme option, it is still
a good idea to not suppress the pixmap feature due to
inconsistencies and gaps in the support provided by the desktop
configurations.</dd>
</dl>
<h2 id="installxvile-toc"><a name="installxvile" id=
"installxvile">Installing (x)vile</a></h2>
<p>Installation of (x)vile is simple. Obtain the appropriate
privileges (become superuser if necessary), and enter the
following command:</p>
<pre>
make install
</pre>
<p>If you have ever installed an older version of vile, you
should probably check to be sure the old help files are gone.
They used to go to a different place (by default) than they do
now. It can be most confusing to use an older version of the help
file with a newer version of the program, and unfortunately,
older help files didn't have version numbers.</p>
<p>By default, (x)vile and the script "vile-pager" are installed
in /usr/local/bin. Other editor components are stored in these
directories:</p>
<table border="0" summary="Command Prefixes">
<colgroup>
<col width="200px">
</colgroup>
<tr>
<th align="left">component</th>
<th align="left">install dir</th>
</tr>
<tr>
<td>vile.hlp</td>
<td>/usr/local/share/vile</td>
</tr>
<tr>
<td>vile.1 (man page)</td>
<td>/usr/local/man/man1</td>
</tr>
<tr>
<td>syntax coloring filters</td>
<td>[note 1]</td>
</tr>
<tr>
<td>coloring keyword files</td>
<td>/usr/local/share/vile</td>
</tr>
<tr>
<td>various macro files</td>
<td>/usr/local/share/vile</td>
</tr>
</table>
<p>Note 1: the value of the environment variable VILE_LIBDIR_PATH
specifies where configure installs external coloring filters. If
unset, configure defaults to /usr/local/lib/vile.</p>
<p>We realize that not everyone has superuser privileges on the
machines on which they wish to build (x)vile. If you lack
superuser access or write access to /usr/local, you will want to
change the installation location. You may do so by using the
--prefix option to "configure". Suppose you wish to have xvile
installed in $HOME/bin (your home bin directory). You would issue
the following commands:</p>
<pre>
./configure --with-screen=x11 --prefix=$HOME
make install
</pre>
<p>Here are other useful options for configuring xvile:</p>
<pre>
--with-app-defaults=DIR directory in which to install resource files (default: EPREFIX/lib/X11/app-defaults)
--with-icondir=DIR directory in which to install icons (default: EPREFIX/share/pixmaps)
--disable-desktop disable install of X desktop files
</pre>
<p>The file INSTALL has more information on installation and on
configure's --prefix option. If you don't feel like rebuilding
(likely), you can also edit the makefile and change the "prefix",
"bindir", or "libdir" definitions--but remember that your changes
will be lost the next time configure is run.</p>
<h2 id="sourcedir-toc"><a name="sourcedir" id=
"sourcedir">Building in a separate directory</a></h2>
<p>If you are building (x)vile for several machines or want to
perhaps simultaneously build and try out the various versions of
xvile, you will probably want to configure (x)vile to build in a
directory different from where the source resides. This requires
that you have make program which correctly uses the VPATH
variable. GNU make does this well, others may or may not.</p>
<p>Suppose that the source resides in vile-src. At the same level
as vile-src, you might perhaps create a directory called
vile-x11-sunos to indicate that you are building xvile on a
platform running sunos. You would then cd into this directory and
issue the following configuration command:</p>
<pre>
../vile-src/configure --with-screen=x11
</pre>
<p>Another directory at the same level as vile-src might be named
vile-sunos to indicate that you are building vile on a platform
running sunos. After you cd into this directory, you'd then issue
the following command to configure ordinary vile.</p>
<pre>
../vile-src/configure
</pre>
<p>The "make" step in each case is the same as described above;
you simply issue the command:</p>
<pre>
make
</pre>
<p>to finish making (x)vile.</p>
<p>This process is described in more formally in the INSTALL
document. As described there, you will need to use a version of
"make" which supports the VPATH variable. And it must support it
_correctly_. Again, GNU make does this. A lot of older "make"s
don't.</p>
<h2 id="versionedprog-toc"><a name="versionedprog" id=
"versionedprog">Building Versioned Executables</a></h2>
<p>Normally vile is installed without renaming it. But the
configure script supports these options, which allow you to
rename the program:</p>
<pre>
--program-prefix=PREFIX prepend PREFIX to installed program names
--program-suffix=SUFFIX append SUFFIX to installed program names
--program-transform-name=PROGRAM run sed PROGRAM on installed program names
--with-symlink=XXX make symbolic link to installed application
</pre>
<p>In particular, the <code>--with-symlink</code> option is used
to install executables that are named according to vile's
version, e.g., <code>vile-9.7za</code>, <code>vile-9.7zb</code>,
etc., with a symbolic link pointing to the most recently
installed executables. This allows you to install successive
releases of vile, and easily switch between them (provided that
the associated macros are compatible).</p>
<h2 id="locale-toc"><a name="locale" id="locale">Locale
Support</a></h2>
<p>There are two parts to locale support:</p>
<pre>
--with-locale use i18n support for character-types
--with-iconv use iconv() support for character-types
--with-libiconv-prefix=DIR
search for libiconv in DIR/include and DIR/lib
</pre>
<p>The <code>--with-locale</code> option provides the basic
portable support for different character types. It is enabled by
default since only rather old systems lack support for these
functions. (Some older systems have the functions but only a
buggy implementation; it is not simple to make the configure
script aware of those).</p>
<p>The <code>--with-iconv</code> option checks for functions that
vile can use to facilitate editing UTF-8 text on devices which do
not display UTF-8, as well as work with UTF-8 files which are
largely compatible with 8-bit encoding.</p>
<p>Without the iconv option, vile can still work with UTF-8, but
the support for non-UTF-8 encoding is focused on ISO-8859-1.</p>
<h2 id="otheroptions-toc"><a name="otheroptions" id=
"otheroptions">Other Compile-Time Options</a></h2>
<p>Aside from the screen type, most functionality in vile is
controlled by the "OPT_" #ifdef's in the estruct.h file. Some of
the more useful ones (or those that require manipulating the
makefile) are also provided as configure options:</p>
<pre>
--with-exec-macros=N specify count of numbered macros (anachronism)
--with-perl enable use of Perl as an extension language
</pre>
<h2 id="testingoptions-toc"><a name="testingoptions" id=
"testingoptions">Testing/Development Options</a></h2>
<p>Several other options appear in the configure script's
"--help" message. They are used to support testing and
development, by building various debug versions of vile. These
include:</p>
<pre>
--enable-warnings test: turn on GCC compiler warnings
--disable-echo test: display "compiling" commands (default: on)
--disable-extensions test: build only core functions (default: on)
--disable-rpath-hack don't add rpath options for additional libraries
--disable-shell test: disable shell/external commands (default: on)
--with-dbmalloc test: use Conor Cahill's dbmalloc library
--with-dmalloc test: use Gray Watson's dmalloc library
--with-no-leaks test: free permanent memory, analyze leaks
--with-trace test: turn on debug-tracing
</pre>
<p>The dbmalloc and dmalloc libraries are similar, checking for
memory leaks and related malloc/free problems. Both have
limitations, so we use both, as well as other tools such as
Purify and ElectricFence, according to the problem.</p>
<p>The --with-no-leaks option compiles in code that frees all of
the permanently allocated memory on exit. This greatly simplifies
the task of analyzing memory leaks.</p>
<p>The --with-trace option turns on debug traces that go to the
Trace.out file. Since vile is a fullscreen program, it is not
useful to write messages to the screen. (The OPT_HEAPSIZE option
is an exception; you may be amused by it).</p>
<p>The --with-warnings option applies mostly to compiles with
GCC, since it is available across several platforms. We build
with all available compilers, but their warnings options are not
consistent.</p>
<p>Because the echoed commands in the makefile are long, the
--disable-echo option is provided to shorten the commands, making
it easy to see the warnings.</p>
<p>The --disable-extensions and --disable-shell options are for
testing. Disabling extensions produces a smaller program,
essentially the core of vile (no macros), which is a workable
editor. You may wish to build vile without shell support, but
perhaps not (ymmv).</p>
<p>The --disable-rpath-hack option is useful for packagers, who
may not wish the executable to be bound to a particular library
path from their build environment.</p>
</body>
</html>
|
