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
|
= HIGHLIGHT IMPORTANT RELEASE AND PACKAGING INFORMATION
André Simon
:revdate: February 2021
:lang: en
:toc: left
:toc-title: Contents
:toclevels: 4
:sectnums:
:sectnumlevels: 2
:sectanchors:
// Misc Settings:
:experimental: true
:icons: font
:linkattrs: true
// =====================================
// Custom Attributes for Reference Links
// =====================================
// Highlight Docs (uncovenrted):
:INSTALL: pass:q[link:INSTALL[`INSTALL`]]
// Source files:
:bclear: pass:q[link:themes/bclear.theme[bclear^]]
:src_makefile: pass:q[link:src/makefile[`src/makefile`^]]
== GIT: FIRST COMMIT -- THEN EXPORT
Triple check.
== TESTS
........................
highlight --print-config
........................
This will print the config file search paths and compilation options.
To test syntax definitions, run
..............................
highlight --list-scripts=langs
..............................
This command compiles all syntax scripts.
................................
highlight --list-scripts=themes
highlight --list-scripts=plugins
................................
These commands show installed files.
To quickly test highlighting on the command line, type:
................................
highlight -ISc
................................
Now type some C code and hit kbd:[CTRL+D] to quit.
Add `--verbose` to print additional syntax parsing information.
Test filetype recognition:
* file suffix (default)
* no suffix (i.e. makefile)
* shebang (i.e. Bash script)
* force syntax using `-S` and `--syntax-by-name`
== UNNEEDED FILES
Remove `src/gui-qt/.qmake.stash`
== THIRD PARTY COMPATIBILITY
The following options are used in third party applications:
* `--input, -i`
* `--output, -o`
* `--encoding, -u`
* `--font`
* `--font-size`
* `--force`
* `--line-numbers, -l`
* `--replace-tabs, -t`
* `--syntax`
* `--syntax-by-name`
* `--out-format`
* `--include-style`
* `--inline-css`
* `--style`
* `--failsafe`
* `--validate-input`
The following themes are used in third party applications:
* {bclear} (Evolution)
The following platform dependent classes are used in SWIG scripts (ikiwiki):
* `DataDir`
== SO-LIB VERSION
Increase `SO_VERSION` in {src_makefile}.
See the makefiles and {INSTALL} for more packaging information.
// EOF //
|