1=head1 NAME
2
3bib2html - A perl script that generates an HTML documentation for a BibTeX database
4
5
6=head1 SYNOPSYS
7
8bib2html [options] F<file> [F<file> ...]
9
10=head1 DESCRIPTION
11
12bib2html is a script which permits to generate a set of HTML pages for
13the entries of BibTeX files.
14
15=head1 OPTIONS
16
17=over 4
18
19=item B<-[no]b>
20
21=item B<--[no]bibtex>
22
23This option permits to generate, or not, a verbatim of the
24BibTeX entry code.
25
26=item B<--[no]checknames>
27
28This option permits to check if the some author's names are
29similar and generates a set of warnings about each of them.
30
31=item B<--cvs>
32
33If specified, this option disables the deletion of the subfiles
34'.cvs', 'CVS' and 'CVSROOT' in the output directory.
35
36=item B<-d> I<name>[=I<value>]
37
38See B<--generatorparam>.
39
40=item B<--doctitle> I<text>
41
42Sets the title that appears in the main page.
43
44=item B<-f>
45
46=item B<--force>
47
48Forces to overwrite into the output directory.
49
50=item B<-g> I<class>
51
52=item B<--generator> I<class>
53
54Sets the generator to use. I<class> must be a valid Perl class.
55
56=item B<--generatorparam> I<name>[=I<value>]
57
58Sets a generator param. It must be a I<key>=I<value> pair or
59simply a I<name>.
60Example: "target=thisdirectory" defines the parameter target
61with corresponding value "thisdirectory". The specified
62parameters which are not supported by the generator are
63ignored.
64
65=item B<--generatorparams>
66
67Shows the list of supported parameters, and their
68semantics for the current generator.
69
70=item B<--genlist>
71
72Shows the list of supported generators.
73
74=item B<-?>
75
76=item B<-h>
77
78Show the list of available options.
79
80=item B<--help>
81
82See B<--man>.
83
84=item B<--jabref>
85
86The generator will translate JabRef's groups
87into Bib2HTML's domains.
88
89=item B<--lang> I<name>
90
91Sets the language used by the generator.
92
93=item B<--langlist>
94
95Shows the list of supported language.
96
97=item B<--man>
98
99=item B<--manual>
100
101Show the manual page.
102
103=item B<-o> F<file>
104
105=item B<--output> F<file>
106
107Sets the directory or the F<file> in which the documentation will be put.
108
109=item B<-p> F<file>
110
111=item B<--preamble> F<file>
112
113Sets the name of the F<file> to read to include some TeX preambles.
114You could use this option to dynamicaly defined some unsupported
115LaTeX commands.
116
117=item B<--protect> F<shell_wildcard>
118
119If specified, this option disables the deletion in the target
120directory of the subfiles that match the specified shell
121expression.
122
123=item B<-q>
124
125Don't be verbose: only error messages are displayed.
126
127=item B<--[no]sortw>
128
129Shows (or not) a sorted list of warnings.
130
131=item B<--stdout>
132
133Force the output of the generated files onto the standard output.
134This option is equivalent to C<-d stdout>.
135
136=item B<--svn>
137
138If specified, this option disables the deletion of the subfiles
139'.svn' and 'svn' in the output directory.
140
141=item B<--texcmd>
142
143Shows the list of supported LaTeX commands.
144
145=item B<--theme> I<name>
146
147Sets the theme used by the generator.
148
149=item B<--themelist>
150
151Shows the list of supported themes.
152
153=item B<-v>
154
155Be more verbose.
156
157=item B<--version>
158
159Show the version of this script.
160
161=item B<--[no]warning>
162
163If false, the warning are converted to errors.
164
165=item B<--windowtitle> I<text>
166
167Sets the title that appears as the window's title.
168
169=back
170
171=head1 LICENSE
172
173S<GNU Public License (GPL)>
174
175=head1 COPYRIGHT
176
177S<Copyright (c) 1998-06 St�phane Galland E<lt>galland@arakhne.orgE<gt>>
178
179=head1 CONTRIBUTORS
180
181=over
182
183=item S<Aurel GABRIS E<lt>L<gabrisa@optics.szfki.kfki.hu>E<gt>>
184
185=item S<Gasper JAKLIC E<lt>L<gasper.jaklic@fmf.uni-lj.si>E<gt>>
186
187=item S<Tobias LOEW E<lt>L<loew@mathematik.tu-darmstadt.de>E<gt>>
188
189=item S<Joao LOURENCO E<lt>L<joao.lourenco@di.fct.unl.pt>E<gt>>
190
191=item S<Dimitris MICHAIL E<lt>L<michail@mpi-sb.mpg.de>E<gt>>
192
193=item S<Luca PAOLINI E<lt>L<paolini@di.unito.it>E<gt>>
194
195=item S<Norbert PREINING E<lt>L<preining@logic.at>E<gt>>
196
197=item S<Cristian RIGAMONTI E<lt>L<cri@linux.it>E<gt>>
198
199=item S<Sebastian RODRIGUEZ E<lt>L<sebastian.rodriguez@utbm.fr>E<gt>>
200
201=item S<Martin P.J. ZINSER E<lt>L<zinser@zinser.no-ip.info>E<gt>>
202
203=item S<Olivier HUGHES E<lt>L<olivier.hugues@gmail.com>E<gt>>
204
205=back
206
207=head1 SEE ALSO
208
209L<latex>, L<bibtex>
210