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