Skip to content

Commit 35066c8

Browse files
aggro80aggro80
committed
Update man page
1 parent 2fa2157 commit 35066c8

1 file changed

Lines changed: 40 additions & 26 deletions

File tree

‎man/cppcheck.1.xml‎

Lines changed: 40 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -102,28 +102,30 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
102102
<refsynopsisdiv>
103103
<cmdsynopsis>
104104
<command>&dhpackage;</command>
105-
<arg choice="opt"><option>--append=[file]</option></arg>
106-
<arg choice="opt"><option>-D[id]</option></arg>
107-
<arg choice="opt"><option>--enable=[id]</option></arg>
108-
<arg choice="opt"><option>--error-exitcode=[n]</option></arg>
105+
<arg choice="opt"><option>--append=&lt;file&gt;</option></arg>
106+
<arg choice="opt"><option>-D&lt;id&gt;</option></arg>
107+
<arg choice="opt"><option>--enable=&lt;id&gt;</option></arg>
108+
<arg choice="opt"><option>--error-exitcode=&lt;n&gt;</option></arg>
109109
<arg choice="opt"><option>--errorlist</option></arg>
110-
<arg choice="opt"><option>--exitcode-suppressions=[file]</option></arg>
111-
<arg choice="opt"><option>--file-list=file</option></arg>
110+
<arg choice="opt"><option>--exitcode-suppressions=&lt;file&gt;</option></arg>
111+
<arg choice="opt"><option>--file-list=&lt;file&gt;</option></arg>
112112
<arg choice="opt"><option>--force</option></arg>
113113
<arg choice="opt"><option>--help</option></arg>
114-
<arg choice="opt"><option>-I[dir]</option></arg>
115-
<arg choice="opt"><option>-i[dir]</option></arg>
114+
<arg choice="opt"><option>-I&lt;dir&gt;</option></arg>
115+
<arg choice="opt"><option>-i&lt;dir&gt;</option></arg>
116116
<arg choice="opt"><option>--inline-suppr</option></arg>
117-
<arg choice="opt"><option>-j[jobs]</option></arg>
117+
<arg choice="opt"><option>-j&lt;jobs&gt;</option></arg>
118118
<arg choice="opt"><option>--quiet</option></arg>
119119
<arg choice="opt"><option>--report-progress</option></arg>
120+
<arg choice="opt"><option>--rule=&lt;rule&gt;</option></arg>
121+
<arg choice="opt"><option>--rule-file=&lt;file&gt;</option></arg>
120122
<arg choice="opt"><option>--style</option></arg>
121-
<arg choice="opt"><option>--suppressions-list=[file]</option></arg>
122-
<arg choice="opt"><option>--template '[text]'</option></arg>
123+
<arg choice="opt"><option>--suppressions-list=&lt;file&gt;</option></arg>
124+
<arg choice="opt"><option>--template '&lt;text&gt;'</option></arg>
123125
<arg choice="opt"><option>--verbose</option></arg>
124126
<arg choice="opt"><option>--version</option></arg>
125127
<arg choice="opt"><option>--xml</option></arg>
126-
<arg choice="opt"><option>--xml-version=[version]</option></arg>
128+
<arg choice="opt"><option>--xml-version=&lt;version&gt;]</option></arg>
127129
<arg choice="opt"><option>file or path</option></arg>
128130
<arg choice="plain"><option>...</option></arg>
129131
</cmdsynopsis>
@@ -146,20 +148,20 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
146148
variablelist.term.break.after parameters to
147149
control the term elements. -->
148150
<varlistentry>
149-
<term><option>--append=[file]</option></term>
151+
<term><option>--append=&lt;file&gt;</option></term>
150152
<listitem>
151153
<para>This allows you to provide information about functions by providing an implementation for these.</para>
152154
</listitem>
153155
</varlistentry>
154156
<varlistentry>
155-
<term><option>-D[id]</option></term>
157+
<term><option>-D&lt;id&gt;</option></term>
156158
<listitem>
157159
<para>By default Cppcheck checks all configurations. Use -D to limit the checking. When -D is used the checking is limited to the given configuration.
158160
Example: -DDEBUG=1 -D__cplusplus</para>
159161
</listitem>
160162
</varlistentry>
161163
<varlistentry>
162-
<term><option>--enable=[id]</option></term>
164+
<term><option>--enable=&lt;id&gt;</option></term>
163165
<listitem>
164166
<para>Enable additional checks. The available ids are:
165167
<glosslist>
@@ -199,9 +201,9 @@ Example: -DDEBUG=1 -D__cplusplus</para>
199201
</listitem>
200202
</varlistentry>
201203
<varlistentry>
202-
<term><option>--error-exitcode=[n]</option></term>
204+
<term><option>--error-exitcode=&lt;n&gt;</option></term>
203205
<listitem>
204-
<para>If errors are found, integer [n] is returned instead of default 0.
206+
<para>If errors are found, integer &lt;n&gt; is returned instead of default 0.
205207
EXIT_FAILURE is returned if arguments are not valid or if no input files are
206208
provided. Note that your operating system can modify this value, e.g.
207209
256 can become 0.</para>
@@ -214,13 +216,13 @@ Example: -DDEBUG=1 -D__cplusplus</para>
214216
</listitem>
215217
</varlistentry>
216218
<varlistentry>
217-
<term><option>--exitcode-suppressions=[file]</option></term>
219+
<term><option>--exitcode-suppressions=&lt;file&gt;</option></term>
218220
<listitem>
219221
<para>Used when certain messages should be displayed but should not cause a non-zero exitcode.</para>
220222
</listitem>
221223
</varlistentry>
222224
<varlistentry>
223-
<term><option>--file-list=[file]</option></term>
225+
<term><option>--file-list=&lt;file&gt;</option></term>
224226
<listitem>
225227
<para>Specify the files to check in a text file. One filename per line.</para>
226228
</listitem>
@@ -241,15 +243,15 @@ default.</para>
241243
</listitem>
242244
</varlistentry>
243245
<varlistentry>
244-
<term><option>-I [dir]</option></term>
246+
<term><option>-I &lt;dir&gt;</option></term>
245247
<listitem>
246248
<para>Give include path. Give several -I parameters to give several paths. First given path is checked first. If paths are relative to source
247249
files, this is not needed.</para>
248250
</listitem>
249251
</varlistentry>
250252

