Add TOC to DPorts page

[ikiwiki.git] / docs / howtos / HowToDPorts / index.mdwn

[[!toc  levels=3]]

# DPorts and pkgng

DPorts is DragonFly's own third-party software build system.  It is based on FreeBSD's Ports Collection.  Differences between ports and DPorts are intentionally kept to a minimum, both to maintain familiarity for mutual users of both operating systems and also to leverage the tremendous amount of work the FreeBSD contributors put into ports.  DPorts can and does feature ports unique to DragonFly, so it's truly a native system.

The __pkgng__ tool called "pkg" is a modern and fast binary package manager.  It was developed for FreeBSD, but PC-BSD used it in production first, followed soon after by DragonFly.  FreeBSD has since removed their legacy tools so __pkgng__ is exclusively used by FreeBSD as well.

__pkgng__ is not a replacement for port management tools like `ports-mgmt/portmaster` or `ports-mgmt/portupgrade`. While `ports-mgmt/portmaster` and `ports-mgmt/portupgrade` can install third-party software from both binary packages and DPorts, __pkgng__ installs only binary packages.  On the other hand, many people use __pkgng__ by itself and never install the optional portupgrade or portmaster tools.

## Getting started with pkgng

DragonFly daily snapshots and Releases (starting with 3.4) come with __pkgng__ already installed.  Upgrades from earlier releases, however, will not have it.  If the "pkg" program is missing on the system for any reason, it can be quickly bootstrapped without having to build it from source or even having dports installed:

    # make pkg-bootstrap
    # rehash
    # pkg-static install -y pkg
    # rehash

If pkgsrc has ever been installed on the system, make sure all binaries produced by it have been removed:

    # rm -rf /usr/pkg

Currently it's necessary to manually install the configuration file, but this requirement should disappear in the future.  After installing the configuration file, you may want to open it up and edit it to select a different mirror.

## Configuring pkgng

Older versions of pkgng saved their configuration at /usr/local/etc/pkg.conf; this file made reference to a PACKAGESITE.  pkgng will still work based on this file, but will output errors:

    # pkg update
    pkg: PACKAGESITE in pkg.conf is deprecated. Please create a repository configuration file
    Updating repository catalogue
    pkg: Warning: use of http:// URL scheme with SRV records is deprecated: switch to pkg+http://

If you do __not__ see these errors, then skip to "Now, navigate to `/usr/local/etc/pkg/repos/`", otherwise:

Listen to the errors: hash out the packagesite line, save the file, and move on.  This can be done with vi:

    # vi /usr/local/etc/pkg.conf

There will be two lines in the file like this:

    # Default DPorts package server (California)
    PACKAGESITE: http://mirror-master.dragonflybsd.org/dports/${ABI}/LATEST

Hash out the offending line:

    # Default DPorts package server (California)
    # PACKAGESITE: http://mirror-master.dragonflybsd.org/dports/${ABI}/LATEST

Note that, as of time of writing, there are two working package repositories:

    # Default DPorts package server (California)
    # PACKAGESITE: http://mirror-master.dragonflybsd.org/dports/${ABI}/LATEST
    
    # European mirrors
    [...]
    #PACKAGESITE: http://dfly.schlundtech.de/dports/${ABI}/LATEST

Test their performance---we will be using the fastest one.  This may, or may not, be the one closest to you (the California site for the New World, the German site for the Old World).

    # ping schlundtech.de
    PING schlundtech.de (85.236.36.90): 56 data bytes
    64 bytes from 85.236.36.90: icmp_seq=0 ttl=49 time=101.433 ms
    64 bytes from 85.236.36.90: icmp_seq=1 ttl=49 time=59.177 ms
    64 bytes from 85.236.36.90: icmp_seq=2 ttl=49 time=79.550 ms
    64 bytes from 85.236.36.90: icmp_seq=3 ttl=49 time=88.268 ms
    64 bytes from 85.236.36.90: icmp_seq=4 ttl=49 time=120.060 ms
    [...]
    --- schlundtech.de ping statistics ---
    20 packets transmitted, 19 packets received, 5.0% packet loss
    round-trip min/avg/max/stddev = 49.555/96.064/186.662/33.559 ms
    # ping mirror-master.dragonflybsd.org
    PING avalon.dragonflybsd.org (199.233.90.72): 56 data bytes
    64 bytes from 199.233.90.72: icmp_seq=0 ttl=47 time=208.013 ms
    64 bytes from 199.233.90.72: icmp_seq=1 ttl=47 time=256.441 ms
    64 bytes from 199.233.90.72: icmp_seq=2 ttl=47 time=281.436 ms
    64 bytes from 199.233.90.72: icmp_seq=3 ttl=47 time=281.103 ms
    64 bytes from 199.233.90.72: icmp_seq=4 ttl=47 time=285.440 ms
    [...]
    --- avalon.dragonflybsd.org ping statistics ---
    19 packets transmitted, 19 packets received, 0.0% packet loss
    round-trip min/avg/max/stddev = 208.013/264.017/334.180/31.549 ms

