Differences between version 2 and previous revision of ports(7).
Other diffs: Previous Major Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 2 | Last edited on Friday, February 28, 2003 1:05:04 am | by PerryLorier | Revert |
| Older page: | version 1 | Last edited on Thursday, February 27, 2003 10:11:12 pm | by zcat(1) | Revert |
@@ -1,178 +1,105 @@
-NAME
+!!
NAME
ports - contributed applications
-DESCRIPTION
-
The FreeBSD Ports Collection offers a simple way for users and adminis-
- trators
to install applications. Each port contains any patches neces-
- sary
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.
+!!
DESCRIPTION
+;:
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 down-
- load
new ports.
+;:
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 The Ports Collection
-
(file:/usr/share/doc/handbook/ports.html --or--
-
http://www.FreeBSD.org/handbook/ports.html). For information about cre-
- ating
new ports, see Porting applications (file:/usr/share/doc/hand-
- book/porting.html --or--
http://www.FreeBSD.org/handbook/porting.html).
-
Both are part of the FreeBSD Handbook.
+;:
For more information about using ports, see The Ports Collection (http://www.FreeBSD.org/handbook/ports.html). For information about creating
new ports, see Porting applications (http://www.FreeBSD.org/handbook/porting.html). Both are part of the FreeBSD Handbook.
-TARGETS
-
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.
+!!
TARGETS
+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.
+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
-
site(s) listed in MASTER_SITES and PATCH_SITES. See FETCH_CMD
-
and MASTER_SITE_OVERRIDE.
+;
fetch:
Fetch all of the files needed to build this port from the site(s) listed in MASTER_SITES and PATCH_SITES. See FETCH_CMD and MASTER_SITE_OVERRIDE.
-
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.
+;
checksum:
Verify that the fetched distfile's checksum matches the one the port was tested against. Defining NO_CHECKSUM will skip this step.
- extract Expand
the distfile into a work directory
.
+;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
.
- patch Apply any patches that are necessary for
the port
.
+;extract:Expand
the distfile into a work directory
.
- configure Configure
the port. Some ports will ask you questions during
- this stage. See INTERACTIVE and BATCH
.
+;patch:Apply any patches that are necessary for
the port.
- build Build
the port. This is the same as calling the all target
.
+;configure:Configure
the port. Some ports will ask you questions during this stage. See INTERACTIVE and BATCH
.
- install Install
the port and register it with the package system
.
-
This is all you really need to do
.
+;build:Build
the port.
This is the same as calling the
all target
.
- The following targets are not run during the normal
install process
.
+;
install:Install the port and register it with the package system. This is all you really need to do
.
- fetch-list Show list of files needed to be fetched in order to build
the
- port
.
+;:The following targets are not run during
the normal install process
.
- 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
.
+;fetch
-list:Show
list of files needed to be fetched in order to build
the port
.
- clean Remove the expanded source code. This recurses to dependen
-
- cies unless NOCLEANDEPENDS is defined
.
+;pretty
-print-run-depends-list, pretty-print-build-depends-list: Print a list of all the compile and run dependencies, and ependencies of those dependencies
.
- distclean
Remove the port's distfile(s) 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)
.
+;clean:
Remove the expanded source code
. This
recurses to dependencies unless NOCLEANDEPENDS is defined.
- reinstall Use this to restore a
port after using pkg_delete
(1
) when you
- should have used deinstall
.
+;distclean:Remove the
port's distfile
(s) 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
).
- deinstall Remove an installed port from the system, similar
to
-
pkg_delete(1).
+;reinstall:Use this
to restore a port after using
pkg_delete(1) when you should have used deinstall
.
- package Make a binary package for
the port. The port will be
- installed if it hasn't already been. The package is a .tgz
- 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
.
+;deinstall:Remove an installed port from
the system, similar
to pkg_delete
(1).
- 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!
+;package:Make
a binary package for the
port. The port will be installed if it hasn
't already been
. The package is a .tgz 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.
-
search
Search the INDEX file for the pattern specified by either the
-
key (searches the port name, comment, and dependencies) or
-
name (just searches the port name) make argument. For exam-
- ple
, one would type:
+;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 (just searches the port name) make argument. 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.
+;:
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.
+;
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
-
You can change all of these.
+!!
ENVIRONMENT
+;:
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.
+;
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 cdrom).
+;
WRKDIRPREFIX:
Where to create any temporary files. Useful if PORTSDIR is read-only (perhaps mounted from a cdrom).
-
DISTDIR
Where to find/put distfiles, normally distfiles/ in
-
PORTSDIR.
+;
DISTDIR:
Where to find/put distfiles, normally distfiles/ in PORTSDIR.
-
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) con-
- structed
. This directory does not have to exist; if it
-
doesn't packages will be placed into the current directory,
-
or you can define one of
+;
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 doesn't packages will be placed into the current directory, or you can define one of
-
PKGREPOSITORY
Directory to put the package in.
+;
PKGREPOSITORY:
Directory to put the package in.
-
PKGFILE
The full path to the package.
+;
PKGFILE:
The full path to the package.
-
PREFIX
Where to install things in general (usually /usr/local or
-
/usr/X11R6)
+;
PREFIX:
Where to install things in general (usually /usr/local or /usr/X11R6)
-
MASTER_SITES
Primary sites for distribution files if not found locally.
+;
MASTER_SITES:
Primary sites for distribution files if not found locally.
-
PATCH_SITES
Primary location(s) for distribution patch files if not
-
found locally.
+;
PATCH_SITES:
Primary location(s) for distribution patch files if not found locally.
-
MASTER_SITE_FREEBSD
-
If set, go to the master FreeBSD site for all files.
+;
MASTER_SITE_FREEBSD:
If set, go to the master FreeBSD site for all files.
-
MASTER_SITE_OVERRIDE
-
Try going to this site for all files and patches, first.
+;
MASTER_SITE_OVERRIDE:
Try going to this site for all files and patches, first.
-
NOCLEANDEPENDS
-
If defined, don't let `clean' recurse to dependencies.
+;
NOCLEANDEPENDS:
If defined, don't let `clean' recurse to dependencies.
-
FETCH_CMD
Command to use to fetch files. Normally fetch(1).
+;
FETCH_CMD:
Command to use to fetch files. Normally fetch(1).
-
FORCE_PKG_REGISTER
-
If set, overwrite any existing package registration on the
-
system.
+;
FORCE_PKG_REGISTER:
If set, overwrite any existing package registration on the system.
-
MOTIFLIB
Location of libXm.{a,so}.
+;
MOTIFLIB:
Location of libXm.{a,so}.
-
INTERACTIVE
If defined, only operate on a port if it requires interac-
- tion
.
+;
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.
+;
BATCH:
If defined, only operate on a port if it can be installed 100% automatically.
-FILES
-
/usr/ports
The default ports directory (FreeBSD and OpenBSD).
-
/usr/pkgsrc
The default ports directory (NetBSD).
-
/usr/ports/Mk/bsd.port.mk
-
The big Kahuna.
+!!
FILES
+;
/usr/ports:
The default ports directory (FreeBSD and OpenBSD).
+;
/usr/pkgsrc:
The default ports directory (NetBSD).
+;
/usr/ports/Mk/bsd.port.mk:
The big Kahuna.
-SEE ALSO
-
make(1), pkg_add(1), pkg_create(1), pkg_delete(1), pkg_info(1),
-
pkg_version(1)
+!!
SEE ALSO
+;:
make(1), pkg_add(1), pkg_create(1), pkg_delete(1), pkg_info(1), pkg_version(1)
The following are part of the ports collection:
pib(1), portcheckout(1), portlint(1)
