=encoding utf8

=head1 NAME

pacaur - an AUR helper that minimizes user interaction

=head1 SYNOPSIS

Usage: I EoperationE [ options ] [ target(s) ]

=head1 DESCRIPTION

Pacaur is an Arch User Repository (AUR) helper aiming at speed and simplicity and is designed to minimize user prompt interaction. It uses an uncluttered interface and makes use of the full secured RPC interface to solve the dependency tree. It will also automatically prompt for sudo access when needed. It is built upon the well designed auracle C++ and expac C backends.

Invoking pacaur consists of supplying an operation, any applicable options, and usually one or more targets. A I is usually a package name or a search string.

=head1 USERBASE TARGET

Pacaur is targeted at B who want some degree of automation for repetitive tasks. As such, the user is expected to be familiar with the AUR manual build process with makepkg and its configuration options, as well as being knowledgeable about sudo and gpg configuration.

Two sets of command line options are provided: commands which call the pacman binary and extend it with AUR functions B<(-S, -Ss, -Si, -Sw, -Su, -Qu, -Sc, -Scc)>, and I<-a/--aur> can be added to only apply these to the AUR. As such, pacaur can be used by users who prefer to have a single tool to manage the officialand AUR repositories, or by users who prefer to keep their AUR frontend separated from pacman.

=head1 OPERATIONS

=head2 Pacman extension operations

=over 4

=item B<-S, -Ss, -Si, -Sw, -Su, -Qu, -Sc, -Scc>

Pacaur wraps all B and by default extends respectively its sync, search, info, download only, system upgrade, upgrades check, clean and clean all functions to the AUR. This extension behavior is optional and can be disabled with the I<-r/--repo> flag, and used with the variable set with the I<-a/--aur> flag. Pacaur will also pass any other pacman operations and their related options to the pacman binary.

=back

=head2 General operations

=over 4

=item B<-v, --version>

Display version and quit.

=item B<-h, --help>

Display the help message and quit.

=back

=head1 OPTIONS

=head2 Pacman extension options

=over 4

=item B<-a, --aur>

When used with pacman extended operations, only search, build, install, upgrade or clean I<target(s)> from the AUR.

=item B<-r, --repo>

When used with pacman extended operations, only search, build, install, upgrade or clean I<target(s)> from the repositories.

=back

=head2 General options

=over 4

=item B<-e, --edit>

Edit build files when cloning or building I<target(s)>. Overrides the I config option and always fully shows the build files. Can also be used as a standalone command.

=item B<-q, --quiet>

Show less information for search and query operations. Search will only show package names and not version, group, and description information.

=item B<--devel>

When used with upgrade and check operations, also consider AUR development packages. Supported are I, I, I, I, I and I development packages, as well as I and I build packages.

=item B<--foreign>

When used with buildonly, sync and upgrade operations, also consider already installed foreign dependencies when solving the dependency tree.

=item B<--ignore> I<target(s)>

Ignore a I upgrade. Can be used more than once. Also accepts a comma delimited list as a single argument. Packages listed in pacman's I directive are honored.

=item B<--needed>

Do not reinstall I<target(s)> that are already up-to-date. The build of development packages that are found up-to-date after the source checkout will be skipped. Supported are I, I, I and I development packages, as well as I and I build packages.

=item B<--noconfirm>

Perform commands without confirmation from the user.

=item B<--noedit>

Perform commands without editing any installation files. Overrides the I<--edit> option. =item B<--rebuild>

Always rebuild packages regardless of any existing file in I<$PKGDEST> directory, and regardless of up-to-date status of development packages.

=item B<--silent>

Silence output. This will send the output of each packaging functions to text files in the clone directory named I. Additional pacman output for providers and cached packages installation will also be hidden.

=back

=head2 Search options

=over 4

=item B<--by> , B<--searchby>

When searching the AUR, search by I where I is B, B, or B to search for packages by their name, name and description, or by the package maintainer, respectively. The default is to search by name-desc.

=item B<--literal>

When searching the AUR, disable regex search and interpret target as a literal string.

=item B<--sort> , B<--rsort>

When searching the AUR, sort the results in ascending or descending order, respectively, by I where I is B, B or B.

=back

=head1 CONFIG FILE

=over 4

=item B

Pacaur honors a system-wide config file which will be looked for first at

$XDG_CONFIG_DIRS/pacaur/config

and falling back to

/etc/xdg/pacaur/config

=item B

User-defined configuration files overriding the general settings will be looked for first at

$XDG_CONFIG_HOME/pacaur/config

and falling back to

$HOME/.config/pacaur/config

=back

=head1 CONFIG OPTIONS

The available options are:

=over 4

=item B

Define the editor. Default is B<$VISUAL>, with a fallback on B<$EDITOR> and I.

=item B

Display PKGBUILD and install script viewing prompt. Possible values are I to always display the full build files, I to only display the difference since last build, and I to disable the viewing prompt. Default is B.

=item B

Enable silent output. The makepkg output will be collected in the clone directory or the I<$LOGDEST> directory should any error occur. Default is B.

=item B

When searching the AUR, sort the results by I, number of I or I. Default is B.

=item B

When searching the AUR, sort the results in I or I order. Default is B.

=item B

Prevent sudo timeout. This option overrides the system-wide I sudo configuration and refreshes the sudo timestamp automatically in a loop when building packages. Default is B.

