Annotation of www/ports.html, Revision 1.41
1.11 deraadt 1: <html>
1.25 deraadt 2: <head>
3: <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4: <meta name="resource-type" content="document">
5: <meta name="description" CONTENT="How OpenBSD can make use of the FreeBSD ports">
6: <meta name="keywords" content="openbsd,ports">
7: <meta name="distribution" content="global">
8: <meta name="copyright" content="copyright 1997-1999 by the OpenBSD project">
9:
1.27 brad 10: <title>OpenBSD Ports and Packages</title>
1.25 deraadt 11: <link rev="made" HREF="mailto:www@openbsd.org">
12:
13: <body text="#000000" bgcolor="#FFFFFF" link="#23238E">
14:
15: <img height=30 width=141 src=images/smalltitle.gif alt="[OpenBSD]" >
1.30 espie 16:
1.31 espie 17: <h2><font color=#e00000>The Ports & Packages collection</font><hr></h2>
1.25 deraadt 18:
1.31 espie 19: <h3><font color=#0000e0>Motivation</font></h3>
1.25 deraadt 20:
21: OpenBSD is a fairly complete system of its own, but still there is a lot
22: of software that one might want see added. However there is the problem
23: on where to draw the line as to what to include, as well as the occasional
24: licensing and export restriction problems. As OpenBSD is supposed to be
25: a small stand-alone UNIX-like operating system, some things just can't be
26: shipped with the system.
27:
28: <p>
1.31 espie 29: <strong><font color=#e00000>
30: The ports & packages collection does NOT go through the thorough security audit that OpenBSD follows.
31: Although we strive to keep the quality of the packages collection high, we just do not have enough human
32: resources to ensure the same level of robustness and security.
33: </font></strong>
1.25 deraadt 34:
35: <p>
1.31 espie 36: The port collection, originally borrowed from
37: <a href="http://www.freebsd.org/">FreeBSD</a>, fills this gap.
38: The concept is to have, for each third-party software, a Makefile that
1.25 deraadt 39: controls
40: <ul>
41: <li>where to fetch it,
42: <li>how to do the fetch,
43: <li>what it depends upon (if anything),
44: <li>how to alter the sources (if needed),
45: <li>and how to configure, build and install it.
46: </ul>
47: This information is kept in a directory hierarchy under the
48: /usr/ports directory.
1.31 espie 49:
50: <p>
51: Packages are the binary equivalent of ports. A compiled port becomes
52: a package that can be registered into the system using pkg_add(1).
53:
54: <p>
55: <strong><font color=#e00000>
1.36 brad 56: Packages look like simple <code>.tgz</code> bundles, but they should
1.33 espie 57: always be added using
58: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>,
59: as there might be some extra information that only
60: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>
61: knows how to handle.</font></strong>
1.36 brad 62: Tip: you can distinguish between packages and <strong>.tgz</strong> bundles
1.33 espie 63: using
64: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_info&sektion=1&format=html">pkg_info(1)</a>.
1.31 espie 65:
66: <h3><font color=#0000e0>Getting packages</font></h3>
67:
68: A large collection of pre-compiled packages is available for most common
69: architectures.
70: <ul>
1.34 jufi 71: <li>On the CD-Rom (that you can order <a href="orders.html">here</a>),
1.31 espie 72: <li>On the <a href=ftp.html>ftp mirror sites</a>.
1.40 beck 73: <li>Browsed and retrieved from the web package lists:
74: <ul>
1.41 ! beck 75: <li><A HREF="http://www.openbsd.org/Snap_packages/">Packages for OpenBSD Snapshots
1.40 beck 76: <li><A HREF="http://www.openbsd.org/2.7_packages/">Packages for OpenBSD 2.7
77: </A>
78: </ul>
1.31 espie 79: </ul>
80:
81: Adding a package is as easy as
1.36 brad 82: <code>pkg_add pkgname.tgz</code>.
1.31 espie 83: If you are grabbing packages off a single source (a package repository),
1.39 espie 84: set PKG_PATH to that repository URL, in order to grab dependencies.
1.31 espie 85:
86: <p>
87: For instance, to install the gimp package for the 2.7 release on an i386
88: machine off the ftp site (including dependencies), do:
89:
90: <pre>
91: # setenv PKG_PATH ftp://ftp.openbsd.org/pub/OpenBSD/2.7/packages/i386/
1.39 espie 92: # pkg_add ${PKG_PATH}gimp-1.1.17.tgz
1.31 espie 93: </pre>
94:
95: <h3><font color=#0000e0>Managing installed packages</font></h3>
96:
1.33 espie 97: The <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=packages&sektion=7&format=html">packages(7)</a>
1.31 espie 98: manual page holds useful information about ways to manage
99: installed packages, solve conflicts (files that already exist) and handle
100: dependencies.
101: <p>
102: As of OpenBSD 2.7, to update a package you must:
103: <ul>
1.33 espie 104: <li>Remove the old package using
105: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_delete&sektion=1&format=html">pkg_delete(1)</a>
106: <li>Add the new package using
107: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>
1.31 espie 108: </ul>
109: This is slightly inconvenient, as packages may trigger dependencies, and
110: you may have to remove a large subset of packages for an update.
111:
112: <h3><font color=#0000e0>Using ports</font></h3>
113:
114: If a given package does not exist for your architecture, you may still
115: be able to compile the port. Besides, some users will want to compile
116: everything from source for various reasons.
117:
1.25 deraadt 118: <p>
1.27 brad 119: You can ftp the release version from the pub/OpenBSD/[version] (where
120: [version] is the release number) directory on any of the
121: <a href=ftp.html>ftp mirror sites</a>.
122: The release versions are the ones we ship on our CDROM, and have gone
123: through more testing than any snapshot.
1.30 espie 124: Further information is available in the
125: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ports&sektion=7&format=html">ports(7)</a> man page.
126:
127: <h3><font color=#0000e0>Ports update for an OpenBSD release</font></h3>
1.27 brad 128:
129: <p>
1.31 espie 130: The ports tree, like the rest of OpenBSD, is constantly changing.
1.30 espie 131: The normal life cycle of the ports tree is as follows:
132: <ul>
133: <li>Track the latest release of OpenBSD for a few months after the release
134: comes out.
135: <li>Switch to tracking OpenBSD-current about two months before the next
136: release.
137: </ul>
138: The change of status will be widely publicized on the
139: <a href=mail.html>Mailing lists</a>.
140:
1.37 marc 141: <p>
142: The current ports tree <strong>may not</strong> be used with the previous
143: release once the switch to tracking OpenBSD-current occurs. This is due
144: to changes, typically with the port make process, that require code
145: based upon the OpenBSD-current source tree. To get the latest version of
146: the ports tree that will work with the previous release:
147: <ul>
148: <li>Determine the cut-off date. Example, the cut-off between 2.7 and
149: 2.8 was indicated by a message to ports@openbsd.org on Aug 16, 2000.
150: <li>Check out a version of the ports tree as of the cut-off date. The
151: steps are (assuming your ports tree came from anoncvs and live in
152: /usr/ports):
153: <pre>
154: $ cd /usr/ports
155: $ cvs -q -d anoncvs@some.anon.server:/cvs up -D 08/15/00 -Pd
156: </pre>
157: Change the name of the server and cut-off date to fit your needs.
158: </ul>
1.38 marc 159: <p>
160: The ports that build with the 2.7 release have also been put into a
161: branch of their own. Instead of grabbing the ports by date you can:
162: <pre>
163: $ cd /usr/ports
164: $ cvs -q -d anoncvs@some.anon.server:/cvs up -r OPENBSD_2_7 -Pd
165: </pre>
166: The OPENBSD_2_7 tag does not imply these ports are in any way `stable', only
167: that the ports will build on a 2.7 system. Security fixes may be added
168: to this branch.
1.30 espie 169: <p>The ports tree works as a single entity. Updating a single directory is
170: not guaranteed to work, as package dependencies may force you to update
171: and recompile vast portions of the ports tree.
1.31 espie 172: It is strongly suggested that people don't track ports-current unless
1.30 espie 173: they're prepared to deal with various problems.
1.33 espie 174: <a href=mail.html>Mailing lists</a> such as
175: <code>source-changes@openbsd.org</code> or
176: <code>tech@openbsd.org</code> will probably be invaluable.
1.27 brad 177:
178: <p>
1.29 espie 179: The ports-current tree can be retrieved via:
1.25 deraadt 180: <ul>
181: <li><a href=anoncvs.html>Anonymous CVS</a> (see link). The command is
182: essentially <strong>cvs get ports</strong>.
183: <li>Anonymous ftp from
184: <a href="ftp://ftp.openbsd.org/pub/OpenBSD/snapshots/ports.tar.gz">
185: ftp://ftp.openbsd.org/pub/OpenBSD/snapshots/ports.tar.gz</a>.
1.19 marc 186: This archive is updated nightly.
1.32 naddy 187: <li><a href="cvsup.html">CVSup</a>. See the example for using CVSup in
188: <a href="cvsup.html#checkout">checkout mode</a>.
1.25 deraadt 189: <li>Your web browser using the
190: <a href="http://www.openbsd.org/cgi-bin/cvsweb/ports/">CVS
1.20 marc 191: web interface</a>.
1.25 deraadt 192: </ul>
193:
1.35 espie 194: <h3><font color=#0000e0>Ports and XFree</font></h3>
195: There is some special magic in the OpenBSD XFree configuration files
196: that allows the ports tree to install imake-based applications under
197: /usr/local.
198:
199: <p>OpenBSD currently does not ship with XFree 4.0.x for various reasons.
200: This ports magic does not work with the XFree 4.0.x distribution.
201: You will need to apply the patch in
202: <code>/usr/ports/infrastructure/patches/patch-xfree-4.0</code>
203: to a default binary XFree 4.0.x distribution for it to work with the OpenBSD
204: ports tree.
205:
1.25 deraadt 206: <h3><font color=#0000e0>Example use of the Ports tree</font></h3>
207:
208: <p>
209: Let's say you managed to get a ports tree and you want to compile and
1.33 espie 210: install the archiving utility <strong>unzip</strong>. You should be able to
1.23 espie 211: do something like this:
1.31 espie 212:
1.11 deraadt 213: <pre>
1.31 espie 214: % cd /usr/ports/archivers/unzip
215: % su
216: # make
217: # make install
218: # exit
1.11 deraadt 219: </pre>
1.25 deraadt 220:
1.31 espie 221: Easy, huh ? Especially considering all that happened in the background:
222: <ul>
223: <li>Fetch unzip sources from an ftp site,
224: <li>Check the source archive integrity,
225: <li>Extract the unzip source,
226: <li>Apply OpenBSD specific patches,
227: <li>Configure and build the program,
228: <li>Create a binary package under /usr/ports/packages,
229: <li>Install that package.
230: </ul>
1.25 deraadt 231:
232: <p>
1.31 espie 233: In OpenBSD 2.7, a large proportion of the ports automatically build
234: packages when installing.
235: In OpenBSD current, almost all ports follow that standard.
236:
237: <p>
238: As ports get built, the /usr/ports/distfiles directory gets filled with
239: program sources, and /usr/ports/packages gets filled with binary packages.
240: Users with low connectivity may refer to mirror-distfiles(7) for
241: an efficient way to grab all distfiles at once.
242: Note that the OpenBSD CD only include the ports tree and selected packages.
243: If you wish to have the distfiles, you will have to get them through an
244: independent way.
1.25 deraadt 245:
246: <h3><font color=#0000e0>Creating new ports</font></h3>
247: <p>
248: If you are interested in helping to expand the OpenBSD ports tree
249: you should first read <a href="porting.html">porting.html</a>.
250: That page references the porting section of the
251: <a href="http://www.freebsd.org/handbook/">FreeBSD handbook</a>
252: as well as OpenBSD specific policies and hints.
253:
254: <h3><font color=#0000e0>Problems and contacts</font></h3>
255:
256: <p>
1.31 espie 257: If you have trouble with existing ports, or need information about creating new ports,
258: please send e-mail to the OpenBSD
1.27 brad 259: ports mailing list, <a href="mailto:ports@openbsd.org">ports@openbsd.org</a>.
1.25 deraadt 260: Corrections are always welcome, but in any case do please provide:
261: <ul>
262: <li>The output of <code>uname -a</code>,
263: <li>Your OpenBSD version, including any patches you may have applied,
264: <li>A complete description of the problem.
265:
266: </ul>
267:
268: <hr>
269: <a href="index.html"><img height=24 width=24 src=back.gif border=0 alt=OpenBSD></a>
270: <a href=mailto:www@openbsd.org>www@openbsd.org</a>
1.41 ! beck 271: <br><small>$OpenBSD: ports.html,v 1.40 2000/10/25 22:46:14 beck Exp $</small>
1.25 deraadt 272: </body>
1.11 deraadt 273: </html>
![[BACK]](/icons/back.gif){kind=icon}
Return to ports.html CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / www