Annotation of www/ports.html, Revision 1.104
1.47 naddy 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
1.11 deraadt 2: <html>
1.25 deraadt 3: <head>
1.88 nick 4: <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
1.25 deraadt 5: <meta name="resource-type" content="document">
1.47 naddy 6: <meta name="description" content="The OpenBSD Ports and Packages Collection">
1.25 deraadt 7: <meta name="keywords" content="openbsd,ports">
8: <meta name="distribution" content="global">
1.97 steven 9: <meta name="copyright" content="copyright 1997-2008 by OpenBSD.">
1.27 brad 10: <title>OpenBSD Ports and Packages</title>
1.47 naddy 11: <link rev="made" href="mailto:www@openbsd.org">
1.43 jufi 12: </head>
1.25 deraadt 13:
14: <body text="#000000" bgcolor="#FFFFFF" link="#23238E">
15:
1.88 nick 16: <a href="index.html"><img alt="[OpenBSD]" height="30" width="141" src="images/smalltitle.gif" border="0"></a>
1.30 espie 17:
1.88 nick 18: <h2><font color="#e00000">The Ports & Packages collection</font></h2>
1.25 deraadt 19:
1.47 naddy 20: <hr>
21:
1.88 nick 22: <h3><font color="#0000e0">Index</font></h3>
1.53 naddy 23: <ul>
1.88 nick 24: <li><a href="#Motivation">Motivation</a></li>
25: <li><a href="#Get">Getting Packages</a></li>
26: <li><a href="#stable">Ports and Packages Update for an OpenBSD Release</a></li>
27: <li><a href="#Manage">Managing Installed Packages</a></li>
28: <li><a href="#Use">Using Ports</a></li>
29: <li><a href="#Life">Life Cycle of the Ports Tree</a></li>
30: <li><a href="#X">Ports and the X Window System</a></li>
31: <li><a href="#Example">Example Use of the Ports Tree</a></li>
32: <li><a href="#Advanced">Advanced Usage of the Ports Tree</a></li>
33: <li><a href="#Create">Creating New Ports</a></li>
34: <li><a href="#Lag">When a Port Is Lagging Behind the Mainstream Version</a></li>
35: <li><a href="#Help">Problems and Contacts</a></li>
1.53 naddy 36: </ul>
37:
38: <hr>
39:
1.88 nick 40: <h3><font color="#0000e0"><a name="Motivation">Motivation</a></font></h3>
1.25 deraadt 41:
1.88 nick 42: OpenBSD is a fairly complete system of its own, but still there is a lot
43: of software that one might want to see added. However, there is the problem
44: of where to draw the line as to what to include, as well as the occasional
45: licensing and export restriction problems. As OpenBSD is supposed to be
46: a small stand-alone UNIX-like operating system, some things just can't be
47: shipped with the system.
1.25 deraadt 48:
49: <p>
1.47 naddy 50: <strong><font color="#e00000">
1.98 ian 51: The ports & packages collection does NOT go through the thorough security audit that the OpenBSD
52: base system does.
1.88 nick 53: Although we strive to keep the quality of the packages collection high, we just do not have enough human
54: resources to ensure the same level of robustness and security.
1.31 espie 55: </font></strong>
1.25 deraadt 56:
57: <p>
1.88 nick 58: The port collection, originally borrowed from
1.98 ian 59: <a href="http://www.freebsd.org/">FreeBSD</a> and significantly rewritten, fills this gap.
1.88 nick 60: The concept is to have, for each third-party software, a Makefile that
61: controls
1.25 deraadt 62: <ul>
1.88 nick 63: <li>where to fetch it,
64: <li>how to do the fetch,
65: <li>what it depends upon (if anything),
66: <li>how to alter the sources (if needed),
67: <li>and how to configure, build and install it.
1.25 deraadt 68: </ul>
1.88 nick 69: This information is kept in a directory hierarchy under the
70: /usr/ports directory.
1.31 espie 71:
72: <p>
1.88 nick 73: Packages are the binary equivalent of ports. A compiled port becomes
1.98 ian 74: a package that can be easily installed and registered into the system using
1.63 rohee 75: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>
1.31 espie 76:
77: <p>
1.47 naddy 78: <strong><font color="#e00000">
1.88 nick 79: Packages look like simple <code>.tgz</code> bundles, but they should
80: always be added using
81: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>,
82: as there might be some extra information that only
83: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>
84: knows how to handle.</font></strong>
85: Tip: you can distinguish between packages and <strong>.tgz</strong> bundles
86: using
87: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_info&sektion=1&format=html">pkg_info(1)</a>.
1.31 espie 88:
1.88 nick 89: <h3><font color="#0000e0"><a name="Get">Getting Packages</a></font></h3>
1.31 espie 90:
1.88 nick 91: A large collection of pre-compiled packages is available for most common
1.98 ian 92: architectures:
1.31 espie 93: <ul>
1.88 nick 94: <li>On the CD-Rom (that you can order <a href="orders.html">here</a>),
95: <li>On the <a href=ftp.html>ftp mirror sites</a>.
1.31 espie 96: </ul>
97:
1.44 espie 98:
1.88 nick 99: Adding a package is as easy as
1.96 landry 100: <code>pkg_add pkgname</code>.
1.88 nick 101: If you are grabbing packages from a single source (a package repository),
102: set PKG_PATH to that repository URL, in order to grab dependencies.
1.31 espie 103:
104: <p>
1.98 ian 105: For instance, to install the Gimp package (and any needed dependencies)
1.101 sthen 106: for the 4.6 release on an i386 machine from the ftp site, do:
1.31 espie 107:
108: <pre>
1.101 sthen 109: # export PKG_PATH=ftp://ftp.openbsd.org/pub/OpenBSD/4.6/packages/i386/
1.96 landry 110: # pkg_add gimp
1.31 espie 111: </pre>
112:
1.88 nick 113: <h3><font color="#0000e0"><a name="stable">Ports and Packages Update for an OpenBSD Release</a></font></h3>
1.45 espie 114: <p>
1.88 nick 115: The 2.7 release saw the introduction of a stable branch for the ports tree.
1.45 espie 116: <p>
1.101 sthen 117: For instance, to grab the stable branch for the 4.6 release:
1.45 espie 118: <pre>
119: $ cd /usr/ports
1.101 sthen 120: $ cvs -q -d anoncvs@some.anon.server:/cvs up -r OPENBSD_4_6 -Pd
1.45 espie 121: </pre>
122: <p>
1.88 nick 123: Starting with the 2.8 release, selected binary packages are also made
124: available.
125: If you want to receive security announcements, you can subscribe
126: to the ports-security mailing list.
1.45 espie 127: </p>
128: <p>
1.88 nick 129: Package names are <strong>always</strong> changed in case of a package
130: update, to avoid any risk of confusion between a package from the release
131: and a bug-fixed package.
1.45 espie 132: </p>
133:
1.88 nick 134: <h3><font color="#0000e0"><a name="Manage">Managing Installed Packages</a></font></h3>
1.31 espie 135:
1.88 nick 136: The <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=packages&sektion=7&format=html">packages(7)</a>
137: manual page holds useful information about ways to manage
138: installed packages, solve conflicts (files that already exist) and handle
139: dependencies.
1.31 espie 140: <p>
1.96 landry 141: Starting with OpenBSD 3.9, an update mechanism is provided by
142: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_add&sektion=1&format=html">pkg_add(1)</a>.
143: To update a package (and its dependencies) you must set PKG_PATH to a
144: repository URL which contains updates, and use
145: <code>pkg_add -ui pkgname</code>.
1.31 espie 146:
1.88 nick 147: <h3><font color="#0000e0"><a name="Use">Using Ports</a></font></h3>
1.31 espie 148:
1.88 nick 149: If a given package does not exist for your architecture, you may still
150: be able to compile the port. Besides, some users will want to compile
151: everything from source for various reasons.
152:
153: <p>
154: You can ftp the release version from the pub/OpenBSD/[version] (where
155: [version] is the release number) directory on any of the
156: <a href=ftp.html>ftp mirror sites</a>.
157: The release versions are the ones we ship on our CDROM, and have gone
158: through more testing than any snapshot.
159: Further information is available in the
160: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ports&sektion=7&format=html">ports(7)</a> man page.
161:
162: <h3><font color="#0000e0"><a name="Life">Life Cycle of the Ports Tree</a></font></h3>
163:
164: <p>
165: The ports tree, like the rest of OpenBSD, is constantly changing.
166: <p>
167: The current ports tree <strong>may not</strong> be used with the previous
168: release. This is due to changes, typically with the port make process,
169: that require code based upon the OpenBSD-current source tree.
170: <p>The ports tree works as a single entity. Updating a single directory is
171: not guaranteed to work, as package dependencies may force you to update
172: and recompile vast portions of the ports tree.
173: It is strongly suggested that people don't track ports-current unless
174: they're prepared to deal with various problems.
175: <a href=mail.html>Mailing lists</a> such as
176: <code>ports-changes@openbsd.org</code> or
177: <code>tech@openbsd.org</code> will probably be invaluable.
178:
179: <p>You are advised to track ports-stable on a production machine:
180: we will try to keep the stable ports tree up-to-par with respect to
181: problems, and to provide timely binary updates as well.
182:
183: <p>Note that vanishing distfiles is not an issue, as
184: ftp.openbsd.org holds the complete repository. Even changing checksums is
185: not an issue: you can issue the command
1.59 espie 186: <pre>
187: make checksum REFETCH=true
188: </pre>
1.88 nick 189: to make sure you are grabbing the correct distfile for your ports tree.
1.59 espie 190:
1.88 nick 191: For definitions of <i>current</i> and <i>stable</i>, see the
192: <a href="faq/faq5.html#Flavors">OpenBSD's flavors</a>.
1.59 espie 193:
194:
1.88 nick 195: <p>A list of <a href="portsplus/index.html">daily changes</a> to ports
196: and ports-current is available.
1.47 naddy 197:
1.27 brad 198: <p>
1.88 nick 199: The ports-current tree can be retrieved via:
1.25 deraadt 200: <ul>
1.88 nick 201: <li><a href=anoncvs.html>Anonymous CVS</a> (see link). The command is
202: essentially <strong>cvs get ports</strong>.
203: <li>Anonymous ftp from
204: <a href="ftp://ftp.openbsd.org/pub/OpenBSD/snapshots/ports.tar.gz">
205: ftp://ftp.openbsd.org/pub/OpenBSD/snapshots/ports.tar.gz</a>.
206: This archive is updated nightly.
207: <li><a href="cvsup.html">CVSup</a>. See the example for using CVSup in
208: <a href="cvsup.html#checkout">checkout mode</a>.
209: <li>Your web browser using the
210: <a href="http://www.openbsd.org/cgi-bin/cvsweb/ports/">CVS
211: web interface</a>.
1.25 deraadt 212: </ul>
213:
1.88 nick 214: <h3><font color="#0000e0"><a name="X">Ports and the X Window System</a></font></h3>
215: There is some special magic in the OpenBSD X configuration files
216: that allows the ports tree to install imake-based applications under
217: /usr/local.
1.35 espie 218:
1.88 nick 219: <h3><a name="Example"></a><font color="#0000e0">Example Use of the Ports Tree</font></h3>
1.54 lebel 220:
221: <p>
1.88 nick 222: Let's say you managed to get a ports tree and you want to compile and
223: install the archiving utility <strong>unzip</strong>. You should be able to
224: do something like this:
1.31 espie 225:
1.11 deraadt 226: <pre>
1.31 espie 227: % cd /usr/ports/archivers/unzip
228: % su
1.96 landry 229: # make install clean
1.31 espie 230: # exit
1.11 deraadt 231: </pre>
1.25 deraadt 232:
1.88 nick 233: Easy, huh ? Especially considering all that happened in the background:
1.31 espie 234: <ul>
1.88 nick 235: <li>Fetch unzip sources from an ftp site,
236: <li>Check the source archive integrity,
237: <li>Extract the unzip source,
238: <li>Apply OpenBSD specific patches,
239: <li>Configure and build the program,
240: <li>Create a binary package under /usr/ports/packages,
241: <li>Install that package.
1.31 espie 242: </ul>
1.25 deraadt 243:
244: <p>
1.88 nick 245: With OpenBSD 3.0, almost all ports automatically build
246: packages when installing.
1.31 espie 247:
248: <p>
1.88 nick 249: As ports get built, the /usr/ports/distfiles directory gets filled with
250: program sources, and /usr/ports/packages gets filled with binary packages.
251: Users with low connectivity may refer to
252: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=mirroring-ports&sektion=7&format=html">mirroring-ports(7)</a> for
253: an efficient way to grab all distfiles at once. In OpenBSD-current, you
254: can use the script /usr/ports/infrastructure/fetch/clean-old to track
255: old distfiles.
256: Note that the OpenBSD CD only includes the ports tree and selected packages.
257: If you wish to have the distfiles, you will have to get them through an
258: independent way.
259:
260: <h3><font color="#0000e0"><a name="Advanced"></a>Advanced Usage of the Ports Tree</font></h3>
261:
262: <p>
263: Ports tree has many features for the advanced user that make it a valuable
264: tool beyond basic installation. Advanced users may wish to tamper with
265: the makefiles (you should read the
1.63 rohee 266: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=make&sektion=1&format=html">make(1)</a>
1.88 nick 267: manual page first) or set various variables from the make command-line or in
268: <tt>/etc/mk.conf</tt>. These variables are described in detail in the
1.63 rohee 269: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=bsd.port.mk&sektion=5&format=html">bsd.port.mk(5)</a>
1.88 nick 270: manual page, and the porting documents below.
1.55 heko 271: </p>
272:
1.88 nick 273: <h3><font color="#0000e0"><a name="Create">Creating New Ports</a></font></h3>
1.25 deraadt 274: <p>
1.88 nick 275: If you are interested in helping to expand the OpenBSD ports tree
276: you should first read <a href="porting.html">porting.html</a>.
277: That page references the
1.66 jufi 278: <a href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/index.html">
279: FreeBSD Porter's Handbook</a>
1.88 nick 280: as well as OpenBSD specific policies and hints.
1.56 heko 281:
1.88 nick 282: <h3><font color="#0000e0"><a name="Lag">When a Port Is Lagging Behind the Mainstream Version</a></font></h3>
1.56 heko 283:
284: <p>
1.88 nick 285: The ports collection is a volunteer project. Sometimes the project simply
286: doesn't have the developer resources to keep everything up-to-date.
287: Developers pretty much pick up what they consider interesting and can
288: test in their environment. Your <a href="goals.html#funding">donations</a>
289: count for what platforms the ports can be tested on.
1.56 heko 290: </p>
291:
292: <p>
1.88 nick 293: Some individual ports may lag behind the mainstream versions because of this.
294: The ports collection may have a version back of a program from January while a new
295: version of the program has been released by its developers in May three months ago.
296: Often this is a conscious decision; the new version may have problems in it on
297: OpenBSD that the maintainer is trying to solve, or that have simply made the
298: application worse than the old version: OpenBSD may have different
299: <a href="goals.html">goals</a> than the mainstream developers in other projects,
300: which sometimes results in features and design or implementation choices
301: that are undesirable from OpenBSD developers' point of view. The update may also be
302: postponed because the new version is not considered a crucial update.
1.56 heko 303: </p>
304:
305: <p>
1.88 nick 306: If you really need a new version of a port, you should ask the <tt>MAINTAINER</tt>
307: of the port to update the port (see <a href="#Help">below</a> on how to find out who
308: the maintainer is); if you can send patches for this, all the better. To create proper
309: patches, you should refer to the <a href="porting.html">documentation on building
310: ports</a>.
1.56 heko 311: </p>
1.25 deraadt 312:
1.88 nick 313: <h3><font color="#0000e0"><a name="Help">Problems and Contacts</a></font></h3>
1.25 deraadt 314:
315: <p>
1.88 nick 316: If you have trouble with an existing port, please send e-mail to the
317: port maintainer. To see who is the maintainer of the port, type, for
318: example:
1.54 lebel 319: <pre>
320: % cd /usr/ports/archivers/unzip
1.74 xsa 321: % make show=MAINTAINER
1.54 lebel 322: </pre>
1.88 nick 323: Alternatively, if there is no maintainer, or you can't reach
324: him/her, send mail to the OpenBSD
325: ports mailing list, <a href="mailto:ports@openbsd.org">ports@openbsd.org</a>.
326: Please don't use the misc@openbsd.org mailing list for questions about ports.
327: Corrections are always welcome, but in any case do please provide:
1.25 deraadt 328: <ul>
1.88 nick 329: <li>The output of <code>uname -a</code>,
330: <li>Your OpenBSD version, including any patches you may have applied,
331: <li>A complete description of the problem.
1.45 espie 332: </ul>
1.88 nick 333: For ports that don't build correctly, a complete build transcript is almost
334: always required. You can use the portslogger script, found in
335: /usr/ports/infrastructure/build, for this. A sample run of portslogger
336: might be:
1.54 lebel 337:
338: <pre>
339: % cd /usr/ports/archivers/unzip
340: % su
341: # mkdir -p ~/portslogs
1.63 rohee 342: # make clean install 2>&1 | /usr/ports/infrastructure/build/portslogger \
1.54 lebel 343: ~/portslogs
344: </pre>
345:
1.88 nick 346: After this, you should have a logfile of the build in your ~/portslogs directory
347: that you can send to the port maintainer. Also, make sure you are not using
348: any special options in your build, for example in /etc/mk.conf.
1.54 lebel 349:
350: <p>
1.88 nick 351: Alternatively, you can
1.45 espie 352: <ul>
1.88 nick 353: <li>Use <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=script&sektion=1&format=html">script(1)</a> to create a complete build transcript. Don't remove the configure information.
354: <li>Attach the output of <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=pkg_info&sektion=1&format=html">pkg_info(1)</a> if it seems even remotely relevant.
355: <li><a href="http://www.openbsd.org/cgi-bin/man.cgi?query=gcc&sektion=1&format=html">gcc(1)</a> internal compiler errors do ask you to report the bug to
356: the gcc mailing-list. It does save time if you follow their direction, and
357: provide at least the various files produced by <tt>gcc -save-temps</tt>.
1.25 deraadt 358: </ul>
359:
360: <hr>
1.88 nick 361: <a href="index.html"><img height=24 width=24 src=back.gif border=0 alt=OpenBSD></a>
1.47 naddy 362: <a href="mailto:www@openbsd.org">www@openbsd.org</a>
1.104 ! nick 363: <br><small>$OpenBSD: ports.html,v 1.103 2010/06/08 01:01:43 nick Exp $</small>
1.25 deraadt 364: </body>
1.11 deraadt 365: </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