New donator - thanks, Michael Roach!
[ikiwiki.git] / docs / howtos / HowToPkgsrc.mdwn
index bb8c531..cbcc8d1 100644 (file)
@@ -1,13 +1,73 @@
-[[!toc levels=2 ]]
+# Disclaimer 
 
-## History and Overview 
+DragonFly, up to and including version 3.4, used pkgsrc to manage third party software packages.  DragonFly switched to dports at the 3.6 release.
+
+This page is still useful for anyone wanting to use pkgsrc, but the recommended packaging method is dports, which is covered in a similar document here: 
+
+[http://www.dragonflybsd.org/docs/howtos/HowToDPorts/](http://www.dragonflybsd.org/docs/howtos/HowToDPorts/)
+
+----
+
+# pkgsrc on DragonFly
+
+DragonFly uses a specially crafted Makefile in /usr and a git mirror
+of the official pkgsrc repository to make pkgsrc distribution more user-friendly.
+
+The basics of the pkgsrc system can be found in NetBSD's [Pkgsrc Guide](http://www.netbsd.org/docs/pkgsrc/), and can be considered the canonical resource.
+
+
+[[!toc levels=3 ]]
+
+## Overview 
+
+### History 
 [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.
 
+### Overview
+
+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.
+
+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.
+
+ **Binary Package Benefits** 
+
+* A compressed package tarball is typically smaller than the compressed tarball containing the source code for the application.
+
+* 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.
+
+* Packages do not require any understanding of the process involved in compiling software on DragonFly.
+
+
+**Pkgsrc source Benefits** 
+
+
+* 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.
+
+* 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.
+
+* The licensing conditions of some software distributions forbid binary distribution. They must be distributed as source code.
+
+* 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.
+
+* If you have local patches, you will need the source in order to apply them.
+
+* Some people like having code around, so they can read it if they get bored, hack it, debug crashes, borrow from it (license permitting, of course), and so on.
+
+To keep track of 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.
+
+ **Warning:** Before installing any application, you should check http://www.pkgsrc.org/ for security issues related to your application.
+
+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.
+
+**Note:** Binary packages and source packages are effectively the same software and can be manipulated with the same pkg_* tools.  
+
 ## Installing pkgsrc 
 
 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.  
 
-As root:
+Set GITHOST in /etc/make.conf or set it as an environment variable to select a different download location, if desired. See mirrors page for available mirrors.
+
+This downloads the stable version of the pkgsrc tree from the default mirror, if you didn't set GITHOST. As root:
 
     # cd /usr
     # make pkgsrc-create
@@ -19,13 +79,83 @@ to fetch the intial pkgsrc repository from the net, or
 
 to update.
 
-Edit /usr/Makefile to select a different download location, if desired.
+**Note**: If your DragonFly install is not up to date, you might have ended up with an old release of the pkgsrc tree.
+
+    # cd /usr/pkgsrc
+    # git branch
+
+will show what release you are on. See Tracking the stable branch for more information.
+
+### Tracking the stable branch
+
+There are quarterly releases of pkgsrc that are specifically designed for stability.  You should in general follow these, rather than the bleeding edge pkgsrc. When a new branch is out you need to set up a local branch tracking that one. 'make pkgsrc-update' will not do this for you.
+
+To see the available remote branches:
+
+    # cd /usr/pkgsrc 
+    # git pull
+    # git branch -r
+
+To create a local branch, tracking the remote quarterly release:
+
+    # cd /usr/pkgsrc 
+    # git branch pkgsrc-2010Q4 origin/pkgsrc-2010Q4
+
+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 latest stable branch.
+
+After adding a new branch, it can be downloaded with:
+
+    # cd /usr/pkgsrc 
+    # git checkout pkgsrc-2010Q4
+    # git pull
+
+## Dealing with pkgsrc packages
+
+The following section explains how to find, install and remove pkgsrc packages.
+
+### Finding Your Application 
+
+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:
+
+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.
+
+    # pkg_search fvwm
+    fvwm-2.4.20nb1          Newer version of X11 Virtual window manager
+    fvwm-2.5.24             Development version of X11 Virtual window manager
+    fvwm-themes-0.6.2nb8    Configuration framework for fvwm2 with samples
+    fvwm-wharf-1.0nb1       Copy of AfterStep's Wharf compatible with fvwm2
+    fvwm1-1.24rnb1          Virtual window manager for X
+
+    # pkg_search -v fvwm-2.5
+    Name    : fvwm-2.5.24-50
+    Dir     : wm/fvwm-devel                                     
+    Desc    : Development version of X11 Virtual window manager 
+    URL     : any                                               
+    Deps    : perl>#5.0 gettext-lib>0.14.5 [...]
+
+Its also possible to issue the command
+
+    # cd /usr/pkgsrc/
+    # bmake search key='package you are looking for'
+
+from the `/usr/pkgsrc` directory.
 
-This downloads the absolute most recent version of pkgsrc.  In a production environment, you may want a more stable release.  Check the section below titled "Tracking the stable branch" for more details.
+It's also possible to browse website that show all the available pkgsrc packages, such as [http://pkgsrc.se/](http://pkgsrc.se) .
 
-## Installing packages from source
+### Installing applications
 
-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.
+Downloading a binary package is almost always faster than building from source, but not all programs in pkgsrc can be redistributed as a binary.  In most cases, you will want to download a binary package if possible, and otherwise build from source if it's not available.  
+
+The `bin-install` target on DragonFly (with pkgsrc from 2011/02/07 and later) will do just that:
+
+    # cd /usr/pkgsrc/misc/screen
+    # bmake bin-install clean
+
+This will download and install the appropriate `screen` binary package if it exists, and try building from source if it can't complete the download.
+
+### Installing applications, source only
+
+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.
 
     # cd /usr/pkgsrc/misc/screen
     # bmake install clean
@@ -40,139 +170,185 @@ To change options:
 
 Listing an option enables it.  Listing an option with a "-" before it disables the option.
 
-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:
+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`:
 
      . PKG_OPTIONS.<package_name>=-option1 option2
     
-## Installing pre-built packages 
+### Installing applications, binary only
 
-Binary packages can be installed using pkg_radd:
+Binary packages can be installed using *pkg_radd*:
 
     # pkg_radd screen
 
-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.
+This program works by setting the `PKG_PATH` environment 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. This will install most packages, but will not upgrade packages that are already installed.
 
-You can manually set PKG_PATH and use pkg_add to get the same effect, using a different server.
+You can manually set `BINPKG_BASE` and use *pkg_add* to get the same effect, using a different server.
 
-    # setenv PKG_PATH http://avalon.dragonflybsd.org/packages/i386/DragonFly-2.7/stable
+    # setenv BINPKG_BASE http://mirror-master.dragonflybsd.org/packages
     # pkg_add screen
 
-This will install most packages, but will not upgrade packages that are already installed.
 
-***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.***
+#### Issues with pre-built packages
 
-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 pkg_radd fails, try going to that package's directory in /usr/pkgsrc and using 'bmake install clean'.
+* The default remote repository for binary packages tracks quarterly pkgsrc releases, so your local install of pkgsrc should be the same quarterly release.
+* 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.
+* If you upgrade to an new DEVELOPMENT version of DragonFly very early (i.e. shortly after the branch), it might be possible that *pkg_radd* fails to install packages. This is due the fact, that it takes some time to built binary packages and thus, there are no binary packages available on the mirrors yet. Usually you'll see an announcement on the lists once the first packages for DEVELOPMENT are ready.
 
-### Tracking the stable branch 
 
-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.
+### List all installed applications 
 
-To see the available branches:
+To obtain a list of all the packages that are installed on your system:
 
-    cd /usr/pkgsrc 
-    git branch -r
+    # pkg_info
 
-To switch to a recent branch:
+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:
 
-    cd /usr/pkgsrc 
-    git branch pkgsrc-2010Q3 origin/pkgsrc-2010Q3
+    # pkg_info | grep xorg
 
-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.
+### Removing packages
 
-After switching to a new branch, it can be downloaded with:
+If a program was installed as a package:
 
-    cd /usr/pkgsrc 
-    git checkout vendor
-    git pull
+    # pkg_delete packagename
 
-### List all installed packages 
+If a package was installed from the source files, you can also change to the directory they were installed from and issue the command:
 
-To obtain a list of all the packages that are installed on your system:
+    # bmake deinstall
 
-    # pkg_info
+Note that these methods are effectively interchangeable.  Either will work whether the package was originally installed from source or binary.
 
-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:
+#### Remove associated files needed for building a package 
 
-    # pkg_info | grep xorg
+To remove the work file from building a package, and the package's dependencies:
 
-### Searching available packages 
+    # bmake clean clean-depends
 
-Packages can be found using one of two ways. You can issue the command
+This can be combined with other steps:
 
-    # cd /usr/pkgsrc/
-    # bmake search key='package you are looking for'
+    # bmake install clean clean-depends
 
-from the /usr/pkgsrc directory.
+## Upgrading packages 
 
-There is also the pkglocate tool that comes with pkgsrc:
+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.
 
-    # /usr/pkgsrc/pkglocate 'package name'
+### Update pkgsrc system packages
 
-Normal UNIX file finding commands will work (whereis, locate, or find).
+**Note**: Sometimes basic pkgsrc tools; *bmake*, *pkg_install* and *bootstrap-mk-files* 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. 
 
-It's also possible to browse website that show all the available pkgsrc packages, such as [http://pkgsrc.se/](pkgsrc.se)
+    # cd /usr/pkgsrc/devel/bmake
+    or
+    # cd /usr/pkgsrc/pkgtools/pkg_install
+    or 
+    # cd /usr/pkgsrc/pkgtools/bootstrap-mk-files
+    
+    # env USE_DESTDIR=yes bmake package
+    # bmake clean-depends clean
 
-## Upgrading packages 
+And go to the packages directory and install the binary package with
 
-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.
+    # cd /usr/pkgsrc/packages/All
+    # pkg_add -u <pkg_name> (i.e. the name of the .tgz file).
 
-pkg_rolling-replace: Rebuilds packages from source in dependency order.
 
-pkgin: Downloads and installs binary packages.  Check the [[mirrors]] page for sites carrying binary packages to use with pkgin.
+### bmake replace
+Performed in the `/usr/pkgsrc` directory that correlates with the installed package, the software is first built and then replaced.
 
-pkg_chk: will update package by removing them and rebuilding them.  Warning: programs are unavailable until a rebuild finishes.  If they don't rebuild, it won't work.
+    # cd /usr/pkgsrc/chat/ircII
+    # bmake replace
 
-'bmake update': 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.
+### pkg_rolling-replace
 
-'pkg_add -u': point at a local or online binary archive location to download and update packages.
+*pkg_rolling-replace* replaces packages one by one and you can use it for a better way of package management. Actually it does `bmake 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.
 
+    # cd /usr && make pkgsrc-update
+    # pkg_rolling-replace -u
 
+### pkgin
 
-## Removing packages
+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.
 
-If a program was installed as a package:
+    # pkgin update
+    # pkgin full-upgrade 
 
-    # pkg_delete packagename
+### pkg_chk
 
-If a package was installed from the source files, you can also change to the directory they were installed from and issue the command:
+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.
 
-    # bmake deinstall
+    # pkg_chk -g  # make initial list of installed packages
+    # pkg_chk -r  # remove all packages that are not up to date and packages that depend on them
+    # pkg_chk -a  # install all missing packages (use binary packages, this is the default)
+    # pkg_chk -as # install all missing packages (build from source)
 
-### Remove associated files needed for building a package 
+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. 
 
-To remove the work file from building package
+### pkg_add -u
 
-    # bmake clean
+Point at a local or online binary archive location to download and update packages.
 
-This can be combined with other steps:
+### rpkgmanager
+
+This requires that you've set up rpkgmanager first. Read more about rpkgmanager [[here|docs/howtos/rpkgmanager/]].
 
-    # bmake install clean 
+    # yes | rpkgmanager.rb
 
-## Additional /usr/pkg/etc/mk.conf notes
+## Start pkgsrc applications on system startup
 
-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:
+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:
 
     RCD_SCRIPTS_DIR=/etc/rc.d
     PKG_RCD_SCRIPTS=YES
 
-This option can be set in the environment to activate it for binary packages.  These packages will still have to be enabled in 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.
+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`.
 
-## What is WIP? 
+Many other options can be set in this file; see `/usr/pkgsrc/mk/defaults/mk.conf` for examples.
 
-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](pkgsrc-wip).  These packages need to be downloaded separately; check the website for details.  Packages in this collection are in development and may not build successfully.
+## Miscellaneous topics
 
-## Links
+### Post-installation Activities 
 
-* [http://www.netbsd.org/Documentation/pkgsrc/](http://www.netbsd.org/Documentation/pkgsrc/)
+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.
+ 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:
 
-* [http://www.pkgsrc.se](http://www.pkgsrc.se)
+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
 
-* 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'.
+    # pkg_info -L foopackage-1.0.0 | less
+
+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
+
+    # pkg_info | grep -i foopackage
+
+will find all the installed packages that have *foopackage* in the package name. Replace *foopackage* in your command line as necessary.
+
+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
+
+    # pkg_info foopackage-1.0.0
+
+A `WWW:` line, if present, should provide a URL for the application's web site.
 
-* [http://pkgsrc-wip.sourceforge.net](pkgsrc-wip), **w**ork **i**n **p**rogress packages not yet in offical pkgsrc release
+### Dealing with Broken Packages 
+
+If you come across a package that does not work for you, there are a few things you can do, including:
+
+  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!
+
+  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/) .
+
+  1. Grab a pre-built package from an [[mirror|mirrors]] site near you. 
+
+### What is WIP? 
+
+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.
+
+### Links
+
+* More information: The pkgsrc guide [http://www.netbsd.org/Documentation/pkgsrc/](http://www.netbsd.org/Documentation/pkgsrc/)
+
+* Web interface for searching packages: [http://www.pkgsrc.se](http://www.pkgsrc.se)
+
+* Ways to upgrade packages [http://wiki-static.aydogan.net/How_to_upgrade_packages](http://wiki-static.aydogan.net/How_to_upgrade_packages)
+
+* 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'.
 
 * The #pkgsrc IRC channel on Freenode
 
 * The #dragonflybsd IRC channel on EFnet
-
-* [http://www.netbsd.org/Changes/rss-netbsd-pkgs.xml](New and updated pkgsrc packages via RSS)