pkgsrc doc merge part 2
[ikiwiki.git] / docs / howtos / HowToPkgsrc.mdwn
1 [[!toc levels=2 ]]
2
3 The following page describes the basics of the pkgsrc system as used by DragonFly.
4
5 ## pkgsrc Overview 
6
7 ### History 
8 [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.
9
10 ### Overview
11
12 If you have used a UNIX® system before you will know that the typical procedure for installing third party software goes something like this:
13
14   1. Download the software, which might be distributed in source code format, or as a binary.
15
16   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)).
17
18   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.
19
20   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.
21
22   1. Test and install the software.
23
24 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.
25
26 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.
27
28
29
30 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.
31
32 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.
33
34  **Binary Package Benefits** 
35
36 * A compressed package tarball is typically smaller than the compressed tarball containing the source code for the application.
37
38 * 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.
39
40 * Packages do not require any understanding of the process involved in compiling software on DragonFly.
41
42
43 **Pkgsrc source Benefits** 
44
45
46 * 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.
47
48 * 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.
49
50 * The licensing conditions of some software distributions forbid binary distribution. They must be distributed as source code.
51
52 * 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.
53
54 * If you have local patches, you will need the source in order to apply them.
55
56 * 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.
57
58 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.
59
60  **Warning:** Before installing any application, you should check http://www.pkgsrc.org/ for security issues related to your application.
61
62 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.
63
64 ## Installing pkgsrc 
65
66 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.  
67
68 As root:
69
70     # cd /usr
71     # make pkgsrc-create
72
73 to fetch the intial pkgsrc repository from the net, or
74
75     # cd /usr
76     # make pkgsrc-update
77
78 to update.
79
80 Edit /usr/Makefile to select a different download location, if desired.
81
82 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.
83
84 ### Tracking the stable branch 
85
86 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.
87
88 To see the available branches:
89
90     cd /usr/pkgsrc 
91     git branch -r
92
93 To switch to a recent branch:
94
95     cd /usr/pkgsrc 
96     git branch pkgsrc-2010Q3 origin/pkgsrc-2010Q3
97
98 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.
99
100 After switching to a new branch, it can be downloaded with:
101
102     cd /usr/pkgsrc 
103     git checkout vendor
104     git pull
105
106 ## Dealing with pkgsrc packages
107
108 The following section explains how to find, install and remove pkgsrc packages.
109
110 ### Finding Your Application 
111
112 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:
113
114 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.
115
116     # pkg_search fvwm
117     fvwm-2.4.20nb1          Newer version of X11 Virtual window manager
118     fvwm-2.5.24             Development version of X11 Virtual window manager
119     fvwm-themes-0.6.2nb8    Configuration framework for fvwm2 with samples
120     fvwm-wharf-1.0nb1       Copy of AfterStep's Wharf compatible with fvwm2
121     fvwm1-1.24rnb1          Virtual window manager for X
122
123     # pkg_search -v fvwm-2.5
124     Name    : fvwm-2.5.24-50
125     Dir     : wm/fvwm-devel                                     
126     Desc    : Development version of X11 Virtual window manager 
127     URL     : any                                               
128     Deps    : perl>#5.0 gettext-lib>0.14.5 [...]
129
130 Its also possible to issue the command
131
132     # cd /usr/pkgsrc/
133     # bmake search key='package you are looking for'
134
135 from the `/usr/pkgsrc` directory.
136
137 It's also possible to browse website that show all the available pkgsrc packages, such as [http://pkgsrc.se/](http://pkgsrc.se) .
138
139 ### Installing packages from source
140
141 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.
142
143     # cd /usr/pkgsrc/misc/screen
144     # bmake install clean
145
146 To find out the options that can affect how a program is built:
147
148     # bmake show-options
149
150 To change options:
151
152     # bmake PKG_OPTIONS.<package_name>="-option1 option2" install clean
153
154 Listing an option enables it.  Listing an option with a "-" before it disables the option.
155
156 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`:
157
158      . PKG_OPTIONS.<package_name>=-option1 option2
159     
160 ### Installing pre-built packages 
161
162 Binary packages can be installed using *pkg_radd*:
163
164     # pkg_radd screen
165
166 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.
167
168 You can manually set PKG_PATH and use pkg_add to get the same effect, using a different server.
169
170     # setenv PKG_PATH http://mirror-master.dragonflybsd.org/packages/i386/DragonFly-2.7/stable
171     # pkg_add screen
172
173 *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.
174
175 This will install most packages, but will not upgrade packages that are already installed.
176
177 ***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.
178
179 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.
180
181 #### Dealing with different package versions 
182
183 It is possible that you see a warning when installing binary packages on a DEVELOPMENT-version of DragonFly.  The warning could look like this:
184
185     pkg_add: Warning: package `vim-gtk2-7.1.116.tgz' was built for a different version of the OS:
186     pkg_add: DragonFly/i386 1.10.1 (pkg) vs. DragonFly/i386 1.11.0 (this host)
187
188 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.
189
190 ### List all installed packages 
191
192 To obtain a list of all the packages that are installed on your system:
193
194     # pkg_info
195
196 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:
197
198     # pkg_info | grep xorg
199
200 ### Removing packages
201
202 If a program was installed as a package:
203
204     # pkg_delete packagename
205
206 If a package was installed from the source files, you can also change to the directory they were installed from and issue the command:
207
208     # bmake deinstall
209
210 #### Remove associated files needed for building a package 
211
212 To remove the work file from building a package, and the package's dependencies:
213
214     # bmake clean clean-depends
215
216 This can be combined with other steps:
217
218     # bmake install clean clean-depends
219
220 ## Upgrading packages 
221
222 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!
223
224 ### pkg_rolling-replace
225
226 *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.
227
228     # cd /usr && make pkgsrc-update
229     # pkg_rolling-replace -u
230
231 ### pkgin
232
233 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.
234
235     # pkgin update
236     # pkgin full-upgrade 
237
238 ### pkg_chk
239
240 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.
241
242     # pkg_chk -g  # make initial list of installed packages
243     # pkg_chk -r  # remove all packages that are not up to date and packages that depend on them
244     # pkg_chk -a  # install all missing packages (use binary packages, this is the default)
245     # pkg_chk -as # install all missing packages (build from source)
246
247 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. 
248
249 ### bmake update
250
251 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*.
252
253 ### pkg_add -u
254
255 Point at a local or online binary archive location to download and update packages.
256
257 #### Update pkgsrc system packages
258
259 **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)
260
261     # env USE_DESTDIR=full bmake package
262     # bmake clean-depends clean
263
264 And go to the packages directory and install the binary package with
265
266     # pkg_add -u <pkg_name> (i.e. the name of the .tgz file).
267     # bmake replace USE_DESTDIR=yes
268
269 ## Start pkgsrc applications on system startup
270
271 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:
272
273     RCD_SCRIPTS_DIR=/etc/rc.d
274     PKG_RCD_SCRIPTS=YES
275
276 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`.
277
278 Many other options can be set in this file; see `/usr/pkgsrc/mk/defaults/mk.conf` for examples.
279
280 ## Miscellaneous topics
281
282 ### Post-installation Activities 
283
284 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.
285  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:
286
287 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
288
289     # pkg_info -L foopackage-1.0.0 | less
290
291 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
292
293     # pkg_info | grep -i foopackage
294
295 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.
296
297 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
298
299     # pkg_info foopackage-1.0.0
300
301   
302 A `WWW:` line, if present, should provide a URL for the application's web site.
303
304 ### Dealing with Broken Packages 
305
306 If you come across a package that does not work for you, there are a few things you can do, including:
307
308   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!
309
310   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/) .
311
312   1. Grab a pre-built package from an [[mirror|mirrors]] site near you. 
313
314 ### What is WIP? 
315
316 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.
317
318 ### Links
319
320 * [http://www.netbsd.org/Documentation/pkgsrc/](http://www.netbsd.org/Documentation/pkgsrc/)
321
322 * [http://www.pkgsrc.se](http://www.pkgsrc.se)
323
324 * [http://wiki-static.aydogan.net/How_to_upgrade_packages](http://wiki-static.aydogan.net/How_to_upgrade_packages)
325
326 * 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'.
327
328 * [http://pkgsrc-wip.sourceforge.net](http://pkgsrc-wip.sourceforge.net), **w**ork **i**n **p**rogress packages not yet in official pkgsrc release
329
330 * An [in-depth explanation of pkgsrc](http://www.unixgarden.com/index.php/administration-reseau/netbsd-s01e03-gestion-des-paquets), in French.
331
332 * The #pkgsrc IRC channel on Freenode
333
334 * The #dragonflybsd IRC channel on EFnet