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