251253
<varlistentry>
252-
<term><option>-i [dir]</option></term>
254+
<term><option>-i &lt;dir&gt;</option></term>
253255
<listitem>
254256
<para>Give path to ignore. Give several -i parameters to ignore several paths. Give directory name or filename with path as parameter.
255257
Directory name is matched to all parts of the path.</para>
@@ -264,9 +266,9 @@ Directory name is matched to all parts of the path.</para>
264266
</listitem>
265267
</varlistentry>
266268
<varlistentry>
267-
<term><option>-j [jobs]</option></term>
269+
<term><option>-j &lt;jobs&gt;</option></term>
268270
<listitem>
269-
<para>Start [jobs] threads to do the checking work.</para>
271+
<para>Start &lt;jobs&gt; threads to do the checking work.</para>
270272
</listitem>
271273
</varlistentry>
272274
<varlistentry>
@@ -282,6 +284,18 @@ Directory name is matched to all parts of the path.</para>
282284
<para>Report progress when checking a file.</para>
283285
</listitem>
284286
</varlistentry>
287+
<varlistentry>
288+
<term><option>--rule=&lt;rule&gt;</option></term>
289+
<listitem>
290+
<para>Match regular expression.</para>
291+
</listitem>
292+
</varlistentry>
293+
<varlistentry>
294+
<term><option>--rule-file=&lt;file&gt;</option></term>
295+
<listitem>
296+
<para>Use given rule file.</para>
297+
</listitem>
298+
</varlistentry>
285299
<varlistentry>
286300
<term><option>-s</option></term>
287301
<term><option>--style</option></term>
@@ -290,14 +304,14 @@ Directory name is matched to all parts of the path.</para>
290304
</listitem>
291305
</varlistentry>
292306
<varlistentry>
293-
<term><option>--suppressions-list=[file]</option></term>
307+
<term><option>--suppressions-list=&lt;file&gt;</option></term>
294308
<listitem>
295309
<para>Suppress warnings listed in the file. Filename and line are optional. The format of the single line in file is: [error id]:[filename]:[line].
296310
You can use --template or --xml to see the error id.</para>
297311
</listitem>
298312
</varlistentry>
299313
<varlistentry>
300-
<term><option>--template '[text]'</option></term>
314+
<term><option>--template '&lt;text&gt;'</option></term>
301315
<listitem>
302316
<para>Format the error messages. E.g. '{file}:{line},{severity},{id},{message}' or '{file}({line}):({severity}) {message}'. Pre-defined templates: gcc, vs</para>
303317
</listitem>
@@ -322,7 +336,7 @@ Directory name is matched to all parts of the path.</para>
322336
</listitem>
323337
</varlistentry>
324338
<varlistentry>
325-
<term><option>--xml-version=[version]</option></term>
339+
<term><option>--xml-version=&lt;version&gt;</option></term>
326340
<listitem>
327341
<para>Select the XML file version. Currently versions 1 and 2 are available. The default version is 1.</para>
328342
</listitem>

0 commit comments

Comments
 (0)