Permalink
Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
175 lines (174 sloc) 5.86 KB
.TH POWAUR 1 "10-06-2011" "powaur" "powaur manual"
.SH NAME
powaur \- an AUR helper with a pacman-like interface
.SH SYNOPSIS
.I powaur
<operation> [options] [targets]
.SH DESCRIPTION
powaur is an AUR helper which provides a pacman-like interface. Invoking
powaur involves specifying an operation with applicable options and targets.
.SH OPERATIONS
.TP
.B "-G, --getpkgbuild <package(s)>"
Download PKGBUILDS from the AUR. PKGBUILDS are downloaded as tarballs, then
extracted into the current working directory. Dependency resolution can be
turned on with the --deps flag.
.IP
powaur now supports multi-threaded downloading, up to a maximum of 10 threads.
.IP
NOTE: With --deps, downloading is threaded but dependency resolution is NOT
threaded.
.TP
.B "-Q, --query"
Query the pacman local database. This option lets you view information about
installed packages (eg. dependencies, provides, installed date). When no
packages are provided, all installed packages will be queried.
.TP
.B "-S, --sync"
Synchronize packages. When used with no options, at least one target is
required and powaur will attempt to install the target package(s) from the AUR.
Dependency resolution is now available.
.IP
Note that the use of this flag to install AUR packages is discouraged.
You are adviced to use the -G flag to download PKGBUILDS and review them
before installing them using makepkg.
.TP
.B "-B, --backup"
Backup the local pacman database. See Backup Usage.
.TP
.B "--crawl <package(s)>"
Shows a valid topological order for the given package(s). The package(s) can
be from local or sync databases or the AUR. For installed AUR packages, a fresh
copy of the PKGBUILD will be downloaded and dependency resolution is based on
the PKGBUILD instead of information in the local database.
.IP
NOTE: This option only shows a single valid topological order (there may be
many other valid topological orders) for the packages.
.TP
.B "-M, --maintainer <person>"
Search the AUR for packages maintained by person. 1 and only 1 maintainer must
be specified.
.TP
.B "--list-aur"
Lists all installed AUR packages.
.TP
.B "-h, --help"
Displays help message and exits.
.TP
.B "-V, --version"
Displays version information and exits.
.SH OPTIONS
.TP
.B "--color"
Enables colorized output. This option can be supplied many times but the effect
will be the same as if it was supplied once. If --nocolor is supplied, the
effect of this option is nullified.
.TP
.B "--debug"
Display debug messages.
.TP
.B "--nocolor"
Disables colorized output. This option can be supplied many times but the
effect will be the same as if it was supplied once. If --color is supplied, the
effect of this option is nullified.
.TP
.B "--noconfirm"
Bypass all questions. This option is passed down to makepkg.
.TP
.B "--threads <N>"
Limits powaur to spawn up to a maximum of N threads. Currently, mutli-threading
is limited to the -G operation. This option can be used to override the
"MaxThreads" setting in the configuration file.
.SH GETPKGBUILD OPTIONS
.TP
.B "--deps"
.br
Resolve dependencies for all target packages. If any dependencies are from the
AUR, they will be downloaded, with their dependencies resolved. This is done
until all dependencies have been resolved.
.IP
NOTE: For dependency resolution to work properly, the package names in the
PKGBUILDS must be exact. Use the --verbose flag to see more information for
dependency resolution.
.IP
NOTE: Dependency resolution is NOT threaded. But downloading of resolved packages
is threaded.
.TP
.B "--target <DIR>"
Downloads packages to alterante directory <DIR> instead of the current working
directory.
.SH QUERY OPTIONS
.TP
.B "-i, --info"
Displays information on installed packages. If no packages were specified, then
information on all installed packages is displayed.
.TP
.B "-s, --search"
Searches installed packages for the specified package(s). If no packages were
specified, then all installed packages will be listed.
.SH SYNC OPTIONS
.TP
.B "--check"
Only meaningful when used with -u. Will stop -Su before package upgrading. Use
this flag to check for outdated AUR packages without upgrading them.
.TP
.B "-i, --info"
Searches sync databases, followed by AUR for package information. If no
packages were specified, then information on all packages from all sync
databases is displayed.
.TP
.B "-s, --search"
Searches the AUR for a specified package. Currently, there is only support for
searching for 1 package.
.TP
.B "-u, --upgrade"
Checks all locally installed AUR packages and updates any outdated AUR packages,
with all relevant dependencies resolved.
.TP
.B "--vote"
.br
Used with -s. Orders search results from the AUR by vote count instead of
alphabetical order.
.SH MAINTAINER OPTIONS
.TP
.B "--vote"
.br
Orders search results from the AUR by vote count instead of alphabetical order.
.SH BACKUP USAGE
.IP "powaur -B"
Backup pacman database to current working directory.
.IP "powaur -B dir"
Backup pacman database to dir.
.SH Configuration
powaur looks for its configuration file first in:
.P
$XDG_CONFIG_HOME/powaur.conf
.P
followed by:
.P
$HOME/.config/powaur.conf
.P
1 and only 1 of the above files will be parsed. In the event of unspecified
configuration settings, powaur will fallback to using the defaults.
.P
A sample config file can be found at /usr/share/powaur/powaur.conf
.SH Colorized Output
By default, powaur's output is colorized. Thus, "color" starts with a value
of 1.
.P
The --color flag and "Color" option when set to "On" in powaur.conf increases
the value of "color" by 1.
.P
The --nocolor flag and "Color" option when set to "Off" in powaur.conf increases
the value of "color" by 1.
.P
If the final value of "color" is greater than 0, then output is colorized.
.SH CREDITS
Dave Reisner - For his kind permission to let powaur use code from cower
.P
pacman, git - Source code was used from both of these projects, especially
pacman
.SH BUG REPORTS
Please email bug reports to <pangyanhan@gmail.com>
.SH AUTHOR
Pang Yan Han <pangyanhan@gmail.com>