1KRAZY2XML(1)          User Contributed Perl Documentation         KRAZY2XML(1)
2
3
4

NAME

6       krazy2xml - KDE source code checking for the English Breakfast Network
7       (EBN)
8

SYNOPSIS

10       krazy2xml [options]
11

DESCRIPTION

13       krazy2xml is a big wrapper around krazy(1) for no obvious use other
14       than generating Code Checking Quality reports on the English Breakfast
15       Network.
16

OPTIONS

18       --help
19           Print help message and exit.
20
21       --version
22           Print version information and exit.
23
24       --config <settings.yaml>
25           Read system settings from the specified settings.yaml configuration
26           file.
27
28       --dry-run
29           With this option the checker programs aren't run; instead, the
30           command line for each check that would be run is printed.
31
32       --nodb
33           Set this option to turn-off all database operations.
34
35       --dbgen=[id]
36           Use the specified value for the database generationId.
37
38           The value is intended to be computed by the database being used and
39           then passed into this program, rather than this program computing
40           the value itself.
41
42           Do NOT use this option unless you know what you're doing.
43
44       --component=[comp]
45           Only run for the specified KDE component. By default, the kde-4.x
46           component is assumed.
47
48       --module=[mod1,<mod2>,...<modN>]
49           Only run for the specified KDE module within the component.  By
50           default all modules within the component are processed.
51
52       --title=title
53           A title string to print onto each report page. If this option is
54           not provided, a title for each page is generated that contains the
55           source component, module and subdir.
56

EXAMPLES

58       Process all modules within component extragear
59            % krazy2xml --component=extragear
60
61       Process module kdelibs within component kde-4.0
62            % krazy2xml --component=kde-4.0 --module=kdelibs
63

ENVIRONMENT

65       KRAZY_PLUGIN_PATH - this is a colon-separated list of paths which is
66       searched when locating plugins. By default, plugins are searched for in
67       the path $TOP/lib/krazy2/krazy-plugins:krazy-plugins.
68
69       KRAZY_EXTRA_PATH - this is a colon-separated list of paths which is
70       searched when locating "extra" plugins. By default, the "extras" are
71       searched for in the path $TOP/lib/krazy2/krazy-extras:krazy-extras.
72
73       KRAZY_SET_PATH - this is a colon-separated list of paths which is
74       searched when locating checker sets. By default, the sets are searched
75       for in the path $TOP/lib/krazy2/krazy-sets:krazy-sets.
76
77       where $TOP is the top-level installation directory (eg. /usr/local,
78       /usr/local/Krazy2)
79

EXIT STATUS

81       In normal operation, krazy2xml exits with status 0.
82
83       If a command line option was incorrectly provided, krazy2xml exits with
84       status=1.
85
86       If krazy2 was envoked with the --help or --version options it will exit
87       with status=0.
88

90       Copyright (c) 2005-2013 by Allen Winter <winter@kde.org>
91
92       This program is free software; you can redistribute it and/or modify it
93       under the terms of the GNU General Public License as published by the
94       Free Software Foundation; either version 2 of the License, or (at your
95       option) any later version.
96
97       This program is distributed in the hope that it will be useful, but
98       WITHOUT ANY WARRANTY; without even the implied warranty of
99       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
100       General Public License for more details.
101
102       You should have received a copy of the GNU General Public License along
103       with this program; if not, write to the Free Software Foundation, Inc.,
104       51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
105

FILES

107       krazyrc(3) files are processed in descending hierarchical order with
108       each sublevel setting appending in a logical way to the previous level
109       settings. The following files are read:
110        component/.krazy
111        component/module/.krazy
112        component/module/subdir/.krazy
113

SEE ALSO

115       krazyrc(3), krazy2(1), krazy2all(1)
116

AUTHORS

118       Allen Winter, <winter@kde.org>
119
120
121
122perl v5.38.0                      2023-07-20                      KRAZY2XML(1)
Impressum