Difference between revisions of "Arch User Repository"

From ArchWiki
Jump to: navigation, search
(wikify some external links, use https for archlinux.org)
(Other requests: Clarify merge requests)
 
(399 intermediate revisions by 97 users not shown)
Line 2: Line 2:
 
[[Category:Package development]]
 
[[Category:Package development]]
 
[[Category:Package management]]
 
[[Category:Package management]]
 +
[[ar:Arch User Repository]]
 
[[cs:Arch User Repository]]
 
[[cs:Arch User Repository]]
 
[[da:Arch User Repository]]
 
[[da:Arch User Repository]]
 +
[[de:Arch User Repository]]
 
[[el:Arch User Repository]]
 
[[el:Arch User Repository]]
 
[[es:Arch User Repository]]
 
[[es:Arch User Repository]]
Line 16: Line 18:
 
[[ru:Arch User Repository]]
 
[[ru:Arch User Repository]]
 
[[sr:Arch User Repository]]
 
[[sr:Arch User Repository]]
[[tr:Arch_Kullanıcı_Deposu]]
+
[[tr:Arch Kullanıcı Deposu]]
 
[[uk:Arch User Repository]]
 
[[uk:Arch User Repository]]
 
[[zh-CN:Arch User Repository]]
 
[[zh-CN:Arch User Repository]]
{{Article summary start}}
+
[[zh-TW:Arch User Repository]]
{{Article summary text|The Arch User Repository is a collection of user-submitted [[PKGBUILD]]s that supplement software available from the [[official repositories]]. This article describes how to build ''unsupported'' software packages from the AUR.}}
+
{{Related articles start}}
{{Article summary heading|Overview}}
+
{{Related|makepkg}}
{{Article summary text|{{Package management overview}}}}
+
{{Related|pacman}}
{{Article summary heading|Related}}
+
{{Related|PKGBUILD}}
{{Article summary wiki|AUR Helpers}}
+
{{Related|.SRCINFO}}
{{Article summary wiki|AurJson}}
+
{{Related|AurJson}}
{{Article summary wiki|AUR Trusted User Guidelines}}
+
{{Related|AUR Trusted User Guidelines}}
{{Article summary heading|Resources}}
+
{{Related|Official repositories}}
{{Article summary link|AUR Web Interface|https://aur.archlinux.org}}
+
{{Related|Arch Build System}}
{{Article summary link|AUR Mailing List|https://www.archlinux.org/mailman/listinfo/aur-general}}
+
{{Related|Creating packages}}
{{Article summary end}}
+
{{Related|AUR helpers}}
 +
{{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 [[#.5Bcommunity.5D|[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 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]]).
  
 
== 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 base-devel}}).
+
* Ensure the {{Grp|base-devel}} package group is installed ({{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.
  
 
== 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).
 +
 +
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.
  
 
== Searching ==
 
== Searching ==
  
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].
+
The AUR web interface can be found at https://aur.archlinux.org/, and an interface suitable for accessing the AUR from a script can be found at https://aur.archlinux.org/rpc.php.
  
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 '\%'.
+
Queries search package names and descriptions via a MySQL LIKE comparison. This allows for more flexible search criteria (e.g. try searching for {{ic|tool%like%grep}} instead of {{ic|tool like grep}}). If you need to search for a description that contains {{ic|%}}, escape it with {{ic|\%}}.
  
 
== Installing packages ==
 
== Installing packages ==
 
 
Installing packages from the AUR is a relatively simple process. Essentially:
 
Installing packages from the AUR is a relatively simple process. Essentially:
  
# Acquire the tarball which contains the [[PKGBUILD]] and possibly other required files.
+
# Acquire the build files, including the [[PKGBUILD]] and possibly other required files, like [[systemd]] units and patches (often not the actual code).
# Extract the tarball (preferably in a folder set aside just for builds from the AUR).
+
# Verify that the [[PKGBUILD]] and accompanying files are not malicious or untrustworthy.
# Run {{ic|makepkg}} in the directory where the files are saved ({{ic|makepkg -s}} will automatically resolve dependencies with pacman).
+
# 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.
# Install the resulting package with [[pacman]]:
+
 
+
: {{bc|# pacman -U /path/to/pkg.tar.xz}}
+
 
+
[[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.
+
 
+
{{Note|There is not and will never be an ''official'' mechanism for installing build material from the AUR. '''All users should be familiar with the build process.'''}}
+
 
+
What follows is a detailed example of installation of a package called "foo".
+
  
 
=== Prerequisites ===
 
=== Prerequisites ===
  
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.
+
First ensure that the necessary tools are installed:
 
+
{{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.}}
+
 
+
# pacman -S base-devel
+
 
+
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:
+
  
  ~/builds
+
  # pacman -S --needed base-devel
  
or if using ABS (the [[Arch Build System]]):
+
The package group {{grp|base-devel}} should be sufficient; it includes {{pkg|make}} and other tools needed for compiling from source.
  
/var/abs/local
+
{{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.}}
  
For more information on ABS read the [[Arch Build System]] article. The example will use {{ic|~/builds}} as the build directory.
+
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 ===
 
=== Acquire build files ===
Line 99: Line 84:
 
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.
 
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.
  
Download the necessary build files. From the package's information page download the build files by clicking the "Tarball" link on the left-hand side near the end of the package details. 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).
+
There are several methods for acquiring the build files:
  
=== Build the package ===
+
* Clone the [[git]] repository that is labeled as the "Git Clone URL" in the "Package Details":
  
Extract the tarball. Change directories to the build directory if not already there and extract the build files.
+
$ git clone <nowiki>https://aur.archlinux.org/</nowiki>''package_name''.git
  
$ cd ~/builds
+
:An advantage of this method is that you can easily get updates to the package via {{ic|git pull}}.
$ tar -xvzf foo.tar.gz
+
* 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)
  
This should create a new directory called "foo" in the build directory.
+
$ tar -xvf ''package_name''.tar.gz
 +
* Similarly, you can download a tarball from the terminal (and extract it):
  
{{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.}}
+
$ curl -L -O <nowiki>https://aur.archlinux.org/cgit/aur.git/snapshot/</nowiki>''package_name''.tar.gz
  
$ cd foo
+
=== Build and install the package ===
$ nano PKGBUILD
+
$ nano foo.install
+
  
Make the package. After manually confirming the integrity of the files, run [[makepkg]] as a normal user in the build directory.
+
Change directories to the directory containing the package's [[PKGBUILD]].
  
$ makepkg -s
+
{{Warning|'''Carefully check all files.''' 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 ''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 ''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 {{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.
+
$ cd ''package_name''
 +
$ less PKGBUILD
 +
$ less ''package_name''.install
  
=== Install the package ===
+
Make the package. After manually confirming the integrity of the files, run [[makepkg]] as a normal user:
  
Install the package using pacman. A tarball should have been created named:
+
  $ makepkg -si
  
<''application name''>-<''application version number''>-<''package revision number''>-<''architecture''>.pkg.tar.xz
+
* {{ic|-s}}/{{ic|--syncdeps}} automatically resolves and install 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}}.
  
This package can be installed using pacman's "upgrade" command:
+
Other useful flags are
  
# pacman -U foo-0.1-1-i686.pkg.tar.xz 
+
* {{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.
  
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:
+
{{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.}}
$ 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.}}
+
  
 
== Feedback ==
 
== Feedback ==
  
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]].
+
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]].
  
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], and the vote count is one of the considerations in that process; it is in everyone's interest to vote!
+
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 ==
 
== Sharing and maintaining packages ==
  
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.
+
{{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.
 
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.
Line 151: Line 136:
 
=== Submitting packages ===
 
=== Submitting packages ===
  
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|Before attempting to submit a package you are expected to familiarize yourself with [[Arch packaging standards]] and all the articles under "Related articles".}}
  
The tarball can be created with the following command:
+
==== Rules of submission ====
  
$ makepkg --source
+
{{Merge|Arch packaging standards#AUR packages|Keep the info in one place.|Talk:Arch_packaging_standards#Update_"Submitting_packages_to_the_AUR"_section}}
 
+
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:
+
+
{{hc|$ tar tf libfoo-0.1-1.src.tar.gz|
+
libfoo/
+
libfoo/PKGBUILD
+
libfoo/libfoo.install}}
+
  
 
When submitting a package, observe the following rules:
 
When submitting a package, observe the following rules:
  
* Check the [https://www.archlinux.org/packages/ package database] for the package. If it exists, '''do not''' submit the package. If the current package is broken or is lacking an included feature then please file a [https://bugs.archlinux.org/ bug report].
+
* 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].
 
* 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.
 
* 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.
* 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.
+
* 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.
 
* Packages that contain binaries or that are very poorly written may be deleted without warning.
 
* Packages that contain binaries or that are very poorly written may be deleted without warning.
* 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 Mailing List] or the [https://bbs.archlinux.org/viewforum.php?id=4 AUR boards] on the forum for public review before adding it to the AUR.
+
* 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.
 
* 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.
 
* 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.
 
* 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]].
+
 
 +
==== Authentication ====
 +
 
 +
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:
 +
 
 +
{{hc|~/.ssh/config|
 +
Host aur.archlinux.org
 +
  IdentityFile ~/.ssh/aur
 +
  User aur}}
 +
 
 +
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:
 +
 
 +
$ ssh-keygen -f ~/.ssh/aur
 +
 
 +
{{Tip|You can add multiple public keys to your profile by seperating them with a newline in the input field.}}
 +
 
 +
==== Creating a new package ====
 +
 
 +
In order to create a new, empty, local Git repository for a package, simply {{ic|git clone}} the remote repository with the corresponding name. If the package does not exist on AUR yet, you will see the following warning:
 +
 
 +
{{hc|$ git clone <nowiki>ssh://</nowiki>aur@aur.archlinux.org/''package_name''.git|
 +
Cloning into &apos;''package_name''&apos;...
 +
warning: You appear to have cloned an empty repository.
 +
Checking connectivity... done.}}
 +
 
 +
{{Note|When a package on the AUR is deleted, the git repository is not deleted so it is possible for a deleted package's repository to not be empty when cloned if someone is creating a package with the same name.}}
 +
 
 +
If you have already created a git repository, you can simply create a remote for the AUR git repository and then fetch it:
 +
 
 +
$ git remote add ''remote_name'' <nowiki>ssh://</nowiki>aur@aur.archlinux.org/''package_name''.git
 +
  $ git fetch ''remote_name''
 +
 
 +
where {{ic|''remote_name''}} is the name of the remote to create (''e.g.,'' "origin"). See [[Git#Using remotes]] for more information.
 +
 
 +
The new package will appear on AUR after you ''push'' the first commit. You can now add the source files to the local copy of the Git repository. See [[#Uploading packages]].
 +
 
 +
{{Warning|Your AUR commits will be authored according to your git user name and email address and it is very difficult to change commits after you push them (see {{Bug|45425}}). If you want to push to AUR under a different name/email, you can change them for this package via {{ic|git config user.name [...]}} and {{ic|git config user.email [...]}}. Review your commits before pushing them!}}
 +
 
 +
==== Uploading packages ====
 +
 
 +
{{Tip|To prevent untracked files from commits and keep a clean working directory as possible, exclude all files with {{ic|.gitignore}} and force-add files instead. See [[dotfiles#Using gitignore]].}}
 +
 
 +
The procedure for uploading packages to the AUR is the same for new packages and package updates. You need at least [[PKGBUILD]] and [[.SRCINFO]] in the top-level directory to ''push'' your package to AUR.
 +
 
 +
To upload, add the {{ic|PKGBUILD}}, {{ic|.SRCINFO}}, and any helper files (like {{ic|.install}} files or local source files like {{ic|.patch}}) to the ''staging area'' with {{ic|git add}}, commit them to your local tree with a commit message with {{ic|git commit}}, and finally publish the changes to the AUR with {{ic|git push}}.
 +
 
 +
For example:
 +
 
 +
$ makepkg --printsrcinfo > .SRCINFO
 +
$ git add PKGBUILD .SRCINFO
 +
$ git commit -m "''useful commit message''"
 +
$ git push
 +
 
 +
{{Tip|If you initially forgot to commit the {{ic|.SRCINFO}} and added it in a later commit, the AUR will still reject your pushes because the {{ic|.SRCINFO}} must exist for ''every'' commit. To solve this problem you can use [https://git-scm.com/docs/git-rebase git rebase] with the {{ic|--root}} option or [https://git-scm.com/docs/git-filter-branch git filter-branch] with the {{ic|--tree-filter}} option.}}
  
 
=== 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. [[AUR helpers]] are suited better to check for updates.
 
* 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.
Line 185: Line 216:
 
=== Other requests ===
 
=== Other requests ===
  
* Disownment requests and removal requests go to the aur-general mailing list for TUs and other users to decide upon.
+
* Disownment requests and removal requests can be created by clicking on the "Submit Request" link under "Package Actions" on the right hand side. This automatically sends a notification email to the current package maintainer and to the [https://mailman.archlinux.org/mailman/listinfo/aur-requests aur-requests mailing list] for discussion. [[Trusted Users]] 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 after two weeks if the current maintainer did not react.
* Disownment requests will be granted two weeks after the current maintainer has been contacted by email and did not react.
+
* Merge requests are for when one package is replacing another one. Users still have to resubmit a package under a new name and may request merging of the old version's comments and votes. This has nothing to do with 'git merge' and is not similar to github's merge requests.
* '''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:
 
* 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-requests mailing list.
** 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.
+
** 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.
** Include supporting details, like when a package is provided by another package, if you are the maintainer yourself, it's renamed and the original owner agreed, etc.
+
** For merge requests: Name of the package base to merge into.
  
Removal requests can be disapproved, in which case you'll likely be advised to disown the package for a future packager's reference.
+
Removal requests can be disapproved, in which case you will likely be advised to disown the package for a future packager's reference.
  
== [community] ==
+
== Git repositories for AUR3 packages ==
 +
{{Note|aur-mirror is no longer available}}
 +
The [https://github.com/aur-archive AUR Archive] on GitHub has a repository for every package that was in AUR 3 during the migration to AUR 4.
  
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:
+
== Web interface translation ==
  
{{hc|/etc/pacman.conf|2=
+
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.
...
+
[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.
+
== FAQ ==
  
Users can also access the [community] build files by editing {{ic|/etc/abs.conf}} and enabling the [community] repository in the {{ic|REPOS}} array.
+
=== What is the AUR? ===
  
== Git Repo ==
+
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.
  
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):
+
=== What kind of packages are permitted on the AUR? ===
  
$ git clone <nowiki>git://pkgbuild.com/aur-mirror.git</nowiki>
+
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.
  
More informations: [http://pkgbuild.com/git/aur-mirror.git/ Web interface], [http://pkgbuild.com/~td123/readme readme], [https://bbs.archlinux.org/viewtopic.php?id=113099 forum thread].
+
=== How can I vote for packages in the AUR? ===
  
== FAQ ==
+
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-git}}.
  
{{FAQ
+
=== What is a Trusted User / TU? ===
|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.}}
+
  
{{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=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
+
=== 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're 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's 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 votes, they are moved into the [community] repository, where the TUs maintain binary packages that can be installed with [[pacman]].}}
+
  
{{FAQ
+
=== Foo in the AUR is outdated; what do 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
+
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 can file an orphan request. 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.
|question=How do I make a PKGBUILD?
+
|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 - sometimes updates do not require any 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 isn't working but I know it's in [community]
+
|answer=You probably haven't 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 -S -y}} first to synchronize the pkgcache before trying your package again.}}
+
  
{{FAQ
+
=== Foo in the AUR does not compile when I run makepkg; what should I do? ===
|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're 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
+
You are probably missing something trivial.
|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
+
# [[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.
|question=Foo in AUR doesn't compile when I run makepkg; what should I do?
+
# Ensure you have both {{Grp|base}} and {{Grp|base-devel}} groups installed.
|answer=You are probably missing something trivial.
+
# Try using the {{ic|-s}} option with {{ic|makepkg}} to check and install all the dependencies needed before starting the build process.
 
+
# Run {{ic|pacman -Syyu}} 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.
+
# 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's 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.
 +
 
 +
=== How do I make 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 critiqued, 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 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
 +
* The package is AUR-centric (e.g. an [[AUR helper]])
 +
* Its license prohibits redistribution
 +
 
 +
See also [[DeveloperWiki:Community repo candidates]] and [[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? ===
 +
 
 +
If you frequently compile code that uses GCC - say, a Git or SVN package - you may find [[ccache]], short for "compiler cache", useful.
 +
 
 +
=== 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? ===
 +
 
 +
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:
 +
{{bc|<nowiki>#!/bin/bash
 +
for pkg in $(pacman -Qqm); do
 +
    if ! curl -sILfo /dev/null -w '%{http_code}' "https://aur.archlinux.org/packages/$pkg" | grep -q '^2'; then
 +
        echo "$pkg is missing!"
 +
    fi
 +
done</nowiki>}}
 +
 
 +
If you use an [[AUR helper]], you can shorten this script by replacing the curl command with whatever command queries the AUR for a package.
  
{{FAQ
+
=== How can I obtain a list of all AUR packages? ===
|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
+
* https://aur.archlinux.org/packages.gz
|question=How do I access unsupported packages?
+
* Use <code>aurpkglist</code> from {{aur|python3-aur}}
|answer=See [[#Installing packages]]}}
+
  
{{FAQ
+
== See also ==
|question=How can I upload to AUR without using the web interface?
+
* [https://aur.archlinux.org AUR Web Interface]
|answer=You can use {{pkg|burp}}, {{AUR|aurploader}} or {{AUR|aurup}} &mdash; these are command-line programs.}}
+
* [https://www.archlinux.org/mailman/listinfo/aur-general AUR Mailing List]
 +
* [http://pkgbuild.com/git/aur-mirror.git/ AUR Mirror Git repository]

Latest revision as of 01:39, 23 November 2016

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 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).

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 (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.

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.

Searching

The AUR web interface can be found at https://aur.archlinux.org/, and an interface suitable for accessing the AUR from a script can be found at https://aur.archlinux.org/rpc.php.

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 \%.

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.

Prerequisites

First ensure that the necessary tools are installed:

# pacman -S --needed base-devel

The package group base-devel should be sufficient; it 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 feature (text 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:

  • Clone the git repository that is labeled as the "Git Clone URL" in the "Package Details":
$ 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.
  • 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.

Warning: Carefully check all files. Carefully check the PKGBUILD and any .install file for malicious commands. PKGBUILDs are bash scripts containing functions to be executed by makepkg: these functions can contain any valid commands or Bash syntax, so it is totally possible for a PKGBUILD to contain dangerous commands through malice or ignorance on the part of the author. Since 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.
$ cd package_name
$ less PKGBUILD
$ less package_name.install

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

$ makepkg -si
  • -s/--syncdeps automatically resolves and install 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.

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".

Rules of submission

Merge-arrows-2.pngThis article or section is a candidate for merging with Arch packaging standards#AUR packages.Merge-arrows-2.png

When submitting a package, observe the following rules:

  • 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.
  • 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.
  • 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.
  • Packages that contain binaries or that are very poorly written may be deleted without warning.
  • If you are unsure about the package (or the build/submission process) in any way, submit the PKGBUILD to the AUR mailing list or the 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.

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 seperating them with a newline in the input field.

Creating a new package

In order to create a new, empty, local Git repository for a package, simply git clone the remote repository with the corresponding name. If the package does not exist on AUR yet, you will see the following warning:

$ git clone ssh://aur@aur.archlinux.org/package_name.git
Cloning into 'package_name'...
warning: You appear to have cloned an empty repository.
Checking connectivity... done.
Note: When a package on the AUR is deleted, the git repository is not deleted so it is possible for a deleted package's repository to not be empty when cloned if someone is creating a package with the same name.

If you have already created a git repository, you can simply create a remote for the AUR git repository and then fetch it:

$ git remote add remote_name ssh://aur@aur.archlinux.org/package_name.git
$ git fetch remote_name

where remote_name is the name of the remote to create (e.g., "origin"). See Git#Using remotes for more information.

The new package will appear on AUR after you push the first commit. You can now add the source files to the local copy of the Git repository. See #Uploading packages.

Warning: Your AUR commits will be authored according to your git user name and email address and it is very difficult to change commits after you push them (see FS#45425). If you want to push to AUR under a different name/email, you can change them for this package via git config user.name [...] and git config user.email [...]. Review your commits before pushing them!

Uploading packages

Tip: To prevent untracked files from commits and keep a clean working directory as possible, exclude all files with .gitignore and force-add files instead. See dotfiles#Using gitignore.

The procedure for uploading packages to the AUR is the same for new packages and package updates. You need at least PKGBUILD and .SRCINFO in the top-level directory to push your package to AUR.

To upload, add the PKGBUILD, .SRCINFO, and any helper files (like .install files or local source files like .patch) to the staging area with git add, commit them to your local tree with a commit message with git commit, and finally publish the changes to the AUR with git push.

For example:

$ makepkg --printsrcinfo > .SRCINFO
$ git add PKGBUILD .SRCINFO
$ git commit -m "useful commit message"
$ git push
Tip: If you initially forgot to commit the .SRCINFO and added it in a later commit, the AUR will still reject your pushes because the .SRCINFO must exist for every commit. To solve this problem you can use git rebase with the --root option or git filter-branch with the --tree-filter option.

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. AUR helpers are suited better to check for updates.
  • 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.

Other requests

  • Disownment requests and removal requests can be created by clicking on the "Submit Request" link under "Package Actions" on the right hand side. This automatically sends a notification email to the current package maintainer and to the aur-requests mailing list for discussion. Trusted Users will then either accept or reject the request.
  • Disownment requests will be granted after two weeks if the current maintainer did not react.
  • Merge requests are for when one package is replacing another one. Users still have to resubmit a package under a new name and may request merging of the old version's comments and votes. This has nothing to do with 'git merge' and is not similar to github's merge requests.
  • Removal requests require the following information:
    • Reason for deletion, at least a short note
      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-requests mailing list.
    • 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.
    • For merge requests: Name of the package base to merge into.

Removal requests can be disapproved, in which case you will likely be advised to disown the package for a future packager's reference.

Git repositories for AUR3 packages

Note: aur-mirror is no longer available

The AUR Archive on GitHub has a repository for every package that was in AUR 3 during the migration to AUR 4.

Web interface translation

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

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 aurvote-gitAUR.

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 do I do?

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 can file an orphan request. 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.

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

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.

How do I make 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 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 IRC channel, #archlinux 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
  • The package is AUR-centric (e.g. an AUR helper)
  • Its license prohibits redistribution

See also DeveloperWiki:Community repo candidates and Rules for Packages Entering the community Repo.

How can I speed up repeated build processes?

If you frequently compile code that uses GCC - say, a Git or SVN package - you may find ccache, short for "compiler cache", useful.

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?

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:

#!/bin/bash
for pkg in $(pacman -Qqm); do
    if ! curl -sILfo /dev/null -w '%{http_code}' "https://aur.archlinux.org/packages/$pkg" | grep -q '^2'; then
        echo "$pkg is missing!"
    fi
done

If you use an AUR helper, you can shorten this script by replacing the curl command with whatever command queries the AUR for a package.

How can I obtain a list of all AUR packages?

See also