File: adequate.podt

package info (click to toggle)
adequate 0.12.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 332 kB
  • ctags: 55
  • sloc: perl: 1,114; python: 350; makefile: 139; sh: 89; ansic: 21
file content (132 lines) | stat: -rw-r--r-- 2,566 bytes parent folder | download | duplicates (2)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
=encoding UTF-8

=head1 NAME

adequate - Debian package quality testing tool

=head1 SYNOPSIS

=over 1

=item B<adequate> [I<options>] I<package-name>...

=item B<adequate> [I<options>] --all

=item B<adequate> [I<options>] --apt-preinst

=item B<adequate> [I<options>] --pending

=item B<adequate> --help

=back

=head1 DESCRIPTION

B<adequate> checks packages installed on the system and reports bugs and policy
violations.

=head1 OPTIONS

=over 4

=item B<--all>

Run checks against all the installed packages.

=item B<--tags> I<tag1>[,I<tag2>...]

Emit only these tags.

=item B<--tags> -I<tag1>[,I<tag2>...]

Don't emit these tags.

=item B<--debconf>

Report issues via L<debconf(7)>.

=item B<--root> I<directory>

Change the root directory (using L<chroot(2)>).

=item B<--user> I<user>[:I<group>]

Switch user and group before running any checks.
This is most useful together with B<--root> or B<--pending>, which require
superuser privileges.

=item B<--apt-preinst>

Read APT configuration and F<.deb> filenames from stdin, and append packages
names to F</var/lib/adequate/pending> for later processing (see B<--pending>).

This option is used internally by the APT hook.
The hook is disabled by default; please edit F</etc/apt/apt.conf.d/20adequate> to enable it.

=item B<--pending>

Run checks against packages listed in F</var/lib/adequate/pending>,
then empty the file.

=item B<--help>

Display help and exit.

=back

=head1 TAGS

=head1 EXAMPLES

=over 4

=item B<C<adequate coreutils>>

Check the B<coreutils> package.

=item B<C<adequate --tags obsolete-conffile --all>>

Check all the packages for obsolete conffiles.

=item B<C<adequate --tags -py-file-not-bytecompiled,pyshared-file-not-bytecompiled --all>>

Check all the packages, ignoring Python bytecompilation issues.

=back

=head1 REPORTING BUGS

If you report a bug that was found by adequate, please use the following usertags:

=over 4

=item Z<>

=over

=item User: debian-qa@lists.debian.org

=item Usertags: adequate I<tag-name>

=back

=back

Please keep in mind that adequate is not perfect; therefore false positives are
possible. Don't report the bug unless you understand the underlying problem.
When in doubt, please ask at I<debian-qa@lists.debian.org> first.

=head1 SEE ALSO

Debian Policy:
F</usr/share/doc/debian-policy/policy.txt.gz>
or L<https://www.debian.org/doc/debian-policy/>

Python Policy:
F</usr/share/doc/python/python-policy.txt.gz>
or L<https://www.debian.org/doc/packaging-manuals/python-policy/>

L<lintian(1)>, L<piuparts(1)>

=for comment
vim:ft=pod