Difference between revisions of "AUR User Guidelines"

From ArchWiki
Jump to: navigation, search
m (moved AUR User Guidelines to AUR User Guidelines (old): lost history; restoration failed due to existing page)
(restoring previous version)
Line 1: Line 1:
[[Category:Package management]]
+
[[Category:Package management (English)]]
[[Category:About Arch]]
+
[[Category:About Arch (English)]]
[[Category:Package development]]
+
[[Category:Package development (English)]]
[[Category:Guidelines]]
+
[[Category:AUR (English)]]
 +
[[Category:Guidelines (English)]]
 
{{Article summary start}}
 
{{Article summary start}}
{{Article summary text|Explains how to access and use AUR}}
+
{{Article summary text|Explains how to access and use the Arch User Repository.}}
 
{{Article summary heading|Available in languages}}
 
{{Article summary heading|Available in languages}}
 
{{i18n_entry|Česky|:AUR - uživatelský průvodce (Česky)}}
 
{{i18n_entry|Česky|:AUR - uživatelský průvodce (Česky)}}
 
{{i18n_entry|Dansk|:AUR_Brugervejledning}}
 
{{i18n_entry|Dansk|:AUR_Brugervejledning}}
{{i18n_entry|English|:AUR_User_Guidelines}}
+
{{i18n_entry|English|:AUR User Guidelines}}
 
{{i18n_entry|Español|:Guía de usuario AUR (Español)}}
 
{{i18n_entry|Español|:Guía de usuario AUR (Español)}}
 
{{i18n_entry|French|:AUR_User_Guidelines (French)}}
 
{{i18n_entry|French|:AUR_User_Guidelines (French)}}
 
{{i18n_entry|Italiano|:AUR_User_Guidelines (Italiano)}}
 
{{i18n_entry|Italiano|:AUR_User_Guidelines (Italiano)}}
 
{{i18n_entry|Русский|:AUR_руководство_пользователя}}
 
{{i18n_entry|Русский|:AUR_руководство_пользователя}}
{{i18n_entry|简体中文|:AUR用户指南}}
+
{{i18n_entry|简体中文|:AUR_用户指南_(简体中文)}}
{{Article summary heading|See also}}
+
{{Article summary heading|Related articles}}
 +
{{Article summary wiki|Arch User Repository}}
 +
{{Article summary wiki|AUR User Guidelines}}
 
{{Article summary wiki|AUR Trusted User Guidelines}}
 
{{Article summary wiki|AUR Trusted User Guidelines}}
{{Article summary wiki|ArchLinux User-community Repository (AUR)}}
 
{{Article summary wiki|AUR Q & A}}
 
{{Article summary wiki|Aurbuild}}
 
 
{{Article summary end}}
 
{{Article summary end}}
  
==Purpose==
+
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]]. This document shows the normal user how to access AUR using the web interface and how to work with AUR.
  
The [[ArchLinux User-community Repository (AUR)]] is a community driven repository for Arch users. This document shows the normal user how to access AUR and work with it.
+
==Using the AUR==
  
==The User and the AUR==
+
===Searching the AUR===
 +
