fix formatting error and remove duplicate links
[ikiwiki.git] / docs / howtos / HowToPkgsrc.mdwn
1 # pkgsrc on DragonFly
2
3 The following page describes the basics of the pkgsrc system as used by DragonFly.
4
5 [[!toc levels=2 ]]
6
7 ## Overview 
8
9 ### History 
10 [Pkgsrc](http://www.pkgsrc.org) is a packaging system that was originally created for NetBSD. It has been ported to DragonFly, along with other operating systems.  Pkgsrc is very similar to FreeBSD's ports mechanism.
11
12 ### Overview
13
14 If you have used a UNIX® system before you will know that the typical procedure for installing third party software goes something like this:
15
16   1. Download the software, which might be distributed in source code format, or as a binary.
17
18   1. Unpack the software from its distribution format (typically a tarball compressed with [compress(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=compress&section1), [gzip(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=gzip&section=1), or [bzip2(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=bzip2&section=1)).
19
20   1. Locate the documentation (perhaps an `INSTALL` or `README` file, or some files in a `doc/` subdirectory) and read up on how to install the software.
21
22   1. If the software was distributed in source format, compile it. This may involve editing a `Makefile`, or running a `configure` script, and other work.
23
24   1. Test and install the software.
25
26 And that is only if everything goes well. If you are installing a software package that was not deliberately ported to DragonFly you may even have to go in and edit the code to make it work properly. Should you want to, you can continue to install software the ***traditional*** way with DragonFly. However, DragonFly provides technology from NetBSD, which can save you a lot of effort: pkgsrc. At the time of writing, over 8,000 third party applications have been made available in this way.
27
28 For any given application, the DragonFly Binary package for that application is a single file which you must download. The package contains pre-compiled copies of all the commands for the application, as well as any configuration files or documentation. A downloaded package file can be manipulated with DragonFly package management commands, such as [pkg_radd(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_add&section1), [pkg_delete(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_delete&section=1), [pkg_info(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_info&section=1), and so on. Installing a new application can be carried out with a single command.
29
30
31
32 In addition the pkgsrc collection supplies a collection of files designed to automate the process of compiling an application from source code. Remember that there are a number of steps you would normally carry out if you compiled a program yourself (downloading, unpacking, patching, compiling, installing). The files that make up a pkgsrc source collection contain all the necessary information to allow the system to do this for you. You run a handful of simple commands and the source code for the application is automatically downloaded, extracted, patched, compiled, and installed for you. In fact, the pkgsrc source subsystem can also be used to generate packages which can later be manipulated with `pkg_add` and the other package management commands that will be introduced shortly.
33
34 Pkgsrc understands ***dependencies***. Suppose you want to install an application that depends on a specific library being installed. Both the application and the library have been made available through the pkgsrc collection. If you use the `pkg_add` command or the pkgsrc subsystem to add the application, both will notice that the library has not been installed, and automatically install the library first. You might be wondering why pkgsrc® bothers with both. Binary packages and the source tree both have their own strengths, and which one you use will depend on your own preference.
35
36  **Binary Package Benefits** 
37
38 * A compressed package tarball is typically smaller than the compressed tarball containing the source code for the application.
39
40 * Packages do not require any additional compilation. For large applications, such as ***Mozilla***, ***KDE***, or ***GNOME*** this can be important, particularly if you are on a slow system.
41
42 * Packages do not require any understanding of the process involved in compiling software on DragonFly.
43
44
45 **Pkgsrc source Benefits** 
46
47
48 * Binary packages are normally compiled with conservative options, because they have to run on the maximum number of systems. By installing from the source, you can tweak the compilation options to (for example) generate code that is specific to a Pentium IV or Athlon processor.
49
50 * Some applications have compile time options relating to what they can and cannot do. For example, <i>Apache</i> can be configured with a wide variety of different built-in options. By building from the source you do not have to accept the default options, and can set them yourself. In some cases, multiple packages will exist for the same application to specify certain settings. For example, <i>vim</i> is available as a `vim` package and a `vim-gtk` package, depending on whether you have installed an X11 server. This sort of rough tweaking is possible with packages, but rapidly becomes impossible if an application has more than one or two different compile time options.
51
52 * The licensing conditions of some software distributions forbid binary distribution. They must be distributed as source code.
53
54 * Some people do not trust binary distributions. With source code, it is possible to check for any vulnerabilities built into the program before installing it to an otherwise secure system. Few people perform this much review, however.
55
56 * If you have local patches, you will need the source in order to apply them.
57
58 * Some people like having code around, so they can read it if they get bored, hack it, borrow from it (license permitting, of course), and so on.
59
60 To keep track of updated pkgsrc releases subscribe to the [NetBSD pkgsrc users mailing list](http://www.netbsd.org/MailingLists/pkgsrc-users) and the [NetBSD pkgsrc users mailing list](http://www.netbsd.org/MailingLists/tech-pkgsrc). It's also useful to watch the [DragonFly User related mailing list](http://leaf.dragonflybsd.org/mailarchive/) as errors with pkgsrc on DragonFly should be reported there.
61
62  **Warning:** Before installing any application, you should check http://www.pkgsrc.org/ for security issues related to your application.
63
64 Audit-packages will automatically check all installed applications for known vulnerabilities, a check will be also performed before any application build. Meanwhile, you can use the command `audit-packages -d` after you have installed some packages.
65
66 ## Installing pkgsrc 
67
68 The basic pkgsrc tools are provided with every DragonFly system as part of installation.  However, you still need to download the pkgsrc tree for building applications with these tools.  
69
70 As root:
71
72     # cd /usr
73     # make pkgsrc-create
74
75 to fetch the intial pkgsrc repository from the net, or
76
77     # cd /usr
78     # make pkgsrc-update
79
80 to update.
81
82 Edit /usr/Makefile to select a different download location, if desired.
83
84 This downloads the absolute most recent version of pkgsrc.  In a production environment, you may want a more stable release.  Check the section below for more details.
85
86 ### Tracking the stable branch 
87
88 There are quarterly releases of pkgsrc that are specifically designed for stability.  You should in general follow the latest branch, rather than bleeding edge pkgsrc.
89
90 To see the available branches:
91
92     cd /usr/pkgsrc 
93     git branch -r
94
95 To switch to a recent branch:
96
97     cd /usr/pkgsrc 
98     git branch pkgsrc-2010Q3 origin/pkgsrc-2010Q3
99
100 Branch naming format is 'pkgsrc-YYYYQX', where YYYY is the year and QX is quarters 1-4 of the year.  Check [pkgsrc.org](http://www.pkgsrc.org/) to see the name of the most recently released branch.
101
102 After switching to a new branch, it can be downloaded with:
103
104     cd /usr/pkgsrc 
105     git checkout vendor
106     git pull
107
108 ## Dealing with pkgsrc packages
109
110 The following section explains how to find, install and remove pkgsrc packages.
111
112 ### Finding Your Application 
113
114 Before you can install any applications you need to know what you want, and what the application is called. DragonFly's list of available applications is growing all the time. Fortunately, there are a number of ways to find what you want:
115
116 Since DragonFly 1.11 [pkg_search(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_search&section1) is included in the base system.  [pkg_search(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_search&section=1) searches an already installed pkgsrc INDEX for for a given package name.  If pkgsrc is not installed or the INDEX file is missing, it fetches the [pkg_summary(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_summary&section=5) file.
117
118     # pkg_search fvwm
119     fvwm-2.4.20nb1          Newer version of X11 Virtual window manager
120     fvwm-2.5.24             Development version of X11 Virtual window manager
121     fvwm-themes-0.6.2nb8    Configuration framework for fvwm2 with samples
122     fvwm-wharf-1.0nb1       Copy of AfterStep's Wharf compatible with fvwm2
123     fvwm1-1.24rnb1          Virtual window manager for X
124
125     # pkg_search -v fvwm-2.5
126     Name    : fvwm-2.5.24-50
127     Dir     : wm/fvwm-devel                                     
128     Desc    : Development version of X11 Virtual window manager 
129     URL     : any                                               
130     Deps    : perl>#5.0 gettext-lib>0.14.5 [...]
131
132 Its also possible to issue the command
133
134     # cd /usr/pkgsrc/
135     # bmake search key='package you are looking for'
136
137 from the `/usr/pkgsrc` directory.
138
139 It's also possible to browse website that show all the available pkgsrc packages, such as [http://pkgsrc.se/](http://pkgsrc.se) .
140
141 ### Installing applications from source
142
143 Packages are built by going into the appropriate directory and issuing `bmake install clean`. For example, to build the *screen* package you need to issue the following commands.
144
145     # cd /usr/pkgsrc/misc/screen
146     # bmake install clean
147
148 To find out the options that can affect how a program is built:
149
150     # bmake show-options
151
152 To change options:
153
154     # bmake PKG_OPTIONS.<package_name>="-option1 option2" install clean
155
156 Listing an option enables it.  Listing an option with a "-" before it disables the option.
157
158 To make these option changes permanent for every future build or upgrade of this package, put a similar line in `/usr/pkg/etc/mk.conf`:
159
160      . PKG_OPTIONS.<package_name>=-option1 option2
161     
162 ### Installing pre-built packages 
163
164 Binary packages can be installed using *pkg_radd*:
165
166     # pkg_radd screen
167
168 This program works by setting the `PKG_PATH` enviroment variable to the appropriate path for the operating system and architecture to a remote repository of binary packages, and then using pkg_add to get packages.
169
170 You can manually set PKG_PATH and use pkg_add to get the same effect, using a different server.
171
172     # setenv PKG_PATH http://mirror-master.dragonflybsd.org/packages/i386/DragonFly-2.7/stable
173     # pkg_add screen
174
175 *Note:* The above URL is for the DragonFly-2.7 on i386.  Adjust the file path to match your installation and what's available on the server.
176
177 This will install most packages, but will not upgrade packages that are already installed.
178
179 ***Note:*** that the default remote repository for binary packages tracks quarterly pkgsrc releases, so your local install of pkgsrc should be the same quarterly release.
180
181 Some packages are not licensed for distribution in binary form, so they may be able to build on DragonFly but won't be available with *pkg_radd*.  If it fails, try going to that package's directory and install the package manually as described above.
182
183 #### Dealing with different package versions 
184
185 It is possible that you see a warning when installing binary packages on a DEVELOPMENT-version of DragonFly.  The warning could look like this:
186
187     pkg_add: Warning: package `vim-gtk2-7.1.116.tgz' was built for a different version of the OS:
188     pkg_add: DragonFly/i386 1.10.1 (pkg) vs. DragonFly/i386 1.11.0 (this host)
189
190 You can safely ignore this warning.  Normally all packages build for RELEASE run fine on DEVELOPMENT unless a major API-breakage was introduced.  In this case you would see a message from the developers on the appropriate mailing list.
191
192 ### List all installed applications 
193
194 To obtain a list of all the packages that are installed on your system:
195
196     # pkg_info
197
198 To see if certain packages have been installed, filter for the name of the package.  This example will show all xorg-related packages currently installed on the system:
199
200     # pkg_info | grep xorg
201
202 ### Removing packages
203
204 If a program was installed as a package:
205
206     # pkg_delete packagename
207
208 If a package was installed from the source files, you can also change to the directory they were installed from and issue the command:
209
210     # bmake deinstall
211
212 #### Remove associated files needed for building a package 
213
214 To remove the work file from building a package, and the package's dependencies:
215
216     # bmake clean clean-depends
217
218 This can be combined with other steps:
219
220     # bmake install clean clean-depends
221
222 ## Upgrading packages 
223
224 There's a number of ways to upgrade pkgsrc; some of these are built in and some are packages installable with pkgsrc.  This list is not necessarily comprehensive. Be sure to read the note about upgrading pkgsrc system packages at the end of this subsection!
225
226 ### pkg_rolling-replace
227
228 *pkg_rolling-replace* replaces packages one by one and one can use it for a better way of package management. Actually it does `make replace` on one package at a time, sorting the packages being replaced according to their interdependencies, which avoids most duplicate rebuilds. Once *pkg_rolling-replace* is installed you can update the packages through the following steps.
229
230     # cd /usr && make pkgsrc-update
231     # pkg_rolling-replace -u
232
233 ### pkgin
234
235 Downloads and installs binary packages.  Check the [[mirrors]] page for sites carrying binary packages to use with pkgin. You can run the following commands to get the packages updated. This assumes that *pkgin* is already configured. Please consult the documentation and the man page on how to do so.
236
237     # pkgin update
238     # pkgin full-upgrade 
239
240 ### pkg_chk
241
242 It updates packages by removing them and rebuilding them.  Warning: programs are unavailable until a rebuild finishes.  If they don't rebuild, it won't work. *pkg_chk* requires a few steps in order to work correctly. They are listed here.
243
244     # pkg_chk -g  # make initial list of installed packages
245     # pkg_chk -r  # remove all packages that are not up to date and packages that depend on them
246     # pkg_chk -a  # install all missing packages (use binary packages, this is the default)
247     # pkg_chk -as # install all missing packages (build from source)
248
249 The above process removes all packages at once and installs the missing packages one by one. This can cause longer disruption of services when the removed package has to wait a long time for its turn to get installed. 
250
251 ### bmake update
252
253 Performed in the `/usr/pkgsrc` directory that correlates with the installed package, the software is deleted and rebuilt.  The same warning applies as with *pkg_chk*.
254
255 ### pkg_add -u
256
257 Point at a local or online binary archive location to download and update packages.
258
259 #### Update pkgsrc system packages
260
261 **Note**: Sometimes, basic pkgsrc tools, like bmake or pkg_install, need to be upgraded.  However, they can't be deleted and replaced since you need that tool to accomplish replacement.  The solution is to build a separate package before deletion, and install that package. Inside the packages directory (`/usr/pkgsrc/devel/bmake` in this case)
262
263     # env USE_DESTDIR=full bmake package
264     # bmake clean-depends clean
265
266 And go to the packages directory and install the binary package with
267
268     # pkg_add -u <pkg_name> (i.e. the name of the .tgz file).
269     # bmake replace USE_DESTDIR=yes
270
271 ## Start pkgsrc applications on system startup
272
273 Packages often install rc.d scripts to control software running on startup.  To specify where the rc.d scripts from the installed packages should go, add the following lines to your `/usr/pkg/etc/mk.conf` file:
274
275     RCD_SCRIPTS_DIR=/etc/rc.d
276     PKG_RCD_SCRIPTS=YES
277
278 This option can be set in the environment to activate it for binary packages.  These packages will still have to be enabled in `/etc/rc.conf/` to run at boot.  If these options aren't set, the rc file will be placed in `/usr/pkg/share/examples/rc.d/` and will need to be manually copied over to `/etc/rc.d`.
279
280 Many other options can be set in this file; see `/usr/pkgsrc/mk/defaults/mk.conf` for examples.
281
282 ## Miscellaneous topics
283
284 ### Post-installation Activities 
285
286 After installing a new application you will normally want to read any documentation it may have included, edit any configuration files that are required, ensure that the application starts at boot time (if it is a daemon), and so on.
287  The exact steps you need to take to configure each application will obviously be different. However, if you have just installed a new application and are wondering *What now?* These tips might help:
288
289 Use [pkg_info(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_info&section=1) to find out which files were installed, and where. For example, if you have just installed Foo_Package version 1.0.0, then this command
290
291     # pkg_info -L foopackage-1.0.0 | less
292
293 will show all the files installed by the package. Pay special attention to files in `man/` directories, which will be manual pages, `etc/` directories, which will be configuration files, and `doc/`, which will be more comprehensive documentation. If you are not sure which version of the application was just installed, a command like this
294
295     # pkg_info | grep -i foopackage
296
297 will find all the installed packages that have <i>foopackage</i> in the package name. Replace <i>foopackage</i> in your command line as necessary.
298
299 Once you have identified where the application's manual pages have been installed, review them using [man(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=man&section=1). Similarly, look over the sample configuration files, and any additional documentation that may have been provided. If the application has a web site, check it for additional documentation, frequently asked questions, and so forth. If you are not sure of the web site address it may be listed in the output from
300
301     # pkg_info foopackage-1.0.0
302
303 A `WWW:` line, if present, should provide a URL for the application's web site.
304
305 ### Dealing with Broken Packages 
306
307 If you come across a package that does not work for you, there are a few things you can do, including:
308
309   1. Fix it! The [pkgsrc Guide](http://www.netbsd.org/Documentation/pkgsrc/) includes detailed information on the ***pkgsrc®*** infrastructure so that you can fix the occasional broken package or even submit your own!
310
311   1. Send email to the maintainer of the package first. Type `bmake maintainer` or read the `Makefile` to find the maintainer's email address. Remember to include the name and version of the port (send the `$NetBSD:` line from the `Makefile`) and the output leading up to the error when you email the maintainer. If you do not get a response from the maintainer, you can try [users](http://leaf.dragonflybsd.org/mailarchive/) .
312
313   1. Grab a pre-built package from an [[mirror|mirrors]] site near you. 
314
315 ### What is WIP? 
316
317 Packages that can be built within the pkgsrc framework but are not yet necessarily ready for production use can be found in [http://pkgsrc-wip.sourceforge.net](http://pkgsrc-wip.sourceforge.net).  These packages need to be downloaded separately; check the website for details.  Packages in this collection are in development and may not build successfully.
318
319 ### Links
320
321 * [http://www.netbsd.org/Documentation/pkgsrc/](http://www.netbsd.org/Documentation/pkgsrc/)
322
323 * [http://www.pkgsrc.se](http://www.pkgsrc.se)
324
325 * [http://wiki-static.aydogan.net/How_to_upgrade_packages](http://wiki-static.aydogan.net/How_to_upgrade_packages)
326
327 * To search and/or report bugs against packages in pkgsrc, look at [http://www.netbsd.org/support/send-pr.html](http://www.netbsd.org/support/send-pr.html) - use category 'pkg'.
328
329 * The #pkgsrc IRC channel on Freenode
330
331 * The #dragonflybsd IRC channel on EFnet