path: root/ports-mgmt/porteasy/src/porteasy.8

.\"-
.\" Copyright (c) 2000 Dag-Erling Coïdan Smørgrav
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer
.\"    in this position and unchanged.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"	$FreeBSD$
.\"
.Dd September 19, 2000
.Dt PORTEASY 8
.Os
.Sh NAME
.Nm porteasy
.Nd fetch and build ports
.Sh SYNOPSIS
.Nm porteasy
.Op Fl abCceFfhikluVv
.Op Fl D Ar date
.Op Fl d Ar dir
.Op Fl p Ar dir
.Op Fl r Ar dir
.Op Fl t Ar tag
.Op Ar port ...
.Sh DESCRIPTION
.Nm
maintains an updated ports tree, and fetches and builds ports
automatically, keeping track of dependencies.
.Pp
The following options are available:
.Bl -tag -width Fl
.It Fl a
Use the FreeBSD project's anoncvs server as CVS root directory.
.It Fl b
Build the selected ports.
.It Fl C
Don't clean port directories after building.
.It Fl c
Clean the selected ports.
.It Fl D Ar date
Specify a date to use for
.Xr cvs 1
operations.
.It Fl d Ar dir
Specify the package database directory (normally
.Pa /var/db/pkg ) .
.It Fl e
Deselect ports that are already installed.
.It Fl F
Force installation and registration, even if the port is already
installed.
.It Fl f
Fetch the selected ports.
.It Fl h
Show a summary of options and parameters.
.It Fl i
Describe the selected ports.
.It Fl k
Build packages for the selected ports.
.It Fl l
List the selected ports.
.It Fl p Ar dir
Specify the ports directory (normally 
.Pa /usr/ports ) .
.It Fl r Ar dir
Specify the CVS root directory.
.It Fl t Ar tag
Specify a tag to use for
.Xr cvs 1
operations.
.It Fl u
Update all necessary files using
.Xr cvs 1 .
.It Fl V
Show the
.Nm
version number and exit.
.It Fl v
Verbose mode: show more information about what is being done.
.El
.Pp
If no options are specified, the default is to build the specified
ports.
.Ss Port names
The port names listed on the command line may be either unqualified or
fully qualified.
A fully qualified port name is the path to the port directory relative
to the root of the ports tree (i.e. the port's category and name
separated by a slash).
An unqualified port name is the name of the package built by the
intended port, or part of that name.
.Pp
Unqualified names need to be looked up in the ports index, which is
usually slightly out of date, so fully qualified names should be used
whenever possible.
.Ss Sequence of operation
This section describes the operations performed by
.Nm
and the order in which they are performed.
.Bl -tag -width indent
.It Update index
If the
.Fl u
option was specified and some unqualified port names were listed on
the command line, the index file is updated using
.Xr cvs 1 .
.It Select ports
The selection list is initialized with the ports listed on the command
line, marked as explicit dependencies.
Any unqualified names are looked up in the index, using simple
heuristics to identify incompletely named ports.
If a certain match is not found,
.Nm
prints a list of possible matches and exits.
.Pp
All direct and indirect dependencies of the ports listed on the
command line are also selected and marked as dependencies.
.It Update ports tree and discover dependencies
If the
.Fl u
option was specified, the port directories for all selected ports are
updated using
.Xr cvs 1 .
Each selected port's Makefile is scanned to discover dependencies,
which are in turn selected and marked as implicit dependencies.
This process is repeated until no new dependencies are found.
.It Deselect installed ports
.Pp
If the
.Fl e
option was specified,
.Nm
checks to see if any of the selected ports are already installed;
those that are are deselected.
This process is not very accurate, as it will not detect if an older
or alternate version of a selected port is installed.
.It List selected ports
If the
.Fl l
option was specified, the fully qualified name and package name of all
selected ports are listed.
Explicitly selected ports are indicated with a star.
.It Describe selected ports
If the
.Fl i
option was specified,
.Nm
prints a description of each port that was specified on the command
line.
If no ports were specified,
.Nm
instead prints a list of all installed ports, with unknown ports (i.e.
ports that are not in the index file, or are out of date) indicated
with a question mark.
.It Clean the tree
If the
.Fl c
option was specified,
.Nm
runs the
.Sq clean
target on every selected port.
If no ports were selected,
.Nm
runs the
.Sq clean
target on every known port that is present in the tree.
.It Fetch ports
If at least one of the
.Fl b ,
.Fl f
or
.Fl k
options was specified,
.Nm
runs the
.Sq fetch
target on every selected port.
.It Build, install, package, clean ports
If one or both of the
.Fl f
or
.Fl k
options were specified,
.Nm
runs the
.Sq install
or
.Sq package
target, followed by the
.Sq clean
target (unless the
.Fl C
option was specified), on every explicitly selected port.
.Nm
lets the ports system handle dependencies on its own, since the
reported dependencies are sometimes too inclusive.
.El
.Sh IMPLEMENTATION NOTES
There may be a significant difference between what ports are selected
(and listed if the
.Fl l
option is specified) and what ports are actually installed and/or have
packages built for them, since implicitly selected ports that are
already installed, or somehow pass the dependency check (e.g. because
an alternate, equivalent port has been installed) will be passed over
by the ports system, as indeed they should.
.Pp
.Nm
tries to minimize the number of times
.Xr cvs 1
is invoked, since the overhead involved in connecting to a remote
server is usually quite high (and the user might have to type a
password every time), but prefers correctness to performance.
The maximum number of invocations is (2 + NC + NP), where NC and NP
are the number of distinct categories and ports (including master
directories and dependencies).
.Sh ENVIRONMENT
.Bl -tag -width PORTEASY_OPTIONS
.It Ev PORTEASY_OPTIONS
Specifies a set of default options for
.Nm .
These options can be overridden by command line parameters.
.El
.Sh FILES
.Nm
maintains and operates on a ports tree, normally
.Pa /usr/ports .
Some information is gathered from the package database, normally
located in
.Pa /var/db/pkg .
.Sh AUTHORS
.Nm
was written by
.An Dag-Erling Smørgrav Aq des@FreeBSD.org .
Several people contributed their comments and suggestions, most
notably
.An Eivind Eklund Aq eivind@FreeBSD.org .