Debian Codegraph @

doc/man/botch-dose2html.pod

raw
1 =head1 NAME
2
3 botch-dose2html - turn the yaml output by B<dose-builddebcheck> into html
4
5 =head1 SYNOPSIS
6
7 =over
8
9 =item B<botch-dose2html> [options] I<in.yaml> I<out.html>
10
11 =back
12
13 =head1 DESCRIPTION
14
15 Given a buildcheck or distcheck result, create a html overview and machine
16 readable json data.
17
18 =head1 OPTIONS
19
20 =over 4
21
22 =item B<-h, --help>
23
24 Show help.
25
26 =item B<--btsuser>
27
28 bts user to associate packages with. Must be given in conjunction with B<--btstag>.
29
30 =item B<--btstag>
31
32 bts tag to associate packages with. Must be given in conjunction with B<--btsuser>.
33
34 =item B<--desc>
35
36 A HTML description that will be put on top of the generated page.
37
38 =item B<--srcsdir>
39
40 Output directory for individual source package overviews. Must be given in conjunction with B<--packages>.
41
42 =item B<--wnpp>
43
44 Retrieve and print wnpp status for packages. Must be given in conjunction with B<--packages>.
45
46 =item B<--packages>
47
48 Packages file to create a mapping from binary to source packages. Must be given in conjunction with B<--srcsdir>. This argument can be specified more than once.
49
50 =item B<--timestamp>
51
52 Add timestamp to generated HTML.
53
54 =item B<--wwwroot>
55
56 This string will be removed from the beginning of the hyperlinks to the source
57 package overviews created with the B<--srcsdir> option.
58
59 =item B<-v, --verbose>
60
61 Be verbose.
62
63 =back
64
65 =head1 EXAMPLE
66
67 Generate overview:
68
69 dose-builddebcheck --explain --successes --failures --deb-native-arch=amd64 \
70 packages-build packages-host sources | botch-dose2html - out.html
71
72 =head1 BUGS
73
74 See L<http://bugs.debian.org/botch>.
75
76 =head1 SEE ALSO
77
78 Debian doc-base Manual F</usr/share/doc/botch/wiki/Home.html>
79
80 =head1 AUTHOR
81
82 This man page was written by Johannes Schauer. Botch is written by Johannes
83 Schauer and Pietro Abate.
84
85 =head1 COPYRIGHT
86
87 Copyright 2012-2014 Johannes Schauer, Pietro Abate
88
89 This program is free software: you can redistribute it and/or modify it under
90 the terms of the GNU Lesser General Public License as published by the Free
91 Software Foundation, either version 3 of the License, or (at your option) any
92 later version. A special linking exception to the GNU Lesser General Public
93 License applies to this library, see the COPYING file for more information.
94