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