Editing Using the Ports Collection

<noinclude>{{NavHeader|back=Using pkgng Package Management|forward=Using pkgsrc Package Management|custompagename=Using the Ports Collection}}</noinclude>

This section provides basic instructions on using the Ports Collection to install or remove software. The detailed description of available make targets and environment variables is available in [http://www.freebsd.org/cgi/man.cgi?query=ports&amp;sektion=7 ports].

{| style="color:black; background-color:#ff8762;" class="wikitable"
|'''Warning!''' As of mid 2012, the FreeBSD Ports Project has migrated revision control systems from CVS to Subversion. The preferred method for obtaining and maintaining the ports tree is Portsnap. Users requiring local customization of ports (that is, maintaining additional local patches) will probably prefer to use Subversion directly. The CVSup service is being phased out as of February 28, 2013, and further use is discouraged.
|}

=== Obtaining the Ports Collection ===

The Ports Collection is a set of ''Makefiles'', patches, and description files stored in ''/usr/ports''. This set of files is used to compile and install applications on FreeBSD. The instructions below show several methods of obtaining the Ports Collection if it was not installed during initial FreeBSD setup.

==== Portsnap Method ====

Portsnap is a fast and user-friendly tool for retrieving the Ports Collection, the preferred choice for most users. See Using Portsnap for a detailed description of Portsnap.

# Download a compressed snapshot of the Ports Collection into /var/db/portsnap:
#: <code>portsnap fetch</code>
# When running Portsnap for the first time, extract the snapshot into /usr/ports:
#: <code>portsnap extract</code>
#: After the first use of Portsnap has been completed as shown above, /usr/ports can be updated with:
#:: <code>portsnap update</code>

=== Installing Ports ===

A port skeleton is a set of files that tell FreeBSD system how to compile and install a program. Each port skeleton includes:

* ''Makefile'': The ''Makefile'' contains statements that specify how the application should be compiled and where its components should be installed.
* ''distinfo'': This file contains information about the files that must be downloaded to build the port, and their checksums (using sha256(1)), to verify that files have not been corrupted during the download.
* ''files/'': This directory contains any patches needed for the program to compile and install on FreeBSD. This directory may also contain other files used to build the port.
* ''pkg-descr'': This file provides a more detailed description of the program.
* ''pkg-plist'': This is a list of all the files that will be installed by the port. It also tells the ports system what files to remove upon deinstallation.

Some ports include other files, such as ''pkg-message''. The ports system uses these files to handle special situations. If you want more details on these files, and on ports in general, refer to the [http://www.freebsd.org/doc/en/books/porters-handbook/ FreeBSD Porter's Handbook].

The port does not include the actual source code, also known as a “distfile”. Source code is distributed in whatever manner the software author desires. The two methods for installing a FreeBSD port are described below.

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' You must be logged in as root to install ports.
|}

{| style="color:black; background-color:#ff8762;" class="wikitable"
|'''Warning!''' Before compiling any port, be sure to have an up-to-date Ports Collection and check http://vuxml.freebsd.org/ for security issues related to your port. If ports-mgmt/portaudit) is installed, run portaudit -F before installing a new port, to fetch the current vulnerabilities database. A security audit and an update of the database will be performed during the daily security system check. For more information read the portaudit(1) and periodic(8) manual pages.
|}

Using the Ports Collection assumes a working Internet connection. Otherwise, manually obtain and place a copy of the distfile into /usr/ports/distfiles.

To begin, change to the directory of the port to be installed:
: <code>cd /usr/ports/sysutils/lsof</code>

To compile, or “build”, the port, type make at the prompt. You should see messages similar to the ones in this example:
: <code>make</code>
<pre>
>> lsof_4.57D.freebsd.tar.gz doesn't seem to exist in /usr/ports/distfiles/.
>> Attempting to fetch from ftp://lsof.itap.purdue.edu/pub/tools/unix/lsof/.
===>  Extracting for lsof-4.57
...
[extraction output snipped]
...
>> Checksum OK for lsof_4.57D.freebsd.tar.gz.
===>  Patching for lsof-4.57
===>  Applying FreeBSD patches for lsof-4.57
===>  Configuring for lsof-4.57
...
[configure output snipped]
...
===>  Building for lsof-4.57
...
[compilation output snipped]
...
</pre>

Once the compile is complete, you are returned to the prompt. The next step is to install the port using make install:
: <code>make install</code>
<pre>
===>  Installing for lsof-4.57
...
[installation output snipped]
...
===>   Generating temporary packing list
===>   Compressing manual pages for lsof-4.57
===>   Registering installation for lsof-4.57
===>  SECURITY NOTE:
      This port has installed the following binaries which execute with
      increased privileges.
</pre>

Once you are returned to the prompt, you should be able to run the installed application. Since lsof is a program that runs with increased privileges, a security warning is shown. During the building and installation of ports, take heed of any other warnings that may appear.

It is a good idea to delete the working subdirectory, which contains all the temporary files used during compilation. Doing so saves disk space and minimizes the chance of problems later when upgrading to the newer version of the port.

: <code>make clean</code>
<pre>
===>  Cleaning for lsof-4.57
</pre>

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' You can save two extra steps by just running make install clean instead of make, make install and make clean as three separate steps.
|}
 
