*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> ports (7)              



NAME    [Toc]    [Back]

     ports -- contributed applications

DESCRIPTION    [Toc]    [Back]

     The FreeBSD Ports Collection offers a simple way for users and administrators
 to install applications.  Each port contains any patches necessary
 to make the original application source code compile and run on BSD.
     Compiling an application is as simple as typing make build in the port
     directory!  The Makefile automatically fetches the application source
     code, either from a local disk or via FTP, unpacks it on your system,
     applies the patches, and compiles it.  If all goes well, simply type make
     install to install the application.

     It is possible to download and use ports from the FreeBSD repository that
     are newer than the installed system; however it is important to install
     the appropriate ``Upgrade Kit'' from http://www.FreeBSD.org/ports/ first!
     The portcheckout(1) script (also a port, of course!) will help to download
 new ports.

     For more information about using ports, see ``Packages and Ports'' in The
     FreeBSD Handbook,
     (file:/usr/share/doc/en_US.ISO8859-1/books/handbook/ports.html or
     For information about creating new ports, see The Porter's Handbook
     (file:/usr/share/doc/en_US.ISO8859-1/books/porters-handbook/index.html or

TARGETS    [Toc]    [Back]

     Some of the targets work recursively through subdirectories.  This lets
     you, for example, install all of the ``biology'' ports.  The targets that
     do this are build, checksum, clean, configure, depends, extract, fetch,
     install, and package.

     The following targets will be run automatically by each proceeding target
     in order.	That is, build will be run (if necessary) by install, and so
     on all the way to fetch.  Usually, you will only use the install target.

     fetch	Fetch all of the files needed to build this port from the
		sites listed in MASTER_SITES and PATCH_SITES.  See FETCH_CMD

     checksum	Verify that the fetched distfile's checksum matches the one
		the port was tested against.  Defining NO_CHECKSUM will skip
		this step.

     depends	Install (or compile if only compilation is necessary) any
		dependencies of the current port.  When called by the extract
		or fetch targets, this is run in piecemeal as fetch-depends,
		build-depends, etc.  Defining NO_DEPENDS will skip this step.

     extract	Expand the distfile into a work directory.

     patch	Apply any patches that are necessary for the port.

     configure	Configure the port.  Some ports will ask you questions during
		this stage.  See INTERACTIVE and BATCH.

     build	Build the port.  This is the same as calling the all target.

     install	Install the port and register it with the package system.
		This is all you really need to do.

     The following targets are not run during the normal install process.

     fetch-list       Show list of files needed to be fetched in order to
		      build the port.

     fetch-recursive  Fetch the distfiles of the port and all its dependencies.

		      Show list of files that would be retrieved by

     pretty-print-run-depends-list, pretty-print-build-depends-list
		      Print a list of all the compile and run dependencies,
		      and dependencies of those dependencies.

     clean	      Remove the expanded source code.	This recurses to
		      dependencies unless NOCLEANDEPENDS is defined.

     distclean	      Remove the port's distfiles and perform the clean target.
  The clean portion recurses to dependencies unless
		      NOCLEANDEPENDS is defined, but the distclean portion
		      never recurses (this is perhaps a bug).

     reinstall	      Use this to restore a port after using pkg_delete(1)
		      when you should have used deinstall.

     deinstall	      Remove an installed port from the system, similar to

     deinstall-all    Remove all installed ports with the same PKGORIGIN from
		      the system.

     package	      Make a binary package for the port.  The port will be
		      installed if it has not already been.  The package is a
		      .tbz file that you can use to install the port on other
		      machines with pkg_add(1).  If the directory specified by
		      PACKAGES does not exist, the package will be put into
		      the current directory.  See PKGREPOSITORY and PKGFILE.

		      Like package, but makes a package for each depending
		      port as well.

     readmes	      Create a port's README.html.  This can be used from
		      /usr/ports to create a browsable web of all ports on
		      your system!

     search	      Search the INDEX file for the pattern specified by
		      either the key (searches the port name, comment, and
		      dependencies) or name (searches the port name only)
		      make(1) variable.  For example, one would type:

			    cd /usr/ports && make search name=query

		      to find all ports whose name matches ``query''.  Results
		      include the matching ports' path, comment, maintainer,
		      build dependencies, and run dependencies.

     index	      Create /usr/ports/INDEX, which is used by the
		      pretty-print-* and search targets.  While the master
		      INDEX file in the CVS repository is periodically
		      updated, running the index target will ensure your INDEX
		      file is up to date with your ports tree.

ENVIRONMENT    [Toc]    [Back]

     You can change all of these.

     PORTSDIR	   Location of the ports tree.	This is /usr/ports on FreeBSD
		   and OpenBSD, and /usr/pkgsrc on NetBSD.

     WRKDIRPREFIX  Where to create any temporary files.  Useful if PORTSDIR is
		   read-only (perhaps mounted from a CD-ROM).

     DISTDIR	   Where to find/put distfiles, normally distfiles/ in

     PACKAGES	   Used only for the package target; the base directory for
		   the packages tree, normally packages/ in PORTSDIR.  If this
		   directory exists, the package tree will be (partially) constructed.
  This directory does not have to exist; if it
		   does not, packages will be placed into the current directory,
 or you can define one of

		   PKGREPOSITORY  Directory to put the package in.

		   PKGFILE	  The full path to the package.

     PREFIX	   Where to install things in general (usually /usr/local or

     MASTER_SITES  Primary sites for distribution files if not found locally.

     PATCH_SITES   Primary locations for distribution patch files if not found

		   If set, go to the master FreeBSD site for all files.

		   Try going to these sites for all files and patches, first.

		   If defined, do not let clean recurse to dependencies.

     FETCH_CMD	   Command to use to fetch files.  Normally fetch(1).

		   If set, overwrite any existing package registration on the

     MOTIFLIB	   Location of libXm.{a,so}.

     INTERACTIVE   If defined, only operate on a port if it requires interaction.

     BATCH	   If defined, only operate on a port if it can be installed
		   100% automatically.

FILES    [Toc]    [Back]

     /usr/ports 		The default ports directory (FreeBSD and
     /usr/pkgsrc		The default ports directory (NetBSD).
     /usr/ports/Mk/bsd.port.mk	The big Kahuna.

SEE ALSO    [Toc]    [Back]

     make(1), pkg_add(1), pkg_create(1), pkg_delete(1), pkg_info(1),

     The following are part of the ports collection:

     pib(1), portcheckout(1), portlint(1)

     The FreeBSD Handbook.

     http://www.FreeBSD.org/ports (searchable index of all ports)

AUTHORS    [Toc]    [Back]

     This man page was originated by David O'Brien.

HISTORY    [Toc]    [Back]

     The Ports Collection appeared in FreeBSD 1.0.  It has since spread to
     NetBSD and OpenBSD.

BUGS    [Toc]    [Back]

     Ports documentation is split over four places --
     /usr/ports/Mk/bsd.port.mk, The Porter's Handbook, the ``Packages and
     Ports'' chapter of The FreeBSD Handbook, and this man page.

     This man page is too long.

FreeBSD 5.2.1		       January 25, 1998 		 FreeBSD 5.2.1
[ Back ]
 Similar pages
Name OS Title
sysman_intro Tru64 Introduction of SysMan applications
portal HP-UX a "window to the future" for applications
form_init OpenBSD set hooks for automatic invocation by applications
menu_term OpenBSD set hooks for automatic invocation by applications
menu_init OpenBSD set hooks for automatic invocation by applications
menu_hook OpenBSD set hooks for automatic invocation by applications
item_term OpenBSD set hooks for automatic invocation by applications
item_init OpenBSD set hooks for automatic invocation by applications
field_term OpenBSD set hooks for automatic invocation by applications
form_hook OpenBSD set hooks for automatic invocation by applications
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service