Difference between revisions of "Arch User Repository"

From ArchWiki
Jump to navigation Jump to search
m (Submitting packages: improve AUR ML link and minor reword of same sentence)
m (make it clear that those are not steps, but options for one step.)
 
(526 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
[[Category:Arch User Repository]]
+
[[Category:About Arch]]
 
[[Category:Package development]]
 
[[Category:Package development]]
 
[[Category:Package management]]
 
[[Category:Package management]]
Line 8: Line 8:
 
[[el:Arch User Repository]]
 
[[el:Arch User Repository]]
 
[[es:Arch User Repository]]
 
[[es:Arch User Repository]]
[[fi:AUR]]
 
 
[[fr:AUR]]
 
[[fr:AUR]]
 
[[it:Arch User Repository]]
 
[[it:Arch User Repository]]
Line 15: Line 14:
 
[[pl:Arch User Repository]]
 
[[pl:Arch User Repository]]
 
[[pt:Arch User Repository]]
 
[[pt:Arch User Repository]]
[[ro:AUR]]
 
 
[[ru:Arch User Repository]]
 
[[ru:Arch User Repository]]
 
[[sr:Arch User Repository]]
 
[[sr:Arch User Repository]]
[[tr:Arch_Kullanıcı_Deposu]]
+
[[zh-hans:Arch User Repository]]
[[uk:Arch User Repository]]
+
[[zh-hant:Arch User Repository]]
[[zh-CN:Arch User Repository]]
 
 
{{Related articles start}}
 
{{Related articles start}}
{{Related|AUR Helpers}}
 
{{Related|AurJson}}
 
{{Related|AUR Trusted User Guidelines}}
 
{{Related|PKGBUILD}}
 
 
{{Related|makepkg}}
 
{{Related|makepkg}}
 
{{Related|pacman}}
 
{{Related|pacman}}
{{Related|Official Repositories}}
+
{{Related|PKGBUILD}}
 +
{{Related|.SRCINFO}}
 +
{{Related|Aurweb RPC interface}}
 +
{{Related|AUR Trusted User Guidelines}}
 +
{{Related|Official repositories}}
 
{{Related|Arch Build System}}
 
{{Related|Arch Build System}}
 +
{{Related|Creating packages}}
 +
{{Related|AUR helpers}}
 
{{Related articles end}}
 
{{Related articles end}}
  
The Arch User Repository (AUR) is a community-driven repository for Arch users. It contains package descriptions ([[PKGBUILD]]s) that allow you to compile a package from source with [[makepkg]] and then install it via [[pacman]]. The AUR was created to organize and share new packages from the community and to help expedite popular packages' inclusion into the [[#community|community]] repository. This document explains how users can access and utilize the AUR.
+
The Arch User Repository (AUR) is a community-driven repository for Arch users. It contains package descriptions ([[PKGBUILD]]s) that allow you to compile a package from source with [[makepkg]] and then install it via [[pacman#Additional commands|pacman]]. The AUR was created to organize and share new packages from the community and to help expedite popular packages' inclusion into the [[community repository]]. This document explains how users can access and utilize the AUR.
  
A good number of new packages that enter the official repositories start in the AUR.  In the AUR, users are able to contribute their own package builds (PKGBUILD and related files). The AUR community has the ability to vote for or against packages in the AUR.  If a package becomes popular enough — provided it has a compatible license and good packaging technique — it may be entered into the ''community'' repository (directly accessible by [[pacman]] or [[ABS|abs]]).
+
A good number of new packages that enter the official repositories start in the AUR.  In the AUR, users are able to contribute their own package builds (PKGBUILD and related files). The AUR community has the ability to vote for packages in the AUR.  If a package becomes popular enough — provided it has a compatible license and good packaging technique — it may be entered into the ''community'' repository (directly accessible by [[pacman]] or [[abs]]).
 +
 
 +
{{Warning|AUR packages are user produced content with no official support. Any use of the provided files is at your own risk.}}
  
 
== Getting started ==
 
== Getting started ==
  
Users can search and download PKGBUILDs from the [https://aur.archlinux.org AUR Web Interface]. These PKGBUILDs can be built into installable packages using [[makepkg]], then installed using pacman.
+
Users can search and download PKGBUILDs from the [https://aur.archlinux.org AUR Web Interface]. These PKGBUILDs can be built into installable packages using [[makepkg]], then installed using pacman.
  
* Ensure the {{Grp|base-devel}} group package is installed ({{ic|pacman -S --needed base-devel}}).
+
* Ensure the {{Grp|base-devel}} package group is installed in full ({{ic|pacman -S --needed base-devel}}).
* Read the remainder of this article for more info and a short tutorial on installing AUR packages.
 
* Visit the [https://aur.archlinux.org AUR Web Interface] to inform yourself on updates and happenings. There you will also find statistics and an up-to-date list of newest available packages available in AUR.
 
 
* Glance over the [[#FAQ]] for answers to the most common questions.
 
* Glance over the [[#FAQ]] for answers to the most common questions.
* You may wish to adjust {{ic|/etc/makepkg.conf}} to better optimize for your processor prior to building packages from the AUR.  A significant improvement in compile times can be realized on systems with multi-core processors by adjusting the MAKEFLAGS variable. Users can also enable hardware-specific optimizations in GCC via the CFLAGS variable.  See [[makepkg.conf]] for more information.
+
* You may wish to adjust {{ic|/etc/makepkg.conf}} to optimize for your processor prior to building packages from the AUR.  A significant improvement in compile times can be realized on systems with multi-core processors by adjusting the MAKEFLAGS variable. Users can also enable hardware-specific optimizations in GCC via the CFLAGS variable.  See [[makepkg]] for more information.
 +
 
 +
It is also possible to interact with the AUR through SSH: type {{ic|ssh aur@aur.archlinux.org help}} for a list of available commands.
  
 
== History ==
 
== History ==
  
The following items are listed for historical purposes only. They have since been superseded by the AUR and are no longer available.
+
In the beginning, there was {{ic|<nowiki>ftp://ftp.archlinux.org/incoming</nowiki>}}, and people contributed by simply uploading the PKGBUILD, the needed supplementary files, and the built package itself to the server. The package and associated files remained there until a [[Package Maintainer]] saw the program and adopted it.
 
 
At the beginning, there was {{ic|<nowiki>ftp://ftp.archlinux.org/incoming</nowiki>}}, and people contributed by simply uploading the PKGBUILD, the needed supplementary files, and the built package itself to the server. The package and associated files remained there until a [[Package Maintainer]] saw the program and adopted it.
 
  
 
Then the Trusted User Repositories were born. Certain individuals in the community were allowed to host their own repositories for anyone to use. The AUR expanded on this basis, with the aim of making it both more flexible and more usable. In fact, the AUR maintainers are still referred to as TUs (Trusted Users).
 
Then the Trusted User Repositories were born. Certain individuals in the community were allowed to host their own repositories for anyone to use. The AUR expanded on this basis, with the aim of making it both more flexible and more usable. In fact, the AUR maintainers are still referred to as TUs (Trusted Users).
  
== Searching ==
+
Between 2015-06-08 and 2015-08-08 the AUR transitioned from version 3.5.1 to 4.0.0, introducing the use of Git repositories for publishing the PKGBUILDs.
 +
Existing packages were dropped unless manually migrated to the new infrastructure by their maintainers.
  
The AUR web interface can be found [https://aur.archlinux.org/ here], and an interface suitable for accessing the AUR from a script (for example) can be found [https://aur.archlinux.org/rpc.php here].
+
=== Git repositories for AUR3 packages ===
  
Queries search package names and descriptions via a MySQL LIKE comparison. This allows for more flexible search criteria (e.g. try searching for 'tool%like%grep' instead of 'tool like grep'). If you need to search for a description that contains '%', escape it with '\%'.
+
The [https://github.com/aur-archive AUR Archive] on GitHub has a repository for every package that was in AUR 3 at the time of the migration.
 +
Alternatively, there is the [https://github.com/felixonmars/aur3-mirror/ aur3-mirror] repository which provides the same.
  
 
== Installing packages ==
 
== Installing packages ==
 +
Installing packages from the AUR is a relatively simple process. Essentially:
 +
 +
# Acquire the build files, including the [[PKGBUILD]] and possibly other required files, like [[systemd]] units and patches (often not the actual code).
 +
# Verify that the [[PKGBUILD]] and accompanying files are not malicious or untrustworthy.
 +
# Run {{ic|makepkg -si}} in the directory where the files are saved. This will download the code, resolve the dependencies with [[pacman]], compile it, package it, and install the package.
 +
 +
{{Note|The AUR is unsupported, so any packages you install are ''your responsibility'' to update, not pacman's. If packages in the official repositories are updated, you will need to rebuild any AUR packages that depend on those libraries.}}
 +
=== Prerequisites ===
 +
 +
First ensure that the necessary tools are installed by [[install]]ing the {{grp|base-devel}} group in full which includes {{pkg|make}} and other tools needed for compiling from source.
 +
 +
{{Note|Packages in the AUR assume that the {{grp|base-devel}} group is installed, i.e. they do not list the group's members as dependencies explicitly.}}
 +
 +
Next choose an appropriate build directory. A build directory is simply a directory where the package will be made or "built" and can be any directory. The examples in the following sections will use {{ic|~/builds}} as the build directory.
 +
 +
=== Acquire build files ===
 +
 +
Locate the package in the AUR. This is done using the search field at the top of the [https://aur.archlinux.org/ AUR home page]. Clicking the application's name in the search list brings up an information page on the package. Read through the description to confirm that this is the desired package, note when the package was last updated, and read any comments.
 +
 +
There are several methods for acquiring the build files:
 +
 +
* Option 1: Clone the [[git]] repository that is labelled as the "Git Clone URL" in the "Package Details". This is the preferred method.
 +
 +
$ git clone <nowiki>https://aur.archlinux.org/</nowiki>''package_name''.git
 +
 +
:An advantage of this method is that you can easily get updates to the package via {{ic|git pull}}.
 +
 +
* Option 2: Download the build files with your web browser by clicking the "Download snapshot" link under "Package Actions" on the right hand side. This will download a compressed file, which must be extracted (preferably in a directory set aside for AUR builds)
 +
 +
$ tar -xvf ''package_name''.tar.gz
 +
* Similarly, you can download a tarball from the terminal (and extract it):
 +
 +
$ curl -L -O <nowiki>https://aur.archlinux.org/cgit/aur.git/snapshot/</nowiki>''package_name''.tar.gz
 +
 +
=== Build and install the package ===
 +
 +
Change directories to the directory containing the package's [[PKGBUILD]].
 +
 +
$ cd ''package_name''
  
Installing packages from the AUR is a relatively simple process. Essentially:
+
{{Warning|Carefully check the [[PKGBUILD]], any ''.install'' files, and any other files in the package's git repository for malicious or dangerous commands. If in doubt, do not build the package, and [[General_troubleshooting#Additional_support|seek advice]] on the forums or mailing list. Malicious code has been found in packages before. [https://lists.archlinux.org/pipermail/aur-general/2018-July/034151.html]}}
  
# Acquire the tarball which contains the [[PKGBUILD]] and possibly other required files, like systemd-units and patches (but often not the actual code).
+
View the contents of all provided files. For example, to use the pager ''less'' to view {{ic|PKGBUILD}} do:
# Extract the tarball (preferably in a folder set aside just for builds from the AUR) with {{ic|tar -xzf foo.tar.gz}}.
 
# Run {{ic|makepkg}} in the directory where the files are saved ({{ic|makepkg -s}} will automatically resolve dependencies with pacman). This will download the code, compile it and pack it.
 
# Look for a README file in {{ic|src/}}, as it might contain information needed later on.
 
# Install the resulting package with [[pacman]]:
 
  
: {{bc|# pacman -U /path/to/pkg.tar.xz}}
+
$ less PKGBUILD
  
[[AUR Helpers]] add seamless access to the AUR. They vary in their features but can ease in searching, fetching, building, and installing from PKGBUILDs found in the AUR. All of these scripts can be found in the AUR.
+
{{Tip|If you are updating a package, you may want to look at the changes since the last commit.
 +
* To view changes since the last git commit you can use {{ic|git show}}.
 +
* To view changes since the last commit using ''vimdiff'', do {{ic|git difftool @~..@ vimdiff}}. The advantage of ''vimdiff'' is that you view the entire contents of each file along with indicators on what has changed.}}
  
{{Note|There is not and will never be an ''official'' mechanism for installing build material from the AUR. '''All AUR users should be familiar with the build process.'''}}
+
Make the package. After manually confirming the contents of the files, run [[makepkg]] as a normal user:
  
=== Prerequisites ===
+
$ makepkg -si
  
First ensure that the necessary tools are installed. The package group {{grp|base-devel}} should be sufficient; it includes {{pkg|make}} and other tools needed for compiling from source.
+
* {{ic|-s}}/{{ic|--syncdeps}} automatically resolves and installs any dependencies with [[pacman]] before building. If the package depends on other AUR packages, you will need to manually install them first.
 +
* {{ic|-i}}/{{ic|--install}} installs the package if it is built successfully. Alternatively the built package can be installed with {{ic|pacman -U ''package''.pkg.tar.xz}}.
  
{{Warning|Packages in the AUR assume the {{grp|base-devel}} group is installed, and AUR packages will not list members of this group as dependencies even if the package cannot be built without them. Please ensure this group is installed before complaining about failed builds.}}
+
Other useful flags are
  
# pacman -S --needed base-devel
+
* {{ic|-r}}/{{ic|--rmdeps}} removes build-time dependencies after the build, as they are no longer needed. However these dependencies may need to be reinstalled the next time the package is updated.
 +
* {{ic|-c}}/{{ic|--clean}} cleans up temporary build files after the build, as they are no longer needed. These files are usually needed only when debugging the build process.
  
Next choose an appropriate build directory. A build directory is simply a directory where the package will be made or "built" and can be any directory. Examples of commonly used directories are:
+
{{Note|The above example is only a brief summary of the build process. It is '''highly''' recommended to read the [[makepkg]] and [[ABS]] articles for more details.}}
  
~/builds
+
== Feedback ==
  
or if using ABS (the [[Arch Build System]]):
+
The [https://aur.archlinux.org AUR Web Interface] has a comments facility that allows users to provide suggestions and feedback on improvements to the PKGBUILD contributor. Avoid pasting patches or PKGBUILDs into the comments section: they quickly become obsolete and just end up needlessly taking up lots of space. Instead email those files to the maintainer, or even use a [[pastebin]].
  
/var/abs/local
+
One of the easiest activities for '''all''' Arch users is to browse the AUR and '''vote''' for their favourite packages using the online interface. All packages are eligible for adoption by a TU for inclusion in the [[community repository]], and the vote count is one of the considerations in that process; it is in everyone's interest to vote!
  
For more information on ABS read the [[Arch Build System]] article. The example will use {{ic|~/builds}} as the build directory.
+
== Sharing and maintaining packages ==
  
=== Acquire build files ===
+
{{Note|1=Please see [https://wiki.archlinux.org/index.php?title=Talk:Arch_User_Repository&oldid=484964#Scope_of_the_AUR4_section Talk:Arch User Repository#Scope of the AUR4 section] before making changes to this section.}}
 +
 
 +
Users can '''share''' PKGBUILDs using the Arch User Repository.  It does not contain any binary packages but allows users to upload PKGBUILDs that can be downloaded by others. These PKGBUILDs are completely unofficial and have not been thoroughly vetted, so they should be used at your own risk.
  
Locate the package in the AUR. This is done using the search feature (text field at the top of the [https://aur.archlinux.org/ AUR home page]). Clicking the application's name in the search list brings up an information page on the package. Read through the description to confirm that this is the desired package, note when the package was last updated, and read any comments.
+
=== Submitting packages ===
  
Download the necessary build files by clicking on the "Download tarball" link under "Package actions" on the right hand side. This file should be saved to the build directory or otherwise copied to the directory after downloading. In this example, the file is called "foo.tar.gz" (standard format is ''pkgname''.tar.gz, if it has been properly submitted).
+
{{Warning|Before attempting to submit a package you are expected to familiarize yourself with [[Arch packaging standards]] and all the articles under "Related articles". '''Verify carefully''' that what you are uploading is correct. Packages that violate the rules may be '''deleted''' without warning.}}
  
Alternatively you can download the tarball from the terminal, changing directories to the build directory first:
+
If you are unsure in any way about the package or the build/submission process even after reading this section twice, submit the PKGBUILD to the [https://mailman.archlinux.org/mailman/listinfo/aur-general AUR mailing list], the [https://bbs.archlinux.org/viewforum.php?id=4 AUR forum] on the Arch forums, or ask on our [[IRC channel]] for public review before adding it to the AUR.
  
$ cd ~/builds
+
==== Rules of submission ====
$ curl -O <nowiki>https://aur.archlinux.org/packages/fo/foo/foo.tar.gz</nowiki>
 
  
=== Build the package ===
+
When submitting a package to the AUR, observe the following rules:
  
Change directories to the build directory if not already there, then extract the previously downloaded package:
+
* The submitted PKGBUILDs must not build applications '''already in any''' of the '''official''' binary '''repositories''' under any circumstances. Check the [https://www.archlinux.org/packages/ official package database] for the package. If any version of it exists, '''do not''' submit the package. If the official package is out-of-date, flag it as such. If the official package is broken or is lacking a feature, then please file a [https://bugs.archlinux.org/ bug report].
 +
:'''Exception''' to this strict rule may only be packages having '''extra features''' enabled and/or '''patches''' in comparison to the official ones. In such an occasion the {{ic|pkgname}} should be different to express that difference. For example, a package for GNU screen containing the sidebar patch could be named {{ic|screen-sidebar}}. Additionally the {{ic|1=provides=('screen')}} array should be used in order to avoid conflicts with the official package.
  
$ cd ~/builds
+
* '''Check the AUR''' if the package '''already exists'''. If it is currently maintained, changes can be submitted in a comment for the maintainer's attention. If it is unmaintained or the maintainer is unresponsive, the package can be adopted and updated as required. Do not create duplicate packages.
$ tar -xvzf foo.tar.gz
 
  
This should create a new directory called "foo" in the build directory.
+
* Make sure the package you want to upload is '''useful'''. Will anyone else want to use this package? Is it extremely specialized? If more than a few people would find this package useful, it is appropriate for submission.
  
{{Warning|'''Carefully check all files.''' {{ic|cd}} to the newly created directory and carefully check the {{ic|PKGBUILD}} and any {{ic|.install}} file for malicious commands. {{ic|PKGBUILD}}s are bash scripts containing functions to be executed by {{ic|makepkg}}: these functions can contain ''any'' valid commands or Bash syntax, so it is totally possible for a {{ic|PKGBUILD}} to contain dangerous commands through malice or ignorance on the part of the author. Since {{ic|makepkg}} uses fakeroot (and should never be run as root), there is some level of protection but you should never count on it. If in doubt, do not build the package and seek advice on the forums or mailing list.}}
+
:The AUR and official repositories are intended for packages which install generally software and software-related content, including one or more of the following: executable(s); config file(s); online or offline documentation for specific software or the Arch Linux distribution as a whole; media intended to be used directly by software.
  
$ cd foo
+
* Do not use {{ic|replaces}} in an AUR PKGBUILD unless the package is to be renamed, for example when ''Ethereal'' became ''Wireshark''. If the package is an '''alternate version of an already existing package''', use {{ic|conflicts}} (and {{ic|provides}} if that package is required by others). The main difference is: after syncing (-Sy) pacman immediately wants to replace an installed, 'offending' package upon encountering a package with the matching {{ic|replaces}} anywhere in its repositories; {{ic|conflicts}}, on the other hand, is only evaluated when actually installing the package, which is usually the desired behavior because it is less invasive.
$ nano PKGBUILD
 
$ nano foo.install
 
  
Make the package. After manually confirming the integrity of the files, run [[makepkg]] as a normal user.
+
* Submitting '''binaries''' should be '''avoided''' if the sources are available. The AUR should not contain the binary tarball created by makepkg, nor should it contain the filelist.
  
$ makepkg -s
+
* Please add a '''comment line''' to the top of the {{ic|PKGBUILD}} file which contains information about the current '''maintainers''' and previous '''contributors''', respecting the following format. Remember to disguise your email to protect against spam. Additional or unneeded lines are facultative.
 +
:If you are assuming the role of maintainer for an existing PKGBUILD, add your name to the top like this
 +
:{{bc|<nowiki>
 +
# Maintainer: Your Name <address at domain dot tld>
 +
</nowiki>}}
 +
:If there were previous maintainers, put them as contributors. The same applies for the original submitter if this is not you. If you are a co-maintainer, add the names of the other current maintainers as well.
 +
:{{bc|<nowiki>
 +
# Maintainer: Your name <address at domain dot tld>
 +
# Maintainer: Other maintainer's name <address at domain dot tld>
 +
# Contributor: Previous maintainer's name <address at domain dot tld>
 +
# Contributor: Original submitter's name <address at domain dot tld>
 +
</nowiki>}}
  
The {{ic|-s}} switch will use [[sudo]] to install any needed dependencies. If the use of sudo is undesirable, manually install required dependencies beforehand and exclude the {{ic|-s}} in the above command.
+
==== Authentication ====
  
=== Install the package ===
+
For write access to the AUR, you need to have an [[SSH keys|SSH key pair]]. The content of the public key needs to be copied to your profile in ''My Account'', and the corresponding private key configured for the {{ic|aur.archlinux.org}} host. For example:
  
Install the package using pacman. A tarball should have been created named:
+
{{hc|~/.ssh/config|
 +
Host aur.archlinux.org
 +
  IdentityFile ~/.ssh/aur
 +
  User aur}}
  
<''application name''>-<''application version number''>-<''package revision number''>-<''architecture''>.pkg.tar.xz
+
You should [[SSH_keys#Generating_an_SSH_key_pair|create a new key pair]] rather than use an existing one, so that you can selectively revoke the keys should something happen:
  
This package can be installed using pacman's "upgrade" command:
+
$ ssh-keygen -f ~/.ssh/aur
  
# pacman -U foo-0.1-1-i686.pkg.tar.xz 
+
{{Tip|You can add multiple public keys to your profile by separating them with a newline in the input field.}}
  
These manually installed packages are called foreign packages &mdash; packages which have not originated from any repository known to pacman. To list all foreign packages:
+
==== Creating package repositories ====
$ pacman -Qm
 
  
{{Note|The above example is only a brief summary of the package building process. A visit to the [[makepkg]] and [[Arch Build System|ABS]] pages will provide more detail and is highly recommended, especially for first-time users.}}
+
If you are [[Creating_packages|creating a new package]] from scratch, establish a local Git repository and an AUR remote by [[Git#Getting_a_Git_repository|cloning]] the intended [[PKGBUILD#pkgbase|pkgbase]]. If the package does not yet exist, the following warning is expected:
  
== Feedback ==
+
{{hc|$ git clone <nowiki>ssh://</nowiki>aur@aur.archlinux.org/''pkgbase''.git|
 +
Cloning into &apos;''pkgbase''&apos;...
 +
warning: You appear to have cloned an empty repository.
 +
Checking connectivity... done.}}
  
The [https://aur.archlinux.org AUR Web Interface] has a comments facility that allows users to provide suggestions and feedback on improvements to the PKGBUILD contributor. Avoid pasting patches or PKGBUILDs into the comments section: they quickly become obsolete and just end up needlessly taking up lots of space. Instead email those files to the maintainer, or even use a [[pastebin Clients|pastebin]].
+
{{Note|The repository will not be empty if {{ic|''pkgbase''}} matches a [[#Deletion|deleted]] package.}}
  
One of the easiest activities for '''all''' Arch users is to browse the AUR and '''vote''' for their favourite packages using the online interface. All packages are eligible for adoption by a TU for inclusion in [[#community|community]] repository, and the vote count is one of the considerations in that process; it is in everyone's interest to vote!
+
If you already have a package, [[Git#Getting_a_Git_repository|initialize it]] as a Git repository if it isn't one, and add an AUR remote:
  
== Sharing and maintaining packages ==
+
$ git remote add ''label'' <nowiki>ssh://</nowiki>aur@aur.archlinux.org/''pkgbase''.git
  
The user plays an essential role in the AUR, which cannot fulfill its potential without the support, involvement, and contribution of the wider user community.  The life-cycle of an AUR package starts and ends with the user and requires the user to contribute in several ways.
+
Then [[Git#Using remotes|fetch]] this remote to initialize it in the AUR.
  
Users can '''share''' PKGBUILDs using the Arch User Repository.  It does not contain any binary packages but allows users to upload PKGBUILDs that can be downloaded by others. These PKGBUILDs are completely unofficial and have not been thoroughly vetted, so they should be used at your own risk.
+
{{Note|[https://git-scm.com/docs/git-pull#git-pull---rebasefalsetruemergespreserveinteractive Pull and rebase] to resolve conflicts if {{ic|''pkgbase''}} matches a deleted package.}}
  
=== Submitting packages ===
+
==== Publishing new package content ====
  
After logging in to the AUR web interface, a user can [https://aur.archlinux.org/pkgsubmit.php submit] a gzipped tarball ({{ic|.tar.gz}}) of a directory containing build files for a package. The directory inside the tarball should contain a [[PKGBUILD]], any {{ic|.install}} files, patches, etc. ('''absolutely''' no binaries). Examples of what such a directory should look like can be seen inside {{ic|/var/abs}} if the [[Arch Build System]] was installed.
+
{{Warning|Your commits will be authored with your [[Git#Configuration|global Git name and email address]]. It is very difficult to change commits after pushing them ({{Bug|45425}}). If you want to push to the AUR under different credentials, you can change them per package with {{ic|git config user.name "..."}} and {{ic|git config user.email "..."}}.}}
  
The tarball can be created with the following command:
+
To upload or update a package [[Git#Staging_changes|add]] ''at least'' [[PKGBUILD]] and [[.SRCINFO]] then any new or modified [[PKGBUILD#install|.install]] files, [[Patching_packages|patches]] or other [[PKGBUILD#source|local source files]]; [[Git#Commiting_changes|commit]] with a meaningful commit message, and finally [[Git#Push_to_a_repository|push]] the changes to the AUR.
  
$ makepkg --source
+
{{Tip|To keep the working directory and commits as clean as possible, create a {{man|5|gitignore}} that excludes all files and force-add files as needed.}}
  
Note that this is a gzipped tarball; assuming you are uploading a package called ''libfoo'', when you create the file it should look similar to this:
+
For example:
 
{{hc|$ tar tf libfoo-0.1-1.src.tar.gz|
 
libfoo/
 
libfoo/PKGBUILD
 
libfoo/libfoo.install}}
 
  
When submitting a package, observe the following rules:
+
$ makepkg --printsrcinfo > .SRCINFO
 +
$ git add -f PKGBUILD .SRCINFO
 +
$ git commit -m "''useful commit message''"
 +
$ git push
  
* Check the [https://www.archlinux.org/packages/ official package database] for the package. If '''any version''' of it exists, '''do not''' submit the package. If the official package is out of date, flag it. If the official package is broken or is lacking a feature then please file a [https://bugs.archlinux.org/ bug report].
+
{{Note|
* Check the AUR for the package. If it is currently maintained, changes can be submitted in a comment for the maintainer's attention. If it is unmaintained, the package can be adopted and updated as required. Do not create duplicate packages.
+
* After modifying a package, except for very minor changes (such as fixing a typo) that would not require re-installation of the package, update its [[PKGBUILD#Version|version]] accordingly.
* Verify carefully that what you are uploading is correct. All contributors must read and adhere to the [[Arch Packaging Standards]] when writing PKGBUILDs.  This is essential to the smooth running and general success of the AUR. Remember that you are not going to earn any credit or respect from your peers by wasting their time with a bad PKGBUILD.
+
* Regenerate {{ic|.SRCINFO}} after updating such {{ic|PKGBUILD}} metadata in order to publish it in the AUR.
* Packages that contain binaries or that are very poorly written may be deleted without warning.
+
* If {{ic|.SRCINFO}} was not added before your first commit, add it by [https://git-scm.com/docs/git-rebase#git-rebase---root rebasing with --root] or [https://git-scm.com/docs/git-filter-branch#git-filter-branch---tree-filterltcommandgt filtering the tree] so the AUR will permit your initial push.}}
* If you are unsure about the package (or the build/submission process) in any way, submit the PKGBUILD to the [https://mailman.archlinux.org/mailman/listinfo/aur-general AUR mailing list] or the [https://bbs.archlinux.org/viewforum.php?id=4 AUR forum] on the Arch forums for public review before adding it to the AUR.
 
* Make sure the package is useful. Will anyone else want to use this package? Is it extremely specialized? If more than a few people would find this package useful, it is appropriate for submission.
 
* The AUR and official repositories are intended for packages which install generally software and software-related content, including one or more of the following: executable(s); config file(s); online or offline documentation for specific software or the Arch Linux distribution as a whole; media intended to be used directly by software.
 
* Gain some experience before submitting packages. Build a few packages to learn the process and then submit.
 
* If you submit a {{ic|package.tar.gz}} with a file named '{{ic|package}}' in it you will get an error: 'Could not change to directory {{ic|/home/aur/unsupported/package/package}}'.  To resolve this, rename the file named '{{ic|package}}' to something else, for example, '{{ic|package.rc}}'.  When it is installed in the {{ic|pkg}} directory you may rename it back to '{{ic|package}}'. Make sure to also read [[Arch Packaging Standards#Submitting packages to the AUR]].
 
  
 
=== Maintaining packages ===
 
=== Maintaining packages ===
  
* If you maintain a package and want to update the PKGBUILD for your package just resubmit it.
 
 
* Check for feedback and comments from other users and try to incorporate any improvements they suggest; consider it a learning process!
 
* Check for feedback and comments from other users and try to incorporate any improvements they suggest; consider it a learning process!
 +
* Please do not leave a comment containing the version number every time you update the package. This keeps the comment section usable for valuable content mentioned above.
 
* Please do not just submit and forget about packages! It is the maintainer's job to maintain the package by checking for updates and improving the PKGBUILD.
 
* Please do not just submit and forget about packages! It is the maintainer's job to maintain the package by checking for updates and improving the PKGBUILD.
* If you do not want to continue to maintain the package for some reason, {{ic|disown}} the package using the AUR web interface and/or post a message to the AUR Mailing List.
+
* If you do not want to continue to maintain the package for some reason, {{ic|disown}} the package using the AUR web interface and/or post a message to the AUR Mailing List. If all maintainers of an AUR package disown it, it will become an [https://aur.archlinux.org/packages/?SB=n&do_Orphans=Orphans "orphaned"] package.
  
 
=== Other requests ===
 
=== Other requests ===
  
* Disownment requests and removal requests go to the [https://mailman.archlinux.org/mailman/listinfo/aur-general aur-general mailing list] for [[Trusted Users]] and other users to decide upon.
+
[[#Deletion|Deletion]], [[#Merge|merge]], and [[#Orphan|orphan]] requests can be created by clicking on the "Submit Request" link under "Package Actions" on the right hand side. This will send a notification email to the current maintainer and to the [https://mailman.archlinux.org/mailman/listinfo/aur-requests aur-requests mailing list] for discussion. A [[Trusted User]] will then either accept or reject the request.  
* '''Include package name and URL to AUR page''', preferably with a footnote [1].
 
* Disownment requests will be granted two weeks after the current maintainer has been contacted by email and did not react.
 
* '''Package merging has been implemented''', users still have to resubmit a package under a new name and may request merging of the old version's comments and votes on the mailing list.
 
* Removal requests require the following information:
 
** Package name and URL to AUR page
 
** Reason for deletion, at least a short note <br> '''Notice:''' A package's comments does not sufficiently point out the reasons why a package is up for deletion. Because as soon as a TU takes action, the only place where such information can be obtained is the aur-general mailing list.
 
** Include supporting details, like when a package is provided by another package, if you are the maintainer yourself, it is renamed and the original owner agreed, etc.
 
  
Removal requests can be disapproved, in which case you will likely be advised to disown the package for a future packager's reference.
+
==== Deletion ====
  
== community repository ==
+
You may request to ''unlist'' a {{ic|''pkgbase''}} from the AUR. A short note explaining the reason for deletion is required, as well as supporting details (like when a package is provided by another package, if you are the maintainer yourself, it is renamed and the original owner agreed, etc).
 +
{{Note|
 +
* It is not sufficient to explain why a package is up for deletion only in its comments because as soon as a TU takes action, the only place where such information can be obtained is the aur-requests mailing list.
 +
* Deletion requests can be rejected, in which case if you are the maintainer you will likely be advised to disown the package to allow adoption by another maintainer.
 +
* After a package is "deleted", its [[git]] repository remains available for [[Arch User Repository#Acquire build files|cloning]].}}
  
The ''community'' repository, maintained by [[Trusted Users]], contains the most popular packages from the AUR. It is enabled by default in {{ic|/etc/pacman.conf}}. If ''community'' has been disabled or removed, it can be enabled by uncommenting or adding these two lines:
+
==== Merge ====
  
{{hc|/etc/pacman.conf|2=
+
You may request to delete a {{ic|''pkgbase''}} and transfer its votes and comments to another {{ic|''pkgbase''}}. The name of the package to merge into is required.
...
+
{{Note|This has nothing to do with 'git merge' or GitLab's merge requests.}}
[community]
 
Include = /etc/pacman.d/mirrorlist
 
...}}
 
  
This repository, unlike the AUR, contains binary packages that can be installed directly with [[pacman]] and the build files can also be accessed with the [[Arch Build System|ABS]]. Some of these packages may eventually make the transition to the ''core'' or ''extra'' repositories as the developers consider them crucial to the distribution.
+
==== Orphan ====
  
Users can also access the ''community'' build files by editing {{ic|/etc/abs.conf}} and enabling the ''community'' repository in the {{ic|REPOS}} array.
+
You may request that a {{ic|''pkgbase''}} be disowned. These requests will be granted after two weeks if the current maintainer did not react.
  
== Git Repo ==
+
== Web interface translation ==
  
A  Git Repo of the AUR is maintained by Thomas Dziedzic providing package history among other things. It is updated at least once a day.  To clone the repository (several hundred MB):
+
See [https://projects.archlinux.org/aurweb.git/tree/doc/i18n.txt i18n.txt] in the AUR source tree for information about creating and maintaining translation of the AUR web interface.
  
$ git clone <nowiki>git://pkgbuild.com/aur-mirror.git</nowiki>
+
== Comment syntax ==
  
More informations: [http://pkgbuild.com/git/aur-mirror.git/ Web interface], [https://bbs.archlinux.org/viewtopic.php?id=113099 forum thread].
+
The [https://python-markdown.github.io/ Python-Markdown] syntax is supported in comments.
 +
It provides basic [[Wikipedia:Markdown|Markdown]] syntax to format comments. Note this implementation has some occasional [https://python-markdown.github.io/#differences differences] with the official [https://daringfireball.net/projects/markdown/syntax syntax rules]. Commit hashes to the Git repository of the package and references to Flyspray tickets are converted to links automatically. Long comments are collapsed and can be expanded on demand.
  
 
== FAQ ==
 
== FAQ ==
  
{{FAQ
+
=== What is the AUR? ===
|question=What is the AUR?
+
 
|answer=The AUR (Arch User Repository) is a place where the Arch Linux community can upload [[PKGBUILD]]s of applications, libraries, etc., and share them with the entire community. Fellow users can then vote for their favorites to be moved into the ''community'' repository to be shared with Arch Linux users in binary form.}}
+
The AUR (Arch User Repository) is a place where the Arch Linux community can upload [[PKGBUILD]]s of applications, libraries, etc., and share them with the entire community. Fellow users can then vote for their favorites to be moved into the [[community repository]] to be shared with Arch Linux users in binary form.
 +
 
 +
=== What kind of packages are permitted on the AUR? ===
 +
 
 +
The packages on the AUR are merely "build scripts", i.e. recipes to build binaries for pacman. For most cases, everything is permitted, subject to the abovementioned [[#Rules of submission|usefulness and scope guidelines]], as long as you are in compliance with the licensing terms of the content. For other cases, where it is mentioned that "you may not link" to downloads, i.e. contents that are not redistributable, you may only use the file name itself as the source. This means and requires that users already have the restricted source in the build directory prior to building the package. When in doubt, ask.
 +
 
 +
=== How can I vote for packages in the AUR? ===
 +
 
 +
Sign up on the [https://aur.archlinux.org/ AUR website] to get a "Vote for this package" option while browsing packages. After signing up it is also possible to vote from the commandline with {{AUR|aurvote}}, {{AUR|aurvote-git}} or {{AUR|aur-auto-vote-git}}.
 +
 
 +
Alternatively, if you have set up [[#Authentication|ssh authentication]] as above, you can directly vote from the command line using your ssh key. This means that you won't need to save or type in your AUR password.
 +
 
 +
ssh aur@aur.archlinux.org vote <PACKAGE_NAME>
  
{{FAQ
+
=== What is a Trusted User / TU? ===
|question=What kind of packages are permitted on the AUR?
 
|answer=The packages on the AUR are merely "build scripts", i.e. recipes to build binaries for pacman. For most cases, everything is permitted, subject to the abovementioned usefulness and scope guidelines, as long as you are in compliance with the licensing terms of the content. For other cases, where it is mentioned that "you may not link" to downloads, i.e. contents that are not redistributable, you may only use the file name itself as the source. This means and requires that users already have the restricted source in the build directory prior to building the package. When in doubt, ask.}}
 
  
{{FAQ
+
A [[AUR Trusted User Guidelines|Trusted User]], in short TU, is a person who is chosen to oversee AUR and the [[community repository]]. They are the ones who maintain popular PKGBUILDs in ''community'', and overall keep the AUR running.
|question=How can I vote for packages in AUR?
 
|answer=Sign up on the [https://aur.archlinux.org/ AUR website] to get a "Vote for this package" option while browsing packages.}}
 
  
{{FAQ
+
=== What is the difference between the Arch User Repository and the community repository? ===
|question=What is a TU?
 
|answer=A [[AUR Trusted User Guidelines|TU (Trusted User)]] is a person who is chosen to oversee AUR and the ''community'' repository. They are the ones who maintain popular PKGBUILDs in ''community'', and overall keep the AUR running.}}
 
  
{{FAQ
+
The Arch User Repository is where all PKGBUILDs that users submit are stored, and must be built manually with [[makepkg]]. When PKGBUILDs receive enough community interest and the support of a TU, they are moved into the [[community repository]] (maintained by the TUs), where the binary packages can be installed with [[pacman]].
|question=What is the difference between the Arch User Repository and ''community''?
 
|answer=The Arch User Repository is where all PKGBUILDs that users submit are stored, and must be built manually with [[makepkg]]. When PKGBUILDs receive enough community interest and the support of a TU, they are moved into the ''community'' repository (maintained by the TUs), where the binary packages can be installed with [[pacman]].}}
 
  
{{FAQ
+
=== Foo in the AUR is outdated; what should I do? ===
|question=How many votes does it take to get a PKGBUILD into ''community''?
 
|answer=Usually, at least 10 votes are required for something to move into ''community''. However, if a TU wants to support a package, it will often be found in the repository.}}
 
  
{{FAQ
+
First, you should flag the package ''out-of-date'' indicating details on why the package is outdated, preferably including links to the release announcement or the new release tarball.
|question=How do I make a PKGBUILD?
+
You should also try to reach out to the maintainer directly by email. If there is no response from the maintainer after ''two weeks'', you can file an ''orphan'' request. This means you ask a [[Trusted User]] to disown the package base. This is to be done only if the package requires maintainer action, that he/she is not responding and you already tried to contact him/her previously.
|answer=The best resource is [[Creating Packages]]. Remember to look in AUR before creating the PKGBUILD as to not duplicate efforts.}}
 
  
{{FAQ
+
In the meantime, you can try updating the package yourself by editing the PKGBUILD locally. Sometimes, updates do not require changes to the build or package process, in which case simply updating the {{ic|pkgver}} or {{ic|source}} array is sufficient.
|question=I'm trying to run "pacman -S foo"; it is not working but I know it is in ''community''
 
|answer=You probably have not enabled ''community'' in your {{ic|/etc/pacman.conf}}. Just uncomment the relevant lines.
 
If ''community'' is enabled in your {{ic|/etc/pacman.conf}} try running {{ic|pacman -Syu}} first to synchronize the pkgcache and update your system before trying to install ''foo'' again.}}
 
  
{{FAQ
+
{{Note|[[VCS package guidelines|VCS packages]] are not considered out of date when the pkgver changes, do not flag them as the maintainer will merely unflag the package and ignore you. AUR maintainers should not commit mere pkgver bumps.}}
|question=Foo in AUR is outdated; what do I do?
 
|answer=For starters, you can flag packages out-of-date. If it stays out-of-date for an extended period of time, the best thing to do is email the maintainer. If there is no response from the maintainer after two weeks, you could send mail to the aur-general mailing list to have a TU orphan the PKGBUILD if you are willing to maintain it yourself. When we are talking about a package which is flagged out of date for more than 3 months and is in general not updated for a long time, please add this in your orphan request.}}
 
  
{{FAQ
+
=== Foo in the AUR does not compile when I run makepkg; what should I do? ===
|question=I have a PKGBUILD I would like to submit; can someone check it to see if there are any errors?
 
|answer=If you would like to have your PKGBUILD critiqued, post it on the aur-general mailing list to get feedback from the TUs and fellow AUR members. You could also get help from the [[ArchChannel|IRC channel]], #archlinux on irc.freenode.net. You can also
 
use [[namcap]] to check your PKGBUILD and the resulting package for errors.}}
 
  
{{FAQ
+
You are probably missing something trivial.
|question=Foo in AUR does not compile when I run makepkg; what should I do?
 
|answer=You are probably missing something trivial.
 
  
# Run {{ic|pacman -Syyu}} before compiling anything with {{ic|makepkg}} as the problem may be that your system is not up-to-date.
+
# [[Pacman#Upgrading_packages|Upgrade the system]] before compiling anything with {{ic|makepkg}} as the problem may be that your system is not up-to-date.
# Ensure you have both "base" and "base-devel" groups installed.
+
# Ensure you have both {{Grp|base}} and {{Grp|base-devel}} groups installed.
# Try using the "{{ic|-s}}" option with {{ic|makepkg}} to check and install all the dependencies needed before starting the build process.
+
# Try using the {{ic|-s}} option with {{ic|makepkg}} to check and install all the dependencies needed before starting the build process.
  
 
Be sure to first read the PKGBUILD and the comments on the AUR page of the package in question.
 
Be sure to first read the PKGBUILD and the comments on the AUR page of the package in question.
The reason might not be trivial after all. Custom CFLAGS, LDFLAGS and MAKEFLAGS can cause failures. It is also possible that the PKGBUILD is broken for everyone. If you cannot figure it out on your own, just report it to the maintainer e.g. by posting the errors you are getting in the comments on the AUR page.}}
+
The reason might not be trivial after all. Custom CFLAGS, LDFLAGS and MAKEFLAGS can cause failures. It is also possible that the PKGBUILD is broken for everyone. If you cannot figure it out on your own, just report it to the maintainer e.g. by posting the errors you are getting in the comments on the AUR page.
 +
 
 +
To check if the PKGBUILD is broken, or your system is misconfigured, consider building in a clean chroot. It will build your package in a clean Arch Linux environment, with only (build) dependencies installed, and without user customization. To do this [[install]] {{pkg|devtools}} and run {{ic|extra-x86_64-build}} instead of {{ic|makepkg}}. For [[multilib]] packages, run {{ic|multilib-build}} See [[DeveloperWiki:Building in a clean chroot]] for more information. If the build process still fails in a clean chroot, the issue is probably with the PKGBUILD.
 +
 
 +
=== ERROR: One or more PGP signatures could not be verified!; what should I do? ===
 +
 
 +
Most likely you do not have the required public key(s) in you personal keyring to verify downloaded files. If one or more .sig files are downloaded while building the package, [[Makepkg#Signature_checking|makepkg will automatically verify corresponding file(s) with the public key of its signer]]. If you do not have the required key in your personal keyring, ''makepkg'' will fail to do the verification.
 +
 
 +
The recommended way to deal with this problem is to import the required public key, either [[GnuPG#Import_a_public_key|manually]] or [[GnuPG#Use_a_keyserver|from a key server]]. Often, you can simply find the fingerprint of the needed public key(s) in the [[PKGBUILD#validpgpkeys|validpgpkeys]] section of the [[PKGBUILD]].
 +
 
 +
=== How do I create a PKGBUILD? ===
 +
 
 +
The best resource is the wiki page about [[creating packages]]. Remember to look in AUR before creating the PKGBUILD as to not duplicate efforts.
 +
 
 +
=== I have a PKGBUILD I would like to submit; can someone check it to see if there are any errors? ===
 +
 
 +
If you would like to have your PKGBUILD reviewed, post it on the [https://mailman.archlinux.org/mailman/listinfo/aur-general aur-general mailing list] to get feedback from the TUs and fellow AUR members. You could also get help from the [[IRC channel]], #archlinux-aur on irc.freenode.net. You can also use [[namcap]] to check your PKGBUILD and the resulting package for errors.
 +
 
 +
=== How to get a PKGBUILD into the community repository? ===
 +
 
 +
Usually, at least 10 votes are required for something to move into [[community repository|community]]. However, if a TU wants to support a package, it will often be found in the repository.
 +
 
 +
Reaching the required minimum of votes is not the only requirement, there has to be a TU willing to maintain the package. TUs are not required to move a package into the ''community'' repository even if it has thousands of votes.
 +
 
 +
Usually when a very popular package stays in the AUR it is because:
 +
 
 +
* Arch Linux already has another version of a package in the repositories
 +
* Its license prohibits redistribution
 +
* It helps retrieve user-submitted PKGBUILDs. [[AUR helpers]] are [https://bbs.archlinux.org/viewtopic.php?pid=828310#p828310 unsupported] by definition.
 +
 
 +
See also [[AUR Trusted User Guidelines#Rules for Packages Entering the .5Bcommunity.5D Repo|Rules for Packages Entering the community Repo]].
 +
 
 +
=== How can I speed up repeated build processes? ===
 +
 
 +
See [[Makepkg#Improving compile times]].
 +
 
 +
=== What is the difference between foo and foo-git packages? ===
 +
 
 +
Many AUR packages are presented in regular ("stable") and development versions ("unstable"). A development package usually has a suffix such as {{ic|-cvs}}, {{ic|-svn}}, {{ic|-git}}, {{ic|-hg}}, {{ic|-bzr}} or {{ic|-darcs}}. While development packages are not intended for regular use, they may offer new features or bugfixes. Because these packages download the latest available source when you execute {{ic|makepkg}}, a package version to track possible updates is not directly available for these. Likewise, these packages cannot perform an authenticity checksum, instead it is relied on the maintainer(s) of the Git repository.
 +
 
 +
See also [[System maintenance#Use proven software packages]].
 +
 
 +
=== Why has foo disappeared from the AUR? ===
 +
 
 +
It is possible the package has been adopted by a TU and is now in the [[community repository]].
 +
 
 +
Packages may be deleted if they did not fulfill the [[#Rules of submission]]. See the [https://lists.archlinux.org/pipermail/aur-requests/ aur-requests archives] for the reason for deletion.
 +
 
 +
If the package used to exist in AUR3, it might not have been [https://lists.archlinux.org/pipermail/aur-general/2015-August/031322.html migrated to AUR4]. See the [[#Git repositories for AUR3 packages]] where these are preserved.
 +
 
 +
=== How do I find out if any of my installed packages disappeared from AUR? ===
 +
 
 +
The simplest way is to check the HTTP status of the package's AUR page:
  
{{FAQ
+
$ comm -23 <(pacman -Qqm | sort) <(curl https://aur.archlinux.org/packages.gz | gzip -cd | sort)
|question=How can I speed up repeated build processes?
 
|answer=If you frequently compile code that uses gcc - say, a git or SVN package - you may find [[ccache]], short for "compiler cache", useful.}}
 
  
{{FAQ
+
=== How can I obtain a list of all AUR packages? ===
|question=How do I access unsupported packages?
 
|answer=See [[#Installing packages]]}}
 
  
{{FAQ
+
* https://aur.archlinux.org/packages.gz
|question=How can I upload to AUR without using the web interface?
+
* Use <code>aurpkglist</code> from {{aur|python3-aur}}
|answer=You can use {{pkg|burp}}, {{AUR|aurploader}} or {{AUR|aurup}} &mdash; these are command-line programs.}}
 
  
 
== See also ==
 
== See also ==
 
* [https://aur.archlinux.org AUR Web Interface]
 
* [https://aur.archlinux.org AUR Web Interface]
* [https://www.archlinux.org/mailman/listinfo/aur-general AUR Mailing List]
+
* [https://lists.archlinux.org/listinfo/aur-general AUR Mailing List]
 +
* [[DeveloperWiki:AUR Cleanup Day]]

Latest revision as of 20:37, 17 February 2019

The Arch User Repository (AUR) is a community-driven repository for Arch users. It contains package descriptions (PKGBUILDs) that allow you to compile a package from source with makepkg and then install it via pacman. The AUR was created to organize and share new packages from the community and to help expedite popular packages' inclusion into the community repository. This document explains how users can access and utilize the AUR.

A good number of new packages that enter the official repositories start in the AUR. In the AUR, users are able to contribute their own package builds (PKGBUILD and related files). The AUR community has the ability to vote for packages in the AUR. If a package becomes popular enough — provided it has a compatible license and good packaging technique — it may be entered into the community repository (directly accessible by pacman or abs).

Warning: AUR packages are user produced content with no official support. Any use of the provided files is at your own risk.

Getting started

Users can search and download PKGBUILDs from the AUR Web Interface. These PKGBUILDs can be built into installable packages using makepkg, then installed using pacman.

  • Ensure the base-devel package group is installed in full (pacman -S --needed base-devel).
  • Glance over the #FAQ for answers to the most common questions.
  • You may wish to adjust /etc/makepkg.conf to optimize for your processor prior to building packages from the AUR. A significant improvement in compile times can be realized on systems with multi-core processors by adjusting the MAKEFLAGS variable. Users can also enable hardware-specific optimizations in GCC via the CFLAGS variable. See makepkg for more information.

It is also possible to interact with the AUR through SSH: type ssh aur@aur.archlinux.org help for a list of available commands.

History

In the beginning, there was ftp://ftp.archlinux.org/incoming, and people contributed by simply uploading the PKGBUILD, the needed supplementary files, and the built package itself to the server. The package and associated files remained there until a Package Maintainer saw the program and adopted it.

Then the Trusted User Repositories were born. Certain individuals in the community were allowed to host their own repositories for anyone to use. The AUR expanded on this basis, with the aim of making it both more flexible and more usable. In fact, the AUR maintainers are still referred to as TUs (Trusted Users).

Between 2015-06-08 and 2015-08-08 the AUR transitioned from version 3.5.1 to 4.0.0, introducing the use of Git repositories for publishing the PKGBUILDs. Existing packages were dropped unless manually migrated to the new infrastructure by their maintainers.

Git repositories for AUR3 packages

The AUR Archive on GitHub has a repository for every package that was in AUR 3 at the time of the migration. Alternatively, there is the aur3-mirror repository which provides the same.

Installing packages

Installing packages from the AUR is a relatively simple process. Essentially:

  1. Acquire the build files, including the PKGBUILD and possibly other required files, like systemd units and patches (often not the actual code).
  2. Verify that the PKGBUILD and accompanying files are not malicious or untrustworthy.
  3. Run makepkg -si in the directory where the files are saved. This will download the code, resolve the dependencies with pacman, compile it, package it, and install the package.
Note: The AUR is unsupported, so any packages you install are your responsibility to update, not pacman's. If packages in the official repositories are updated, you will need to rebuild any AUR packages that depend on those libraries.

Prerequisites

First ensure that the necessary tools are installed by installing the base-devel group in full which includes make and other tools needed for compiling from source.

Note: Packages in the AUR assume that the base-devel group is installed, i.e. they do not list the group's members as dependencies explicitly.

Next choose an appropriate build directory. A build directory is simply a directory where the package will be made or "built" and can be any directory. The examples in the following sections will use ~/builds as the build directory.

Acquire build files

Locate the package in the AUR. This is done using the search field at the top of the AUR home page. Clicking the application's name in the search list brings up an information page on the package. Read through the description to confirm that this is the desired package, note when the package was last updated, and read any comments.

There are several methods for acquiring the build files:

  • Option 1: Clone the git repository that is labelled as the "Git Clone URL" in the "Package Details". This is the preferred method.
$ git clone https://aur.archlinux.org/package_name.git
An advantage of this method is that you can easily get updates to the package via git pull.
  • Option 2: Download the build files with your web browser by clicking the "Download snapshot" link under "Package Actions" on the right hand side. This will download a compressed file, which must be extracted (preferably in a directory set aside for AUR builds)
$ tar -xvf package_name.tar.gz
  • Similarly, you can download a tarball from the terminal (and extract it):
$ curl -L -O https://aur.archlinux.org/cgit/aur.git/snapshot/package_name.tar.gz

Build and install the package

Change directories to the directory containing the package's PKGBUILD.

$ cd package_name
Warning: Carefully check the PKGBUILD, any .install files, and any other files in the package's git repository for malicious or dangerous commands. If in doubt, do not build the package, and seek advice on the forums or mailing list. Malicious code has been found in packages before. [1]

View the contents of all provided files. For example, to use the pager less to view PKGBUILD do:

$ less PKGBUILD
Tip: If you are updating a package, you may want to look at the changes since the last commit.
  • To view changes since the last git commit you can use git show.
  • To view changes since the last commit using vimdiff, do git difftool @~..@ vimdiff. The advantage of vimdiff is that you view the entire contents of each file along with indicators on what has changed.

Make the package. After manually confirming the contents of the files, run makepkg as a normal user:

$ makepkg -si
  • -s/--syncdeps automatically resolves and installs any dependencies with pacman before building. If the package depends on other AUR packages, you will need to manually install them first.
  • -i/--install installs the package if it is built successfully. Alternatively the built package can be installed with pacman -U package.pkg.tar.xz.

Other useful flags are

  • -r/--rmdeps removes build-time dependencies after the build, as they are no longer needed. However these dependencies may need to be reinstalled the next time the package is updated.
  • -c/--clean cleans up temporary build files after the build, as they are no longer needed. These files are usually needed only when debugging the build process.
Note: The above example is only a brief summary of the build process. It is highly recommended to read the makepkg and ABS articles for more details.

Feedback

The AUR Web Interface has a comments facility that allows users to provide suggestions and feedback on improvements to the PKGBUILD contributor. Avoid pasting patches or PKGBUILDs into the comments section: they quickly become obsolete and just end up needlessly taking up lots of space. Instead email those files to the maintainer, or even use a pastebin.

One of the easiest activities for all Arch users is to browse the AUR and vote for their favourite packages using the online interface. All packages are eligible for adoption by a TU for inclusion in the community repository, and the vote count is one of the considerations in that process; it is in everyone's interest to vote!

Sharing and maintaining packages

Note: Please see Talk:Arch User Repository#Scope of the AUR4 section before making changes to this section.

Users can share PKGBUILDs using the Arch User Repository. It does not contain any binary packages but allows users to upload PKGBUILDs that can be downloaded by others. These PKGBUILDs are completely unofficial and have not been thoroughly vetted, so they should be used at your own risk.

Submitting packages

Warning: Before attempting to submit a package you are expected to familiarize yourself with Arch packaging standards and all the articles under "Related articles". Verify carefully that what you are uploading is correct. Packages that violate the rules may be deleted without warning.

If you are unsure in any way about the package or the build/submission process even after reading this section twice, submit the PKGBUILD to the AUR mailing list, the AUR forum on the Arch forums, or ask on our IRC channel for public review before adding it to the AUR.

Rules of submission

When submitting a package to the AUR, observe the following rules:

  • The submitted PKGBUILDs must not build applications already in any of the official binary repositories under any circumstances. Check the official package database for the package. If any version of it exists, do not submit the package. If the official package is out-of-date, flag it as such. If the official package is broken or is lacking a feature, then please file a bug report.
Exception to this strict rule may only be packages having extra features enabled and/or patches in comparison to the official ones. In such an occasion the pkgname should be different to express that difference. For example, a package for GNU screen containing the sidebar patch could be named screen-sidebar. Additionally the provides=('screen') array should be used in order to avoid conflicts with the official package.
  • Check the AUR if the package already exists. If it is currently maintained, changes can be submitted in a comment for the maintainer's attention. If it is unmaintained or the maintainer is unresponsive, the package can be adopted and updated as required. Do not create duplicate packages.
  • Make sure the package you want to upload is useful. Will anyone else want to use this package? Is it extremely specialized? If more than a few people would find this package useful, it is appropriate for submission.
The AUR and official repositories are intended for packages which install generally software and software-related content, including one or more of the following: executable(s); config file(s); online or offline documentation for specific software or the Arch Linux distribution as a whole; media intended to be used directly by software.
  • Do not use replaces in an AUR PKGBUILD unless the package is to be renamed, for example when Ethereal became Wireshark. If the package is an alternate version of an already existing package, use conflicts (and provides if that package is required by others). The main difference is: after syncing (-Sy) pacman immediately wants to replace an installed, 'offending' package upon encountering a package with the matching replaces anywhere in its repositories; conflicts, on the other hand, is only evaluated when actually installing the package, which is usually the desired behavior because it is less invasive.
  • Submitting binaries should be avoided if the sources are available. The AUR should not contain the binary tarball created by makepkg, nor should it contain the filelist.
  • Please add a comment line to the top of the PKGBUILD file which contains information about the current maintainers and previous contributors, respecting the following format. Remember to disguise your email to protect against spam. Additional or unneeded lines are facultative.
If you are assuming the role of maintainer for an existing PKGBUILD, add your name to the top like this
# Maintainer: Your Name <address at domain dot tld>
If there were previous maintainers, put them as contributors. The same applies for the original submitter if this is not you. If you are a co-maintainer, add the names of the other current maintainers as well.
# Maintainer: Your name <address at domain dot tld>
# Maintainer: Other maintainer's name <address at domain dot tld>
# Contributor: Previous maintainer's name <address at domain dot tld>
# Contributor: Original submitter's name <address at domain dot tld>

Authentication

For write access to the AUR, you need to have an SSH key pair. The content of the public key needs to be copied to your profile in My Account, and the corresponding private key configured for the aur.archlinux.org host. For example:

~/.ssh/config
Host aur.archlinux.org
  IdentityFile ~/.ssh/aur
  User aur

You should create a new key pair rather than use an existing one, so that you can selectively revoke the keys should something happen:

$ ssh-keygen -f ~/.ssh/aur
Tip: You can add multiple public keys to your profile by separating them with a newline in the input field.

Creating package repositories

If you are creating a new package from scratch, establish a local Git repository and an AUR remote by cloning the intended pkgbase. If the package does not yet exist, the following warning is expected:

$ git clone ssh://aur@aur.archlinux.org/pkgbase.git
Cloning into 'pkgbase'...
warning: You appear to have cloned an empty repository.
Checking connectivity... done.
Note: The repository will not be empty if pkgbase matches a deleted package.

If you already have a package, initialize it as a Git repository if it isn't one, and add an AUR remote:

$ git remote add label ssh://aur@aur.archlinux.org/pkgbase.git

Then fetch this remote to initialize it in the AUR.

Note: Pull and rebase to resolve conflicts if pkgbase matches a deleted package.

Publishing new package content

Warning: Your commits will be authored with your global Git name and email address. It is very difficult to change commits after pushing them (FS#45425). If you want to push to the AUR under different credentials, you can change them per package with git config user.name "..." and git config user.email "...".

To upload or update a package add at least PKGBUILD and .SRCINFO then any new or modified .install files, patches or other local source files; commit with a meaningful commit message, and finally push the changes to the AUR.

Tip: To keep the working directory and commits as clean as possible, create a gitignore(5) that excludes all files and force-add files as needed.

For example:

$ makepkg --printsrcinfo > .SRCINFO
$ git add -f PKGBUILD .SRCINFO
$ git commit -m "useful commit message"
$ git push
Note:
  • After modifying a package, except for very minor changes (such as fixing a typo) that would not require re-installation of the package, update its version accordingly.
  • Regenerate .SRCINFO after updating such PKGBUILD metadata in order to publish it in the AUR.
  • If .SRCINFO was not added before your first commit, add it by rebasing with --root or filtering the tree so the AUR will permit your initial push.

Maintaining packages

  • Check for feedback and comments from other users and try to incorporate any improvements they suggest; consider it a learning process!
  • Please do not leave a comment containing the version number every time you update the package. This keeps the comment section usable for valuable content mentioned above.
  • Please do not just submit and forget about packages! It is the maintainer's job to maintain the package by checking for updates and improving the PKGBUILD.
  • If you do not want to continue to maintain the package for some reason, disown the package using the AUR web interface and/or post a message to the AUR Mailing List. If all maintainers of an AUR package disown it, it will become an "orphaned" package.

Other requests

Deletion, merge, and orphan requests can be created by clicking on the "Submit Request" link under "Package Actions" on the right hand side. This will send a notification email to the current maintainer and to the aur-requests mailing list for discussion. A Trusted User will then either accept or reject the request.

Deletion

You may request to unlist a pkgbase from the AUR. A short note explaining the reason for deletion is required, as well as supporting details (like when a package is provided by another package, if you are the maintainer yourself, it is renamed and the original owner agreed, etc).

Note:
  • It is not sufficient to explain why a package is up for deletion only in its comments because as soon as a TU takes action, the only place where such information can be obtained is the aur-requests mailing list.
  • Deletion requests can be rejected, in which case if you are the maintainer you will likely be advised to disown the package to allow adoption by another maintainer.
  • After a package is "deleted", its git repository remains available for cloning.

Merge

You may request to delete a pkgbase and transfer its votes and comments to another pkgbase. The name of the package to merge into is required.

Note: This has nothing to do with 'git merge' or GitLab's merge requests.

Orphan

You may request that a pkgbase be disowned. These requests will be granted after two weeks if the current maintainer did not react.

Web interface translation

See i18n.txt in the AUR source tree for information about creating and maintaining translation of the AUR web interface.

Comment syntax

The Python-Markdown syntax is supported in comments. It provides basic Markdown syntax to format comments. Note this implementation has some occasional differences with the official syntax rules. Commit hashes to the Git repository of the package and references to Flyspray tickets are converted to links automatically. Long comments are collapsed and can be expanded on demand.

FAQ

What is the AUR?

The AUR (Arch User Repository) is a place where the Arch Linux community can upload PKGBUILDs of applications, libraries, etc., and share them with the entire community. Fellow users can then vote for their favorites to be moved into the community repository to be shared with Arch Linux users in binary form.

What kind of packages are permitted on the AUR?

The packages on the AUR are merely "build scripts", i.e. recipes to build binaries for pacman. For most cases, everything is permitted, subject to the abovementioned usefulness and scope guidelines, as long as you are in compliance with the licensing terms of the content. For other cases, where it is mentioned that "you may not link" to downloads, i.e. contents that are not redistributable, you may only use the file name itself as the source. This means and requires that users already have the restricted source in the build directory prior to building the package. When in doubt, ask.

How can I vote for packages in the AUR?

Sign up on the AUR website to get a "Vote for this package" option while browsing packages. After signing up it is also possible to vote from the commandline with aurvoteAUR, aurvote-gitAUR or aur-auto-vote-gitAUR.

Alternatively, if you have set up ssh authentication as above, you can directly vote from the command line using your ssh key. This means that you won't need to save or type in your AUR password.

ssh aur@aur.archlinux.org vote <PACKAGE_NAME>

What is a Trusted User / TU?

A Trusted User, in short TU, is a person who is chosen to oversee AUR and the community repository. They are the ones who maintain popular PKGBUILDs in community, and overall keep the AUR running.

What is the difference between the Arch User Repository and the community repository?

The Arch User Repository is where all PKGBUILDs that users submit are stored, and must be built manually with makepkg. When PKGBUILDs receive enough community interest and the support of a TU, they are moved into the community repository (maintained by the TUs), where the binary packages can be installed with pacman.

Foo in the AUR is outdated; what should I do?

First, you should flag the package out-of-date indicating details on why the package is outdated, preferably including links to the release announcement or the new release tarball. You should also try to reach out to the maintainer directly by email. If there is no response from the maintainer after two weeks, you can file an orphan request. This means you ask a Trusted User to disown the package base. This is to be done only if the package requires maintainer action, that he/she is not responding and you already tried to contact him/her previously.

In the meantime, you can try updating the package yourself by editing the PKGBUILD locally. Sometimes, updates do not require changes to the build or package process, in which case simply updating the pkgver or source array is sufficient.

Note: VCS packages are not considered out of date when the pkgver changes, do not flag them as the maintainer will merely unflag the package and ignore you. AUR maintainers should not commit mere pkgver bumps.

Foo in the AUR does not compile when I run makepkg; what should I do?

You are probably missing something trivial.

  1. Upgrade the system before compiling anything with makepkg as the problem may be that your system is not up-to-date.
  2. Ensure you have both base and base-devel groups installed.
  3. Try using the -s option with makepkg to check and install all the dependencies needed before starting the build process.

Be sure to first read the PKGBUILD and the comments on the AUR page of the package in question. The reason might not be trivial after all. Custom CFLAGS, LDFLAGS and MAKEFLAGS can cause failures. It is also possible that the PKGBUILD is broken for everyone. If you cannot figure it out on your own, just report it to the maintainer e.g. by posting the errors you are getting in the comments on the AUR page.

To check if the PKGBUILD is broken, or your system is misconfigured, consider building in a clean chroot. It will build your package in a clean Arch Linux environment, with only (build) dependencies installed, and without user customization. To do this install devtools and run extra-x86_64-build instead of makepkg. For multilib packages, run multilib-build See DeveloperWiki:Building in a clean chroot for more information. If the build process still fails in a clean chroot, the issue is probably with the PKGBUILD.

ERROR: One or more PGP signatures could not be verified!; what should I do?

Most likely you do not have the required public key(s) in you personal keyring to verify downloaded files. If one or more .sig files are downloaded while building the package, makepkg will automatically verify corresponding file(s) with the public key of its signer. If you do not have the required key in your personal keyring, makepkg will fail to do the verification.

The recommended way to deal with this problem is to import the required public key, either manually or from a key server. Often, you can simply find the fingerprint of the needed public key(s) in the validpgpkeys section of the PKGBUILD.

How do I create a PKGBUILD?

The best resource is the wiki page about creating packages. Remember to look in AUR before creating the PKGBUILD as to not duplicate efforts.

I have a PKGBUILD I would like to submit; can someone check it to see if there are any errors?

If you would like to have your PKGBUILD reviewed, post it on the aur-general mailing list to get feedback from the TUs and fellow AUR members. You could also get help from the IRC channel, #archlinux-aur on irc.freenode.net. You can also use namcap to check your PKGBUILD and the resulting package for errors.

How to get a PKGBUILD into the community repository?

Usually, at least 10 votes are required for something to move into community. However, if a TU wants to support a package, it will often be found in the repository.

Reaching the required minimum of votes is not the only requirement, there has to be a TU willing to maintain the package. TUs are not required to move a package into the community repository even if it has thousands of votes.

Usually when a very popular package stays in the AUR it is because:

  • Arch Linux already has another version of a package in the repositories
  • Its license prohibits redistribution
  • It helps retrieve user-submitted PKGBUILDs. AUR helpers are unsupported by definition.

See also Rules for Packages Entering the community Repo.

How can I speed up repeated build processes?

See Makepkg#Improving compile times.

What is the difference between foo and foo-git packages?

Many AUR packages are presented in regular ("stable") and development versions ("unstable"). A development package usually has a suffix such as -cvs, -svn, -git, -hg, -bzr or -darcs. While development packages are not intended for regular use, they may offer new features or bugfixes. Because these packages download the latest available source when you execute makepkg, a package version to track possible updates is not directly available for these. Likewise, these packages cannot perform an authenticity checksum, instead it is relied on the maintainer(s) of the Git repository.

See also System maintenance#Use proven software packages.

Why has foo disappeared from the AUR?

It is possible the package has been adopted by a TU and is now in the community repository.

Packages may be deleted if they did not fulfill the #Rules of submission. See the aur-requests archives for the reason for deletion.

If the package used to exist in AUR3, it might not have been migrated to AUR4. See the #Git repositories for AUR3 packages where these are preserved.

How do I find out if any of my installed packages disappeared from AUR?

The simplest way is to check the HTTP status of the package's AUR page:

$ comm -23 <(pacman -Qqm | sort) <(curl https://aur.archlinux.org/packages.gz | gzip -cd | sort)

How can I obtain a list of all AUR packages?

See also