Now, navigate to `/usr/local/etc/pkg/repos/` and rename one of the configuration file samples you find there. `df-latest.conf` will make pkg use the newest available binaries while `df-release.conf` points to binaries built at the time of the release. The latter is frozen so you will not get any updates. Edit the one you renamed:

    # cd /usr/local/etc/pkg/repos/
    # ls
    df-latest.conf.sample       df-releases.conf.sample
    # cp -v df-latest.conf.sample df-latest.conf
    df-latest.conf.sample -> df-latest.conf
    # chmod -v 644 df-latest.conf
    df-latest.conf
    # vi df-latest.conf

Enable whichever server was faster (Avalon is American, SchlundTech is German), and pkg+ to the url and SRV to mirror_type:

    Avalon: {
        url             : pkg+http://mirror-master.dragonflybsd.org/dports/${ABI}/LATEST,
        mirror_type     : SRV
        [...]
        enabled         : no
    }
    SchlundTech: {
        url             : pkg+http://dfly.schlundtech.de/dports/${ABI}/LATEST,
        mirror_type     : SRV
        [...]
        enabled         : yes
    }

Before using, consult the man page (`man pkg`) and then try these examples:

    # pkg search editors
    # pkg install vim

## Basic pkgng Operations

Usage information for __pkgng__ is available in the pkg(8) manual page, or by running `pkg` without additional arguments.

Each __pkgng__ command argument is documented in a command-specific manual page. To read the manual page for `pkg install`, for example, run either:

    # pkg help install
    # man pkg-install

## Obtaining Information About Installed Packages with pkgng

Information about the packages installed on a system can be viewed by running `pkg info`. Similar to pkg_info(1), the package version and description for all packages will be listed.  Information about a specific package is available by running:

    # pkg info packagename

For example, to see which version of __pkgng__ is installed on the system, run:

    # pkg info pkg
    pkg-1.0.12                   New generation package manager

## Installing and Removing Packages with pkgng

In general, most DragonFly users will install binary packages by typing:

    # pkg install <packagename>

For example, to install curl:

    # pkg install curl

    Updating repository catalogue
    Repository catalogue is up-to-date, no need to fetch fresh copy
    The following packages will be installed:
    
        Installing ca_root_nss: 3.13.5
        Installing curl: 7.24.0
    
    The installation will require 4 MB more space
    
    1 MB to be downloaded
    
    Proceed with installing packages [y/N]: y
    ca_root_nss-3.13.5.txz           100%    255KB   255.1KB/s  255.1KB/s   00:00
    curl-7.24.0.txz                  100%   1108KB     1.1MB/s    1.1MB/s   00:00
    Checking integrity... done
    Installing ca_root_nss-3.13.5... done
    Installing curl-7.24.0... done

The new package and any additional packages that were installed as dependencies can be seen in the installed packages list:

    # pkg info
    ca_root_nss-3.13.5    The root certificate bundle from the Mozilla Project
    curl-7.24.0           Non-interactive tool to get files from FTP, GOPHER, HTTP(S) servers
    pkg-1.0.12            New generation package manager

Packages that are no longer needed can be removed with `pkg delete`. For example, if it turns out that curl is not needed after all:

    # pkg delete curl
    The following packages will be deleted:
    
        curl-7.24.0_1
    
    The deletion will free 3 MB
    
    Proceed with deleting packages [y/N]: y
    Deleting curl-7.24.0_1... done

## Upgrading Installed Packages with pkgng

Packages that are outdated can be found with `pkg version`. If a local ports tree does not exist, pkg-version(8) will use the remote repository catalogue, otherwise the local ports tree will be used to identify package versions.

Packages can be upgraded to newer versions with __pkgng__. Suppose a new version of curl has been released. The local package can be upgraded to the new version:

    # pkg upgrade
    Updating repository catalogue
    repo.txz            100%    297KB   296.5KB/s   296.5KB/s   00:00
    The following packages will be upgraded:
    
    Upgrading curl: 7.24.0 -> 7.24.0_1
    
    1 MB to be downloaded
    
    Proceed with upgrading packages [y/N]: y
    curl-7.24.0_1.txz   100%    1108KB  1.1MB/s       1.1MB/s   00:00
    Checking integrity... done
    Upgrading curl from 7.24.0 to 7.24.0_1... done

## Auditing Installed Packages with pkgng

