summaryrefslogtreecommitdiffstats
path: root/scripts/deb-janitor.1
blob: 223a2063611ae3a1b3dfc94da03b1415dfd1e284 (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
.\" Copyright (c) 2020 Jelmer Vernooij <jelmer@debian.org>
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 3
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" See file /usr/share/common-licenses/GPL-3 for more details.
.\"
.TH "DEB\-JANITOR" 1 "Debian Utilities" "DEBIAN"

.SH NAME
deb-janitor \- interact with the Debian Janitor service

.SH SYNOPSIS
.TP
.B deb-janitor status CAMPAIGN SOURCE?
.TP
.B deb-janitor diff CAMPAIGN SOURCE?
.TP
.B deb-janitor schedule CAMPAIGN SOURCE?
.TP
.B deb-janitor merge [--force] CAMPAIGN
.TP
.B deb-janitor review CAMPAIGN [--source SOURCE] rejected|approved|reschedule COMMENT?

.SH DESCRIPTION
.B deb-janitor
is a command-line client for the Debian Janitor service, interacting
with the API. It currently allows retrieving the diff for
specific packages or scheduling new runs.
.PP
\fBCAMPAIGN\fR is the name of one of the campaigns supported by the janitor. Common values
include \fIlintian-fixes\fR and \fImultiarch-fixes\fR. See the homepage for a
full list.
.PP
\fBSOURCE\fR is the name of a source package. If no source package name is specified,
the source name is retrieved from debian/changelog in the current directory.

.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Output more information
.TP
\fB\-\-api-url\fR
Override the API endpoint to communicate with, rather than using the
main Debian Janitor instance. E.g. --api-url=https://janitor.kali.org/api/.

.SH EXAMPLES
.EX
# Schedule a new run fixing lintian issues in the "dulwich" package:
$ deb-janitor schedule dulwich lintian-fixes
Scheduled. Estimated duration: 236.32s, queue position: 1 (wait time: 0.00)

# Retrieve the diff for fontmake
$ deb-janitor diff fontmake lintian-fixes
=== added file 'debian/upstream/metadata'
--- a/debian/upstream/metadata	1970-01-01 00:00:00 +0000
+++ b/debian/upstream/metadata	2020-11-28 11:58:34 +0000
@@ -0,0 +1,5 @@
+---
+Bug-Database: https://github.com/googlei18n/fontmake/issues
+Bug-Submit: https://github.com/googlei18n/fontmake/issues/new
+Repository: https://github.com/googlei18n/fontmake.git
+Repository-Browse: https://github.com/googlei18n/fontmake

# Leave a review for a package
$ deb-janitor review fontmake lintian-fixes rejected "Some fonts are no longer installed"

# Merge lintian-fixes for a package
$ debcheckout a56
$ cd a56
$ deb-janitor merge lintian-fixes
Adding debian-janitor remote


.EE

.SH AUTHORS
\fBdeb-janitor\fR and this manual page were written by Jelmer Vernooij
<jelmer@debian.org>
.PP
Both are released under the GNU General Public License, version 3 or later.

.SH SEE ALSO
.BR lintian-brush (1)