chiark / gitweb /
devscripts (2.10.69+squeeze4) stable-security; urgency=high
[devscripts.git] / scripts / rc-alert.1
1 .TH RC-ALERT 1 "Debian Utilities" "DEBIAN" \" -*- nroff -*-
2 .SH NAME
3 rc-alert \- check for installed packages with release-critical bugs
4 .SH SYNOPSIS
5 \fBrc\-alert [inclusion options] [\-\-debtags [tag[,tag ...]] [\-\-popcon] [package ...]\fR
6 .br
7 \fBrc\-alert \-\-help|\-\-version\fR
8 .SH DESCRIPTION
9 \fBrc\-alert\fR downloads the list of release-critical bugs from the
10 Debian BTS webpages, and then outputs a list of packages installed on
11 the system, or given on the command-line, which are in that list.
12 .P
13 If the directory \fI~/.devscripts_cache\fP exists or the
14 \fB\-\-cache\fP option is given, then the (sizable) downloaded list
15 will be cached, and will only be downloaded again on a second
16 invocation if it has changed.
17 .SH OPTIONS
18 .TP
19 .BR \-\-cache
20 Force the creation of the \fI~/.devscripts_cache\fP cache directory.
21 .TP
22 .BR \-\-help ", " \-h
23 Show a summary of options.
24 .TP
25 .BR \-\-version ", " \-v
26 Show version and copyright information.
27 .P
28 It is also possible to filter the list of bugs reported based on the
29 tags and distributions associated with the package. The filtering options
30 are:
31 .TP
32 .BR \-\-include\-tags ", " \-f
33 A list of tags which the bug must have, in the format used for output.
34 For example, to include bugs tagged security or help wanted, use "SH".
35 .TP
36 .BR \-\-include\-tag\-op ", " \-t
37 If set to \fIand\fP, a bug must have all of the tags specified by
38 \fB\-\-include\-tags\fP.
39 .TP
40 .BR \-\-exclude\-tags
41 A list of tags which the bug must not have, in the same format as
42 \fB\-\-include\-tags\fP.
43 .TP
44 .BR \-\-exclude\-tag\-op
45 If set to \fIand\fP, a bug must have none of the tags specified by
46 \fB\-\-exclude\-tags\fP.  By default, the bug will be excluded if any tag
47 matches.
48 .TP
49 .BR \-\-include\-dists ", " \-d
50 A list of distributions which the bug must apply to, in the format used for
51 output.  For example, to include bugs affecting testing or unstable, use "TU".
52 .TP
53 .BR \-\-include\-dist\-op ", " \-o
54 If set to \fIand\fP, a bug must apply to all of the specified distributions in
55 order to be included.
56 .TP
57 .BR \-\-exclude\-dists
58 A list of distributions to which the bug must not apply, in the same format as
59 \fB\-\-include\-dists\fP.
60 .TP
61 .BR \-\-exclude\-dist\-op
62 If set to \fIand\fP, a bug must apply to all of the specified distributions
63 in order to be excluded.  By default the bug will be excluded if it applies
64 to any of the listed distributions.
65 .P
66 It is also possible to only list bugs which have specific debtags set. Note
67 that you need to have debtags installed and also that it's not mandatory for
68 maintainers to set proper debtags. The produced list will thus probably be
69 incomplete.
70 .TP
71 .BR \-\-debtags
72 Match packages based on the listed tags. Each package is matched only if it has
73 all the listed tags; in the case of multiple tags within the same facet, a
74 package is matched if it has any of the listed tags within the facet.
75 .TP
76 .BR \-\-debtags\-database
77 Use a non-standard debtags database.  The default is
78 \fI/var/lib/debtags/packages-tags\fP.
79 .P
80 Popularity-contest collects data about installation and usage of Debian
81 packages. You can additionally sort the bugs by the popcon rank of the related
82 packages.
83 .TP
84 .BR \-\-popcon
85 Sort bugs by the popcon rank of the package the bug belongs to.
86 .TP
87 .BR \-\-pc\-vote
88 By default, packages are sorted according to the number of people who have the
89 package installed. This option enables sorting by the number of people
90 regularly using the package instead. This option has no effect in combination
91 with \-\-pc\-local.
92 .TP
93 .BR \-\-pc\-local
94 Instead of requesting remote data the information from the last popcon run is
95 used (\fI/var/log/popularity-contest\fP).
96 .SH EXAMPLES
97 .TP
98 .BR \-\-include\-dists " OS"
99 The bug must apply to at least one of oldstable or stable
100 .TP
101 .BR \-\-include\-dists " TU" " \-\-include\-dist\-op" " and"
102 The bug must apply to both testing and unstable
103 .TP
104 .BR \-\-include\-dists " O" " \-\-include\-tags" " S" " \-\-exclude\-tags" " +"
105 The bug must apply to oldstable and be tagged security but not patch
106 .TP
107 .BR \-\-exclude\-dists " SOT" " \-\-include\-tags" " R"
108 The bug must apply to only unstable or experimental (or both) and be tagged
109 unreproducible
110 .TP
111 .BR \-\-debtags " implemented-in::perl,role::plugin,implemented-in::python"
112 The bug must apply to packages matching the specified debtags, i.e. the match
113 will only include packages that have the 'role::plugin' tag and that have
114 either of the tags 'implemented-in::perl' or 'implemented-in::python'.
115 .TP
116 .BR \-\-popcon " "\-\-pc\-local
117 Read \fI/var/log/popularity-contest\fP and sort bugs by your personal popcon ranking
118 (which is basically the atime of your packages' binaries).
119 .SH BUGS
120 It is not possible to say "does not apply only to unstable"
121 .SH SEE ALSO
122 .BR debtags(1)
123 .BR popbugs(1)
124 .BR popularity-contest(8)
125 .SH AUTHOR
126 \fBrc-alert\fR was written by Anthony DeRobertis and modified by
127 Julian Gilbey <jdg@debian.org> and Adam D. Barratt <adam@adam-barratt.org.uk>
128 for the devscripts package. Debtags and popcon functionality was added by Jan
129 Hauke Rahm <info@jhr-online.de>.