{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' Using only make install means there will potentially be many waiting periods between user interaction as the default behaviour is to prompt the user for options. To avoid this when there are many dependencies, first run make config-recursive to do the configuration in one batch. Then run make install [clean] afterwards.
|}

{| style="color:black; background-color:#98ff8d;" class="wikitable"
|'''Tip!''' When using config-recursive, the list of ports to configure are gathered by the all-depends-list make(1) target. It is often recommended to run make config-recursive until all dependent ports options have been defined, and ports options dialog(1) screens no longer appear, to be certain all ports options have been configured as intended.
|}

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' Some shells keep a cache of the commands that are available in the directories listed in the PATH environment variable, to speed up lookup operations for the executable file of these commands. If you are using tcsh, you might have to type rehash so that a newly installed command can be used without specifying its full path. Use hash -r instead for the sh shell. Refer to the documentation for the shell for more information.
|}
    
The ports system uses fetch to download the files, which honors various environment variables, including FTP_PASSIVE_MODE, FTP_PROXY, and FTP_PASSWORD. You may need to set one or more of these if you are behind a firewall, or need to use an FTP/HTTP proxy.

For users which cannot be connected all the time, the make fetch option is provided. Run this command within /usr/ports and the required files will be downloaded. This command also works in the lower level categories, such as /usr/ports/net. Note that if a port depends on libraries or other ports, this will not fetch the distfiles of ports from another category. Use makefetch-recursive fetch to fetch all the dependencies of a port.

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' You can build all the ports in a category or as a whole by running make in the top level directory. This is dangerous, however, as some ports cannot co-exist. In other cases, some ports can install two different files with the same filename.
|}

In some rare cases, users may need to acquire the tarballs from a site other than the default MASTER_SITES. You can override the MASTER_SITES option with the following command:
: <code>cd /usr/ports/directory</code>
: <code>make MASTER_SITE_OVERRIDE= \</code>
: <code>ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/ fetch</code>

In this example, MASTER_SITES is changed to ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/.

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' Some ports provide build options which can be used to enable/disable parts of the application which are unneeded, provide security options, or allow for other customizations. Examples include www/firefox, security/gpgme, and mail/sylpheed-claws. A menu will be displayed at the beginning of a port compile when compile options are available.
|}

==== Overriding the Default Ports Directories ====

The WRKDIRPREFIX and PREFIX variables can override the default working and target directories. For example:
: <code>make WRKDIRPREFIX=/usr/home/example/ports install</code>
will compile the port in /usr/home/example/ports and install everything under /usr/local.

: <code>make PREFIX=/usr/home/example/local install</code>
will compile the port in /usr/ports and install it in /usr/home/example/local.

And
: <code>make WRKDIRPREFIX=../ports PREFIX=../local install</code>
will combine the two.

Alternatively, these can be set as environmental variables. Refer to the manual page for your shell for instructions on how to set an environmental variable. 

==== Reconfiguring Ports ====

