summaryrefslogtreecommitdiff
path: root/rpmlint.1
blob: 7e7794ce05129eafbdb94058081b8102683003b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
.TH RPMLINT "1" "April 2011" "rpmlint" "User Commands"
.SH NAME
rpmlint \- check common problems in rpm packages
.SH SYNOPSIS
\fBrpmlint\fR [\fIOPTION\fR]... [\fIFILE\fR|\fIPACKAGE\fR]...
.SH DESCRIPTION
\fBrpmlint\fR is a tool for checking common errors in rpm packages.
It can be used to test individual packages and spec files before
uploading or to check an entire distribution.  By default all
applicable checks are processed but specific checks can be performed
by using command line parameters.

\fIFILE\fR can be a rpm package file, a spec file, or a directory.  In
case of a directory, it is recursively searched for rpm and spec files
to check.  The special value \fB\-\fR results in standard input being
read and treated as (single) spec file content.
\fIPACKAGE\fR is the name of an installed package or a
.BR glob (7)
pattern to match installed packages, unless a file by that name exists.
.TP
\fB\-i\fR, \fB\-\-info\fR
Display explanations for reported messages.
.TP
\fB-I\fR, \fB\-\-explain\fR=\fImessageid\fR
Display explanations for the specified message identifiers and exit.
This option may be given multiple times.
.TP
\fB\-c\fR, \fB\-\-check\fR=\fIcheck\fR
Run only the specified check.  This option may be given multiple times
to specify multiple checks to run.  \fIcheck\fR is the name of the Python
module (as it would be given to Python's import statement) containing the
check.
.TP
\fB\-a\fR, \fB\-\-all\fR
Check all installed packages.
.TP
\fB\-C\fR, \fB\-\-checkdir\fR=\fIdir\fR
Insert \fIdir\fR to the front of the list of paths to load checks
from, unless it is already in the list.  The default list of check
dirs typically contains only /usr/share/rpmlint.  Directories in the
check dirs list are also inserted to the front of the list of paths to
load Python modules from when the check process begins.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display summary of command line options and exit.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Operate in verbose mode.
.TP
\fB\-E\fR, \fB\-\-extractdir\fR=\fIdir\fR
Base directory for extracted temporary files, default is what Python's
tempfile.gettempdir() returns.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
.TP
\fB\-n\fR, \fB\-\-noexception\fR
Ignore output filters.
.TP
\fB\-\-rawout\fR=\fIfile\fR
Write unfiltered output to \fIfile\fR.
.TP
\fB\-f\fR, \fB\-\-file\fR=\fIconffile\fR
Load user configuration from the specified file, default is
$XDG_CONFIG_HOME/rpmlint (~/.config/rpmlint if $XDG_CONFIG_HOME is
empty or not set).
.TP
\fB\-o\fR, \fB\-\-option\fR=\fIvalue\fR
Override a configuration option.  \fIvalue\fR is a whitespace separated string,
first word of which is the option name to set, and the Python eval() return
value for the rest is set as the value for the option.  Passing only an option
name is treated as if None was passed as its value.  See the file "config"
shipped with rpmlint for the list of configuration options and their types.
For example:
 \-o "NetworkEnabled True"
 \-o "Distribution \(aqMy favorite distro\(aq"
 \-o "MaxLineLength 80"
 \-o "ValidShells (\(aq/bin/sh\(aq, \(aq/bin/bash\(aq)"
.SH CAVEATS
All checks do not apply to all argument types.  For best check
coverage, run rpmlint on all source and binary packages your build
produces.  The set of checks rpmlint runs on source packages is a
superset of the one for plain specfiles, the set of checks run for
installed binary packages is a superset of the one for uninstalled
binary package files, and the source and binary package check sets are
quite different.
.SH FILES
.TP
\fB/usr/share/rpmlint/config\fR, \fB/usr/share/rpmlint/config.*\fR
Built-in configuration.  When invoked as \fIsomeprefix\fR-rpmlint,
/usr/share/rpmlint/config.\fIsomeprefix\fR is used if it exists,
otherwise /usr/share/rpmlint/config.
.TP
\fB/etc/rpmlint/*config\fR
System wide configuration.
.TP
\fB$XDG_CONFIG_HOME/rpmlint\fR or \fB~/.config/rpmlint\fR
User configuration.
.SH EXIT CODES
.IP 0
No errors.
.IP 1
Unspecified error.
.IP 2
Interrupted.
.IP 64
One or more error message printed.
.IP 66
Badness threshold exceeded.
.SH AUTHOR
Originally written by Frédéric Lepied, see the file AUTHORS for (probably
incomplete) list of additional contributors.
.SH COPYRIGHT
This program is licensed under the GNU General Public License, see the
file COPYING included in the distribution archive.