Debian Codegraph @

debian/KWStyle.1

raw
1 .TH KWSTYLE 1 2016-02-06
2 .SH NAME
3 KWStyle \- Style checker for source code
4 .SH SYNOPSIS
5 .B KWStyle
6 .br
7 .SH DESCRIPTION
8 This manual page documents briefly the
9 .BR KWStyle
10 command.
11
12 You can find information on the KWStyle web page at https://kitware.github.io/KWStyle/.
13
14 .SH OPTIONS
15 .PP
16 \fB\-d\fR
17 .RS 4
18 Specify a directory.
19 .RE
20 .PP
21 \fB\-R\fR
22 .RS 4
23 Associated with \-d: recurse through directories.
24 .RE
25 .PP
26 \fB\-v\fR
27 .RS 4
28 Display errors.
29 .RE
30 .PP
31 \fB\-qv\fR
32 .RS 4
33 Display less information.
34 .RE
35 .PP
36 \fB\-lesshtml\fR
37 .RS 4
38 Display less HTML.
39 .RE
40 .PP
41 \fB\-vim\fR
42 .RS 4
43 Generate errors as VIM format.
44 .RE
45 .PP
46 \fB\-msvc\fR
47 .RS 4
48 Generate errors as MSVC format.
49 .RE
50 .PP
51 \fB\-gcc\fR
52 .RS 4
53 Generate errors as GCC format.
54 .RE
55 .PP
56 \fB\-html [filename]\fR
57 .RS 4
58 Generate the HTML report.
59 .RE
60 .PP
61 \fB\-cvs\fR
62 .RS 4
63 Using KWStyle as a cvs precommit script.
64 .RE
65 .PP
66 \fB\-exporthtml\fR
67 .RS 4
68 Export the HTML report online.
69 .RE
70 .PP
71 \fB\-xml [filename]\fR
72 .RS 4
73 Read a XML configure file.
74 .RE
75 .PP
76 \fB\-exportxml [filename]\fR
77 .RS 4
78 Write output the report as a simple XML.
79 .RE
80 .PP
81 \fB\-o [filename]\fR
82 .RS 4
83 Overwrite rules file.
84 .RE
85 .PP
86 \fB\-D\fR
87 .RS 4
88 Specify a file listing all the directories.
89 .RE
90 .PP
91 \fB\-B [filename]\fR
92 .RS 4
93 Specify the base directory of the file.
94 .RE
95 .PP
96 \fB\-b [filename]\fR
97 .RS 4
98 Specify a black list of words.
99 .RE
100 .PP
101 \fB\-dart <filename> [maxerror] [group]\fR
102 .RS 4
103 Write out files to be send to the dart server.
104 With: maxerror (Default = \-1)
105 With: group (Default = 0)
106 .RE
107 .PP
108 \fB\-kwsurl <url>\fR
109 .RS 4
110 Specify the base url of the KWStyle HTML report.
111 .RE
112 .PP
113 \fB\-fix\fR
114 .RS 4
115 Write out a fixed version of the parsed file.
116 .RE
117 .PP
118 \fB<infile>\fR
119 .RS 4
120 input filename
121 .RE
122
123 .SH SEE ALSO
124 List of KWStyle features at https://kitware.github.io/KWStyle/resources/features.html.
125
126 .SH AUTHOR
127 Julien Jomier
128
129 This manual page was written by Mathieu Malaterre
130 <[email protected]> and Benjamin Eikel <[email protected]> for the Debian GNU/Linux system (but may be used by others).