ports/README - diff

Return to README CVS log

Up to [local] / ports

Diff for /ports/README between version 1.10 and 1.11

version 1.10, 2001/04/11 15:57:50

version 1.11, 2001/11/01 22:59:37

Line 9

======================================================================

This file is mostly obsolete. You should refer to the corresponding

man-pages: ports(7), packages(7), bsd.port.mk(5) instead.

man-pages: ports(7), packages(7), mirroring-ports(7), packages-specs (7),

and bsd.port.mk(5) instead.

======================================================================

Contacts

========

* individual ports list a

* individual ports have a MAINTAINER.

MAINTAINER=

Go to the port directory and use make show=MAINTAINER to see it.

line in their Makefile.

* specific issues related to the ports framework (e.g., bugs in

bsd.port.mk) should go to ports-admin@openbsd.org

* ports without explicit maintainers, and other general issues should

go to ports@openbsd.org

Line 30

Line 28

or go to the next step.

Developers with a major investment in the ports tree include

brad@cvs.openbsd.org, naddy@cvs.openbsd.org, espie@cvs.openbsd.org

Brad Smith <brad@openbsd.org>, Christian Weisberger <naddy@openbsd.org>,

Marc Espie <espie@openbsd.org>.

Those people can be contacted to put some pressure on a lazy maintainer.

But we do read ports@openbsd.org, so...

Line 47

Line 46

The main Makefile, PORTSDIR/Makefile, can be used to obtain various

information.

* make search key=<keyword>

* make key=<keyword> describe

will locate ports that match the given keyword in the Index and print

information about them.

Line 56

Line 55

ports dir through cvs.

* make readmes

will populate the ports tree with a set of html indices.

will populate the ports tree with a set of html indices (currently somewhat

broken).

The script INFRA/build/out-of-date will find

discrepancies between your installed packages and the INDEX. This might

Line 88

* build the program

`make install' will

* install the software on your system

* install the software in a special playpen directory (the fake area)

* log the installation so that later pkg_info or pkg_delete can deal with

* create a binary package out of that fake-install

the software.

* install the package on your system

Some ports can have some options, or demand that you make some choice

Some ports can have some options (flavors), or demand that you make some choice

before building, e.g.,

cd /usr/ports/security/ssh

cd /usr/ports/editors/vim/stable

make all install USA_RESIDENT=no

env FLAVOR=no_x11 make all install

Some ports may prompt you for more choice, or give you important

Some ports may give you some information about ways to build them.

information about ports building. Likewise, installing or uninstalling

Likewise, installing or uninstalling

a port may give you useful information. READ IT.

a package may give you useful information. READ IT.

You can also use

* `make uninstall' to remove the installed software (same as pkg_delete)

* `make clean=install' to remove the installed software (calls pkg_delete)

* `make package' to convert the installed software into a binary `package'

* `make package' to create a binary package without necessarily installing

(a tar ball that you can share with other machines with the same

it. Packages normally end up in /usr/ports/packages/${MACHINE_ARCH},

configuration, contribute to the ftp project, or that you can backup

overridable with PACKAGES.

separately). Packages normally end up in /usr/ports/packages, overridable

* `make clean=package' to remove a previously built package.

with PACKAGE.

* `make fetch-list' to build a small shell-script that should be able to

retrieve the missing distfiles and distribution patches for the given port.

* `make clean' to remove all scaffolding after the port is built and

installed.

* `make distclean' to also remove distfiles and distribution patches

* `make clean=dist' to also remove distfiles and distribution patches

from the repository

* `make clean CLEANDEPENDS=Yes' will also remove sub ports that have been

* `make clean=depends' will also remove sub ports that have been

recursively built.

* `make distclean CLEANDEPENDS=Yes', guess what this does.

* `make clean="depends dist"', guess what this does.

Please note that, in normal use, the OpenBSD ports tree will grow quite

a lot. Careful use of make clean and make distclean will help you. You

a lot. Starting with OpenBSD 3.0, working directories for packaged ports

can also redirect ports activity elsewhere by making use of WRKOBJDIR

can be cleaned out. See the bulk-packages target.

and DISTDIR. `find /usr/ports -type d -name work\* -print'

However, the distfiles and built

packages still can take a lot of space (over 1 Gb).

You can redirect ports activity elsewhere by making use of WRKOBJDIR,

DISTDIR and PACKAGES. `find /usr/ports -type d -name w-\* -print'

can be useful to find out ports you forgot to clean out.

There are a few kinks in the building of ports with options yet. Namely,

all such ports should produce distinct package names if built with

different options. Also, there is no check for consistency between

make and make install. Taking the ssh example again,

make USA_RESIDENT=No

make install USA_RESIDENT=Yes

won't be flagged as an error...

Where do the distfiles come from

================================

Retrieving distfiles is a subpart of `make' that can be invoked separately

Line 175

Line 167

the distribution files on ftp.openbsd.org. MASTER_SITE_BACKUP holds an

overridable list of backup sites, normally

ftp://ftp.openbsd.org/pub/OpenBSD/distfiles/${DIST_SUBDIR}/

ftp://ftp.openbsd.org/pub/OpenBSD/licensed/${DIST_SUBDIR}/

ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/

You can ask the fetch process to try to retrieve files from those sites first

Line 210

Line 201

There is a backup copy of that file in

INFRA/templates/network.conf.template.

In case you don't have a permanent network connection,

In case you don't have a permanent network connection, you should read

`make fetch-list' should provide you with a shell script you can use to

