source-highlight(1)

1SOURCE-HIGHLIGHT(1)              User Commands             SOURCE-HIGHLIGHT(1)
2
3
4

NAME

6       Source-highlight - convert source code to syntax highlighted document
7

SYNOPSIS

9       source-highlight [OPTIONS]... < input_file > output_file
10

DESCRIPTION

12       GNU source-highlight 3.1.6
13
14       Highlight  the syntax of a source file (e.g. Java) into a specific for‐
15       mat (e.g.  HTML)
16
17              source-highlight  [OPTIONS]...  -i  input_file  -o   output_file
18              source-highlight [OPTIONS]... [FILES]...
19
20       -h, --help
21              Print help and exit
22
23       --detailed-help
24              Print help, including all details and hidden options, and exit
25
26       -V, --version
27              Print version and exit
28
29       -i, --input=filename
30              input file. default std input
31
32       -o, --output=filename
33              output  file. default std output (when the third invocation form
34              is used). If STDOUT is specified,  the  output  is  directed  to
35              standard output
36
37       you can simply specify some files at the command line and also use reg‐
38       ular expressions (for instance *.java).  In this case the name for  the
39       output  files  will  be formed using the name of the source file with a
40       .<ext> appended, where <ext> is the extension chosen according  to  the
41       output format specified (for instance .html).
42
43       -s, --src-lang=STRING
44              source  language (use --lang-list to get the complete list).  If
45              not specified, the source language will be guessed from the file
46              extension.
47
48       --lang-list
49              list  all the supported language and associated language defini‐
50              tion file
51
52       --outlang-list
53              list all the supported output language and  associated  language
54              definition file
55
56       -f, --out-format=STRING
57              output  format  (use  --outlang-list  to  get the complete list)
58              (default=`html')
59
60       -d, --doc
61              create an output file that can be used as a stand alone document
62              (e.g., not to be included in another one)
63
64       --no-doc
65              cancel the --doc option even if it is implied (e.g., when css is
66              given)
67
68       -c, --css=filename
69              the external style sheet filename.  Implies --doc
70
71       -T, --title=STRING
72              give a title to the output document.  Implies --doc
73
74       -t, --tab=INT
75              specify tab length.  (default=`8')
76
77       -H, --header=filename
78              file to insert as header
79
80       -F, --footer=filename
81              file to insert as footer
82
83       --style-file=filename
84              specify     the     file     containing      format      options
85              (default=`default.style')
86
87       --style-css-file=filename  specify  the  file containing format options
88       (in
89              css syntax)
90
91       --style-defaults=filename specify the file containing defaults for for‐
92       mat
93              options  (default=`style.defaults')
94
95       --outlang-def=filename
96              output language definition file
97
98       --outlang-map=filename
99              output language map file (default=`outlang.map')
100
101       --data-dir=path
102              directory  where language definition files and language maps are
103              searched for.  If not specified these files are searched for  in
104              the current directory and in the data dir installation directory
105
106       --output-dir=path
107              output directory
108
109       --lang-def=filename
110              language definition file
111
112       --lang-map=filename
113              language map file  (default=`lang.map')
114
115       --show-lang-elements=filename
116              prints the language elements that are defined
117
118              in the language definition file
119
120       --infer-lang
121              force to infer source script language (overriding given language
122              specification)
123
124   Lines:
125       -n, --line-number[=padding]
126              number all output lines, using the specified  padding  character
127              (default=`0')
128
129       --line-number-ref[=prefix]
130              number all output lines and generate an anchor,
131
132              made of the specified prefix + the line number  (default=`line')
133
134       Filtering output:
135
136              Mode: linerange
137
138              specifying line ranges
139
140       --line-range=STRING
141              generate only the lines in the specified range(s)
142
143       --range-separator=STRING
144              the optional separator to be printed among ranges (e.g., "...")
145
146       --range-context=INT
147              number of (context) lines generated even if not in range
148
149              Mode: regexrange
150
151              specifying regular expression delimited ranges
152
153       --regex-range=STRING
154              generate only the lines within the specified regular expressions
155
156   reference generation:
157       --gen-references=STRING
158              generate   references   (possible  values="inline",  "postline",
159              "postdoc" default=`inline')
160
161       --ctags-file=filename
162              specify the file generated by ctags that will be used to  gener‐
163              ate references (default=`tags')
164
165       --ctags=cmd
166              how  to run the ctags command.  If this option is not specified,
167              ctags will be executed with the default value.  If it is  speci‐
168              fied  with  an  empty  string, ctags will not be executed at all
169              (default=`ctags --excmd=n --tag-relative=yes')
170
171   testing:
172       -v, --verbose
173              verbose mode on
174
175       -q, --quiet
176              print no progress information
177
178       --binary-output
179              write output files in binary mode
180
181       --statistics
182              print some statistics (i.e., elapsed time)
183
184       --gen-version
185              put source-highlight version in the generated file  (default=on)
186
187       --check-lang=filename
188              only check the correctness of a language definition file
189
190       --check-outlang=filename
191              only check the correctness of an output language definition file
192
193       --failsafe
194              if no language definition is found for the input, it  is  simply
195              copied to the output
196
197       -g, --debug-langdef[=type]
198              debug  a  language  definition.  In dump mode just dumps all the
199              steps; in interactive, at each step, waits for some input (press
200              ENTER   to   step)    (possible   values="interactive",   "dump"
201              default=`dump')
202
203       --show-regex=filename
204              show the regular expression automaton corresponding  to  a  lan‐
205              guage definition file
206
207       Maintained by Lorenzo Bettini <http://www.lorenzobettini.it>
208

REPORTING BUGS

210       Report bugs to <bug-source-highlight at gnu.org>
211

COPYRIGHT

213       Copyright  ©  1999-2008  Lorenzo Bettini <http://www.lorenzobettini.it>
214       This program comes with ABSOLUTELY NO WARRANTY.
215       This is free software; you may redistribute copies of the program under
216       the  terms  of  the  GNU  General Public License.  For more information
217       about these matters, see the file named COPYING.
218

NAME

SYNOPSIS

DESCRIPTION

REPORTING BUGS

COPYRIGHT

SEE ALSO