=back

=head1 ENVIRONMENT

=over 4

=item B

Determines where the packages build files (PKGBUILD, .SRCINFO and install script files) will be cloned. The I<-Sc> and I<-Scc> clean operations allow to remove the untracked cloned files and the non locally installed cloned files, and all cloned files, respectively.

If this environment variable is not defined, the clone directory will be set to

$XDG_CACHE_HOME/pacaur

with a fall back to

$HOME/.cache/pacaur

=item B

Internally used variable for passing options to makepkg, can be set externally to add flags for pacaur to always pass to makepkg, such as I<-A>, which ignores the arch field in a PKGBUILD to allow for building on other architectures regardless of if that architecture has been added to the arch field

=back

In addition, makepkg environment variables are fully honored. See B(8). In particular, the following variables are useful:

=over 4

=item B

Determines where the built packages will be stored. If using the existing I</var/cache/pacman/pkg> pacman cache directory, ensure your user has proper write permissions. Additionally, if added to the I path option of I, the I<-Sc> and I<-Scc> clean operations will enable removal of non locally installed cached files and all cached files, respectively.

=item B

Determines where the source of packages will be stored. This will speed up the upgrade of development packages. The I<-Sc> and I<-Scc> clean operations allow to remove the non development packages source files and all source files, respectively.

=item B

Determines where the build logs will be stored. By default, the I<--silent> option will write build logs in the clone directory if the build fails, but will remove them if the build succeeds.

=item B

Determines where the packages will be built. By default, build will happen in the defined clone directory, but build speed can be improved by using I located in volatile memory. This is however not recommended if big packages need to be built on a low-memory machine.

=back

=head1 NOTES

=over 4

=item B

To be used with minimal password prompting, I should be configured accordingly to allow sudo access. See B(5). If you disable the I config option, you might also want to disable the I sudo parameter to avoid password prompt timeout.

=item B

Miscellaneous options enabled in I are taken into account. Thus, colored output can be enabled with the I option, while a detailed interface displaying name, version and size of packages formatted as a table is available through the I option.

=item B

To allow build files comparison, the I default config option is set to I. Although the clone directory (set by default to I<$XDG_CACHE_HOME/pacaur>) can be changed through the alternative I<$AURDEST> environment variable, it should always be set to a persistent location.

=item B

Packages requiring user input while building are not supported and might fail to install properly. There is currently no official directive about these interactive PKGBUILDs, but some of the official pacman developers expressed the opinion that PKGBUILDs should always provide default compilation options.

=item B

If a lot of "Could not connect to the AUR" and "Timeout was reached" messages are displayed while searching or requesting info for packages despite the internet connection working correctly, ensure your local I is correctly configured to improve name lookups. Using Google's primary DNS (8.8.8.8 and 8.8.4.4) might also help.

=back

=head1 SEE ALSO

B(1), B(8), B(8), B(5)

=head1 CURRENT MAINTAINER

E5ten Elt>e5ten.arch@gmail.comE<gt

https://github.com/E5ten/pacaur

=head1 ORIGINAL AUTHOR

Remy Marquis Elt>remy.marquis@gmail.comE<gt

If you feel great pity for the present maintainer that has to constantly cope with users that don't want to read man pages and refuse to take responsibility for their own system, you can send me funny cat pictures. Alternatively, you can send a donation via PayPal to the above email address.

I would also suggest to donate to a charitable organization of your choice should you believe that your money could make a bigger difference there. Thank you!

Absolutely B is provided, unless you are ready to pay for it.

All credits go to all direct or indirect contributors. Many thanks to all of you!

=head1 TRANSLATORS

B<[ca] - Català> - Alex "alexhenrie" Henrie

B<[da] - Dansk> - Filip "filipkemuel" Kemuel

B<[de] - Deutsch> - Marco "BigBoot" Kirchner, "HerrNieschnell", "pszalanski", Stefan "rumpelsepp" Tatschner, Tilman "Tblue" Blumenbach

B<[es] - Español> - Germán "gosella" Osella Massa, Ismael "ChuckDaniels87" González, Pablo "jristz" Lezaeta Reyes

B<[fi] - Suomi> - "durazell"

B<[fr] - Français> - "spider-mario", "Neitsab", Antoine "Nevax07" Gravelot

B<[hu] - Magyar> - "avelkei"

B<[it] - Italiano> - Demenico "NoMore201" Lezzi, Giovanni "ItachiSan" Santini

B<[ja] - 日本語> - Colin "fosskers" Woodbury, TSUYUSATO "MakeNowJust" Kitsune

B<[nl] - Nederlands> - "Yoshi2889", Willem "14mRh4X0r" Mulder

B<[pl] - Polski> - Tomasz "Ludvick" Niedzielski

B<[pt] - Português> - Thiago "thiagowfx" Barroso Perrotta, Rafael "rccavalcanti" Cavalcanti

B<[ru] - Русский> - "kyak"

B<[sk] - Slovenčina> - Pavol "pakapusta" Kapusta, Juraj "DoctorJellyface" Fiala

B<[sl] - Slovenščina> - Žan "tofiffe" Skamljič

B<[sr] - Српски / srpski> - Slobodan "Faenriis" Terzić

B<[tr] - Türkçe> - Volkan "wakeup" Gezer

B<[zh_CN] - 简体中文> - "Victorique "victoriqueko" Ko, kizayoi"