Add new alpm_list_remove_item() function
[pacman-ng.git] / doc / index.txt
blob0e037ac6d202c52c9eebebd6ba938a272fdeb868
1 Pacman Home Page
2 ================
4 A simple library-based package manager.
6 Introduction
7 ------------
8 pacman is a utility which manages software packages in Linux. It uses simple
9 compressed files as a package format, and maintains a text-based package
10 database (more of a hierarchy), just in case some hand tweaking is necessary.
12 pacman does not strive to "do everything." It will add, remove and upgrade
13 packages in the system, and it will allow you to query the package database for
14 installed packages, files and owners. It also attempts to handle dependencies
15 automatically and can download packages from a remote server.
17 History
18 ~~~~~~~
19 Version 2.0 of pacman introduced the ability to sync packages (the `--sync`
20 option) with a master server through the use of package databases. Prior to
21 this, packages would have to be installed manually using the `--add` and
22 `--upgrade` operations.
24 Version 3.0 was the switch to a two-part pacman- a backend named libalpm
25 (library for Arch Linux Package Management), and the familiar pacman frontend.
26 Speed in many cases was improved, along with dependency and conflict resolution
27 being able to handle a much wider variety of cases. The switch to a
28 library-based program should also make it easier in the future to develop
29 alternative front ends.
31 Documentation
32 -------------
34 Manpages
35 ~~~~~~~~
36 There are several manpages available for the programs, utilities, and
37 configuration files dealing with pacman.
39 * linkman:PKGBUILD[5]
40 * linkman:libalpm[3]
41 * linkman:makepkg[8]
42 * linkman:makepkg.conf[5]
43 * linkman:pacman[8]
44 * linkman:pacman.conf[5]
45 * linkman:repo-add[8]
46 * linkman:vercmp[8]
48 Changelog
49 ~~~~~~~~~
50 For a good idea of what is going on in pacman development, take a look at the
51 link:http://projects.archlinux.org/pacman.git/[Git summary page] for the
52 project.
54 See the most recent
55 link:http://projects.archlinux.org/pacman.git/tree/NEWS[NEWS]
56 file for a not-as-frequently-updated list of changes. However, this should
57 contain the biggest changes in a format more concise than the commit log.
60 Releases
61 --------
63 `------------`-------
64 Date         Version
65 ---------------------
66 2011-01-22   v3.4.3
67 2010-12-29   v3.4.2
68 2010-09-03   v3.4.1
69 2010-06-16   v3.4.0
70 2009-11-10   v3.3.3
71 2009-10-05   v3.3.2
72 2009-09-22   v3.3.1
73 2009-08-02   v3.3.0
74 2009-01-05   v3.2.2
75 2008-08-26   v3.2.1
76 2008-07-30   v3.2.0
77 2008-04-01   v3.1.4
78 2008-03-06   v3.1.3
79 2008-02-20   v3.1.2
80 2008-01-20   v3.1.1
81 2008-01-09   v3.1.0
82 2007-09-16   v3.0.6
83 2007-06-17   v3.0.5
84 2007-05-08   v3.0.4
85 2007-04-28   v3.0.3
86 2007-04-23   v3.0.2
87 2007-04-04   v3.0.1
88 2007-03-25   v3.0.0
89 2006-02-02   v2.9.8
90 2005-09-16   v2.9.7
91 2005-06-10   v2.9.6
92 2005-01-11   v2.9.5
93 2004-12-19   v2.9.4
94 2004-12-18   v2.9.3
95 2004-09-25   v2.9.2
96 2004-09-24   v2.9.1
97 2004-09-18   v2.9
98 ---------------------
100 Source code for all releases is available at
101 link:ftp://ftp.archlinux.org/other/pacman/[]. To install, download the newest
102 available source tarball, unpack it in a directory, and run the three magic
103 commands:
105     $ ./configure
106     $ make
107     # make install
109 You may wish to read the options presented by `./configure --help` in order to
110 set appropriate paths and build options that are correct for your system.
112 Development
113 -----------
115 Mailing List
116 ~~~~~~~~~~~~
117 There is a mailing list devoted to pacman development, hosted by Arch Linux.
118 link:http://mailman.archlinux.org/mailman/listinfo/pacman-dev/[Subscribe] or
119 link:http://mailman.archlinux.org/pipermail/pacman-dev/[view the archives].
121 Source Code
122 ~~~~~~~~~~~
123 Development of pacman is currently done in GIT. The central repository is
124 hosted by Arch Linux, although some of the developers have their own trees (ask
125 on the above mailing lists if you are interested in finding the locations of
126 these trees).
128 The current development tree can be fetched with the following command:
130     git clone git://projects.archlinux.org/pacman.git pacman
132 which will fetch the full development history into a directory named pacman.
133 You can browse the source as well using
134 link:http://projects.archlinux.org/pacman.git/[cgit]. HTTP/HTTPS URLs are also
135 available for cloning purposes; these URLs are listed at the above page.
137 If you are interested in hacking on pacman, it is highly recommended you join
138 the mailing list mentioned above, as well as take a quick glance at our
139 link:HACKING.html[HACKING] document.
140 link:submitting-patches.html[submitting-patches] is also a recommended read.
142 Not as familiar with code as you'd like to be, but still want to help out? If
143 you speak a foreign language, you can help by either creating or updating a
144 translation file for your native language. Instructions can be found in
145 link:translation-help.html[translation-help].
147 Other Utilities
148 ~~~~~~~~~~~~~~~
149 Although the package manager itself is quite simple, many scripts have been
150 developed that help automate building and installing packages. These are used
151 extensively in link:http://archlinux.org/[Arch Linux]. Most of these utilities
152 are available in the Arch Linux projects
153 link:http://projects.archlinux.org/[code browser].
155 Utilities available:
157 * link:http://projects.archlinux.org/abs.git/[abs] - ABS (Arch Build System), scripts to download  & use the Arch Linux PKGBUILD tree
158 * link:http://projects.archlinux.org/dbscripts.git/[dbscripts] - scripts used by Arch Linux to manage the main package repositories
159 * link:http://projects.archlinux.org/devtools.git/[devtools] - tools to assist in packaging and dependency checking
160 * link:http://projects.archlinux.org/namcap.git/[namcap] - a package analysis utility written in python
161 * link:http://projects.archlinux.org/srcpac.git/[srcpac] - a bash build-from-source pacman wrapper
163 Bugs
164 ----
165 If you find bugs (which is quite likely), please email them to the pacman-dev
166 mailing last at mailto:pacman-dev@archlinux.org[] with specific information
167 such as your commandline, the nature of the bug, and even the package database
168 if it helps.
170 You can also post a bug to the Arch Linux bug tracker
171 link:http://bugs.archlinux.org/index.php?project=3[Flyspray]. Be sure to file
172 bugs under the Pacman project.
174 Pacman/libalpm in the Wild
175 --------------------------
176 Although Arch Linux is the primary user of pacman and libalpm, other
177 distributions and projects also use pacman as a package management tool. In
178 addition, there have been several projects started to provide a frontend GUI to
179 pacman and/or libalpm.
181 Arch derivatives:
183 * link:http://archie.dotsrc.org/[Archie] - Arch Live on steroids
184 * link:http://www.faunos.com/[FaunOS] - A portable, fully integrated operating system based on Arch Linux
185 * link:http://larch.berlios.de/[larch] - A live CD/DVD/USB-stick construction kit for Arch Linux
187 Other distributions:
189 * link:http://www.delilinux.org/[DeLi Linux] - "Desktop Light" Linux, a Linux distribution for old computers
190 * link:http://www.frugalware.org/[Frugalware Linux] - A general purpose Linux distribution for intermediate users (pacman is forked and maintained separately)
192 Pacman/libalpm frontends:
194 * link:http://shaman.iskrembilen.com/[Shaman] - A GUI frontend using Qt and libalpm
196 Copyright
197 ---------
198 pacman is Copyright (C) 2006-2011 Pacman Development Team
199 <pacman-dev@archlinux.org> and Copyright (C) 2002-2006 Judd Vinet
200 <jvinet@zeroflux.org> and is licensed through the GNU General Public License,
201 version 2 or later.
203 /////
204 vim: set ts=2 sw=2 syntax=asciidoc et:
205 /////