bryson/pacman
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move common stuff into footer.txt and some formating tweaks.

Browse source 
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
This commit is contained in:
Andrew Fyfe 2007-07-02 21:30:39 +01:00 • committed by Dan McGee
parent 2f7d2485f5
commit 493e5fb782
3 changed files with 78 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/footer.txt
View file

@ -1,3 +1,16 @@
See the Arch Linux website at <http://www.archlinux.org> for more current
information on the distribution and the pacman family of tools, and
<http://wiki.archlinux.org/index.php/Arch_Packaging_Standards> for
recommendations on packaging standards.
Bugs
----
Bugs? You must be kidding, there are no bugs in this software. But if we
happen to be wrong, send us an email with as much detail as possible to
<pacman-dev@archlinux.org>.
Authors Authors
------- -------
* Judd Vinet <jvinet@zeroflux.org> * Judd Vinet <jvinet@zeroflux.org>

109
doc/pacman.8.txt
View file

@ -1,17 +1,17 @@
PACMAN(8) PACMAN(8)
========= =========
NAME Name
---- ----
pacman - package manager utility pacman - package manager utility
SYNOPSIS Synopsis
-------- --------
'pacman' <operation> [options] [packages] 'pacman' <operation> [options] [packages]
DESCRIPTION Description
----------- -----------
Pacman is a package management utility that tracks installed packages on a Linux Pacman is a package management utility that tracks installed packages on a Linux
system. It features dependency support, package groups, install and uninstall system. It features dependency support, package groups, install and uninstall
@ -23,77 +23,77 @@ Since version 3.0.0, pacman has been the frontend to manlink:libalpm[3], the
ends to be written (for instance, a GUI front end). ends to be written (for instance, a GUI front end).
OPERATIONS Operations
---------- ----------
-A, --add (deprecated):: *-A, --add* (deprecated)::
Add a package to the system. Either a URL or file path can be specified. Add a package to the system. Either a URL or file path can be specified.
The package will be uncompressed into the installation root and the The package will be uncompressed into the installation root and the
database will be updated. The package will not be installed if another database will be updated. The package will not be installed if another
version is already installed. *NOTE*: please use `--upgrade` in place of version is already installed. *NOTE*: please use `--upgrade` in place of
this option. this option.
-F, --freshen:: *-F, --freshen*::
This is like `--upgrade` except it will only upgrade packages already This is like `--upgrade` except it will only upgrade packages already
installed on the system. installed on the system.
-Q, --query:: *-Q, --query*::
Query the package database. This operation allows you to view installed Query the package database. This operation allows you to view installed
packages and their files, as well as meta-information about individual packages and their files, as well as meta-information about individual
packages (dependencies, conflicts, install date, build date, size). This packages (dependencies, conflicts, install date, build date, size). This
can be run against the local package database or can be used on can be run against the local package database or can be used on
individual `.tar.gz` packages. See <<QO,Query Options>> below. individual `.tar.gz` packages. See <<QO,Query Options>> below.
-R, --remove:: *-R, --remove*::
Remove a package from the system. Files belonging to the specified Remove a package from the system. Files belonging to the specified
package will be deleted, and the database will be updated. Most package will be deleted, and the database will be updated. Most
configuration files will be saved with a `.pacsave` extension unless the configuration files will be saved with a `.pacsave` extension unless the
`--nosave` option is used. See <<RO,Remove Options>> below. `--nosave` option is used. See <<RO,Remove Options>> below.
-S, --sync:: *-S, --sync*::
Synchronize packages. Packages are installed directly from the ftp Synchronize packages. Packages are installed directly from the ftp
servers, including all dependencies required to run the packages. For servers, including all dependencies required to run the packages. For
example, `pacman -S qt` will download and install qt and all the example, `pacman -S qt` will download and install qt and all the
packages it depends on. You can also use `pacman -Su` to upgrade all packages it depends on. You can also use `pacman -Su` to upgrade all
packages that are out of date. See <<SO,Sync Options>> below. packages that are out of date. See <<SO,Sync Options>> below.
-U, --upgrade:: *-U, --upgrade*::
Upgrade or add a package to the system. Either a URL or file path can be Upgrade or add a package to the system. Either a URL or file path can be
specified. This is a "remove-then-add" process. See specified. This is a "remove-then-add" process. See
<<HCF,Handling Config Files>> for an explanation on how <<HCF,Handling Config Files>> for an explanation on how
pacman takes care of config files. pacman takes care of config files.
-V, --version:: *-V, --version*::
Display version and exit. Display version and exit.
-h, --help:: *-h, --help*::
Display syntax for the given operation. If no operation was supplied Display syntax for the given operation. If no operation was supplied
then the general syntax is shown. then the general syntax is shown.
OPTIONS Options
------- -------
--ask <number>:: *--ask* <'number'>::
Pre-specify answers to questions. It is doubtful whether this option Pre-specify answers to questions. It is doubtful whether this option
even works, so I would not recommend using it. *TODO*: document this even works, so I would not recommend using it. *TODO*: document this
more, as I have no idea how it works or when you would use it, or if we more, as I have no idea how it works or when you would use it, or if we
should just dump it. should just dump it.
-b, --dbpath <path>:: *-b, --dbpath* <'path'>::
Specify an alternative database location (default is `/var/lib/pacman`). Specify an alternative database location (default is `/var/lib/pacman`).
This should not be used unless you know what you are doing. This should not be used unless you know what you are doing.
-d, --nodeps:: *-d, --nodeps*::
Skips all dependency checks. Normally, pacman will always check a Skips all dependency checks. Normally, pacman will always check a
package's dependency fields to ensure that all dependencies are package's dependency fields to ensure that all dependencies are
installed and there are no package conflicts in the system. installed and there are no package conflicts in the system.
-f, --force:: *-f, --force*::
Bypass file conflict checks and overwrite conflicting files. If the Bypass file conflict checks and overwrite conflicting files. If the
package that is about to be installed contains files that are already package that is about to be installed contains files that are already
installed, this option will cause all those files to be overwritten. installed, this option will cause all those files to be overwritten.
This option should be used with care, ideally not at all. This option should be used with care, ideally not at all.
-r, --root <path>:: *-r, --root* <'path'>::
Specify an alternative installation root (default is `/`). This should Specify an alternative installation root (default is `/`). This should
not be used as a way to install software into `/usr/local` instead of not be used as a way to install software into `/usr/local` instead of
`/usr`. This option is used if you want to install a package on a `/usr`. This option is used if you want to install a package on a
@ -101,89 +101,89 @@ OPTIONS
this option you not only specify where the software should be installed, this option you not only specify where the software should be installed,
but you also specify which package database and cache location to use. but you also specify which package database and cache location to use.
-v, --verbose:: *-v, --verbose*::
Output more status messages, such as the Root and DBPath. Output more status messages, such as the Root and DBPath.
--cachedir <dir>:: *--cachedir* <'dir'>::
Specify an alternative package cache location (default is Specify an alternative package cache location (default is
`/var/cache/pacman/pkg`). This should not be used unless you know what `/var/cache/pacman/pkg`). This should not be used unless you know what
you are doing. you are doing.
--config <file>:: *--config* <'file'>::
Specify an alternate configuration file. Specify an alternate configuration file.
--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.
--noprogressbar:: *--noprogressbar*::
Do not show a progress bar when downloading files. This can be useful Do not show a progress bar when downloading files. This can be useful
for scripts that call pacman and capture the output. for scripts that call pacman and capture the output.
--noscriptlet:: *--noscriptlet*::
If an install scriptlet exists, do not execute it. Do not use this If an install scriptlet exists, do not execute it. Do not use this
unless you know what you are doing. unless you know what you are doing.
Query Options[[QO]] Query Options[[QO]]
------------------- -------------------
-c, --changelog:: *-c, --changelog*::
View the ChangeLog of a package. Not every package will provide one but View the ChangeLog of a package. Not every package will provide one but
it will be shown if available. it will be shown if available.
-e, --orphans:: *-e, --orphans*::
List all packages that were pulled in by a previously installed package List all packages that were pulled in by a previously installed package
but no longer required by any installed package. but no longer required by any installed package.
-g, --groups:: *-g, --groups*::
Display all packages that are members of a named group. If not name is Display all packages that are members of a named group. If not name is
specified, list all grouped packages. specified, list all grouped packages.
-i, --info:: *-i, --info*::
Display information on a given package. The `-p` option can be used if Display information on a given package. The `-p` option can be used if
querying a package file instead of the local database. querying a package file instead of the local database.
-l, --list:: *-l, --list*::
List all files owned by a given package. Multiple packages can be List all files owned by a given package. Multiple packages can be
specified on the command line. specified on the command line.
-m, --foreign:: *-m, --foreign*::
List all packages that were not found in the sync database(s). Typically List all packages that were not found in the sync database(s). Typically
these are packages that were downloaded manually and installed with these are packages that were downloaded manually and installed with
`--upgrade`. `--upgrade`.
-o, --owns <file>:: *-o, --owns* <'file'>::
Search for the package that owns file. Search for the package that owns file.
-p, --file:: *-p, --file*::
Signifies that the package supplied on the command line is a file and Signifies that the package supplied on the command line is a file and
not an entry in the database. The file will be decompressed and queried. not an entry in the database. The file will be decompressed and queried.
This is useful in combination with `--info` and `--list`. This is useful in combination with `--info` and `--list`.
-s, --search <regexp>:: *-s, --search* <'regexp'>::
This will search each locally-installed package for names or This will search each locally-installed package for names or
descriptions that matche regexp. descriptions that matche regexp.
-u, --upgrades:: *-u, --upgrades*::
Lists all packages that are out of date on the local system. This option Lists all packages that are out of date on the local system. This option
works best if the sync database is refreshed using `-Sy`. works best if the sync database is refreshed using `-Sy`.
Remove Options[[RO]] Remove Options[[RO]]
-------------------- --------------------
-c, --cascade:: *-c, --cascade*::
Remove all target packages, as well as all packages that depend on one Remove all target packages, as well as all packages that depend on one
or more target packages. This operation is recursive. or more target packages. This operation is recursive.
-k, --keep:: *-k, --keep*::
Removes the database entry only. Leaves all files in place. Removes the database entry only. Leaves all files in place.
-n, --nosave:: *-n, --nosave*::
Instructs pacman to ignore file backup designations. Normally, when a Instructs pacman to ignore file backup designations. Normally, when a
file is removed from the system the database is checked to see if the file is removed from the system the database is checked to see if the
file should be renamed with a .pacsave extension. file should be renamed with a .pacsave extension.
-s, --recursive:: *-s, --recursive*::
Remove each target specified including all dependencies, provided that Remove each target specified including all dependencies, provided that
(A) they are not required by other packages; and (B) they were not (A) they are not required by other packages; and (B) they were not
explicitly installed by the user. This option is analogous to a explicitly installed by the user. This option is analogous to a
@ -192,39 +192,39 @@ Remove Options[[RO]]
Sync Options[[SO]] Sync Options[[SO]]
------------------ ------------------
-c, --clean:: *-c, --clean*::
Remove old packages from the cache to free up disk space. When pacman Remove old packages from the cache to free up disk space. When pacman
downloads packages, it saves them in `/var/cache/pacman/pkg`. Use one downloads packages, it saves them in `/var/cache/pacman/pkg`. Use one
`--clean` switch to remove old packages; use two to remove all packages `--clean` switch to remove old packages; use two to remove all packages
from the cache. from the cache.
-e, --dependsonly:: *-e, --dependsonly*::
Install all dependencies of a package, but not the specified package Install all dependencies of a package, but not the specified package
itself. This is pretty useless and we're not sure why it even exists. itself. This is pretty useless and we're not sure why it even exists.
-g, --groups:: *-g, --groups*::
Display all the members for each package group specified. If no group Display all the members for each package group specified. If no group
names are provided, all groups will be listed; pass the flag twice to names are provided, all groups will be listed; pass the flag twice to
view all groups and their members. view all groups and their members.
-i, --info:: *-i, --info*::
Display dependency and other information for a given package. This will Display dependency and other information for a given package. This will
search through all repositories for a matching package. search through all repositories for a matching package.
-l, --list:: *-l, --list*::
List all packages in the specified repositories. Multiple repositories List all packages in the specified repositories. Multiple repositories
can be specified on the command line. can be specified on the command line.
-p, --print-uris:: *-p, --print-uris*::
Print out URIs for each package that will be installed, including any Print out URIs for each package that will be installed, including any
dependencies yet to be installed. These can be piped to a file and dependencies yet to be installed. These can be piped to a file and
downloaded at a later time, using a program like wget. downloaded at a later time, using a program like wget.
-s, --search <regexp>:: *-s, --search* <'regexp'>::
This will search each package in the sync databases for names or This will search each package in the sync databases for names or
descriptions that match regexp. descriptions that match regexp.
-u, --sysupgrade:: *-u, --sysupgrade*::
Upgrades all packages that are out of date. Each currently-installed Upgrades all packages that are out of date. Each currently-installed
package will be examined and upgraded if a newer package exists. A package will be examined and upgraded if a newer package exists. A
report of all packages to upgrade will be presented and the operation report of all packages to upgrade will be presented and the operation
@ -232,17 +232,17 @@ Sync Options[[SO]]
automatically resolved at this level and will be installed/upgraded if automatically resolved at this level and will be installed/upgraded if
necessary. necessary.
-w, --downloadonly:: *-w, --downloadonly*::
Retrieve all packages from the server, but do not install/upgrade Retrieve all packages from the server, but do not install/upgrade
anything. anything.
-y, --refresh:: *-y, --refresh*::
Download a fresh copy of the master package list from the server(s) Download a fresh copy of the master package list from the server(s)
defined in pacman.conf. This should typically be used each time you use defined in pacman.conf. This should typically be used each time you use
`--sysupgrade` or `-u`. Passing two `--refresh` or `-y` flags will force `--sysupgrade` or `-u`. Passing two `--refresh` or `-y` flags will force
a refresh of all package lists even if they are thought to be up to date. a refresh of all package lists even if they are thought to be up to date.
--ignore <package>:: *--ignore* <'package'>::
Directs pacman to ignore upgrades of package even if there is one Directs pacman to ignore upgrades of package even if there is one
available. available.
@ -284,19 +284,8 @@ See manlink:pacman.conf[5] for more details on configuring pacman using the
`pacman.conf` file. `pacman.conf` file.
Bugs
----
Bugs? You must be kidding, there are no bugs in this software. But if we happen
to be wrong, send us an email with as much detail as possible to
pacman-dev@archlinux.org.
See Also See Also
-------- --------
manlink:pacman.conf[5], manlink:makepkg[8], manlink:libalpm[3] manlink:pacman.conf[5], manlink:makepkg[8], manlink:libalpm[3]
See the Arch Linux website at http://www.archlinux.org for more current
information on the distribution and the pacman family of tools.
include::footer.txt[] include::footer.txt[]

