.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "deb-triggers 5"
.TH deb-triggers 5 2024-08-01 1.22.11 "dpkg suite"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
deb\-triggers \- package triggers
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBdebian/triggers\fR, \fBdebian/\fR\fIbinary-package\fR\fB.triggers\fR, 
\&\fBDEBIAN/triggers\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A package declares its relationship to some trigger(s) by including
a \fItriggers\fR file in its control archive (i.e. \fIDEBIAN/triggers\fR
during package creation).
.PP
This file contains directives, one per line.
Leading and trailing whitespace
and everything after the first \fB#\fR on any line will be trimmed, and
empty lines will be ignored.
.PP
The trigger control directives currently supported are:
.IP "\fBinterest\fR \fItrigger-name\fR" 4
.IX Item "interest trigger-name"
.PD 0
.IP "\fBinterest-await\fR \fItrigger-name\fR" 4
.IX Item "interest-await trigger-name"
.IP "\fBinterest-noawait\fR \fItrigger-name\fR" 4
.IX Item "interest-noawait trigger-name"
.PD
Specifies that the package is interested in the named trigger.
All
triggers in which a package is interested must be listed using this
directive in the triggers control file.
.Sp
The \(lqawait\(rq variants put the triggering package in triggers-awaited
state depending on how the trigger was activated.
The \(lqnoawait\(rq variant does not put the triggering packages in
triggers-awaited state, even if the triggering package declared an
\(lqawait\(rq activation (either with an \fBactivate-await\fR or \fBactivate\fR
directive, or by using the \fBdpkg-trigger\fR \fB\-\-no\-await\fR
command-line option).
The \(lqnoawait\(rq variant should be used when the functionality provided
by the trigger is not crucial.
.IP "\fBactivate\fR \fItrigger-name\fR" 4
.IX Item "activate trigger-name"
.PD 0
.IP "\fBactivate-await\fR \fItrigger-name\fR" 4
.IX Item "activate-await trigger-name"
.IP "\fBactivate-noawait\fR \fItrigger-name\fR" 4
.IX Item "activate-noawait trigger-name"
.PD
Arranges that changes to this package's state will activate the
specified trigger.
The trigger will be activated at the start of
the following operations: unpack, configure, remove (including for
the benefit of a conflicting package), purge and deconfigure.
.Sp
The \(lqawait\(rq variants only put the triggering package in triggers-awaited
state if the interest directive is also \(lqawait\(rq.
The \(lqnoawait\(rq variant never puts the triggering packages in
triggers-awaited state.
The \(lqnoawait\(rq variant should be used when the functionality provided
by the trigger is not crucial.
.Sp
If this package disappears during the unpacking of another package
the trigger will be activated when the disappearance is noted
towards the end of the unpack.
Trigger processing, and transition
from triggers-awaited to installed, does not cause activations.
In the case of unpack, triggers mentioned in both the old and new
versions of the package will be activated.
.PP
Unknown directives are an error which will prevent installation of the
package.
.PP
The \(lq\-noawait\(rq variants should always be favored when possible since
triggering packages are not put in triggers-awaited state and can thus
be immediately configured without requiring the processing of the trigger.
If the triggering packages are dependencies of other upgraded packages,
it will avoid an early trigger processing run and make it possible
to run the trigger only once as one of the last steps of the upgrade.
.PP
The \(lq\-noawait\(rq variants are supported since dpkg 1.16.1, and
will lead to errors if used with an older dpkg.
.PP
The \(lq\-await\(rq alias variants are supported since dpkg 1.17.21, and
will lead to errors if used with an older dpkg.
.PP
When a package provides an \fBinterest-noawait\fR directive, any activation
will set the triggering package into \(lqnoawait\(rq mode, regardless of the
awaiting mode requested by the activation (either \(lqawait\(rq or \(lqnoawait\(rq).
When a package provides an \fBinterest\fR or \fBinterest-await\fR directive,
any activation will set the triggering package into \(lqawait\(rq or \(lqnoawait\(lq
depending on how it was activated.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdpkg\-trigger\fR\|(1),
\&\fBdpkg\fR\|(1),
\&\fB/usr/share/doc/dpkg/spec/triggers.txt\fR.