Highlight documentation

Installation

Package contents

root of highlight-x.x
|
|-- examples            # examples for highlight scripting
|   |-- web_plugins     # plugins for various web toolkits
|   `-- 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             # plug-in scripts (*.lua)
|-- src                 # source code
|   |-- cli             # command line interface code
|   |-- core            # highlight core code (builds the library)
|   |   |-- astyle      # Artistic Style code
|   |   |-- Diliculum   # Diliculum code
|   |   `-- re          # Regex code
|   `-- gui-qt          # optional GUI code
|   `-- include         # Header files
|   |   |-- astyle      # Artistic Style headers
|   |   |-- Diliculum   # Diliculum headers
|   |   `-- re          # Regex 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_REGEX            # regular expression manual
TODO                    # just ideas, no plans

Dependencies

In order to compile highlight, you need to install Lua5.1 (devel package) and Boost (at least the header files).

Installation of the source package

tar xzvf highlight-x.x-x.tar.gz
cd highlight-x.x-x
make help
make
make all-gui (optional, to compile the Qt GUI)
make install
(depending on your installation destination, you need to be root)
make clean (optional)
make apidocs (optional)
(you need to have doxygen installed)

Highlight's default data directory is /usr/share/highlight.
You may alter this directory at compile time or at run time:

See highlight/makefile how to add a compiler directive which defines an installation directory (HL_DATA_DIR)
Use the --data-dir option to define a new directory at run time. You may want to save this parameter in the highlight configuration file ($HOME/.highlightrc)
You can add an additional data directory by the --add-data-dir option.
Files will be searched in this directory first. This may also be configured in $HOME/.highlightrc.

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).

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).

Installation instructions for Windows

Start setup program and follow the instructions.