summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2008-01-06 22:18:08 -0600
committerDan McGee <dan@archlinux.org>2008-01-06 22:20:44 -0600
commitf438f7a8ff8e96691d8f27e77755d1822d5f02f6 (patch)
treef069d937ddfe4228b91e8d0c4162ac0c47ce087e /doc
parent6025df659432cd2dd98d1f1840fb4a0d9d4f5cd4 (diff)
downloadpacman-f438f7a8ff8e96691d8f27e77755d1822d5f02f6.tar.xz
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/pacman.8.txt18
-rw-r--r--doc/pacman.conf.5.txt27
2 files changed, 31 insertions, 14 deletions
diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
index 0ee8c6c0..99133dd9 100644
--- a/doc/pacman.8.txt
+++ b/doc/pacman.8.txt
@@ -79,8 +79,10 @@ Options
the package.
*-b, \--dbpath* <'path'>::
- Specify an alternative database location (default is ``/var/lib/pacman'').
- This should not be used unless you know what you are doing.
+ Specify an alternative database location (a typical default is
+ ``/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*::
Skips all dependency checks. Normally, pacman will always check a
@@ -100,16 +102,22 @@ Options
temporary mounted partition which is "owned" by another system.
*-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'>::
- 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,
- 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'>::
Specify an alternate configuration file.
+*\--logfile* <'file'>::
+ Specify an alternate log file. This is an absolute path, regardless of
+ the installation root setting.
+
*\--noconfirm*::
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.
diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt
index 958f6f71..f18244d1 100644
--- a/doc/pacman.conf.5.txt
+++ b/doc/pacman.conf.5.txt
@@ -44,21 +44,30 @@ Server = file:///home/pkgs
Options
-------
*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::
- Overrides the default location of the toplevel database directory.
- The default is ``/var/lib/pacman/''.
+ Overrides the default location of the toplevel database directory. A
+ 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::
- Overrides the default location of the package cache directory. The default
- is ``/var/cache/pacman/pkg/''. Multiple cache directories can be specified,
- and they are tried in the order they are listed in the config file. If a
- file is not found in any cache directory, it will be downloaded to the
- first cache directory with write access.
+ Overrides the default location of the package cache directory. A typical
+ default is ``/var/cache/pacman/pkg/''. Multiple cache directories can be
+ specified, and they are tried in the order they are listed in the config
+ file. If a file is not found in any cache directory, it will be downloaded
+ 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'::
- 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 ...::
If a user tries to '\--remove' a package that's listed in `HoldPkg`,