1SOURCE-HIGHLIGHT(1) User Commands SOURCE-HIGHLIGHT(1)
2
6 source-highlight - manual page for source-highlight 2.8rc1
7
9 source-highlight [OPTIONS]... [FILES]...
10
12 GNU source-highlight 2.8rc1
13 Highlight the syntax of a source file (e.g. Java) into a specific for‐
15 mat (e.g. HTML)
16 -h, --help
18 Print help and exit
19 -V, --version
21 Print version and exit
22 -i, --input=filename
24 input file. default std input
25 -o, --output=filename
27 output file. default std output. If STDOUT is specified, the
28 output is directed to standard output
29 -s, --src-lang=STRING
31 source language (use --lang-list to get the complete list). If
32 not specified, the source language will be guessed from the file
33 extension.
34 --lang-list
36 list all the supported language and associated language defini‐
37 tion file
38 --outlang-list
40 list all the supported output language and associated language
41 definition file
42 -f, --out-format=STRING
44 output format (use --outlang-list to get the complete list)
45 (default=`html')
46 -d, --doc
48 create an output file that can be used as a stand alone document
49 (e.g., not to be included in another one)
50 --no-doc
52 cancel the --doc option even if it is implied (e.g., when css is
53 given)
54 -c, --css=filename
56 the external style sheet filename. Implies --doc
57 -T, --title=STRING
59 give a title to the output document. Implies --doc
60 -t, --tab=INT
62 specify tab length. (default=`8')
63 -H, --header=filename
65 file to insert as header
66 -F, --footer=filename
68 file to insert as footer
69 --style-file=filename
71 specify the file containing format options
72 (default=`default.style')
73 --style-css-file=filename specify the file containing format options
75 (in
76 css syntax)
77 --outlang-def=filename
79 output language definition file
80 --outlang-map=filename
82 output language map file (default=`outlang.map')
83 --data-dir=path
85 directory where language definition files and language maps are
86 searched for. If not specified these files are searched for in
87 the current directory and in the data dir installation directory
88 --output-dir=path
90 output directory
91 --lang-def=filename
93 language definition file
94 --lang-map=filename
96 language map file (default=`lang.map')
97 --show-lang-elements=filename
99 prints the language elements that are defined
100 in the language definition file
102 --infer-lang
104 force to infer source script language (overriding given language
105 specification)
106 reference generation:
108 -n, --line-number[=padding]
109 number all output lines, using the specified padding character
110 (default=`0')
111 --line-number-ref[=prefix]
113 number all output lines and generate an anchor,
114 made of the specified prefix + the line number (default=`line')
116 --gen-references=STRING
118 generate references (possible values="inline", "postline",
119 "postdoc" default=`inline')
120 --ctags-file=filename
122 specify the file generated by ctags that will be used to gener‐
123 ate references (default=`tags')
124 --ctags=cmd
126 how to run the ctags command. If this option is not specified,
127 ctags will be executed with the default value. If it is speci‐
128 fied with an empty string, ctags will not be executed at all
129 (default=`ctags --excmd=n --tag-relative=yes')
130 testing:
132 -v, --verbose
133 verbose mode on
134 -q, --quiet
136 print no progress information
137 --statistics
139 print some statistics (i.e., elapsed time)
140 --gen-version
142 put source-highlight version in the generated file (default=on)
143 --check-lang=filename
145 only check the correctness of a language definition file
146 --check-outlang=filename
148 only check the correctness of an output language definition file
149 --failsafe
151 if no language definition is found for the input, it is simply
152 copied to the output
153 -g, --debug-langdef[=type]
155 debug a language definition. In dump mode just dumps all the
156 steps; in interactive, at each step, waits for some input (press
157 ENTER to step) (possible values="interactive", "dump"
158 default=`dump')
159 --show-regex=filename
161 show the regular expression automaton corresponding to a lan‐
162 guage definition file
163 Maintained by Lorenzo Bettini <http://www.lorenzobettini.it>
165
167 Report bugs to <bug-source-highlight at gnu.org>
168
170 Copyright © 1999-2007 Lorenzo Bettini <http://www.lorenzobettini.it>
171 This program comes with ABSOLUTELY NO WARRANTY.
172 This is free software; you may redistribute copies of the program under
173 the terms of the GNU General Public License. For more information
174 about these matters, see the file named COPYING.
175
177 The full documentation for source-highlight is maintained as a Texinfo
178 manual. If the info and source-highlight programs are properly
179 installed at your site, the command
180 info source-highlight
182 should give you access to the complete manual.
184source-highlight 2.8rc1 September 2007 SOURCE-HIGHLIGHT(1)