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 manlink: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 [current]
  37 Include = /etc/pacman.d/current
  38
  39 [custom]
  40 Server = file:///home/pkgs
  41 --------
  42
  43
  44 Options
  45 -------
  46 *RootDir =* path/to/root::
  47         Set the default root directory for pacman to install to.
  48
  49 *DBPath =* path/to/db/dir::
  50         Overrides the default location of the toplevel database directory.
  51         The default is ``/var/lib/pacman/''.
  52
  53 *CacheDir =* path/to/cache/dir::
  54         Overrides the default location of the package cache directory. The default
  55         is ``/var/cache/pacman/pkg/''. Multiple cache directories can be specified,
  56         and they are tried in the order they are listed in the config file. If a
  57         file is not found in any cache directory, it will be downloaded to the
  58         first cache directory with write access.
  59
  60 *LogFile =* '/path/to/file'::
  61         Log actions directly to a file. Default is ``/var/log/pacman.log''.
  62
  63 *HoldPkg =* package ...::
  64         If a user tries to '\--remove' a package that's listed in `HoldPkg`,
  65         pacman will ask for confirmation before proceeding.
  66
  67 *IgnorePkg =* package ...::
  68         Instructs pacman to ignore any upgrades for this package when performing
  69         a '\--sysupgrade'.
  70
  71 *IgnoreGroup =* group ...::
  72         Instructs pacman to ignore any upgrades for all packages in this
  73         group when performing a '\--sysupgrade'.
  74
  75 *Include =* path::
  76         Include another config file. This file can include repositories or
  77         general configuration  options.
  78
  79 *XferCommand =* /path/to/command %u::
  80         If set, an external program will be used to download all remote files.
  81         All instances of `%u` will be replaced with the download URL. If present,
  82         instances of `%o` will be replaced with the local filename, plus a
  83         ``.part'' extension, which allows programs like wget to do file resumes
  84         properly.
  85         +
  86         This option is useful for users who experience problems with built-in
  87         http/ftp support, or need the more advanced proxy support that comes with
  88         utilities like wget.
  89
  90 *NoPassiveFtp*::
  91         Disables passive ftp connections when downloading packages. (aka Active Mode)
  92
  93 *NoUpgrade =* file ...::
  94         All files listed with a `NoUpgrade` directive will never be touched during
  95         a package install/upgrade. Do not include the leading slash when specifying
  96         files.
  97
  98 *NoExtract =* file ...::
  99         All files listed with a `NoExtract` directive will never be extracted from
 100         a package into the filesystem. This can be useful when you don't want part
 101         of a package to be installed. For example, if your httpd root uses an
 102         'index.php', then you would not want the 'index.html' file to be extracted
 103         from the 'apache' package.
 104
 105 *UseSyslog*::
 106         Log action messages through syslog(). This will insert log entries into
 107         ``/var/log/messages'' or equivalent.
 108
 109 *ShowSize*::
 110         Display the size of individual packages for '\--sync' and '\--query' modes.
 111
 112 *UseDelta*::
 113         Download delta files instead of complete packages if possible.  Requires
 114         the xdelta program to be installed.
 115
 116 *TotalDownload*::
 117         When downloading, display the amount downloaded, download rate, ETA,
 118         and completed percentage of the entire download list list rather
 119         than the percent of each individual download target. The progress
 120         bar is still based solely on the current file download.
 121
 122 Repository Sections
 123 -------------------
 124 Each repository section defines a section name and at least one location where
 125 the packages can be found. The section name is defined by the string within
 126 square brackets (the two above are 'current'  and  'custom'). Locations are
 127 defined with the 'Server' directive and follow a URL naming structure. If you
 128 want to use a local directory, you can specify the full path with a ``file://''
 129 prefix, as shown above.
 130
 131 The order of repositories in the file matters; repositories listed first will
 132 take precedence over those listed later in the file when packages in two
 133 repositories have identical names, regardless of version number.
 134
 135 Using Your Own Repository
 136 -------------------------
 137 If you have numerous custom packages of your own, it is often easier to generate
 138 your own custom local repository than install them all with the '\--upgrade'
 139 option. All you need to do is generate a compressed package database in the
 140 directory with these packages so pacman can find it when run with '\--refresh'.
 141
 142         repo-add /home/pkgs/custom.db.tar.gz /home/pkgs/*.pkg.tar.gz
 143
 144 The above command will generate a compressed database named
 145 '/home/pkgs/custom.db.tar.gz'. Note that the database must be of the form
 146 '{treename}.db.tar.gz', where '{treename}' is the name of the section defined in
 147 the configuration file. That's it! Now configure your custom section in the
 148 configuration file as shown in the config example above. Pacman will now use your
 149 package repository. If you add new packages to the repository, remember to
 150 re-generate the database and use pacman's '\--refresh' option.
 151
 152 For more information on the repo-add command, see ``repo-add \--help'' or
 153 manlink:repo-add[8].
 154
 155
 156 See Also
 157 --------
 158 manlink:pacman[8], manlink:libalpm[3]
 159
 160 include::footer.txt[]