diff options
| author | Doc Manager <doceng@FreeBSD.org> | 2006-04-28 10:42:53 +0000 |
|---|---|---|
| committer | Doc Manager <doceng@FreeBSD.org> | 2006-04-28 10:42:53 +0000 |
| commit | 9433aabc2fdd235743b7ee0c9767386865973c67 (patch) | |
| tree | 98f2832fb753bc0d3317ec5f531f06b83f91dc0a | |
| parent | 51a92d3509a3e654aa2d1f999888cfff1af72b0d (diff) | |
| -rw-r--r-- | en/handbook/contrib/chapter.sgml | 5796 | ||||
| -rw-r--r-- | en_US.ISO8859-1/books/porters-handbook/book.sgml | 12465 | ||||
| -rw-r--r-- | ru_RU.KOI8-R/articles/hubs/article.sgml | 158 | ||||
| -rw-r--r-- | share/mk/doc.xml.mk | 2 | ||||
| -rw-r--r-- | share/sgml/man-refs.ent | 3 | ||||
| -rw-r--r-- | zh/FAQ/FAQ.sgml | 70 |
6 files changed, 3517 insertions, 14977 deletions
diff --git a/en/handbook/contrib/chapter.sgml b/en/handbook/contrib/chapter.sgml deleted file mode 100644 index 9a41073467..0000000000 --- a/en/handbook/contrib/chapter.sgml +++ /dev/null @@ -1,5796 +0,0 @@ -<!-- - The FreeBSD Documentation Project - - $Id: chapter.sgml,v 1.92 2000-03-19 06:20:31 vanilla Exp $ ---> - -<chapter id="contrib"> - <title>Contributing to FreeBSD</title> - - <para><emphasis>Contributed by &a.jkh;.</emphasis></para> - - <para>So you want to contribute something to FreeBSD? That is great! We can - always use the help, and FreeBSD is one of those systems that - <emphasis>relies</emphasis> on the contributions of its user base in order - to survive. Your contributions are not only appreciated, they are vital - to FreeBSD's continued growth!</para> - - <para>Contrary to what some people might also have you believe, you do not - need to be a hot-shot programmer or a close personal friend of the FreeBSD - core team in order to have your contributions accepted. The FreeBSD - Project's development is done by a large and growing number of - international contributors whose ages and areas of technical expertise - vary greatly, and there is always more work to be done than there are - people available to do it.</para> - - <para>Since the FreeBSD project is responsible for an entire operating - system environment (and its installation) rather than just a kernel or a - few scattered utilities, our <filename>TODO</filename> list also spans a - very wide range of tasks, from documentation, beta testing and - presentation to highly specialized types of kernel development. No matter - what your skill level, there is almost certainly something you can do to - help the project!</para> - - <para>Commercial entities engaged in FreeBSD-related enterprises are also - encouraged to contact us. Need a special extension to make your product - work? You will find us receptive to your requests, given that they are not - too outlandish. Working on a value-added product? Please let us know! We - may be able to work cooperatively on some aspect of it. The free software - world is challenging a lot of existing assumptions about how software is - developed, sold, and maintained throughout its life cycle, and we urge you - to at least give it a second look.</para> - - <sect1> - <title>What Is Needed</title> - - <para>The following list of tasks and sub-projects represents something of - an amalgam of the various core team <filename>TODO</filename> lists and - user requests we have collected over the last couple of months. Where - possible, tasks have been ranked by degree of urgency. If you are - interested in working on one of the tasks you see here, send mail to the - coordinator listed by clicking on their names. If no coordinator has - been appointed, maybe you would like to volunteer?</para> - - <sect2> - <title>High priority tasks</title> - - <para>The following tasks are considered to be urgent, usually because - they represent something that is badly broken or sorely needed:</para> - - <orderedlist> - <listitem> - <para>3-stage boot issues. Overall coordination: &a.hackers;</para> - - <itemizedlist> - <listitem> - <para>Do WinNT compatible drive tagging so that the 3rd stage - can provide an accurate mapping of BIOS geometries for - disks.</para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para>Filesystem problems. Overall coordination: &a.fs;</para> - - <itemizedlist> - <listitem> - <para>Fix the MSDOS file system.</para> - </listitem> - - <listitem> - <para>Clean up and document the nullfs filesystem code. - Coordinator: &a.eivind;</para> - </listitem> - - <listitem> - <para>Fix the union file system. Coordinator: &a.dg;</para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para>Implement Int13 vm86 disk driver. Coordinator: - &a.hackers;</para> - </listitem> - - <listitem> - <para>New bus architecture. Coordinator: &a.newbus;</para> - - <itemizedlist> - <listitem> - <para>Port existing ISA drivers to new architecture.</para> - </listitem> - - <listitem> - <para>Move all interrupt-management code to appropriate parts of - the bus drivers.</para> - </listitem> - - <listitem> - <para>Port PCI subsystem to new architecture. Coordinator: - &a.dfr;</para> - </listitem> - - <listitem> - <para>Figure out the right way to handle removable devices and - then use that as a substrate on which PC-Card and CardBus - support can be implemented.</para> - </listitem> - - <listitem> - <para>Resolve the probe/attach priority issue once and for - all.</para> - </listitem> - - <listitem> - <para>Move any remaining buses over to the new - architecture.</para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para>Kernel issues. Overall coordination: &a.hackers;</para> - </listitem> - - <listitem> - <para>Add more pro-active security infrastructure. Overall - coordination: &a.security;</para> - - <itemizedlist> - <listitem> - <para>Build something like Tripwire(TM) into the kernel, with a - remote and local part. There are a number of cryptographic - issues to getting this right; contact the coordinator for - details. Coordinator: &a.eivind;</para> - </listitem> - - <listitem> - <para>Make the entire kernel use <literal>suser()</literal> - instead of comparing to 0. It is presently using about half - of each. Coordinator: &a.eivind;</para> - </listitem> - - <listitem> - <para>Split securelevels into different parts, to allow an - administrator to throw away those privileges he can throw - away. Setting the overall securelevel needs to have the same - effect as now, obviously. Coordinator: &a.eivind;</para> - </listitem> - - <listitem> - <para>Make it possible to upload a list of “allowed - program” to BPF, and then block BPF from accepting other - programs. This would allow BPF to be used e.g. for DHCP, - without allowing an attacker to start snooping the local - network.</para> - </listitem> - - <listitem> - <para>Update the security checker script. We should at least - grab all the checks from the other BSD derivatives, and add - checks that a system with securelevel increased also have - reasonable flags on the relevant parts. Coordinator: - &a.eivind;</para> - </listitem> - - <listitem> - <para>Add authorization infrastructure to the kernel, to allow - different authorization policies. Part of this could be done - by modifying <literal>suser()</literal>. Coordinator: - &a.eivind;</para> - </listitem> - - <listitem> - <para>Add code to the NFS layer so that you cannot - <literal>chdir("..")</literal> out of an NFS partition. E.g., - <filename>/usr</filename> is a UFS partition with - <filename>/usr/src</filename> NFS exported. Now it is - possible to use the NFS filehandle for - <filename>/usr/src</filename> to get access to - <filename>/usr</filename>.</para> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> - </sect2> - - <sect2> - <title>Medium priority tasks</title> - - <para>The following tasks need to be done, but not with any particular - urgency:</para> - - <orderedlist> - <listitem> - <para>Full KLD based driver support/Configuration Manager.</para> - - <itemizedlist> - <listitem> - <para>Write a configuration manager (in the 3rd stage boot?) - that probes your hardware in a sane manner, keeps only the - KLDs required for your hardware, etc.</para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para>PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk;</para> - - <itemizedlist> - <listitem> - <para>Documentation!</para> - </listitem> - - <listitem> - <para>Reliable operation of the pcic driver (needs - testing).</para> - </listitem> - - <listitem> - <para>Recognizer and handler for <filename>sio.c</filename> - (mostly done).</para> - </listitem> - - <listitem> - <para>Recognizer and handler for <filename>ed.c</filename> - (mostly done).</para> - </listitem> - - <listitem> - <para>Recognizer and handler for <filename>ep.c</filename> - (mostly done).</para> - </listitem> - - <listitem> - <para>User-mode recognizer and handler (partially done).</para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para>Advanced Power Management. Coordinators: &a.msmith; and - &a.phk;</para> - - <itemizedlist> - <listitem> - <para>APM sub-driver (mostly done).</para> - </listitem> - - <listitem> - <para>IDE/ATA disk sub-driver (partially done).</para> - </listitem> - - <listitem> - <para>syscons/pcvt sub-driver.</para> - </listitem> - - <listitem> - <para>Integration with the PCMCIA/PCCARD drivers - (suspend/resume).</para> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> - </sect2> - - <sect2> - <title>Low priority tasks</title> - - <para>The following tasks are purely cosmetic or represent such an - investment of work that it is not likely that anyone will get them - done anytime soon:</para> - - <para>The first N items are from Terry Lambert - <email>terry@lambert.org</email></para> - - <orderedlist> - <listitem> - <para>NetWare Server (protected mode ODI driver) loader and - subservices to allow the use of ODI card drivers supplied with - network cards. The same thing for NDIS drivers and NetWare SCSI - drivers.</para> - </listitem> - - <listitem> - <para>An "upgrade system" option that works on Linux boxes instead - of just previous rev FreeBSD boxes.</para> - </listitem> - - <listitem> - <para>Symmetric Multiprocessing with kernel preemption (requires - kernel preemption).</para> - </listitem> - - <listitem> - <para>A concerted effort at support for portable computers. This is - somewhat handled by changing PCMCIA bridging rules and power - management event handling. But there are things like detecting - internal vs. external display and picking a different screen - resolution based on that fact, not spinning down the disk if the - machine is in dock, and allowing dock-based cards to disappear - without affecting the machines ability to boot (same issue for - PCMCIA).</para> - </listitem> - </orderedlist> - </sect2> - - <sect2> - <title>Smaller tasks</title> - - <para>Most of the tasks listed in the previous sections require either a - considerable investment of time or an in-depth knowledge of the - FreeBSD kernel (or both). However, there are also many useful tasks - which are suitable for "weekend hackers", or people without - programming skills.</para> - - <orderedlist> - <listitem> - <para>If you run FreeBSD-current and have a good Internet - connection, there is a machine <hostid - role="fqdn">current.FreeBSD.org</hostid> which builds a full - release once a day — every now and again, try and install - the latest release from it and report any failures in the - process.</para> - </listitem> - - <listitem> - <para>Read the freebsd-bugs mailing list. There might be a - problem you can comment constructively on or with patches you - can test. Or you could even try to fix one of the problems - yourself.</para> - </listitem> - - <listitem> - <para>Read through the FAQ and Handbook periodically. If anything - is badly explained, out of date or even just completely wrong, let - us know. Even better, send us a fix (SGML is not difficult to - learn, but there is no objection to ASCII submissions).</para> - </listitem> - - <listitem> - <para>Help translate FreeBSD documentation into your native language - (if not already available) — just send an email to &a.doc; - asking if anyone is working on it. Note that you are not - committing yourself to translating every single FreeBSD document - by doing this — in fact, the documentation most in need of - translation is the installation instructions.</para> - </listitem> - - <listitem> - <para>Read the freebsd-questions mailing list and &ng.misc - occasionally (or even regularly). It can be very satisfying to - share your expertise and help people solve their problems; - sometimes you may even learn something new yourself! These forums - can also be a source of ideas for things to work on.</para> - </listitem> - - <listitem> - <para>If you know of any bugfixes which have been successfully - applied to -current but have not been merged into -stable after a - decent interval (normally a couple of weeks), send the committer a - polite reminder.</para> - </listitem> - - <listitem> - <para>Move contributed software to <filename>src/contrib</filename> - in the source tree.</para> - </listitem> - - <listitem> - <para>Make sure code in <filename>src/contrib</filename> is up to - date.</para> - </listitem> - - <listitem> - <para>Look for year 2000 bugs (and fix any you find!)</para> - </listitem> - - <listitem> - <para>Build the source tree (or just part of it) with extra warnings - enabled and clean up the warnings.</para> - </listitem> - - <listitem> - <para>Fix warnings for ports which do deprecated things like using - gets() or including malloc.h.</para> - </listitem> - - <listitem> - <para>If you have contributed any ports, send your patches back to - the original author (this will make your life easier when they - bring out the next version)</para> - </listitem> - - <listitem> - <para>Suggest further tasks for this list!</para> - </listitem> - </orderedlist> - </sect2> - - <sect2> - <title>Work through the PR database</title> - - <para>The <ulink - url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi">FreeBSD PR - list</ulink> shows all the current active problem reports and - requests for enhancement that have been submitted by FreeBSD users. - Look through the open PRs, and see if anything there takes your - interest. Some of these might be very simple tasks, that just need an - extra pair of eyes to look over them and confirm that the fix in the - PR is a good one. Others might be much more complex.</para> - - <para>Start with the PRs that have not been assigned to anyone else, but - if one them is assigned to someone else, but it looks like something - you can handle, e-mail the person it is assigned to and ask if you can - work on it—they might already have a patch ready to be tested, - or further ideas that you can discuss with them.</para> - </sect2> - </sect1> - - <sect1> - <title>How to Contribute</title> - - <para>Contributions to the system generally fall into one or more of the - following 6 categories:</para> - - <sect2 id="contrib-general"> - <title>Bug reports and general commentary</title> - - <para>An idea or suggestion of <emphasis>general</emphasis> technical - interest should be mailed to the &a.hackers;. Likewise, people with - an interest in such things (and a tolerance for a - <emphasis>high</emphasis> volume of mail!) may subscribe to the - hackers mailing list by sending mail to &a.majordomo;. See <link - linkend="eresources-mail">mailing lists</link> for more information - about this and other mailing lists.</para> - - <para>If you find a bug or are submitting a specific change, please - report it using the &man.send-pr.1; program or its <ulink - URL="http://www.FreeBSD.org/send-pr.html">WEB-based - equivalent</ulink>. Try to fill-in each field of the bug report. - Unless they exceed 65KB, include any patches directly in the report. - When including patches, <emphasis>do not</emphasis> use cut-and-paste - because cut-and-paste turns tabs into spaces and makes them unusable. - Consider compressing patches and using &man.uuencode.1; if they exceed - 20KB. Upload very large submissions to <ulink - url="ftp://ftp.FreeBSD.org/pub/FreeBSD/incoming/">ftp.FreeBSD.org:/pub/FreeBSD/incoming/</ulink>.</para> - - <para>After filing a report, you should receive confirmation along with - a tracking number. Keep this tracking number so that you can update - us with details about the problem by sending mail to - <email>bug-followup@FreeBSD.org</email>. Use the number as the - message subject, e.g. <literal>"Re: kern/3377"</literal>. Additional - information for any bug report should be submitted this way.</para> - - <para>If you do not receive confirmation in a timely fashion (3 days to - a week, depending on your email connection) or are, for some reason, - unable to use the &man.send-pr.1; command, then you may ask - someone to file it for you by sending mail to the &a.bugs;.</para> - </sect2> - - <sect2> - <title>Changes to the documentation</title> - - <para>Changes to the documentation are overseen by the &a.doc;. Send - submissions and changes (even small ones are welcome!) using - <command>send-pr</command> as described in <link - linkend="contrib-general">Bug Reports and General - Commentary</link>.</para> - </sect2> - - <sect2> - <title>Changes to existing source code</title> - - <para>An addition or change to the existing source code is a somewhat - trickier affair and depends a lot on how far out of date you are with - the current state of the core FreeBSD development. There is a special - on-going release of FreeBSD known as “FreeBSD-current” - which is made available in a variety of ways for the convenience of - developers working actively on the system. See <link - linkend="current">Staying current with FreeBSD</link> for more - information about getting and using FreeBSD-current.</para> - - <para>Working from older sources unfortunately means that your changes - may sometimes be too obsolete or too divergent for easy re-integration - into FreeBSD. Chances of this can be minimized somewhat by - subscribing to the &a.announce; and the &a.current; lists, where - discussions on the current state of the system take place.</para> - - <para>Assuming that you can manage to secure fairly up-to-date sources - to base your changes on, the next step is to produce a set of diffs to - send to the FreeBSD maintainers. This is done with the &man.diff.1; - command, with the “context diff” form - being preferred. For example:</para> - - <para> - <screen>&prompt.user; <userinput>diff -c oldfile newfile</userinput></screen> - - or - - <screen>&prompt.user; <userinput>diff -c -r olddir newdir</userinput></screen> - - would generate such a set of context diffs for the given source file - or directory hierarchy. See the man page for &man.diff.1; for more - details.</para> - - <para>Once you have a set of diffs (which you may test with the - &man.patch.1; command), you should submit them for inclusion with - FreeBSD. Use the &man.send-pr.1; program as described in <link - linkend="contrib-general">Bug Reports and General Commentary</link>. - <emphasis>Do not</emphasis> just send the diffs to the &a.hackers; or - they will get lost! We greatly appreciate your submission (this is a - volunteer project!); because we are busy, we may not be able to - address it immediately, but it will remain in the pr database until we - do.</para> - - <para>If you feel it appropriate (e.g. you have added, deleted, or - renamed files), bundle your changes into a <command>tar</command> file - and run the &man.uuencode.1; program on it. Shar archives are also - welcome.</para> - - <para>If your change is of a potentially sensitive nature, e.g. you are - unsure of copyright issues governing its further distribution or you - are simply not ready to release it without a tighter review first, - then you should send it to &a.core; directly rather than submitting it - with &man.send-pr.1;. The core mailing list reaches a much smaller - group of people who do much of the day-to-day work on FreeBSD. Note - that this group is also <emphasis>very busy</emphasis> and so you - should only send mail to them where it is truly necessary.</para> - - <para>Please refer to <command>man 9 intro</command> and <command>man 9 - style</command> for some information on coding style. We would - appreciate it if you were at least aware of this information before - submitting code.</para> - </sect2> - - <sect2> - <title>New code or major value-added packages</title> - - <para>In the rare case of a significant contribution of a large body - work, or the addition of an important new feature to FreeBSD, it - becomes almost always necessary to either send changes as uuencode'd - tar files or upload them to our ftp site <ulink - URL="ftp://ftp.FreeBSD.org/pub/FreeBSD/incoming">ftp://ftp.FreeBSD.org/pub/FreeBSD/incoming</ulink>.</para> - - <para>When working with large amounts of code, the touchy subject of - copyrights also invariably comes up. Acceptable copyrights for code - included in FreeBSD are:</para> - - <orderedlist> - <listitem> - <para>The BSD copyright. This copyright is most preferred due to - its “no strings attached” nature and general - attractiveness to commercial enterprises. Far from discouraging - such commercial use, the FreeBSD Project actively encourages such - participation by commercial interests who might eventually be - inclined to invest something of their own into FreeBSD.</para> - </listitem> - - <listitem> - <para>The GNU Public License, or “GPL”. This license is - not quite as popular with us due to the amount of extra effort - demanded of anyone using the code for commercial purposes, but - given the sheer quantity of GPL'd code we currently require - (compiler, assembler, text formatter, etc) it would be silly to - refuse additional contributions under this license. Code under - the GPL also goes into a different part of the tree, that being - <filename>/sys/gnu</filename> or - <filename>/usr/src/gnu</filename>, and is therefore easily - identifiable to anyone for whom the GPL presents a problem.</para> - </listitem> - </orderedlist> - - <para>Contributions coming under any other type of copyright must be - carefully reviewed before their inclusion into FreeBSD will be - considered. Contributions for which particularly restrictive - commercial copyrights apply are generally rejected, though the authors - are always encouraged to make such changes available through their own - channels.</para> - - <para>To place a “BSD-style” copyright on your work, include - the following text at the very beginning of every source code file you - wish to protect, replacing the text between the <literal>%%</literal> - with the appropriate information.</para> - - <programlisting> -Copyright (c) %%proper_years_here%% - %%your_name_here%%, %%your_state%% %%your_zip%%. - 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 as - the first lines of this file unmodified. -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. - -THIS SOFTWARE IS PROVIDED BY %%your_name_here%% ``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 %%your_name_here%% 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. - - $Id$</programlisting> - - <para>For your convenience, a copy of this text can be found in - <filename>/usr/share/examples/etc/bsd-style-copyright</filename>.</para> - </sect2> - - <sect2> - <title>Money, Hardware or Internet access</title> - - <para>We are always very happy to accept donations to further the cause - of the FreeBSD Project and, in a volunteer effort like ours, a little - can go a long way! Donations of hardware are also very important to - expanding our list of supported peripherals since we generally lack - the funds to buy such items ourselves.</para> - - <sect3> - <title><anchor id="donations">Donating funds</title> - - <para>While the FreeBSD Project is not a 501(c)(3) (charitable) - corporation and hence cannot offer special tax incentives for any - donations made, any such donations will be gratefully accepted on - behalf of the project by FreeBSD, Inc.</para> - - <para>FreeBSD, Inc. was founded in early 1995 by &a.jkh; and &a.dg; - with the goal of furthering the aims of the FreeBSD Project and - giving it a minimal corporate presence. Any and all funds donated - (as well as any profits that may eventually be realized by FreeBSD, - Inc.) will be used exclusively to further the project's - goals.</para> - - <para>Please make any checks payable to FreeBSD, Inc., sent in care of - the following address:</para> - - <address> - <otheraddr>FreeBSD, Inc.</otheraddr> - <otheraddr>c/o Jordan Hubbard</otheraddr> - <street>4041 Pike Lane, Suite F</street> - <city>Concord</city> - <state>CA</state>, <postcode>94520</postcode> - </address> - - <para>(currently using the Walnut Creek CDROM address until a PO box - can be opened)</para> - - <para>Wire transfers may also be sent directly to:</para> - - <address> - <otheraddr>Bank Of America</otheraddr> - <otheraddr>Concord Main Office</otheraddr> - <pob>P.O. Box 37176</pob> - <city>San Francisco</city> - <state>CA</state>, <postcode>94137-5176</postcode> - - <otheraddr>Routing #: 121-000-358</otheraddr> - <otheraddr>Account #: 01411-07441 (FreeBSD, Inc.)</otheraddr> - </address> - - <para>Any correspondence related to donations should be sent to &a.jkh, - either via email or to the FreeBSD, Inc. postal address given above. - </para> - - <para>If you do not wish to be listed in our <link - linkend="donors">donors</link> section, please specify this when - making your donation. Thanks!</para> - </sect3> - - <sect3> - <title>Donating hardware</title> - - <para>Donations of hardware in any of the 3 following categories are - also gladly accepted by the FreeBSD Project:</para> - - <itemizedlist> - <listitem> - <para>General purpose hardware such as disk drives, memory or - complete systems should be sent to the FreeBSD, Inc. address - listed in the <emphasis>donating funds</emphasis> - section.</para> - </listitem> - - <listitem> - <para>Hardware for which ongoing compliance testing is desired. - We are currently trying to put together a testing lab of all - components that FreeBSD supports so that proper regression - testing can be done with each new release. We are still lacking - many important pieces (network cards, motherboards, etc) and if - you would like to make such a donation, please contact &a.dg; - for information on which items are still required.</para> - </listitem> - - <listitem> - <para>Hardware currently unsupported by FreeBSD for which you - would like to see such support added. Please contact the - &a.core; before sending such items as we will need to find a - developer willing to take on the task before we can accept - delivery of new hardware.</para> - </listitem> - </itemizedlist> - </sect3> - - <sect3> - <title>Donating Internet access</title> - - <para>We can always use new mirror sites for FTP, WWW or - <command>cvsup</command>. If you would like to be such a mirror, - please contact the FreeBSD project administrators - <email>admin@FreeBSD.org</email> for more information.</para> - </sect3> - </sect2> - </sect1> - - <sect1 id="donors"> - <title>Donors Gallery</title> - - <para>The FreeBSD Project is indebted to the following donors and would - like to publically thank them here!</para> - - <itemizedlist> - <listitem> - <para><emphasis>Contributors to the central server - project:</emphasis></para> - - <para>The following individuals and businesses made it possible for - the FreeBSD Project to build a new central server machine to - eventually replace <hostid role="fqdn">freefall.FreeBSD.org</hostid> - by donating the following items:</para> - - <itemizedlist> - <listitem> - <para>&a.mbarkah and his employer, <ulink URL="http://www.hemi.com"> - Hemisphere Online</ulink>, donated a <emphasis>Pentium Pro - (P6) 200Mhz CPU</emphasis></para> - </listitem> - - <listitem> - <para><ulink URL="http://www.asacomputers.com">ASA - Computers</ulink> donated a <emphasis>Tyan 1662 - motherboard</emphasis>.</para> - </listitem> - - <listitem> - <para>Joe McGuckin <email>joe@via.net</email> of <ulink - URL="http://www.via.net">ViaNet Communications</ulink> donated - a <emphasis>Kingston ethernet controller.</emphasis></para> - </listitem> - - <listitem> - <para>Jack O'Neill <email>jack@diamond.xtalwind.net</email> - donated an <emphasis>NCR 53C875 SCSI controller - card</emphasis>.</para> - </listitem> - - <listitem> - <para>Ulf Zimmermann <email>ulf@Alameda.net</email> of <ulink - URL="http://www.Alameda.net">Alameda Networks</ulink> donated - <emphasis>128MB of memory</emphasis>, a <emphasis>4 Gb disk - drive and the case.</emphasis></para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><emphasis>Direct funding:</emphasis></para> - - <para>The following individuals and businesses have generously - contributed direct funding to the project:</para> - - <itemizedlist> - <listitem> - <para>Annelise Anderson - <email>ANDRSN@HOOVER.STANFORD.EDU</email></para> - </listitem> - - <listitem> - <para>&a.dillon</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.epilogue.com/">Epilogue Technology - Corporation</ulink></para> - </listitem> - - <listitem> - <para>&a.sef</para> - </listitem> - - <listitem> - <para>Don Scott Wilde</para> - </listitem> - - <listitem> - <para>Gianmarco Giovannelli - <email>gmarco@masternet.it</email></para> - </listitem> - - <listitem> - <para>Josef C. Grosch <email>joeg@truenorth.org</email></para> - </listitem> - - <listitem> - <para>Robert T. Morris</para> - </listitem> - - <listitem> - <para>&a.chuckr</para> - </listitem> - - <listitem> - <para>Kenneth P. Stox <email>ken@stox.sa.enteract.com</email> of - <ulink URL="http://www.imagescape.com">Imaginary Landscape, - LLC.</ulink></para> - </listitem> - - <listitem> - <para>Dmitry S. Kohmanyuk <email>dk@dog.farm.org</email></para> - </listitem> - - <listitem> - <para><ulink URL="http://www.cdrom.co.jp/">Laser5</ulink> of Japan - (a portion of the profits from sales of their various FreeBSD - CD-ROMs.</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.mmjp.or.jp/fuki/">Fuki Shuppan - Publishing Co.</ulink> donated a portion of their profits from - <emphasis>Hajimete no FreeBSD</emphasis> (FreeBSD, Getting - started) to the FreeBSD and XFree86 projects.</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.ascii.co.jp/">ASCII Corp.</ulink> - donated a portion of their profits from several FreeBSD-related - books to the FreeBSD project.</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.yokogawa.co.jp/">Yokogawa Electric - Corp</ulink> has generously donated significant funding to the - FreeBSD project.</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.buffnet.net/">BuffNET</ulink></para> - </listitem> - - <listitem> - <para><ulink url="http://www.pacificsolutions.com/">Pacific - Solutions</ulink></para> - </listitem> - - <listitem> - <para><ulink url="http://www.siemens.de/">Siemens AG</ulink> - via <ulink url="mailto:andre.albsmeier@mchp.siemens.de">Andre - Albsmeier</ulink></para> - </listitem> - - <listitem> - <para><ulink url="mailto:ras@interaccess.com">Chris Silva</ulink> - </para> - </listitem> - - </itemizedlist> - </listitem> - - <listitem> - <para><emphasis>Hardware contributors:</emphasis></para> - - <para>The following individuals and businesses have generously - contributed hardware for testing and device driver - development/support:</para> - - <itemizedlist> - <listitem> - <para>Walnut Creek CDROM for providing the Pentium P5-90 and - 486/DX2-66 EISA/VL systems that are being used for our - development work, to say nothing of the network access and other - donations of hardware resources.</para> - </listitem> - - <listitem> - <para>TRW Financial Systems, Inc. provided 130 PCs, three 68 GB - fileservers, twelve Ethernets, two routers and an ATM switch for - debugging the diskless code.</para> - </listitem> - - <listitem> - <para>Dermot McDonnell donated the Toshiba XM3401B CDROM drive - currently used in freefall.</para> - </listitem> - - <listitem> - <para>&a.chuck; contributed his floppy tape streamer for - experimental work.</para> - </listitem> - - <listitem> - <para>Larry Altneu <email>larry@ALR.COM</email>, and &a.wilko;, - provided Wangtek and Archive QIC-02 tape drives in order to - improve the <devicename>wt</devicename> driver.</para> - </listitem> - - <listitem> - <para>Ernst Winter <email>ewinter@lobo.muc.de</email> contributed - a 2.88 MB floppy drive to the project. This will hopefully - increase the pressure for rewriting the floppy disk driver. - <!-- smiley -->;-)</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.tekram.com">Tekram - Technologies</ulink> sent one each of their DC-390, DC-390U - and DC-390F FAST and ULTRA SCSI host adapter cards for - regression testing of the NCR and AMD drivers with their cards. - They are also to be applauded for making driver sources for free - operating systems available from their FTP server <ulink - URL="ftp://ftp.tekram.com/scsi/FreeBSD">ftp://ftp.tekram.com/scsi/FreeBSD</ulink>.</para> - </listitem> - - <listitem> - <para><email>Larry M. Augustin</email> contributed not only a - Symbios Sym8751S SCSI card, but also a set of data books, - including one about the forthcoming Sym53c895 chip with Ultra-2 - and LVD support, and the latest programming manual with - information on how to safely use the advanced features of the - latest Symbios SCSI chips. Thanks a lot!</para> - </listitem> - - <listitem> - <para>Christoph Kukulies <email>kuku@FreeBSD.org</email> donated - an FX120 12 speed Mitsumi CDROM drive for IDE CDROM driver - development.</para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><emphasis>Special contributors:</emphasis></para> - - <itemizedlist> - <listitem> - <para><ulink URL="http://www.cdrom.com">Walnut Creek CDROM</ulink> - has donated almost more than we can say (see the <link - linkend="history">history</link> document for more details). - In particular, we would like to thank them for the original - hardware used for <hostid - role="fqdn">freefall.FreeBSD.org</hostid>, our primary - development machine, and for <hostid - role="fqdn">thud.FreeBSD.org</hostid>, a testing and build - box. We are also indebted to them for funding various - contributors over the years and providing us with unrestricted - use of their T1 connection to the Internet.</para> - </listitem> - - <listitem> - <para>The <ulink URL="http://www.interface-business.de">interface - business GmbH, Dresden</ulink> has been patiently supporting - &a.joerg; who has often preferred FreeBSD work over paywork, and - used to fall back to their (quite expensive) EUnet Internet - connection whenever his private connection became too slow or - flakey to work with it...</para> - </listitem> - - <listitem> - <para><ulink URL="http://www.bsdi.com">Berkeley Software Design, - Inc.</ulink> has contributed their DOS emulator code to the - remaining BSD world, which is used in the - <emphasis>doscmd</emphasis> command.</para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - </sect1> - - <sect1> - <title>Core Team Alumni</title> - - <para>The following people were members of the FreeBSD core team during - the periods indicated. We thank them for their past efforts in the - service of the FreeBSD project.</para> - - <para><emphasis>In rough chronological order:</emphasis></para> - - <itemizedlist> - <listitem> - <para>&a.guido (1995 - 1999)</para> - </listitem> - - <listitem> - <para>&a.dyson (1993 - 1998)</para> - </listitem> - - <listitem> - <para>&a.nate (1992 - 1996)</para> - </listitem> - - <listitem> - <para>&a.rgrimes (1992 - 1995)</para> - </listitem> - - <listitem> - <para>Andreas Schulz (1992 - 1995)</para> - </listitem> - - <listitem> - <para>&a.csgr (1993 - 1995)</para> - </listitem> - - <listitem> - <para>&a.paul (1992 - 1995)</para> - </listitem> - - <listitem> - <para>&a.smace (1993 - 1994)</para> - </listitem> - - <listitem> - <para>Andrew Moore (1993 - 1994)</para> - </listitem> - - <listitem> - <para>Christoph Robitschko (1993 - 1994)</para> - </listitem> - - <listitem> - <para>J. T. Conklin (1992 - 1993)</para> - </listitem> - </itemizedlist> - </sect1> - - <sect1> - <title>Derived Software Contributors</title> - - <para>This software was originally derived from William F. Jolitz's 386BSD - release 0.1, though almost none of the original 386BSD specific code - remains. This software has been essentially re-implemented from the - 4.4BSD-Lite release provided by the Computer Science Research Group - (CSRG) at the University of California, Berkeley and associated academic - contributors.</para> - - <para>There are also portions of NetBSD and OpenBSD that have been - integrated into FreeBSD as well, and we would therefore like to thank - all the contributors to NetBSD and OpenBSD for their work.</para> - </sect1> - - <sect1 id="contrib-additional"> - <title>Additional FreeBSD Contributors</title> - - <para>(in alphabetical order by first name):</para> - - <itemizedlist> - <listitem> - <para>ABURAYA Ryushirou <email>rewsirow@ff.iij4u.or.jp</email></para> - </listitem> - - <listitem> - <para>AMAGAI Yoshiji <email>amagai@nue.org</email></para> - </listitem> - - <listitem> - <para>Aaron Bornstein <email>aaronb@j51.com</email></para> - </listitem> - - <listitem> - <para>Aaron Smith <email>aaron@mutex.org</email></para> - </listitem> - - <listitem> - <para>Achim Patzner <email>ap@noses.com</email></para> - </listitem> - - <listitem> - <para>Ada T Lim <email>ada@bsd.org</email></para> - </listitem> - - <listitem> - <para>Adam Baran <email>badam@mw.mil.pl</email></para> - </listitem> - - <listitem> - <para>Adam Glass <email>glass@postgres.berkeley.edu</email></para> - </listitem> - - <listitem> - <para>Adam McDougall <email>mcdouga9@egr.msu.edu</email></para> - </listitem> - - <listitem> - <para>Adrian Colley <email>aecolley@ois.ie</email></para> - </listitem> - - <listitem> - <para>Adrian Hall <email>adrian@ibmpcug.co.uk</email></para> - </listitem> - - <listitem> - <para>Adrian Mariano <email>adrian@cam.cornell.edu</email></para> - </listitem> - - <listitem> - <para>Adrian Steinmann <email>ast@marabu.ch</email></para> - </listitem> - - <listitem> - <para>Adam Strohl <email>troll@digitalspark.net</email></para> - </listitem> - - <listitem> - <para>Adrian T. Filipi-Martin - <email>atf3r@agate.cs.virginia.edu</email></para> - </listitem> - - <listitem> - <para>Ajit Thyagarajan <email>unknown</email></para> - </listitem> - - <listitem> - <para>Akio Morita - <email>amorita@meadow.scphys.kyoto-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Akira SAWADA <email>unknown</email></para> - </listitem> - - <listitem> - <para>Akira Watanabe - <email>akira@myaw.ei.meisei-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Akito Fujita <email>fujita@zoo.ncl.omron.co.jp</email></para> - </listitem> - - <listitem> - <para>Alain Kalker - <email>A.C.P.M.Kalker@student.utwente.nl</email></para> - </listitem> - - <listitem> - <para>Alan Bawden <email>alan@curry.epilogue.com</email></para> - </listitem> - - <listitem> - <para>Alec Wolman <email>wolman@cs.washington.edu</email></para> - </listitem> - - <listitem> - <para>Aled Morris <email>aledm@routers.co.uk</email></para> - </listitem> - - <listitem> - <para>Alex <email>garbanzo@hooked.net</email></para> - </listitem> - - <listitem> - <para>Alex D. Chen - <email>dhchen@Canvas.dorm7.nccu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Alex G. Bulushev <email>bag@demos.su</email></para> - </listitem> - - <listitem> - <para>Alex Le Heux <email>alexlh@funk.org</email></para> - </listitem> - - <listitem> - <para>Alex Perel <email>veers@disturbed.net</email></para> - </listitem> - - <listitem> - <para>Alexander B. Povolotsky <email>tarkhil@mgt.msk.ru</email></para> - </listitem> - - <listitem> - <para>Alexander Leidinger - <email>netchild@wurzelausix.CS.Uni-SB.DE</email></para> - </listitem> - - <listitem> - <para>Alexander Langer <email>alex@cichlids.com</email></para> - </listitem> - - <listitem> - <para>Alexandre Snarskii <email>snar@paranoia.ru</email></para> - </listitem> - - <listitem> - <para>Alistair G. Crooks <email>agc@uts.amdahl.com</email></para> - </listitem> - - <listitem> - <para>Allan Saddi <email>asaddi@philosophysw.com</email></para> - </listitem> - - <listitem> - <para>Allen Campbell <email>allenc@verinet.com</email></para> - </listitem> - - <listitem> - <para>Amakawa Shuhei <email>amakawa@hoh.t.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>Amancio Hasty <email>hasty@star-gate.com</email></para> - </listitem> - - <listitem> - <para>Amir Farah <email>amir@comtrol.com</email></para> - </listitem> - - <listitem> - <para>Amy Baron <email>amee@beer.org</email></para> - </listitem> - - <listitem> - <para>Anatoly A. Orehovsky <email>tolik@mpeks.tomsk.su</email></para> - </listitem> - - <listitem> - <para>Anatoly Vorobey <email>mellon@pobox.com</email></para> - </listitem> - - <listitem> - <para>Anders Nordby <email>nickerne@nome.no</email></para> - </listitem> - - <listitem> - <para>Anders Thulin <email>Anders.X.Thulin@telia.se</email></para> - </listitem> - - <listitem> - <para>Andras Olah <email>olah@cs.utwente.nl</email></para> - </listitem> - - <listitem> - <para>Andre Albsmeier - <email>Andre.Albsmeier@mchp.siemens.de</email></para> - </listitem> - - <listitem> - <para>Andre Oppermann <email>andre@pipeline.ch</email></para> - </listitem> - - <listitem> - <para>Andreas Haakh <email>ah@alman.robin.de</email></para> - </listitem> - - <listitem> - <para>Andreas Kohout <email>shanee@rabbit.augusta.de</email></para> - </listitem> - - <listitem> - <para>Andreas Lohr <email>andreas@marvin.RoBIN.de</email></para> - </listitem> - - <listitem> - <para>Andreas Schulz <email>unknown</email></para> - </listitem> - - <listitem> - <para>Andreas Wetzel <email>mickey@deadline.snafu.de</email></para> - </listitem> - - <listitem> - <para>Andreas Wrede <email>andreas@planix.com</email></para> - </listitem> - - <listitem> - <para>Andres Vega Garcia <email>unknown</email></para> - </listitem> - - <listitem> - <para>Andrew Atrens <email>atreand@statcan.ca</email></para> - </listitem> - - <listitem> - <para>Andrew Boothman <email>andrew@cream.org</email></para> - </listitem> - - <listitem> - <para>Andrew Gillham <email>gillham@andrews.edu</email></para> - </listitem> - - <listitem> - <para>Andrew Gordon <email>andrew.gordon@net-tel.co.uk</email></para> - </listitem> - - <listitem> - <para>Andrew Herbert <email>andrew@werple.apana.org.au</email></para> - </listitem> - - <listitem> - <para>Andrew J. Korty <email>ajk@purdue.edu</email></para> - </listitem> - - <listitem> - <para>Andrew L. Moore <email>alm@mclink.com</email></para> - </listitem> - - <listitem> - <para>Andrew McRae <email>amcrae@cisco.com</email></para> - </listitem> - - <listitem> - <para>Andrew Stevenson <email>andrew@ugh.net.au</email></para> - </listitem> - - <listitem> - <para>Andrew Timonin <email>tim@pool1.convey.ru</email></para> - </listitem> - - <listitem> - <para>Andrew V. Stesin <email>stesin@elvisti.kiev.ua</email></para> - </listitem> - - <listitem> - <para>Andrew Webster <email>awebster@dataradio.com</email></para> - </listitem> - - <listitem> - <para>Andrey Zakhvatov <email>andy@icc.surw.chel.su</email></para> - </listitem> - - <listitem> - <para>Andy Farkas <email>andyf@speednet.com.au</email></para> - </listitem> - - <listitem> - <para>Andy Valencia <email>ajv@csd.mot.com</email></para> - </listitem> - - <listitem> - <para>Andy Whitcroft <email>andy@sarc.city.ac.uk</email></para> - </listitem> - - <listitem> - <para>Angelo Turetta <email>ATuretta@stylo.it</email></para> - </listitem> - - <listitem> - <para>Anthony C. Chavez <email>magus@xmission.com</email></para> - </listitem> - - <listitem> - <para>Anthony Yee-Hang Chan <email>yeehang@netcom.com</email></para> - </listitem> - - <listitem> - <para>Anton Berezin <email>tobez@plab.ku.dk</email></para> - </listitem> - - <listitem> - <para>Antti Kaipila <email>anttik@iki.fi</email></para> - </listitem> - - <listitem> - <para>Are Bryne <email>are.bryne@communique.no</email></para> - </listitem> - - <listitem> - <para>Ari Suutari <email>ari@suutari.iki.fi</email></para> - </listitem> - - <listitem> - <para>Arjan de Vet <email>devet@IAEhv.nl</email></para> - </listitem> - - <listitem> - <para>Arne Henrik Juul <email>arnej@Lise.Unit.NO</email></para> - </listitem> - - <listitem> - <para>Assar Westerlund <email>assar@sics.se</email></para> - </listitem> - - <listitem> - <para>Atsushi Furuta <email>furuta@sra.co.jp</email></para> - </listitem> - - <listitem> - <para>Atsushi Murai <email>amurai@spec.co.jp</email></para> - </listitem> - - <listitem> - <para>Bakul Shah <email>bvs@bitblocks.com</email></para> - </listitem> - - <listitem> - <para>Barry Bierbauch <email>pivrnec@vszbr.cz</email></para> - </listitem> - - <listitem> - <para>Barry Lustig <email>barry@ictv.com</email></para> - </listitem> - - <listitem> - <para>Ben Hutchinson <email>benhutch@xfiles.org.uk</email></para> - </listitem> - - <listitem> - <para>Ben Jackson <email>unknown</email></para> - </listitem> - - <listitem> - <para>Ben Smithurst <email>ben@scientia.demon.co.uk</email></para> - </listitem> - - <listitem> - <para>Ben Walter <email>bwalter@itachi.swcp.com</email></para> - </listitem> - - <listitem> - <para>Benjamin Lewis <email>bhlewis@gte.net</email></para> - </listitem> - - <listitem> - <para>Bernd Rosauer <email>br@schiele-ct.de</email></para> - </listitem> - - <listitem> - <para>Bill Kish <email>kish@osf.org</email></para> - </listitem> - - <listitem> - <para>Bill Trost <email>trost@cloud.rain.com</email></para> - </listitem> - - <listitem> - <para>Blaz Zupan <email>blaz@amis.net</email></para> - </listitem> - - <listitem> - <para>Bob Van Valzah <email>Bob@whitebarn.com</email></para> - </listitem> - - <listitem> - <para>Bob Willcox <email>bob@luke.pmr.com</email></para> - </listitem> - - <listitem> - <para>Boris Staeblow <email>balu@dva.in-berlin.de</email></para> - </listitem> - - <listitem> - <para>Boyd R. Faulkner <email>faulkner@asgard.bga.com</email></para> - </listitem> - - <listitem> - <para>Brad Karp <email>karp@eecs.harvard.edu</email></para> - </listitem> - - <listitem> - <para>Bradley Dunn <email>bradley@dunn.org</email></para> - </listitem> - - <listitem> - <para>Brandon Fosdick <email>bfoz@glue.umd.edu</email></para> - </listitem> - - <listitem> - <para>Brandon Gillespie <email>brandon@roguetrader.com</email></para> - </listitem> - - <listitem> - <para>&a.wlloyd</para> - </listitem> - - <listitem> - <para>Bob Wilcox <email>bob@obiwan.uucp</email></para> - </listitem> - - <listitem> - <para>Boyd Faulkner <email>faulkner@mpd.tandem.com</email></para> - </listitem> - - <listitem> - <para>Brent J. Nordquist <email>bjn@visi.com</email></para> - </listitem> - - <listitem> - <para>Brett Lymn <email>blymn@mulga.awadi.com.AU</email></para> - </listitem> - - <listitem> - <para>Brett Taylor - <email>brett@peloton.physics.montana.edu</email></para> - </listitem> - - <listitem> - <para>Brian Campbell <email>brianc@pobox.com</email></para> - </listitem> - - <listitem> - <para>Brian Clapper <email>bmc@willscreek.com</email></para> - </listitem> - - <listitem> - <para>Brian Cully <email>shmit@kublai.com</email></para> - </listitem> - - <listitem> - <para>Brian Handy - <email>handy@lambic.space.lockheed.com</email></para> - </listitem> - - <listitem> - <para>Brian Litzinger <email>brian@MediaCity.com</email></para> - </listitem> - - <listitem> - <para>Brian McGovern <email>bmcgover@cisco.com</email></para> - </listitem> - - <listitem> - <para>Brian Moore <email>ziff@houdini.eecs.umich.edu</email></para> - </listitem> - - <listitem> - <para>Brian R. Haug <email>haug@conterra.com</email></para> - </listitem> - - <listitem> - <para>Brian Tao <email>taob@risc.org</email></para> - </listitem> - - <listitem> - <para>Brion Moss <email>brion@queeg.com</email></para> - </listitem> - - <listitem> - <para>Bruce A. Mah <email>bmah@ca.sandia.gov</email></para> - </listitem> - - <listitem> - <para>Bruce Albrecht <email>bruce@zuhause.mn.org</email></para> - </listitem> - - <listitem> - <para>Bruce Gingery <email>bgingery@gtcs.com</email></para> - </listitem> - - <listitem> - <para>Bruce J. Keeler <email>loodvrij@gridpoint.com</email></para> - </listitem> - - <listitem> - <para>Bruce Murphy <email>packrat@iinet.net.au</email></para> - </listitem> - - <listitem> - <para>Bruce Walter <email>walter@fortean.com</email></para> - </listitem> - - <listitem> - <para>Carey Jones <email>mcj@acquiesce.org</email></para> - </listitem> - - <listitem> - <para>Carl Fongheiser <email>cmf@netins.net</email></para> - </listitem> - - <listitem> - <para>Carl Mascott <email>cmascott@world.std.com</email></para> - </listitem> - - <listitem> - <para>Casper <email>casper@acc.am</email></para> - </listitem> - - <listitem> - <para>Castor Fu <email>castor@geocast.com</email></para> - </listitem> - - <listitem> - <para>Cejka Rudolf <email>cejkar@dcse.fee.vutbr.cz</email></para> - </listitem> - - <listitem> - <para>Chain Lee <email>chain@110.net</email></para> - </listitem> - - <listitem> - <para>Charles Hannum <email>mycroft@ai.mit.edu</email></para> - </listitem> - - <listitem> - <para>Charles Henrich <email>henrich@msu.edu</email></para> - </listitem> - - <listitem> - <para>Charles Mott <email>cmott@srv.net</email></para> - </listitem> - - <listitem> - <para>Charles Owens <email>owensc@enc.edu</email></para> - </listitem> - - <listitem> - <para>Chet Ramey <email>chet@odin.INS.CWRU.Edu</email></para> - </listitem> - - <listitem> - <para>Chia-liang Kao <email>clkao@CirX.ORG</email></para> - </listitem> - - <listitem> - <para>Chiharu Shibata <email>chi@bd.mbn.or.jp</email></para> - </listitem> - - <listitem> - <para>Chip Norkus <email>unknown</email></para> - </listitem> - - <listitem> - <para>Choi Jun Ho <email>junker@jazz.snu.ac.kr</email></para> - </listitem> - - <listitem> - <para>Chris Csanady <email>cc@tarsier.ca.sandia.gov</email></para> - </listitem> - - <listitem> - <para>Chris Dabrowski <email>chris@vader.org</email></para> - </listitem> - - <listitem> - <para>Chris Dillon <email>cdillon@wolves.k12.mo.us</email></para> - </listitem> - - <listitem> - <para>Chris Shenton - <email>cshenton@angst.it.hq.nasa.gov</email></para> - </listitem> - - <listitem> - <para>Chris Stenton <email>jacs@gnome.co.uk</email></para> - </listitem> - - <listitem> - <para>Chris Timmons <email>skynyrd@opus.cts.cwu.edu</email></para> - </listitem> - - <listitem> - <para>Chris Torek <email>torek@ee.lbl.gov</email></para> - </listitem> - - <listitem> - <para>Christian Gusenbauer - <email>cg@fimp01.fim.uni-linz.ac.at</email></para> - </listitem> - - <listitem> - <para>Christian Haury <email>Christian.Haury@sagem.fr</email></para> - </listitem> - - <listitem> - <para>Christian Weisgerber - <email>naddy@bigeye.rhein-neckar.de</email></para> - </listitem> - - <listitem> - <para>Christoph P. Kukulies <email>kuku@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Christoph Robitschko - <email>chmr@edvz.tu-graz.ac.at</email></para> - </listitem> - - <listitem> - <para>Christoph Weber-Fahr - <email>wefa@callcenter.systemhaus.net</email></para> - </listitem> - - <listitem> - <para>Christopher G. Demetriou - <email>cgd@postgres.berkeley.edu</email></para> - </listitem> - - <listitem> - <para>Christopher T. Johnson - <email>cjohnson@neunacht.netgsi.com</email></para> - </listitem> - - <listitem> - <para>Chrisy Luke <email>chrisy@flix.net</email></para> - </listitem> - - <listitem> - <para>Chuck Hein <email>chein@cisco.com</email></para> - </listitem> - - <listitem> - <para>Clive Lin <email>clive@CiRX.ORG</email></para> - </listitem> - - <listitem> - <para>Colman Reilly <email>careilly@tcd.ie</email></para> - </listitem> - - <listitem> - <para>Conrad Sabatier <email>conrads@neosoft.com</email></para> - </listitem> - - <listitem> - <para>Coranth Gryphon <email>gryphon@healer.com</email></para> - </listitem> - - <listitem> - <para>Cornelis van der Laan - <email>nils@guru.ims.uni-stuttgart.de</email></para> - </listitem> - - <listitem> - <para>Cove Schneider <email>cove@brazil.nbn.com</email></para> - </listitem> - - <listitem> - <para>Craig Leres <email>leres@ee.lbl.gov</email></para> - </listitem> - - <listitem> - <para>Craig Loomis <email>unknown</email></para> - </listitem> - - <listitem> - <para>Craig Metz <email>cmetz@inner.net</email></para> - </listitem> - - <listitem> - <para>Craig Spannring <email>cts@internetcds.com</email></para> - </listitem> - - <listitem> - <para>Craig Struble <email>cstruble@vt.edu</email></para> - </listitem> - - <listitem> - <para>Cristian Ferretti <email>cfs@riemann.mat.puc.cl</email></para> - </listitem> - - <listitem> - <para>Curt Mayer <email>curt@toad.com</email></para> - </listitem> - - <listitem> - <para>Cy Schubert <email>cschuber@uumail.gov.bc.ca</email></para> - </listitem> - - <listitem> - <para>DI. Christian Gusenbauer - <email>cg@scotty.edvz.uni-linz.ac.at</email></para> - </listitem> - - <listitem> - <para>Dai Ishijima <email>ishijima@tri.pref.osaka.jp</email></para> - </listitem> - - <listitem> - <para>Damian Hamill <email>damian@cablenet.net</email></para> - </listitem> - - <listitem> - <para>Dan Cross <email>tenser@spitfire.ecsel.psu.edu</email></para> - </listitem> - - <listitem> - <para>Dan Lukes <email>dan@obluda.cz</email></para> - </listitem> - - <listitem> - <para>Dan Nelson <email>dnelson@emsphone.com</email></para> - </listitem> - - <listitem> - <para>Dan Walters <email>hannibal@cyberstation.net</email></para> - </listitem> - - <listitem> - <para>Daniel M. Eischen - <email>deischen@iworks.InterWorks.org</email></para> - </listitem> - - <listitem> - <para>Daniel O'Connor <email>doconnor@gsoft.com.au</email></para> - </listitem> - - <listitem> - <para>Daniel Poirot <email>poirot@aio.jsc.nasa.gov</email></para> - </listitem> - - <listitem> - <para>Daniel Rock <email>rock@cs.uni-sb.de</email></para> - </listitem> - - <listitem> - <para>Danny Egen <email>unknown</email></para> - </listitem> - - <listitem> - <para>Danny J. Zerkel <email>dzerkel@phofarm.com</email></para> - </listitem> - - <listitem> - <para>Darren Reed <email>avalon@coombs.anu.edu.au</email></para> - </listitem> - - <listitem> - <para>Dave Adkins <email>adkin003@tc.umn.edu</email></para> - </listitem> - - <listitem> - <para>Dave Andersen <email>angio@aros.net</email></para> - </listitem> - - <listitem> - <para>Dave Blizzard <email>dblizzar@sprynet.com</email></para> - </listitem> - - <listitem> - <para>Dave Bodenstab <email>imdave@synet.net</email></para> - </listitem> - - <listitem> - <para>Dave Burgess <email>burgess@hrd769.brooks.af.mil</email></para> - </listitem> - - <listitem> - <para>Dave Chapeskie <email>dchapes@ddm.on.ca</email></para> - </listitem> - - <listitem> - <para>Dave Cornejo <email>dave@dogwood.com</email></para> - </listitem> - - <listitem> - <para>Dave Edmondson <email>davided@sco.com</email></para> - </listitem> - - <listitem> - <para>Dave Glowacki <email>dglo@ssec.wisc.edu</email></para> - </listitem> - - <listitem> - <para>Dave Marquardt <email>marquard@austin.ibm.com</email></para> - </listitem> - - <listitem> - <para>Dave Tweten <email>tweten@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>David A. Adkins <email>adkin003@tc.umn.edu</email></para> - </listitem> - - <listitem> - <para>David A. Bader <email>dbader@umiacs.umd.edu</email></para> - </listitem> - - <listitem> - <para>David Borman <email>dab@bsdi.com</email></para> - </listitem> - - <listitem> - <para>David Dawes <email>dawes@XFree86.org</email></para> - </listitem> - - <listitem> - <para>David Filo <email>filo@yahoo.com</email></para> - </listitem> - - <listitem> - <para>David Holland <email>dholland@eecs.harvard.edu</email></para> - </listitem> - - <listitem> - <para>David Holloway <email>daveh@gwythaint.tamis.com</email></para> - </listitem> - - <listitem> - <para>David Horwitt <email>dhorwitt@ucsd.edu</email></para> - </listitem> - - <listitem> - <para>David Hovemeyer <email>daveho@infocom.com</email></para> - </listitem> - - <listitem> - <para>David Jones <email>dej@qpoint.torfree.net</email></para> - </listitem> - - <listitem> - <para>David Kelly <email>dkelly@tomcat1.tbe.com</email></para> - </listitem> - - <listitem> - <para>David Kulp <email>dkulp@neomorphic.com</email></para> - </listitem> - - <listitem> - <para>David L. Nugent <email>davidn@blaze.net.au</email></para> - </listitem> - - <listitem> - <para>David Leonard <email>d@scry.dstc.edu.au</email></para> - </listitem> - - <listitem> - <para>David Malone <email>dwmalone@maths.tcd.ie</email></para> - </listitem> - - <listitem> - <para>David Muir Sharnoff <email>muir@idiom.com</email></para> - </listitem> - - <listitem> - <para>David S. Miller <email>davem@jenolan.rutgers.edu</email></para> - </listitem> - - <listitem> - <para>David Wolfskill <email>dhw@whistle.com</email></para> - </listitem> - - <listitem> - <para>Dean Gaudet <email>dgaudet@arctic.org</email></para> - </listitem> - - <listitem> - <para>Dean Huxley <email>dean@fsa.ca</email></para> - </listitem> - - <listitem> - <para>Denis Fortin <email>unknown</email></para> - </listitem> - - <listitem> - <para>Dennis Glatting - <email>dennis.glatting@software-munitions.com</email></para> - </listitem> - - <listitem> - <para>Denton Gentry <email>denny1@home.com</email></para> - </listitem> - - <listitem> - <para>Derek Inksetter <email>derek@saidev.com</email></para> - </listitem> - - <listitem> - <para>Dima Sivachenko <email>dima@Chg.RU</email></para> - </listitem> - - <listitem> - <para>Dirk Keunecke <email>dk@panda.rhein-main.de</email></para> - </listitem> - - <listitem> - <para>Dirk Nehrling <email>nerle@pdv.de</email></para> - </listitem> - - <listitem> - <para>Dmitry Khrustalev <email>dima@xyzzy.machaon.ru</email></para> - </listitem> - - <listitem> - <para>Dmitry Kohmanyuk <email>dk@farm.org</email></para> - </listitem> - - <listitem> - <para>Dom Mitchell <email>dom@myrddin.demon.co.uk</email></para> - </listitem> - - <listitem> - <para>Dominik Brettnacher <email>domi@saargate.de</email></para> - </listitem> - - <listitem> - <para>Don Croyle <email>croyle@gelemna.ft-wayne.in.us</email></para> - </listitem> - - <listitem> - <para>&a.whiteside;</para> - </listitem> - - <listitem> - <para>Don Morrison <email>dmorrisn@u.washington.edu</email></para> - </listitem> - - <listitem> - <para>Don Yuniskis <email>dgy@rtd.com</email></para> - </listitem> - - <listitem> - <para>Donald Maddox <email>dmaddox@conterra.com</email></para> - </listitem> - - <listitem> - <para>Doug Barton <email>studded@dal.net</email></para> - </listitem> - - <listitem> - <para>Douglas Ambrisko <email>ambrisko@whistle.com</email></para> - </listitem> - - <listitem> - <para>Douglas Carmichael <email>dcarmich@mcs.com</email></para> - </listitem> - - <listitem> - <para>Douglas Crosher <email>dtc@scrooge.ee.swin.oz.au</email></para> - </listitem> - - <listitem> - <para>Drew Derbyshire <email>ahd@kew.com</email></para> - </listitem> - - <listitem> - <para>Duncan Barclay <email>dmlb@ragnet.demon.co.uk</email></para> - </listitem> - - <listitem> - <para>Dustin Sallings <email>dustin@spy.net</email></para> - </listitem> - - <listitem> - <para>Eckart "Isegrim" Hofmann - <email>Isegrim@Wunder-Nett.org</email></para> - </listitem> - - <listitem> - <para>Ed Gold - <email>vegold01@starbase.spd.louisville.edu</email></para> - </listitem> - - <listitem> - <para>Ed Hudson <email>elh@p5.spnet.com</email></para> - </listitem> - - <listitem> - <para>Edward Wang <email>edward@edcom.com</email></para> - </listitem> - - <listitem> - <para>Edwin Groothus <email>edwin@nwm.wan.philips.com</email></para> - </listitem> - - <listitem> - <para>Eiji-usagi-MATSUmoto <email>usagi@clave.gr.jp</email></para> - </listitem> - - <listitem> - <para>ELISA Font Project</para> - </listitem> - - <listitem> - <para>Elmar Bartel - <email>bartel@informatik.tu-muenchen.de</email></para> - </listitem> - - <listitem> - <para>Eric A. Griff <email>eagriff@global2000.net</email></para> - </listitem> - - <listitem> - <para>Eric Blood <email>eblood@cs.unr.edu</email></para> - </listitem> - - <listitem> - <para>Eric J. Haug <email>ejh@slustl.slu.edu</email></para> - </listitem> - - <listitem> - <para>Eric J. Schwertfeger <email>eric@cybernut.com</email></para> - </listitem> - - <listitem> - <para>Eric L. Hernes <email>erich@lodgenet.com</email></para> - </listitem> - - <listitem> - <para>Eric P. Scott <email>eps@sirius.com</email></para> - </listitem> - - <listitem> - <para>Eric Sprinkle <email>eric@ennovatenetworks.com</email></para> - </listitem> - - <listitem> - <para>Erich Stefan Boleyn <email>erich@uruk.org</email></para> - </listitem> - - <listitem> - <para>Erik E. Rantapaa <email>rantapaa@math.umn.edu</email></para> - </listitem> - - <listitem> - <para>Erik H. Moe <email>ehm@cris.com</email></para> - </listitem> - - <listitem> - <para>Ernst Winter <email>ewinter@lobo.muc.de</email></para> - </listitem> - - <listitem> - <para>Espen Skoglund <email>espensk@stud.cs.uit.no></email></para> - </listitem> - - <listitem> - <para>Eugene M. Kim <email>astralblue@usa.net</email></para> - </listitem> - - <listitem> - <para>Eugene Radchenko <email>genie@qsar.chem.msu.su</email></para> - </listitem> - - <listitem> - <para>Evan Champion <email>evanc@synapse.net</email></para> - </listitem> - - <listitem> - <para>Faried Nawaz <email>fn@Hungry.COM</email></para> - </listitem> - - <listitem> - <para>Flemming Jacobsen <email>fj@tfs.com</email></para> - </listitem> - - <listitem> - <para>Fong-Ching Liaw <email>fong@juniper.net</email></para> - </listitem> - - <listitem> - <para>Francis M J Hsieh <email>mjshieh@life.nthu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Frank Bartels <email>knarf@camelot.de</email></para> - </listitem> - - <listitem> - <para>Frank Chen Hsiung Chan - <email>frankch@waru.life.nthu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Frank Durda IV <email>uhclem@nemesis.lonestar.org</email></para> - </listitem> - - <listitem> - <para>Frank MacLachlan <email>fpm@n2.net</email></para> - </listitem> - - <listitem> - <para>Frank Mayhar <email>frank@exit.com</email></para> - </listitem> - - <listitem> - <para>Frank Nobis <email>fn@Radio-do.de</email></para> - </listitem> - - <listitem> - <para>Frank Volf <email>volf@oasis.IAEhv.nl</email></para> - </listitem> - - <listitem> - <para>Frank ten Wolde <email>franky@pinewood.nl</email></para> - </listitem> - - <listitem> - <para>Frank van der Linden <email>frank@fwi.uva.nl</email></para> - </listitem> - - <listitem> - <para>Fred Cawthorne <email>fcawth@jjarray.umn.edu</email></para> - </listitem> - - <listitem> - <para>Fred Gilham <email>gilham@csl.sri.com</email></para> - </listitem> - - <listitem> - <para>Fred Templin <email>templin@erg.sri.com</email></para> - </listitem> - - <listitem> - <para>Frederick Earl Gray <email>fgray@rice.edu</email></para> - </listitem> - - <listitem> - <para>FUJIMOTO Kensaku - <email>fujimoto@oscar.elec.waseda.ac.jp</email></para> - </listitem> - - <listitem> - <para>FUJISHIMA Satsuki <email>k5@respo.or.jp</email></para> - </listitem> - - <listitem> - <para>FURUSAWA Kazuhisa - <email>furusawa@com.cs.osakafu-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Gabor Kincses <email>gabor@acm.org</email></para> - </listitem> - - <listitem> - <para>Gabor Zahemszky <email>zgabor@CoDe.hu</email></para> - </listitem> - - <listitem> - <para>G. Adam Stanislav<email>adam@whizkidtech.net</email></para> - </listitem> - - <listitem> - <para>Garance A Drosehn <email>gad@eclipse.its.rpi.edu</email></para> - </listitem> - - <listitem> - <para>Gareth McCaughan <email>gjm11@dpmms.cam.ac.uk</email></para> - </listitem> - - <listitem> - <para>Gary A. Browning <email>gab10@griffcd.amdahl.com</email></para> - </listitem> - - <listitem> - <para>Gary Howland <email>gary@hotlava.com</email></para> - </listitem> - - <listitem> - <para>Gary J. <email>garyj@rks32.pcs.dec.com</email></para> - </listitem> - - <listitem> - <para>Gary Kline <email>kline@thought.org</email></para> - </listitem> - - <listitem> - <para>Gaspar Chilingarov <email>nightmar@lemming.acc.am</email></para> - </listitem> - - <listitem> - <para>Gea-Suan Lin <email>gsl@tpts4.seed.net.tw</email></para> - </listitem> - - <listitem> - <para>Geoff Rehmet <email>csgr@alpha.ru.ac.za</email></para> - </listitem> - - <listitem> - <para>Georg Wagner <email>georg.wagner@ubs.com</email></para> - </listitem> - - <listitem> - <para>Gerard Roudier <email>groudier@club-internet.fr</email></para> - </listitem> - - <listitem> - <para>Gianmarco Giovannelli - <email>gmarco@giovannelli.it</email></para> - </listitem> - - <listitem> - <para>Gil Kloepfer Jr. <email>gil@limbic.ssdl.com</email></para> - </listitem> - - <listitem> - <para>Gilad Rom <email>rom_glsa@ein-hashofet.co.il</email></para> - </listitem> - - <listitem> - <para>Ginga Kawaguti - <email>ginga@amalthea.phys.s.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>Giles Lean <email>giles@nemeton.com.au</email></para> - </listitem> - - <listitem> - <para>Glen Foster <email>gfoster@gfoster.com</email></para> - </listitem> - - <listitem> - <para>Glenn Johnson <email>gljohns@bellsouth.net</email></para> - </listitem> - - <listitem> - <para>Godmar Back <email>gback@facility.cs.utah.edu</email></para> - </listitem> - - <listitem> - <para>Goran Hammarback <email>goran@astro.uu.se</email></para> - </listitem> - - <listitem> - <para>Gord Matzigkeit <email>gord@enci.ucalgary.ca</email></para> - </listitem> - - <listitem> - <para>Gordon Greeff <email>gvg@uunet.co.za</email></para> - </listitem> - - <listitem> - <para>Graham Wheeler <email>gram@cdsec.com</email></para> - </listitem> - - <listitem> - <para>Greg A. Woods <email>woods@zeus.leitch.com</email></para> - </listitem> - - <listitem> - <para>Greg Ansley <email>gja@ansley.com</email></para> - </listitem> - - <listitem> - <para>Greg Troxel <email>gdt@ir.bbn.com</email></para> - </listitem> - - <listitem> - <para>Greg Ungerer <email>gerg@stallion.oz.au</email></para> - </listitem> - - <listitem> - <para>Gregory Bond <email>gnb@itga.com.au</email></para> - </listitem> - - <listitem> - <para>Gregory D. Moncreaff - <email>moncrg@bt340707.res.ray.com</email></para> - </listitem> - - <listitem> - <para>Guy Harris <email>guy@netapp.com</email></para> - </listitem> - - <listitem> - <para>Guy Helmer <email>ghelmer@cs.iastate.edu</email></para> - </listitem> - - <listitem> - <para>HAMADA Naoki <email>hamada@astec.co.jp</email></para> - </listitem> - - <listitem> - <para>HONDA Yasuhiro - <email>honda@kashio.info.mie-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>HOSOBUCHI Noriyuki <email>hoso@buchi.tama.or.jp</email></para> - </listitem> - - <listitem> - <para>Hannu Savolainen <email>hannu@voxware.pp.fi</email></para> - </listitem> - - <listitem> - <para>Hans Huebner <email>hans@artcom.de</email></para> - </listitem> - - <listitem> - <para>Hans Petter Bieker <email>zerium@webindex.no</email></para> - </listitem> - - <listitem> - <para>Hans Zuidam <email>hans@brandinnovators.com</email></para> - </listitem> - - <listitem> - <para>Harlan Stenn <email>Harlan.Stenn@pfcs.com</email></para> - </listitem> - - <listitem> - <para>Harold Barker <email>hbarker@dsms.com</email></para> - </listitem> - - <listitem> - <para>Havard Eidnes - <email>Havard.Eidnes@runit.sintef.no</email></para> - </listitem> - - <listitem> - <para>Heikki Suonsivu <email>hsu@cs.hut.fi</email></para> - </listitem> - - <listitem> - <para>Heiko W. Rupp <email>unknown</email></para> - </listitem> - - <listitem> - <para>Helmut F. Wirth <email>hfwirth@ping.at</email></para> - </listitem> - - <listitem> - <para>Henrik Vestergaard Draboel - <email>hvd@terry.ping.dk</email></para> - </listitem> - - <listitem> - <para>Herb Peyerl <email>hpeyerl@NetBSD.org</email></para> - </listitem> - - <listitem> - <para>Hideaki Ohmon <email>ohmon@tom.sfc.keio.ac.jp</email></para> - </listitem> - - <listitem> - <para>Hidekazu Kuroki <email>hidekazu@cs.titech.ac.jp</email></para> - </listitem> - - <listitem> - <para>Hideki Yamamoto <email>hyama@acm.org</email></para> - </listitem> - - <listitem> - <para>Hideyuki Suzuki - <email>hideyuki@sat.t.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>Hirayama Issei <email>iss@mail.wbs.ne.jp</email></para> - </listitem> - - <listitem> - <para>Hiroaki Sakai <email>sakai@miya.ee.kagu.sut.ac.jp</email></para> - </listitem> - - <listitem> - <para>Hiroharu Tamaru <email>tamaru@ap.t.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>Hironori Ikura <email>hikura@kaisei.org</email></para> - </listitem> - - <listitem> - <para>Hiroshi Nishikawa <email>nis@pluto.dti.ne.jp</email></para> - </listitem> - - <listitem> - <para>Hiroya Tsubakimoto <email>unknown</email></para> - </listitem> - - <listitem> - <para>Holger Veit <email>Holger.Veit@gmd.de</email></para> - </listitem> - - <listitem> - <para>Holm Tiffe <email>holm@geophysik.tu-freiberg.de</email></para> - </listitem> - - <listitem> - <para>Horance Chou - <email>horance@freedom.ie.cycu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Horihiro Kumagai <email>kuma@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>HOTARU-YA <email>hotaru@tail.net</email></para> - </listitem> - - <listitem> - <para>Hr.Ladavac <email>lada@ws2301.gud.siemens.co.at</email></para> - </listitem> - - <listitem> - <para>Hubert Feyrer <email>hubertf@NetBSD.ORG</email></para> - </listitem> - - <listitem> - <para>Hugh F. Mahon <email>hugh@nsmdserv.cnd.hp.com</email></para> - </listitem> - - <listitem> - <para>Hugh Mahon <email>h_mahon@fc.hp.com</email></para> - </listitem> - - <listitem> - <para>Hung-Chi Chu <email>hcchu@r350.ee.ntu.edu.tw</email></para> - </listitem> - - <listitem> - <para>IMAI Takeshi <email>take-i@ceres.dti.ne.jp</email></para> - </listitem> - - <listitem> - <para>IMAMURA Tomoaki - <email>tomoak-i@is.aist-nara.ac.jp</email></para> - </listitem> - - <listitem> - <para>Ian Dowse <email>iedowse@maths.tcd.ie</email></para> - </listitem> - - <listitem> - <para>Ian Holland <email>ianh@tortuga.com.au</email></para> - </listitem> - - <listitem> - <para>Ian Struble <email>ian@broken.net</email></para> - </listitem> - - <listitem> - <para>Ian Vaudrey <email>i.vaudrey@bigfoot.com</email></para> - </listitem> - - <listitem> - <para>Igor Khasilev <email>igor@jabber.paco.odessa.ua</email></para> - </listitem> - - <listitem> - <para>Igor Roshchin <email>str@giganda.komkon.org</email></para> - </listitem> - - <listitem> - <para>Igor Sviridov <email>siac@ua.net</email></para> - </listitem> - - <listitem> - <para>Igor Vinokurov <email>igor@zynaps.ru</email></para> - </listitem> - - <listitem> - <para>Ikuo Nakagawa <email>ikuo@isl.intec.co.jp</email></para> - </listitem> - - <listitem> - <para>Ilya V. Komarov <email>mur@lynx.ru</email></para> - </listitem> - - <listitem> - <para>Issei Suzuki <email>issei@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Itsuro Saito <email>saito@miv.t.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>J. Bryant <email>jbryant@argus.flash.net</email></para> - </listitem> - - <listitem> - <para>J. David Lowe <email>lowe@saturn5.com</email></para> - </listitem> - - <listitem> - <para>J. Han <email>hjh@best.com</email></para> - </listitem> - - <listitem> - <para>J. Hawk <email>jhawk@MIT.EDU</email></para> - </listitem> - - <listitem> - <para>J.T. Conklin <email>jtc@cygnus.com</email></para> - </listitem> - - <listitem> - <para>J.T. Jang <email>keith@email.gcn.net.tw</email></para> - </listitem> - - <listitem> - <para>Jack <email>jack@zeus.xtalwind.net</email></para> - </listitem> - - <listitem> - <para>Jacob Bohn Lorensen <email>jacob@jblhome.ping.mk</email></para> - </listitem> - - <listitem> - <para>Jagane D Sundar <email>jagane@netcom.com</email></para> - </listitem> - - <listitem> - <para>Jake Burkholder <email>jake@checker.org</email></para> - </listitem> - - <listitem> - <para>Jake Hamby <email>jehamby@lightside.com</email></para> - </listitem> - - <listitem> - <para>James Clark <email>jjc@jclark.com</email></para> - </listitem> - - <listitem> - <para>James D. Stewart <email>jds@c4systm.com</email></para> - </listitem> - - <listitem> - <para>James Jegers <email>jimj@miller.cs.uwm.edu</email></para> - </listitem> - - <listitem> - <para>James Raynard - <email>fhackers@jraynard.demon.co.uk</email></para> - </listitem> - - <listitem> - <para>James T. Liu <email>jtliu@phlebas.rockefeller.edu</email></para> - </listitem> - - <listitem> - <para>James da Silva <email>jds@cs.umd.edu</email></para> - </listitem> - - <listitem> - <para>Jan Conard - <email>charly@fachschaften.tu-muenchen.de</email></para> - </listitem> - - <listitem> - <para>Jan Koum <email>jkb@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Janick Taillandier - <email>Janick.Taillandier@ratp.fr</email></para> - </listitem> - - <listitem> - <para>Janusz Kokot <email>janek@gaja.ipan.lublin.pl</email></para> - </listitem> - - <listitem> - <para>Jarle Greipsland <email>jarle@idt.unit.no</email></para> - </listitem> - - <listitem> - <para>Jason Garman <email>init@risen.org</email></para> - </listitem> - - <listitem> - <para>Jason Thorpe <email>thorpej@NetBSD.org</email></para> - </listitem> - - <listitem> - <para>Jason Wright <email>jason@OpenBSD.org</email></para> - </listitem> - - <listitem> - <para>Jason Young - <email>doogie@forbidden-donut.anet-stl.com</email></para> - </listitem> - - <listitem> - <para>Javier Martin Rueda <email>jmrueda@diatel.upm.es</email></para> - </listitem> - - <listitem> - <para>Jay Fenlason <email>hack@datacube.com</email></para> - </listitem> - - <listitem> - <para>Jaye Mathisen <email>mrcpu@cdsnet.net</email></para> - </listitem> - - <listitem> - <para>Jeff Bartig <email>jeffb@doit.wisc.edu</email></para> - </listitem> - - <listitem> - <para>Jeff Forys <email>jeff@forys.cranbury.nj.us</email></para> - </listitem> - - <listitem> - <para>Jeff Kletsky <email>Jeff@Wagsky.com</email></para> - </listitem> - - <listitem> - <para>Jeffrey Evans <email>evans@scnc.k12.mi.us</email></para> - </listitem> - - <listitem> - <para>Jeffrey Wheat <email>jeff@cetlink.net</email></para> - </listitem> - - <listitem> - <para>Jens Schweikhardt <email>schweikh@noc.dfn.d</email></para> - </listitem> - - <listitem> - <para>Jeremy Allison <email>jallison@whistle.com</email></para> - </listitem> - - <listitem> - <para>Jeremy Chatfield <email>jdc@xinside.com</email></para> - </listitem> - - <listitem> - <para>Jeremy Lea <email>reg@shale.csir.co.za</email></para> - </listitem> - - <listitem> - <para>Jeremy Prior <email>unknown</email></para> - </listitem> - - <listitem> - <para>Jeroen Ruigrok/Asmodai <email>asmodai@wxs.nl</email></para> - </listitem> - - <listitem> - <para>Jesse Rosenstock <email>jmr@ugcs.caltech.edu</email></para> - </listitem> - - <listitem> - <para>Jian-Da Li <email>jdli@csie.nctu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Jim Babb <email>babb@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Jim Binkley <email>jrb@cs.pdx.edu</email></para> - </listitem> - - <listitem> - <para>Jim Carroll <email>jim@carroll.com</email></para> - </listitem> - - <listitem> - <para>Jim Flowers <email>jflowers@ezo.net</email></para> - </listitem> - - <listitem> - <para>Jim Leppek <email>jleppek@harris.com</email></para> - </listitem> - - <listitem> - <para>Jim Lowe <email>james@cs.uwm.edu</email></para> - </listitem> - - <listitem> - <para>Jim Mattson <email>jmattson@sonic.net</email></para> - </listitem> - - <listitem> - <para>Jim Mercer <email>jim@komodo.reptiles.org</email></para> - </listitem> - - <listitem> - <para>Jim Wilson <email>wilson@moria.cygnus.com</email></para> - </listitem> - - <listitem> - <para>Jimbo Bahooli - <email>griffin@blackhole.iceworld.org</email></para> - </listitem> - - <listitem> - <para>Jin Guojun <email>jin@george.lbl.gov</email></para> - </listitem> - - <listitem> - <para>Joachim Kuebart <email>unknown</email></para> - </listitem> - - <listitem> - <para>Joao Carlos Mendes Luis <email>jonny@jonny.eng.br</email></para> - </listitem> - - <listitem> - <para>Jochen Pohl <email>jpo.drs@sni.de</email></para> - </listitem> - - <listitem> - <para>Joe "Marcus" Clarke <email>marcus@miami.edu</email></para> - </listitem> - - <listitem> - <para>Joe Abley <email>jabley@clear.co.nz</email></para> - </listitem> - - <listitem> - <para>Joe Jih-Shian Lu <email>jslu@dns.ntu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Joe Orthoefer <email>j_orthoefer@tia.net</email></para> - </listitem> - - <listitem> - <para>Joe Traister <email>traister@mojozone.org</email></para> - </listitem> - - <listitem> - <para>Joel Faedi <email>Joel.Faedi@esial.u-nancy.fr</email></para> - </listitem> - - <listitem> - <para>Joel Ray Holveck <email>joelh@gnu.org</email></para> - </listitem> - - <listitem> - <para>Joel Sutton <email>sutton@aardvark.apana.org.au</email></para> - </listitem> - - <listitem> - <para>Johan Granlund <email>johan@granlund.nu</email></para> - </listitem> - - <listitem> - <para>Johan Karlsson <email>k@numeri.campus.luth.se</email></para> - </listitem> - - <listitem> - <para>Johan Larsson <email>johan@moon.campus.luth.se</email></para> - </listitem> - - <listitem> - <para>Johann Tonsing <email>jtonsing@mikom.csir.co.za</email></para> - </listitem> - - <listitem> - <para>Johannes Helander <email>unknown</email></para> - </listitem> - - <listitem> - <para>Johannes Stille <email>unknown</email></para> - </listitem> - - <listitem> - <para>John Baldwin <email>jobaldwi@vt.edu</email></para> - </listitem> - - <listitem> - <para>John Beckett <email>jbeckett@southern.edu</email></para> - </listitem> - - <listitem> - <para>John Beukema <email>jbeukema@hk.super.net</email></para> - </listitem> - - <listitem> - <para>John Brezak <email>unknown</email></para> - </listitem> - - <listitem> - <para>John Capo <email>jc@irbs.com</email></para> - </listitem> - - <listitem> - <para>John F. Woods <email>jfw@jfwhome.funhouse.com</email></para> - </listitem> - - <listitem> - <para>John Goerzen - <email>jgoerzen@alexanderwohl.complete.org</email></para> - </listitem> - - <listitem> - <para>John Hay <email>jhay@mikom.csir.co.za</email></para> - </listitem> - - <listitem> - <para>John Heidemann <email>johnh@isi.edu</email></para> - </listitem> - - <listitem> - <para>John Hood <email>cgull@owl.org</email></para> - </listitem> - - <listitem> - <para>John Kohl <email>unknown</email></para> - </listitem> - - <listitem> - <para>John Lind <email>john@starfire.mn.org</email></para> - </listitem> - - <listitem> - <para>John Mackin <email>john@physiol.su.oz.au</email></para> - </listitem> - - <listitem> - <para>John P <email>johnp@lodgenet.com</email></para> - </listitem> - - <listitem> - <para>John Perry <email>perry@vishnu.alias.net</email></para> - </listitem> - - <listitem> - <para>John Preisler <email>john@vapornet.com</email></para> - </listitem> - - <listitem> - <para>John Rochester <email>jr@cs.mun.ca</email></para> - </listitem> - - <listitem> - <para>John Sadler <email>john_sadler@alum.mit.edu</email></para> - </listitem> - - <listitem> - <para>John Saunders <email>john@pacer.nlc.net.au</email></para> - </listitem> - - <listitem> - <para>John W. DeBoskey <email>jwd@unx.sas.com</email></para> - </listitem> - - <listitem> - <para>John Wehle <email>john@feith.com</email></para> - </listitem> - - <listitem> - <para>John Woods <email>jfw@eddie.mit.edu</email></para> - </listitem> - - <listitem> - <para>Jon Morgan <email>morgan@terminus.trailblazer.com</email></para> - </listitem> - - <listitem> - <para>Jonathan H N Chin <email>jc254@newton.cam.ac.uk</email></para> - </listitem> - - <listitem> - <para>Jonathan Hanna - <email>jh@pc-21490.bc.rogers.wave.ca</email></para> - </listitem> - - <listitem> - <para>Jorge Goncalves <email>j@bug.fe.up.pt</email></para> - </listitem> - - <listitem> - <para>Jorge M. Goncalves <email>ee96199@tom.fe.up.pt</email></para> - </listitem> - - <listitem> - <para>Jos Backus <email>jbackus@plex.nl</email></para> - </listitem> - - <listitem> - <para>Jose M. Alcaide <email>jose@we.lc.ehu.es</email></para> - </listitem> - - <listitem> - <para>Jose Marques <email>jose@nobody.org</email></para> - </listitem> - - <listitem> - <para>Josef Grosch - <email>jgrosch@superior.mooseriver.com</email></para> - </listitem> - - <listitem> - <para>Josef Karthauser <email>joe@uk.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Joseph Stein <email>joes@wstein.com</email></para> - </listitem> - - <listitem> - <para>Josh Gilliam <email>josh@quick.net</email></para> - </listitem> - - <listitem> - <para>Josh Tiefenbach <email>josh@ican.net</email></para> - </listitem> - - <listitem> - <para>Juergen Lock <email>nox@jelal.hb.north.de</email></para> - </listitem> - - <listitem> - <para>Juha Inkari <email>inkari@cc.hut.fi</email></para> - </listitem> - - <listitem> - <para>Jukka A. Ukkonen <email>jua@iki.fi</email></para> - </listitem> - - <listitem> - <para>Julian Assange <email>proff@suburbia.net</email></para> - </listitem> - - <listitem> - <para>Julian Coleman <email>j.d.coleman@ncl.ac.uk</email></para> - </listitem> - - <listitem> - <para>&a.jhs</para> - </listitem> - - <listitem> - <para>Julian Jenkins <email>kaveman@magna.com.au</email></para> - </listitem> - - <listitem> - <para>Junichi Satoh <email>junichi@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Junji SAKAI <email>sakai@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Junya WATANABE <email>junya-w@remus.dti.ne.jp</email></para> - </listitem> - - <listitem> - <para>K.Higashino <email>a00303@cc.hc.keio.ac.jp</email></para> - </listitem> - - <listitem> - <para>KUNISHIMA Takeo <email>kunishi@c.oka-pu.ac.jp</email></para> - </listitem> - - <listitem> - <para>Kai Vorma <email>vode@snakemail.hut.fi</email></para> - </listitem> - - <listitem> - <para>Kaleb S. Keithley <email>kaleb@ics.com</email></para> - </listitem> - - <listitem> - <para>Kaneda Hiloshi <email>vanitas@ma3.seikyou.ne.jp</email></para> - </listitem> - - <listitem> - <para>Kapil Chowksey <email>kchowksey@hss.hns.com</email></para> - </listitem> - - <listitem> - <para>Karl Denninger <email>karl@mcs.com</email></para> - </listitem> - - <listitem> - <para>Karl Dietz <email>Karl.Dietz@triplan.com</email></para> - </listitem> - - <listitem> - <para>Karl Lehenbauer <email>karl@NeoSoft.com</email></para> - </listitem> - - <listitem> - <para>Kato Takenori - <email>kato@eclogite.eps.nagoya-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Kawanobe Koh <email>kawanobe@st.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Kazuhiko Kiriyama <email>kiri@kiri.toba-cmt.ac.jp</email></para> - </listitem> - - <listitem> - <para>Kazuo Horikawa <email>horikawa@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Kees Jan Koster <email>kjk1@ukc.ac.uk</email></para> - </listitem> - - <listitem> - <para>Keith Bostic <email>bostic@bostic.com</email></para> - </listitem> - - <listitem> - <para>Keith E. Walker <email>unknown</email></para> - </listitem> - - <listitem> - <para>Keith Moore <email>unknown</email></para> - </listitem> - - <listitem> - <para>Keith Sklower <email>unknown</email></para> - </listitem> - - <listitem> - <para>Kelly Yancey <email>kbyanc@posi.net</email></para> - </listitem> - - <listitem> - <para>Ken Hornstein <email>unknown</email></para> - </listitem> - - <listitem> - <para>Ken Key <email>key@cs.utk.edu</email></para> - </listitem> - - <listitem> - <para>Ken Mayer <email>kmayer@freegate.com</email></para> - </listitem> - - <listitem> - <para>Kenji Saito <email>marukun@mx2.nisiq.net</email></para> - </listitem> - - <listitem> - <para>Kenji Tomita <email>tommyk@da2.so-net.or.jp</email></para> - </listitem> - - <listitem> - <para>Kenneth Furge <email>kenneth.furge@us.endress.com</email></para> - </listitem> - - <listitem> - <para>Kenneth Monville <email>desmo@bandwidth.org</email></para> - </listitem> - - <listitem> - <para>Kenneth R. Westerback <email>krw@tcn.net</email></para> - </listitem> - - <listitem> - <para>Kenneth Stailey <email>kstailey@gnu.ai.mit.edu</email></para> - </listitem> - - <listitem> - <para>Kent Talarico <email>kent@shipwreck.tsoft.net</email></para> - </listitem> - - <listitem> - <para>Kent Vander Velden <email>graphix@iastate.edu</email></para> - </listitem> - - <listitem> - <para>Kentaro Inagaki <email>JBD01226@niftyserve.ne.jp</email></para> - </listitem> - - <listitem> - <para>Kevin Bracey <email>kbracey@art.acorn.co.uk</email></para> - </listitem> - - <listitem> - <para>Kevin Day <email>toasty@dragondata.com</email></para> - </listitem> - - <listitem> - <para>Kevin Lahey <email>kml@nas.nasa.gov</email></para> - </listitem> - - <listitem> - <para>Kevin Lo<email>kevlo@hello.com.tw</email></para> - </listitem> - - <listitem> - <para>Kevin Street <email>street@iname.com</email></para> - </listitem> - - <listitem> - <para>Kevin Van Maren <email>vanmaren@fast.cs.utah.edu</email></para> - </listitem> - - <listitem> - <para>Kiroh HARADA <email>kiroh@kh.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Klaus Klein <email>kleink@layla.inka.de</email></para> - </listitem> - - <listitem> - <para>Klaus-J. Wolf <email>Yanestra@t-online.de</email></para> - </listitem> - - <listitem> - <para>Koichi Sato <email>copan@ppp.fastnet.or.jp</email></para> - </listitem> - - <listitem> - <para>Kostya Lukin <email>lukin@okbmei.msk.su</email></para> - </listitem> - - <listitem> - <para>Kouichi Hirabayashi <email>kh@mogami-wire.co.jp</email></para> - </listitem> - - <listitem> - <para>Kurt D. Zeilenga <email>Kurt@Boolean.NET</email></para> - </listitem> - - <listitem> - <para>Kurt Olsen <email>kurto@tiny.mcs.usu.edu</email></para> - </listitem> - - <listitem> - <para>L. Jonas Olsson - <email>ljo@ljo-slip.DIALIN.CWRU.Edu</email></para> - </listitem> - - <listitem> - <para>Lars Köller - <email>Lars.Koeller@Uni-Bielefeld.DE</email></para> - </listitem> - - <listitem> - <para>Larry Altneu <email>larry@ALR.COM</email></para> - </listitem> - - <listitem> - <para>Laurence Lopez <email>lopez@mv.mv.com</email></para> - </listitem> - - <listitem> - <para>Lee Cremeans <email>lcremean@tidalwave.net</email></para> - </listitem> - - <listitem> - <para>Liang Tai-hwa - <email>avatar@www.mmlab.cse.yzu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Lon Willett <email>lon%softt.uucp@math.utah.edu</email></para> - </listitem> - - <listitem> - <para>Louis A. Mamakos <email>louie@TransSys.COM</email></para> - </listitem> - - <listitem> - <para>Louis Mamakos <email>loiue@TransSys.com</email></para> - </listitem> - - <listitem> - <para>Lucas James <email>Lucas.James@ldjpc.apana.org.au</email></para> - </listitem> - - <listitem> - <para>Lyndon Nerenberg <email>lyndon@orthanc.com</email></para> - </listitem> - - <listitem> - <para>M.C. Wong <email>unknown</email></para> - </listitem> - - <listitem> - <para>MANTANI Nobutaka <email>nobutaka@nobutaka.com</email></para> - </listitem> - - <listitem> - <para>MIHIRA Sanpei Yoshiro <email>sanpei@sanpei.org</email></para> - </listitem> - - <listitem> - <para>MITA Yoshio <email>mita@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>MITSUNAGA Noriaki - <email>mitchy@er.ams.eng.osaka-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>MOROHOSHI Akihiko <email>moro@race.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>Magnus Enbom <email>dot@tinto.campus.luth.se</email></para> - </listitem> - - <listitem> - <para>Mahesh Neelakanta <email>mahesh@gcomm.com</email></para> - </listitem> - - <listitem> - <para>Makoto MATSUSHITA <email>matusita@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Makoto WATANABE - <email>watanabe@zlab.phys.nagoya-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Malte Lance <email>malte.lance@gmx.net</email></para> - </listitem> - - <listitem> - <para>Manu Iyengar - <email>iyengar@grunthos.pscwa.psca.com</email></para> - </listitem> - - <listitem> - <para>Marc Frajola <email>marc@dev.com</email></para> - </listitem> - - <listitem> - <para>Marc Ramirez <email>mrami@mramirez.sy.yale.edu</email></para> - </listitem> - - <listitem> - <para>Marc Slemko <email>marcs@znep.com</email></para> - </listitem> - - <listitem> - <para>Marc van Kempen <email>wmbfmk@urc.tue.nl</email></para> - </listitem> - - <listitem> - <para>Marc van Woerkom <email>van.woerkom@netcologne.de</email></para> - </listitem> - - <listitem> - <para>Marcel Moolenaar <email>marcel@scc.nl</email></para> - </listitem> - - <listitem> - <para>Mario Sergio Fujikawa Ferreira - <email>lioux@gns.com.br</email></para> - </listitem> - - <listitem> - <para>Mark Andrews <email>unknown</email></para> - </listitem> - - <listitem> - <para>Mark Cammidge <email>mark@gmtunx.ee.uct.ac.za</email></para> - </listitem> - - <listitem> - <para>Mark Diekhans <email>markd@grizzly.com</email></para> - </listitem> - - <listitem> - <para>Mark Huizer <email>xaa@stack.nl</email></para> - </listitem> - - <listitem> - <para>Mark J. Taylor <email>mtaylor@cybernet.com</email></para> - </listitem> - - <listitem> - <para>Mark Krentel <email>krentel@rice.edu</email></para> - </listitem> - - <listitem> - <para>Mark Mayo <email>markm@vmunix.com</email></para> - </listitem> - - <listitem> - <para>Mark Thompson <email>thompson@tgsoft.com</email></para> - </listitem> - - <listitem> - <para>Mark Tinguely <email>tinguely@plains.nodak.edu</email></para> - </listitem> - - <listitem> - <para>Mark Treacy <email>unknown</email></para> - </listitem> - - <listitem> - <para>Mark Valentine <email>mark@linus.demon.co.uk</email></para> - </listitem> - - <listitem> - <para>Martin Birgmeier</para> - </listitem> - - <listitem> - <para>Martin Ibert <email>mib@ppe.bb-data.de</email></para> - </listitem> - - <listitem> - <para>Martin Kammerhofer <email>dada@sbox.tu-graz.ac.at</email></para> - </listitem> - - <listitem> - <para>Martin Renters <email>martin@tdc.on.ca</email></para> - </listitem> - - <listitem> - <para>Martti Kuparinen - <email>martti.kuparinen@ericsson.com</email></para> - </listitem> - - <listitem> - <para>Masachika ISHIZUKA - <email>ishizuka@isis.min.ntt.jp</email></para> - </listitem> - - <listitem> - <para>Mas.TAKEMURA <email>unknown</email></para> - </listitem> - - <listitem> - <para>Masafumi NAKANE <email>max@wide.ad.jp</email></para> - </listitem> - - <listitem> - <para>Masahiro Sekiguchi - <email>seki@sysrap.cs.fujitsu.co.jp</email></para> - </listitem> - - <listitem> - <para>Masanobu Saitoh <email>msaitoh@spa.is.uec.ac.jp</email></para> - </listitem> - - <listitem> - <para>Masanori Kanaoka <email>kana@saijo.mke.mei.co.jp</email></para> - </listitem> - - <listitem> - <para>Masanori Kiriake <email>seiken@ARGV.AC</email></para> - </listitem> - - <listitem> - <para>Masatoshi TAMURA - <email>tamrin@shinzan.kuee.kyoto-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Mats Lofkvist <email>mal@algonet.se</email></para> - </listitem> - - <listitem> - <para>Matt Bartley <email>mbartley@lear35.cytex.com</email></para> - </listitem> - - <listitem> - <para>Matt Thomas <email>matt@3am-software.com</email></para> - </listitem> - - <listitem> - <para>Matt White <email>mwhite+@CMU.EDU</email></para> - </listitem> - - <listitem> - <para>Matthew C. Mead <email>mmead@Glock.COM</email></para> - </listitem> - - <listitem> - <para>Matthew Cashdollar <email>mattc@rfcnet.com</email></para> - </listitem> - - <listitem> - <para>Matthew Flatt <email>mflatt@cs.rice.edu</email></para> - </listitem> - - <listitem> - <para>Matthew Fuller <email>fullermd@futuresouth.com</email></para> - </listitem> - - <listitem> - <para>Matthew Stein <email>matt@bdd.net</email></para> - </listitem> - - <listitem> - <para>Matthias Pfaller <email>leo@dachau.marco.de</email></para> - </listitem> - - <listitem> - <para>Matthias Scheler <email>tron@netbsd.org</email></para> - </listitem> - - <listitem> - <para>Mattias Gronlund - <email>Mattias.Gronlund@sa.erisoft.se</email></para> - </listitem> - - <listitem> - <para>Mattias Pantzare <email>pantzer@ludd.luth.se</email></para> - </listitem> - - <listitem> - <para>Maurice Castro - <email>maurice@planet.serc.rmit.edu.au</email></para> - </listitem> - - <listitem> - <para>Max Euston <email>meuston@jmrodgers.com</email></para> - </listitem> - - <listitem> - <para>Max Khon <email>fjoe@husky.iclub.nsu.ru</email></para> - </listitem> - - <listitem> - <para>Maxim Bolotin <email>max@rsu.ru</email></para> - </listitem> - - <listitem> - <para>Maxim V. Sobolev <email>sobomax@altavista.net</email></para> - </listitem> - - <listitem> - <para>Micha Class - <email>michael_class@hpbbse.bbn.hp.com</email></para> - </listitem> - - <listitem> - <para>Michael Butler <email>imb@scgt.oz.au</email></para> - </listitem> - - <listitem> - <para>Michael Butschky <email>butsch@computi.erols.com</email></para> - </listitem> - - <listitem> - <para>Michael Clay <email>mclay@weareb.org</email></para> - </listitem> - - <listitem> - <para>Michael Elbel <email>me@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Michael Galassi <email>nerd@percival.rain.com</email></para> - </listitem> - - <listitem> - <para>Michael Hancock <email>michaelh@cet.co.jp</email></para> - </listitem> - - <listitem> - <para>Michael Hohmuth <email>hohmuth@inf.tu-dresden.de</email></para> - </listitem> - - <listitem> - <para>Michael Perlman <email>canuck@caam.rice.edu</email></para> - </listitem> - - <listitem> - <para>Michael Petry <email>petry@netwolf.NetMasters.com</email></para> - </listitem> - - <listitem> - <para>Michael Reifenberger <email>root@totum.plaut.de</email></para> - </listitem> - - <listitem> - <para>Michael Sardo <email>jaeger16@yahoo.com</email></para> - </listitem> - - <listitem> - <para>Michael Searle <email>searle@longacre.demon.co.uk</email></para> - </listitem> - - <listitem> - <para>Michal Listos <email>mcl@Amnesiac.123.org</email></para> - </listitem> - - <listitem> - <para>Michio Karl Jinbo - <email>karl@marcer.nagaokaut.ac.jp</email></para> - </listitem> - - <listitem> - <para>Miguel Angel Sagreras - <email>msagre@cactus.fi.uba.ar</email></para> - </listitem> - - <listitem> - <para>Mihoko Tanaka <email>m_tonaka@pa.yokogawa.co.jp</email></para> - </listitem> - - <listitem> - <para>Mika Nystrom <email>mika@cs.caltech.edu</email></para> - </listitem> - - <listitem> - <para>Mikael Hybsch <email>micke@dynas.se</email></para> - </listitem> - - <listitem> - <para>Mikael Karpberg - <email>karpen@ocean.campus.luth.se</email></para> - </listitem> - - <listitem> - <para>Mike Del <email>repenting@hotmail.com</email></para> - </listitem> - - <listitem> - <para>Mike Durian <email>durian@plutotech.com</email></para> - </listitem> - - <listitem> - <para>Mike Durkin <email>mdurkin@tsoft.sf-bay.org</email></para> - </listitem> - - <listitem> - <para>Mike E. Matsnev <email>mike@azog.cs.msu.su</email></para> - </listitem> - - <listitem> - <para>Mike Evans <email>mevans@candle.com</email></para> - </listitem> - - <listitem> - <para>Mike Grupenhoff <email>kashmir@umiacs.umd.edu</email></para> - </listitem> - - <listitem> - <para>Mike Hibler <email>mike@marker.cs.utah.edu</email></para> - </listitem> - - <listitem> - <para>Mike Karels <email>unknown</email></para> - </listitem> - - <listitem> - <para>Mike McGaughey <email>mmcg@cs.monash.edu.au</email></para> - </listitem> - - <listitem> - <para>Mike Meyer <email>mwm@shiva.the-park.com</email></para> - </listitem> - - <listitem> - <para>Mike Mitchell <email>mitchell@ref.tfs.com</email></para> - </listitem> - - <listitem> - <para>Mike Murphy <email>mrm@alpharel.com</email></para> - </listitem> - - <listitem> - <para>Mike Peck <email>mike@binghamton.edu</email></para> - </listitem> - - <listitem> - <para>Mike Spengler <email>mks@msc.edu</email></para> - </listitem> - - <listitem> - <para>Mikhail A. Sokolov <email>mishania@demos.su</email></para> - </listitem> - - <listitem> - <para>Mikhail Teterin <email>mi@aldan.ziplink.net</email></para> - </listitem> - - <listitem> - <para>Ming-I Hseh <email>PA@FreeBSD.ee.Ntu.edu.TW</email></para> - </listitem> - - <listitem> - <para>Mitsuru IWASAKI <email>iwasaki@pc.jaring.my</email></para> - </listitem> - - <listitem> - <para>Mitsuru Yoshida <email>mitsuru@riken.go.jp</email></para> - </listitem> - - <listitem> - <para>Monte Mitzelfelt <email>monte@gonefishing.org</email></para> - </listitem> - - <listitem> - <para>Morgan Davis <email>root@io.cts.com</email></para> - </listitem> - - <listitem> - <para>Mostyn Lewis <email>mostyn@mrl.com</email></para> - </listitem> - - <listitem> - <para>Motomichi Matsuzaki <email>mzaki@e-mail.ne.jp</email></para> - </listitem> - - <listitem> - <para>Motoyuki Kasahara <email>m-kasahr@sra.co.jp</email></para> - </listitem> - - <listitem> - <para>Motoyuki Konno <email>motoyuki@snipe.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Murray Stokely <email>murray@cdrom.com</email></para> - </listitem> - - <listitem> - <para>N.G.Smith <email>ngs@sesame.hensa.ac.uk</email></para> - </listitem> - - <listitem> - <para>NAGAO Tadaaki <email>nagao@cs.titech.ac.jp</email></para> - </listitem> - - <listitem> - <para>NAKAJI Hiroyuki - <email>nakaji@tutrp.tut.ac.jp</email></para> - </listitem> - - <listitem> - <para>NAKAMURA Kazushi <email>nkazushi@highway.or.jp</email></para> - </listitem> - - <listitem> - <para>NAKAMURA Motonori - <email>motonori@econ.kyoto-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>NIIMI Satoshi <email>sa2c@and.or.jp</email></para> - </listitem> - - <listitem> - <para>NOKUBI Hirotaka <email>h-nokubi@yyy.or.jp</email></para> - </listitem> - - <listitem> - <para>Nadav Eiron <email>nadav@barcode.co.il</email></para> - </listitem> - - <listitem> - <para>Nanbor Wang <email>nw1@cs.wustl.edu</email></para> - </listitem> - - <listitem> - <para>Naofumi Honda - <email>honda@Kururu.math.sci.hokudai.ac.jp</email></para> - </listitem> - - <listitem> - <para>Naoki Hamada <email>nao@tom-yam.or.jp</email></para> - </listitem> - - <listitem> - <para>Narvi <email>narvi@haldjas.folklore.ee</email></para> - </listitem> - - <listitem> - <para>Nathan Ahlstrom <email>nrahlstr@winternet.com</email></para> - </listitem> - - <listitem> - <para>Nathan Dorfman <email>nathan@rtfm.net</email></para> - </listitem> - - <listitem> - <para>Neal Fachan <email>kneel@ishiboo.com</email></para> - </listitem> - - <listitem> - <para>Neil Blakey-Milner <email>nbm@rucus.ru.ac.za</email></para> - </listitem> - - <listitem> - <para>Niall Smart <email>rotel@indigo.ie</email></para> - </listitem> - - <listitem> - <para>Nick Barnes <email>Nick.Barnes@pobox.com</email></para> - </listitem> - - <listitem> - <para>Nick Handel <email>nhandel@NeoSoft.com</email></para> - </listitem> - - <listitem> - <para>Nick Hilliard <email>nick@foobar.org</email></para> - </listitem> - - <listitem> - <para>&a.nsayer;</para> - </listitem> - - <listitem> - <para>Nick Williams <email>njw@cs.city.ac.uk</email></para> - </listitem> - - <listitem> - <para>Nickolay N. Dudorov <email>nnd@itfs.nsk.su</email></para> - </listitem> - - <listitem> - <para>Niklas Hallqvist <email>niklas@filippa.appli.se</email></para> - </listitem> - - <listitem> - <para>Nisha Talagala <email>nisha@cs.berkeley.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>ZW6T-KND@j.asahi-net.or.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>adrian@virginia.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>alex@elvisti.kiev.ua</email></para> - </listitem> - - <listitem> - <para>No Name <email>anto@netscape.net</email></para> - </listitem> - - <listitem> - <para>No Name <email>bobson@egg.ics.nitch.ac.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>bovynf@awe.be</email></para> - </listitem> - - <listitem> - <para>No Name <email>burg@is.ge.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>chris@gnome.co.uk</email></para> - </listitem> - - <listitem> - <para>No Name <email>colsen@usa.net</email></para> - </listitem> - - <listitem> - <para>No Name <email>coredump@nervosa.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>dannyman@arh0300.urh.uiuc.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>davids@SECNET.COM</email></para> - </listitem> - - <listitem> - <para>No Name <email>derek@free.org</email></para> - </listitem> - - <listitem> - <para>No Name <email>devet@adv.IAEhv.nl</email></para> - </listitem> - - <listitem> - <para>No Name <email>djv@bedford.net</email></para> - </listitem> - - <listitem> - <para>No Name <email>dvv@sprint.net</email></para> - </listitem> - - <listitem> - <para>No Name <email>enami@ba2.so-net.or.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>flash@eru.tubank.msk.su</email></para> - </listitem> - - <listitem> - <para>No Name <email>flash@hway.ru</email></para> - </listitem> - - <listitem> - <para>No Name <email>fn@pain.csrv.uidaho.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>gclarkii@netport.neosoft.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>gordon@sheaky.lonestar.org</email></para> - </listitem> - - <listitem> - <para>No Name <email>graaf@iae.nl</email></para> - </listitem> - - <listitem> - <para>No Name <email>greg@greg.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>grossman@cygnus.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>gusw@fub46.zedat.fu-berlin.de</email></para> - </listitem> - - <listitem> - <para>No Name <email>hfir@math.rochester.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>hnokubi@yyy.or.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>iaint@css.tuu.utas.edu.au</email></para> - </listitem> - - <listitem> - <para>No Name <email>invis@visi.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>ishisone@sra.co.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>iverson@lionheart.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>jpt@magic.net</email></para> - </listitem> - - <listitem> - <para>No Name <email>junker@jazz.snu.ac.kr</email></para> - </listitem> - - <listitem> - <para>No Name <email>k-sugyou@ccs.mt.nec.co.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>kenji@reseau.toyonaka.osaka.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>kfurge@worldnet.att.net</email></para> - </listitem> - - <listitem> - <para>No Name <email>lh@aus.org</email></para> - </listitem> - - <listitem> - <para>No Name <email>lhecking@nmrc.ucc.ie</email></para> - </listitem> - - <listitem> - <para>No Name <email>mrgreen@mame.mu.oz.au</email></para> - </listitem> - - <listitem> - <para>No Name <email>nakagawa@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>No Name <email>ohki@gssm.otsuka.tsukuba.ac.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>owaki@st.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>pechter@shell.monmouth.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>pete@pelican.pelican.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>pritc003@maroon.tc.umn.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>risner@stdio.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>roman@rpd.univ.kiev.ua</email></para> - </listitem> - - <listitem> - <para>No Name <email>root@ns2.redline.ru</email></para> - </listitem> - - <listitem> - <para>No Name <email>root@uglabgw.ug.cs.sunysb.edu</email></para> - </listitem> - - <listitem> - <para>No Name <email>stephen.ma@jtec.com.au</email></para> - </listitem> - - <listitem> - <para>No Name <email>sumii@is.s.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>takas-su@is.aist-nara.ac.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>tamone@eig.unige.ch</email></para> - </listitem> - - <listitem> - <para>No Name <email>tjevans@raleigh.ibm.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>tony-o@iij.ad.jp amurai@spec.co.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>torii@tcd.hitachi.co.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>uenami@imasy.or.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>uhlar@netlab.sk</email></para> - </listitem> - - <listitem> - <para>No Name <email>vode@hut.fi</email></para> - </listitem> - - <listitem> - <para>No Name <email>wlloyd@mpd.ca</email></para> - </listitem> - - <listitem> - <para>No Name <email>wlr@furball.wellsfargo.com</email></para> - </listitem> - - <listitem> - <para>No Name <email>wmbfmk@urc.tue.nl</email></para> - </listitem> - - <listitem> - <para>No Name <email>yamagata@nwgpc.kek.jp</email></para> - </listitem> - - <listitem> - <para>No Name <email>ziggy@ryan.org</email></para> - </listitem> - - <listitem> - <para>Nobuhiro Yasutomi <email>nobu@psrc.isac.co.jp</email></para> - </listitem> - - <listitem> - <para>Nobuyuki Koganemaru - <email>kogane@koganemaru.co.jp</email></para> - </listitem> - - <listitem> - <para>Norio Suzuki <email>nosuzuki@e-mail.ne.jp</email></para> - </listitem> - - <listitem> - <para>Noritaka Ishizumi <email>graphite@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Noriyuki Soda <email>soda@sra.co.jp</email></para> - </listitem> - - <listitem> - <para>Oh Junseon <email>hollywar@mail.holywar.net</email></para> - </listitem> - - <listitem> - <para>Olaf Wagner <email>wagner@luthien.in-berlin.de</email></para> - </listitem> - - <listitem> - <para>Oleg Sharoiko <email>os@rsu.ru</email></para> - </listitem> - - <listitem> - <para>Oleg V. Volkov <email>rover@lglobus.ru</email></para> - </listitem> - - <listitem> - <para>Oliver Breuninger <email>ob@seicom.NET</email></para> - </listitem> - - <listitem> - <para>Oliver Friedrichs <email>oliver@secnet.com</email></para> - </listitem> - - <listitem> - <para>Oliver Fromme - <email>oliver.fromme@heim3.tu-clausthal.de</email></para> - </listitem> - - <listitem> - <para>Oliver Laumann - <email>net@informatik.uni-bremen.de</email></para> - </listitem> - - <listitem> - <para>Oliver Oberdorf <email>oly@world.std.com</email></para> - </listitem> - - <listitem> - <para>Olof Johansson <email>offe@ludd.luth.se</email></para> - </listitem> - - <listitem> - <para>Osokin Sergey aka oZZ <email>ozz@FreeBSD.org.ru</email></para> - </listitem> - - <listitem> - <para>Pace Willisson <email>pace@blitz.com</email></para> - </listitem> - - <listitem> - <para>Paco Rosich <email>rosich@modico.eleinf.uv.es</email></para> - </listitem> - - <listitem> - <para>Palle Girgensohn <email>girgen@partitur.se</email></para> - </listitem> - - <listitem> - <para>Parag Patel <email>parag@cgt.com</email></para> - </listitem> - - <listitem> - <para>Pascal Pederiva <email>pascal@zuo.dec.com</email></para> - </listitem> - - <listitem> - <para>Pasvorn Boonmark <email>boonmark@juniper.net</email></para> - </listitem> - - <listitem> - <para>Patrick Gardella <email>patrick@cre8tivegroup.com</email></para> - </listitem> - - <listitem> - <para>Patrick Hausen <email>unknown</email></para> - </listitem> - - <listitem> - <para>Paul Antonov <email>apg@demos.su</email></para> - </listitem> - - <listitem> - <para>Paul F. Werkowski <email>unknown</email></para> - </listitem> - - <listitem> - <para>Paul Fox <email>pgf@foxharp.boston.ma.us</email></para> - </listitem> - - <listitem> - <para>Paul Koch <email>koch@thehub.com.au</email></para> - </listitem> - - <listitem> - <para>Paul Kranenburg <email>pk@NetBSD.org</email></para> - </listitem> - - <listitem> - <para>Paul Mackerras <email>paulus@cs.anu.edu.au</email></para> - </listitem> - - <listitem> - <para>Paul Popelka <email>paulp@uts.amdahl.com</email></para> - </listitem> - - <listitem> - <para>Paul S. LaFollette, Jr. <email>unknown</email></para> - </listitem> - - <listitem> - <para>Paul Saab <email>paul@mu.org</email></para> - </listitem> - - <listitem> - <para>Paul Sandys <email>myj@nyct.net</email></para> - </listitem> - - <listitem> - <para>Paul T. Root <email>proot@horton.iaces.com</email></para> - </listitem> - - <listitem> - <para>Paul Vixie <email>paul@vix.com</email></para> - </listitem> - - <listitem> - <para>Paulo Menezes <email>paulo@isr.uc.pt</email></para> - </listitem> - - <listitem> - <para>Paulo Menezes <email>pm@dee.uc.pt</email></para> - </listitem> - - <listitem> - <para>Pedro A M Vazquez <email>vazquez@IQM.Unicamp.BR</email></para> - </listitem> - - <listitem> - <para>Pedro Giffuni <email>giffunip@asme.org</email></para> - </listitem> - - <listitem> - <para>Pete Bentley <email>pete@demon.net</email></para> - </listitem> - - <listitem> - <para>Peter Childs <email>pjchilds@imforei.apana.org.au</email></para> - </listitem> - - <listitem> - <para>Peter Cornelius <email>pc@inr.fzk.de</email></para> - </listitem> - - <listitem> - <para>Peter Haight <email>peterh@prognet.com</email></para> - </listitem> - - <listitem> - <para>Peter Jeremy <email>perer.jeremy@alcatel.com.au</email></para> - </listitem> - - <listitem> - <para>Peter M. Chen <email>pmchen@eecs.umich.edu</email></para> - </listitem> - - <listitem> - <para>Peter Much <email>peter@citylink.dinoex.sub.org</email></para> - </listitem> - - <listitem> - <para>Peter Olsson <email>unknown</email></para> - </listitem> - - <listitem> - <para>Peter Philipp <email>pjp@bsd-daemon.net</email></para> - </listitem> - - <listitem> - <para>Peter Stubbs <email>PETERS@staidan.qld.edu.au</email></para> - </listitem> - - <listitem> - <para>Phil Maker <email>pjm@cs.ntu.edu.au</email></para> - </listitem> - - <listitem> - <para>Phil Sutherland - <email>philsuth@mycroft.dialix.oz.au</email></para> - </listitem> - - <listitem> - <para>Phil Taylor <email>phil@zipmail.co.uk</email></para> - </listitem> - - <listitem> - <para>Philip Musumeci <email>philip@rmit.edu.au</email></para> - </listitem> - - <listitem> - <para>Pierre Y. Dampure <email>pierre.dampure@k2c.co.uk</email></para> - </listitem> - - <listitem> - <para>Pius Fischer <email>pius@ienet.com</email></para> - </listitem> - - <listitem> - <para>Pomegranate <email>daver@flag.blackened.net</email></para> - </listitem> - - <listitem> - <para>Powerdog Industries - <email>kevin.ruddy@powerdog.com</email></para> - </listitem> - - <listitem> - <para>R. Kym Horsell</para> - </listitem> - - <listitem> - <para>Rajesh Vaidheeswarran <email>rv@fore.com</email></para> - </listitem> - - <listitem> - <para>Ralf Friedl <email>friedl@informatik.uni-kl.de</email></para> - </listitem> - - <listitem> - <para>Randal S. Masutani <email>randal@comtest.com</email></para> - </listitem> - - <listitem> - <para>Randall Hopper <email>rhh@ct.picker.com</email></para> - </listitem> - - <listitem> - <para>Randall W. Dean <email>rwd@osf.org</email></para> - </listitem> - - <listitem> - <para>Randy Bush <email>rbush@bainbridge.verio.net</email></para> - </listitem> - - <listitem> - <para>Reinier Bezuidenhout - <email>rbezuide@mikom.csir.co.za</email></para> - </listitem> - - <listitem> - <para>Remy Card <email>Remy.Card@masi.ibp.fr</email></para> - </listitem> - - <listitem> - <para>Ricardas Cepas <email>rch@richard.eu.org</email></para> - </listitem> - - <listitem> - <para>Riccardo Veraldi <email>veraldi@cs.unibo.it</email></para> - </listitem> - - <listitem> - <para>Richard Henderson <email>richard@atheist.tamu.edu</email></para> - </listitem> - - <listitem> - <para>Richard Hwang <email>rhwang@bigpanda.com</email></para> - </listitem> - - <listitem> - <para>Richard Kiss <email>richard@homemail.com</email></para> - </listitem> - - <listitem> - <para>Richard J Kuhns <email>rjk@watson.grauel.com</email></para> - </listitem> - - <listitem> - <para>Richard M. Neswold - <email>rneswold@drmemory.fnal.gov</email></para> - </listitem> - - <listitem> - <para>Richard Seaman, Jr. <email>dick@tar.com</email></para> - </listitem> - - <listitem> - <para>Richard Stallman <email>rms@gnu.ai.mit.edu</email></para> - </listitem> - - <listitem> - <para>Richard Straka <email>straka@user1.inficad.com</email></para> - </listitem> - - <listitem> - <para>Richard Tobin <email>richard@cogsci.ed.ac.uk</email></para> - </listitem> - - <listitem> - <para>Richard Wackerbarth <email>rkw@Dataplex.NET</email></para> - </listitem> - - <listitem> - <para>Richard Winkel <email>rich@math.missouri.edu</email></para> - </listitem> - - <listitem> - <para>Richard Wiwatowski <email>rjwiwat@adelaide.on.net</email></para> - </listitem> - - <listitem> - <para>Rick Macklem <email>rick@snowhite.cis.uoguelph.ca</email></para> - </listitem> - - <listitem> - <para>Rick Macklin <email>unknown</email></para> - </listitem> - - <listitem> - <para>Rob Austein <email>sra@epilogue.com</email></para> - </listitem> - - <listitem> - <para>Rob Mallory <email>rmallory@qualcomm.com</email></para> - </listitem> - - <listitem> - <para>Rob Snow <email>rsnow@txdirect.net</email></para> - </listitem> - - <listitem> - <para>Robert Crowe <email>bob@speakez.com</email></para> - </listitem> - - <listitem> - <para>Robert D. Thrush <email>rd@phoenix.aii.com</email></para> - </listitem> - - <listitem> - <para>Robert Eckardt - <email>roberte@MEP.Ruhr-Uni-Bochum.de</email></para> - </listitem> - - <listitem> - <para>Robert Sanders <email>rsanders@mindspring.com</email></para> - </listitem> - - <listitem> - <para>Robert Sexton <email>robert@kudra.com</email></para> - </listitem> - - <listitem> - <para>Robert Shady <email>rls@id.net</email></para> - </listitem> - - <listitem> - <para>Robert Swindells <email>swindellsr@genrad.co.uk</email></para> - </listitem> - - <listitem> - <para>Robert Watson <email>robert@cyrus.watson.org</email></para> - </listitem> - - <listitem> - <para>Robert Withrow <email>witr@rwwa.com</email></para> - </listitem> - - <listitem> - <para>Robert Yoder <email>unknown</email></para> - </listitem> - - <listitem> - <para>Robin Carey - <email>robin@mailgate.dtc.rankxerox.co.uk</email></para> - </listitem> - - <listitem> - <para>Roger Hardiman <email>roger@cs.strath.ac.uk</email></para> - </listitem> - - <listitem> - <para>Roland Jesse <email>jesse@cs.uni-magdeburg.de</email></para> - </listitem> - - <listitem> - <para>Ron Bickers <email>rbickers@intercenter.net</email></para> - </listitem> - - <listitem> - <para>Ron Lenk <email>rlenk@widget.xmission.com</email></para> - </listitem> - - <listitem> - <para>Ronald Kuehn <email>kuehn@rz.tu-clausthal.de</email></para> - </listitem> - - <listitem> - <para>Rudolf Cejka <email>unknown</email></para> - </listitem> - - <listitem> - <para>Ruslan Belkin <email>rus@home2.UA.net</email></para> - </listitem> - - <listitem> - <para>Ruslan Ermilov <email>ru@ucb.crimea.ua</email></para> - </listitem> - - <listitem> - <para>Ruslan Shevchenko <email>rssh@cam.grad.kiev.ua</email></para> - </listitem> - - <listitem> - <para>Russell L. Carter <email>rcarter@pinyon.org</email></para> - </listitem> - - <listitem> - <para>Russell Vincent <email>rv@groa.uct.ac.za</email></para> - </listitem> - - <listitem> - <para>Ryan Younce <email>ryany@pobox.com</email></para> - </listitem> - - <listitem> - <para>Ryuichiro IMURA <email>imura@cs.titech.ac.jp</email></para> - </listitem> - - <listitem> - <para>SANETO Takanori <email>sanewo@strg.sony.co.jp</email></para> - </listitem> - - <listitem> - <para>SAWADA Mizuki <email>miz@qb3.so-net.ne.jp</email></para> - </listitem> - - <listitem> - <para>SUGIMURA Takashi <email>sugimura@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>SURANYI Peter - <email>suranyip@jks.is.tsukuba.ac.jp</email></para> - </listitem> - - <listitem> - <para>Sakai Hiroaki <email>sakai@miya.ee.kagu.sut.ac.jp</email></para> - </listitem> - - <listitem> - <para>Sakari Jalovaara <email>sja@tekla.fi</email></para> - </listitem> - - <listitem> - <para>Sam Hartman <email>hartmans@mit.edu</email></para> - </listitem> - - <listitem> - <para>Samuel Lam <email>skl@ScalableNetwork.com</email></para> - </listitem> - - <listitem> - <para>Samuele Zannoli <email>zannoli@cs.unibo.it</email></para> - </listitem> - - <listitem> - <para>Sander Vesik <email>sander@haldjas.folklore.ee</email></para> - </listitem> - - <listitem> - <para>Sandro Sigala <email>ssigala@globalnet.it</email></para> - </listitem> - - <listitem> - <para>Sascha Blank <email>blank@fox.uni-trier.de</email></para> - </listitem> - - <listitem> - <para>Sascha Wildner <email>swildner@channelz.GUN.de</email></para> - </listitem> - - <listitem> - <para>Satoh Junichi <email>junichi@astec.co.jp</email></para> - </listitem> - - <listitem> - <para>Scot Elliott <email>scot@poptart.org</email></para> - </listitem> - - <listitem> - <para>Scot W. Hetzel <email>hetzels@westbend.net</email></para> - </listitem> - - <listitem> - <para>Scott A. Kenney <email>saken@rmta.ml.org</email></para> - </listitem> - - <listitem> - <para>Scott Blachowicz - <email>scott.blachowicz@seaslug.org</email></para> - </listitem> - - <listitem> - <para>Scott Burris <email>scott@pita.cns.ucla.edu</email></para> - </listitem> - - <listitem> - <para>Scott Hazen Mueller <email>scott@zorch.sf-bay.org</email></para> - </listitem> - - <listitem> - <para>Scott Michel <email>scottm@cs.ucla.edu</email></para> - </listitem> - - <listitem> - <para>Scott Mitchel <email>scott@uk.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Scott Reynolds <email>scott@clmqt.marquette.mi.us</email></para> - </listitem> - - <listitem> - <para>Sebastian Strollo <email>seb@erix.ericsson.se</email></para> - </listitem> - - <listitem> - <para>Serge A. Babkin <email>babkin@hq.icb.chel.su</email></para> - </listitem> - - <listitem> - <para>Serge V. Vakulenko <email>vak@zebub.msk.su</email></para> - </listitem> - - <listitem> - <para>Sergei Chechetkin - <email>csl@whale.sunbay.crimea.ua</email></para> - </listitem> - - <listitem> - <para>Sergei S. Laskavy <email>laskavy@pc759.cs.msu.su</email></para> - </listitem> - - <listitem> - <para>Sergey Gershtein <email>sg@mplik.ru</email></para> - </listitem> - - <listitem> - <para>Sergey Kosyakov <email>ks@itp.ac.ru</email></para> - </listitem> - - <listitem> - <para>Sergey Potapov <email>sp@alkor.ru</email></para> - </listitem> - - <listitem> - <para>Sergey Shkonda <email>serg@bcs.zp.ua</email></para> - </listitem> - - <listitem> - <para>Sergey V.Dorokhov <email>svd@kbtelecom.nalnet.ru</email></para> - </listitem> - - <listitem> - <para>Sergio Lenzi <email>lenzi@bsi.com.br</email></para> - </listitem> - - <listitem> - <para>Shaun Courtney <email>shaun@emma.eng.uct.ac.za</email></para> - </listitem> - - <listitem> - <para>Shawn M. Carey <email>smcarey@mailbox.syr.edu</email></para> - </listitem> - - <listitem> - <para>Shigio Yamaguchi <email>shigio@tamacom.com</email></para> - </listitem> - - <listitem> - <para>Shinya Esu <email>esu@yk.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Shuichi Tanaka <email>stanaka@bb.mbn.or.jp</email></para> - </listitem> - - <listitem> - <para>Shunsuke Akiyama <email>akiyama@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Simon <email>simon@masi.ibp.fr</email></para> - </listitem> - - <listitem> - <para>Simon Burge <email>simonb@telstra.com.au</email></para> - </listitem> - - <listitem> - <para>Simon J Gerraty <email>sjg@melb.bull.oz.au</email></para> - </listitem> - - <listitem> - <para>Simon Marlow <email>simonm@dcs.gla.ac.uk</email></para> - </listitem> - - <listitem> - <para>Simon Shapiro <email>shimon@simon-shapiro.org</email></para> - </listitem> - - <listitem> - <para>Sin'ichiro MIYATANI <email>siu@phaseone.co.jp</email></para> - </listitem> - - <listitem> - <para>Slaven Rezic <email>eserte@cs.tu-berlin.de</email></para> - </listitem> - - <listitem> - <para>Soochon Radee <email>slr@mitre.org</email></para> - </listitem> - - <listitem> - <para>Soren Dayton <email>csdayton@midway.uchicago.edu</email></para> - </listitem> - - <listitem> - <para>Soren Dossing <email>sauber@netcom.com</email></para> - </listitem> - - <listitem> - <para>Soren S. Jorvang <email>soren@dt.dk</email></para> - </listitem> - - <listitem> - <para>Stefan Bethke <email>stb@hanse.de</email></para> - </listitem> - - <listitem> - <para>Stefan Eggers <email>seggers@semyam.dinoco.de</email></para> - </listitem> - - <listitem> - <para>Stefan Moeding <email>s.moeding@ndh.net</email></para> - </listitem> - - <listitem> - <para>Stefan Petri <email>unknown</email></para> - </listitem> - - <listitem> - <para>Stefan `Sec` Zehl <email>sec@42.org</email></para> - </listitem> - - <listitem> - <para>Steinar Haug <email>sthaug@nethelp.no</email></para> - </listitem> - - <listitem> - <para>Stephane E. Potvin <email>sepotvin@videotron.ca</email></para> - </listitem> - - <listitem> - <para>Stephane Legrand <email>stephane@lituus.fr</email></para> - </listitem> - - <listitem> - <para>Stephen Clawson - <email>sclawson@marker.cs.utah.edu</email></para> - </listitem> - - <listitem> - <para>Stephen F. Combs <email>combssf@salem.ge.com</email></para> - </listitem> - - <listitem> - <para>Stephen Farrell <email>stephen@farrell.org</email></para> - </listitem> - - <listitem> - <para>Stephen Hocking <email>sysseh@devetir.qld.gov.au</email></para> - </listitem> - - <listitem> - <para>Stephen J. Roznowski <email>sjr@home.net</email></para> - </listitem> - - <listitem> - <para>Stephen McKay <email>syssgm@devetir.qld.gov.au</email></para> - </listitem> - - <listitem> - <para>Stephen Melvin <email>melvin@zytek.com</email></para> - </listitem> - - <listitem> - <para>Steve Bauer <email>sbauer@rock.sdsmt.edu</email></para> - </listitem> - - <listitem> - <para>Steve Coltrin <email>spcoltri@io.com</email></para> - </listitem> - - <listitem> - <para>Steve Deering <email>unknown</email></para> - </listitem> - - <listitem> - <para>Steve Gerakines <email>steve2@genesis.tiac.net</email></para> - </listitem> - - <listitem> - <para>Steve Gericke <email>steveg@comtrol.com</email></para> - </listitem> - - <listitem> - <para>Steve Piette <email>steve@simon.chi.il.US</email></para> - </listitem> - - <listitem> - <para>Steve Schwarz <email>schwarz@alpharel.com</email></para> - </listitem> - - <listitem> - <para>Steven G. Kargl - <email>kargl@troutmask.apl.washington.edu</email></para> - </listitem> - - <listitem> - <para>Steven H. Samorodin <email>samorodi@NUXI.com</email></para> - </listitem> - - <listitem> - <para>Steven McCanne <email>mccanne@cs.berkeley.edu</email></para> - </listitem> - - <listitem> - <para>Steven Plite <email>splite@purdue.edu</email></para> - </listitem> - - <listitem> - <para>Steven Wallace <email>unknown</email></para> - </listitem> - - <listitem> - <para>Stuart Henderson - <email>stuart@internationalschool.co.uk</email></para> - </listitem> - - <listitem> - <para>Sue Blake <email>sue@welearn.com.au</email></para> - </listitem> - - <listitem> - <para>Sugimoto Sadahiro <email>ixtl@komaba.utmc.or.jp</email></para> - </listitem> - - <listitem> - <para>Sugiura Shiro <email>ssugiura@duo.co.jp</email></para> - </listitem> - - <listitem> - <para>Sujal Patel <email>smpatel@wam.umd.edu</email></para> - </listitem> - - <listitem> - <para>Sune Stjerneby <email>stjerneby@usa.net</email></para> - </listitem> - - <listitem> - <para>Suzuki Yoshiaki - <email>zensyo@ann.tama.kawasaki.jp</email></para> - </listitem> - - <listitem> - <para>Tadashi Kumano <email>kumano@strl.nhk.or.jp</email></para> - </listitem> - - <listitem> - <para>Taguchi Takeshi <email>taguchi@tohoku.iij.ad.jp</email></para> - </listitem> - - <listitem> - <para>Takahiro Yugawa <email>yugawa@orleans.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Takanori Watanabe - <email>takawata@shidahara1.planet.sci.kobe-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takashi Mega <email>mega@minz.org</email></para> - </listitem> - - <listitem> - <para>Takashi Uozu <email>j1594016@ed.kagu.sut.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takayuki Ariga <email>a00821@cc.hc.keio.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takeru NAIKI <email>naiki@bfd.es.hokudai.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takeshi Amaike <email>amaike@iri.co.jp</email></para> - </listitem> - - <listitem> - <para>Takeshi MUTOH <email>mutoh@info.nara-k.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takeshi Ohashi - <email>ohashi@mickey.ai.kyutech.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takeshi WATANABE - <email>watanabe@crayon.earth.s.kobe-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Takuya SHIOZAKI - <email>tshiozak@makino.ise.chuo-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Tatoku Ogaito <email>tacha@tera.fukui-med.ac.jp</email></para> - </listitem> - - <listitem> - <para>Tatsumi HOSOKAWA <email>hosokawa@jp.FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Ted Buswell <email>tbuswell@mediaone.net</email></para> - </listitem> - - <listitem> - <para>Ted Faber <email>faber@isi.edu</email></para> - </listitem> - - <listitem> - <para>Ted Lemon <email>mellon@isc.org</email></para> - </listitem> - - <listitem> - <para>Terry Lambert <email>terry@lambert.org</email></para> - </listitem> - - <listitem> - <para>Terry Lee <email>terry@uivlsi.csl.uiuc.edu</email></para> - </listitem> - - <listitem> - <para>Tetsuya Furukawa <email>tetsuya@secom-sis.co.jp</email></para> - </listitem> - - <listitem> - <para>Theo de Raadt <email>deraadt@OpenBSD.org</email></para> - </listitem> - - <listitem> - <para>Thomas <email>thomas@mathematik.uni-Bremen.de</email></para> - </listitem> - - <listitem> - <para>Thomas D. Dean <email>tomdean@ix.netcom.com</email></para> - </listitem> - - <listitem> - <para>Thomas David Rivers <email>rivers@dignus.com</email></para> - </listitem> - - <listitem> - <para>Thomas G. McWilliams <email>tgm@netcom.com</email></para> - </listitem> - - <listitem> - <para>Thomas Gellekum - <email>thomas@ghpc8.ihf.rwth-aachen.de</email></para> - </listitem> - - <listitem> - <para>Thomas Graichen - <email>graichen@omega.physik.fu-berlin.de</email></para> - </listitem> - - <listitem> - <para>Thomas König - <email>Thomas.Koenig@ciw.uni-karlsruhe.de</email></para> - </listitem> - - <listitem> - <para>Thomas Ptacek <email>unknown</email></para> - </listitem> - - <listitem> - <para>Thomas A. Stephens <email>tas@stephens.org</email></para> - </listitem> - - <listitem> - <para>Thomas Stromberg <email>tstrombe@rtci.com</email></para> - </listitem> - - <listitem> - <para>Thomas Valentino Crimi - <email>tcrimi+@andrew.cmu.edu</email></para> - </listitem> - - <listitem> - <para>Thomas Wintergerst <email>thomas@lemur.nord.de</email></para> - </listitem> - - <listitem> - <para>Þórður Ívarsson - <email>totii@est.is</email></para> - </listitem> - - <listitem> - <para>Tim Kientzle <email>kientzle@netcom.com</email></para> - </listitem> - - <listitem> - <para>Tim Singletary - <email>tsingle@sunland.gsfc.nasa.gov</email></para> - </listitem> - - <listitem> - <para>Tim Wilkinson <email>tim@sarc.city.ac.uk</email></para> - </listitem> - - <listitem> - <para>Timo J. Rinne <email>tri@iki.fi</email></para> - </listitem> - - <listitem> - <para>Todd Miller <email>millert@openbsd.org</email></para> - </listitem> - - <listitem> - <para>Tom <email>root@majestix.cmr.no</email></para> - </listitem> - - <listitem> - <para>Tom <email>tom@sdf.com</email></para> - </listitem> - - <listitem> - <para>Tom Gray - DCA <email>dcasba@rain.org</email></para> - </listitem> - - <listitem> - <para>Tom Jobbins <email>tom@tom.tj</email></para> - </listitem> - - <listitem> - <para>Tom Pusateri <email>pusateri@juniper.net</email></para> - </listitem> - - <listitem> - <para>Tom Rush <email>tarush@mindspring.com</email></para> - </listitem> - - <listitem> - <para>Tom Samplonius <email>tom@misery.sdf.com</email></para> - </listitem> - - <listitem> - <para>Tomohiko Kurahashi - <email>kura@melchior.q.t.u-tokyo.ac.jp</email></para> - </listitem> - - <listitem> - <para>Tony Kimball <email>alk@Think.COM</email></para> - </listitem> - - <listitem> - <para>Tony Li <email>tli@jnx.com</email></para> - </listitem> - - <listitem> - <para>Tony Lynn <email>wing@cc.nsysu.edu.tw</email></para> - </listitem> - - <listitem> - <para>Tony Maher <email>tonym@angis.org.au</email></para> - </listitem> - - <listitem> - <para>Torbjorn Granlund <email>tege@matematik.su.se</email></para> - </listitem> - - <listitem> - <para>Toshihiko ARAI <email>toshi@tenchi.ne.jp</email></para> - </listitem> - - <listitem> - <para>Toshihiko SHIMOKAWA <email>toshi@tea.forus.or.jp</email></para> - </listitem> - - <listitem> - <para>Toshihiro Kanda <email>candy@kgc.co.jp</email></para> - </listitem> - - <listitem> - <para>Toshiomi Moriki - <email>Toshiomi.Moriki@ma1.seikyou.ne.jp</email></para> - </listitem> - - <listitem> - <para>Trefor S. <email>trefor@flevel.co.uk</email></para> - </listitem> - - <listitem> - <para>Trevor Blackwell <email>tlb@viaweb.com</email></para> - </listitem> - - <listitem> - <para>URATA Shuichiro <email>s-urata@nmit.tmg.nec.co.jp</email></para> - </listitem> - - <listitem> - <para>Udo Schweigert <email>ust@cert.siemens.de</email></para> - </listitem> - - <listitem> - <para>Ugo Paternostro <email>paterno@dsi.unifi.it</email></para> - </listitem> - - <listitem> - <para>Ulf Kieber <email>kieber@sax.de</email></para> - </listitem> - - <listitem> - <para>Ulli Linzen <email>ulli@perceval.camelot.de</email></para> - </listitem> - - <listitem> - <para>Ustimenko Semen <email>semen@iclub.nsu.ru</email></para> - </listitem> - - <listitem> - <para>Uwe Arndt <email>arndt@mailhost.uni-koblenz.de</email></para> - </listitem> - - <listitem> - <para>Vadim Chekan <email>vadim@gc.lviv.ua</email></para> - </listitem> - - <listitem> - <para>Vadim Kolontsov <email>vadim@tversu.ac.ru</email></para> - </listitem> - - <listitem> - <para>Vadim Mikhailov <email>mvp@braz.ru</email></para> - </listitem> - - <listitem> - <para>Van Jacobson <email>van@ee.lbl.gov</email></para> - </listitem> - - <listitem> - <para>Vasily V. Grechishnikov - <email>bazilio@ns1.ied-vorstu.ac.ru</email></para> - </listitem> - - <listitem> - <para>Vasim Valejev <email>vasim@uddias.diaspro.com</email></para> - </listitem> - - <listitem> - <para>Vernon J. Schryver <email>vjs@mica.denver.sgi.com</email></para> - </listitem> - - <listitem> - <para>Vic Abell <email>abe@cc.purdue.edu</email></para> - </listitem> - - <listitem> - <para>Ville Eerola <email>ve@sci.fi</email></para> - </listitem> - - <listitem> - <para>Vincent Poy <email>vince@venus.gaianet.net</email></para> - </listitem> - - <listitem> - <para>Vincenzo Capuano - <email>VCAPUANO@vmprofs.esoc.esa.de</email></para> - </listitem> - - <listitem> - <para>Virgil Champlin <email>champlin@pa.dec.com</email></para> - </listitem> - - <listitem> - <para>Vladimir A. Jakovenko - <email>vovik@ntu-kpi.kiev.ua</email></para> - </listitem> - - <listitem> - <para>Vladimir Kushnir <email>kushn@mail.kar.net</email></para> - </listitem> - - <listitem> - <para>Vsevolod Lobko <email>seva@alex-ua.com</email></para> - </listitem> - - <listitem> - <para>W. Gerald Hicks <email>wghicks@bellsouth.net</email></para> - </listitem> - - <listitem> - <para>W. Richard Stevens <email>rstevens@noao.edu</email></para> - </listitem> - - <listitem> - <para>Walt Howard <email>howard@ee.utah.edu</email></para> - </listitem> - - <listitem> - <para>Warren Toomey <email>wkt@csadfa.cs.adfa.oz.au</email></para> - </listitem> - - <listitem> - <para>Wayne Scott <email>wscott@ichips.intel.com</email></para> - </listitem> - - <listitem> - <para>Werner Griessl - <email>werner@btp1da.phy.uni-bayreuth.de</email></para> - </listitem> - - <listitem> - <para>Wes Santee <email>wsantee@wsantee.oz.net</email></para> - </listitem> - - <listitem> - <para>Wietse Venema <email>wietse@wzv.win.tue.nl</email></para> - </listitem> - - <listitem> - <para>Wilfredo Sanchez <email>wsanchez@apple.com</email></para> - </listitem> - - <listitem> - <para>Wiljo Heinen <email>wiljo@freeside.ki.open.de</email></para> - </listitem> - - <listitem> - <para>Wilko Bulte <email>wilko@yedi.iaf.nl</email></para> - </listitem> - - <listitem> - <para>Will Andrews <email>andrews@technologist.com</email></para> - </listitem> - - <listitem> - <para>Willem Jan Withagen <email>wjw@surf.IAE.nl</email></para> - </listitem> - - <listitem> - <para>William Jolitz <email>withheld</email></para> - </listitem> - - <listitem> - <para>William Liao <email>william@tale.net</email></para> - </listitem> - - <listitem> - <para>Wojtek Pilorz - <email>wpilorz@celebris.bdk.lublin.pl</email></para> - </listitem> - - <listitem> - <para>Wolfgang Helbig <email>helbig@ba-stuttgart.de</email></para> - </listitem> - - <listitem> - <para>Wolfgang Solfrank <email>ws@tools.de</email></para> - </listitem> - - <listitem> - <para>Wolfgang Stanglmeier <email>wolf@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Wu Ching-hong <email>woju@FreeBSD.ee.Ntu.edu.TW</email></para> - </listitem> - - <listitem> - <para>Yarema <email>yds@ingress.com</email></para> - </listitem> - - <listitem> - <para>Yaroslav Terletsky <email>ts@polynet.lviv.ua</email></para> - </listitem> - - <listitem> - <para>Yasuhito FUTATSUKI <email>futatuki@fureai.or.jp</email></para> - </listitem> - - <listitem> - <para>Yasuhiro Fukama <email>yasuf@big.or.jp</email></para> - </listitem> - - <listitem> - <para>Yen-Shuo Su <email>yssu@CCCA.NCTU.edu.tw</email></para> - </listitem> - - <listitem> - <para>Ying-Chieh Liao <email>ijliao@csie.NCTU.edu.tw</email></para> - </listitem> - - <listitem> - <para>Yixin Jin <email>yjin@rain.cs.ucla.edu</email></para> - </listitem> - - <listitem> - <para>Yoshiaki Uchikawa <email>yoshiaki@kt.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Yoshihiko OHTA <email>yohta@bres.tsukuba.ac.jp</email></para> - </listitem> - - <listitem> - <para>Yoshihisa NAKAGAWA - <email>y-nakaga@ccs.mt.nec.co.jp</email></para> - </listitem> - - <listitem> - <para>Yoshikazu Goto <email>gotoh@ae.anritsu.co.jp</email></para> - </listitem> - - <listitem> - <para>Yoshimasa Ohnishi - <email>ohnishi@isc.kyutech.ac.jp</email></para> - </listitem> - - <listitem> - <para>Yoshishige Arai <email>ryo2@on.rim.or.jp</email></para> - </listitem> - - <listitem> - <para>Yuichi MATSUTAKA <email>matutaka@osa.att.ne.jp</email></para> - </listitem> - - <listitem> - <para>Yujiro MIYATA - <email>miyata@bioele.nuee.nagoya-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Yukihiro Nakai <email>nacai@iname.com</email></para> - </listitem> - - <listitem> - <para>Yusuke Nawano <email>azuki@azkey.org</email></para> - </listitem> - - <listitem> - <para>Yuu Yashiki <email>s974123@cc.matsuyama-u.ac.jp</email></para> - </listitem> - - <listitem> - <para>Yuval Yarom <email>yval@cs.huji.ac.il</email></para> - </listitem> - - <listitem> - <para>Yves Fonk <email>yves@cpcoup5.tn.tudelft.nl</email></para> - </listitem> - - <listitem> - <para>Yves Fonk <email>yves@dutncp8.tn.tudelft.nl</email></para> - </listitem> - - <listitem> - <para>Zach Heilig <email>zach@gaffaneys.com</email></para> - </listitem> - - <listitem> - <para>Zahemszhky Gabor <email>zgabor@code.hu</email></para> - </listitem> - - <listitem> - <para>Zhong Ming-Xun <email>zmx@mail.CDPA.nsysu.edu.tw</email></para> - </listitem> - - <listitem> - <para>arci <email>vega@sophia.inria.fr</email></para> - </listitem> - - <listitem> - <para>der Mouse <email>mouse@Collatz.McRCIM.McGill.EDU</email></para> - </listitem> - - <listitem> - <para>frf <email>frf@xocolatl.com</email></para> - </listitem> - - <listitem> - <para>Ege Rekk <email>aagero@aage.priv.no</email></para> - </listitem> - </itemizedlist> - </sect1> - - <sect1> - <title>386BSD Patch Kit Patch Contributors</title> - - <para>(in alphabetical order by first name):</para> - - <itemizedlist> - <listitem> - <para>Adam Glass <email>glass@postgres.berkeley.edu</email></para> - </listitem> - - <listitem> - <para>Adrian Hall <email>adrian@ibmpcug.co.uk</email></para> - </listitem> - - <listitem> - <para>Andrey A. Chernov <email>ache@astral.msk.su</email></para> - </listitem> - - <listitem> - <para>Andrew Herbert <email>andrew@werple.apana.org.au</email></para> - </listitem> - - <listitem> - <para>Andrew Moore <email>alm@netcom.com</email></para> - </listitem> - - <listitem> - <para>Andy Valencia <email>ajv@csd.mot.com</email> - <email>jtk@netcom.com</email></para> - </listitem> - - <listitem> - <para>Arne Henrik Juul <email>arnej@Lise.Unit.NO</email></para> - </listitem> - - <listitem> - <para>Bakul Shah <email>bvs@bitblocks.com</email></para> - </listitem> - - <listitem> - <para>Barry Lustig <email>barry@ictv.com</email></para> - </listitem> - - <listitem> - <para>Bob Wilcox <email>bob@obiwan.uucp</email></para> - </listitem> - - <listitem> - <para>Branko Lankester</para> - </listitem> - - <listitem> - <para>Brett Lymn <email>blymn@mulga.awadi.com.AU</email></para> - </listitem> - - <listitem> - <para>Charles Hannum <email>mycroft@ai.mit.edu</email></para> - </listitem> - - <listitem> - <para>Chris G. Demetriou - <email>cgd@postgres.berkeley.edu</email></para> - </listitem> - - <listitem> - <para>Chris Torek <email>torek@ee.lbl.gov</email></para> - </listitem> - - <listitem> - <para>Christoph Robitschko - <email>chmr@edvz.tu-graz.ac.at</email></para> - </listitem> - - <listitem> - <para>Daniel Poirot <email>poirot@aio.jsc.nasa.gov</email></para> - </listitem> - - <listitem> - <para>Dave Burgess <email>burgess@hrd769.brooks.af.mil</email></para> - </listitem> - - <listitem> - <para>Dave Rivers <email>rivers@ponds.uucp</email></para> - </listitem> - - <listitem> - <para>David Dawes <email>dawes@physics.su.OZ.AU</email></para> - </listitem> - - <listitem> - <para>David Greenman <email>dg@Root.COM</email></para> - </listitem> - - <listitem> - <para>Eric J. Haug <email>ejh@slustl.slu.edu</email></para> - </listitem> - - <listitem> - <para>Felix Gaehtgens - <email>felix@escape.vsse.in-berlin.de</email></para> - </listitem> - - <listitem> - <para>Frank Maclachlan <email>fpm@crash.cts.com</email></para> - </listitem> - - <listitem> - <para>Gary A. Browning <email>gab10@griffcd.amdahl.com</email></para> - </listitem> - - <listitem> - <para>Gary Howland <email>gary@hotlava.com</email></para> - </listitem> - - <listitem> - <para>Geoff Rehmet <email>csgr@alpha.ru.ac.za</email></para> - </listitem> - - <listitem> - <para>Goran Hammarback <email>goran@astro.uu.se</email></para> - </listitem> - - <listitem> - <para>Guido van Rooij <email>guido@gvr.org</email></para> - </listitem> - - <listitem> - <para>Guy Harris <email>guy@auspex.com</email></para> - </listitem> - - <listitem> - <para>Havard Eidnes - <email>Havard.Eidnes@runit.sintef.no</email></para> - </listitem> - - <listitem> - <para>Herb Peyerl <email>hpeyerl@novatel.cuc.ab.ca</email></para> - </listitem> - - <listitem> - <para>Holger Veit <email>Holger.Veit@gmd.de</email></para> - </listitem> - - <listitem> - <para>Ishii Masahiro, R. Kym Horsell</para> - </listitem> - - <listitem> - <para>J.T. Conklin <email>jtc@cygnus.com</email></para> - </listitem> - - <listitem> - <para>Jagane D Sundar <email>jagane@netcom.com</email></para> - </listitem> - - <listitem> - <para>James Clark <email>jjc@jclark.com</email></para> - </listitem> - - <listitem> - <para>James Jegers <email>jimj@miller.cs.uwm.edu</email></para> - </listitem> - - <listitem> - <para>James W. Dolter</para> - </listitem> - - <listitem> - <para>James da Silva <email>jds@cs.umd.edu</email> et al</para> - </listitem> - - <listitem> - <para>Jay Fenlason <email>hack@datacube.com</email></para> - </listitem> - - <listitem> - <para>Jim Wilson <email>wilson@moria.cygnus.com</email></para> - </listitem> - - <listitem> - <para>Jörg Lohse - <email>lohse@tech7.informatik.uni-hamburg.de</email></para> - </listitem> - - <listitem> - <para>Jörg Wunsch - <email>joerg_wunsch@uriah.heep.sax.de</email></para> - </listitem> - - <listitem> - <para>John Dyson</para> - </listitem> - - <listitem> - <para>John Woods <email>jfw@eddie.mit.edu</email></para> - </listitem> - - <listitem> - <para>Jordan K. Hubbard <email>jkh@whisker.hubbard.ie</email></para> - </listitem> - - <listitem> - <para>Julian Elischer <email>julian@dialix.oz.au</email></para> - </listitem> - - <listitem> - <para>Julian Stacey <email>jhs@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Karl Dietz <email>Karl.Dietz@triplan.com</email></para> - </listitem> - - <listitem> - <para>Karl Lehenbauer <email>karl@NeoSoft.com</email> - <email>karl@one.neosoft.com</email></para> - </listitem> - - <listitem> - <para>Keith Bostic <email>bostic@toe.CS.Berkeley.EDU</email></para> - </listitem> - - <listitem> - <para>Ken Hughes</para> - </listitem> - - <listitem> - <para>Kent Talarico <email>kent@shipwreck.tsoft.net</email></para> - </listitem> - - <listitem> - <para>Kevin Lahey <email>kml%rokkaku.UUCP@mathcs.emory.edu</email> - <email>kml@mosquito.cis.ufl.edu</email></para> - </listitem> - - <listitem> - <para>Marc Frajola <email>marc@dev.com</email></para> - </listitem> - - <listitem> - <para>Mark Tinguely <email>tinguely@plains.nodak.edu</email> - <email>tinguely@hookie.cs.ndsu.NoDak.edu</email></para> - </listitem> - - <listitem> - <para>Martin Renters <email>martin@tdc.on.ca</email></para> - </listitem> - - <listitem> - <para>Michael Clay <email>mclay@weareb.org</email></para> - </listitem> - - <listitem> - <para>Michael Galassi <email>nerd@percival.rain.com</email></para> - </listitem> - - <listitem> - <para>Mike Durkin <email>mdurkin@tsoft.sf-bay.org</email></para> - </listitem> - - <listitem> - <para>Naoki Hamada <email>nao@tom-yam.or.jp</email></para> - </listitem> - - <listitem> - <para>Nate Williams <email>nate@bsd.coe.montana.edu</email></para> - </listitem> - - <listitem> - <para>Nick Handel <email>nhandel@NeoSoft.com</email> - <email>nick@madhouse.neosoft.com</email></para> - </listitem> - - <listitem> - <para>Pace Willisson <email>pace@blitz.com</email></para> - </listitem> - - <listitem> - <para>Paul Kranenburg <email>pk@cs.few.eur.nl</email></para> - </listitem> - - <listitem> - <para>Paul Mackerras <email>paulus@cs.anu.edu.au</email></para> - </listitem> - - <listitem> - <para>Paul Popelka <email>paulp@uts.amdahl.com</email></para> - </listitem> - - <listitem> - <para>Peter da Silva <email>peter@NeoSoft.com</email></para> - </listitem> - - <listitem> - <para>Phil Sutherland - <email>philsuth@mycroft.dialix.oz.au</email></para> - </listitem> - - <listitem> - <para>Poul-Henning Kamp<email>phk@FreeBSD.org</email></para> - </listitem> - - <listitem> - <para>Ralf Friedl <email>friedl@informatik.uni-kl.de</email></para> - </listitem> - - <listitem> - <para>Rick Macklem <email>root@snowhite.cis.uoguelph.ca</email></para> - </listitem> - - <listitem> - <para>Robert D. Thrush <email>rd@phoenix.aii.com</email></para> - </listitem> - - <listitem> - <para>Rodney W. Grimes <email>rgrimes@cdrom.com</email></para> - </listitem> - - <listitem> - <para>Sascha Wildner <email>swildner@channelz.GUN.de</email></para> - </listitem> - - <listitem> - <para>Scott Burris <email>scott@pita.cns.ucla.edu</email></para> - </listitem> - - <listitem> - <para>Scott Reynolds <email>scott@clmqt.marquette.mi.us</email></para> - </listitem> - - <listitem> - <para>Sean Eric Fagan <email>sef@kithrup.com</email></para> - </listitem> - - <listitem> - <para>Simon J Gerraty <email>sjg@melb.bull.oz.au</email> - <email>sjg@zen.void.oz.au</email></para> - </listitem> - - <listitem> - <para>Stephen McKay <email>syssgm@devetir.qld.gov.au</email></para> - </listitem> - - <listitem> - <para>Terry Lambert <email>terry@icarus.weber.edu</email></para> - </listitem> - - <listitem> - <para>Terry Lee <email>terry@uivlsi.csl.uiuc.edu</email></para> - </listitem> - - <listitem> - <para>Tor Egge <email>Tor.Egge@idi.ntnu.no</email></para> - </listitem> - - <listitem> - <para>Warren Toomey <email>wkt@csadfa.cs.adfa.oz.au</email></para> - </listitem> - - <listitem> - <para>Wiljo Heinen <email>wiljo@freeside.ki.open.de</email></para> - </listitem> - - <listitem> - <para>William Jolitz <email>withheld</email></para> - </listitem> - - <listitem> - <para>Wolfgang Solfrank <email>ws@tools.de</email></para> - </listitem> - - <listitem> - <para>Wolfgang Stanglmeier <email>wolf@dentaro.GUN.de</email></para> - </listitem> - - <listitem> - <para>Yuval Yarom <email>yval@cs.huji.ac.il</email></para> - </listitem> - </itemizedlist> - </sect1> -</chapter> - -<!-- - Local Variables: - mode: sgml - sgml-declaration: "../chapter.decl" - sgml-indent-data: t - sgml-omittag: nil - sgml-always-quote-attributes: t - sgml-parent-document: ("../handbook.sgml" "part" "chapter") - End: ---> - diff --git a/en_US.ISO8859-1/books/porters-handbook/book.sgml b/en_US.ISO8859-1/books/porters-handbook/book.sgml index e95a44b758..625217f419 100644 --- a/en_US.ISO8859-1/books/porters-handbook/book.sgml +++ b/en_US.ISO8859-1/books/porters-handbook/book.sgml @@ -1,12 +1,20 @@ <!-- The FreeBSD Documentation Project - $FreeBSD$ + $FreeBSD: doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v 1.163 2001/08/29 17:31:24 tom Exp $ --> <!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [ -<!ENTITY % books.ent PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Books Entity Set//EN"> -%books.ent; +<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"> +%man; + +<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//EN"> +%bookinfo; + +<!ENTITY % authors PUBLIC "-//FreeBSD//ENTITIES DocBook Author Entities//EN"> %authors; +<!ENTITY % mailing-lists PUBLIC "-//FreeBSD//ENTITIES DocBook Mailing List Entities//EN"> +%mailing-lists; + ]> <book> @@ -21,64 +29,41 @@ <copyright> <year>2000</year> - <year>2001</year> - <year>2002</year> - <year>2003</year> - <year>2004</year> - <year>2005</year> - <year>2006</year> <holder role="mailto:doc@FreeBSD.org">The FreeBSD Documentation Project</holder> </copyright> - &bookinfo.trademarks; - &bookinfo.legalnotice; </bookinfo> - <chapter id="why-port"> - <title>Introduction</title> - - <para>The FreeBSD ports collection is the way almost everyone - installs applications ("ports") on FreeBSD. Like everything - else about FreeBSD, it is primarily a volunteer effort. - It is important to keep this in mind when reading this - document.</para> - - <para>In FreeBSD, anyone may submit a new port, or volunteer - to maintain an existing port if it is unmaintained—you - do not need any special commit privileges to do so.</para> - </chapter> - - <chapter id="own-port"> + <chapter> <title>Making a port yourself</title> - <para>So, you are interested in making your own port or - upgrading an existing one? Great!</para> + <para>So, now you are interested in making your own port or + upgrading an existing one? Great!</para> <para>What follows are some guidelines for creating a new port for - FreeBSD. If you want to upgrade an existing port, you should + FreeBSD. If you want to upgrade an existing port, you should read this and then read <xref linkend="port-upgrading">.</para> <para>When this document is not sufficiently detailed, you should - refer to <filename>/usr/ports/Mk/bsd.port.mk</filename>, which + refer to <filename>/usr/ports/Mk/bsd.port.mk</filename>, which all port Makefiles include. Even if you do not hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Additionally, you may send specific questions to the &a.ports;.</para> <note> - <para>Only a fraction of the variables - (<makevar><replaceable>VAR</replaceable></makevar>) that can be - overridden are mentioned in this document. Most (if not all) - are documented at the start of <filename>/usr/ports/Mk/bsd.port.mk</filename>; - the others probably ought to be. - Note that this file uses a non-standard tab setting: + <para>Only a fraction of the variables + (<makevar><replaceable>VAR</replaceable></makevar>) that can be + overridden are mentioned in this document. Most (if not all) + are documented at the start of <filename>bsd.port.mk</filename>. + This file uses a non-standard tab setting. <application>Emacs</application> and <application>Vim</application> should recognize the setting on - loading the file. Both &man.vi.1; and - &man.ex.1; can be set to use the correct value by + loading the file. Both <command>vi</command> and + <command>ex</command> can be set to use the correct value by typing <command>:set tabstop=4</command> once the file has been loaded.</para> </note> @@ -88,27 +73,26 @@ <title>Quick Porting</title> <para>This section tells you how to do a quick port. In many cases, it - is not sufficient, so you will have to read further on into - the document.</para> + is not enough, but we will see.</para> <para>First, get the original tarball and put it into - <makevar>DISTDIR</makevar>, which defaults to - <filename>/usr/ports/distfiles</filename>.</para> + <makevar>DISTDIR</makevar>, which defaults to + <filename>/usr/ports/distfiles</filename>.</para> <note> - <para>The following assumes that the software compiled out-of-the-box, - i.e., there was absolutely no change required for the port to work - on your FreeBSD box. If you needed to change something, you will - have to refer to the next section too.</para> + <para>The following assumes that the software compiled out-of-the-box, + i.e., there was absolutely no change required for the port to work + on your FreeBSD box. If you needed to change something, you will + have to refer to the next section too.</para> </note> - <sect1 id="porting-makefile"> - <title>Writing the <filename>Makefile</filename></title> + <sect1> + <title>Writing the <filename>Makefile</filename></title> - <para>The minimal <filename>Makefile</filename> would look something - like this:</para> + <para>The minimal <filename>Makefile</filename> would look something + like this:</para> - <programlisting># New ports collection makefile for: oneko + <programlisting># New ports collection makefile for: oneko # Date created: 5 December 1994 # Whom: asami # @@ -121,7 +105,6 @@ CATEGORIES= games MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/ MAINTAINER= asami@FreeBSD.org -COMMENT= A cat chasing a mouse all over the screen MAN1= oneko.1 MANCOMPRESSED= yes @@ -129,630 +112,547 @@ USE_IMAKE= yes .include <bsd.port.mk></programlisting> - <para>See if you can figure it out. Do not worry about the contents - of the <literal>$FreeBSD$</literal> line, it will be - filled in automatically by CVS when the port is imported to our main - ports tree. You can find a more detailed example in the <link - linkend="porting-samplem">sample Makefile</link> section.</para> + <para>See if you can figure it out. Do not worry about the contents + of the <literal>$FreeBSD$</literal> line, it will be + filled in automatically by CVS when the port is imported to our main + ports tree. You can find a more detailed example in the <link + linkend="porting-samplem">sample Makefile</link> section.</para> </sect1> - <sect1 id="porting-desc"> - <title>Writing the description files</title> + <sect1> + <title>Writing the description files</title> + + <para>There are three description files that are required for + any port, whether they actually package or not. They are + <filename>pkg-comment</filename>, + <filename>pkg-descr</filename>, and + <filename>pkg-plist</filename>, and their + <filename>pkg-</filename> prefix distinguishes them from + other files.</para> + + <sect2> + <title><filename>pkg-comment</filename></title> + + <para>This is the one-line description of the port. + <emphasis>Please</emphasis> do not include the package name (or + version number of the software) in the comment. The comment + should begin with a capital, and end without a period. Here + is an example:</para> + + <programlisting>A cat chasing a mouse all over the screen</programlisting> + </sect2> + + <sect2> + <title><filename>pkg-descr</filename></title> + + <para>This is a longer description of the port. One to a few + paragraphs concisely explaining what the port does is + sufficient.</para> + + <note> + <para>This is <emphasis>not</emphasis> a manual or an in-depth + description on how to use or compile the port! <emphasis>Please + be careful if you are copying from the + <filename>README</filename> or manpage</emphasis>; too often + they are not a concise description of the port or are in an + awkward format (e.g., manpages have justified spacing). If the + ported software has an official WWW homepage, you should list it + here. Prefix <emphasis>one</emphasis> of the websites with + <literal>WWW:</literal> so that automated tools will work + correctly.</para> + </note> + + <para>It is recommended that you sign your name at the end of this + file, as in:</para> + + <programlisting>This is a port of oneko, in which a cat chases a poor mouse all over +the screen. + : +(etc.) - <para>There are two description files that are required for - any port, whether they actually package or not. They are - <filename>pkg-descr</filename> and - <filename>pkg-plist</filename>. Their - <filename>pkg-</filename> prefix distinguishes them from - other files.</para> +WWW: http://www.oneko.org/ - <sect2> - <title><filename>pkg-descr</filename></title> - - <para>This is a longer description of the port. One to a few - paragraphs concisely explaining what the port does is - sufficient.</para> - - <note> - <para>This is <emphasis>not</emphasis> a manual or an in-depth - description on how to use or compile the port! <emphasis>Please - be careful if you are copying from the - <filename>README</filename> or manpage</emphasis>; too often - they are not a concise description of the port or are in an - awkward format (e.g., manpages have justified spacing). If the - ported software has an official WWW homepage, you should list it - here. Prefix <emphasis>one</emphasis> of the websites with - <literal>WWW:</literal> so that automated tools will work - correctly.</para> - </note> +- Satoshi +asami@cs.berkeley.edu</programlisting> + </sect2> - <para>The following example shows how your - <filename>pkg-descr</filename> should look:</para> + <sect2> + <title><filename>pkg-plist</filename></title> - <programlisting>This is a port of oneko, in which a cat chases a poor mouse all over -the screen. - : -(etc.) + <para>This file lists all the files installed by the port. It is + also called the “packing list” because the package is + generated by packing the files listed here. The pathnames are + relative to the installation prefix (usually + <filename>/usr/local</filename> or + <filename>/usr/X11R6</filename>). If you are using the + <makevar>MAN<replaceable>n</replaceable></makevar> variables (as + you should be), do not list any manpages here.</para> -WWW: http://www.oneko.org/</programlisting> - </sect2> + <para>Here is a small example:</para> - <sect2> - <title><filename>pkg-plist</filename></title> - - <para>This file lists all the files installed by the port. It is - also called the <quote>packing list</quote> because the package is - generated by packing the files listed here. The pathnames are - relative to the installation prefix (usually - <filename>/usr/local</filename> or - <filename>/usr/X11R6</filename>). If you are using the - <makevar>MAN<replaceable>n</replaceable></makevar> variables (as - you should be), do not list any manpages here. If the port creates - directories during installation, make sure to add - <literal>@dirrm</literal> lines to remove them when the package is - deleted.</para> - - <para>Here is a small example:</para> - - <programlisting>bin/oneko + <programlisting>bin/oneko lib/X11/app-defaults/Oneko lib/X11/oneko/cat1.xpm lib/X11/oneko/cat2.xpm lib/X11/oneko/mouse.xpm @dirrm lib/X11/oneko</programlisting> - <para>Refer to the &man.pkg.create.1; manual page for details on the - packing list.</para> - - <note> - <para>It is recommended that you keep all the filenames in this - file sorted alphabetically. It will make verifying the changes - when you upgrade the port much easier.</para> - </note> - - <note> - <para>Creating a packing list manually can be a very tedious - task. If the port installs a large numbers of files, <link - linkend="plist-autoplist">creating the packing list - automatically</link> might save time.</para> - </note> - - <para>There is only one case when <filename>pkg-plist</filename> - can be omitted from a port. If the port installs just a handful - of files, and perhaps directories, the files and directories may - be listed in the variables <makevar>PLIST_FILES</makevar> and - <makevar>PLIST_DIRS</makevar>, respectively, within the port's - <filename>Makefile</filename>. For instance, we could get along - without <filename>pkg-plist</filename> in the above - <filename>oneko</filename> port by adding the - following lines to the <filename>Makefile</filename>:</para> - - <programlisting>PLIST_FILES= bin/oneko \ - lib/X11/app-defaults/Oneko \ - lib/X11/oneko/cat1.xpm \ - lib/X11/oneko/cat2.xpm \ - lib/X11/oneko/mouse.xpm -PLIST_DIRS= lib/X11/oneko</programlisting> - - <para>Of course, <makevar>PLIST_DIRS</makevar> should be left - unset if a port installs no directories of its own.</para> - - <para>The price for this way of listing port's files and - directories is that you cannot use command sequences - described in &man.pkg.create.1;. Therefore, it is suitable - only for simple ports and makes them even simpler. At the - same time, it has the advantage of reducing the number of files - in the ports collection. Please consider using this technique - before you resort to <filename>pkg-plist</filename>.</para> - - <para>Later we will see how <filename>pkg-plist</filename> - and <makevar>PLIST_FILES</makevar> can be used to fulfil - <link linkend="plist">more sophisticated - tasks</link>.</para> - </sect2> + <para>Refer to the &man.pkg.create.1; man page for details on the + packing list.</para> + + <note> + <para>You should list all the files, but not the name directories, + in the list. Also, if the port creates directories for itself + during installation, make sure to add <literal>@dirrm</literal> + lines as necessary to remove them when the port is + deleted.</para> + + <para>It is recommended that you keep all the filenames in this + file sorted alphabetically. It will make verifying the changes + when you upgrade the port much easier.</para> + + <para>Creating a packing list manually can be a very tedious + task. If the port installs a large numbers of files, <link + linkend="porting-autoplist">creating the packing list + automatically</link> might save time.</para> + </note> + </sect2> </sect1> - <sect1 id="porting-checksum"> - <title>Creating the checksum file</title> + <sect1> + <title>Creating the checksum file</title> - <para>Just type <command>make makesum</command>. The ports make rules - will automatically generate the file - <filename>distinfo</filename>.</para> - - <para>If a file fetched has its checksum changed regularly and you are - certain the source is trusted (i.e. it comes from manufacturer CDs - or documentation generated daily), you should specify these files in - the <makevar>IGNOREFILES</makevar> variable. - Then the checksum is not calculated for that file when you run - <command>make makesum</command>, but set to - <literal>IGNORE</literal>.</para> + <para>Just type <command>make makesum</command>. The ports make rules + will automatically generate the file + <filename>distinfo</filename>.</para> </sect1> <sect1 id="porting-testing"> - <title>Testing the port</title> - - <para>You should make sure that the port rules do exactly what you - want them to do, including packaging up the port. These are the - important points you need to verify.</para> - - <itemizedlist> - <listitem> - <para><filename>pkg-plist</filename> does not contain anything not - installed by your port</para> - </listitem> - - <listitem> - <para><filename>pkg-plist</filename> contains everything that is - installed by your port</para> - </listitem> - - <listitem> - <para>Your port can be installed multiple times using the - <maketarget>reinstall</maketarget> target</para> - </listitem> - - <listitem> - <para>Your port <link linkend="plist-cleaning">cleans up</link> - after itself upon deinstall</para> - </listitem> - </itemizedlist> - - <procedure> - <title>Recommended test ordering</title> - - <step> - <para><command>make install</command></para> - </step> - - <step> - <para><command>make package</command></para> - </step> - - <step> - <para><command>make deinstall</command></para> - </step> - - <step> - <para><command>pkg_add <replaceable>package-name</replaceable> - </command></para> - </step> - - <step> - <para><command>make deinstall</command></para> - </step> - - <step> - <para><command>make reinstall</command></para> - </step> - - <step> - <para><command>make package</command></para> - </step> - </procedure> - - <para>Make sure that there are not any warnings issued in any of the - <maketarget>package</maketarget> and - <maketarget>deinstall</maketarget> stages. After step 3, check to - see if all the new directories are correctly deleted. Also, try - using the software after step 4, to ensure that it works correctly - when installed from a package.</para> + <title>Testing the port</title> + + <para>You should make sure that the port rules do exactly what you + want them to do, including packaging up the port. These are the + important points you need to verify.</para> + + <itemizedlist> + <listitem> + <para><filename>pkg-plist</filename> does not contain anything not + installed by your port</para> + </listitem> + + <listitem> + <para><filename>pkg-plist</filename> contains everything that is + installed by your port</para> + </listitem> + + <listitem> + <para>Your port can be installed multiple times using the + <maketarget>reinstall</maketarget> target</para> + </listitem> + + <listitem> + <para>Your port <link linkend="porting-cleaning">cleans up</link> + after itself upon deinstall</para> + </listitem> + </itemizedlist> + + <procedure> + <title>Recommended test ordering</title> + + <step> + <para><command>make install</command></para> + </step> + + <step> + <para><command>make package</command></para> + </step> + + <step> + <para><command>make deinstall</command></para> + </step> + + <step> + <para><command>pkg_add <replaceable>package-name</replaceable> + </command></para> + </step> + + <step> + <para><command>make deinstall</command></para> + </step> + + <step> + <para><command>make reinstall</command></para> + </step> + + <step> + <para><command>make package</command></para> + </step> + </procedure> + + <para>Make sure that there are not any warnings issued in any of the + <maketarget>package</maketarget> and + <maketarget>deinstall</maketarget> stages. After step 3, check to + see if all the new directories are correctly deleted. Also, try + using the software after step 4, to ensure that it works correctly + when installed from a package.</para> </sect1> <sect1 id="porting-portlint"> - <title>Checking your port with <command>portlint</command></title> - - <para>Please use <command>portlint</command> to see if your port - conforms to our guidelines. The <filename role="package"> - devel/portlint</filename> program is part of the ports collection. - In particular, you may want to check if the - <link linkend="porting-samplem">Makefile</link> is in the right - shape and the <link linkend="porting-pkgname">package</link> is named - appropriately.</para> + <title>Checking your port with <command>portlint</command></title> + + <para>Please use <command>portlint</command> to see if your port + conforms to our guidelines. The <command>portlint</command> program + is part of the ports collection. In particular, you may want to + check if the <link linkend="porting-samplem">Makefile</link> is in + the right shape and the <link + linkend="porting-pkgname">package</link> is named + appropriately.</para> </sect1> <sect1 id="porting-submitting"> - <title>Submitting the port</title> - - <para>First, make sure you have read the <link - linkend="porting-dads">DOs and DON'Ts</link> section.</para> - - <para>Now that you are happy with your port, the only thing remaining - is to put it in the main FreeBSD ports tree and make everybody else - happy about it too. We do not need your <filename>work</filename> - directory or the <filename>pkgname.tgz</filename> package, so delete - them now. Next, simply include the output of <command>shar `find - port_dir`</command> in a bug report and send it with the - &man.send-pr.1; program (see <ulink url="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug - Reports and General Commentary</ulink> for more information about - &man.send-pr.1;). Be sure to classify the bug report as category - <literal>ports</literal> and class - <literal>change-request</literal> (Do not mark the report - <literal>confidential</literal>!). - Also add a short description of the program you ported - to the <quote>Description</quote> field of the PR and - the shar to the <quote>Fix</quote> field.</para> - - <note> - <para>You can make our work a lot easier, if you use a good - description in the synopsis of the problem report. - We prefer something like - <quote>New port: <category>/<portname> - <short description of the port></quote> for new ports and - <quote>Update port: <category>/<portname> - <short description of the update></quote> for port updates. - If you stick to this scheme, the chance that someone will take a - look at your PR soon is much better.</para> - </note> - - <para>One more time, <emphasis>do not include the original source - distfile, the <filename>work</filename> directory, or the package - you built with <command>make package</command></emphasis>.</para> - - <para>After you have submitted your port, please be patient. - Sometimes it can take a few months before a port is included - in FreeBSD, although it might only take a few days. You can - view the list of <ulink - url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports">ports - waiting to be committed to FreeBSD</ulink>.</para> - - <para>Once we have looked at your port, we will get back to you if necessary, and put - it in the tree. Your name will also appear in the list of - <ulink url="&url.articles.contributors;/contrib-additional.html">Additional FreeBSD Contributors</ulink> - and other files. Isn't that great?!? <!-- smiley - -->:-)</para> + <title>Submitting the port</title> + + <para>First, make sure you have read the <link + linkend="porting-dads">DOs and DON'Ts</link> section.</para> + + <para>Now that you are happy with your port, the only thing remaining + is to put it in the main FreeBSD ports tree and make everybody else + happy about it too. We do not need your <filename>work</filename> + directory or the <filename>pkgname.tgz</filename> package, so delete + them now. Next, simply include the output of <command>shar `find + port_dir`</command> in a bug report and send it with the + &man.send-pr.1; program (see <ulink url="../handbook/contrib-how.html#CONTRIB-GENERAL">Bug + Reports and General Commentary</ulink> for more information about + &man.send-pr.1;. If the uncompressed port is larger than 20KB, + you should compress it into a tarfile and use &man.uuencode.1; + before including it in the bug report (uuencoded tarfiles are + acceptable even if the bug report is smaller than 20KB but are not + preferred). Be sure to classify the bug report as category + <literal>ports</literal> and class + <literal>change-request</literal> (Do not mark the report + <literal>confidential</literal>!). + Also add a short description of the program you ported + to the <quote>Description</quote> field of the PR and + the shar or uuencoded tarfile to the + <quote>Fix</quote> field. The latter one helps the committers + a lot, who use scripts for the ports-work.</para> + + <para>One more time, <emphasis>do not include the original source + distfile, the <filename>work</filename> directory, or the package + you built with <command>make package</command></emphasis>.</para> + + <note> + <para>In the past, we asked you to upload new port submissions in + our FTP site (<hostid role="fqdn">ftp.FreeBSD.org</hostid>). This + is no longer recommended as read access is turned off on the + <filename>incoming/</filename> directory of that site due to the + large amount of pirated software showing up there.</para> + </note> + + <para>We will look at your port, get back to you if necessary, and put + it in the tree. Your name will also appear in the list of + “Additional FreeBSD contributors” in the FreeBSD + Handbook and other files. Isn't that great?!? <!-- smiley + -->:-)</para> + + <note> + <para>You can make our work a lot easier, if you use a good + description in the synopsis of the problem report. + We prefer something like + “New port: <short description of the port>” for + new ports and + “Update port: <category>/<port> <short description + of the update>” for port updates. + If you stick to this scheme, the chance that one takes a look at + your PR soon is much bigger.</para> + </note> </sect1> </chapter> - <chapter id="slow"> + <chapter> <title>Slow Porting</title> <para>Ok, so it was not that simple, and the port required some - modifications to get it to work. In this section, we will explain, - step by step, how to modify it to get it to work with the ports - paradigm.</para> - - <sect1 id="slow-work"> - <title>How things work</title> - - <para>First, this is the sequence of events which occurs when the user - first types <command>make</command> in your port's directory. - You may find that having <filename>bsd.port.mk</filename> in another - window while you read this really helps to understand it.</para> - - <para>But do not worry if you do not really understand what - <filename>bsd.port.mk</filename> is doing, not many people do... - <!-- smiley --><emphasis>:-></emphasis></para> - - <procedure> - - <step> - <para>The <maketarget>fetch</maketarget> target is run. The - <maketarget>fetch</maketarget> target is responsible for making - sure that the tarball exists locally in - <makevar>DISTDIR</makevar>. If <maketarget>fetch</maketarget> - cannot find the required files in <makevar>DISTDIR</makevar> it - will look up the URL <makevar>MASTER_SITES</makevar>, which is - set in the Makefile, as well as our main FTP site at <ulink - url="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/"></ulink>, - where we put sanctioned distfiles as backup. It will then - attempt to fetch the named distribution file with - <makevar>FETCH</makevar>, assuming that the requesting site has - direct access to the Internet. If that succeeds, it will save - the file in <makevar>DISTDIR</makevar> for future use and - proceed.</para> - </step> - - <step> - <para>The <maketarget>extract</maketarget> target is run. It - looks for your port's distribution file (typically a gzip'd - tarball) in <makevar>DISTDIR</makevar> and unpacks it into a - temporary subdirectory specified by <makevar>WRKDIR</makevar> - (defaults to <filename>work</filename>).</para> - </step> - - <step> - <para>The <maketarget>patch</maketarget> target is run. First, - any patches defined in <makevar>PATCHFILES</makevar> are - applied. Second, if any patch files named - <filename>patch-<replaceable>*</replaceable></filename> are found in - <makevar>PATCHDIR</makevar> (defaults to the - <filename>files</filename> subdirectory), they are applied at - this time in alphabetical order.</para> - </step> - - <step> - <para>The <maketarget>configure</maketarget> target is run. This - can do any one of many different things.</para> - - <orderedlist> - <listitem> - <para>If it exists, <filename>scripts/configure</filename> is - run.</para> - </listitem> - - <listitem> - <para>If <makevar>HAS_CONFIGURE</makevar> or - <makevar>GNU_CONFIGURE</makevar> is set, - <filename><makevar>WRKSRC</makevar>/configure</filename> is - run.</para> - </listitem> - - <listitem> - <para>If <makevar>USE_IMAKE</makevar> is set, - <makevar>XMKMF</makevar> (default: <command>xmkmf - -a</command>) is run.</para> - </listitem> - </orderedlist> - </step> - - <step> - <para>The <maketarget>build</maketarget> target is run. This is - responsible for descending into the port's private working - directory (<makevar>WRKSRC</makevar>) and building it. If - <makevar>USE_GMAKE</makevar> is set, GNU <command>make</command> - will be used, otherwise the system <command>make</command> will - be used.</para> - </step> - </procedure> - - <para>The above are the default actions. In addition, you can define - targets - <maketarget>pre-<replaceable>something</replaceable></maketarget> or - <maketarget>post-<replaceable>something</replaceable></maketarget>, - or put scripts with those names, in the <filename>scripts</filename> - subdirectory, and they will be run before or after the default - actions are done.</para> - - <para>For example, if you have a <maketarget>post-extract</maketarget> - target defined in your <filename>Makefile</filename>, and a file - <filename>pre-build</filename> in the <filename>scripts</filename> - subdirectory, the <maketarget>post-extract</maketarget> target will - be called after the regular extraction actions, and the - <filename>pre-build</filename> script will be executed before the - default build rules are done. It is recommended that you use - <filename>Makefile</filename> targets if the actions are simple - enough, because it will be easier for someone to figure out what - kind of non-default action the port requires.</para> - - <para>The default actions are done by the - <filename>bsd.port.mk</filename> targets - <maketarget>do-<replaceable>something</replaceable></maketarget>. - For example, the commands to extract a port are in the target - <maketarget>do-extract</maketarget>. If you are not happy with the - default target, you can fix it by redefining the - <maketarget>do-<replaceable>something</replaceable></maketarget> - target in your <filename>Makefile</filename>.</para> - - <note> - <para>The <quote>main</quote> targets (e.g., - <maketarget>extract</maketarget>, - <maketarget>configure</maketarget>, etc.) do nothing more than - make sure all the stages up to that one are completed and call - the real targets or scripts, and they are not intended to be - changed. If you want to fix the extraction, fix - <maketarget>do-extract</maketarget>, but never ever change - the way <maketarget>extract</maketarget> operates!</para> - </note> - - <para>Now that you understand what goes on when the user types - <command>make</command>, let us go through the recommended steps to - create the perfect port.</para> + modifications to get it to work. In this section, we will explain, + step by step, how to modify it to get it to work with the ports + paradigm.</para> + + <sect1> + <title>How things work</title> + + <para>First, this is the sequence of events which occurs when the user + first types <command>make</command> in your port's directory. + You may find that having <filename>bsd.port.mk</filename> in another + window while you read this really helps to understand it.</para> + + <para>But do not worry if you do not really understand what + <filename>bsd.port.mk</filename> is doing, not many people do... + <!-- smiley --><emphasis>:-></emphasis></para> + + <procedure> + + <step> + <para>The <maketarget>fetch</maketarget> target is run. The + <maketarget>fetch</maketarget> target is responsible for making + sure that the tarball exists locally in + <makevar>DISTDIR</makevar>. If <maketarget>fetch</maketarget> + cannot find the required files in <makevar>DISTDIR</makevar> it + will look up the URL <makevar>MASTER_SITES</makevar>, which is + set in the Makefile, as well as our main FTP site at <ulink + url="ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/">ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/</ulink>, + where we put sanctioned distfiles as backup. It will then + attempt to fetch the named distribution file with + <makevar>FETCH</makevar>, assuming that the requesting site has + direct access to the Internet. If that succeeds, it will save + the file in <makevar>DISTDIR</makevar> for future use and + proceed.</para> + </step> + + <step> + <para>The <maketarget>extract</maketarget> target is run. It + looks for your port's distribution file (typically a gzip'd + tarball) in <makevar>DISTDIR</makevar> and unpacks it into a + temporary subdirectory specified by <makevar>WRKDIR</makevar> + (defaults to <filename>work</filename>).</para> + </step> + + <step> + <para>The <maketarget>patch</maketarget> target is run. First, + any patches defined in <makevar>PATCHFILES</makevar> are + applied. Second, if any patch files named + <filename>patch-<replaceable>*</replaceable></filename> are found in + <makevar>PATCHDIR</makevar> (defaults to the + <filename>files</filename> subdirectory), they are applied at + this time in alphabetical order.</para> + </step> + + <step> + <para>The <maketarget>configure</maketarget> target is run. This + can do any one of many different things.</para> + + <orderedlist> + <listitem> + <para>If it exists, <filename>scripts/configure</filename> is + run.</para> + </listitem> + + <listitem> + <para>If <makevar>HAS_CONFIGURE</makevar> or + <makevar>GNU_CONFIGURE</makevar> is set, + <filename><makevar>WRKSRC</makevar>/configure</filename> is + run.</para> + </listitem> + + <listitem> + <para>If <makevar>USE_IMAKE</makevar> is set, + <makevar>XMKMF</makevar> (default: <command>xmkmf + -a</command>) is run.</para> + </listitem> + </orderedlist> + </step> + + <step> + <para>The <maketarget>build</maketarget> target is run. This is + responsible for descending into the port's private working + directory (<makevar>WRKSRC</makevar>) and building it. If + <makevar>USE_GMAKE</makevar> is set, GNU <command>make</command> + will be used, otherwise the system <command>make</command> will + be used.</para> + </step> + </procedure> + + <para>The above are the default actions. In addition, you can define + targets + <maketarget>pre-<replaceable>something</replaceable></maketarget> or + <maketarget>post-<replaceable>something</replaceable></maketarget>, + or put scripts with those names, in the <filename>scripts</filename> + subdirectory, and they will be run before or after the default + actions are done.</para> + + <para>For example, if you have a <maketarget>post-extract</maketarget> + target defined in your Makefile, and a file + <filename>pre-build</filename> in the <filename>scripts</filename> + subdirectory, the <maketarget>post-extract</maketarget> target will + be called after the regular extraction actions, and the + <filename>pre-build</filename> script will be executed before the + default build rules are done. It is recommended that you use + <filename>Makefile</filename> targets if the actions are simple + enough, because it will be easier for someone to figure out what + kind of non-default action the port requires.</para> + + <para>The default actions are done by the + <filename>bsd.port.mk</filename> targets + <maketarget>do-<replaceable>something</replaceable></maketarget>. + For example, the commands to extract a port are in the target + <maketarget>do-extract</maketarget>. If you are not happy with the + default target, you can fix it by redefining the + <maketarget>do-<replaceable>something</replaceable></maketarget> + target in your <filename>Makefile</filename>.</para> + + <note> + <para>The “main” targets (e.g., + <maketarget>extract</maketarget>, + <maketarget>configure</maketarget>, etc.) do nothing more than + make sure all the stages up to that one are completed and call + the real targets or scripts, and they are not intended to be + changed. If you want to fix the extraction, fix + <maketarget>do-extract</maketarget>, but never ever touch + <maketarget>extract</maketarget>!</para> + </note> + + <para>Now that you understand what goes on when the user types + <command>make</command>, let us go through the recommended steps to + create the perfect port.</para> </sect1> - <sect1 id="slow-sources"> - <title>Getting the original sources</title> - - <para>Get the original sources (normally) as a compressed tarball - (<filename><replaceable>foo</replaceable>.tar.gz</filename> or - <filename><replaceable>foo</replaceable>.tar.Z</filename>) and copy - it into <makevar>DISTDIR</makevar>. Always use - <emphasis>mainstream</emphasis> sources when and where you - can.</para> - - <para>You will need to set the variable <makevar>MASTER_SITES</makevar> - to reflect where the original tarball resides. You will find - convenient shorthand definitions for most mainstream sites - in <filename>bsd.sites.mk</filename>. Please use these - sites—and the associated definitions—if - at all possible, to help avoid the problem of having the same - information repeated over again many times in the source base. - As these sites tend to change over time, this becomes a - maintenance nightmare for everyone involved.</para> - - <para>If you cannot find a FTP/HTTP site that is well-connected to the - net, or can only find sites that have irritatingly non-standard - formats, you might want to put a copy on a reliable FTP or HTTP - server that you control (e.g., your home page).</para> - - <para>If you cannot find somewhere convenient and reliable to put the - distfile - we can <quote>house</quote> it ourselves - on <hostid>ftp.FreeBSD.org</hostid>; however, this is the - least-preferred solution. - The distfile must be placed into - <filename>~/public_distfiles/</filename> of someone's - <hostid>freefall</hostid> account. - Ask the person who commits your port to do this. - This person will also set <makevar>MASTER_SITES</makevar> to - <makevar>MASTER_SITE_LOCAL</makevar> and - <makevar>MASTER_SITE_SUBDIR</makevar> to their - <hostid>freefall</hostid> username.</para> - - <para>If your port's distfile changes all the time without any - kind of version update by the author, - consider putting the distfile on your home page and listing it as - the first <makevar>MASTER_SITES</makevar>. If you can, try - to talk the port author out of doing this; it - really does help to establish some kind of source code control. - Hosting your own version will prevent users - from getting <errorname>checksum mismatch</errorname> errors, and - also reduce the workload of maintainers of our FTP site. Also, if - there is only one master site for the port, it is recommended that - you house a backup at your site and list it as the second - <makevar>MASTER_SITES</makevar>.</para> - - <para>If your port requires some additional `patches' that are - available on the Internet, fetch them too and put them in - <makevar>DISTDIR</makevar>. Do not worry if they come from a site - other than where you got the main source tarball, we have a way to - handle these situations (see the description of <link - linkend="porting-patchfiles">PATCHFILES</link> below).</para> + <sect1> + <title>Getting the original sources</title> + + <para>Get the original sources (normally) as a compressed tarball + (<filename><replaceable>foo</replaceable>.tar.gz</filename> or + <filename><replaceable>foo</replaceable>.tar.Z</filename>) and copy + it into <makevar>DISTDIR</makevar>. Always use + <emphasis>mainstream</emphasis> sources when and where you + can.</para> + + <para>If you cannot find a FTP/http site that is well-connected to the + net, or can only find sites that have irritatingly non-standard + formats, you might want to put a copy on a reliable FTP or http + server that you control (e.g., your home page). Make sure you set + <makevar>MASTER_SITES</makevar> to reflect your choice.</para> + + <para>If you cannot find somewhere convenient and reliable to put the + distfile + we can “house” it ourselves + on <hostid>ftp.FreeBSD.org</hostid>. + The distfile must be placed into + <filename>~/public_distfiles/</filename> of someone's + <hostid>freefall</hostid> account. + Ask the person who commits your port to do this. + This person will also set <makevar>MASTER_SITES</makevar> to + <makevar>MASTER_SITE_LOCAL</makevar> and + <makevar>MASTER_SITE_SUBDIR</makevar> to their + <hostid>freefall</hostid> username.</para> + + <para>If your port's distfile changes all the time for no good reason, + consider putting the distfile in your home page and listing it as + the first <makevar>MASTER_SITES</makevar>. This will prevent users + from getting <errorname>checksum mismatch</errorname> errors, and + also reduce the workload of maintainers of our FTP site. Also, if + there is only one master site for the port, it is recommended that + you house a backup at your site and list it as the second + <makevar>MASTER_SITES</makevar>.</para> + + <para>If your port requires some additional `patches' that are + available on the Internet, fetch them too and put them in + <makevar>DISTDIR</makevar>. Do not worry if they come from a site + other than where you got the main source tarball, we have a way to + handle these situations (see the description of <link + linkend="porting-patchfiles">PATCHFILES</link> below).</para> </sect1> - <sect1 id="slow-modifying"> - <title>Modifying the port</title> - - <para>Unpack a copy of the tarball in a private directory and make - whatever changes are necessary to get the port to compile properly - under the current version of FreeBSD. Keep <emphasis>careful - track</emphasis> of everything you do, as you will be automating - the process shortly. Everything, including the deletion, addition, - or modification of files should be doable using an automated script - or patch file when your port is finished.</para> - - <para>If your port requires significant user interaction/customization - to compile or install, you should take a look at one of Larry Wall's - classic <application>Configure</application> scripts and perhaps do - something similar yourself. The goal of the new ports collection is - to make each port as <quote>plug-and-play</quote> as possible for the - end-user while using a minimum of disk space.</para> - - <note> - <para>Unless explicitly stated, patch files, scripts, and other - files you have created and contributed to the FreeBSD ports - collection are assumed to be covered by the standard BSD copyright - conditions.</para> - </note> + <sect1> + <title>Modifying the port</title> + + <para>Unpack a copy of the tarball in a private directory and make + whatever changes are necessary to get the port to compile properly + under the current version of FreeBSD. Keep <emphasis>careful + track</emphasis> of everything you do, as you will be automating + the process shortly. Everything, including the deletion, addition, + or modification of files should be doable using an automated script + or patch file when your port is finished.</para> + + <para>If your port requires significant user interaction/customization + to compile or install, you should take a look at one of Larry Wall's + classic <application>Configure</application> scripts and perhaps do + something similar yourself. The goal of the new ports collection is + to make each port as “plug-and-play” as possible for the + end-user while using a minimum of disk space.</para> + + <note> + <para>Unless explicitly stated, patch files, scripts, and other + files you have created and contributed to the FreeBSD ports + collection are assumed to be covered by the standard BSD copyright + conditions.</para> + </note> </sect1> - <sect1 id="slow-patch"> - <title>Patching</title> - - <para>In the preparation of the port, files that have been added or - changed can be picked up with a &man.diff.1; - for later feeding to &man.patch.1;. Each patch you - wish to apply should be saved into a file named - <filename>patch-<replaceable>*</replaceable></filename> where - <replaceable>*</replaceable> indicates - the pathname of the file that is patched, - such as <filename>patch-Imakefile</filename> or - <filename>patch-src-config.h</filename>. These files should - be stored in <makevar>PATCHDIR</makevar> - (usually <filename>files/</filename>, from where they will be - automatically applied. All patches must be relative to - <makevar>WRKSRC</makevar> (generally the directory your port's - tarball unpacks itself into, that being where the build is done). - To make fixes and upgrades easier, you should avoid having more than - one patch fix the same file (e.g., <filename>patch-file</filename> and - <filename>patch-file2</filename> both changing - <filename><makevar>WRKSRC</makevar>/foobar.c</filename>).</para> - - <para>Please only use characters <literal>[-+._a-zA-Z0-9]</literal> for - naming your patches. Do not use any other characters besides them. - Do not name your patches like <filename>patch-aa</filename> or - <filename>patch-ab</filename> etc, always mention path and file name - in patch names.</para> - - <para>Do not put RCS strings in patches. CVS will mangle them when we - put the files into the ports tree, and when we check them out again, - they will come out different and the patch will fail. RCS strings - are surrounded by dollar (<literal>$</literal>) signs, and - typically start with <literal>$Id</literal> or - <literal>$RCS</literal>.</para> - - <para>Using the recurse (<option>-r</option>) option to - &man.diff.1; to generate patches is fine, but please take - a look at the resulting patches to make sure you do not have any - unnecessary junk in there. In particular, diffs between two backup - files, <filename>Makefile</filename>s when the port uses - <command>Imake</command> or GNU <command>configure</command>, etc., - are unnecessary and should be deleted. If you had to edit - <filename>configure.in</filename> and run - <command>autoconf</command> to regenerate - <command>configure</command>, do not take the diffs of - <command>configure</command> (it often grows to a few thousand - lines!); define <literal>USE_AUTOTOOLS=autoconf:253</literal> and take the - diffs of <filename>configure.in</filename>.</para> - - <para>If you had to delete a file, then you can do it in the - <maketarget>post-extract</maketarget> target rather than as part of - the patch.</para> - - <para>Simple replacements can be performed directly from the port - <filename>Makefile</filename> using the in-place mode of - &man.sed.1;. This is very useful when you need to patch in - a variable value. Example:</para> - - <programlisting>post-patch: - @${REINPLACE_CMD} -e 's|for Linux|for FreeBSD|g' ${WRKSRC}/README - @${REINPLACE_CMD} -e 's|-pthread|${PTHREAD_LIBS}|' ${WRKSRC}/configure</programlisting> - - <para>Quite often, there is a situation when the software being - ported, especially if it is primarily developed on &windows;, uses - the CR/LF convention for most of its source files. This may cause - problems with further patching, compiler warnings, scripts - execution (<command>/bin/sh^M</command> not found), etc. To - quickly convert all files from CR/LF to just LF, add - <literal>USE_DOS2UNIX=yes</literal> to the port - <filename>Makefile</filename>. A list of files to convert can - be specified:</para> - - <programlisting>USE_DOS2UNIX= util.c util.h</programlisting> + <sect1> + <title>Patching</title> + + <para>In the preparation of the port, files that have been added or + changed can be picked up with a recursive diff for later feeding to + patch. Each set of patches you wish to apply should be collected + into a file named + <filename>patch-<replaceable>*</replaceable></filename> where + <replaceable>*</replaceable> denotes the sequence in which the + patches will be applied — these are done in + <emphasis>alphabetical order</emphasis>, thus <literal>aa</literal> + first, <literal>ab</literal> second and so on. If you wish, + you can use names that indicate the pathnames of the files that + are patched, such as <filename>patch-Imakefile</filename> or + <filename>patch-src-config.h</filename>. These files should + be stored in <makevar>PATCHDIR</makevar>, from where they will be + automatically applied. All patches should be relative to + <makevar>WRKSRC</makevar> (generally the directory your port's + tarball unpacks itself into, that being where the build is done). + To make fixes and upgrades easier, you should avoid having more than + one patch fix the same file (e.g., <filename>patch-aa</filename> and + <filename>patch-ab</filename> both changing + <filename><makevar>WRKSRC</makevar>/foobar.c</filename>).</para> </sect1> - <sect1 id="slow-configure"> - <title>Configuring</title> + <sect1> + <title>Configuring</title> - <para>Include any additional customization commands in your - <filename>configure</filename> script and save it in the - <filename>scripts</filename> subdirectory. As mentioned above, you - can also do this with <filename>Makefile</filename> targets and/or - scripts with the name <filename>pre-configure</filename> or - <filename>post-configure</filename>.</para> + <para>Include any additional customization commands in your + <filename>configure</filename> script and save it in the + <filename>scripts</filename> subdirectory. As mentioned above, you + can also do this with <filename>Makefile</filename> targets and/or + scripts with the name <filename>pre-configure</filename> or + <filename>post-configure</filename>.</para> </sect1> - <sect1 id="slow-user-input"> - <title>Handling user input</title> - - <para>If your port requires user input to build, configure, or install, - you must set <makevar>IS_INTERACTIVE</makevar> in your <filename>Makefile</filename>. This - will allow <quote>overnight builds</quote> to skip your port if the - user sets the variable <envar>BATCH</envar> in his environment (and - if the user sets the variable <envar>INTERACTIVE</envar>, then - <emphasis>only</emphasis> those ports requiring interaction are - built). This will save a lot of wasted time on the set of - machines that continually build ports (see below).</para> - - <para>It is also recommended that if there are reasonable default - answers to the questions, you check the - <makevar>PACKAGE_BUILDING</makevar> variable and turn off the - interactive script when it is set. This will allow us to build the - packages for CDROMs and FTP.</para> + <sect1> + <title>Handling user input</title> + + <para>If your port requires user input to build, configure, or install, + then set <makevar>IS_INTERACTIVE</makevar> in your Makefile. This + will allow “overnight builds” to skip your port if the + user sets the variable <envar>BATCH</envar> in his environment (and + if the user sets the variable <envar>INTERACTIVE</envar>, then + <emphasis>only</emphasis> those ports requiring interaction are + built).</para> + + <para>It is also recommended that if there are reasonable default + answers to the questions, you check the + <makevar>PACKAGE_BUILDING</makevar> variable and turn off the + interactive script when it is set. This will allow us to build the + packages for CDROMs and FTP.</para> </sect1> </chapter> - <chapter id="makefile"> + <chapter> <title>Configuring the Makefile</title> - <para>Configuring the <filename>Makefile</filename> is pretty simple, and again we suggest - that you look at existing examples before starting. Also, there is a - <link linkend="porting-samplem">sample Makefile</link> in this - handbook, so take a look and please follow the ordering of variables - and sections in that template to make your port easier for others to - read.</para> + <para>Configuring the Makefile is pretty simple, and again we suggest + that you look at existing examples before starting. Also, there is a + <link linkend="porting-samplem">sample Makefile</link> in this + handbook, so take a look and please follow the ordering of variables + and sections in that template to make your port easier for others to + read.</para> <para>Now, consider the following problems in sequence as you design - your new <filename>Makefile</filename>:</para> + your new Makefile:</para> - <sect1 id="makefile-source"> - <title>The original source</title> + <sect1> + <title>The original source</title> - <para>Does it live in <makevar>DISTDIR</makevar> as a standard + <para>Does it live in <makevar>DISTDIR</makevar> as a standard gzip'd tarball named something like <filename>foozolix-1.2.tar.gz</filename>? If so, you can go on to the next step. If not, you should look at overriding any of - the <makevar>DISTVERSION</makevar>, <makevar>DISTNAME</makevar>, - <makevar>EXTRACT_CMD</makevar>, + the <makevar>DISTNAME</makevar>, <makevar>EXTRACT_CMD</makevar>, <makevar>EXTRACT_BEFORE_ARGS</makevar>, <makevar>EXTRACT_AFTER_ARGS</makevar>, <makevar>EXTRACT_SUFX</makevar>, or <makevar>DISTFILES</makevar> @@ -762,32 +662,25 @@ PLIST_DIRS= lib/X11/oneko</programlisting> condensed by regular <command>compress</command>, not <command>gzip</command>.)</para> - <para>In the worst case, you can simply create your own + <para>In the worst case, you can simply create your own <maketarget>do-extract</maketarget> target to override the default, though this should be rarely, if ever, necessary.</para> </sect1> - <sect1 id="makefile-naming"> - <title>Naming</title> - - <para>The first part of the port's <filename>Makefile</filename> names - the port, describes its version number, and lists it in the correct - category.</para> - - <sect2> - <title><makevar>PORTNAME</makevar> and <makevar>PORTVERSION</makevar></title> + <sect1> + <title><makevar>PORTNAME</makevar> and <makevar>PORTVERSION</makevar></title> - <para>You should set <makevar>PORTNAME</makevar> to the - base name of your port, and <makevar>PORTVERSION</makevar> - to the version number of the port.</para> - </sect2> + <para>You should set <makevar>PORTNAME</makevar> to the + base name of your port, and <makevar>PORTVERSION</makevar> + to the version number of the port.</para> + </sect1> - <sect2 id="makefile-naming-revepoch"> + <sect1> <title><makevar>PORTREVISION</makevar> and <makevar>PORTEPOCH</makevar></title> - <sect3> + <sect2> <title><makevar>PORTREVISION</makevar></title> <para>The <makevar>PORTREVISION</makevar> variable is a @@ -795,34 +688,28 @@ PLIST_DIRS= lib/X11/oneko</programlisting> every increase of <makevar>PORTVERSION</makevar> (i.e. every time a new official vendor release is made), and appended to the package name if non-zero. - Changes to <makevar>PORTREVISION</makevar> are - used by automated tools (e.g. &man.pkg.version.1;) - to highlight the fact that a new package is - available.</para> - - <para><makevar>PORTREVISION</makevar> should be increased - each time a change is made to the port which significantly - affects the content or structure of the derived + <makevar>PORTREVISION</makevar> is increased each time a + change is made to the FreeBSD port which significantly + affects the content or stucture of the derived package.</para> - <para>Examples of when <makevar>PORTREVISION</makevar> - should be bumped:</para> + <para>Examples of when PORTREVISION should be bumped:</para> <itemizedlist> <listitem> <para>Addition of patches to correct security vulnerabilities, bugs, or to add new functionality to - the port.</para> + the FreeBSD port.</para> </listitem> <listitem> - <para>Changes to the port <filename>Makefile</filename> to enable or disable + <para>Changes to the port makefile to enable or disable compile-time options in the package.</para> </listitem> <listitem> <para>Changes in the packing list or the install-time - behavior of the package (e.g. change to a script + behaviour of the package (e.g. change to a script which generates initial data for the package, like ssh host keys).</para> </listitem> @@ -859,7 +746,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting> <listitem> <para>Changes to <makevar>MASTER_SITES</makevar> or other functional changes to the port which do not - affect the resulting package.</para> + effect the resulting package.</para> </listitem> <listitem> @@ -875,7 +762,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting> the changes do not introduce any functional change on any other platforms on which the port did previously build). Since <makevar>PORTREVISION</makevar> reflects - the content of the package, if the package was not + the content of the package, if no package was previously buildable then there is no need to increase <makevar>PORTREVISION</makevar> to mark a change.</para> @@ -883,16 +770,17 @@ PLIST_DIRS= lib/X11/oneko</programlisting> </itemizedlist> <para>A rule of thumb is to ask yourself whether a change - committed to a port is something which everyone + committed to a port is something which someone, somewhere, would benefit from having (either because of an enhancement, fix, or by virtue that the new package will - actually work at all), and weigh that against that fact - that it will cause everyone who regularly updates their - ports tree to be compelled to update. If yes, the - <makevar>PORTREVISION</makevar> should be bumped.</para> - </sect3> + actually work for them). If yes, the + <makevar>PORTREVISION</makevar> should be bumped so that + automated tools (e.g. <command>pkg_version</command>) + will highlight the fact that a new package is + available.</para> + </sect2> - <sect3> + <sect2> <title><makevar>PORTEPOCH</makevar></title> <para>From time to time a software vendor or FreeBSD porter @@ -907,7 +795,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting> <makevar>PORTEPOCH</makevar> version should be increased. If <makevar>PORTEPOCH</makevar> is nonzero it is appended to the package name as described in section 0 above. - <makevar>PORTEPOCH</makevar> must never be decreased or reset + <makevar>PORTEPOCH</makevar> is never decreased or reset to zero, because that would cause comparison to a package from an earlier epoch to fail (i.e. the package would not be detected as out of date): the new version number (e.g. @@ -915,13 +803,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting> numerically less than the previous version (20000801), but the <literal>,1</literal> suffix is treated specially by automated tools and found to be greater than the implied - suffix <literal>,0</literal> on the earlier package.</para> - - <para>Dropping or resetting <makevar>PORTEPOCH</makevar> - incorrectly leads - to no end of grief; if you do not understand the above discussion, - please keep after it until you do, or ask questions on - the mailing lists.</para> + suffix ",0" on the earlier package.</para> <para>It is expected that <makevar>PORTEPOCH</makevar> will not be used for the majority of ports, and that sensible @@ -929,10 +811,10 @@ PLIST_DIRS= lib/X11/oneko</programlisting> it becoming necessary if a future release of the software should change the version structure. However, care is needed by FreeBSD porters when a vendor release is made - without an official version number — such as a code - <quote>snapshot</quote> release. The temptation is to label the + without an official version number - such as a code + "snapshot" release. The temptation is to label the release with the release date, which will cause problems - as in the example above when a new <quote>official</quote> release is + as in the example above when a new "official" release is made.</para> <para>For example, if a snapshot release is made on the date @@ -941,18 +823,17 @@ PLIST_DIRS= lib/X11/oneko</programlisting> <makevar>PORTVERSION</makevar> of 1.2.20000917 or similar, not 20000917, so that the succeeding release, say 1.3, is still a numerically greater value.</para> - </sect3> + </sect2> - <sect3> + <sect2> <title>Example of <makevar>PORTREVISION</makevar> and <makevar>PORTEPOCH</makevar> usage</title> - <para>The <literal>gtkmumble</literal> port, version - <literal>0.10</literal>, is committed to the ports - collection:</para> + <para>The gtkmumble port, version 0.10, is committed to the + ports collection.</para> - <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.10</programlisting> + <programlisting>PORTNAME= gtkmumble +PORTVERSION= 0.10</programlisting> <para><makevar>PKGNAME</makevar> becomes <literal>gtkmumble-0.10</literal>.</para> @@ -961,29 +842,29 @@ PORTVERSION= 0.10</programlisting> FreeBSD patch. <makevar>PORTREVISION</makevar> is bumped accordingly.</para> - <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.10 -PORTREVISION= 1</programlisting> + <programlisting>PORTNAME= gtkmumble +PORTVERSIOn= 0.10 +PORTREVISION= 1</programlisting> <para><makevar>PKGNAME</makevar> becomes <literal>gtkmumble-0.10_1</literal></para> - <para>A new version is released by the vendor, numbered <literal>0.2</literal> + <para>A new version is released by the vendor, numbered 0.2 (it turns out the author actually intended <literal>0.10</literal> to actually mean <literal>0.1.0</literal>, not <quote>what comes after 0.9</quote> - oops, too late now). Since the new minor version <literal>2</literal> is numerically less than the - previous version <literal>10</literal>, the + previous version <literal>10</literal> the <makevar>PORTEPOCH</makevar> must be bumped to manually - force the new package to be detected as <quote>newer</quote>. Since it + force the new package to be detected as "newer". Since it is a new vendor release of the code, <makevar>PORTREVISION</makevar> is reset to 0 (or removed - from the <filename>Makefile</filename>).</para> + from the makefile).</para> - <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.2 -PORTEPOCH= 1</programlisting> + <programlisting>PORTNAME= gtkmumble +PORTVERSION= 0.2 +PORTEPOCH= 1</programlisting> <para><makevar>PKGNAME</makevar> becomes <literal>gtkmumble-0.2,1</literal></para> @@ -991,2518 +872,712 @@ PORTEPOCH= 1</programlisting> <para>The next release is 0.3. Since <makevar>PORTEPOCH</makevar> never decreases, the version variables are now:</para> - - <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.3 -PORTEPOCH= 1</programlisting> + + <programlisting>PORTNAME= gtkmumble +PORTVERSION= 0.3 +PORTEPOCH= 1</programlisting> <para><makevar>PKGNAME</makevar> becomes <literal>gtkmumble-0.3,1</literal></para> - <note> - <para>If <makevar>PORTEPOCH</makevar> were reset - to <literal>0</literal> with this upgrade, someone who had - installed the <literal>gtkmumble-0.10_1</literal> package would not detect - the <literal>gtkmumble-0.3</literal> package as newer, since - <literal>3</literal> is still numerically less than - <literal>10</literal>. Remember, this is the whole point of - <makevar>PORTEPOCH</makevar> in the first place.</para> + <note> + <para>If <makevar>PORTEPOCH</makevar> were reset + to <literal>0</literal> with this upgrade, someone who had + installed the gtkmumble-0.10_1 package would not detect + the gtkmumble-0.3 package as newer, since + <literal>3</literal> is still numerically less than + <literal>10</literal>.</para> </note> - </sect3> - </sect2> + </sect2> + </sect1> - <sect2> - <title><makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar></title> + <sect1> + <title><makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar></title> <para>Two optional variables, <makevar>PKGNAMEPREFIX</makevar> and <makevar>PKGNAMESUFFIX</makevar>, are combined with <makevar>PORTNAME</makevar> and - <makevar>PORTVERSION</makevar> to - form <makevar>PKGNAME</makevar> as - <literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>. - Make sure this conforms to our <link - linkend="porting-pkgname">guidelines for a good package - name</link>. In particular, you are <emphasis>not</emphasis> allowed to use a - hyphen (<literal>-</literal>) in - <makevar>PORTVERSION</makevar>. Also, if the package name - has the <replaceable>language-</replaceable> or the - <replaceable>-compiled.specifics</replaceable> part (see below), use - <makevar>PKGNAMEPREFIX</makevar> and - <makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make - them part of <makevar>PORTNAME</makevar>.</para> - </sect2> - - <sect2 id="porting-pkgname"> - <title>Package Naming Conventions</title> - - <para>The following are the conventions you should follow in naming your - packages. This is to have our package directory easy to scan, as - there are already thousands of packages and users are going to - turn away if they hurt their eyes!</para> - - <para>The package name should look like - <filename><replaceable><optional>language<optional>_region</optional></optional>-name<optional><optional>-</optional>compiled.specifics</optional>-version.numbers</replaceable></filename>.</para> - - <para>The package name is defined as - <literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>. - Make sure to set the variables to conform to that format.</para> - - <orderedlist> - <listitem> - <para>FreeBSD strives to support the native language of its users. - The <replaceable>language-</replaceable> part should be a two - letter abbreviation of the natural language defined by ISO-639 if - the port is specific to a certain language. Examples are - <literal>ja</literal> for Japanese, <literal>ru</literal> for - Russian, <literal>vi</literal> for Vietnamese, - <literal>zh</literal> for Chinese, <literal>ko</literal> for - Korean and <literal>de</literal> for German.</para> - - <para>If the port is specific to a certain region within the - language area, add the two letter country code as well. - Examples are <literal>en_US</literal> for US English and - <literal>fr_CH</literal> for Swiss French.</para> - - <para>The <replaceable>language-</replaceable> part should - be set in the <makevar>PKGNAMEPREFIX</makevar> variable.</para> - </listitem> - - <listitem> - <para>The first letter of <filename>name</filename> part - should be lowercase. (The rest of the name can contain - capital letters, so use your own discretion when you are - converting a software name that has some capital letters in it.) - There is a tradition of naming <literal>perl 5</literal> modules by - prepending <literal>p5-</literal> and converting the double-colon - separator to a hyphen; for example, the - <literal>Data::Dumper</literal> module becomes - <literal>p5-Data-Dumper</literal>. If the software in question - has numbers, hyphens, or underscores in its name, you may include - them as well (like <literal>kinput2</literal>).</para> - </listitem> - - <listitem> - <para>If the port can be built with different <link - linkend="makefile-masterdir">hardcoded defaults</link> (usually - part of the directory name in a family of ports), the - <replaceable>-compiled.specifics</replaceable> part should state - the compiled-in defaults (the hyphen is optional). Examples are - papersize and font units.</para> - - <para>The <replaceable>-compiled.specifics</replaceable> part - should be set in the <makevar>PKGNAMESUFFIX</makevar> - variable.</para> - </listitem> - - <listitem> - <para>The version string should follow a dash - (<literal>-</literal>) and be a period-separated list of - integers and single lowercase alphabetics. In particular, - it is not permissible to have another dash inside the - version string. The only exception is the string - <literal>pl</literal> (meaning <quote>patchlevel</quote>), which can be - used <emphasis>only</emphasis> when there are no major and - minor version numbers in the software. If the software - version has strings like <quote>alpha</quote>, <quote>beta</quote>, <quote>rc</quote>, or <quote>pre</quote>, take - the first letter and put it immediately after a period. - If the version string continues after those names, the - numbers should follow the single alphabet without an extra - period between them.</para> - - <para>The idea is to make it easier to sort ports by looking - at the version string. In particular, make sure version - number components are always delimited by a period, and - if the date is part of the string, use the - <literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> - format, not - <literal><replaceable>dd</replaceable>.<replaceable>mm</replaceable>.<replaceable>yyyy</replaceable></literal> - or the non-Y2K compliant - <literal><replaceable>yy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> - format.</para> - </listitem> - </orderedlist> - - <para>Here are some (real) examples on how to convert the name - as called by the software authors to a suitable package - name:</para> - - <informaltable frame="none" pgwide="1"> - <tgroup cols="6"> - <thead> - <row> - <entry>Distribution Name</entry> - <entry><makevar>PKGNAMEPREFIX</makevar></entry> - <entry><makevar>PORTNAME</makevar></entry> - <entry><makevar>PKGNAMESUFFIX</makevar></entry> - <entry><makevar>PORTVERSION</makevar></entry> - <entry>Reason</entry> - </row> - </thead> - - <tbody> - <row> - <entry>mule-2.2.2</entry> - <entry>(empty)</entry> - <entry>mule</entry> - <entry>(empty)</entry> - <entry>2.2.2</entry> - <entry>No changes required</entry> - </row> - - <row> - <entry>XFree86-3.3.6</entry> - <entry>(empty)</entry> - <entry>XFree86</entry> - <entry>(empty)</entry> - <entry>3.3.6</entry> - <entry>No changes required</entry> - </row> - - <row> - <entry>EmiClock-1.0.2</entry> - <entry>(empty)</entry> - <entry>emiclock</entry> - <entry>(empty)</entry> - <entry>1.0.2</entry> - <entry>No uppercase names for single programs</entry> - </row> - - <row> - <entry>rdist-1.3alpha</entry> - <entry>(empty)</entry> - <entry>rdist</entry> - <entry>(empty)</entry> - <entry>1.3.a</entry> - <entry>No strings like <literal>alpha</literal> - allowed</entry> - </row> - - <row> - <entry>es-0.9-beta1</entry> - <entry>(empty)</entry> - <entry>es</entry> - <entry>(empty)</entry> - <entry>0.9.b1</entry> - <entry>No strings like <literal>beta</literal> - allowed</entry> - </row> - - <row> - <entry>mailman-2.0rc3</entry> - <entry>(empty)</entry> - <entry>mailman</entry> - <entry>(empty)</entry> - <entry>2.0.r3</entry> - <entry>No strings like <literal>rc</literal> - allowed</entry> - </row> - - <row> - <entry>v3.3beta021.src</entry> - <entry>(empty)</entry> - <entry>tiff</entry> - <entry>(empty)</entry> - <entry>3.3</entry> - <entry>What the heck was that anyway?</entry> - </row> - - <row> - <entry>tvtwm</entry> - <entry>(empty)</entry> - <entry>tvtwm</entry> - <entry>(empty)</entry> - <entry>pl11</entry> - <entry>Version string always required</entry> - </row> - - <row> - <entry>piewm</entry> - <entry>(empty)</entry> - <entry>piewm</entry> - <entry>(empty)</entry> - <entry>1.0</entry> - <entry>Version string always required</entry> - </row> - - <row> - <entry>xvgr-2.10pl1</entry> - <entry>(empty)</entry> - <entry>xvgr</entry> - <entry>(empty)</entry> - <entry>2.10.1</entry> - <entry><literal>pl</literal> allowed only when no - major/minor version numbers</entry> - </row> - - <row> - <entry>gawk-2.15.6</entry> - <entry>ja-</entry> - <entry>gawk</entry> - <entry>(empty)</entry> - <entry>2.15.6</entry> - <entry>Japanese language version</entry> - </row> - - <row> - <entry>psutils-1.13</entry> - <entry>(empty)</entry> - <entry>psutils</entry> - <entry>-letter</entry> - <entry>1.13</entry> - <entry>Papersize hardcoded at package build time</entry> - </row> - - <row> - <entry>pkfonts</entry> - <entry>(empty)</entry> - <entry>pkfonts</entry> - <entry>300</entry> - <entry>1.0</entry> - <entry>Package for 300dpi fonts</entry> - </row> - </tbody> - </tgroup> - </informaltable> + <makevar>PORTVERSION</makevar> to + form <makevar>PKGNAME</makevar> as + <literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>. + Make sure this conforms to our <link + linkend="porting-pkgname">guidelines for a good package + name</link>. In particular, you are not allowed to use a + hyphen (<literal>-</literal>) in + <makevar>PORTVERSION</makevar>. Also, if the package name + has the <replaceable>language-</replaceable> or the + <replaceable>compiled.specifics</replaceable> part, use + <makevar>PKGNAMEPREFIX</makevar> and + <makevar>PKGNAMESUFFIX</makevar>, respectively. Do not make + them part of <makevar>PORTNAME</makevar>.</para> + </sect1> - <para>If there is absolutely no trace of version information in the - original source and it is unlikely that the original author will ever - release another version, just set the version string to - <literal>1.0</literal> (like the <literal>piewm</literal> example above). Otherwise, ask - the original author or use the date string - (<literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>) - as the version.</para> - </sect2> - </sect1> - - <sect1 id="makefile-categories"> - <title>Categorization</title> - - <sect2> - <title><makevar>CATEGORIES</makevar></title> - - <para>When a package is created, it is put under - <filename>/usr/ports/packages/All</filename> and links are made from - one or more subdirectories of - <filename>/usr/ports/packages</filename>. The names of these - subdirectories are specified by the variable - <makevar>CATEGORIES</makevar>. It is intended to make life easier - for the user when he is wading through the pile of packages on the - FTP site or the CDROM. Please take a look at the <link - linkend="porting-categories">current list of categories</link> and pick the ones - that are suitable for your port.</para> - - <para>This list also determines where in the ports tree the port is - imported. If you put more than one category here, it is assumed - that the port files will be put in the subdirectory with the name in - the first category. See <link - linkend="choosing-categories">below</link> for more - discussion about how to pick the right categories.</para> - </sect2> - - <sect2 id="porting-categories"> - <title>Current list of categories</title> - - <para>Here is the current list of port categories. Those - marked with an asterisk (<literal>*</literal>) are - <emphasis>virtual</emphasis> categories—those that do not have - a corresponding subdirectory in the ports tree. They are only - used as secondary categories, and only for search purposes.</para> + <sect1> + <title><makevar>DISTNAME</makevar></title> + + <para><makevar>DISTNAME</makevar> is the name of the port as + called by the authors of the software. + <makevar>DISTNAME</makevar> defaults to + <literal>${PORTNAME}-${PORTVERSION}</literal>, so override it if necessary. + <makevar>DISTNAME</makevar> is only used in two places. + First, the distribution file list + (<makevar>DISTFILES</makevar>) defaults to + <makevar>${DISTNAME}</makevar><makevar>${EXTRACT_SUFX}</makevar>. + Second, the distribution file is expected to extract into a + subdirectory named <makevar>WRKSRC</makevar>, which defaults + to <filename>work/<makevar>${DISTNAME}</makevar></filename>.</para> <note> - <para>For non-virtual categories, you will find a one-line - description in the <makevar>COMMENT</makevar> in that - subdirectory's <filename>Makefile</filename>.</para> + <para><makevar>PKGNAMEPREFIX</makevar> and + <makevar>PKGNAMESUFFIX</makevar> do not affect + <makevar>DISTNAME</makevar>. Also note that when + <makevar>WRKSRC</makevar> is equal to + <filename>work/<makevar>${PORTNAME}-${PORTVERSION}</makevar></filename> + while the original source archive is named something other than + <makevar>${PORTNAME}-${PORTVERSION}${EXTRACT_SUFX}</makevar>, + you should probably leave <makevar>DISTNAME</makevar> + alone— you are better off defining + <makevar>DISTFILES</makevar> than having to set both + <makevar>DISTNAME</makevar> and <makevar>WRKSRC</makevar> + (and possibly <makevar>EXTRACT_SUFX</makevar>).</para> </note> + </sect1> - <informaltable frame="none" pgwide="1"> - <tgroup cols="3"> - <thead> - <row> - <entry>Category</entry> - <entry>Description</entry> - <entry>Notes</entry> - </row> - </thead> - - <tbody> - <row> - <entry><filename>accessibility</filename></entry> - <entry>Ports to help disabled users.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>afterstep*</filename></entry> - <entry>Ports to support the - <ulink url="http://www.afterstep.org">AfterStep</ulink> - window manager.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>arabic</filename></entry> - <entry>Arabic language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>archivers</filename></entry> - <entry>Archiving tools.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>astro</filename></entry> - <entry>Astronomical ports.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>audio</filename></entry> - <entry>Sound support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>benchmarks</filename></entry> - <entry>Benchmarking utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>biology</filename></entry> - <entry>Biology-related software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>cad</filename></entry> - <entry>Computer aided design tools.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>chinese</filename></entry> - <entry>Chinese language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>comms</filename></entry> - <entry>Communication software.</entry> - <entry>Mostly software to talk to your serial port.</entry> - </row> - - <row> - <entry><filename>converters</filename></entry> - <entry>Character code converters.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>databases</filename></entry> - <entry>Databases.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>deskutils</filename></entry> - <entry>Things that used to be on the desktop before - computers were invented.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>devel</filename></entry> - <entry>Development utilities.</entry> - <entry>Do not put libraries here just because they are - libraries—unless they truly do not belong anywhere - else, they should not be in this category.</entry> - </row> - - <row> - <entry><filename>dns</filename></entry> - <entry>DNS-related software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>editors</filename></entry> - <entry>General editors.</entry> - <entry>Specialized editors go in the section for those - tools (e.g., a mathematical-formula editor will go - in <filename>math</filename>).</entry> - </row> - - <row> - <entry><filename>elisp*</filename></entry> - <entry>Emacs-lisp ports.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>emulators</filename></entry> - <entry>Emulators for other operating systems.</entry> - <entry>Terminal emulators do <emphasis>not</emphasis> belong - here—X-based ones should go to - <filename>x11</filename> and text-based ones to either - <filename>comms</filename> or <filename>misc</filename>, - depending on the exact functionality.</entry> - </row> - - <row> - <entry><filename>finance</filename></entry> - <entry>Monetary, financial and related applications.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>french</filename></entry> - <entry>French language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>ftp</filename></entry> - <entry>FTP client and server utilities.</entry> - <entry>If your port speaks both FTP and HTTP, put it in - <filename>ftp</filename> with a secondary - category of <filename>www</filename>.</entry> - </row> - - <row> - <entry><filename>games</filename></entry> - <entry>Games.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>german</filename></entry> - <entry>German language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>gnome*</filename></entry> - <entry>Ports from the <ulink - url="http://www.gnome.org">GNOME</ulink> - Project.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>graphics</filename></entry> - <entry>Graphics utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>hamradio*</filename></entry> - <entry>Software for amateur radio.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>haskell*</filename></entry> - <entry>Software related to the Haskell language.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>hebrew</filename></entry> - <entry>Hebrew language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>hungarian</filename></entry> - <entry>Hungarian language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>ipv6*</filename></entry> - <entry>IPv6 related software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>irc</filename></entry> - <entry>Internet Relay Chat utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>japanese</filename></entry> - <entry>Japanese language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>java</filename></entry> - <entry>Software related to the Java language.</entry> - <entry>The <filename>java</filename> category shall not be - the only one for a port. Save for ports directly related to - the Java language, porters are also encouraged not to - use <filename>java</filename> as the main category of a - port.</entry> - </row> - - <row> - <entry><filename>kde*</filename></entry> - <entry>Ports from the <ulink url="http://www.kde.org">K Desktop Environment (KDE)</ulink> - Project.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>korean</filename></entry> - <entry>Korean language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>lang</filename></entry> - <entry>Programming languages.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>linux*</filename></entry> - <entry>Linux applications and support utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>lisp*</filename></entry> - <entry>Software related to the Lisp language.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>mail</filename></entry> - <entry>Mail software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>math</filename></entry> - <entry>Numerical computation software and other utilities - for mathematics.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>mbone</filename></entry> - <entry>MBone applications.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>misc</filename></entry> - <entry>Miscellaneous utilities</entry> - <entry>Basically things that - do not belong anywhere else. - If at all possible, try to - find a better category for your port than - <literal>misc</literal>, as ports tend to get overlooked - in here.</entry> - </row> - - <row> - <entry><filename>multimedia</filename></entry> - <entry>Multimedia software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>net</filename></entry> - <entry>Miscellaneous networking software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>net-im</filename></entry> - <entry>Instant messaging software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>net-mgmt</filename></entry> - <entry>Networking management software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>net-p2p</filename></entry> - <entry>Peer to peer network applications.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>news</filename></entry> - <entry>USENET news software.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>palm</filename></entry> - <entry>Software support for the <ulink url="http://www.palm.com/">Palm™</ulink> series.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>parallel*</filename></entry> - <entry>Applications dealing with parallelism in computing.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>pear*</filename></entry> - <entry>Ports related to the Pear PHP framework.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>perl5*</filename></entry> - <entry>Ports that require <application>Perl</application> version 5 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>plan9*</filename></entry> - <entry>Various programs from <ulink url="http://www.cs.bell-labs.com/plan9dist/">Plan9</ulink>.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>polish</filename></entry> - <entry>Polish language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>portuguese</filename></entry> - <entry>Portuguese language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>print</filename></entry> - <entry>Printing software.</entry> - <entry>Desktop publishing tools - (previewers, etc.) belong here too.</entry> - </row> - - <row> - <entry><filename>python*</filename></entry> - <entry>Software related to the <ulink url="http://www.python.org/">Python</ulink> language.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>ruby*</filename></entry> - <entry>Software related to the <ulink url="http://www.ruby-lang.org/">Ruby</ulink> language.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>rubygems*</filename></entry> - <entry>Ports of <ulink url="http://www.rubygems.org/">RubyGems</ulink> packages.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>russian</filename></entry> - <entry>Russian language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>scheme*</filename></entry> - <entry>Software related to the Scheme language.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>science</filename></entry> - <entry>Scientific ports that do not fit into other - categories such as <filename>astro</filename>, - <filename>biology</filename> and - <filename>math</filename>.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>security</filename></entry> - <entry>Security utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>shells</filename></entry> - <entry>Command line shells.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>sysutils</filename></entry> - <entry>System utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tcl80*</filename></entry> - <entry>Ports that use Tcl version 8.0 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tcl81*</filename></entry> - <entry>Ports that use Tcl version 8.1 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tcl82*</filename></entry> - <entry>Ports that use Tcl version 8.2 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tcl83*</filename></entry> - <entry>Ports that use Tcl version 8.3 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tcl84*</filename></entry> - <entry>Ports that use Tcl version 8.4 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>textproc</filename></entry> - <entry>Text processing utilities.</entry> - <entry>It does not include - desktop publishing tools, which go to <filename>print</filename>.</entry> - </row> - - <row> - <entry><filename>tk80*</filename></entry> - <entry>Ports that use Tk version 8.0 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tk82*</filename></entry> - <entry>Ports that use Tk version 8.2 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tk83*</filename></entry> - <entry>Ports that use Tk version 8.3 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tk84*</filename></entry> - <entry>Ports that use Tk version 8.4 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>tkstep80*</filename></entry> - <entry>Ports that use TkSTEP version 8.0 to run.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>ukrainian</filename></entry> - <entry>Ukrainian language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>vietnamese</filename></entry> - <entry>Vietnamese language support.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>windowmaker*</filename></entry> - <entry>Ports to support the WindowMaker window - manager.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>www</filename></entry> - <entry>Software related to the World Wide Web.</entry> - <entry>HTML language - support belongs here too.</entry> - </row> - - <row> - <entry><filename>x11</filename></entry> - <entry>The X Window System and friends.</entry> - <entry>This category is only - for software that directly supports the window system. Do not - put regular X applications here; most of them should go - into other <filename>x11-*</filename> categories (see below). - If your port <emphasis>is</emphasis> an X - application, define <makevar>USE_XLIB</makevar> (implied by - <makevar>USE_IMAKE</makevar>) and put it in the appropriate - category.</entry> - </row> - - <row> - <entry><filename>x11-clocks</filename></entry> - <entry>X11 clocks.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>x11-fm</filename></entry> - <entry>X11 file managers.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>x11-fonts</filename></entry> - <entry>X11 fonts and font utilities.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>x11-servers</filename></entry> - <entry>X11 servers.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>x11-themes</filename></entry> - <entry>X11 themes.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>x11-toolkits</filename></entry> - <entry>X11 toolkits.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>x11-wm</filename></entry> - <entry>X11 window managers.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>xfce*</filename></entry> - <entry>Ports relating to the - <ulink url="http://www.xfce.org/">Xfce</ulink> desktop - environment.</entry> - <entry></entry> - </row> - - <row> - <entry><filename>zope*</filename></entry> - <entry><ulink url="http://www.zope.org/">Zope</ulink> support.</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </sect2> - - <sect2 id="choosing-categories"> - <title>Choosing the right category</title> - - <para>As many of the categories overlap, you often have to choose - which of the categories should be the primary category of your port. - There are several rules that govern this issue. Here is the list of - priorities, in decreasing order of precedence:</para> - - <itemizedlist> - <listitem> - <para>The first category must be a physical category (see - <link linkend="porting-categories">above</link>). This is - necessary to make the packaging work. Virtual categories and - physical categories may be intermixed after that.</para> - </listitem> - - <listitem> - <para>Language specific categories always come first. For - example, if your port installs Japanese X11 fonts, then your - <makevar>CATEGORIES</makevar> line would read <filename>japanese - x11-fonts</filename>.</para> - </listitem> - - <listitem> - <para>Specific categories are listed before less-specific ones. For - instance, an HTML editor should be listed as <filename>www - editors</filename>, not the other way around. Also, you should not - list <filename>net</filename> when the port belongs to - any of <filename>irc</filename>, <filename>mail</filename>, - <filename>mbone</filename>, <filename>news</filename>, - <filename>security</filename>, or <filename>www</filename>, as - <filename>net</filename> is included implicitly.</para> - </listitem> - - <listitem> - <para><filename>x11</filename> is used as a secondary category only - when the primary category is a natural language. In particular, - you should not put <filename>x11</filename> in the category line - for X applications.</para> - </listitem> - - <listitem> - <para><application>Emacs</application> modes should be - placed in the same ports category as the application - supported by the mode, not in - <filename>editors</filename>. For example, an - <application>Emacs</application> mode to edit source - files of some programming language should go into - <filename>lang</filename>. - </para> - </listitem> - - <listitem> - <para><filename>misc</filename> - should not appear with any other non-virtual category. - If you have <literal>misc</literal> with something else in - your <makevar>CATEGORIES</makevar> line, that means you can - safely delete <literal>misc</literal> and just put the port - in that other subdirectory!</para> - </listitem> - - <listitem> - <para>If your port truly does not belong anywhere else, put it in - <filename>misc</filename>.</para> - </listitem> - </itemizedlist> - - <para>If you are not sure about the category, please put a comment to - that effect in your &man.send-pr.1; submission so we can - discuss it before we import it. If you are a committer, send a note - to the &a.ports; so we can discuss it first. Too often, new ports are - imported to the wrong category only to be moved right away. - This causes unnecessary and undesirable bloat in the master - source repository.</para> - </sect2> - - <sect2 id="proposing-categories"> - <title>Proposing a new category</title> - - <para>As the Ports Collection has grown over time, various new - categories have been introduced. New categories can either - be <emphasis>virtual</emphasis> categories—those that do - not have a corresponding subdirectory in the ports tree— - or <emphasis>physical</emphasis> categories—those that - do. The following text discusses the issues involved in creating - a new physical category so that you can understand them before - you propose one.</para> - - <para>Our existing practice has been to avoid creating a new - physical category unless either a large number of ports would - logically belong to it, or the ports that would belong to it - are a logically distinct group that is of limited general - interest (for instance, categories related to spoken human - languages), or preferably both.</para> - - <para>The rationale for this is that such a change creates a - <ulink url="&url.articles.committers-guide;/#ports"> - fair amount of work</ulink> for both the committers and also - for all users who track changes to the Ports Collection. In - addition, proposed category changes just naturally seem to - attract controversy. (Perhaps this is because there is no - clear consensus on when a category is <quote>too big</quote>, - nor whether categories should lend themselves to browsing (and - thus what number of categories would be an ideal number), and - so forth.)</para> - - <para>Here is the procedure:</para> - - <procedure> - <step> - <para>Propose the new category on &a.ports;. You should - include a detailed rationale for the new category, - including why you feel the existing categories are not - sufficient, and the list of existing ports proposed to move. - (If there are new ports pending in - <application>GNATS</application> that would fit this - category, list them too.) If you are the maintainer and/or - submitter, respectively, mention that as it may help you - to make your case.</para> - </step> - - <step> - <para>Participate in the discussion.</para> - </step> - - <step> - <para>If it seems that there is support for your idea, - file a PR which includes both the rationale and the list - of existing ports that need to be moved. Ideally, this - PR should also include patches for the following:</para> - - <itemizedlist> - <listitem> - <para><filename>Makefile</filename>s for the - new ports once they are repocopied</para> - </listitem> - - <listitem> - <para><filename>Makefile</filename> for the - new category</para> - </listitem> - - <listitem> - <para><filename>Makefile</filename> for the - old ports' categories</para> - </listitem> - - <listitem> - <para><filename>Makefile</filename>s for ports - that depend on the old ports</para> - </listitem> - - <listitem> - <para>(for extra credit, you can include the other - files that have to change, as per the procedure - in the Committer's Guide.)</para> - </listitem> - </itemizedlist> - </step> - - <step> - <para>Since it affects the ports infrastructure and involves - not only performing repo-copies but also possibly running - regression tests on the build cluster, the PR should be - assigned to the &a.portmgr;.</para> - </step> - - <step> - <para>If that PR is approved, a committer will need to follow - the rest of the procedure that is - <ulink url="&url.articles.committers-guide;/#ports"> - outlined in the Committer's Guide</ulink>.</para> - </step> - </procedure> - - <para>Proposing a new virtual category should be similar to - the above but much less involved, since no ports will - actually have to move. In this case, the only patches to - include in the PR would be those to add the new category to the - <makevar>CATEGORIES</makevar>s of the affected ports.</para> - </sect2> - - <sect2 id="proposing-reorg"> - <title>Proposing reorganizing all the categories</title> - - <para>Occasionally someone proposes reorganizing the categories - with either a 2-level structure, or some other kind of keyword - structure. To date, nothing has come of any of these proposals - because, while they are very easy to make, the effort involved to - retrofit the entire existing ports collection with any kind of - reorganization is daunting to say the very least. Please read - the history of these proposals in the mailing list archives before - you post this idea; furthermore, you should be prepared to be - challenged to offer a working prototype.</para> - </sect2> - </sect1> - - <sect1 id="makefile-distfiles"> - <title>The distribution files</title> - - <para>The second part of the <filename>Makefile</filename> describes the - files that must be downloaded in order to build the port, and where - they can be downloaded from.</para> - - <sect2> - <title><makevar>DISTVERSION/DISTNAME</makevar></title> - - <para><makevar>DISTNAME</makevar> is the name of the port as - called by the authors of the software. - <makevar>DISTNAME</makevar> defaults to - <literal>${PORTNAME}-${PORTVERSION}</literal>, so override it only if necessary. - <makevar>DISTNAME</makevar> is only used in two places. - First, the distribution file list - (<makevar>DISTFILES</makevar>) defaults to - <makevar>${DISTNAME}</makevar><makevar>${EXTRACT_SUFX}</makevar>. - Second, the distribution file is expected to extract into a - subdirectory named <makevar>WRKSRC</makevar>, which defaults - to <filename>work/<makevar>${DISTNAME}</makevar></filename>.</para> - - <para>Some vendor's distribution names which do not fit into the - <literal>${PORTNAME}-${PORTVERSION}</literal>-scheme can be handled - automatically by setting <makevar>DISTVERSION</makevar>. - <makevar>PORTVERSION</makevar> and <makevar>DISTNAME</makevar> will be - derived automatically, but can of course be overridden. The following - table lists some examples:</para> - - <informaltable frame="none" pgwide="1"> - <tgroup cols="2"> - <thead> - <row> - <entry><makevar>DISTVERSION</makevar></entry> - <entry><makevar>PORTVERSION</makevar></entry> - </row> - </thead> - - <tbody> - <row> - <entry>0.7.1d</entry> - <entry>0.7.1.d</entry> - </row> - <row> - <entry>10Alpha3</entry> - <entry>10.a3</entry> - </row> - <row> - <entry>3Beta7-pre2</entry> - <entry>3.b7.p2</entry> - </row> - <row> - <entry>8:f_17</entry> - <entry>8f.17</entry> - </row> - </tbody> - </tgroup> - </informaltable> + <sect1> + <title><makevar>CATEGORIES</makevar></title> + + <para>When a package is created, it is put under + <filename>/usr/ports/packages/All</filename> and links are made from + one or more subdirectories of + <filename>/usr/ports/packages</filename>. The names of these + subdirectories are specified by the variable + <makevar>CATEGORIES</makevar>. It is intended to make life easier + for the user when he is wading through the pile of packages on the + FTP site or the CDROM. Please take a look at the existing <link + linkend="porting-categories">categories</link> and pick the ones + that are suitable for your port.</para> + + <para>This list also determines where in the ports tree the port is + imported. If you put more than one category here, it is assumed + that the port files will be put in the subdirectory with the name in + the first category. See the <link + linkend="porting-categories">categories</link> section for more + discussion about how to pick the right categories.</para> + + <para>If your port truly belongs to something that is different from + all the existing ones, you can even create a new category name. In + that case, please send mail to the &a.ports; to propose a new + category.</para> + </sect1> - <note> - <para><makevar>PKGNAMEPREFIX</makevar> and - <makevar>PKGNAMESUFFIX</makevar> do not affect - <makevar>DISTNAME</makevar>. Also note that if - <makevar>WRKSRC</makevar> is equal to - <filename>work/<makevar>${PORTNAME}-${PORTVERSION}</makevar></filename> - while the original source archive is named something other than - <makevar>${PORTNAME}-${PORTVERSION}${EXTRACT_SUFX}</makevar>, - you should probably leave <makevar>DISTNAME</makevar> - alone— you are better off defining - <makevar>DISTFILES</makevar> than having to set both - <makevar>DISTNAME</makevar> and <makevar>WRKSRC</makevar> - (and possibly <makevar>EXTRACT_SUFX</makevar>).</para> - </note> - </sect2> - - <sect2> - <title><makevar>MASTER_SITES</makevar></title> - - <para>Record the directory part of the FTP/HTTP-URL pointing at the - original tarball in <makevar>MASTER_SITES</makevar>. Do not forget - the trailing slash (<filename>/</filename>)!</para> - - <para>The <command>make</command> macros will try to use this - specification for grabbing the distribution file with - <makevar>FETCH</makevar> if they cannot find it already on the - system.</para> - - <para>It is recommended that you put multiple sites on this list, - preferably from different continents. This will safeguard against - wide-area network problems. We are even planning to add support - for automatically determining the closest master site and fetching - from there; having multiple sites will go a long way towards - helping this effort.</para> - - <para>If the original tarball is part of one of the popular - archives such as X-contrib, GNU, or Perl CPAN, you may be able - refer to those sites in an easy compact form using - <makevar>MASTER_SITE_<replaceable>*</replaceable></makevar> - (e.g., <makevar>MASTER_SITE_XCONTRIB</makevar> and - <makevar>MASTER_SITE_PERL_GNU</makevar>). Simply set - <makevar>MASTER_SITES</makevar> to one of these variables and - <makevar>MASTER_SITE_SUBDIR</makevar> to the path within the - archive. Here is an example:</para> - - <programlisting>MASTER_SITES= ${MASTER_SITE_XCONTRIB} + <sect1> + <title><makevar>MASTER_SITES</makevar></title> + + <para>Record the directory part of the FTP/http-URL pointing at the + original tarball in <makevar>MASTER_SITES</makevar>. Do not forget + the trailing slash (<filename>/</filename>)!</para> + + <para>The <command>make</command> macros will try to use this + specification for grabbing the distribution file with + <makevar>FETCH</makevar> if they cannot find it already on the + system.</para> + + <para>It is recommended that you put multiple sites on this list, + preferably from different continents. This will safeguard against + wide-area network problems, and we are even planning to add support + for automatically determining the closest master site and fetching + from there!</para> + + <para>If the original tarball is part of one of the popular + archives such as X-contrib, GNU, or Perl CPAN, you may be able + refer to those sites in an easy compact form using + <makevar>MASTER_SITE_<replaceable>*</replaceable></makevar> + (e.g., <makevar>MASTER_SITE_XCONTRIB</makevar> and + <makevar>MASTER_SITE_PERL_GNU</makevar>). Simply set + <makevar>MASTER_SITES</makevar> to one of these variables and + <makevar>MASTER_SITE_SUBDIR</makevar> to the path within the + archive. Here is an example:</para> + + <programlisting>MASTER_SITES= ${MASTER_SITE_XCONTRIB} MASTER_SITE_SUBDIR= applications</programlisting> - <para>These variables are defined in - <filename>/usr/ports/Mk/bsd.sites.mk</filename>. There are - new entries added all the time, so make sure to check the - latest version of this file before submitting a port.</para> - - <para>The user can also set the <makevar>MASTER_SITE_*</makevar> - variables in <filename>/etc/make.conf</filename> to override our - choices, and use their favorite mirrors of these popular archives - instead.</para> - </sect2> - - <sect2> - <title><makevar>EXTRACT_SUFX</makevar></title> - - <para>If you have one distribution file, and it uses an odd suffix to - indicate the compression mechanism, set - <makevar>EXTRACT_SUFX</makevar>.</para> - - <para>For example, if the distribution file was named - <filename>foo.tgz</filename> instead of the more normal - <filename>foo.tar.gz</filename>, you would write:</para> + <para>These variables are defined in + <filename>/usr/ports/Mk/bsd.sites.mk</filename>. There are + new archives added all the time, so make sure to check the + latest version of this file before submitting a port.</para> - <programlisting>DISTNAME= foo -EXTRACT_SUFX= .tgz</programlisting> - - <para>The <makevar>USE_BZIP2</makevar> and <makevar>USE_ZIP</makevar> - variables automatically set <makevar>EXTRACT_SUFX</makevar> to - <literal>.tar.bz2</literal> or <literal>.zip</literal> as necessary. If - neither of these are set then <makevar>EXTRACT_SUFX</makevar> - defaults to <literal>.tar.gz</literal>.</para> - - <note> - <para>You never need to set both <makevar>EXTRACT_SUFX</makevar> and - <makevar>DISTFILES</makevar>.</para> - </note> - </sect2> - - <sect2> - <title><makevar>DISTFILES</makevar></title> - - <para>Sometimes the names of the files to be downloaded have no - resemblance to the name of the port. For example, it might be - called <filename>source.tar.gz</filename> or similar. In other - cases the application's source code might be in several different - archives, all of which must be downloaded.</para> - - <para>If this is the case, set <makevar>DISTFILES</makevar> to be a - space separated list of all the files that must be - downloaded.</para> - - <programlisting>DISTFILES= source1.tar.gz source2.tar.gz</programlisting> - - <para>If not explicitly set, <makevar>DISTFILES</makevar> defaults to - <literal>${DISTNAME}${EXTRACT_SUFX}</literal>.</para> - </sect2> - - <sect2> - <title><makevar>EXTRACT_ONLY</makevar></title> - - <para>If only some of the <makevar>DISTFILES</makevar> must be - extracted—for example, one of them is the source code, while - another is an uncompressed document—list the filenames that - must be extracted in <makevar>EXTRACT_ONLY</makevar>.</para> - - <programlisting>DISTFILES= source.tar.gz manual.html -EXTRACT_ONLY= source.tar.gz</programlisting> - - <para>If <emphasis>none</emphasis> of the <makevar>DISTFILES</makevar> - should be uncompressed then set <makevar>EXTRACT_ONLY</makevar> to - the empty string.</para> - - <programlisting>EXTRACT_ONLY=</programlisting> - </sect2> - - <sect2 id="porting-patchfiles"> - <title><makevar>PATCHFILES</makevar></title> - - <para>If your port requires some additional patches that are available - by FTP or HTTP, set <makevar>PATCHFILES</makevar> to the names of - the files and <makevar>PATCH_SITES</makevar> to the URL of the - directory that contains them (the format is the same as - <makevar>MASTER_SITES</makevar>).</para> - - <para>If the patch is not relative to the top of the source tree - (i.e., <makevar>WRKSRC</makevar>) because it contains some extra - pathnames, set <makevar>PATCH_DIST_STRIP</makevar> accordingly. For - instance, if all the pathnames in the patch have an extra - <literal>foozolix-1.0/</literal> in front of the filenames, then set - <literal>PATCH_DIST_STRIP=-p1</literal>.</para> - - <para>Do not worry if the patches are compressed; they will be - decompressed automatically if the filenames end with - <filename>.gz</filename> or <filename>.Z</filename>.</para> - - <para>If the patch is distributed with some other files, such as - documentation, in a gzip'd tarball, you cannot just use - <makevar>PATCHFILES</makevar>. If that is the case, add the name - and the location of the patch tarball to - <makevar>DISTFILES</makevar> and <makevar>MASTER_SITES</makevar>. - Then, use the <makevar>EXTRA_PATCHES</makevar> variable to - point to those files and <filename>bsd.port.mk</filename> - will automatically apply them for you. In particular, do - <emphasis>not</emphasis> copy patch files into the - <makevar>PATCHDIR</makevar> directory—that directory may - not be writable.</para> - - <note> - <para>The tarball will have been extracted alongside the - regular source by then, so there is no need to explicitly extract - it if it is a regular gzip'd or compress'd tarball. If you do the - latter, take extra care not to overwrite something that already - exists in that directory. Also, do not forget to add a command to - remove the copied patch in the <maketarget>pre-clean</maketarget> - target.</para> - </note> - </sect2> - - <sect2 id="porting-master-sites-n"> - <title>Multiple distribution files or patches from different - sites and subdirectories - (<literal>MASTER_SITES:n</literal>)</title> - - <para>(Consider this to be a somewhat <quote>advanced topic</quote>; - those new to this document may wish to skip this section at first). - </para> - - <para>This section has information on the fetching mechanism - known as both <literal>MASTER_SITES:n</literal> and - <literal>MASTER_SITES_NN</literal>. We will refer to this - mechanism as <literal>MASTER_SITES:n</literal> - hereon.</para> - - <para>A little background first. OpenBSD has a neat feature - inside both <makevar>DISTFILES</makevar> and - <makevar>PATCHFILES</makevar> variables, both files and - patches can be postfixed with <literal>:n</literal> - identifiers where <literal>n</literal> both can be - <literal>[0-9]</literal> and denote a group designation. - For example:</para> - - <programlisting>DISTFILES= alpha:0 beta:1</programlisting> - - <para>In OpenBSD, distribution file <filename>alpha</filename> - will be associated with variable - <makevar>MASTER_SITES0</makevar> instead of our common - <makevar>MASTER_SITES</makevar> and - <filename>beta</filename> with - <makevar>MASTER_SITES1</makevar>.</para> - - <para>This is a very interesting feature which can decrease - that endless search for the correct download site.</para> - - <para>Just picture 2 files in <makevar>DISTFILES</makevar> and - 20 sites in <makevar>MASTER_SITES</makevar>, the sites slow - as hell where <filename>beta</filename> is carried by all - sites in <makevar>MASTER_SITES</makevar>, and - <filename>alpha</filename> can only be found in the 20th - site. It would be such a waste to check all of them if - maintainer knew this beforehand, would it not? Not a good - start for that lovely weekend!</para> - - <para>Now that you have the idea, just imagine more - <makevar>DISTFILES</makevar> and more - <makevar>MASTER_SITES</makevar>. Surely our - <quote>distfiles survey meister</quote> would appreciate the - relief to network strain that this would bring.</para> - - <para>In the next sections, information will follow on the - FreeBSD implementation of this idea. We improved a bit on - OpenBSD's concept.</para> - - <sect3> - <title>Simplified information</title> - - <para>This section tells you how to quickly prepare fine - grained fetching of multiple distribution files and - patches from different sites and subdirectories. We - describe here a case of simplified - <literal>MASTER_SITES:n</literal> usage. This will be - sufficient for most scenarios. However, if you need - further information, you will have to refer to the next - section.</para> - - <para>Some applications consist of multiple distribution - files that must be downloaded from a number of different - sites. For example, - <application>Ghostscript</application> consists of the - core of the program, and then a large number of driver - files that are used depending on the user's printer. Some - of these driver files are supplied with the core, but many - others must be downloaded from a variety of different - sites.</para> - - <para>To support this, each entry in - <makevar>DISTFILES</makevar> may be followed by a colon - and a <quote>tag name</quote>. Each site listed in - <makevar>MASTER_SITES</makevar> is then followed by a - colon, and the tag that indicates which distribution files - should be downloaded from this site.</para> - - <para>For example, consider an application with the source - split in two parts, <filename>source1.tar.gz</filename> - and <filename>source2.tar.gz</filename>, which must be - downloaded from two different sites. The port's - <filename>Makefile</filename> would include lines like - <xref - linkend="ports-master-sites-n-example-simple-use-one-file-per-site">.</para> - - <example - id="ports-master-sites-n-example-simple-use-one-file-per-site"> - <title>Simplified use of <literal>MASTER_SITES:n</literal> - with 1 file per site</title> - - <programlisting>MASTER_SITES= ftp://ftp.example1.com/:source1 \ - ftp://ftp.example2.com/:source2 -DISTFILES= source1.tar.gz:source1 \ - source2.tar.gz:source2</programlisting> - </example> - - <para>Multiple distribution files can have the same tag. - Continuing the previous example, suppose that there was a - third distfile, <filename>source3.tar.gz</filename>, that - should be downloaded from - <hostid>ftp.example2.com</hostid>. The - <filename>Makefile</filename> would then be written like - <xref - linkend="ports-master-sites-n-example-simple-use-more-than-one-file-per-site">.</para> - - <example - id="ports-master-sites-n-example-simple-use-more-than-one-file-per-site"> - <title>Simplified use of <literal>MASTER_SITES:n</literal> - with more than 1 file per site</title> - - <programlisting>MASTER_SITES= ftp://ftp.example1.com/:source1 \ - ftp://ftp.example2.com/:source2 -DISTFILES= source1.tar.gz:source1 \ - source2.tar.gz:source2 \ - source3.tar.gz:source2</programlisting> - </example> - </sect3> - - <sect3> - <title>Detailed information</title> - - <para>Okay, so the previous section example did not reflect - your needs? In this section we will explain in detail how - the fine grained fetching mechanism - <literal>MASTER_SITES:n</literal> works and how you can - modify your ports to use it.</para> - - <orderedlist> - <listitem> - <para>Elements can be postfixed with - <literal>:<replaceable>n</replaceable></literal> where - <replaceable>n</replaceable> is - <literal>[^:,]+</literal>, i.e., - <replaceable>n</replaceable> could conceptually be any - alphanumeric string but we will limit it to - <literal>[a-zA-Z_][0-9a-zA-Z_]+</literal> for - now.</para> - - <para>Moreover, string matching is case sensitive; - i.e., <literal>n</literal> is different from - <literal>N</literal>.</para> - - <para>However, the following words cannot be used for - postfixing purposes since they yield special meaning: - <literal>default</literal>, <literal>all</literal> and - <literal>ALL</literal> (they are used internally in - item <xref - linkend="porting-master-sites-n-what-changes-in-port-targets">). - Furthermore, <literal>DEFAULT</literal> is a special - purpose word (check item <xref - linkend="porting-master-sites-n-DEFAULT-group">).</para> - </listitem> - - <listitem> - <para>Elements postfixed with <literal>:n</literal> - belong to the group <literal>n</literal>, - <literal>:m</literal> belong to group - <literal>m</literal> and so forth.</para> - </listitem> - - <listitem id="porting-master-sites-n-DEFAULT-group"> - <para>Elements without a postfix are groupless, i.e., - they all belong to the special group - <literal>DEFAULT</literal>. If you postfix any - elements with <literal>DEFAULT</literal>, you are just - being redundant unless you want to have an element - belonging to both <literal>DEFAULT</literal> and other - groups at the same time (check item <xref - linkend="porting-master-sites-n-comma-operator">).</para> - - <para>The following examples are equivalent but the - first one is preferred:</para> - - <programlisting>MASTER_SITES= alpha - -MASTER_SITES= alpha:DEFAULT</programlisting> - </listitem> - - <listitem> - <para>Groups are not exclusive, an element may belong to - several different groups at the same time and a group - can either have either several different elements or - none at all. Repeated elements within the same group - will be simply that, repeated elements.</para> - </listitem> - - <listitem id="porting-master-sites-n-comma-operator"> - <para>When you want an element to belong to several - groups at the same time, you can use the comma - operator (<literal>,</literal>).</para> - - <para>Instead of repeating it several times, each time - with a different postfix, we can list several groups - at once in a single postfix. For instance, - <literal>:m,n,o</literal> marks an element that - belongs to group <literal>m</literal>, - <literal>n</literal> and <literal>o</literal>.</para> - - <para>All the following examples are equivalent but the - last one is preferred:</para> - - <programlisting>MASTER_SITES= alpha alpha:SOME_SITE - -MASTER_SITES= alpha:DEFAULT alpha:SOME_SITE - -MASTER_SITES= alpha:SOME_SITE,DEFAULT - -MASTER_SITES= alpha:DEFAULT,SOME_SITE</programlisting> - </listitem> - - <listitem> - <para>All sites within a given group are sorted - according to <makevar>MASTER_SORT_AWK</makevar>. All - groups within <makevar>MASTER_SITES</makevar> and - <makevar>PATCH_SITES</makevar> are sorted as - well.</para> - </listitem> - - <listitem id="porting-master-sites-n-group-semantics"> - <para>Group semantics can be used in any of the - following variables <makevar>MASTER_SITES</makevar>, - <makevar>PATCH_SITES</makevar>, - <makevar>MASTER_SITE_SUBDIR</makevar>, - <makevar>PATCH_SITE_SUBDIR</makevar>, - <makevar>DISTFILES</makevar>, and - <makevar>PATCHFILES</makevar> according to the - following syntax:</para> - - <orderedlist> - <listitem> - <para>All <makevar>MASTER_SITES</makevar>, - <makevar>PATCH_SITES</makevar>, - <makevar>MASTER_SITE_SUBDIR</makevar> and - <makevar>PATCH_SITE_SUBDIR</makevar> elements must - be terminated with the forward slash - <literal>/</literal> character. If any elements - belong to any groups, the group postfix - <literal>:<replaceable>n</replaceable></literal> - must come right after the terminator - <literal>/</literal>. The - <literal>MASTER_SITES:n</literal> mechanism relies - on the existence of the terminator - <literal>/</literal> to avoid confusing elements - where a <literal>:n</literal> is a valid part of - the element with occurrences where - <literal>:n</literal> denotes group - <literal>n</literal>. For compatibility purposes, - since the <literal>/</literal> terminator was not - required before in both - <makevar>MASTER_SITE_SUBDIR</makevar> and - <makevar>PATCH_SITE_SUBDIR</makevar> elements, if - the postfix immediate preceding character is not - a <literal>/</literal> then <literal>:n</literal> - will be considered a valid part of the element - instead of a group postfix even if an element is - postfixed with <literal>:n</literal>. See both - <xref - linkend="ports-master-sites-n-example-detailed-use-master-site-subdir"> - and <xref - linkend="ports-master-sites-n-example-detailed-use-complete-example-master-sites">.</para> - - <example id="ports-master-sites-n-example-detailed-use-master-site-subdir"> - <title>Detailed use of - <literal>MASTER_SITES:n</literal> in - <makevar>MASTER_SITE_SUBDIR</makevar></title> - - <programlisting>MASTER_SITE_SUBDIR= old:n new/:NEW</programlisting> - - <itemizedlist> - <listitem> - <para>Directories within group - <literal>DEFAULT</literal> -> old:n</para> - </listitem> - - <listitem> - <para>Directories within group - <literal>NEW</literal> -> new</para> - </listitem> - </itemizedlist> - </example> - - <example - id="ports-master-sites-n-example-detailed-use-complete-example-master-sites"> - <title>Detailed use of - <literal>MASTER_SITES:n</literal> with comma - operator, multiple files, multiple sites and - multiple subdirectories</title> - - <programlisting>MASTER_SITES= http://site1/%SUBDIR%/ http://site2/:DEFAULT \ - http://site3/:group3 http://site4/:group4 \ - http://site5/:group5 http://site6/:group6 \ - http://site7/:DEFAULT,group6 \ - http://site8/%SUBDIR%/:group6,group7 \ - http://site9/:group8 -DISTFILES= file1 file2:DEFAULT file3:group3 \ - file4:group4,group5,group6 file5:grouping \ - file6:group7 -MASTER_SITE_SUBDIR= directory-trial:1 directory-n/:groupn \ - directory-one/:group6,DEFAULT \ - directory</programlisting> - - <para>The previous example results in the - following fine grained fetching. Sites are - listed in the exact order they will be - used.</para> - - <itemizedlist> - <listitem> - <para><filename>file1</filename> will be - fetched from</para> - - <itemizedlist> - <listitem> - <para><makevar>MASTER_SITE_OVERRIDE</makevar></para> - </listitem> - - <listitem> - <para>http://site1/directory-trial:1/</para> - </listitem> - - <listitem> - <para>http://site1/directory-one/</para> - </listitem> - - <listitem> - <para>http://site1/directory/</para> - </listitem> - - <listitem> - <para>http://site2/</para> - </listitem> - - <listitem> - <para>http://site7/</para> - </listitem> - - <listitem> - <para><makevar>MASTER_SITE_BACKUP</makevar></para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><filename>file2</filename> will be - fetched exactly as - <filename>file1</filename> since they - both belong to the same group</para> - - <itemizedlist> - <listitem> - <para><makevar>MASTER_SITE_OVERRIDE</makevar></para> - </listitem> - - <listitem> - <para>http://site1/directory-trial:1/</para> - </listitem> - - <listitem> - <para>http://site1/directory-one/</para> - </listitem> - - <listitem> - <para>http://site1/directory/</para> - </listitem> - - <listitem> - <para>http://site2/</para> - </listitem> - - <listitem> - <para>http://site7/</para> - </listitem> - - <listitem> - <para><makevar>MASTER_SITE_BACKUP</makevar></para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><filename>file3</filename> will be - fetched from</para> - - <itemizedlist> - <listitem> - <para><makevar>MASTER_SITE_OVERRIDE</makevar></para> - </listitem> - - <listitem> - <para>http://site3/</para> - </listitem> - - <listitem> - <para><makevar>MASTER_SITE_BACKUP</makevar></para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><filename>file4</filename> will be - fetched from</para> - - <itemizedlist> - <listitem> - <para><makevar>MASTER_SITE_OVERRIDE</makevar></para> - </listitem> - - <listitem> - <para>http://site4/</para> - </listitem> - - <listitem> - <para>http://site5/</para> - </listitem> - - <listitem> - <para>http://site6/</para> - </listitem> - - <listitem> - <para>http://site7/</para> - </listitem> - - <listitem> - <para>http://site8/directory-one/</para> - </listitem> - - <listitem> - <para><makevar>MASTER_SITE_BACKUP</makevar></para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><filename>file5</filename> will be - fetched from</para> - - <itemizedlist> - <listitem> - <para><makevar>MASTER_SITE_OVERRIDE</makevar></para> - </listitem> - - <listitem> - <para><makevar>MASTER_SITE_BACKUP</makevar></para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para><filename>file6</filename> will be - fetched from</para> - - <itemizedlist> - <listitem> - <para><makevar>MASTER_SITE_OVERRIDE</makevar></para> - </listitem> - - <listitem> - <para>http://site8/</para> - </listitem> - - <listitem> - <para><makevar>MASTER_SITE_BACKUP</makevar></para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - </example> - </listitem> - </orderedlist> - </listitem> - - <listitem> - <para>How do I group one of the special variables from - <filename>bsd.sites.mk</filename>, e.g., - <makevar>MASTER_SITE_SOURCEFORGE</makevar>?</para> - - <para>See <xref - linkend="ports-master-sites-n-example-detailed-use-master-site-sourceforge">.</para> - - <example - id="ports-master-sites-n-example-detailed-use-master-site-sourceforge"> - <title>Detailed use of - <literal>MASTER_SITES:n</literal> with - <makevar>MASTER_SITE_SOURCEFORGE</makevar></title> - - <programlisting>MASTER_SITES= http://site1/ ${MASTER_SITE_SOURCEFORGE:S/$/:sourceforge,TEST/} -DISTFILES= something.tar.gz:sourceforge</programlisting> - </example> - - <para><filename>something.tar.gz</filename> will be - fetched from all sites within - <makevar>MASTER_SITE_SOURCEFORGE</makevar>.</para> - </listitem> - - <listitem> - <para>How do I use this with <makevar>PATCH*</makevar> - variables?</para> - - <para>All examples were done with - <makevar>MASTER*</makevar> variables but they work - exactly the same for <makevar>PATCH*</makevar> ones as - can be seen in <xref - linkend="ports-master-sites-n-example-detailed-use-patch-sites">.</para> - - <example - id="ports-master-sites-n-example-detailed-use-patch-sites"> - <title>Simplified use of - <literal>MASTER_SITES:n</literal> with - <makevar>PATCH_SITES</makevar>.</title> - - <programlisting>PATCH_SITES= http://site1/ http://site2/:test -PATCHFILES= patch1:test</programlisting> - </example> - </listitem> - </orderedlist> - </sect3> - - <sect3> - <title>What does change for ports? What does not?</title> - - <orderedlist numeration="lowerroman"> - <listitem> - <para>All current ports remain the same. The - <literal>MASTER_SITES:n</literal> feature code is only - activated if there are elements postfixed with - <literal>:<replaceable>n</replaceable></literal> like - elements according to the aforementioned syntax rules, - especially as shown in item <xref - linkend="porting-master-sites-n-group-semantics">.</para> - </listitem> - - <listitem id="porting-master-sites-n-what-changes-in-port-targets"> - <para>The port targets remain the same: - <maketarget>checksum</maketarget>, - <maketarget>makesum</maketarget>, - <maketarget>patch</maketarget>, - <maketarget>configure</maketarget>, - <maketarget>build</maketarget>, etc. With the obvious - exceptions of <maketarget>do-fetch</maketarget>, - <maketarget>fetch-list</maketarget>, - <maketarget>master-sites</maketarget> and - <maketarget>patch-sites</maketarget>.</para> - - <itemizedlist> - <listitem> - <para><maketarget>do-fetch</maketarget>: deploys the - new grouping postfixed - <makevar>DISTFILES</makevar> and - <makevar>PATCHFILES</makevar> with their matching - group elements within both - <makevar>MASTER_SITES</makevar> and - <makevar>PATCH_SITES</makevar> which use matching - group elements within both - <makevar>MASTER_SITE_SUBDIR</makevar> and - <makevar>PATCH_SITE_SUBDIR</makevar>. Check <xref - linkend="ports-master-sites-n-example-detailed-use-complete-example-master-sites">.</para> - </listitem> - - <listitem> - <para><maketarget>fetch-list</maketarget>: works - like old <maketarget>fetch-list</maketarget> with - the exception that it groups just like - <maketarget>do-fetch</maketarget>.</para> - </listitem> - - <listitem> - <para><maketarget>master-sites</maketarget> and - <maketarget>patch-sites</maketarget>: - (incompatible with older versions) only return the - elements of group <literal>DEFAULT</literal>; in - fact, they execute targets - <maketarget>master-sites-default</maketarget> and - <maketarget>patch-sites-default</maketarget> - respectively.</para> - - <para>Furthermore, using target either - <maketarget>master-sites-all</maketarget> or - <maketarget>patch-sites-all</maketarget> is - preferred to directly checking either - <maketarget>MASTER_SITES</maketarget> or - <maketarget>PATCH_SITES</maketarget>. Also, - directly checking is not guaranteed to work in any - future versions. Check item <xref - linkend="porting-master-sites-n-new-port-targets-master-sites-all"> - for more information on these new port - targets.</para> - </listitem> - - </itemizedlist> - </listitem> - - <listitem> - <para>New port targets</para> - - <orderedlist> - <listitem> - <para>There are - <maketarget>master-sites-<replaceable>n</replaceable></maketarget> - and - <maketarget>patch-sites-<replaceable>n</replaceable></maketarget> - targets which will list the elements of the - respective group <replaceable>n</replaceable> - within <makevar>MASTER_SITES</makevar> and - <makevar>PATCH_SITES</makevar> respectively. For - instance, both - <maketarget>master-sites-DEFAULT</maketarget> and - <maketarget>patch-sites-DEFAULT</maketarget> will - return the elements of group - <literal>DEFAULT</literal>, - <maketarget>master-sites-test</maketarget> and - <maketarget>patch-sites-test</maketarget> of group - <literal>test</literal>, and thereon.</para> - </listitem> - - <listitem id="porting-master-sites-n-new-port-targets-master-sites-all"> - <para>There are new targets - <maketarget>master-sites-all</maketarget> and - <maketarget>patch-sites-all</maketarget> which do - the work of the old - <maketarget>master-sites</maketarget> and - <maketarget>patch-sites</maketarget> ones. They - return the elements of all groups as if they all - belonged to the same group with the caveat that it - lists as many - <makevar>MASTER_SITE_BACKUP</makevar> and - <makevar>MASTER_SITE_OVERRIDE</makevar> as there - are groups defined within either - <makevar>DISTFILES</makevar> or - <makevar>PATCHFILES</makevar>; respectively for - <maketarget>master-sites-all</maketarget> and - <maketarget>patch-sites-all</maketarget>.</para> - </listitem> - </orderedlist> - </listitem> - </orderedlist> - </sect3> - </sect2> - - <sect2> - <title><makevar>DIST_SUBDIR</makevar></title> - - <para>Do not let your port clutter - <filename>/usr/ports/distfiles</filename>. If your port requires a - lot of files to be fetched, or contains a file that has a name that - might conflict with other ports (e.g., - <filename>Makefile</filename>), set <makevar>DIST_SUBDIR</makevar> - to the name of the port (<literal>${PORTNAME}</literal> or - <literal>${PKGNAMEPREFIX}${PORTNAME}</literal> - should work fine). This will change - <makevar>DISTDIR</makevar> from the default - <filename>/usr/ports/distfiles</filename> to - <filename>/usr/ports/distfiles/<makevar>DIST_SUBDIR</makevar></filename>, - and in effect puts everything that is required for your port into - that subdirectory.</para> - - <para>It will also look at the subdirectory with the same name on the - backup master site at <filename>ftp.FreeBSD.org</filename>. - (Setting <makevar>DISTDIR</makevar> explicitly in your - <makevar>Makefile</makevar> will not accomplish this, so please use - <makevar>DIST_SUBDIR</makevar>.)</para> - - <note> - <para>This does not affect the <makevar>MASTER_SITES</makevar> you - define in your <filename>Makefile</filename>.</para> - </note> - </sect2> - - <sect2> - <title><makevar>ALWAYS_KEEP_DISTFILES</makevar></title> - - <para>If your port uses binary distfiles and has a license that - requires that the source code is provided with packages distributed - in binary form, e.g. GPL, <makevar>ALWAYS_KEEP_DISTFILES</makevar> - will instruct the &os; build cluster to keep a copy of the files - specified in <makevar>DISTFILES</makevar>. Users of these ports - will generally not need these files, so it is a good idea to only - add the source distfiles to <makevar>DISTFILES</makevar> when - <makevar>PACKAGE_BUILDING</makevar> is defined. - </para> - - <example - id="ports-master-sites-n-example-always-keep-distfiles"> - <title>Use of <makevar>ALWAYS_KEEP_DISTFILES</makevar>.</title> - <programlisting>.if defined(PACKAGE_BUILDING) -DISTFILES+= <replaceable>foo.tar.gz</replaceable> -ALWAYS_KEEP_DISTFILES= yes -.endif</programlisting> - </example> - - <para>When adding extra files to <makevar>DISTFILES</makevar>, - make sure you also add them to <filename>distinfo</filename>. - Also, the additional files will normally be extracted into - <makevar>WRKDIR</makevar> as well, which for some ports may - lead to undesirable sideeffects and require special handling.</para> - </sect2> - </sect1> - - <sect1 id="makefile-maintainer"> - <title><makevar>MAINTAINER</makevar></title> - - <para>Set your mail-address here. Please. <!-- smiley - --><emphasis>:-)</emphasis></para> - - <para>Note that only a single address without the comment part is - allowed as a <makevar>MAINTAINER</makevar> value. - The format used should be <literal>user@hostname.domain</literal>. - Please do not include any descriptive text such as your real - name in this entry—that merely confuses - <filename>bsd.port.mk</filename>.</para> - - <para>The maintainer is responsible for keeping the port up to - date, and ensuring the port works correctly. - For a detailed description of the responsibilities of a port - maintainer, refer to the <ulink - url="&url.articles.contributing-ports;/maintain-port.html">The - challenge for port maintainers</ulink> section.</para> - - <para>Changes to the port will be sent to the maintainer of - a port for a review and an approval before being committed. - If the maintainer does not respond to an update - request after two weeks (excluding major public - holidays), then that is considered a maintainer timeout, and the - update may be made without explicit maintainer approval. If the - maintainer does not respond within three months, then that - maintainer is considered absent without leave, and can be - replaced as the maintainer of the particular port in question. - Exceptions to this are anything maintained by the &a.portmgr;, or - the &a.security-officer;. No unauthorized commits may ever be - made to ports maintained by those groups.</para> - - <para>We reserve the right to modify the maintainer's submission - to better match existing policies and style of the Ports - Collection without explicit blessing from the submitter. - Also, large infrastructural changes can result in - a port being modified without maintainer's consent. - This kind of changes will never affect the port's - functionality.</para> - - <para>The &a.portmgr; reserves the right to revoke or override - anyone's maintainership for any reason, and the &a.security-officer; - reserves the right to revoke or override maintainership for security - reasons.</para> + <para>The user can also set the <makevar>MASTER_SITE_*</makevar> + variables in <filename>/etc/make.conf</filename> to override our + choices, and use their favorite mirrors of these popular archives + instead.</para> </sect1> - <sect1 id="makefile-comment"> - <title><makevar>COMMENT</makevar></title> + <sect1 id="porting-patchfiles"> + <title><makevar>PATCHFILES</makevar></title> + + <para>If your port requires some additional patches that are available + by FTP or http, set <makevar>PATCHFILES</makevar> to the names of + the files and <makevar>PATCH_SITES</makevar> to the URL of the + directory that contains them (the format is the same as + <makevar>MASTER_SITES</makevar>).</para> + + <para>If the patch is not relative to the top of the source tree + (i.e., <makevar>WRKSRC</makevar>) because it contains some extra + pathnames, set <makevar>PATCH_DIST_STRIP</makevar> accordingly. For + instance, if all the pathnames in the patch have an extra + <literal>foozolix-1.0/</literal> in front of the filenames, then set + <literal>PATCH_DIST_STRIP=-p1</literal>.</para> + + <para>Do not worry if the patches are compressed; they will be + decompressed automatically if the filenames end with + <filename>.gz</filename> or <filename>.Z</filename>.</para> + + <para>If the patch is distributed with some other files, such as + documentation, in a gzip'd tarball, you cannot just use + <makevar>PATCHFILES</makevar>. If that is the case, add the name + and the location of the patch tarball to + <makevar>DISTFILES</makevar> and <makevar>MASTER_SITES</makevar>. + Then, use the <makevar>EXTRA_PATCHES</makevar> variable to + point to those files and <filename>bsd.port.mk</filename> + will automatically apply them for you. In particular, do + <emphasis>not</emphasis> copy patch files into the + <makevar>PATCHDIR</makevar> directory—that directory may + not be writable.</para> + + <note> + <para>Note that the tarball will have been extracted alongside the + regular source by then, so there is no need to explicitly extract + it if it is a regular gzip'd or compress'd tarball. If you do the + latter, take extra care not to overwrite something that already + exists in that directory. Also, do not forget to add a command to + remove the copied patch in the <maketarget>pre-clean</maketarget> + target.</para> + </note> + </sect1> - <para>This is a one-line description of the port. - <emphasis>Please</emphasis> do not include the package name (or - version number of the software) in the comment. The comment - should begin with a capital and end without a period. Here - is an example:</para> + <sect1> + <title><makevar>MAINTAINER</makevar></title> - <programlisting>COMMENT= A cat chasing a mouse all over the screen</programlisting> + <para>Set your mail-address here. Please. <!-- smiley + --><emphasis>:-)</emphasis></para> - <para>The COMMENT variable should immediately follow the MAINTAINER - variable in the <filename>Makefile</filename>.</para> + <para>For a detailed description of the responsibilities of maintainers, + refer to the <ulink url="../handbook/policies.html#POLICIES-MAINTAINER">MAINTAINER on + Makefiles</ulink> section.</para> + </sect1> - <para>Please try to keep the COMMENT line less than 70 - characters, as it is displayed to users as a one-line - summary of the port.</para> + <sect1> + <title>Dependencies</title> + + <para>Many ports depend on other ports. There are five variables that + you can use to ensure that all the required bits will be on the + user's machine. There are also some pre-supported dependency + variables for common cases, plus a few more to control the behaviour + of dependencies.</para> + + <sect2> + <title><makevar>LIB_DEPENDS</makevar></title> + + <para>This variable specifies the shared libraries this port depends + on. It is a list of + <replaceable>lib</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> + tuples where <replaceable>lib</replaceable> is the name of the + shared library, <replaceable>dir</replaceable> is the + directory in which to find it in case it is not available, and + <replaceable>target</replaceable> is the target to call in that + directory. For example, <programlisting> LIB_DEPENDS= + jpeg.9:${PORTSDIR}/graphics/jpeg:install</programlisting> + will check for a shared jpeg library with major version 9, and + descend into the <filename>graphics/jpeg</filename> subdirectory + of your ports tree to build and install it if it is not found. + The <replaceable>target</replaceable> part can be omitted if it is + equal to <makevar>DEPENDS_TARGET</makevar> (which defaults to + <literal>install</literal>).</para> + + <note> + <para>The <replaceable>lib</replaceable> part is an argument given + to <command>ldconfig -r | grep -wF</command>. There shall be no + regular expressions in this variable.</para> + </note> + + <para>The dependency is checked twice, once from within the + <maketarget>extract</maketarget> target and then from within the + <maketarget>install</maketarget> target. Also, the name of the + dependency is put into the package so that + <command>pkg_add</command> will automatically install it if it is + not on the user's system.</para> + </sect2> + + <sect2> + <title><makevar>RUN_DEPENDS</makevar></title> + + <para>This variable specifies executables or files this port depends + on during run-time. It is a list of + <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> + tuples where <replaceable>path</replaceable> is the name of the + executable or file, <replaceable>dir</replaceable> is the + directory in which to find it in case it is not available, and + <replaceable>target</replaceable> is the target to call in that + directory. If <replaceable>path</replaceable> starts with a slash + (<literal>/</literal>), it is treated as a file and its existence + is tested with <command>test -e</command>; otherwise, it is + assumed to be an executable, and <command>which -s</command> is + used to determine if the program exists in the user's search + path.</para> + + <para>For example,</para> + + <programlisting>RUN_DEPENDS= ${PREFIX}/etc/innd:${PORTSDIR}/news/inn \ + wish8.0:${PORTSDIR}/x11-toolkits/tk80</programlisting> + + <para>will check if the file or directory + <filename>/usr/local/etc/innd</filename> exists, and build and + install it from the <filename>news/inn</filename> subdirectory of + the ports tree if it is not found. It will also see if an + executable called <command>wish8.0</command> is in your search + path, and descend into the <filename>x11-toolkits/tk80</filename> + subdirectory of your ports tree to build and install it if it is + not found.</para> + + <note> + <para>In this case, <command>innd</command> is actually an + executable; if an executable is in a place that is not expected + to be in a normal user's search path, you should use the full + pathname.</para> + </note> + + <para>The dependency is checked from within the + <maketarget>install</maketarget> target. Also, the name of the + dependency is put in to the package so that + <command>pkg_add</command> will automatically install it if it is + not on the user's system. The <replaceable>target</replaceable> + part can be omitted if it is the same as + <makevar>DEPENDS_TARGET</makevar>.</para> + </sect2> + + <sect2> + <title><makevar>BUILD_DEPENDS</makevar></title> + + <para>This variable specifies executables or files this port + requires to build. Like <makevar>RUN_DEPENDS</makevar>, it is a + list of + <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> + tuples. For example, <programlisting> BUILD_DEPENDS= + unzip:${PORTSDIR}/archivers/unzip</programlisting> will check + for an executable called <command>unzip</command>, and descend + into the <filename>archivers/unzip</filename> subdirectory of your + ports tree to build and install it if it is not found.</para> + + <note> + <para>“build” here means everything from extraction to + compilation. The dependency is checked from within the + <maketarget>extract</maketarget> target. The + <replaceable>target</replaceable> part can be omitted if it is + the same as <makevar>DEPENDS_TARGET</makevar></para> + </note> + </sect2> + + <sect2> + <title><makevar>FETCH_DEPENDS</makevar></title> + + <para>This variable specifies executables or files this port + requires to fetch. Like the previous two, it is a list of + <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> + tuples. For example, <programlisting> FETCH_DEPENDS= + ncftp2:${PORTSDIR}/net/ncftp2</programlisting> will check for an + executable called <command>ncftp2</command>, and descend into the + <filename>net/ncftp2</filename> subdirectory of your ports tree to + build and install it if it is not found.</para> + + <para>The dependency is checked from within the + <maketarget>fetch</maketarget> target. The + <replaceable>target</replaceable> part can be omitted if it is the + same as <makevar>DEPENDS_TARGET</makevar>.</para> + </sect2> + + <sect2> + <title><makevar>DEPENDS</makevar></title> + + <para>If there is a dependency that does not fall into either of the + above four categories, or your port requires having the source of + the other port extracted in addition to having it installed, + then use this variable. This is a list of + <replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional>, + as there is nothing to check, unlike the previous four. The + <replaceable>target</replaceable> part can be omitted if it is the + same as <makevar>DEPENDS_TARGET</makevar>.</para> + </sect2> + + <sect2> + <title>Common dependency variables</title> + + <para>Define <literal>USE_XLIB=yes</literal> if your port requires + the X Window System to be installed (it is implied by + <makevar>USE_IMAKE</makevar>). Define + <literal>USE_GMAKE=yes</literal> if your port requires GNU + <command>make</command> instead of BSD <command>make</command>. + Define <literal>USE_AUTOCONF=yes</literal> if your port requires + GNU autoconf to be run. Define <literal>USE_QT=yes</literal> if + your port uses the latest qt toolkit. Use + <literal>USE_PERL5=yes</literal> if your port requires version 5 + of the perl language. (The last is especially important since + some versions of FreeBSD have perl5 as part of the base system + while others do not.)</para> + </sect2> + + <sect2> + <title>Notes on dependencies</title> + + <para>As mentioned above, the default target to call when a + dependency is required is <maketarget>DEPENDS_TARGET</maketarget>. + It defaults to <literal>install</literal>. This is a user + variable; it is never defined in a port's + <filename>Makefile</filename>. If your port needs a special way + to handle a dependency, use the <literal>:target</literal> part of + the <makevar>*_DEPENDS</makevar> variables instead of redefining + <makevar>DEPENDS_TARGET</makevar>.</para> + + <para>When you type <command>make clean</command>, its dependencies + are automatically cleaned too. If you do not wish this to happen, + define the variable <makevar>NOCLEANDEPENDS</makevar> in your + environment.</para> + + <para>To depend on another port unconditionally, use the + variable <makevar>${NONEXISTENT}</makevar> as the first field + of <makevar>BUILD_DEPENDS</makevar> or + <makevar>RUN_DEPENDS</makevar>. Use this only when you need to + the to get to the source of the other port. You can often save + compilation time by specifying the target too. For + instance + + <programlisting>BUILD_DEPENDS= ${NONEXISTENT}:${PORTSDIR}/graphics/jpeg:extract</programlisting> + + will always descend to the JPEG port and extract it.</para> + + <para>Do not use <makevar>DEPENDS</makevar> unless there is no other + way the behaviour you want can be accomplished. It will cause the + other port to always be built (and installed, by default), and the + dependency will go into the packages as well. If this is really + what you need, you should probably write it as + <literal>BUILD_DEPENDS</literal> and + <literal>RUN_DEPENDS</literal> instead—at least the + intention will be clear.</para> + </sect2> </sect1> - <sect1 id="makefile-depend"> - <title>Dependencies</title> + <sect1> + <title>Optional dependencies</title> + + <para>Some large applications can be built in a number of + configurations, adding functionality if one of a number of + libraries or applications is available. Since not all users + want those libraries or applications, the ports system + provides hooks that the port author can use to decide which + configuration should be built. Supporting these properly will + make uses happy, and effectively provide 2 or more ports for the + price of one.</para> + + <para>The easiest of these to use is + <makevar>WITHOUT_X11</makevar>. If the port can be built both + with and without X support, then it should normally be built + with X support. If <makevar>WITHOUT_X11</makevar> is defined, + then the version that does not have X support should be + built.</para> + + <para>Various parts of GNOME have such knobs, though they are + slightly more difficult to use. The variables to use in the + <filename>Makefile</filename> are <makevar>WANT_*</makevar> + and <makevar>HAVE_*</makevar>. If the application can be + built both with or without one of the dependencies listed + below, then the <filename>Makefile</filename> should set + <makevar>WANT_PKG</makevar>, and should build the version that + uses <makevar>PKG</makevar> if <makevar>HAVE_PKG</makevar> + is defined.</para> + + <para>The <makevar>WANT_*</makevar> variables currently + supported this way are <makevar>WANT_GLIB</makevar>, + <makevar>WANT_GTK</makevar>, <makevar>WANT_ESOUND</makevar>, + <makevar>WANT_IMLIB</makevar>, and + <makevar>WANT_GNOME</makevar>.</para> + </sect1> - <para>Many ports depend on other ports. There are seven variables that - you can use to ensure that all the required bits will be on the - user's machine. There are also some pre-supported dependency - variables for common cases, plus a few more to control the behavior - of dependencies.</para> + <sect1> + <title>Building mechanisms</title> + + <para>If your package uses GNU <command>make</command>, set + <literal>USE_GMAKE=yes</literal>. If your package uses + <command>configure</command>, set + <literal>HAS_CONFIGURE=yes</literal>. If your package uses GNU + <command>configure</command>, set + <literal>GNU_CONFIGURE=yes</literal> (this implies + <literal>HAS_CONFIGURE</literal>). If you want to give some extra + arguments to <command>configure</command> (the default argument list + <literal>--prefix=${PREFIX}</literal> for GNU + <command>configure</command> and empty for non-GNU + <command>configure</command>), set those extra arguments in + <makevar>CONFIGURE_ARGS</makevar>. If your package uses GNU + <command>autoconf</command>, set + <literal>USE_AUTOCONF=yes</literal>. This implies + <makevar>GNU_CONFIGURE</makevar>, and will cause + <command>autoconf</command> to be run before + <command>configure</command>.</para> + + <para>If your package is an X application that creates + <filename>Makefile</filename>s from <filename>Imakefile</filename>s + using <command>imake</command>, then set + <literal>USE_IMAKE=yes</literal>. This will cause the configure + stage to automatically do an <command>xmkmf -a</command>. If the + <option>-a</option> flag is a problem for your port, set + <literal>XMKMF=xmkmf</literal>. If the port uses + <command>imake</command> but does not understand the + <maketarget>install.man</maketarget> target, + <literal>NO_INSTALL_MANPAGES=yes</literal> should be set. In + addition, the author of the original port should be shot. <!-- + smiley --><emphasis>:-></emphasis></para> + + <para>If your port's source <filename>Makefile</filename> has + something else than <maketarget>all</maketarget> as the main build + target, set <makevar>ALL_TARGET</makevar> accordingly. Same goes + for <maketarget>install</maketarget> and + <makevar>INSTALL_TARGET</makevar>.</para> + </sect1> + </chapter> - <sect2> - <title><makevar>LIB_DEPENDS</makevar></title> - - <para>This variable specifies the shared libraries this port depends - on. It is a list of - <replaceable>lib</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> - tuples where <replaceable>lib</replaceable> is the name of the - shared library, <replaceable>dir</replaceable> is the - directory in which to find it in case it is not available, and - <replaceable>target</replaceable> is the target to call in that - directory. For example, - <programlisting>LIB_DEPENDS= jpeg.9:${PORTSDIR}/graphics/jpeg</programlisting> - will check for a shared jpeg library with major version 9, and - descend into the <filename>graphics/jpeg</filename> subdirectory - of your ports tree to build and install it if it is not found. - The <replaceable>target</replaceable> part can be omitted if it is - equal to <makevar>DEPENDS_TARGET</makevar> (which defaults to - <literal>install</literal>).</para> - - <note> - <para>The <replaceable>lib</replaceable> part is a regular - expression which is being looked up in the - <command>ldconfig -r</command> output. Values such as - <literal>intl.[5-7]</literal> and <literal>intl</literal> are - allowed. The first pattern, - <literal>intl.[5-7]</literal>, will match any of: - <literal>intl.5</literal>, <literal>intl.6</literal> or - <literal>intl.7</literal>. The second pattern, - <literal>intl</literal>, will match any version of the - <literal>intl</literal> library.</para> - </note> + <chapter> + <title>Special considerations</title> - <para>The dependency is checked twice, once from within the - <maketarget>extract</maketarget> target and then from within the - <maketarget>install</maketarget> target. Also, the name of the - dependency is put into the package so that - &man.pkg.add.1; will automatically install it if it is - not on the user's system.</para> - </sect2> + <para>There are some more things you have to take into account when you + create a port. This section explains the most common of those.</para> - <sect2> - <title><makevar>RUN_DEPENDS</makevar></title> - - <para>This variable specifies executables or files this port depends - on during run-time. It is a list of - <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> - tuples where <replaceable>path</replaceable> is the name of the - executable or file, <replaceable>dir</replaceable> is the - directory in which to find it in case it is not available, and - <replaceable>target</replaceable> is the target to call in that - directory. If <replaceable>path</replaceable> starts with a slash - (<literal>/</literal>), it is treated as a file and its existence - is tested with <command>test -e</command>; otherwise, it is - assumed to be an executable, and <command>which -s</command> is - used to determine if the program exists in the search path.</para> - - <para>For example,</para> - - <programlisting>RUN_DEPENDS= ${LOCALBASE}/etc/innd:${PORTSDIR}/news/inn \ - wish8.0:${PORTSDIR}/x11-toolkits/tk80</programlisting> - - <para>will check if the file or directory - <filename>/usr/local/etc/innd</filename> exists, and build and - install it from the <filename>news/inn</filename> subdirectory of - the ports tree if it is not found. It will also see if an - executable called <command>wish8.0</command> is in the search - path, and descend into the <filename>x11-toolkits/tk80</filename> - subdirectory of your ports tree to build and install it if it is - not found.</para> - - <note> - <para>In this case, <command>innd</command> is actually an - executable; if an executable is in a place that is not expected - to be in the search path, you should use the full - pathname.</para> - </note> + <sect1 id="porting-shlibs"> + <title>Shared Libraries</title> + + <para>If your port installs one or more shared libraries, define a + <makevar>INSTALLS_SHLIB</makevar> make variable, which will instruct + a <filename>bsd.port.mk</filename> to run + <literal>${LDCONFIG} -m</literal> on the directory where the + new library is installed (usually + <filename><makevar>PREFIX</makevar>/lib</filename>) during + <maketarget>post-install</maketarget> target to register it into the + shared library cache. This variable, when defined, will also + facilitate addition of an appropriate + <literal>@exec /sbin/ldconfig -m</literal> and + <literal>@unexec /sbin/ldconfig -R</literal> pair into your + <filename>pkg-plist</filename> file, so that a user who installed + the package can start using the shared library immediately and + deinstallation will not cause the system to still believe the + library is there.</para> + + <para>If you need, you can override default location where the new + library is installed by defining <makevar>LDCONFIG_DIRS</makevar> + make variable, which should contain a list of directories into which + shared libraries are to be installed. For example if your port + installs shared libraries into + <filename><makevar>PREFIX</makevar>/lib/foo</filename> and + <filename><makevar>PREFIX</makevar>/lib/bar</filename> directories + you could use the following in your + <filename>Makefile</filename>:</para> + + <programlisting>INSTALLS_SHLIB= yes +LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting> - <note> - <para>The official search <envar>PATH</envar> used on the ports - build cluster is</para> + <para>Note that content of <makevar>LDCONFIG_DIRS</makevar> is passed + through &man.sed.1; just like the rest of <filename>pkg-plist</filename>, + so <makevar>PLIST_SUB</makevar> substitutions also apply here. It is + recommended that you use <literal>%%PREFIX%%</literal> for + <makevar>PREFIX</makevar>, <literal>%%LOCALBASE%%</literal> for + <makevar>LOCALBASE</makevar> and <literal>%%X11BASE%%</literal> for + <makevar>X11BASE</makevar>.</para> + </sect1> + </chapter> - <programlisting>/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin:/usr/X11R6/bin</programlisting> - </note> +<!-- - <para>The dependency is checked from within the - <maketarget>install</maketarget> target. Also, the name of the - dependency is put into the package so that - &man.pkg.add.1; will automatically install it if it is - not on the user's system. The <replaceable>target</replaceable> - part can be omitted if it is the same as - <makevar>DEPENDS_TARGET</makevar>.</para> - </sect2> + <chapter> + <title>ELF support</title> + + <para>Since FreeBSD changed to an ELF binary format shortly after + 3.0-RELEASE, we need to convert many ports that build shared + libraries to support ELF. Complicating this task is that a 3.0 + system can run as both ELF and a.out, and we wish to unofficially + support the 2.2 branch as long as possible. Below are the guidelines on + how to convert a.out only ports to support both a.out and ELF + compilation.</para> + + <para>Some part of this list is only applicable during the conversion, + but will be left here for a while for reference in case you have come + across some old port you wish to upgrade.</para> + + <sect1> + <title>Moving a.out libraries out of the way</title> + + <para>Any a.out libraries should be moved out of + <filename>/usr/local/lib</filename> and similar to an + <filename>aout</filename> subdirectory. (If you do not move them out + of the way, ELF ports will happily overwrite a.out libraries.) The + <maketarget>move-aout-libs</maketarget> target in the 3.0-CURRENT + <filename>src/Makefile</filename> (called from + <maketarget>aout-to-elf</maketarget>) will do this for you. It will + only move a.out libs so it is safe to call it on a system with both + ELF and a.out libs in the standard directories.</para> + </sect1> - <sect2> - <title><makevar>BUILD_DEPENDS</makevar></title> - - <para>This variable specifies executables or files this port - requires to build. Like <makevar>RUN_DEPENDS</makevar>, it is a - list of - <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> - tuples. For example, <programlisting> BUILD_DEPENDS= - unzip:${PORTSDIR}/archivers/unzip</programlisting> will check - for an executable called <command>unzip</command>, and descend - into the <filename>archivers/unzip</filename> subdirectory of your - ports tree to build and install it if it is not found.</para> - - <note> - <para><quote>build</quote> here means everything from extraction to - compilation. The dependency is checked from within the - <maketarget>extract</maketarget> target. The - <replaceable>target</replaceable> part can be omitted if it is - the same as <makevar>DEPENDS_TARGET</makevar></para> - </note> - </sect2> + <sect1> + <title>Format</title> + + <para>The ports tree will build packages in the format the machine is + in. This means a.out for 2.2 and a.out or ELF for 3.0 depending on + what <command>`objformat`</command> returns. Also, once users move + a.out libraries to a subdirectory, building a.out libraries will be + unsupported. (I.e., it may still work if you know what you are + doing, but you are on your own.)</para> + + <note> + <para>If a port only works for a.out, set + <makevar>BROKEN_ELF</makevar> to a string describing the reason + why. Such ports will be skipped during a build on an ELF + system.</para> + </note> + </sect1> - <sect2> - <title><makevar>FETCH_DEPENDS</makevar></title> - - <para>This variable specifies executables or files this port - requires to fetch. Like the previous two, it is a list of - <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> - tuples. For example, <programlisting> FETCH_DEPENDS= - ncftp2:${PORTSDIR}/net/ncftp2</programlisting> will check for an - executable called <command>ncftp2</command>, and descend into the - <filename>net/ncftp2</filename> subdirectory of your ports tree to - build and install it if it is not found.</para> - - <para>The dependency is checked from within the - <maketarget>fetch</maketarget> target. The - <replaceable>target</replaceable> part can be omitted if it is the - same as <makevar>DEPENDS_TARGET</makevar>.</para> - </sect2> + <sect1> + <title><makevar>PORTOBJFORMAT</makevar></title> - <sect2> - <title><makevar>EXTRACT_DEPENDS</makevar></title> - - <para>This variable specifies executables or files this port - requires for extraction. Like the previous, it is a list of - <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> - tuples. For example, <programlisting>EXTRACT_DEPENDS= - unzip:${PORTSDIR}/archivers/unzip</programlisting> will check - for an executable called <command>unzip</command>, and descend - into the <filename>archivers/unzip</filename> subdirectory of - your ports tree to build and install it if it is not found.</para> - - <para>The dependency is checked from within the - <maketarget>extract</maketarget> target. The - <replaceable>target</replaceable> part can be omitted if it is the - same as <makevar>DEPENDS_TARGET</makevar>.</para> - - <note> - <para>Use this variable only if the extraction does not already - work (the default assumes <command>gzip</command>) and cannot - be made to work using <makevar>USE_ZIP</makevar> or - <makevar>USE_BZIP2</makevar> described in <xref - linkend="use-vars">.</para> - </note> - </sect2> + <para><filename>bsd.port.mk</filename> will set + <makevar>PORTOBJFORMAT</makevar> to <literal>aout</literal> or + <literal>elf</literal> and export it in the environments + <envar>CONFIGURE_ENV</envar>, <envar>SCRIPTS_ENV</envar> and + <envar>MAKE_ENV</envar>. (It's always going to be + <literal>aout</literal> in 2.2-STABLE). It is also passed to + <maketarget>PLIST_SUB</maketarget> as + <literal>PORTOBJFORMAT=${PORTOBJFORMAT}</literal>. (See comment on + <literal>ldconfig</literal> lines below.)</para> - <sect2> - <title><makevar>PATCH_DEPENDS</makevar></title> - - <para>This variable specifies executables or files this port - requires to patch. Like the previous, it is a list of - <replaceable>path</replaceable>:<replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional> - tuples. For example, <programlisting> PATCH_DEPENDS= - ${NONEXISTENT}:${PORTSDIR}/java/jfc:extract - </programlisting>will descend into the - <filename>java/jfc</filename> subdirectory of your ports tree to - extract it.</para> - - <para>The dependency is checked from within the - <maketarget>patch</maketarget> target. The - <replaceable>target</replaceable> part can be omitted if it is the - same as <makevar>DEPENDS_TARGET</makevar>.</para> - </sect2> + <para>The variable is set using this line in + <filename>bsd.port.mk</filename>:</para> - <sect2> - <title><makevar>DEPENDS</makevar></title> - - <para>If there is a dependency that does not fall into either of the - above categories, or your port requires having the source of - the other port extracted in addition to having it installed, - then use this variable. This is a list of - <replaceable>dir</replaceable><optional><replaceable>:target</replaceable></optional>, - as there is nothing to check, unlike the previous four. The - <replaceable>target</replaceable> part can be omitted if it is the - same as <makevar>DEPENDS_TARGET</makevar>.</para> - </sect2> + <programlisting>PORTOBJFORMAT!= test -x /usr/bin/objformat && /usr/bin/objformat || echo aout</programlisting> - <sect2 id="use-vars"> - <title><makevar>USE_<replaceable>*</replaceable></makevar></title> - - <para>A number of variables exist in order to encapsulate common - dependencies that many ports have. Although their use is - optional, they can help to reduce the verbosity of the port - <filename>Makefile</filename>s. Each of them is styled - as <makevar>USE_<replaceable>*</replaceable></makevar>. The - usage of these variables is restricted to the port - <filename>Makefile</filename>s and - <filename>ports/Mk/bsd.*.mk</filename> and is not designed - to encapsulate user-settable options — use - <makevar>WITH_<replaceable>*</replaceable></makevar> and - <makevar>WITHOUT_<replaceable>*</replaceable></makevar> - for that purpose.</para> + <para>Ports' make processes should use this variable to decide what to + do. However, if the port's <filename>configure</filename> script + already automatically detects an ELF system, it is not necessary to + refer to <makevar>PORTOBJFORMAT</makevar>.</para> + </sect1> - <note> - <para>It is <emphasis>always</emphasis> incorrect to set - any <makevar>USE_<replaceable>*</replaceable></makevar> - in <filename>/etc/make.conf</filename>. For instance, - setting <programlisting>USE_GCC=3.2</programlisting> - would adds a dependency on gcc32 for every port, - including gcc32 itself!</para> - </note> + <sect1> + <title>Building shared libraries</title> + + <para>The following are differences in handling shared libraries for + a.out and ELF.</para> + + <itemizedlist> + <listitem> + <para>Shared library versions</para> + + <para>An ELF shared library should be called + <filename>libfoo.so.<replaceable>M</replaceable></filename> + where <replaceable>M</replaceable> is the single version number, + and an a.out library should be called + <filename>libfoo.so.<replaceable>M</replaceable>.<replaceable>N</replaceable></filename> + where <replaceable>M</replaceable> is the major version and + <replaceable>N</replaceable> is the minor version number. + Do not mix those; <emphasis>never</emphasis> install an ELF + shared library called + <filename>libfoo.so.<replaceable>N</replaceable>.<replaceable>M</replaceable></filename> + or an a.out shared library (or symlink) called + <filename>libfoo.so.<replaceable>N</replaceable></filename>.</para> + </listitem> + + <listitem> + <para>Linker command lines</para> + + <para>Assuming <command>cc -shared</command> is used rather than + <command>ld</command> directly, the only difference is that you + need to add + <option>-Wl,-<replaceable>soname,libfoo.so.M</replaceable></option> + on the command line for ELF.</para> + </listitem> + </itemizedlist> + + <para>You need to install a symlink from + <filename>libfoo.so</filename> to + <filename>libfoo.so.<replaceable>N</replaceable></filename> to make + ELF linkers happy. Since it should be listed in + <filename>pkg-plist</filename> too, and it won't hurt in the a.out case + (some ports even require the link for dynamic loading), you should + just make this link regardless of the setting of + <makevar>PORTOBJFORMAT</makevar>.</para> + </sect1> - <table frame="none"> - <title>The <makevar>USE_<replaceable>*</replaceable></makevar> - variables</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - - <entry>Means</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>USE_BZIP2</makevar></entry> - - <entry>The port's tarballs are compressed with - <command>bzip2</command>.</entry> - </row> - - <row> - <entry><makevar>USE_ZIP</makevar></entry> - - <entry>The port's tarballs are compressed with - <command>zip</command>.</entry> - </row> - - <row> - <entry><makevar>USE_BISON</makevar></entry> - - <entry>The port uses <command>bison</command> for - building.</entry> - </row> - - <row> - <entry><makevar>USE_GCC</makevar></entry> - - <entry>The port requires a specific version of - <command>gcc</command> to build. The exact version can be - specified with value such as <literal>3.2</literal>. - The minimal required version can be specified as - <literal>3.2+</literal>. The <command>gcc</command> from - the base system is used when it satisfies the requested - version, otherwise an appropriate <command>gcc</command> is - compiled from ports and the <makevar>CC</makevar> and - <makevar>CXX</makevar> variables are adjusted.</entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>Variables related to <application>gmake</application> and - the <filename>configure</filename> script are described in - <xref linkend="building">, while - <application>autoconf</application>, - <application>automake</application> and - <application>libtool</application> are described in - <xref linkend="using-autotools">. <application>Perl</application> - related variables are described in <xref linkend="using-perl">. - X11 variables are listed in <xref linkend="using-x11">. <xref - linkend="using-gnome"> deals with GNOME and <xref - linkend="using-kde"> with KDE related variables. <xref - linkend="using-java"> documents Java variables, while <xref - linkend="using-php"> contains information on - <application>Apache</application>, <application>PHP</application> - and PEAR modules. <application>Python</application> is discussed - in <xref linkend="using-python">, while - <application>Ruby</application> in <xref linkend="using-ruby">. - Finally, <xref linkend="using-sdl"> provides variables used for - <application>SDL</application> applications.</para> + <sect1> + <title><makevar>LIB_DEPENDS</makevar></title> - </sect2> + <para>All port Makefiles are edited to remove minor numbers from + <makevar>LIB_DEPENDS</makevar>, and also to have the regexp support + removed. (E.g., <literal>foo\\.1\\.\\(33|40\\)</literal> becomes + <literal>foo.2</literal>.) They will be matched using <command>grep + -wF</command>.</para> + </sect1> - <sect2> - <title>Minimal version of a dependency</title> + <sect1> + <title><filename>pkg-plist</filename></title> + + <para><filename>pkg-plist</filename> should contain the short (ELF) shlib + names if the a.out minor number is zero, and the long (a.out) names + otherwise. <filename>bsd.port.mk</filename> will automatically add + <literal>.0</literal> to the end of short shlib lines if + <makevar>PORTOBJFORMAT</makevar> equals <literal>aout</literal>, and + will delete the minor number from long shlib names if + <makevar>PORTOBJFORMAT</makevar> equals + <literal>elf</literal>.</para> + + <para>In cases where you really need to install shlibs with two + versions on an ELF system or those with one version on an a.out + system (for instance, ports that install compatibility libraries for + other operating systems), define the variable + <makevar>NO_FILTER_SHLIBS</makevar>. This will turn off the editing + of <filename>pkg-plist</filename> mentioned in the previous + paragraph.</para> + </sect1> - <para>A minimal version of a dependency can be specified in any - <makevar>*_DEPENDS</makevar> variable using the following - syntax:</para> + <sect1> + <title><literal>ldconfig</literal></title> - <programlisting>p5-Spiffy>=0.26:${PORTSDIR}/devel/p5-Spiffy</programlisting> + <para>The <literal>ldconfig</literal> line in Makefiles should + read:</para> - <para>The first field contains a dependent package name, - which must match the entry in the package database, - a comparison sign, and a package version. The dependency - is satisfied if p5-Spiffy-0.26 or newer is installed on - the machine.</para> - </sect2> + <programlisting>${SETENV} OBJFORMAT=${PORTOBJFORMAT} ${LDCONFIG} -m ....</programlisting> - <sect2> - <title>Notes on dependencies</title> - - <para>As mentioned above, the default target to call when a - dependency is required is <maketarget>DEPENDS_TARGET</maketarget>. - It defaults to <literal>install</literal>. This is a user - variable; it is never defined in a port's - <filename>Makefile</filename>. If your port needs a special way - to handle a dependency, use the <literal>:target</literal> part of - the <makevar>*_DEPENDS</makevar> variables instead of redefining - <makevar>DEPENDS_TARGET</makevar>.</para> - - <para>When you type <command>make clean</command>, its dependencies - are automatically cleaned too. If you do not wish this to happen, - define the variable <makevar>NOCLEANDEPENDS</makevar> in your - environment. This may be particularly desirable if the port - has something that takes a long time to rebuild in its - dependency list, such as KDE, GNOME or Mozilla.</para> - - <para>To depend on another port unconditionally, use the - variable <makevar>${NONEXISTENT}</makevar> as the first field - of <makevar>BUILD_DEPENDS</makevar> or - <makevar>RUN_DEPENDS</makevar>. Use this only when you need to - get the source of the other port. You can often save - compilation time by specifying the target too. For - instance - - <programlisting>BUILD_DEPENDS= ${NONEXISTENT}:${PORTSDIR}/graphics/jpeg:extract</programlisting> - - will always descend to the <literal>jpeg</literal> port and extract it.</para> - - <para>Do not use <makevar>DEPENDS</makevar> unless there is no other - way the behavior you want can be accomplished. It will cause the - other port to always be built (and installed, by default), and the - dependency will go into the packages as well. If this is really - what you need, you should probably write it as - <literal>BUILD_DEPENDS</literal> and - <literal>RUN_DEPENDS</literal> instead—at least the - intention will be clear.</para> - </sect2> + <para>In <filename>pkg-plist</filename> it should read;</para> - <sect2> - <title>Circular dependencies are fatal</title> - - <important> - <para>Do not introduce any circular dependencies into the - ports tree!</para> - </important> - - <para>The ports building technology does not tolerate - circular dependencies. If you introduce one, you will have - someone, somewhere in the world, whose FreeBSD installation will - break almost immediately, with many others quickly to follow. - These can really be hard to detect; if in doubt, before - you make that change, make sure you have done the following: - <command>cd /usr/ports; make index</command>. That process - can be quite slow on older machines, but you may be able to - save a large number of people—including yourself— - a lot of grief in the process.</para> - </sect2> + <programlisting>@exec /usr/bin/env OBJFORMAT=%%PORTOBJFORMAT%% /sbin/ldconfig -m ... +@unexec /usr/bin/env OBJFORMAT=%%PORTOBJFORMAT%% /sbin/ldconfig -R</programlisting> + <para>This is to ensure that the correct <command>ldconfig</command> + will be called depending on the format of the package, not the + default format of the system.</para> </sect1> + </chapter> + +--> - <sect1 id="makefile-masterdir"> + <chapter id="porting-masterdir"> <title><makevar>MASTERDIR</makevar></title> <para>If your port needs to build slightly different versions of - packages by having a variable (for instance, resolution, or paper - size) take different values, create one subdirectory per package to - make it easier for users to see what to do, but try to share as many - files as possible between ports. Typically you only need a very short - <filename>Makefile</filename> in all but one of the directories if you - use variables cleverly. In the sole <filename>Makefile</filename>, - you can use <makevar>MASTERDIR</makevar> to specify the directory - where the rest of the files are. Also, use a variable as part of - <link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so - the packages will have different names.</para> + packages by having a variable (for instance, resolution, or paper + size) take different values, create one subdirectory per package to + make it easier for users to see what to do, but try to share as many + files as possible between ports. Typically you only need a very short + <filename>Makefile</filename> in all but one of the directories if you + use variables cleverly. In the sole <filename>Makefiles</filename>, + you can use <makevar>MASTERDIR</makevar> to specify the directory + where the rest of the files are. Also, use a variable as part of + <link linkend="porting-pkgname"><makevar>PKGNAMESUFFIX</makevar></link> so + the packages will have different names.</para> <para>This will be best demonstrated by an example. This is part of - <filename>japanese/xdvi300/Makefile</filename>;</para> + <filename>japanese/xdvi300/Makefile</filename>;</para> <programlisting>PORTNAME= xdvi PORTVERSION= 17 @@ -3518,80 +1593,116 @@ RESOLUTION?= 300 @${FALSE} .endif</programlisting> - <para><filename role="package">japanese/xdvi300</filename> also has all the regular - patches, package files, etc. If you type <command>make</command> - there, it will take the default value for the resolution (300) and - build the port normally.</para> + <para><filename>japanese/xdvi300</filename> also has all the regular + patches, package files, etc. If you type <command>make</command> + there, it will take the default value for the resolution (300) and + build the port normally.</para> <para>As for other resolutions, this is the <emphasis>entire</emphasis> - <filename>xdvi118/Makefile</filename>:</para> + <filename>xdvi118/Makefile</filename>:</para> <programlisting>RESOLUTION= 118 MASTERDIR= ${.CURDIR}/../xdvi300 -.include "${MASTERDIR}/Makefile"</programlisting> +.include ${MASTERDIR}/Makefile</programlisting> <para>(<filename>xdvi240/Makefile</filename> and - <filename>xdvi400/Makefile</filename> are similar). The - <makevar>MASTERDIR</makevar> definition tells - <filename>bsd.port.mk</filename> that the regular set of - subdirectories like <makevar>FILESDIR</makevar> and - <makevar>SCRIPTDIR</makevar> are to be found under - <filename>xdvi300</filename>. The <literal>RESOLUTION=118</literal> - line will override the <literal>RESOLUTION=300</literal> line in - <filename>xdvi300/Makefile</filename> and the port will be built with - resolution set to 118.</para> - </sect1> - - <sect1 id="makefile-manpages"> + <filename>xdvi400/Makefile</filename> are similar). The + <makevar>MASTERDIR</makevar> definition tells + <filename>bsd.port.mk</filename> that the regular set of + subdirectories like <makevar>FILESDIR</makevar> and + <makevar>SCRIPTDIR</makevar> are to be found under + <filename>xdvi300</filename>. The <literal>RESOLUTION=118</literal> + line will override the <literal>RESOLUTION=300</literal> line in + <filename>xdvi300/Makefile</filename> and the port will be built with + resolution set to 118.</para> + </chapter> + + <chapter> + <title>Shared library versions</title> + + <para>Please read our <ulink url="../handbook/policies-shlib.html">policy on + shared library versioning</ulink> to understand what to do with + shared library versions in general. Do not blindly assume software + authors know what they are doing; many of them do not. It is very + important that these details are carefully considered, as we have + quite a unique situation where we are trying to have dozens of + potentially incompatible software pairs co-exist. Careless port + imports have caused great trouble regarding shared libraries in the + past (ever wondered why the port <filename>jpeg-6b</filename> has a + shared library version of 9?). If in doubt, send a message to the + &a.ports;. Most of the time, your job ends by determining the right + shared library version and making appropriate patches to implement + it.</para> + +<!-- + <para>However, if there is a port which is a different version of the + same software already in the tree, the situation is much more complex. + In short, the FreeBSD implementation does not allow the user to + specify to the linker which version of shared library to link against + (the linker will always pick the highest numbered version). This + means, if there is a <filename>libfoo.so.3.2</filename> and + <filename>libfoo.so.4.0</filename> in the system, there is no way to + tell the linker to link a particular application to + <filename>libfoo.so.3.2</filename>. It is essentially completely + overshadowed in terms of compilation-time linkage. In this case, the + only solution is to rename the <emphasis>base</emphasis> part of the + shared library. For instance, change + <filename>libfoo.so.4.0</filename> to + <filename>libfoo4.so.1.0</filename> so both version 3.2 and 4.0 can be + linked from other ports.</para> +--> + </chapter> + + <chapter id="porting-manpages"> <title>Manpages</title> <para>The <makevar>MAN[1-9LN]</makevar> variables will automatically add - any manpages to <filename>pkg-plist</filename> (this means you must - <emphasis>not</emphasis> list manpages in the - <filename>pkg-plist</filename>—see <link - linkend="plist-sub">generating PLIST</link> for more). It also - makes the install stage automatically compress or uncompress manpages - depending on the setting of <makevar>NOMANCOMPRESS</makevar> in - <filename>/etc/make.conf</filename>.</para> + any manpages to <filename>pkg-plist</filename> (this means you must + <emphasis>not</emphasis> list manpages in the + <filename>pkg-plist</filename>—see <link + linkend="porting-plist">generating PLIST</link> for more). It also + makes the install stage automatically compress or uncompress manpages + depending on the setting of <makevar>NOMANCOMPRESS</makevar> in + <filename>/etc/make.conf</filename>.</para> <para>If your port tries to install multiple names for manpages using - symlinks or hardlinks, you must use the <makevar>MLINKS</makevar> - variable to identify these. The link installed by your port will - be destroyed and recreated by <filename>bsd.port.mk</filename> - to make sure it points to the correct file. Any manpages - listed in MLINKS must not be listed in the - <filename>pkg-plist</filename>.</para> + symlinks or hardlinks, you must use the <makevar>MLINKS</makevar> + variable to identify these. The link installed by your port will + be destroyed and recreated by <filename>bsd.port.mk</filename> + to make sure it points to the correct file. Any manpages + listed in MLINKS must not be listed in the + <filename>pkg-plist</filename>.</para> <para>To specify whether the manpages are compressed upon installation, - use the <makevar>MANCOMPRESSED</makevar> variable. This variable can - take three values, <literal>yes</literal>, <literal>no</literal> and - <literal>maybe</literal>. <literal>yes</literal> means manpages are - already installed compressed, <literal>no</literal> means they are - not, and <literal>maybe</literal> means the software already respects - the value of <makevar>NOMANCOMPRESS</makevar> so - <filename>bsd.port.mk</filename> does not have to do anything - special.</para> + use the <makevar>MANCOMPRESSED</makevar> variable. This variable can + take three values, <literal>yes</literal>, <literal>no</literal> and + <literal>maybe</literal>. <literal>yes</literal> means manpages are + already installed compressed, <literal>no</literal> means they are + not, and <literal>maybe</literal> means the software already respects + the value of <makevar>NOMANCOMPRESS</makevar> so + <filename>bsd.port.mk</filename> does not have to do anything + special.</para> <para><makevar>MANCOMPRESSED</makevar> is automatically set to - <literal>yes</literal> if <makevar>USE_IMAKE</makevar> is set and - <makevar>NO_INSTALL_MANPAGES</makevar> is not set, and to - <literal>no</literal> otherwise. You do not have to explicitly define - it unless the default is not suitable for your port.</para> + <literal>yes</literal> if <makevar>USE_IMAKE</makevar> is set and + <makevar>NO_INSTALL_MANPAGES</makevar> is not set, and to + <literal>no</literal> otherwise. You do not have to explicitly define + it unless the default is not suitable for your port.</para> <para>If your port anchors its man tree somewhere other than - <makevar>PREFIX</makevar>, you can use the - <makevar>MANPREFIX</makevar> to set it. Also, if only manpages in - certain sections go in a non-standard place, such as some <literal>perl</literal> modules - ports, you can set individual man paths using - <makevar>MAN<replaceable>sect</replaceable>PREFIX</makevar> (where - <replaceable>sect</replaceable> is one of <literal>1-9</literal>, - <literal>L</literal> or <literal>N</literal>).</para> + <makevar>PREFIX</makevar>, you can use the + <makevar>MANPREFIX</makevar> to set it. Also, if only manpages in + certain sections go in a non-standard place, such as some Perl modules + ports, you can set individual man paths using + <makevar>MAN<replaceable>sect</replaceable>PREFIX</makevar> (where + <replaceable>sect</replaceable> is one of <literal>1-9</literal>, + <literal>L</literal> or <literal>N</literal>).</para> <para>If your manpages go to language-specific subdirectories, set the - name of the languages to <makevar>MANLANG</makevar>. The value of - this variable defaults to <literal>""</literal> (i.e., English - only).</para> + name of the languages to <makevar>MANLANG</makevar>. The value of + this variable defaults to <literal>""</literal> (i.e., English + only).</para> <para>Here is an example that puts it all together.</para> @@ -3605,7 +1716,7 @@ MANCOMPRESSED= yes</programlisting> <para>This states that six files are installed by this port;</para> - <programlisting>${PREFIX}/man/man1/foo.1.gz + <programlisting>${PREFIX}/man/man1/foo.1.gz ${PREFIX}/man/ja/man1/foo.1.gz ${PREFIX}/share/foobar/man/man3/bar.3.gz ${PREFIX}/share/foobar/man/ja/man3/bar.3.gz @@ -3613,3786 +1724,822 @@ ${PREFIX}/man/man4/baz.4.gz ${PREFIX}/man/ja/man4/baz.4.gz</programlisting> <para>Additionally <filename>${PREFIX}/man/man8/alt-name.8.gz</filename> - may or may not be installed by your port. Regardless, a - symlink will be made to join the foo(1) manpage and - alt-name(8) manpage.</para> - - </sect1> - - <sect1 id="makefile-info"> - <title>Info files</title> - - <para>If your package needs to install GNU info files, they should be - listed in the <makevar>INFO</makevar> variable (without the trailing - <literal>.info</literal>), and appropriate installation/de-installation - code will be automatically added to the temporary - <filename>pkg-plist</filename> before package registration.</para> - </sect1> - - <sect1 id="makefile-options"> - <title>Makefile Options</title> - - <para>Some large applications can be built in a number of - configurations, adding functionality if one of a number of - libraries or applications is available. Examples include - choice of natural (human) language, GUI versus command-line, - or type of database to support. Since not all users - want those libraries or applications, the ports system - provides hooks that the port author can use to control which - configuration should be built. Supporting these properly will - make users happy, and effectively provide 2 or more ports for the - price of one.</para> - - <sect2> - <title><makevar>KNOBS</makevar></title> - - <sect3> - <title><makevar>WITH_<replaceable>*</replaceable></makevar> and - <makevar>WITHOUT_<replaceable>*</replaceable></makevar></title> - - <para>These variables are designed to be set by the system - administrator. There are many that are standardized in - <filename>ports/Mk/bsd.*.mk</filename>; others are not, - which can be confusing. If you need to add such a - configuration variable, please consider using one of the - ones from the following list.</para> - - <note> - <para>You should not assume that a - <makevar>WITH_<replaceable>*</replaceable></makevar> - necessarily has a corresponding - <makevar>WITHOUT_<replaceable>*</replaceable></makevar> - variable and vice versa. In general, the default is - simply assumed.</para> - </note> - - <note> - <para>Unless otherwise specified, these variables are only - tested for being set or not set, rather than being set to - some kind of variable such as <literal>YES</literal> or - <literal>NO</literal>.</para> - </note> - - <table frame="none"> - <title>The <makevar>WITH_<replaceable>*</replaceable></makevar> - and <makevar>WITHOUT_<replaceable>*</replaceable></makevar> - variables</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - - <entry>Means</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>WITH_APACHE2</makevar></entry> - - <entry>If set, use - <filename role="package">www/apache20</filename> - instead of the default of - <filename role="package">www/apache13</filename>.</entry> - </row> - - <row> - <entry><makevar>WITH_BERKELEY_DB</makevar></entry> - - <entry>Define this variable to specify the ability to - use a variant of the Berkeley database package such as - <filename role="package">databases/db41</filename>. - An associated variable, - <makevar>WITH_BDB_VER</makevar>, may be - set to values such as 2, 3, 4, 41 or 42.</entry> - </row> - - <row> - <entry><makevar>WITH_MYSQL</makevar></entry> - - <entry>Define this variable to specify the ability to - use a variant of the MySQL database package such as - <filename role="package">databases/mysql40-server</filename>. - An associated variable, - <makevar>WANT_MYSQL_VER</makevar>, may be - set to values such as 323, 40, 41, or 50.</entry> - </row> - - <row> - <entry><makevar>WITHOUT_NLS</makevar></entry> - - <entry>If set, says that internationalization is not - needed, which can save compile time. By default, - internationalization is used.</entry> - </row> - - <row> - <entry><makevar>WITH_OPENSSL_BASE</makevar></entry> - - <entry>Use the version of OpenSSL in the base system.</entry> - </row> - - <row> - <entry><makevar>WITH_OPENSSL_PORT</makevar></entry> - - <entry>Use the version of OpenSSL from - <filename role="package">security/openssh</filename>, - overwriting the version that was originally installed - in the base system.</entry> - </row> - - <row> - <entry><makevar>WITH_POSTGRESQL</makevar></entry> - - <entry>Define this variable to specify the ability to - use a variant of the PostGreSQL database package such as - <filename role="package">databases/postgresql72</filename>. - </entry> - </row> - - <row> - <entry><makevar>WITHOUT_X11</makevar></entry> - - <entry>If the port can be built both with and without - X support, then it should normally be built with - X support. If this variable is defined, then - the version that does not have X support should - be built instead.</entry> - </row> - </tbody> - </tgroup> - </table> - - </sect3> - - <sect3> - <title>Knob naming</title> - <para>It is recommended that porters use like-named knobs, for the - benefit of end-users and to help keep the number of knob names down. - A list of popular knob names can be found in the - <ulink url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/KNOBS?rev=HEAD&content-type=text/x-cvsweb-markup">KNOBS</ulink> - file.</para> - - <para>Knob names should reflect what the knob is and does. - When a port has a lib-prefix in the <makevar>PORTNAME</makevar> - the lib-prefix should be dropped in knob naming.</para> - - </sect3> - </sect2> - - <sect2> - <title><makevar>OPTIONS</makevar></title> - - <sect3> - <title>Background</title> - <para>The <makevar>OPTIONS</makevar> variable gives the user who - installs the port a dialog with the available options and saves - them to <filename>/var/db/ports/<replaceable>portname</replaceable>/options</filename>. - Next time when the port has to be rebuild, the options are reused. - Never again you will have to remember all the twenty - <makevar>WITH_<replaceable>*</replaceable></makevar> and - <makevar>WITHOUT_<replaceable>*</replaceable></makevar> options you - used to build this port!</para> - - <para>When the user runs <command>make config</command> (or runs - <command>make build</command> for the first time), the framework will - check for - <filename>/var/db/ports/<replaceable>portname</replaceable>/options</filename>. - If that file does not exist, it will use the values of - <makevar>OPTIONS</makevar> to create a dialogbox where the options - can be enabled or disabled. Then the - <filename>options</filename> file is saved and the selected - variables will be used when building the port.</para> - - <para>Use <command>make showconfig</command> to see the saved - configuration. Use <command>make rmconfig</command> to remove the - saved configuration.</para> - </sect3> - - <sect3> - <title>Syntax</title> - <para>The syntax for the <makevar>OPTIONS</makevar> variable is: - -<programlisting>OPTIONS= OPTION "descriptive text" default ... -</programlisting> - - The value for default is either <literal>ON</literal> or - <literal>OFF</literal>. Multiple repetitions of these three fields - are allowed.</para> - - <para><makevar>OPTIONS</makevar> definition must appear before - the inclusion of <filename>bsd.port.pre.mk</filename>. - The <makevar>WITH_*</makevar> and <makevar>WITHOUT_*</makevar> - variables can only be tested after the inclusion of - <filename>bsd.port.pre.mk</filename>. Due to a deficiency - in the infrastructure, you can only test - <makevar>WITH_*</makevar> variables for options, which are - <literal>OFF</literal> by default, and - <makevar>WITHOUT_*</makevar> variables for options, which - defaults to <literal>ON</literal>.</para> - - <sect3> - <title>Example</title> - <example id="ports-options-simple-use"> - <title>Simple use of <makevar>OPTIONS</makevar></title> - <para><programlisting>OPTIONS= FOO "Enable option foo" On \ - BAR "Support feature bar" Off - -.include <bsd.port.pre.mk> - -.if defined(WITHOUT_FOO) -CONFIGURE_ARGS+= --without-foo -.else -CONFIGURE_ARGS+= --with-foo -.endif - -.if defined(WITH_BAR) -RUN_DEPENDS+= bar:${PORTSDIR}/bar/bar -.endif - -.include <bsd.port.post.mk></programlisting></para> - </example> - - </sect2> - - </sect1> - - <sect1 id="makefile-wrkdir"> - <title>Specifying the working directory</title> - - <para>Each port is extracted in to a working directory, which must be - writable. The ports system defaults to having the - <makevar>DISTFILES</makevar> unpack in to a directory called - <literal>${DISTNAME}</literal>. In other words, if you have - set:</para> - - <programlisting>PORTNAME= foo -PORTVERSION= 1.0</programlisting> - - <para>then the port's distribution files contain a top-level directory, - <filename>foo-1.0</filename>, and the rest of the files are located - under that directory.</para> - - <para>There are a number of variables you can override if that is not the - case.</para> - - <sect2> - <title><makevar>WRKSRC</makevar></title> - - <para>The variable lists the name of the directory that is created when - the application's distfiles are extracted. If our previous example - extracted into a directory called <filename>foo</filename> (and not - <filename>foo-1.0</filename>) you would write:</para> - - <programlisting>WRKSRC= ${WRKDIR}/foo</programlisting> - - <para>or possibly</para> - - <programlisting>WRKSRC= ${WRKDIR}/${PORTNAME}</programlisting> - </sect2> - - <sect2> - <title><makevar>NO_WRKSUBDIR</makevar></title> - - <para>If the port does not extract in to a subdirectory at all then - you should set <makevar>NO_WRKSUBDIR</makevar> to indicate - that.</para> - - <programlisting>NO_WRKSUBDIR= yes</programlisting> - </sect2> - </sect1> - - <sect1 id="conflicts"> - <title><makevar>CONFLICTS</makevar></title> - - <para>If your package cannot coexist with other packages - (because of file conflicts, runtime incompatibility, etc.), - list the other package names in the <makevar>CONFLICTS</makevar> - variable. You can use shell globs like <literal>*</literal> and - <literal>?</literal> here. Packages names should be - enumerated the same way they appear in - <filename>/var/db/pkg</filename>. Please make sure that - <makevar>CONFLICTS</makevar> does not match this port's - package itself, or else forcing its installation with - <makevar>FORCE_PKG_REGISTER</makevar> will no longer work. - </para> - - <note> - <para><makevar>CONFLICTS</makevar> automatically sets - <makevar>IGNORE</makevar>, which is more fully documented - in <xref linkend="dads-noinstall">.</para> - </note> - </sect1> + may or may not be installed by your port. Regardless, a + symlink will be made to join the foo(1) manpage and + alt-name(8) manpage.</para> </chapter> - <chapter id="special"> - <title>Special considerations</title> - - <para>There are some more things you have to take into account when you - create a port. This section explains the most common of those.</para> - - <sect1 id="porting-shlibs"> - <title>Shared Libraries</title> - - <para>If your port installs one or more shared libraries, define a - <makevar>INSTALLS_SHLIB</makevar> make variable, which will instruct - a <filename>bsd.port.mk</filename> to run - <literal>${LDCONFIG} -m</literal> on the directory where the - new library is installed (usually - <filename><makevar>PREFIX</makevar>/lib</filename>) during - <maketarget>post-install</maketarget> target to register it into the - shared library cache. This variable, when defined, will also - facilitate addition of an appropriate - <literal>@exec /sbin/ldconfig -m</literal> and - <literal>@unexec /sbin/ldconfig -R</literal> pair into your - <filename>pkg-plist</filename> file, so that a user who installed - the package can start using the shared library immediately and - de-installation will not cause the system to still believe the - library is there.</para> - - <para>If you need, you can override the default location where the new - library is installed by defining the <makevar>LDCONFIG_DIRS</makevar> - make variable, which should contain a list of directories into which - shared libraries are to be installed. For example if your port - installs shared libraries into - <filename><makevar>PREFIX</makevar>/lib/foo</filename> and - <filename><makevar>PREFIX</makevar>/lib/bar</filename> directories - you could use the following in your - <filename>Makefile</filename>:</para> - - <programlisting>INSTALLS_SHLIB= yes -LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PREFIX%%/lib/bar</programlisting> - - <para>Remember that non-standard directories will not be passed to - &man.ldconfig.8; on (re-)boot! If any port really - needs this to work, install a startup-script as - <filename role="package">x11/kdelibs3</filename> does. Please - double-check, often this is not necessary at all or can be avoided - through <literal>-rpath</literal> or setting <envar>LD_RUN_PATH</envar> - during linking (see <filename role="package">lang/moscow_ml</filename> - for an example), or through a shell-wrapper which sets - <makevar>LD_LIBRARY_PATH</makevar> before invoking the binary, like - <filename role="package">www/mozilla</filename> does.</para> - - <para>Note that content of <makevar>LDCONFIG_DIRS</makevar> is passed - through &man.sed.1; just like the rest of <filename>pkg-plist</filename>, - so <makevar>PLIST_SUB</makevar> substitutions also apply here. It is - recommended that you use <literal>%%PREFIX%%</literal> for - <makevar>PREFIX</makevar>, <literal>%%LOCALBASE%%</literal> for - <makevar>LOCALBASE</makevar> and <literal>%%X11BASE%%</literal> for - <makevar>X11BASE</makevar>.</para> - - <para>Try to keep shared library version numbers in the - <filename>libfoo.so.0</filename> format. Our runtime linker only - cares for the major (first) number.</para> - - <para>When the major library version number increments in the update - to the new port version, all other ports that link to the affected - library should have their <makevar>PORTREVISION</makevar> incremented, - to force recompilation with the new library version.</para> - - <para>If the port installs shared libraries with long version numbers, - e.g. <filename>libfoo.so.0.2.9</filename>, the ports infrastructure - will try to rename the files. Define - <makevar>NO_FILTER_SHLIBS</makevar> to disable this - functionality.</para> - + <chapter id="porting-motif"> + <title>Ports that require Motif</title> + + <para>There are many programs that require a Motif library (available + from several commercial vendors, while there is a free clone reported + to be able to run many applications in + <filename>x11-toolkits/lesstif</filename>) to compile. Since it is a + popular toolkit and their licenses usually permit redistribution of + statically linked binaries, we have made special provisions for + handling ports that require Motif in a way that we can easily compile + binaries linked either dynamically (for people who are compiling from + the port) or statically (for people who distribute packages).</para> + + <sect1> + <title><makevar>REQUIRES_MOTIF</makevar></title> + + <para>If your port requires Motif, define this variable in the + Makefile. This will prevent people who do not own a copy of Motif + from even attempting to build it.</para> </sect1> - <sect1 id="porting-restrictions"> - <title>Ports with distribution restrictions</title> - - <para>Licenses vary, and some of them place restrictions on how the - application can be packaged, whether it can be sold for profit, and so - on.</para> - - <important> - <para>It is your responsibility as a porter to read the licensing - terms of the software and make sure that the FreeBSD project will - not be held accountable for violating them by redistributing the - source or compiled binaries either via FTP/HTTP or CD-ROM. If in doubt, - please contact the &a.ports;.</para> - </important> - - <para>In situations like this, the variables described in the following - sections can be set.</para> - - <sect2> - <title><makevar>NO_PACKAGE</makevar></title> - - <para>This variable indicates that we may not generate a binary - package of the application. For instance, the license may - disallow binary redistribution, or it may prohibit distribution - of packages created from patched sources.</para> - - <para>However, the port's <makevar>DISTFILES</makevar> may be - freely mirrored on FTP/HTTP. They may also be distributed on - a CD-ROM (or similar media) unless <makevar>NO_CDROM</makevar> - is set as well.</para> - - <para><makevar>NO_PACKAGE</makevar> should also be used if the binary - package is not generally useful, and the application should always - be compiled from the source code. For example, if the application - has configuration information that is site specific hard coded in to - it at compile time, set <makevar>NO_PACKAGE</makevar>.</para> - - <para><makevar>NO_PACKAGE</makevar> should be set to a string - describing the reason why the package should not be - generated.</para> - </sect2> - - <sect2> - <title><makevar>NO_CDROM</makevar></title> - - <para>This variable alone indicates that, although we are allowed - to generate binary packages, we may put neither those packages - nor the port's <makevar>DISTFILES</makevar> onto a CD-ROM (or - similar media) for resale. However, the binary packages and - the port's <makevar>DISTFILES</makevar> will still be available - via FTP/HTTP.</para> - - <para> If this variable is set along with - <makevar>NO_PACKAGE</makevar>, then only the port's - <makevar>DISTFILES</makevar> will be available, and only via - FTP/HTTP.</para> - - <para><makevar>NO_CDROM</makevar> should be set to a string - describing the reason why the port cannot be redistributed - on CD-ROM. For instance, this should be used if the port's license - is for <quote>non-commercial</quote> use only.</para> - </sect2> - - <sect2> - <title><makevar>NOFETCHFILES</makevar></title> - - <para>Files defined in the <makevar>NOFETCHFILES</makevar> - variable are not fetchable from any of the - <makevar>MASTER_SITES</makevar>. An example of such a - file is when the file is supplied on CD-ROM by the - vendor.</para> - - <para>Tools which check for the availability of these files - on the <makevar>MASTER_SITES</makevar> should ignore these - files and not report about them.</para> - </sect2> - - <sect2> - <title><makevar>RESTRICTED</makevar></title> - - <para>Set this variable alone if the application's license permits - neither mirroring the application's <makevar>DISTFILES</makevar> - nor distributing the binary package in any way.</para> - - <para><makevar>NO_CDROM</makevar> or <makevar>NO_PACKAGE</makevar> - should not be set along with <makevar>RESTRICTED</makevar> - since the latter variable implies the former ones.</para> - - <para><makevar>RESTRICTED</makevar> should be set to a string - describing the reason why the port cannot be redistributed. - Typically, this indicates that the port contains proprietary - software and that the user will need to manually download the - <makevar>DISTFILES</makevar>, possibly after registering for the - software or agreeing to accept the terms of an - <acronym>EULA</acronym>.</para> - </sect2> - - <sect2> - <title><makevar>RESTRICTED_FILES</makevar></title> - - <para>When <makevar>RESTRICTED</makevar> or <makevar>NO_CDROM</makevar> - is set, this variable defaults to <literal>${DISTFILES} - ${PATCHFILES}</literal>, otherwise it is empty. If only some of the - distribution files are restricted, then set this variable to list - them.</para> - - <para>Note that the port committer should add an entry to - <filename>/usr/ports/LEGAL</filename> for every listed distribution - file, describing exactly what the restriction entails.</para> - </sect2> - </sect1> - - <sect1 id="building"> - <title>Building mechanisms</title> - - <sect2 id="using-make"> - <title><command>make</command>, <command>gmake</command>, and - <command>imake</command></title> - - <para>If your port uses <application>GNU make</application>, set - <literal>USE_GMAKE=yes</literal>.</para> - - <table frame="none"> - <title>Variables for ports related to gmake</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - - <entry>Means</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>USE_GMAKE</makevar></entry> - - <entry>The port requires <command>gmake</command> to - build.</entry> - </row> - - <row> - <entry><makevar>GMAKE</makevar></entry> - - <entry>The full path for <command>gmake</command> if it is not - in the <envar>PATH</envar>.</entry> - </row> - </tbody> - </tgroup> - </table> - - <para>If your port is an X application that creates - <filename>Makefile</filename> files from - <filename>Imakefile</filename> files using - <application>imake</application>, then set - <literal>USE_IMAKE=yes</literal>. This will cause the - configure stage to automatically do an <command>xmkmf -a</command>. - If the <option>-a</option> flag is a problem for your port, set - <literal>XMKMF=xmkmf</literal>. If the port uses - <application>imake</application> but does not understand the - <maketarget>install.man</maketarget> target, - <literal>NO_INSTALL_MANPAGES=yes</literal> should be set.</para> - - <para>If your port's source <filename>Makefile</filename> has - something else than <maketarget>all</maketarget> as the main build - target, set <makevar>ALL_TARGET</makevar> accordingly. Same goes - for <maketarget>install</maketarget> and - <makevar>INSTALL_TARGET</makevar>.</para> - - </sect2> - - <sect2 id="using-configure"> - <title><command>configure</command> script</title> - - <para>If your port uses the <command>configure</command> script to - generate <filename>Makefile</filename> files from - <filename>Makefile.in</filename> files, set - <literal>GNU_CONFIGURE=yes</literal>. If you want to give extra - arguments to the <command>configure</command> script (the default - argument is <literal>--prefix=${PREFIX} - ${CONFIGURE_TARGET}</literal>), set those - extra arguments in <makevar>CONFIGURE_ARGS</makevar>. Extra - environment variables can be passed using - <makevar>CONFIGURE_ENV</makevar> variable.</para> - - <para>If your package uses GNU <command>configure</command>, and - the resulting executable file has a <quote>strange</quote> name - like - <filename>i386-portbld-freebsd4.7-</filename><replaceable>appname</replaceable>, - you will need to additionally override the - <makevar>CONFIGURE_TARGET</makevar> variable to specify the - target in the way required by scripts generated by recent - versions of <command>autoconf</command>. Add the following line - immediately after the <literal>GNU_CONFIGURE=yes</literal> line - in your <filename>Makefile</filename>:</para> - - <para> - <literal>CONFIGURE_TARGET=--build=${MACHINE_ARCH}-portbld-freebsd${OSREL}</literal> - </para> - - <table frame="none"> - <title>Variables for ports that use configure</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - - <entry>Means</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>GNU_CONFIGURE</makevar></entry> - - <entry>The port uses <command>configure</command> script to - prepare build.</entry> - </row> - - <row> - <entry><makevar>HAS_CONFIGURE</makevar></entry> - - <entry>Same as <makevar>GNU_CONFIGURE</makevar>, except - default configure target is not added to - <makevar>CONFIGURE_ARGS</makevar>.</entry> - </row> - - <row> - <entry><makevar>CONFIGURE_ARGS</makevar></entry> - - <entry>Additional arguments passed to - <command>configure</command> script.</entry> - </row> - - <row> - <entry><makevar>CONFIGURE_ENV</makevar></entry> - - <entry>Additional environment variables to be set - for <command>configure</command> script run.</entry> - </row> - - <row> - <entry><makevar>CONFIGURE_TARGET</makevar></entry> - - <entry>Override default configure target. Default value is - <literal>${MACHINE_ARCH}-portbld-freebsd${OSREL}</literal>.</entry> - </row> - </tbody> - </tgroup> - </table> - </sect2> - </sect1> - - <sect1 id="using-autotools"> - <title>Using GNU autotools</title> - - <sect2 id="using-autotools-introduction"> - <title>Introduction</title> - - <para>The various GNU autotools provide an abstraction mechanism for - building a piece of software over a wide variety of operating - systems and machine architectures. Within the Ports Collection, - an individual port can make use of these tools via a simple - construct:</para> - - <programlisting>USE_AUTOTOOLS= <replaceable>tool</replaceable>:<replaceable>version</replaceable>[:<replaceable>operation</replaceable>] ...</programlisting> - - <para>At the time of writing, <replaceable>tool</replaceable> can be - one of <literal>libtool</literal>, <literal>libltdl</literal>, - <literal>autoconf</literal>, <literal>autoheader</literal>, - <literal>automake</literal> or <literal>aclocal</literal>.</para> - - <para><replaceable>version</replaceable> specifies the particular - tool revision to be used (see - <literal>devel/{automake,autoconf,libtool}[0-9]+</literal> for - valid versions).</para> - - <para><replaceable>operation</replaceable> is an optional extension - to modify how the tool is used.</para> - - <para>Multiple tools can be specified at once, either by including - them all on a single line, or using the <literal>+=</literal> - Makefile construct.</para> - - <para>Before proceeding any further, it cannot be stressed highly - enough that the constructs discussed here are for use ONLY in - building other ports. For cross-development work, the - <literal>devel/gnu-{automake,autoconf,libtool}</literal> ports - should be used, such as within an IDE. <filename - role="package">devel/anjuta</filename> and <filename - role="package">devel/kdevelop</filename> (GNOME and KDE - respectively) are good examples of how to achieve this.</para> - - </sect2> - - <sect2 id="using-libtool"> - <title><command>libtool</command></title> - - <para>Shared libraries using the GNU building framework usually use - <command>libtool</command> to adjust the compilation and - installation of shared libraries to match the specifics of the - underlying operating system. The usual practice is to use copy of - <command>libtool</command> bundled with the application. In case - you need to use external <command>libtool</command>, you can use - the version provided by The Ports Collection:</para> - - <programlisting>USE_AUTOTOOLS= libtool:<replaceable>version</replaceable>[:env]</programlisting> - - <para>With no additional operations, - <literal>libtool:<replaceable>version</replaceable></literal> tells - the building framework to patch the configure script with the - system-installed copy of <command>libtool</command>. - The <makevar>GNU_CONFIGURE</makevar> is implied. - Further, a number of make and shell - variables will be assigned for onward use by the port. See - <filename>bsd.autotools.mk</filename> for details.</para> - - <para>With the <literal>:env</literal> operation, only the - environment will be set up.</para> - - <informaltable frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Previously</entry> - - <entry><makevar>USE_AUTOTOOLS</makevar> construct</entry> - </row> - </thead> - - <tbody> - <row> - <entry><literal>USE_LIBTOOL_VER=15</literal></entry> - - <entry><literal>libtool:15</literal></entry> - </row> - - <row> - <entry><literal>USE_INC_LIBTOOL_VER=15</literal></entry> - - <entry>not in use anymore</entry> - </row> - - <row> - <entry><literal>WANT_LIBTOOL_VER=15</literal></entry> - - <entry><literal>libtool:15:env</literal></entry> - </row> - - </tbody> - </tgroup> - </informaltable> - - <para>Finally, <makevar>LIBTOOLFLAGS</makevar> and - <makevar>LIBTOOLFILES</makevar> can be optionally set to override - the most likely arguments to, and files patched by, - <command>libtool</command>. Most ports are unlikely to need this. - See <filename>bsd.autotools.mk</filename> for further - details.</para> - - </sect2> - - <sect2 id="using-libltdl"> - <title><command>libltdl</command></title> - - <para>Some ports make use of the <command>libltdl</command> library - package, which is part of the <command>libtool</command> suite. - Use of this library does not automatically necessitate the use of - <command>libtool</command> itself, so a separate construct is - provided.</para> - - <programlisting>USE_AUTOTOOLS= libltdl:<replaceable>version</replaceable></programlisting> - - <para>Currently, all this does is to bring in a - <makevar>LIB_DEPENDS</makevar> on the appropriate - <command>libltdl</command> port, and is provided as a convenience - function to help eliminate any dependencies on the autotools ports - outside of the <makevar>USE_AUTOTOOLS</makevar> framework. There - are no optional operations for this tool.</para> - - <informaltable frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Previously</entry> - - <entry><makevar>USE_AUTOTOOLS</makevar> construct</entry> - </row> - </thead> - - <tbody> - <row> - <entry><literal>USE_LIBLTDL=YES</literal></entry> - - <entry><literal>libltdl:15</literal></entry> - </row> - - </tbody> - </tgroup> - </informaltable> - - </sect2> - - <sect2 id="using-autoconf"> - <title><command>autoconf</command> and - <command>autoheader</command></title> - - <para>Some ports do not contain a configure script, but do contain an - autoconf template in the <filename>configure.ac</filename> file. - You can use the following assignments to let - <command>autoconf</command> create the configure script, and also - have <command>autoheader</command> create template headers for use - by the configure script.</para> - - <programlisting>USE_AUTOTOOLS= autoconf:<replaceable>version</replaceable>[:env]</programlisting> - - <para>and</para> - - <programlisting>USE_AUTOTOOLS= autoheader:<replaceable>version</replaceable></programlisting> - - <para>which also implies the use of - <literal>autoconf:<replaceable>version</replaceable></literal>.</para> - - <para>Similarly to <command>libtool</command>, the inclusion of the - optional <literal>:env</literal> operation simply sets up the - environment for further use. Without it, patching and - reconfiguration of the port is carried out.</para> - - <informaltable frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Previously</entry> - - <entry><makevar>USE_AUTOTOOLS</makevar> construct</entry> - </row> - </thead> - - <tbody> - <row> - <entry><literal>USE_AUTOCONF_VER=213</literal></entry> - - <entry><literal>autoconf:213</literal></entry> - </row> - - <row> - <entry><literal>WANT_AUTOCONF_VER=259</literal></entry> - - <entry><literal>autoconf:259:env</literal></entry> - </row> - - <row> - <entry><literal>USE_AUTOHEADER_VER=253</literal></entry> - - <entry><literal>autoheader:253</literal> (implies - <literal>autoconf:253</literal>)</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - - <para>The additional optional variables - <makevar>AUTOCONF_ARGS</makevar> and - <makevar>AUTOHEADER_ARGS</makevar> can be overridden by the port - <filename>Makefile</filename> if specifically requested. As with - the <command>libtool</command> equivalents, most ports are unlikely - to need this.</para> - - </sect2> - - <sect2 id="using-automake"> - <title><command>automake</command> and - <command>aclocal</command></title> - - <para>Some packages only contain <filename>Makefile.am</filename> - files. These have to be converted into - <filename>Makefile.in</filename> files using - <command>automake</command>, and the further processed by - <command>configure</command> to generate an actual - <filename>Makefile</filename>.</para> - - <para>Similarly, packages occasionally do not ship with included - <filename>aclocal.m4</filename> files, again required to build the - software. This can be achieved with <command>aclocal</command>, - which scans <filename>configure.ac</filename> or - <filename>configure.in</filename>.</para> - - <para><command>aclocal</command> has a similar relationship to - <command>automake</command> as <command>autoheader</command> does - to <command>autoconf</command>, described in the previous section. - <command>aclocal</command> implies the use of - <command>automake</command>, thus we have:</para> - - <programlisting>USE_AUTOTOOLS= automake:<replaceable>version</replaceable>[:<replaceable>env</replaceable>]</programlisting> - - <para>and</para> - - <programlisting>USE_AUTOTOOLS= aclocal:<replaceable>version</replaceable></programlisting> - - <para>which also implies the use of - <literal>automake:<replaceable>version</replaceable></literal>.</para> - - <para>Similarly to <command>libtool</command> and - <command>autoconf</command>, the inclusion of the optional - <literal>:env</literal> operation simply sets up the environment - for further use. Without it, reconfiguration of the port is - carried out.</para> - - <informaltable frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Previously</entry> - - <entry><makevar>USE_AUTOTOOLS</makevar> construct</entry> - </row> - </thead> - - <tbody> - <row> - <entry><literal>USE_AUTOMAKE_VER=14</literal></entry> - - <entry><literal>automake:14</literal></entry> - </row> - - <row> - <entry><literal>WANT_AUTOMAKE_VER=15</literal></entry> - - <entry><literal>automake:15:env</literal></entry> - </row> - - <row> - <entry><literal>USE_ACLOCAL_VER=19</literal></entry> - - <entry><literal>aclocal:19</literal> (implies - <literal>automake:19</literal>)</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - - <para>As with - <command>autoconf</command> and <command>autoheader</command>, both - <command>automake</command> and <command>aclocal</command> have - optional argument variables, <makevar>AUTOMAKE_ARGS</makevar> and - <makevar>ACLOCAL_ARGS</makevar> respectively, which may be - overriden by the port <filename>Makefile</filename> if - required.</para> - - </sect2> - </sect1> - - <sect1 id="using-perl"> - <title>Using <literal>perl</literal></title> - - <table frame="none"> - <title>Variables for ports that use <literal>perl</literal></title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - - <entry>Means</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>USE_PERL5</makevar></entry> - - <entry>Says that the port uses <literal>perl 5</literal> to build and run.</entry> - </row> - - <row> - <entry><makevar>USE_PERL5_BUILD</makevar></entry> - - <entry>Says that the port uses <literal>perl 5</literal> to build.</entry> - </row> - - <row> - <entry><makevar>USE_PERL5_RUN</makevar></entry> - - <entry>Says that the port uses <literal>perl 5</literal> to run.</entry> - </row> - - <row> - <entry><makevar>PERL</makevar></entry> - - <entry>The full path of <literal>perl 5</literal>, either in the - system or installed from a port, but without the version - number. Use this if you need to replace - <quote><literal>#!</literal></quote>lines in scripts.</entry> - </row> - - <row> - <entry><makevar>PERL_CONFIGURE</makevar></entry> - - <entry>Configure using Perl's MakeMaker. It implies - <makevar>USE_PERL5</makevar>.</entry> - </row> - - <row> - <entry><makevar>PERL_MODBUILD</makevar></entry> - - <entry>Configure, build and install using Module::Build. It - implies <makevar>PERL_CONFIGURE</makevar>.</entry> - </row> - </tbody> - </tgroup> - - <tgroup cols="2"> - <thead> - <row> - <entry>Read only variables</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>PERL_VERSION</makevar></entry> - - <entry>The full version of <literal>perl</literal> installed (e.g., - <literal>5.00503</literal>).</entry> - </row> - - <row> - <entry><makevar>PERL_VER</makevar></entry> - - <entry>The short version of <literal>perl</literal> installed (e.g., - <literal>5.005</literal>).</entry> - </row> - - <row> - <entry><makevar>PERL_LEVEL</makevar></entry> - - <entry>The installed <literal>perl</literal> version as an integer of the form <literal>MNNNPP</literal> - (e.g., <literal>500503</literal>).</entry> - </row> - - <row> - <entry><makevar>PERL_ARCH</makevar></entry> - - <entry>Where <literal>perl</literal> stores architecture dependent libraries. - Defaults to <literal>${ARCH}-freebsd</literal>.</entry> - </row> + <sect1> + <title><makevar>MOTIFLIB</makevar></title> + + <para>This variable will be set by <filename>bsd.port.mk</filename> to + be the appropriate reference to the Motif library. Please patch the + source to use this wherever the Motif library is referenced in the + <filename>Makefile</filename> or + <filename>Imakefile</filename>.</para> + + <para>There are two common cases:</para> + + <itemizedlist> + <listitem> + <para>If the port refers to the Motif library as + <literal>-lXm</literal> in its <filename>Makefile</filename> or + <filename>Imakefile</filename>, simply substitute + <literal>${MOTIFLIB}</literal> for it.</para> + </listitem> + + <listitem> + <para>If the port uses <literal>XmClientLibs</literal> in its + <filename>Imakefile</filename>, change it to + <literal>${MOTIFLIB} ${XTOOLLIB} + ${XLIB}</literal>.</para> + </listitem> + + </itemizedlist> + + <para>Note that <makevar>MOTIFLIB</makevar> (usually) expands to + <literal>-L/usr/X11R6/lib -lXm</literal> or + <literal>/usr/X11R6/lib/libXm.a</literal>, so there is no need to + add <literal>-L</literal> or <literal>-l</literal> in front.</para> + </sect1> + </chapter> - <row> - <entry><makevar>PERL_PORT</makevar></entry> + <chapter> + <title>X11 fonts</title> - <entry>Name of the <literal>perl</literal> port that is - installed (e.g., <literal>perl5</literal>).</entry> - </row> + <para>If your port installs fonts for the X Window system, put them in + <filename><makevar>X11BASE</makevar>/lib/X11/fonts/local</filename>. + This directory is new to XFree86 release 3.3.3. If it does not exist, + please create it, and print out a message urging the user to update + their XFree86 to 3.3.3 or newer, or at least add this directory to the + font path in <filename>/etc/XF86Config</filename>.</para> + </chapter> - <row> - <entry><makevar>SITE_PERL</makevar></entry> + <chapter id="porting-info"> + <title>Info files</title> - <entry>Directory name where site specific - <literal>perl</literal> packages go. - This value is added to PLIST_SUB.</entry> - </row> - </tbody> - </tgroup> - </table> + <para>The new version of texinfo (included in 2.2.2-RELEASE and onwards) + contains a utility called <command>install-info</command> to add and + delete entries to the <filename>dir</filename> file. If your port + installs any info documents, please follow these instructions so your + port/package will correctly update the user's + <filename><makevar>PREFIX</makevar>/info/dir</filename> file. (Sorry + for the length of this section, but is it imperative to weave all the + info files together. If done correctly, it will produce a + <emphasis>beautiful</emphasis> listing, so please bear with me!</para> + + <para>First, this is what you (as a porter) need to know</para> + + <screen>&prompt.user; <userinput>install-info --help</userinput> +install-info [OPTION]... [INFO-FILE [DIR-FILE]] + Install INFO-FILE in the Info directory file DIR-FILE. + +Options: +--delete Delete existing entries in INFO-FILE; + don't insert any new entries. + : +--entry=TEXT Insert TEXT as an Info directory entry. + : +--section=SEC Put this file's entries in section SEC of the directory. :</screen> <note> - <para>Ports of Perl modules, which do not have an official website, - should link <hostid>cpan.org</hostid> in the WWW line of a - <filename>pkg-descr</filename> file. The preferred URL form is - <literal>http://search.cpan.org/dist/Module-Name/</literal> - (including the trailing slash).</para> + <para>This program will not actually <emphasis>install</emphasis> info + files; it merely inserts or deletes entries in the + <filename>dir</filename> file.</para> </note> - </sect1> - - <sect1 id="using-x11"> - <title>Using X11</title> - - <sect2 id="x11-variables"> - <title>Variable definitions</title> - - <table frame="none"> - <title>Variables for ports that use X</title> - - <tgroup cols="2"> - <tbody> - <row> - <entry><makevar>USE_X_PREFIX</makevar></entry> - - <entry>The port installs in <makevar>X11BASE</makevar>, not - <makevar>PREFIX</makevar>.</entry> - </row> - - <row> - <entry><makevar>USE_XLIB</makevar></entry> - - <entry>The port uses the X libraries.</entry> - </row> - - <row> - <entry><makevar>USE_MOTIF</makevar></entry> - - <entry>The port uses the Motif toolkit. Implies - <makevar>USE_XPM</makevar>.</entry> - </row> - - <row> - <entry><makevar>USE_IMAKE</makevar></entry> - - <entry>The port uses <command>imake</command>. Implies - <makevar>USE_X_PREFIX</makevar>.</entry> - </row> - - <row> - <entry><makevar>XMKMF</makevar></entry> - - <entry>Set to the path of <command>xmkmf</command> if not in the - <envar>PATH</envar>. Defaults to <literal>xmkmf - -a</literal>.</entry> - </row> - </tbody> - </tgroup> - </table> - - <table frame="none"> - <title>Variables for depending on individual parts of X11</title> - - <tgroup cols="2"> - <tbody> - <row> - <entry><makevar>X_IMAKE_PORT</makevar></entry> - - <entry>Port providing <command>imake</command> and several - other utilities used to build X11.</entry> - </row> - - <row> - <entry><makevar>X_LIBRARIES_PORT</makevar></entry> - - <entry>Port providing X11 libraries.</entry> - </row> - - <row> - <entry><makevar>X_CLIENTS_PORT</makevar></entry> - - <entry>Port providing X clients.</entry> - </row> - - <row> - <entry><makevar>X_SERVER_PORT</makevar></entry> - - <entry>Port providing X server.</entry> - </row> - - <row> - <entry><makevar>X_FONTSERVER_PORT</makevar></entry> - - <entry>Port providing font server.</entry> - </row> - - <row> - <entry><makevar>X_PRINTSERVER_PORT</makevar></entry> - - <entry>Port providing print server.</entry> - </row> - - <row> - <entry><makevar>X_VFBSERVER_PORT</makevar></entry> - - <entry>Port providing virtual framebuffer server.</entry> - </row> - - <row> - <entry><makevar>X_NESTSERVER_PORT</makevar></entry> - - <entry>Port providing a nested X server.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_ENCODINGS_PORT</makevar></entry> - - <entry>Port providing encodings for fonts.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_MISC_PORT</makevar></entry> - - <entry>Port providing miscellaneous bitmap fonts.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_100DPI_PORT</makevar></entry> - - <entry>Port providing 100dpi bitmap fonts.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_75DPI_PORT</makevar></entry> - - <entry>Port providing 75dpi bitmap fonts.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_CYRILLIC_PORT</makevar></entry> - - <entry>Port providing cyrillic bitmap fonts.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_TTF_PORT</makevar></entry> - - <entry>Port providing &truetype; fonts.</entry> - </row> - - <row> - <entry><makevar>X_FONTS_TYPE1_PORT</makevar></entry> - - <entry>Port providing Type1 fonts.</entry> - </row> - - <row> - <entry><makevar>X_MANUALS_PORT</makevar></entry> - - <entry>Port providing developer oriented manual pages</entry> - </row> - </tbody> - </tgroup> - </table> - - <example id="using-x11-vars"> - <title>Using X11 related variables in port</title> - <programlisting># Use X11 libraries and depend on -# font server as well as cyrillic fonts. -RUN_DEPENDS= ${X11BASE}/bin/xfs:${X_FONTSERVER_PORT} \ - ${X11BASE}/lib/X11/fonts/cyrillic/crox1c.pcf.gz:${X_FONTS_CYRILLIC_PORT} - -USE_XLIB= yes</programlisting> - </example> - - </sect2> - - <sect2 id="x11-motif"> - <title>Ports that require Motif</title> - - <para>If your port requires a Motif library, define - <makevar>USE_MOTIF</makevar> in the <filename>Makefile</filename>. - Default Motif implementation is - <filename role="package">x11-toolkits/open-motif</filename>. - Users can choose - <filename role="package">x11-toolkits/lesstif</filename> instead - by setting <makevar>WANT_LESSTIF</makevar> variable.</para> - - <para>The <makevar>MOTIFLIB</makevar> variable will be set by - <filename>bsd.port.mk</filename> to reference the appropriate - Motif library. Please patch the source of your port to - use <literal>${MOTIFLIB}</literal> wherever the Motif library is referenced in the original - <filename>Makefile</filename> or - <filename>Imakefile</filename>.</para> - - <para>There are two common cases:</para> - - <itemizedlist> - <listitem> - <para>If the port refers to the Motif library as - <literal>-lXm</literal> in its <filename>Makefile</filename> or - <filename>Imakefile</filename>, simply substitute - <literal>${MOTIFLIB}</literal> for it.</para> - </listitem> - - <listitem> - <para>If the port uses <literal>XmClientLibs</literal> in its - <filename>Imakefile</filename>, change it to - <literal>${MOTIFLIB} ${XTOOLLIB} - ${XLIB}</literal>.</para> - </listitem> - - </itemizedlist> - - <para>Note that <makevar>MOTIFLIB</makevar> (usually) expands to - <literal>-L/usr/X11R6/lib -lXm</literal> or - <literal>/usr/X11R6/lib/libXm.a</literal>, so there is no need to - add <literal>-L</literal> or <literal>-l</literal> in front.</para> - - </sect2> - - <sect2> - <title>X11 fonts</title> - - <para>If your port installs fonts for the X Window System, put them in - <filename><makevar>X11BASE</makevar>/lib/X11/fonts/local</filename>.<para> - - </sect2> - - <sect2> - <title>Getting fake <envar>DISPLAY</envar> using Xvfb</title> - - <para>Some applications require a working X11 display for compilation to - succeed. This pose a problem for the FreeBSD package building - cluster, which operates headless. When the following canonical hack - is used, the package cluster will start the virtual framebuffer - X server. The working <envar>DISPLAY</envar> is then passed - to the build.</para> - - <programlisting>.if defined(PACKAGE_BUILDING) -BUILD_DEPENDS+= Xvfb:${X_VFBSERVER_PORT} \ - ${X11BASE}/lib/X11/fonts/misc/8x13O.pcf.gz:${X_FONTS_MISC_PORT} -.endif</programlisting> - - </sect2> - - </sect1> - - <sect1 id="using-gnome"> - <title>Using GNOME</title> - - <para>The FreeBSD/GNOME project uses its own set of variables - to define which GNOME components a - particular port uses. A - <ulink url="http://www.FreeBSD.org/gnome/docs/porting.html">comprehensive - list of these variables</ulink> exists within the FreeBSD/GNOME - project's homepage.</para> - - </sect1> - - <sect1 id="using-kde"> - <title>Using KDE</title> - - <table frame="none"> - <title>Variables for ports that use KDE</title> - - <tgroup cols="2"> - <tbody> - <row> - <entry><makevar>USE_QT_VER</makevar></entry> - - <entry>The port uses the Qt toolkit. Possible values are - <literal>1</literal> and - <literal>3</literal>; each specify the major version - of Qt to use. Sets both <makevar>MOC</makevar> and - <makevar>QTCPPFLAGS</makevar>to default appropriate - values.</entry> - </row> - - <row> - <entry><makevar>USE_KDELIBS_VER</makevar></entry> - - <entry>The port uses KDE libraries. Possible values are - <literal>3</literal>; each specify the major version - of KDE to use. Implies <makevar>USE_QT_VER</makevar> - of the appropriate version.</entry> - </row> - - <row> - <entry><makevar>USE_KDEBASE_VER</makevar></entry> - - <entry>The port uses KDE base. Possible values are - <literal>3</literal>; each specify the major version - of KDE to use. Implies <makevar>USE_KDELIBS_VER</makevar> - of the appropriate version.</entry> - </row> - - <row> - <entry><makevar>MOC</makevar></entry> - - <entry>Set to the path of <command>moc</command>. - Default set according to <makevar>USE_QT_VER</makevar> - value.</entry> - </row> - - <row> - <entry><makevar>QTCPPFLAGS</makevar></entry> - - <entry>Set the <makevar>CPPFLAGS</makevar> to use when - processing Qt code. Default set according to - <makevar>USE_QT_VER</makevar> value.</entry> - </row> - </tbody> - </tgroup> - </table> - - </sect1> - - <sect1 id="using-java"> - <title>Using Java</title> - - <sect2 id="java-variables"> - <title>Variable definitions</title> - - <para>If your port needs a Java™ Development Kit (JDK) to - either build, run or even extract the distfile, then it should - define <makevar>USE_JAVA</makevar>.</para> - - <para>There are several JDKs in the ports collection, from various - vendors, and in several versions. If your port must use one of - these versions, you can define which one. The most current - version is <filename role="package">java/jdk14</filename>.</para> - - <table frame="none"> - <title>Variables that may be set by ports that use Java</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Means</entry> - </row> - </thead> - <tbody> - <row> - <entry><makevar>USE_JAVA</makevar></entry> - <entry>Should be defined for the remaining variables to have any - effect.</entry> - </row> - <row> - <entry><makevar>JAVA_VERSION</makevar></entry> - <entry>List of space-separated suitable Java versions for - the port. An optional <literal>"+"</literal> allows you to - specify a range of versions (allowed values: - <literal>1.1[+] 1.2[+] 1.3[+] 1.4[+]</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_OS</makevar></entry> - <entry>List of space-separated suitable JDK port operating - systems for the port (allowed values: <literal>native - linux</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_VENDOR</makevar></entry> - <entry>List of space-separated suitable JDK port vendors for - the port (allowed values: <literal>freebsd bsdjava sun ibm - blackdown</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_BUILD</makevar></entry> - <entry>When set, it means that the selected JDK port should - be added to the build dependencies of the port.</entry> - </row> - <row> - <entry><makevar>JAVA_RUN</makevar></entry> - <entry>When set, it means that the selected JDK port should - be added to the run dependencies of the port.</entry> - </row> - <row> - <entry><makevar>JAVA_EXTRACT</makevar></entry> - <entry>When set, it means that the selected JDK port should - be added to the extract dependencies of the port.</entry> - </row> - <row> - <entry><makevar>USE_JIKES</makevar></entry> - <entry>Whether the port should or should not use the - <command>jikes</command> bytecode compiler to build. When - no value is set for this variable, the port will use - <command>jikes</command> to build if available. You may - also explicitly forbid or enforce the use of - <command>jikes</command> (by setting <literal>'no'</literal> - or <literal>'yes'</literal>). In the later case, <filename - role="package">devel/jikes</filename> will be added to build - dependencies of the port. In any case that <command>jikes</command> - is actually used in place of <command>javac</command>, then the - <makevar>HAVE_JIKES</makevar> variable is defined by - <filename>bsd.java.mk</filename>.</entry> - </row> - </tbody> - </tgroup> - </table> - - <para>Below is the list of all settings a port will receive after - setting <makevar>USE_JAVA</makevar>:</para> - - <table frame="none"> - <title>Variables provided to ports that use Java</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Value</entry> - </row> - </thead> - <tbody> - <row> - <entry><makevar>JAVA_PORT</makevar></entry> - <entry>The name of the JDK port (e.g. - <literal>'java/jdk14'</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_PORT_VERSION</makevar></entry> - <entry>The full version of the JDK port (e.g. - <literal>'1.4.2'</literal>). If you only need the first - two digits of this version number, use - <makevar>${JAVA_PORT_VERSION:C/^([0-9])\.([0-9])(.*)$/\1.\2/}</makevar>.</entry> - </row> - <row> - <entry><makevar>JAVA_PORT_OS</makevar></entry> - <entry>The operating system used by the JDK port (e.g. - <literal>'linux'</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_PORT_VENDOR</makevar></entry> - <entry>The vendor of the JDK port (e.g. - <literal>'sun'</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_PORT_OS_DESCRIPTION</makevar></entry> - <entry>Description of the operating system used by the JDK port - (e.g. <literal>'Linux'</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_PORT_VENDOR_DESCRIPTION</makevar></entry> - <entry>Description of the vendor of the JDK port (e.g. - <literal>'FreeBSD Foundation'</literal>).</entry> - </row> - <row> - <entry><makevar>JAVA_HOME</makevar></entry> - <entry>Path to the installation directory of the JDK (e.g. - <filename>'/usr/local/jdk1.3.1'</filename>).</entry> - </row> - <row> - <entry><makevar>JAVAC</makevar></entry> - <entry>Path to the Java compiler to use (e.g. - <filename>'/usr/local/jdk1.1.8/bin/javac'</filename> or - <filename>'/usr/local/bin/jikes'</filename>).</entry> - </row> - <row> - <entry><makevar>JAR</makevar></entry> - <entry>Path to the <command>jar</command> tool to use (e.g. - <filename>'/usr/local/jdk1.2.2/bin/jar'</filename> or - <filename>'/usr/local/bin/fastjar'</filename>).</entry> - </row> - <row> - <entry><makevar>APPLETVIEWER</makevar></entry> - <entry>Path to the <command>appletviewer</command> utility (e.g. - <filename>'/usr/local/linux-jdk1.2.2/bin/appletviewer'</filename>).</entry> - </row> - <row> - <entry><makevar>JAVA</makevar></entry> - <entry>Path to the <command>java</command> executable. Use - this for executing Java programs (e.g. - <filename>'/usr/local/jdk1.3.1/bin/java'</filename>).</entry> - </row> - <row> - <entry><makevar>JAVADOC</makevar></entry> - <entry>Path to the <command>javadoc</command> utility - program.</entry> - </row> - <row> - <entry><makevar>JAVAH</makevar></entry> - <entry>Path to the <command>javah</command> program.</entry> - </row> - <row> - <entry><makevar>JAVAP</makevar></entry> - <entry>Path to the <command>javap</command> program.</entry> - </row> - <row> - <entry><makevar>JAVA_KEYTOOL</makevar></entry> - <entry>Path to the <command>keytool</command> utility program. - This variable is available only if the JDK is Java 1.2 or - higher.</entry> - </row> - <row> - <entry><makevar>JAVA_N2A</makevar></entry> - <entry>Path to the <command>native2ascii</command> tool.</entry> - </row> - <row> - <entry><makevar>JAVA_POLICYTOOL</makevar></entry> - <entry>Path to the <command>policytool</command> program. - This variable is available only if the JDK is Java 1.2 or - higher.</entry> - </row> - <row> - <entry><makevar>JAVA_SERIALVER</makevar></entry> - <entry>Path to the <command>serialver</command> utility - program.</entry> - </row> - <row> - <entry><makevar>RMIC</makevar></entry> - <entry>Path to the RMI stub/skeleton generator, - <command>rmic</command>.</entry> - </row> - <row> - <entry><makevar>RMIREGISTRY</makevar></entry> - <entry>Path to the RMI registry program, - <command>rmiregistry</command>.</entry> - </row> - <row> - <entry><makevar>RMID</makevar></entry> - <entry>Path to the RMI daemon program <command>rmid</command>. - This variable is only available if the JDK is Java 1.2 - or higher.</entry> - </row> - <row> - <entry><makevar>JAVA_CLASSES</makevar></entry> - <entry>Path to the archive that contains the JDK class - files. On JDK 1.2 or later, this is - <filename>${JAVA_HOME}/jre/lib/rt.jar</filename>. Earlier - JDKs used - <filename>${JAVA_HOME}/lib/classes.zip</filename>.</entry> - </row> - <row> - <entry><makevar>HAVE_JIKES</makevar></entry> - <entry>Defined whenever <command>jikes</command> is used by - the port (see <makevar>USE_JIKES</makevar> above).</entry> - </row> - </tbody> - </tgroup> - </table> - - <para>You may use the <literal>java-debug</literal> make target - to get information for debugging your port. It will display the - value of many of the forecited variables.</para> - - <para>Additionally, the following constants are defined so all - Java ports may be installed in a consistent way:</para> - - <table frame="none"> - <title>Constants defined for ports that use Java</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Constant</entry> - <entry>Value</entry> - </row> - </thead> - <tbody> - <row> - <entry><makevar>JAVASHAREDIR</makevar></entry> - <entry>The base directory for everything related to Java. - Default: <filename>${PREFIX}/share/java</filename>. - </entry> - </row> - <row> - <entry><makevar>JAVAJARDIR</makevar></entry> - <entry>The directory where JAR files should be installed. - Default: - <filename>${JAVASHAREDIR}/classes</filename>.</entry> - </row> - <row> - <entry><makevar>JAVALIBDIR</makevar></entry> - <entry>The directory where JAR files installed by other - ports are located. Default: - <filename>${LOCALBASE}/share/java/classes</filename>.</entry> - </row> - </tbody> - </tgroup> - </table> - - <para>The related entries are defined in both - <makevar>PLIST_SUB</makevar> (documented in - <xref linkend="plist-sub">) and - <makevar>SUB_LIST</makevar>.</para> - - </sect2> - - <sect2 id="java-building-with-ant"> - <title>Building with Ant</title> - - <para>When the port is to be built using Apache Ant, it has to - define <makevar>USE_ANT</makevar>. Ant is thus considered to be - the sub-make command. When no <literal>do-build</literal> target - is defined by the port, a default one will be set that simply - runs Ant according to <makevar>MAKE_ENV</makevar>, - <makevar>MAKE_ARGS</makevar> and <makevar>ALL_TARGETS</makevar>. - This is similar to the <makevar>USE_GMAKE</makevar> mechanism, - which is documented in <xref linkend="building">.</para> - - <para>If <command>jikes</command> is used in place of - <command>javac</command> (see <makevar>USE_JIKES</makevar> in - <xref linkend="java-variables">), then Ant will automatically - use it to build the port.</para> - - </sect2> - - <sect2 id="java-best-practices"> - <title>Best practices</title> - - <para>When porting a Java library, your port should install the - JAR file(s) in <filename>${JAVAJARDIR}</filename>, and everything - else under <filename>${JAVASHAREDIR}/${PORTNAME}</filename> - (except for the documentation, see below). In order to reduce - the packing file size, you may reference the JAR file(s) directly - in the <filename>Makefile</filename>. Just use the following - statement (where <filename>myport.jar</filename> is the name - of the JAR file installed as part of the port):</para> - - <programlisting>PLIST_FILES+= %%JAVAJARDIR%%/myport.jar</programlisting> - - <para>When porting a Java application, the port usually installs - everything under a single directory (including its JAR - dependencies). The use of - <filename>${JAVASHAREDIR}/${PORTNAME}</filename> is strongly - encouraged in this regard. It is up the porter to decide - whether the port should install the additional JAR dependencies - under this directory or directly use the already installed ones - (from <filename>${JAVAJARDIR}</filename>).</para> - - <para>Regardless of the type of your port (library or application), - the additional documentation should be installed in the - <link linkend="dads-documentation">same location</link> as for - any other port. The JavaDoc tool is known to produce a - different set of files depending on the version of the JDK that - is used. For ports that do not enforce the use of a particular - JDK, it is therefore a complex task to specify the packing list - (<filename>pkg-plist</filename>). This is one reason why - porters are strongly encouraged to use the - <makevar>PORTDOCS</makevar> macro. Moreover, even if you can - predict the set of files that will be generated by - <command>javadoc</command>, the size of the resulting - <filename>pkg-plist</filename> advocates for the use of - <makevar>PORTDOCS</makevar>.</para> - - <para>The default value for <makevar>DATADIR</makevar> is - <filename>${PREFIX}/share/${PORTNAME}</filename>. It is a good - idea to override <makevar>DATADIR</makevar> to - <filename>${JAVASHAREDIR}/${PORTNAME}</filename> for Java ports. - Indeed, <makevar>DATADIR</makevar> is automatically added to - <makevar>PLIST_SUB</makevar> (documented in <xref - linkend="plist-sub">) so you may use - <literal>%%DATADIR%%</literal> directly in - <filename>pkg-plist</filename>.</para> - - <para>As for the choice of building Java ports from source or - directly installing them from a binary distribution, there is - no defined policy at the time of writing. However, people from - the <ulink - url="http://www.freebsd.org/java/">&os; Java Project</ulink> - encourage porters to have their ports built from source whenever - it is a trivial task.</para> - - <para>All the features that have been presented in this section - are implemented in <filename>bsd.java.mk</filename>. If you - ever think that your port needs more sophisticated Java support, - please first have a look at the <ulink - url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/Mk/bsd.java.mk"> - bsd.java.mk CVS log</ulink> as it usually takes some time to - document the latest features. Then, if you think the support - you are lacking would be beneficial to many other Java ports, - feel free to discuss it on the &a.java;.</para> - - <para>Although there is a <literal>java</literal> category for - PRs, it refers to the JDK porting effort from the &os; Java - project. Therefore, you should submit your Java port in the - <literal>ports</literal> category as for any other port, unless - the issue you are trying to resolve is related to either a JDK - implementation or <filename>bsd.java.mk</filename>.</para> - - <para>Similarly, there is a defined policy regarding the - <makevar>CATEGORIES</makevar> of a Java port, which is detailed - in <xref linkend="makefile-categories">.</para> - - </sect2> - - </sect1> - - <sect1 id="using-php"> - <title>Using Apache and PHP</title> - - <sect2 id="using-apache"> - <title>Apache</title> - - <table frame="none"> - <title>Variables for ports that use Apache</title> - - <tgroup cols="2"> - <tbody> - - <row> - <entry>USE_APACHE</entry> - - <entry>The port requires Apache.</entry> - </row> - - <row> - <entry>WITH_APACHE2</entry> - - <entry>The port requires Apache 2.0. Without this variable, - the port will depend on Apache 1.3.</entry> - </row> - - <row> - <entry>APXS</entry> - - <entry>Full path to the <command>apxs</command> binary - (read-only variable).</entry> - </row> - - </tbody> - </tgroup> - </table> - - </sect2> - - <sect2 id="php-variables"> - <title>PHP</title> - - <table frame="none"> - <title>Variables for ports that use PHP</title> - - <tgroup cols="2"> - <tbody> - <row> - <entry><makevar>USE_PHP</makevar></entry> - - <entry>The port requires PHP. The value <literal>yes</literal> - adds a dependency on PHP. The list of required PHP extensions - can be specified instead. Example: <literal>pcre xml - gettext</literal></entry> - </row> - - <row> - <entry><makevar>DEFAULT_PHP_VER</makevar></entry> - - <entry>Selects which major version of PHP will be installed as - a dependency when no PHP is installed yet. Default is - <literal>4</literal>. Possible values: <literal>4</literal>, - <literal>5</literal></entry> - </row> - - <row> - <entry><makevar>BROKEN_WITH_PHP</makevar></entry> - - <entry>The port does not work with PHP of the given version. - Possible values: <literal>4</literal>, - <literal>5</literal></entry> - </row> - - <row> - <entry><makevar>USE_PHPIZE</makevar></entry> - - <entry>The port will be built as a PHP extension.</entry> - </row> - - <row> - <entry><makevar>USE_PHPEXT</makevar></entry> - - <entry>The port will be treated as a PHP extension, including - installation and registration in the extension registry.</entry> - </row> - - <row> - <entry><makevar>USE_PHP_BUILD</makevar></entry> - - <entry>Set PHP as a build dependency.</entry> - </row> - - <row> - <entry><makevar>WANT_PHP_CLI</makevar></entry> - - <entry>Want the CLI (command line) version of PHP.</entry> - </row> - - <row> - <entry><makevar>WANT_PHP_CGI</makevar></entry> - - <entry>Want the CGI version of PHP.</entry> - </row> - - <row> - <entry><makevar>WANT_PHP_MOD</makevar></entry> - - <entry>Want the Apache module version of PHP.</entry> - </row> - - <row> - <entry><makevar>WANT_PHP_SCR</makevar></entry> - - <entry>Want the CLI or the CGI version of PHP.</entry> - </row> - - <row> - <entry><makevar>WANT_PHP_WEB</makevar></entry> - - <entry>Want the Apache module or the CGI version of PHP.</entry> - </row> - - <row> - <entry><makevar>WANT_PHP_PEAR</makevar></entry> - - <entry>Want the PEAR framework.</entry> - </row> - - </tbody> - </tgroup> - </table> - - </sect2> - - <sect2> - <title>PEAR modules</title> - - <para>Porting PEAR modules is a very simple process.</para> - - <para>Use the variables <makevar>FILES</makevar>, - <makevar>TESTS</makevar>, <makevar>DATA</makevar>, - <makevar>SQLS</makevar>, <makevar>SCRIPTFILES</makevar>, - <makevar>DOCS</makevar> and <makevar>EXAMPLES</makevar> to list the - files you want to install. All listed files will be automatically - installed into the appropriate locations and added to - <filename>pkg-plist</filename>.</para> - - <para>Include - <filename>${PORTSDIR}/devel/pear-PEAR/Makefile.common</filename> - on the last line of the <filename>Makefile</filename>.</para> - - <example id="pear-makefile"> - <title>Example Makefile for PEAR class</title> - <programlisting>PORTNAME= Date -PORTVERSION= 1.4.3 -CATEGORIES= devel www pear - -MAINTAINER= example@domain.com -COMMENT= PEAR Date and Time Zone Classes - -BUILD_DEPENDS= ${PEARDIR}/PEAR.php:${PORTSDIR}/devel/pear-PEAR -RUN_DEPENDS= ${BUILD_DEPENDS} - -FILES= Date.php Date/Calc.php Date/Human.php Date/Span.php \ - Date/TimeZone.php -TESTS= test_calc.php test_date_methods_span.php testunit.php \ - testunit_date.php testunit_date_span.php wknotest.txt \ - bug674.php bug727_1.php bug727_2.php bug727_3.php \ - bug727_4.php bug967.php weeksinmonth_4_monday.txt \ - weeksinmonth_4_sunday.txt weeksinmonth_rdm_monday.txt \ - weeksinmonth_rdm_sunday.txt -DOCS= TODO -_DOCSDIR= . - -.include <bsd.port.pre.mk> -.include "${PORTSDIR}/devel/pear-PEAR/Makefile.common" -.include <bsd.port.post.mk></programlisting> - - </example> - - </sect2> - - </sect1> - - <sect1 id="using-python"> - <title>Using Python</title> - - <table frame="none"> - <title>Most useful variables for ports that use Python</title> - - <tgroup cols="2"> - <tbody> - <row> - <entry><makevar>USE_PYTHON</makevar></entry> - - <entry>The port needs Python. Minimal required version can be - specified with values such as <literal>2.3+</literal>. - Version ranges can also be specified, by separating two version - numbers with a dash, e.g.: <literal>2.1-2.3</literal></entry> - </row> - - <row> - <entry><makevar>USE_PYDISTUTILS</makevar></entry> - - <entry>Use Python distutils for configuring, compiling and - installing. This is required when the port comes with - <filename>setup.py</filename>. This overrides the - <maketarget>do-build</maketarget> and - <maketarget>do-install</maketarget> targets - and may also override <maketarget>do-configure</maketarget> if - <makevar>GNU_CONFIGURE</makevar> is not defined.</entry> - </row> - - <row> - <entry><makevar>PYTHON_PKGNAMEPREFIX</makevar></entry> - - <entry>Used as a <makevar>PKGNAMEPREFIX</makevar> to distinguish - packages for different Python versions. - Example: <literal>py24-</literal></entry> - </row> - - <row> - <entry><makevar>PYTHON_SITELIBDIR</makevar></entry> - - <entry>Location of the site-packages tree, that contains - installation path of Python (usually <makevar>LOCALBASE</makevar>). - The <makevar>PYTHON_SITELIBDIR</makevar> variable can be very - useful when installing Python modules.</entry> - </row> - - <row> - <entry><makevar>PYTHONPREFIX_SITELIBDIR</makevar></entry> - - <entry>The PREFIX-clean variant of PYTHON_SITELIBDIR. - Always use - <literal>%%PYTHON_SITELIBDIR%%</literal> in - <filename>pkg-plist</filename> when possible. The default value of - <literal>%%PYTHON_SITELIBDIR%%</literal> is - <literal>lib/python%%PYTHON_VERSION%%/site-packages</literal></entry> - </row> - - <row> - <entry><makevar>PYTHON_CMD</makevar></entry> - - <entry>Python interpreter command line, including version - number.</entry> - </row> - - <row> - <entry><makevar>PYNUMERIC</makevar></entry> - - <entry>Dependency line for numeric extension.</entry> - </row> - - <row> - <entry><makevar>PYXML</makevar></entry> - - <entry>Dependency line for XML extension (not needed for - Python 2.0 and higher as it is also in base distribution).</entry> - </row> - - <row> - <entry><makevar>USE_TWISTED</makevar></entry> - - <entry>Add dependency on twistedCore. The list of required - components can be specified as a value of this - variable. Example: <literal>web lore pair - flow</literal></entry> - </row> - - <row> - <entry><makevar>USE_ZOPE</makevar></entry> - - <entry>Add dependency on Zope, a web application platform. - Change Python dependency to Python 2.3. Set - <makevar>ZOPEBASEDIR</makevar> containing a directory with - Zope installation.</entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>A complete list of available variables can be found in - <filename>/usr/ports/Mk/bsd.python.mk</filename>.</para> - - </sect1> - - <sect1 id="using-emacs"> - <title>Using Emacs</title> - - <para>This section is yet to be written.</para> - </sect1> - - <sect1 id="using-ruby"> - <title>Using Ruby</title> - - <table frame="none"> - <title>Useful variables for ports that use Ruby</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><makevar>USE_RUBY</makevar></entry> - - <entry>The port requires Ruby.</entry> - </row> - - <row> - <entry><makevar>USE_RUBY_EXTCONF</makevar></entry> - - <entry>The port uses <filename>extconf.rb</filename> to - configure.</entry> - </row> - - <row> - <entry><makevar>USE_RUBY_SETUP</makevar></entry> - - <entry>The port uses <filename>setup.rb</filename> to - configure.</entry> - </row> - - <row> - <entry><makevar>RUBY_SETUP</makevar></entry> - - <entry>Set to the alternative name of - <filename>setup.rb</filename>. Common value is - <filename>install.rb</filename>.</entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>The following table shows the selected variables available to port - authors via the ports infrastructure. These variables should be used - to install files into their proper locations. Use them in - <filename>pkg-plist</filename> as much as possible. These variables - should not be redefined in the port.</para> - - <table frame="none"> - <title>Selected read-only variables for ports that use Ruby</title> - - <tgroup cols="3"> - <thead> - <row> - <entry>Variable</entry> - <entry>Description</entry> - <entry>Example value</entry> - </row> - </thead> - <tbody> - - <row> - <entry><makevar>RUBY_PKGNAMEPREFIX</makevar></entry> - - <entry>Used as a <makevar>PKGNAMEPREFIX</makevar> to distinguish - packages for different Ruby versions.</entry> - - <entry><literal>ruby18-</literal></entry> - </row> - - <row> - <entry><makevar>RUBY_VERSION</makevar></entry> - - <entry>Full version of Ruby in the form of - <literal>x.y.z</literal>.</entry> - - <entry><literal>1.8.2</literal></entry> - </row> - - <row> - <entry><makevar>RUBY_SITELIBDIR</makevar></entry> - - <entry>Architecture independent libraries installation - path.</entry> - - <entry><literal>/usr/local/lib/ruby/site_ruby/1.8</literal></entry> - </row> - - <row> - <entry><makevar>RUBY_SITEARCHILIBDIR</makevar></entry> - - <entry>Architecture dependent libraries installation - path.</entry> - - <entry><literal>/usr/local/lib/ruby/site_ruby/1.8/amd64-freebsd6</literal></entry> - </row> - - <row> - <entry><makevar>RUBY_MODDOCDIR</makevar></entry> - - <entry>Module documentation installation path.</entry> - - <entry><literal>/usr/local/share/doc/ruby18/patsy</literal></entry> - </row> - - <row> - <entry><makevar>RUBY_MODEXAMPLESDIR</makevar></entry> - - <entry>Module examples installation path.</entry> - - <entry><literal>/usr/local/share/examples/ruby18/patsy</literal></entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>A complete list of available variables can be found in - <filename>/usr/ports/Mk/bsd.ruby.mk</filename>.</para> - - </sect1> - - <sect1 id="using-sdl"> - <title>Using SDL</title> - - <para>The <makevar>USE_SDL</makevar> variable is used to autoconfigure - the dependencies for ports which use an SDL based library like - <filename role="package">devel/sdl12</filename> and - <filename role="package">x11-toolkits/sdl_gui</filename>.</para> - - <para>The following SDL libraries are recognized at the moment:</para> - - <itemizedlist> - <listitem> - <para>sdl: <filename role="package">devel/sdl12</filename></para> - </listitem> - - <listitem> - <para>gfx: <filename role="package">graphics/sdl_gfx</filename></para> - </listitem> - - <listitem> - <para>gui: <filename role="package">x11-toolkits/sdl_gui</filename></para> - </listitem> - - <listitem> - <para>image: <filename role="package">graphics/sdl_image</filename></para> - </listitem> - - <listitem> - <para>ldbad: <filename role="package">devel/sdl_ldbad</filename></para> - </listitem> - - <listitem> - <para>mixer: <filename role="package">audio/sdl_mixer</filename></para> - </listitem> - - <listitem> - <para>mm: <filename role="package">devel/sdlmm</filename></para> - </listitem> - - <listitem> - <para>net: <filename role="package">net/sdl_net</filename></para> - </listitem> - - <listitem> - <para>sound: <filename role="package">audio/sdl_sound</filename></para> - </listitem> - - <listitem> - <para>ttf: <filename role="package">graphics/sdl_ttf</filename></para> - </listitem> - </itemizedlist> - - <para>Therefore, if a port has a dependency on - <filename role="package">net/sdl_net</filename> and - <filename role="package">audio/sdl_mixer</filename>, - the syntax will be:</para> - - <programlisting>USE_SDL= net mixer</programlisting> - - <para>The dependency <filename role="package">devel/sdl12</filename>, - which is required by <filename role="package">net/sdl_net</filename> and - <filename role="package">audio/sdl_mixer</filename>, is automatically - added as well.</para> - - <para>If you use <makevar>USE_SDL</makevar>, it will automatically:</para> - - <itemizedlist> - <listitem> - <para>Add a dependency on <application>sdl12-config</application> to - <makevar>BUILD_DEPENDS</makevar></para> - </listitem> - - <listitem> - <para>Add the variable <makevar>SDL_CONFIG</makevar> to - <makevar>CONFIGURE_ENV</makevar></para> - </listitem> - - <listitem> - <para>Add the dependencies of the selected libraries to the - <makevar>LIB_DEPENDS</makevar></para> - </listitem> - </itemizedlist> - - <para>To check whether an SDL library is available, you can do it - with the <makevar>WANT_SDL</makevar> variable:</para> - - <programlisting>WANT_SDL=yes - -.include <bsd.port.pre.mk> - -.if ${HAVE_SDL:Mmixer}!="" -USE_SDL+= mixer -.endif - -.include <bsd.port.post.mk></programlisting> - - </sect1> - - <sect1 id="rc-scripts"> - <title>Starting and stopping services (rc scripts)</title> - - <para><filename>rc.d</filename> scripts are used to start services on system - startup, and to give administrators a standard way of stopping, - starting and restarting the service. Ports integrate into - the system <filename>rc.d</filename> framework. Details on usage - can be found in - <ulink url="&url.books.handbook;/configtuning-rcd.html">the rc.d Handbook - chapter</ulink>. Detailed explanation of available commands are in - &man.rc.8; and &man.rc.subr.8;.</para> - - <para>One or more rc scripts can be installed:</para> - - <programlisting>USE_RC_SUBR= doormand.sh</programlisting> - - <para>Scripts must be placed in the <filename>files</filename> - subdirectory and a <literal>.in</literal> suffix must be added to their - filename. The only difference from a base system <filename>rc.d</filename> script is that the - <literal>. /etc/rc.subr</literal> line must be replaced with the - <literal>. %%RC_SUBR%%</literal>, because older versions of &os; - do not have an <filename>/etc/rc.subr</filename> file. Standard - <makevar>SUB_LIST</makevar> expansions are used too. - Use of the <literal>%%PREFIX%%</literal>, - <literal>%%LOCALBASE%%</literal>, and - <literal>%%X11BASE%%</literal> expansions is strongly encouraged as well. - More on - <makevar>SUB_LIST</makevar> in <link - linkend="using-sub-files">the relevant section</link>.</para> - - <para>Prior to &os; 6.1-RELEASE, integration with &man.rcorder.8; is available by using - <makevar>USE_RCORDER</makevar> instead of - <makevar>USE_RC_SUBR</makevar>. - However, use of this method is deprecated.</para> - - <para>As of &os; 6.1-RELEASE, local <filename>rc.d</filename> - scripts (including those installed by ports) are included in - the overall &man.rcorder.8; of the base system.</para> - - <para>Example simple <filename>rc.d</filename> script:</para> - - <programlisting>#!/bin/sh - -# PROVIDE: doormand -# REQUIRE: LOGIN -# -# Add the following lines to /etc/rc.conf.local or /etc/rc.conf -# to enable this service: -# -# doormand_enable (bool): Set to NO by default. -# Set it to YES to enable doormand. -# doormand_config (path): Set to %%PREFIX%%/etc/doormand/doormand.cf -# by default. -# - -. %%RC_SUBR%% - -name="doormand" -rcvar=${name}_enable - -command=%%PREFIX%%/sbin/doormand -command_args="-p $pidfile -f $doormand_config" -pidfile=/var/run/doormand.pid - -load_rc_config $name - -: ${doormand_enable="NO"} -: ${doormand_config="%%PREFIX%%/etc/doormand/doormand.cf"} - -run_rc_command "$1"</programlisting> - - <para>The "=" style of default variable assignment - is preferable to the ":=" style here, since the - former sets a default value only if the variable is unset, - and the latter sets one if the variable is unset - <emphasis>or</emphasis> null. - A user might very well include something like - <programlisting>doormand_flags=""</programlisting> in their - <filename>rc.conf.local</filename> file, and a variable - substitution using ":=" would inappropriately - override the user's intention.</para> - - </sect1> - </chapter> - - <chapter id="plist"> - <title>Advanced <filename>pkg-plist</filename> practices</title> - - <sect1 id="plist-sub"> - <title>Changing <filename>pkg-plist</filename> based on make - variables</title> - - <para>Some ports, particularly the <literal>p5-</literal> ports, - need to change their <filename>pkg-plist</filename> depending on - what options they are configured with (or version of - <literal>perl</literal>, in the case of <literal>p5-</literal> - ports). To make this easy, any instances in the - <filename>pkg-plist</filename> of <literal>%%OSREL%%</literal>, - <literal>%%PERL_VER%%</literal>, and - <literal>%%PERL_VERSION%%</literal> will be substituted for - appropriately. The value of <literal>%%OSREL%%</literal> is the - numeric revision of the operating system (e.g., - <literal>4.9</literal>). <literal>%%PERL_VERSION%%</literal> is - the full version number of <command>perl</command> (e.g., - <literal>5.00502</literal>) and <literal>%%PERL_VER%%</literal> - is the <command>perl</command> version number minus - the patchlevel (e.g., <literal>5.005</literal>). Several other - <literal>%%<replaceable>VARS</replaceable>%%</literal> related to - port's documentation files are described in <link - linkend="dads-documentation">the relevant section</link>.</para> - - <para>If you need to make other substitutions, you can set the - <makevar>PLIST_SUB</makevar> variable with a list of - <literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal> - pairs and instances of - <literal>%%<replaceable>VAR</replaceable>%%</literal> will be - substituted with <replaceable>VALUE</replaceable> in the - <filename>pkg-plist</filename>.</para> - - <para>For instance, if you have a port that installs many files in a - version-specific subdirectory, you can put something like</para> - - <programlisting>OCTAVE_VERSION= 2.0.13 -PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting> - - <para>in the <filename>Makefile</filename> and use - <literal>%%OCTAVE_VERSION%%</literal> wherever the version shows up - in <filename>pkg-plist</filename>. That way, when you upgrade the port, - you will not have to change dozens (or in some cases, hundreds) of - lines in the <filename>pkg-plist</filename>.</para> - - <para>This substitution (as well as addition of any <link - linkend="makefile-manpages">manual pages</link>) will be done between - the <maketarget>pre-install</maketarget> and - <maketarget>do-install</maketarget> targets, by reading from - <filename><makevar>PLIST</makevar></filename> and writing to - <filename><makevar>TMPPLIST</makevar></filename> - (default: - <filename><makevar>WRKDIR</makevar>/.PLIST.mktmp</filename>). So if - your port builds <filename><makevar>PLIST</makevar></filename> - on the fly, do so in or - before <maketarget>pre-install</maketarget>. Also, if your port - needs to edit the resulting file, do so in - <maketarget>post-install</maketarget> to a file named - <filename><makevar>TMPPLIST</makevar></filename>.</para> - - <para>Another possibility to modify port's packing list is based - on setting the variables <makevar>PLIST_FILES</makevar> and - <makevar>PLIST_DIRS</makevar>. The value of each variable - is regarded as a list of pathnames to - write to <filename><makevar>TMPPLIST</makevar></filename> - along with <filename><makevar>PLIST</makevar></filename> - contents. Names listed in <makevar>PLIST_FILES</makevar> - and <makevar>PLIST_DIRS</makevar> are subject to - <literal>%%<replaceable>VAR</replaceable>%%</literal> - substitution, as described above. - Except for that, names from <makevar>PLIST_FILES</makevar> - will appear in the final packing list unchanged, - while <literal>@dirrm</literal> will be - prepended to names from <makevar>PLIST_DIRS</makevar>. - To take effect, <makevar>PLIST_FILES</makevar> and - <makevar>PLIST_DIRS</makevar> must be set before - <filename><makevar>TMPPLIST</makevar></filename> is written, - i.e. in <maketarget>pre-install</maketarget> or earlier.</para> - </sect1> - - <sect1 id="plist-cleaning"> - <title>Empty directories</title> - - <sect2 id="plist-dir-cleaning"> - <title>Cleaning up empty directories</title> - - <para>Do make your ports remove empty directories when they are - de-installed. This is usually accomplished by adding - <literal>@dirrm</literal> lines for all directories that are - specifically created by the port. You need to delete subdirectories - before you can delete parent directories.</para> - - <programlisting> : -lib/X11/oneko/pixmaps/cat.xpm -lib/X11/oneko/sounds/cat.au + <para>Here's a seven-step procedure to convert ports to use + <command>install-info</command>. + <filename>editors/emacs</filename> will be used as an + example.</para> + + <procedure> + <step> + <para>Look at the texinfo sources and make a patch to insert + <literal>@dircategory</literal> and <literal>@direntry</literal> + statements to files that do not have them. This is part of my + patch:</para> + + <programlisting>--- ./man/vip.texi.org Fri Jun 16 15:31:11 1995 ++++ ./man/vip.texi Tue May 20 01:28:33 1997 +@@ -2,6 +2,10 @@ + + @setfilename ../info/vip + @settitle VIP ++@dircategory The Emacs editor and associated tools ++@direntry ++* VIP: (vip). A VI-emulation for Emacs. ++@end direntry + + @iftex + @finalout + :</programlisting> + + <para>The format should be self-explanatory. Many authors leave a + <filename>dir</filename> file in the source tree that contains all + the entries you need, so look around before you try to write your + own. Also, make sure you look into related ports and make the + section names and entry indentations consistent (we recommend that + all entry text start at the 4th tab stop).</para> + + <note> + <para>Note that you can put only one info entry per file because + of a bug in <command>install-info --delete</command> that + deletes only the first entry if you specify multiple entries in + the <email>@direntry</email> section.</para> + </note> + + <para>You can give the <literal>dir</literal> entries to + <command>install-info</command> as arguments + (<option>--section</option> and <option>--entry</option>) instead + of patching the texinfo sources. This probably is not a good + idea for ports because you need to duplicate the same information + in <emphasis>three</emphasis> places + (<filename>Makefile</filename> and + <literal>@exec</literal>/<literal>@unexec</literal> of + <filename>pkg-plist</filename>; see below). However, if you have + Japanese (or other multibyte encoding) info files, you will have + to use the extra arguments to <command>install-info</command> + because <command>makeinfo</command> cannot handle those texinfo + sources. (See <filename>Makefile</filename> and + <filename>pkg-plist</filename> of <filename>japanese/skk</filename> + for examples on how to do this).</para> + </step> + + <step> + <para>Go back to the port directory and do a <command>make clean; + make</command> and verify that the info files are regenerated + from the texinfo sources. Since the texinfo sources are newer than + the info files, they should be rebuilt when you type + <command>make</command>; but many <filename>Makefile</filename>s + do not include correct dependencies for info files. In + <command>emacs</command>' case, it was necessary to patch the main + <filename>Makefile.in</filename> so it would descend into the + <filename>man</filename> subdirectory to rebuild the info + pages.</para> + + <programlisting>--- ./Makefile.in.org Mon Aug 19 21:12:19 1996 ++++ ./Makefile.in Tue Apr 15 00:15:28 1997 +@@ -184,7 +184,7 @@ + # Subdirectories to make recursively. `lisp' is not included + # because the compiled lisp files are part of the distribution + # and you cannot remake them without installing Emacs first. +-SUBDIR = lib-src src ++SUBDIR = lib-src src man + + # The makefiles of the directories in $SUBDIR. + SUBDIR_MAKEFILES = lib-src/Makefile man/Makefile src/Makefile oldXMenu/Makefile + lwlib/Makefile +--- ./man/Makefile.in.org Thu Jun 27 15:27:19 1996 ++++ ./man/Makefile.in Tue Apr 15 00:29:52 1997 +@@ -66,6 +66,7 @@ + ${srcdir}/gnu1.texi \ + ${srcdir}/glossary.texi + ++all: info + info: $(INFO_TARGETS) + + dvi: $(DVI_TARGETS)</programlisting> + + <para>The second hunk was necessary because the default target in + the <filename>man</filename> subdir is called + <maketarget>info</maketarget>, while the main + <filename>Makefile</filename> wants to call + <maketarget>all</maketarget>. The installation of the + <filename>info</filename> info file was also removed because we + already have one with the same name in + <filename>/usr/share/info</filename> (that patch is not shown + here).</para> + </step> + + <step> + <para>If there is a place in the <filename>Makefile</filename> that + is installing the <filename>dir</filename> file, delete it. Your + port may not be doing it. Also, remove any commands that are + otherwise mucking around with the <filename>dir</filename> + file.</para> + + <programlisting>--- ./Makefile.in.org Mon Aug 19 21:12:19 1996 ++++ ./Makefile.in Mon Apr 14 23:38:07 1997 +@@ -368,14 +368,8 @@ + if [ `(cd ${srcdir}/info && /bin/pwd)` != `(cd ${infodir} && /bin/pwd)` ]; \ + then \ + (cd ${infodir}; \ +- if [ -f dir ]; then \ +- if [ ! -f dir.old ]; then mv -f dir dir.old; \ +- else mv -f dir dir.bak; fi; \ +- fi; \ + cd ${srcdir}/info ; \ +- (cd $${thisdir}; ${INSTALL_DATA} ${srcdir}/info/dir ${infodir}/dir); +\ +- (cd $${thisdir}; chmod a+r ${infodir}/dir); \ + for f in ccmode* cl* dired-x* ediff* emacs* forms* gnus* info* message* mh-e* sc* vip*; do \ + (cd $${thisdir}; \ + ${INSTALL_DATA} ${srcdir}/info/$$f ${infodir}/$$f; \ + chmod a+r ${infodir}/$$f); \</programlisting> + </step> + + <step> + <para>(This step is only necessary if you are modifying an existing + port.) Take a look at <filename>pkg-plist</filename> and delete + anything that is trying to patch up <filename>info/dir</filename>. + They may be in <filename>pkg-install</filename> or some other + file, so search extensively.</para> + + <programlisting>Index: pkg-plist +=================================================================== +RCS file: /usr/cvs/ports/editors/emacs/pkg-plist,v +retrieving revision 1.15 +diff -u -r1.15 pkg-plist +--- pkg-plist 1997/03/04 08:04:00 1.15 ++++ pkg-plist 1997/04/15 06:32:12 +@@ -15,9 +15,6 @@ + man/man1/emacs.1.gz + man/man1/etags.1.gz + man/man1/ctags.1.gz +-@unexec cp %D/info/dir %D/info/dir.bak +-info/dir +-@unexec cp %D/info/dir.bak %D/info/dir + info/cl + info/cl-1 + info/cl-2</programlisting> + </step> + + <step> + <para>Add a <maketarget>post-install</maketarget> target to the + <filename>Makefile</filename> to call + <maketarget>install-info</maketarget> with the installed + info files. (It is no longer necessary to create the + <filename>dir</filename> file yourself; + <command>install-info</command> automatically creates this + file if it does not exist.)</para> + + <programlisting>Index: Makefile +=================================================================== +RCS file: /usr/cvs/ports/editors/emacs/Makefile,v +retrieving revision 1.26 +diff -u -r1.26 Makefile +--- Makefile 1996/11/19 13:14:40 1.26 ++++ Makefile 1997/05/20 10:25:09 1.28 +@@ -20,5 +20,8 @@ + post-install: + .for file in emacs-19.34 emacsclient etags ctags b2m + strip ${PREFIX}/bin/${file} + .endfor ++.for info in emacs vip viper forms gnus mh-e cl sc dired-x ediff ccmode ++ install-info ${PREFIX}/info/${info} ${PREFIX}/info/dir ++.endfor + + .include <bsd.port.mk></programlisting> + </step> + + <step> + <para>Edit <filename>pkg-plist</filename> and add equivalent + <literal>@exec</literal> statements and also + <literal>@unexec</literal> for + <command>pkg_delete</command>.</para> + + <programlisting>Index: pkg-plist +=================================================================== +RCS file: /usr/cvs/ports/editors/emacs/pkg-plist,v +retrieving revision 1.15 +diff -u -r1.15 pkg-plist +--- pkg-plist 1997/03/04 08:04:00 1.15 ++++ pkg-plist 1997/05/20 10:25:12 1.17 +@@ -16,7 +14,14 @@ + man/man1/etags.1.gz + man/man1/ctags.1.gz ++@unexec install-info --delete %D/info/emacs %D/info/dir : -@dirrm lib/X11/oneko/pixmaps -@dirrm lib/X11/oneko/sounds -@dirrm lib/X11/oneko</programlisting> - - <para>However, sometimes <literal>@dirrm</literal> will give you - errors because other ports share the same directory. You - can use <literal>@dirrmtry</literal> to - remove only empty directories without warning.</para> - - <programlisting>@dirrmtry share/doc/gimp</programlisting> - - <para>This will neither print any error messages nor cause - &man.pkg.delete.1; to exit abnormally even if - <filename><makevar>${PREFIX}</makevar>/share/doc/gimp</filename> is not - empty due to other ports installing some files in there.</para> - </sect2> - - <sect2 id="plist-dir-empty"> - <title>Creating empty directories</title> - - <para>Empty directories created during port installation need special - attention. They will not get created when installing the package, - because packages only store the files, and &man.pkg.add.1; creates - directories for them as needed. To make sure the empty directory - is created when installing the package, add this line to - <filename>pkg-plist</filename> above the corresponding - <literal>@dirrm</literal> line:</para> - - <programlisting>@exec mkdir -p %D/share/foo/templates</programlisting> - </sect2> - - </sect1> - - <sect1 id="plist-config"> - <title>Configuration files</title> - - <para>If your port requires some configuration files in - <filename><makevar>PREFIX</makevar>/etc</filename>, do - <emphasis>not</emphasis> just install them and list them in - <filename>pkg-plist</filename>. That will cause - &man.pkg.delete.1; to delete files carefully edited by - the user and a new installation to wipe them out.</para> - - <para>Instead, install sample files with a suffix - (<filename><replaceable>filename</replaceable>.sample</filename> - will work well). Copy the sample file as the real configuration - file, if it does not exist. On deinstall, delete the configuration - file, but only if it was not modified by the user. You need to - handle this both in the port <filename>Makefile</filename>, and in - the <filename>pkg-plist</filename> (for installation from - the package).</para> - - <para>Example of the <filename>Makefile</filename> part:</para> - - <programlisting>post-install: - @if [ ! -f ${PREFIX}/etc/orbit.conf ]; then \ - ${CP} -p ${PREFIX}/etc/orbit.conf.sample ${PREFIX}/etc/orbit.conf ; \ - fi</programlisting> - - <para>Example of the <filename>pkg-plist</filename> part:</para> - - <programlisting>@unexec if cmp -s %D/etc/orbit.conf.sample %D/etc/orbit.conf; then rm -f %D/etc/orbit.conf; fi -etc/orbit.conf.sample -@exec if [ ! -f %D/etc/orbit.conf ] ; then cp -p %D/%F %B/orbit.conf; fi</programlisting> - - <para>Alternatively, print out a <link - linkend="porting-message">message</link> pointing out that the - user has to copy and edit the file before the software can be made - to work.</para> - </sect1> - - <sect1 id="plist-dynamic"> - <title>Dynamic vs. static package list</title> - - <para>A <emphasis>static package list</emphasis> is a package list - which is available in the Ports Collection either as a - <filename>pkg-plist</filename> file (with or without variable - substitution), or embedded into the <filename>Makefile</filename> - via <makevar>PLIST_FILES</makevar> and <makevar>PLIST_DIRS</makevar>. - Even if the contents are auto-generated by a tool or a target - in the Makefile <emphasis>before</emphasis> the inclusion into the - Ports Collection by a committer, this is still considered a - static list, since it is possible to examine it without having - to download or compile the distfile.</para> - - <para>A <emphasis>dynamic package list</emphasis> is a package list - which is generated at the time the port is compiled based upon the - files and directories which are installed. It is not possible to - examine it before the source code of the ported application - is downloaded and compiled, or after running a <literal>make - clean</literal>.</para> - - <para>While the use of dynamic package lists is not forbidden, - maintainers should use static package lists wherever possible, as it - enables users to &man.grep.1; through available ports to discover, - for example, which port installs a certain file. Dynamic lists - should be primarily used for - complex ports where the package list changes drastically based upon - optional features of the port (and thus maintaining a static package - list is infeasible), or ports which change the - package list based upon the version of dependent software used (e.g. - ports which generate docs with - <application>Javadoc</application>).</para> - - <para>Maintainers who prefer dynamic package lists are encouraged to - add a new target to their port which generates the - <filename>pkg-plist</filename> file so that users may examine - the contents.</para> - - </sect1> - - <sect1 id="plist-autoplist"> - <title>Automated package list creation</title> - - <para>First, make sure your port is almost complete, with only - <filename>pkg-plist</filename> missing.</para> - - <para>Next, create a temporary directory tree into which your port can be - installed, and install any dependencies. - <replaceable>port-type</replaceable> should be <literal>local</literal> - for non-X ports and <literal>x11-4</literal> or <literal>x11</literal> - for ports which install into the directory hierarchy of XFree86 4 - or an earlier XFree86 release, respectively.</para> - - <screen>&prompt.root; <userinput>mkdir /var/tmp/<replaceable>port-name</replaceable></userinput> -&prompt.root; <userinput>mtree -U -f /etc/mtree/BSD.<replaceable>port-type</replaceable>.dist -d -e -p /var/tmp/<replaceable>port-name</replaceable></userinput> -&prompt.root; <userinput>make depends PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput></screen> - - <para>Store the directory structure in a new file.</para> - - <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find -d * -type d) | sort > OLD-DIRS</userinput></screen> - - <para>Create an empty <filename>pkg-plist</filename> file:</para> - - <screen>&prompt.root; <userinput>touch pkg-plist</userinput></screen> - - <para>If your port honors <makevar>PREFIX</makevar> (which it should) - you can then install the port and create the package list.</para> - - <screen>&prompt.root; <userinput>make install PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput> -&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find -d * \! -type d) | sort > pkg-plist</userinput></screen> - - <para>You must also add any newly created directories to the packing - list.</para> - - <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find -d * -type d) | sort | comm -13 OLD-DIRS - | sort -r | sed -e 's#^#@dirrm #' >> pkg-plist</userinput></screen> - - <para>Finally, you need to tidy up the packing list by hand; it is not - <emphasis>all</emphasis> automated. Manual pages should be listed in - the port's <filename>Makefile</filename> under - <makevar>MAN<replaceable>n</replaceable></makevar>, and not in the - package list. User configuration files should be removed, or - installed as - <filename><replaceable>filename</replaceable>.sample</filename>. - The <filename>info/dir</filename> file should not be listed - and appropriate <filename>install-info</filename> lines should - be added as noted in the <link linkend="makefile-info">info - files</link> section. Any - libraries installed by the port should be listed as specified in the - <link linkend="porting-shlibs">shared libraries</link> section.</para> - - <para>Alternatively, use the <command>plist</command> script in - <filename>/usr/ports/Tools/scripts/</filename> to build the - package list automatically. The first step is the same as - above: take the first three lines, that is, - <command>mkdir</command>, <command>mtree</command> and - <command>make depends</command>. Then build and install the - port:</para> - - <screen>&prompt.root; <userinput>make install PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput></screen> - - <para>And let <command>plist</command> create the - <filename>pkg-plist</filename> file:</para> - - <screen>&prompt.root; <userinput>/usr/ports/Tools/scripts/plist -Md -m /etc/mtree/BSD.<replaceable>port-type</replaceable>.dist /var/tmp/<replaceable>port-name</replaceable> > pkg-plist</userinput></screen> - - <para>The packing list still has to be tidied up by hand as - stated above.</para> - - </sect1> - ++@unexec install-info --delete %D/info/ccmode %D/info/dir + info/cl + info/cl-1 +@@ -87,6 +94,18 @@ + info/viper-3 + info/viper-4 ++@exec install-info %D/info/emacs %D/info/dir + : ++@exec install-info %D/info/ccmode %D/info/dir + libexec/emacs/19.34/i386--freebsd/cvtmail + libexec/emacs/19.34/i386--freebsd/digest-doc</programlisting> + + <note> + <para>The <literal>@unexec install-info --delete</literal> + commands have to be listed before the info files themselves so + they can read the files. Also, the <literal>@exec + install-info</literal> commands have to be after the info + files and the <literal>@exec</literal> command that creates the + the <filename>dir</filename> file.</para> + </note> + </step> + + <step> + <para><link linkend="porting-testing">Test</link> and admire your + work. <!-- smiley --><emphasis>:-)</emphasis>. Check the + <filename>dir</filename> file before and after each step.</para> + </step> + </procedure> </chapter> - <chapter id="pkg-files"> + <chapter> <title>The <filename>pkg-<replaceable>*</replaceable></filename> files</title> <para>There are some tricks we have not mentioned yet about the - <filename>pkg-<replaceable>*</replaceable></filename> files - that come in handy sometimes.</para> + <filename>pkg-<replaceable>*</replaceable></filename> files + that come in handy sometimes.</para> <sect1 id="porting-message"> - <title><filename>pkg-message</filename></title> - - <para>If you need to display a message to the installer, you may place - the message in <filename>pkg-message</filename>. This capability is - often useful to display additional installation steps to be taken - after a &man.pkg.add.1; or to display licensing - information.</para> - - <note> - <para>The <filename>pkg-message</filename> file does not need to be - added to <filename>pkg-plist</filename>. Also, it will not get - automatically printed if the user is using the port, not the - package, so you should probably display it from the - <maketarget>post-install</maketarget> target yourself.</para> - </note> + <title><filename>pkg-message</filename></title> + + <para>If you need to display a message to the installer, you may place + the message in <filename>pkg-message</filename>. This capability is + often useful to display additional installation steps to be taken + after a <command>pkg_add</command> or to display licensing + information.</para> + + <note> + <para>The <filename>pkg-message</filename> file does not need to be + added to <filename>pkg-plist</filename>. Also, it will not get + automatically printed if the user is using the port, not the + package, so you should probably display it from the + <maketarget>post-install</maketarget> target yourself.</para> + </note> </sect1> - <sect1 id="pkg-install"> - <title><filename>pkg-install</filename></title> - - <para>If your port needs to execute commands when the binary package - is installed with &man.pkg.add.1; you can do this via the - <filename>pkg-install</filename> script. This script will - automatically be added to the package, and will be run twice by - &man.pkg.add.1;: the first time as - <literal>${SH} pkg-install ${PKGNAME} - PRE-INSTALL</literal> and the second time as - <literal>${SH} pkg-install ${PKGNAME} POST-INSTALL</literal>. - <literal>$2</literal> can be tested to determine which mode - the script is being run in. The <envar>PKG_PREFIX</envar> - environmental variable will be set to the package installation - directory. See &man.pkg.add.1; for - additional information.</para> - - <note> - <para>This script is not run automatically if you install the port - with <command>make install</command>. If you are depending on it - being run, you will have to explicitly call it from your port's - <filename>Makefile</filename>, with a line like - <literal>PKG_PREFIX=${PREFIX} ${SH} ${PKGINSTALL} - ${PKGNAME} PRE-INSTALL</literal>.</para> - </note> + <sect1> + <title><filename>pkg-install</filename></title> + + <para>If your port needs to execute commands when the binary package + is installed with <command>pkg_add</command> you can do this via the + <filename>pkg-install</filename> script. This script will + automatically be added to the package, and will be run twice by + <command>pkg_add</command>. The first time as + <literal>${SH} pkg-install ${PKGNAME} + PRE-INSTALL</literal> and the second time as + <literal>${SH} pkg-install ${PKGNAME} POST-INSTALL</literal>. + <literal>$2</literal> can be tested to determine which mode + the script is being run in. The <envar>PKG_PREFIX</envar> + environmental variable will be set to the package installation + directory. See &man.pkg.add.1; for + additional information.</para> + + <note> + <para>This script is not run automatically if you install the port + with <command>make install</command>. If you are depending on it + being run, you will have to explicitly call it from your port's + <filename>Makefile</filename>.</para> + </note> </sect1> - <sect1 id="pkg-deinstall"> - <title><filename>pkg-deinstall</filename></title> - - <para>This script executes when a package is removed.</para> - - <para> - This script will be run twice by &man.pkg.delete.1;. - The first time as <literal>${SH} pkg-deinstall ${PKGNAME} - DEINSTALL</literal> and the second time as - <literal>${SH} pkg-deinstall ${PKGNAME} POST-DEINSTALL</literal>. - </para> + <sect1> + <title><filename>pkg-req</filename></title> + + <para>If your port needs to determine if it should install or not, you + can create a <filename>pkg-req</filename> “requirements” + script. It will be invoked automatically at + installation/deinstallation time to determine whether or not + installation/deinstallation should proceed.</para> + + <para>The script will be run at installation time by + <command>pkg_add</command> as + <literal>pkg-req ${PKGNAME} INSTALL</literal>. + At deinstallation time it will be run by + <command>pkg_delete</command> as + <literal>pkg-req ${PKGNAME} DEINSTALL</literal>.</para> </sect1> - <sect1 id="pkg-req"> - <title><filename>pkg-req</filename></title> - - <para>If your port needs to determine if it should install or not, you - can create a <filename>pkg-req</filename> <quote>requirements</quote> - script. It will be invoked automatically at - installation/de-installation time to determine whether or not - installation/de-installation should proceed.</para> - - <para>The script will be run at installation time by - &man.pkg.add.1; as - <literal>pkg-req ${PKGNAME} INSTALL</literal>. - At de-installation time it will be run by - &man.pkg.delete.1; as - <literal>pkg-req ${PKGNAME} DEINSTALL</literal>.</para> - </sect1> + <sect1 id="porting-plist"> + <title>Changing <filename>pkg-plist</filename> based on make + variables</title> + + <para>Some ports, particularly the p5- ports, need to change their + <filename>pkg-plist</filename> depending on what options they are + configured with (or version of perl, in the case of p5- ports). To + make this easy, any instances in the <filename>pkg-plist</filename> of + <literal>%%OSREL%%</literal>, <literal>%%PERL_VER%%</literal>, and + <literal>%%PERL_VERSION%%</literal> will be substituted for + appropriately. The value of <literal>%%OSREL%%</literal> is the + numeric revision of the operating system (e.g., + <literal>2.2.7</literal>). <literal>%%PERL_VERSION%%</literal> is + the full version number of perl (e.g., <literal>5.00502</literal>) + and <literal>%%PERL_VER%%</literal> is the perl version number minus + the patchlevel (e.g., <literal>5.005</literal>).</para> + + <para>If you need to make other substitutions, you can set the + <makevar>PLIST_SUB</makevar> variable with a list of + <literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal> + pairs and instances of + <literal>%%<replaceable>VAR</replaceable>%%</literal>' will be + substituted with <replaceable>VALUE</replaceable> in the + <filename>pkg-plist</filename>.</para> + + <para>For instance, if you have a port that installs many files in a + version-specific subdirectory, you can put something like + + <programlisting>OCTAVE_VERSION= 2.0.13 +PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting> - <sect1 id="pkg-names"> - <title id="porting-pkgfiles">Changing the names of - <filename>pkg-<replaceable>*</replaceable></filename> files</title> - - <para>All the names of <filename>pkg-<replaceable>*</replaceable></filename> files - are defined using variables so you can change them in your - <filename>Makefile</filename> if need be. This is especially useful - when you are sharing the same <filename>pkg-<replaceable>*</replaceable></filename> files - among several ports or have to write to one of the above files (see - <link linkend="porting-wrkdir">writing to places other than - <makevar>WRKDIR</makevar></link> for why it is a bad idea to write - directly into the <filename>pkg-<replaceable>*</replaceable></filename> subdirectory).</para> - - <para>Here is a list of variable names and their default - values. (<makevar>PKGDIR</makevar> defaults to - <makevar>${MASTERDIR}</makevar>.)</para> - - <informaltable frame="none" pgwide="1"> - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Default value</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>DESCR</makevar></entry> - <entry><literal>${PKGDIR}/pkg-descr</literal></entry> - </row> - - <row> - <entry><makevar>PLIST</makevar></entry> - <entry><literal>${PKGDIR}/pkg-plist</literal></entry> - </row> - - <row> - <entry><makevar>PKGINSTALL</makevar></entry> - <entry><literal>${PKGDIR}/pkg-install</literal></entry> - </row> - - <row> - <entry><makevar>PKGDEINSTALL</makevar></entry> - <entry><literal>${PKGDIR}/pkg-deinstall</literal></entry> - </row> - - <row> - <entry><makevar>PKGREQ</makevar></entry> - <entry><literal>${PKGDIR}/pkg-req</literal></entry> - </row> - - <row> - <entry><makevar>PKGMESSAGE</makevar></entry> - <entry><literal>${PKGDIR}/pkg-message</literal></entry> - </row> - </tbody> - </tgroup> - </informaltable> - - <para>Please change these variables rather than overriding - <makevar>PKG_ARGS</makevar>. If you change - <makevar>PKG_ARGS</makevar>, those files will not correctly be - installed in <filename>/var/db/pkg</filename> upon install from a - port.</para> + in the <filename>Makefile</filename> and use + <literal>%%OCTAVE_VERSION%%</literal> wherever the version shows up + in <filename>pkg-plist</filename>. That way, when you upgrade the port, + you will not have to change dozens (or in some cases, hundreds) of + lines in the <filename>pkg-plist</filename>.</para> + + <para>This substitution (as well as addition of any <link + linkend="porting-manpages">man pages</link>) will be done between + the <maketarget>do-install</maketarget> and + <maketarget>post-install</maketarget> targets, by reading from + <makevar>PLIST</makevar> and writing to <makevar>TMPPLIST</makevar> + (default: + <filename><makevar>WRKDIR</makevar>/.PLIST.mktmp</filename>). So if + your port builds <makevar>PLIST</makevar> on the fly, do so in or + before <maketarget>do-install</maketarget>. Also, if your port + needs to edit the resulting file, do so in + <maketarget>post-install</maketarget> to a file named + <makevar>TMPPLIST</makevar>.</para> </sect1> - <sect1 id="using-sub-files"> - <title>Making use of <makevar>SUB_FILES</makevar> and - <makevar>SUB_LIST</makevar></title> - - <para>The <makevar>SUB_FILES</makevar> and <makevar>SUB_LIST</makevar> - variables are useful for dynamic values in port files, such as the - installation <makevar>PREFIX</makevar> in - <filename>pkg-message</filename>.</para> - - <para>The <makevar>SUB_FILES</makevar> variable specifies a list - of files to be automatically modified. Each - <replaceable>file</replaceable> in the - <makevar>SUB_FILES</makevar> list must have a corresponding - <filename><replaceable>file</replaceable>.in</filename> present - in <makevar>FILESDIR</makevar>. A modified version will - be created in <makevar>WRKDIR</makevar>. Files defined as a - value of <makevar>USE_RC_SUBR</makevar> (or the deprecated - <makevar>USE_RCORDER</makevar>) - are automatically added to the - <makevar>SUB_FILES</makevar>. For the files - <filename>pkg-message</filename>, - <filename>pkg-install</filename>, <filename>pkg-deinstall</filename> - and <filename>pkg-reg</filename>, the corresponding Makefile variable - is automatically set to point to the processed version.</para> - - <para>The <makevar>SUB_LIST</makevar> variable is a list of - <literal>VAR=VALUE</literal> pairs. For each pair - <literal>%%VAR%%</literal> will get replaced - with <literal>VALUE</literal> in each file listed in - <makevar>SUB_FILES</makevar>. Several common pairs are - automatically defined: <makevar>PREFIX</makevar>, - <makevar>LOCALBASE</makevar>, <makevar>X11BASE</makevar>, - <makevar>DATADIR</makevar>, <makevar>DOCSDIR</makevar>, - <makevar>EXAMPLESDIR</makevar>. Any line beginning with - <literal>@comment</literal> will be deleted from resulting files - after a variable substitution.</para> - - <para>The following example will replace <literal>%%ARCH%%</literal> - with the system architecture - in a <filename>pkg-message</filename>:</para> - - <programlisting>SUB_FILES= pkg-message -SUB_LIST= ARCH=${ARCH}</programlisting> - - <para>Note that for this example, the - <filename>pkg-message.in</filename> file must exist in - <makevar>FILESDIR</makevar>.</para> - - <para>Example of a good <filename>pkg-message.in</filename>:</para> - - <programlisting>Now it is time to configure this package. -Copy %%PREFIX%%/share/examples/putsy/%%ARCH%%.conf into your home directory -as .putsy.conf and edit it.</programlisting> - + <sect1> + <title id="porting-pkgfiles">Changing the names of + <filename>pkg-<replaceable>*</replaceable></filename> files</title> + + <para>All the names of <filename>pkg-<replaceable>*</replaceable></filename> files + are defined using variables so you can change them in your + <filename>Makefile</filename> if need be. This is especially useful + when you are sharing the same <filename>pkg-<replaceable>*</replaceable></filename> files + among several ports or have to write to one of the above files (see + <link linkend="porting-wrkdir">writing to places other than + <makevar>WRKDIR</makevar></link> for why it is a bad idea to write + directly in to the <filename>pkg-<replaceable>*</replaceable></filename> subdirectory).</para> + + <para>Here is a list of variable names and their default + values. (<makevar>PKGDIR</makevar> defaults to + <makevar>${MASTERDIR}</makevar>.)</para> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Variable</entry> + <entry>Default value</entry> + </row> + </thead> + + <tbody> + <row> + <entry><makevar>COMMENT</makevar></entry> + <entry><literal>${PKGDIR}/pkg-comment</literal></entry> + </row> + + <row> + <entry><makevar>DESCR</makevar></entry> + <entry><literal>${PKGDIR}/pkg-descr</literal></entry> + </row> + + <row> + <entry><makevar>PLIST</makevar></entry> + <entry><literal>${PKGDIR}/pkg-plist</literal></entry> + </row> + + <row> + <entry><makevar>PKGINSTALL</makevar></entry> + <entry><literal>${PKGDIR}/pkg-install</literal></entry> + </row> + + <row> + <entry><makevar>PKGDEINSTALL</makevar></entry> + <entry><literal>${PKGDIR}/pkg-deinstall</literal></entry> + </row> + + <row> + <entry><makevar>PKGREQ</makevar></entry> + <entry><literal>${PKGDIR}/pkg-req</literal></entry> + </row> + + <row> + <entry><makevar>PKGMESSAGE</makevar></entry> + <entry><literal>${PKGDIR}/pkg-message</literal></entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para>Please change these variables rather than overriding + <makevar>PKG_ARGS</makevar>. If you change + <makevar>PKG_ARGS</makevar>, those files will not correctly be + installed in <filename>/var/db/pkg</filename> upon install from a + port.</para> </sect1> </chapter> - <chapter id="testing"> - <title>Testing your port</title> - - <sect1 id="make-describe"> - <title>Running <command>make describe</command></title> + <chapter> + <title>Licensing Problems</title> - <para>Several of the &os; port maintenance tools, such as - &man.portupgrade.1;, rely on a database called - <filename>/usr/ports/INDEX</filename> which keeps track of such - items as port dependencies. <filename>INDEX</filename> is created - by the top-level <filename>ports/Makefile</filename> via - <command>make index</command>, which descends into each - port subdirectory and executes <command>make describe</command> - there. Thus, if <command>make describe</command> fails in any - port, no one can generate <filename>INDEX</filename>, and many - people will quickly become unhappy.</para> + <para>Some software packages have restrictive licenses or can be in + violation of the law in some countries (such as violating a patent). + What we can do with + them varies a lot, depending on the exact wordings of the respective + licenses.</para> - <note> - <para>It is important to be able to generate this file no - matter what options are present in <filename>make.conf</filename>, - so please avoid doing things such as using <literal>.error</literal> - statements when (for instance) a dependency is not satisfied. - (See <xref linkend="dads-dot-error">.)</para> - </note> - - <para>If <command>make describe</command> produces a string - rather than an error message, you are probably safe. See - <filename>bsd.port.mk</filename> for the meaning of the - string produced.</para> - - <para>Also note that running a recent version of - <command>portlint</command> (as specified in the next section) - will cause <command>make describe</command> to be run - automatically.</para> - </sect1> - - <sect1 id="testing-portlint"> - <title>Portlint</title> - - <para>Do check your work with <link - linkend="porting-portlint"><command>portlint</command></link> - before you submit or commit it. <command>portlint</command> - warns you about many common errors, both functional and - stylistic. For a new (or repocopied) port, - <command>portlint -A</command> is the most thorough; for an - existing port, <command>portlint -C</command> is sufficient.</para> - - <para>Since <command>portlint</command> uses heuristics to - try to figure out errors, it can produce false positive - warnings. In addition, occasionally something that is - flagged as a problem really cannot be done in any other - way due to limitations in the ports framework. When in - doubt, the best thing to do is ask on &a.ports;.</para> - </sect1> - - <sect1 id="porting-prefix"> - <title><makevar>PREFIX</makevar></title> - - <para>Do try to make your port install relative to - <makevar>PREFIX</makevar>. The value of this variable will be set - to <makevar>LOCALBASE</makevar> (default - <filename>/usr/local</filename>). If - <makevar>USE_X_PREFIX</makevar> or <makevar>USE_IMAKE</makevar> is - set, <makevar>PREFIX</makevar> will be <makevar>X11BASE</makevar> (default - <filename>/usr/X11R6</filename>). If - <makevar>USE_LINUX_PREFIX</makevar> is set, <makevar>PREFIX</makevar> - will be <makevar>LINUXBASE</makevar> (default - <filename>/compat/linux</filename>).</para> - - <para>Avoiding the hard-coding of <filename>/usr/local</filename> or - <filename>/usr/X11R6</filename> anywhere in the source will make the - port much more flexible and able to cater to the needs of other - sites. For X ports that use <command>imake</command>, this is - automatic; otherwise, this can often be done by simply replacing the - occurrences of <filename>/usr/local</filename> (or - <filename>/usr/X11R6</filename> for X ports that do not use imake) - in the various <filename>scripts/Makefile</filename>s in the port to read - <makevar>${PREFIX}</makevar>, as this variable is automatically passed - down to every stage of the build and install processes.</para> - - <para>Make sure your application is not installing things in - <filename>/usr/local</filename> instead of <makevar>PREFIX</makevar>. - A quick test for this is to do this is:</para> - - <screen>&prompt.root; <userinput>make clean; make package PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput></screen> - - <para>If anything is installed outside of <makevar>PREFIX</makevar>, - the package creation process will complain that it - cannot find the files.</para> - - <!-- XXX This paragraph is confusing and poorly indented. --> - <para>This does not test for the existence of internal references, - or correct use of <makevar>LOCALBASE</makevar> for references to - files from other ports. Testing the installation in - <filename>/var/tmp/<replaceable>port-name</replaceable></filename> - to do that while you have it installed would do that.</para> - - <para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port - truly requires it (i.e., it links against X libs or it needs to - reference files in <makevar>X11BASE</makevar>).</para> + <note> + <para>It is your responsibility as a porter to read the licensing + terms of the software and make sure that the FreeBSD project will + not be held accountable for violating them by redistributing the + source or compiled binaries either via FTP or CDROM. If in doubt, + please contact the &a.ports;.</para> + </note> - <para>The variable <makevar>PREFIX</makevar> can be reassigned in your - <filename>Makefile</filename> or in the user's environment. - However, it is strongly discouraged for individual ports to set this - variable explicitly in the <filename>Makefile</filename>s.</para> + <para>There are two variables you can set in the Makefile to handle the + situations that arise frequently:</para> - <para>Also, refer to programs/files from other ports with the - variables mentioned above, not explicit pathnames. For instance, if - your port requires a macro <literal>PAGER</literal> to be the full - pathname of <command>less</command>, use the compiler flag: + <orderedlist> + <listitem> + <para>If the port has a “do not sell for profit” type of + license, set the variable <makevar>NO_CDROM</makevar> to a string + describing the reason why. We will make sure such ports will not go + into the CDROM come release time. The distfile and package will + still be available via FTP.</para> + </listitem> + + <listitem> + <para>If the resulting package needs to be built uniquely for each + site, or the resulting binary package cannot be distributed due to + licensing; set the variable <makevar>NO_PACKAGE</makevar> to a + string describing the reason why. We will make sure such packages + will not go on the FTP site, nor into the CDROM come release time. + The distfile will still be included on both however.</para> + </listitem> + + <listitem> + <para>If the port has legal restrictions on who can use it (e.g., + patented stuff) or has a “no commercial use” license, + set the variable <makevar>RESTRICTED</makevar> to be the string + describing the reason why. For such ports, the distfiles/packages + will not be available even from our FTP sites.</para> + </listitem> + </orderedlist> - <programlisting>-DPAGER=\"${LOCALBASE}/bin/less\"</programlisting> + <note> + <para>The GNU General Public License (GPL), both version 1 and 2, + should not be a problem for ports.</para> + </note> - instead of - <literal>-DPAGER=\"/usr/local/bin/less\"</literal>. This way it will - have a better chance of working if the system administrator has - moved the whole <filename>/usr/local</filename> tree somewhere else.</para> - </sect1> - </chapter> + <note> + <para>If you are a committer, make sure you update the + <filename>ports/LEGAL</filename> file too.</para> + </note> + </chapter> <chapter id="port-upgrading"> <title>Upgrading</title> <para>When you notice that a port is out of date compared to the latest - version from the original authors, you should first ensure that you - have the latest - port. You can find them in the - <filename>ports/ports-current</filename> directory of the &os; FTP mirror - sites. However, if you are working with more than a few - ports, you will probably find it easier to use - <application>CVSup</application> to keep your whole ports collection - up-to-date, as described in the - <ulink url="&url.books.handbook;/synching.html#CVSUP-CONFIG">Handbook</ulink>. - This will have the added benefit of tracking all the ports' - dependencies.</para> - - <para>The next step is to see if there is an update already pending. - To do this, you have two options. There is a searchable interface - to the - <ulink url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query"> - FreeBSD Problem Report (PR) database</ulink> (also known as - <literal>GNATS</literal>). Select <literal>ports</literal> in the - dropdown, and enter the name of the port.</para> - - <para>However, sometimes people forget to put the name of the port - into the Synopsis field in an unambiguous fashion. In that case, - you can try the <link linkend="portsmon"> - FreeBSD Ports Monitoring System</link> (also known as - <literal>portsmon</literal>). This system attempts to classify - port PRs by portname. To search for PRs about a particular port, - use the <ulink url="http://portsmon.FreeBSD.org/portoverview.py"> - Overview of One Port</ulink>.</para> - - <para>If there is no pending PR, the next step is to send an email - to the port's maintainer, as shown by - <command>make maintainer</command>. That person may - already be working on an upgrade, or have a reason to not upgrade the - port right now (because of, for example, stability problems of the new - version); you would not want to duplicate their work. Note that - unmaintained ports are listed with a maintainer of - <literal>ports@FreeBSD.org</literal>, which is just the general - ports mailing list, so sending mail there - probably will not help in this case.</para> - - <para>If the maintainer asks you to do the upgrade or there is - no maintainer, then you have a chance to help out &os; by - preparing the update yourself! Please make the changes and save - the result of the - recursive <command>diff</command> output - of the new and old - ports directories (e.g., if your modified port directory is - called <filename>superedit</filename> and the original is in our tree - as <filename>superedit.bak</filename>, then save the result of - <command>diff -ruN superedit.bak superedit</command>). Either - unified or context diff is fine, but port committers generally - prefer unified diffs. Note the use of the <literal>-N</literal> - option—this is the accepted way to force diff to properly - deal with the case of new files being added or old files being - deleted. Before sending us the diff, please examine the - output to make sure all the changes make sense. To - simplify common operations with patch files, you can use - <filename>/usr/ports/Tools/scripts/patchtool.py</filename>. - Before using it, please read - <filename>/usr/ports/Tools/scripts/README.patchtool</filename>.</para> - - <para>If the port is unmaintained, and you are actively using - it yourself, please consider volunteering to become its - maintainer. &os; has over 2000 ports without maintainers, - and this is an area where more volunteers are always needed. - (For a detailed description of the responsibilities of maintainers, - refer to the - <ulink url="&url.books.developers-handbook;/policies.html#POLICIES-MAINTAINER"> - MAINTAINER on Makefiles</ulink> section.)</para> - - <para> The best way to - send us the diff is by including it via &man.send-pr.1; (category - <literal>ports</literal>). If you are volunteering to maintain the - port, - be sure to put <literal>[maintainer update]</literal> at the beginning - of your synopsis line and set the <quote>Class</quote> of your PR - to <literal>maintainer-update</literal>. Otherwise, the - <quote>Class</quote> of your PR should be - <literal>change-request</literal>. Please mention any added or - deleted files in the message, as they have to be explicitly specified - to &man.cvs.1; when doing a commit. If the diff is more than about 20KB, - please compress and uuencode it; otherwise, just include it in the PR - as is.</para> - - <para>Before you &man.send-pr.1;, you should review the - <ulink url="&url.articles.problem-reports;/pr-writing.html"> - Writing the problem report</ulink> section in the Problem - Reports article; it contains far more information about how to write - useful problem reports.</para> - - <important> - <para>If your upgrade is motivated by security concerns or a - serious fault in the currently committed port, please notify - the &a.portmgr; to request immediate rebuilding and - redistribution of your port's package. Unsuspecting users - of &man.pkg.add.1; will otherwise continue to install the - old version via <command>pkg_add -r</command> for several - weeks.</para> - </important> + version from the original authors, first make sure you have the latest + port. You can find them in the + <filename>ports/ports-current</filename> directory of the FTP mirror + sites. You may also use CVSup to keep your whole ports collection + up-to-date, as described in <ulink url="../handbook/synching.html#CVSUP-CONFIG">the Handbook</ulink>.</para> + + <para>The next step is to send a mail to the maintainer, if one is + listed in the port's <filename>Makefile</filename>. That person may + already be working on an upgrade, or have a reason to not upgrade the + port right now (because of, for example, stability problems of the new + version).</para> + + <para>If the maintainer asks you to do the upgrade or there is not any + such person to begin with, please make the upgrade and send the + recursive diff (either unified or context diff is fine, but port + committers appear to prefer unified diff more) of the new and old + ports directories to us (e.g., if your modified port directory is + called <filename>superedit</filename> and the original as in our tree + is <filename>superedit.bak</filename>, then send us the result of + <command>diff -ruN superedit.bak superedit</command>). Please examine + the output to make sure all the changes make sense. The best way to + send us the diff is by including it via &man.send-pr.1; (category + <literal>ports</literal>). Please mention any added or deleted files + in the message, as they have to be explicitly specified to CVS when + doing a commit. If the diff is more than about 20KB, please compress + and uuencode it; otherwise, just include it in the PR as is.</para> <note> - <para>Once again, please use &man.diff.1; and not &man.shar.1; to send - updates to existing ports!</para> + <para>Once again, please use &man.diff.1; and not &man.shar.1; to send + updates to existing ports!</para> </note> - - <para>Now that you have done all that, you will want to read about - how to keep up-to-date in <xref linkend="keeping-up">.</para> - </chapter> - <chapter id="security"> - <title>Ports security</title> - - <sect1 id="security-intro"> - <title>Why security is so important</title> - - <para>Bugs are occasionally introduced to the software. - Arguably, the most dangerous of them are those opening - security vulnerabilities. From the technical viewpoint, - such vulnerabilities are to be closed by exterminating - the bugs that caused them. However, the policies for - handling mere bugs and security vulnerabilities are - very different.</para> - - <para>A typical small bug affects only those users who have - enabled some combination of options triggering the bug. - The developer will eventually release a patch followed - by a new version of the software, free of the bug, but - the majority of users will not take the trouble of upgrading - immediately because the bug has never vexed them. A - critical bug that may cause data loss represents a graver - issue. Nevertheless, prudent users know that a lot of - possible accidents, besides software bugs, are likely to - lead to data loss, and so they make backups of important - data; in addition, a critical bug will be discovered - really soon.</para> - - <para>A security vulnerability is all different. First, - it may remain unnoticed for years because often it does - not cause software malfunction. Second, a malicious party - can use it to gain unauthorized access to a vulnerable - system, to destroy or alter sensitive data; and in the - worst case the user will not even notice the harm caused. - Third, exposing a vulnerable system often assists attackers - to break into other systems that could not be compromised - otherwise. Therefore closing a vulnerability alone is - not enough: the audience should be notified of it in most - clear and comprehensive manner, which will allow to - evaluate the danger and take appropriate actions.</para> - </sect1> - - <sect1 id="security-fix"> - <title>Fixing security vulnerabilities</title> - - <para>While on the subject of ports and packages, a security - vulnerability may initially appear in the original - distribution or in the port files. In the former case, - the original software developer is likely to release a - patch or a new version instantly, and you will - only need to update the port promptly with respect to - the author's fix. If the fix is delayed for some reason, - you should either <link linkend="dads-noinstall">mark the port as - <makevar>FORBIDDEN</makevar></link> - or introduce a patch file of your own to the port. In - the case of a vulnerable port, just fix the port as soon as - possible. In either case, <link linkend="port-upgrading">the - standard procedure for submitting your change</link> should - be followed unless you have rights to commit it directly - to the ports tree.</para> - - <important> - <para>Being a ports committer is not enough to commit to - an arbitrary port. Remember that ports usually have - maintainers, whom you should respect.</para> - </important> - - <para>Please make sure that the port's revision is bumped - as soon as the vulnerability has been closed. - That is how the users who upgrade installed packages - on a regular basis will see they need to run an update. - Besides, a new package will be built and distributed - over FTP and WWW mirrors, replacing the vulnerable one. - <makevar>PORTREVISION</makevar> should be bumped unless - <makevar>PORTVERSION</makevar> has changed in the course - of correcting the vulnerability. That is you should - bump <makevar>PORTREVISION</makevar> if you have added a - patch file to the port, but you should not if you have updated - the port to the latest software version and thus already - touched <makevar>PORTVERSION</makevar>. Please refer to the - <link linkend="makefile-naming-revepoch">corresponding section</link> - for more information.</para> - </sect1> - - <sect1 id="security-notify"> - <title>Keeping the community informed</title> - - <sect2 id="security-notify-vuxml-db"> - <title>The VuXML database</title> - - <para>A very important and urgent step to take as early as - a security vulnerability is discovered is to notify the - community of port users about the jeopardy. Such - notification serves two purposes. First, should the danger - be really severe, it will be wise to apply an instant workaround, - e.g., stop the affected network service or even deinstall - the port completely, until the vulnerability is closed. - Second, a lot of users tend to upgrade installed packages - just occasionally. They will know from the notification - that they <emphasis>must</emphasis> update the package - without delay as soon as a corrected version is available.</para> - - <para>Given the huge number of ports in the tree, - a security advisory cannot be issued on each incident - without creating a flood and losing the attention of - the audience by the time it comes to really serious - matters. Therefore security vulnerabilities found in - ports are recorded in <ulink - url="http://vuxml.freebsd.org/">the FreeBSD VuXML - database</ulink>. The Security Officer Team members - are monitoring it for issues requiring their - intervention.</para> - - <para>If you have committer rights, you can update the VuXML - database by yourself. So you will both help the Security - Officer Team and deliver the crucial information to the - community earlier. However, if you are not a committer, - or you believe you have found an exceptionally severe - vulnerability, or whatever, please do not hesitate to - contact the Security Officer Team directly as described - on the <ulink - url="http://www.freebsd.org/security/#how">FreeBSD - Security Information</ulink> page.</para> - - <para>All right, you elected the hard way. As it may be obvious - from its title, the VuXML database is essentially an - XML document. Its source file <filename>vuln.xml</filename> - is kept right inside the port <filename - role="package">security/vuxml</filename>. Therefore - the file's full pathname will be - <filename><envar>PORTSDIR</envar>/security/vuxml/vuln.xml</filename>. - Each time you discover a security vulnerability in a - port, please add an entry for it to that file. - Until you are familiar with VuXML, the best thing you can - do is to find an existing entry fitting your case, then copy - it and use as a template.</para> - </sect2> - - <sect2 id="security-notify-vuxml-intro"> - <title>A short introduction to VuXML</title> - - <para>The full-blown XML is complex and far beyond the scope of - this book. However, to gain basic insight on the structure - of a VuXML entry, you need only the notion of tags. XML - tag names are enclosed in angle brackets. Each opening - <tag> must have a matching closing </tag>. - Tags may be nested. If nesting, the inner tags must be - closed before the outer ones. There is a hierarchy of - tags, i.e. more complex rules of nesting them. Sounds - very similar to HTML, doesn't it? The major difference - is that XML is e<emphasis>X</emphasis>tensible, i.e. based - on defining custom tags. Due to its intrinsic structure, - XML puts otherwise amorphous data into shape. VuXML is - particularly tailored to mark up descriptions of security - vulnerabilities.</para> - - <para>Now let's consider a realistic VuXML entry:</para> - - <programlisting><vuln vid="f4bc80f4-da62-11d8-90ea-0004ac98a7b9"> <co id="co-vx-vid"> - <topic>Several vulnerabilities found in Foo</topic> <co id="co-vx-top"> - <affects> - <package> - <name>foo</name> <co id="co-vx-nam"> - <name>foo-devel</name> - <name>ja-foo</name> - <range><ge>1.6</ge><lt>1.9</lt></range> <co id="co-vx-rng"> - <range><ge>2.*</ge><lt>2.4_1</lt></range> - <range><eq>3.0b1</eq></range> - </package> - <package> - <name>openfoo</name> <co id="co-vx-nm2"> - <range><lt>1.10_7</lt></range> <co id="co-vx-epo"> - <range><ge>1.2,1</ge><lt>1.3_1,1</lt></range> - </package> - </affects> - <description> - <body xmlns="http://www.w3.org/1999/xhtml"> - <p>J. Random Hacker reports:</p> <co id="co-vx-bdy"> - <blockquote - cite="http://j.r.hacker.com/advisories/1"> - <p>Several issues in the Foo software may be exploited - via carefully crafted QUUX requests. These requests will - permit the injection of Bar code, mumble theft, and the - readability of the Foo administrator account.</p> - </blockquote> - </body> - </description> - <references> <co id="co-vx-ref"> - <freebsdsa>SA-10:75.foo</freebsdsa> <co id="co-vx-fsa"> - <freebsdpr>ports/987654</freebsdpr> <co id="co-vx-fpr"> - <cvename>CAN-2010-0201</cvename> <co id="co-vx-cve"> - <cvename>CAN-2010-0466</cvename> - <bid>96298</bid> <co id="co-vx-bid"> - <certsa>CA-2010-99</certsa> <co id="co-vx-cts"> - <certvu>740169</certvu> <co id="co-vx-ctv"> - <uscertsa>SA10-99A</uscertsa> <co id="co-vx-ucs"> - <uscertta>SA10-99A</uscertta> <co id="co-vx-uct"> - <mlist msgid="201075606@hacker.com">http://marc.theaimsgroup.com/?l=bugtraq&amp;m=203886607825605</mlist> <co id="co-vx-mls"> - <url>http://j.r.hacker.com/advisories/1</url> <co id="co-vx-url"> - </references> - <dates> - <discovery>2010-05-25</discovery> <co id="co-vx-dsc"> - <entry>2010-07-13</entry> <co id="co-vx-ent"> - <modified>2010-09-17</entry> <co id="co-vx-mod"> - </dates> -</vuln></programlisting> - - <para>The tag names are supposed to be self-descriptive, - so we shall take a closer look only at fields you will need - to fill in by yourself:</para> - - <calloutlist> - <callout arearefs="co-vx-vid"> - <para>This is the top-level tag of a VuXML entry. It has - a mandatory attribute, <literal>vid</literal>, - specifying a universally unique identifier (UUID) for - this entry (in quotes). You should generate a UUID - for each new VuXML entry (and do not forget to substitute - it for the template UUID unless you are writing the - entry from scratch). You can use &man.uuidgen.1; in - FreeBSD 5.x, or you may install the port <filename - role="package">devel/p5-Data-UUID</filename> and issue - the following command:</para> - - <programlisting>perl -MData::UUID -le 'print lc new Data::UUID->create_str'</programlisting> - </callout> - - <callout arearefs="co-vx-top"> - <para>This is a one-line description of the issue found.</para> - </callout> - - <callout arearefs="co-vx-nam"> - <para>The names of packages affected are listed there. - Multiple names can be given since several packages may be - based on a single master port or software product. This - may include stable and development branches, localized - versions, and slave ports featuring different choices of - important build-time configuration options.</para> - - <important> - <para>It is your responsibility to find all such related - packages when writing a VuXML entry. Keep in mind that - <literal>make search name=foo</literal> is your friend. - The primary points to look for are as follows:</para> - - <itemizedlist> - <listitem> - <para>the <filename>foo-devel</filename> variant - for a <filename>foo</filename> port;</para> - </listitem> - - <listitem> - <para>other variants with a suffix like - <literal>-a4</literal> (for print-related packages), - <literal>-without-gui</literal> (for packages with X - support disabled), or similar;</para> - </listitem> - - <listitem> - <para><literal>jp-</literal>, <literal>ru-</literal>, - <literal>zh-</literal>, and other possible localized - variants in the corresponding national categories of - the ports collection.</para> - </listitem> - </itemizedlist> - </important> - </callout> - - <callout arearefs="co-vx-rng"> - <para>Affected versions of the package(s) are specified - there as one or more ranges using a combination of - <literal><lt></literal>, <literal><le></literal>, - <literal><eq></literal>, <literal><ge></literal>, - and <literal><gt></literal> elements. The - version ranges given should not overlap.</para> - - <para>In a range specification, <literal>*</literal> (asterisk) - denotes the smallest version number. In particular, - <literal>2.*</literal> is less than <literal>2.a</literal>. - Therefore an asterisk may be used for a range to match all - possible <literal>alpha</literal>, <literal>beta</literal>, - and <literal>RC</literal> versions. For instance, - <literal><ge>2.*</ge><lt>3.*</lt></literal> - will selectively match every <literal>2.x</literal> version while - <literal><ge>2.0</ge><lt>3.0</lt></literal> - will obviously not since the latter misses - <literal>2.r3</literal> and matches - <literal>3.b</literal>.</para> - - <para>The above example - specifies that affected are versions from <literal>1.6</literal> - to <literal>1.9</literal> inclusive, versions - <literal>2.x</literal> before <literal>2.4_1</literal>, - and version <literal>3.0b1</literal>.</para> - </callout> - - <callout arearefs="co-vx-nm2"> - <para>Several related package groups (essentially, ports) - can be listed in the <literal><affected></literal> - section. This can be used if several software products - (say FooBar, FreeBar and OpenBar) grow from the same code base - and still share its bugs and vulnerabilities. Note the - difference from listing multiple names within a single - <package> section.</para> - </callout> - - <callout arearefs="co-vx-epo"> - <para>The version ranges should allow for - <makevar>PORTEPOCH</makevar> and - <makevar>PORTREVISION</makevar> if applicable. - Please remember that according to the collation rules, - a version with a non-zero <makevar>PORTEPOCH</makevar> is - greater than any version without - <makevar>PORTEPOCH</makevar>, e.g., <literal>3.0,1</literal> - is greater than <literal>3.1</literal> or even than - <literal>8.9</literal>.</para> - </callout> - - <callout arearefs="co-vx-bdy"> - <para>This is a summary of the issue. - XHTML is used in this field. At least enclosing - <literal><p></literal> and <literal></p></literal> - should appear. More complex mark-up may be used, but only for - the sake of accuracy and clarity: No eye candy please.</para> - </callout> - - <callout arearefs="co-vx-ref"> - <para>This section contains references to relevant documents. - As many references as apply are encouraged.</para> - </callout> - - <callout arearefs="co-vx-fsa"> - <para>This is a - <ulink url="http://www.freebsd.org/security/#adv">FreeBSD - security advisory</ulink>.</para> - </callout> - - <callout arearefs="co-vx-fpr"> - <para>This is a - <ulink url="http://www.freebsd.org/support.html#gnats">FreeBSD - problem report</ulink>.</para> - </callout> - - <callout arearefs="co-vx-cve"> - <para>This is a <ulink url="http://www.cve.mitre.org/">Mitre - CVE</ulink> identifier.</para> - </callout> - - <callout arearefs="co-vx-bid"> - <para>This is a - <ulink url="http://www.securityfocus.com/bid">SecurityFocus - Bug ID</ulink>.</para> - </callout> - - <callout arearefs="co-vx-cts"> - <para>This is a - <ulink url="http://www.cert.org/">US-CERT</ulink> - security advisory.</para> - </callout> - - <callout arearefs="co-vx-ctv"> - <para>This is a - <ulink url="http://www.cert.org/">US-CERT</ulink> - vulnerability note.</para> - </callout> - - <callout arearefs="co-vx-ucs"> - <para>This is a - <ulink url="http://www.cert.org/">US-CERT</ulink> - Cyber Security Alert.</para> - </callout> - - <callout arearefs="co-vx-uct"> - <para>This is a - <ulink url="http://www.cert.org/">US-CERT</ulink> - Technical Cyber Security Alert.</para> - </callout> - - <callout arearefs="co-vx-mls"> - <para>This is a URL to an archived posting in a mailing list. - The attribute <literal>msgid</literal> is optional and - may specify the message ID of the posting.</para> - </callout> - - <callout arearefs="co-vx-url"> - <para>This is a generic URL. It should be used only if none of - the other reference categories apply.</para> - </callout> - - <callout arearefs="co-vx-dsc"> - <para>This is the date when the issue was disclosed - (<replaceable>YYYY-MM-DD</replaceable>).</para> - </callout> - - <callout arearefs="co-vx-ent"> - <para>This is the date when the entry was added - (<replaceable>YYYY-MM-DD</replaceable>).</para> - </callout> - - <callout arearefs="co-vx-mod"> - <para>This is the date when any information in the entry - was last modified (<replaceable>YYYY-MM-DD</replaceable>). - New entries must not include this field. It should be added - upon editing an existing entry.</para> - </callout> - </calloutlist> - </sect2> - - <sect2 id="security-notify-vuxml-testing"> - <title>Testing your changes to the VuXML database</title> - - <para>Assume you just wrote or filled in an entry for a - vulnerability in the package <literal>clamav</literal> - that has been fixed in version <literal>0.65_7</literal>.</para> - - <para>As a prerequisite, you need to install fresh versions of the - ports <filename role="package">security/portaudit</filename> and - <filename role="package">security/portaudit-db</filename>.</para> - - <para>First, check whether there already is an entry for this - vulnerability. If there were such entry, it would match the - previous version of the package, - <literal>0.65_6</literal>:</para> - - <screen>&prompt.user; <userinput>packaudit</userinput> -&prompt.user; <userinput>portaudit clamav-0.65_6</userinput></screen> - - <note> - <para>To run <command>packaudit</command>, you must have - permission to write to its - <filename><makevar>DATABASEDIR</makevar></filename>, - typically <filename>/var/db/portaudit</filename>.</para> - </note> - - <para>If there is none found, you get the green light to add - a new entry for this vulnerability. Now you can generate - a brand-new UUID (assume it's - <literal>74a9541d-5d6c-11d8-80e3-0020ed76ef5a</literal>) and - add your new entry to the VuXML database. Please verify - its syntax after that as follows:</para> - - <screen>&prompt.user; <userinput>cd ${PORTSDIR}/security/vuxml && make validate</userinput></screen> - - <note> - <para>You will need at least one of the following packages - installed: <filename role="package">textproc/libxml2</filename>, - <filename role="package">textproc/jade</filename>.</para> - </note> - - <para>Now rebuild the <command>portaudit</command> database - from the VuXML file:</para> - - <screen>&prompt.user; <userinput>packaudit</userinput></screen> - - <para>To verify that the <literal><affected></literal> - section of your entry will match correct package(s), issue - the following command:</para> - - <screen>&prompt.user; <userinput>portaudit -f /usr/ports/INDEX -r 74a9541d-5d6c-11d8-80e3-0020ed76ef5a</userinput></screen> - - <note> - <para>Please refer to &man.portaudit.1; for better understanding - of the command syntax.</para> - </note> - - <para>Make sure that your entry produces no spurious matches - in the output.</para> - - <para>Now check whether the right package versions are matched - by your entry:</para> - - <screen>&prompt.user; <userinput>portaudit clamav-0.65_6 clamav-0.65_7</userinput> -Affected package: clamav-0.65_6 (matched by clamav<0.65_7) -Type of problem: clamav remote denial-of-service. -Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.html> - -1 problem(s) found.</screen> - - <para>Obviously, the former version should match while the - latter one should not.</para> - - <para>Finally, verify whether the web page generated from the - VuXML database looks like expected:</para> - - <screen>&prompt.user; <userinput>mkdir -p ~/public_html/portaudit</userinput> -&prompt.user; <userinput>packaudit</userinput> -&prompt.user; <userinput>lynx ~/public_html/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.html</userinput></screen> - </sect2> - </sect1> - </chapter> - - <chapter id="porting-dads"> - <title>Dos and Don'ts</title> - - <sect1 id="dads-intro"> - <title>Introduction</title> + <chapter> + <title><anchor id="porting-dads">Dos and Don'ts</title> <para>Here is a list of common dos and don'ts that you encounter during - the porting process. You should check your own port against this list, - but you can also check ports in the <ulink url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">PR database</ulink> that others have - submitted. Submit any comments on ports you check as described in - <ulink url="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug Reports and General - Commentary</ulink>. Checking ports in the PR database will both make - it faster for us to commit them, and prove that you know what you are - doing.</para> + the porting process.You should check your own port against this list, + but you can also check ports in the PR database that others have + submitted. Submit any comments on ports you check as described in + <ulink url="../handbook/contrib-how.html#CONTRIB-GENERAL">Bug Reports and General + Commentary</ulink>. Checking ports in the PR database will both make + it faster for us to commit them, and prove that you know what you are + doing.</para> + + <sect1> + <title>Strip Binaries</title> + + <para>Do strip binaries. If the original source already strips the + binaries, fine; otherwise you should add a + <literal>post-install</literal> rule to it yourself. Here is an + example:</para> + + <programlisting>post-install: + strip ${PREFIX}/bin/xdl</programlisting> + + <para>Use the &man.file.1; command on the installed executable to + check whether the binary is stripped or not. If it does not say + <literal>not stripped</literal>, it is stripped.</para> </sect1> - <sect1 id="dads-strip"> - <title>Stripping Binaries</title> - - <para>Do not strip binaries manually unless you have to. All binaries - should be stripped, but the <maketarget>INSTALL_PROGRAM</maketarget> - macro will install and strip a binary at the same time (see the next - section).</para> - - <para>If you need to strip a file, but do not wish to use the - <makevar>INSTALL_PROGRAM</makevar> macro, - <makevar>${STRIP_CMD}</makevar> will strip your program. This is - typically done within the <literal>post-install</literal> - target. For example:</para> - - <programlisting>post-install: - ${STRIP_CMD} ${PREFIX}/bin/xdl</programlisting> - - <para>Use the &man.file.1; command on the installed executable to - check whether the binary is stripped or not. If it does not say - <literal>not stripped</literal>, it is stripped. Additionally, - &man.strip.1; will not strip a previously stripped program; it - will instead exit cleanly.</para> - </sect1> - - <sect1 id="dads-install"> - <title>INSTALL_* macros</title> - - <para>Do use the macros provided in <filename>bsd.port.mk</filename> - to ensure correct modes and ownership of files in your own - <maketarget>*-install</maketarget> targets.</para> - - <itemizedlist> - <listitem> - <para><makevar>INSTALL_PROGRAM</makevar> is a command to install - binary executables.</para> - </listitem> - - <listitem> - <para><makevar>INSTALL_SCRIPT</makevar> is a command to install - executable scripts.</para> - </listitem> - - <listitem> - <para><makevar>INSTALL_DATA</makevar> is a command to install - sharable data.</para> - </listitem> - - <listitem> - <para><makevar>INSTALL_MAN</makevar> is a command to install - manpages and other documentation (it does not compress - anything).</para> - </listitem> - </itemizedlist> - - <para>These are basically the <command>install</command> command with - all the appropriate flags. See below for an example on how to use - them.</para> + <sect1> + <title>INSTALL_* macros</title> + + <para>Do use the macros provided in <filename>bsd.port.mk</filename> + to ensure correct modes and ownership of files in your own + <maketarget>*-install</maketarget> targets.</para> + + <itemizedlist> + <listitem> + <para><makevar>INSTALL_PROGRAM</makevar> is a command to install + binary executables.</para> + </listitem> + + <listitem> + <para><makevar>INSTALL_SCRIPT</makevar> is a command to install + executable scripts.</para> + </listitem> + + <listitem> + <para><makevar>INSTALL_DATA</makevar> is a command to install + sharable data.</para> + </listitem> + + <listitem> + <para><makevar>INSTALL_MAN</makevar> is a command to install + manpages and other documentation (it does not compress + anything).</para> + </listitem> + </itemizedlist> + + <para>These are basically the <command>install</command> command with + all the appropriate flags. See below for an example on how to use + them.</para> </sect1> <sect1 id="porting-wrkdir"> - <title><makevar>WRKDIR</makevar></title> - - <para>Do not write anything to files outside - <makevar>WRKDIR</makevar>. <makevar>WRKDIR</makevar> is the only - place that is guaranteed to be writable during the port build (see - <ulink url="&url.books.handbook;/ports-using.html#PORTS-CD"> - installing ports from a CDROM</ulink> for an - example of building ports from a read-only tree). If you need to - modify one of the <filename>pkg-<replaceable>*</replaceable></filename> - files, do so by <link - linkend="porting-pkgfiles">redefining a variable</link>, not by - writing over it.</para> + <title><makevar>WRKDIR</makevar></title> + + <para>Do not write anything to files outside + <makevar>WRKDIR</makevar>. <makevar>WRKDIR</makevar> is the only + place that is guaranteed to be writable during the port build (see + <ulink url="../handbook/ports-using.html#PORTS-CD">compiling ports from CDROM</ulink> for an + example of building ports from a read-only tree). If you need to + modify one of the <filename>pkg-<replaceable>*</replaceable></filename> + files, do so by <link + linkend="porting-pkgfiles">redefining a variable</link>, not by + writing over it.</para> </sect1> <sect1 id="porting-wrkdirprefix"> - <title><makevar>WRKDIRPREFIX</makevar></title> - - <para>Make sure your port honors <makevar>WRKDIRPREFIX</makevar>. - Most ports do not have to worry about this. In particular, if you - are referring to a <makevar>WRKDIR</makevar> of another port, note - that the correct location is - <filename><makevar>WRKDIRPREFIX</makevar><makevar>PORTSDIR</makevar>/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> not <filename><makevar>PORTSDIR</makevar>/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or <filename><makevar>.CURDIR</makevar>/../../<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or some such.</para> - - <para>Also, if you are defining <makevar>WRKDIR</makevar> yourself, - make sure you prepend - <literal>${WRKDIRPREFIX}${.CURDIR}</literal> in the - front.</para> + <title><makevar>WRKDIRPREFIX</makevar></title> + + <para>Make sure your port honors <makevar>WRKDIRPREFIX</makevar>. + Most ports do not have to worry about this. In particular, if you + are referring to a <makevar>WRKDIR</makevar> of another port, note + that the correct location is + <filename><makevar>WRKDIRPREFIX</makevar><makevar>PORTSDIR</makevar>/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> not <filename><makevar>PORTSDIR</makevar>/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or <filename><makevar>.CURDIR</makevar>/../../<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or some such.</para> + + <para>Also, if you are defining <makevar>WRKDIR</makevar> yourself, + make sure you prepend + <literal>${WRKDIRPREFIX}${.CURDIR}</literal> in the + front.</para> </sect1> <sect1 id="porting-versions"> - <title>Differentiating operating systems and OS versions</title> - - <para>You may come across code that needs modifications or conditional - compilation based upon what version of Unix it is running under. If - you need to make such changes to the code for conditional - compilation, make sure you make the changes as general as possible - so that we can back-port code to older FreeBSD systems and cross-port - to other BSD systems such as 4.4BSD from CSRG, BSD/386, 386BSD, - NetBSD, and OpenBSD.</para> - - <para>The preferred way to tell 4.3BSD/Reno (1990) and newer versions - of the BSD code apart is by using the <literal>BSD</literal> macro - defined in - <ulink url="http://cvsweb.freebsd.org/src/sys/sys/param.h">sys/param.h</ulink>. - Hopefully that - file is already included; if not, add the code:</para> - - <programlisting>#if (defined(__unix__) || defined(unix)) && !defined(USG) + <title>Differentiating operating systems and OS versions</title> + + <para>You may come across code that needs modifications or conditional + compilation based upon what version of Unix it is running under. If + you need to make such changes to the code for conditional + compilation, make sure you make the changes as general as possible + so that we can back-port code to FreeBSD 1.x systems and cross-port + to other BSD systems such as 4.4BSD from CSRG, BSD/386, 386BSD, + NetBSD, and OpenBSD.</para> + + <para>The preferred way to tell 4.3BSD/Reno (1990) and newer versions + of the BSD code apart is by using the <literal>BSD</literal> macro + defined in <filename><sys/param.h></filename>. Hopefully that + file is already included; if not, add the code:</para> + + <programlisting>#if (defined(__unix__) || defined(unix)) && !defined(USG) #include <sys/param.h> #endif</programlisting> - <para>to the proper place in the <filename>.c</filename> file. We - believe that every system that defines these two symbols has - <filename>sys/param.h</filename>. If you find a system that - does not, we would like to know. Please send mail to the - &a.ports;.</para> + <para>to the proper place in the <filename>.c</filename> file. We + believe that every system that defines these two symbols has + <filename>sys/param.h</filename>. If you find a system that + does not, we would like to know. Please send mail to the + &a.ports;.</para> - <para>Another way is to use the GNU Autoconf style of doing - this:</para> + <para>Another way is to use the GNU Autoconf style of doing + this:</para> - <programlisting>#ifdef HAVE_SYS_PARAM_H + <programlisting>#ifdef HAVE_SYS_PARAM_H #include <sys/param.h> #endif</programlisting> - <para>Do not forget to add <literal>-DHAVE_SYS_PARAM_H</literal> to the - <makevar>CFLAGS</makevar> in the <filename>Makefile</filename> for - this method.</para> - - <para>Once you have <filename>sys/param.h</filename> included, you may - use:</para> - - <programlisting>#if (defined(BSD) && (BSD >= 199103))</programlisting> - - <para>to detect if the code is being compiled on a 4.3 Net2 code base - or newer (e.g. FreeBSD 1.x, 4.3/Reno, NetBSD 0.9, 386BSD, BSD/386 - 1.1 and below).</para> - - <para>Use:</para> - - <programlisting>#if (defined(BSD) && (BSD >= 199306))</programlisting> - - <para>to detect if the code is being compiled on a 4.4 code base or - newer (e.g. FreeBSD 2.x, 4.4, NetBSD 1.0, BSD/386 2.0 or - above).</para> - - <para>The value of the <literal>BSD</literal> macro is - <literal>199506</literal> for the 4.4BSD-Lite2 code base. This is - stated for informational purposes only. It should not be used to - distinguish between versions of FreeBSD based only on 4.4-Lite vs. - versions that have merged in changes from 4.4-Lite2. The - <literal>__FreeBSD__</literal> macro should be used instead.</para> - - <para>Use sparingly:</para> - - <itemizedlist> - <listitem> - <para><literal>__FreeBSD__</literal> is defined in all versions of - FreeBSD. Use it if the change you are making - <emphasis>only</emphasis> affects FreeBSD. Porting gotchas like - the use of <literal>sys_errlist[]</literal> vs - <function>strerror()</function> are Berkeley-isms, not FreeBSD - changes.</para> - </listitem> - - <listitem> - <para>In FreeBSD 2.x, <literal>__FreeBSD__</literal> is defined to - be <literal>2</literal>. In earlier versions, it is - <literal>1</literal>. Later versions always bump it to match - their major version number.</para> - </listitem> - - <listitem> - <para>If you need to tell the difference between a FreeBSD 1.x - system and a FreeBSD 2.x or above system, usually the right answer - is to use the <literal>BSD</literal> macros described above. If - there actually is a FreeBSD specific change (such as special - shared library options when using <command>ld</command>) then it - is OK to use <literal>__FreeBSD__</literal> and <literal>#if - __FreeBSD__ > 1</literal> to detect a FreeBSD 2.x and later - system. If you need more granularity in detecting FreeBSD - systems since 2.0-RELEASE you can use the following:</para> - - <programlisting>#if __FreeBSD__ >= 2 + <para>Do not forget to add <literal>-DHAVE_SYS_PARAM_H</literal> to the + <makevar>CFLAGS</makevar> in the <filename>Makefile</filename> for + this method.</para> + + <para>Once you have <filename>sys/param.h</filename> included, you may + use:</para> + + <programlisting>#if (defined(BSD) && (BSD >= 199103))</programlisting> + + <para>to detect if the code is being compiled on a 4.3 Net2 code base + or newer (e.g. FreeBSD 1.x, 4.3/Reno, NetBSD 0.9, 386BSD, BSD/386 + 1.1 and below).</para> + + <para>Use:</para> + + <programlisting>#if (defined(BSD) && (BSD >= 199306))</programlisting> + + <para>to detect if the code is being compiled on a 4.4 code base or + newer (e.g. FreeBSD 2.x, 4.4, NetBSD 1.0, BSD/386 2.0 or + above).</para> + + <para>The value of the <literal>BSD</literal> macro is + <literal>199506</literal> for the 4.4BSD-Lite2 code base. This is + stated for informational purposes only. It should not be used to + distinguish between versions of FreeBSD based only on 4.4-Lite vs. + versions that have merged in changes from 4.4-Lite2. The + <literal>__FreeBSD__</literal> macro should be used instead.</para> + + <para>Use sparingly:</para> + + <itemizedlist> + <listitem> + <para><literal>__FreeBSD__</literal> is defined in all versions of + FreeBSD. Use it if the change you are making + <emphasis>only</emphasis> affects FreeBSD. Porting gotchas like + the use of <literal>sys_errlist[]</literal> vs + <function>strerror()</function> are Berkeleyisms, not FreeBSD + changes.</para> + </listitem> + + <listitem> + <para>In FreeBSD 2.x, <literal>__FreeBSD__</literal> is defined to + be <literal>2</literal>. In earlier versions, it is + <literal>1</literal>. Later versions will bump it to match + their major version number.</para> + </listitem> + + <listitem> + <para>If you need to tell the difference between a FreeBSD 1.x + system and a FreeBSD 2.x or 3.x system, usually the right answer + is to use the <literal>BSD</literal> macros described above. If + there actually is a FreeBSD specific change (such as special + shared library options when using <command>ld</command>) then it + is OK to use <literal>__FreeBSD__</literal> and <literal>#if + __FreeBSD__ > 1</literal> to detect a FreeBSD 2.x and later + system. If you need more granularity in detecting FreeBSD + systems since 2.0-RELEASE you can use the following:</para> + + <programlisting>#if __FreeBSD__ >= 2 #include <osreldate.h> # if __FreeBSD_version >= 199504 - /* 2.0.5+ release specific code here */ + /* 2.0.5+ release specific code here */ # endif #endif</programlisting> - </listitem> - </itemizedlist> - - <para>In the hundreds of ports that have been done, there have only - been one or two cases where <literal>__FreeBSD__</literal> should - have been used. Just because an earlier port screwed up and used it - in the wrong place does not mean you should do so too.</para> - </sect1> - - <sect1 id="freebsd-versions"> - <title>__FreeBSD_version values</title> - <para>Here is a convenient list of - <literal>__FreeBSD_version</literal> values as defined in - <ulink url="http://cvsweb.freebsd.org/src/sys/sys/param.h">sys/param.h</ulink>:</para> - - <table frame="none"> - <title>__FreeBSD_version values</title> + <informaltable frame="none"> <tgroup cols="2"> <thead> <row> @@ -7408,216 +2555,216 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 </row> <row> - <entry>2.1-CURRENT</entry> - <entry>199501, 199503</entry> + <entry>2.1-CURRENT</entry> + <entry>199501, 199503</entry> </row> <row> - <entry>2.0.5-RELEASE</entry> - <entry>199504</entry> + <entry>2.0.5-RELEASE</entry> + <entry>199504</entry> </row> <row> - <entry>2.2-CURRENT before 2.1</entry> - <entry>199508</entry> + <entry>2.2-CURRENT before 2.1</entry> + <entry>199508</entry> </row> <row> - <entry>2.1.0-RELEASE</entry> - <entry>199511</entry> + <entry>2.1.0-RELEASE</entry> + <entry>199511</entry> </row> <row> - <entry>2.2-CURRENT before 2.1.5</entry> - <entry>199512</entry> + <entry>2.2-CURRENT before 2.1.5</entry> + <entry>199512</entry> </row> <row> - <entry>2.1.5-RELEASE</entry> - <entry>199607</entry> + <entry>2.1.5-RELEASE</entry> + <entry>199607</entry> </row> <row> - <entry>2.2-CURRENT before 2.1.6</entry> - <entry>199608</entry> + <entry>2.2-CURRENT before 2.1.6</entry> + <entry>199608</entry> </row> <row> - <entry>2.1.6-RELEASE</entry> - <entry>199612</entry> + <entry>2.1.6-RELEASE</entry> + <entry>199612</entry> </row> <row> - <entry>2.1.7-RELEASE</entry> - <entry>199612</entry> + <entry>2.1.7-RELEASE</entry> + <entry>199612</entry> </row> <row> - <entry>2.2-RELEASE</entry> - <entry>220000</entry> + <entry>2.2-RELEASE</entry> + <entry>220000</entry> </row> <row> - <entry>2.2.1-RELEASE</entry> - <entry>220000 (no change)</entry> + <entry>2.2.1-RELEASE</entry> + <entry>220000 (no change)</entry> </row> <row> - <entry>2.2-STABLE after 2.2.1-RELEASE</entry> - <entry>220000 (no change)</entry> + <entry>2.2-STABLE after 2.2.1-RELEASE</entry> + <entry>220000 (no change)</entry> </row> <row> - <entry>2.2-STABLE after texinfo-3.9</entry> - <entry>221001</entry> + <entry>2.2-STABLE after texinfo-3.9</entry> + <entry>221001</entry> </row> <row> - <entry>2.2-STABLE after top</entry> - <entry>221002</entry> + <entry>2.2-STABLE after top</entry> + <entry>221002</entry> </row> <row> - <entry>2.2.2-RELEASE</entry> - <entry>222000</entry> + <entry>2.2.2-RELEASE</entry> + <entry>222000</entry> </row> <row> - <entry>2.2-STABLE after 2.2.2-RELEASE</entry> - <entry>222001</entry> + <entry>2.2-STABLE after 2.2.2-RELEASE</entry> + <entry>222001</entry> </row> <row> - <entry>2.2.5-RELEASE</entry> - <entry>225000</entry> + <entry>2.2.5-RELEASE</entry> + <entry>225000</entry> </row> <row> - <entry>2.2-STABLE after 2.2.5-RELEASE</entry> - <entry>225001</entry> + <entry>2.2-STABLE after 2.2.5-RELEASE</entry> + <entry>225001</entry> </row> <row> - <entry>2.2-STABLE after ldconfig -R merge</entry> - <entry>225002</entry> + <entry>2.2-STABLE after ldconfig -R merge</entry> + <entry>225002</entry> </row> <row> - <entry>2.2.6-RELEASE</entry> - <entry>226000</entry> + <entry>2.2.6-RELEASE</entry> + <entry>226000</entry> </row> <row> - <entry>2.2.7-RELEASE</entry> - <entry>227000</entry> + <entry>2.2.7-RELEASE</entry> + <entry>227000</entry> </row> <row> - <entry>2.2-STABLE after 2.2.7-RELEASE</entry> - <entry>227001</entry> + <entry>2.2-STABLE after 2.2.7-RELEASE</entry> + <entry>227001</entry> </row> <row> - <entry>2.2-STABLE after &man.semctl.2; change</entry> - <entry>227002</entry> + <entry>2.2-STABLE after &man.semctl.2; change</entry> + <entry>227002</entry> </row> <row> - <entry>2.2.8-RELEASE</entry> - <entry>228000</entry> + <entry>2.2.8-RELEASE</entry> + <entry>228000</entry> </row> <row> - <entry>2.2-STABLE after 2.2.8-RELEASE</entry> - <entry>228001</entry> + <entry>2.2-STABLE after 2.2.8-RELEASE</entry> + <entry>228001</entry> </row> <row> - <entry>3.0-CURRENT before &man.mount.2; change</entry> - <entry>300000</entry> + <entry>3.0-CURRENT before &man.mount.2; change</entry> + <entry>300000</entry> </row> <row> - <entry>3.0-CURRENT after &man.mount.2; change</entry> - <entry>300001</entry> + <entry>3.0-CURRENT after &man.mount.2; change</entry> + <entry>300001</entry> </row> <row> - <entry>3.0-CURRENT after &man.semctl.2; change</entry> - <entry>300002</entry> + <entry>3.0-CURRENT after &man.semctl.2; change</entry> + <entry>300002</entry> </row> <row> - <entry>3.0-CURRENT after ioctl arg changes</entry> - <entry>300003</entry> + <entry>3.0-CURRENT after ioctl arg changes</entry> + <entry>300003</entry> </row> <row> - <entry>3.0-CURRENT after ELF conversion</entry> - <entry>300004</entry> + <entry>3.0-CURRENT after ELF conversion</entry> + <entry>300004</entry> </row> <row> - <entry>3.0-RELEASE</entry> - <entry>300005</entry> + <entry>3.0-RELEASE</entry> + <entry>300005</entry> </row> <row> - <entry>3.0-CURRENT after 3.0-RELEASE</entry> - <entry>300006</entry> + <entry>3.0-CURRENT after 3.0-RELEASE</entry> + <entry>300006</entry> </row> <row> - <entry>3.0-STABLE after 3/4 branch</entry> - <entry>300007</entry> + <entry>3.0-STABLE after 3/4 branch</entry> + <entry>300007</entry> </row> <row> - <entry>3.1-RELEASE</entry> - <entry>310000</entry> + <entry>3.1-RELEASE</entry> + <entry>310000</entry> </row> <row> - <entry>3.1-STABLE after 3.1-RELEASE</entry> - <entry>310001</entry> + <entry>3.1-STABLE after 3.1-RELEASE</entry> + <entry>310001</entry> </row> <row> - <entry>3.1-STABLE after C++ constructor/destructor order - change</entry> - <entry>310002</entry> + <entry>3.1-STABLE after C++ constructor/destructor order + change</entry> + <entry>310002</entry> </row> <row> - <entry>3.2-RELEASE</entry> - <entry>320000</entry> + <entry>3.2-RELEASE</entry> + <entry>320000</entry> </row> <row> - <entry>3.2-STABLE</entry> - <entry>320001</entry> + <entry>3.2-STABLE</entry> + <entry>320001</entry> </row> <row> - <entry>3.2-STABLE after binary-incompatible IPFW and - socket changes</entry> - <entry>320002</entry> + <entry>3.2-STABLE after binary-incompatible IPFW and + socket changes</entry> + <entry>320002</entry> </row> <row> - <entry>3.3-RELEASE</entry> - <entry>330000</entry> + <entry>3.3-RELEASE</entry> + <entry>330000</entry> </row> <row> - <entry>3.3-STABLE</entry> - <entry>330001</entry> + <entry>3.3-STABLE</entry> + <entry>330001</entry> </row> <row> - <entry>3.3-STABLE after adding &man.mkstemp.3; - to libc</entry> - <entry>330002</entry> + <entry>3.3-STABLE after adding &man.mkstemp.3; + to libc</entry> + <entry>330002</entry> </row> <row> @@ -7631,96 +2778,86 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 </row> <row> - <entry>3.5-RELEASE</entry> - <entry>350000</entry> + <entry>4.0-CURRENT after 3.4 branch</entry> + <entry>400000</entry> </row> <row> - <entry>3.5-STABLE</entry> - <entry>350001</entry> + <entry>4.0-CURRENT after change in dynamic linker + handling</entry> + <entry>400001</entry> </row> <row> - <entry>4.0-CURRENT after 3.4 branch</entry> - <entry>400000</entry> + <entry>4.0-CURRENT after C++ constructor/destructor + order change</entry> + <entry>400002</entry> </row> <row> - <entry>4.0-CURRENT after change in dynamic linker - handling</entry> - <entry>400001</entry> - </row> - - <row> - <entry>4.0-CURRENT after C++ constructor/destructor - order change</entry> - <entry>400002</entry> - </row> - - <row> - <entry>4.0-CURRENT after functioning &man.dladdr.3;</entry> - <entry>400003</entry> + <entry>4.0-CURRENT after functioning &man.dladdr.3;</entry> + <entry>400003</entry> </row> <row> <entry>4.0-CURRENT after __deregister_frame_info dynamic - linker bug fix (also 4.0-CURRENT after EGCS 1.1.2 - integration) + linker bug fix (also 4.0-CURRENT after EGCS 1.1.2 + integration) </entry> <entry>400004</entry> </row> <row> - <entry>4.0-CURRENT after &man.suser.9; API change - (also 4.0-CURRENT after newbus)</entry> - <entry>400005</entry> + <entry>4.0-CURRENT after &man.suser.9; API change + (also 4.0-CURRENT after newbus)</entry> + <entry>400005</entry> </row> <row> - <entry>4.0-CURRENT after cdevsw registration change</entry> - <entry>400006</entry> + <entry>4.0-CURRENT after cdevsw registration change</entry> + <entry>400006</entry> </row> <row> - <entry>4.0-CURRENT after the addition of so_cred for - socket level credentials</entry> - <entry>400007</entry> + <entry>4.0-CURRENT after the addition of so_cred for + socket level credentials</entry> + <entry>400007</entry> </row> <row> - <entry>4.0-CURRENT after the addition of a poll syscall - wrapper to libc_r</entry> - <entry>400008</entry> + <entry>4.0-CURRENT after the addition of a poll syscall + wrapper to libc_r</entry> + <entry>400008</entry> </row> <row> - <entry>4.0-CURRENT after the change of the kernel's - <literal>dev_t</literal> type to <literal>struct - specinfo</literal> pointer</entry> - <entry>400009</entry> + <entry>4.0-CURRENT after the change of the kernel's + <literal>dev_t</literal> type to <literal>struct + specinfo</literal> pointer</entry> + <entry>400009</entry> </row> <row> - <entry>4.0-CURRENT after fixing a hole - in &man.jail.2;</entry> - <entry>400010</entry> + <entry>4.0-CURRENT after fixing a hole + in &man.jail.2;</entry> + <entry>400010</entry> </row> <row> - <entry>4.0-CURRENT after the <literal>sigset_t</literal> - datatype change</entry> - <entry>400011</entry> + <entry>4.0-CURRENT after the <literal>sigset_t</literal> + datatype change</entry> + <entry>400011</entry> </row> <row> - <entry>4.0-CURRENT after the cutover to the GCC 2.95.2 - compiler</entry> - <entry>400012</entry> + <entry>4.0-CURRENT after the cutover to the GCC 2.95.2 + compiler</entry> + <entry>400012</entry> </row> <row> <entry>4.0-CURRENT after adding pluggable linux-mode - ioctl handlers</entry> + ioctl handlers</entry> <entry>400013</entry> </row> @@ -7731,8 +2868,8 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 <row> <entry>4.0-CURRENT after the C++ ABI change in GCC 2.95.2 - from -fvtable-thunks to -fno-vtable-thunks by - default</entry> + from -fvtable-thunks to -fno-vtable-thunks by + default</entry> <entry>400015</entry> </row> @@ -7752,20 +2889,14 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 </row> <row> - <entry>4.0-STABLE after the introduction of delayed - checksums.</entry> - <entry>400019</entry> - </row> - - <row> <entry>4.0-STABLE after merging libxpg4 code into - libc.</entry> + libc.</entry> <entry>400020</entry> </row> <row> <entry>4.0-STABLE after upgrading Binutils to 2.10.0, ELF - branding changes, and tcsh in the base system.</entry> + branding changes, and tcsh in the base system.</entry> <entry>400021</entry> </row> @@ -7781,7 +2912,7 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 <row> <entry>4.1-STABLE after &man.setproctitle.3; moved from - libutil to libc.</entry> + libutil to libc.</entry> <entry>410002</entry> </row> @@ -7802,7 +2933,7 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 <row> <entry>4.2-STABLE after combining libgcc.a and - libgcc_r.a, and associated GCC linkage changes.</entry> + libgcc_r.a, and associated GCC linkage changes.</entry> <entry>420001</entry> </row> @@ -7822,252 +2953,64 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 </row> <row> - <entry>4.4-RELEASE</entry> - <entry>440000</entry> - </row> - - <row> - <entry>4.4-STABLE after d_thread_t introduction.</entry> - <entry>440001</entry> - </row> - - <row> - <entry>4.4-STABLE after mount structure changes (affects - filesystem klds).</entry> - <entry>440002</entry> - </row> - - <row> - <entry>4.4-STABLE after the userland components of smbfs - were imported.</entry> - <entry>440003</entry> - </row> - - <row> - <entry>4.5-RELEASE</entry> - <entry>450000</entry> - </row> - - <row> - <entry>4.5-STABLE after the usb structure element rename.</entry> - <entry>450001</entry> - </row> - - <row> - <entry>4.5-STABLE after the - <literal>sendmail_enable</literal> &man.rc.conf.5; - variable was made to take the value - <literal>NONE</literal>.</entry> - <entry>450004</entry> - </row> - - <row> - <entry>4.5-STABLE after moving to XFree86 4 by default - for package builds.</entry> - <entry>450005</entry> - </row> - - <row> - <entry>4.5-STABLE after accept filtering was fixed so - that is no longer susceptible to an easy DoS.</entry> - <entry>450006</entry> - </row> - - <row> - <entry>4.6-RELEASE</entry> - <entry>460000</entry> - </row> - - <row> - <entry>4.6-STABLE &man.sendfile.2; fixed to comply with - documentation, not to count any headers sent against - the amount of data to be sent from the file.</entry> - <entry>460001</entry> - </row> - - <row> - <entry>4.6.2-RELEASE</entry> - <entry>460002</entry> - </row> - - <row> - <entry>4.6-STABLE</entry> - <entry>460100</entry> - </row> - - <row> - <entry>4.6-STABLE after MFC of `sed -i'.</entry> - <entry>460101</entry> - </row> - - <row> - <entry>4.6-STABLE after MFC of many new pkg_install - features from the HEAD.</entry> - <entry>460102</entry> - </row> - - <row> - <entry>4.7-RELEASE</entry> - <entry>470000</entry> - </row> - - <row> - <entry>4.7-STABLE</entry> - <entry>470100</entry> - </row> - - <row> - <entry>Start generated __std{in,out,err}p references rather - than __sF. This changes std{in,out,err} from a - compile time expression to a runtime one.</entry> - <entry>470101</entry> - </row> - - <row> - <entry>4.7-STABLE after MFC of mbuf changes to replace - m_aux mbufs by m_tag's</entry> - <entry>470102</entry> - </row> - - <row> - <entry>4.7-STABLE gets OpenSSL 0.9.7</entry> - <entry>470103</entry> - </row> - - <row> - <entry>4.8-RELEASE</entry> - <entry>480000</entry> - </row> - - <row> - <entry>4.8-STABLE</entry> - <entry>480100</entry> - </row> - - <row> - <entry>4.8-STABLE after &man.realpath.3; has been made - thread-safe</entry> - <entry>480101</entry> - </row> - - <row> - <entry>4.8-STABLE 3ware API changes to twe.</entry> - <entry>480102</entry> - </row> - - <row> - <entry>4.9-RELEASE</entry> - <entry>490000</entry> - </row> - - <row> - <entry>4.9-STABLE</entry> - <entry>490100</entry> - </row> - - <row> - <entry>4.9-STABLE after e_sid was added to struct - kinfo_eproc.</entry> - <entry>490101</entry> - </row> - - <row> - <entry>4.9-STABLE after MFC of libmap functionality - for rtld.</entry> - <entry>490102</entry> - </row> - - <row> - <entry>4.10-RELEASE</entry> - <entry>491000</entry> - </row> - - <row> - <entry>4.10-STABLE</entry> - <entry>491100</entry> - </row> - - <row> - <entry>4.10-STABLE after MFC of revision 20040629 of - the package tools</entry> - <entry>491101</entry> - </row> - - <row> - <entry>4.10-STABLE after VM fix dealing with unwiring - of fictitious pages</entry> - <entry>491102</entry> - </row> - - <row> - <entry>4.11-RELEASE</entry> - <entry>492000</entry> - </row> - - <row> - <entry>4.11-STABLE</entry> - <entry>492100</entry> - </row> - - <row> <entry>5.0-CURRENT</entry> <entry>500000</entry> </row> <row> <entry>5.0-CURRENT after adding addition ELF header fields, - and changing our ELF binary branding method.</entry> + and changing our ELF binary branding method.</entry> <entry>500001</entry> </row> - <row> - <entry>5.0-CURRENT after kld metadata changes.</entry> - <entry>500002</entry> - </row> + <row> + <entry>5.0-CURRENT after kld metadata changes.</entry> + <entry>500002</entry> + </row> - <row> - <entry>5.0-CURRENT after buf/bio changes.</entry> - <entry>500003</entry> - </row> + <row> + <entry>5.0-CURRENT after buf/bio changes.</entry> + <entry>500003</entry> + </row> - <row> - <entry>5.0-CURRENT after binutils upgrade.</entry> - <entry>500004</entry> - </row> + <row> + <entry>5.0-CURRENT after binutils upgrade.</entry> + <entry>500004</entry> + </row> - <row> - <entry>5.0-CURRENT after merging libxpg4 code into - libc and after TASKQ interface introduction.</entry> - <entry>500005</entry> - </row> + <row> + <entry>5.0-CURRENT after merging libxpg4 code into + libc and after TASKQ interface introduction.</entry> + <entry>500005</entry> + </row> - <row> - <entry>5.0-CURRENT after the addition of AGP - interfaces.</entry> - <entry>500006</entry> - </row> + <row> + <entry>5.0-CURRENT after the addition of AGP + interfaces.</entry> + <entry>500006</entry> + </row> <row> <entry>5.0-CURRENT after Perl upgrade to 5.6.0</entry> <entry>500007</entry> </row> - <row> - <entry>5.0-CURRENT after the update of KAME code to - 2000/07 sources.</entry> - <entry>500008</entry> - </row> + <row> + <entry>5.0-CURRENT after the update of KAME code to + 2000/07 sources.</entry> + <entry>500008</entry> + </row> <row> <entry>5.0-CURRENT after ether_ifattach() and - ether_ifdetach() changes.</entry> + ether_ifdetach() changes.</entry> <entry>500009</entry> </row> <row> - <entry>5.0-CURRENT after changing mtree defaults - back to original variant, adding -L to follow - symlinks.</entry> + <entry>5.0-CURRENT after changing mtree defaults + back to original variant, adding -L to follow + symlinks.</entry> <entry>500010</entry> </row> @@ -8078,7 +3021,7 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 <row> <entry>5.0-CURRENT after &man.setproctitle.3; moved from - libutil to libc.</entry> + libutil to libc.</entry> <entry>500012</entry> </row> @@ -8089,39 +3032,38 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 <row> <entry>5.0-CURRENT after <sys/select.h> moved to - <sys/selinfo.h>.</entry> + <sys/selinfo.h>.</entry> <entry>500014</entry> </row> <row> <entry>5.0-CURRENT after combining libgcc.a and - libgcc_r.a, and associated GCC linkage changes.</entry> + libgcc_r.a, and associated GCC linkage changes.</entry> <entry>500015</entry> </row> <row> <entry>5.0-CURRENT after change allowing libc and libc_r - to be linked together, deprecating -pthread - option.</entry> + to be linked together, deprecating -pthread option.</entry> <entry>500016</entry> </row> <row> <entry>5.0-CURRENT after switch from struct ucred to - struct xucred to stabilize kernel-exported API for - mountd et al.</entry> + struct xucred to stabilize kernel-exported API for + mountd et al.</entry> <entry>500017</entry> </row> <row> <entry>5.0-CURRENT after addition of CPUTYPE make variable - for controlling CPU-specific optimizations.</entry> + for controlling CPU-specific optimizations.</entry> <entry>500018</entry> </row> <row> <entry>5.0-CURRENT after moving machine/ioctl_fd.h to - sys/fdcio.h</entry> + sys/fdcio.h</entry> <entry>500019</entry> </row> @@ -8131,8 +3073,7 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 </row> <row> - <entry>5.0-CURRENT after Bzip2 import. - Also signifies removal of S/Key.</entry> + <entry>5.0-CURRENT after Bzip2 import.</entry> <entry>500021</entry> </row> @@ -8145,932 +3086,133 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 <entry>5.0-CURRENT after KSE Milestone 2.</entry> <entry>500023</entry> </row> - - <row> - <entry>5.0-CURRENT after d_thread_t, - and moving UUCP to ports.</entry> - <entry>500024</entry> - </row> - - <row> - <entry>5.0-CURRENT after ABI change for descriptor - and creds passing on 64 bit platforms.</entry> - <entry>500025</entry> - </row> - - <row> - <entry>5.0-CURRENT after moving to XFree86 4 by default for - package builds, and after the new libc strnstr() function - was added.</entry> - <entry>500026</entry> - </row> - - <row> - <entry>5.0-CURRENT after the new libc strcasestr() function - was added.</entry> - <entry>500027</entry> - </row> - - <row> - <entry>5.0-CURRENT after the userland components of smbfs - were imported.</entry> - <entry>500028</entry> - </row> - - <row> - <entry>5.0-CURRENT after the new C99 specific-width - integer types were added.</entry> - <entry>(Not incremented.)</entry> - </row> - - <row> - <entry>5.0-CURRENT after a change was made in the return - value of &man.sendfile.2;.</entry> - <entry>500029</entry> - </row> - - <row> - <entry>5.0-CURRENT after the introduction of the - type <literal>fflags_t</literal>, which is the - appropriate size for file flags.</entry> - <entry>500030</entry> - </row> - - <row> - <entry>5.0-CURRENT after the usb structure element rename.</entry> - <entry>500031</entry> - </row> - - <row> - <entry>5.0-CURRENT after the introduction of - Perl 5.6.1.</entry> - <entry>500032</entry> - </row> - - <row> - <entry>5.0-CURRENT after the - <literal>sendmail_enable</literal> &man.rc.conf.5; - variable was made to take the value - <literal>NONE</literal>.</entry> - <entry>500033</entry> - </row> - - <row> - <entry>5.0-CURRENT after mtx_init() grew a third argument.</entry> - <entry>500034</entry> - </row> - - <row> - <entry>5.0-CURRENT with Gcc 3.1.</entry> - <entry>500035</entry> - </row> - - <row> - <entry>5.0-CURRENT without Perl in /usr/src</entry> - <entry>500036</entry> - </row> - - <row> - <entry>5.0-CURRENT after the addition of &man.dlfunc.3;</entry> - <entry>500037</entry> - </row> - - <row> - <entry>5.0-CURRENT after the types of some struct - sockbuf members were changed and the structure was - reordered.</entry> - <entry>500038</entry> - </row> - - <row> - <entry>5.0-CURRENT after GCC 3.2.1 import. - Also after headers stopped using - _BSD_FOO_T_ and started using _FOO_T_DECLARED. - This value can also be used as a conservative - estimate of the start of &man.bzip2.1; package - support.</entry> - <entry>500039</entry> - </row> - - <row> - <entry>5.0-CURRENT after various changes to disk functions - were made in the name of removing dependency on disklabel - structure internals.</entry> - <entry>500040</entry> - </row> - - <row> - <entry>5.0-CURRENT after the addition of &man.getopt.long.3; - to libc.</entry> - <entry>500041</entry> - </row> - - <row> - <entry>5.0-CURRENT after Binutils 2.13 upgrade, which - included new FreeBSD emulation, vec, and output format. - </entry> - <entry>500042</entry> - </row> - - <row> - <entry>5.0-CURRENT after adding weak pthread_XXX stubs - to libc, obsoleting libXThrStub.so. 5.0-RELEASE.</entry> - <entry>500043</entry> - </row> - - <row> - <entry>5.0-CURRENT after branching for RELENG_5_0</entry> - <entry>500100</entry> - </row> - <row> - <entry><sys/dkstat.h> is empty and should - not be included.</entry> - <entry>500101</entry> - </row> - <row> - <entry>5.0-CURRENT after the d_mmap_t interface - change.</entry> - <entry>500102</entry> - </row> - <row> - <entry>5.0-CURRENT after taskqueue_swi changed to run - without Giant, and taskqueue_swi_giant added to run - with Giant.</entry> - <entry>500103</entry> - </row> - <row> - <entry>cdevsw_add() and cdevsw_remove() no - longer exists. - Appearance of MAJOR_AUTO allocation facility.</entry> - <entry>500104</entry> - </row> - <row> - <entry>5.0-CURRENT after new cdevsw initialization method.</entry> - <entry>500105</entry> - </row> - <row> - <entry>devstat_add_entry() has been replaced by - devstat_new_entry()</entry> - <entry>500106</entry> - </row> - <row> - <entry>Devstat interface change; see sys/sys/param.h 1.149</entry> - <entry>500107</entry> - </row> - <row> - <entry>Token-Ring interface changes.</entry> - <entry>500108</entry> - </row> - <row> - <entry>Addition of vm_paddr_t.</entry> - <entry>500109</entry> - </row> - <row> - <entry>5.0-CURRENT after &man.realpath.3; has been made - thread-safe</entry> - <entry>500110</entry> - </row> - <row> - <entry>5.0-CURRENT after &man.usbhid.3; has been synced with - NetBSD</entry> - <entry>500111</entry> - </row> - <row> - <entry>5.0-CURRENT after new NSS implementation - and addition of POSIX.1 getpw*_r, getgr*_r - functions</entry> - <entry>500112</entry> - </row> - <row> - <entry>5.0-CURRENT after removal of the old rc system.</entry> - <entry>500113</entry> - </row> - <row> - <entry>5.1-RELEASE.</entry> - <entry>501000</entry> - </row> - <row> - <entry>5.1-CURRENT after branching for RELENG_5_1.</entry> - <entry>501100</entry> - </row> - <row> - <entry>5.1-CURRENT after correcting the semantics of - sigtimedwait(2) and sigwaitinfo(2).</entry> - <entry>501101</entry> - </row> - <row> - <entry>5.1-CURRENT after adding the lockfunc and lockfuncarg - fields to &man.bus.dma.tag.create.9;.</entry> - <entry>501102</entry> - </row> - <row> - <entry>5.1-CURRENT after GCC 3.3.1-pre 20030711 snapshot - integration.</entry> - <entry>501103</entry> - </row> - <row> - <entry>5.1-CURRENT 3ware API changes to twe.</entry> - <entry>501104</entry> - </row> - <row> - <entry>5.1-CURRENT dynamically-linked /bin and /sbin - support and movement of libraries to /lib.</entry> - <entry>501105</entry> - </row> - <row> - <entry>5.1-CURRENT after adding kernel support for - Coda 6.x.</entry> - <entry>501106</entry> - </row> - <row> - <entry>5.1-CURRENT after 16550 UART constants moved from - <filename><dev/sio/sioreg.h></filename> to - <filename><dev/ic/ns16550.h></filename>. - Also when libmap functionality was unconditionally - supported by rtld.</entry> - <entry>501107</entry> - </row> - <row> - <entry>5.1-CURRENT after PFIL_HOOKS API update</entry> - <entry>501108</entry> - </row> - <row> - <entry>5.1-CURRENT after adding kiconv(3)</entry> - <entry>501109</entry> - </row> - <row> - <entry>5.1-CURRENT after changing default operations - for open and close in cdevsw</entry> - <entry>501110</entry> - </row> - <row> - <entry>5.1-CURRENT after changed layout of cdevsw</entry> - <entry>501111</entry> - </row> - <row> - <entry> 5.1-CURRENT after adding kobj multiple inheritance - </entry> - <entry>501112</entry> - </row> - <row> - <entry> 5.1-CURRENT after the if_xname change in - struct ifnet</entry> - <entry>501113</entry> - </row> - <row> - <entry> 5.1-CURRENT after changing /bin and /sbin to - be dynamically linked</entry> - <entry>501114</entry> - </row> - <row> - <entry>5.2-RELEASE</entry> - <entry>502000</entry> - </row> - <row> - <entry>5.2.1-RELEASE</entry> - <entry>502010</entry> - </row> - <row> - <entry>5.2-CURRENT after branching for RELENG_5_2</entry> - <entry>502100</entry> - </row> - <row> - <entry>5.2-CURRENT after __cxa_atexit/__cxa_finalize - functions were added to libc.</entry> - <entry>502101</entry> - </row> - <row> - <entry>5.2-CURRENT after change of default thread library - from libc_r to libpthread.</entry> - <entry>502102</entry> - </row> - <row> - <entry>5.2-CURRENT after device driver API megapatch. - </entry> - <entry>502103</entry> - </row> - <row> - <entry>5.2-CURRENT after getopt_long_only() addition. - </entry> - <entry>502104</entry> - </row> - <row> - <entry>5.2-CURRENT after NULL is made into ((void *)0) - for C, creating more warnings. - </entry> - <entry>502105</entry> - </row> - <row> - <entry>5.2-CURRENT after pf is linked to the build and - install. - </entry> - <entry>502106</entry> - </row> - <row> - <entry>5.2-CURRENT after time_t is changed to a - 64-bit value on sparc64. - </entry> - <entry>502107</entry> - </row> - <row> - <entry>5.2-CURRENT after Intel C/C++ compiler support in some headers and execve(2) changes to be more strictly conforming to POSIX. - </entry> - <entry>502108</entry> - </row> - <row> - <entry>5.2-CURRENT after the introduction of the - bus_alloc_resource_any API - </entry> - <entry>502109</entry> - </row> - <row> - <entry>5.2-CURRENT after the addition of UTF-8 locales - </entry> - <entry>502110</entry> - </row> - <row> - <entry>5.2-CURRENT after the removal of the getvfsent(3) - API - </entry> - <entry>502111</entry> - </row> - <row> - <entry>5.2-CURRENT after the addition of the .warning - directive for make.</entry> - <entry>502112</entry> - </row> - <row> - <entry>5.2-CURRENT after ttyioctl() was made mandatory - for serial drivers.</entry> - <entry>502113</entry> - </row> - <row> - <entry>5.2-CURRENT after import of the ALTQ framework. - </entry> - <entry>502114</entry> - </row> - <row> - <entry>5.2-CURRENT after changing sema_timedwait(9) to - return 0 on success and a non-zero error code on - failure. - </entry> - <entry>502115</entry> - </row> - <row> - <entry>5.2-CURRENT after changing kernel dev_t to - be pointer to struct cdev *. - </entry> - <entry>502116</entry> - </row> - <row> - <entry>5.2-CURRENT after changing kernel udev_t to dev_t. - </entry> - <entry>502117</entry> - </row> - <row> - <entry>5.2-CURRENT after adding support for CLOCK_VIRTUAL - and CLOCK_PROF to clock_gettime(2) and clock_getres(2). - </entry> - <entry>502118</entry> - </row> - <row> - <entry>5.2-CURRENT after changing network interface - cloning overhaul. - </entry> - <entry>502119</entry> - </row> - <row> - <entry>5.2-CURRENT after the update of the package tools - to revision 20040629. - </entry> - <entry>502120</entry> - </row> - <row> - <entry>5.2-CURRENT after marking Bluetooth code as - non-i386 specific. - </entry> - <entry>502121</entry> - </row> - <row> - <entry>5.2-CURRENT after the introduction of the KDB - debugger framework, the conversion of DDB into a - backend and the introduction of the GDB backend. - </entry> - <entry>502122</entry> - </row> - <row> - <entry>5.2-CURRENT after change to make - VFS_ROOT take a struct - thread argument as does vflush. Struct kinfo_proc - now has a user data pointer. - The switch of the default X implementation to - <literal>xorg</literal> was also made at this time. - </entry> - <entry>502123</entry> - </row> - <row> - <entry>5.2-CURRENT after the change to separate the way - ports rc.d and legacy scripts are started. - </entry> - <entry>502124</entry> - </row> - <row> - <entry>5.2-CURRENT after the backout of the - previous change. - </entry> - <entry>502125</entry> - </row> - <row> - <entry>5.2-CURRENT after the removal of - kmem_alloc_pageable() and the import of gcc 3.4.2. - </entry> - <entry>502126</entry> - </row> - <row> - <entry>5.2-CURRENT after changing the UMA kernel - API to allow ctors/inits to fail. - </entry> - <entry>502127</entry> - </row> - <row> - <entry>5.2-CURRENT after the change of the - vfs_mount signature as well as global replacement of - PRISON_ROOT with SUSER_ALLOWJAIL for the suser(9) - API. - </entry> - <entry>502128</entry> - </row> - <row> - <entry>5.3-BETA/RC before the pfil API change</entry> - <entry>503000</entry> - </row> - <row> - <entry>5.3-RELEASE</entry> - <entry>503001</entry> - </row> - <row> - <entry>5.3-STABLE after branching for RELENG_5_3</entry> - <entry>503100</entry> - </row> - <row> - <entry>5.3-STABLE after addition of glibc style - &man.strftime.3; padding options.</entry> - <entry>503101</entry> - </row> - <row> - <entry>5.3-STABLE after OpenBSD's nc(1) import MFC.</entry> - <entry>503102</entry> - </row> - <row> - <entry>5.4-PRERELEASE after the MFC of the fixes in - <filename><src/include/stdbool.h></filename> and - <filename><src/sys/i386/include/_types.h></filename> - for using the GCC-compatibility of the Intel C/C++ compiler.</entry> - <entry>503103</entry> - </row> - <row> - <entry>5.4-PRERELEASE after the MFC of the change of - ifi_epoch from wall clock time to uptime.</entry> - <entry>503104</entry> - </row> - <row> - <entry>5.4-PRERELEASE after the MFC of the fix of EOVERFLOW check in vswprintf(3).</entry> - <entry>503105</entry> - </row> - <row> - <entry>5.4-RELEASE.</entry> - <entry>504000</entry> - </row> - <row> - <entry>5.4-STABLE after branching for RELENG_5_4</entry> - <entry>504100</entry> - </row> - <row> - <entry>5.4-STABLE after increasing the default - thread stacksizes</entry> - <entry>504101</entry> - </row> - <row> - <entry>5.4-STABLE after the addition of sha256</entry> - <entry>504102</entry> - </row> - <row> - <entry>5.4-STABLE after the MFC of if_bridge</entry> - <entry>504103</entry> - </row> - <row> - <entry>5.4-STABLE after the MFC of bsdiff and portsnap</entry> - <entry>504104</entry> - </row> - <row> - <entry>5.4-STABLE after MFC of ldconfig_local_dirs - change.</entry> - <entry>504105</entry> - </row> - <row> - <entry>6.0-CURRENT</entry> - <entry>600000</entry> - </row> - <row> - <entry>6.0-CURRENT after permanently enabling PFIL_HOOKS - in the kernel. - </entry> - <entry>600001</entry> - </row> - <row> - <entry>6.0-CURRENT after initial addition of - ifi_epoch to struct if_data. Backed out after a - few days. Do not use this value. - </entry> - <entry>600002</entry> - </row> - <row> - <entry>6.0-CURRENT after the re-addition of the - ifi_epoch member of struct if_data. - </entry> - <entry>600003</entry> - </row> - <row> - <entry>6.0-CURRENT after addition of the struct inpcb - argument to the pfil API. - </entry> - <entry>600004</entry> - </row> - <row> - <entry>6.0-CURRENT after addition of the "-d - DESTDIR" argument to newsyslog. - </entry> - <entry>600005</entry> - </row> - <row> - <entry>6.0-CURRENT after addition of glibc style - &man.strftime.3; padding options. - </entry> - <entry>600006</entry> - </row> - <row> - <entry>6.0-CURRENT after addition of 802.11 framework - updates. - </entry> - <entry>600007</entry> - </row> - <row> - <entry>6.0-CURRENT after changes to VOP_*VOBJECT() functions - and introduction of MNTK_MPSAFE flag for Giantfree filesystems. - </entry> - <entry>600008</entry> - </row> - <row> - <entry>6.0-CURRENT after addition of the cpufreq framework - and drivers. - </entry> - <entry>600009</entry> - </row> - <row> - <entry>6.0-CURRENT after importing OpenBSD's nc(1).</entry> - <entry>600010</entry> - </row> - <row> - <entry>6.0-CURRENT after removing semblance of SVID2 - <literal>matherr()</literal> support.</entry> - <entry>600011</entry> - </row> - <row> - <entry>6.0-CURRENT after increase of default thread stacks' - size.</entry> - <entry>600012</entry> - </row> - <row> - <entry>6.0-CURRENT after fixes in - <filename><src/include/stdbool.h></filename> and - <filename><src/sys/i386/include/_types.h></filename> - for using the GCC-compatibility of the Intel C/C++ compiler.</entry> - <entry>600013</entry> - </row> - <row> - <entry>6.0-CURRENT after EOVERFLOW checks in vswprintf(3) fixed.</entry> - <entry>600014</entry> - </row> - <row> - <entry>6.0-CURRENT after changing the struct if_data - member, ifi_epoch, from wall clock time to uptime.</entry> - <entry>600015</entry> - </row> - <row> - <entry>6.0-CURRENT after LC_CTYPE disk format changed.</entry> - <entry>600016</entry> - </row> - <row> - <entry>6.0-CURRENT after NLS catalogs disk format changed.</entry> - <entry>600017</entry> - </row> - <row> - <entry>6.0-CURRENT after LC_COLLATE disk format changed.</entry> - <entry>600018</entry> - </row> - <row> - <entry>Installation of acpica includes into /usr/include.</entry> - <entry>600019</entry> - </row> - <row> - <entry>Addition of MSG_NOSIGNAL flag to send(2) API.</entry> - <entry>600020</entry> - </row> - <row> - <entry>Addition of fields to cdevsw</entry> - <entry>600021</entry> - </row> - <row> - <entry>Removed gtar from base system.</entry> - <entry>600022</entry> - </row> - <row> - <entry>LOCAL_CREDS, LOCAL_CONNWAIT socket options added to unix(4).</entry> - <entry>600023</entry> - </row> - <row> - <entry>&man.hwpmc.4; and related tools added to 6.0-CURRENT.</entry> - <entry>600024</entry> - </row> - <row> - <entry>struct icmphdr added to 6.0-CURRENT.</entry> - <entry>600025</entry> - </row> - <row> - <entry>pf updated to 3.7.</entry> - <entry>600026</entry> - </row> - <row> - <entry>Kernel libalias and ng_nat introduced.</entry> - <entry>600027</entry> - </row> - <row> - <entry>POSIX ttyname_r(3) made available through unistd.h and libc.</entry> - <entry>600028</entry> - </row> - <row> - <entry>6.0-CURRENT after libpcap updated to v0.9.1 alpha 096.</entry> - <entry>600029</entry> - </row> - <row> - <entry>6.0-CURRENT after importing NetBSD's if_bridge(4).</entry> - <entry>600030</entry> - </row> - <row> - <entry>6.0-CURRENT after struct ifnet was broken out - of the driver softcs.</entry> - <entry>600031</entry> - </row> - <row> - <entry>6.0-CURRENT after the import of libpcap v0.9.1.</entry> - <entry>600032</entry> - </row> - <row> - <entry>6.0-STABLE after bump of all shared library - versions that had not been changed since - RELENG_5.</entry> - <entry>600033</entry> - </row> - <row> - <entry>6.0-STABLE after credential argument is added to - dev_clone vent handler. 6.0-RELEASE.</entry> - <entry>600034</entry> - </row> - <row> - <entry>6.0-STABLE after 6.0-RELEASE</entry> - <entry>600100</entry> - </row> - <row> - <entry>6.0-STABLE after incorporating scripts from the - local_startup directories into the base &man.rcorder.8;.</entry> - <entry>600101</entry> - </row> - <row> - <entry>6.0-STABLE after updating the ELF types and - constants.</entry> - <entry>600102</entry> - </row> - <row> - <entry>6.0-STABLE after MFC of pidfile(3) API.</entry> - <entry>600103</entry> - </row> - <row> - <entry>6.0-STABLE after MFC of ldconfig_local_dirs - change.</entry> - <entry>600104</entry> - </row> - <row> - <entry>6.0-STABLE after NLS catalog support of - csh(1).</entry> - <entry>600105</entry> - </row> - <row> - <entry>6.1-RELEASE</entry> - <entry>601000</entry> - </row> - <row> - <entry>7.0-CURRENT.</entry> - <entry>700000</entry> - </row> - <row> - <entry>7.0-CURRENT after bump of all shared library - versions that had not been changed since - RELENG_5.</entry> - <entry>700001</entry> - </row> - <row> - <entry>7.0-CURRENT after credential argument is added to - dev_clone vent handler.</entry> - <entry>700002</entry> - </row> - <row> - <entry>7.0-CURRENT after memmem(3) is added to libc.</entry> - <entry>700003</entry> - </row> - <row> - <entry>7.0-CURRENT after solisten(9) kernel arguments - are modified to accept a backlog parameter.</entry> - <entry>700004</entry> - </row> - <row> - <entry>7.0-CURRENT after IFP2ENADDR() was changed to return - a pointer to IF_LLADDR().</entry> - <entry>700005</entry> - </row> - <row> - <entry>7.0-CURRENT after addition of <literal>if_addr</literal> - member to <literal>struct ifnet</literal> and IFP2ENADDR() - removal.</entry> - <entry>700006</entry> - </row> - <row> - <entry>7.0-CURRENT after incorporating scripts from the - local_startup directories into the base &man.rcorder.8;.</entry> - <entry>700007</entry> - </row> - <row> - <entry>7.0-CURRENT after removal of MNT_NODEV mount - option.</entry> - <entry>700008</entry> - </row> - <row> - <entry>7.0-CURRENT after ELF-64 type changes and symbol - versioning.</entry> - <entry>700009</entry> - </row> - <row> - <entry>7.0-CURRENT after addition of hostb and vgapci - drivers, addition of pci_find_extcap(), and changing - the AGP drivers to no longer map the aperture.</entry> - <entry>700010</entry> - </row> - <row> - <entry>7.0-CURRENT after tv_sec was made time_t on - all platforms but Alpha.</entry> - <entry>700011</entry> - </row> - <row> - <entry>7.0-CURRENT after ldconfig_local_dirs change.</entry> - <entry>700012</entry> - </row> - <row> - <entry>7.0-CURRENT after changes to - <filename>/etc/rc.d/abi</filename> to support - <filename>/compat/linux/etc/ld.so.cache</filename> - being a symlink in a readonly filesystem.</entry> - <entry>700013</entry> - </row> - <row> - <entry>7.0-CURRENT after pts import.</entry> - <entry>700014</entry> - </row> - <row> - <entry>7.0-CURRENT after the introduction of version 2 - of &man.hwpmc.4;'s ABI.</entry> - <entry>700015</entry> - </row> - </tbody> - </tgroup> - </table> - - <note> - <para>Note that 2.2-STABLE sometimes identifies itself as - <quote>2.2.5-STABLE</quote> after the 2.2.5-RELEASE. The pattern - used to be year followed by the month, but we decided to change it - to a more straightforward major/minor system starting from 2.2. - This is because the parallel development on several branches made - it infeasible to classify the releases simply by their real - release dates. If you are making a port now, you do not have to - worry about old -CURRENTs; they are listed here just for your - reference.</para> - </note> + </tbody> + </tgroup> + </informaltable> + </listitem> + </itemizedlist> + + <note> + <para>Note that 2.2-STABLE sometimes identifies itself as + “2.2.5-STABLE” after the 2.2.5-RELEASE. The pattern + used to be year followed by the month, but we decided to change it + to a more straightforward major/minor system starting from 2.2. + This is because the parallel development on several branches made + it infeasible to classify the releases simply by their real + release dates. If you are making a port now, you do not have to + worry about old -CURRENTs; they are listed here just for your + reference.</para> + </note> + + <para>In the hundreds of ports that have been done, there have only + been one or two cases where <literal>__FreeBSD__</literal> should + have been used. Just because an earlier port screwed up and used it + in the wrong place does not mean you should do so too.</para> </sect1> - <sect1 id="dads-after-port-mk"> - <title>Writing something after - <filename>bsd.port.mk</filename></title> - - <para>Do not write anything after the <literal>.include - <bsd.port.mk></literal> line. It usually can be avoided by - including <filename>bsd.port.pre.mk</filename> somewhere in the - middle of your <filename>Makefile</filename> and - <filename>bsd.port.post.mk</filename> at the end.</para> - - <note> - <para>You need to include either the - <filename>bsd.port.pre.mk</filename>/<filename>bsd.port.post.mk</filename> pair or - <filename>bsd.port.mk</filename> only; do not mix these two usages.</para> - </note> - - <para><filename>bsd.port.pre.mk</filename> only defines a few - variables, which can be used in tests in the - <filename>Makefile</filename>, <filename>bsd.port.post.mk</filename> - defines the rest.</para> - - <para>Here are some important variables defined in - <filename>bsd.port.pre.mk</filename> (this is not the complete list, - please read <filename>bsd.port.mk</filename> for the complete - list).</para> - - <informaltable frame="none" pgwide="1"> - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Description</entry> - </row> - </thead> - - <tbody> - <row> - <entry><makevar>ARCH</makevar></entry> - <entry>The architecture as returned by <command>uname - -m</command> (e.g., <literal>i386</literal>)</entry> - </row> - - <row> - <entry><makevar>OPSYS</makevar></entry> - <entry>The operating system type, as returned by - <command>uname -s</command> (e.g., - <literal>FreeBSD</literal>)</entry> - </row> - - <row> - <entry><makevar>OSREL</makevar></entry> - <entry>The release version of the operating system (e.g., - <literal>2.1.5</literal> or - <literal>2.2.7</literal>)</entry> - </row> - - <row> - <entry><makevar>OSVERSION</makevar></entry> - <entry>The numeric version of the operating system; the same as - <link - linkend="freebsd-versions"><literal>__FreeBSD_version</literal></link>.</entry> - </row> - - <row> - <entry><makevar>PORTOBJFORMAT</makevar></entry> - <entry>The object format of the system - (<literal>elf</literal> or <literal>aout</literal>; - note that for <quote>modern</quote> versions of FreeBSD, - <literal>aout</literal> is deprecated.)</entry> - </row> - - <row> - <entry><makevar>LOCALBASE</makevar></entry> - <entry>The base of the <quote>local</quote> tree (e.g., - <literal>/usr/local/</literal>)</entry> - </row> - - <row> - <entry><makevar>X11BASE</makevar></entry> - <entry>The base of the <quote>X11</quote> tree (e.g., - <literal>/usr/X11R6</literal>)</entry> - </row> - - <row> - <entry><makevar>PREFIX</makevar></entry> - <entry>Where the port installs itself (see <link - linkend="porting-prefix">more on - <makevar>PREFIX</makevar></link>).</entry> - </row> - </tbody> - </tgroup> - </informaltable> - - <note> - <para>If you have to define the variables - <makevar>USE_IMAKE</makevar>, <makevar>USE_X_PREFIX</makevar>, or - <makevar>MASTERDIR</makevar>, do so before including - <filename>bsd.port.pre.mk</filename>.</para> - </note> - - <para>Here are some examples of things you can write after - <filename>bsd.port.pre.mk</filename>:</para> - - <programlisting># no need to compile lang/perl5 if perl5 is already in system -.if ${OSVERSION} > 300003 + <sect1> + <title>Writing something after + <filename>bsd.port.mk</filename></title> + + <para>Do not write anything after the <literal>.include + <bsd.port.mk></literal> line. It usually can be avoided by + including <filename>bsd.port.pre.mk</filename> somewhere in the + middle of your <filename>Makefile</filename> and + <filename>bsd.port.post.mk</filename> at the end.</para> + + <note> + <para>You need to include either the + <filename>pre.mk</filename>/<filename>post.mk</filename> pair or + <filename>bsd.port.mk</filename> only; do not mix these two.</para> + </note> + + <para><filename>bsd.port.pre.mk</filename> only defines a few + variables, which can be used in tests in the + <filename>Makefile</filename>, <filename>bsd.port.post.mk</filename> + defines the rest.</para> + + <para>Here are some important variables defined in + <filename>bsd.port.pre.mk</filename> (this is not the complete list, + please read <filename>bsd.port.mk</filename> for the complete + list).</para> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Variable</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry><makevar>ARCH</makevar></entry> + <entry>The architecture as returned by <command>uname + -m</command> (e.g., <literal>i386</literal>)</entry> + </row> + + <row> + <entry><makevar>OPSYS</makevar></entry> + <entry>The operating system type, as returned by + <command>uname -s</command> (e.g., + <literal>FreeBSD</literal>)</entry> + </row> + + <row> + <entry><makevar>OSREL</makevar></entry> + <entry>The release version of the operating system (e.g., + <literal>2.1.5</literal> or + <literal>2.2.7</literal>)</entry> + </row> + + <row> + <entry><makevar>OSVERSION</makevar></entry> + <entry>The numeric version of the operating system, same as + <link + linkend="porting-versions"><literal>__FreeBSD_version</literal></link>.</entry> + </row> + + <row> + <entry><makevar>PORTOBJFORMAT</makevar></entry> + <entry>The object format of the system + (<literal>aout</literal> or <literal>elf</literal>)</entry> + </row> + + <row> + <entry><makevar>LOCALBASE</makevar></entry> + <entry>The base of the “local” tree (e.g., + <literal>/usr/local/</literal>)</entry> + </row> + + <row> + <entry><makevar>X11BASE</makevar></entry> + <entry>The base of the “X11” tree (e.g., + <literal>/usr/X11R6</literal>)</entry> + </row> + + <row> + <entry><makevar>PREFIX</makevar></entry> + <entry>Where the port installs itself (see <link + linkend="porting-prefix">more on + <makevar>PREFIX</makevar></link>).</entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <note> + <para>If you have to define the variables + <makevar>USE_IMAKE</makevar>, <makevar>USE_X_PREFIX</makevar>, or + <makevar>MASTERDIR</makevar>, do so before including + <filename>bsd.port.pre.mk</filename>.</para> + </note> + + <para>Here are some examples of things you can write after + <filename>bsd.port.pre.mk</filename>:</para> + + <programlisting># no need to compile lang/perl5 if perl5 is already in system +.if ${OSVERSION} > 300003 BROKEN= perl is in system .endif @@ -9086,422 +3228,323 @@ post-install: .if ${PORTOBJFORMAT} == "aout" ${LN} -sf liblinpack.so.1.0 ${PREFIX}/lib/liblinpack.so .endif</programlisting> - - <para>You did remember to use tab instead of spaces after - <literal>BROKEN=</literal> and - <literal>TCL_LIB_FILE=</literal>, did you not? - <!-- smiley -->:-).</para> </sect1> - <sect1 id="dads-documentation"> - <title>Install additional documentation</title> + <sect1> + <title>Install additional documentation</title> - <para>If your software has some documentation other than the standard - man and info pages that you think is useful for the user, install it - under <filename><makevar>PREFIX</makevar>/share/doc</filename>. - This can be done, like the previous item, in the - <maketarget>post-install</maketarget> target.</para> + <para>If your software has some documentation other than the standard + man and info pages that you think is useful for the user, install it + under <filename><makevar>PREFIX</makevar>/share/doc</filename>. + This can be done, like the previous item, in the + <maketarget>post-install</maketarget> target.</para> - <para>Create a new directory for your port. The directory name should - reflect what the port is. This usually means - <makevar>PORTNAME</makevar>. However, if you - think the user might want different versions of the port to be - installed at the same time, you can use the whole - <makevar>PKGNAME</makevar>.</para> + <para>Create a new directory for your port. The directory name should + reflect what the port is. This usually means + <makevar>PORTNAME</makevar>. However, if you + think the user might want different versions of the port to be + installed at the same time, you can use the whole + <makevar>PKGNAME</makevar>.</para> - <para>Make the installation dependent on the variable - <makevar>NOPORTDOCS</makevar> so that users can disable it in - <filename>/etc/make.conf</filename>, like this:</para> + <para>Make the installation dependent to the variable + <makevar>NOPORTDOCS</makevar> so that users can disable it in + <filename>/etc/make.conf</filename>, like this:</para> - <programlisting>post-install: + <programlisting>post-install: .if !defined(NOPORTDOCS) - ${MKDIR} ${DOCSDIR} - ${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${DOCSDIR} + ${MKDIR} ${PREFIX}/share/doc/xv + ${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${PREFIX}/share/doc/xv .endif</programlisting> - <para>Here are some handy variables and how they are expanded - by default when used - in the <filename>Makefile</filename>:</para> - - <itemizedlist> - <listitem> - <para><makevar>DATADIR</makevar> gets expanded to - <filename><makevar>PREFIX</makevar>/share/<makevar>PORTNAME</makevar></filename>.</para> - </listitem> - - <listitem> - <para><makevar>DOCSDIR</makevar> gets expanded to - <filename><makevar>PREFIX</makevar>/share/doc/<makevar>PORTNAME</makevar></filename>.</para> - </listitem> - - <listitem> - <para><makevar>EXAMPLESDIR</makevar> gets expanded to - <filename><makevar>PREFIX</makevar>/share/examples/<makevar>PORTNAME</makevar></filename>.</para> - </listitem> - </itemizedlist> - - <para>These variables are exported to <makevar>PLIST_SUB</makevar>. - Their values will appear there as pathnames relative to - <filename><makevar>PREFIX</makevar></filename> if possible. - That is, <filename>share/doc/<makevar>PORTNAME</makevar></filename> - will be substituted for <literal>%%DOCSDIR%%</literal> - in the packing list by default, and so on. - (See more on <filename>pkg-plist</filename> substitution - <link linkend="plist-sub">here</link>.)</para> - <para>All documentation files and directories installed should be included in <filename>pkg-plist</filename> with the <literal>%%PORTDOCS%%</literal> prefix, for example:</para> - <programlisting>%%PORTDOCS%%%%DOCSDIR%%/AUTHORS -%%PORTDOCS%%%%DOCSDIR%%/CONTACT -%%PORTDOCS%%@dirrm %%DOCSDIR%%</programlisting> - - <para>As an alternative to enumerating the documentation files - in <filename>pkg-plist</filename>, a port can set the variable - <makevar>PORTDOCS</makevar> to a list of file names and shell - glob patterns to add to the final packing list. - The names will be relative to <makevar>DOCSDIR</makevar>. - Therefore, a port that utilizes <makevar>PORTDOCS</makevar> and - uses a non-default location for its documentation should set - <makevar>DOCSDIR</makevar> accordingly. - If a directory is listed in <makevar>PORTDOCS</makevar> - or matched by a glob pattern from this variable, - the entire subtree of contained files and directories will be - registered in the final packing list. If <makevar>NOPORTDOCS</makevar> - is defined then files and directories listed in - <makevar>PORTDOCS</makevar> would not be installed and neither - would be added to port packing list. - Installing the documentation at <makevar>PORTDOCS</makevar> - as shown above remains up to the port itself. - A typical example of utilizing <makevar>PORTDOCS</makevar> - looks as follows:</para> - - <programlisting>PORTDOCS= README.* ChangeLog docs/*</programlisting> + <programlisting>%%PORTDOCS%%share/doc/pure-ftpd/AUTHORS +%%PORTDOCS%%share/doc/pure-ftpd/CONTACT +%%PORTDOCS%%@dirrm share/doc/pure-ftpd</programlisting> - <note> - <para>You can also use the <filename>pkg-message</filename> file to - display messages upon installation. See <link - linkend="porting-message">the section on using - <filename>pkg-message</filename></link> for details. - The <filename>pkg-message</filename> file does not need to be - added to <filename>pkg-plist</filename>.</para> - </note> + <para>You can also use the <filename>pkg-message</filename> file to + display messages upon installation. See the <link + linkend="porting-message">using + <filename>pkg-message</filename></link> section for + details.</para> + + <note> + <para><filename>pkg-message</filename> does not need to be added to + <filename>pkg-plist</filename>.</para> + </note> </sect1> - <sect1 id="dads-subdirs"> - <title>Subdirectories</title> - - <para>Try to let the port put things in the right subdirectories of - <makevar>PREFIX</makevar>. Some ports lump everything and put it in - the subdirectory with the port's name, which is incorrect. Also, - many ports put everything except binaries, header files and manual - pages in the a subdirectory of <filename>lib</filename>, which does - not work well with the BSD paradigm. Many of the files should be - moved to one of the following: <filename>etc</filename> - (setup/configuration files), <filename>libexec</filename> - (executables started internally), <filename>sbin</filename> - (executables for superusers/managers), <filename>info</filename> - (documentation for info browser) or <filename>share</filename> - (architecture independent files). See &man.hier.7; for details; - the rules governing - <filename>/usr</filename> pretty much apply to - <filename>/usr/local</filename> too. The exception are ports - dealing with USENET <quote>news</quote>. They may use - <filename><makevar>PREFIX</makevar>/news</filename> as a destination - for their files.</para> + <sect1> + <title><makevar>DIST_SUBDIR</makevar></title> + + <para>Do not let your port clutter + <filename>/usr/ports/distfiles</filename>. If your port requires a + lot of files to be fetched, or contains a file that has a name that + might conflict with other ports (e.g., + <filename>Makefile</filename>), set <makevar>DIST_SUBDIR</makevar> + to the name of the port (<literal>${PORTNAME}</literal> or + <literal>${PKGNAMEPREFIX}${PORTNAME}</literal> + should work fine). This will change + <makevar>DISTDIR</makevar> from the default + <filename>/usr/ports/distfiles</filename> to + <filename>/usr/ports/distfiles/<makevar>DIST_SUBDIR</makevar></filename>, + and in effect puts everything that is required for your port into + that subdirectory.</para> + + <para>It will also look at the subdirectory with the same name on the + backup master site at <filename>ftp.FreeBSD.org</filename>. + (Setting <makevar>DISTDIR</makevar> explicitly in your + <makevar>Makefile</makevar> will not accomplish this, so please use + <makevar>DIST_SUBDIR</makevar>.)</para> + + <note> + <para>This does not affect the <makevar>MASTER_SITES</makevar> you + define in your Makefile.</para> + </note> </sect1> - <sect1 id="dads-sh-exec"> - <title>Use the <function>exec</function> statement in wrapper scripts</title> + <sect1> + <title>Package information</title> - <para>If the port installs a shell script whose purpose is to launch - another program, and if launching that program is the last action - performed by the script, make sure to launch the program using - the <function>exec</function> statement, for instance:</para> + <para>Do include package information, i.e. + <filename>pkg-comment</filename>, <filename>pkg-descr</filename>, and + <filename>pkg-plist</filename>.</para> - <programlisting>#!/bin/sh -exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"</programlisting> + <note> + <para>Note that these files are not used only for packaging anymore, + and are <emphasis>mandatory</emphasis> now, even if + <makevar>NO_PACKAGE</makevar> is set.</para> + </note> + </sect1> - <para>The <function>exec</function> statement replaces the shell - process with the specified program. If <function>exec</function> - is omitted, the shell process remains in memory while the - program is executing, and needlessly consumes system - resources.</para> + <sect1> + <title>RCS strings</title> + <para>Do not put RCS strings in patches. CVS will mangle them when we + put the files into the ports tree, and when we check them out again, + they will come out different and the patch will fail. RCS strings + are surrounded by dollar (<literal>$</literal>) signs, and + typically start with <literal>$Id</literal> or + <literal>$RCS</literal>.</para> </sect1> - <sect1 id="dads-uid-and-gids"> - <title>UIDs and GIDs</title> + <sect1> + <title>Recursive diff</title> + + <para>Using the recurse (<option>-r</option>) option to + <command>diff</command> to generate patches is fine, but please take + a look at the resulting patches to make sure you do not have any + unnecessary junk in there. In particular, diffs between two backup + files, <filename>Makefiles</filename> when the port uses + <command>Imake</command> or GNU <command>configure</command>, etc., + are unnecessary and should be deleted. If you had to edit + <filename>configure.in</filename> and run + <command>autoconf</command> to regenerate + <command>configure</command>, do not take the diffs of + <command>configure</command> (it often grows to a few thousand + lines!); define <literal>USE_AUTOCONF=yes</literal> and take the + diffs of <filename>configure.in</filename>.</para> + + <para>Also, if you had to delete a file, then you can do it in the + <maketarget>post-extract</maketarget> target rather than as part of + the patch. Once you are happy with the resulting diff, please split + it up into one source file per patch file.</para> + </sect1> - <para>If your port requires a certain user to be on the installed - system, let the <filename>pkg-install</filename> script call - <command>pw</command> to create it automatically. Look at - <filename role="package">net/cvsup-mirror</filename> for an example.</para> + <sect1 id="porting-prefix"> + <title><makevar>PREFIX</makevar></title> + + <para>Do try to make your port install relative to + <makevar>PREFIX</makevar>. (The value of this variable will be set + to <makevar>LOCALBASE</makevar> (default + <filename>/usr/local</filename>), unless + <makevar>USE_X_PREFIX</makevar> or <makevar>USE_IMAKE</makevar> is + set, in which case it will be <makevar>X11BASE</makevar> (default + <filename>/usr/X11R6</filename>).)</para> + + <para>Not hard-coding <filename>/usr/local</filename> or + <filename>/usr/X11R6</filename> anywhere in the source will make the + port much more flexible and able to cater to the needs of other + sites. For X ports that use <command>imake</command>, this is + automatic; otherwise, this can often be done by simply replacing the + occurrences of <filename>/usr/local</filename> (or + <filename>/usr/X11R6</filename> for X ports that do not use imake) + in the various scripts/Makefiles in the port to read + <makevar>PREFIX</makevar>, as this variable is automatically passed + down to every stage of the build and install processes.</para> + + <para>Make sure your application isn't installing things in + <filename>/usr/local</filename> instead of <makevar>PREFIX</makevar>. + A quick test for this is to do this is:</para> - <para>If your port must use the same user/group ID number when it is - installed as a binary package as when it was compiled, then you must - choose a free UID from 50 to 999 and register it below. Look at - <filename role="package">japanese/Wnn6</filename> for an example.</para> + <screen>&prompt.root; <userinput>make clean; make package PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput></screen> + + <para>If anything is installed outside of <makevar>PREFIX</makevar>, + making the package creation process will complain that it + can't find the files.</para> - <para>Make sure you do not use a UID already used by the system or - other ports.</para> + <!-- XXX This paragraph is confusing and poorly indented. --> + <para>This does not test for the existence of internal references, + or correct use of <makevar>LOCALBASE</makevar> for references to + files from other ports. Testing the installation in + <filename>/var/tmp/<replaceable>port-name</replaceable></filename> + to do that that while you have it installed would do that.</para> + + <para>Do not set <makevar>USE_X_PREFIX</makevar> unless your port + truly requires it (i.e., it links against X libs or it needs to + reference files in <makevar>X11BASE</makevar>).</para> + + <para>The variable <makevar>PREFIX</makevar> can be reassigned in your + <filename>Makefile</filename> or in the user's environment. + However, it is strongly discouraged for individual ports to set this + variable explicitly in the <filename>Makefiles</filename>.</para> - <para>This is the current list of UIDs between 50 and 999.</para> + <para>Also, refer to programs/files from other ports with the + variables mentioned above, not explicit pathnames. For instance, if + your port requires a macro <literal>PAGER</literal> to be the full + pathname of <command>less</command>, use the compiler flag: + + <programlisting>-DPAGER=\"${PREFIX}/bin/less\"</programlisting> + + or + + <programlisting>-DPAGER=\"${LOCALBASE}/bin/less\"</programlisting> + + if this is an X port, instead of + <literal>-DPAGER=\"/usr/local/bin/less\"</literal>. This way it will + have a better chance of working if the system administrator has + moved the whole `/usr/local' tree somewhere else.</para> + </sect1> - <!-- Please keep this list sorted by uid --> - <programlisting>bind:*:53:53:Bind Sandbox:/:/sbin/nologin -majordom:*:54:54:Majordomo Pseudo User:/usr/local/majordomo:/nonexistent -rdfdb:*:55:55:rdfDB Daemon:/var/db/rdfdb:/bin/sh -spamd:*:58:58:SpamAssassin user:/var/spool/spamd:/sbin/nologin + <sect1> + <title>Subdirectories</title> + + <para>Try to let the port put things in the right subdirectories of + <makevar>PREFIX</makevar>. Some ports lump everything and put it in + the subdirectory with the port's name, which is incorrect. Also, + many ports put everything except binaries, header files and manual + pages in the a subdirectory of <filename>lib</filename>, which does + not bode well with the BSD paradigm. Many of the files should be + moved to one of the following: <filename>etc</filename> + (setup/configuration files), <filename>libexec</filename> + (executables started internally), <filename>sbin</filename> + (executables for superusers/managers), <filename>info</filename> + (documentation for info browser) or <filename>share</filename> + (architecture independent files). See man &man.hier.7; for details, + the rules governing + <filename>/usr</filename> pretty much apply to + <filename>/usr/local</filename> too. The exception are ports + dealing with USENET “news”. They may use + <filename><makevar>PREFIX</makevar>/news</filename> as a destination + for their files.</para> + </sect1> + + <sect1 id="porting-cleaning"> + <title>Cleaning up empty directories</title> + + <para>Do make your ports clean up after themselves when they are + deinstalled. This is usually accomplished by adding + <literal>@dirrm</literal> lines for all directories that are + specifically created by the port. You need to delete subdirectories + before you can delete parent directories.</para> + + <programlisting> : +lib/X11/oneko/pixmaps/cat.xpm +lib/X11/oneko/sounds/cat.au + : +@dirrm lib/X11/oneko/pixmaps +@dirrm lib/X11/oneko/sounds +@dirrm lib/X11/oneko</programlisting> + + <para>However, sometimes <literal>@dirrm</literal> will give you + errors because other ports also share the same subdirectory. You + can call <command>rmdir</command> from <literal>@unexec</literal> to + remove only empty directories without warning.</para> + + <programlisting>@unexec rmdir %D/share/doc/gimp 2>/dev/null || true</programlisting> + + <para>This will neither print any error messages nor cause + <command>pkg_delete</command> to exit abnormally even if + <filename><makevar>PREFIX</makevar>/share/doc/gimp</filename> is not + empty due to other ports installing some files in there.</para> + </sect1> + + <sect1> + <title>UIDs</title> + + <para>If your port requires a certain user to be on the installed + system, let the <filename>pkg-install</filename> script call + <command>pw</command> to create it automatically. Look at + <filename>net/cvsup-mirror</filename> for an example.</para> + + <para>If your port must use the same user/group ID number when it is + installed as a binary package as when it was compiled, then you must + choose a free UID from 50 to 99 and register it below. Look at + <filename>japanese/Wnn</filename> for an example.</para> + + <para>Make sure you do not use a UID already used by the system or + other ports. This is the current list of UIDs between 50 and + 99.</para> + + <programlisting>majordom:*:54:54:Majordomo Pseudo User:/usr/local/majordomo:/nonexistent cyrus:*:60:60:the cyrus mail server:/nonexistent:/nonexistent gnats:*:61:1:GNATS database owner:/usr/local/share/gnats/gnats-db:/bin/sh -proxy:*:62:62:Packet Filter pseudo-user:/nonexistent:/nonexistent uucp:*:66:66:UUCP pseudo-user:/var/spool/uucppublic:/usr/libexec/uucp/uucico xten:*:67:67:X-10 daemon:/usr/local/xten:/nonexistent -pop:*:68:6:Post Office Owner (popper):/nonexistent:/sbin/nologin +pop:*:68:6:Post Office Owner (popper):/nonexistent:/nonexistent wnn:*:69:7:Wnn:/nonexistent:/nonexistent +ifmail:*:70:66:Ifmail user:/nonexistent:/nonexistent pgsql:*:70:70:PostgreSQL pseudo-user:/usr/local/pgsql:/bin/sh -oracle:*:71:71::0:0:Oracle:/usr/local/oracle7:/sbin/nologin -ircd:*:72:72:IRC daemon:/nonexistent:/nonexistent -ircservices:*:73:73:IRC services:/nonexistent:/nonexistent -simscan:*:74:74:Simscan User:/nonexistent:/sbin/nologin -ifmail:*:75:66:Ifmail user:/nonexistent:/nonexistent -www:*:80:80:World Wide Web Owner:/nonexistent:/sbin/nologin +ircd:*:72:72:IRCd hybrid:/nonexistent:/nonexistent alias:*:81:81:QMail user:/var/qmail/alias:/nonexistent -qmaild:*:82:81:QMail user:/var/qmail:/nonexistent qmaill:*:83:81:QMail user:/var/qmail:/nonexistent -qmailp:*:84:81:QMail user:/var/qmail:/nonexistent +qmaild:*:82:81:QMail user:/var/qmail:/nonexistent qmailq:*:85:82:QMail user:/var/qmail:/nonexistent -qmailr:*:86:82:QMail user:/var/qmail:/nonexistent qmails:*:87:82:QMail user:/var/qmail:/nonexistent +qmailp:*:84:81:QMail user:/var/qmail:/nonexistent +qmailr:*:86:82:QMail user:/var/qmail:/nonexistent +msql:*:87:87:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh mysql:*:88:88:MySQL Daemon:/var/db/mysql:/sbin/nologin -vpopmail:*:89:89:VPop Mail User:/usr/local/vpopmail:/nonexistent -firebird:*:90:90:Firebird Database Administrator:/usr/local/firebird:/bin/sh -mailman:*:91:91:Mailman User:/usr/local/mailman:/sbin/nologin -gdm:*:92:92:GDM Sandbox:/:/sbin/nologin -jabber:*:93:93:Jabber Daemon:/nonexistent:/nonexistent -p4admin:*:94:94:Perforce admin:/usr/local/perforce:/sbin/nologin -interch:*:95:95:Interchange user:/usr/local/interchange:/sbin/nologin -squeuer:*:96:96:SQueuer Owner:/nonexistent:/bin/sh -mud:*:97:97:MUD Owner:/nonexistent:/bin/sh -msql:*:98:98:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh -rscsi:*:99:99:Remote SCSI:/usr/local/rscsi:/usr/local/sbin/rscsi -squid:*:100:100:squid caching-proxy pseudo user:/usr/local/squid:/sbin/nologin -quagga:*:101:101:Quagga route daemon pseudo user:/usr/local/etc/quagga:/sbin/nologin -ganglia:*:102:102:Ganglia User:/nonexistent:/sbin/nologin -sgeadmin:*:103:103:Sun Grid Engine Admin:/nonexistent:/sbin/nologin -slimserv:*:104:104:Slim Devices SlimServer pseudo-user:/nonexistent:/sbin/nologin -dnetc:*:105:105:distributed.net client and proxy pseudo-user:/nonexistent:/sbin/nologin -clamav:*:106:106:Clamav Antivirus:/nonexistent:/sbin/nologin -cacti:*:107:107:Cacti Sandbox:/nonexistent:/sbin/nologin -webkit:*:108:108:WebKit Default User:/usr/local/www/webkit:/bin/sh -quickml:*:109:109:quickml Server:/nonexistent:/sbin/nologin -vscan:*:110:110:Scanning Virus Account:/var/amavis:/bin/sh -fido:*:111:111:Fido System:/usr/local/fido:/bin/sh -dcc:*:112:112:Distributed Checksum Clearinghouse:/nonexistent:/sbin/nologin -amavis:*:113:113:Amavis-stats Account:/nonexistent:/sbin/nologin -dhis:*:114:114:DHIS Daemon:/nonexistent:/sbin/nologin -_symon:*:115:115:Symon Account:/var/empty:/sbin/nologin -postfix:*:125:125:Postfix Mail System:/var/spool/postfix:/sbin/nologin -_bgpd:*:130:130:BGP Daemon:/var/empty:/sbin/nologin -_ospfd:*:131:131:OSPF Daemon:/var/empty:/sbin/nologin -rbldns:*:153:153:rbldnsd pseudo-user:/nonexistent:/sbin/nologin -sfs:*:171:171:Self-Certifying File System:/nonexistent:/sbin/nologin -agk:*:172:172:AquaGateKeeper:/nonexistent:/nonexistent -polipo:*:173:173:polipo web cache:/nonexistent:/sbin/nologin -bogomilter:*:174:174:milter-bogom:/nonexistent:/sbin/nologin -moinmoin:*:192:192:MoinMoin User:/nonexistent:/sbin/nologin -sympa:*:200:200:Sympa Owner:/nonexistent:/sbin/nologin -privoxy:*:201:201:Privoxy proxy user:/nonexistent:/sbin/nologin -dspam:*:202:202:Dspam:/nonexistent:/sbin/nologin -shoutcast:*:210:210:Shoutcast sandbox:/nonexistent:/bin/sh -_tor:*:256:256:Tor anonymising router:/var/db/tor:/bin/sh -smxs:*:260:260:Sendmail X SMTPS:/nonexistent:/sbin/nologin -smxq:*:261:261:Sendmail X QMGR:/nonexistent:/sbin/nologin -smxc:*:262:262:Sendmail X SMTPC:/nonexistent:/sbin/nologin -smxm:*:263:263:Sendmail X misc:/nonexistent:/sbin/nologin -smx:*:264:264:Sendmail X other:/nonexistent:/sbin/nologin -mrtg:*:279:279:MRTG daemon:/nonexistent:/sbin/nologin -ldap:*:389:389:OpenLDAP Server:/nonexistent:/sbin/nologin -drweb:*:426:426:Dr.Web Mail Scanner:/nonexistent:/sbin/nologin -courier:*:465:465:Courier Mail Server:/nonexistent:/sbin/nologin -_bbstored:*:505:505::0:0:BoxBackup Store Daemon:/nonexistent:/bin/sh -qtss:*:554:554:Darwin Streaming Server:/nonexistent:/sbin/nologin -ircdru:*:555:555:Russian hybrid IRC server:/nonexistent:/bin/sh -messagebus:*:556:556:D-BUS Daemon User:/nonexistent:/sbin/nologin -avahi:*:558:558:Avahi Daemon User:/nonexistent:/sbin/nologin -bnetd:*:700:700:Bnetd user:/nonexistent:/sbin/nologin -bopm:*:717:717:Blitzed Open Proxy Monitor:/nonexistent:/bin/sh -bacula:*:910:910:Bacula Daemon:/var/db/bacula:/sbin/nologin</programlisting> - - <para>This is the current list of reserved GIDs.</para> - - <!-- Please keep this list sorted by gid --> - <!-- XXX incomplete! --> - <programlisting>bind:*:53: -rdfdb:*:55: -spamd:*:58: -cyrus:*:60: -proxy:*:62: -authpf:*:63: -uucp:*:66: -xten:*:67: -dialer:*:68: -network:*:69: -pgsql:*:70: -simscan:*:74: -audit:*:77: -www:*:80: -qnofiles:*:81: -qmail:*:82: -mysql:*:88: -vpopmail:*:89: -firebird:*:90: -mailman:*:91: -gdm:*:92: -jabber:*:93: -p4admin:*:94: -interch:*:95: -squeuer:*:96: -mud:*:97: -msql:*:98: -rscsi:*:99: -squid:*:100: -quagga:*:101: -ganglia:*:102: -sgeadmin:*:103: -slimserv:*:104: -dnetc:*:105: -clamav:*:106: -cacti:*:107: -webkit:*:108: -quickml:*:109: -vscan:*:110: -fido:*:111: -dcc:*:112: -amavis:*:113: -dhis:*:114: -_symon:*:115: -postfix:*:125: -maildrop:*:126: -_bgpd:*:130: -_ospfd:*:131: -rbldns:*:153: -sfs:*:171: -agk:*:172: -polipo:*:173: -moinmoin:*:192: -sympa:*:200: -dspam:*:202: -_tor:*:256: -smxs:*:260: -smxq:*:261: -smxc:*:262: -smxm:*:263: -smx:*:264: -mrtg:*:279: -ldap:*:389: -drweb:*:426: -courier:*:465: -_bbstored:*:505: -qtss:*:554: -ircdru:*:555: -messagebus:*:556: -realtime:*:557: -avahi:*:558: -bnetd:*:700: -bopm:*:717: -bacula:*:910:</programlisting> - - <para>Please include a notice when you submit a port (or an upgrade) - that reserves a new UID or GID in this range. This allows us to - keep the list of reserved IDs up to date.</para> - </sect1> +vpopmail:*:89:89::0:0:User &:/usr/local/vpopmail:/nonexistent</programlisting> - <sect1 id="dads-rational"> - <title>Do things rationally</title> - - <para>The <filename>Makefile</filename> should do things simply and - reasonably. If you can make it a couple of lines shorter or more - readable, then do so. Examples include using a make - <literal>.if</literal> construct instead of a shell - <literal>if</literal> construct, not redefining - <maketarget>do-extract</maketarget> if you can redefine - <makevar>EXTRACT*</makevar> instead, and using - <makevar>GNU_CONFIGURE</makevar> instead of <literal>CONFIGURE_ARGS - += --prefix=${PREFIX}</literal>.</para> - - <para>If you find yourself having to write a lot - of new code to try to do something, please go back and review - <filename>bsd.port.mk</filename> to see if it contains an - existing implementation of what you are trying to do. While - hard to read, there are a great many seemingly-hard problems for - which <filename>bsd.port.mk</filename> already provides a - shorthand solution.</para> + <para>Please include a notice when you submit a port (or an upgrade) + that reserves a new UID or GID in this range. This allows us to + keep the list of reserved IDs up to date.</para> </sect1> - <sect1 id="dads-cc"> - <title>Respect both <makevar>CC</makevar> and - <makevar>CXX</makevar></title> - - <para>The port should respect both <makevar>CC</makevar> - and <makevar>CXX</makevar> variables. What we mean by this - is that the port should not set the values of these variables - absolutely, overriding existing values; instead, it should append - whatever values it needs to the existing values. This is so that - build options that affect all ports can be set globally.</para> - - <para>If the port does not respect these variables, - please add <literal>NO_PACKAGE=ignores either cc or - cxx</literal> to the <filename>Makefile</filename>.</para> - - <para>An example of a <filename>Makefile</filename> respecting - both <makevar>CC</makevar> and <makevar>CXX</makevar> - variables follows. Note the <makevar>?=</makevar>:</para> - - <programlisting>CC?= gcc</programlisting> - <programlisting>CXX?= g++</programlisting> - - <para>Here is an example which respects neither - <makevar>CC</makevar> nor <makevar>CXX</makevar> - variables:</para> - - <programlisting>CC= gcc</programlisting> - <programlisting>CXX= g++</programlisting> - - <para>Both <makevar>CC</makevar> and <makevar>CXX</makevar> - variables can be defined on FreeBSD systems in - <filename>/etc/make.conf</filename>. The first example - defines a value if it was not previously set in - <filename>/etc/make.conf</filename>, preserving any - system-wide definitions. The second example clobbers - anything previously defined.</para> + <sect1> + <title>Do things rationally</title> + + <para>The <filename>Makefile</filename> should do things simply and + reasonably. If you can make it a couple of lines shorter or more + readable, then do so. Examples include using a make + <literal>.if</literal> construct instead of a shell + <literal>if</literal> construct, not redefining + <maketarget>do-extract</maketarget> if you can redefine + <makevar>EXTRACT*</makevar> instead, and using + <makevar>GNU_CONFIGURE</makevar> instead of <literal>CONFIGURE_ARGS + += --prefix=${PREFIX}</literal>.</para> </sect1> - <sect1 id="dads-cflags"> - <title>Respect <makevar>CFLAGS</makevar></title> - - <para>The port should respect the <makevar>CFLAGS</makevar> variable. - What we mean by this is that the port should not set the value of - this variable absolutely, overriding the existing value; instead, - it should append whatever values it needs to the existing value. - This is so that build options that affect all ports can be set - globally.</para> + <sect1> + <title>Respect <makevar>CFLAGS</makevar></title> - <para>If it does not, please add <literal>NO_PACKAGE=ignores - cflags</literal> to the <filename>Makefile</filename>.</para> + <para>The port should respect the <makevar>CFLAGS</makevar> variable. + If it does not, please add <literal>NO_PACKAGE=ignores + cflags</literal> to the <filename>Makefile</filename>.</para> <para>An example of a <filename>Makefile</filename> respecting the <makevar>CFLAGS</makevar> variable follows. Note the <makevar>+=</makevar>:</para> - <programlisting>CFLAGS+= -Wall -Werror</programlisting> + <programlisting>CFLAGS += -Wall -Werror</programlisting> <para>Here is an example which does not respect the <makevar>CFLAGS</makevar> variable:</para> - <programlisting>CFLAGS= -Wall -Werror</programlisting> + <programlisting>CFLAGS = -Wall -Werror</programlisting> <para>The <makevar>CFLAGS</makevar> variable is defined on FreeBSD systems in <filename>/etc/make.conf</filename>. The @@ -9509,350 +3552,93 @@ bacula:*:910:</programlisting> <makevar>CFLAGS</makevar> variable, preserving any system-wide definitions. The second example clobbers anything previously defined.</para> - - <para>You should remove optimization flags from the third party - <filename>Makefile</filename>s. System <makevar>CFLAGS</makevar> - contains system-wide optimization flags. An example from - an unmodified <filename>Makefile</filename>:</para> - - <programlisting>CFLAGS= -O3 -funroll-loops -DHAVE_SOUND</programlisting> - - <para>Using system optimization flags, the - <filename>Makefile</filename> would look similar to the - following example:</para> - - <programlisting>CFLAGS+= -DHAVE_SOUND</programlisting> - </sect1> - <sect1 id="dads-pthread"> - <title>Threading libraries</title> - - <para>The threading library must be linked to the binaries - using a special linker flag <literal>-pthread</literal> on - &os;. If a port insists on linking - <literal>-lpthread</literal> or <literal>-lc_r</literal> - directly, patch it to use <makevar>PTHREAD_LIBS</makevar> - variable provided by the ports framework. This variable - usually has the value of <literal>-pthread</literal>, but - on certain architectures and &os; versions it can have - different values, so do not just hardcode - <literal>-pthread</literal> into patches and always use - <makevar>PTHREAD_LIBS</makevar>.</para> - - <note> - <para>If building the port errors out with <literal>unrecognized - option '-pthread'</literal> when setting - <makevar>PTHREAD_LIBS</makevar>, it may be desirable to use - <command>gcc</command> as linker by setting - <makevar>CONFIGURE_ENV</makevar> to <literal>LD=${CC}</literal>. - The <literal>-pthread</literal> option is not supported by - <command>ld</command> directly.</para> - </note> - + <sect1> + <title>Configuration files</title> + + <para>If your port requires some configuration files in + <filename><makevar>PREFIX</makevar>/etc</filename>, do + <emphasis>not</emphasis> just install them and list them in + <filename>pkg-plist</filename>. That will cause + <command>pkg_delete</command> to delete files carefully edited by + the user and a new installation to wipe them out.</para> + + <para>Instead, install sample files with a suffix + (<filename><replaceable>filename</replaceable>.sample</filename> + will work well) and print out a <link + linkend="porting-message">message</link> pointing out that the + user has to copy and edit the file before the software can be made + to work.</para> </sect1> - <sect1 id="dads-freedback"> - <title>Feedback</title> + <sect1> + <title>Portlint</title> - <para>Do send applicable changes/patches to the original - author/maintainer for inclusion in next release of the code. This - will only make your job that much easier for the next - release.</para> + <para>Do check your work with <link + linkend="porting-portlint"><command>portlint</command></link> + before you submit or commit it.</para> </sect1> - <sect1 id="dads-readme"> - <title><filename>README.html</filename></title> + <sect1> + <title>Feedback</title> - <para>Do not include the <filename>README.html</filename> file. This - file is not part of the cvs collection but is generated using the - <command>make readme</command> command. - </para> + <para>Do send applicable changes/patches to the original + author/maintainer for inclusion in next release of the code. This + will only make your job that much easier for the next + release.</para> </sect1> - <sect1 id="dads-noinstall"> - <title>Marking a port not installable with <makevar>BROKEN</makevar>, - <makevar>FORBIDDEN</makevar>, or <makevar>IGNORE</makevar></title> - - <para>In certain cases users should be prevented from installing - a port. To tell a user that - a port should not be installed, there are several - <command>make</command> variables that can be used in a port's - <filename>Makefile</filename>. The value of the following - <command>make</command> variables will be the reason that is - given back to users for why the port refuses to install itself. - Please use the correct <command>make</command> variable as - each make variable conveys radically different meanings to - both users, and to automated systems that depend on the - <filename>Makefile</filename>s, such as - <link linkend="build-cluster">the ports build cluster</link>, - <link linkend="freshports">FreshPorts</link>, and - <link linkend="portsmon">portsmon</link>.</para> - - <sect2 id="dads-noinstall-variables"> - <title>Variables</title> - - <itemizedlist> - <listitem> - <para><makevar>BROKEN</makevar> is reserved for ports that - currently do not compile, install, or deinstall correctly. - It should be used for ports where the the problem is - believed to be temporary. - The build cluster will still attempt to try to build - them to see if the underlying problem has been - resolved. For instance, use - <makevar>BROKEN</makevar> when a port:</para> - - <itemizedlist> - <listitem> - <para>does not compile</para> - </listitem> - - <listitem> - <para>fails its configuration or installation process</para> - </listitem> - - <listitem> - <para>installs files outside of - <filename>${LOCALBASE}</filename> and - <filename>${X11BASE}</filename></para> - </listitem> - - <listitem> - <para>does not remove all its files cleanly upon - deinstall (however, it may be acceptable, and desirable, - for the port to leave user-modified files behind)</para> - </listitem> - </itemizedlist> - - </listitem> - - <listitem> - <para><makevar>FORBIDDEN</makevar> is used for ports that - do contain a security vulnerability or induce grave - concern regarding the security of a FreeBSD system with - a given port installed (ex: a reputably insecure program - or a program that provides easily exploitable services). - Ports should be marked as <makevar>FORBIDDEN</makevar> - as soon as a particular piece of software has a - vulnerability and there is no released upgrade. Ideally - ports should be upgraded as soon as possible when a - security vulnerability is discovered so as to reduce the - number of vulnerable FreeBSD hosts (we like being known - for being secure), however sometimes there is a - noticeable time gap between disclosure of a - vulnerability and an updated release of the - vulnerable software. Do not mark a port - <makevar>FORBIDDEN</makevar> for any reason other than - security.</para> - </listitem> - - <listitem> - <para><makevar>IGNORE</makevar> is reserved for ports that - should not be built for some other reason. - It should be used for ports where the the problem is - believed to be structural. - The build - cluster will not, under any - circumstances, build ports marked as - <makevar>IGNORE</makevar>. For instance, use - <makevar>IGNORE</makevar> when a port:</para> - - <itemizedlist> - <listitem> - <para>compiles but does not run properly</para> - </listitem> - - <listitem> - <para>does not work on the installed version of &os;</para> - </listitem> - - <listitem> - <para>requires &os; kernel sources to build, but the - user does not have them installed</para> - </listitem> - - <listitem> - <para>has a distfile which may not be automatically - fetched due to licensing restrictions</para> - </listitem> - - <listitem> - <para>does not work with some other currently installed - port (for instance, the port depends on - <filename role="package">www/apache21</filename> but - <filename role="package">www/apache13</filename> - is installed)</para> - </listitem> - </itemizedlist> - - <note> - <para>If a port would conflict with a currently installed - port (for example, if they install a file in the same - place that perfoms a different function), - <link linkend="conflicts">use - <makevar>CONFLICTS</makevar> instead</link>. - <makevar>CONFLICTS</makevar> will set - <makevar>IGNORE</makevar> by itself.</para> - </note> - </listitem> - - <listitem> - <para>If a port sould be marked <makevar>IGNORE</makevar> - only on certain architectures, there are two other - convenience variables that will automatically set - <makevar>IGNORE</makevar> for you: - <makevar>ONLY_FOR_ARCHS</makevar> and - <makevar>NOT_FOR_ARCHS</makevar>. Examples:</para> - - <programlisting>ONLY_FOR_ARCHS= i386 amd64</programlisting> - - <programlisting>NOT_FOR_ARCHS= alpha ia64 sparc64</programlisting> - </listitem> - - </itemizedlist> - - </sect2> - <sect2 id="dads-noinstall-notes"> - <title>Implementation Notes</title> - - <para>The strings should not be quoted. - Also, the wording of the string should be somewhat - different due to the way the information is shown to the - user. Examples:</para> - - <programlisting>BROKEN= this port is unsupported on FreeBSD 5.x</programlisting> - - <programlisting>IGNORE= is unsupported on FreeBSD 5.x</programlisting> - - <para>resulting in the following output from - <command>make describe</command>:</para> - - <programlisting>===> foobar-0.1 is marked as broken: this port is unsupported on FreeBSD 5.x.</programlisting> - - <programlisting>===> foobar-0.1 is unsupported on FreeBSD 5.x.</programlisting> - </sect2> - </sect1> - - <sect1 id="dads-deprecated"> - <title>Marking a port for removal with <makevar>DEPRECATED</makevar> - or <makevar>EXPIRATION_DATE</makevar></title> - - <para>Do remember that <makevar>BROKEN</makevar> and - <makevar>FORBIDDEN</makevar> are to be used as a - temporary resort if a port is not working. Permanently - broken ports should be removed from the tree - entirely.</para> - - <para>When it makes sense to do so, users can be warned about - a pending port removal with <makevar>DEPRECATED</makevar> - and <makevar>EXPIRATION_DATE</makevar>. The former is - simply a string stating why the port is scheduled for removal; - the latter is a string in ISO 8601 format (YYYY-MM-DD). Both - will be shown to the user.</para> - - <para>It is possible to set <makevar>DEPRECATED</makevar> - without an <makevar>EXPIRATION_DATE</makevar> (for - instance, recommending a newer version of the port), but - the converse does not make any sense.</para> - - <para>There is no set policy on how much notice to give. - Current practice seems to be one month for security-related - issues and two months for build issues. This also gives any - interested committers a little time to fix the problems.</para> - </sect1> - - <sect1 id="dads-dot-error"> - <title>Avoid use of the <literal>.error</literal> construct</title> - - <para>The correct way for a <filename>Makefile</filename> to - signal that the port can not be installed due to some external - factor (for instance, the user has specified an illegal - combination of build options) is to set a nonblank value to - <makevar>IGNORE</makevar>. This value will be formatted and - shown to the user by <command>make install</command>.</para> - - <para>It is a common mistake to use <literal>.error</literal> - for this purpose. The problem with this is that many - automated tools that work with the ports tree will fail in - this situation. The most common occurence of this is seen - when trying to build <filename>/usr/ports/INDEX</filename> - (see <xref linkend="make-describe">). However, even more - trivial commands such as <command>make -V maintainer</command> - also fail in this scenario. This is not acceptable.</para> - - <example id="dot-error-breaks-index"> - <title>How to avoid using <literal>.error</literal></title> - <para>Assume that someone has the line - <programlisting>USE_POINTYHAT=yes</programlisting> - in <filename>make.conf</filename>. The first of - the next two <filename>Makefile</filename> snippets will - cause <command>make index</command> to fail, while the - second one will not:</para> - <programlisting>.if USE_POINTYHAT -.error "POINTYHAT is not supported" -.endif</programlisting> - <programlisting>.if USE_POINTYHAT -IGNORE=POINTYHAT is not supported -.endif</programlisting> - </example> + <sect1> + <title><filename>README.html</filename></title> + <para>Do not include the <filename>README.html</filename> file. This + file is not part of the cvs collection but is generated using the + <command>make readme</command> command. + </para> </sect1> - <sect1 id="dads-workarounds"> - <title>Necessary workarounds</title> - - <para>Sometimes it is necessary to work around bugs in - software included with older versions of &os;.</para> + <sect1> + <title>Miscellanea</title> - <itemizedlist> - <listitem> - <para>Some versions of &man.make.1; were broken - on at least 4.8 and 5.0 with respect to handling - comparisons based on <makevar>OSVERSION</makevar>. - This would often lead to failures during - <command>make describe</command> (and thus, the overall - ports <command>make index</command>). The workaround is - to enclose the conditional comparison in spaces, e.g.: - <programlisting>if ( ${OSVERSION} > 500023 )</programlisting> - Be aware that test-installing a port on 4.9 or 5.2 - will <emphasis>not</emphasis> detect this problem.</para> - </listitem> + <para>The files <filename>pkg-comment</filename>, + <filename>pkg-descr</filename>, and <filename>pkg-plist</filename> + should each be double-checked. If you are reviewing a port and feel + they can be worded better, do so.</para> - </itemizedlist> + <para>Do not copy more copies of the GNU General Public License into + our system, please.</para> + <para>Please be careful to note any legal issues! Do not let us + illegally distribute software!</para> </sect1> - <sect1 id="dads-misc"> - <title>Miscellanea</title> + <sect1> + <title>If you are stuck…</title> - <para>The files - <filename>pkg-descr</filename> and <filename>pkg-plist</filename> - should each be double-checked. If you are reviewing a port and feel - they can be worded better, do so.</para> + <para>Do look at existing examples and the + <filename>bsd.port.mk</filename> file before asking us questions! + <!-- smiley --><emphasis>;-)</emphasis></para> - <para>Do not copy more copies of the GNU General Public License into - our system, please.</para> - - <para>Please be careful to note any legal issues! Do not let us - illegally distribute software!</para> + <para>Do ask us questions if you have any trouble! Do not just beat + your head against a wall! <!-- smiley + --><emphasis>:-)</emphasis></para> </sect1> - </chapter> <chapter id="porting-samplem"> <title>A Sample <filename>Makefile</filename></title> <para>Here is a sample <filename>Makefile</filename> that you can use to - create a new port. Make sure you remove all the extra comments (ones - between brackets)!</para> + create a new port. Make sure you remove all the extra comments (ones + between brackets)!</para> <para>It is recommended that you follow this format (ordering of - variables, empty lines between sections, etc.). This format is - designed so that the most important information is easy to locate. We - recommend that you use <link - linkend="porting-portlint">portlint</link> to check the - <filename>Makefile</filename>.</para> + variables, empty lines between sections, etc.). This format is + designed so that the most important information is easy to locate. We + recommend that you use <link + linkend="porting-portlint">portlint</link> to check the + <filename>Makefile</filename>.</para> <programlisting>[the header...just to make it easier for us to identify the ports.] # New ports collection makefile for: xdvi @@ -9892,13 +3678,12 @@ EXTRACT_SUFX= .tar.Z PATCH_SITES= ftp://ftp.sra.co.jp/pub/X11/japanese/ PATCHFILES= xdvi-18.patch1.gz xdvi-18.patch2.gz -[maintainer; *mandatory*! This is the person who is volunteering to - handle port updates, build breakages, and to whom a users can direct - questions and bug reports. To keep the quality of the Ports Collection - as high as possible, we no longer accept new ports that are assigned to - "ports@FreeBSD.org".] +[maintainer; *mandatory*! This is the person (preferably with commit + privileges) whom a user can contact for questions and bug reports - this + person should be the porter or someone who can forward questions to the + original porter reasonably promptly. If you really do not want to have + your address here, set it to "ports@FreeBSD.org".] MAINTAINER= asami@FreeBSD.org -COMMENT= A DVI Previewer for the X Window System [dependencies -- can be empty] RUN_DEPENDS= gs:${PORTSDIR}/print/ghostscript @@ -9926,153 +3711,815 @@ MY_FAVORITE_RESPONSE= "yeah, right" [then the special rules, in the order they are called] pre-fetch: - i go fetch something, yeah + i go fetch something, yeah post-patch: - i need to do something after patch, great + i need to do something after patch, great pre-install: - and then some more stuff before installing, wow + and then some more stuff before installing, wow [and then the epilogue] .include <bsd.port.mk></programlisting> </chapter> - <chapter id="keeping-up"> - <title>Keeping Up</title> - - <para>The &os; Ports Collection is constantly changing. Here is - some information on how to keep up.</para> - - <sect1 id="freshports"> - <title>FreshPorts</title> - - <para>One of the easiest ways to learn about updates that have - already been committed is by subscribing to - <ulink url="http://www.FreshPorts.org/">FreshPorts</ulink>. - You can select multiple ports to monitor. Maintainers are - strongly encouraged to subscribe, because they will receive - notification of not only their own changes, but also any - changes that any other &os; committer has made. (These are - often necessary to keep up with changes in the underlying - ports framework—although it would be most polite to - receive an advance heads-up from those committing such changes, - sometimes this is overlooked or just simply impractical. - Also, in some cases, the changes are very minor in nature. - We expect everyone to use their best judgement in these - cases.)</para> - - <para>If you wish to use FreshPorts, all you need is an - account. If your registered email address is - <literal>@FreeBSD.org</literal>, you will see the opt-in link on the - right hand side of the webpages. - For those of you who already have a FreshPorts account, but are not - using your <literal>@FreeBSD.org</literal> email address, - just change your email to <literal>@FreeBSD.org</literal>, subscribe, - then change it back again.</para> - - <para>FreshPorts also has - a sanity test feature which automatically tests each commit to the - FreeBSD ports tree. If subscribed to this service, you will be - notified of any errors which FreshPorts detects during sanity - testing of your commits.</para> - </sect1> + <chapter id="porting-autoplist"> + <title>Automated package list creation</title> + + <para>First, make sure your port is almost complete, with only + <filename>pkg-plist</filename> missing. Create an empty + <filename>pkg-plist</filename>.</para> - <sect1 id="cvsweb"> - <title>The Web Interface to the Source Repository</title> - - <para>It is possible to browse the files in the source repository by - using a web interface. Changes that affect the entire port system - are now documented in the - <ulink url="http://cvsweb.FreeBSD.org/ports/CHANGES"> - CHANGES</ulink> file. Changes that affect individual ports - are now documented in the - <ulink url="http://cvsweb.FreeBSD.org/ports/UPDATING"> - UPDATING</ulink> file. However, the definitive answer to any - question is undoubtedly to read the source code of <ulink - url="http://cvsweb.FreeBSD.org/ports/Mk/bsd.port.mk"> - bsd.port.mk</ulink>, and associated files.</para> + <screen>&prompt.root; <userinput>touch pkg-plist</userinput></screen> - </sect1> + <para>Next, create a new set of directories which your port can be + installed, and install any dependencies.</para> - <sect1 id="ports-mailling-list"> - <title>The &os; Ports Mailing List</title> + <screen>&prompt.root; <userinput>mtree -U -f /etc/mtree/BSD.local.dist -d -e -p /var/tmp/<replaceable>port-name</replaceable></userinput> +&prompt.root; <userinput>make depends PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput></screen> - <para>If you maintain ports, you should consider following the - &a.ports;. Important changes to the way ports work will be announced - there, and then committed to <filename>CHANGES</filename>.</para> + <para>Store the directory structure in a new file.</para> - </sect1> + <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find * -type d) > OLD-DIRS</userinput></screen> - <sect1 id="build-cluster"> - <title>The &os; Port Building Cluster on - <hostid role="hostname">pointyhat.FreeBSD.org</hostid></title> - - <para>One of the least-publicized strengths of &os; is that - an entire cluster of machines is dedicated to continually - building the Ports Collection, for each of the major OS - releases and for each Tier-1 architecture. You can find - the results of these builds at - <ulink url="http://pointyhat.FreeBSD.org/">package building logs - and errors</ulink>.</para> - - <para>Individual ports are built unless they are specifically - marked with <makevar>IGNORE</makevar>. Ports that are - marked with <makevar>BROKEN</makevar> will still be attempted, - to see if the underlying problem has been resolved. (This - is done by passing <makevar>TRYBROKEN</makevar> to the - port's <filename>Makefile</filename>.)</para> + <para>If your port honors <makevar>PREFIX</makevar> (which it should) + you can then install the port and create the package list.</para> - </sect1> + <screen>&prompt.root; <userinput>make install PREFIX=/var/tmp/<replaceable>port-name</replaceable></userinput> +&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find * \! -type d) > pkg-plist</userinput></screen> - <sect1 id="distfile-survey"> - <title>The &os; Port Distfile Survey</title> - - <para>The build cluster is dedicated to building the latest - release of each port with distfiles that have already been - fetched. However, as the Internet continually changes, - distfiles can quickly go missing. The <ulink - url="http://people.FreeBSD.org/~fenner/portsurvey/">FreeBSD - Ports distfiles survey</ulink> attempts to query every - download site for every port to find out if each distfile - is still currently available. Maintainers are asked to - check this report periodically, not only to speed up the - building process for users, but to help avoid wasting - bandwidth of the sites that volunteer to host all these - distfiles.</para> + <para>You must also add any newly created directories to the packing + list.</para> + + <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name && find * -type d) | comm -13 OLD-DIRS - | sed -e 's#^#@dirrm #' >> pkg-plist</replaceable></userinput></screen> + + <para>Finally, you need to tidy up the packing list by hand; it isn't + <emphasis>all</emphasis> automated. Manual pages should be listed in + the port's <filename>Makefile</filename> under + <makevar>MAN<replaceable>n</replaceable></makevar>, and not in the + package list. User configuration files should be removed, or + installed as + <filename><replaceable>filename</replaceable>.sample</filename>. + The <filename>info/dir</filename> file should not be listed + and appropriate <filename>install-info</filename> lines should + be added as noted in the <link linkend="porting-info">info + files</link> section. Any + libraries installed by the port should be listed as specified in the + <link linkend="porting-shlibs">shared libraries</link> section.</para> + </chapter> + <chapter id="porting-pkgname"> + <title>Package Names</title> + + <para>The following are the conventions you should follow in naming your + packages. This is to have our package directory easy to scan, as + there are already lots and lots of packages and users are going to + turn away if they hurt their eyes!</para> + + <para>The package name should look like + <filename><replaceable><optional>language<optional>_region</optional></optional>-name<optional><optional>-</optional>compiled.specifics</optional>-version.numbers</replaceable></filename>.</para> + + <para>The package name is defined as + <literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>. + Make sure to set the variables to conform to that format.</para> + + <orderedlist> + <listitem> + <para>FreeBSD strives to support the native language of its users. + The <replaceable>language-</replaceable> part should be a two + letter abbreviation of the natural language defined by ISO-639 if + the port is specific to a certain language. Examples are + <literal>ja</literal> for Japanese, <literal>ru</literal> for + Russian, <literal>vi</literal> for Vietnamese, + <literal>zh</literal> for Chinese, <literal>ko</literal> for + Korean and <literal>de</literal> for German.</para> + + <para>If the port is specific to a certain region within the + language area, add the two letter country code as well. + Examples are <literal>en_US</literal> for US English and + <literal>fr_CH</literal> for Swiss French.</para> + + <para>The <replaceable>language-</replaceable> part should + be set in the <makevar>PKGNAMEPREFIX</makevar> variable.</para> + </listitem> + + <listitem> + <para>The first letter of <filename>name</filename> part + should be lowercase. (The rest of the name can contain + capital letters, so use your own discretion when you are + converting a software name that has some capital letters in it.) + There is a tradition of naming Perl 5 modules by + prepending <literal>p5-</literal> and converting the double-colon + separator to a hyphen; for example, the + <literal>Data::Dumper</literal> module becomes + <literal>p5-Data-Dumper</literal>. If the software in question + has numbers, hyphens, or underscores in its name, you may include + them as well (like <literal>kinput2</literal>).</para> + </listitem> + + <listitem> + <para>If the port can be built with different <link + linkend="porting-masterdir">hardcoded defaults</link> (usually + part of the directory name in a family of ports), the + <replaceable>-compiled.specifics</replaceable> part should state + the compiled-in defaults (the hyphen is optional). Examples are + papersize and font units.</para> + + <para>The <replaceable>compiled.specifics</replaceable> part + should be set in the <makevar>PKGNAMESUFFIX</makevar> + variable.</para> + </listitem> + + <listitem> + <para>The version string should follow a dash + (<literal>-</literal>) and be a period-separated list of + integers and single lowercase alphabetics. In particular, + it is not permissible to have another dash inside the + version string. The only exception is the string + <literal>pl</literal> (meaning `patchlevel'), which can be + used <emphasis>only</emphasis> when there are no major and + minor version numbers in the software. If the software + version has strings like "alpha", "beta", "rc", or "pre", take + the first letter and put it immediately after a period. + If the version string continues after those names, the + numbers should follow the single alphabet without an extra + period between them.</para> + + <para>The idea is to make it easier to sort ports by looking + at the version string. In particular, make sure version + number components are always delimited by a period, and + if the date is part of the string, use the + <literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> + format, not + <literal><replaceable>dd</replaceable>.<replaceable>mm</replaceable>.<replaceable>yyyy</replaceable></literal> + or the non-Y2K compliant + <literal><replaceable>yy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> + format.</para> + </listitem> + </orderedlist> + + <para>Here are some (real) examples on how to convert the name + as called by the software authors to a suitable package + name:</para> + + <informaltable frame="none"> + <tgroup cols="6"> + <thead> + <row> + <entry>Distribution Name</entry> + <entry><makevar>PKGNAMEPREFIX</makevar></entry> + <entry><makevar>PORTNAME</makevar></entry> + <entry><makevar>PKGNAMESUFFIX</makevar></entry> + <entry><makevar>PORTVERSION</makevar></entry> + <entry>Reason</entry> + </row> + </thead> + + <tbody> + <row> + <entry>mule-2.2.2</entry> + <entry>(empty)</entry> + <entry>mule</entry> + <entry>(empty)</entry> + <entry>2.2.2</entry> + <entry>No changes required</entry> + </row> + + <row> + <entry>XFree86-3.3.6</entry> + <entry>(empty)</entry> + <entry>XFree86</entry> + <entry>(empty)</entry> + <entry>3.3.6</entry> + <entry>No changes required</entry> + </row> + + <row> + <entry>EmiClock-1.0.2</entry> + <entry>(empty)</entry> + <entry>emiclock</entry> + <entry>(empty)</entry> + <entry>1.0.2</entry> + <entry>No uppercase names for single programs</entry> + </row> + + <row> + <entry>rdist-1.3alpha</entry> + <entry>(empty)</entry> + <entry>rdist</entry> + <entry>(empty)</entry> + <entry>1.3.a</entry> + <entry>No strings like <literal>alpha</literal> + allowed</entry> + </row> + + <row> + <entry>es-0.9-beta1</entry> + <entry>(empty)</entry> + <entry>es</entry> + <entry>(empty)</entry> + <entry>0.9.b1</entry> + <entry>No strings like <literal>beta</literal> + allowed</entry> + </row> + + <row> + <entry>mailman-2.0rc3</entry> + <entry>(empty)</entry> + <entry>mailman</entry> + <entry>(empty)</entry> + <entry>2.0.r3</entry> + <entry>No strings like <literal>rc</literal> + allowed</entry> + </row> + + <row> + <entry>v3.3beta021.src</entry> + <entry>(empty)</entry> + <entry>tiff</entry> + <entry>(empty)</entry> + <entry>3.3</entry> + <entry>What the heck was that anyway?</entry> + </row> + + <row> + <entry>tvtwm</entry> + <entry>(empty)</entry> + <entry>tvtwm</entry> + <entry>(empty)</entry> + <entry>pl11</entry> + <entry>Version string always required</entry> + </row> + + <row> + <entry>piewm</entry> + <entry>(empty)</entry> + <entry>piewm</entry> + <entry>(empty)</entry> + <entry>1.0</entry> + <entry>Version string always required</entry> + </row> + + <row> + <entry>xvgr-2.10pl1</entry> + <entry>(empty)</entry> + <entry>xvgr</entry> + <entry>(empty)</entry> + <entry>2.10.1</entry> + <entry><literal>pl</literal> allowed only when no + major/minor version numbers</entry> + </row> + + <row> + <entry>gawk-2.15.6</entry> + <entry>ja-</entry> + <entry>gawk</entry> + <entry>(empty)</entry> + <entry>2.15.6</entry> + <entry>Japanese language version</entry> + </row> + + <row> + <entry>psutils-1.13</entry> + <entry>(empty)</entry> + <entry>psutils</entry> + <entry>-letter</entry> + <entry>1.13</entry> + <entry>Papersize hardcoded at package build time</entry> + </row> + + <row> + <entry>pkfonts</entry> + <entry>(empty)</entry> + <entry>pkfonts</entry> + <entry>300</entry> + <entry>1.0</entry> + <entry>Package for 300dpi fonts</entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para>If there is absolutely no trace of version information in the + original source and it is unlikely that the original author will ever + release another version, just set the version string to + <literal>1.0</literal> (like the piewm example above). Otherwise, ask + the original author or use the date string + (<literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>) + as the version.</para> + </chapter> + + <chapter id="porting-categories"> + <title>Categories</title> + + <para>As you already know, ports are classified in several categories. + But for this to work, it is important that porters and users understand + what each category is for and how we decide what to put in each + category.</para> + + <sect1> + <title>Current list of categories</title> + + <para>First, this is the current list of port categories. Those + marked with an asterisk (<literal>*</literal>) are + <emphasis>virtual</emphasis> categories—those that do not have + a corresponding subdirectory in the ports tree.</para> + + <note> + <para>For non-virtual categories, you will find a one-line + description in the <filename>pkg/COMMENT</filename> file in that + subdirectory (e.g., + <filename>archivers/pkg/COMMENT</filename>).</para> + </note> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Category</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry><filename>afterstep*</filename></entry> + <entry>Ports to support the AfterStep window manager.</entry> + </row> + + <row> + <entry><filename>archivers</filename></entry> + <entry>Archiving tools.</entry> + </row> + + <row> + <entry><filename>astro</filename></entry> + <entry>Astronomical ports.</entry> + </row> + + <row> + <entry><filename>audio</filename></entry> + <entry>Sound support.</entry> + </row> + + <row> + <entry><filename>benchmarks</filename></entry> + <entry>Benchmarking utilities.</entry> + </row> + + <row> + <entry><filename>biology</filename></entry> + <entry>Biology-related software.</entry> + </row> + + <row> + <entry><filename>cad</filename></entry> + <entry>Computer aided design tools.</entry> + </row> + + <row> + <entry><filename>chinese</filename></entry> + <entry>Chinese language support.</entry> + </row> + + <row> + <entry><filename>comms</filename></entry> + <entry>Communication software. Mostly software to talk to + your serial port.</entry> + </row> + + <row> + <entry><filename>converters</filename></entry> + <entry>Character code converters.</entry> + </row> + + <row> + <entry><filename>databases</filename></entry> + <entry>Databases.</entry> + </row> + + <row> + <entry><filename>deskutils</filename></entry> + <entry>Things that used to be on the desktop before + computers were invented.</entry> + </row> + + <row> + <entry><filename>devel</filename></entry> + <entry>Development utilities. Do not put libraries here just + because they are libraries—unless they truly do not + belong anywhere else, they should not be in this + category.</entry> + </row> + + <row> + <entry><filename>editors</filename></entry> + <entry>General editors. Specialized editors go in the section + for those tools (e.g., a mathematical-formula editor will go + in <filename>math</filename>).</entry> + </row> + + <row> + <entry><filename>elisp*</filename></entry> + <entry>Emacs-lisp ports.</entry> + </row> + + <row> + <entry><filename>emulators</filename></entry> + <entry>Emulators for other operating systems. Terminal + emulators do <emphasis>not</emphasis> belong + here—X-based ones should go to + <filename>x11</filename> and text-based ones to either + <filename>comms</filename> or <filename>misc</filename>, + depending on the exact functionality.</entry> + </row> + + <row> + <entry><filename>french</filename></entry> + <entry>French language support.</entry> + </row> + + <row> + <entry><filename>ftp</filename></entry> + <entry>FTP client and server utilities. If your + port speaks both FTP and HTTP, put it in + <filename>ftp</filename> with a secondary + category of <filename>www</filename>.</entry> + </row> + + <row> + <entry><filename>games</filename></entry> + <entry>Games.</entry> + </row> + + <row> + <entry><filename>german</filename></entry> + <entry>German language support.</entry> + </row> + + <row> + <entry><filename>gnome*</filename></entry> + <entry>Ports from the GNU Object Model Environment (GNOME) + Project.</entry> + </row> + + <row> + <entry><filename>graphics</filename></entry> + <entry>Graphics utilities.</entry> + </row> + + <row> + <entry><filename>hebrew</filename></entry> + <entry>Hebrew language support.</entry> + </row> + + <row> + <entry><filename>irc</filename></entry> + <entry>Internet Relay Chat utilities.</entry> + </row> + + <row> + <entry><filename>ipv6*</filename></entry> + <entry>IPv6 related software.</entry> + </row> + + <row> + <entry><filename>japanese</filename></entry> + <entry>Japanese language support.</entry> + </row> + + <row> + <entry><filename>java</filename></entry> + <entry>Java language support.</entry> + </row> + + <row> + <entry><filename>kde*</filename></entry> + <entry>Ports from the K Desktop Environment (KDE) + Project.</entry> + </row> + + <row> + <entry><filename>korean</filename></entry> + <entry>Korean language support.</entry> + </row> + + <row> + <entry><filename>lang</filename></entry> + <entry>Programming languages.</entry> + </row> + + <row> + <entry><filename>linux*</filename></entry> + <entry>Linux applications and support utilities.</entry> + </row> + + <row> + <entry><filename>mail</filename></entry> + <entry>Mail software.</entry> + </row> + + <row> + <entry><filename>math</filename></entry> + <entry>Numerical computation software and other utilities + for mathematics.</entry> + </row> + + <row> + <entry><filename>mbone</filename></entry> + <entry>MBone applications.</entry> + </row> + + <row> + <entry><filename>misc</filename></entry> + <entry>Miscellaneous utilities—basically things that + do not belong anywhere else. This is the only category + that should not appear with any other non-virtual category. + If you have <literal>misc</literal> with something else in + your <makevar>CATEGORIES</makevar> line, that means you can + safely delete <literal>misc</literal> and just put the port + in that other subdirectory!</entry> + </row> + + <row> + <entry><filename>net</filename></entry> + <entry>Miscellaneous networking software.</entry> + </row> + + <row> + <entry><filename>news</filename></entry> + <entry>USENET news software.</entry> + </row> + + <row> + <entry><filename>offix*</filename></entry> + <entry>Ports from the OffiX suite.</entry> + </row> + + <row> + <entry><filename>palm</filename></entry> + <entry>Software support for the 3Com Palm(tm) series.</entry> + </row> + + <row> + <entry><filename>perl5*</filename></entry> + <entry>Ports that require perl version 5 to run.</entry> + </row> + + <row> + <entry><filename>picobsd</filename></entry> + <entry>Ports to support PicoBSD.</entry> + </row> + + <row> + <entry><filename>plan9*</filename></entry> + <entry>Various programs from Plan9.</entry> + </row> + + <row> + <entry><filename>print</filename></entry> + <entry>Printing software. Desktop publishing tools + (previewers, etc.) belong here too.</entry> + </row> + + <row> + <entry><filename>python*</filename></entry> + <entry>Software written in python.</entry> + </row> + + <row> + <entry><filename>ruby*</filename></entry> + <entry>Software written in ruby.</entry> + </row> + + <row> + <entry><filename>russian</filename></entry> + <entry>Russian language support.</entry> + </row> + + <row> + <entry><filename>science</filename></entry> + <entry>Scientific ports that don't fit into other + categories such as <filename>astro</filename>, + <filename>biology</filename> and + <filename>math</filename>.</entry> + </row> + + <row> + <entry><filename>security</filename></entry> + <entry>Security utilities.</entry> + </row> + + <row> + <entry><filename>shells</filename></entry> + <entry>Command line shells.</entry> + </row> + + <row> + <entry><filename>sysutils</filename></entry> + <entry>System utilities.</entry> + </row> + + <row> + <entry><filename>tcl76*</filename></entry> + <entry>Ports that use Tcl version 7.6 to run.</entry> + </row> + + <row> + <entry><filename>tcl80*</filename></entry> + <entry>Ports that use Tcl version 8.0 to run.</entry> + </row> + + <row> + <entry><filename>tcl81*</filename></entry> + <entry>Ports that use Tcl version 8.1 to run.</entry> + </row> + + <row> + <entry><filename>tcl82*</filename></entry> + <entry>Ports that use Tcl version 8.2 to run.</entry> + </row> + + <row> + <entry><filename>textproc</filename></entry> + <entry>Text processing utilities. It does not include + desktop publishing tools, which go to print/.</entry> + </row> + + <row> + <entry><filename>tk42*</filename></entry> + <entry>Ports that use Tk version 4.2 to run.</entry> + </row> + + <row> + <entry><filename>tk80*</filename></entry> + <entry>Ports that use Tk version 8.0 to run.</entry> + </row> + + <row> + <entry><filename>tk81*</filename></entry> + <entry>Ports that use Tk version 8.1 to run.</entry> + </row> + + <row> + <entry><filename>tk82*</filename></entry> + <entry>Ports that use Tk version 8.2 to run.</entry> + </row> + + <row> + <entry><filename>tkstep80*</filename></entry> + <entry>Ports that use TkSTEP version 8.0 to run.</entry> + </row> + + <row> + <entry><filename>ukrainian</filename></entry> + <entry>Ukrainian language support.</entry> + </row> + + <row> + <entry><filename>vietnamese</filename></entry> + <entry>Vietnamese language support.</entry> + </row> + + <row> + <entry><filename>windowmaker*</filename></entry> + <entry>Ports to support the WindowMaker window + manager</entry> + </row> + + <row> + <entry><filename>www</filename></entry> + <entry>Software related to the World Wide Web. HTML language + support belongs here too.</entry> + </row> + + <row> + <entry>x11</entry> + <entry>The X window system and friends. This category is only + for software that directly supports the window system. Do not + put regular X applications here. If your port is an X + application, define <makevar>USE_XLIB</makevar> (implied by + <makevar>USE_IMAKE</makevar>) and put it in the appropriate + categories. Also, many of them go into other + <filename>x11-*</filename> categories (see below).</entry> + </row> + + <row> + <entry><filename>x11-clocks</filename></entry> + <entry>X11 clocks.</entry> + </row> + + <row> + <entry><filename>x11-fm</filename></entry> + <entry>X11 file managers.</entry> + </row> + + <row> + <entry><filename>x11-fonts</filename></entry> + <entry>X11 fonts and font utilities.</entry> + </row> + + <row> + <entry><filename>x11-servers</filename></entry> + <entry>X11 servers.</entry> + </row> + + <row> + <entry><filename>x11-toolkits</filename></entry> + <entry>X11 toolkits.</entry> + </row> + + <row> + <entry><filename>x11-wm</filename></entry> + <entry>X11 window managers.</entry> + </row> + + <row> + <entry><filename>zope*</filename></entry> + <entry>Zope support.</entry> + </row> + </tbody> + </tgroup> + </informaltable> </sect1> - <sect1 id="portsmon"> - - <title>The &os; Ports Monitoring System</title> - - <para>Another handy resource is the - <ulink url="http://portsmon.FreeBSD.org"> - FreeBSD Ports Monitoring System</ulink> (also known as - <literal>portsmon</literal>). This system comprises a - database that processes information from several sources - and allows its to be browsed via a web interface. Currently, - the ports Problem Reports (PRs), the error logs from - the build cluster, and individual files from the ports - collection are used. In the future, this will be expanded - to include the distfile survey, as well as other sources.</para> - - <para>To get started, you can view all information about a - particular port by using the - <ulink url="http://portsmon.FreeBSD.org/portoverview.py"> - Overview of One Port</ulink>.</para> - - <para>As of this writing, this is the only resource available - that maps GNATS PR entries to portnames. (PR submitters - do not always include the portname in their Synopsis, although - we would prefer that they did.) So, <literal>portsmon</literal> - is a good place to start if you want to find out whether an - existing port has any PRs filed against it and/or any build - errors; or, to find out if a new port that you may be thinking - about creating has already been submitted.</para> + <sect1> + <title>Choosing the right category</title> + + <para>As many of the categories overlap, you often have to choose + which of the categories should be the primary category of your port. + There are several rules that govern this issue. Here is the list of + priorities, in decreasing order of precedence.</para> + + <itemizedlist> + <listitem> + <para>Language specific categories always come first. For + example, if your port installs Japanese X11 fonts, then your + <makevar>CATEGORIES</makevar> line would read <literal>japanese + x11-fonts</literal>.</para> + </listitem> + + <listitem> + <para>Specific categories win over less-specific ones. For + instance, an HTML editor should be listed as <literal>www + editors</literal>, not the other way around. Also, you do not + need to list <literal>net</literal> when the port belongs to + any of <literal>irc</literal>, <literal>mail</literal>, + <literal>mbone</literal>, <literal>news</literal>, + <literal>security</literal>, or <literal>www</literal>.</para> + </listitem> + + <listitem> + <para><literal>x11</literal> is used as a secondary category only + when the primary category is a natural language. In particular, + you should not put <literal>x11</literal> in the category line + for X applications.</para> + </listitem> + + <listitem> + <para><application>Emacs</application> modes should be + placed in the same ports category as the application + supported by the mode, not in + <filename>editors</filename>. For example, an + <application>Emacs</application> mode to edit source + files of some programming language should go into + <filename>lang</filename>. + </para> + </listitem> + + <listitem> + <para>If your port truly does not belong anywhere else, put it in + <literal>misc</literal>.</para> + </listitem> + </itemizedlist> + + <para>If you are not sure about the category, please put a comment to + that effect in your <command>send-pr</command> submission so we can + discuss it before we import it. If you are a committer, send a note + to the &a.ports; so we can discuss it first—too often new ports are + imported to the wrong category only to be moved right away.</para> </sect1> + </chapter> + + <chapter> + <title>Changes to this document and the ports system</title> + + <para>If you maintain a lot of ports, you should consider following the + &a.ports;. Important changes to the way ports work will be announced + there. You can always find more detailed information on the latest + changes by looking at <ulink + url="http://www.FreeBSD.org/cgi/cvsweb.cgi/ports/Mk/bsd.port.mk"> the + bsd.port.mk CVS log</ulink>.</para> + </chapter> + + <chapter> + <title>That is It, Folks!</title> + <para>Boy, this sure was a long tutorial, wasn't it? Thanks for + following us to here, really. Now that you know how to do a port, + have at it and convert everything in the world into ports! That + is the easiest way to start contributing to the FreeBSD Project! + <!-- smiley --><emphasis>:-)</emphasis></para> </chapter> </book> diff --git a/ru_RU.KOI8-R/articles/hubs/article.sgml b/ru_RU.KOI8-R/articles/hubs/article.sgml index 59cda73b5e..1ba324b232 100644 --- a/ru_RU.KOI8-R/articles/hubs/article.sgml +++ b/ru_RU.KOI8-R/articles/hubs/article.sgml @@ -2,9 +2,9 @@ <!-- The FreeBSD Russian Documentation Project - $FreeBSDru: frdp/doc/ru_RU.KOI8-R/articles/hubs/article.sgml,v 1.19 2006/02/09 14:48:32 marck Exp $ + $FreeBSDru: frdp/doc/ru_RU.KOI8-R/articles/hubs/article.sgml,v 1.20 2006/04/24 13:56:21 gad Exp $ - Original revision: 1.55 + Original revision: 1.62 --> <!ENTITY % articles.ent PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Articles Entity Set//EN"> @@ -137,7 +137,7 @@ </para> <para> Для умеренно посещаемого сайта, предоставляющего - <application>rsync</application>, можно использовать процессор + <application>Rsync</application>, можно использовать процессор с частотой 800MHz - 1 GHz и по крайней мере 512MB памяти. Скорее всего, данная конфигурация может считаться минимальной для <emphasis>официального</emphasis> зеркала. @@ -218,10 +218,10 @@ </para> </listitem> </itemizedlist> - Наиболее популярными являются встроенный во FreeBSD <application>ftpd</application>, <application>proftpd</application>, <application>wu-ftpd</application> и, возможно, - <application>ncftpd</application>. + <application>ncftpd</application> являются наиболее часто + встречающимися FTP серверами. Прочие распространены среди существующих зеркал в существенно меньшей степени. Дополнительным поводом для рассмотрения может являться возможность гибко ограничивать количество одновременных @@ -230,18 +230,18 @@ </para> </sect3> <sect3 id="mirror-serv-rsync"> - <title>RSYNC (необязательный сервис для FTP зеркала)</title> + <title>Rsync (необязательный сервис для FTP зеркала)</title> <para> - <application>rsync</application> часто используется для + <application>Rsync</application> часто используется для предоставления доступа к FTP-области FreeBSD, чтобы другие зеркала могли синхронизироваться по вашему. Протокол rsync во многом отличается от FTP, в частности, он гораздо гуманнее с точки зрения пропускной способности каналов, поскольку не требует передачи измененного файла целиком (передаются лишь различия). Взамен - <application>rsync</application> требует значительных объемов + <application>Rsync</application> требует значительных объемов памяти. Размер каждого процесса зависит от размера синхронизируемого модуля (в основном от количества директорий и файлов). - <application>rsync</application> может использовать в качестве + <application>Rsync</application> может использовать в качестве транспортного протокола <command>rsh</command> или <command>ssh</command> (по умолчанию); также, может использоваться внутренний протокол <application>rsync</application> (этот метод @@ -257,7 +257,7 @@ <title>HTTP (требуется для веб-страниц, дополнителен для FTP зеркал)</title> <para> Если вы хотите поддерживать зеркало веб-страниц FreeBSD, вам потребуется - веб-сервер, или <application>httpd</application>. + установить веб-сервер. Дополнительно, вы можете предоставлять HTTP доступ к FTP-набору файлов FreeBSD. Выбор веб-сервера остается на усмотрение администратора зеркала. Некоторые из наиболее популярных @@ -266,9 +266,10 @@ <itemizedlist> <listitem> <para><filename role="package">www/apache13</filename>: - Apache — один из самых популярных веб-серверов, активно + <application>Apache</application> — самый широко распространённый + в Интернете веб-сервер, активно используемый проектом FreeBSD. Вы можете также использовать - Apache нового поколения, доступный в коллекции портов как + веб-сервер <application>Apache</application> следующего поколения, доступный в коллекции портов как <filename role="package">www/apache22</filename>.</para> </listitem> @@ -276,17 +277,20 @@ <para><filename role="package">www/thttpd</filename>: Для обслуживания большого количества запросов к статическим документам сервер thttpd может оказаться более эффективным, чем - Apache. thttpd отлично оптимизирован по производительности + <application>Apache</application>. thttpd отлично оптимизирован по производительности при работе под FreeBSD.</para> </listitem> <listitem> <para><filename role="package">www/boa</filename>: - Boa — еще одна альтернатива thttpd и Apache. Этот сервер - должен быть ощутимо более высокопроизводительным, чем Apache, + <application>Boa</application> — еще одна + альтернатива <application>thttpd</application> и + <application>Apache</application>. Этот сервер + должен быть ощутимо более высокопроизводительным, чем + <application>Apache</application>, для полностью статических страниц. На время написания данного документа, впрочем, он не так хорошо оптимизирован под - FreeBSD, как thttpd.</para> + FreeBSD, как <application>thttpd</application>.</para> </listitem> </itemizedlist> </para> @@ -300,7 +304,7 @@ использования с репозиториями CVS. Если вы планируете предоставлять доступ к репозиторию CVS FreeBSD, стоит делать это посредством <application>CVSup</application>. Помимо этого, можно использовать - <application>AnonCVS</application>, FTP, <application>Rsync</application> + <application>AnonCVS</application>, FTP, <application>rsync</application> или HTTP, но использование <application>CVSup</application> наиболее разумно. Автором <application>CVSup</application> является &a.jdp;. @@ -320,8 +324,8 @@ </listitem> <listitem> <para><filename role="package">net/cvsup-mirror</filename>: - Набор для CVSup-зеркала, требующий - <filename role="package">net/cvsup</filename>, + Набор для CVSup-зеркала, требующий + <filename role="package">net/cvsup-without-gui</filename>, и конфигурирующий его в процессе установки. Возможно, некоторым администраторам потребуется другой набор установок. </para> @@ -432,14 +436,14 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all <para> Для выкачивания файлов вы можете использовать программу <application>FTP-зеркалирования</application>. - Существует довольно много таких, например: + Вот некоторые из наиболее часто использующихся: <itemizedlist> <listitem><para><filename role="package">ftp/mirror</filename></para></listitem> <listitem><para><filename role="package">ftp/ftpmirror</filename></para></listitem> <listitem><para><filename role="package">ftp/emirror</filename></para></listitem> <listitem><para><filename role="package">ftp/spegla</filename></para></listitem> <listitem><para><filename role="package">ftp/omi</filename></para></listitem> - <listitem><para>и даже <filename role="package">ftp/wget</filename></para></listitem> + <listitem><para><filename role="package">ftp/wget</filename></para></listitem> </itemizedlist> Ранее наиболее популярным вариантом был @@ -458,7 +462,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all </para> </sect3> <sect3 id="mirror-ftp-rsync"> - <title>При помощи RSYNC</title> + <title>При помощи rsync</title> <para> Более эффективным будет синхронизация FTP-области при помощи <application>rsync</application>. Для этого следует установить @@ -501,7 +505,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all <hostid role="fqdn">ftp-master.FreeBSD.org</hostid> предоставляют для синхронизации FTP-области доступ по протоколу <application>CVSup</application>. Вам потребуется клиент - <application>cvsup</application>, предпочтительно из пакета + <application>CVSup</application>, предпочтительно из пакета <filename role="package">net/cvsup</filename> (см. также <xref linkend="mirror-serv-cvsup">). Пример конфигурационного файла (<filename>supfile</filename>) для @@ -531,50 +535,29 @@ FreeBSD-archive release=all preserve <para> Прочтите документацию по <application>CVSup</application>, например, &man.cvsup.1;, и обратите внимание на опцию - <option>-s</option>: она может существенно уменьшить объем - работы при синхронизации. - </para> + <option>-s</option>. Она может уменьшить объем операций + ввода-вывода, предполагая, что записанная информация о + каждом файле корректна.</para> </note> </para> </sect3> </sect2> <sect2 id="mirror-cvs"> - <title>Синхронизация репозитория CVS</title> - <para> - Как и в других случаях, репозиторий можно синхронизировать различными - способами; однако, рекомендуемым является - <link linkend="mirror-cvs-cvsup">CVSup</link>. - </para> + <title>Зеркалирование CVS репозитория</title> + <para>Существует несколько способов синхронизации + CVS репозитория. <application>CVSup</application> наиболее + общий метод.</para> + <sect3 id="mirror-cvs-cvsup"> <title>Использование CVSup</title> - <para> - Программа <application>CVSup</application> уже была описана ранее - (<xref linkend="mirror-serv-cvsup"> и - <xref linkend="mirror-ftp-cvsup">). - </para> - <para> - Здесь мы лишь приведем пример конфигурационного файла - (<filename>supfile</filename>): - <programlisting> -# -# FreeBSD CVS supfile from master server -# -*default host=cvsup-master.FreeBSD.org -*default base=/usr -*default prefix=/pub/FreeBSD/development/FreeBSD-CVS -*default release=cvs -*default delete use-rel-suffix -*default umask=002 - -# If your network link is a T1 or faster, comment out the following line. -#*default compress - -cvs-all - </programlisting> + <para>Программа <application>CVSup</application> немного описана + в (<xref linkend="mirror-serv-cvsup"> и + <xref linkend="mirror-ftp-cvsup">).</para> - Кроме того, можете использовать в качестве шаблона - <filename>/usr/share/examples/cvsup</filename>. - </para> + <para>Настроить <application>CVSup</application> зеркало очень + просто. Установка <filename role="package">net/cvsup-mirror</filename> + проверит, что все нужные программы установлены и затем + соберет всю необходимую информацию для конфигурирования зеркала.</para> <note> <para> Не забудьте почитать полезную подсказку @@ -593,23 +576,14 @@ cvs-all могут быть использованы: <itemizedlist> <listitem><para><application>FTP</application></para></listitem> - <listitem><para><application>RSYNC</application></para></listitem> - <listitem><para>и даже <application>HTTP</application></para></listitem> + <listitem><para><application>Rsync</application></para></listitem> + <listitem><para><application>HTTP</application></para></listitem> </itemizedlist> - Если вы найдете сайт, поддерживающий обновления по - <filename role="package">net/sup</filename>, можете использовать его. - Впрочем, учитывая, что именно недостатки sup в свое время - заставили Джона Полстру написать <application>CVSup</application>, - данный метод никак не может быть рекомендован. - <important> - <para> - Для синхронизации репозитория CVS <emphasis>не может - быть</emphasis> использован AnonCVS, поскольку CVS не - дает доступа к репозиторию напрямую, а лишь позволяет - извлекать отдельные версии модулей. - </para> + <para>AnonCVS не может использоваться для зеркалирования CVS + репозитория, так как CVS не разрешает сам доступ к репозиторию, + а только к извлечённым версиям модулей.</para> </important> </para> </sect3> @@ -619,8 +593,7 @@ cvs-all <para> Лучшим способом будет извлечение (check out) из репозитория CVS модуля <emphasis>www</emphasis>. При условии наличия у вас копии - репозитория, все, что для этого потребуется — выполнить - один раз команду + репозитория, все, что для этого потребуется — выполнить команду <screen>&prompt.user; <userinput>cvs -d /home/ncvs co www</userinput></screen> и сформировать задание для <emphasis>cron</emphasis>, которое будет регулярно выполнять операцию <command>cvs up -d -P</command>, @@ -630,14 +603,6 @@ cvs-all процесс установки и конфигурации веб-сервера для этих целей. </para> - <note><para> - Для того, чтобы страницы сайта стали доступны для просмотра, - необходимо выполнить команду &man.make.1; в основном каталоге модуля - <filename>www</filename>. В результате будет создан комплект - стандартных файлов <filename>*.html</filename>, подготовленных для - просмотра веб-броузером. Обращаем ваше внимание, что для этого - потребуется предварительно установить пакет - <filename role="package">textproc/docproj</filename>.</para></note> <para> Если у вас нет локальной копии репозитория, можно использовать <application>CVSup</application> для синхронизации копии веб-страниц. @@ -713,18 +678,12 @@ doc-all <para> Процесс подготовки и построения документации, а также многие сопутствующие вопросы, подробно описан в документе - <ulink url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/fdp-primer/">fdp-primer</ulink>. - Прочтите этот документ, в особенности если у вас возникли - проблемы со сборкой стандартного комплекта документации - FreeBSD. + <ulink url="&url.books.fdp-primer;">Учебник по Проекту + Документирования &os;</ulink>. Прочтите этот документ, + в особенности если у вас возникли проблемы со сборкой + стандартного комплекта документации. </para> </important> - <note> - <para> - <!-- к чему это относится - мне непонятно [marck] --> - XXX MAYBE THIS CAN BE LINKED FROM WITHIN - NOT USING AN ABSOLUTE URL XXX - </para> - </note> </para> </sect3> </sect2> @@ -772,7 +731,7 @@ doc-all Некоторые рекомендуемые установки частоты обновления: <itemizedlist> <listitem><para>FTP-набор: раз в сутки</para></listitem> - <listitem><para>репозиторий CVS: от раза в сутки до раза в час</para></listitem> + <listitem><para>репозиторий CVS: раз в час</para></listitem> <listitem><para>WWW-страницы: раз в сутки</para></listitem> </itemizedlist> </para> @@ -916,7 +875,7 @@ doc-all <para> <hostid>ftp-master.FreeBSD.org</hostid> поддерживает доступ по <application>rsync</application> и - <application>CVSup</application>. Использование этих протоколов + <application>CVSup</application>, в дополнение к FTP. Использование этих протоколов описано в разделах <xref linkend="mirror-ftp-rsync"> и <xref linkend="mirror-ftp-cvsup">. </para> @@ -1003,7 +962,7 @@ doc-all <listitem><para>предоставлять доступ для других зеркал</para></listitem> <listitem><para>обеспечивать доступ по протоколам <application>FTP</application> и - <application>RSYNC</application>. + <application>rsync</application>. </para></listitem> </itemizedlist> @@ -1098,11 +1057,6 @@ doc-all <title>Статистика FTP сайтов</title> <itemizedlist> <listitem> - <para>ftp2.FreeBSD.org - <email>grisha@ispol.com</email> - - <ulink url="http://people.FreeBSD.org/~logo/ftp2/">(загрузка канала)</ulink> - </para> - </listitem> - <listitem> <para>ftp.is.FreeBSD.org - <email>hostmaster@is.FreeBSD.org</email> - <ulink url="http://www.rhnet.is/status/draupnir/draupnir.html"> (загрузка канала)</ulink> <ulink url="http://www.rhnet.is/status/ftp/ftp-notendur.html">(FTP @@ -1114,7 +1068,7 @@ doc-all <para>ftp.cz.FreeBSD.org - <email>cejkar@fit.vutbr.cz</email> - <ulink url="http://www.cz.FreeBSD.org/stats/mrtg/net.html">(загрузка канала)</ulink> <ulink url="http://www.freebsd.cz/stats/mrtg/ftpd.html">(FTP процессы)</ulink> - <ulink url="http://www.freebsd.cz/stats/mrtg/rsyncd.html">(Rsync процессы)</ulink> + <ulink url="http://www.freebsd.cz/stats/mrtg/rsyncd.html">(rsync процессы)</ulink> </para> </listitem> <listitem> diff --git a/share/mk/doc.xml.mk b/share/mk/doc.xml.mk index e40ced9d01..b222ea1ecc 100644 --- a/share/mk/doc.xml.mk +++ b/share/mk/doc.xml.mk @@ -75,9 +75,11 @@ ${XML_MIRRORS}: ${XML_MIRRORS_MASTER} \ --param 'transtable-sortkey.xml' "'$@.sort'" \ ${XSL_TRANSTABLE} ${XML_MIRRORS_MASTER} ${RM} -f $@.sort $@.sort.tmp +.if ${LANGCODE} != . CLEANFILES+= ${XML_MIRRORS} CLEANFILES+= ${XML_MIRRORS}.sort CLEANFILES+= ${XML_MIRRORS}.sort.tmp +.endif # DEPENDSET: usergroups ...................................................... _DEPENDSET.usergroups= ${XML_USERGROUPS} ${XML_USERGROUPS_LOCAL} \ diff --git a/share/sgml/man-refs.ent b/share/sgml/man-refs.ent index 165d393c90..84b099b1c1 100644 --- a/share/sgml/man-refs.ent +++ b/share/sgml/man-refs.ent @@ -1646,6 +1646,7 @@ <!ENTITY man.fabs.3 "<citerefentry/<refentrytitle/fabs/<manvolnum/3//"> <!ENTITY man.fabsf.3 "<citerefentry/<refentrytitle/fabsf/<manvolnum/3//"> <!ENTITY man.fclose.3 "<citerefentry/<refentrytitle/fclose/<manvolnum/3//"> +<!ENTITY man.fcloseall.3 "<citerefentry/<refentrytitle/fcloseall/<manvolnum/3//"> <!ENTITY man.fdopen.3 "<citerefentry/<refentrytitle/fdopen/<manvolnum/3//"> <!ENTITY man.feof.3 "<citerefentry/<refentrytitle/feof/<manvolnum/3//"> <!ENTITY man.ferror.3 "<citerefentry/<refentrytitle/ferror/<manvolnum/3//"> @@ -3546,6 +3547,7 @@ <!ENTITY man.rl.4 "<citerefentry/<refentrytitle/rl/<manvolnum/4//"> <!ENTITY man.route.4 "<citerefentry/<refentrytitle/route/<manvolnum/4//"> <!ENTITY man.rp.4 "<citerefentry/<refentrytitle/rp/<manvolnum/4//"> +<!ENTITY man.rr232x.4 "<citerefentry/<refentrytitle/rr232x/<manvolnum/4//"> <!ENTITY man.rtc.4 "<citerefentry/<refentrytitle/rtc/<manvolnum/4//"> <!ENTITY man.rue.4 "<citerefentry/<refentrytitle/rue/<manvolnum/4//"> <!ENTITY man.sa.4 "<citerefentry/<refentrytitle/sa/<manvolnum/4//"> @@ -4400,6 +4402,7 @@ <!ENTITY man.slstat.8 "<citerefentry/<refentrytitle/slstat/<manvolnum/8//"> <!ENTITY man.smbmsg.8 "<citerefentry/<refentrytitle/smbmsg/<manvolnum/8//"> <!ENTITY man.smrsh.8 "<citerefentry/<refentrytitle/smrsh/<manvolnum/8//"> +<!ENTITY man.snapinfo.8 "<citerefentry/<refentrytitle/snapinfo/<manvolnum/8//"> <!ENTITY man.spkrtest.8 "<citerefentry/<refentrytitle/spkrtest/<manvolnum/8//"> <!ENTITY man.spppcontrol.8 "<citerefentry/<refentrytitle/spppcontrol/<manvolnum/8//"> <!ENTITY man.spray.8 "<citerefentry/<refentrytitle/spray/<manvolnum/8//"> diff --git a/zh/FAQ/FAQ.sgml b/zh/FAQ/FAQ.sgml deleted file mode 100644 index 9bf088483a..0000000000 --- a/zh/FAQ/FAQ.sgml +++ /dev/null @@ -1,70 +0,0 @@ -<!-- $Id: FAQ.sgml,v 1.8 1999-11-12 08:34:11 vanilla Exp $ --> -<!-- The FreeBSD Documentation Project --> -<!-- Translate into Chinese by ijliao@dragon2.net --> -<!-- English Version: 1.103 --> - -<!DOCTYPE linuxdoc PUBLIC "-//FreeBSD//DTD linuxdoc//EN" [ -<!ENTITY % includes SYSTEM "includes.sgml"> %includes; -<!ENTITY preface SYSTEM "preface.sgml"> -<!ENTITY install SYSTEM "install.sgml"> -<!ENTITY hardware SYSTEM "hardware.sgml"> -<!ENTITY troubleshoot SYSTEM "troubleshoot.sgml"> -<!ENTITY commercial SYSTEM "commercial.sgml"> -<!ENTITY applications SYSTEM "applications.sgml"> -<!ENTITY kernelconfig SYSTEM "kernelconfig.sgml"> -<!ENTITY admin SYSTEM "admin.sgml"> -<!ENTITY x SYSTEM "x.sgml"> -<!ENTITY network SYSTEM "network.sgml"> -<!ENTITY serial SYSTEM "serial.sgml"> -<!ENTITY misc SYSTEM "misc.sgml"> -<!ENTITY hackers SYSTEM "hackers.sgml"> -<!ENTITY acknowledgments SYSTEM "acknowledgments.sgml"> -]> - -<article> - - <title>FreeBSD 2.X ╠`╗ё╟щ╣╙╤╟</title> - <author> - <name>FreeBSD ╓Е╔С╜p╣e</name> - </author> - - <date>$Date: 1999-11-12 08:34:11 $</date> - - <abstract> - Ёo╔В╓Е╔С╛O FreeBSD 2.X ╙╨╠`╗ё╟щ╣╙╤╟║C╟ё╚D╕Ё╞S╖O╔[╣Ы║A╖_╚hЁo╗г╠Ь╔ьЁё╬A - ╔н╘С FreeBSD 2.0.5 ╓н╔H╚А╙╨╙╘╔╩║C╕p╙G╠Ь╔ь╓╨╝e╓╓╕Ё <XXX> ╚h╛O╘|╔╪ - ╖╧╕╗╙╨Ё║╔В║C╕p╙G╠z╧О╗С╖U╔╩╜p╣e╙╨╤i╕Ф╕Ё©Ё╫Л╙╨╦э║A╫п╠H╓@╚й╧q╓l╤l╔С╗Л - FreeBSD ╓Е╔С╜p╣e╙╨ mailing list <htmlurl - url="mailto:freebsd-doc@FreeBSD.org" name="<freebsd-doc@FreeBSD.org>">║C - ╠z╔i╔H╠q <url url="http://www.FreeBSD.org/" - name="FreeBSD World Wide Web server"> ╝Ё╗ЛЁo╔В╓Е╔С╙╨Ёл╥s╙╘╔╩║C╠z╓]╔i╔H - ╖Q╔н HTTP ╗с╓U╦Э╔╩╓Е╔С╙╨ <url url="FAQ.latin1" name="╞б╓Е╕r╙╘">║A - <url url="FAQ.ps" name="postscript ╙╘">║A - <url url="ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/FAQ.pdf" name="PDF ╙╘">║A - ╘н╛O <url url="FAQ-html.tar.gz" name="HTML ╙╘">║A╘н╛O╦g╔я - <url url="ftp://ftp.FreeBSD.org/pub/FreeBSD/docs" name="FreeBSD FTP ╞╦"> - ╗с╓U╦Э gzip'd ╙╨╙╘╔╩║C╠z╘нЁ\╓]╥Q - <url url="http://www.FreeBSD.org/search/search.html" - name="╕b╠`╗ё╟щ╣╙╤╟╓╓╥j╢M╦Й╝ф">║C - - </abstract> - - <toc> - -&preface; -&install; -&hardware; -&troubleshoot; -&commercial; -&applications; -&kernelconfig; -&admin; -&x; -&network; -&serial; -&misc; -&hackers; -&acknowledgments; - -</article> - |