man/dpkg-trigger.pod

   1 # dpkg manual page - dpkg-trigger(1)
   2 #
   3 # Copyright © 2008-2015 Guillem Jover <guillem@debian.org>
   4 #
   5 # This is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17
  18 =encoding utf8
  19
  20 =head1 NAME
  21
  22 dpkg-trigger - a package trigger utility
  23
  24 =head1 SYNOPSIS
  25
  26 B<dpkg-trigger>
  27 [I<option>...] I<trigger-name>
  28
  29 B<dpkg-trigger>
  30 [I<option>...] I<command>
  31
  32 =head1 DESCRIPTION
  33
  34 B<dpkg-trigger> is a tool to explicitly activate triggers and check
  35 for its support on the running B<dpkg>.
  36
  37 This can be used by maintainer scripts in complex and conditional
  38 situations where the file triggers, or the declarative B<activate>
  39 triggers control file directive, are insufficiently rich.
  40 It can also
  41 be used for testing and by system administrators (but note that the
  42 triggers won't actually be run by B<dpkg-trigger>).
  43
  44 Unrecognized trigger name syntaxes are an error for B<dpkg-trigger>.
  45
  46 This program was introduced in dpkg 1.14.17.
  47
  48 =head1 COMMANDS
  49
  50 =over
  51
  52 =item B<--check-supported>
  53
  54 Check if the running B<dpkg> supports triggers (usually called from a
  55 postinst).
  56 Will exit B<0> if a triggers-capable B<dpkg> has run,
  57 or B<1> with an error message to stderr if not.
  58 Normally, however,
  59 it is better just to activate the desired trigger with B<dpkg-trigger>.
  60
  61 =item B<-?>, B<--help>
  62
  63 Show the usage message and exit.
  64
  65 =item B<--version>
  66
  67 Show the version and exit.
  68
  69 =back
  70
  71 =head1 OPTIONS
  72
  73 =over
  74
  75 =item B<--admindir=>I<dir>
  76
  77 Change the location of the B<dpkg> database.
  78 Defaults to I<%ADMINDIR%> if B<DPKG_ADMINDIR> has not been set.
  79
  80 =item B<--root=>I<directory>
  81
  82 Set the root directory to I<directory>, which sets the administrative
  83 directory to «I<directory>%ADMINDIR%» (since dpkg 1.21.0).
  84
  85 =item B<--by-package=>I<package>
  86
  87 Override trigger awaiter (normally set by B<dpkg> through the
  88 B<DPKG_MAINTSCRIPT_PACKAGE> environment variable of the maintainer scripts,
  89 naming the package to which the script belongs, and this will be used
  90 by default).
  91
  92 =item B<--no-await>
  93
  94 This option arranges that the calling package I<T> (if any) need not await
  95 the processing of this trigger; the interested package(s) I<I>, will not be
  96 added to I<T>'s trigger processing awaited list and I<T>'s status is unchanged.
  97 I<T> may be considered installed even though I<I> may not yet have
  98 processed the trigger.
  99
 100 =item B<--await>
 101
 102 This option does the inverse of B<--no-await> (since dpkg 1.17.21).
 103 If the interested package has declared a “noawait” directive, then this
 104 option will not be effective.
 105 It is currently the default behavior.
 106
 107 =item B<--no-act>
 108
 109 Just test, do not actually change anything.
 110
 111 =back
 112
 113 =head1 EXIT STATUS
 114
 115 =over
 116
 117 =item B<0>
 118
 119 The requested action was successfully performed.
 120 Or a check or assertion command returned true.
 121
 122 =item B<1>
 123
 124 A check or assertion command returned false.
 125
 126 =item B<2>
 127
 128 Fatal or unrecoverable error due to invalid command-line usage, or
 129 interactions with the system, such as accesses to the database,
 130 memory allocations, etc.
 131
 132 =back
 133
 134 =head1 ENVIRONMENT
 135
 136 =over
 137
 138 =item B<DPKG_ROOT>
 139
 140 If set and the B<--root> option has not been specified, it will be used as
 141 the filesystem root directory (since dpkg 1.21.0).
 142
 143 =item B<DPKG_ADMINDIR>
 144
 145 If set and the B<--admindir> option has not been specified, it will
 146 be used as the B<dpkg> data directory.
 147
 148 =item B<DPKG_DEBUG>
 149
 150 Sets the debug mask (since dpkg 1.21.10) from an octal value.
 151 The currently accepted flags are described in the B<dpkg --debug> option,
 152 but not all these flags might have an effect on this program.
 153
 154 =item B<DPKG_COLORS>
 155
 156 Sets the color mode (since dpkg 1.18.5).
 157 The currently accepted values are: B<auto> (default), B<always> and
 158 B<never>.
 159
 160 =item B<DPKG_NLS>
 161
 162 If set, it will be used to decide whether to activate Native Language Support,
 163 also known as internationalization (or i18n) support (since dpkg 1.22.7).
 164 The accepted values are: B<0> and B<1> (default).
 165
 166 =back
 167
 168 =head1 SEE ALSO
 169
 170 L<dpkg(1)>,
 171 L<deb-triggers(5)>,
 172 B<%PKGDOCDIR%/spec/triggers.txt>.