summaryrefslogtreecommitdiffstats
path: root/scripts/pts-subscribe.1
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/pts-subscribe.1')
-rw-r--r--scripts/pts-subscribe.159
1 files changed, 59 insertions, 0 deletions
diff --git a/scripts/pts-subscribe.1 b/scripts/pts-subscribe.1
new file mode 100644
index 0000000..bb1d459
--- /dev/null
+++ b/scripts/pts-subscribe.1
@@ -0,0 +1,59 @@
+.TH PTS-SUBSCRIBE 1 "Debian Utilities" "DEBIAN" \" -*- nroff -*-
+.SH NAME
+pts-subscribe \- time-limited subscription to the PTS
+.SH SYNOPSIS
+\fBpts-subscribe\fR [\fIoptions\fR] \fIpackage\fR
+.PP
+\fBpts-unsubscribe\fR [\fIoptions\fR] \fIpackage\fR
+.SH DESCRIPTION
+\fBpts-subscribe\fR sends a subscription request for \fIpackage\fR to
+the Package Tracking System at pts@qa.debian.org, and cancels the
+subscription 30 days later.
+.PP
+If called as \fBpts-unsubscribe\fR, send an unsubscription request
+for \fIpackage\fR to the Package Tracking System.
+.PP
+This utility is useful if a developer has made an NMU and wants to
+track the package for a limited period of time.
+.SH OPTIONS
+.TP
+\fB\-\-until \fItime\fR, \fB\-u\fR \fItime\fR
+When \fBat\fR(1) should cancel the subscription. \fItime\fR must be
+specified using \fBat\fR's syntax. Default is 'now + 30 days'. This
+option will probably require quoting!
+.TP
+.B \-\-forever
+Don't cancel the subscription automatically. This can also be
+specified as \fB\-\-until forever\fR.
+.TP
+.BR \-\-help ", " \-h
+Display a help message and exit successfully.
+.TP
+.B \-\-version
+Display version and copyright information and exit successfully.
+.SH "ENVIRONMENT VARIABLES"
+.TP
+.BR DEBEMAIL ", " EMAIL
+If one of these is set (with preference give to \fBDEBEMAIL\fR), then this
+will be used for the subscription address. If neither is set, then
+the email will be sent without a specified subscription address, and
+the email's From: line will be used to determine the sender's
+address. This will be determined by \fBmail\fR(1).
+.SH "CONFIGURATION VARIABLES"
+The two configuration files \fI/etc/devscripts.conf\fR and
+\fI~/.devscripts\fR are sourced in that order to set configuration
+variables. Command line options can be used to override configuration
+file settings. Environment variable settings are ignored for this
+purpose. The currently recognised variables are:
+.TP
+.B PTS_UNTIL
+Setting this is equivalent to giving a \fB\-\-until\fR option.
+.SH "SEE ALSO"
+.BR at (1),
+information about the Package Tracking System in the Developer's
+Reference at
+https://www.debian.org/doc/developers-reference/resources.html#pkg-tracking-system
+.SH AUTHOR
+This program was written by Julian Gilbey <jdg@debian.org> based on a
+public domain prototype by Raphael Hertzog <hertzog@debian.org> and is
+copyright under the GPL, version 2 or later.