Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / Enscript
CommitLineData
7f918cf1
CE
1<!DOCTYPE html>\r
2<html lang="en">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
5<meta name="generator" content="AsciiDoc 8.6.9">\r
6<title>Enscript</title>\r
7<link rel="stylesheet" href="./asciidoc.css" type="text/css">\r
8<link rel="stylesheet" href="./pygments.css" type="text/css">\r
9\r
10\r
11<script type="text/javascript" src="./asciidoc.js"></script>\r
12<script type="text/javascript">\r
13/*<![CDATA[*/\r
14asciidoc.install();\r
15/*]]>*/\r
16</script>\r
17<link rel="stylesheet" href="./mlton.css" type="text/css">\r
18</head>\r
19<body class="article">\r
20<div id="banner">\r
21<div id="banner-home">\r
22<a href="./Home">MLton 20180207</a>\r
23</div>\r
24</div>\r
25<div id="header">\r
26<h1>Enscript</h1>\r
27</div>\r
28<div id="content">\r
29<div id="preamble">\r
30<div class="sectionbody">\r
31<div class="paragraph"><p><a href="http://www.gnu.org/s/enscript/">GNU Enscript</a> converts ASCII files to\r
32PostScript, HTML, and other output languages, applying language\r
33sensitive highlighting (similar to <a href="Emacs">Emacs</a>'s font lock mode). Here\r
34are a few <em>states</em> files for highlighting <a href="StandardML"> Standard ML</a>.</p></div>\r
35<div class="ulist"><ul>\r
36<li>\r
37<p>\r
38<a href="https://github.com/MLton/mlton/blob/master/ide/enscript/sml_simple.st"><span class="monospaced">sml_simple.st</span></a>&#8201;&#8212;&#8201;Provides highlighting of keywords, string and character constants, and (nested) comments.\r
39</p>\r
40</li>\r
41</ul></div>\r
42<div class="ulist"><ul>\r
43<li>\r
44<p>\r
45<a href="https://github.com/MLton/mlton/blob/master/ide/enscript/sml_verbose.st"><span class="monospaced">sml_verbose.st</span></a>&#8201;&#8212;&#8201;Supersedes\r
46the above, adding highlighting of numeric constants. Due to the\r
47limited parsing available, numeric record labels are highlighted as\r
48numeric constants, in all contexts. Likewise, a binding precedence\r
49separated from <span class="monospaced">infix</span> or <span class="monospaced">infixr</span> by a newline is highlighted as a\r
50numeric constant and a numeric record label selector separated from\r
51<span class="monospaced">#</span> by a newline is highlighted as a numeric constant.\r
52</p>\r
53</li>\r
54</ul></div>\r
55<div class="ulist"><ul>\r
56<li>\r
57<p>\r
58<a href="https://github.com/MLton/mlton/blob/master/ide/enscript/sml_fancy.st"><span class="monospaced">sml_fancy.st</span></a>&#8201;&#8212;&#8201;Supersedes the\r
59above, adding highlighting of type and constructor bindings,\r
60highlighting of explicit binding of type variables at <span class="monospaced">val</span> and <span class="monospaced">fun</span>\r
61declarations, and separate highlighting of core and modules level\r
62keywords. Due to the limited parsing available, it is assumed that\r
63the input is a syntactically correct, top-level declaration.\r
64</p>\r
65</li>\r
66</ul></div>\r
67<div class="ulist"><ul>\r
68<li>\r
69<p>\r
70<a href="https://github.com/MLton/mlton/blob/master/ide/enscript/sml_gaudy.st"><span class="monospaced">sml_gaudy.st</span></a>&#8201;&#8212;&#8201;Supersedes the\r
71above, adding highlighting of type annotations, in both expressions\r
72and signatures. Due to the limited parsing available, it is assumed\r
73that the input is a syntactically correct, top-level declaration.\r
74</p>\r
75</li>\r
76</ul></div>\r
77</div>\r
78</div>\r
79<div class="sect1">\r
80<h2 id="_install_and_use">Install and use</h2>\r
81<div class="sectionbody">\r
82<div class="ulist"><ul>\r
83<li>\r
84<p>\r
85Version 1.6.3 of <a href="http://people.ssh.com/mtr/genscript">GNU Enscript</a>\r
86</p>\r
87<div class="ulist"><ul>\r
88<li>\r
89<p>\r
90Copy all files to <span class="monospaced">/usr/share/enscript/hl/</span> or <span class="monospaced">.enscript/</span> in your home directory.\r
91</p>\r
92</li>\r
93<li>\r
94<p>\r
95Invoke <span class="monospaced">enscript</span> with <span class="monospaced">--highlight=sml_simple</span> (or <span class="monospaced">--highlight=sml_verbose</span> or <span class="monospaced">--highlight=sml_fancy</span> or <span class="monospaced">--highlight=sml_gaudy</span>).\r
96</p>\r
97</li>\r
98</ul></div>\r
99</li>\r
100<li>\r
101<p>\r
102Version 1.6.1 of <a href="http://people.ssh.com/mtr/genscript">GNU Enscript</a>\r
103</p>\r
104<div class="ulist"><ul>\r
105<li>\r
106<p>\r
107Append <a href="https://github.com/MLton/mlton/blob/master/ide/enscript/sml_all.st"><span class="monospaced">sml_all.st</span></a> to <span class="monospaced">/usr/share/enscript/enscript.st</span>\r
108</p>\r
109</li>\r
110<li>\r
111<p>\r
112Invoke <span class="monospaced">enscript</span> with <span class="monospaced">--pretty-print=sml_simple</span> (or <span class="monospaced">--pretty-print=sml_verbose</span> or <span class="monospaced">--pretty-print=sml_fancy</span> or <span class="monospaced">--pretty-print=sml_gaudy</span>).\r
113</p>\r
114</li>\r
115</ul></div>\r
116</li>\r
117</ul></div>\r
118</div>\r
119</div>\r
120<div class="sect1">\r
121<h2 id="_feedback">Feedback</h2>\r
122<div class="sectionbody">\r
123<div class="paragraph"><p>Comments and suggestions should be directed to <a href="MatthewFluet">MatthewFluet</a>.</p></div>\r
124</div>\r
125</div>\r
126</div>\r
127<div id="footnotes"><hr></div>\r
128<div id="footer">\r
129<div id="footer-text">\r
130</div>\r
131<div id="footer-badges">\r
132</div>\r
133</div>\r
134</body>\r
135</html>\r