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 # pacman.conf
  31 #
  32 [options]
  33 NoUpgrade = etc/passwd etc/group etc/shadow
  34 NoUpgrade = etc/fstab
  35
  36 [core]
  37 Include = /etc/pacman.d/core
  38
  39 [custom]
  40 Server = file:///home/pkgs
  41 --------
  42
  43 NOTE: Each directive must be in CamelCase. If the case isn't respected, the
  44 directive won't be recognized. For example. noupgrade or NOUPGRADE will not
  45 work.
  46
  47 Options
  48 -------
  49 *RootDir =* path/to/root::
  50         Set the default root directory for pacman to install to. This option is
  51         used if you want to install a package on a temporary mounted partition
  52         which is "owned" by another system, or for a chroot install.
  53         *NOTE*: If database path or logfile are not specified on either the
  54         command line or in linkman:pacman.conf[5], their default location will
  55         be inside this root path.
  56
  57 *DBPath =* path/to/db/dir::
  58         Overrides the default location of the toplevel database directory.  A
  59         typical default is ``/var/lib/pacman/''. Most users will not need to set
  60         this option. *NOTE*: if specified, this is an absolute path and the root
  61         path is not automatically prepended.
  62
  63 *CacheDir =* path/to/cache/dir::
  64         Overrides the default location of the package cache directory. A typical
  65         default is ``/var/cache/pacman/pkg/''. Multiple cache directories can be
  66         specified, and they are tried in the order they are listed in the config
  67         file. If a file is not found in any cache directory, it will be downloaded
  68         to the first cache directory with write access. *NOTE*: this is an absolute
  69         path, the root path is not automatically prepended.
  70
  71
  72 *LogFile =* '/path/to/file'::
  73         Overrides the default location of the pacman log file. A typical default
  74         is ``/var/log/pacman.log''. This is an absolute path and the root directory
  75         is not prepended.
  76
  77 *HoldPkg =* package ...::
  78         If a user tries to '\--remove' a package that's listed in `HoldPkg`,
  79         pacman will ask for confirmation before proceeding.
  80
  81 *IgnorePkg =* package ...::
  82         Instructs pacman to ignore any upgrades for this package when performing
  83         a '\--sysupgrade'.
  84
  85 *SyncFirst =* package ...::
  86         Instructs pacman to check for newer version of these packages before any
  87         sync operation. The user will have the choice to either cancel the current
  88         operation and upgrade these packages first or go on with the current operation.
  89         This option is typically used with the 'pacman' package.
  90
  91 *IgnoreGroup =* group ...::
  92         Instructs pacman to ignore any upgrades for all packages in this
  93         group when performing a '\--sysupgrade'.
  94
  95 *Include =* path::
  96         Include another config file. This file can include repositories or
  97         general configuration  options.
  98
  99 *XferCommand =* /path/to/command %u::
 100         If set, an external program will be used to download all remote files.
 101         All instances of `%u` will be replaced with the download URL. If present,
 102         instances of `%o` will be replaced with the local filename, plus a
 103         ``.part'' extension, which allows programs like wget to do file resumes
 104         properly.
 105         +
 106         This option is useful for users who experience problems with built-in
 107         http/ftp support, or need the more advanced proxy support that comes with
 108         utilities like wget.
 109
 110 *NoPassiveFtp*::
 111         Disables passive ftp connections when downloading packages. (aka Active Mode)
 112
 113 *NoUpgrade =* file ...::
 114         All files listed with a `NoUpgrade` directive will never be touched during
 115         a package install/upgrade.
 116         These files refer to files in the package archive, so do not include the
 117         leading slash (the RootDir) when specifying them.
 118
 119 *NoExtract =* file ...::
 120         All files listed with a `NoExtract` directive will never be extracted from
 121         a package into the filesystem. This can be useful when you don't want part
 122         of a package to be installed. For example, if your httpd root uses an
 123         'index.php', then you would not want the 'index.html' file to be extracted
 124         from the 'apache' package.
 125         These files refer to files in the package archive, so do not include the
 126         leading slash (the RootDir) when specifying them.
 127
 128 *CleanMethod =* KeepInstalled | KeepCurrent::
 129         If set to `KeepInstalled` (the default), the '-Sc' operation will clean
 130         packages that are no longer installed (not present in the local database).
 131         If set to `KeepCurrent`, '-Sc' will clean outdated packages (not present in
 132         any sync database).
 133         The second behavior is useful when the package cache is shared among
 134         multiple machines, where the local databases are usually different, but the
 135         sync databases in use could be the same.
 136
 137 *UseSyslog*::
 138         Log action messages through syslog(). This will insert log entries into
 139         ``/var/log/messages'' or equivalent.
 140
 141 *ShowSize*::
 142         Display the size of individual packages for '\--sync' and '\--query' modes.
 143
 144 *UseDelta*::
 145         Download delta files instead of complete packages if possible.  Requires
 146         the xdelta program to be installed.
 147
 148 *TotalDownload*::
 149         When downloading, display the amount downloaded, download rate, ETA,
 150         and completed percentage of the entire download list rather
 151         than the percent of each individual download target. The progress
 152         bar is still based solely on the current file download.
 153
 154 Repository Sections
 155 -------------------
 156 Each repository section defines a section name and at least one location where
 157 the packages can be found. The section name is defined by the string within
 158 square brackets (the two above are 'current'  and  'custom'). Locations are
 159 defined with the 'Server' directive and follow a URL naming structure. If you
 160 want to use a local directory, you can specify the full path with a ``file://''
 161 prefix, as shown above.
 162
 163 A common way to define DB locations utilizes the 'Include' directive. For each
 164 repository defined in the configuration file, a single 'Include' directive can
 165 contain a file that lists the servers for that repository.
 166
 167 --------
 168 [core]
 169 # use this repository first
 170 Server = ftp://ftp.archlinux.org/core/os/arch
 171 # next use servers as defined in the mirrorlist below
 172 Include = /etc/pacman.d/mirrorlist
 173 --------
 174
 175 During parsing, pacman will define the `$repo` variable to the name of the
 176 current section. This is often utilized in files specified using the 'Include'
 177 directive so all repositories can use the same mirrorfile.
 178
 179 --------
 180 Server = ftp://ftp.archlinux.org/$repo/os/arch
 181 --------
 182
 183 The order of repositories in the configuration files matters; repositories
 184 listed first will take precedence over those listed later in the file when
 185 packages in two repositories have identical names, regardless of version
 186 number.
 187
 188 Using Your Own Repository
 189 -------------------------
 190 If you have numerous custom packages of your own, it is often easier to generate
 191 your own custom local repository than install them all with the '\--upgrade'
 192 option. All you need to do is generate a compressed package database in the
 193 directory with these packages so pacman can find it when run with '\--refresh'.
 194
 195         repo-add /home/pkgs/custom.db.tar.gz /home/pkgs/*.pkg.tar.gz
 196
 197 The above command will generate a compressed database named
 198 '/home/pkgs/custom.db.tar.gz'. Note that the database must be of the form
 199 '{treename}.db.tar.gz', where '{treename}' is the name of the section defined in
 200 the configuration file. That's it! Now configure your custom section in the
 201 configuration file as shown in the config example above. Pacman will now use your
 202 package repository. If you add new packages to the repository, remember to
 203 re-generate the database and use pacman's '\--refresh' option.
 204
 205 For more information on the repo-add command, see ``repo-add \--help'' or
 206 linkman:repo-add[8].
 207
 208
 209 See Also
 210 --------
 211 linkman:pacman[8], linkman:libalpm[3]
 212
 213 include::footer.txt[]