Beyond Linux® From Scratch (System V Edition) - Version r11.2-1338

Chapter 11. General Utilities

Highlight-4.4

Introduction to Highlight

Highlight is an utility that converts source code to formatted text with syntax highlighting.

This package is known to build and work properly using an LFS 11.3 platform.

Package Information

Highlight Dependencies

Required

Boost-1.81.0 and Lua-5.4.4

Optional

Qt-5.15.8 (to build the GUI front-end)

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/highlight

Installation of Highlight

For consistency, do not compress man pages. 

sed -i '/GZIP/s/^/#/' makefile

To build Highlight run the following command: 

make

To build the Qt5 GUI front-end, run the following command: 

make doc_dir=/usr/share/doc/highlight-4.4/ gui

This package does not come with a test suite.

To install Highlight, run the following command as the root user: 

make doc_dir=/usr/share/doc/highlight-4.4/ install

To install the GUI program, run the following command as the root user: 

make install-gui

Command Explanations

doc_dir=/usr/share/doc/highlight-4.4/: installs the highlight documentation into a versioned directory. This parameter is also needed for make gui, because its value would be hardcoded into the gui executable. Note that the trailing “/” is necessary.

Contents

Installed Programs: highlight and highlight-gui (optional)
Installed Libraries: None
Installed Directories: /etc/highlight, /usr/share/doc/highlight-4.4, and /usr/share/highlight

Short Descriptions

highlight

is a universal source code to formatted text converter

highlight-gui

is the Qt5 interface to highlight.