Certain ports provide an ncurses-based menu containing build options. There are several ways to revisit this menu in order to add, remove, or change these options after a port has been built. One method is to cd into the directory containing the port and type make config. Another option is to use make showconfig. Another option is to execute make rmconfig which will remove all selected options and allow you to start over. All of these options, and others, are explained in great detail in the manual page for [http://www.freebsd.org/cgi/man.cgi?query=ports&amp;sektion=7 ports].

=== Removing Installed Ports ===

Installed ports and packages are uninstalled using the pkg_delete command:
: <code>pkg_delete lsof-4.57</code>

=== Upgrading Ports ===

First, list outdated ports that have a newer version available in the Ports Collection with the pkg_version command:
: <code>pkg_version -v</code>

==== Read ''/usr/ports/UPDATING'' ====

Once you have updated your Ports Collection, before attempting a port upgrade, you should check ''/usr/ports/UPDATING''. This file describes various issues and additional steps users may encounter and need to perform when updating a port, including such things as file format changes, changes in locations of configuration files, or other such incompatibilities with previous versions.

If ''UPDATING'' contradicts something you read here, '''UPDATING''' takes precedence.

==== Upgrading Ports Using Portupgrade ====

The '''portupgrade''' utility is designed to easily upgrade installed ports. It is available from the ''ports-mgmt/portupgrade'' port. Install it like any other port, using make install clean:
: <code>cd /usr/ports/ports-mgmt/portupgrade</code>
: <code>make install clean</code>

Scan the list of installed ports using ''pkgdb -F'' and fix all the inconsistencies it reports. It is a good idea to do this regularly, before every upgrade.

Use portupgrade -a to upgrade all the outdated ports installed on the system. Include -i to be asked for confirmation of every individual upgrade.
: <code>portupgrade -ai</code>

To upgrade only a specified application instead of all available ports, use portupgrade pkgname. Include -R to first upgrade all the ports required by the given application.
: <code>portupgrade -R firefox</code>

To use packages instead of ports, include the -P flag. With this option, '''portupgrade''' searches the local directories listed in PKG_PATH, then fetches packages from a remote site if not found locally. If packages can not be found locally or fetched remotely, '''portupgrade''' will use ports. To avoid using ports, specify -PP.
: <code>portupgrade -PP gnome2</code>

To just fetch distfiles (or packages, if -P is specified) without building or installing anything, use -F. For further information see [http://www.freebsd.org/cgi/man.cgi?query=portupgrade&amp;sektion=1&amp;manpath=FreeBSD+8.2-RELEASE+and+Ports portupgrade].

==== Upgrading Ports Using portmaster ====

''ports-mgmt/portmaster'' is another utility for upgrading installed ports. '''portmaster''' was designed to use the tools found in the “base” system without depending upon other ports. It uses the information in ''/var/db/pkg/'' to determine which ports to upgrade. To install the port:
: <code>cd /usr/ports/ports-mgmt/portmaster</code>
: <code>make install clean</code>

'''Portmaster''' groups ports into four categories:
* Root ports: no dependencies and is not depended on by other ports
* Trunk ports: no dependencies, but other ports depend upon it
* Branch ports: have dependencies and are depended upon by other ports
* Leaf ports: have dependencies but are not depended upon by other ports

To list all installed software and search for updates, use -L:
: <code>portmaster -L</code>
<pre>
===>>> Root ports (No dependencies, not depended on)
===>>> ispell-3.2.06_18
===>>> screen-4.0.3
        ===>>> New version available: screen-4.0.3_1
===>>> tcpflow-0.21_1
===>>> 7 root ports
...
===>>> Branch ports (Have dependencies, are depended on)
===>>> apache-2.2.3
        ===>>> New version available: apache-2.2.8
...
===>>> Leaf ports (Have dependencies, not depended on)
===>>> automake-1.9.6_2
===>>> bash-3.1.17
        ===>>> New version available: bash-3.2.33
...
===>>> 32 leaf ports

===>>> 137 total installed ports
        ===>>> 83 have new versions available
</pre>

All the installed ports can be upgraded using this command:
: <code>portmaster -a</code>

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' By default, portmaster will make a backup package before deleting the existing port. If the installation of the new version is successful, portmaster will delete the backup. Using -b will instruct portmaster not to automatically delete the backup. Adding -i will start portmaster in interactive mode, prompting for confirmation before upgrading each port.
|}

If you encounter errors during the upgrade process, use -f to upgrade/rebuild all ports:
: <code>portmaster -af</code>

You can also use portmaster to install new ports on the system, upgrading all dependencies before building and installing the new port:
: <code>portmaster shells/bash</code>

Refer to [http://www.freebsd.org/cgi/man.cgi?query=portmaster&amp;sektion=8&amp;manpath=FreeBSD+8.2-RELEASE+and+Ports portmaster] for more information.

=== Ports and Disk Space ===

Using the Ports Collection will use up disk space over time. After building and installing a port, make clean will clean up the temporary ''work'' directory. To sweep the whole Ports Collection:
: <code>portsclean -C</code>

A lot of out-dated source distribution files will collect in distfiles over time. The following command will delete all the distfiles that are no longer referenced by any ports:
: <code>portsclean -D</code>

To remove all distfiles not referenced by any port currently installed on the system:
: <code>portsclean -DD</code>

{| style="color:black; background-color:#f3f8fd;" class="wikitable"
|'''Note!''' The ''portsclean'' utility is part of the '''portupgrade''' suite.
|}

''ports-mgmt/pkg_cutleaves'' automates the task of removing installed ports that are no longer needed.

== See also ==
* [http://www.freebsd.org/doc/handbook/ports-using.html FreeBSD Handbook: Using the Ports Collection]

[[Category:Handbook]]
[[Category:Application Management]]
@@ Line 1: / Line 1: @@
 <noinclude>{{NavHeader|back=Using pkgng Package Management|forward=Using pkgsrc Package Management|custompagename=Using the Ports Collection}}</noinclude>
-{|class="wikitable" style="width:96.5%;background:#FFFFFF; border:2px solid #008000"
-|-
-|style="text-align:center;padding: 10px" | [[File:Dialog-warning.png|35px|link=]] '''Attention: Not all instructions on this page are up to date. <br/>Please look at [[Ports|Ports on this wiki.]]
-|}
 This section provides basic instructions on using the Ports Collection to install or remove software. The detailed description of available make targets and environment variables is available in [http://www.freebsd.org/cgi/man.cgi?query=ports&amp;sektion=7 ports].