forked from andre-simon/highlight
-
Notifications
You must be signed in to change notification settings - Fork 4
/
INSTALL
279 lines (199 loc) · 8.77 KB
/
INSTALL
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
Highlight installation instructions
-----------------------------------
Content
=======
1. Package structure
2. Dependencies
3. Compilation and installation
4. Known compiler issues
5. LaTeX unicode support
6. Lazy pointer issue under MacOS X
7. Static linking (to run highlight as service)
8. Known distribution issues
1. Package structure
=====================
root of highlight-x.x
|
|-- extras # extras for highlight scripting
| |-- css-themes # detailed theme explanation
| |-- json # Lua to JSON converters
| |-- langdefs-res. # language definition template with explanations
| |-- pandoc # Pandoc macros
| |-- tcl # TCL extension
| |-- web_plugins # plugins for various web toolkits
| |-- pywal # pywal terminal colouring template
| `-- swig # SWIG interface and sample code
|-- gui_files # supporting files for the optional GUI
| |-- ext # file open filter configuration
| `-- l10n # GUI translations
|-- langDefs # language definitions (*.lang)
|-- man # man page
|-- plugins # Lua plugin scripts (*.lua)
|-- src # source code
| |-- cli # command line interface code
| |-- core # highlight core code (builds the library)
| | |-- astyle # Artistic Style code
| | `-- Diliculum # Diliculum code
| `-- gui-qt # optional GUI code
| `-- include # Header files
| | |-- astyle # Artistic Style headers
| | `-- Diliculum # Diliculum headers
`-- themes # color themes (*.theme)
AUTHORS # contributors of code and patches
ChangeLog # list of changes
COPYING # license
Doxyfile # Doxygen configuration
filetypes.conf # file type extension configuration
highlight.desktop # desktop integration of optional GUI
INSTALL # this file
makefile # basic makefile
README # user manual
README_DE # German user manual
README_LANGLIST # list of supported languages
README_PLUGINS # plug-in manual
README_REGEX # regular expression manual
README_RELEASE # information for packagers
TODO # just ideas, no plans
2. Dependencies
===============
In order to compile highlight, you need to install Lua (5.x or LuaJIT as
devel package) and Boost (at least the header files).
The optional GUI requires Qt5 and its development tools (qmake).
3. Compilation and installation
===============================
3.1 Linux
---------
1. tar xjf highlight-x.x.tar.bz2
2. cd highlight-x.x
3. make help
4. make / make cli (compile static library and the CLI interface)
make lib-static (optional, compile static library only)
make lib-shared (optional, compile shared library only)
make gui (optional, compile static library and the Qt GUI)
5, make install
(depending on your installation destination, you need to be root)
6. make install-gui (optional)
Install additional files if you have compiled the highlight GUI binary.
(depending on your installation destination, you need to be root)
7. make clean (optional)
After the compilation of the CLI or GUI, a library (libhighlight.a) was
generated which may be used for other C++ projects.
Highlight's default data directory is /usr/share/highlight.
You may alter this directory at compile time or at run time:
- See the makefile how to add a compiler directive which defines an
installation directory (data_dir variable)
- See the makefile to change the configuration file directory
(conf_dir variable)
- See section CONFIG FILE SEARCH in README for run time options
3.2 Windows
-----------
Install the following tools and libraries.
a) Install Qt Creator IDE (www.qt.io)
b) Install MingW (gcc toolchain)
-Download Online-Installer:
https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/installer/
-Start mingw-w64-install.exe and select default options
-Add bin directory of the downloaded files to the system PATH
-open cmd.exe and type "g++ --version" to check
c) Compile Qt:
-Install git, Python and Perl for Windows
-If you install Strawberry Perl, remove its g++ compiler path from your system PATH
-Open cmd.exe and change into a directory "QT-ROOT" which will contain the Qt sources
-Execute the following cmds
git clone git://code.qt.io/qt/qt5.git
cd qt5
git checkout 5.15.0
perl init-repository
-Configure Qt. Create new directories qt-build and qt-5.15.0-x64 in QT-ROOT. Change into qt-build and run
..\qt5\configure -release -opensource -confirm-license -static -static-runtime -optimize-size -no-pch \
-no-fontconfig -no-freetype -qt-libpng -qt-libjpeg -no-tiff -nomake examples -nomake tools \
-nomake tests -skip webengine -skip qtlocation -opengl desktop -prefix "F:\QT-ROOT\qt-5.15.0-x64"
-Compile Qt (set numbers of CPU cores after -j):
mingw32-make -j8
-Install the tools and libs in qt-5.15.0-x64:
mingw32-make -j8 install
d) Add compiler and Qt paths (location of qmake.exe) in QtCreator
e) Install Boost
-Download and extract package from boost.org (no compilation needed)
f) Compile Lua
-Download source package: https://www.lua.org/download.html
-Open QtCreator and create a new Project ("without Qt")
-Import all c files of the Lua package except lua.c and luac.c
-Edit the project file like this:
TEMPLATE = lib
CONFIG += console
CONFIG -= app_bundle
CONFIG -= qt
DEFINES -= UNICODE
SOURCES += $$files(../lua-5.3.0/src/*.c)
SOURCES -= ../lua-5.3.0/src/lua.c ../lua-5.3.0/src/luac.c
-Compile the Lua library
g) Install upx from http://upx.sourceforge.net/
h) Open the pro files in src/w32-projects and src/gui_qt in QtCreator and
adjust the paths of libraries and tools. Compile the lib project first.
3.3 Precompiled packages
------------------------
Highlight is written in ISO C++. The following packages are available:
- UNIX console and GUI application
- Windows console and GUI application
- statically and dynamically linked library
The website www.andre-simon.de offers links to precompiled packages for several
operating systems (like Debian, Arch Linux, Ubuntu, Darwin, FreeBSD).
The website distributes the latest upstream sources.
Windows and MacOS executables
http://www.andre-simon.de
Arch Linux
http://www.archlinux.org/packages/community/i686/highlight/
Debian GNU/Linux
https://packages.debian.org/search?keywords=highlight
Fedora
http://koji.fedoraproject.org/koji/packageinfo?packageID=2044
FreeBSD
http://www.freshports.org/textproc/highlight/
Gentoo Portage
https://packages.gentoo.org/packages/app-text/highlight
Mac OS X
http://braumeister.org/formula/highlight
Slackware
http://sotirov-bg.net/slackpack/search.cgi?q=highlight
openSUSE
https://build.opensuse.org/package/show/devel:tools/highlight
Ubuntu
http://packages.ubuntu.com/oneiric/allpackages
Windows Chocolatey
https://chocolatey.org/packages/highlight
4. Known compiler issues
========================
Highlight was tested with gcc > 4.8 and clang 3.9.0. It will not compile with gcc 2.x.
For gcc versions < 4.7, unique_ptr needs to be replaced by auto_ptr.
5. LaTeX unicode support
========================
To enable UTF-8 support in LaTeX, the ucs package has to be installed.
See the following package names or sources:
Fedora: tetex-unicode
SuSE: latex-ucs
6. Lazy pointer issue under MacOS X
===================================
Stripping the highlight binary causes program termination at runtime:
dyld: lazy symbol binding failed: lazy pointer not found
dyld: lazy pointer not found
Trace/BPT trap
To avoid this issue, edit the makefile to not strip the binary after
linkage (see src/makefile, LDFLAGS variable).
7. Static linking (to run highlight as service)
===============================================
If highlight cannot be run as service because of shared linkage, link
it with the -static option (see src/makefile, LDFLAGS variable).
8. Known distribution issues
============================
Linux Mint
There is a system script called highlight which is located in a preferenced path:
mintsystem provides: /usr/local/bin/highlight
highlight provides: /usr/bin/highlight
Calling this script with the true highlight command line options will have no effect.
See bug tracker items: https://bugs.launchpad.net/linuxmint/+bug/593583 and
https://bugs.launchpad.net/linuxmint/+bug/815005
OpenSUSE Leap 42.2
==================
The lua-devel package installation causes error messages.
Workaround: ignore dependency conflict.