share/man/nitc: Adding the man explication to disable contracts

[nit.git] / share / man / nitpick.md

diff --git a/share/man/nitpick.md b/share/man/nitpick.md
index f852d27..38dd752 100644 (file)
--- a/share/man/nitpick.md
+++ b/share/man/nitpick.md
@@ -1,68 +1,23 @@
-% NITPICK(1)
-
 # NAME
 
-Collect potential style and code issues.
-
-# SYNOPSYS
-
-nitpick [*options*]...
-
-# OPTIONS
-
-`-W`, `--warn`
-:   Show more warnings
-
-`-w`, `--warning`
-:   Show/hide a specific warning
-
-`-q`, `--quiet`
-:   Do not show warnings
+nitpick - collect potential style and code issues.
 
-`--stop-on-first-error`
-:   Stop on first error
+# SYNOPSIS
 
-`--no-color`
-:   Do not use color to display errors and warnings
+nitpick [*options*] FILE...
 
-`--log`
-:   Generate various log files
+# DESCRIPTION
 
-`--log-dir`
-:   Directory where to generate log files
+`nitpick` is a fast code checker.
 
-`-h`, `-?`, `--help`
-:   Show Help (This screen)
+It is currently used with the vim syntactic plugin.
 
-`--version`
-:   Show version and exit
-
-`--set-dummy-tool`
-:   Set toolname and version to DUMMY. Useful for testing
-
-`-v`, `--verbose`
-:   Verbose
-
-`--bash-completion`
-:   Generate bash_completion file for this program
-
-`--stub-man`
-:   Generate a stub manpage in pandoc markdown format
-
-`--disable-phase`
-:   DEBUG: Disable a specific phase; use `list` to get the list.
-
-`-I`, `--path`
-:   Set include path for loaders (may be used more than once)
-
-`--only-parse`
-:   Only proceed to parse step of loaders
+# OPTIONS
 
-`--only-metamodel`
-:   Stop after meta-model processing
+### `--vim-autocomplete`
+Generate metadata files used by the Vim plugin for autocompletion.
 
-`--ignore-visibility`
-:   Do not check, and produce errors, on visibility issues.
+This option is not expected to be called directly by users.
 
 # SEE ALSO