doc/pacman.conf.5.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
   3 /////
   4 pacman.conf(5)
   5 ==============
   6
   7 Name
   8 ----
   9 pacman.conf - pacman package manager configuration file
  10
  11
  12 Synopsis
  13 --------
  14 {sysconfdir}/pacman.conf
  15
  16
  17 Description
  18 -----------
  19 Pacman, using linkman:libalpm[3], will attempt to read pacman.conf each time it
  20 is invoked. This configuration file is divided into sections or repositories.
  21 Each section defines a package repository that pacman can use when searching
  22 for packages in '\--sync' mode. The exception to this is the options section,
  23 which defines global options.
  24
  25
  26 Example
  27 -------
  28
  29 --------
  30 #
  31 # pacman.conf
  32 #
  33 [options]
  34 NoUpgrade = etc/passwd etc/group etc/shadow
  35 NoUpgrade = etc/fstab
  36
  37 [core]
  38 Include = /etc/pacman.d/core
  39
  40 [custom]
  41 Server = file:///home/pkgs
  42 --------
  43
  44 NOTE: Each directive must be in CamelCase. If the case isn't respected, the
  45 directive won't be recognized. For example. noupgrade or NOUPGRADE will not
  46 work.
  47
  48 Options
  49 -------
  50 *RootDir =* path/to/root::
  51         Set the default root directory for pacman to install to. This option is
  52         used if you want to install a package on a temporary mounted partition
  53         which is "owned" by another system, or for a chroot install.
  54         *NOTE*: If database path or logfile are not specified on either the
  55         command line or in linkman:pacman.conf[5], their default location will
  56         be inside this root path.
  57
  58 *DBPath =* path/to/db/dir::
  59         Overrides the default location of the toplevel database directory.  A
  60         typical default is +{localstatedir}/lib/pacman/+. Most users will not need to set
  61         this option. *NOTE*: if specified, this is an absolute path and the root
  62         path is not automatically prepended.
  63
  64 *CacheDir =* path/to/cache/dir::
  65         Overrides the default location of the package cache directory. A typical
  66         default is +{localstatedir}/cache/pacman/pkg/+. Multiple cache directories can be
  67         specified, and they are tried in the order they are listed in the config
  68         file. If a file is not found in any cache directory, it will be downloaded
  69         to the first cache directory with write access. *NOTE*: this is an absolute
  70         path, the root path is not automatically prepended.
  71
  72 *GPGDir =* path/to/gpg/dir::
  73         Overrides the default location of the directory containing configuration
  74         files for GnuPG. A typical default is +{sysconfdir}/pacman.d/gnupg/+.
  75         This directory should contain two files: `pubring.gpg` and `trustdb.gpg`.
  76         `pubring.gpg` holds the public keys of all packagers. `trustdb.gpg`
  77         contains a so-called trust database, which specifies that the keys are
  78         authentic and trusted.
  79         *NOTE*: this is an absolute path, the root path is not automatically
  80         prepended.
  81
  82 *LogFile =* '/path/to/file'::
  83         Overrides the default location of the pacman log file. A typical default
  84         is +{localstatedir}/log/pacman.log+. This is an absolute path and the root directory
  85         is not prepended.
  86
  87 *HoldPkg =* package ...::
  88         If a user tries to '\--remove' a package that's listed in `HoldPkg`,
  89         pacman will ask for confirmation before proceeding. Shell-style glob
  90         patterns are allowed.
  91
  92 *IgnorePkg =* package ...::
  93         Instructs pacman to ignore any upgrades for this package when performing
  94         a '\--sysupgrade'. Shell-style glob patterns are allowed.
  95
  96 *SyncFirst =* package ...::
  97         Instructs pacman to check for newer version of these packages before any
  98         sync operation. The user will have the choice to either cancel the current
  99         operation and upgrade these packages first or go on with the current
 100         operation. This option is typically used with the 'pacman' package.
 101         *NOTE*: when a `SyncFirst` transaction takes place, no command line flags
 102         (e.g. '\--force') are honored. If this is not ideal, disabling `SyncFirst`
 103         and performing a manual sync of the involved packages may be required.
 104
 105 *IgnoreGroup =* group ...::
 106         Instructs pacman to ignore any upgrades for all packages in this
 107         group when performing a '\--sysupgrade'. Shell-style glob patterns are
 108         allowed.
 109
 110 *Include =* path::
 111         Include another config file. This file can include repositories or
 112         general configuration options. Wildcards in the specified paths will get
 113         expanded based on linkman:glob[7] rules.
 114
 115 *Architecture =* auto | i686 | x86_64 | ...::
 116         If set, pacman will only allow installation of packages of the given
 117         architecture (e.g. 'i686', 'x86_64', etc). The special value 'auto' will
 118         use the system architecture, provided by in ``uname -m''.  If unset, no
 119         architecture checks are made. *NOTE*: packages with the special
 120         architecture 'any' can always be installed, as they are meant to be
 121         architecture independent.
 122
 123 *XferCommand =* /path/to/command %u::
 124         If set, an external program will be used to download all remote files.
 125         All instances of `%u` will be replaced with the download URL. If present,
 126         instances of `%o` will be replaced with the local filename, plus a
 127         ``.part'' extension, which allows programs like wget to do file resumes
 128         properly.
 129         +
 130         This option is useful for users who experience problems with built-in
 131         http/ftp support, or need the more advanced proxy support that comes with
 132         utilities like wget.
 133
 134 *NoUpgrade =* file ...::
 135         All files listed with a `NoUpgrade` directive will never be touched during
 136         a package install/upgrade, and the new files will be installed with a
 137         '.pacnew' extension.
 138         These files refer to files in the package archive, so do not include the
 139         leading slash (the RootDir) when specifying them. Shell-style glob patterns
 140         are allowed.
 141
 142 *NoExtract =* file ...::
 143         All files listed with a `NoExtract` directive will never be extracted from
 144         a package into the filesystem. This can be useful when you don't want part
 145         of a package to be installed. For example, if your httpd root uses an
 146         'index.php', then you would not want the 'index.html' file to be extracted
 147         from the 'apache' package.
 148         These files refer to files in the package archive, so do not include the
 149         leading slash (the RootDir) when specifying them. Shell-style glob patterns
 150         are allowed.
 151
 152 *CleanMethod =* KeepInstalled &| KeepCurrent::
 153         If set to `KeepInstalled` (the default), the '-Sc' operation will clean
 154         packages that are no longer installed (not present in the local database).
 155         If set to `KeepCurrent`, '-Sc' will clean outdated packages (not present in
 156         any sync database).
 157         The second behavior is useful when the package cache is shared among
 158         multiple machines, where the local databases are usually different, but the
 159         sync databases in use could be the same. If both values are specified,
 160         packages are only cleaned if not installed locally and not present in any
 161         known sync database.
 162
 163 *SigLevel =* ...::
 164         Set the default signature verification level. For more information, see
 165         <<SC,Package and Database Signature Checking>> below.
 166
 167 *UseSyslog*::
 168         Log action messages through syslog(). This will insert log entries into
 169         +{localstatedir}/log/messages+ or equivalent.
 170
 171 *UseDelta* [= ratio]::
 172         Download delta files instead of complete packages if possible. Requires
 173         the `xdelta3` program to be installed. If a ratio is specified (e.g.,
 174         `0.5`), then it is used as a cutoff for determining whether to use deltas.
 175         Allowed values are between `0.0` and `2.0`; sensible values are between
 176         `0.2` and `0.9`.  Using a value above `1.0` is not recommended.  The
 177         default is `0.7` if left unspecified.
 178
 179 *TotalDownload*::
 180         When downloading, display the amount downloaded, download rate, ETA,
 181         and completed percentage of the entire download list rather
 182         than the percent of each individual download target. The progress
 183         bar is still based solely on the current file download.
 184
 185 *CheckSpace*::
 186         Performs an approximate check for adequate available disk space before
 187         installing packages.
 188
 189 *VerbosePkgLists*::
 190         Displays name, version and size of target packages formatted
 191         as a table for upgrade, sync and remove operations.
 192
 193 Repository Sections
 194 -------------------
 195 Each repository section defines a section name and at least one location where
 196 the packages can be found. The section name is defined by the string within
 197 square brackets (the two above are 'current'  and  'custom'). Locations are
 198 defined with the 'Server' directive and follow a URL naming structure. If you
 199 want to use a local directory, you can specify the full path with a ``file://''
 200 prefix, as shown above.
 201
 202 A common way to define DB locations utilizes the 'Include' directive. For each
 203 repository defined in the configuration file, a single 'Include' directive can
 204 contain a file that lists the servers for that repository.
 205
 206 --------
 207 [core]
 208 # use this server first
 209 Server = ftp://ftp.archlinux.org/$repo/os/$arch
 210 # next use servers as defined in the mirrorlist below
 211 Include = {sysconfdir}/pacman.d/mirrorlist
 212 --------
 213
 214 The order of repositories in the configuration files matters; repositories
 215 listed first will take precedence over those listed later in the file when
 216 packages in two repositories have identical names, regardless of version
 217 number.
 218
 219 *Include =* path::
 220         Include another config file. This file can include repositories or
 221         general configuration options. Wildcards in the specified paths will get
 222         expanded based on linkman:glob[7] rules.
 223
 224 *Server =* url::
 225         A full URL to a location where the database, packages, and signatures (if
 226         available) for this repository can be found.
 227 +
 228 During parsing, pacman will define the `$repo` variable to the name of the
 229 current section. This is often utilized in files specified using the 'Include'
 230 directive so all repositories can use the same mirrorfile. pacman also defines
 231 the `$arch` variable to the value of `Architecture`, so the same mirrorfile can
 232 even be used for different architectures.
 233
 234 *SigLevel =* ...::
 235         Set the signature verification level for this repository. For more
 236         information, see <<SC,Package and Database Signature Checking>> below.
 237
 238 Package and Database Signature Checking
 239 ---------------------------------------
 240 The 'SigLevel' directive is valid in both the `[options]` and repository
 241 sections. If used in `[options]`, it sets a default value for any repository
 242 that does not provide the setting.
 243
 244 * If set to *Never*, no signature checking will take place.
 245 * If set to *Optional* , signatures will be checked when present, but unsigned
 246   databases and packages will also be accepted.
 247 * If set to *Required*, signatures will be required on all packages and
 248   databases.
 249
 250 Alternatively, you can get more fine-grained control by combining some of
 251 the options and prefixes described below. All options in a config file are
 252 processed in top-to-bottom, left-to-right fashion, where later options override
 253 and/or supplement earlier ones. If 'SigLevel' is specified in a repository
 254 section, the starting value is that from the `[options]` section, or the
 255 built-in system default as shown below if not specified.
 256
 257 The options are split into two main groups, described below. Terms used such as
 258 ``marginally trusted'' are terms used by GnuPG, for more information please
 259 consult linkman:gpg[1].
 260
 261 When to Check::
 262         These options control if and when signature checks should take place.
 263
 264         *Never*;;
 265                 All signature checking is suppressed, even if signatures are present.
 266
 267         *Optional* (default);;
 268                 Signatures are checked if present; absence of a signature is not an
 269                 error. An invalid signature is a fatal error, as is a signature from a
 270                 key not in the keyring.
 271
 272         *Required*;;
 273                 Signatures are required; absence of a signature or an invalid signature
 274                 is a fatal error, as is a signature from a key not in the keyring.
 275
 276 What is Allowed::
 277         These options control what signatures are viewed as permissible. Note that
 278         neither of these options allows acceptance of invalid or expired
 279         signatures, or those from revoked keys.
 280
 281         *TrustedOnly* (default);;
 282                 If a signature is checked, it must be in the keyring and fully trusted;
 283                 marginal trust does not meet this criteria.
 284
 285         *TrustAll*;;
 286                 If a signature is checked, it must be in the keyring, but is not
 287                 required to be assigned a trust level (e.g., unknown or marginal
 288                 trust).
 289
 290 Options in both groups can additionally be prefixed with either *Package* or
 291 *Database*, which will cause it to only take effect on the specified object
 292 type. For example, `PackageTrustAll` would allow marginal and unknown trust
 293 level signatures for packages.
 294
 295 The built-in default is the following:
 296
 297 --------
 298 SigLevel = Optional TrustedOnly
 299 --------
 300
 301 Using Your Own Repository
 302 -------------------------
 303 If you have numerous custom packages of your own, it is often easier to generate
 304 your own custom local repository than install them all with the '\--upgrade'
 305 option. All you need to do is generate a compressed package database in the
 306 directory with these packages so pacman can find it when run with '\--refresh'.
 307
 308         repo-add /home/pkgs/custom.db.tar.gz /home/pkgs/*.pkg.tar.gz
 309
 310 The above command will generate a compressed database named
 311 '/home/pkgs/custom.db.tar.gz'. Note that the database must be of the form
 312 '\{treename\}.db.tar.{ext}', where '\{treename\}' is the name of the section
 313 defined in the configuration file and '\{ext\}' is a valid compression type as
 314 documented in linkman:repo-add[8]. That's it! Now configure your custom section
 315 in the configuration file as shown in the config example above. Pacman will now
 316 use your package repository. If you add new packages to the repository,
 317 remember to re-generate the database and use pacman's '\--refresh' option.
 318
 319 For more information on the repo-add command, see ``repo-add \--help'' or
 320 linkman:repo-add[8].
 321
 322
 323 See Also
 324 --------
 325 linkman:pacman[8], linkman:libalpm[3]
 326
 327 include::footer.txt[]