Documentation updates

Update description of path specifiers for both pacman and pacman.conf in
their respective manpages. Ensure it is obvious that they are absolute and
not relative paths.

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Dan McGee 2008-01-06 22:18:08 -06:00
parent 6025df6594
commit f438f7a8ff
2 changed files with 31 additions and 14 deletions

View File

@ -79,8 +79,10 @@ Options
the package. the package.
*-b, \--dbpath* <'path'>:: *-b, \--dbpath* <'path'>::
Specify an alternative database location (default is ``/var/lib/pacman''). Specify an alternative database location (a typical default is
This should not be used unless you know what you are doing. ``/var/lib/pacman''). This should not be used unless you know what you are
doing. *NOTE*: if specified, this is an absolute path and the root path is
not automatically prepended. This behavior changed in pacman 3.1.0.
*-d, \--nodeps*:: *-d, \--nodeps*::
Skips all dependency checks. Normally, pacman will always check a Skips all dependency checks. Normally, pacman will always check a
@ -100,16 +102,22 @@ Options
temporary mounted partition which is "owned" by another system. temporary mounted partition which is "owned" by another system.
*-v, --verbose*:: *-v, --verbose*::
Output more status messages, such as the Root, DBPath, CacheDir, etc. Output paths such as as the Root, Conf File, DB Path, Cache Dirs, etc.
*\--cachedir* <'dir'>:: *\--cachedir* <'dir'>::
Specify an alternative package cache location (default is Specify an alternative package cache location (a typical default is
``/var/cache/pacman/pkg''). Multiple cache directories can be specified, ``/var/cache/pacman/pkg''). Multiple cache directories can be specified,
and they are tried in the order they are passed to pacman. and they are tried in the order they are passed to pacman. *NOTE*: if
specified, this is an absolute path and the root path is not automatically
prepended. This behavior changed in pacman 3.1.0.
*\--config* <'file'>:: *\--config* <'file'>::
Specify an alternate configuration file. Specify an alternate configuration file.
*\--logfile* <'file'>::
Specify an alternate log file. This is an absolute path, regardless of
the installation root setting.
*\--noconfirm*:: *\--noconfirm*::
Bypass any and all "Are you sure?" messages. It's not a good idea to do Bypass any and all "Are you sure?" messages. It's not a good idea to do
this unless you want to run pacman from a script. this unless you want to run pacman from a script.

View File

@ -44,21 +44,30 @@ Server = file:///home/pkgs
Options Options
------- -------
*RootDir =* path/to/root:: *RootDir =* path/to/root::
Set the default root directory for pacman to install to. Set the default root directory for pacman to install to. This option is
used if you want to install a package on a temporary mounted partition
which is "owned" by another system, or for a chroot install.
*DBPath =* path/to/db/dir:: *DBPath =* path/to/db/dir::
Overrides the default location of the toplevel database directory. Overrides the default location of the toplevel database directory. A
The default is ``/var/lib/pacman/''. typical default is ``/var/lib/pacman/''. Most users will not need to set
this option. *NOTE*: if specified, this is an absolute path and the root
path is not automatically prepended. This behavior changed in pacman 3.1.0.
*CacheDir =* path/to/cache/dir:: *CacheDir =* path/to/cache/dir::
Overrides the default location of the package cache directory. The default Overrides the default location of the package cache directory. A typical
is ``/var/cache/pacman/pkg/''. Multiple cache directories can be specified, default is ``/var/cache/pacman/pkg/''. Multiple cache directories can be
and they are tried in the order they are listed in the config file. If a specified, and they are tried in the order they are listed in the config
file is not found in any cache directory, it will be downloaded to the file. If a file is not found in any cache directory, it will be downloaded
first cache directory with write access. to the first cache directory with write access. *NOTE*: if specified, this
is an absolute path and the root path is not automatically prepended. This
behavior changed in pacman 3.1.0.
*LogFile =* '/path/to/file':: *LogFile =* '/path/to/file'::
Log actions directly to a file. Default is ``/var/log/pacman.log''. Log actions directly to a file. A typical default is
``/var/log/pacman.log''. As of pacman 3.1.0, this does not need to be
specified by default. This is an absolute path and root is not prepended.
*HoldPkg =* package ...:: *HoldPkg =* package ...::
If a user tries to '\--remove' a package that's listed in `HoldPkg`, If a user tries to '\--remove' a package that's listed in `HoldPkg`,