1SOURCE-HIGHLIGHT(1) User Commands SOURCE-HIGHLIGHT(1)
2
6 Source-highlight - convert source code to syntax highlighted document
7
9 source-highlight [OPTIONS]... < input_file > output_file
10
12 GNU source-highlight 3.1.4
13 Highlight the syntax of a source file (e.g. Java) into a specific for‐
15 mat (e.g. HTML)
16 source-highlight [OPTIONS]... -i input_file -o output_file
18 source-highlight [OPTIONS]... [FILES]...
19 -h, --help
21 Print help and exit
22 --detailed-help
24 Print help, including all details and hidden options, and exit
25 -V, --version
27 Print version and exit
28 -i, --input=filename
30 input file. default std input
31 -o, --output=filename
33 output file. default std output. If STDOUT is specified, the
34 output is directed to standard output
35 -s, --src-lang=STRING
37 source language (use --lang-list to get the complete list). If
38 not specified, the source language will be guessed from the file
39 extension.
40 --lang-list
42 list all the supported language and associated language defini‐
43 tion file
44 --outlang-list
46 list all the supported output language and associated language
47 definition file
48 -f, --out-format=STRING
50 output format (use --outlang-list to get the complete list)
51 (default=`html')
52 -d, --doc
54 create an output file that can be used as a stand alone document
55 (e.g., not to be included in another one)
56 --no-doc
58 cancel the --doc option even if it is implied (e.g., when css is
59 given)
60 -c, --css=filename
62 the external style sheet filename. Implies --doc
63 -T, --title=STRING
65 give a title to the output document. Implies --doc
66 -t, --tab=INT
68 specify tab length. (default=`8')
69 -H, --header=filename
71 file to insert as header
72 -F, --footer=filename
74 file to insert as footer
75 --style-file=filename
77 specify the file containing format options
78 (default=`default.style')
79 --style-css-file=filename specify the file containing format options
81 (in
82 css syntax)
83 --style-defaults=filename specify the file containing defaults for for‐
85 mat
86 options (default=`style.defaults')
87 --outlang-def=filename
89 output language definition file
90 --outlang-map=filename
92 output language map file (default=`outlang.map')
93 --data-dir=path
95 directory where language definition files and language maps are
96 searched for. If not specified these files are searched for in
97 the current directory and in the data dir installation directory
98 --output-dir=path
100 output directory
101 --lang-def=filename
103 language definition file
104 --lang-map=filename
106 language map file (default=`lang.map')
107 --show-lang-elements=filename
109 prints the language elements that are defined
110 in the language definition file
112 --infer-lang
114 force to infer source script language (overriding given language
115 specification)
116 Lines:
118 -n, --line-number[=padding]
119 number all output lines, using the specified padding character
120 (default=`0')
121 --line-number-ref[=prefix]
123 number all output lines and generate an anchor,
124 made of the specified prefix + the line number (default=`line')
126 Filtering output:
128 Mode: linerange
130 specifying line ranges
132 --line-range=STRING
134 generate only the lines in the specified range(s)
135 --range-separator=STRING
137 the optional separator to be printed among ranges (e.g., "...")
138 --range-context=INT
140 number of (context) lines generated even if not in range
141 Mode: regexrange
143 specifying regular expression delimited ranges
145 --regex-range=STRING
147 generate only the lines within the specified regular expressions
148 reference generation:
150 --gen-references=STRING
151 generate references (possible values="inline", "postline",
152 "postdoc" default=`inline')
153 --ctags-file=filename
155 specify the file generated by ctags that will be used to gener‐
156 ate references (default=`tags')
157 --ctags=cmd
159 how to run the ctags command. If this option is not specified,
160 ctags will be executed with the default value. If it is speci‐
161 fied with an empty string, ctags will not be executed at all
162 (default=`ctags --excmd=n --tag-relative=yes')
163 testing:
165 -v, --verbose
166 verbose mode on
167 -q, --quiet
169 print no progress information
170 --binary-output
172 write output files in binary mode
173 --statistics
175 print some statistics (i.e., elapsed time)
176 --gen-version
178 put source-highlight version in the generated file (default=on)
179 --check-lang=filename
181 only check the correctness of a language definition file
182 --check-outlang=filename
184 only check the correctness of an output language definition file
185 --failsafe
187 if no language definition is found for the input, it is simply
188 copied to the output
189 -g, --debug-langdef[=type]
191 debug a language definition. In dump mode just dumps all the
192 steps; in interactive, at each step, waits for some input (press
193 ENTER to step) (possible values="interactive", "dump"
194 default=`dump')
195 --show-regex=filename
197 show the regular expression automaton corresponding to a lan‐
198 guage definition file
199 Maintained by Lorenzo Bettini <http://www.lorenzobettini.it>
201
203 Report bugs to <bug-source-highlight at gnu.org>
204
206 Copyright © 1999-2008 Lorenzo Bettini <http://www.lorenzobettini.it>
207 This program comes with ABSOLUTELY NO WARRANTY.
208 This is free software; you may redistribute copies of the program under
209 the terms of the GNU General Public License. For more information
210 about these matters, see the file named COPYING.
211
213 The full documentation for Source-highlight is maintained as a Texinfo
214 manual. If the info and Source-highlight programs are properly
215 installed at your site, the command
216 info Source-highlight
218 should give you access to the complete manual.
220Source-highlight 3.1.4 (library: 3:1M:a0y)2010 SOURCE-HIGHLIGHT(1)