man/dpkg-statoverride.pod

   1 # dpkg manual page - dpkg-statoverride(1)
   2 #
   3 # Copyright © 2000-2001 Wichert Akkerman <wakkerma@debian.org>
   4 # Copyright © 2009-2011, 2013, 2015 Guillem Jover <guillem@debian.org>
   5 #
   6 # This is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  18
  19 =encoding utf8
  20
  21 =head1 NAME
  22
  23 dpkg-statoverride - override ownership and mode of files
  24
  25 =head1 SYNOPSIS
  26
  27 B<dpkg-statoverride>
  28 [I<option>...] I<command>
  29
  30 =head1 DESCRIPTION
  31
  32 “B<stat overrides>” are a way to tell
  33 L<dpkg(1)>
  34 to use a different owner
  35 or mode for a path when a package is installed (this applies to any
  36 filesystem object that
  37 B<dpkg>
  38 handles, including directories, devices, etc.).
  39 This can be used to
  40 force programs that are normally setuid to be install without a setuid
  41 flag, or only executable by a certain group.
  42
  43 B<dpkg-statoverride> is a utility to manage the list of stat
  44 overrides.
  45 It has three basic functions: adding, removing and listing
  46 overrides.
  47
  48 =head1 COMMANDS
  49
  50 =over
  51
  52 =item B<--add> I<user group mode path>
  53
  54 Add an override for I<path>.
  55 I<path> does not need to exist nor be known to
  56 B<dpkg> when this command is used; the override will be stored and used later.
  57 Users and groups can be specified by their name (for example B<root>
  58 or B<nobody>), or by their number by prepending the number with a
  59 ‘B<#>’ (for example B<#0> or B<#65534>).
  60 The I<mode> needs to be specified in octal.
  61
  62 If B<--update> is specified and I<path> exists, it is immediately
  63 set to the new owner and mode.
  64
  65 =item B<--remove> I<path>
  66
  67 Remove an override for I<path>, the status of I<path> is left
  68 unchanged by this command.
  69
  70 =item B<--list> [I<glob-pattern>]
  71
  72 List all overrides.
  73 If a glob pattern is specified restrict the output
  74 to overrides which match the glob.
  75
  76 =item B<--help>
  77
  78 Show the usage message and exit.
  79
  80 =item B<--force-help>
  81
  82 Give help about the B<--force->I<thing> options (since dpkg 1.19.5).
  83
  84 =item B<--version>
  85
  86 Show the version and exit.
  87
  88 =back
  89
  90 =head1 OPTIONS
  91
  92 =over
  93
  94 =item B<--admindir> I<directory>
  95
  96 Set the administrative directory to I<directory>.
  97 This is where the I<statoverride> file is stored.
  98 Defaults to «I<%ADMINDIR%>» if B<DPKG_ADMINDIR> has not been set.
  99
 100 =item B<--instdir> I<directory>
 101
 102 Set the installation directory, which refers to the directory where
 103 packages get installed (since dpkg 1.19.2).
 104 Defaults to «I</>» if B<DPKG_ROOT> has not been set.
 105
 106 =item B<--root> I<directory>
 107
 108 Set the root directory to B<directory>, which sets the installation
 109 directory to «I<directory>» and the administrative
 110 directory to «I<directory>B<%ADMINDIR%>» (since dpkg 1.19.2)
 111 if B<DPKG_ROOT> has not been set.
 112
 113 =item B<--force->I<things>
 114
 115 =item B<--no-force->I<things>, B<--refuse->I<things>
 116
 117 Force or refuse (B<no-force> and B<refuse> mean the same thing)
 118 to do some things (since dpkg 1.19.5).
 119 I<things> is a comma separated list of things specified below.
 120 B<--force-help> displays a message describing them.
 121 Things marked with (*) are forced by default.
 122
 123 B<Warning>: These options are mostly intended to be used by experts only.
 124 Using them without fully understanding their effects may break your whole
 125 system.
 126
 127 =over 4
 128
 129 =item B<all>:
 130
 131 Turns on (or off) all force options.
 132
 133 =item B<statoverride-add>:
 134
 135 Overwrite an existing stat override when adding it (since dpkg 1.19.5).
 136
 137 =item B<statoverride-remove>:
 138
 139 Ignore a missing stat override when removing it (since dpkg 1.19.5).
 140
 141 =item B<security-mac>(*):
 142
 143 Use platform-specific Mandatory Access Controls (MAC) based security when
 144 installing files into the filesystem (since dpkg 1.19.5).
 145 On Linux systems the implementation uses SELinux.
 146
 147 =item B<not-root>:
 148
 149 Try to (de)install things even when not root (since dpkg 1.21.8).
 150
 151 =back
 152
 153 =item B<--force>
 154
 155 Force an action, even if a sanity check would otherwise prohibit it.
 156 This is necessary to override an existing override.
 157 This option is deprecated (since dpkg 1.19.5), it is replaced by
 158 B<--force-all>.
 159
 160 =item B<--update>
 161
 162 Immediately try to change the I<path> to the new owner and mode if it
 163 exists.
 164
 165 =item B<--quiet>
 166
 167 Be less verbose about what we do.
 168
 169 =back
 170
 171 =head1 EXIT STATUS
 172
 173 =over
 174
 175 =item B<0>
 176
 177 The requested action was successfully performed.
 178
 179 =item B<1>
 180
 181 For B<--list>, if there are no overrides or none match the supplied
 182 glob.
 183
 184 =item B<2>
 185
 186 Fatal or unrecoverable error due to invalid command-line usage, or
 187 interactions with the system, such as accesses to the database,
 188 memory allocations, etc.
 189
 190 =back
 191
 192 =head1 ENVIRONMENT
 193
 194 =over
 195
 196 =item B<DPKG_ROOT>
 197
 198 If set and the B<--instdir> or B<--root> options have not been
 199 specified, it will be used as the filesystem root directory
 200 (since dpkg 1.19.2).
 201
 202 =item B<DPKG_ADMINDIR>
 203
 204 If set and the B<--admindir> or B<--root> options have not been
 205 specified, it will be used as the B<dpkg> data directory.
 206
 207 =item B<DPKG_DEBUG>
 208
 209 Sets the debug mask (since dpkg 1.21.10) from an octal value.
 210 The currently accepted flags are described in the B<dpkg --debug> option,
 211 but not all these flags might have an effect on this program.
 212
 213 =item B<DPKG_FORCE>
 214
 215 If set and none of the B<--force->I<...> options have been
 216 specified, it will be used as the force options to use (since dpkg 1.19.5).
 217
 218 =item B<DPKG_COLORS>
 219
 220 Sets the color mode (since dpkg 1.18.5).
 221 The currently accepted values are: B<auto> (default), B<always> and
 222 B<never>.
 223
 224 =back
 225
 226 =head1 FILES
 227
 228 =over
 229
 230 =item I<%ADMINDIR%/statoverride>
 231
 232 File which contains the current list of stat overrides of the system.
 233 It
 234 is located in the B<dpkg> administration directory, along with other files
 235 important to B<dpkg>, such as I<status> or I<available>.
 236
 237 B<Note>: B<dpkg-statoverride> preserves the old copy of this file, with
 238 extension “-old”, before replacing it with the new one.
 239
 240 =back
 241
 242 =head1 SEE ALSO
 243
 244 L<dpkg(1)>.