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