36
doc/pacman.conf.5.txt
View file

@ -1,12 +1,12 @@
pacman.conf(5) pacman.conf(5)
============== ==============
NAME Name
---- ----
pacman.conf - pacman package manager configuration file pacman.conf - pacman package manager configuration file
DESCRIPTION Description
----------- -----------
Pacman, using manlink:libalpm[3], will attempt to read `pacman.conf` each Pacman, using manlink:libalpm[3], will attempt to read `pacman.conf` each
time it is invoked. This configuration file is divided into sections or time it is invoked. This configuration file is divided into sections or
@ -15,7 +15,7 @@ when searching for packages in `--sync` mode. The exception to this is the
options section, which defines global options. options section, which defines global options.
EXAMPLE Example
------- -------
-------- --------
# #
@ -33,29 +33,29 @@ Server = file:///home/pkgs
-------- --------
OPTIONS Options
------- -------
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.
The default is `var/lib/pacman`. The default is `var/lib/pacman`.
CacheDir = path/to/cache/dir:: *CacheDir =* 'path/to/cache/dir'::
Overrides the default location of the package cache directory. The Overrides the default location of the package cache directory. The
default is `var/cache/pacman`. default is `var/cache/pacman`.
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`,
pacman will ask for confirmation before proceeding. pacman will ask for confirmation before proceeding.
IgnorePkg = package ...:: *IgnorePkg =* 'package' ...::
Instructs pacman to ignore any upgrades for this package when performing Instructs pacman to ignore any upgrades for this package when performing
a `--sysupgrade`. a `--sysupgrade`.
Include = path:: *Include =* 'path'::
Include another config file. This file can include repositories or Include another config file. This file can include repositories or
general configuration options. general configuration options.
XferCommand = /path/to/command %u:: *XferCommand =* '/path/to/command %u'::
If set, an external program will be used to download all remote files. If set, an external program will be used to download all remote files.
All instances of `%u` will be replaced with the download URL. If present, All instances of `%u` will be replaced with the download URL. If present,
instances of `%o` will be replaced with the local filename, plus a instances of `%o` will be replaced with the local filename, plus a
@ -65,29 +65,29 @@ XferCommand = /path/to/command %u::
http/ftp support, or need the more advanced proxy support that comes with http/ftp support, or need the more advanced proxy support that comes with
utilities like wget. utilities like wget.
NoPassiveFtp:: *NoPassiveFtp*::
Disables passive ftp connections when downloading packages. (aka Active Mode) Disables passive ftp connections when downloading packages. (aka Active Mode)
NoUpgrade = file ...:: *NoUpgrade =* 'file' ...::
All files listed with a `NoUpgrade` directive will never be touched during All files listed with a `NoUpgrade` directive will never be touched during
a package install/upgrade. Do not include the leading slash when specifying a package install/upgrade. Do not include the leading slash when specifying
files. files.
NoExtract = file ...:: *NoExtract =* 'file' ...::
All files listed with a `NoExtract` directive will never be extracted from All files listed with a `NoExtract` directive will never be extracted from
a package into the filesystem. This can be useful when you don't want part a package into the filesystem. This can be useful when you don't want part
of a package to be installed. For example, if your httpd root uses an of a package to be installed. For example, if your httpd root uses an
index.php, then you would not want the index.html file to be extracted from index.php, then you would not want the index.html file to be extracted from
the apache package. the apache package.
UseSyslog:: *UseSyslog*::
Log action messages through syslog(). This will insert log entries into Log action messages through syslog(). This will insert log entries into
`/var/log/messages` or equivalent. `/var/log/messages` or equivalent.
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. Default is `/var/log/pacman.log`.
ShowSize:: *ShowSize*::
Display the size of individual packages for `--sync` and `--query` modes. Display the size of individual packages for `--sync` and `--query` modes.
@ -128,8 +128,4 @@ See Also
-------- --------
manlink:pacman[8], manlink:libalpm[3] manlink:pacman[8], manlink:libalpm[3]
See the Arch Linux website at http://www.archlinux.org for more current
information on the distribution and the pacman family of tools.
include::footer.txt[] include::footer.txt[]