mirroring-ports(7).

retrieve distfiles you're missing to build a given port.

(TODO: improve and systematize fetch-all)

Building several ports

======================

Each category directory holds a Makefile that propagates commands to

its sub ports, e.g., if you cd /usr/ports/audio && make, this should

its sub ports, e.g., if you cd /usr/ports/audio && make package, this should

build all ports under /usr/ports/audio.

build packages for all ports under /usr/ports/audio.

A more useful command is the

INFRA/build/find-build-order script.

INFRA/package/check-plist script.

You normally prepare a list of the ports you want to build, in the same

format as INFRA/db/essentials, and pass it to find-build-order like

format as INFRA/db/essentials, and pass it to that script.

this:

cd /usr/ports/infrastructure

cat db/essentials|build/find-build-order

This yields a sorted list of the required ports.

(Todo: provide for a script which builds everything we want)

You can filter ports that require interaction out with

make BATCH=yes

Likewise, make FOR_CDROM=yes, make NO_RESTRICTED=yes

will yield only the ports with the required level of liberty.

Files Summary

=============

/usr/ports (PORTSDIR):

Line 247

Line 227

where to find a given port

/usr/ports/INDEX:

all distfiles, rebuilt with make index

/usr/ports/README.html

/usr/ports/<category>/README.html

/usr/ports/<category>/<portname>/README.html:

www indices produced by make readmes

/usr/ports/distfiles (DISTFILES):

repository for distribution files and distribution patches

/cdrom/distfiles (CDROM_SITE):

standard location for distfiles off a CD

/usr/ports/packages (PACKAGES):

/usr/ports/packages/${MACHINE_ARCH} (PACKAGES):

where binary packages are built (by category. Normally everything

ends up under All, with symlinks for each category)

/usr/ports/<category>/<portname>/work:

/usr/ports/<category>/<portname>/w-${PKGNAME}:

where the ports mechanism does the building. This is normally a

real directory, but you can set WRKOBJDIR to point to another

base which is not /usr/ports, and work/ will be a link to

Line 279

Line 255

installed ports, see pkg_add(1).

/usr/local (LOCALBASE):

where normal ports install themselves.

/usr/X11R6 (X11BASE):

where ports with a large dependency on X11 install themselves.

Other tweaks

============

FORCE_PACKAGE: force package building. Some ports can't be distributed

as packages for legal reasons, but you may wish to build a package for

your private consumption.

HAVE_MOTIF: set in /etc/mk.conf if we own a copy of the real thing.

MOTIF_STATIC: set in /etc/mk.conf to use a static version of the Motif

library only.

NO_MTREE: don't run mtree before installing a port. This is a dangerous

option.

NO_PKG_REGISTER: used for make install, don't register port under

/var/db/pkg. This is a dangerous option.

FORCE_PACKAGE_REGISTER: override an existing port (the <pkgname> is already

installed message). You will end up with several flavors of the same

package. This is a dangerous option, as this will probably erase the other

port.

NO_IGNORE: coerce fetch, build, install... into doing their job even though

there might be a good reason not to. Good reasons include BROKEN,

ONLY_FOR_ARCH, IS_INTERACTIVE in BATCH mode, NO_CDROM in FOR_CDROM... This

ONLY_FOR_ARCH, IS_INTERACTIVE in BATCH mode. This is a dangerous option.

is a dangerous option.

Keeping up with the Jones, ports as a moving target

===================================================

The OpenBSD ports tree is growing from release to release. It needs

people to write and test new ports.

Like for src, you can choose to live on the bleeding edge by updating

your ports dir thru cvs or ftp, and contribute bug-reports.

your ports dir thru cvs or ftp, and contribute bug-reports. You must

update both ports and src in synch.

If you prefer to stay with a stable release, we try to make sure

the distfiles for a given release stay on the OpenBSD site between

releases.

No matter how fast we update the tree it seems that we are always

behind. For this reason you will sometimes find a port that is

behind. There are always new version of software out there, without

marked as BROKEN. If you try to build the port you will see a

an existing port. Very often, no-one had time to update the port yet,

message something like:

or it is very likely that the new version has not been tested enough

yet to deem it reasonable to upgrade the port.

===> xxx-1.0 is marked as broken: newer version available.

You may wish to contribute, by updating ports or creating new ports.

This means we know there is a newer version of the application but

have not yet had time to update the port. If you get this message

all may not be lost. If the old sources are still available (and

this is often the case) you can force a build using the old sources

using the command:

make NO_IGNORE=yes

sudo make NO_IGNORE=yes install

If you're feeling generous a better solution is to update the port

to use the new sources and feed the changes back to the project.

If you are interested in contributing (or creating a new port)

please visit

http://www.openbsd.org/porting.html

and always remember to communicate with OpenBSD project members on

ports@openbsd.org. Why create a brand new shiny port to discover that

someone was already working on it, and they committed their new version

ten minutes before you announced yours ?

$OpenBSD$