suse-binarieschecks.diff
[platform/upstream/rpmlint.git] / README
1 rpmlint is a tool for checking common errors in rpm packages.  rpmlint
2 can be used to test individual packages before uploading or to check
3 an entire distribution.  By default all applicable checks are
4 performed but specific checks can be performed by using command line
5 parameters.
6
7 rpmlint can check binary rpms (files and installed ones), source rpms,
8 and plain specfiles, but all checks do not apply to all argument
9 types.  For best check coverage, run rpmlint on source rpms instead of
10 plain specfiles, and installed binary rpms instead of uninstalled
11 binary rpm files.
12
13 The idea for rpmlint is from the lintian tool of the Debian project.
14
15 Comments and new checks welcome. See the project home page at
16 http://rpmlint.zarb.org/ for mailing list information, bug tracking
17 system and other project resources.
18
19 Implemented checks:
20
21         o Tag checks (TagsCheck).
22         o Distribution specific checks (MandrakeCheck).
23         o Binary checks (BinaryCheck).
24         o Configuration file checks (ConfigCheck).
25         o Location, permission, group and owner checks (FileCheck).
26         o suid warnings (FileCheck).
27         o Signature checks (SignatureCheck).
28         o FHS checks (FHSCheck).
29         o Source specific checks (SourceCheck).
30         o i18n checks (I18NCheck).
31         o Menu system checks (MenuCheck).
32         o %post; %pre, %postun and %preun script checks (PostCheck).
33         o /etc/rc.d/init.d checks (InitScriptCheck).
34         o Spec file checks (SpecCheck).
35         o Zip/Jar file checks (ZipCheck).
36         o Pam configuration file checks (PamCheck).
37         o Rpm file checks (RpmFileCheck).
38
39 If you want to change configuration options or the list of checks, use
40 the global configuration files /etc/rpmlint/*config or the user
41 configuration file $XDG_CONFIG_HOME/rpmlint (~/.config/rpmlint if
42 $XDG_CONFIG_HOME is empty or not set).
43
44 Configuration files are Python source files and should begin with the
45 following line:
46
47 from Config import *
48
49 to load configuration functions.
50
51 Configuration functions:
52
53 resetChecks() resets the list of checks.
54
55 addCheck(check) adds the check to the list of checks to try.
56
57 addCheckDir(path) adds a path to look for checks.
58
59 setOption(name, value) sets the value of the configuration option.
60 See below for the list of available options.
61
62 addFilter(regexp) adds a filter to remove the output of a check, and
63 removeFilter(regexp) removes one (for use eg. in per-user configuration
64 files to remove filters added in system config files).
65
66 See the file "config" shipped with rpmlint for examples, available
67 options and their default values.