|
| 1 | +<?xml version="1.0" encoding="utf-8"?> |
| 2 | +<!DOCTYPE html |
| 3 | + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 4 | + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 5 | +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 6 | + |
| 7 | +<head> |
| 8 | +<title>Alex</title> |
| 9 | +<style> |
| 10 | + body { |
| 11 | + font-family: Arial |
| 12 | + } |
| 13 | + h1 { |
| 14 | + font-size: 24pt; |
| 15 | + padding-bottom: 0px; |
| 16 | + background-color: #77aaFF; |
| 17 | + } |
| 18 | + h2 { |
| 19 | + border-bottom: 1px dotted; |
| 20 | + font-size: 18pt; |
| 21 | + padding-top: 10px |
| 22 | + } |
| 23 | + .code-block { |
| 24 | + padding-left: 1em; |
| 25 | + } |
| 26 | +</style> |
| 27 | +</head> |
| 28 | +<body> |
| 29 | +<h1> |
| 30 | + Alex: A lexical analyser generator for Haskell |
| 31 | +</h1> |
| 32 | + |
| 33 | +<ul> |
| 34 | + <li><a href="#Overview">Overview</a></li> |
| 35 | + <li><a href="#Documentation">Documentation</a></li> |
| 36 | + <li><a href="#Download">Download</a></li> |
| 37 | + <li><a href="#Development">Development</a></li> |
| 38 | +</ul> |
| 39 | + |
| 40 | +<h2> |
| 41 | +<a name="Overview">Overview</a> |
| 42 | +</h2> |
| 43 | + |
| 44 | +<p> |
| 45 | + Alex is a tool for generating lexical analysers in Haskell, given a description of the tokens to be recognised in the form of regular expressions. |
| 46 | + It is similar to the tool <q>lex</q> or <q>flex</q> for C/C++. |
| 47 | +</p> |
| 48 | + |
| 49 | +<h2> |
| 50 | + <a name="Documentation">Documentation</a> |
| 51 | +</h2> |
| 52 | + |
| 53 | +<p>Documentation is hosted on <a href="https://haskell-alex.readthedocs.io">Read the Docs</a>.</p> |
| 54 | +<ul> |
| 55 | + <li><a href="https://haskell-alex.readthedocs.io">Online (HTML)</a></li> |
| 56 | + <li><a href="https://haskell-alex.readthedocs.io/_/downloads/en/latest/pdf/">PDF</a></li> |
| 57 | + <li><a href="https://haskell-alex.readthedocs.io/_/downloads/en/latest/htmlzip/">Downloadable HTML</a></li> |
| 58 | +</ul> |
| 59 | + |
| 60 | +<h2> |
| 61 | + <a name="Download">Download</a> |
| 62 | +</h2> |
| 63 | + |
| 64 | +<p>From <a href="https://hackage.haskell.org/package/alex">Hackage</a> via |
| 65 | + <a href="https://www.haskell.org/cabal/"><code>cabal-install</code></a>:</p> |
| 66 | +<div class="code-block"><code> |
| 67 | + cabal install alex |
| 68 | +</code></div> |
| 69 | + |
| 70 | +<p>From <a href="https://www.stackage.org/package/alex">Stackage</a> via |
| 71 | + <a href="https://haskellstack.org"><code>stack</code></a>, e.g.:</p> |
| 72 | +<div class="code-block"><code> |
| 73 | + stack install --resolver nightly alex |
| 74 | +</code></div> |
| 75 | + |
| 76 | +<p>Alex might also be pre-packaged for your OS (unconfirmed as of 2022-04-06):</p> |
| 77 | + |
| 78 | +<ul> |
| 79 | + <li>Ubuntu users: packages should be available from the universe repository.</li> |
| 80 | + <li>Debian GNU/Linux users: packages are available <a href="http://packages.debian.org/alex">here</a>.</li> |
| 81 | + <li>RPMs for other versions of Linux can be built directly from the source, using <tt>rpmbuild -ta</tt>.</li> |
| 82 | + <li>FreeBSD/x86 users: Alex is in the ports tree, |
| 83 | + so either <tt>pkg_add -r hs-alex</tt>, |
| 84 | + or install it from the ports tree in <tt>/usr/ports/devel/hs-alex</tt>. |
| 85 | + </li> |
| 86 | + <li>OpenBSD users: Alex is in the -current ports tree, you can install it from <tt>/usr/ports/devel/alex</tt>.</li> |
| 87 | +</ul> |
| 88 | + |
| 89 | +<h2> |
| 90 | + <a name="Development">Development</a> |
| 91 | +</h2> |
| 92 | + |
| 93 | +<p>Alex is licensed under a |
| 94 | + <a href="https://github.com/haskell/alex/blob/master/LICENSE">BSD-style license</a>. |
| 95 | + The current sources are on <a href="https://github.com/haskell/alex">GitHub</a>, |
| 96 | + get the latest version with: |
| 97 | +</p> |
| 98 | +<div class="code-block"><code> |
| 99 | + git clone https://github.com/haskell/alex.git |
| 100 | +</code></div> |
| 101 | + |
| 102 | +<p> |
| 103 | + Contribute by opening <a href="https://github.com/haskell/alex/issues">issues</a> |
| 104 | + which can be followed up by <a href="https://github.com/haskell/alex/pulls">pull requests</a>. |
| 105 | +</p> |
| 106 | + |
| 107 | +</body> |
| 108 | + |
| 109 | +</html> |
0 commit comments