This repository has been archived by the owner on Sep 24, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 115
/
index.html
5461 lines (4024 loc) · 115 KB
/
index.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<meta name="GENERATOR" content="TtH 3.85">
<style type="text/css"> div.p { margin-top: 7pt;}</style>
<style type="text/css">
td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
td div.norm {line-height:normal;}
span.roman {font-family: serif; font-style: normal; font-weight: normal;}
span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
</style>
<style type="text/css">
body{
background-color: #F7F7F7;
font-family: sans-serif;
text-align: center;
color:#2B373D;
margin-bottom: 100px;
font-size: 10pt;
}
#container {
width: 750px;
text-align: left;
}
a{
color: #1E83CB;
}
b{
font-weight: bold;
font-size: 100%;
}
h1{
margin-top: 30px;
margin-bottom: 30px;
font-size: 240%;
}
h2{
margin-top: 70px;
margin-bottom: 50px;
font-size: 210%;
}
h3{
margin-top: 40px;
font-size: 150%;
}
h4{
margin-top: 30px;
font-size: 120%;
}
pre{
color: #333333;
font-weight: normal;
}
table td{
border: 1px solid #CCCCCC;
padding: 5px 5px 5px 5px;
}
table{
margin-left: 10px;
border: 1px solid #CCCCCC;
font-weight: normal;
font-size: 100%;
}
</style>
<center>
<div id="container">
<div class="p"><!----></div>
<title>ENSIME User Manual</title>
<h1 align="center">ENSIME User Manual </h1>
<h3 align="center">Aemon Cannon </h3>
<div class="p"><!----></div>
<div style="text-align:center"><b>Last Updated</b>: 07/12/2014
</div>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1 Introduction</a><br />
<a href="#tth_sEc1.1"
>1.1 What is ENSIME?</a><br />
<a href="#tth_sEc2"
>2 Installation</a><br />
<a href="#tth_sEc2.1"
>2.1 System Requirements</a><br />
<a href="#tth_sEc2.2"
>2.2 Getting Started</a><br />
<a href="#tth_sEc3"
>3 Creating a Project</a><br />
<a href="#tth_sEc3.1"
>3.1 Generating a Config File</a><br />
<a href="#tth_sEc3.1.1"
>3.1.1 Using sbt to Generate a Config File</a><br />
<a href="#tth_sEc3.1.2"
>3.1.2 Generating Configs for Other Project Types</a><br />
<a href="#tth_sEc3.2"
>3.2 Notes on Specific Project Types</a><br />
<a href="#tth_sEc3.2.1"
>3.2.1 SBT</a><br />
<a href="#tth_sEc3.2.2"
>3.2.2 Other</a><br />
<a href="#tth_sEc3.3"
>3.3 Config File Format</a><br />
<a href="#tth_sEc4"
>4 Usage</a><br />
<a href="#tth_sEc4.1"
>4.1 Startup</a><br />
<a href="#tth_sEc4.2"
>4.2 Error Highlighting</a><br />
<a href="#tth_sEc4.3"
>4.3 Symbol and Member Completion</a><br />
<a href="#tth_sEc4.4"
>4.4 Type/Package Inspector</a><br />
<a href="#tth_sEc4.5"
>4.5 The Scala REPL</a><br />
<a href="#tth_sEc4.6"
>4.6 Incremental Building</a><br />
<a href="#tth_sEc4.7"
>4.7 Debugging</a><br />
<a href="#tth_sEc4.8"
>4.8 Refactoring</a><br />
<a href="#tth_sEc4.9"
>4.9 Global Type and Method Search</a><br />
<a href="#tth_sEc4.10"
>4.10 Source Formatting</a><br />
<a href="#tth_sEc4.11"
>4.11 Semantic Highlighting</a><br />
<a href="#tth_sEc4.12"
>4.12 Scaladoc and Javadoc Browsing (customizing)</a><br />
<a href="#tth_sEc4.13"
>4.13 Command Reference</a><br />
<a href="#tth_sEc5"
>5 Troubleshooting</a><br />
<a href="#tth_sEc5.1"
>5.1 Diagnosing Issues</a><br />
<a href="#tth_sEc5.2"
>5.2 Emacs Binary Search Path</a><br />
<a href="#tth_sEc5.3"
>5.3 Custom JVM Options</a><br />
<a href="#tth_sEcA"
>A Installation from Git Clone</a><br />
<a href="#tth_sEcB"
>B Running the End-to-End ENSIME Tests</a><br />
<a href="#tth_sEcC"
>C Using the ENSIME Server with Other Editors</a><br />
<a href="#tth_sEcC.1"
>C.1 Starting the Server</a><br />
<a href="#tth_sEcC.2"
>C.2 The Swank Protocol</a><br />
<a href="#tth_sEcC.3"
>C.3 ENSIME Swank RPC: Version 0.8.7</a><br />
<a href="#tth_sEcC.3.1"
>C.3.1 Protocol Change Log</a><br />
<a href="#tth_sEcC.3.2"
>C.3.2 Important Datastructures</a><br />
<a href="#tth_sEcC.3.3"
>C.3.3 RPC Calls</a><br />
<a href="#tth_sEcC.3.4"
>C.3.4 Events</a><br />
<a href="#tth_sEcC.4"
>C.4 Other Protocols</a><br />
<div class="p"><!----></div>
<a name="tth_sEc1"></a><h2>
1 Introduction</h2>
<div class="p"><!----></div>
<a name="tth_sEc1.1"></a><h3>
1.1 What is ENSIME?</h3>
ENSIME is the ENhanced Scala Interaction Mode for Emacs. It provides many features that are commonly found only in IDEs, such as live error-checking, symbol inspection, package/type browsing, and basic refactorings. ENSIME's architecture is client/server: a thin Emacs client communicates with an analysis server written in Scala. The client component is based heavily on the SLIME environment for Common Lisp - using the same Swank RPC protocol. The server component services these calls using an instance of the official Scala compiler, so the results should always be consistent with the commandline compiler.
<div class="p"><!----></div>
<a name="tth_sEc2"></a><h2>
2 Installation</h2>
<div class="p"><!----></div>
<a name="tth_sEc2.1"></a><h3>
2.1 System Requirements</h3>
<div class="p"><!----></div>
<ul>
<li> Emacs 22 or later (23 is recommended)
<div class="p"><!----></div>
</li>
<li> Linux, Mac OSX, Windows
<div class="p"><!----></div>
</li>
<li> JVM Version 6
<div class="p"><!----></div>
</li>
<li> Scala 2.8.x or 2.9.x compatible project
<div class="p"><!----></div>
</li>
</ul>
<div class="p"><!----></div>
<a name="tth_sEc2.2"></a><h3>
2.2 Getting Started</h3>
<a name="sec:install">
</a>
<div class="p"><!----></div>
<b>scala-mode</b>:<br />
Although it's not required, ENSIME is designed to compliment an existing scala major mode. scala-mode2 is an excellent scala mode, and can be found at https://github.com/hvesalai/scala-mode2<br />
<div class="p"><!----></div>
<b>ensime-mode</b>:<br />
Download the latest ENSIME distribution from github.com at
<pre>http://github.com/aemoncannon/ensime/downloads
</pre> Make sure you get the version that is appropriate for your Scala version. Unpack the ENSIME distribution into a directory of your choosing, and add the following lines to your .emacs file:
<div class="p"><!----></div>
<dl>
<dd><b>
<pre>
;; Load the ensime lisp code...
(add-to-list 'load-path "ENSIME_ROOT/elisp/")
(require 'ensime)
;; This step causes the ensime-mode to be started whenever
;; scala-mode is started for a buffer. You may have to customize this step
;; if you're not using the standard scala mode.
(add-hook 'scala-mode-hook 'ensime-scala-mode-hook)
</pre>
</b></dd>
</dl>
<div class="p"><!----></div>
<b>Create a .ensime config file</b>:<br />
See section <a href="#sec:config">3.1</a>.<br />
<div class="p"><!----></div>
<b>Finally...</b><br />
<div class="p"><!----></div>
Execute <em>M-x ensime</em> from Emacs. Follow the instructions in the minibuffer to select your project. If you encounter any problems, see section <a href="#sec:troubleshooting">5</a> for troubleshooting.
<div class="p"><!----></div>
<a name="tth_sEc3"></a><h2>
3 Creating a Project</h2>
<div class="p"><!----></div>
<a name="tth_sEc3.1"></a><h3>
3.1 Generating a Config File</h3>
<a name="sec:config">
</a>
<div class="p"><!----></div>
<a name="tth_sEc3.1.1"></a><h4>
3.1.1 Using sbt to Generate a Config File</h4>
<div class="p"><!----></div>
First, you need to install the ENSIME sbt plugin. Add the following lines to your project/plugins.sbt:
<div class="p"><!----></div>
<dl>
<dd><b>
<pre>
addSbtPlugin("org.ensime" % "ensime-sbt-cmd" % "VERSION")
</pre>
</b></dd>
</dl>
<div class="p"><!----></div>
Replace VERSION with the latest version of the plugin, available at https://github.com/aemoncannon/ensime-sbt-cmd. Then, from an sbt shell, generate your ENSIME project:
<div class="p"><!----></div>
<dl>
<dd><b>
<pre>
ensime generate
</pre>
</b></dd>
</dl>
<div class="p"><!----></div>
You should now have a .ensime file in the root of your project. Instead of editing this file directly, if you need to adjust ENSIME configuration settings, you can change the value of the sbt setting <em>ensime-config</em>. The value should be a lisp S-Expression, just like the .ensime configuration format. The ENSIME sbt plugin includes some helpers for building S-Expressions. For example, your Build.scala might include the following:
<div class="p"><!----></div>
<dl>
<dd><b>
<pre>
import org.ensime.sbt.Plugin.Settings.ensimeConfig
import org.ensime.sbt.util.SExp._
ensimeConfig := sexp(
key(":compiler-args"), sexp("-Ywarn-dead-code", "-Ywarn-shadowing"),
key(":formatting-prefs"), sexp(
key(":alignParameters"), true
)
)
</pre>
</b></dd>
</dl>
<div class="p"><!----></div>
If you have multiple sbt subprojects, they may each specify different ensime-config values.
<div class="p"><!----></div>
<a name="tth_sEc3.1.2"></a><h4>
3.1.2 Generating Configs for Other Project Types</h4>
<div class="p"><!----></div>
ENSIME includes a wizard for automatically generating configuration files. In Emacs, execute <em>M-x ensime-config-gen</em>. Then simply follow the directions in the mini-buffer to create a .ensime file for your project. ENSIME will try to guess the type(mvn, custom, etc) of your project, based on the files and directory structure. If the config generator does a poor job for your project, please let us know so we can improve it. And of course you can still create the .ensime file for your project manually. See the section on the .ensime format below.
<div class="p"><!----></div>
<a name="tth_sEc3.2"></a><h3>
3.2 Notes on Specific Project Types</h3>
<div class="p"><!----></div>
<a name="tth_sEc3.2.1"></a><h4>
3.2.1 SBT</h4>
<div class="p"><!----></div>
<b>Inferior SBT</b>:<br />
The keystrokes <em>C-c C-v s</em> will launch (or switch to an existing) inferior sbt session.<br />
<div class="p"><!----></div>
<b>Compile-on-Save</b>:<br />
If the value of the Emacs-Lisp variablt ensime-sbt-compile-on-save is non-nil ENSIME will invoke the 'compile' task in the inferior sbt process(presuming you have one running) whenever you save a Scala buffer. This option is enabled by default.<br />
<div class="p"><!----></div>
<a name="tth_sEc3.2.2"></a><h4>
3.2.2 Other</h4>
See section <a href="#sec:configformat">3.3</a> for how to specify dependency, source, and class-output locations.
<div class="p"><!----></div>
<a name="tth_sEc3.3"></a><h3>
3.3 Config File Format</h3>
<a name="sec:configformat">
</a>
<div class="p"><!----></div>
Each project <em>must</em> have a .ensime file. The .ensime file contains the configuration for your project, and must be located in your project's root directory.The contents of the file must be a valid Emacs-Lisp S-Expression. Here's a quick primer on ELisp values.
<div class="p"><!----></div>
<br /><br />
<table border="1">
<tr><td align="left"><b>"..."</b> </td><td align="left">A String </td></tr>
<tr><td align="left"><b>t</b> </td><td align="left">True </td></tr>
<tr><td align="left"><b>nil</b> </td><td align="left">False, null, or opposite of t. </td></tr>
<tr><td align="left"><b>(...)</b> </td><td align="left">A literal list. </td></tr>
<tr><td align="left"><b>:abcd123</b> </td><td align="left">A keyword </td></tr>
<tr><td align="left"><b>(:key1 val1 :key2 val2)</b> </td><td align="left">An indexed property-list. </td></tr></table>
<div class="p"><!----></div>
<br /><br />What follows is a description of all available configuration options. Required options are marked as 'Required'. Any filename or directory paths may be relative to the project root.
<div class="p"><!----></div>
<br /><b>:root-dir</b>
<br />
<blockquote><div>
The root directory of your project. This option should be filled in by your editor.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: a filename
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:name</b>
<br />
<blockquote><div>
The short identifier for your project. Should be the same that you use
when publishing. Will be displayed in the Emacs mode-line when
connected to an ENSIME server.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: name
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:package</b>
<br />
<blockquote><div>
An optional 'primary' package for your project. Used by ENSIME to populate
the project outline view.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: package name
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:module-name</b>
<br />
<blockquote><div>
The canonical module-name of this project.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: name
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:active-subproject</b>
<br />
<blockquote><div>
The module-name of the subproject which is currently selected.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: module name
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:depends-on-modules</b>
<br />
<blockquote><div>
A list of module-names on which this project depends.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: module names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:version</b>
<br />
<blockquote><div>
The current, working version of your project.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: version number
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:compile-deps</b>
<br />
<blockquote><div>
A list of jar files and class directories to include on the compilation
classpath. No recursive expansion will be done.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: file and directory names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:compile-jars</b>
<br />
<blockquote><div>
A list of jar files and directories to search for jar files to include
on the compilation classpath. Directories will be searched recursively.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: file and directory names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:runtime-deps</b>
<br />
<blockquote><div>
A list of jar files and class directories to include on the runtime
classpath. No recursive expansion will be done.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: file and directory names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:runtime-jars</b>
<br />
<blockquote><div>
A list of jar files and directories to search for jar files to include
on the runtime classpath. Directories will be searched recursively.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: file and directory names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:test-deps</b>
<br />
<blockquote><div>
A list of jar files and class directories to include on the test
classpath. No recursive expansion will be done.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: file and directory names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:source-roots</b>
<br />
<blockquote><div>
A list of directories in which to start searching for source files.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: directory names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:reference-source-roots</b>
<br />
<blockquote><div>
A list of files or directories in which to start searching for reference
sources. Generally these are the sources that correspond to library
dependencies.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: a combination of directory names or .jar or .zip
file names
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:target</b>
<br />
<blockquote><div>
The root of the class output directory.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: directory
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:target</b>
<br />
<blockquote><div>
The root of the test class output directory.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: directory
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:disable-index-on-startup</b>
<br />
<blockquote><div>
Disable the classpath indexing process that happens at startup.
This will speed up the loading process significantly, at the
cost of breaking some functionality.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
Boolean: t or nil
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:disable-source-load-on-startup</b>
<br />
<blockquote><div>
Disable the parsing and reloading of all sources that normally
occurs on startup.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
Boolean: t or nil
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:disable-scala-jars-on-classpath</b>
<br />
<blockquote><div>
Disable putting standard Scala jars (i.e. scala-library.jar,
scala-reflect.jar and scala-compiler) on the classpath.
Useful for compiling against custom Scala builds and for
development of Scala compiler.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
Boolean: t or nil
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:only-include-in-index</b>
<br />
<blockquote><div>
Only classes that match one of the given regular expressions will be
added to the index. If this is omitted, all classes will be added.
This can be used to reduce memory usage and speed up loading.
For example:
<dl>
<dd><b>
<pre>:only-include-in-index ("my\\.project\\.packages\\.\*" "important\\.dependency\\..\*")
</pre>
</b></dd>
</dl>
This option can be used in conjunction with 'exclude-from-index' -
the result when both are given is that the exclusion expressions are
applied to the names that pass the inclusion filter.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: regular expresions
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:exclude-from-index</b>
<br />
<blockquote><div>
Classes that match one of the given regular expressions will not be
added to the index. This can be used to reduce memory usage and
speed up loading.
For example:
<dl>
<dd><b>
<pre>:exclude-from-index ("com\\.sun\\..\*" "com\\.apple\\..\*")
</pre>
</b></dd>
</dl>
This option can be used in conjunction with 'only-include-in-index' -
the result when both are given is that the exclusion expressions are
applied to the names that pass the inclusion filter.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: regular expresions
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:compiler-args</b>
<br />
<blockquote><div>
Specify arguments that should be passed to ENSIME's internal
presentation compiler. Warning: the presentation compiler
understands a subset of the batch compiler's arguments.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: arguments
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:builder-args</b>
<br />
<blockquote><div>
Specify arguments that should be passed to ENSIME's internal
incremental compiler.<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: arguments
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:java-compiler-args</b>
<br />
<blockquote><div>
Specify arguments that should be passed to ENSIME's internal
JDT java compiler. Arguments are passed as a list of strings,
with each pair being a key, value drawn from
org.eclipse.jdt.internal.compiler.impl.CompilerOptions<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
List of Strings: arguments
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:java-compiler-version</b>
<br />
<blockquote><div>
Specify version of java compiler to use (must be supported by internal
JDT).<br /><br />
<b>Arguments:</b>
<dl>
<dd><b>
<pre>
String: version
</pre>
</b></dd>
</dl>
</div></blockquote>
<br />
<div class="p"><!----></div>
<b>:formatting-prefs</b>
<br />
<blockquote><div>
Customize the behavior of the source formatter. All Scalariform
preferences are supported:
<br /><br />
<table border="1">
<tr><td align="left"><b>:alignParameters</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:alignSingleLineCaseStatements</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:alignSingleLineCaseStatements_maxArrowIndent</b> </td><td align="left">1-100 </td></tr>
<tr><td align="left"><b>:compactStringConcatenation</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:doubleIndentClassDeclaration</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:indentLocalDefs</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:indentPackageBlocks</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:indentSpaces</b> </td><td align="left">1-10 </td></tr>
<tr><td align="left"><b>:indentWithTabs</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:multilineScaladocCommentsStartOnFirstLine</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:preserveDanglingCloseParenthesis</b> </td><td align="left">t or nil </td></tr>
<tr><td align="left"><b>:preserveSpaceBeforeArguments</b> </td><td align="left">t or nil </td></tr>