Use ignoregroup rather than ignoregrp in the handle
[pacman-ng.git] / doc / index.txt
blob4cc83132f40c7923e2f8ed24608e0da4031e9a3e
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-key[8]
45 * linkman:pacman.conf[5]
46 * linkman:pkgdelta[8]
47 * linkman:repo-add[8]
48 * linkman:vercmp[8]
50 Changelog
51 ~~~~~~~~~
52 For a good idea of what is going on in pacman development, take a look at the
53 link:http://projects.archlinux.org/pacman.git/[Git summary page] for the
54 project.
56 See the most recent
57 link:http://projects.archlinux.org/pacman.git/tree/NEWS[NEWS]
58 file for a not-as-frequently-updated list of changes. However, this should
59 contain the biggest changes in a format more concise than the commit log.
62 Releases
63 --------
65 `------------`-------
66 Date         Version
67 ---------------------
68 2011-04-18   v3.5.2
69 2011-03-23   v3.5.1
70 2011-03-16   v3.5.0
71 2011-01-22   v3.4.3
72 2010-12-29   v3.4.2
73 2010-09-03   v3.4.1
74 2010-06-16   v3.4.0
75 2009-11-10   v3.3.3
76 2009-10-05   v3.3.2
77 2009-09-22   v3.3.1
78 2009-08-02   v3.3.0
79 2009-01-05   v3.2.2
80 2008-08-26   v3.2.1
81 2008-07-30   v3.2.0
82 2008-04-01   v3.1.4
83 2008-03-06   v3.1.3
84 2008-02-20   v3.1.2
85 2008-01-20   v3.1.1
86 2008-01-09   v3.1.0
87 2007-09-16   v3.0.6
88 2007-06-17   v3.0.5
89 2007-05-08   v3.0.4
90 2007-04-28   v3.0.3
91 2007-04-23   v3.0.2
92 2007-04-04   v3.0.1
93 2007-03-25   v3.0.0
94 2006-02-02   v2.9.8
95 2005-09-16   v2.9.7
96 2005-06-10   v2.9.6
97 2005-01-11   v2.9.5
98 2004-12-19   v2.9.4
99 2004-12-18   v2.9.3
100 2004-09-25   v2.9.2
101 2004-09-24   v2.9.1
102 2004-09-18   v2.9
103 ---------------------
105 Source code for all releases is available at
106 link:ftp://ftp.archlinux.org/other/pacman/[]. To install, download the newest
107 available source tarball, unpack it in a directory, and run the three magic
108 commands:
110     $ ./configure
111     $ make
112     # make install
114 You may wish to read the options presented by `./configure --help` in order to
115 set appropriate paths and build options that are correct for your system.
117 Development
118 -----------
120 Mailing List
121 ~~~~~~~~~~~~
122 There is a mailing list devoted to pacman development, hosted by Arch Linux.
123 link:http://mailman.archlinux.org/mailman/listinfo/pacman-dev/[Subscribe] or
124 link:http://mailman.archlinux.org/pipermail/pacman-dev/[view the archives].
126 Source Code
127 ~~~~~~~~~~~
128 Development of pacman is currently done in GIT. The central repository is
129 hosted by Arch Linux, although some of the developers have their own trees (ask
130 on the above mailing lists if you are interested in finding the locations of
131 these trees).
133 The current development tree can be fetched with the following command:
135     git clone git://projects.archlinux.org/pacman.git pacman
137 which will fetch the full development history into a directory named pacman.
138 You can browse the source as well using
139 link:http://projects.archlinux.org/pacman.git/[cgit]. HTTP/HTTPS URLs are also
140 available for cloning purposes; these URLs are listed at the above page.
142 If you are interested in hacking on pacman, it is highly recommended you join
143 the mailing list mentioned above, as well as take a quick glance at our
144 link:HACKING.html[HACKING] document.
145 link:submitting-patches.html[submitting-patches] is also a recommended read.
147 Not as familiar with code as you'd like to be, but still want to help out? If
148 you speak a foreign language, you can help by either creating or updating a
149 translation file for your native language. Instructions can be found in
150 link:translation-help.html[translation-help].
152 Other Utilities
153 ~~~~~~~~~~~~~~~
154 Although the package manager itself is quite simple, many scripts have been
155 developed that help automate building and installing packages. These are used
156 extensively in link:http://archlinux.org/[Arch Linux]. Most of these utilities
157 are available in the Arch Linux projects
158 link:http://projects.archlinux.org/[code browser].
160 Utilities available:
162 * link:http://projects.archlinux.org/abs.git/[abs] - ABS (Arch Build System), scripts to download  & use the Arch Linux PKGBUILD tree
163 * link:http://projects.archlinux.org/dbscripts.git/[dbscripts] - scripts used by Arch Linux to manage the main package repositories
164 * link:http://projects.archlinux.org/devtools.git/[devtools] - tools to assist in packaging and dependency checking
165 * link:http://projects.archlinux.org/namcap.git/[namcap] - a package analysis utility written in python
166 * link:http://projects.archlinux.org/srcpac.git/[srcpac] - a bash build-from-source pacman wrapper
168 Bugs
169 ----
170 If you find bugs (which is quite likely), please email them to the pacman-dev
171 mailing last at mailto:pacman-dev@archlinux.org[] with specific information
172 such as your commandline, the nature of the bug, and even the package database
173 if it helps.
175 You can also post a bug to the Arch Linux bug tracker
176 link:http://bugs.archlinux.org/index.php?project=3[Flyspray]. Be sure to file
177 bugs under the Pacman project.
179 Pacman/libalpm in the Wild
180 --------------------------
181 Although Arch Linux is the primary user of pacman and libalpm, other
182 distributions and projects also use pacman as a package management tool. In
183 addition, there have been several projects started to provide a frontend GUI to
184 pacman and/or libalpm.
186 Arch derivatives:
188 * link:http://archie.dotsrc.org/[Archie] - Arch Live on steroids
189 * link:http://www.faunos.com/[FaunOS] - A portable, fully integrated operating system based on Arch Linux
190 * link:http://larch.berlios.de/[larch] - A live CD/DVD/USB-stick construction kit for Arch Linux
192 Other distributions:
194 * link:http://www.delilinux.org/[DeLi Linux] - "Desktop Light" Linux, a Linux distribution for old computers
195 * link:http://www.frugalware.org/[Frugalware Linux] - A general purpose Linux distribution for intermediate users (pacman is forked and maintained separately)
197 Pacman/libalpm frontends:
199 * link:http://shaman.iskrembilen.com/[Shaman] - A GUI frontend using Qt and libalpm
201 Copyright
202 ---------
203 pacman is Copyright (C) 2006-2011 Pacman Development Team
204 <pacman-dev@archlinux.org> and Copyright (C) 2002-2006 Judd Vinet
205 <jvinet@zeroflux.org> and is licensed through the GNU General Public License,
206 version 2 or later.
208 /////
209 vim: set ts=2 sw=2 syntax=asciidoc et:
210 /////