1KRAZY2XML(1) User Contributed Perl Documentation KRAZY2XML(1)
2
3
4
6 krazy2xml - KDE source code checking for the English Breakfast Network
7 (EBN)
8
10 krazy2xml [options]
11
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
18 --help
19 Print help message and exit.
20
21 --version
22 Print version information and exit.
23
24 --dry-run
25 With this option the checker programs aren't run; instead, the
26 command line for each check that would be run is printed.
27
28 --nodb
29 Set this option to turn-off all database operations.
30
31 --dbgen=[id]
32 Use the specified value for the database generationId.
33
34 The value is intended to be computed by the database being used and
35 then passed into this program, rather than this program computing
36 the value itself.
37
38 Do NOT use this option unless you know what you're doing.
39
40 --component=[comp]
41 Only run for the specified KDE component. By default, the kde-4.x
42 component is assumed.
43
44 --module=[mod1,<mod2>,...<modN>]
45 Only run for the specified KDE module within the component. By
46 default all modules within the component are processed.
47
48 --title=title
49 A title string to print onto each report page. If this option is
50 not provided, a title for each page is generated that contains the
51 source component, module and subdir.
52
54 Process all modules within component extragear
55 % krazy2xml --component=extragear
56
57 Process module kdelibs within component kde-4.0
58 % krazy2xml --component=kde-4.0 --module=kdelibs
59
61 KRAZY_PLUGIN_PATH - this is a colon-separated list of paths which is
62 searched when locating plugins. By default, plugins are searched for in
63 the path $TOP/lib/krazy2/krazy-plugins:krazy-plugins.
64
65 KRAZY_EXTRA_PATH - this is a colon-separated list of paths which is
66 searched when locating "extra" plugins. By default, the "extras" are
67 searched for in the path $TOP/lib/krazy2/krazy-extras:krazy-extras.
68
69 KRAZY_SET_PATH - this is a colon-separated list of paths which is
70 searched when locating checker sets. By default, the sets are searched
71 for in the path $TOP/lib/krazy2/krazy-sets:krazy-sets.
72
73 where $TOP is the top-level installation directory (eg. /usr/local,
74 /usr/local/Krazy2)
75
77 In normal operation, krazy2xml exits with status 0.
78
79 If a command line option was incorrectly provided, krazy2xml exits with
80 status=1.
81
82 If krazy2 was envoked with the --help or --version options it will exit
83 with status=0.
84
86 Copyright (c) 2005-2010 by Allen Winter <winter@kde.org>
87
88 This program is free software; you can redistribute it and/or modify it
89 under the terms of the GNU General Public License as published by the
90 Free Software Foundation; either version 2 of the License, or (at your
91 option) any later version.
92
93 This program is distributed in the hope that it will be useful, but
94 WITHOUT ANY WARRANTY; without even the implied warranty of
95 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
96 General Public License for more details.
97
98 You should have received a copy of the GNU General Public License along
99 with this program; if not, write to the Free Software Foundation, Inc.,
100 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
101
103 krazyrc(5) files are processed in descending hierarchical order with
104 each sublevel setting appending in a logical way to the previous level
105 settings. The following files are read:
106 component/.krazy
107 component/module/.krazy
108 component/module/subdir/.krazy
109
111 krazyrc(5), krazy2(1), krazy2all(1)
112
114 Allen Winter, <winter@kde.org>
115
116
117
118perl v5.12.2 2010-08-08 KRAZY2XML(1)