The AUR web interface can be found [http://aur.archlinux.org/ here].
  
The normal user plays an essential role in the AUR and without the support, involvement and contribution of the wider user community the AUR cannot fulfil its potential. The lifecycle of an AUR package starts and ends with the user and requires the user to contribute in several ways.
+
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 '\%'.  
  
===Sharing PKGBUILDs in UNSUPPORTED===
+
===Installing Packages from the AUR===
Users can '''share PKGBUILDs''' using the UNSUPPORTED area in the AUR. UNSUPPORTED does not contain any binary packages but allows users to upload PKGBUILDs that can be downloaded by others. A comments facility is provided that allows users to '''feedback improvements''' and suggestions to the PKGBUILD contributor. A new flagging system has been introduced that allows TUs to mark pkgs as checked for malicious code.  However, these PKGBUILDs are completely unofficial and unvetted so should be used with caution and at your own risk.
+
Installing packages from the AUR (aka the [unsupported] repository) is a relatively simple process. Essentially:
 +
# Acquire a [[PKGBUILD]] and any other required files (e.g. patches)
 +
# Run [[makepkg]] in the directory where the files are saved
 +
# Install the resulting package with [[pacman]]
  
There is as yet no official mechanism for downloading build material from UNSUPPORTED but a few scripts can be found on the wiki.
+
What follows is a detailed example of installation of a package called "foo".
  
===[community]===
+
====Prerequisites====
The [community] repo is a supplement to the [extra] and [current] repositories where the most popular packages from UNSUPPORTED are maintained by the Trusted Users group on behalf of the users. [community], unlike UNSUPPORTED, contains binary packages that can be installed directly with pacman and the build files can also be accessed with [[ABS]]. Some of these packages may eventually make the transition to the [current] or [extra] repositories as the developers consider them crucial to the distribution.
+
First ensure that the necessary tools are installed. The package group "base-devel" should be sufficient, as it includes [[makepkg]] and the tools needed for compiling from source.
  
Users can access the AUR [community] repo by adding/uncommenting this line in their pacman.conf file:
+
{{Warning|Packages in the AUR assume "base-devel" is installed, and 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.}}
Include = /etc/pacman.d/community
+
If <code>/etc/pacman.d/community</code> does not exist then it should be created and contain the following:
+
<pre>[community]
+
Server = ftp://ftp.archlinux.org/community/os/i686/</pre>
+
  
Users can also access the [community] build files by editing <code>/etc/abs/abs.conf</code> as follows:
+
# pacman -Sy base-devel
<pre>SUPFILES=(arch extra !unstable community)</pre>
+
  
===Voting===
+
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:
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 - so it is in everyones interest to vote!
+
  
==How to use the AUR==
+
~/builds
  
===Using Packages from UNSUPPORTED===
+
or if using ABS (the [[Arch Build System]]):
To install a pkg from UNSUPPORTED you should follow these steps:
+
* locate the application in the AUR using the [http://aur.archlinux.org/packages.php search feature] (we'll use foo as an example pkg name here) and click the package name in the list of results.  This will bring up the information page for that pkg.  On the left side you can see two links side by side:
+
<pre> Tarball :: Files </pre>
+
* Click <code>Tarball</code> to download the necessary build files to your hard drive.  This should be called <code>foo.tar.gz</code>, for example, if it has been properly submitted.
+
* Copy the <code>foo.tar.gz</code> tarball to a build directory e.g. <code>/var/abs/local</code> and extract it.  This should create a new directory, <code>/var/abs/local/foo</code> that contains all the files necessary to build the pkg.
+
* '''IMPORTANT''': cd to the newly created directory and carefully check the PKGBUILD and any .install file for malicious commands - if in any doubt DO NOT build the pkg and seek advice on the forums or mailing list.
+
* It is suggested you use <code>fakeroot</code> to build pkgs (see below), so having manually confirmed the integrity of the files simply run <code>makepkg</code> as a normal user in the build dir. The source files will be downloaded, verified and built as normal.
+
* makepkg should create an tarball named foo.pkg.tar.gz that can be installed with pacman. e.g.
+
  <code>pacman -U foo.pkg.tar.gz</code>
+
  
===Using <code>fakeroot</code>===
+
/var/abs/local
<code>fakeroot</code> simply allows a normal user the necessary root permissions to create pkgs in the build environment without being able to alter the wider system.  If the build process attempts to alter files outside of the build environment then errors are produced and the build fails - this is very useful for checking the quality/safety/integrity of PKGBUILDs for distribution.  By default <code>export USE_FAKEROOT="y"</code> is included in <code>/etc/makepkg.conf</code>, so unless you have switched it off it is already enabled.
+
 
 +
For more information on ABS read the [[Arch Build System]] article. The example will use {{Filename|~/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 [http://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).
 +
 
 +
====Build the package====
 +
Extract the tarball. Change directories to the build directory if not already there and extract the build files.
 +
 
 +
$ cd ~/builds
 +
$ tar -xvzf foo.tar.gz
 +
 
 +
This should create a new directory called "foo" in the build directory.
 +
 
 +
{{Warning|'''Carefully check all files.'''  Change directories to the newly created directory and carefully check the {{Filename|PKGBUILD}} and any {{Filename|.install}} file for malicious commands.  If in doubt, do NOT build the package and seek advice on the forums or mailing list.}}
 +
 
 +
$ cd foo
 +
$ 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.
 +
 
 +
$ makepkg -s
 +
 
 +
The {{Codeline|-s}} switch will use [[sudo]] to install any needed dependencies. If the use of sudo is undesirable, use fakeroot (see [[#Using fakeroot]]) and exclude the {{Codeline|-s}} in the above command.
 +
 
 +
====Install the package====
 +
Install the package using [[pacman]].  A tarball should have been created named:
 +
 
 +
<application name>-<version number>-<architecture>.pkg.tar.gz
 +
 
 +
This package can be installed using [[pacman]]'s "upgrade" command:
 +
 
 +
# pacman -U foo-0.1-i686.pkg.tar.gz 
 +
 
 +
{{Note|The above example is only a brief summary of the package building process. A visit to the [[makepkg]] and [[ABS]] pages will provide more detail and is highly recommended (particularly for first-time users).}}
 +
 
 +
===Using {{Codeline|fakeroot}}===
 +
{{Codeline|fakeroot}} simply allows a normal user the necessary root permissions to create packages in the build environment without being able to alter the wider system.  If the build process attempts to alter files outside of the build environment then errors are produced and the build fails -- this is very useful for checking the quality/safety/integrity of PKGBUILDs for distribution.  By default, {{Codeline|<nowiki>export USE_FAKEROOT="y"</nowiki>}} is enabled in {{Filename|/etc/makepkg.conf}}.
  
 
===Submitting Packages to UNSUPPORTED===
 
===Submitting Packages to UNSUPPORTED===
After logging in to the AUR web interface, a user can [http://aur.archlinux.org/pkgsubmit.php submit] a tarball (tar.gz) of a directory containing build files for a package. The directory inside the tarball should contain a PKGBUILD, any .install files, patches, etc (ABSOLUTELY no binaries). Examples of what such a directory should look like can be seen inside /var/abs.  
+
After logging in to the AUR web interface, a user can [http://aur.archlinux.org/pkgsubmit.php submit] a gzipped tarball (.tar.gz) of a directory containing build files for a package. The directory inside the tarball should contain a {{Filename|PKGBUILD}}, any {{Filename|.install}} files, patches, etc. (ABSOLUTELY no binaries). Examples of what such a directory should look like can be seen inside {{Filename|/var/abs}} if [[ABS]] was installed.  
 +
 
 +
Note that this is a gzipped tarball - assuming you're uploading a package called 'libfoo', when you create the file it should look similar to this:
 +
$ ls -a libfoo
 +
. .. PKGBUILD libfoo.install
 +
$ makepkg --source
 +
 
 +
# List contents of tarball.
 +
$ 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 [extra], [current], [unstable], UNSUPPORTED, and [community] for the package. If it is inside any of those repositories in ANY form, DO NOT submit the package (if the current package is broken or is lacking an included feature then please file a bug report in [http://bugs.archlinux.org/ FlySpray]).
+
* Check [core], [extra], and [community] for the package. If it is inside any of those repositories in ANY form, DO NOT submit the package (if the current package is broken or is lacking an included feature then please file a bug report in [http://bugs.archlinux.org/ FlySpray]).
* Verify carefully that what you are uploading is correct. All contributors must read and adhere to the [http://wiki.archlinux.org/index.php/Arch_Packaging_Standards Arch Packaging Standards] when writing PKGBUILDs.  This is essential to the smooth running and general success of the AUR.  Remember you are not going to earn any credit or respect from your peers by wasting their time with a bad PKGBUILD.
+
* Check UNSUPPORTED 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.
 +
* 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 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 AUR Mailing List or the 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 AUR Mailing List or the AUR boards on the forum 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.
 
* 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 package.tar.gz with a file named 'package' in it you'll get a an error: 'Could not change to directory /home/aur/unsupported/package/package'.  To resolve this rename the file named 'package' to something else, for example, 'package.rc'.  When it is installed in the pkg directory you may rename it back to 'package'.
  
 
===Maintaining Packages in UNSUPPORTED===
 
===Maintaining Packages in UNSUPPORTED===
Line 81: Line 123:
 
* If you do not want to continue to maintain the package for some reason, <code>disown</code> the pkg 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, <code>disown</code> the pkg using the AUR web interface and/or post a message to the AUR Mailing List.
  
==AUR-DMS (downloading and management scripts)==
+
==The User and the AUR==
  
=== List of AUR-DMS ===
+
The normal user plays an essential role in the AUR and without the support, involvement and contribution of the wider user community the AUR cannot fulfill its potential.  The lifecycle of an AUR package starts and ends with the user and requires the user to contribute in several ways.
#aur-sync (Perl) - for downloading all AUR tartballs
+
#aur-install (bash)
+
#aurup (bash) - for uploading packages to AUR
+
#aurscripts (bash):
+
##aurcreate - create clean packages prepared for upload to AUR
+
##aurdownload - download and extract packages from AUR
+
##aurupdate - update package versions (if specified) and md5sums
+
#autoaur (bash, depends on aurscripts, will automatically update all of your packages installed from AUR)
+
#yaourt (bash, a wrapper for srcpac with aur support and more)
+
#[[aurbuild]] (Python, most voted)
+
#[[aurbuild | qpkg]] (Python, works with non-AUR-apps too, second voted, but most advanced?)
+
+
  
All of these scripts can be found in UNSUPPORTED.
+
===Sharing PKGBUILDs in UNSUPPORTED===
 +
Users can '''share PKGBUILDs''' using the UNSUPPORTED area in the AUR.  UNSUPPORTED does not contain any binary packages but allows users to upload PKGBUILDs that can be downloaded by others.  A comments facility allows users to provide suggestions and feedback on improvements to the PKGBUILD contributor.  These PKGBUILDs are completely unofficial and have not been thoroughly vetted, so they should be used at your own risk.
  
==See also==
+
There is not and will never be an official mechanism for downloading build material from UNSUPPORTED, but there are many scripts and tools which can do so.
*[[Repositories_Structure_Overview | Repositories Structure Overview]]
+
 
 +
===[community]===
 +
The [community] repo is a supplement to the [extra] and [core] repositories where the most popular packages from UNSUPPORTED are maintained by the Trusted Users group on behalf of the users. [community], unlike UNSUPPORTED, contains binary packages that can be installed directly with pacman and the build files can also be accessed with [[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.
 +
 
 +
Users can access the AUR [community] repo by adding/uncommenting this line in their pacman.conf file (''enabled by default''):
 +
Include = /etc/pacman.d/mirrorlist
 +
If <code>/etc/pacman.d/mirrorlist</code> does not exist then it should be created and contain the following:
 +
<pre>[community]
 +
Server = ftp://ftp.archlinux.org/community/os/i686/</pre>
 +
 
 +
Users can also access the [community] build files by editing <code>/etc/abs.conf</code> and removing the exclamation mark from in front of the community repo (''disabled by default''), as follows:
 +
<pre>REPOS=(core extra community !testing)</pre>
 +
 
 +
===Voting===
 +
One of the easiest activities for '''all''' Arch users is to browse the AUR and '''vote''' for their favorite 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 - so it is in everyone's interest to vote!
 +
 
 +
===Install an AUR Helper===
 +
[[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 AUR.
 +
 
 +
All of these scripts can be found in UNSUPPORTED.

Revision as of 17:24, 2 January 2010

Template:Article summary start Template:Article summary text Template:Article summary heading Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary end

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. This document shows the normal user how to access AUR using the web interface and how to work with AUR.

Using the AUR

Searching the AUR

The AUR web interface can be found here.

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 from the AUR

Installing packages from the AUR (aka the [unsupported] repository) is a relatively simple process. Essentially:

  1. Acquire a PKGBUILD and any other required files (e.g. patches)
  2. Run makepkg in the directory where the files are saved
  3. Install the resulting package with pacman

What follows is a detailed example of installation of a package called "foo".

Prerequisites

First ensure that the necessary tools are installed. The package group "base-devel" should be sufficient, as it includes makepkg and the tools needed for compiling from source.

Warning: Packages in the AUR assume "base-devel" is installed, and 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 -Sy 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

or if using ABS (the Arch Build System):

/var/abs/local

For more information on ABS read the Arch Build System article. The example will use Template:Filename 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.

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

Build the package

Extract the tarball. Change directories to the build directory if not already there and extract the build files.

$ cd ~/builds
$ tar -xvzf foo.tar.gz

This should create a new directory called "foo" in the build directory.

Warning: Carefully check all files. Change directories to the newly created directory and carefully check the Template:Filename and any Template:Filename file for malicious commands. If in doubt, do NOT build the package and seek advice on the forums or mailing list.
$ cd foo
$ 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.

$ makepkg -s

The Template:Codeline switch will use sudo to install any needed dependencies. If the use of sudo is undesirable, use fakeroot (see #Using fakeroot) and exclude the Template:Codeline in the above command.

Install the package

Install the package using pacman. A tarball should have been created named:

<application name>-<version number>-<architecture>.pkg.tar.gz

This package can be installed using pacman's "upgrade" command:

# pacman -U foo-0.1-i686.pkg.tar.gz   
Note: The above example is only a brief summary of the package building process. A visit to the makepkg and ABS pages will provide more detail and is highly recommended (particularly for first-time users).

Using Template:Codeline

Template:Codeline simply allows a normal user the necessary root permissions to create packages in the build environment without being able to alter the wider system. If the build process attempts to alter files outside of the build environment then errors are produced and the build fails -- this is very useful for checking the quality/safety/integrity of PKGBUILDs for distribution. By default, Template:Codeline is enabled in Template:Filename.

Submitting Packages to UNSUPPORTED

After logging in to the AUR web interface, a user can submit a gzipped tarball (.tar.gz) of a directory containing build files for a package. The directory inside the tarball should contain a Template:Filename, any Template:Filename files, patches, etc. (ABSOLUTELY no binaries). Examples of what such a directory should look like can be seen inside Template:Filename if ABS was installed.

Note that this is a gzipped tarball - assuming you're uploading a package called 'libfoo', when you create the file it should look similar to this:

$ ls -a libfoo
. .. PKGBUILD libfoo.install
$ makepkg --source
# List contents of tarball.
$ tar tf libfoo-0.1-1.src.tar.gz
libfoo/
libfoo/PKGBUILD
libfoo/libfoo.install

When submitting a package, observe the following rules:

  • Check [core], [extra], and [community] for the package. If it is inside any of those repositories in ANY form, DO NOT submit the package (if the current package is broken or is lacking an included feature then please file a bug report in FlySpray).
  • Check UNSUPPORTED 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.
  • 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 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 boards on the forum 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.
  • Gain some experience before submitting packages. Build a few packages to learn the process and then submit.
  • If you submit a package.tar.gz with a file named 'package' in it you'll get a an error: 'Could not change to directory /home/aur/unsupported/package/package'. To resolve this rename the file named 'package' to something else, for example, 'package.rc'. When it is installed in the pkg directory you may rename it back to 'package'.

Maintaining Packages in UNSUPPORTED

  • Check for feedback and comments from other users and try to incorporate any improvements they suggest; consider it a learning process!
  • Please DO NOT just submit and forget about packages! While in UNSUPPORTED, it is the user'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 pkg using the AUR web interface and/or post a message to the AUR Mailing List.

The User and the AUR

The normal user plays an essential role in the AUR and without the support, involvement and contribution of the wider user community the AUR cannot fulfill its potential. The lifecycle of an AUR package starts and ends with the user and requires the user to contribute in several ways.

Sharing PKGBUILDs in UNSUPPORTED

Users can share PKGBUILDs using the UNSUPPORTED area in the AUR. UNSUPPORTED does not contain any binary packages but allows users to upload PKGBUILDs that can be downloaded by others. A comments facility allows users to provide suggestions and feedback on improvements to the PKGBUILD contributor. These PKGBUILDs are completely unofficial and have not been thoroughly vetted, so they should be used at your own risk.

There is not and will never be an official mechanism for downloading build material from UNSUPPORTED, but there are many scripts and tools which can do so.

[community]

The [community] repo is a supplement to the [extra] and [core] repositories where the most popular packages from UNSUPPORTED are maintained by the Trusted Users group on behalf of the users. [community], unlike UNSUPPORTED, contains binary packages that can be installed directly with pacman and the build files can also be accessed with 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.

Users can access the AUR [community] repo by adding/uncommenting this line in their pacman.conf file (enabled by default):

Include = /etc/pacman.d/mirrorlist

If /etc/pacman.d/mirrorlist does not exist then it should be created and contain the following:

[community]
Server = ftp://ftp.archlinux.org/community/os/i686/

Users can also access the [community] build files by editing /etc/abs.conf and removing the exclamation mark from in front of the community repo (disabled by default), as follows:

REPOS=(core extra community !testing)

Voting

One of the easiest activities for all Arch users is to browse the AUR and vote for their favorite 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 - so it is in everyone's interest to vote!

Install an AUR Helper

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

All of these scripts can be found in UNSUPPORTED.