doc/pacman.conf.5.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet:
   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.
  90
  91 *IgnorePkg =* package ...::
  92         Instructs pacman to ignore any upgrades for this package when performing
  93         a '\--sysupgrade'.
  94
  95 *SyncFirst =* package ...::
  96         Instructs pacman to check for newer version of these packages before any
  97         sync operation. The user will have the choice to either cancel the current
  98         operation and upgrade these packages first or go on with the current
  99         operation. This option is typically used with the 'pacman' package.
 100         *NOTE*: when a `SyncFirst` transaction takes place, no command line flags
 101         (e.g. '\--force') are honored. If this is not ideal, disabling `SyncFirst`
 102         and performing a manual sync of the involved packages may be required.
 103
 104 *IgnoreGroup =* group ...::
 105         Instructs pacman to ignore any upgrades for all packages in this
 106         group when performing a '\--sysupgrade'.
 107
 108 *Include =* path::
 109         Include another config file. This file can include repositories or
 110         general configuration options. Wildcards in the specified paths will get
 111         expanded based on linkman:glob[7] rules.
 112
 113 *Architecture =* auto | i686 | x86_64 | ...::
 114         If set, pacman will only allow installation of packages of the given
 115         architecture (e.g. 'i686', 'x86_64', etc). The special value 'auto' will
 116         use the system architecture, provided by in ``uname -m''.  If unset, no
 117         architecture checks are made. *NOTE*: packages with the special
 118         architecture 'any' can always be installed, as they are meant to be
 119         architecture independent.
 120
 121 *XferCommand =* /path/to/command %u::
 122         If set, an external program will be used to download all remote files.
 123         All instances of `%u` will be replaced with the download URL. If present,
 124         instances of `%o` will be replaced with the local filename, plus a
 125         ``.part'' extension, which allows programs like wget to do file resumes
 126         properly.
 127         +
 128         This option is useful for users who experience problems with built-in
 129         http/ftp support, or need the more advanced proxy support that comes with
 130         utilities like wget.
 131
 132 *NoUpgrade =* file ...::
 133         All files listed with a `NoUpgrade` directive will never be touched during
 134         a package install/upgrade, and the new files will be installed with a
 135         '.pacnew' extension.
 136         These files refer to files in the package archive, so do not include the
 137         leading slash (the RootDir) when specifying them.
 138
 139 *NoExtract =* file ...::
 140         All files listed with a `NoExtract` directive will never be extracted from
 141         a package into the filesystem. This can be useful when you don't want part
 142         of a package to be installed. For example, if your httpd root uses an
 143         'index.php', then you would not want the 'index.html' file to be extracted
 144         from the 'apache' package.
 145         These files refer to files in the package archive, so do not include the
 146         leading slash (the RootDir) when specifying them.
 147
 148 *CleanMethod =* KeepInstalled &| KeepCurrent::
 149         If set to `KeepInstalled` (the default), the '-Sc' operation will clean
 150         packages that are no longer installed (not present in the local database).
 151         If set to `KeepCurrent`, '-Sc' will clean outdated packages (not present in
 152         any sync database).
 153         The second behavior is useful when the package cache is shared among
 154         multiple machines, where the local databases are usually different, but the
 155         sync databases in use could be the same. If both values are specified,
 156         packages are only cleaned if not installed locally and not present in any
 157         known sync database.
 158
 159 *UseSyslog*::
 160         Log action messages through syslog(). This will insert log entries into
 161         +{localstatedir}/log/messages+ or equivalent.
 162
 163 *UseDelta*::
 164         Download delta files instead of complete packages if possible.  Requires
 165         the xdelta3 program to be installed.
 166
 167 *TotalDownload*::
 168         When downloading, display the amount downloaded, download rate, ETA,
 169         and completed percentage of the entire download list rather
 170         than the percent of each individual download target. The progress
 171         bar is still based solely on the current file download.
 172
 173 *CheckSpace*::
 174         Performs an approximate check for adequate available disk space before
 175         installing packages.
 176
 177 *VerbosePkgLists*::
 178         Displays name, version and size of target packages formatted
 179         as a table for upgrade, sync and remove operations.
 180
 181 Repository Sections
 182 -------------------
 183 Each repository section defines a section name and at least one location where
 184 the packages can be found. The section name is defined by the string within
 185 square brackets (the two above are 'current'  and  'custom'). Locations are
 186 defined with the 'Server' directive and follow a URL naming structure. If you
 187 want to use a local directory, you can specify the full path with a ``file://''
 188 prefix, as shown above.
 189
 190 A common way to define DB locations utilizes the 'Include' directive. For each
 191 repository defined in the configuration file, a single 'Include' directive can
 192 contain a file that lists the servers for that repository.
 193
 194 --------
 195 [core]
 196 # use this repository first
 197 Server = ftp://ftp.archlinux.org/core/os/arch
 198 # next use servers as defined in the mirrorlist below
 199 Include = {sysconfdir}/pacman.d/mirrorlist
 200 --------
 201
 202 During parsing, pacman will define the `$repo` variable to the name of the
 203 current section. This is often utilized in files specified using the 'Include'
 204 directive so all repositories can use the same mirrorfile. pacman also defines
 205 the `$arch` variable to the value of `Architecture`, so the same mirrorfile can
 206 even be used for different architectures.
 207
 208 --------
 209 Server = ftp://ftp.archlinux.org/$repo/os/$arch
 210 --------
 211
 212 The order of repositories in the configuration files matters; repositories
 213 listed first will take precedence over those listed later in the file when
 214 packages in two repositories have identical names, regardless of version
 215 number.
 216
 217 Using Your Own Repository
 218 -------------------------
 219 If you have numerous custom packages of your own, it is often easier to generate
 220 your own custom local repository than install them all with the '\--upgrade'
 221 option. All you need to do is generate a compressed package database in the
 222 directory with these packages so pacman can find it when run with '\--refresh'.
 223
 224         repo-add /home/pkgs/custom.db.tar.gz /home/pkgs/*.pkg.tar.gz
 225
 226 The above command will generate a compressed database named
 227 '/home/pkgs/custom.db.tar.gz'. Note that the database must be of the form
 228 '\{treename\}.db.tar.gz', where '\{treename\}' is the name of the section defined in
 229 the configuration file. That's it! Now configure your custom section in the
 230 configuration file as shown in the config example above. Pacman will now use your
 231 package repository. If you add new packages to the repository, remember to
 232 re-generate the database and use pacman's '\--refresh' option.
 233
 234 For more information on the repo-add command, see ``repo-add \--help'' or
 235 linkman:repo-add[8].
 236
 237
 238 See Also
 239 --------
 240 linkman:pacman[8], linkman:libalpm[3]
 241
 242 include::footer.txt[]