apacman.8

'\" t
.\"     Title: apacman
.\"    Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 10/12/2016
.\"    Manual: apacman Manual
.\"    Source: apacman
.\"  Language: English
.\"
.TH "APACMAN" "8" "10/12/2016" "apacman" "apacman Manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
apacman \- AUR wrapper forked from packer
.SH "SYNOPSIS"
.sp
\fIapacman\fR <operation> [options] [packages]
.SH "DESCRIPTION"
.sp
apacman is a bash wrapper forked from packer for pacman and the ArchLinux User Repository (AUR)\&. It adds package saving functionality and some extra
pass-through options for makepkg and pacman.
.SH "OPERATIONS"
.PP
\fB\-Ss\fR
.RS 4
Search for a package\&.
.RE
.PP
\fB\-S\fR
.RS 4
Install a package\&.
.RE
.PP
\fB\-Syu\fR
.RS 4
Sync with repositories\&.
.RE
.PP
\fB\-Si\fR
.RS 4
Show information for a package\&.
.RE
.PP
\fB\-G\fR
.RS 4
Download and extract ABS and AUR package tarballs, but don\(cqt install anything\&.
.RE
.PP
\fB\-L\fR
.RS 4
List installed packages by size (replacement for \fIpacsysclean\fR command)\&.
.RE
.PP
\fB\-P, \-\-pkgfile\fR
.RS 4
Patched AUR passthrough for \fIpkgfile\fR command\&.
.RE
.PP
\fB\-W\fR
.RS 4
View AUR comments\&.
.RE
.PP
\fB\-V\fR
.RS 4
Show apacman version\&.
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Show enabled options\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
Show apacman usage\&.
.RE
.SH "OPTIONS"
.PP
\fB\-\-auronly\fR
.RS 4
Only perform commands for the AUR\&.
.RE
.PP
\fB\-\-buildonly\fR
.RS 4
Build packages but do not install them then post\-install remove unneeded build makedepends\&.
.PP
\fBNote:\fR list of package filenames stored in \fI$tmpdir/bundle\&.lst\fB
.RE
.PP
\fB\-\-config\fR \fIfilename\fR, \fB\-\-config=\fR\fIfilename\fR
.RS 4
Use alternate configuration file\&.
.RE
.PP
\fB\-\-cachevcs\fR
.RS 4
installs cached VCS (git, svn, hg) packages newer than AUR PKGBUILDs\&.
.RE
.PP
\fB\-\-devel\fR
.RS 4
Update development packages\&. (cvs, git\&...)
.RE
.PP
\fB\-\-edit\fR
.RS 4
Always ask to edit PKGBUILD (overrides 'noedit' option)\&.
.RE
.PP
\fB\-\-gendb\fR
.RS 4
Generate AUR local package database\&.
.RE
.PP
\fB\-\-ignore\fR \fIpackage\fR, \fB\-\-ignore=\fR\fIpkg1\fR,\fIpkg2\fR,\fIpkg3\fR
.RS 4
Ignore packages\&. Separate package names with a comma\&.
.RE
.PP
\fB\-\-ignorearch\fR
.RS 4
ignores architectures specified in PKGBUILD\&.
.RE
.PP
\fB\-\-keepkeys\fR
.RS 4
Do not remove imported PGP keys\&.
.RE
.PP
\fB\-\-legacy\fR
.RS 4
Use AUR3 repo rather than default AUR4 (deprecated)\&.
.RE
.PP
\fB\-\-needed\fR
.RS 4
Does not install up-to-date packages\&.
.RE
.PP
\fB\-\-noaur\fR
.RS 4
Do not perform commands for the AUR\&.
.RE
.PP
\fB\-\-noconfirm\fR
.RS 4
Perform commands without confirmation from the user\&.
.RE
.PP
\fB\-\-nodatabase\fR
.RS 4
Do not store AUR database\&.
.RE
.PP
\fB\-\-noedit\fR
.RS 4
Perform commands without asking if the user wants to edit any installation files\&.
.RE
.PP
\fB\-\-nofail\fR
.RS 4
Immediately quit if any package does not build successfully\&.
.RE
.PP
\fB\-\-noprogress\fR
.RS 4
Do not replace terminal title with transaction status\&.
.RE
.PP
\fB\-\-nosource\fR
.RS 4
Do not source PKGBUILDs, for security reasons (WIP)\&.
.RE
.PP
\fB\-\-notify\fR
.RS 4
Notification via \fInotify\-send\fR with transaction status\&.
.RE
.PP
\fB\-\-preview\fR
.RS 4
Always offer to edit the pkgbuild before sourcing it\&.
.RE
.PP
\fB\-\-progress\fR
.RS 4
Terminal title transaction status\&.
.RE
.PP
\fB\-\-purgebuild\fR
.RS 4
Post\-install remove unneeded build makedepends\&.
.RE
.PP
\fB\-\-purgekeys\fR
.RS 4
Remove trusted PGP keys\&.
.RE
.PP
\fB\-\-quickcheck\fR
.RS 4
Check for updates and exit\&.
.RE
.PP
\fB\-\-quiet\fR
.RS 4
Turn off package descriptions\&.
.RE
.PP
\fB\-\-savedir\fR \fIdirectory\fR, \fB\-\-savedir=\fR\fIdirectory\fR
.RS 4
Use alternate cache directory\&.
.RE
.PP
\fB\-\-skipcache\fR
.RS 4
skips check for pre-built package in cache directory\&.
.RE
.PP
\fB\-\-skipinteg\fR
.RS 4
Skip the integrity check by ignoring AUR package MD5 sums\&.
.RE
.PP
\fB\-\-skiptest\fR
.RS 4
Avoid install of check unit test packages\&.
.RE
.PP
\fB\-\-warn\fR
.RS 4
Treat errors as non-fatal warnings (only enable if you are know what you are doing\&.)
.RE
.SH "INTERACTIVE MODE"
.sp
Use apacman without any operations or options to use the interactive mode\&. apacman will show a numbered list of search results\&. To install a package, enter the corresponding number\&.
.SH "EXAMPLE USAGE"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Sync and update all packages:
apacman \-Syu
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update only AUR packages:
apacman \-Syu \-\-auronly
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update, and reinstall packages that were installed from a revision control source:
apacman \-Syu \-\-devel
.RE
.sp
For a package called \fIname\fR:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Search:
apacman \-Ss \fIname\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Install:
apacman \-S \fIname\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Install without confirmations:
apacman \-S \-\-noconfirm \fIname\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Get information about a package:
apacman \-Si \fIname\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Search and install in interactive mode:
apacman \fIname\fR
.RE
.SH "CONFIGURATION"
.sp
apacman defaults to saving succesfully built packages to /var/cache/apacman/pkg.
.sp
apacman uses the AUR package cache directory if applicable (unless \-\-skipcache parameter)
.sp
By default VCS package versions are compared via PKGBUILD in AUR (unless \-\-cachevcs parameter)
.sp
apacman output will be colorized unless the environmental variable COLOR is set to `NO'.
.sp
To manually edit files, apacman uses the EDITOR variable\&. If EDITOR is not set then the default editor is vi\&.
.sp
Packages are built in the TMPDIR path\&. If the TMPDIR variable is not set then the default path is /tmp
.sp
Default configuration file:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
/etc/apacman\&.conf
.RE
.sp
These settings are used from /etc/pacman\&.conf:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
IgnorePkg
.RE
.SH EXIT CODES
.sp
There are several possible exit status codes, useful for scripting or debugging listed below.
.sp
Note: apacman<=3.0 only uses 0 for success, 1 for fail.
.IP 0
Success
.IP 1
Miscellaneous errors
.IP 2
Invalid parameters
.IP 3
Fatal errors, not warnings
.IP 4
No package matches found
.IP 5
Package does not exist
.IP 6
No internet connection
.IP 7
No free space in tmpfs
.IP 8
One or more package(s) failed to build, keep going
.IP 9
One package failed to build, do not continue
.IP 10
Permission problem \-\- fakeroot
.IP 11
Permission problem \-\- root user
.IP 12
Permission problem \-\- sudo
.IP 13
Permission problem \-\- su
.RE
.SH "SEE ALSO"
.sp
\fBapacman.conf\fR(5)
.sp
\fBpacman\fR(8)
.sp
\fBpkgfile\fR(1)
.sp
\fBpacker\fR(8)

.SH "AUTHORS"
.sp
OS Hazard <oshazard+apacman@gmail\&.com>
.sp
Matthew Bruenig <matthewbruenig@gmail\&.com>