"Fossies" - the Fresh Open Source Software Archive

Member "highlight-3.57-x64/INSTALL" (12 May 2020, 8648 Bytes) of package /windows/www/highlight-3.57-x64.zip:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 Highlight installation instructions
    2 -----------------------------------
    3 
    4 Content
    5 =======
    6 
    7 1. Package structure
    8 2. Dependencies
    9 3. Compilation and installation
   10 4. Known compiler issues
   11 5. LaTeX unicode support
   12 6. Lazy pointer issue under MacOS X
   13 7. Static linking (to run highlight as service)
   14 8. Known distribution issues
   15 
   16 
   17 1. Package structure
   18 =====================
   19 
   20 root of highlight-x.x
   21 |
   22 |-- extras              # extras for highlight scripting
   23 |   |-- css-themes      # detailed theme explanation
   24 |   |-- json            # Lua to JSON converters
   25 |   |-- langdefs-res.   # language definition template with explanations
   26 |   |-- pandoc          # Pandoc macros
   27 |   |-- tcl             # TCL extension
   28 |   |-- web_plugins     # plugins for various web toolkits
   29 |   |-- pywal           # pywal terminal colouring template
   30 |   `-- swig            # SWIG interface and sample code
   31 |-- gui_files           # supporting files for the optional GUI
   32 |   |-- ext             # file open filter configuration
   33 |   `-- l10n            # GUI translations
   34 |-- langDefs            # language definitions (*.lang)
   35 |-- man                 # man page
   36 |-- plugins             # Lua plugin scripts (*.lua)
   37 |-- src                 # source code
   38 |   |-- cli             # command line interface code
   39 |   |-- core            # highlight core code (builds the library)
   40 |   |   |-- astyle      # Artistic Style code
   41 |   |   `-- Diliculum   # Diliculum code
   42 |   `-- gui-qt          # optional GUI code
   43 |   `-- include         # Header files
   44 |   |   |-- astyle      # Artistic Style headers
   45 |   |   `-- Diliculum   # Diliculum headers
   46 `-- themes              # color themes (*.theme)
   47 
   48 AUTHORS                 # contributors of code and patches
   49 ChangeLog               # list of changes
   50 COPYING                 # license
   51 Doxyfile                # Doxygen configuration
   52 filetypes.conf          # file type extension configuration
   53 highlight.desktop       # desktop integration of optional GUI
   54 INSTALL                 # this file
   55 makefile                # basic makefile
   56 README                  # user manual
   57 README_DE               # German user manual
   58 README_LANGLIST         # list of supported languages
   59 README_PLUGINS          # plug-in manual
   60 README_REGEX            # regular expression manual
   61 README_RELEASE          # information for packagers
   62 TODO                    # just ideas, no plans
   63 
   64 
   65 2. Dependencies
   66 ===============
   67 
   68 In order to compile highlight, you need to install Lua (5.x or LuaJIT as
   69 devel package) and Boost (at least the header files).
   70 The optional GUI requires Qt5 and its development tools (qmake).
   71 
   72 
   73 3. Compilation and installation
   74 ===============================
   75 
   76 3.1 Linux
   77 ---------
   78 
   79  1. tar xjf highlight-x.x.tar.bz2
   80 
   81  2. cd highlight-x.x
   82 
   83  3. make help
   84 
   85  4. make / make cli   (compile static library and the CLI interface)
   86     make lib-static   (optional, compile static library only)
   87     make lib-shared   (optional, compile shared library only)
   88     make gui          (optional, compile static library and the Qt GUI)
   89 
   90  5, make install
   91     (depending on your installation destination, you need to be root)
   92 
   93  6. make install-gui (optional)
   94     Install additional files if you have compiled the highlight GUI binary.
   95     (depending on your installation destination, you need to be root)
   96 
   97  7. make clean (optional)
   98 
   99  After the compilation of the CLI or GUI, a library (libhighlight.a) was
  100  generated which may be used for other C++ projects.
  101 
  102  Highlight's default data directory is /usr/share/highlight.
  103  You may alter this directory at compile time or at run time:
  104  - See the makefile how to add a compiler directive which defines an
  105    installation directory (data_dir variable)
  106  - See the makefile to change the configuration file directory
  107    (conf_dir variable)
  108  - See section CONFIG FILE SEARCH in README for run time options
  109 
  110 
  111 3.2 Windows
  112 -----------
  113 
  114 Install the following tools and libraries.
  115 
  116 a) Install Qt Creator IDE (www.qt.io)
  117 
  118 b) Install MingW (gcc toolchain)
  119 
  120     -Download Online-Installer: 
  121      https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/installer/
  122     -Start mingw-w64-install.exe and select default options
  123     -Add bin directory of the downloaded files to the system PATH
  124     -open cmd.exe and type "g++ --version" to check
  125 
  126 c) Compile Qt:
  127 
  128     -Download and extract package from qt.io:
  129      https://www.qt.io/download-open-source/ -> qt-everywhere-opensource-src-5.6.0.tar.gz
  130     -Open cmd.exe and change into the Qt directory
  131     -Configure Qt. Use static if you do not want to ship Qt DLLs:
  132      configure -release -opensource -confirm-license -static  -qt-zlib -qt-pcre -qt-libpng -qt-libjpeg -qt-freetype -qt-sql-sqlite -no-openssl -nomake examples -opengl  desktop
  133     -Compile Qt:
  134      mingw32-make -k -j4
  135 
  136 d) Add compiler and Qt paths (location of qmake.exe) in QtCreator
  137 
  138 e) Install Boost
  139 
  140     -Download and extract package from boost.org (no compilation needed)
  141 
  142 f) Compile Lua 
  143 
  144     -Download source package: https://www.lua.org/download.html
  145     -Open QtCreator and create a new Project ("without Qt")
  146     -Import all c files of the Lua package except lua.c and luac.c
  147     -Edit the project file like this: 
  148     
  149      TEMPLATE = lib
  150      CONFIG += console
  151      CONFIG -= app_bundle
  152      CONFIG -= qt
  153      DEFINES -= UNICODE
  154      SOURCES += $$files(../lua-5.3.0/src/*.c)
  155      SOURCES -= ../lua-5.3.0/src/lua.c ../lua-5.3.0/src/luac.c
  156 
  157     -Compile the Lua library
  158 
  159 g) Install upx from http://upx.sourceforge.net/
  160 
  161 h) Open the pro files in src/w32-projects and src/gui_qt in QtCreator and 
  162    adjust the paths of libraries and tools. Compile the lib project first.
  163 
  164 i) Ship highlight with libgcc_s_dw2-1.dll (32 bit) libgcc_s_seh-1.dll (64 bit)  libstdc++-6.dll libwinpthread-1.dll
  165    (all DLLs are located in the mingw32 installation)
  166 
  167    
  168 3.3 Precompiled packages
  169 ------------------------
  170 
  171 Highlight is written in ISO C++. The following packages are available:
  172 - UNIX console and GUI application
  173 - Windows console and GUI application
  174 - statically and dynamically linked library
  175 
  176 The website www.andre-simon.de offers links to precompiled packages for several
  177 operating systems (like Debian, Arch Linux, Ubuntu, Darwin, FreeBSD).
  178 The website distributes the latest upstream sources.
  179 
  180 Windows and MacOS executables
  181 http://www.andre-simon.de
  182 
  183 Arch Linux
  184 http://www.archlinux.org/packages/community/i686/highlight/
  185 
  186 Debian GNU/Linux
  187 https://packages.debian.org/search?keywords=highlight
  188 
  189 Fedora
  190 http://koji.fedoraproject.org/koji/packageinfo?packageID=2044
  191 
  192 FreeBSD
  193 http://www.freshports.org/textproc/highlight/
  194 
  195 Gentoo Portage
  196 https://packages.gentoo.org/packages/app-text/highlight
  197 
  198 Mac OS X
  199 http://braumeister.org/formula/highlight
  200 
  201 Slackware
  202 http://sotirov-bg.net/slackpack/search.cgi?q=highlight
  203 
  204 openSUSE
  205 https://build.opensuse.org/package/show/devel:tools/highlight
  206 
  207 Ubuntu
  208 http://packages.ubuntu.com/oneiric/allpackages
  209 
  210 Windows Chocolatey
  211 https://chocolatey.org/packages/highlight
  212 
  213    
  214 4. Known compiler issues
  215 ========================
  216 
  217 Highlight was tested with gcc > 4.8 and clang 3.9.0. It will not compile with gcc 2.x.
  218 For gcc versions < 4.7, unique_ptr needs to be replaced by auto_ptr.
  219 
  220 
  221 5. LaTeX unicode support
  222 ========================
  223 
  224 To enable UTF-8 support in LaTeX, the ucs package has to be installed.
  225 See the following package names or sources:
  226 
  227 Fedora: tetex-unicode
  228 SuSE:   latex-ucs
  229 
  230 
  231 6. Lazy pointer issue under MacOS X
  232 ===================================
  233 
  234 Stripping the highlight binary causes program termination at runtime:
  235 
  236 dyld: lazy symbol binding failed: lazy pointer not found
  237 dyld: lazy pointer not found
  238 Trace/BPT trap
  239 
  240 To avoid this issue, edit the makefile to not strip the binary after
  241 linkage (see src/makefile, LDFLAGS variable).
  242 
  243 
  244 7. Static linking (to run highlight as service)
  245 ===============================================
  246 
  247 If highlight cannot be run as service because of shared linkage, link
  248 it with the -static option (see src/makefile, LDFLAGS variable).
  249 
  250 
  251 8. Known distribution issues
  252 ============================
  253 
  254 Linux Mint
  255 
  256 There is a system script called highlight which is located in a preferenced path: 
  257 
  258 mintsystem provides: /usr/local/bin/highlight
  259  highlight provides: /usr/bin/highlight
  260 
  261 Calling this script with the true highlight command line options will have no effect. 
  262 See bug tracker items: https://bugs.launchpad.net/linuxmint/+bug/593583 and
  263                        https://bugs.launchpad.net/linuxmint/+bug/815005
  264                    
  265 
  266 OpenSUSE Leap 42.2
  267 ==================
  268 
  269 The lua-devel package installation causes error messages. 
  270 Workaround: ignore dependency conflict.
  271