From 545f305e367ae91c2a57aaae42d38841fedd9f9f Mon Sep 17 00:00:00 2001
From: Robert Callicotte <rcallicotte@protonmail.com>
Date: Mon, 1 Nov 2021 01:56:22 -0500
Subject: [PATCH] docs: add man page for salt-lint (#270)

Add man page for salt-lint.

Fixes #269

Signed-off-by: Roald Nefs <info@roaldnefs.com>
---
 docs/man/salt-lint.1 | 88 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 docs/man/salt-lint.1

diff --git a/docs/man/salt-lint.1 b/docs/man/salt-lint.1
new file mode 100644
index 0000000..595357d
--- /dev/null
+++ b/docs/man/salt-lint.1
@@ -0,0 +1,88 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
+.TH SALT-LINT "1" "October 2021" "salt-lint 0.6.1" "User Commands"
+.SH NAME
+salt-lint - A command-line utility that checks for best practices in SaltStack.
+.SH SYNOPSIS
+salt\-lint [OPTIONS] [FILE ...]
+.SH DESCRIPTION
+This document describes the \fBsalt-lint\fR program, a linting utility that
+checks for best practices in SaltStack SLS files.
+.SH OPTIONS
+.SS "positional arguments:"
+.TP
+FILE
+one or more files or paths
+.SS "options:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-version\fR
+show program's version number and exit
+.TP
+\fB\-L\fR
+list all the rules
+.TP
+\fB\-r\fR RULESDIR
+specify one or more rules directories using one or
+more \fB\-r\fR arguments. Any \fB\-r\fR flags override the default
+rules in \fI\,$rulesdir/saltlint/rules\/\fP, unless \fB\-R\fR is also used.
+.TP
+\fB\-R\fR
+Use default rules in \fI\,$rulesdir/saltlint/rules\/\fP in addition to any
+extra rules directories specified with \fB\-r\fR. There is no need to
+specify this if no \fB\-r\fR flags are used.
+.TP
+\fB\-t\fR TAGS
+only check rules whose id/tags match these values
+.TP
+\fB\-T\fR
+list all the tags
+.TP
+\fB\-v\fR
+Increase verbosity level
+.TP
+\fB\-x\fR SKIP_LIST
+only check rules whose id/tags do not match these
+values
+.TP
+\fB\-\-nocolor\fR, \fB\-\-nocolour\fR
+disable colored output
+.TP
+\fB\-\-force\-color\fR, \fB\-\-force\-colour\fR
+Try force colored output (relying on salt's code)
+.TP
+\fB\-\-exclude\fR EXCLUDE_PATHS
+path to directories or files to skip. This option is
+repeatable.
+.TP
+\fB\-\-json\fR
+parse the output as JSON
+.TP
+\fB\-\-severity\fR
+add the severity to the standard output
+.TP
+\fB\-c\fR C
+Specify configuration file to use. Defaults to ".saltlint"
+.SH FILES
+$PWD/.saltlint -- Salt-lint checks the working directory for the presence of
+this file and applies any configuration found there. The configuration file
+location can also be overridden via the -c path/to/file CLI flag.
+
+If a value is provided on both the command line and via a configuration file,
+the values will be merged (if a list like exclude_paths), or the True value
+will be preferred, in the case of something like quiet.
+.SH AUTHOR
+Warpnet B.V. <info@warpnet.nl>
+.SH "REPORTING BUGS"
+Report bugs to https://github.com/warpnet/salt-lint/issues.
+.SH COPYRIGHT
+Copyright (c) 2020, 2021 Warpnet B.V.
+.br
+Copyright (c) 2013-2018 Will Thames <will@thames.id.au>
+.br
+Copyright (c) 2018 Ansible by Red Hat
+.br
+
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.