Occasionally, software vulnerabilities may be discovered in software within DPorts. __pkgng__ includes built-in auditing. To audit the software installed on the system, type:

    # pkg audit -F

# Advanced pkgng Operations

## Automatically Removing Leaf Dependencies with pkgng

Removing a package may leave behind unnecessary dependencies, like `security/ca_root_nss` in the example above. Such packages are still installed, but nothing depends on them any more. Unneeded packages that were installed as dependencies can be automatically detected and removed:

    # pkg autoremove
    Packages to be autoremoved:
        ca_root_nss-3.13.5
    
    The autoremoval will free 723 kB
    
    Proceed with autoremoval of packages [y/N]: y
    Deinstalling ca_root_nss-3.13.5... done

## Backing Up the pkgng Package Database

__pkgng__ includes its own package database backup mechanism. To manually back up the package database contents, type:

    # pkg backup -d <pkgng.db>

Additionally, __pkgng__ includes a periodic(8) script to automatically back up the package database daily if `daily_backup_pkgng_enable` is set to `YES` in periodic.conf(5).   To prevent the `pkg_install` periodic script from also backing up the package database, set `daily_backup_pkgdb_enable` to `NO` in periodic.conf(5).

To restore the contents of a previous package database backup, run:

    # pkg backup -r </path/to/pkgng.db>

## Removing Stale pkgng Packages

By default, __pkgng__ stores binary packages in a cache directory as defined by `PKG_CACHEDIR` in pkg.conf(5). When upgrading packages with pkg upgrade, old versions of the upgraded packages are not automatically removed.

To remove the outdated binary packages, type:

    # pkg clean

##Modifying pkgng Package Metadata

__pkgng__ has a built-in command to update package origins. For example, if `lang/php5` was originally at version 5.3, but has been renamed to lang/php53 for the inclusion of version 5.4, the package database can be updated to deal with this. For __pkgng__, the syntax is:

    # pkg set -o <category/oldport>:<category/newport>

For example, to change the package origin for the above example, type:

    # pkg set -o lang/php5:lang/php53

As another example, to update lang/ruby18 to lang/ruby19, type:

    # pkg set -o lang/ruby18:lang/ruby19

As a final example, to change the origin of the libglut shared libraries from graphics/libglut to graphics/freeglut, type:

    # pkg set -o graphics/libglut:graphics/freeglut

_Note_: When changing package origins, in most cases it is important to reinstall packages that are dependent on the package that has had the origin changed. To force a reinstallation of dependent packages, type:

    # pkg install -Rf graphics/freeglut

# Building DPorts from source

The average user will probably not build packages from source.  However, it's easy to do and it can be done even when packages have already been pre-installed on the system.  Common reasons to build from source are:

* The port is new and there's no pre-binary available yet
* The pre-built binaries use the default options and the user needs a package built with a different set of options
* Testing FreeBSD port in order to patch them and submit to DPorts
* The user just prefers building from source

## Installing DPorts tree

DragonFly 3.4 or later is the minimum version that can build DPorts from source.

It's probably that pkgsrc binaries are already installed because it comes bootstrapped with new systems.  It is necessary to rename `/usr/pkg` directory so that the existing pkgsrc binary tools and libraries don’t get accidentally used while building DPorts, causing breakage.  For the installation of the DPorts tree, type:

    # cd /usr
    # make dports-create-shallow

If the `/usr/pkg directory` has already been renamed, `git` won’t be in the search path any more.  One option is to download a tarball of DPorts and unpack it.  To do this, type:

    # cd /usr
    # make dports-download

For future updates, pull delta changes via `git` is fastest, so it is suggested to convert the static tree to a git repository by typing:

    # cd /usr/dports/devel/git
    # make install
    # cd /usr
    # rm -rf /usr/dports
    # make dports-create-shallow

The git repository is hosted on the [github account of John Marino](https://github.com/jrmarino/DPorts/#readme).

## Final thoughts

Building from source works similar to ports and pkgsrc: cd into the appropriate program's directory, and type 'make'. 'make install' to install the software, 'make clean' to clean up work files, and so on. Use 'make config-recursive' if you want to set all the port's options, and the options of its dependencies, immediately instead of during the build.

To take all the default build options and avoid getting the pop-up dialog box, set `NO_DIALOG=yes` on either the command line or the make.conf file.

If you just want to set the options for one package, and accept the default for all of its dependencies, do 'make config' in the package in you want non-default options, and then 'make NO_DIALOG=yes'.  Note that this is only necessary if you want to build from source with a non-default set of options, or if no pre-built binary package is available yet.

## More reading
* How fix/add broken ports: [[docs/howtos/fixdports]]
* [Trick: How to get i386-only software via dports](http://leaf.dragonflybsd.org/mailarchive/users/2013-06/msg00023.html)