Index: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml
===================================================================
--- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml (revision 42006)
+++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml (revision 42007)
@@ -1,263 +1,266 @@
%chapters;
]>
FreeBSD Documentation Project Primer for New
ContributorsThe FreeBSD Documentation Project199819992000200120022003200420052006200720082009
+ 2010
+ 2011
+ 2012
+ 2013DocEng$FreeBSD$$FreeBSD$
&legalnotice;
Thank you for becoming a part of the FreeBSD Documentation
Project. Your contribution is extremely valuable.
- This primer covers everything you will need to know in
- order to start contributing to the FreeBSD Documentation
- Project, from the tools and software you will be using (both
+ This primer covers details needed
+ to start contributing to the FreeBSD Documentation
+ Project, from the tools and software (both
mandatory and recommended) to the philosophy behind the
Documentation Project.
- This document is a work in progress, and is not complete.
- Sections that are known to be incomplete are indicated with a
- * in their name.
+ This document is a work in progress. Corrections and
+ additions are welcomed.PrefaceShell PromptsThe following table shows the default system prompt and
superuser prompt. The examples will use this prompt to
indicate which user you should be running the example
as.UserPromptNormal user&prompt.user;root&prompt.root;Typographic ConventionsThe following table describes the typographic conventions
used in this book.MeaningExamplesThe names of commands.Use ls -l to list all
files.The names of files.Edit .login.On screen computer output.You have mail.What you type, when contrasted with on-screen
computer output.&prompt.user; su
Password:Manual page references.Use &man.su.1; to change user names.User and group namesOnly root can do
this.EmphasisYou must do this.Command line variables; replace with the real
name or variable.To delete a file, type rm
filenameEnvironment variables$HOME is your home
directory.Notes, Tips, Important Information, Warnings, and
ExamplesWithin the text appear notes, warnings, and
examples.Notes are represented like this, and contain information
that you should take note of, as it may affect what you
do.Tips are represented like this, and contain information
that you might find useful, or lead to an easier way to do
something.Important information is represented like this.
Typically they flag extra steps you may need to carry
out.Warnings are represented like this, and contain
information warning you about possible damage if you do not
follow the instructions. This damage may be physical, to
your hardware or to you, or it may be non-physical, such as
the inadvertent deletion of important files.A Sample ExampleExamples are represented like this, and typically
contain examples you should walk through, or show you what
the results of a particular action should be.AcknowledgmentsMy thanks to Sue Blake, Patrick Durusau, Jon Hamilton,
Peter Flynn, and Christopher Maden, who took the time to read
early drafts of this document and offer many valuable comments
and criticisms.
&chap.overview;
&chap.tools;
&chap.xml-primer;
&chap.xml-markup;
&chap.stylesheets;
&chap.structure;
&chap.doc-build;
&chap.the-website;
&chap.translations;
&chap.writing-style;
&chap.psgml-mode;
&chap.see-also;
&app.examples;
Index: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
===================================================================
--- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml (revision 42006)
+++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml (revision 42007)
@@ -1,536 +1,560 @@
Writing Style
- In order to promote consistency between the myriad authors of
- the FreeBSD documentation, some guidelines have been drawn up for
- authors to follow.
+
+ Tips
-
-
- Use American English Spelling
+ Technical documentation can be improved by consistent use of
+ several principes. Most of these can be classified into three
+ goals: be clear,
+ be complete, and
+ be concise. These goals can conflict with
+ each other. Good writing consists of a balance between
+ them.
-
- There are several variants of English, with different
- spellings for the same word. Where spellings differ, use
- the American English variant. color, not
- colour, rationalize, not
- rationalise, and so on.
+
+ Be Clear
-
- The use of British English may be accepted in the case
- of a contributed article, however the spelling must be
- consistent within the whole document. The other documents
- such as books, web site, manual pages, etc. will have to
- use American English.
-
-
-
+ Clarity is extremely important. The reader may be a
+ novice, or reading the document in a second language. Strive
+ for simple, uncomplicated text that clearly explains the
+ concepts.
-
- Do not use contractions
+ Avoid flowery or embellished speech, jokes, or colloquial
+ expressions. Write as simply and clearly as possible. Simple
+ text is easier to understand and translate.
-
- Do not use contractions. Always spell the phrase out in
- full. Don't use contractions would be
- wrong.
+ Keep explanations as short, simple, and clear as possible.
+ Avoid empty phrases like in order to, which
+ usually just means to. Avoid potentially
+ patronizing words like basically. Avoid Latin
+ terms like i.e. or cf., which
+ may be unknown outside of academic or scientific
+ groups.
- Avoiding contractions makes for a more formal tone, is
- more precise, and is slightly easier for translators.
-
-
+ Write in a formal style. Avoid addressing the reader
+ as you. For example, say
+ copy the file to /tmp
+ rather than you can copy the file to
+ /tmp.
-
- Use the serial comma
+ Avoid weasel words like
+ should, might,
+ try, or could. These words
+ imply that the speaker is unsure of the facts, and
+ create doubt in the reader.
-
- In a list of items within a paragraph, separate each
- item from the others with a comma. Separate the last item
- from the others with a comma and the word
- and.
+ Similarly, give instructions as imperative commands: not
+ you should do this, but merely
+ do this.
+
- For example, look at the following:
+
+ Be Complete
-
- This is a list of one, two and three items.
-
+ Do not make assumptions about the reader's abilities or
+ skill level. Tell them what they need to know. Give links to
+ other documents to provide background information without
+ having to recreate it. Put yourself in the reader's place,
+ and answer the questions they will ask.
+
- Is this a list of three items, one,
- two, and three, or a list of
- two items, one and two and
- three?
+
+ Be Concise
- It is better to be explicit and include a serial
- comma:
+ While features should be documented completely, sometimes
+ there is so much information that the reader cannot easily
+ find the specific detail needed. The balance between being
+ complete and being concise is a challenge. One approach is to
+ have an introduction, then a quick start
+ section that describes the most common situation, followed by
+ an in-depth reference section.
+
+
-
- This is a list of one, two, and three items.
-
-
-
+
+ Guidelines
-
- Avoid redundant phrases
+ To promote consistency between the myriad authors of the
+ FreeBSD documentation, some guidelines have been drawn up for
+ authors to follow.
-
- Try not to use redundant phrases. In particular,
- the command, the file, and
- man command are probably redundant.
+
+
+ Use American English Spelling
- These two examples show this for commands. The second
- example is preferred.
+
+ There are several variants of English, with different
+ spellings for the same word. Where spellings differ, use
+ the American English variant. color, not
+ colour, rationalize, not
+ rationalise, and so on.
-
- Use the command svn to update
- your sources.
-
+
+ The use of British English may be accepted in the
+ case of a contributed article, however the spelling must
+ be consistent within the whole document. The other
+ documents such as books, web site, manual pages, etc.
+ will have to use American English.
+
+
+
-
- Use svn to update your
- sources.
-
+
+ Do not use contractions
- These two examples show this for filenames. The second
- example is preferred.
+
+ Do not use contractions. Always spell the phrase out
+ in full. Don't use contractions would be
+ wrong.
-
- … in the filename
- /etc/rc.local…
-
+ Avoiding contractions makes for a more formal tone, is
+ more precise, and is slightly easier for
+ translators.
+
+
-
- … in
- /etc/rc.local…
-
+
+ Use the serial comma
- These two examples show this for manual references. The
- second example is preferred (the second example uses
- citerefentry).
+
+ In a list of items within a paragraph, separate each
+ item from the others with a comma. Separate the last item
+ from the others with a comma and the word
+ and.
-
- See man csh for more
- information.
-
+ For example, look at the following:
-
- See &man.csh.1;.
-
-
-
-
- Two spaces at the end of sentences
+
+ This is a list of one, two and three items.
+
-
- Always use two spaces at the end of sentences, as this
- improves readability, and eases use of tools such as
- Emacs.
+ Is this a list of three items, one,
+ two, and three, or a list of
+ two items, one and two and
+ three?
- While it may be argued that a capital letter following
- a period denotes a new sentence, this is not the case,
- especially in name usage. Jordan K. Hubbard
- is a good example; it has a capital H
- following a period and a space, and there certainly is not a
- new sentence there.
-
-
-
+ It is better to be explicit and include a serial
+ comma:
- For more information about writing style, see Elements of
- Style, by William Strunk.
+
+ This is a list of one, two, and three items.
+
+
+
+
+ Avoid redundant phrases
+
+
+ Try not to use redundant phrases. In particular,
+ the command, the file, and
+ man command are probably redundant.
+
+ These two examples show this for commands. The second
+ example is preferred.
+
+
+ Use the command svn to update
+ your sources.
+
+
+
+ Use svn to update your
+ sources.
+
+
+ These two examples show this for filenames. The
+ second example is preferred.
+
+
+ … in the filename
+ /etc/rc.local…
+
+
+
+ … in
+ /etc/rc.local…
+
+
+ These two examples show this for manual references.
+ The second example is preferred (the second example uses
+ citerefentry).
+
+
+ See man csh for more
+ information.
+
+
+
+ See &man.csh.1;.
+
+
+
+
+
+ Two spaces at the end of sentences
+
+
+ Always use two spaces at the end of sentences, as this
+ improves readability, and eases use of tools such as
+ Emacs.
+
+ While it may be argued that a capital letter following
+ a period denotes a new sentence, this is not the case,
+ especially in name usage.
+ Jordan K. Hubbard is a good example; it has
+ a capital H following a period and a
+ space, and there certainly is not a new sentence
+ there.
+
+
+
+
+ For more information about writing style, see Elements of
+ Style, by William Strunk.
+
+
Style GuideTo keep the source for the documentation consistent when
many different people are editing it, please follow these style
conventions.Letter CaseTags are entered in lower case, para,
notPARA.Text that appears in SGML contexts is generally written in
upper case, <!ENTITY…>, and
<!DOCTYPE…>,
not<!entity…> and
<!doctype…>.AcronymsAcronyms should generally be spelled out the first time
they appear in a document, as in: Network Time Protocol
(NTP).
After the acronym has been defined, you should generally use
the acronym only (not the whole term, unless it makes more
sense contextually to use the whole term). Usually, acronyms
are defined only one per document. But if you prefer, you can
also define them the first time they appear in each
chapter.All acronyms should be enclosed in
acronym tags, with a
role attribute with the full term defined.
This allows a link to the glossary to be created, and for
mouseovers to be rendered with the fully expanded term.
-
- Be Formal
-
- Write in a formal style. Avoid addressing the reader
- as you. For example, say
- copy the file to /tmp
- rather than you can copy the file to
- /tmp.
-
-
-
- Be Confident
-
- Avoid weasel words like
- should, might,
- try, or could. These words
- imply that the speaker is unsure of the facts, and
- create doubt in the reader.
-
-
-
- Be Imperative
-
- Give instructions as an imperative command: not
- you should do this, but merely
- do this.
-
-
-
- Be Simple
-
- Avoid flowery or embellished speech, jokes, or colloquial
- expressions. Write as simply and clearly as possible. Simple
- text is easier to understand and makes the job of translation
- easier.
-
- Keep explanations as short, simple, and clear as possible.
- Avoid empty phrases like in order to, which
- usually just means to. Avoid potentially
- patronizing words like basically. Avoid Latin
- terms like i.e. or cf., which
- may be unknown outside of academic or scientific
- groups.
-
-
-
- Use the Three C Approach
-
- Writing must be clear,
- complete, and
- concise. These goals can conflict with
- each other. Good writing consists of a balance between
- them.
-
-
IndentationEach file starts with indentation set at column 0,
regardless of the indentation level of
the file which might contain this one.Opening tags increase the indentation level by 2 spaces.
Closing tags decrease the indentation level by 2 spaces.
Blocks of 8 spaces at the start of a line should be replaced
with a tab. Do not use spaces in front of tabs, and do not
add extraneous whitespace at the end of a line. Content
within elements should be indented by two spaces if the
content runs over more than one line.For example, the source for this section looks something
like:......IndentationEach file starts with indentation set at column 0,
regardless of the indentation level of the file
which might contain this one.
...
]]>
If you use Emacs or
XEmacs to edit the files then
sgml-mode should be loaded automatically,
and the Emacs local variables at
the bottom of each file should enforce these styles.Vim users might want to
configure their editor with:augroup sgmledit
autocmd FileType sgml set formatoptions=cq2l " Special formatting options
autocmd FileType sgml set textwidth=70 " Wrap lines at 70 columns
autocmd FileType sgml set shiftwidth=2 " Automatically indent
autocmd FileType sgml set softtabstop=2 " Tab key indents 2 spaces
autocmd FileType sgml set tabstop=8 " Replace 8 spaces with a tab
autocmd FileType sgml set autoindent " Automatic indentation
augroup ENDTag StyleTag SpacingTags that start at the same indent as a previous tag
should be separated by a blank line, and those that are not
at the same indent as a previous tag should not:NISOctober 1999...
...
...............
]]>Separating TagsTags like itemizedlist which will
always have further tags inside them, and in fact do not
take character data themselves, are always on a line by
themselves.Tags like para and
term do not need other tags to contain
normal character data, and their contents begin immediately
after the tag, on the same line.The same applies to when these two types of tags
close.This leads to an obvious problem when mixing these
tags.When a starting tag which cannot contain character data
directly follows a tag of the type that requires other tags
within it to use character data, they are on separate lines.
The second tag should be properly indented.When a tag which can contain character data closes
directly after a tag which cannot contain character data
closes, they co-exist on the same line.White Space ChangesWhen committing changes, do not commit changes
to the content at the same time as changes to the
formatting.This is so that the teams that convert the documentation
to other languages can quickly see what content has actually
changed in your commit, without having to decide whether a
line has changed because of the content, or just because it
has been refilled.For example, if you have added two sentences to a
paragraph, such that the line lengths on the paragraph now go
over 80 columns, first commit your change with the too-long
line lengths. Then fix the line wrapping, and commit this
second change. In the commit message for the second change,
be sure to indicate that this is a whitespace-only change, and
that the translation team can ignore it.Non-Breaking SpaceAvoid line breaks in places where they look ugly or make
it difficult to follow a sentence. Line breaks depend on the
width of the chosen output medium. In particular, viewing the
HTML documentation with a text browser can lead to badly
formatted paragraphs like the next one:Data capacity ranges from 40 MB to 15
GB. Hardware compression …The general entity prohibits
line breaks between parts belonging together. Use
non-breaking spaces in the following places:between numbers and units:between program names and version numbers:between multiword names (use with caution when
applying this to more than 3-4 word names like
The FreeBSD Brazilian Portuguese Documentation
Project):Word ListThis list of words shows the correct spelling and
capitalization when used in FreeBSD Documentation. If a word is
- not on this list, ask about that word on the &a.doc;.
+ not on this list, ask about it on the &a.doc;.
WordXML CodeCD-ROM
- CD-ROM]]>
+ <acronym>CD-ROM</acronym>DoS (Denial of Service)
- DoS]]>
+ <acronym>DoS</acronym>emailfile systemIPsecInternetmanual pagemail servername serverPorts Collection
+ Ports Collectionread-onlySoft Updates&unix;
-
+ &unix;web server
Index: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/disks/chapter.xml
===================================================================
--- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/disks/chapter.xml (revision 42006)
+++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/disks/chapter.xml (revision 42007)
@@ -1,4443 +1,4443 @@
StorageSynopsisThis chapter covers the use of disks in &os;. This
includes memory-backed disks, network-attached disks,
standard SCSI/IDE storage devices, and devices using the USB
interface.After reading this chapter, you will know:The terminology &os; uses to describe the organization
of data on a physical disk.How to add additional hard disks to a &os;
system.How to configure &os; to use USB storage devices.How to set up virtual file systems, such as memory
disks.How to use quotas to limit disk space usage.How to encrypt disks to secure them against
attackers.How to create and burn CDs and DVDs on &os;.The various storage media options for backups.How to use the backup programs available under
&os;.How to backup to floppy disks.What file system snapshots are and how to use them
efficiently.Before reading this chapter, you should:Know how to configure and
install a new &os; kernel.Device NamesThe following is a list of physical storage devices
supported in &os;, and their associated device names.
Physical Disk Naming ConventionsDrive typeDrive device nameIDE hard drivesadIDE CDROM drivesacdSCSI hard drives and USB Mass storage
devicesdaSCSI CDROM drivescdAssorted non-standard CDROM drivesmcd for Mitsumi CD-ROM and
scd for Sony CD-ROM devicesFloppy drivesfdSCSI tape drivessaIDE tape drivesastFlash drivesfla for &diskonchip; Flash
deviceRAID drivesaacd for &adaptec; AdvancedRAID,
mlxd and mlyd
for &mylex;,
amrd for AMI &megaraid;,
idad for Compaq Smart RAID,
twed for &tm.3ware; RAID.
DavidO'BrienOriginally contributed by Adding DisksdisksaddingThis section describes how to add a new
SATA disk to a machine that currently only
has a single drive. First, turn off the computer and install
the drive in the computer following the instructions of the
computer, controller, and drive manufacturers. Reboot
the system and become root.Inspect /var/run/dmesg.boot to ensure
the new disk was found. In this example, the newly added
SATA drive will appear as
ada1.partitionsgpartFor this example, a single large partition will be created
on the new disk. The
GPT partitioning scheme will be
used in preference to the older and less versatile
MBR scheme.If the disk to be added is not blank, old partition
information can be removed with
gpart delete. See &man.gpart.8; for
details.The partition scheme is created, and then a single partition
is added:&prompt.root; gpart create -s GPT ada1
&prompt.root; gpart add -t freebsd-ufs ada1Depending on use, several smaller partitions may be desired.
See &man.gpart.8; for options to create partitions smaller than
a whole disk.A file system is created on the new blank disk:
- &prompt.root; newfs -U /dev/ada1
+ &prompt.root; newfs -U /dev/ada1p1An empty directory is created as a
mountpoint, a location for mounting the new
disk in the original disk's file system:&prompt.root; mkdir /newdiskFinally, an entry is added to
/etc/fstab so the new disk will be mounted
automatically at startup:
- /dev/ada1 /newdisk ufs rw 2 2
+ /dev/ada1p1 /newdisk ufs rw 2 2The new disk can be mounted manually, without restarting the
system:&prompt.root; mount /newdiskRAIDSoftware RAIDChristopherShumwayOriginal work by JimBrownRevised by Concatenated Disk Driver (CCD) ConfigurationRAIDsoftwareRAIDCCDWhen choosing a mass storage solution, the most
important factors to consider are speed, reliability, and
cost. It is rare to have all three in balance. Normally a
fast, reliable mass storage device is expensive, and to cut
back on cost either speed or reliability must be
sacrificed.In designing the system described below, cost was
chosen as the most important factor, followed by speed,
then reliability. Data transfer speed for this system is
ultimately constrained by the network. While reliability is
very important, the CCD drive described below serves online
data that is already fully backed up and which can easily be
replaced.Defining the requirements is the first step in choosing
a mass storage solution. If the requirements prefer speed
or reliability over cost, the solution will differ from the
system described in this section.Installing the HardwareIn addition to the IDE system disk, three Western
Digital 30GB, 5400 RPM IDE disks form the core of the CCD
disk described below, providing approximately 90GB of
online storage. Ideally, each IDE disk would have its own
IDE controller and cable, but to minimize cost, additional
IDE controllers were not used. Instead, the disks were
configured with jumpers so that each IDE controller has
one master, and one slave.Upon reboot, the system BIOS was configured to
automatically detect the disks attached. More
importantly, &os; detected them on reboot:ad0: 19574MB <WDC WD205BA> [39770/16/63] at ata0-master UDMA33
ad1: 29333MB <WDC WD307AA> [59598/16/63] at ata0-slave UDMA33
ad2: 29333MB <WDC WD307AA> [59598/16/63] at ata1-master UDMA33
ad3: 29333MB <WDC WD307AA> [59598/16/63] at ata1-slave UDMA33If &os; does not detect all the disks, consult
the drive documentation for proper setup and verify
that the controller is supported by &os;.Setting Up the CCDThe &man.ccd.4; driver takes several identical disks
and concatenates them into one logical file system. In
order to use &man.ccd.4;, its kernel module must be
loaded using &man.ccd.4;. When using a custom kernel,
ensure that this line is compiled in:device ccdBefore configuring &man.ccd.4;, use &man.bsdlabel.8;
to label the disks:bsdlabel -w ad1 auto
bsdlabel -w ad2 auto
bsdlabel -w ad3 autoThis example creates a bsdlabel for
ad1c,
ad2c and
ad3c that spans the entire
disk.The next step is to change the disk label type. Use
&man.bsdlabel.8; to edit the disks:bsdlabel -e ad1
bsdlabel -e ad2
bsdlabel -e ad3This opens up the current disk label on each disk with
the editor specified by the EDITOR
environment variable, typically &man.vi.1;.An unmodified disk label will look something like
this:8 partitions:
# size offset fstype [fsize bsize bps/cpg]
c: 60074784 0 unused 0 0 0 # (Cyl. 0 - 59597)Add a new e partition for
&man.ccd.4; to use. This can usually be copied from the
c partition, but the
must be
4.2BSD. The disk label should now
look something like this:8 partitions:
# size offset fstype [fsize bsize bps/cpg]
c: 60074784 0 unused 0 0 0 # (Cyl. 0 - 59597)
e: 60074784 0 4.2BSD 0 0 0 # (Cyl. 0 - 59597)Building the File SystemNow that all the disks are labeled, build the
&man.ccd.4; using &man.ccdconfig.8;, with options similar
to the following:ccdconfig ccd0 32 0 /dev/ad1e /dev/ad2e /dev/ad3eThe use and meaning of each option is described
below:The first argument is the device to configure, in
this case, /dev/ccd0c. The
/dev/ portion is optional.The interleave for the file system, which defines
the size of a stripe in disk blocks, each normally 512
bytes. So, an interleave of 32 would be 16,384
bytes.Flags for &man.ccdconfig.8;. For example, to
enable drive mirroring, specify a flag. This
configuration does not provide mirroring for
&man.ccd.4;, so it is set at 0 (zero).The final arguments to &man.ccdconfig.8; are the
devices to place into the array. Use the complete
path name for each device.After running &man.ccdconfig.8; the &man.ccd.4; is
configured and a file system can be installed. Refer to
&man.newfs.8; for options, or run: newfs /dev/ccd0cMaking it All AutomaticGenerally, &man.ccd.4; should be configured to
automount upon each reboot. To do this, write out the
current configuration to
/etc/ccd.conf using the following
command:ccdconfig -g > /etc/ccd.confDuring reboot, the script /etc/rc
runs ccdconfig -C if
/etc/ccd.conf exists. This
automatically configures the &man.ccd.4; so it can be
mounted.When booting into single user mode, the following
command must be issued to configure the array before
the &man.ccd.4; can be mounted:ccdconfig -CTo automatically mount the &man.ccd.4;, place an entry
for the &man.ccd.4; in /etc/fstab so
it will be mounted at boot time:/dev/ccd0c /media ufs rw 2 2The Vinum Volume ManagerRAIDsoftwareRAIDVinumThe Vinum Volume Manager is a block device driver which
implements virtual disk drives. It isolates disk hardware
from the block device interface and maps data in ways which
result in an increase in flexibility, performance and
reliability compared to the traditional slice view of disk
storage. &man.vinum.4; implements the RAID-0, RAID-1 and
RAID-5 models, both individually and in combination.Refer to for more
information about &man.vinum.4;.Hardware RAIDRAIDhardware&os; also supports a variety of hardware
RAID controllers. These devices control a
RAID subsystem without the need for &os;
specific software to manage the array.Using an on-card BIOS, the card
controls most of the disk operations. The following is a
brief setup description using a Promise
IDE RAID controller.
When this card is installed and the system is started up, it
displays a prompt requesting information. Follow the
instructions to enter the card's setup screen and to combine
all the attached drives. After doing so, the disks will
look like a single drive to &os;. Other
RAID levels can be set up
accordingly.Rebuilding ATA RAID1 Arrays&os; supports the ability to hot-replace a failed disk in
an array.An error indicating a failed disk will appear in
/var/log/messages or in the &man.dmesg.8;
output:ad6 on monster1 suffered a hard error.
ad6: READ command timeout tag=0 serv=0 - resetting
ad6: trying fallback to PIO mode
ata3: resetting devices .. done
ad6: hard error reading fsbn 1116119 of 0-7 (ad6 bn 1116119; cn 1107 tn 4 sn 11)\\
status=59 error=40
ar0: WARNING - mirror lostUse &man.atacontrol.8; to check for further
information:&prompt.root; atacontrol list
ATA channel 0:
Master: no device present
Slave: acd0 <HL-DT-ST CD-ROM GCR-8520B/1.00> ATA/ATAPI rev 0
ATA channel 1:
Master: no device present
Slave: no device present
ATA channel 2:
Master: ad4 <MAXTOR 6L080J4/A93.0500> ATA/ATAPI rev 5
Slave: no device present
ATA channel 3:
Master: ad6 <MAXTOR 6L080J4/A93.0500> ATA/ATAPI rev 5
Slave: no device present
&prompt.root; atacontrol status ar0
ar0: ATA RAID1 subdisks: ad4 ad6 status: DEGRADEDFirst, detach the ata channel with the failed disk
so that it can be safely removed:&prompt.root; atacontrol detach ata3Replace the disk.Reattach the ata channel:&prompt.root; atacontrol attach ata3
Master: ad6 <MAXTOR 6L080J4/A93.0500> ATA/ATAPI rev 5
Slave: no device presentAdd the new disk to the array as a spare:&prompt.root; atacontrol addspare ar0 ad6Rebuild the array:&prompt.root; atacontrol rebuild ar0It is possible to check on the progress by issuing the
following command:&prompt.root; dmesg | tail -10
[output removed]
ad6: removed from configuration
ad6: deleted from ar0 disk1
ad6: inserted into ar0 disk1 as spare
&prompt.root; atacontrol status ar0
ar0: ATA RAID1 subdisks: ad4 ad6 status: REBUILDING 0% completedWait until this operation completes.MarcFonvieilleContributed by USB Storage DevicesUSBdisksMany external storage solutions, such as hard drives, USB
thumbdrives, and CD/DVD burners, use the Universal Serial Bus
(USB). &os; provides support for these devices.ConfigurationThe USB mass storage devices driver, &man.umass.4;,
is built into the GENERIC kernel
and provides support for USB storage devices. For a custom
kernel, be sure that the following lines are present in the
kernel configuration file:device scbus
device da
device pass
device uhci
device ohci
device ehci
device usb
device umassSince the &man.umass.4; driver uses the SCSI subsystem to
access the USB storage devices, any USB device will be seen as
a SCSI device by the system. Depending on the USB chipset on
the motherboard, device uhci or
device ohci is used to provide USB 1.X
support. Support for USB 2.0 controllers is provided by
device ehci.If the USB device is a CD or DVD burner, &man.cd.4;,
must be added to the kernel via the line:device cdSince the burner is seen as a SCSI drive, the driver
&man.atapicam.4; should not be used in the kernel
configuration.Testing the ConfigurationTo test the USB configuration, plug in the USB device. In
the system message buffer, &man.dmesg.8;, the drive should
appear as something like:umass0: USB Solid state disk, rev 1.10/1.00, addr 2
GEOM: create disk da0 dp=0xc2d74850
da0 at umass-sim0 bus 0 target 0 lun 0
da0: <Generic Traveling Disk 1.11> Removable Direct Access SCSI-2 device
da0: 1.000MB/s transfers
da0: 126MB (258048 512 byte sectors: 64H 32S/T 126C)The brand, device node (da0), and
other details will differ according to the device.Since the USB device is seen as a SCSI one,
camcontrol can be used to list the USB
storage devices attached to the system:&prompt.root; camcontrol devlist
<Generic Traveling Disk 1.11> at scbus0 target 0 lun 0 (da0,pass0)If the drive comes with a file system, it can be mounted.
Refer to for
instructions on how to format and create partitions on the USB
drive.Allowing untrusted users to mount arbitrary media, by
enabling vfs.usermount as
described below, should not be considered safe from a
security point of view. Most file systems in &os; were not
built to safeguard against malicious devices.To make the device mountable as a normal user, one
solution is to make all users of the device a member of the
operator group using &man.pw.8;.
Next, ensure that the operator group is
able to read and write the device by adding these lines to
/etc/devfs.rules:[localrules=5]
add path 'da*' mode 0660 group operatorIf SCSI disks are installed in the system, change
the second line as follows:add path 'da[3-9]*' mode 0660 group operatorThis will exclude the first three SCSI disks
(da0 to
da2)from belonging to the
operator group.Next, enable the &man.devfs.rules.5; ruleset in
/etc/rc.conf:devfs_system_ruleset="localrules"Next, instruct the running kernel to allow regular users
to mount file systems. The easiest way is to add the
following line to
/etc/sysctl.conf:vfs.usermount=1Since this only takes effect after the next reboot use
&man.sysctl.8; to set this variable now.The final step is to create a directory where the file
system is to be mounted. This directory needs to be owned by
the user that is to mount the file system. One way to do that
is for root to create a subdirectory
owned by that user as /mnt/username.
In the following example, replace
username with the login name of the
user and usergroup with the user's
primary group:&prompt.root; mkdir /mnt/username
&prompt.root; chown username:usergroup /mnt/usernameSuppose a USB thumbdrive is plugged in, and a device
/dev/da0s1 appears. If the device is
preformatted with a FAT file system, it can be mounted
using:&prompt.user; mount -t msdosfs -o -m=644,-M=755 /dev/da0s1 /mnt/usernameBefore the device can be unplugged, it
must be unmounted first. After device
removal, the system message buffer will show messages similar
to the following:umass0: at uhub0 port 1 (addr 2) disconnected
(da0:umass-sim0:0:0:0): lost device
(da0:umass-sim0:0:0:0): removing device entry
GEOM: destroy disk da0 dp=0xc2d74850
umass0: detachedFurther ReadingBeside the Adding
Disks and Mounting and
Unmounting File Systems sections, reading various
manual pages may be also useful: &man.umass.4;,
&man.camcontrol.8;, and &man.usbconfig.8; under &os; 8.X
or &man.usbdevs.8; under earlier versions of &os;.MikeMeyerContributed by Creating and Using CD MediaCDROMscreatingIntroductionCD media provide a number of features that differentiate
them from conventional disks. Initially, they were not
writable by the user. They are designed so that they can be
read continuously without delays to move the head between
tracks. They are also much easier to transport between
systems.CD media do have tracks, but this refers to a section of
data to be read continuously and not a physical property of
the disk. For example, to produce a CD on &os;, prepare the
data files that are going to make up the tracks on the CD,
then write the tracks to the CD.ISO 9660file systemsISO 9660The ISO 9660 file system was designed to deal with these
differences. To overcome the original file system limits, it
provides an extension mechanism that allows properly written
CDs to exceed those limits while still working with systems
that do not support those extensions.sysutils/cdrtoolsThe sysutils/cdrtools
port includes &man.mkisofs.8;, a program that can be used to
produce a data file containing an ISO 9660 file system. It
has options that support various extensions, and is described
below.CD burnerATAPIWhich tool to use to burn the CD depends on whether the
CD burner is ATAPI or something else. ATAPI CD burners use
burncd
which is part of the base system. SCSI and USB CD burners
should use cdrecord from the
sysutils/cdrtools port.
It is also possible to use cdrecord and other tools
for SCSI drives on ATAPI hardware with the ATAPI/CAM module.For CD burning software with a graphical user
interface, consider X-CD-Roast or
K3b. These tools are available as
packages or from the
sysutils/xcdroast and
sysutils/k3b ports.
X-CD-Roast and
K3b require the
ATAPI/CAM module with ATAPI
hardware.mkisofsThe sysutils/cdrtools
port also installs &man.mkisofs.8;, which produces an ISO 9660
file system that is an image of a directory tree in the &unix;
file system name space. The simplest usage is:&prompt.root; mkisofs -o imagefile.iso/path/to/treefile systemsISO 9660This command creates an
imagefile.iso containing an ISO
9660 file system that is a copy of the tree at
/path/to/tree. In the process, it
maps the file names to names that fit the limitations of
the standard ISO 9660 file system, and will exclude files that
have names uncharacteristic of ISO file systems.file systemsHFSfile systemsJolietA number of options are available to overcome these
restrictions. In particular, enables the
Rock Ridge extensions common to &unix; systems,
enables Joliet extensions used by
Microsoft systems, and can be used to
create HFS file systems used by &macos;.For CDs that are going to be used only on &os; systems,
can be used to disable all filename
restrictions. When used with , it produces
a file system image that is identical to the specified &os;
tree, though it may violate the ISO 9660 standard in a number
of ways.CDROMscreating bootableThe last option of general use is .
This is used to specify the location of the boot image for use
in producing an El Torito bootable CD. This
option takes an argument which is the path to a boot image
from the top of the tree being written to the CD. By default,
&man.mkisofs.8; creates an ISO image in floppy disk
emulation mode, and thus expects the boot image to
be exactly 1200, 1440 or 2880 KB in size. Some boot
loaders, like the one used by the &os; distribution disks, do
not use emulation mode. In this case,
should be used. So, if
/tmp/myboot holds a
bootable &os; system with the boot image in /tmp/myboot/boot/cdboot, this
command would produce the image of an ISO 9660 file system as
/tmp/bootable.iso:&prompt.root; mkisofs -R -no-emul-boot -b boot/cdboot -o /tmp/bootable.iso /tmp/mybootIf md is configured in the
kernel, the file system can be mounted as a memory disk
with:&prompt.root; mdconfig -a -t vnode -f /tmp/bootable.iso -u 0
&prompt.root; mount -t cd9660 /dev/md0 /mntOne can then verify that /mnt and /tmp/myboot are
identical.There are many other options available for
&man.mkisofs.8; to fine-tune its behavior. Refer to
&man.mkisofs.8; for details.burncdCDROMsburningFor an ATAPI CD burner, burncd can be
used to burn an ISO image onto a CD.
burncd is part of the base system,
installed as /usr/sbin/burncd. Usage is
very simple, as it has few options:&prompt.root; burncd -f cddevice data imagefile.iso fixateThis command will burn a copy of
imagefile.iso on
cddevice. The default device is
/dev/acd0. See &man.burncd.8; for
options to set the write speed, eject the CD after burning,
and write audio data.cdrecordFor systems without an ATAPI CD burner,
cdrecord can be used to burn CDs.
cdrecord is not part of the base system and
must be installed from either the sysutils/cdrtools package or port.
Changes to the base system can cause binary versions of this
program to fail, possibly resulting in a
coaster. It is recommended to either upgrade
the port when the system is upgraded, or for users
tracking -STABLE, to upgrade the
port when a new version becomes available.While cdrecord has many options, basic
usage is simple. Burning an ISO 9660 image is done
with:&prompt.root; cdrecord dev=deviceimagefile.isoThe tricky part of using cdrecord is
finding the to use. To find the proper
setting, use which might produce
results like this:CDROMsburning&prompt.root; cdrecord -scanbus
Cdrecord-Clone 2.01 (i386-unknown-freebsd7.0) Copyright (C) 1995-2004 Jörg Schilling
Using libscg version 'schily-0.1'
scsibus0:
0,0,0 0) 'SEAGATE ' 'ST39236LW ' '0004' Disk
0,1,0 1) 'SEAGATE ' 'ST39173W ' '5958' Disk
0,2,0 2) *
0,3,0 3) 'iomega ' 'jaz 1GB ' 'J.86' Removable Disk
0,4,0 4) 'NEC ' 'CD-ROM DRIVE:466' '1.26' Removable CD-ROM
0,5,0 5) *
0,6,0 6) *
0,7,0 7) *
scsibus1:
1,0,0 100) *
1,1,0 101) *
1,2,0 102) *
1,3,0 103) *
1,4,0 104) *
1,5,0 105) 'YAMAHA ' 'CRW4260 ' '1.0q' Removable CD-ROM
1,6,0 106) 'ARTEC ' 'AM12S ' '1.06' Scanner
1,7,0 107) *This lists the appropriate value for
the devices on the list. Locate the CD burner, and use the
three numbers separated by commas as the value for
. In this case, the CRW device is 1,5,0,
so the appropriate input is .
Refer to &man.cdrecord.1; for easier ways to specify this
value and for information on writing audio tracks and
controlling the write speed.Duplicating Audio CDsTo duplicate an audio CD, extract the audio data from the
CD to a series of files, then write these files to a blank CD.
The process is slightly different for ATAPI and SCSI
drives.SCSI DrivesUse cdda2wav to extract the
audio:&prompt.user; cdda2wav -vall -D2,0 -B -OwavUse cdrecord to write the
.wav files:&prompt.user; cdrecord -v dev=2,0 -dao -useinfo *.wavMake sure that 2,0 is set
appropriately, as described in .ATAPI DrivesWith the help of the
ATAPI/CAM module,
cdda2wav can also be used on ATAPI
drives. This tool is usually a better choice for most of
users, as it supports jitter correction and endianness,
than the method proposed below.The ATAPI CD driver makes each track available as
/dev/acddtnn,
where d is the drive number,
and nn is the track number
written with two decimal digits, prefixed with zero as
needed. So the first track on the first disk is
/dev/acd0t01, the second is
/dev/acd0t02, the third is
/dev/acd0t03, and so on.Make sure the appropriate files exist in
/dev. If the entries are missing,
force the system to retaste the media:&prompt.root; dd if=/dev/acd0 of=/dev/null count=1Extract each track using &man.dd.1;, making sure to
specify a block size when extracting the files:&prompt.root; dd if=/dev/acd0t01 of=track1.cdr bs=2352
&prompt.root; dd if=/dev/acd0t02 of=track2.cdr bs=2352
...Burn the extracted files to disk using
burncd. Specify that these are audio
files, and that burncd should fixate
the disk when finished:&prompt.root; burncd -f /dev/acd0 audio track1.cdr track2.cdr ... fixateDuplicating Data CDsIt is possible to copy a data CD to an image file that is
functionally equivalent to the image file created with
&man.mkisofs.8;, and then use it to duplicate any data CD.
The example given here assumes that the CDROM device is
acd0. Substitute the correct CDROM
device.&prompt.root; dd if=/dev/acd0 of=file.iso bs=2048Now that there is an image, it can be burned to CD as
described above.Using Data CDsIt is possible to mount and read the data on a standard
data CD. By default, &man.mount.8; assumes that a file system
is of type ufs. Running this
command:&prompt.root; mount /dev/cd0 /mntwill generate an error about Incorrect super
block, and will fail to mount the CD. The CD
does not use the UFS file system, so
attempts to mount it as such will fail. Instead, tell
&man.mount.8; that the file system is of type
ISO9660 by specifying
to &man.mount.8;. For example,
to mount the CDROM device, /dev/cd0,
under /mnt,
use:&prompt.root; mount -t cd9660 /dev/cd0 /mntReplace /dev/cd0 with the device
name for the CD device. Also,
executes &man.mount.cd9660.8;, meaning the above command is
equivalent to:&prompt.root; mount_cd9660 /dev/cd0 /mntWhile data CDROMs from any vendor can be mounted this way,
disks with certain ISO 9660 extensions might behave oddly.
For example, Joliet disks store all filenames in two-byte
Unicode characters. The &os; kernel does not speak Unicode,
but the &os; CD9660 driver is able to convert Unicode
characters on the fly. If some non-English characters show up
as question marks, specify the local charset with
. For more information, refer to
&man.mount.cd9660.8;.In order to do this character conversion with the help
of , the kernel requires the
cd9660_iconv.ko module to be loaded.
This can be done either by adding this line to
loader.conf:cd9660_iconv_load="YES"and then rebooting the machine, or by directly loading
the module with &man.kldload.8;.Occasionally, Device not configured
will be displayed when trying to mount a CDROM. This
usually means that the CDROM drive thinks that there is no
disk in the tray, or that the drive is not visible on the bus.
It can take a couple of seconds for a CDROM drive to realize
that a media is present, so be patient.Sometimes, a SCSI CDROM may be missed because it did not
have enough time to answer the bus reset. To resolve this,add
the following option to the kernel configuration and rebuild the
kernel.options SCSI_DELAY=15000This tells the SCSI bus to pause 15 seconds during boot,
to give the CDROM drive every possible chance to answer the
bus reset.Burning Raw Data CDsIt is possible to burn a file directly to CD, without
creating an ISO 9660 file system. Some people do this for
backup purposes. This command runs more quickly than burning
a standard CD:&prompt.root; burncd -f /dev/acd1 -s 12 data archive.tar.gz fixateIn order to retrieve the data burned to such a CD, the
data must be read from the raw device node:&prompt.root; tar xzvf /dev/acd1This type of disk can not be mounted as a normal CDROM and
the data cannot be read under any operating system except
&os;. In order to mount the CD, or to share the data with
another operating system, &man.mkisofs.8; must be used as
described above.MarcFonvieilleContributed by Using the ATAPI/CAM DriverCD burnerATAPI/CAM driverThis driver allows ATAPI devices, such as CD/DVD drives,
to be accessed through the SCSI subsystem, and so allows the
use of applications like sysutils/cdrdao or
&man.cdrecord.1;.To use this driver, add the following line to
/boot/loader.conf:atapicam_load="YES"then, reboot the system.Users who prefer to statically compile &man.atapicam.4;
support into the kernel, should add this line to the
kernel configuration file:device atapicamEnsure the following lines are still in the kernel
configuration file:device ata
device scbus
device cd
device passThen rebuild, install the new kernel, and reboot the
machine.During the boot process, the burner should show up, like
so:acd0: CD-RW <MATSHITA CD-RW/DVD-ROM UJDA740> at ata1-master PIO4
cd0 at ata1 bus 0 target 0 lun 0
cd0: <MATSHITA CDRW/DVD UJDA740 1.00> Removable CD-ROM SCSI-0 device
cd0: 16.000MB/s transfers
cd0: Attempt to query device size failed: NOT READY, Medium not present - tray closedThe drive can now be accessed via the
/dev/cd0 device name. For example, to
mount a CD-ROM on /mnt,
type the following:&prompt.root; mount -t cd9660 /dev/cd0 /mntAs root, run the following command
to get the SCSI address of the burner:&prompt.root; camcontrol devlist
<MATSHITA CDRW/DVD UJDA740 1.00> at scbus1 target 0 lun 0 (pass0,cd0)In this example, 1,0,0 is the SCSI
address to use with &man.cdrecord.1; and other SCSI
applications.For more information about ATAPI/CAM and SCSI system,
refer to &man.atapicam.4; and &man.cam.4;.MarcFonvieilleContributed by AndyPolyakovWith inputs from Creating and Using DVD MediaDVDburningIntroductionCompared to the CD, the DVD is the next generation of
optical media storage technology. The DVD can hold more data
than any CD and is the standard for video publishing.Five physical recordable formats can be defined for a
recordable DVD:DVD-R: This was the first DVD recordable format
available. The DVD-R standard is defined by the
DVD
Forum. This format is write once.DVD-RW: This is the rewritable version of the
DVD-R standard. A DVD-RW can be rewritten about 1000
times.DVD-RAM: This is a rewritable format which can be seen
as a removable hard drive. However, this media is not
compatible with most DVD-ROM drives and DVD-Video players
as only a few DVD writers support the DVD-RAM format.
Refer to for more
information on DVD-RAM use.DVD+RW: This is a rewritable format defined by
the DVD+RW
Alliance. A DVD+RW can be rewritten about 1000
times.DVD+R: This format is the write once variation
of the DVD+RW format.A single layer recordable DVD can hold up to
4,700,000,000 bytes which is actually 4.38 GB or
4485 MB as 1 kilobyte is 1024 bytes.A distinction must be made between the physical media
and the application. For example, a DVD-Video is a specific
file layout that can be written on any recordable DVD
physical media such as DVD-R, DVD+R, or DVD-RW. Before
choosing the type of media, ensure that both the burner and
the DVD-Video player are compatible with the media under
consideration.ConfigurationTo perform DVD recording, use &man.growisofs.1;. This
command is part of the sysutils/dvd+rw-tools utilities
which support all DVD media types.These tools use the SCSI subsystem to access the devices,
therefore ATAPI/CAM support
must be loaded or statically compiled into the kernel. This
support is not needed if the burner uses the USB interface.
Refer to for more details
on USB device configuration.DMA access must also be enabled for ATAPI devices, by
adding the following line to
/boot/loader.conf:hw.ata.atapi_dma="1"Before attempting to use
dvd+rw-tools, consult the
Hardware
Compatibility Notes.For a graphical user interface, consider using sysutils/k3b which provides a
user friendly interface to &man.growisofs.1; and many other
burning tools.Burning Data DVDsSince &man.growisofs.1; is a front-end to mkisofs, it will invoke
&man.mkisofs.8; to create the file system layout and perform
the write on the DVD. This means that an image of the data
does not need to be created before the burning process.To burn to a DVD+R or a DVD-R the data in
/path/to/data,
use the following command:&prompt.root; growisofs -dvd-compat -Z /dev/cd0 -J -R /path/to/dataIn this example, is passed to
&man.mkisofs.8; to create an ISO 9660 file system with Joliet
and Rock Ridge extensions. Refer to &man.mkisofs.8; for more
details.For the initial session recording, is
used for both single and multiple sessions. Replace
/dev/cd0, with the name of the DVD
device. Using indicates that the
disk will be closed and that the recording will be
unappendable. This should also provide better media
compatibility with DVD-ROM drives.To burn a pre-mastered image, such as
imagefile.iso, use:&prompt.root; growisofs -dvd-compat -Z /dev/cd0=imagefile.isoThe write speed should be detected and automatically set
according to the media and the drive being used. To force the
write speed, use . Refer to
&man.growisofs.1; for example usage.In order to support working files larger than 4.38GB, an
UDF/ISO-9660 hybrid filesystem must be created by passing
to &man.mkisofs.8; and
all related programs, such as &man.growisofs.1;. This is
required only when creating an ISO image file or when
writing files directly to a disk. Since a disk created this
way must be mounted as an UDF filesystem with
&man.mount.udf.8;, it will be usable only on an UDF aware
operating system. Otherwise it will look as if it contains
corrupted files.To create this type of ISO file:&prompt.user; mkisofs -R -J -udf -iso-level 3 -o imagefile.iso/path/to/dataTo burn files directly to a disk:&prompt.root; growisofs -dvd-compat -udf -iso-level 3 -Z /dev/cd0 -J -R /path/to/dataWhen an ISO image already contains large files, no
additional options are required for &man.growisofs.1; to
burn that image on a disk.Be sure to use an up-to-date version of sysutils/cdrtools, which
contains &man.mkisofs.8;, as an older version may not
contain large files support. If the latest version does
not work, install sysutils/cdrtools-devel and read
its &man.mkisofs.8;.Burning a DVD-VideoDVDDVD-VideoA DVD-Video is a specific file layout based on the ISO
9660 and micro-UDF (M-UDF) specifications. Since DVD-Video
presents a specific data structure hierarchy, a particular
program such as multimedia/dvdauthor is needed to
author the DVD.If an image of the DVD-Video file system already exists,
it can be burned in the same way as any other image. If
dvdauthor was used to make the DVD and the
result is in /path/to/video, the following
command should be used to burn the DVD-Video:&prompt.root; growisofs -Z /dev/cd0 -dvd-video /path/to/video is passed to &man.mkisofs.8;
to instruct it to create a DVD-Video file system layout.
This option implies the
&man.growisofs.1; option.Using a DVD+RWDVDDVD+RWUnlike CD-RW, a virgin DVD+RW needs to be formatted before
first use. It is recommended to let
&man.growisofs.1; take care of this automatically whenever
appropriate. However, it is possible to use
dvd+rw-format to format the DVD+RW:&prompt.root; dvd+rw-format /dev/cd0Only perform this operation once and keep in mind that
only virgin DVD+RW medias need to be formatted. Once
formatted, the DVD+RW can be burned as usual.To burn a totally new file system and not just append some
data onto a DVD+RW, the media does not need to be blanked
first. Instead, write over the previous recording like
this:&prompt.root; growisofs -Z /dev/cd0 -J -R /path/to/newdataThe DVD+RW format supports appending data to a previous
recording. This operation consists of merging a new session
to the existing one as it is not considered to be
multi-session writing. &man.growisofs.1; will
grow the ISO 9660 file system present on
the media.For example, to append data to a DVD+RW, use the
following:&prompt.root; growisofs -M /dev/cd0 -J -R /path/to/nextdataThe same &man.mkisofs.8; options used to burn the
initial session should be used during next writes.Use for better media
compatibility with DVD-ROM drives. When using DVD+RW, this
option will not prevent the addition of data.To blank the media, use:&prompt.root; growisofs -Z /dev/cd0=/dev/zeroUsing a DVD-RWDVDDVD-RWA DVD-RW accepts two disc formats: incremental sequential
and restricted overwrite. By default, DVD-RW discs are in
sequential format.A virgin DVD-RW can be directly written without being
formatted. However, a non-virgin DVD-RW in sequential format
needs to be blanked before writing a new initial
session.To blank a DVD-RW in sequential mode:&prompt.root; dvd+rw-format -blank=full /dev/cd0A full blanking using will
take about one hour on a 1x media. A fast blanking can be
performed using , if the DVD-RW will
be recorded in Disk-At-Once (DAO) mode. To burn the DVD-RW
in DAO mode, use the command:&prompt.root; growisofs -use-the-force-luke=dao -Z /dev/cd0=imagefile.isoSince &man.growisofs.1; automatically attempts to detect
fast blanked media and engage DAO write,
should not be
required.One should instead use restricted overwrite mode with
any DVD-RW as this format is more flexible than the default
of incremental sequential.To write data on a sequential DVD-RW, use the same
instructions as for the other DVD formats:&prompt.root; growisofs -Z /dev/cd0 -J -R /path/to/dataTo append some data to a previous recording, use
with &man.growisofs.1;. However, if data
is appended on a DVD-RW in incremental sequential mode, a new
session will be created on the disc and the result will be a
multi-session disc.A DVD-RW in restricted overwrite format does not need to
be blanked before a new initial session. Instead, overwrite
the disc with . It is also possible to
grow an existing ISO 9660 file system written on the disc with
. The result will be a one-session
DVD.To put a DVD-RW in restricted overwrite format, the
following command must be used:&prompt.root; dvd+rw-format /dev/cd0To change back to sequential format, use:&prompt.root; dvd+rw-format -blank=full /dev/cd0Multi-SessionFew DVD-ROM drives support multi-session DVDs and most of
the time only read the first session. DVD+R, DVD-R and DVD-RW
in sequential format can accept multiple sessions. The notion
of multiple sessions does not exist for the DVD+RW and the
DVD-RW restricted overwrite formats.Using the following command after an initial non-closed
session on a DVD+R, DVD-R, or DVD-RW in sequential format,
will add a new session to the disc:&prompt.root; growisofs -M /dev/cd0 -J -R /path/to/nextdataUsing this command with a DVD+RW or a DVD-RW in restricted
overwrite mode will append data while merging the new session
to the existing one. The result will be a single-session
disc. Use this method to add data after an initial write on
these types of media.Since some space on the media is used between each
session to mark the end and start of sessions, one should
add sessions with a large amount of data to optimize media
space. The number of sessions is limited to 154 for a
DVD+R, about 2000 for a DVD-R, and 127 for a DVD+R Double
Layer.For More InformationTo obtain more information about a DVD, use
dvd+rw-mediainfo
/dev/cd0 while the disc
in the specified drive.More information about
dvd+rw-tools can be found in
&man.growisofs.1;, on the dvd+rw-tools
web site, and in the cdwrite mailing
list archives.When creating a problem report related to the use of
dvd+rw-tools, always include the
output of dvd+rw-mediainfo.Using a DVD-RAMDVDDVD-RAMConfigurationDVD-RAM writers can use either a SCSI or ATAPI
interface. For ATAPI devices, DMA access has to be
enabled by adding the following line to
/boot/loader.conf:hw.ata.atapi_dma="1"Preparing the MediaA DVD-RAM can be seen as a removable hard drive. Like
any other hard drive, the DVD-RAM must be formatted before
it can be used. In this example, the whole disk space will
be formatted with a standard UFS2 file system:&prompt.root; dd if=/dev/zero of=/dev/acd0 bs=2k count=1
&prompt.root; bsdlabel -Bw acd0
&prompt.root; newfs /dev/acd0The DVD device, acd0, must be
changed according to the configuration.Using the MediaOnce the DVD-RAM has been formatted, it can be mounted
as a normal hard drive:&prompt.root; mount /dev/acd0/mntOnce mounted, the DVD-RAM will be both readable and
writeable.JulioMerinoOriginal work by MartinKarlssonRewritten by Creating and Using Floppy DisksStoring data on floppy disks is sometimes useful, for
example when one does not have any other removable storage media
or when one needs to transfer small amounts of data to another
computer.This section explains how to use floppy disks in &os;. It
covers formatting and usage of 3.5inch DOS floppies, but the
concepts are similar for other floppy disk formats.Formatting FloppiesThe DeviceFloppy disks are accessed through entries in
/dev, just like other
devices. To access the raw floppy disk, simply use
/dev/fdN.FormattingA floppy disk needs to be low-level formatted before it
can be used. This is usually done by the vendor, but
formatting is a good way to check media integrity. Although
it is possible to force other disk sizes, 1440kB is what
most floppy disks are designed for.To low-level format the floppy disk, use
&man.fdformat.1;. This utility expects the device name as
an argument.Make note of any error messages, as these can help
determine if the disk is good or bad.Formatting Floppy DisksTo format the floppy, insert a new 3.5inch floppy
disk into the first floppy drive and issue:&prompt.root; /usr/sbin/fdformat -f 1440 /dev/fd0The Disk LabelAfter low-level formatting the disk, a disk label needs to
placed on it. This disk label will be destroyed later, but
it is needed by the system to determine the size of the disk
and its geometry.The new disk label will take over the whole disk and will
contain all the proper information about the geometry of the
floppy. The geometry values for the disk label are listed in
/etc/disktab.To write the disk label, use &man.bsdlabel.8;:&prompt.root; /sbin/bsdlabel -B -w /dev/fd0 fd1440The File SystemThe floppy is now ready to be high-level formatted. This
will place a new file system on it so that &os; can read and
write to the disk. Since creating the new file system
destroys the disk label, the disk label needs to be recreated
whenever the disk is reformatted.The floppy's file system can be either UFS or FAT.
FAT is generally a better choice for floppies.To put a new file system on the floppy, issue:&prompt.root; /sbin/newfs_msdos /dev/fd0The disk is now ready for use.Using the FloppyTo use the floppy, mount it with &man.mount.msdosfs.8;.
One can also use
emulators/mtools from the
Ports Collection.Creating and Using Data Tapestape mediaTape technology has continued to evolve but is less likely
to be used in a modern system. Modern backup systems tend to
use off site combined with local removable disk drive
technologies. Still, &os; will support any tape drive that
uses SCSI, such as LTO and older devices such as DAT. There is
limited support for SATA and USB tape drives.Serial Access with &man.sa.4;tape drives&os; uses the &man.sa.4; driver, providing
/dev/sa0,
/dev/nsa0, and
/dev/esa0. In normal use, only
/dev/sa0 is needed.
/dev/nsa0 is the same physical drive
as /dev/sa0 but does not rewind the
tape after writing a file. This allows writing more than one
file to a tape. Using /dev/esa0
ejects the tape after the device is closed, if
applicable.Controlling the Tape Drive with
&man.mt.1;tape mediamt&man.mt.1; is the &os; utility for controlling other
operations of the tape drive, such as seeking through files on
a tape or writing tape control marks to the tape.For example, the first three files on a tape can be
preserved by skipping past them before writing a new
file:&prompt.root; mt -f /dev/nsa0 fsf 3Using &man.tar.1; to Read and
Write Tape BackupsAn example of writing a single file to tape using
&man.tar.1;:&prompt.root; tar cvf /dev/sa0 fileRecovering files from a &man.tar.1; archive on tape into
the current directory:&prompt.root; tar xvf /dev/sa0Using &man.dump.8; and
&man.restore.8; to Create and Restore BackupsA simple backup of /usr with &man.dump.8;:&prompt.root; dump -0aL -b64 -f /dev/nsa0 /usrInteractively restoring files from a &man.dump.8; file on
tape into the current directory:&prompt.root; restore -i -f /dev/nsa0Other Tape SoftwareHigher-level programs are available to simplify tape
backup. The most popular are
Amanda and
Bacula. These programs aim to make
backups easier and more convenient, or to automate complex
backups of multiple machines. The Ports Collection contains
both these and other tape utility applications.Backups to FloppiesCan I Use Floppies for Backing Up My Data?backup floppiesfloppy disksFloppy disks are not a suitable media for making backups
as:The media is unreliable, especially over long periods
of time.Backing up and restoring is very slow.They have a very limited capacity.However, if no other method of backing up data is
available, floppy disks are better than no backup at
all.When backing up to floppy disks, ensure the floppies are
of good quality. Floppies that have been lying around the
office for a couple of years are a bad choice. Ideally,
use new ones from a reputable manufacturer.So How Do I Backup My Data to Floppies?The best way to backup to floppy disk is to use
&man.tar.1; with (multi-volume), which
allows backups to span multiple floppies.To backup all the files in the current directory and
sub-directory, use this as root:&prompt.root; tar Mcvf /dev/fd0 *When the first floppy is full, &man.tar.1; will prompt
to insert the next volume, which in this case is the next
floppy disk:Prepare volume #2 for /dev/fd0 and hit return:This is repeated, with the volume number incrementing,
until all the specified files have been archived.Can I Compress My Backups?targzipcompressionUnfortunately, &man.tar.1; does not support
for multi-volume archives. Instead,
&man.gzip.1; all the files, &man.tar.1; them to the floppies,
then &man.gunzip.1; the files.How Do I Restore My Backups?To restore the entire archive use:&prompt.root; tar Mxvf /dev/fd0There are two methods to restore only specific files. The
first is to insert the first floppy and use:&prompt.root; tar Mxvf /dev/fd0 filename&man.tar.1; will prompt to insert subsequent floppies
until it finds the required file.Alternatively, if the floppy containing the file is known,
insert that floppy and use the same command. If the first
file on the floppy is a continuation from the previous one,
&man.tar.1; will warn that it cannot restore it, even if you
have not asked it to.LowellGilbertOriginal work by Backup StrategiesThe first requirement in devising a backup plan is to make
sure that all of the following problems are covered:Disk failure.Accidental file deletion.Random file corruption.Complete machine destruction, say by fire, including
destruction of any on-site backups.Some systems will be best served by having each of these
problems covered by a completely different technique. Except
for strictly personal systems with low-value data, it is
unlikely that one technique will cover all of them.Some possible techniques include:Archives of the whole system, backed up onto permanent,
off-site media. This provides protection against all of the
problems listed above, but is slow and inconvenient to
restore from. Copies of the backups can be stored on site
or online, but there will still be inconveniences in
restoring files, especially for non-privileged users.Filesystem snapshots, which are really only helpful in
the accidental file deletion scenario, but can be
very helpful in that case, as well as
quick and easy to deal with.Copies of whole file systems or disks which can be
created with a periodic net/rsync of the whole machine.
This is generally most useful in networks with unique
requirements. For general protection against disk failure,
this is usually inferior to RAID. For
restoring accidentally deleted files, it can be comparable
to UFS snapshots.RAID, which minimizes or avoids
downtime when a disk fails at the expense of having to deal
with disk failures more often, because there are more disks,
albeit at a much lower urgency.Checking fingerprints of files using &man.mtree.8;.
Although this is not a backup, this technique indicates
when one needs to resort to backups. This is particularly
important for offline backups, and should be checked
periodically.It is quite easy to come up with more techniques, many
of them variations on the ones listed above. Specialized
requirements usually lead to specialized techniques. For
example, backing up a live database usually requires a method
particular to the database software as an intermediate step.
The important thing is to know which dangers should be protected
against, and how each will be handled.Backup BasicsThe major backup programs built into &os; are
&man.dump.8;, &man.tar.1;, &man.cpio.1;, and
&man.pax.1;.Dump and Restorebackup softwaredump / restoredumprestoreThe traditional &unix; backup programs are
dump and restore. They
operate on the drive as a collection of disk blocks, below the
abstractions of files, links and directories that are created
by the file systems. Unlike other backup software,
dump backs up an entire file system on a
device. It is unable to backup only part of a file system or
a directory tree that spans more than one file system.
dump does not write files and directories,
but rather writes the raw data blocks that comprise files and
directories. When used to extract data,
restore stores temporary
files in /tmp/ by
default. When using a recovery disk with a small /tmp, set
TMPDIR to a directory with more free space in
order for the restore to succeed.If dump is used on the root
directory, it will not back up /home,
/usr or many other
directories since these are typically mount points for other
file systems or symbolic links into those file
systems.dump has quirks that remain from its
early days in Version 6 of AT&T &unix;,circa 1975. The
default parameters are suitable for 9-track tapes (6250 bpi),
not the high-density media available today (up to 62,182
ftpi). These defaults must be overridden on the command line
to utilize the capacity of current tape drives..rhostsIt is also possible to backup data across the network to a
tape drive attached to another computer with
rdump and rrestore.
Both programs rely upon &man.rcmd.3; and &man.ruserok.3; to
access the remote tape drive. Therefore, the user performing
the backup must be listed in .rhosts on
the remote computer. The arguments to
rdump and rrestore must
be suitable to use on the remote computer. For example, to
rdump from a &os; computer to an Exabyte
tape drive connected to a host called
komodo, use:&prompt.root; /sbin/rdump 0dsbfu 54000 13000 126 komodo:/dev/nsa8 /dev/da0a 2>&1There are security implications to allowing
.rhosts authentication, so use
with caution.It is also possible to use dump and
restore in a more secure fashion over
ssh.Using dump over
ssh&prompt.root; /sbin/dump -0uan -f - /usr | gzip -2 | ssh -c blowfish \
targetuser@targetmachine.example.com dd of=/mybigfiles/dump-usr-l0.gzOr, use the built-in RSH:Using dump over
ssh with RSH
Set&prompt.root; env RSH=/usr/bin/ssh /sbin/dump -0uan -f targetuser@targetmachine.example.com:/dev/sa0 /usrtarbackup softwaretar&man.tar.1; also dates back to Version 6 of AT&T
&unix;, circa 1975. tar operates in
cooperation with the file system and writes files and
directories to tape. tar does not support
the full range of options that are available from
&man.cpio.1;, but it does not require the unusual command
pipeline that cpio uses.tarTo tar to an Exabyte tape drive
connected to a host called komodo:&prompt.root; tar cf - . | rsh komodo dd of=tape-device obs=20bWhen backing up over an insecure network, instead use
ssh.cpiobackup softwarecpio&man.cpio.1; is the original &unix; file interchange tape
program for magnetic media. cpio includes
options to perform byte-swapping, write a number of different
archive formats, and pipe the data to other programs. This
last feature makes cpio an excellent choice
for installation media. cpio does not know
how to walk the directory tree and a list of files must be
provided through stdin.cpioSince cpio does not support backups
across the network, use a pipeline and ssh
to send the data to a remote tape drive.&prompt.root; for f in directory_list; dofind $f >> backup.listdone
&prompt.root; cpio -v -o --format=newc < backup.list | ssh user@host "cat > backup_device"Where directory_list is the
list of directories to back up,
user@host
is the user/hostname combination that will be performing the
backups, and backup_device is where
the backups should be written to, such as
/dev/nsa0).paxbackup softwarepaxpaxPOSIXIEEE&man.pax.1; is the IEEE/&posix; answer to
tar and cpio. Over the
years the various versions of tar and
cpio have become slightly incompatible. So
rather than fight it out to fully standardize them, &posix;
created a new archive utility. pax
attempts to read and write many of the various
cpio and tar formats,
plus new formats of its own. Its command set more resembles
cpio than tar.Amandabackup softwareAmandaAmandaAmanda (Advanced Maryland
Network Disk Archiver) is a client/server backup system,
rather than a single program. An
Amanda server will backup to a
single tape drive any number of computers that have
Amanda clients and a network
connection to the Amanda server. A
common problem at sites with a number of large disks is that
the length of time required to backup to data directly to tape
exceeds the amount of time available for the task.
Amanda solves this problem by using
a holding disk to backup several file systems
at the same time. Amanda creates
archive sets: a group of tapes used over a
period of time to create full backups of all the file systems
listed in Amanda's configuration
file. The archive set also contains nightly
incremental, or differential, backups of all the file systems.
Restoring a damaged file system requires the most recent full
backup and the incremental backups.The configuration file provides fine grained control of
backups and the network traffic that
Amanda generates.
Amanda will use any of the above
backup programs to write the data to tape.
Amanda is not installed by
but is available as either a port or package.Do NothingDo nothing is not a computer program, but
it is the most widely used backup strategy. There are no
initial costs. There is no backup schedule to follow. Just
say no. If something happens to your data, grin and bear
it!If your time and data is worth little to nothing, then
Do nothing is the most suitable backup program
for the computer. But beware, &os; is a useful tool and
over time it can be used to create a valuable collection of
files.Do nothing is the correct backup method for
/usr/obj and other
directory trees that can be exactly recreated by the computer.
An example is the files that comprise the HTML or &postscript;
version of this Handbook. These document formats have been
created from XML input files. Creating backups of the HTML or
&postscript; files is not necessary if the XML files are
backed up regularly.Which Backup Program Is Best?LISA&man.dump.8; Period. Elizabeth D.
Zwicky torture tested all the backup programs discussed here.
The clear choice for preserving all your data and all the
peculiarities of &unix; file systems is
dump. Elizabeth created file systems
containing a large variety of unusual conditions (and some not
so unusual ones) and tested each program by doing a backup and
restore of those file systems. The peculiarities included:
files with holes, files with holes and a block of nulls, files
with funny characters in their names, unreadable and
unwritable files, devices, files that change size during the
backup, files that are created/deleted during the backup and
more. She presented the results at LISA V in Oct. 1991. See
torture-testing
Backup and Archive Programs.Emergency Restore ProcedureBefore the DisasterThere are four steps which should be performed in
preparation for any disaster that may occur.bsdlabelFirst, print the bsdlabel of each disk using a command
such as bsdlabel da0 | lpr. Also print a
copy of /etc/fstab and all boot
messages.livefs CDSecond, burn a livefs CD. This CD
contains support for booting into a &os;
livefs rescue mode, allowing the user to
perform many tasks like running &man.dump.8;,
&man.restore.8;, &man.fdisk.8;, &man.bsdlabel.8;,
&man.newfs.8;, &man.mount.8;, and more. The livefs CD image
for &os;/&arch.i386; &rel2.current;-RELEASE is
available from .Livefs CD images are not available for
&os; &rel.current;-RELEASE and later. In addition to
the CDROM installation images, flash drive installation
images may be used to recover a system. The
memstick image for
&os;/&arch.i386; &rel.current;-RELEASE is available
from .Third, create backup tapes regularly. Any changes that
made after the last backup may be irretrievably lost.
Write-protect the backup media.Fourth, test the livefs CD and the
backups. Make notes of the procedure. Store these notes
with the CD, the printouts, and the backups. These notes
may prevent the inadvertent destruction of the backups while
under the stress of performing an emergency
recovery.For an added measure of security, store an extra
livefs CD and the latest backup at a
remote location, where a remote location is
not the basement of the same building.
A remote location should be physically separated from the
computers and disk drives by a significant distance.After the DisasterFirst, determine if the hardware survived. Thanks
to regular, off-site backups, there is no need to worry
about the software.If the hardware has been damaged, the parts should be
replaced before attempting to use the computer.If the hardware is okay, insert the
livefs CD and boot the computer. The
original install menu will be displayed on the screen.
Select the correct country, then choose
Fixit -- Repair mode with CDROM/DVD/floppy or
start a shell. then select
CDROM/DVD -- Use the live filesystem
CDROM/DVD.
restore and the other needed programs
are located in /mnt2/rescue.Recover each file system separately.mountroot partitionbsdlabelnewfsTry to mount the root partition
of the first disk using mount /dev/da0a
/mnt. If the bsdlabel was damaged, use
bsdlabel to re-partition and label the
disk to match the label that was printed and saved. Use
newfs to re-create the file systems.
Re-mount the root partition of the disk read-write using
mount -u -o rw /mnt. Use the backups
to recover the data for this file system. Unmount the file
system with umount /mnt. Repeat for each
file system that was damaged.Once the system is running, backup the data onto new
media as whatever caused the crash or data loss may strike
again. Another hour spent now may save further distress
later.MarcFonvieilleReorganized and enhanced by Network, Memory, and File-Backed File Systemsvirtual disksdisksvirtualIn addition to physical disks such as floppies, CDs, and
hard drives, &os; also supports virtual
disks.NFSCodadisksmemoryThese include network file systems such as the
Network File System and Coda,
memory-based file systems, and file-backed file systems.According to the &os; version, the tools used for the
creation and use of file-backed and memory-based file systems
differ.Use &man.devfs.5; to allocate device nodes transparently
for the user.File-Backed File Systemdisksfile-backed&man.mdconfig.8; is used to configure and enable memory
disks, &man.md.4;, under &os;. To use &man.mdconfig.8;,
&man.md.4; must be first loaded. When using a custom kernel
configuration file, ensure it includes this line:device md&man.mdconfig.8; supports several types of memory backed
virtual disks: memory disks allocated with &man.malloc.9; and
memory disks using a file or swap space as backing. One
possible use is the mounting of CD images.To mount an existing file system image:Using mdconfig to Mount an Existing
File System Image&prompt.root; mdconfig -a -t vnode -f diskimage -u 0
&prompt.root; mount /dev/md0/mntTo create a new file system image with
&man.mdconfig.8;:Creating a New File-Backed Disk with
mdconfig&prompt.root; dd if=/dev/zero of=newimage bs=1k count=5k
5120+0 records in
5120+0 records out
&prompt.root; mdconfig -a -t vnode -f newimage -u 0
&prompt.root; bsdlabel -w md0 auto
&prompt.root; newfs md0a
/dev/md0a: 5.0MB (10224 sectors) block size 16384, fragment size 2048
using 4 cylinder groups of 1.25MB, 80 blks, 192 inodes.
super-block backups (for fsck -b #) at:
160, 2720, 5280, 7840
&prompt.root; mount /dev/md0a /mnt
&prompt.root; df /mnt
Filesystem 1K-blocks Used Avail Capacity Mounted on
/dev/md0a 4710 4 4330 0% /mntIf unit number is not specified with
, &man.mdconfig.8; uses the
&man.md.4; automatic allocation to select an unused device.
The name of the allocated unit will be output to stdout, such
as md4. Refer to &man.mdconfig.8;
for more details about.While &man.mdconfig.8; is useful, it takes several
command lines to create a file-backed file system. &os; also
comes with &man.mdmfs.8; which automatically configures a
&man.md.4; disk using &man.mdconfig.8;, puts a UFS file system
on it using &man.newfs.8;, and mounts it using &man.mount.8;.
For example, to create and mount the same file system image as
above, type the following:Configure and Mount a File-Backed Disk with
mdmfs&prompt.root; dd if=/dev/zero of=newimage bs=1k count=5k
5120+0 records in
5120+0 records out
&prompt.root; mdmfs -F newimage -s 5m md0/mnt
&prompt.root; df /mnt
Filesystem 1K-blocks Used Avail Capacity Mounted on
/dev/md0 4718 4 4338 0% /mntWhen is used without a unit number,
&man.mdmfs.8; uses the &man.md.4; auto-unit feature to
automatically select an unused device. For more details
about &man.mdmfs.8;, refer to its manual page.Memory-Based File Systemdisksmemory file systemFor a memory-based file system, swap
backing should normally be used. This does not mean
that the memory disk will be swapped out to disk by default,
but rather that the memory disk will be allocated from a
memory pool which can be swapped out to disk if needed. It is
also possible to create memory-based disks which are
&man.malloc.9; backed, but using large malloc backed memory
disks can result in a system panic if the kernel runs out of
memory.Creating a New Memory-Based Disk with
mdconfig&prompt.root; mdconfig -a -t swap -s 5m -u 1
&prompt.root; newfs -U md1
/dev/md1: 5.0MB (10240 sectors) block size 16384, fragment size 2048
using 4 cylinder groups of 1.27MB, 81 blks, 192 inodes.
with soft updates
super-block backups (for fsck -b #) at:
160, 2752, 5344, 7936
&prompt.root; mount /dev/md1/mnt
&prompt.root; df /mnt
Filesystem 1K-blocks Used Avail Capacity Mounted on
/dev/md1 4718 4 4338 0% /mntCreating a New Memory-Based Disk with
mdmfs&prompt.root; mdmfs -s 5m md2/mnt
&prompt.root; df /mnt
Filesystem 1K-blocks Used Avail Capacity Mounted on
/dev/md2 4846 2 4458 0% /mntDetaching a Memory Disk from the Systemdisksdetaching a memory diskWhen a memory-based or file-based file system is no
longer in use, its resources should be released back to
the system. First, unmount the file system, then use
&man.mdconfig.8; to detach the disk from the system and
release the resources.For example, to detach and free all resources used by
/dev/md4:&prompt.root; mdconfig -d -u 4It is possible to list information about configured
&man.md.4; devices by running
mdconfig -l.TomRhodesContributed by File System Snapshotsfile systemssnapshots&os; offers a feature in conjunction with
Soft Updates: file system
snapshots.UFS snapshots allow a user to create images of specified
file systems, and treat them as a file. Snapshot files must be
created in the file system that the action is performed on, and
a user may create no more than 20 snapshots per file system.
Active snapshots are recorded in the superblock so they are
persistent across unmount and remount operations along with
system reboots. When a snapshot is no longer required, it can
be removed using &man.rm.1;. While snapshots may be removed in
any order, all the used space may not be acquired because
another snapshot will possibly claim some of the released
blocks.The un-alterable file flag is set
by &man.mksnap.ffs.8; after initial creation of a snapshot file.
&man.unlink.1; makes an exception for snapshot files since it
allows them to be removed.Snapshots are created using &man.mount.8;. To place a
snapshot of /var in the
file /var/snapshot/snap, use the following
command:&prompt.root; mount -u -o snapshot /var/snapshot/snap /varAlternatively, use &man.mksnap.ffs.8; to create the
snapshot:&prompt.root; mksnap_ffs /var /var/snapshot/snapOne can find snapshot files on a file system, such as
/var, using
&man.find.1;:&prompt.root; find /var -flags snapshotOnce a snapshot has been created, it has several
uses:Some administrators will use a snapshot file for backup
purposes, because the snapshot can be transferred to CDs or
tape.The file system integrity checker, &man.fsck.8;, may be
run on the snapshot. Assuming that the file system was
clean when it was mounted, this should always provide a
clean and unchanging result.Running &man.dump.8; on the snapshot will produce a dump
file that is consistent with the file system and the
timestamp of the snapshot. &man.dump.8; can also take a
snapshot, create a dump image, and then remove the snapshot
in one command by using .The snapshot can be mounted as a frozen image of the
file system. To &man.mount.8; the snapshot
/var/snapshot/snap run:&prompt.root; mdconfig -a -t vnode -f /var/snapshot/snap -u 4
&prompt.root; mount -r /dev/md4 /mntThe frozen /var is
now available through /mnt. Everything will initially
be in the same state it was during the snapshot creation time.
The only exception is that any earlier snapshots will appear as
zero length files. To unmount the snapshot, use:&prompt.root; umount /mnt
&prompt.root; mdconfig -d -u 4For more information about and
file system snapshots, including technical papers, visit
Marshall Kirk McKusick's website at
.File System Quotasaccountingdisk spacedisk quotasQuotas are an optional feature of the operating system that
can be used to limit the amount of disk space or the number of
files a user or members of a group may allocate on a per-file
system basis. This is used most often on timesharing systems
where it is desirable to limit the amount of resources any one
user or group of users may allocate. This prevents one user or
group of users from consuming all of the available disk
space.Configuring the System to Enable Disk QuotasBefore using disk quotas, quota support must be added to
the kernel by adding the following line to the kernel
configuration file:options QUOTAThe GENERIC kernel does not
have this enabled by default, so a custom kernel must be
compiled in order to use disk quotas. Refer to for more information on
kernel configuration.Next, enable disk quotas in
/etc/rc.conf:quota_enable="YES"disk quotascheckingFor finer control over quota startup, an additional
configuration variable is available. Normally on bootup, the
quota integrity of each file system is checked by
&man.quotacheck.8;. This program insures that the data in the
quota database properly reflects the data on the file system.
This is a time consuming process that will significantly
affect the time the system takes to boot. To skip this step,
add this variable to /etc/rc.conf:check_quotas="NO"Finally, edit /etc/fstab to enable
disk quotas on a per-file system basis. This is when user or
group quotas can be enabled on the file systems.To enable per-user quotas on a file system, add
to the options field in the
/etc/fstab entry for the file system to
enable quotas on. For example:/dev/da1s2g /home ufs rw,userquota 1 2To enable group quotas, instead use
. To enable both user and group
quotas, change the entry as follows:/dev/da1s2g /home ufs rw,userquota,groupquota 1 2By default, the quota files are stored in the root
directory of the file system as
quota.user and
quota.group. Refer to &man.fstab.5; for
more information. Even though an alternate location for the
quota files can be specified, this is not recommended because
the various quota utilities do not seem to handle this
properly.Once the configuration is complete, reboot the system
with the new kernel. /etc/rc will
automatically run the appropriate commands to create the
initial quota files for all of the quotas enabled in
/etc/fstab. There is no need to
manually create any zero length quota files.In the normal course of operations, there should be no
need to manually run &man.quotacheck.8;, &man.quotaon.8;, or
&man.quotaoff.8;. However, one should read their manual pages
to be familiar with their operation.Setting Quota Limitsdisk quotaslimitsOnce the system has been configured to enable quotas,
verify they really are enabled by running:&prompt.root; quota -vThere should be a one line summary of disk usage and
current quota limits for each file system that quotas are
enabled on.The system is now ready to be assigned quota limits with
&man.edquota.8;.Several options are available to enforce limits on the
amount of disk space a user or group may allocate, and how
many files they may create. Allocations can be limited based
on disk space (block quotas), number of files (inode quotas),
or a combination of both. Each limits is further broken down
into two categories: hard and soft limits.hard limitA hard limit may not be exceeded. Once a user reaches a
hard limit, no further allocations can be made on that file
system by that user. For example, if the user has a hard
limit of 500 kbytes on a file system and is currently using
490 kbytes, the user can only allocate an additional 10
kbytes. Attempting to allocate an additional 11 kbytes will
fail.soft limitSoft limits can be exceeded for a limited amount of time,
known as the grace period, which is one week by default. If a
user stays over their limit longer than the grace period, the
soft limit turns into a hard limit and no further allocations
are allowed. When the user drops back below the soft limit,
the grace period is reset.The following is an example output from &man.edquota.8;.
When &man.edquota.8; is invoked, the editor specified by
EDITOR is opened in order to edit the quota
limits. The default editor is set to
vi.&prompt.root; edquota -u testQuotas for user test:
/usr: kbytes in use: 65, limits (soft = 50, hard = 75)
inodes in use: 7, limits (soft = 50, hard = 60)
/usr/var: kbytes in use: 0, limits (soft = 50, hard = 75)
inodes in use: 0, limits (soft = 50, hard = 60)There are normally two lines for each file system that
has quotas enabled. One line represents the block limits and
the other represents the inode limits. Change the value to
modify the quota limit. For example, to raise this
user's block limit from a soft limit of 50 and a hard limit of
75 to a soft limit of 500 and a hard limit of 600,
change:/usr: kbytes in use: 65, limits (soft = 50, hard = 75)to:/usr: kbytes in use: 65, limits (soft = 500, hard = 600)The new quota limits take affect upon exiting the
editor.Sometimes it is desirable to set quota limits on a range
of UIDs. This can be done by passing to
&man.edquota.8;. First, assign the desired quota limit to a
user, then run edquota -p protouser
startuid-enduid. For example, if
test has the desired quota limits, the
following command will duplicate those quota limits for UIDs
10,000 through 19,999:&prompt.root; edquota -p test 10000-19999For more information, refer to &man.edquota.8;.Checking Quota Limits and Disk Usagedisk quotascheckingEither &man.quota.1; or &man.repquota.8; can be used to
check quota limits and disk usage. To check individual user
or group quotas and disk usage, use &man.quota.1;. A user
may only examine their own quota and the quota of a group they
are a member of. Only the superuser may view all user and
group quotas. To get a summary of all quotas and disk usage
for file systems with quotas enabled, use
&man.repquota.8;.The following is sample output from
quota -v for a user that has quota limits
on two file systems.Disk quotas for user test (uid 1002):
Filesystem usage quota limit grace files quota limit grace
/usr 65* 50 75 5days 7 50 60
/usr/var 0 50 75 0 50 60grace periodIn this example, the user is currently 15 kbytes over the
soft limit of 50 kbytes on /usr and has 5 days of grace
period left. The asterisk * indicates that
the user is currently over the quota limit.Normally, file systems that the user is not using any disk
space on will not show in the output of &man.quota.1;, even if
the user has a quota limit assigned for that file system. Use
to display those file systems, such as
/usr/var in the above
example.Quotas over NFSNFSQuotas are enforced by the quota subsystem on the NFS
server. The &man.rpc.rquotad.8; daemon makes quota
information available to &man.quota.1; on NFS clients,
allowing users on those machines to see their quota
statistics.Enable rpc.rquotad in
/etc/inetd.conf like so:rquotad/1 dgram rpc/udp wait root /usr/libexec/rpc.rquotad rpc.rquotadNow restart inetd:&prompt.root; service inetd restartLuckyGreenContributed by shamrock@cypherpunks.toEncrypting Disk Partitionsdisksencrypting&os; offers excellent online protections against
unauthorized data access. File permissions and Mandatory Access Control (MAC) help
prevent unauthorized users from accessing data while the
operating system is active and the computer is powered up.
However, the permissions enforced by the operating system are
irrelevant if an attacker has physical access to a computer and
can move the computer's hard drive to another system to copy and
analyze the data.Regardless of how an attacker may have come into possession
of a hard drive or powered-down computer, both the GEOM Based
Disk Encryption (gbde) and
geli cryptographic subsystems in &os; are
able to protect the data on the computer's file systems against
even highly-motivated attackers with significant resources.
Unlike cumbersome encryption methods that encrypt only
individual files, gbde and
geli transparently encrypt entire file
systems. No cleartext ever touches the hard drive's
platter.Disk Encryption with
gbdeConfiguring gbde requires
superuser privileges.&prompt.user; su -
Password:If using a custom kernel configuration file, ensure it
contains this line:options GEOM_BDEIf the kernel already contains this support, use
kldload to load &man.gbde.4;:&prompt.root; kldload geom_bdePreparing the Encrypted Hard DriveThe following example demonstrates adding a new hard
drive to a system that will hold a single encrypted
partition. This partition will be mounted as
/private.
gbde can also be used to encrypt
/home and
/var/mail, but this
requires more complex instructions which exceed the scope of
this introduction.Add the New Hard DriveInstall the new drive to the system as explained in
. For the purposes
of this example, a new hard drive partition has been
added as /dev/ad4s1c and
/dev/ad0s1*
represents the existing standard &os; partitions.&prompt.root; ls /dev/ad*
/dev/ad0 /dev/ad0s1b /dev/ad0s1e /dev/ad4s1
/dev/ad0s1 /dev/ad0s1c /dev/ad0s1f /dev/ad4s1c
/dev/ad0s1a /dev/ad0s1d /dev/ad4Create a Directory to Hold gbde
Lock Files&prompt.root; mkdir /etc/gbdeThe gbde lock file
contains information that
gbde requires to access
encrypted partitions. Without access to the lock file,
gbde will not be able to
decrypt the data contained in the encrypted partition
without significant manual intervention which is not
supported by the software. Each encrypted partition
uses a separate lock file.Initialize the gbde
PartitionA gbde partition must be
initialized before it can be used. This initialization
needs to be performed only once:&prompt.root; gbde init /dev/ad4s1c -i -L /etc/gbde/ad4s1c.lock&man.gbde.8; will open the default editor, in order
to set various configuration options in a template. For
use with UFS1 or UFS2, set the sector_size to
2048:# $FreeBSD: src/sbin/gbde/template.txt,v 1.1.36.1 2009/08/03 08:13:06 kensmith Exp $
#
# Sector size is the smallest unit of data which can be read or written.
# Making it too small decreases performance and decreases available space.
# Making it too large may prevent filesystems from working. 512 is the
# minimum and always safe. For UFS, use the fragment size
#
sector_size = 2048
[...]&man.gbde.8; will ask the user twice to type the
passphrase used to secure the data. The passphrase must
be the same both times. The ability of
gbde to protect data depends
entirely on the quality of the passphrase. For tips on
how to select a secure passphrase that is easy to
remember, see the Diceware
Passphrase website.gbde initcreates a lock file for
the gbde partition. In this
example, it is stored as
/etc/gbde/ad4s1c.lock.
gbde lock files must end in
.lock in order to be correctly detected
by the /etc/rc.d/gbde start up
script.gbde lock files
must be backed up together with
the contents of any encrypted partitions. While
deleting a lock file alone cannot prevent a determined
attacker from decrypting a
gbde partition, without the
lock file, the legitimate owner will be unable to
access the data on the encrypted partition without a
significant amount of work that is totally unsupported
by &man.gbde.8;.Attach the Encrypted Partition to the
Kernel&prompt.root; gbde attach /dev/ad4s1c -l /etc/gbde/ad4s1c.lockThis command will prompt to input the passphrase
that was selected during the initialization of the
encrypted partition. The new encrypted device will
appear in
/dev as
/dev/device_name.bde:&prompt.root; ls /dev/ad*
/dev/ad0 /dev/ad0s1b /dev/ad0s1e /dev/ad4s1
/dev/ad0s1 /dev/ad0s1c /dev/ad0s1f /dev/ad4s1c
/dev/ad0s1a /dev/ad0s1d /dev/ad4 /dev/ad4s1c.bdeCreate a File System on the Encrypted
DeviceOnce the encrypted device has been attached to the
kernel, a file system can be created on the device using
&man.newfs.8;. This example creates a UFS2 file
system with soft updates enabled.&prompt.root; newfs -U /dev/ad4s1c.bde&man.newfs.8; must be performed on an attached
gbde partition which is
identified by a
*.bde
extension to the device name.Mount the Encrypted PartitionCreate a mount point for the encrypted file
system:&prompt.root; mkdir /privateMount the encrypted file system:&prompt.root; mount /dev/ad4s1c.bde /privateVerify That the Encrypted File System is
AvailableThe encrypted file system should now be visible to
&man.df.1; and be available for use.&prompt.user; df -H
Filesystem Size Used Avail Capacity Mounted on
/dev/ad0s1a 1037M 72M 883M 8% /
/devfs 1.0K 1.0K 0B 100% /dev
/dev/ad0s1f 8.1G 55K 7.5G 0% /home
/dev/ad0s1e 1037M 1.1M 953M 0% /tmp
/dev/ad0s1d 6.1G 1.9G 3.7G 35% /usr
/dev/ad4s1c.bde 150G 4.1K 138G 0% /privateMounting Existing Encrypted File SystemsAfter each boot, any encrypted file systems must be
re-attached to the kernel, checked for errors, and mounted,
before the file systems can be used. The required commands
must be executed as root.Attach the gbde Partition to the
Kernel&prompt.root; gbde attach /dev/ad4s1c -l /etc/gbde/ad4s1c.lockThis command will prompt for the passphrase that was
selected during initialization of the encrypted
gbde partition.Check the File System for ErrorsSince encrypted file systems cannot yet be listed in
/etc/fstab for automatic mounting,
the file systems must be checked for errors by running
&man.fsck.8; manually before mounting:&prompt.root; fsck -p -t ffs /dev/ad4s1c.bdeMount the Encrypted File System&prompt.root; mount /dev/ad4s1c.bde /privateThe encrypted file system is now available for
use.Automatically Mounting Encrypted PartitionsIt is possible to create a script to automatically
attach, check, and mount an encrypted partition, but for
security reasons the script should not contain the
&man.gbde.8; password. Instead, it is recommended that
such scripts be run manually while providing the password
via the console or &man.ssh.1;.As an alternative, an rc.d script
is provided. Arguments for this script can be passed via
&man.rc.conf.5;:gbde_autoattach_all="YES"
gbde_devices="ad4s1c"
gbde_lockdir="/etc/gbde"This requires that the
gbde passphrase be entered at
boot time. After typing the correct passphrase, the
gbde encrypted partition will
be mounted automatically. This can be useful when using
gbde on laptops.Cryptographic Protections Employed by
gbde&man.gbde.8; encrypts the sector payload using 128-bit
AES in CBC mode. Each sector on the disk is encrypted with
a different AES key. For more information on the
cryptographic design, including how the sector keys are
derived from the user-supplied passphrase, refer to
&man.gbde.4;.Compatibility Issues&man.sysinstall.8; is incompatible with
gbde-encrypted devices. All
*.bde
devices must be detached from the kernel before starting
&man.sysinstall.8; or it will crash during its initial
probing for devices. To detach the encrypted device used in
the example, use the following command:&prompt.root; gbde detach /dev/ad4s1cAlso, since &man.vinum.4; does not use the
&man.geom.4; subsystem,
gbde can not be used with
vinum volumes.DanielGerzoContributed by Disk Encryption with geliAn alternative cryptographic GEOM class is available
through &man.geli.8;. geli differs from
gbde; offers different features, and uses
a different scheme for doing cryptographic work.&man.geli.8; provides the following features:Utilizes the &man.crypto.9; framework and, when
cryptographic hardware is available,
geli uses it automatically.Supports multiple cryptographic algorithms such as
AES, Blowfish, and 3DES.Allows the root partition to be encrypted. The
passphrase used to access the encrypted root partition
will be requested during system boot.Allows the use of two independent keys such as a
key and a
company key.geli is fast as it performs simple
sector-to-sector encryption.Allows backup and restore of master keys. If a user
destroys their keys, it is still possible to get access
to the data by restoring keys from the backup.Allows a disk to attach with a random, one-time key
which is useful for swap partitions and temporary file
systems.More geli features can be found in
&man.geli.8;.This section describes how to enable support for
geli in the &os; kernel and explains how
to create and use a geli encryption
provider.Superuser privileges are required since modifications
to the kernel are necessary.Adding geli Support to the
KernelFor a custom kernel, ensure the kernel configuration
file contains these lines:options GEOM_ELI
device cryptoAlternatively, the geli module can
be loaded at boot time by adding the following line to
/boot/loader.conf:geom_eli_load="YES"&man.geli.8; should now be supported by the
kernel.Generating the Master KeyThe following example describes how to generate a
key file which will be used as part of the master key for
the encrypted provider mounted under
/private. The key
file will provide some random data used to encrypt the
master key. The master key will also be protected by a
passphrase. The provider's sector size will be 4kB.
The example will describe how to attach to the
geli provider, create a file system on
it, mount it, work with it, and finally, how to detach
it.It is recommended to use a bigger sector size, such as
4kB, for better performance.The master key will be protected with a passphrase and
the data source for the key file will be
/dev/random. The sector size of
the provider /dev/da2.eli will be
4kB.&prompt.root; dd if=/dev/random of=/root/da2.key bs=64 count=1
&prompt.root; geli init -s 4096 -K /root/da2.key /dev/da2
Enter new passphrase:
Reenter new passphrase:It is not mandatory to use both a passphrase and a key
file as either method of securing the master key can be
used in isolation.If the key file is given as -, standard
input will be used. This example shows how more than one
key file can be used:&prompt.root; cat keyfile1 keyfile2 keyfile3 | geli init -K - /dev/da2Attaching the Provider with the Generated Key&prompt.root; geli attach -k /root/da2.key /dev/da2
Enter passphrase:The new plaintext device will be named
/dev/da2.eli.&prompt.root; ls /dev/da2*
/dev/da2 /dev/da2.eliCreating the New File System&prompt.root; dd if=/dev/random of=/dev/da2.eli bs=1m
&prompt.root; newfs /dev/da2.eli
&prompt.root; mount /dev/da2.eli /privateThe encrypted file system should now be visible to
&man.df.1; and be available for use:&prompt.root; df -H
Filesystem Size Used Avail Capacity Mounted on
/dev/ad0s1a 248M 89M 139M 38% /
/devfs 1.0K 1.0K 0B 100% /dev
/dev/ad0s1f 7.7G 2.3G 4.9G 32% /usr
/dev/ad0s1d 989M 1.5M 909M 0% /tmp
/dev/ad0s1e 3.9G 1.3G 2.3G 35% /var
/dev/da2.eli 150G 4.1K 138G 0% /privateUnmounting and Detaching the ProviderOnce the work on the encrypted partition is done, and
the /private
partition is no longer needed, it is prudent to consider
unmounting and detaching the geli
encrypted partition from the kernel:&prompt.root; umount /private
&prompt.root; geli detach da2.eliMore information about the use of &man.geli.8; can be
found in its manual page.Using the gelirc.d Scriptgeli comes with a
rc.d script which can be used to
simplify the usage of geli. An example
of configuring geli through
&man.rc.conf.5; follows:geli_devices="da2"
geli_da2_flags="-p -k /root/da2.key"This configures /dev/da2 as a
geli provider of which the master key
file is located in /root/da2.key.
geli will not use a passphrase when
attaching to the provider if
was given during the
geli init phase. The system will detach
the geli provider from the kernel before
the system shuts down.More information about configuring
rc.d is provided in the
rc.d section of the
Handbook.ChristianBrüfferWritten by Encrypting Swap SpaceswapencryptingLike the encryption of disk partitions, encryption of swap
space is used to protect sensitive information. Consider an
application that deals with passwords. As long as these
passwords stay in physical memory, these passwords will not
be written to disk and be cleared after a reboot. If &os;
starts swapping out memory pages to free
space for other applications, the passwords may be written to
the disk platters unencrypted. Encrypting swap space can be a
solution for this scenario.The &man.gbde.8; or &man.geli.8; encryption systems may be
used for swap encryption. Both systems use the
encswap
rc.d script.For the remainder of this section,
ad0s1b will be the swap
partition.Swap partitions are not encrypted by default and should
be cleared of any sensitive data before continuing. To
overwrite the current swap parition with random garbage,
execute the following command:&prompt.root; dd if=/dev/random of=/dev/ad0s1b bs=1mSwap Encryption with &man.gbde.8;The .bde suffix should be added to the
device in the respective /etc/fstab swap
line:# Device Mountpoint FStype Options Dump Pass#
/dev/ad0s1b.bde none swap sw 0 0Swap Encryption with &man.geli.8;The procedure for instead using &man.geli.8; for swap
encryption is similar to that of using &man.gbde.8;. The
.eli suffix should be added to the device
in the respective /etc/fstab swap
line:# Device Mountpoint FStype Options Dump Pass#
/dev/ad0s1b.eli none swap sw 0 0&man.geli.8; uses the AES algorithm
with a key length of 128 bit by default. These defaults can
be altered by using geli_swap_flags in
/etc/rc.conf. The following line tells
the encswap rc.d script to create
&man.geli.8; swap partitions using the Blowfish algorithm with
a key length of 128 bits and a sectorsize of 4 kilobytes, and
sets detach on last close:geli_swap_flags="-e blowfish -l 128 -s 4096 -d"Refer to the description of
onetime in &man.geli.8; for a list of
possible options.Encrypted Swap VerificationOnce the system has rebooted, proper operation of the
encrypted swap can be verified using
swapinfo.If &man.gbde.8; is being used:&prompt.user; swapinfo
Device 1K-blocks Used Avail Capacity
/dev/ad0s1b.bde 542720 0 542720 0%If &man.geli.8; is being used:&prompt.user; swapinfo
Device 1K-blocks Used Avail Capacity
/dev/ad0s1b.eli 542720 0 542720 0%DanielGerzoContributed by FreddieCashWith inputs from Pawel JakubDawidekMichael W.LucasViktorPeterssonHighly Available Storage (HAST)HASThigh availabilitySynopsisHigh availability is one of the main requirements in
serious business applications and highly-available storage is
a key component in such environments. Highly Available
STorage, or HASTHighly
Available STorage, was developed by
&a.pjd; as a framework which allows transparent storage of the
same data across several physically separated machines
connected by a TCP/IP network. HAST can be
understood as a network-based RAID1 (mirror), and is similar
to the DRBD® storage system known from the GNU/&linux;
platform. In combination with other high-availability
features of &os; like CARP,
HAST makes it possible to build a
highly-available storage cluster that is resistant to hardware
failures.After reading this section, you will know:What HAST is, how it works and
which features it provides.How to set up and use HAST on
&os;.How to integrate CARP and
&man.devd.8; to build a robust storage system.Before reading this section, you should:Understand &unix; and &os; basics.Know how to configure network
interfaces and other core &os; subsystems.Have a good understanding of &os;
networking.The HAST project was sponsored by The
&os; Foundation with support from OMCnet Internet Service
GmbH and TransIP
BV.HAST FeaturesThe main features of the HAST system
are:Can be used to mask I/O errors on local hard
drives.File system agnostic as it works with any file
system supported by &os;.Efficient and quick resynchronization, synchronizing
only blocks that were modified during the downtime of a
node.Can be used in an already deployed environment to add
additional redundancy.Together with CARP,
Heartbeat, or other tools, it
can be used to build a robust and durable storage
system.HAST OperationAs HAST provides a synchronous
block-level replication of any storage media to several
machines, it requires at least two physical machines:
the primary, also known as the
master node, and the
secondary or slave
node. These two machines together are referred to as a
cluster.HAST is currently limited to two cluster nodes in
total.Since HAST works in a
primary-secondary configuration, it allows only one of the
cluster nodes to be active at any given time. The
primary node, also called
active, is the one which will handle all
the I/O requests to HAST-managed
devices. The secondary node is
automatically synchronized from the primary
node.The physical components of the HAST
system are:local disk on primary node, anddisk on remote, secondary node.HAST operates synchronously on a block
level, making it transparent to file systems and applications.
HAST provides regular GEOM providers in
/dev/hast/ for use by
other tools or applications, thus there is no difference
between using HAST-provided devices and
raw disks or partitions.Each write, delete, or flush operation is sent to the
local disk and to the remote disk over TCP/IP. Each read
operation is served from the local disk, unless the local disk
is not up-to-date or an I/O error occurs. In such case, the
read operation is sent to the secondary node.Synchronization and Replication ModesHAST tries to provide fast failure
recovery. For this reason, it is very important to reduce
synchronization time after a node's outage. To provide fast
synchronization, HAST manages an on-disk
bitmap of dirty extents and only synchronizes those during a
regular synchronization, with an exception of the initial
sync.There are many ways to handle synchronization.
HAST implements several replication modes
to handle different synchronization methods:memsync: report write operation
as completed when the local write operation is finished
and when the remote node acknowledges data arrival, but
before actually storing the data. The data on the
remote node will be stored directly after sending the
acknowledgement. This mode is intended to reduce
latency, but still provides very good reliability.fullsync: report write
operation as completed when local write completes and
when remote write completes. This is the safest and the
slowest replication mode. This mode is the
default.async: report write operation
as completed when local write completes. This is the
fastest and the most dangerous replication mode. It
should be used when replicating to a distant node where
latency is too high for other modes.HAST ConfigurationHAST requires
GEOM_GATE support which is not present in
the default GENERIC kernel. However, the
geom_gate.ko loadable module is available
in the default &os; installation. Alternatively, to build
GEOM_GATE support into the kernel
statically, add this line to the custom kernel configuration
file:options GEOM_GATEThe HAST framework consists of several
parts from the operating system's point of view:the &man.hastd.8; daemon responsible for data
synchronization,the &man.hastctl.8; userland management
utility,and the &man.hast.conf.5; configuration file.The following example describes how to configure two nodes
in master-slave /
primary-secondary
operation using HAST to replicate the data
between the two. The nodes will be called
hasta with an IP
address of 172.16.0.1 and
hastb with an IP
of address 172.16.0.2. Both nodes
will have a dedicated hard drive
/dev/ad6
of the same size for HAST operation. The
HAST pool, sometimes also referred to as a
resource or the GEOM provider in /dev/hast/, will be
called
test.Configuration of HAST is done using
/etc/hast.conf. This file should be the
same on both nodes. The simplest configuration possible
is:resource test {
on hasta {
local /dev/ad6
remote 172.16.0.2
}
on hastb {
local /dev/ad6
remote 172.16.0.1
}
}For more advanced configuration, refer to
&man.hast.conf.5;.It is also possible to use host names in the
remote statements. In such a case, make
sure that these hosts are resolvable and are defined in
/etc/hosts or in the local
DNS.Now that the configuration exists on both nodes,
the HAST pool can be created. Run these
commands on both nodes to place the initial metadata onto the
local disk and to start &man.hastd.8;:&prompt.root; hastctl create test
&prompt.root; service hastd onestartIt is not possible to use GEOM
providers with an existing file system or to convert an
existing storage to a HAST-managed pool.
This procedure needs to store some metadata on the provider
and there will not be enough required space
available on an existing provider.A HAST node's primary or
secondary role is selected by an
administrator, or software like
Heartbeat, using &man.hastctl.8;.
On the primary node,
hasta, issue
this command:&prompt.root; hastctl role primary testSimilarly, run this command on the secondary node,
hastb:&prompt.root; hastctl role secondary testWhen the nodes are unable to communicate with each
other, and both are configured as primary nodes, the
condition is called split-brain. To
troubleshoot this situation, follow the steps described in
.Verify the result by running &man.hastctl.8; on each
node:&prompt.root; hastctl status testThe important text is the status line,
which should say complete
on each of the nodes. If it says degraded,
something went wrong. At this point, the synchronization
between the nodes has already started. The synchronization
completes when hastctl status
reports 0 bytes of dirty extents.The next step is to create a filesystem on the
/dev/hast/test
GEOM provider and mount it. This must be done on the
primary node, as
/dev/hast/test
appears only on the primary node. Creating
the filesystem can take a few minutes, depending on the size
of the hard drive:&prompt.root; newfs -U /dev/hast/test
&prompt.root; mkdir /hast/test
&prompt.root; mount /dev/hast/test /hast/testOnce the HAST framework is configured
properly, the final step is to make sure that
HAST is started automatically during
system boot. Add this line to
/etc/rc.conf:hastd_enable="YES"Failover ConfigurationThe goal of this example is to build a robust storage
system which is resistant to the failure of any given node.
The scenario is that a primary node of
the cluster fails. If this happens, the
secondary node is there to take over
seamlessly, check and mount the file system, and continue to
work without missing a single bit of data.To accomplish this task, another &os; feature,
CARP, provides for automatic failover on
the IP layer. CARP (Common
Address Redundancy Protocol) allows multiple hosts on the
same network segment to share an IP address. Set up
CARP on both nodes of the cluster
according to the documentation available in
. After setup, each node will
have its own carp0 interface with a
shared IP address of
172.16.0.254. The primary
HAST node of the cluster must be the
master CARP node.The HAST pool created in the previous
section is now ready to be exported to the other hosts on
the network. This can be accomplished by exporting it
through NFS or
Samba, using the shared IP
address 172.16.0.254. The only
problem which remains unresolved is an automatic failover
should the primary node fail.In the event of CARP interfaces going
up or down, the &os; operating system generates a
&man.devd.8; event, making it possible to watch for state
changes on the CARP interfaces. A state
change on the CARP interface is an
indication that one of the nodes failed or came back online.
These state change events make it possible to run a script
which will automatically handle the HAST failover.To be able to catch state changes on the
CARP interfaces, add this
configuration to
/etc/devd.conf on each node:notify 30 {
match "system" "IFNET";
match "subsystem" "carp0";
match "type" "LINK_UP";
action "/usr/local/sbin/carp-hast-switch master";
};
notify 30 {
match "system" "IFNET";
match "subsystem" "carp0";
match "type" "LINK_DOWN";
action "/usr/local/sbin/carp-hast-switch slave";
};Restart &man.devd.8; on both nodes to put the new
configuration into effect:&prompt.root; service devd restartWhen the carp0 interface state
changes by going up or down , the system generates a
notification, allowing the &man.devd.8; subsystem to run an
arbitrary script, in this case
/usr/local/sbin/carp-hast-switch. This
script handles the automatic failover. For further
clarification about the above &man.devd.8; configuration,
refer to &man.devd.conf.5;.An example of such a script could be:#!/bin/sh
# Original script by Freddie Cash <fjwcash@gmail.com>
# Modified by Michael W. Lucas <mwlucas@BlackHelicopters.org>
# and Viktor Petersson <vpetersson@wireload.net>
# The names of the HAST resources, as listed in /etc/hast.conf
resources="test"
# delay in mounting HAST resource after becoming master
# make your best guess
delay=3
# logging
log="local0.debug"
name="carp-hast"
# end of user configurable stuff
case "$1" in
master)
logger -p $log -t $name "Switching to primary provider for ${resources}."
sleep ${delay}
# Wait for any "hastd secondary" processes to stop
for disk in ${resources}; do
while $( pgrep -lf "hastd: ${disk} \(secondary\)" > /dev/null 2>&1 ); do
sleep 1
done
# Switch role for each disk
hastctl role primary ${disk}
if [ $? -ne 0 ]; then
logger -p $log -t $name "Unable to change role to primary for resource ${disk}."
exit 1
fi
done
# Wait for the /dev/hast/* devices to appear
for disk in ${resources}; do
for I in $( jot 60 ); do
[ -c "/dev/hast/${disk}" ] && break
sleep 0.5
done
if [ ! -c "/dev/hast/${disk}" ]; then
logger -p $log -t $name "GEOM provider /dev/hast/${disk} did not appear."
exit 1
fi
done
logger -p $log -t $name "Role for HAST resources ${resources} switched to primary."
logger -p $log -t $name "Mounting disks."
for disk in ${resources}; do
mkdir -p /hast/${disk}
fsck -p -y -t ufs /dev/hast/${disk}
mount /dev/hast/${disk} /hast/${disk}
done
;;
slave)
logger -p $log -t $name "Switching to secondary provider for ${resources}."
# Switch roles for the HAST resources
for disk in ${resources}; do
if ! mount | grep -q "^/dev/hast/${disk} on "
then
else
umount -f /hast/${disk}
fi
sleep $delay
hastctl role secondary ${disk} 2>&1
if [ $? -ne 0 ]; then
logger -p $log -t $name "Unable to switch role to secondary for resource ${disk}."
exit 1
fi
logger -p $log -t $name "Role switched to secondary for resource ${disk}."
done
;;
esacIn a nutshell, the script takes these actions when a
node becomes master /
primary:Promotes the HAST pools to
primary on a given node.Checks the file system under the
HAST pool.Mounts the pools at an appropriate place.When a node becomes backup /
secondary:Unmounts the HAST pools.Degrades the HAST pools to
secondary.Keep in mind that this is just an example script which
serves as a proof of concept. It does not handle all the
possible scenarios and can be extended or altered in any
way, for example, to start/stop required services.For this example, a standard UFS file system was used.
To reduce the time needed for recovery, a journal-enabled
UFS or ZFS file system can be used instead.More detailed information with additional examples can
be found in the
HAST Wiki
page.TroubleshootingGeneral Troubleshooting TipsHAST should generally work without
issues. However, as with any other software product, there
may be times when it does not work as supposed. The sources
of the problems may be different, but the rule of thumb is
to ensure that the time is synchronized between all nodes of
the cluster.When troubleshooting HAST problems,
the debugging level of &man.hastd.8; should be increased by
starting &man.hastd.8; with -d. This
argument may be specified multiple times to further increase
the debugging level. A lot of useful information may be
obtained this way. Consider also using
-F, which starts &man.hastd.8; in the
foreground.Recovering from the Split-brain ConditionSplit-brain is when the nodes of the
cluster are unable to communicate with each other, and both
are configured as primary. This is a dangerous condition
because it allows both nodes to make incompatible changes to
the data. This problem must be corrected manually by the
system administrator.The administrator must decide which node has more
important changes (or merge them manually) and let
HAST perform full synchronization of the
node which has the broken data. To do this, issue these
commands on the node which needs to be
resynchronized:&prompt.root; hastctl role init <resource>
&prompt.root; hastctl create <resource>
&prompt.root; hastctl role secondary <resource>
Index: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/porters-handbook/book.xml
===================================================================
--- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/porters-handbook/book.xml (revision 42006)
+++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/porters-handbook/book.xml (revision 42007)
@@ -1,17040 +1,17040 @@
]>
FreeBSD Porter's HandbookThe FreeBSD Documentation Project
- April 2000
+ $FreeBSD$20002001200220032004200520062007200820092010201120122013The FreeBSD Documentation
Project
&trademarks;
&legalnotice;
$FreeBSD$IntroductionThe 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.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.Making a New Port YourselfSo, you are interested in making your own port or
upgrading an existing one? Great!What follows are some guidelines for creating a new port for
FreeBSD. If you want to upgrade an existing port, you should
read this and then read .When this document is not sufficiently detailed, you should
refer to /usr/ports/Mk/bsd.port.mk, 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;.Only a fraction of the variables
(VAR) that can
be overridden are mentioned in this document. Most (if not
all) are documented at the start of
/usr/ports/Mk/bsd.port.mk; the others
probably ought to be. Note that this file uses a non-standard
tab setting: Emacs and
Vim 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 typing :set
tabstop=4 once the file has been loaded.
Looking for something easy to start with? Take a look at the
list of
requested ports and see if you can work on one (or
more).Quick PortingThis section tells you how to quickly create a new port. In
many cases, it is not sufficient, so you will have to read
further on into the document.First, get the original tarball and put it into
DISTDIR, which defaults to
/usr/ports/distfiles.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.Writing the MakefileThe minimal Makefile would look
something like this:# $FreeBSD$
PORTNAME= oneko
PORTVERSION= 1.1b
CATEGORIES= games
MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/
MAINTAINER= asami@FreeBSD.org
COMMENT= Cat chasing a mouse all over the screen
MAN1= oneko.1
MANCOMPRESSED= yes
USE_IMAKE= yes
.include <bsd.port.mk>In some cases, the Makefile of an
existing port may contain additional lines in the header,
such as the name of the port and the date it was created.
This additional information has been declared obsolete, and
is being phased out.See if you can figure it out. Do not worry about the
contents of the $FreeBSD$
line, it will be filled in automatically by SVN when the port
is imported to our main ports tree. You can find a more
detailed example in the sample Makefile
section.Writing the Description FilesThere are two description files that are required for
any port, whether they actually package or not. They are
pkg-descr and
pkg-plist. Their
pkg- prefix distinguishes them from
other files.pkg-descrThis is a longer description of the port. One to a few
paragraphs concisely explaining what the port does is
sufficient.This is not a manual or an
in-depth description on how to use or compile the port!
Please be careful if you are copying from the
README or manpage; too
often they are not a concise description of the port or
are in an awkward format (e.g., manpages have justified
spacing, as it looks particularly bad with monospaced
fonts).A well-written pkg-descr describes
the port completely enough that users would not have to
consult the documentation or visit the website to understand
what the software does, how it can be useful, or what
particularly nice features it has. Mentioning certain
requirements like a graphical toolkit, heavy dependencies,
runtime environment, or implementation languages help users
decide whether this port will work for them.Include a URL to the official WWW homepage.
Prepend one of
the websites (pick the most common one) with
WWW: (followed by single space) so that
automated tools will work correctly. If the URI is the root
of the website or directory, it should be terminated with a
slash.If the listed webpage for a port is not available, try
to search the Internet first to see if the official site
moved, was renamed, or is hosted elsewhere.The following example shows how your
pkg-descr should look:This is a port of oneko, in which a cat chases a poor mouse all over
the screen.
:
(etc.)
WWW: http://www.oneko.org/pkg-plistThis 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
/usr/local. If you are using the
MANn variables
(as you should be), do not list any manpages here. If the
port creates directories during installation, make sure to
add @dirrm lines to remove them when the
package is deleted.Here is a small example: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/onekoRefer to the &man.pkg.create.1; manual page for details
on the packing list.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.Creating a packing list manually can be a very tedious
task. If the port installs a large numbers of files,
creating the packing list
automatically might save time.There is only one case when
pkg-plist 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 PLIST_FILES and
PLIST_DIRS, respectively, within the
port's Makefile. For instance, we
could get along without pkg-plist in
the above oneko port by adding the
following lines to the Makefile: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/onekoOf course, PLIST_DIRS should be left
unset if a port installs no directories of its own.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
pkg-plist.Later we will see how pkg-plist
and PLIST_FILES can be used to fulfill
more sophisticated
tasks.Creating the Checksum FileJust type make makesum. The ports make
rules will automatically generate the file
distinfo.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 IGNOREFILES
variable. Then the checksum is not calculated for that file
when you run make makesum, but set to
IGNORE.Testing the PortYou 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.pkg-plist does not contain
anything not installed by your portpkg-plist contains everything
that is installed by your portYour port can be installed multiple times using the
reinstall targetYour port cleans
up after itself upon deinstallRecommended Test Orderingmake installmake packagemake deinstallpkg_add
package-namemake deinstallmake reinstallmake packagemake readmeMake sure that there are not any warnings issued in any of
the package and
deinstall 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.The most thorough way to automate these steps is via
installing the ports tinderbox.
This maintains jails in which you can
test all of the above steps without changing the state of
your running system. Please see
ports/ports-mgmt/tinderbox for more
information.Checking Your Port with
portlintPlease use portlint to see if your port
conforms to our guidelines. The ports-mgmt/portlint program is
part of the ports collection. In particular, you may want to
check if the Makefile
is in the right shape and the package is named
appropriately.Submitting the New PortBefore you submit the new port, make sure you have read
the DOs and DON'Ts section.Now that you are happy with your port, the only thing
remaining is to put it in the main &os; ports tree and make
everybody else happy about it too. We do not need your
work directory or the
pkgname.tgz package, so delete them now.
Next, assuming your port is called oneko,
cd to the directory above where the
oneko directory is located, and then type
the following: shar `find oneko` >
oneko.sharInclude your oneko.shar file in a bug
report and send it with the &man.send-pr.1; program (see
Bug
Reports and General Commentary for more information
about &man.send-pr.1;). Be sure to classify the bug report
as category ports and class
change-request (Do not mark the report
confidential!). Also add a short
description of the program you ported to the
Description field of the PR (e.g., perhaps a
short version of the COMMENT), and add
the shar file to the Fix field.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:
<category>/<portname> <short description of
the port> for new ports. If you stick to this
scheme, the chance that someone will take a look at your PR
soon is much better.One more time, do not include the original
source distfile, the work directory, or
the package you built with make
package; and, do use &man.shar.1; for
new ports, not &man.diff.1;.After you have submitted your port, please be patient.
Sometimes it can take a few months before a port is included
in &os;, although it might only take a few days. You can
view the list of ports
PRs waiting to be committed to &os;.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
be added to the list of Additional
FreeBSD Contributors and other files.Slow PortingOk, 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.How Things WorkFirst, this is the sequence of events which occurs when
the user first types make in your port's
directory. You may find that having
bsd.port.mk in another window while you
read this really helps to understand it.But do not worry if you do not really understand what
bsd.port.mk is doing, not many people
do... :-)The fetch target is run. The
fetch target is responsible for
making sure that the tarball exists locally in
DISTDIR. If
fetch cannot find the required
files in DISTDIR it will look up the
URL MASTER_SITES, which is set in the
Makefile, as well as our main FTP site at ,
where we put sanctioned distfiles as backup. It will then
attempt to fetch the named distribution file with
FETCH, assuming that the requesting
site has direct access to the Internet. If that succeeds,
it will save the file in DISTDIR for
future use and proceed.The extract target is run.
It looks for your port's distribution file (typically a
gzipped tarball) in
DISTDIR and unpacks it into a temporary
subdirectory specified by WRKDIR
(defaults to work).The patch target is run.
First, any patches defined in
PATCHFILES are applied. Second, if any
patch files named
patch-*
are found in PATCHDIR (defaults to the
files subdirectory), they are applied
at this time in alphabetical order.The configure target is run.
This can do any one of many different things.If it exists,
scripts/configure is run.If HAS_CONFIGURE or
GNU_CONFIGURE is set,
WRKSRC/configure
is run.If USE_IMAKE is set,
XMKMF (default: xmkmf
-a) is run.The build target is run.
This is responsible for descending into the port's private
working directory (WRKSRC) and building
it. If USE_GMAKE is set, GNU
make will be used, otherwise the system
make will be used.The above are the default actions. In addition, you can
define targets
pre-something
or
post-something,
or put scripts with those names, in the
scripts subdirectory, and they will be
run before or after the default actions are done.For example, if you have a
post-extract target defined in your
Makefile, and a file
pre-build in the
scripts subdirectory, the
post-extract target will be called
after the regular extraction actions, and the
pre-build script will be executed before
the default build rules are done. It is recommended that you
use Makefile 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.The default actions are done by the
bsd.port.mk targets
do-something.
For example, the commands to extract a port are in the target
do-extract. If you are not happy
with the default target, you can fix it by redefining the
do-something
target in your Makefile.The main targets (e.g.,
extract,
configure, 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 do-extract, but never ever
change the way extract
operates! Additionally, the target
post-deinstall is invalid and
is not run by the ports infrastructure.Now that you understand what goes on when the user types
make, let us go through the recommended
steps to create the perfect port.Getting the Original SourcesGet the original sources (normally) as a compressed
tarball
(foo.tar.gz or
foo.tar.bz2)
and copy it into DISTDIR. Always use
mainstream sources when and where you
can.You will need to set the variable
MASTER_SITES to reflect where the original
tarball resides. You will find convenient shorthand
definitions for most mainstream sites in
bsd.sites.mk. 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.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).If you cannot find somewhere convenient and reliable to
put the distfile we can house it ourselves on
ftp.FreeBSD.org; however, this is the
least-preferred solution. The distfile must be placed into
~/public_distfiles/ of someone's
freefall account. Ask the person who commits
your port to do this. This person will also set
MASTER_SITES to
MASTER_SITE_LOCAL and
MASTER_SITE_SUBDIR to their
freefall username.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
MASTER_SITES. 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 checksum
mismatch 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
MASTER_SITES.If your port requires some additional `patches' that are
available on the Internet, fetch them too and put them in
DISTDIR. 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 PATCHFILES
below).Modifying the PortUnpack 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 &os;. Keep
careful track 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.If your port requires significant user
interaction/customization to compile or install, you should
take a look at one of Larry Wall's classic
Configure 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.Unless explicitly stated, patch files, scripts, and
other files you have created and contributed to the &os;
ports collection are assumed to be covered by the standard
BSD copyright conditions.PatchingIn 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
patch-* where
* indicates the pathname of the
file that is patched, such as
patch-Imakefile or
patch-src-config.h. These files should
be stored in PATCHDIR (usually
files/, from where they will be
automatically applied. All patches must be relative to
WRKSRC (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.,
patch-file and
patch-file2 both changing
WRKSRC/foobar.c).
Note that if the path of a patched file contains an underscore
(_) character, the patch needs to have two
underscores instead in its name. For example, to patch a file
named src/freeglut_joystick.c, the
corresponding patch should be named
patch-src-freeglut__joystick.c.Please only use characters
[-+._a-zA-Z0-9] for naming your patches.
Do not use any other characters besides them. Do not name
your patches like patch-aa or
patch-ab etc, always mention the path and
file name in patch names.Do not put RCS strings in patches. SVN 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
($) signs, and typically start with
$Id or
$RCS.Using the recurse () 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, Makefiles when the port
uses Imake or GNU
configure, etc., are unnecessary and should
be deleted. If you had to edit
configure.in and run
autoconf to regenerate
configure, do not take the diffs of
configure (it often grows to a few thousand
lines!); define USE_AUTOTOOLS=autoconf:261
and take the diffs of
configure.in.Also, try to minimize the amount of non-functional
whitespace changes in your patches. It is common in the Open
Source world for projects to share large amounts of a code
base, but obey different style and indenting rules. If you
take a working piece of functionality from one project to fix
similar areas in another, please be careful: the resulting
line patch may be full of non-functional changes. It not only
increases the size of the SVN repository but makes it hard to
find out what exactly caused the problem and what you changed
at all.If you had to delete a file, then you can do it in the
post-extract target rather than as
part of the patch.Simple replacements can be performed directly from the
port Makefile using the in-place mode of
&man.sed.1;. This is very useful when you need to patch in a
variable value. Example:post-patch:
@${REINPLACE_CMD} -e 's|for Linux|for FreeBSD|g' ${WRKSRC}/READMEQuite 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 (/bin/sh^M not found),
etc. To quickly convert all files from CR/LF to just LF, add
USE_DOS2UNIX=yes to the port
Makefile. A list of files to convert can
be specified:USE_DOS2UNIX= util.c util.hIf you want to convert a group of files across
subdirectories, DOS2UNIX_REGEX can be used.
Its argument is a find compatible regular
expression. More on the format is in &man.re.format.7;. This
option is useful for converting all files of a given
extension, for example all source code files leaving binary
files intact:USE_DOS2UNIX= yes
DOS2UNIX_REGEX= .*\.(c|cpp|h)If you want to create a patch file based off of an
existing file, you can copy it with an
.orig extension, and then modify the
original one. The makepatch target
will write out an appropriate patch file to the files directory of the
port.ConfiguringInclude any additional customization commands in your
configure script and save it in the
scripts subdirectory. As mentioned
above, you can also do this with Makefile
targets and/or scripts with the name
pre-configure or
post-configure.Handling User InputIf your port requires user input to build, configure, or
install, you must set IS_INTERACTIVE in
your Makefile. This will allow
overnight builds to skip your port if the user
sets the variable BATCH in his environment (and
if the user sets the variable INTERACTIVE, then
only 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).It is also recommended that if there are reasonable
default answers to the questions, you check the
PACKAGE_BUILDING variable and turn off the
interactive script when it is set. This will allow us to
build the packages for CDROMs and FTP.Configuring the MakefileConfiguring the Makefile is pretty
simple, and again we suggest that you look at existing examples
before starting. Also, there is a sample Makefile 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.Now, consider the following problems in sequence as you
design your new Makefile:The Original SourceDoes it live in DISTDIR as a standard
gzipped tarball named something like
foozolix-1.2.tar.gz? If so, you can go on
to the next step. If not, you should look at overriding any
of the DISTVERSION,
DISTNAME, EXTRACT_CMD,
EXTRACT_BEFORE_ARGS,
EXTRACT_AFTER_ARGS,
EXTRACT_SUFX, or
DISTFILES variables, depending on how alien
a format your port's distribution file is.In the worst case, you can simply create your own
do-extract target to override the
default, though this should be rarely, if ever,
necessary.NamingThe first part of the port's Makefile
names the port, describes its version number, and lists it
in the correct category.PORTNAME and
PORTVERSIONYou should set PORTNAME to the
base name of your port, and PORTVERSION
to the version number of the port.PORTREVISION and
PORTEPOCHPORTREVISIONThe PORTREVISION variable is a
monotonically increasing value which is reset to 0 with
every increase of PORTVERSION (i.e.,
every time a new official vendor release is made), and
appended to the package name if non-zero. Changes to
PORTREVISION are used by automated
tools (e.g., &man.pkg.version.1;) to highlight the fact
that a new package is available.PORTREVISION should be increased
each time a change is made to the port which significantly
affects the content or structure of the derived
package.Examples of when PORTREVISION
should be bumped:Addition of patches to correct security
vulnerabilities, bugs, or to add new functionality to
the port.Changes to the port Makefile
to enable or disable compile-time options in the
package.Changes in the packing list or the install-time
behavior of the package (e.g., change to a script
which generates initial data for the package, like ssh
host keys).Version bump of a port's shared library dependency
(in this case, someone trying to install the old
package after installing a newer version of the
dependency will fail since it will look for the old
libfoo.x instead of libfoo.(x+1)).Silent changes to the port distfile which have
significant functional differences, i.e., changes to
the distfile requiring a correction to
distinfo with no corresponding
change to PORTVERSION, where a
diff -ru of the old and new
versions shows non-trivial changes to the code.Examples of changes which do not require a
PORTREVISION bump:Style changes to the port skeleton with no
functional change to what appears in the resulting
package.Changes to MASTER_SITES or
other functional changes to the port which do not
affect the resulting package.Trivial patches to the distfile such as correction
of typos, which are not important enough that users of
the package should go to the trouble of
upgrading.Build fixes which cause a package to become
compilable where it was previously failing (as long as
the changes do not introduce any functional change on
any other platforms on which the port did previously
build). Since PORTREVISION
reflects the content of the package, if the package
was not previously buildable then there is no need to
increase PORTREVISION to mark a
change.A rule of thumb is to ask yourself whether a change
committed to a port is something which everyone 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
PORTREVISION should be bumped.PORTEPOCHFrom time to time a software vendor or FreeBSD porter
will do something silly and release a version of their
software which is actually numerically less than the
previous version. An example of this is a port which goes
from foo-20000801 to foo-1.0 (the former will be
incorrectly treated as a newer version since 20000801 is a
numerically greater value than 1).The results of version number comparisons are not
always obvious. &man.pkg.version.1; can be used to test
the comparison of two version number strings. The
pkgng equivalent is
pkg version -t. For example:&prompt.user; pkg_version -t 0.031 0.29
>Or, for pkgng
users:&prompt.user; pkg version -t 0.031 0.29
>The > output indicates that
version 0.031 is considered greater than version 0.29,
which may not have been obvious to the porter.In situations such as this, the
PORTEPOCH version should be increased.
If PORTEPOCH is nonzero it is appended
to the package name as described in section 0 above.
PORTEPOCH must never be 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., 1.0,1 in the above
example) is still numerically less than the previous
version (20000801), but the ,1 suffix
is treated specially by automated tools and found to be
greater than the implied suffix ,0 on
the earlier package.Dropping or resetting PORTEPOCH
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.It is expected that PORTEPOCH will
not be used for the majority of ports, and that sensible
use of PORTVERSION can often preempt 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
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
official release is made.For example, if a snapshot release is made on the date
20000917, and the previous version of the software was
version 1.2, the snapshot release should be given a
PORTVERSION of 1.2.20000917 or similar,
not 20000917, so that the succeeding release, say 1.3, is
still a numerically greater value.Example of PORTREVISION and
PORTEPOCH UsageThe gtkmumble port, version
0.10, is committed to the ports
collection:PORTNAME= gtkmumble
PORTVERSION= 0.10PKGNAME becomes
gtkmumble-0.10.A security hole is discovered which requires a local
FreeBSD patch. PORTREVISION is bumped
accordingly.PORTNAME= gtkmumble
PORTVERSION= 0.10
PORTREVISION= 1PKGNAME becomes
gtkmumble-0.10_1A new version is released by the vendor, numbered
0.2 (it turns out the author actually
intended 0.10 to actually mean
0.1.0, not what comes after
0.9 - oops, too late now). Since the new minor
version 2 is numerically less than the
previous version 10, the
PORTEPOCH must be bumped to manually
force the new package to be detected as
newer. Since it is a new vendor release of
the code, PORTREVISION is reset to 0
(or removed from the
Makefile).PORTNAME= gtkmumble
PORTVERSION= 0.2
PORTEPOCH= 1PKGNAME becomes
gtkmumble-0.2,1The next release is 0.3. Since
PORTEPOCH never decreases, the version
variables are now:PORTNAME= gtkmumble
PORTVERSION= 0.3
PORTEPOCH= 1PKGNAME becomes
gtkmumble-0.3,1If PORTEPOCH were reset to
0 with this upgrade, someone who had
installed the gtkmumble-0.10_1
package would not detect the
gtkmumble-0.3 package as newer, since
3 is still numerically less than
10. Remember, this is the whole
point of PORTEPOCH in the first
place.PKGNAMEPREFIX and
PKGNAMESUFFIXTwo optional variables, PKGNAMEPREFIX
and PKGNAMESUFFIX, are combined with
PORTNAME and
PORTVERSION to form
PKGNAME as
${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}.
Make sure this conforms to our guidelines for a good package
name. In particular, you are
not allowed to use a hyphen
(-) in PORTVERSION.
Also, if the package name has the
language- or the
-compiled.specifics part (see
below), use PKGNAMEPREFIX and
PKGNAMESUFFIX, respectively. Do not make
them part of PORTNAME.LATEST_LINKLATEST_LINK is used during package
building to determine a shortened name to create links that
can be used by pkg_add -r. This makes it
possible to, for example, install the latest perl version by
running pkg_add -r perl without knowing
the exact version number. This name needs to be unique and
obvious to users.In some cases, several versions of a program may be
present in the ports collection at the same time. Both the
index build and the package build system need to be able to
see them as different, independent ports, although they may
all have the same PORTNAME,
PKGNAMEPREFIX, and even
PKGNAMESUFFIX. In those cases, the
optional LATEST_LINK variable should be
set to a different value for all ports except the
main one — see the
lang/gcc46 and
lang/gcc ports, and the
www/apache* family for examples of its
use. By setting NO_LATEST_LINK, no link
will be generated, which may be an option for all but the
main version. Note that how to choose a
main version — most
popular, best supported,
least patched, and so on — is outside
the scope of this handbook's recommendations; we only tell
you how to specify the other ports' versions after you have
picked a main one.Package Naming ConventionsThe 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!The package name should look like
language_region-name-compiled.specifics-version.numbers.The package name is defined as
${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}.
Make sure to set the variables to conform to that
format.FreeBSD strives to support the native language of
its users. The language-
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 ja
for Japanese, ru for Russian,
vi for Vietnamese,
zh for Chinese, ko
for Korean and de for German.If the port is specific to a certain region within
the language area, add the two letter country code as
well. Examples are en_US for US
English and fr_CH for Swiss
French.The language- part should
be set in the PKGNAMEPREFIX
variable.The first letter of the name
part should be lowercase. (The rest of the name may
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
p5- and converting the double-colon
separator to a hyphen; for example, the
Data::Dumper module becomes
p5-Data-Dumper.Make sure that the port's name and version are
clearly separated and placed into the
PORTNAME and
PORTVERSION variables. The only
reason for PORTNAME to contain a
version part is if the upstream distribution is really
named that way, as in the
textproc/libxml2 or
japanese/kinput2-freewnn ports.
Otherwise, the PORTNAME should not
contain any version-specific information. It is quite
normal for several ports to have the same
PORTNAME, as the
www/apache* ports do; in that case,
different versions (and different index entries) are
distinguished by the PKGNAMEPREFIX,
PKGNAMESUFFIX, and
LATEST_LINK values.If the port can be built with different hardcoded defaults
(usually part of the directory name in a family of
ports), the
-compiled.specifics part
should state the compiled-in defaults (the hyphen is
optional). Examples are paper size and font
units.The -compiled.specifics
part should be set in the
PKGNAMESUFFIX variable.The version string should follow a dash
(-) 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 pl (meaning
patchlevel), which can be used
only 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.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
0.0.yyyy.mm.dd
format, not
dd.mm.yyyy
or the non-Y2K compliant
yy.mm.dd
format. It is important to prefix the version with
0.0. in case a release with an actual
version number is made, which would of course be
numerically less than
yyyy.Here are some (real) examples on how to convert the name
as called by the software authors to a suitable package
name:Distribution NamePKGNAMEPREFIXPORTNAMEPKGNAMESUFFIXPORTVERSIONReasonmule-2.2.2(empty)mule(empty)2.2.2No changes requiredEmiClock-1.0.2(empty)emiclock(empty)1.0.2No uppercase names for single programsrdist-1.3alpha(empty)rdist(empty)1.3.aNo strings like alpha
allowedes-0.9-beta1(empty)es(empty)0.9.b1No strings like beta
allowedmailman-2.0rc3(empty)mailman(empty)2.0.r3No strings like rc
allowedv3.3beta021.src(empty)tiff(empty)3.3What the heck was that anyway?tvtwm(empty)tvtwm(empty)pl11Version string always requiredpiewm(empty)piewm(empty)1.0Version string always requiredxvgr-2.10pl1(empty)xvgr(empty)2.10.1pl allowed only when no
major/minor version numbersgawk-2.15.6ja-gawk(empty)2.15.6Japanese language versionpsutils-1.13(empty)psutils-letter1.13Paper size hardcoded at package build
timepkfonts(empty)pkfonts3001.0Package for 300dpi fontsIf 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 1.0 (like the
piewm example above). Otherwise, ask the
original author or use the date string
(0.0.yyyy.mm.dd)
as the version.CategorizationCATEGORIESWhen a package is created, it is put under
/usr/ports/packages/All and links are
made from one or more subdirectories of
/usr/ports/packages. The names of
these subdirectories are specified by the variable
CATEGORIES. 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 current list of
categories and pick the ones that are suitable for
your port.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 below for more
discussion about how to pick the right categories.Current List of CategoriesHere is the current list of port categories. Those
marked with an asterisk (*) are
virtual 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.For non-virtual categories, you will find a one-line
description in the COMMENT in that
subdirectory's Makefile.CategoryDescriptionNotesaccessibilityPorts to help disabled users.afterstep*Ports to support the AfterStep
window manager.arabicArabic language support.archiversArchiving tools.astroAstronomical ports.audioSound support.benchmarksBenchmarking utilities.biologyBiology-related software.cadComputer aided design tools.chineseChinese language support.commsCommunication software.Mostly software to talk to your serial
port.convertersCharacter code converters.databasesDatabases.deskutilsThings that used to be on the desktop before
computers were invented.develDevelopment 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.dnsDNS-related software.docs*Meta-ports for FreeBSD documentation.editorsGeneral editors.Specialized editors go in the section for those
tools (e.g., a mathematical-formula editor will go
in math).elisp*Emacs-lisp ports.emulatorsEmulators for other operating systems.Terminal emulators do not
belong here—X-based ones should go to
x11 and text-based ones to
either comms or
misc, depending on the exact
functionality.financeMonetary, financial and related
applications.frenchFrench language support.ftpFTP client and server utilities.If your port speaks both FTP and HTTP, put it
in ftp with a secondary
category of www.gamesGames.geography*Geography-related software.germanGerman language support.gnome*Ports from the GNOME
Project.gnustep*Software related to the GNUstep desktop
environment.graphicsGraphics utilities.hamradio*Software for amateur radio.haskell*Software related to the Haskell
language.hebrewHebrew language support.hungarianHungarian language support.ipv6*IPv6 related software.ircInternet Relay Chat utilities.japaneseJapanese language support.javaSoftware related to the Java™
language.The java category must
not be the only one for a port. Save for ports
directly related to the Java language, porters are
also encouraged not to use java
as the main category of a port.kde*Ports from the KDE
Project.kld*Kernel loadable modules.koreanKorean language support.langProgramming languages.linux*Linux applications and support
utilities.lisp*Software related to the Lisp language.mailMail software.mathNumerical computation software and other
utilities for mathematics.mbone*MBone applications.miscMiscellaneous utilitiesBasically things that do not belong anywhere
else. If at all possible, try to find a better
category for your port than misc,
as ports tend to get overlooked in here.multimediaMultimedia software.netMiscellaneous networking software.net-imInstant messaging software.net-mgmtNetworking management software.net-p2pPeer to peer network applications.newsUSENET news software.palmSoftware support for the Palm™
series.parallel*Applications dealing with parallelism in
computing.pear*Ports related to the Pear PHP
framework.perl5*Ports that require
Perl version 5 to
run.plan9*Various programs from Plan9.polishPolish language support.ports-mgmtPorts for managing, installing and developing
FreeBSD ports and packages.portuguesePortuguese language support.printPrinting software.Desktop publishing tools
(previewers, etc.) belong here too.python*Software related to the Python
language.ruby*Software related to the Ruby
language.rubygems*Ports of RubyGems
packages.russianRussian language support.scheme*Software related to the Scheme
language.scienceScientific ports that do not fit into other
categories such as astro,
biology and
math.securitySecurity utilities.shellsCommand line shells.spanish*Spanish language support.sysutilsSystem utilities.tcl*Ports that use Tcl to run.textprocText processing utilities.It does not include desktop publishing tools,
which go to print.tk*Ports that use Tk to run.ukrainianUkrainian language support.vietnameseVietnamese language support.windowmaker*Ports to support the WindowMaker window
manager.wwwSoftware related to the World Wide Web.HTML language
support belongs here too.x11The X Window System and friends.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 x11-* categories
(see below).x11-clocksX11 clocks.x11-driversX11 drivers.x11-fmX11 file managers.x11-fontsX11 fonts and font utilities.x11-serversX11 servers.x11-themesX11 themes.x11-toolkitsX11 toolkits.x11-wmX11 window managers.xfce*Ports related to the Xfce desktop
environment.zope*Zope
support.Choosing the Right CategoryAs 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:The first category must be a physical category (see
above). This
is necessary to make the packaging work. Virtual
categories and physical categories may be intermixed
after that.Language specific categories always come first. For
example, if your port installs Japanese X11 fonts, then
your CATEGORIES line would read
japanese x11-fonts.Specific categories are listed before less-specific
ones. For instance, an HTML editor should be listed as
www editors, not the other way
around. Also, you should not list
net when the port belongs to any of
irc, mail,
news,
security, or
www, as net is
included implicitly.x11 is used as a secondary
category only when the primary category is a natural
language. In particular, you should not put
x11 in the category line for X
applications.Emacs modes should be
placed in the same ports category as the application
supported by the mode, not in
editors. For example, an
Emacs mode to edit source
files of some programming language should go into
lang.Ports which install loadable kernel modules should
have the virtual category kld in
their CATEGORIES line.misc should not appear with any
other non-virtual category. If you have
misc with something else in your
CATEGORIES line, that means you can
safely delete misc and just put the
port in that other subdirectory!If your port truly does not belong anywhere else,
put it in misc.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.Proposing a New CategoryAs the Ports Collection has grown over time, various new
categories have been introduced. New categories can either
be virtual categories—those that
do not have a corresponding subdirectory in the ports
tree— or physical
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.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.The rationale for this is that such a change creates a
fair
amount of work 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 too
big, nor whether categories should lend themselves
to browsing (and thus what number of categories would be an
ideal number), and so forth.)Here is the procedure: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
GNATS 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.Participate in the discussion.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:Makefiles for the
new ports once they are repocopiedMakefile for the
new categoryMakefile for the
old ports' categoriesMakefiles for ports
that depend on the old ports(for extra credit, you can include the other
files that have to change, as per the procedure
in the Committer's Guide.)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;.If that PR is approved, a committer will need to
follow the rest of the procedure that is
outlined in the Committer's Guide.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 CATEGORIES of the affected
ports.Proposing Reorganizing All the CategoriesOccasionally 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.The Distribution FilesThe second part of the Makefile
describes the files that must be downloaded in order to build
the port, and where they can be downloaded from.DISTVERSION/DISTNAMEDISTNAME is the name of the port as
called by the authors of the software.
DISTNAME defaults to
${PORTNAME}-${PORTVERSION}, so override
it only if necessary. DISTNAME is only
used in two places. First, the distribution file list
(DISTFILES) defaults to
${DISTNAME}${EXTRACT_SUFX}.
Second, the distribution file is expected to extract into a
subdirectory named WRKSRC, which defaults
to
work/${DISTNAME}.Some vendor's distribution names which do not fit into
the ${PORTNAME}-${PORTVERSION}-scheme can
be handled automatically by setting
DISTVERSION.
PORTVERSION and
DISTNAME will be derived automatically,
but can of course be overridden. The following table lists
some examples:DISTVERSIONPORTVERSION0.7.1d0.7.1.d10Alpha310.a33Beta7-pre23.b7.p28:f_178f.17PKGNAMEPREFIX and
PKGNAMESUFFIX do not affect
DISTNAME. Also note that if
WRKSRC is equal to
work/${PORTNAME}-${PORTVERSION}
while the original source archive is named something other
than
${PORTNAME}-${PORTVERSION}${EXTRACT_SUFX},
you should probably leave DISTNAME
alone— you are better off defining
DISTFILES than having to set both
DISTNAME and WRKSRC
(and possibly EXTRACT_SUFX).MASTER_SITESRecord the directory part of the FTP/HTTP-URL pointing
at the original tarball in MASTER_SITES.
Do not forget the trailing slash
(/)!The make macros will try to use this
specification for grabbing the distribution file with
FETCH if they cannot find it already on
the system.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.If the original tarball is part of one of the popular
archives such as SourceForge, GNU, or Perl CPAN, you may be
able refer to those sites in an easy compact form using
MASTER_SITE_*
(e.g., MASTER_SITE_SOURCEFORGE,
MASTER_SITE_GNU and
MASTER_SITE_PERL_CPAN). Simply set
MASTER_SITES to one of these variables
and MASTER_SITE_SUBDIR to the path within
the archive. Here is an example:MASTER_SITES= ${MASTER_SITE_GNU}
MASTER_SITE_SUBDIR= makeOr you can use a condensed format:MASTER_SITES= GNU/makeThese variables are defined in
/usr/ports/Mk/bsd.sites.mk. There are
new entries added all the time, so make sure to check the
latest version of this file before submitting a port.Several magic macros exist for
popular sites with a predictable directory structure. For
these, just use the abbreviation and the system will try to
guess the correct subdirectory for you.MASTER_SITES= SFIf the guess is incorrect, it can be overridden as
follows.MASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION}This can be also written asMASTER_SITES= SF
MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}
Popular Magic MASTER_SITES
MacrosMacroAssumed subdirectoryAPACHE_JAKARTA/dist/jakarta/${PORTNAME:S,-,,/,}/sourceBERLIOS/${PORTNAME:L}CHEESESHOP/packages/source/source/${DISTNAME:C/(.).*/\1/}/${DISTNAME:C/(.*)-[0-9].*/\1/}DEBIAN/debian/pool/main/${PORTNAME:C/^((lib)?.).*$/\1/}/${PORTNAME}GCC/pub/gcc/releases/${DISTNAME}GNOME/pub/GNOME/sources/${PORTNAME}/${PORTVERSION:C/^([0-9]+\.[0-9]+).*/\1/}GNU/gnu/${PORTNAME}MOZDEV/pub/mozdev/${PORTNAME:L}PERL_CPAN/pub/CPAN/modules/by-module/${PORTNAME:C/-.*//}PYTHON/ftp/python/${PYTHON_PORTVERSION:C/rc[0-9]//}RUBYFORGE/${PORTNAME:L}SAVANNAH/${PORTNAME:L}SF/project/${PORTNAME:L}/${PORTNAME:L}/${PORTVERSION}
EXTRACT_SUFXIf you have one distribution file, and it uses an odd
suffix to indicate the compression mechanism, set
EXTRACT_SUFX.For example, if the distribution file was named
foo.tgz instead of the more normal
foo.tar.gz, you would write:DISTNAME= foo
EXTRACT_SUFX= .tgzThe USE_BZIP2,
USE_XZ and
USE_ZIP variables automatically set
EXTRACT_SUFX to
.tar.bz2, .tar.xz
or .zip as necessary. If neither of
these are set then EXTRACT_SUFX
defaults to .tar.gz.You never need to set both
EXTRACT_SUFX and
DISTFILES.DISTFILESSometimes the names of the files to be downloaded have
no resemblance to the name of the port. For example, it
might be called source.tar.gz or
similar. In other cases the application's source code might
be in several different archives, all of which must be
downloaded.If this is the case, set DISTFILES to
be a space separated list of all the files that must be
downloaded.DISTFILES= source1.tar.gz source2.tar.gzIf not explicitly set, DISTFILES
defaults to
${DISTNAME}${EXTRACT_SUFX}.EXTRACT_ONLYIf only some of the DISTFILES 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
EXTRACT_ONLY.DISTFILES= source.tar.gz manual.html
EXTRACT_ONLY= source.tar.gzIf none of the
DISTFILES should be uncompressed then set
EXTRACT_ONLY to the empty string.EXTRACT_ONLY=PATCHFILESIf your port requires some additional patches that are
available by FTP or HTTP, set PATCHFILES
to the names of the files and PATCH_SITES
to the URL of the directory that contains them (the format
is the same as MASTER_SITES).If the patch is not relative to the top of the source
tree (i.e., WRKSRC) because it contains
some extra pathnames, set
PATCH_DIST_STRIP accordingly. For
instance, if all the pathnames in the patch have an extra
foozolix-1.0/ in front of the filenames,
then set PATCH_DIST_STRIP=-p1.Do not worry if the patches are compressed; they will be
decompressed automatically if the filenames end with
.gz or .Z.If the patch is distributed with some other files, such
as documentation, in a gzipped tarball,
you cannot just use PATCHFILES. If that
is the case, add the name and the location of the patch
tarball to DISTFILES and
MASTER_SITES. Then, use the
EXTRA_PATCHES variable to point to those
files and bsd.port.mk will
automatically apply them for you. In particular, do
not copy patch files into the
PATCHDIR directory—that directory
may not be writable.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 gzipped
or compressed 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
pre-clean target.Multiple Distribution Files or Patches from Different
Sites and Subdirectories
(MASTER_SITES:n)(Consider this to be a somewhat advanced
topic; those new to this document may wish to skip
this section at first).This section has information on the fetching mechanism
known as both MASTER_SITES:n and
MASTER_SITES_NN. We will refer to this
mechanism as MASTER_SITES:n.A little background first. OpenBSD has a neat feature
inside the DISTFILES and
PATCHFILES variables which allows files
and patches to be postfixed with :n
identifiers. Here, n can be both
[0-9] and denote a group designation.
For example:DISTFILES= alpha:0 beta:1In OpenBSD, distribution file alpha
will be associated with variable
MASTER_SITES0 instead of our common
MASTER_SITES and
beta with
MASTER_SITES1.This is a very interesting feature which can decrease
that endless search for the correct download site.Just picture 2 files in DISTFILES and
20 sites in MASTER_SITES, the sites slow
as hell where beta is carried by all
sites in MASTER_SITES, and
alpha can only be found in the 20th
site. It would be such a waste to check all of them if the
maintainer knew this beforehand, would it not? Not a good
start for that lovely weekend!Now that you have the idea, just imagine more
DISTFILES and more
MASTER_SITES. Surely our
distfiles survey meister would appreciate the
relief to network strain that this would bring.In the next sections, information will follow on the
FreeBSD implementation of this idea. We improved a bit on
OpenBSD's concept.Simplified InformationThis 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
MASTER_SITES:n usage. This will be
sufficient for most scenarios. However, if you need
further information, you will have to refer to the next
section.Some applications consist of multiple distribution
files that must be downloaded from a number of different
sites. For example,
Ghostscript 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.To support this, each entry in
DISTFILES may be followed by a colon
and a tag name. Each site listed in
MASTER_SITES is then followed by a
colon, and the tag that indicates which distribution files
should be downloaded from this site.For example, consider an application with the source
split in two parts, source1.tar.gz
and source2.tar.gz, which must be
downloaded from two different sites. The port's
Makefile would include lines like
.Simplified Use of MASTER_SITES:n
with One File Per SiteMASTER_SITES= ftp://ftp.example1.com/:source1 \
ftp://ftp.example2.com/:source2
DISTFILES= source1.tar.gz:source1 \
source2.tar.gz:source2Multiple distribution files can have the same tag.
Continuing the previous example, suppose that there was a
third distfile, source3.tar.gz, that
should be downloaded from
ftp.example2.com. The
Makefile would then be written like
.Simplified Use of MASTER_SITES:n
with More Than One File Per SiteMASTER_SITES= ftp://ftp.example1.com/:source1 \
ftp://ftp.example2.com/:source2
DISTFILES= source1.tar.gz:source1 \
source2.tar.gz:source2 \
source3.tar.gz:source2Detailed InformationOkay, so the previous section example did not reflect
your needs? In this section we will explain in detail
how the fine grained fetching mechanism
MASTER_SITES:n works and how you can
modify your ports to use it.Elements can be postfixed with
:n where
n is
[^:,]+, i.e.,
n could conceptually be any
alphanumeric string but we will limit it to
[a-zA-Z_][0-9a-zA-Z_]+ for
now.Moreover, string matching is case sensitive;
i.e., n is different from
N.However, the following words cannot be used for
postfixing purposes since they yield special meaning:
default, all and
ALL (they are used internally in
item ).
Furthermore, DEFAULT is a special
purpose word (check item ).Elements postfixed with :n
belong to the group n,
:m belong to group
m and so forth.Elements without a postfix are groupless, i.e.,
they all belong to the special group
DEFAULT. If you postfix any
elements with DEFAULT, you are just
being redundant unless you want to have an element
belonging to both DEFAULT and other
groups at the same time (check item ).The following examples are equivalent but the
first one is preferred:MASTER_SITES= alphaMASTER_SITES= alpha:DEFAULTGroups 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.When you want an element to belong to several
groups at the same time, you can use the comma
operator (,).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,
:m,n,o marks an element that
belongs to group m,
n and o.All the following examples are equivalent but the
last one is preferred:MASTER_SITES= alpha alpha:SOME_SITEMASTER_SITES= alpha:DEFAULT alpha:SOME_SITEMASTER_SITES= alpha:SOME_SITE,DEFAULTMASTER_SITES= alpha:DEFAULT,SOME_SITEAll sites within a given group are sorted
according to MASTER_SORT_AWK. All
groups within MASTER_SITES and
PATCH_SITES are sorted as
well.Group semantics can be used in any of the
following variables MASTER_SITES,
PATCH_SITES,
MASTER_SITE_SUBDIR,
PATCH_SITE_SUBDIR,
DISTFILES, and
PATCHFILES according to the
following syntax:All MASTER_SITES,
PATCH_SITES,
MASTER_SITE_SUBDIR and
PATCH_SITE_SUBDIR elements must
be terminated with the forward slash
/ character. If any elements
belong to any groups, the group postfix
:n
must come right after the terminator
/. The
MASTER_SITES:n mechanism relies
on the existence of the terminator
/ to avoid confusing elements
where a :n is a valid part of
the element with occurrences where
:n denotes group
n. For compatibility purposes,
since the / terminator was not
required before in both
MASTER_SITE_SUBDIR and
PATCH_SITE_SUBDIR elements, if
the postfix immediate preceding character is not
a / then :n
will be considered a valid part of the element
instead of a group postfix even if an element is
postfixed with :n. See both
and .Detailed Use of
MASTER_SITES:n in
MASTER_SITE_SUBDIRMASTER_SITE_SUBDIR= old:n new/:NEWDirectories within group
DEFAULT ->
old:nDirectories within group
NEW -> newDetailed Use of
MASTER_SITES:n with Comma
Operator, Multiple Files, Multiple Sites and
Multiple SubdirectoriesMASTER_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 \
directoryThe previous example results in the
following fine grained fetching. Sites are
listed in the exact order they will be
used.file1 will be
fetched fromMASTER_SITE_OVERRIDEhttp://site1/directory-trial:1/http://site1/directory-one/http://site1/directory/http://site2/http://site7/MASTER_SITE_BACKUPfile2 will be
fetched exactly as
file1 since they
both belong to the same groupMASTER_SITE_OVERRIDEhttp://site1/directory-trial:1/http://site1/directory-one/http://site1/directory/http://site2/http://site7/MASTER_SITE_BACKUPfile3 will be
fetched fromMASTER_SITE_OVERRIDEhttp://site3/MASTER_SITE_BACKUPfile4 will be
fetched fromMASTER_SITE_OVERRIDEhttp://site4/http://site5/http://site6/http://site7/http://site8/directory-one/MASTER_SITE_BACKUPfile5 will be
fetched fromMASTER_SITE_OVERRIDEMASTER_SITE_BACKUPfile6 will be
fetched fromMASTER_SITE_OVERRIDEhttp://site8/MASTER_SITE_BACKUPHow do I group one of the special variables from
bsd.sites.mk, e.g.,
MASTER_SITE_SOURCEFORGE?See .Detailed Use of
MASTER_SITES:n with
MASTER_SITE_SOURCEFORGEMASTER_SITES= http://site1/ ${MASTER_SITE_SOURCEFORGE:S/$/:sourceforge,TEST/}
DISTFILES= something.tar.gz:sourceforgesomething.tar.gz will be
fetched from all sites within
MASTER_SITE_SOURCEFORGE.How do I use this with PATCH*
variables?All examples were done with
MASTER* variables but they work
exactly the same for PATCH* ones as
can be seen in .Simplified Use of
MASTER_SITES:n with
PATCH_SITESPATCH_SITES= http://site1/ http://site2/:test
PATCHFILES= patch1:testWhat Does Change for Ports? What Does Not?All current ports remain the same. The
MASTER_SITES:n feature code is only
activated if there are elements postfixed with
:n like
elements according to the aforementioned syntax rules,
especially as shown in item .The port targets remain the same:
checksum,
makesum,
patch,
configure,
build, etc. With the obvious
exceptions of do-fetch,
fetch-list,
master-sites and
patch-sites.do-fetch: deploys the
new grouping postfixed
DISTFILES and
PATCHFILES with their matching
group elements within both
MASTER_SITES and
PATCH_SITES which use matching
group elements within both
MASTER_SITE_SUBDIR and
PATCH_SITE_SUBDIR. Check .fetch-list: works
like old fetch-list with
the exception that it groups just like
do-fetch.master-sites and
patch-sites:
(incompatible with older versions) only return the
elements of group DEFAULT; in
fact, they execute targets
master-sites-default and
patch-sites-default
respectively.Furthermore, using target either
master-sites-all or
patch-sites-all is
preferred to directly checking either
MASTER_SITES or
PATCH_SITES. Also,
directly checking is not guaranteed to work in any
future versions. Check item
for more information on these new port
targets.New port targetsThere are
master-sites-n
and
patch-sites-n
targets which will list the elements of the
respective group n
within MASTER_SITES and
PATCH_SITES respectively. For
instance, both
master-sites-DEFAULT and
patch-sites-DEFAULT will
return the elements of group
DEFAULT,
master-sites-test and
patch-sites-test of group
test, and thereon.There are new targets
master-sites-all and
patch-sites-all which do
the work of the old
master-sites and
patch-sites 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
MASTER_SITE_BACKUP and
MASTER_SITE_OVERRIDE as there
are groups defined within either
DISTFILES or
PATCHFILES; respectively for
master-sites-all and
patch-sites-all.DIST_SUBDIRDo not let your port clutter
/usr/ports/distfiles. 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.,
Makefile), set
DIST_SUBDIR to the name of the port
(${PORTNAME} or
${PKGNAMEPREFIX}${PORTNAME} should work
fine). This will change DISTDIR from the
default /usr/ports/distfiles to
/usr/ports/distfiles/DIST_SUBDIR,
and in effect puts everything that is required for your port
into that subdirectory.It will also look at the subdirectory with the same name
on the backup master site at
ftp.FreeBSD.org. (Setting
DISTDIR explicitly in your
Makefile will not accomplish this, so
please use DIST_SUBDIR.)This does not affect the
MASTER_SITES you define in your
Makefile.ALWAYS_KEEP_DISTFILESIf 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,
ALWAYS_KEEP_DISTFILES will instruct the
&os; build cluster to keep a copy of the files specified in
DISTFILES. Users of these ports will
generally not need these files, so it is a good idea to only
add the source distfiles to DISTFILES
when PACKAGE_BUILDING is defined.Use of
ALWAYS_KEEP_DISTFILES.if defined(PACKAGE_BUILDING)
DISTFILES+= foo.tar.gz
ALWAYS_KEEP_DISTFILES= yes
.endifWhen adding extra files to DISTFILES,
make sure you also add them to
distinfo. Also, the additional files
will normally be extracted into WRKDIR as
well, which for some ports may lead to undesirable side
effects and require special handling.MAINTAINERSet your mail-address here. Please. :-)Note that only a single address without the comment part
is allowed as a MAINTAINER value. The
format used should be user@hostname.domain.
Please do not include any descriptive text such as your real
name in this entry—that merely confuses
bsd.port.mk.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 The
challenge for port maintainers section.Changes to the port will be sent to the maintainer of a
port for review and 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.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 the maintainer's consent. These kinds of
changes will never affect the port's functionality.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.COMMENTThis is a one-line description of the port.
Please respect the following rules:Try to keep the COMMENT value at no longer than 70
characters, as this line will be used by the
&man.pkg.info.1; utility to display a one-line summary
of the port;Do not include the package
name (or version number of the software);The comment should begin with a capital and end
without a period;Do not start with an indefinite article (i.e.,
A or An);Names are capitalized (for example, Apache,
JavaScript, Perl);For lists of words, use the Oxford comma (e.g.,
green, red, and blue);Spell check the text.Here is an example:COMMENT= Cat chasing a mouse all over the screenThe COMMENT variable should immediately follow the
MAINTAINER variable in the
Makefile.PORTSCOUTPortscout is an automated
distfile check utility for the &os; Ports Collection,
described in detail in
.The PORTSCOUT variable defines
special conditions within which the
Portscout distfile
scanner should be restricted.Situations where the PORTSCOUT
variable should be set include:When distfiles should be ignored, whether for
specific versions, or specific minor revisions. For
example, to exclude version
8.2 from distfile version
checks because it is known to be broken, add:PORTSCOUT= ignore:8.2When specific versions or specific major and minor
revisions of a distfile should be checked. For
example, if only version
0.6.4 should be monitored
because newer versions have compatablity issues with
&os;, add:PORTSCOUT= limit:^0\.6\.4When URLs listing the available versions differ
from the download URLs. For example, to limit
distfile version checks to the download page for the
databases/pgtune
port, add:PORTSCOUT= site:http://pgfoundry.org/frs/?group_id=1000416DependenciesMany ports depend on other ports. This is a very
convenient feature of most Unix-like operating systems,
including &os;. Multiple ports can share a common dependency,
rather than bundling that dependency with every port or
package that needs it. There are seven variables that can be
used 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.LIB_DEPENDSThis variable specifies the shared libraries this port
depends on. It is a list of
lib:dir:target
tuples where lib is the name of
the shared library, dir is the
directory in which to find it in case it is not available,
and target is the target to call
in that directory. For example,LIB_DEPENDS= jpeg:${PORTSDIR}/graphics/jpegwill check for a shared jpeg library with any version,
and descend into the
graphics/jpeg subdirectory of your
ports tree to build and install it if it is not found. The
target part can be omitted if it
is equal to DEPENDS_TARGET (which
defaults to install).The lib part is a regular
expression which is being looked up in the
ldconfig -r output. Values such as
intl.9 and
intl.[5-7] are allowed. The first
pattern, intl.9, will match only
version 9 of intl, while intl.[5-7],
will match any of: intl.5,
intl.6 or
intl.7.The dependency is checked twice, once from within the
extract target and then from within
the install 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.RUN_DEPENDSThis variable specifies executables or files this port
depends on during run-time. It is a list of
path:dir:target
tuples where path is the name of
the executable or file, dir is
the directory in which to find it in case it is not
available, and target is the
target to call in that directory. If
path starts with a slash
(/), it is treated as a file and its
existence is tested with test -e;
otherwise, it is assumed to be an executable, and
which -s is used to determine if the
program exists in the search path.For example,RUN_DEPENDS= ${LOCALBASE}/news/bin/innd:${PORTSDIR}/news/inn \
xmlcatmgr:${PORTSDIR}/textproc/xmlcatmgrwill check if the file or directory
/usr/local/news/bin/innd exists, and
build and install it from the news/inn
subdirectory of the ports tree if it is not found. It will
also see if an executable called
xmlcatmgr is in the search path, and
descend into the textproc/xmlcatmgr
subdirectory of your ports tree to build and install it if
it is not found.In this case, innd 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.The official search PATH used on the
ports build cluster is/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/binThe dependency is checked from within the
install 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 target
part can be omitted if it is the same as
DEPENDS_TARGET.A quite common situation is when
RUN_DEPENDS is literally the same as
BUILD_DEPENDS, especially if ported
software is written in a scripted language or if it requires
the same build and run-time environment. In this
case, it is both tempting and intuitive to directly
assign one to the other:RUN_DEPENDS= ${BUILD_DEPENDS}However, such assignment can pollute run-time
dependencies with entries not defined in the port's original
BUILD_DEPENDS. This happens because of
&man.make.1;'s lazy evaluation of variable assignment.
Consider a Makefile with
USE_*
variables, which are processed by
ports/Mk/bsd.*.mk to augment initial
build dependencies. For example,
USE_GMAKE=yes adds devel/gmake to
BUILD_DEPENDS. To prevent such
additional dependencies from polluting
RUN_DEPENDS, take care to assign with
expansion, i.e., expand the value before assigning it to the
variable:RUN_DEPENDS:= ${BUILD_DEPENDS}BUILD_DEPENDSThis variable specifies executables or files this port
requires to build. Like RUN_DEPENDS, it
is a list of
path:dir:target
tuples. For example,BUILD_DEPENDS= unzip:${PORTSDIR}/archivers/unzipwill check for an executable called
unzip, and descend into the
archivers/unzip subdirectory of your
ports tree to build and install it if it is not
found.build here means everything from
extraction to compilation. The dependency is checked from
within the extract target. The
target part can be omitted if
it is the same as DEPENDS_TARGETFETCH_DEPENDSThis variable specifies executables or files this port
requires to fetch. Like the previous two, it is a list of
path:dir:target
tuples. For example,FETCH_DEPENDS= ncftp2:${PORTSDIR}/net/ncftp2will check for an executable called
ncftp2, and descend into the
net/ncftp2 subdirectory of your ports
tree to build and install it if it is not found.The dependency is checked from within the
fetch target. The
target part can be omitted if it
is the same as DEPENDS_TARGET.EXTRACT_DEPENDSThis variable specifies executables or files this port
requires for extraction. Like the previous, it is a list of
path:dir:target
tuples. For example,EXTRACT_DEPENDS= unzip:${PORTSDIR}/archivers/unzipwill check for an executable called
unzip, and descend into the
archivers/unzip subdirectory of your
ports tree to build and install it if it is not
found.The dependency is checked from within the
extract target. The
target part can be omitted if it
is the same as DEPENDS_TARGET.Use this variable only if the extraction does not
already work (the default assumes gzip)
and cannot be made to work using
USE_ZIP or USE_BZIP2
described in .PATCH_DEPENDSThis variable specifies executables or files this port
requires to patch. Like the previous, it is a list of
path:dir:target
tuples. For example,PATCH_DEPENDS= ${NONEXISTENT}:${PORTSDIR}/java/jfc:extractwill descend into the java/jfc
subdirectory of your ports tree to extract it.The dependency is checked from within the
patch target. The
target part can be omitted if it
is the same as DEPENDS_TARGET.USESThere several parameters exist for defining different
kind of features and dependencies that the port in question
uses. They can be specified by adding the following line to
the Makefile of the port:USES= feature[:arguments]For the complete list of such values, please see .USES cannot be assigned after
inclusion of bsd.port.pre.mk.USE_*Several variables exist to define
common dependencies shared by many ports. Their
use is optional, but helps to reduce the verbosity of
the port Makefiles. Each of them is
styled as
USE_*.
These variables may be used only in the port
Makefiles and
ports/Mk/bsd.*.mk. They are not meant
for user-settable options — use
PORT_OPTIONS for that purpose.It is always incorrect to set any
USE_* in
/etc/make.conf. For instance,
settingUSE_GCC=3.4would add a dependency on gcc34 for every port,
including gcc34 itself!
The
USE_*
VariablesVariableMeansUSE_BZIP2The port's tarballs are compressed with
bzip2.USE_ZIPThe port's tarballs are compressed with
zip.USE_GCCThe port requires a specific version of
gcc to build. The exact version
can be specified with value such as
3.4. The minimal required
version can be specified as 3.4+.
The gcc from the base system is
used when it satisfies the requested version,
otherwise an appropriate gcc is
compiled from ports and the CC
and CXX variables are
adjusted.
Variables related to gmake
and the configure script are described
in , while
autoconf,
automake and
libtool are described in
.
Perl related variables are
described in . X11 variables
are listed in .
deals with GNOME and
with KDE related variables.
documents Java variables, while
contains information on
Apache,
PHP and PEAR modules.
Python is discussed in
, while
Ruby in
.
provides variables used for SDL
applications and finally,
contains information on
Xfce.Minimal Version of a DependencyA minimal version of a dependency can be specified in
any *_DEPENDS variable except
LIB_DEPENDS using the following
syntax:p5-Spiffy>=0.26:${PORTSDIR}/devel/p5-SpiffyThe 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.Notes on DependenciesAs mentioned above, the default target to call when a
dependency is required is
DEPENDS_TARGET. It defaults to
install. This is a user variable; it is
never defined in a port's Makefile. If
your port needs a special way to handle a dependency, use
the :target part of the
*_DEPENDS variables instead of redefining
DEPENDS_TARGET.When you type make clean, its
dependencies are automatically cleaned too. If you do not
wish this to happen, define the variable
NOCLEANDEPENDS 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.To depend on another port unconditionally, use the
variable ${NONEXISTENT} as the first
field of BUILD_DEPENDS or
RUN_DEPENDS. 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
instanceBUILD_DEPENDS= ${NONEXISTENT}:${PORTSDIR}/graphics/jpeg:extractwill always descend to the jpeg port
and extract it.Circular Dependencies Are FatalDo not introduce any circular dependencies into the
ports tree!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: cd /usr/ports; make index.
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.Problems Caused by Automatic DependenciesDependencies must be declared either explicitly or by
using the OPTIONS framework.
Using other methods like automatic detection complicates
indexing, which causes problems for port and package
management.Wrong Declaration of an Optional Dependency.include <bsd.port.pre.mk>
.if exists(${LOCALBASE}/bin/foo)
LIB_DEPENDS= bar:${PORTSDIR}/foo/bar
.endifThe problem with trying to automatically add
dependencies is that files and settings outside an
individual port can change at any time. For example: an
index is built, then a batch of ports are installed. But
one of the ports installs the tested file. The index is now
incorrect, because an installed port unexpectedly has a new
dependency. The index may still be wrong even after
rebuilding if other ports also determine their need for
dependencies based on the existence of other files.Correct Declaration of an Optional DependencyOPTIONS_DEFINE= BAR
BAR_DESC= Bar support
.include <bsd.port.options.mk>
.if ${PORT_OPTIONS:MBAR}
LIB_DEPENDS= bar:${PORTSDIR}/foo/bar
.endifTesting option variables is the correct method. It will
not cause inconsistencies in the index of a batch of ports,
provided the options were defined prior to the index build.
Simple scripts can then be used to automate the building,
installation, and updating of these ports and their
packages.USE_ and
WANT_USE_ variables are set by the port
maintainer to define software on which this port depends. A
port that needs Firefox would setUSE_FIREFOX= yesSome USE_ variables can accept
version numbers or other parameters. For example, a port
that requires Apache 2.2 would setUSE_APACHE= 22For more control over dependencies in some cases,
WANT_ variables are available to more
precisely specify what is needed. For example, consider the
mail/squirrelmail port.
This port needs some PHP modules, which are listed in the
USE_PHP variable:USE_PHP= session mhash gettext mbstring pcre openssl xmlThose modules may be available in CLI or web versions,
so the web version is selected with a
WANT_ variable:WANT_PHP_WEB= yesAvailable USE_ and
WANT_ variables are defined in the files
in /usr/ports/Mk.MASTERDIRIf 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 Makefile in
all but one of the directories if you use variables cleverly.
In the sole Makefile, you can use
MASTERDIR to specify the directory where
the rest of the files are. Also, use a variable as part of
PKGNAMESUFFIX
so the packages will have different names.This will be best demonstrated by an example. This is
part of japanese/xdvi300/Makefile;PORTNAME= xdvi
PORTVERSION= 17
PKGNAMEPREFIX= ja-
PKGNAMESUFFIX= ${RESOLUTION}
:
# default
RESOLUTION?= 300
.if ${RESOLUTION} != 118 && ${RESOLUTION} != 240 && \
${RESOLUTION} != 300 && ${RESOLUTION} != 400
@${ECHO_MSG} "Error: invalid value for RESOLUTION: \"${RESOLUTION}\""
@${ECHO_MSG} "Possible values are: 118, 240, 300 (default) and 400."
@${FALSE}
.endifjapanese/xdvi300 also
has all the regular patches, package files, etc. If you type
make there, it will take the default value
for the resolution (300) and build the port normally.As for other resolutions, this is the
entirexdvi118/Makefile:RESOLUTION= 118
MASTERDIR= ${.CURDIR}/../xdvi300
.include "${MASTERDIR}/Makefile"(xdvi240/Makefile and
xdvi400/Makefile are similar). The
MASTERDIR definition tells
bsd.port.mk that the regular set of
subdirectories like FILESDIR and
SCRIPTDIR are to be found under
xdvi300. The
RESOLUTION=118 line will override the
RESOLUTION=300 line in
xdvi300/Makefile and the port will be
built with resolution set to 118.Man PagesThe MAN[1-9LN] variables will
automatically add any manpages to
pkg-plist (this means you must
not list manpages in the
pkg-plist—see generating PLIST for more). It
also makes the install stage automatically compress or
uncompress manpages depending on the setting of
NO_MANCOMPRESS in
/etc/make.conf.If your port tries to install multiple names for manpages
using symlinks or hardlinks, you must use the
MLINKS variable to identify these. The
link installed by your port will be destroyed and recreated by
bsd.port.mk to make sure it points to the
correct file. Any manpages listed in MLINKS must not be
listed in the pkg-plist.To specify whether the manpages are compressed upon
installation, use the MANCOMPRESSED
variable. This variable can take three values,
yes, no and
maybe. yes means
manpages are already installed compressed,
no means they are not, and
maybe means the software already respects
the value of NO_MANCOMPRESS so
bsd.port.mk does not have to do anything
special.MANCOMPRESSED is automatically set to
yes if USE_IMAKE is set
and NO_INSTALL_MANPAGES is not set, and to
no otherwise. You do not have to
explicitly define it unless the default is not suitable for
your port.If your port anchors its man tree somewhere other than
PREFIX, you can use the
MANPREFIX 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
MANsectPREFIX
(where sect is one of
1-9, L or
N).If your manpages go to language-specific subdirectories,
set the name of the languages to MANLANG.
The value of this variable defaults to ""
(i.e., English only).Here is an example that puts it all together.MAN1= foo.1
MAN3= bar.3
MAN4= baz.4
MLINKS= foo.1 alt-name.8
MANLANG= "" ja
MAN3PREFIX= ${PREFIX}/share/foobar
MANCOMPRESSED= yesThis states that six files are installed by this
port;${MANPREFIX}/man/man1/foo.1.gz
${MANPREFIX}/man/ja/man1/foo.1.gz
${PREFIX}/share/foobar/man/man3/bar.3.gz
${PREFIX}/share/foobar/man/ja/man3/bar.3.gz
${MANPREFIX}/man/man4/baz.4.gz
${MANPREFIX}/man/ja/man4/baz.4.gzAdditionally
${MANPREFIX}/man/man8/alt-name.8.gz 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.If only some manpages are translated, you can use several
variables dynamically created from MANLANG
content:MANLANG= "" de ja
MAN1= foo.1
MAN1_EN= bar.1
MAN3_DE= baz.3This translates into this list of files:${MANPREFIX}/man/man1/foo.1.gz
${MANPREFIX}/man/de/man1/foo.1.gz
${MANPREFIX}/man/ja/man1/foo.1.gz
${MANPREFIX}/man/man1/bar.1.gz
${MANPREFIX}/man/de/man3/baz.3.gzInfo FilesIf your package needs to install GNU info files, they
should be listed in the INFO variable
(without the trailing .info), one entry per
document. These files are assumed to be installed to
PREFIX/INFO_PATH.
You can change INFO_PATH if your package
uses a different location. However, this is not recommended.
These entries contain just the path relative to
PREFIX/INFO_PATH.
For example, lang/gcc34
installs info files to
PREFIX/INFO_PATH/gcc34,
and INFO will be something like
this:INFO= gcc34/cpp gcc34/cppinternals gcc34/g77 ...Appropriate installation/de-installation code will be
automatically added to the temporary
pkg-plist before package
registration.Makefile OptionsMany applications can be built with optional or differing
configurations. Examples include choice of natural (human)
language, GUI versus command-line, or type of database to
support. Users may need a different configuration than the
default, so the ports system provides hooks the port author
can use to control which variant will be built. Supporting
these options properly will make users happy, and effectively
provide two or more ports for the price of one.KnobsWITH_*
and
WITHOUT_*These variables are designed to be set by the system
administrator. There are many that are standardized in
the ports/KNOBS
file.When creating a port, do not make knob names specific
to a given application. For example in Avahi port, use
WITHOUT_MDNS instead of
WITHOUT_AVAHI_MDNS.You should not assume that a
WITH_*
necessarily has a corresponding
WITHOUT_*
variable and vice versa. In general, the default is
simply assumed.Unless otherwise specified, these variables are only
tested for being set or not set, rather than being set
to a specific value such as YES
or NO.
Common
WITH_* and
WITHOUT_*
VariablesVariableMeansWITHOUT_NLSIf set, says that internationalization is not
needed, which can save compile time. By default,
internationalization is used.WITH_OPENSSL_BASEUse the version of OpenSSL in the base
system.WITH_OPENSSL_PORTInstalls the version of OpenSSL from
security/openssl, even
if the base is up to date.WITHOUT_X11Ports that can be built both with and
without X support are normally
built with X support. If this variable is
defined, then the version that does not have X
support will be built instead.
Knob NamingPorters should use like-named knobs, both
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 KNOBS
file.Knob names should reflect what the knob is and does.
When a port has a lib-prefix in the
PORTNAME the lib-prefix should be
dropped in knob naming.OPTIONSBackgroundThe OPTIONS_* variables give the
user installing the port a dialog showing the available
options, and then saves those options to
/var/db/ports/${UNIQUENAME}/options.
The next time the port is built, the options are
reused.When the user runs make config (or
runs make build for the first time),
the framework checks for
/var/db/ports/${UNIQUENAME}/options.
If that file does not exist, the values of
OPTIONS_* are used, and a dialog box is
displayed where the options can be enabled or disabled.
Then the options file is saved and
the configured variables are used when building the
port.If a new version of the port adds new
OPTIONS, the dialog will be presented
to the user with the saved values of old
OPTIONS prefilled.make showconfig shows the
saved configuration. Use make rmconfig
to remove the saved configuration.SyntaxOPTIONS_DEFINE contains a list of
OPTIONS to be used. These are
independent of each other and are not grouped:OPTIONS_DEFINE= OPT1 OPT2Once defined, OPTIONS are
described (optional, but strongly recommended):OPT1_DESC= Describe OPT1
OPT2_DESC= Describe OPT2
OPT3_DESC= Describe OPT3
OPT4_DESC= Describe OPT4
OPT5_DESC= Describe OPT5
OPT6_DESC= Describe OPT6ports/Mk/bsd.options.desc.mk
has descriptions for many common
OPTIONS; there is usually no need
to override these.When describing options, view it from the
perspective of the user: What does it do?
and Why would I want to enable this? Do
not just repeat the name. For example, describing the
NLS option as
include NLS support does not help the
user, who can already see the option name but may not
know what it means. Describing it as Native
Language Support via gettext utilities is
much more helpful.OPTIONS can be grouped as radio
choices, where only one choice from each group is
allowed:OPTIONS_SINGLE= SG1
OPTIONS_SINGLE_SG1= OPT3 OPT4OPTIONS can be grouped as radio
choices, where none or only one choice from each group
is allowed:OPTIONS_RADIO= RG1
OPTIONS_RADIO_RG1= OPT7 OPT8OPTIONS can also be grouped as
multiple-choice lists, where
at least one option must be
enabled:OPTIONS_MULTI= MG1
OPTIONS_MULTI_MG1= OPT5 OPT6OPTIONS can also be grouped as
multiple-choice lists, where none or any
option can be enabled:OPTIONS_GROUP= GG1
OPTIONS_GROUP_GG1= OPT9 OPT10OPTIONS are unset by default,
unless they are listed in
OPTIONS_DEFAULT:OPTIONS_DEFAULT= OPT1 OPT3 OPT6OPTIONS definitions must appear
before the inclusion of
bsd.port.options.mk. The
PORT_OPTIONS variable can only be
tested after the inclusion of
bsd.port.options.mk. Inclusion of
bsd.port.pre.mk can be used instead,
too, and is still widely used in ports written before the
introduction of bsd.port.options.mk.
But be aware that some variables will not work as expected
after the inclusion of
bsd.port.pre.mk, typically some
USE_* flags.Simple Use of OPTIONSOPTIONS_DEFINE= FOO BAR
FOO_DESC= Enable option foo
BAR_DESC= Support feature bar
OPTIONS_DEFAULT=FOO
.include <bsd.port.options.mk>
.if ${PORT_OPTIONS:MFOO}
CONFIGURE_ARGS+=--with-foo
.else
CONFIGURE_ARGS+=--without-foo
.endif
.if ${PORT_OPTIONS:MBAR}
RUN_DEPENDS+= bar:${PORTSDIR}/bar/bar
.endif
.include <bsd.port.mk>Check for Unset Port
OPTIONS.if ! ${PORT_OPTIONS:MEXAMPLES}
CONFIGURE_ARGS+=--without-examples
.endifPractical Use of OPTIONSOPTIONS_DEFINE= EXAMPLES
OPTIONS_SINGLE= BACKEND
OPTIONS_SINGLE_BACKEND= MYSQL PGSQL BDB
OPTIONS_MULTI= AUTH
OPTIONS_MULTI_AUTH= LDAP PAM SSL
EXAMPLES_DESC= Install extra examples
MYSQL_DESC= Use MySQL as backend
PGSQL_DESC= Use PostgreSQL as backend
BDB_DESC= Use Berkeley DB as backend
LDAP_DESC= Build with LDAP authentication support
PAM_DESC= Build with PAM support
SSL_DESC= Build with OpenSSL support
OPTIONS_DEFAULT= PGSQL LDAP SSL
.include <bsd.port.options.mk>
.if ${PORT_OPTIONS:MPGSQL}
USE_PGSQL= yes
CONFIGURE_ARGS+= --with-postgres
.else
CONFIGURE_ARGS+= --without-postgres
.endif
.if ${PORT_OPTIONS:MICU}
LIB_DEPENDS+= icuuc:${PORTSDIR}/devel/icu
.endif
.if ! ${PORT_OPTIONS:MEXAMPLES}
CONFIGURE_ARGS+= --without-examples
.endif
# Check other OPTIONS
.include <bsd.port.mk>Default OptionsThe following options are always on by default.DOCS — build and install
documentation.NLS — Native Language
Support.EXAMPLES — build and
install examples.IPV6 — IPv6 protocol
support.There is no need to add these to
OPTIONS_DEFAULT. To have them show
up in the options selection dialog, however, they must
be added to OPTIONS_DEFINE.Feature Auto-ActivationWhen using a GNU configure script, keep an eye on which
optional features are activated by auto-detection.
Explicitly disable optional features you do not wish to be
used by passing respective --without-xxx
or --disable-xxx in
CONFIGURE_ARGS.Wrong Handling of an Option.if ${PORT_OPTIONS:MFOO}
LIB_DEPENDS+= foo:${PORTSDIR}/devel/foo
CONFIGURE_ARGS+= --enable-foo
.endifIn the example above, imagine a library libfoo is
installed on the system. The user does not want this
application to use libfoo, so he toggled the option off in
the make config dialog. But the
application's configure script detects the library present
in the system and includes its support in the resulting
executable. Now when the user decides to remove libfoo from
the system, the ports system does not protest (no dependency
on libfoo was recorded) but the application breaks.Correct Handling of an Option.if ${PORT_OPTIONS:MFOO}
LIB_DEPENDS+= foo:${PORTSDIR}/devel/foo
CONFIGURE_ARGS+= --enable-foo
.else
CONFIGURE_ARGS+= --disable-foo
.endifIn the second example, the library libfoo is explicitly
disabled. The configure script does not enable related
features in the application, despite library's presence in
the system.Under some circumstances, the shorthand conditional
syntax can cause problems with complex constructs.
If you receive errors such as Malformed
conditional, an alternative syntax can be
used..if !empty(VARIABLE:MVALUE)
# as an alternative to
.if ${VARIABLE:MVALUE}Specifying the Working DirectoryEach port is extracted in to a working directory, which
must be writable. The ports system defaults to having the
DISTFILES unpack in to a directory called
${DISTNAME}. In other words, if you have
set:PORTNAME= foo
PORTVERSION= 1.0then the port's distribution files contain a top-level
directory, foo-1.0, and the rest of the
files are located under that directory.There are a number of variables you can override if that
is not the case.WRKSRCThe 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
foo (and not
foo-1.0) you would write:WRKSRC= ${WRKDIR}/fooor possiblyWRKSRC= ${WRKDIR}/${PORTNAME}NO_WRKSUBDIRIf the port does not extract in to a subdirectory at all
then you should set NO_WRKSUBDIR to
indicate that.NO_WRKSUBDIR= yesConflict HandlingThere are three different variables to register a conflict
between packages and ports: CONFLICTS,
CONFLICTS_INSTALL and
CONFLICTS_BUILD.The conflict variables automatically set the variable
IGNORE, which is more fully documented
in .When removing one of several conflicting ports, it is
advisable to retain the CONFLICTS entries
in those other ports for a few months to cater for users who
only update once in a while.CONFLICTS_INSTALLIf your package cannot coexist with other packages
(because of file conflicts, runtime incompatibilities,
etc.), list the other package names in the
CONFLICTS_INSTALL variable. You can use
shell globs like * and
? here. Package names should be
enumerated the same way they appear in
/var/db/pkg. Please make sure that
CONFLICTS_INSTALL does not match this
port's package itself. Otherwise enforcing its installation
with FORCE_PKG_REGISTER will no longer
work. The CONFLICTS_INSTALL check is done after the build
stage and prior to the install stage.CONFLICTS_BUILDIf your port cannot be built if a certain port is
already installed, list the other port names in the
CONFLICTS_BUILD variable. You can use
shell globs like * and
? here. Package names should be
enumerated the same way they appear in
/var/db/pkg. The CONFLICTS_BUILD check
is done prior to the build stage. Build conflicts are not
recorded in the resulting package.CONFLICTSIf your port cannot be built if a certain port is
already installed and the resulting package cannot coexist
with the other package, list the other package name in the
CONFLICTS variable. You can use shell
globs like * and ?
here. Packages names should be enumerated the same way they
appear in /var/db/pkg. Please make
sure that CONFLICTS_INSTALL does not
match this port's package itself. Otherwise enforcing its
installation with FORCE_PKG_REGISTER will
no longer work. The CONFLICTS check is done prior to the
build stage and prior to the install stage.Installing FilesINSTALL_* MacrosDo use the macros provided in
bsd.port.mk to ensure correct modes and
ownership of files in your own
*-install targets.INSTALL_PROGRAM is a command to
install binary executables.INSTALL_SCRIPT is a command to
install executable scripts.INSTALL_LIB is a command to
install shared libraries.INSTALL_KLD is a command to
install kernel loadable modules. Some architectures
do not like having the modules stripped, so
use this command instead of
INSTALL_PROGRAM.INSTALL_DATA is a command to
install sharable data.INSTALL_MAN is a command to
install manpages and other documentation (it does not
compress anything).These are basically the install
command with all the appropriate flags.Stripping Binaries and Shared LibrariesDo not strip binaries manually unless you have to. All
binaries should be stripped, but the
INSTALL_PROGRAM macro will install and
strip a binary at the same time (see the next section). The
INSTALL_LIB macro does the same thing to
shared libraries.If you need to strip a file, but wish to use neither
INSTALL_PROGRAM nor
INSTALL_LIB macros,
${STRIP_CMD} will strip your program or
shared library. This is typically done within the
post-install target. For
example:post-install:
${STRIP_CMD} ${PREFIX}/bin/xdlUse the &man.file.1; command on the installed executable
to check whether the binary is stripped or not. If it does
not say not stripped, it is stripped.
Additionally, &man.strip.1; will not strip a previously
stripped program; it will instead exit cleanly.Installing a Whole Tree of FilesSometimes, there is a need to install a big number of
files, preserving their hierarchical organization, i.e.,
copying over a whole directory tree from
WRKSRC to a target directory under
PREFIX.Two macros exist for this situation. The advantage of
using these macros instead of cp is that
they guarantee proper file ownership and permissions on
target files. The first macro,
COPYTREE_BIN, will set all the installed
files to be executable, thus being suitable for installing
into PREFIX/bin.
The second macro, COPYTREE_SHARE, does
not set executable permissions on files, and is therefore
suitable for installing files under
PREFIX/share
target.post-install:
${MKDIR} ${EXAMPLESDIR}
(cd ${WRKSRC}/examples && ${COPYTREE_SHARE} . ${EXAMPLESDIR})This example will install the contents of
examples directory in the vendor
distfile to the proper examples location of your
port.post-install:
${MKDIR} ${DATADIR}/summer
(cd ${WRKSRC}/temperatures && ${COPYTREE_SHARE} "June July August" ${DATADIR}/summer)And this example will install the data of summer months
to the summer subdirectory of a
DATADIR.Additional find arguments can be
passed via the third argument to the
COPYTREE_* macros. For example, to
install all files from the first example except Makefiles,
one can use the following command.post-install:
${MKDIR} ${EXAMPLESDIR}
(cd ${WRKSRC}/examples && \
${COPYTREE_SHARE} . ${EXAMPLESDIR} "! -name Makefile")Note that these macros does not add the installed files
to pkg-plist. You still need to list
them.Install Additional DocumentationIf your software has some documentation other than the
standard man and info pages that you think is useful for the
user, install it under
PREFIX/share/doc.
This can be done, like the previous item, in the
post-install target.Create a new directory for your port. The directory
name should reflect what the port is. This usually means
PORTNAME. 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
PKGNAME.Make the installation dependent on the variable
DOCS option so that users can disable it
in /etc/make.conf, like this:post-install:
.if ${PORT_OPTIONS:MDOCS}
${MKDIR} ${DOCSDIR}
${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${DOCSDIR}
.endifHere are some handy variables and how they are expanded
by default when used in the
Makefile:DATADIR gets expanded to
PREFIX/share/PORTNAME.DATADIR_REL gets expanded to
share/PORTNAME.DOCSDIR gets expanded to
PREFIX/share/doc/PORTNAME.DOCSDIR_REL gets expanded to
share/doc/PORTNAME.EXAMPLESDIR gets expanded to
PREFIX/share/examples/PORTNAME.EXAMPLESDIR_REL gets expanded to
share/examples/PORTNAME.The DOCS option only controls
additional documentation installed in
DOCSDIR. It does not apply to standard
man pages and info pages. Things installed in
DATADIR and
EXAMPLESDIR are controlled by
DATA and EXAMPLES
options, respectively.These variables are exported to
PLIST_SUB. Their values will appear
there as pathnames relative to
PREFIX if possible.
That is,
share/doc/PORTNAME
will be substituted for %%DOCSDIR%% in
the packing list by default, and so on. (See more on
pkg-plist substitution here.)All conditionally installed documentation files and
directories should be included in
pkg-plist with the
%%PORTDOCS%% prefix, for example:%%PORTDOCS%%%%DOCSDIR%%/AUTHORS
%%PORTDOCS%%%%DOCSDIR%%/CONTACT
%%PORTDOCS%%@dirrm %%DOCSDIR%%As an alternative to enumerating the documentation files
in pkg-plist, a port can set the
variable PORTDOCS to a list of file names
and shell glob patterns to add to the final packing list.
The names will be relative to DOCSDIR.
Therefore, a port that utilizes PORTDOCS
and uses a non-default location for its documentation should
set DOCSDIR accordingly. If a directory
is listed in PORTDOCS 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 the DOCS option
has been unset then files and directories listed in
PORTDOCS would not be installed or added
to port packing list. Installing the documentation at
PORTDOCS as shown above remains up to the
port itself. A typical example of utilizing
PORTDOCS looks as follows:PORTDOCS= README.* ChangeLog docs/*The equivalents of PORTDOCS for
files installed under DATADIR and
EXAMPLESDIR are
PORTDATA and
PORTEXAMPLES, respectively.You can also use the pkg-message
file to display messages upon installation. See the section on using
pkg-message for details. The
pkg-message file does not need to be
added to pkg-plist.Subdirectories Under PREFIXTry to let the port put things in the right
subdirectories of PREFIX. 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
a subdirectory of lib, which does not
work well with the BSD paradigm. Many of the files should
be moved to one of the following: etc
(setup/configuration files), libexec
(executables started internally), sbin
(executables for superusers/managers),
info (documentation for info browser)
or share (architecture independent
files). See &man.hier.7; for details; the rules governing
/usr pretty much apply to
/usr/local too. The exception are
ports dealing with USENET news. They may use
PREFIX/news as a
destination for their files.Special ConsiderationsThere are some more things you have to take into account
when you create a port. This section explains the most common
of those.Shared LibrariesIf your port installs one or more shared libraries, define
a USE_LDCONFIG make variable, which will
instruct a bsd.port.mk to run
${LDCONFIG} -m on the directory
where the new library is installed (usually
PREFIX/lib) during
post-install target to register it
into the shared library cache. This variable, when defined,
will also facilitate addition of an appropriate
@exec /sbin/ldconfig -m and
@unexec /sbin/ldconfig -R pair into your
pkg-plist 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.USE_LDCONFIG= yesIf you need, you can override the default directory by
setting the USE_LDCONFIG value to a list of
directories into which shared libraries are to be installed.
For example if your port installs shared libraries into
PREFIX/lib/foo and
PREFIX/lib/bar
directories you could use the following in your
Makefile:USE_LDCONFIG= ${PREFIX}/lib/foo ${PREFIX}/lib/barPlease double-check, often this is not necessary at all or
can be avoided through -rpath or setting
LD_RUN_PATH during linking (see lang/moscow_ml for an example), or
through a shell-wrapper which sets
LD_LIBRARY_PATH before invoking the binary,
like www/seamonkey
does.When installing 32-bit libraries on 64-bit system, use
USE_LDCONFIG32 instead.Try to keep shared library version numbers in the
libfoo.so.0 format. Our runtime linker
only cares for the major (first) number.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
PORTREVISION incremented, to force
recompilation with the new library version.Ports with Distribution RestrictionsLicenses vary, and some of them place restrictions on how
the application can be packaged, whether it can be sold for
profit, and so on.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;.In situations like this, the variables described in the
following sections can be set.NO_PACKAGEThis 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.However, the port's DISTFILES may be
freely mirrored on FTP/HTTP. They may also be distributed
on a CD-ROM (or similar media) unless
NO_CDROM is set as well.NO_PACKAGE 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 NO_PACKAGE.NO_PACKAGE should be set to a string
describing the reason why the package should not be
generated.NO_CDROMThis variable alone indicates that, although we are
allowed to generate binary packages, we may put neither
those packages nor the port's DISTFILES
onto a CD-ROM (or similar media) for resale. However, the
binary packages and the port's DISTFILES
will still be available via FTP/HTTP. If this variable is set along with
NO_PACKAGE, then only the port's
DISTFILES will be available, and only via
FTP/HTTP.NO_CDROM 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 non-commercial use
only.NOFETCHFILESFiles defined in the NOFETCHFILES
variable are not fetchable from any of the
MASTER_SITES. An example of such a file
is when the file is supplied on CD-ROM by the vendor.Tools which check for the availability of these files
on the MASTER_SITES should ignore these
files and not report about them.RESTRICTEDSet this variable alone if the application's license
permits neither mirroring the application's
DISTFILES nor distributing the binary
package in any way.NO_CDROM or
NO_PACKAGE should not be set along with
RESTRICTED since the latter variable
implies the former ones.RESTRICTED 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 DISTFILES, possibly after registering
for the software or agreeing to accept the terms of an
EULA.RESTRICTED_FILESWhen RESTRICTED or
NO_CDROM is set, this variable defaults
to ${DISTFILES} ${PATCHFILES}, otherwise
it is empty. If only some of the distribution files are
restricted, then set this variable to list them.Note that the port committer should add an entry to
/usr/ports/LEGAL for every listed
distribution file, describing exactly what the restriction
entails.ExamplesThe preferred way to state "the distfiles for this port
must be fetched manually" is as follows:.if !exists(${DISTDIR}/${DISTNAME}${EXTRACT_SUFX})
IGNORE= may not be redistributed because of licensing reasons. Please visit some-website to accept their license and download ${DISTFILES} into ${DISTDIR}
.endifThis both informs the user, and sets the proper metadata
on the user's machine for use by automated programs.Note that this stanza must be preceded by an inclusion
of bsd.port.pre.mk.Building MechanismsBuilding Ports in ParallelThe &os; ports framework supports parallel building
using multiple make sub-processes, which
allows SMP systems to utilize all of
their available CPU power, allowing port
builds to be faster and more effective.This is achieved by passing -jX flag
to &man.make.1; running on vendor code. Unfortunately, not
all ports handle parallel building well. Therefore it is
required to explicitly enable this feature by adding
MAKE_JOBS_SAFE=yes somewhere below the
dependency declaration section of the
Makefile.Another option for controlling this feature from the
maintainer's point of view is the
MAKE_JOBS_UNSAFE=yes variable. It is
used when a port is known to be broken with
-jX and a user forces the use of multi
processor compilations for all ports in
/etc/make.conf with the
FORCE_MAKE_JOBS=yes variable.make, gmake, and
imakeIf your port uses GNU make,
set USE_GMAKE=yes.
Variables for Ports Related to
gmakeVariableMeansUSE_GMAKEThe port requires gmake to
build.GMAKEThe full path for gmake if
it is not in the PATH.
If your port is an X application that creates
Makefile files from
Imakefile files using
imake, then set
USE_IMAKE=yes. This will cause the
configure stage to automatically do an xmkmf
-a. If the flag is a
problem for your port, set XMKMF=xmkmf.
If the port uses imake but does
not understand the install.man
target, NO_INSTALL_MANPAGES=yes should be
set.If your port's source Makefile has
something else than all as the main
build target, set ALL_TARGET accordingly.
Same goes for install and
INSTALL_TARGET.configure ScriptIf your port uses the configure
script to generate Makefile files from
Makefile.in files, set
GNU_CONFIGURE=yes. If you want to give
extra arguments to the configure script
(the default argument is --prefix=${PREFIX}
--infodir=${PREFIX}/${INFO_PATH}
--mandir=${MANPREFIX}/man
--build=${CONFIGURE_TARGET}), set those
extra arguments in CONFIGURE_ARGS. Extra
environment variables can be passed using
CONFIGURE_ENV variable.
Variables for Ports That Use
configureVariableMeansGNU_CONFIGUREThe port uses configure
script to prepare build.HAS_CONFIGURESame as GNU_CONFIGURE,
except default configure target is not added to
CONFIGURE_ARGS.CONFIGURE_ARGSAdditional arguments passed to
configure script.CONFIGURE_ENVAdditional environment variables to be set
for configure script run.CONFIGURE_TARGETOverride default configure target. Default
value is
${MACHINE_ARCH}-portbld-freebsd${OSREL}.
Using cmakeFor ports that use CMake,
define USES= cmake, or
USES= cmake:outsource to build in a
separate directory (see below).
Variables for Ports That Use
cmakeVariableMeansCMAKE_ARGSPort specific CMake
flags to be passed to the cmake
binary.CMAKE_BUILD_TYPEType of build (CMake
predefined build profiles). Default is
Release, or
Debug if
WITH_DEBUG is set.CMAKE_ENVEnvironment variables to be set for
cmake binary. Default is
${CONFIGURE_ENV}.CMAKE_SOURCE_PATHPath to the source directory. Default is
${WRKSRC}.
CMake supports the following
build profiles: Debug,
Release,
RelWithDebInfo and
MinSizeRel. Debug and
Release profiles respect system
*FLAGS, RelWithDebInfo
and MinSizeRel will set
CFLAGS to -O2 -g and
-Os -DNDEBUG correspondingly. The
lower-cased value of CMAKE_BUILD_TYPE is
exported to the PLIST_SUB and should be
used if port installs *.cmake files
depending on the build type (see deskutils/strigi for an
example). Please note that some projects may define their
own build profiles and/or force particular build type by
setting CMAKE_BUILD_TYPE in
CMakeLists.txt files. In order to
make a port for such a project respect
CFLAGS and WITH_DEBUG,
the CMAKE_BUILD_TYPE definitions must be
removed from those files.Most CMake-based projects
support an out-of-source method of building. The
out-of-source build for a port can be requested by using the
:outsource suffix. When enabled,
CONFIGURE_WRKSRC,
BUILD_WRKSRC and
INSTALL_WRKSRC will be set to
${WRKDIR}/.build and this
directory will be used to keep all files generated during
configuration and build stages, leaving the source directory
intact.USES= cmake ExampleThe following snippet demonstrates the use of
CMake for a port.
CMAKE_SOURCE_PATH is not usually
required, but can be set when the sources are not located
in the top directory, or if only a subset of the project
is intended to be built by the port.USES= cmake:outsource
CMAKE_SOURCE_PATH= ${WRKSRC}/subprojectUsing sconsIf your port uses SCons,
define USE_SCONS=yes.
Variables for Ports That Use
sconsVariableMeansSCONS_ARGSPort specific SCons flags passed to the SCons
environment.SCONS_BUILDENVVariables to be set in system
environment.SCONS_ENVVariables to be set in SCons
environment.SCONS_TARGETLast argument passed to SCons, similar to
MAKE_TARGET.
To make third party SConstruct
respect everything that is passed to SCons in
SCONS_ENV (that is, most importantly,
CC/CXX/CFLAGS/CXXFLAGS), patch the
SConstruct so build
Environment is constructed like
this:env = Environment(**ARGUMENTS)It may be then modified with
env.Append and
env.Replace.Using GNU AutotoolsIntroductionThe 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:USE_AUTOTOOLS= tool:version[:operation] ...At the time of writing, tool
can be one of libtool,
libltdl, autoconf,
autoheader, automake
or aclocal.version specifies the
particular tool revision to be used (see
devel/{automake,autoconf,libtool}[0-9]+
for valid versions).operation is an optional
extension to modify how the tool is used.Multiple tools can be specified at once, either by
including them all on a single line, or using the
+= Makefile construct.Finally, there is the special tool, called
autotools, which is a convenience
function to bring in all available versions of the autotools
to allow for cross-development work. This can also be
accomplished by installing the
devel/autotools port.libtoolShared libraries using the GNU building framework
usually use libtool 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 libtool
bundled with the application. In case you need to use
external libtool, you can use the version
provided by The Ports Collection:USE_AUTOTOOLS= libtool:version[:env]With no additional operations,
libtool:version
tells the building framework to patch the configure script
with the system-installed copy of
libtool. The
GNU_CONFIGURE is implied. Further, a
number of make and shell variables will be assigned for
onward use by the port. See
bsd.autotools.mk for details.With the :env operation, only the
environment will be set up.Finally, LIBTOOLFLAGS and
LIBTOOLFILES can be optionally set to
override the most likely arguments to, and files patched by,
libtool. Most ports are unlikely to need
this. See bsd.autotools.mk for further
details.libltdlSome ports make use of the libltdl
library package, which is part of the
libtool suite. Use of this library does
not automatically necessitate the use of
libtool itself, so a separate construct
is provided.USE_AUTOTOOLS= libltdl:versionCurrently, all this does is to bring in a
LIB_DEPENDS on the appropriate
libltdl port, and is provided as a
convenience function to help eliminate any dependencies on
the autotools ports outside of the
USE_AUTOTOOLS framework. There are no
optional operations for this tool.autoconf and
autoheaderSome ports do not contain a configure script, but do
contain an autoconf template in the
configure.ac file. You can use the
following assignments to let autoconf
create the configure script, and also have
autoheader create template headers for
use by the configure script.USE_AUTOTOOLS= autoconf:version[:env]andUSE_AUTOTOOLS= autoheader:versionwhich also implies the use of
autoconf:version.Similarly to libtool, the inclusion
of the optional :env operation simply
sets up the environment for further use. Without it,
patching and reconfiguration of the port is carried
out.The additional optional variables
AUTOCONF_ARGS and
AUTOHEADER_ARGS can be overridden by the
port Makefile if specifically
requested. As with the libtool
equivalents, most ports are unlikely to need this.automake and
aclocalSome packages only contain
Makefile.am files. These have to be
converted into Makefile.in files using
automake, and the further processed by
configure to generate an actual
Makefile.Similarly, packages occasionally do not ship with
included aclocal.m4 files, again
required to build the software. This can be achieved with
aclocal, which scans
configure.ac or
configure.in.aclocal has a similar relationship to
automake as autoheader
does to autoconf, described in the
previous section. aclocal implies the
use of automake, thus we have:USE_AUTOTOOLS= automake:version[:env]andUSE_AUTOTOOLS= aclocal:versionwhich also implies the use of
automake:version.Similarly to libtool and
autoconf, the inclusion of the optional
:env operation simply sets up the
environment for further use. Without it, reconfiguration of
the port is carried out.As with autoconf and
autoheader, both
automake and aclocal
have optional argument variables,
AUTOMAKE_ARGS and
ACLOCAL_ARGS respectively, which may be
overridden by the port Makefile if
required.Using GNU gettextBasic UsageIf your port requires gettext, set
USES= gettext, and your
port will inherit a dependency on devel/gettext. Other values for
gettext usage are listed in .A rather common case is a port using
gettext and configure.
Generally, GNU configure should be able
to locate gettext automatically. If it
ever fails to, hints at the location of
gettext can be passed in
CPPFLAGS and LDFLAGS as
follows:USES= gettext
CPPFLAGS+= -I${LOCALBASE}/include
LDFLAGS+= -L${LOCALBASE}/lib
GNU_CONFIGURE= yesOf course, the code can be more compact if there are no
more flags to pass to configure:USES= gettext
GNU_CONFIGURE= yesOptional UsageSome software products allow for disabling NLS, e.g.,
through passing to
configure. In that case, your port
should use gettext conditionally,
depending on the status of WITHOUT_NLS.
For ports of low to medium complexity, you can rely on the
following idiom:GNU_CONFIGURE= yes
.include <bsd.port.options.mk>
.if ${PORT_OPTIONS:MNLS}
USES+= gettext
PLIST_SUB+= NLS=""
.else
CONFIGURE_ARGS+= --disable-nls
PLIST_SUB+= NLS="@comment "
.endif
.include <bsd.port.mk>The next item on your to-do list is to arrange so that
the message catalog files are included in the packing list
conditionally. The Makefile part of
this task is already provided by the idiom. It is explained
in the section on advanced
pkg-plist practices. In a
nutshell, each occurrence of %%NLS%% in
pkg-plist will be replaced by
@comment if NLS is
disabled, or by a null string if NLS is enabled.
Consequently, the lines prefixed by
%%NLS%% will become mere comments in the
final packing list if NLS is off; otherwise the prefix will
be just left out. All you need to do now is insert
%%NLS%% before each path to a message
catalog file in pkg-plist. For
example:%%NLS%%share/locale/fr/LC_MESSAGES/foobar.mo
%%NLS%%share/locale/no/LC_MESSAGES/foobar.moIn high complexity cases, you may need to use more
advanced techniques than the recipe given here, such as
dynamic packing list
generation.Handling Message Catalog DirectoriesThere is a point to note about installing message
catalog files. The target directories for them, which
reside under
LOCALBASE/share/locale,
should rarely be created and removed by a port. The most
popular languages have their respective directories listed
in
PORTSDIR/Templates/BSD.local.dist.
The directories for many other languages are governed by the
devel/gettext port.
Consult its pkg-plist and see whether
the port is going to install a message catalog file for a
unique language.Using PerlIf MASTER_SITES is set to
MASTER_SITE_PERL_CPAN, then the preferred
value of MASTER_SITE_SUBDIR is the
top-level hierarchy name. For example, the recommended value
for p5-Module-Name is
Module. The top-level hierarchy can be
examined at cpan.org.
This keeps the port working when the author of the module
changes.The exception to this rule is when the relevant directory
does not exist or the distfile does not exist in that
directory. In such case, using author's id as
MASTER_SITE_SUBDIR is allowed.All of the tunable knobs below accept either
YES or a version string like
5.8.0+. YES means
that the port can be used with any of the supported
Perl versions. If a port only
works with specific versions of
Perl, it can be indicated with a
version string, specifying a minimum version (e.g.,
5.7.3+), a maximum version (e.g.,
5.8.0-) or an exact version (e.g.,
5.8.3).
Variables for Ports That Use
PerlVariableMeaningUSE_PERL5The port uses Perl 5
to build and run.USE_PERL5_BUILDThe port uses Perl 5
to build.USE_PERL5_RUNThe port uses Perl 5
to run.PERLThe full path of the Perl 5 interpreter,
either in the system or installed from a port, but
without the version number. Use this if you need to
replace #!lines in
scripts.PERL_CONFIGUREConfigure using Perl's MakeMaker. It implies
USE_PERL5.PERL_MODBUILDConfigure, build and install using Module::Build.
It implies PERL_CONFIGURE.Read only variablesPERL_VERSIONThe full version of Perl
installed (e.g., 5.8.9).PERL_LEVELThe installed Perl version as
an integer of the form MNNNPP
(e.g., 500809).PERL_ARCHWhere Perl stores architecture
dependent libraries. Defaults to
${ARCH}-freebsd.PERL_PORTName of the Perl port that is
installed (e.g., perl5).SITE_PERLDirectory name where site specific
Perl packages go. This value is
added to PLIST_SUB.
Ports of Perl modules which do not have an official
website should link to cpan.org in the WWW
line of pkg-descr. The
preferred URL form is
http://search.cpan.org/dist/Module-Name/
(including the trailing slash).Do not use ${SITE_PERL} in dependency
declarations. Doing so assumes that
bsd.perl.mk has been included, which is
not always true. Ports depending on this port will have
incorrect dependencies if this port's files move later in an
upgrade. The right way to declare Perl module dependencies
is shown in the example below.Perl Dependency Examplep5-IO-Tee>=0.64:${PORTSDIR}/devel/p5-IO-TeeUsing X11X.Org ComponentsThe X11 implementation available in The Ports Collection
is X.Org. If your application depends on X components, set
USE_XORG to the list of required
components. Available components, at the time of writing,
are:bigreqsproto compositeproto damageproto dmx
dmxproto dri2proto evieproto fixesproto fontcacheproto
fontenc fontsproto fontutil glproto ice inputproto kbproto
libfs oldx pciaccess pixman printproto randrproto
recordproto renderproto resourceproto scrnsaverproto sm
trapproto videoproto x11 xau xaw xaw6 xaw7 xbitmaps
xcmiscproto xcomposite xcursor xdamage xdmcp xevie xext
xextproto xf86bigfontproto xf86dgaproto xf86driproto
xf86miscproto xf86rushproto xf86vidmodeproto xfixes xfont
xfontcache xft xi xinerama xineramaproto xkbfile xkbui
xmu xmuu xorg-server xp xpm xprintapputil xprintutil
xproto xproxymngproto xrandr xrender xres xscrnsaver xt
xtrans xtrap xtst xv xvmc xxf86dga xxf86misc
xxf86vm.Always up-to-date list can be found in
/usr/ports/Mk/bsd.xorg.mk.The Mesa Project is an effort to provide free OpenGL
implementation. You can specify a dependency on various
components of this project with USE_GL
variable. Valid options are: glut, glu, glw, glew,
gl and linux. For backwards
compatibility, the value of yes maps to
glu.USE_XORG ExampleUSE_XORG= xrender xft xkbfile xt xaw
USE_GL= glu
Variables for Ports That Use XUSE_IMAKEThe port uses imake.XMKMFSet to the path of xmkmf if
not in the PATH. Defaults to
xmkmf -a.
Variables for Depending on Individual Parts of
X11X_IMAKE_PORTPort providing imake and
several other utilities used to build X11.X_LIBRARIES_PORTPort providing X11 libraries.X_CLIENTS_PORTPort providing X clients.X_SERVER_PORTPort providing X server.X_FONTSERVER_PORTPort providing font server.X_PRINTSERVER_PORTPort providing print server.X_VFBSERVER_PORTPort providing virtual framebuffer
server.X_NESTSERVER_PORTPort providing a nested X server.X_FONTS_ENCODINGS_PORTPort providing encodings for fonts.X_FONTS_MISC_PORTPort providing miscellaneous bitmap
fonts.X_FONTS_100DPI_PORTPort providing 100dpi bitmap fonts.X_FONTS_75DPI_PORTPort providing 75dpi bitmap fonts.X_FONTS_CYRILLIC_PORTPort providing cyrillic bitmap fonts.X_FONTS_TTF_PORTPort providing &truetype; fonts.X_FONTS_TYPE1_PORTPort providing Type1 fonts.X_MANUALS_PORTPort providing developer oriented manual
pages
Using X11-Related Variables# Use some X11 libraries and depend on
# font server as well as cyrillic fonts.
RUN_DEPENDS= ${LOCALBASE}/bin/xfs:${X_FONTSERVER_PORT} \
${LOCALBASE}/lib/X11/fonts/cyrillic/crox1c.pcf.gz:${X_FONTS_CYRILLIC_PORT}
USE_XORG= x11 xpmPorts That Require MotifIf your port requires a Motif library, define
USE_MOTIF in the
Makefile. Default Motif implementation
is x11-toolkits/open-motif. Users
can choose x11-toolkits/lesstif instead by
setting WANT_LESSTIF variable.The MOTIFLIB variable will be set by
bsd.port.mk to reference the
appropriate Motif library. Please patch the source of your
port to use ${MOTIFLIB} wherever
the Motif library is referenced in the original
Makefile or
Imakefile.There are two common cases:If the port refers to the Motif library as
-lXm in its
Makefile or
Imakefile, simply substitute
${MOTIFLIB} for it.If the port uses XmClientLibs in
its Imakefile, change it to
${MOTIFLIB} ${XTOOLLIB}
${XLIB}.Note that MOTIFLIB (usually) expands
to -L/usr/local/lib -lXm or
/usr/local/lib/libXm.a, so there is no
need to add -L or -l
in front.X11 FontsIf your port installs fonts for the X Window System, put
them in
LOCALBASE/lib/X11/fonts/local.Getting a Fake DISPLAY with XvfbSome applications require a working X11 display for
compilation to succeed. This pose a problem for machines
that operate headless. When the following variable is used,
the build infrastructure will start the virtual framebuffer
X server. The working DISPLAY is then passed
to the build.USE_DISPLAY= yesDesktop EntriesDesktop entries (a
Freedesktop standard) provide a way to
automatically adjust desktop features when a new program is
installed, without requiring user intervention. For
example, newly-installed programs automatically appear in
the application menus of compatible desktop environments.
Desktop entries originated in the
GNOME desktop environment, but
are now a standard and also work with
KDE and
Xfce. This bit of automation
provides a real benefit to the user, and desktop entries are
encouraged for applications which can be used in a desktop
environment.Using Predefined .desktop
FilesPorts that include predefined
*.desktop files should
include those files in pkg-plist
and install them in the
$LOCALBASE/share/applications
directory. The INSTALL_DATA
macro is useful for installing these
files.Updating desktop databaseIf a port has a MimeType entry in its
portname.desktop,
the desktop database must
be updated after install and deinstall. To do this,
define USES= desktop-file-utils.Creating Desktop Entries with the
DESKTOP_ENTRIES MacroDesktop entries can be easily created for applications
by using the DESKTOP_ENTRIES variable.
A file named
name.desktop
will be created, installed, and added to the
pkg-plist automatically. Syntax
is:DESKTOP_ENTRIES= "NAME" "COMMENT" "ICON" "COMMAND" "CATEGORY" StartupNotifyThe list of possible categories is available on the
Freedesktop
website. StartupNotify
indicates whether the application is compatible with
startup notifications. These are
typically a graphic indicator like a clock that appear at
the mouse pointer, menu, or panel to give the user an
indication when a program is starting. A program that is
compatible with startup notifications clears the indicator
after it has started. Programs that are not compatible
with startup notifications would never clear the indicator
(potentially confusing and infuriating the user), and
should have StartupNotify set to
false so the indicator is not shown at
all.Example:DESKTOP_ENTRIES= "ToME" "Roguelike game based on JRR Tolkien's work" \
"${DATADIR}/xtra/graf/tome-128.png" \
"tome -v -g" "Application;Game;RolePlaying;" \
falseUsing GNOMEThe FreeBSD/GNOME project uses its own set of variables to
define which GNOME components a particular port uses. A
comprehensive
list of these variables exists within the
FreeBSD/GNOME project's homepage.Using QtPorts That Require Qt
Variables for Ports That Use QtUSE_QT_VERThe port uses the Qt toolkit. The only
possible value is 3.
Appropriate parameters are passed to
configure script and
make.USE_QT4Specify tool and library dependencies for ports
that use Qt 4. See Qt 4 component
selection for more details.QT_PREFIXSet to the path where Qt installed to
(read-only variable).MOCSet to the path of moc
(read-only variable). Default set according to
USE_QT_VER value.QTCPPFLAGSAdditional compiler flags passed via
CONFIGURE_ENV for Qt toolkit.
Default set according to
USE_QT_VER.QTCFGLIBSAdditional libraries for linking passed via
CONFIGURE_ENV for Qt toolkit.
Default set according to
USE_QT_VER.QTNONSTANDARDSuppress modification of
CONFIGURE_ENV,
CONFIGURE_ARGS,
CPPFLAGS and
MAKE_ENV.
Additional Variables for Ports That Use Qt
4.xUICSet to the path of uic
(read-only variable).QMAKESet to the path of qmake
(read-only variable).QMAKESPECSet to the path of configuration file for
qmake (read-only
variable).QMAKEFLAGSAdditional flags for
qmake.QT_INCDIRSet to Qt 4 include directories (read-only
variable).QT_LIBDIRSet to Qt 4 libraries path (read-only
variable).QT_PLUGINDIRSet to Qt 4 plugins path (read-only
variable).
When USE_QT_VER is set to
3, some useful settings are passed to the
configure script:CONFIGURE_ARGS+= --with-qt-includes=${QT_PREFIX}/include \
--with-qt-libraries=${QT_PREFIX}/lib \
--with-extra-libs=${LOCALBASE}/lib \
--with-extra-includes=${LOCALBASE}/include
CONFIGURE_ENV+= MOC="${MOC}" LIBS="${QTCFGLIBS}" \
QTDIR="${QT_PREFIX}" KDEDIR="${KDE_PREFIX}"
CPPFLAGS+= ${QTCPPFLAGS}If USE_QT4 is set, the following
settings are deployed:CONFIGURE_ARGS+= --with-qt-includes=${QT_INCDIR} \
--with-qt-libraries=${QT_LIBDIR} \
--with-extra-libs=${LOCALBASE}/lib \
--with-extra-includes=${LOCALBASE}/include
CONFIGURE_ENV+= MOC="${MOC}" UIC="${UIC}" LIBS="${QTCFGLIBS}" \
QMAKE="${QMAKE}" QMAKESPEC="${QMAKESPEC}" QTDIR="${QT_PREFIX}"
MAKE_ENV+= QMAKESPEC="${QMAKESPEC}"
PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_REL} \
QT_LIBDIR_REL=${QT_LIBDIR_REL} \
QT_PLUGINDIR_REL=${QT_PLUGINDIR_REL}Component Selection (Qt 4.x Only)Individual Qt 4 tool and library dependencies
must be specified in the USE_QT4
variable. Every component
can be suffixed by either _build or
_run, the suffix indicating whether the
component should be depended on at buildtime or runtime,
respectively. If unsuffixed, the component will be depended
on at both build- and runtime. Usually, library components
should be specified unsuffixed, tool components should be
specified with the _build suffix and
plugin components should be specified with the
_run suffix. The most commonly used
components are listed below (all available components are
listed in _USE_QT4_ALL in
/usr/ports/Mk/bsd.qt.mk):
Available Qt 4 Library ComponentsNameDescriptioncorelibcore library (can be omitted unless the port
uses nothing but corelib)guigraphical user interface librarynetworknetwork libraryopenglOpenGL libraryqt3supportQt 3 compatibility libraryqtestlibunit testing libraryscriptscript librarysqlSQL libraryxmlXML library
You can determine which libraries the application
depends on, by running ldd on the main
executable after a successful compilation.
Available Qt 4 Tool ComponentsNameDescriptionmocmeta object compiler (needed for almost
every Qt application at buildtime)qmakeMakefile generator / build utilityrccresource compiler (needed if the application
comes with *.rc or
*.qrc files)uicuser interface compiler (needed if the
application comes with *.ui
files created by Qt Designer - in practice, every Qt
application with a GUI)
Available Qt 4 Plugin ComponentsNameDescriptioniconenginesSVG icon engine plugin (if the application
ships SVG icons)imageformatsimageformat plugins for GIF, JPEG, MNG and
SVG (if the application ships image files)
Selecting Qt 4 ComponentsIn this example, the ported application uses the Qt 4
graphical user interface library, the Qt 4 core library,
all of the Qt 4 code generation tools and Qt 4's Makefile
generator. Since the gui library
implies a dependency on the core library,
corelib does not need to be specified.
The Qt 4 code generation tools moc,
uic and rcc, as well
as the Makefile generator qmake are
only needed at buildtime, thus they are specified with the
_build suffix:USE_QT4= gui moc_build qmake_build rcc_build uic_buildAdditional ConsiderationsIf the application does not provide a
configure file but a
.pro file, you can use the
following:HAS_CONFIGURE= yes
do-configure:
@cd ${WRKSRC} && ${SETENV} ${CONFIGURE_ENV} \
${QMAKE} ${QMAKEFLAGS} PREFIX=${PREFIX} texmaker.proNote the similarity to the qmake line
from the provided BUILD.sh script.
Passing CONFIGURE_ENV ensures
qmake will see the
QMAKESPEC variable, without which it
cannot work. qmake generates standard
Makefiles, so it is not necessary to write our own
build target.Qt applications often are written to be cross-platform
and often X11/Unix is not the platform they are developed
on, which in turn often leads to certain loose ends,
like:Missing additional include
paths. Many applications come with
system tray icon support, but neglect to look for
includes and/or libraries in the X11 directories. You
can tell qmake to add directories to
the include and library search paths via the command
line, for example:${QMAKE} ${QMAKEFLAGS} PREFIX=${PREFIX} INCLUDEPATH+=${LOCALBASE}/include \
LIBS+=-L${LOCALBASE}/lib sillyapp.proBogus installation paths.
Sometimes data such as icons or .desktop files are by
default installed into directories which are not scanned
by XDG-compatible applications. editors/texmaker is an
example for this - look at
patch-texmaker.pro in the
files directory of that port for a
template on how to remedy this directly in the
qmake project file.Using KDEVariable Definitions (KDE 3.x Only)
Variables for Ports That Use KDE 3.xUSE_KDELIBS_VERThe port uses KDE libraries. It specifies the
major version of KDE to use and implies
USE_QT_VER of the appropriate
version. The only possible value is
3.USE_KDEBASE_VERThe port uses KDE base. It specifies the major
version of KDE to use and implies
USE_QT_VER of the appropriate
version. The only possible value is
3.
KDE 4 Variable DefinitionsIf your application depends on KDE 4.x, set
USE_KDE4 to the list of required
components. _build and
_run suffixes can be used to force
components dependency type (e.g.,
baseapps_run). If no suffix is set, a
default dependency type will be used. If you want to force
both types, add the component twice with both suffixes
(e.g., automoc4_build automoc4_run). The
most commonly used components are listed below (up-to-date
components are documented at the top of
/usr/ports/Mk/bsd.kde4.mk):
Available KDE 4 ComponentsNameDescriptionkdehierHierarchy of common KDE directorieskdelibsKDE Developer PlatformkdeprefixIf set, port will be installed into
${KDE4_PREFIX} instead of
${LOCALBASE}sharedmimeMIME types database for KDE portsautomoc4Automatic moc for Qt 4 packagesakonadiStorage server for KDE-PimsopranoQt 4 RDF frameworkstrigiDesktop search daemonlibkcddbKDE CDDB librarylibkcompactdiscKDE library for interfacing with audio
CDslibkdeeduLibraries used by educational
applicationslibkdcrawKDE LibRaw librarylibkexiv2KDE Exiv2 librarylibkipi KDE Image Plugin InterfacelibkonqKonqueror core librarylibksaneKDE SANE ("Scanner Access Now Easy")
librarypimlibsKDE-Pim librarieskateText editor frameworkmarbleVirtual globeokularUniversal document viewerkorundumKDE Ruby bindingsperlkdeKDE Perl bindingspykde4KDE Python bindingspykdeuic4PyKDE user interface compilersmokekdeKDE SMOKE libraries
KDE 4.x ports are installed into
KDE4_PREFIX, which is
/usr/local/kde4 currently, to avoid
conflicts with KDE 3.x ports. This is achieved by
specifying the kdeprefix component, which
overrides the default PREFIX. The ports
however respect any PREFIX set via
MAKEFLAGS environment variable and/or
make arguments.USE_KDE4 ExampleThis is a simple example for a KDE 4 port.
USES= cmake:outsource instructs the
port to utilize CMake, a
configuration tool widely used by KDE 4 projects (see
for detailed usage).
USE_KDE4 brings dependency on KDE
libraries and makes port using
automoc4 at build stage.
Required KDE components and other dependencies can be
determined through configure log.
USE_KDE4 does not imply
USE_QT4. If a port requires some
Qt 4 components, they should be specified in
USE_QT4.USES= cmake:outsource
USE_KDE4= kdelibs kdeprefix automoc4
USE_QT4= moc_build qmake_build rcc_build uic_buildUsing JavaVariable DefinitionsIf your port needs a Java™ Development Kit
(JDK™) to either build, run or even extract the
distfile, then it should define
USE_JAVA.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 java/jdk16.
Variables Which May be Set by Ports That Use
JavaVariableMeansUSE_JAVAShould be defined for the remaining variables
to have any effect.JAVA_VERSIONList of space-separated suitable Java versions
for the port. An optional "+"
allows you to specify a range of versions (allowed
values:
1.5[+] 1.6[+] 1.7[+]).JAVA_OSList of space-separated suitable JDK port
operating systems for the port (allowed values:
native linux).JAVA_VENDORList of space-separated suitable JDK port
vendors for the port (allowed values:
freebsd bsdjava sun
openjdk).JAVA_BUILDWhen set, it means that the selected JDK port
should be added to the build dependencies of the
port.JAVA_RUNWhen set, it means that the selected JDK port
should be added to the run dependencies of the
port.JAVA_EXTRACTWhen set, it means that the selected JDK port
should be added to the extract dependencies of the
port.
Below is the list of all settings a port will receive
after setting USE_JAVA:
Variables Provided to Ports That Use JavaVariableValueJAVA_PORTThe name of the JDK port (e.g.,
'java/openjdk6').JAVA_PORT_VERSIONThe full version of the JDK port (e.g.,
'1.6.0'). If you only need the
first two digits of this version number, use
${JAVA_PORT_VERSION:C/^([0-9])\.([0-9])(.*)$/\1.\2/}.JAVA_PORT_OSThe operating system used by the JDK port
(e.g., 'native').JAVA_PORT_VENDORThe vendor of the JDK port (e.g.,
'openjdk').JAVA_PORT_OS_DESCRIPTIONDescription of the operating system used by the
JDK port (e.g.,
'Native').JAVA_PORT_VENDOR_DESCRIPTIONDescription of the vendor of the JDK port
(e.g., 'OpenJDK BSD Porting
Team').JAVA_HOMEPath to the installation directory of the JDK
(e.g.,
'/usr/local/openjdk6').JAVACPath to the Java compiler to use (e.g.,
'/usr/local/openjdk6/bin/javac').JARPath to the jar tool to use
(e.g.,
'/usr/local/openjdk6/bin/jar'
or
'/usr/local/bin/fastjar').APPLETVIEWERPath to the appletviewer
utility (e.g.,
'/usr/local/openjdk6/bin/appletviewer').JAVAPath to the java executable.
Use this for executing Java programs (e.g.,
'/usr/local/openjdk6/bin/java').JAVADOCPath to the javadoc utility
program.JAVAHPath to the javah
program.JAVAPPath to the javap
program.JAVA_KEYTOOLPath to the keytool utility
program.JAVA_N2APath to the native2ascii
tool.JAVA_POLICYTOOLPath to the policytool
program.JAVA_SERIALVERPath to the serialver
utility program.RMICPath to the RMI stub/skeleton generator,
rmic.RMIREGISTRYPath to the RMI registry program,
rmiregistry.RMIDPath to the RMI daemon program
rmid.JAVA_CLASSESPath to the archive that contains the JDK class
files,
${JAVA_HOME}/jre/lib/rt.jar.
You may use the java-debug make
target to get information for debugging your port. It will
display the value of many of the forecited variables.Additionally, the following constants are defined so all
Java ports may be installed in a consistent way:
Constants Defined for Ports That Use JavaConstantValueJAVASHAREDIRThe base directory for everything related to
Java. Default:
${PREFIX}/share/java.JAVAJARDIRThe directory where JAR files should be
installed. Default:
${JAVASHAREDIR}/classes.JAVALIBDIRThe directory where JAR files installed by
other ports are located. Default:
${LOCALBASE}/share/java/classes.
The related entries are defined in both
PLIST_SUB (documented in
) and
SUB_LIST.Building with AntWhen the port is to be built using Apache Ant, it has to
define USE_ANT. Ant is thus considered
to be the sub-make command. When no
do-build target is defined by the port, a
default one will be set that simply runs Ant according to
MAKE_ENV, MAKE_ARGS
and ALL_TARGET. This is similar to the
USE_GMAKE mechanism, which is documented
in .Best PracticesWhen porting a Java library, your port should install
the JAR file(s) in ${JAVAJARDIR}, and
everything else under
${JAVASHAREDIR}/${PORTNAME} (except for
the documentation, see below). In order to reduce the
packing file size, you may reference the JAR file(s)
directly in the Makefile. Just use the
following statement (where myport.jar
is the name of the JAR file installed as part of the
port):PLIST_FILES+= %%JAVAJARDIR%%/myport.jarWhen porting a Java application, the port usually
installs everything under a single directory (including its
JAR dependencies). The use of
${JAVASHAREDIR}/${PORTNAME} 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
${JAVAJARDIR}).Regardless of the type of your port (library or
application), the additional documentation should be
installed in the same
location 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
(pkg-plist). This is one reason why
porters are strongly encouraged to use the
PORTDOCS macro. Moreover, even if you
can predict the set of files that will be generated by
javadoc, the size of the resulting
pkg-plist advocates for the use of
PORTDOCS.The default value for DATADIR is
${PREFIX}/share/${PORTNAME}. It is a
good idea to override DATADIR to
${JAVASHAREDIR}/${PORTNAME} for Java
ports. Indeed, DATADIR is automatically
added to PLIST_SUB (documented in ) so you may use
%%DATADIR%% directly in
pkg-plist.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 &os; Java
Project encourage porters to have their ports built
from source whenever it is a trivial task.All the features that have been presented in this
section are implemented in bsd.java.mk.
If you ever think that your port needs more sophisticated
Java support, please first have a look at the bsd.java.mk
SVN log 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;.Although there is a java category for
PRs, it refers to the JDK porting effort from the &os; Java
project. Therefore, you should submit your Java port in the
ports category as for any other port,
unless the issue you are trying to resolve is related to
either a JDK implementation or
bsd.java.mk.Similarly, there is a defined policy regarding the
CATEGORIES of a Java port, which is
detailed in .Web Applications, Apache and PHPApache
Variables for Ports That Use ApacheUSE_APACHEThe port requires Apache. Possible values:
yes (gets any version),
22, 24,
22-24, 22+,
etc. The default APACHE version is
22. More details are available
in ports/Mk/bsd.apache.mk and
at wiki.freebsd.org/Apache/.APXSFull path to the apxs
binary. Can be overridden in your port.HTTPDFull path to the httpd
binary. Can be overridden in your port.APACHE_VERSIONThe version of present Apache installation
(read-only variable). This variable is only
available after inclusion of
bsd.port.pre.mk. Possible
values: 22,
24.APACHEMODDIRDirectory for Apache modules. This variable is
automatically expanded in
pkg-plist.APACHEINCLUDEDIRDirectory for Apache headers. This variable is
automatically expanded in
pkg-plist.APACHEETCDIRDirectory for Apache configuration files. This
variable is automatically expanded in
pkg-plist.
Useful Variables for Porting Apache ModulesMODULENAMEName of the module. Default value is
PORTNAME. Example:
mod_helloSHORTMODNAMEShort name of the module. Automatically
derived from MODULENAME, but can
be overridden. Example:
helloAP_FAST_BUILDUse apxs to compile and
install the module.AP_GENPLISTAlso automatically creates a
pkg-plist.AP_INCAdds a directory to a header search path during
compilation.AP_LIBAdds a directory to a library search path
during compilation.AP_EXTRASAdditional flags to pass to
apxs.
Web ApplicationsWeb applications should be installed into
PREFIX/www/appname.
For your convenience, this path is available both in
Makefile and in
pkg-plist as WWWDIR,
and the path relative to PREFIX is
available in Makefile as
WWWDIR_REL.The user and group of web server process are available
as WWWOWN and WWWGRP,
in case you need to change the ownership of some files. The
default values of both are www. If you
want different values for your port, use WWWOWN?=
myuser notation, to allow user to override it
easily.Do not depend on Apache unless the web app explicitly
needs Apache. Respect that users may wish to run your web
app on different web server than Apache.PHP
Variables for Ports That Use PHPUSE_PHPThe port requires PHP. The value
yes adds a dependency on PHP.
The list of required PHP extensions can be specified
instead. Example: pcre xml
gettextDEFAULT_PHP_VERSelects which major version of PHP will be
installed as a dependency when no PHP is installed
yet. Default is 5. Possible
values: 4,
5IGNORE_WITH_PHPThe port does not work with PHP of the given
version. Possible values: 4,
5USE_PHPIZEThe port will be built as a PHP
extension.USE_PHPEXTThe port will be treated as a PHP extension,
including installation and registration in the
extension registry.USE_PHP_BUILDSet PHP as a build dependency.WANT_PHP_CLIWant the CLI (command line) version of
PHP.WANT_PHP_CGIWant the CGI version of PHP.WANT_PHP_MODWant the Apache module version of PHP.WANT_PHP_SCRWant the CLI or the CGI version of PHP.WANT_PHP_WEBWant the Apache module or the CGI version of
PHP.
PEAR ModulesPorting PEAR modules is a very simple process.Use the variables FILES,
TESTS, DATA,
SQLS, SCRIPTFILES,
DOCS and EXAMPLES to
list the files you want to install. All listed files will
be automatically installed into the appropriate locations
and added to pkg-plist.Include
${PORTSDIR}/devel/pear/bsd.pear.mk
on the last line of the
Makefile.Example Makefile for PEAR ClassPORTNAME= 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/bsd.pear.mk"
.include <bsd.port.post.mk>Using PythonThe Ports Collection supports parallel installation of
multiple Python versions. Ports should make sure to use a
correct python interpreter, according to
the user-settable PYTHON_VERSION variable.
Most prominently, this means replacing the path to
python executable in scripts with the value
of PYTHON_CMD variable.Ports that install files under
PYTHON_SITELIBDIR should use the
pyXY- package name prefix, so their package
name embeds the version of Python they are installed
into.PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}
Most Useful Variables for Ports That Use PythonUSE_PYTHONThe port needs Python. Minimal required version
can be specified with values such as
2.6+. Version ranges can also be
specified, by separating two version numbers with a
dash, e.g.: 2.6-2.7USE_PYDISTUTILSUse Python distutils for configuring, compiling
and installing. This is required when the port comes
with setup.py. This overrides
the do-build and
do-install targets and may
also override do-configure if
GNU_CONFIGURE is not
defined.PYTHON_PKGNAMEPREFIXUsed as a PKGNAMEPREFIX to
distinguish packages for different Python versions.
Example: py24-PYTHON_SITELIBDIRLocation of the site-packages tree, that contains
installation path of Python (usually
LOCALBASE). The
PYTHON_SITELIBDIR variable can be
very useful when installing Python modules.PYTHONPREFIX_SITELIBDIRThe PREFIX-clean variant of PYTHON_SITELIBDIR.
Always use %%PYTHON_SITELIBDIR%% in
pkg-plist when possible. The
default value of
%%PYTHON_SITELIBDIR%% is
lib/python%%PYTHON_VERSION%%/site-packagesPYTHON_CMDPython interpreter command line, including
version number.PYNUMERICDependency line for numeric extension.PYNUMPYDependency line for the new numeric extension,
numpy. (PYNUMERIC is deprecated by upstream
vendor).PYXMLDependency line for XML extension (not needed for
Python 2.0 and higher as it is also in base
distribution).USE_TWISTEDAdd dependency on twistedCore. The list of
required components can be specified as a value of
this variable. Example: web lore pair
flowUSE_ZOPEAdd dependency on Zope, a web application
platform. Change Python dependency to Python 2.7.
Set ZOPEBASEDIR containing a
directory with Zope installation.
A complete list of available variables can be found in
/usr/ports/Mk/bsd.python.mk.Using Tcl/TkThe Ports Collection supports parallel installation of
multiple Tcl/Tk versions. Ports
should try to support at least the default
Tcl/Tk version and higher with the
USE_TCL and USE_TK
variables. It is possible to specify the desired version of
tcl with the
WITH_TCL_VER variable.
The Most Useful Variables for Ports That Use
Tcl/TkUSE_TCLThe port depends on the
Tcl library (not the
shell). Minimal required version can be specified
with values such as 84+. Individual unsupported
versions can be specified with the
INVALID_TCL_VER variable.USE_TCL_BUILDThe port needs Tcl
only during the build time.USE_TCL_WRAPPERPorts that require the
Tcl shell and do not
require a specific tclsh version
should use this new variable. The
tclsh wrapper is installed on the
system. The user can specify the desired
tcl shell to use.WITH_TCL_VERUser-defined variable that sets the desired
Tcl version.UNIQUENAME_WITH_TCL_VERLike WITH_TCL_VER, but
per-port.USE_TCL_THREADSRequire a threaded build of
Tcl/Tk.USE_TKThe port depends on the
Tk library (not the wish
shell). Implies USE_TCL with the
same value. For more information see the description
of USE_TCL variable.USE_TK_BUILDAnalog to the USE_TCL_BUILD
variable.USE_TK_WRAPPERAnalog to the USE_TCL_WRAPPER
variable.WITH_TK_VERAnalog to the WITH_TCL_VER
variable and implies WITH_TCL_VER
of the same value.
A complete list of available variables can be found in
/usr/ports/Mk/bsd.tcl.mk.Using EmacsThis section is yet to be written.Using Ruby
Useful Variables for Ports That Use RubyVariableDescriptionUSE_RUBYThe port requires Ruby.USE_RUBY_EXTCONFThe port uses extconf.rb to
configure.USE_RUBY_SETUPThe port uses setup.rb to
configure.RUBY_SETUPSet to the alternative name of
setup.rb. Common value is
install.rb.
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 pkg-plist as much as
possible. These variables should not be redefined in the
port.
Selected Read-Only Variables for Ports That Use
RubyVariableDescriptionExample valueRUBY_PKGNAMEPREFIXUsed as a PKGNAMEPREFIX to
distinguish packages for different Ruby
versions.ruby18-RUBY_VERSIONFull version of Ruby in the form of
x.y.z.1.8.2RUBY_SITELIBDIRArchitecture independent libraries installation
path./usr/local/lib/ruby/site_ruby/1.8RUBY_SITEARCHLIBDIRArchitecture dependent libraries installation
path./usr/local/lib/ruby/site_ruby/1.8/amd64-freebsd6RUBY_MODDOCDIRModule documentation installation path./usr/local/share/doc/ruby18/patsyRUBY_MODEXAMPLESDIRModule examples installation path./usr/local/share/examples/ruby18/patsy
A complete list of available variables can be found in
/usr/ports/Mk/bsd.ruby.mk.Using SDLThe USE_SDL variable is used to
autoconfigure the dependencies for ports which use an SDL
based library like devel/sdl12 and x11-toolkits/sdl_gui.The following SDL libraries are recognized at the
moment:sdl: devel/sdl12gfx: graphics/sdl_gfxgui: x11-toolkits/sdl_guiimage: graphics/sdl_imageldbad: devel/sdl_ldbadmixer: audio/sdl_mixermm: devel/sdlmmnet: net/sdl_netsound: audio/sdl_soundttf: graphics/sdl_ttfTherefore, if a port has a dependency on
net/sdl_net and
audio/sdl_mixer,
the syntax will be:USE_SDL= net mixerThe dependency devel/sdl12, which is required by
net/sdl_net and audio/sdl_mixer, is automatically
added as well.If you use USE_SDL, it will
automatically:Add a dependency on
sdl12-config to
BUILD_DEPENDSAdd the variable SDL_CONFIG to
CONFIGURE_ENVAdd the dependencies of the selected libraries to the
LIB_DEPENDSTo check whether an SDL library is available, you can do
it with the WANT_SDL variable:WANT_SDL= yes
.include <bsd.port.pre.mk>
.if ${HAVE_SDL:Mmixer}!=""
USE_SDL+= mixer
.endif
.include <bsd.port.post.mk>Using wxWidgetsThis section describes the status of the
wxWidgets libraries in the ports
tree and its integration with the ports system.IntroductionThere are many versions of the
wxWidgets libraries which
conflict between them (install files under the same name).
In the ports tree this problem has been solved by installing
each version under a different name using version number
suffixes.The obvious disadvantage of this is that each
application has to be modified to find the expected version.
Fortunately, most of the applications call the
wx-config script to determine the
necessary compiler and linker flags. The script is named
differently for every available version. Majority of
applications respect an environment variable, or accept a
configure argument, to specify which
wx-config script to call. Otherwise they
have to be patched.Version SelectionTo make your port use a specific version of
wxWidgets there are two variables
available for defining (if only one is defined the other
will be set to a default value):
Variables to Select
wxWidgets VersionsVariableDescriptionDefault valueUSE_WXList of versions the port can useAll available versionsUSE_WX_NOTList of versions the port can not useNone
The following is a list of available
wxWidgets versions and the
corresponding ports in the tree:
Available wxWidgets
VersionsVersionPort2.4x11-toolkits/wxgtk242.6x11-toolkits/wxgtk262.8x11-toolkits/wxgtk28
The versions starting from 2.5 also
come in Unicode version and are installed by a slave port
named like the normal one plus a
-unicode suffix, but this can be
handled with variables (see ).The variables in can
be set to one or more of the following combinations
separated by spaces:
wxWidgets Version
SpecificationsDescriptionExampleSingle version2.4Ascending range2.4+Descending range2.6-Full range (must be ascending)2.4-2.6
There are also some variables to select the preferred
versions from the available ones. They can be set to a list
of versions, the first ones will have higher
priority.
Variables to Select Preferred
wxWidgets VersionsNameDesigned forWANT_WX_VERthe portWITH_WX_VERthe user
Component SelectionThere are other applications that, while not being
wxWidgets libraries, are related
to them. These applications can be specified in the
WX_COMPS variable. The following
components are available:
Available wxWidgets
ComponentsNameDescriptionVersion restrictionwxmain librarynonecontribcontributed librariesnonepythonwxPython
(Python bindings)2.4-2.6mozillawxMozilla2.4svgwxSVG2.6
The dependency type can be selected for each component
by adding a suffix separated by a semicolon. If not present
then a default type will be used (see ). The following types are
available:
Available wxWidgets
Dependency TypesNameDescriptionbuildComponent is required for building, equivalent
to BUILD_DEPENDSrunComponent is required for running, equivalent
to RUN_DEPENDSlibComponent is required for building and running,
equivalent to LIB_DEPENDS
The default values for the components are detailed in
the following table:
Selecting wxWidgets
ComponentsThe following fragment corresponds to a port which
uses wxWidgets version
2.4 and its contributed
libraries.USE_WX= 2.4
WX_COMPS= wx contribUnicodeThe wxWidgets library
supports Unicode since version 2.5. In
the ports tree both versions are available and can be
selected with the following variables:
Variables to Select Unicode in
wxWidgets
VersionsVariableDescriptionDesigned forWX_UNICODEThe port works only with
the Unicode versionthe portWANT_UNICODEThe port works with both versions but prefers
the Unicode onethe portWITH_UNICODEThe port will use the Unicode versionthe userWITHOUT_UNICODEThe port will use the normal version if
supported (when WX_UNICODE is not
defined)the user
Do not use WX_UNICODE for ports
that can use both Unicode and normal versions. If you
want the port to use Unicode by default define
WANT_UNICODE instead.Detecting Installed VersionsTo detect an installed version you have to define
WANT_WX. If you do not set it to a
specific version then the components will have a version
suffix. The HAVE_WX variable will be
filled after detection.Detecting Installed
wxWidgets Versions and
ComponentsThe following fragment can be used in a port that uses
wxWidgets if it is installed,
or an option is selected.WANT_WX= yes
.include <bsd.port.pre.mk>
.if defined(WITH_WX) || !empty(PORT_OPTIONS:MWX) || !empty(HAVE_WX:Mwx-2.4)
USE_WX= 2.4
CONFIGURE_ARGS+= --enable-wx
.endifThe following fragment can be used in a port that
enables wxPython support if it
is installed or if an option is selected, in addition to
wxWidgets, both version
2.6.USE_WX= 2.6
WX_COMPS= wx
WANT_WX= 2.6
.include <bsd.port.pre.mk>
.if defined(WITH_WXPYTHON) || !empty(PORT_OPTIONS:MWXPYTHON) || !empty(HAVE_WX:Mpython)
WX_COMPS+= python
CONFIGURE_ARGS+= --enable-wxpython
.endifDefined VariablesThe following variables are available in the port (after
defining one from
).
Variables Defined for Ports That Use
wxWidgetsNameDescriptionWX_CONFIGThe path to the
wxWidgetswx-config script (with different
name)WXRC_CMDThe path to the
wxWidgetswxrc program (with different
name)WX_VERSIONThe wxWidgets
version that is going to be used (e.g.,
2.6)WX_UNICODEIf not defined but Unicode is going to be used
then it will be defined
Processing in
bsd.port.pre.mkIf you need to use the variables for running commands
right after including bsd.port.pre.mk
you need to define WX_PREMK.If you define WX_PREMK, then the
version, dependencies, components and defined variables
will not change if you modify the
wxWidgets port variables
after including
bsd.port.pre.mk.Using wxWidgets Variables
in CommandsThe following fragment illustrates the use of
WX_PREMK by running the
wx-config script to obtain the full
version string, assign it to a variable and pass it to the
program.USE_WX= 2.4
WX_PREMK= yes
.include <bsd.port.pre.mk>
.if exists(${WX_CONFIG})
VER_STR!= ${WX_CONFIG} --release
PLIST_SUB+= VERSION="${VER_STR}"
.endifThe wxWidgets variables can
be safely used in commands when they are inside targets
without the need of WX_PREMK.Additional configure
ArgumentsSome GNU configure scripts can not
find wxWidgets with just the
WX_CONFIG environment variable set,
requiring additional arguments. The
WX_CONF_ARGS variable can be used for
provide them.
Legal Values for
WX_CONF_ARGSPossible valueResulting argumentabsolute--with-wx-config=${WX_CONFIG}relative--with-wx=${LOCALBASE}
--with-wx-config=${WX_CONFIG:T}
Using LuaThis section describes the status of the
Lua libraries in the ports tree and
its integration with the ports system.IntroductionThere are many versions of the
Lua libraries and corresponding
interpreters, which conflict between them (install files
under the same name). In the ports tree this problem has
been solved by installing each version under a different
name using version number suffixes.The obvious disadvantage of this is that each
application has to be modified to find the expected version.
But it can be solved by adding some additional flags to the
compiler and linker.Version SelectionTo make your port use a specific version of
Lua there are two variables
available for defining (if only one is defined the other
will be set to a default value):
Variables to Select Lua
VersionsVariableDescriptionDefault valueUSE_LUAList of versions the port can useAll available versionsUSE_LUA_NOTList of versions the port can not useNone
The following is a list of available
Lua versions and the
corresponding ports in the tree:
Available Lua
VersionsVersionPort4.0lang/lua45.0lang/lua505.1lang/lua
The variables in can
be set to one or more of the following combinations
separated by spaces:
Lua Version
SpecificationsDescriptionExampleSingle version4.0Ascending range5.0+Descending range5.0-Full range (must be ascending)5.0-5.1
There are also some variables to select the preferred
versions from the available ones. They can be set to a list
of versions, the first ones will have higher
priority.
Variables to Select Preferred
Lua VersionsNameDesigned forWANT_LUA_VERthe portWITH_LUA_VERthe user
Selecting the Lua
VersionThe following fragment is from a port which can use
Lua version
5.0 or 5.1, and uses
5.0 by default. It can be overridden
by the user with WITH_LUA_VER.USE_LUA= 5.0-5.1
WANT_LUA_VER= 5.0Component SelectionThere are other applications that, while not being
Lua libraries, are related to
them. These applications can be specified in the
LUA_COMPS variable. The following
components are available:
Available Lua
ComponentsNameDescriptionVersion restrictionluamain librarynonetoluaLibrary for accessing C/C++ code4.0-5.0rubyRuby bindings4.0-5.0
There are more components but they are modules for the
interpreter, not used by applications (only by other
modules).The dependency type can be selected for each component
by adding a suffix separated by a semicolon. If not present
then a default type will be used (see ). The following types are
available:
Available Lua Dependency
TypesNameDescriptionbuildComponent is required for building, equivalent
to BUILD_DEPENDSrunComponent is required for running, equivalent
to RUN_DEPENDSlibComponent is required for building and running,
equivalent to LIB_DEPENDS
The default values for the components are detailed in
the following table:
Default Lua Dependency
TypesComponentDependency typelualib for
4.0-5.0 (shared) and
build for 5.1
(static)toluabuild (static)rubylib (shared)
Selecting Lua
ComponentsThe following fragment corresponds to a port which
uses Lua version
4.0 and its
Ruby bindings.USE_LUA= 4.0
LUA_COMPS= lua rubyDetecting Installed VersionsTo detect an installed version you have to define
WANT_LUA. If you do not set it to a
specific version then the components will have a version
suffix. The HAVE_LUA variable will be
filled after detection.Detecting Installed Lua
Versions and ComponentsThe following fragment can be used in a port that uses
Lua if it is installed, or an
option is selected.WANT_LUA= yes
.include <bsd.port.pre.mk>
.if defined(WITH_LUA5) || !empty(PORT_OPTIONS:MLUA5) || !empty(HAVE_LUA:Mlua-5.[01])
USE_LUA= 5.0-5.1
CONFIGURE_ARGS+= --enable-lua5
.endifThe following fragment can be used in a port that
enables tolua support if it is
installed or if an option is selected, in addition to
Lua, both version
4.0.USE_LUA= 4.0
LUA_COMPS= lua
WANT_LUA= 4.0
.include <bsd.port.pre.mk>
.if defined(WITH_TOLUA) || !empty(PORT_OPTIONS:MTOLUA) || !empty(HAVE_LUA:Mtolua)
LUA_COMPS+= tolua
CONFIGURE_ARGS+= --enable-tolua
.endifDefined VariablesThe following variables are available in the port (after
defining one from ).
Variables Defined for Ports That Use
LuaNameDescriptionLUA_VERThe Lua version that
is going to be used (e.g.,
5.1)LUA_VER_SHThe Lua shared
library major version (e.g.,
1)LUA_VER_STRThe Lua version
without the dots (e.g.,
51)LUA_PREFIXThe prefix where Lua
(and components) is installedLUA_SUBDIRThe directory under
${PREFIX}/bin,
${PREFIX}/share and
${PREFIX}/lib where
Lua is installedLUA_INCDIRThe directory where
Lua and
tolua header files are
installedLUA_LIBDIRThe directory where
Lua and
tolua libraries are
installedLUA_MODLIBDIRThe directory where
Lua module libraries
(.so) are installedLUA_MODSHAREDIRThe directory where
Lua modules
(.lua) are installedLUA_PKGNAMEPREFIXThe package name prefix used by
Lua modulesLUA_CMDThe path to the Lua
interpreterLUAC_CMDThe path to the Lua
compilerTOLUA_CMDThe path to the
tolua program
Telling the Port Where to Find
LuaThe following fragment shows how to tell a port that
uses a configure script where the
Lua header files and libraries
are.USE_LUA= 4.0
GNU_CONFIGURE= yes
CONFIGURE_ENV= CPPFLAGS="-I${LUA_INCDIR}" LDFLAGS="-L${LUA_LIBDIR}"Processing in
bsd.port.pre.mkIf you need to use the variables for running commands
right after including bsd.port.pre.mk
you need to define LUA_PREMK.If you define LUA_PREMK, then the
version, dependencies, components and defined variables
will not change if you modify the
Lua port variables
after including
bsd.port.pre.mk.Using Lua Variables in
CommandsThe following fragment illustrates the use of
LUA_PREMK by running the
Lua interpreter to obtain the
full version string, assign it to a variable and pass it
to the program.USE_LUA= 5.0
LUA_PREMK= yes
.include <bsd.port.pre.mk>
.if exists(${LUA_CMD})
VER_STR!= ${LUA_CMD} -v
CFLAGS+= -DLUA_VERSION_STRING="${VER_STR}"
.endifThe Lua variables can be
safely used in commands when they are inside targets
without the need of LUA_PREMK.Using XfceThe USE_XFCE variable is used to
autoconfigure the dependencies for ports which use an Xfce
based library or application like x11-toolkits/libxfce4gui and
x11-wm/xfce4-panel.The following Xfce libraries and applications are
recognized at the moment:libexo: x11/libexolibgui: x11-toolkits/libxfce4guilibutil: x11/libxfce4utillibmcs: x11/libxfce4mcsmcsmanager: sysutils/xfce4-mcs-managerpanel: x11-wm/xfce4-panelthunar: x11-fm/thunarwm: x11-wm/xfce4-wmxfdev: dev/xfce4-dev-toolsThe following additional parameters are recognized:configenv: Use this if your port requires a special
modified CONFIGURE_ENV to find its
required libraries.-I${LOCALBASE}/include -L${LOCALBASE}/libgets added to CPPFLAGS to
CONFIGURE_ENV.Therefore, if a port has a dependency on sysutils/xfce4-mcs-manager and
requires the special CPPFLAGS in its configure environment,
the syntax will be:USE_XFCE= mcsmanager configenvUsing Mozilla
Variables for Ports That Use MozillaUSE_GECKOGecko backend the port can handle. Possible
values: libxul
(libxul.so),
seamonkey
(libgtkembedmoz.so, deprecated,
should not be used any more).USE_FIREFOXThe port requires Firefox as a runtime
dependency. Possible values: yes
(get default version), 40,
36, 35. Default
dependency is on version
40.USE_FIREFOX_BUILDThe port requires Firefox as a buildtime
dependency. Possible values: see USE_FIREFOX. This
automatically sets USE_FIREFOX and assigns the same
value.USE_SEAMONKEYThe port requires SeaMonkey as a runtime
dependency. Possible values: yes
(get default version), 20,
11 (deprecated, should not be used
any more). Default dependency is on version
20.USE_SEAMONKEY_BUILDThe port requires SeaMonkey as a buildtime
dependency. Possible values: see USE_SEAMONKEY. This
automatically sets USE_SEAMONKEY and assigns the same
value.USE_THUNDERBIRDThe port requires Thunderbird as a runtime
dependency. Possible values: yes
(get default version), 31,
30 (deprecated, should not be used
any more). Default dependency is on version
31.USE_THUNDERBIRD_BUILDThe port requires Thunderbird as a buildtime
dependency. Possible values: see USE_THUNDERBIRD.
This automatically sets USE_THUNDERBIRD and assigns
the same value.
A complete list of available variables can be found in
/usr/ports/Mk/bsd.gecko.mk.Using Databases
Variables for Ports Using DatabasesVariableMeansUSE_BDBIf variable is set to yes,
add dependency on databases/db41 port. The
variable may also be set to values: 40, 41, 42, 43,
44, 46, 47, 48, or 51. You can declare a range of
acceptable values, USE_BDB=42+ will
find the highest installed version, and fall back to
42 if nothing else is installed.USE_MYSQLIf variable is set to yes, add
dependency on databases/mysql55-client
port. An associated variable,
WANT_MYSQL_VER, may be set to
values such as 323, 40, 41, 50, 51, 52, 55, or
60.USE_PGSQLIf set to yes, add dependency
on databases/postgresql90-client
port. An associated variable,
WANT_PGSQL_VER, may be set to
values such as 83, 84, 90, 91 or 92. You can declare
a minimum or maximum value;
WANT_PGSQL_VER=
90+ will cause the
port to depend on a minimum version of 9.0.USE_SQLITEIf variable is set to yes, add
dependency on
databases/sqlite3
port. The variable may also be set to values: 3,
2.
More details are available in bsd.database.mk.Starting and Stopping Services (rc
Scripts)rc.d 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 rc.d
framework. Details on its usage can be found in the rc.d
Handbook chapter. Detailed explanation of available
commands is provided in &man.rc.8; and &man.rc.subr.8;.
Finally, there is an
article on practical aspects of
rc.d scripting.One or more rc.d scripts can be
installed:USE_RC_SUBR= doormandScripts must be placed in the files
subdirectory and a .in suffix must be added
to their filename. Standard SUB_LIST
expansions will be used for this file. Use of the
%%PREFIX%% and
%%LOCALBASE%% expansions is strongly
encouraged as well. More on SUB_LIST in
the relevant
section.Prior to &os; 6.1-RELEASE, integration with
&man.rcorder.8; is available by using
USE_RCORDER instead of
USE_RC_SUBR. However, use of this method
is not necessary unless the port has an option to install
itself in the base, or the service needs to run prior to the
FILESYSTEMSrc.d
script in the base.As of &os; 6.1-RELEASE, local
rc.d scripts (including those installed
by ports) are included in the overall &man.rcorder.8; of the
base system.Example simple rc.d script:#!/bin/sh
# $FreeBSD$
#
# PROVIDE: doormand
# REQUIRE: LOGIN
# KEYWORD: shutdown
#
# 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.
. /etc/rc.subr
name=doormand
rcvar=doormand_enable
load_rc_config $name
: ${doormand_enable:="NO"}
: ${doormand_config="%%PREFIX%%/etc/doormand/doormand.cf"}
command=%%PREFIX%%/sbin/${name}
pidfile=/var/run/${name}.pid
command_args="-p $pidfile -f $doormand_config"
run_rc_command "$1" Unless there is a good reason to start the service
earlier all ports scripts should useREQUIRE: LOGINIf the service runs as a particular user (other than root)
this is mandatory.KEYWORD: shutdownis included in the script above because the mythical port
we are using as an example starts a service, and should be
shut down cleanly when the system shuts down. If the script
is not starting a persistent service this is not
necessary.For optional configuration elements 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 or null. A user
might very well include something likedoormand_flags=""in their rc.conf.local file, and a
variable substitution using ":=" would
inappropriately override the user's intention. The
_enable variable is not optional,
and should use the ":" for the default.No new scripts should be added with the
.sh suffix.Pre-Commit ChecklistBefore contributing a port with an
rc.d script, and more importantly,
before committing one, please consult the following
checklist to be sure that it is ready.If this is a new file, does it have
.sh in the file name? If so that
should be changed to just file.in
since new rc.d files may not end
with that extension.Does the file have a
$FreeBSD$ tag?Do the name of the file (minus
.in), the
PROVIDE line, and
$name
all match? The file name matching
PROVIDE makes debugging easier,
especially for &man.rcorder.8; issues. Matching the
file name and
$name
makes it easier to figure out which variables are
relevant in rc.conf[.local]. The
latter is also what you might call “policy”
for all new scripts, including those in the base
system.Is the REQUIRE line set to
LOGIN? This is mandatory for scripts
that run as a non-root user. If it runs as root, is
there a good reason for it to run prior to
LOGIN? If not, it should run there
so that we can loosely group local scripts to a point in
&man.rcorder.8; after most everything in the base is
already running.Does the script start a persistent service? If so,
it should have KEYWORD:
shutdown.Make sure there is no KEYWORD:
FreeBSD present. This has not been
necessary or desirable for years. It is also an
indication that the new script was copy/pasted from an
old script, so extra caution should be given to the
review.If the script uses an interpreted language like
perl, python, or
ruby, make certain that
command_interpreter is set
appropriately. Otherwise,&prompt.root; service name stopwill probably not work properly. See
&man.service.8; for more information.Have all occurrences of
/usr/local been replaced with
%%PREFIX%%?Do the default variable assignments come after
load_rc_config?Are there default assignments to empty strings?
They should be removed, but double-check that the option
is documented in the comments at the top of the
file.Are things that are set in variables actually used
in the script?Are options listed in the default
name_flags
things that are actually mandatory? If so, they should
be in command_args. The
option is a red flag (pardon the
pun) here, since it is usually the option to
“daemonize” the process, and therefore is
actually mandatory.The
name_flags
variable should never be included in
command_args (and vice versa,
although that error is less common).Does the script execute any code unconditionally?
This is frowned on. Usually these things can/should be
dealt with through a
start_precmd.All boolean tests should utilize the
checkyesno function. No
hand-rolled tests for [Yy][Ee][Ss],
etc.If there is a loop (for example, waiting for
something to start) does it have a counter to terminate
the loop? We do not want the boot to be stuck forever
if there is an error.Does the script create files or directories that
need specific permissions, for example, a
pid file that needs to be owned by
the user that runs the process? Rather than the
traditional &man.touch.1;/&man.chown.8;/&man.chmod.1;
routine, consider using &man.install.1; with the proper
command line arguments to do the whole procedure with
one step.Adding Users and GroupsSome ports require a certain user to be on the installed
system. Choose a free UID from 50 to 999 and register it
either in ports/UIDs (for users) or in
ports/GIDs (for groups). Make sure you
do not use a UID already used by the system or other
ports.Please include a patch against these two files when you
require a new user or group to be created for your
port.Then you can use USERS and
GROUPS variables in your
Makefile, and the user will be
automatically created when installing the port.USERS= pulse
GROUPS= pulse pulse-access pulse-rtThe current list of reserved UIDs and GIDs can be found
in ports/UIDs and
ports/GIDs.Ports That Rely on Kernel SourcesSome ports (such as kernel loadable modules) need the
kernel source files so that the port can compile. Here is the
correct way to determine if the user has them
installed:.if !exists(${SRC_BASE}/sys/Makefile)
IGNORE= requires kernel sources to be installed
.endifAdvanced pkg-plist PracticesChanging pkg-plist Based on Make
VariablesSome ports, particularly the p5- ports,
need to change their pkg-plist 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
pkg-plist of
%%OSREL%%, %%PERL_VER%%,
and %%PERL_VERSION%% will be substituted
for appropriately. The value of %%OSREL%%
is the numeric revision of the operating system (e.g.,
4.9). %%PERL_VERSION%%
and %%PERL_VER%% is the full version number
of perl (e.g., 5.8.9).
Several other
%%VARS%% related
to port's documentation files are described in the relevant
section.If you need to make other substitutions, you can set the
PLIST_SUB variable with a list of
VAR=VALUE
pairs and instances of
%%VAR%% will be
substituted with VALUE in the
pkg-plist.For instance, if you have a port that installs many files
in a version-specific subdirectory, you can put something
likeOCTAVE_VERSION= 2.0.13
PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}in the Makefile and use
%%OCTAVE_VERSION%% wherever the version
shows up in pkg-plist. That way, when
you upgrade the port, you will not have to change dozens (or
in some cases, hundreds) of lines in the
pkg-plist.If your port installs files conditionally on the options
set in the port, the usual way of handling it is prefixing the
pkg-plist lines with a
%%TAG%% and adding that
TAG to the PLIST_SUB
variable inside the Makefile with a
special value of @comment, which makes
package tools to ignore the line:.if defined(WITH_X11)
PLIST_SUB+= X11=""
.else
PLIST_SUB+= X11="@comment "
.endifand in the pkg-plist:%%X11%%bin/foo-guiThis substitution (as well as addition of any manual pages) will be
done between the pre-install and
do-install targets, by reading from
PLIST and writing to
TMPPLIST (default:
WRKDIR/.PLIST.mktmp).
So if your port builds
PLIST on the fly, do
so in or before pre-install. Also,
if your port needs to edit the resulting file, do so in
post-install to a file named
TMPPLIST.Another possibility to modify port's packing list is based
on setting the variables PLIST_FILES and
PLIST_DIRS. The value of each variable is
regarded as a list of pathnames to write to
TMPPLIST along with
PLIST contents. Names
listed in PLIST_FILES and
PLIST_DIRS are subject to
%%VAR%%
substitution, as described above. Except for that, names from
PLIST_FILES will appear in the final
packing list unchanged, while @dirrm will
be prepended to names from PLIST_DIRS. To
take effect, PLIST_FILES and
PLIST_DIRS must be set before
TMPPLIST is written,
i.e., in pre-install or
earlier.Empty DirectoriesCleaning Up Empty DirectoriesDo make your ports remove empty directories when they
are de-installed. This is usually accomplished by adding
@dirrm lines for all directories that are
specifically created by the port. You need to delete
subdirectories before you can delete parent
directories. :
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/onekoHowever, sometimes @dirrm will give
you errors because other ports share the same directory.
You can use @dirrmtry to remove only
empty directories without warning.@dirrmtry share/doc/gimpThis will neither print any error messages nor cause
&man.pkg.delete.1; to exit abnormally even if
${PREFIX}/share/doc/gimp
is not empty due to other ports installing some files in
there.Creating Empty DirectoriesEmpty 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
pkg-plist above the corresponding
@dirrm line:@exec mkdir -p %D/share/foo/templatesConfiguration FilesIf your port installs configuration files to
PREFIX/etc (or
elsewhere) do not simply list them in the
pkg-plist. That will cause
&man.pkg.delete.1; to remove the files carefully edited by
the user, and a re-installation will wipe them out.Instead, install sample file(s) with a
filename.sample
suffix. Then copy the sample file to the real configuration
file name, if it does not already exist. On deinstall
delete the configuration file, but only if it is identical
to the .sample file.
You need to handle this both in the port
Makefile, and in the
pkg-plist (for installation from the
package).Example of the Makefile part:post-install:
@if [ ! -f ${PREFIX}/etc/orbit.conf ]; then \
${CP} -p ${PREFIX}/etc/orbit.conf.sample ${PREFIX}/etc/orbit.conf ; \
fiFor each configuration file, create the following three
lines in pkg-plist:@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; fiThe order of these lines is important. On deinstallation,
the sample file is compared to the actual configuration file.
If these files are identical, no changes have been made by the
user and the actual file can be safely deleted. Because the
sample file must still exist for the comparison, the
@unexec line comes before the sample
configuration file name. On installation, if an actual
configuration file is not already present, the sample file is
copied to the actual file. The sample file must be present
before it can be copied, so the @exec line
comes after the sample configuration file name.To debug any issues, temporarily remove the
-s flag to &man.cmp.1; for more
output.See &man.pkg.create.1; for more information on
%D and related substitution markers.If there is a very good reason not to install a working
configuration file by default, leave the
@exec line out of
pkg-plist and add a message pointing out that
the user must copy and edit the file before the software will
work.Dynamic Versus Static Package ListA static package list is a package
list which is available in the Ports Collection either as a
pkg-plist file (with or without variable
substitution), or embedded into the
Makefile via
PLIST_FILES and
PLIST_DIRS. Even if the contents are
auto-generated by a tool or a target in the Makefile
before 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.A dynamic package list 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
make clean.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
Javadoc).Maintainers who prefer dynamic package lists are
encouraged to add a new target to their port which generates
the pkg-plist file so that users may
examine the contents.Automated Package List CreationFirst, make sure your port is almost complete, with only
pkg-plist missing.Next, create a temporary directory tree into which your
port can be installed, and install any dependencies.&prompt.root; mkdir /var/tmp/`make -V PORTNAME`
&prompt.root; mtree -U -f `make -V MTREE_FILE` -d -e -p /var/tmp/`make -V PORTNAME`
&prompt.root; make depends PREFIX=/var/tmp/`make -V PORTNAME`Store the directory structure in a new file.&prompt.root; (cd /var/tmp/`make -V PORTNAME` && find -d * -type d) | sort > OLD-DIRSCreate an empty pkg-plist
file:&prompt.root; :>pkg-plistIf your port honors PREFIX (which it
should) you can then install the port and create the package
list.&prompt.root; make install PREFIX=/var/tmp/`make -V PORTNAME`
&prompt.root; (cd /var/tmp/`make -V PORTNAME` && find -d * \! -type d) | sort > pkg-plistYou must also add any newly created directories to the
packing list.&prompt.root; (cd /var/tmp/`make -V PORTNAME` && find -d * -type d) | sort | comm -13 OLD-DIRS - | sort -r | sed -e 's#^#@dirrm #' >> pkg-plistFinally, you need to tidy up the packing list by hand; it
is not all automated. Manual pages
should be listed in the port's Makefile
under MANn, and
not in the package list. User configuration files should be
removed, or installed as
filename.sample.
The info/dir file should not be listed
and appropriate install-info lines should
be added as noted in the info
files section. Any libraries installed by the port
should be listed as specified in the shared libraries
section.Alternatively, use the plist script in
/usr/ports/Tools/scripts/ to build the
package list automatically. The plist
script is a Ruby script that
automates most of the manual steps outlined in the previous
paragraphs.The first step is the same as above: take the first three
lines, that is, mkdir,
mtree and make depends.
Then build and install the port:&prompt.root; make install PREFIX=/var/tmp/`make -V PORTNAME`And let plist create the
pkg-plist file:&prompt.root; /usr/ports/Tools/scripts/plist -Md -m `make -V MTREE_FILE` /var/tmp/`make -V PORTNAME` > pkg-plistThe packing list still has to be tidied up by hand as
stated above.Another tool that might be used to create an initial
pkg-plist is ports-mgmt/genplist. As with any
automated tool, the resulting pkg-plist
should be checked and manually edited as needed.The pkg-*
FilesThere are some tricks we have not mentioned yet about the
pkg-* files
that come in handy sometimes.pkg-messageIf you need to display a message to the installer, you may
place the message in pkg-message. This
capability is often useful to display additional installation
steps to be taken after a &man.pkg.add.1; or to display
licensing information.When some lines about the build-time knobs or warnings
have to be displayed, use ECHO_MSG. The
pkg-message file is only for
post-installation steps. Likewise, the distinction between
ECHO_MSG and ECHO_CMD
should be kept in mind. The former is for printing
informational text to the screen, while the latter is for
command pipelining:update-etc-shells:
@${ECHO_MSG} "updating /etc/shells"
@${CP} /etc/shells /etc/shells.bak
@( ${GREP} -v ${PREFIX}/bin/bash /etc/shells.bak; \
${ECHO_CMD} ${PREFIX}/bin/bash) >/etc/shells
@${RM} /etc/shells.bakThe pkg-message file does not need
to be added to pkg-plist. 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 post-install target
yourself.pkg-installIf your port needs to execute commands when the binary
package is installed with &man.pkg.add.1; you can do this via
the pkg-install script. This script will
automatically be added to the package, and will be run twice
by &man.pkg.add.1;: the first time as ${SH}
pkg-install ${PKGNAME} PRE-INSTALL and the
second time as ${SH} pkg-install
${PKGNAME} POST-INSTALL.
$2 can be tested to determine which
mode the script is being run in. The
PKG_PREFIX environmental variable will be set
to the package installation directory. See &man.pkg.add.1;
for additional information.This script is not run automatically if you install the
port with make install. If you are
depending on it being run, you will have to explicitly call
it from your port's Makefile, with a
line like PKG_PREFIX=${PREFIX} ${SH}
${PKGINSTALL} ${PKGNAME}
PRE-INSTALL.pkg-deinstallThis script executes when a package is removed.This script will be run twice by &man.pkg.delete.1;.
The first time as ${SH} pkg-deinstall
${PKGNAME} DEINSTALL and the second time as
${SH} pkg-deinstall ${PKGNAME}
POST-DEINSTALL.pkg-reqIf your port needs to determine if it should install or
not, you can create a pkg-reqrequirements script. It will be invoked
automatically at installation/de-installation time to
determine whether or not installation/de-installation should
proceed.The script will be run at installation time by
&man.pkg.add.1; as
pkg-req ${PKGNAME} INSTALL.
At de-installation time it will be run by
&man.pkg.delete.1; as
pkg-req ${PKGNAME} DEINSTALL.Changing the Names of
pkg-*
FilesAll the names of
pkg-* files
are defined using variables so you can change them in your
Makefile if need be. This is especially
useful when you are sharing the same
pkg-* files
among several ports or have to write to one of the above files
(see writing to places other
than WRKDIR for why it is a bad
idea to write directly into the
pkg-*
subdirectory).Here is a list of variable names and their default values.
(PKGDIR defaults to
${MASTERDIR}.)VariableDefault valueDESCR${PKGDIR}/pkg-descrPLIST${PKGDIR}/pkg-plistPKGINSTALL${PKGDIR}/pkg-installPKGDEINSTALL${PKGDIR}/pkg-deinstallPKGREQ${PKGDIR}/pkg-reqPKGMESSAGE${PKGDIR}/pkg-messagePlease change these variables rather than overriding
PKG_ARGS. If you change
PKG_ARGS, those files will not correctly be
installed in /var/db/pkg upon install
from a port.Making Use of SUB_FILES and
SUB_LISTThe SUB_FILES and
SUB_LIST variables are useful for dynamic
values in port files, such as the installation
PREFIX in
pkg-message.The SUB_FILES variable specifies a list
of files to be automatically modified. Each
file in the
SUB_FILES list must have a corresponding
file.in
present in FILESDIR. A modified version
will be created in WRKDIR. Files defined
as a value of USE_RC_SUBR (or the
deprecated USE_RCORDER) are automatically
added to the SUB_FILES. For the files
pkg-message,
pkg-install,
pkg-deinstall and
pkg-req, the corresponding Makefile
variable is automatically set to point to the processed
version.The SUB_LIST variable is a list of
VAR=VALUE pairs. For each pair
%%VAR%% will get replaced with
VALUE in each file listed in
SUB_FILES. Several common pairs are
automatically defined: PREFIX,
LOCALBASE, DATADIR,
DOCSDIR, EXAMPLESDIR,
WWWDIR, and ETCDIR.
Any line beginning with @comment will be
deleted from resulting files after a variable
substitution.The following example will replace
%%ARCH%% with the system architecture in a
pkg-message:SUB_FILES= pkg-message
SUB_LIST= ARCH=${ARCH}Note that for this example, the
pkg-message.in file must exist in
FILESDIR.Example of a good
pkg-message.in: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.Testing Your PortRunning make describeSeveral of the &os; port maintenance tools, such as
&man.portupgrade.1;, rely on a database called
/usr/ports/INDEX which keeps track of
such items as port dependencies. INDEX
is created by the top-level
ports/Makefile via make
index, which descends into each port subdirectory
and executes make describe there. Thus, if
make describe fails in any port, no one can
generate INDEX, and many people will
quickly become unhappy.It is important to be able to generate this file no
matter what options are present in
make.conf, so please avoid doing things
such as using .error statements when (for
instance) a dependency is not satisfied. (See .)If make describe produces a string
rather than an error message, you are probably safe. See
bsd.port.mk for the meaning of the
string produced.Also note that running a recent version of
portlint (as specified in the next section)
will cause make describe to be run
automatically.PortlintDo check your work with portlint
before you submit or commit it. portlint
warns you about many common errors, both functional and
stylistic. For a new (or repocopied) port, portlint
-A is the most thorough; for an existing port,
portlint -C is sufficient.Since portlint 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;.Port ToolsThe ports-mgmt/porttools program is
part of the Ports Collection.port is the front-end script, which can
help you simplify the testing job. Whenever you want to test
a new port or update an existing one, you can use
port test to test your port, including the
portlint
checking. This command also detects and lists any files that
are not listed in pkg-plist. See the
following example:&prompt.root; port test /usr/ports/net/csupPREFIX and
DESTDIRPREFIX determines where the port will
be installed. It defaults to /usr/local,
but can be set by the user to a custom path like
/opt. Your port must respect the value
of this variable.DESTDIR, if set by the user, determines
the complete alternative environment, usually a jail or an
installed system mounted somewhere other than
/. A port will actually install into
DESTDIR/PREFIX,
and register with the package database in
DESTDIR/var/db/pkg.
As DESTDIR is handled automatically by the
ports infrastructure with &man.chroot.8;, you do not need any
modifications or any extra care to write
DESTDIR-compliant ports.The value of PREFIX will be set to
LOCALBASE (defaulting to
/usr/local). If
USE_LINUX_PREFIX is set,
PREFIX will be LINUXBASE
(defaulting to /compat/linux).Avoiding hard-coded /usr/local paths
in the source makes the port much more flexible and able to
cater to the needs of other sites. Often, this can be
accomplished by simply replacing occurrences of
/usr/local in the port's various
Makefiles with
${PREFIX}. This variable is
automatically passed down to every stage of the build and
install processes.Make sure your application is not installing things in
/usr/local instead of
PREFIX. A quick test for such hard-coded
paths is:&prompt.root; make clean; make package PREFIX=/var/tmp/`make -V PORTNAME`If anything is installed outside of
PREFIX, the package creation process will
complain that it cannot find the files.This test will not find hard-coded paths inside the
port's files, nor will it verify that
LOCALBASE is being used to correctly refer
to files from other ports. The temporarily-installed port in
/var/tmp/`make -V PORTNAME` should be
tested for proper operation to make sure there
are no problems with paths.PREFIX should not be set explicitly
in a port's Makefile. Users installing
the port may have set PREFIX to a custom
location, and the port should respect that setting.Refer to programs and files from other ports with the
variables mentioned above, not explicit pathnames. For
instance, if your port requires a macro
PAGER to have the full pathname of
less, do not use a literal path of
/usr/local/bin/less. Instead, use
${LOCALBASE}:-DPAGER=\"${LOCALBASE}/bin/less\"The path with LOCALBASE is more likely
to still work if the system administrator has moved the whole
/usr/local tree somewhere else.TinderboxIf you are an avid ports contributor, you might want to
take a look at Tinderbox. It is a
powerful system for building and testing ports based on the
scripts used on Pointyhat. You can install
Tinderbox using ports-mgmt/tinderbox port. Be
sure to read supplied documentation since the configuration is
not trivial.Visit the Tinderbox
website for more details.Upgrading an Individual PortWhen 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
ports/ports-current 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
Subversion or &man.portsnap.8;
to keep your whole ports
collection up-to-date, as described in the Handbook.
This will have the added benefit of tracking all the ports'
dependencies.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
FreeBSD Problem Report (PR) database (also known as
GNATS). Select ports in
the dropdown, and enter the name of the port.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 FreeBSD Ports
Monitoring System (also known as
portsmon). This system attempts to classify
port PRs by portname. To search for PRs about a particular
port, use the Overview of
One Port.If there is no pending PR, the next step is to send an email
to the port's maintainer, as shown by make
maintainer. 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
ports@FreeBSD.org, which is just the general
ports mailing list, so sending mail there probably will not help
in this case.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 do this by using the
&man.diff.1; command in the base system.To create a suitable diff for a single
patch, copy the file that needs patching to
something.orig, save your changes to
something and then create your
patch:&prompt.user; diff -u something.orig something > something.diffOtherwise, you should either use the svn
diff method () or copy the
contents of the port to an entire different directory and use
the result of the recursive &man.diff.1; output of the new and
old ports directories (e.g., if your modified port directory is
called superedit and the original is in our
tree as superedit.bak, then save the result
of diff -ruN superedit.bak superedit).
Either unified or context diff is fine, but port committers
generally prefer unified diffs. Note the use of the
-N 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. (In particular, make sure you first clean out the work
directories with make clean).To simplify common operations with patch files, you can use
/usr/ports/Tools/scripts/patchtool.py.
Before using it, please read
/usr/ports/Tools/scripts/README.patchtool.If the port is unmaintained, and you are actively using
it yourself, please consider volunteering to become its
maintainer. &os; has over 4000 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 section in the
Developer's Handbook.) The best way to send us the diff is by including it via
&man.send-pr.1; (category ports). If you are
maintaining the port, be sure to put [maintainer
update] at the beginning of your synopsis line and set
the Class of your PR to
maintainer-update. Otherwise, the
Class of your PR should be
change-request. Please mention any added or
deleted files in the message, as they have to be explicitly
specified to &man.svn.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.Before you &man.send-pr.1;, you should review the
Writing the problem report section in the Problem
Reports article; it contains far more information about how to
write useful problem reports.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 pkg_add -r for several
weeks.Once again, please use &man.diff.1; and not &man.shar.1;
to send updates to existing ports! This helps ports
committers understand exactly what is being changed.Now that you have done all that, you will want to read about
how to keep up-to-date in .Using SVN to Make PatchesIf you can, please submit a &man.svn.1; diff — they
are easier to handle than diffs between new and
old directories. Plus it is easier for you to see
what you have changed and to update your diff if something is
modified in the Ports Collection from when you started to work
on it until you submit your changes, or if the committer asks
you to fix something.&prompt.user; cd ~/my_wrkdir
&prompt.user; svn co https://svn0.us-west.FreeBSD.org/ports/head/dns/pdnsd
&prompt.user; cd ~/my_wrkdir/pdnsdThis can be anywhere you want, of course; building
ports is not limited to within /usr/ports/.svn0.us-west.FreeBSD.org
is a public SVN server.
Select the closest mirror and verify the mirror server
certificate from the list of Subversion
mirror sites.While in the working directory, make any changes that you
would usually make to the port. If you add or remove a file,
use svn to track these changes:&prompt.user; svn add new_file
&prompt.user; svn remove deleted_fileMake sure that you check the port using the checklist in
and
.&prompt.user; svn status
&prompt.user; svn updateThis will try to merge the differences between your
patch and current SVN; watch the output carefully. The
letter in front of each file name indicates what was done
with it. See for a
complete list.
SVN Update File PrefixesUThe file was updated without problems.GThe file was updated without problems (you will
only see this when working against a remote
repository).MThe file had been modified, and was merged
without conflicts.CThe file had been modified, and was merged with
conflicts.
If you get C as a result of
svn update it means something changed in
the SVN repository and &man.svn.1; was not able to merge your
local changes and those from the repository. It is always a
good idea to inspect the changes anyway, since &man.svn.1;
does not know anything about how a port should be, so it might
(and probably will) merge things that do not make
sense.The last step is to make a unified &man.diff.1;
of the files against SVN:&prompt.user; svn diff > ../`basename ${PWD}`.diffAny files that have been removed should be explicitly
mentioned in the PR, because file removal may not be obvious
to the committer.Send your patch following the guidelines in
.The Files UPDATING and
MOVEDIf upgrading the port requires special steps like
changing configuration files or running a specific program,
you should document this in the file
/usr/ports/UPDATING. The format of
an entry in this file is as follows:YYYYMMDD:
AFFECTS: users of portcategory/portname
AUTHOR: Your name <Your email address>
Special instructionsIf you are including exact portmaster or portupgrading
instructions, please make sure to get the shell escaping
right.The /usr/ports/MOVED file is used to
list moved or removed ports. Each line in the file is made
up of the name of the port, where the port was moved to, when,
and why. If the port was removed, the section detailing where
it was moved to can be left blank. Each section must be
separated by the | (pipe) character, like
so:old name|new name (blank for deleted)|date of move|reasonThe date should be entered in the form
YYYY-MM-DD. New entries should be added to
the end of the file to keep it in chronological order.If a port was removed but has since been restored,
delete the line in this file that states that it was
removed.The changes can be validated with
Tools/scripts/MOVEDlint.awk.Ports SecurityWhy Security is So ImportantBugs 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.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.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.Fixing Security VulnerabilitiesWhile 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 mark the port as
FORBIDDEN 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, the standard procedure for
submitting your change should be followed unless you
have rights to commit it directly to the ports tree.Being a ports committer is not enough to commit to
an arbitrary port. Remember that ports usually have
maintainers, whom you should respect.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.
PORTREVISION should be bumped unless
PORTVERSION has changed in the course
of correcting the vulnerability. That is you should
bump PORTREVISION 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 PORTVERSION. Please refer to the
corresponding
section for more information.Keeping the Community InformedThe VuXML DatabaseA very important and urgent step to take as early after
a security vulnerability is discovered as possible 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 only occasionally. They will know from the
notification that they must update the
package without delay as soon as a corrected version is
available.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 when it comes to really serious
matters. Therefore security vulnerabilities found in
ports are recorded in the FreeBSD VuXML
database. The Security Officer Team members
also monitor it for issues requiring their
intervention.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 please do not hesitate to
contact the Security Officer Team directly as described
on the FreeBSD
Security Information page.The VuXML database is an
XML document. Its source file vuln.xml
is kept right inside the port security/vuxml. Therefore
the file's full pathname will be
PORTSDIR/security/vuxml/vuln.xml.
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 it as a template.A Short Introduction to VuXMLThe full-blown XML format 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. This is similar to
HTML. The major difference is that XML is
eXtensible, 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.Now consider a realistic VuXML entry:<vuln vid="f4bc80f4-da62-11d8-90ea-0004ac98a7b9">
<topic>Several vulnerabilities found in Foo</topic>
<affects>
<package>
<name>foo</name>
<name>foo-devel</name>
<name>ja-foo</name>
<range><ge>1.6</ge><lt>1.9</lt></range>
<range><ge>2.*</ge><lt>2.4_1</lt></range>
<range><eq>3.0b1</eq></range>
</package>
<package>
<name>openfoo</name>
<range><lt>1.10_7</lt></range>
<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>
<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>
<freebsdsa>SA-10:75.foo</freebsdsa>
<freebsdpr>ports/987654</freebsdpr>
<cvename>CAN-2010-0201</cvename>
<cvename>CAN-2010-0466</cvename>
<bid>96298</bid>
<certsa>CA-2010-99</certsa>
<certvu>740169</certvu>
<uscertsa>SA10-99A</uscertsa>
<uscertta>SA10-99A</uscertta>
<mlist msgid="201075606@hacker.com">http://marc.theaimsgroup.com/?l=bugtraq&m=203886607825605</mlist>
<url>http://j.r.hacker.com/advisories/1</url>
</references>
<dates>
<discovery>2010-05-25</discovery>
<entry>2010-07-13</entry>
<modified>2010-09-17</modified>
</dates>
</vuln>The tag names are supposed to be self-explanatory
so we shall take a closer look only at fields you will need
to fill in by yourself:This is the top-level tag of a VuXML entry. It has
a mandatory attribute, vid,
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; to generate
a VuXML UUID.This is a one-line description of the issue
found.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.It is your responsibility to find all such related
packages when writing a VuXML entry. Keep in mind
that make search name=foo is your
friend. The primary points to look for are as
follows:the foo-devel variant
for a foo port;other variants with a suffix like
-a4 (for print-related
packages), -without-gui (for
packages with X support disabled), or
similar;jp-,
ru-, zh-,
and other possible localized variants in the
corresponding national categories of the ports
collection.Affected versions of the package(s) are specified
there as one or more ranges using a combination of
<lt>,
<le>,
<eq>,
<ge>, and
<gt> elements. The version
ranges given should not overlap.In a range specification, *
(asterisk) denotes the smallest version number. In
particular, 2.* is less than
2.a. Therefore an asterisk may be
used for a range to match all possible
alpha, beta, and
RC versions. For instance,
<ge>2.*</ge><lt>3.*</lt>
will selectively match every 2.x
version while
<ge>2.0</ge><lt>3.0</lt>
will not since the latter misses
2.r3 and matches
3.b.The above example specifies that affected are
versions from 1.6 to
1.9 inclusive, versions
2.x before 2.4_1,
and version 3.0b1.Several related package groups (essentially, ports)
can be listed in the <affected>
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.The version ranges should allow for
PORTEPOCH and
PORTREVISION if applicable. Please
remember that according to the collation rules, a
version with a non-zero PORTEPOCH is
greater than any version without
PORTEPOCH, e.g.,
3.0,1 is greater than
3.1 or even than
8.9.This is a summary of the issue. XHTML is used in
this field. At least enclosing
<p> and
</p> should appear. More
complex mark-up may be used, but only for the sake of
accuracy and clarity: No eye candy please.This section contains references to relevant
documents. As many references as apply are
encouraged.This is a FreeBSD
security advisory.This is a FreeBSD
problem report.This is a MITRE
CVE identifier.This is a SecurityFocus
Bug ID.This is a
US-CERT
security advisory.This is a US-CERT
vulnerability note.This is a US-CERT
Cyber Security Alert.This is a US-CERT
Technical Cyber Security Alert.This is a URL to an archived posting in a mailing
list. The attribute msgid is
optional and may specify the message ID of the
posting.This is a generic URL. It should be used only if
none of the other reference categories apply.This is the date when the issue was disclosed
(YYYY-MM-DD).This is the date when the entry was added
(YYYY-MM-DD).This is the date when any information in the entry
was last modified
(YYYY-MM-DD). New entries
must not include this field. It should be added upon
editing an existing entry.Testing Your Changes to the VuXML DatabaseAssume you just wrote or filled in an entry for a
vulnerability in the package clamav that
has been fixed in version 0.65_7.As a prerequisite, you need to
install fresh versions of the ports
ports-mgmt/portaudit,
ports-mgmt/portaudit-db,
and security/vuxml.To run packaudit you must have
permission to write to its
DATABASEDIR,
typically /var/db/portaudit.To use a different directory set the
DATABASEDIR
environment variable to a different location.If you are working in a directory other than
${PORTSDIR}/security/vuxml set the
VUXMLDIR
environment variable to the directory where
vuln.xml is located.First, check whether there already is an entry for this
vulnerability. If there were such an entry, it would match
the previous version of the package,
0.65_6:&prompt.user; packaudit
&prompt.user; portaudit clamav-0.65_6If there is none found, you have the green light to add
a new entry for this vulnerability.&prompt.user; cd ${PORTSDIR}/security/vuxml
&prompt.user; make newentryWhen you are done verify its syntax and
formatting.&prompt.user; make validateYou will need at least one of the following packages
installed: textproc/libxml2, textproc/jade.Now rebuild the portaudit database
from the VuXML file:&prompt.user; packauditTo verify that the <affected>
section of your entry will match correct package(s), issue
the following command:&prompt.user; portaudit -f /usr/ports/INDEX -r uuidPlease refer to &man.portaudit.1; for better
understanding of the command syntax.Make sure that your entry produces no spurious matches
in the output.Now check whether the right package versions are matched
by your entry:&prompt.user; portaudit clamav-0.65_6 clamav-0.65_7
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.The former version should match while the
latter one should not.Finally, verify whether the web page generated from the
VuXML database looks like expected:&prompt.user; mkdir -p ~/public_html/portaudit
&prompt.user; packaudit
&prompt.user; lynx ~/public_html/portaudit/74a9541d-5d6c-11d8-80e3-0020ed76ef5a.htmlDos and Don'tsIntroductionHere 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 PR
database that others have submitted. Submit any
comments on ports you check as described in Bug
Reports and General Commentary. 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.WRKDIRDo not write anything to files outside
WRKDIR. WRKDIR is the
only place that is guaranteed to be writable during the port
build (see
installing ports from a CDROM for an example of
building ports from a read-only tree). If you need to modify
one of the
pkg-* files,
do so by redefining a variable, not
by writing over it.WRKDIRPREFIXMake sure your port honors
WRKDIRPREFIX. Most ports do not have to
worry about this. In particular, if you are referring to a
WRKDIR of another port, note that the
correct location is
WRKDIRPREFIXPORTSDIR/subdir/name/work
not
PORTSDIR/subdir/name/work
or
.CURDIR/../../subdir/name/work
or some such.Also, if you are defining WRKDIR
yourself, make sure you prepend
${WRKDIRPREFIX}${.CURDIR} in
the front.Differentiating Operating Systems and OS VersionsYou 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.The preferred way to tell 4.3BSD/Reno (1990) and newer
versions of the BSD code apart is by using the
BSD macro defined in sys/param.h.
Hopefully that file is already included; if not, add the
code:#if (defined(__unix__) || defined(unix)) && !defined(USG)
#include <sys/param.h>
#endifto the proper place in the .c file.
We believe that every system that defines these two symbols
has sys/param.h. If you find a system
that does not, we would like to know. Please send mail to the
&a.ports;.Another way is to use the GNU Autoconf style of doing
this:#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endifDo not forget to add -DHAVE_SYS_PARAM_H
to the CFLAGS in the
Makefile for this method.Once you have sys/param.h included,
you may use:#if (defined(BSD) && (BSD >= 199103))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).Use:#if (defined(BSD) && (BSD >= 199306))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).The value of the BSD macro is
199506 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 versus versions that have merged in changes from
4.4-Lite2. The __FreeBSD__ macro should be
used instead.Use sparingly:__FreeBSD__ is defined in all
versions of FreeBSD. Use it if the change you are making
only affects FreeBSD. Porting
gotchas like the use of sys_errlist[]
versus strerror() are Berkeley-isms,
not FreeBSD changes.In FreeBSD 2.x, __FreeBSD__ is
defined to be 2. In earlier versions,
it is 1. Later versions always bump it
to match their major version number.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 BSD macros
described above. If there actually is a FreeBSD specific
change (such as special shared library options when using
ld) then it is OK to use
__FreeBSD__ and #if
__FreeBSD__ > 1 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:#if __FreeBSD__ >= 2
#include <osreldate.h>
# if __FreeBSD_version >= 199504
/* 2.0.5+ release specific code here */
# endif
#endifIn the hundreds of ports that have been done, there have
only been one or two cases where
__FreeBSD__ 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.__FreeBSD_version ValuesHere is a convenient list of
__FreeBSD_version values as defined in
sys/param.h:
__FreeBSD_version ValuesValueDateRelease1194112.0-RELEASE199501, 199503March 19, 19952.1-CURRENT199504April 9, 19952.0.5-RELEASE199508August 26, 19952.2-CURRENT before 2.1199511November 10, 19952.1.0-RELEASE199512November 10, 19952.2-CURRENT before 2.1.5199607July 10, 19962.1.5-RELEASE199608July 12, 19962.2-CURRENT before 2.1.6199612November 15, 19962.1.6-RELEASE1996122.1.7-RELEASE220000February 19, 19972.2-RELEASE(not changed)2.2.1-RELEASE(not changed)2.2-STABLE after 2.2.1-RELEASE221001April 15, 19972.2-STABLE after texinfo-3.9221002April 30, 19972.2-STABLE after top222000May 16, 19972.2.2-RELEASE222001May 19, 19972.2-STABLE after 2.2.2-RELEASE225000October 2, 19972.2.5-RELEASE225001November 20, 19972.2-STABLE after 2.2.5-RELEASE225002December 27, 19972.2-STABLE after ldconfig -R merge226000March 24, 19982.2.6-RELEASE227000July 21, 19982.2.7-RELEASE227001July 21, 19982.2-STABLE after 2.2.7-RELEASE227002September 19, 19982.2-STABLE after &man.semctl.2; change228000November 29, 19982.2.8-RELEASE228001November 29, 19982.2-STABLE after 2.2.8-RELEASE300000February 19, 19963.0-CURRENT before &man.mount.2; change300001September 24, 19973.0-CURRENT after &man.mount.2; change300002June 2, 19983.0-CURRENT after &man.semctl.2; change300003June 7, 19983.0-CURRENT after ioctl arg changes300004September 3, 19983.0-CURRENT after ELF conversion300005October 16, 19983.0-RELEASE300006October 16, 19983.0-CURRENT after 3.0-RELEASE300007January 22, 19993.0-STABLE after 3/4 branch310000February 9, 19993.1-RELEASE310001March 27, 19993.1-STABLE after 3.1-RELEASE310002April 14, 19993.1-STABLE after C++ constructor/destructor order
change3200003.2-RELEASE320001May 8, 19993.2-STABLE320002August 29, 19993.2-STABLE after binary-incompatible IPFW and
socket changes330000September 2, 19993.3-RELEASE330001September 16, 19993.3-STABLE330002November 24, 19993.3-STABLE after adding &man.mkstemp.3;
to libc340000December 5, 19993.4-RELEASE340001December 17, 19993.4-STABLE350000June 20, 20003.5-RELEASE350001July 12, 20003.5-STABLE400000January 22, 19994.0-CURRENT after 3.4 branch400001February 20, 19994.0-CURRENT after change in dynamic linker
handling400002March 13, 19994.0-CURRENT after C++ constructor/destructor
order change400003March 27, 19994.0-CURRENT after functioning
&man.dladdr.3;400004April 5, 19994.0-CURRENT after __deregister_frame_info dynamic
linker bug fix (also 4.0-CURRENT after EGCS 1.1.2
integration)400005April 27, 19994.0-CURRENT after &man.suser.9; API change
(also 4.0-CURRENT after newbus)400006May 31, 19994.0-CURRENT after cdevsw registration
change400007June 17, 19994.0-CURRENT after the addition of so_cred for
socket level credentials400008June 20, 19994.0-CURRENT after the addition of a poll syscall
wrapper to libc_r400009July 20, 19994.0-CURRENT after the change of the kernel's
dev_t type to struct
specinfo pointer400010September 25, 19994.0-CURRENT after fixing a hole
in &man.jail.2;400011September 29, 19994.0-CURRENT after the sigset_t
datatype change400012November 15, 19994.0-CURRENT after the cutover to the GCC 2.95.2
compiler400013December 4, 19994.0-CURRENT after adding pluggable linux-mode
ioctl handlers400014January 18, 20004.0-CURRENT after importing OpenSSL400015January 27, 20004.0-CURRENT after the C++ ABI change in GCC
2.95.2 from -fvtable-thunks to -fno-vtable-thunks by
default400016February 27, 20004.0-CURRENT after importing OpenSSH400017March 13, 20004.0-RELEASE400018March 17, 20004.0-STABLE after 4.0-RELEASE400019May 5, 20004.0-STABLE after the introduction of delayed
checksums.400020June 4, 20004.0-STABLE after merging libxpg4 code into
libc.400021July 8, 20004.0-STABLE after upgrading Binutils to 2.10.0,
ELF branding changes, and tcsh in the base
system.410000July 14, 20004.1-RELEASE410001July 29, 20004.1-STABLE after 4.1-RELEASE410002September 16, 20004.1-STABLE after &man.setproctitle.3; moved from
libutil to libc.411000September 25, 20004.1.1-RELEASE4110014.1.1-STABLE after 4.1.1-RELEASE420000October 31, 20004.2-RELEASE420001January 10, 20014.2-STABLE after combining libgcc.a and
libgcc_r.a, and associated GCC linkage
changes.430000March 6, 20014.3-RELEASE430001May 18, 20014.3-STABLE after wint_t introduction.430002July 22, 20014.3-STABLE after PCI powerstate API
merge.440000August 1, 20014.4-RELEASE440001October 23, 20014.4-STABLE after d_thread_t introduction.440002November 4, 20014.4-STABLE after mount structure changes (affects
filesystem klds).440003December 18, 20014.4-STABLE after the userland components of smbfs
were imported.450000December 20, 20014.5-RELEASE450001February 24, 20024.5-STABLE after the usb structure element
rename.450004April 16, 20024.5-STABLE after the
sendmail_enable &man.rc.conf.5;
variable was made to take the value
NONE.450005April 27, 20024.5-STABLE after moving to XFree86 4 by default
for package builds.450006May 1, 20024.5-STABLE after accept filtering was fixed so
that is no longer susceptible to an easy DoS.460000June 21, 20024.6-RELEASE460001June 21, 20024.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.460002July 19, 20024.6.2-RELEASE460100June 26, 20024.6-STABLE460101June 26, 20024.6-STABLE after MFC of `sed -i'.460102September 1, 20024.6-STABLE after MFC of many new pkg_install
features from the HEAD.470000October 8, 20024.7-RELEASE470100October 9, 20024.7-STABLE470101November 10, 2002Start 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.470102January 23, 20034.7-STABLE after MFC of mbuf changes to replace
m_aux mbufs by m_tag's470103February 14, 20034.7-STABLE gets OpenSSL 0.9.7480000March 30, 20034.8-RELEASE480100April 5, 20034.8-STABLE480101May 22, 20034.8-STABLE after &man.realpath.3; has been made
thread-safe480102August 10, 20034.8-STABLE 3ware API changes to twe.490000October 27, 20034.9-RELEASE490100October 27, 20034.9-STABLE490101January 8, 20044.9-STABLE after e_sid was added to struct
kinfo_eproc.490102February 4, 20044.9-STABLE after MFC of libmap functionality
for rtld.491000May 25, 20044.10-RELEASE491100June 1, 20044.10-STABLE491101August 11, 20044.10-STABLE after MFC of revision 20040629 of
the package tools491102November 16, 20044.10-STABLE after VM fix dealing with unwiring
of fictitious pages492000December 17, 20044.11-RELEASE492100December 17, 20044.11-STABLE492101April 18, 20064.11-STABLE after adding libdata/ldconfig
directories to mtree files.500000March 13, 20005.0-CURRENT500001April 18, 20005.0-CURRENT after adding addition ELF header
fields, and changing our ELF binary branding
method.500002May 2, 20005.0-CURRENT after kld metadata changes.500003May 18, 20005.0-CURRENT after buf/bio changes.500004May 26, 20005.0-CURRENT after binutils upgrade.500005June 3, 20005.0-CURRENT after merging libxpg4 code into
libc and after TASKQ interface introduction.500006June 10, 20005.0-CURRENT after the addition of AGP
interfaces.500007June 29, 20005.0-CURRENT after Perl upgrade to 5.6.0500008July 7, 20005.0-CURRENT after the update of KAME code to
2000/07 sources.500009July 14, 20005.0-CURRENT after ether_ifattach() and
ether_ifdetach() changes.500010July 16, 20005.0-CURRENT after changing mtree defaults
back to original variant, adding -L to follow
symlinks.500011July 18, 20005.0-CURRENT after kqueue API changed.500012September 2, 20005.0-CURRENT after &man.setproctitle.3; moved from
libutil to libc.500013September 10, 20005.0-CURRENT after the first SMPng commit.500014January 4, 20015.0-CURRENT after <sys/select.h> moved to
<sys/selinfo.h>.500015January 10, 20015.0-CURRENT after combining libgcc.a and
libgcc_r.a, and associated GCC linkage
changes.500016January 24, 20015.0-CURRENT after change allowing libc and libc_r
to be linked together, deprecating -pthread
option.500017February 18, 20015.0-CURRENT after switch from struct ucred to
struct xucred to stabilize kernel-exported API for
mountd et al.500018February 24, 20015.0-CURRENT after addition of CPUTYPE make
variable for controlling CPU-specific
optimizations.500019June 9, 20015.0-CURRENT after moving machine/ioctl_fd.h to
sys/fdcio.h500020June 15, 20015.0-CURRENT after locale names renaming.500021June 22, 20015.0-CURRENT after Bzip2 import.
Also signifies removal of S/Key.500022July 12, 20015.0-CURRENT after SSE support.500023September 14, 20015.0-CURRENT after KSE Milestone 2.500024October 1, 20015.0-CURRENT after d_thread_t,
and moving UUCP to ports.500025October 4, 20015.0-CURRENT after ABI change for descriptor
and creds passing on 64 bit platforms.500026October 9, 20015.0-CURRENT after moving to XFree86 4 by default
for package builds, and after the new libc strnstr()
function was added.500027October 10, 20015.0-CURRENT after the new libc strcasestr()
function was added.500028December 14, 20015.0-CURRENT after the userland components of
smbfs were imported.(not changed)5.0-CURRENT after the new C99 specific-width
integer types were added.500029January 29, 20025.0-CURRENT after a change was made in the return
value of &man.sendfile.2;.500030February 15, 20025.0-CURRENT after the introduction of the
type fflags_t, which is the
appropriate size for file flags.500031February 24, 20025.0-CURRENT after the usb structure element
rename.500032March 16, 20025.0-CURRENT after the introduction of
Perl 5.6.1.500033April 3, 20025.0-CURRENT after the
sendmail_enable &man.rc.conf.5;
variable was made to take the value
NONE.500034April 30, 20025.0-CURRENT after mtx_init() grew a third
argument.500035May 13, 20025.0-CURRENT with Gcc 3.1.500036May 17, 20025.0-CURRENT without Perl in /usr/src500037May 29, 20025.0-CURRENT after the addition of
&man.dlfunc.3;500038July 24, 20025.0-CURRENT after the types of some struct
sockbuf members were changed and the structure was
reordered.500039September 1, 20025.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.500040September 20, 20025.0-CURRENT after various changes to disk
functions were made in the name of removing dependency
on disklabel structure internals.500041October 1, 20025.0-CURRENT after the addition of
&man.getopt.long.3; to libc.500042October 15, 20025.0-CURRENT after Binutils 2.13 upgrade, which
included new FreeBSD emulation, vec, and output
format.500043November 1, 20025.0-CURRENT after adding weak pthread_XXX stubs
to libc, obsoleting libXThrStub.so.
5.0-RELEASE.500100January 17, 20035.0-CURRENT after branching for
RELENG_5_0500101February 19, 2003<sys/dkstat.h> is empty and should
not be included.500102February 25, 20035.0-CURRENT after the d_mmap_t interface
change.500103February 26, 20035.0-CURRENT after taskqueue_swi changed to run
without Giant, and taskqueue_swi_giant added to run
with Giant.500104February 27, 2003cdevsw_add() and cdevsw_remove() no
longer exists.
Appearance of MAJOR_AUTO allocation facility.500105March 4, 20035.0-CURRENT after new cdevsw initialization
method.500106March 8, 2003devstat_add_entry() has been replaced by
devstat_new_entry()500107March 15, 2003Devstat interface change; see sys/sys/param.h
1.149500108March 15, 2003Token-Ring interface changes.500109March 25, 2003Addition of vm_paddr_t.500110March 28, 20035.0-CURRENT after &man.realpath.3; has been made
thread-safe500111April 9, 20035.0-CURRENT after &man.usbhid.3; has been synced
with NetBSD500112April 17, 20035.0-CURRENT after new NSS implementation
and addition of POSIX.1 getpw*_r, getgr*_r
functions500113May 2, 20035.0-CURRENT after removal of the old rc
system.501000June 4, 20035.1-RELEASE.501100June 2, 20035.1-CURRENT after branching for
RELENG_5_1.501101June 29, 20035.1-CURRENT after correcting the semantics of
sigtimedwait(2) and sigwaitinfo(2).501102July 3, 20035.1-CURRENT after adding the lockfunc and
lockfuncarg fields to
&man.bus.dma.tag.create.9;.501103July 31, 20035.1-CURRENT after GCC 3.3.1-pre 20030711 snapshot
integration.501104August 5, 20035.1-CURRENT 3ware API changes to twe.501105August 17, 20035.1-CURRENT dynamically-linked /bin and /sbin
support and movement of libraries to /lib.501106September 8, 20035.1-CURRENT after adding kernel support for
Coda 6.x.501107September 17, 20035.1-CURRENT after 16550 UART constants moved from
<dev/sio/sioreg.h> to
<dev/ic/ns16550.h>.
Also when libmap functionality was unconditionally
supported by rtld.501108September 23, 20035.1-CURRENT after PFIL_HOOKS API update501109September 27, 20035.1-CURRENT after adding kiconv(3)501110September 28, 20035.1-CURRENT after changing default operations
for open and close in cdevsw501111October 16, 20035.1-CURRENT after changed layout of
cdevsw501112October 16, 2003 5.1-CURRENT after adding kobj multiple
inheritance501113October 31, 2003 5.1-CURRENT after the if_xname change in
struct ifnet501114November 16, 2003 5.1-CURRENT after changing /bin and /sbin to
be dynamically linked502000December 7, 20035.2-RELEASE502010February 23, 20045.2.1-RELEASE502100December 7, 20035.2-CURRENT after branching for
RELENG_5_2502101December 19, 20035.2-CURRENT after __cxa_atexit/__cxa_finalize
functions were added to libc.502102January 30, 20045.2-CURRENT after change of default thread
library from libc_r to libpthread.502103February 21, 20045.2-CURRENT after device driver API
megapatch.502104February 25, 20045.2-CURRENT after getopt_long_only()
addition.502105March 5, 20045.2-CURRENT after NULL is made into ((void *)0)
for C, creating more warnings.502106March 8, 20045.2-CURRENT after pf is linked to the build and
install.502107March 10, 20045.2-CURRENT after time_t is changed to a
64-bit value on sparc64.502108March 12, 20045.2-CURRENT after Intel C/C++ compiler support in
some headers and execve(2) changes to be more strictly
conforming to POSIX.502109March 22, 20045.2-CURRENT after the introduction of the
bus_alloc_resource_any API502110March 27, 20045.2-CURRENT after the addition of UTF-8
locales502111April 11, 20045.2-CURRENT after the removal of the getvfsent(3)
API502112April 13, 20045.2-CURRENT after the addition of the .warning
directive for make.502113June 4, 20045.2-CURRENT after ttyioctl() was made mandatory
for serial drivers.502114June 13, 20045.2-CURRENT after import of the ALTQ
framework.502115June 14, 20045.2-CURRENT after changing sema_timedwait(9) to
return 0 on success and a non-zero error code on
failure.502116June 16, 20045.2-CURRENT after changing kernel dev_t to be
pointer to struct cdev *.502117June 17, 20045.2-CURRENT after changing kernel udev_t to
dev_t.502118June 17, 20045.2-CURRENT after adding support for
CLOCK_VIRTUAL and CLOCK_PROF to clock_gettime(2) and
clock_getres(2).502119June 22, 20045.2-CURRENT after changing network interface
cloning overhaul.502120July 2, 20045.2-CURRENT after the update of the package tools
to revision 20040629.502121July 9, 20045.2-CURRENT after marking Bluetooth code as
non-i386 specific.502122July 11, 20045.2-CURRENT after the introduction of the KDB
debugger framework, the conversion of DDB into a
backend and the introduction of the GDB
backend.502123July 12, 20045.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
xorg was also made at this
time.502124July 24, 20045.2-CURRENT after the change to separate the way
ports rc.d and legacy scripts are started.502125July 28, 20045.2-CURRENT after the backout of the previous
change.502126July 31, 20045.2-CURRENT after the removal of
kmem_alloc_pageable() and the import of gcc
3.4.2.502127August 2, 20045.2-CURRENT after changing the UMA kernel
API to allow ctors/inits to fail.502128August 8, 20045.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.503000August 23, 20045.3-BETA/RC before the pfil API change503001September 22, 20045.3-RELEASE503100October 16, 20045.3-STABLE after branching for RELENG_5_3503101December 3, 20045.3-STABLE after addition of glibc style
&man.strftime.3; padding options.503102February 13, 20055.3-STABLE after OpenBSD's nc(1) import
MFC.503103February 27, 20055.4-PRERELEASE after the MFC of the fixes in
<src/include/stdbool.h> and
<src/sys/i386/include/_types.h>
for using the GCC-compatibility of the Intel C/C++
compiler.503104February 28, 20055.4-PRERELEASE after the MFC of the change of
ifi_epoch from wall clock time to uptime.503105March 2, 20055.4-PRERELEASE after the MFC of the fix of
EOVERFLOW check in vswprintf(3).504000April 3, 20055.4-RELEASE.504100April 3, 20055.4-STABLE after branching for RELENG_5_4504101May 11, 20055.4-STABLE after increasing the default
thread stacksizes504102June 24, 20055.4-STABLE after the addition of sha256504103October 3, 20055.4-STABLE after the MFC of if_bridge504104November 13, 20055.4-STABLE after the MFC of bsdiff and
portsnap504105January 17, 20065.4-STABLE after MFC of ldconfig_local_dirs
change.505000May 12, 20065.5-RELEASE.505100May 12, 20065.5-STABLE after branching for RELENG_5_5600000August 18, 20046.0-CURRENT600001August 27, 20046.0-CURRENT after permanently enabling PFIL_HOOKS
in the kernel.600002August 30, 20046.0-CURRENT after initial addition of
ifi_epoch to struct if_data. Backed out after a
few days. Do not use this value.600003September 8, 20046.0-CURRENT after the re-addition of the
ifi_epoch member of struct if_data.600004September 29, 20046.0-CURRENT after addition of the struct inpcb
argument to the pfil API.600005October 5, 20046.0-CURRENT after addition of the "-d
DESTDIR" argument to newsyslog.600006November 4, 20046.0-CURRENT after addition of glibc style
&man.strftime.3; padding options.600007December 12, 20046.0-CURRENT after addition of 802.11 framework
updates.600008January 25, 20056.0-CURRENT after changes to VOP_*VOBJECT()
functions and introduction of MNTK_MPSAFE flag for
Giantfree filesystems.600009February 4, 20056.0-CURRENT after addition of the cpufreq
framework and drivers.600010February 6, 20056.0-CURRENT after importing OpenBSD's
nc(1).600011February 12, 20056.0-CURRENT after removing semblance of SVID2
matherr() support.600012February 15, 20056.0-CURRENT after increase of default thread
stacks' size.600013February 19, 20056.0-CURRENT after fixes in
<src/include/stdbool.h> and
<src/sys/i386/include/_types.h>
for using the GCC-compatibility of the Intel C/C++
compiler.600014February 21, 20056.0-CURRENT after EOVERFLOW checks in
vswprintf(3) fixed.600015February 25, 20056.0-CURRENT after changing the struct if_data
member, ifi_epoch, from wall clock time to
uptime.600016February 26, 20056.0-CURRENT after LC_CTYPE disk format
changed.600017February 27, 20056.0-CURRENT after NLS catalogs disk format
changed.600018February 27, 20056.0-CURRENT after LC_COLLATE disk format
changed.600019February 28, 2005Installation of acpica includes into
/usr/include.600020March 9, 2005Addition of MSG_NOSIGNAL flag to send(2)
API.600021March 17, 2005Addition of fields to cdevsw600022March 21, 2005Removed gtar from base system.600023April 13, 2005LOCAL_CREDS, LOCAL_CONNWAIT socket options added
to unix(4).600024April 19, 2005&man.hwpmc.4; and related tools added to
6.0-CURRENT.600025April 26, 2005struct icmphdr added to 6.0-CURRENT.600026May 3, 2005pf updated to 3.7.600027May 6, 2005Kernel libalias and ng_nat introduced.600028May 13, 2005POSIX ttyname_r(3) made available through
unistd.h and libc.600029May 29, 20056.0-CURRENT after libpcap updated to v0.9.1 alpha
096.600030June 5, 20056.0-CURRENT after importing NetBSD's
if_bridge(4).600031June 10, 20056.0-CURRENT after struct ifnet was broken out
of the driver softcs.600032July 11, 20056.0-CURRENT after the import of libpcap
v0.9.1.600033July 25, 20056.0-STABLE after bump of all shared library
versions that had not been changed since
RELENG_5.600034August 13, 20056.0-STABLE after credential argument is added to
dev_clone event handler. 6.0-RELEASE.600100November 1, 20056.0-STABLE after 6.0-RELEASE600101December 21, 20056.0-STABLE after incorporating scripts from the
local_startup directories into the base
&man.rcorder.8;.600102December 30, 20056.0-STABLE after updating the ELF types and
constants.600103January 15, 20066.0-STABLE after MFC of pidfile(3) API.600104January 17, 20066.0-STABLE after MFC of ldconfig_local_dirs
change.600105February 26, 20066.0-STABLE after NLS catalog support of
csh(1).601000May 6, 20066.1-RELEASE601100May 6, 20066.1-STABLE after 6.1-RELEASE.601101June 22, 20066.1-STABLE after the import of csup.601102July 11, 20066.1-STABLE after the iwi(4) update.601103July 17, 20066.1-STABLE after the resolver update to
BIND9, and exposure of reentrant version of
netdb functions.601104August 8, 20066.1-STABLE after DSO (dynamic shared
objects) support has been enabled in
OpenSSL.601105September 2, 20066.1-STABLE after 802.11 fixups changed the
api for the IEEE80211_IOC_STA_INFO ioctl.602000November 15, 20066.2-RELEASE602100September 15, 20066.2-STABLE after 6.2-RELEASE.602101December 12, 20066.2-STABLE after the addition of Wi-Spy
quirk.602102December 28, 20066.2-STABLE after pci_find_extcap()
addition.602103January 16, 20076.2-STABLE after MFC of dlsym change to look for
a requested symbol both in specified dso and its
implicit dependencies.602104January 28, 20076.2-STABLE after MFC of ng_deflate(4) and
ng_pred1(4) netgraph nodes and new compression and
encryption modes for ng_ppp(4) node.602105February 20, 20076.2-STABLE after MFC of BSD licensed version of
&man.gzip.1; ported from NetBSD.602106March 31, 20076.2-STABLE after MFC of PCI MSI and MSI-X
support.602107April 6, 20076.2-STABLE after MFC of ncurses 5.6 and wide
character support.602108April 11, 20076.2-STABLE after MFC of CAM 'SG' peripheral
device, which implements a subset of Linux SCSI SG
passthrough device API.602109April 17, 20076.2-STABLE after MFC of readline 5.2 patchset
002.602110May 2, 20076.2-STABLE after MFC of pmap_invalidate_cache(),
pmap_change_attr(), pmap_mapbios(),
pmap_mapdev_attr(), and pmap_unmapbios() for amd64 and
i386.602111June 11, 20076.2-STABLE after MFC of BOP_BDFLUSH and caused
breakage of the filesystem modules KBI.602112September 21, 20076.2-STABLE after libutil(3) MFC's.602113October 25, 20076.2-STABLE after MFC of wide and single byte
ctype separation. Newly compiled binary that
references to ctype.h may require a new symbol,
__mb_sb_limit, which is not available on older
systems.602114October 30, 20076.2-STABLE after ctype ABI forward compatibility
restored.602115November 21, 20076.2-STABLE after back out of wide and single byte
ctype separation.603000November 25, 20076.3-RELEASE603100November 25, 20076.3-STABLE after 6.3-RELEASE.603101December 7, 20076.3-STABLE after fixing
multibyte type support in bit macro.603102April 24, 20086.3-STABLE after adding l_sysid to struct
flock.603103May 27, 20086.3-STABLE after MFC of the
memrchr function.603104June 15, 20086.3-STABLE after MFC of support for
:u variable modifier in
make(1).604000October 4, 20086.4-RELEASE604100October 4, 20086.4-STABLE after 6.4-RELEASE.700000July 11, 20057.0-CURRENT.700001July 23, 20057.0-CURRENT after bump of all shared library
versions that had not been changed since
RELENG_5.700002August 13, 20057.0-CURRENT after credential argument is added to
dev_clone event handler.700003August 25, 20057.0-CURRENT after memmem(3) is added to
libc.700004October 30, 20057.0-CURRENT after solisten(9) kernel arguments
are modified to accept a backlog parameter.700005November 11, 20057.0-CURRENT after IFP2ENADDR() was changed to
return a pointer to IF_LLADDR().700006November 11, 20057.0-CURRENT after addition of
if_addr member to struct
ifnet and IFP2ENADDR() removal.700007December 2, 20057.0-CURRENT after incorporating scripts from the
local_startup directories into the base
&man.rcorder.8;.700008December 5, 20057.0-CURRENT after removal of MNT_NODEV mount
option.700009December 19, 20057.0-CURRENT after ELF-64 type changes and symbol
versioning.700010December 20, 20057.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.700011December 31, 20057.0-CURRENT after tv_sec was made time_t on
all platforms but Alpha.700012January 8, 20067.0-CURRENT after ldconfig_local_dirs
change.700013January 12, 20067.0-CURRENT after changes to
/etc/rc.d/abi to support
/compat/linux/etc/ld.so.cache
being a symlink in a readonly filesystem.700014January 26, 20067.0-CURRENT after pts import.700015March 26, 20067.0-CURRENT after the introduction of version 2
of &man.hwpmc.4;'s ABI.700016April 22, 20067.0-CURRENT after addition of &man.fcloseall.3;
to libc.700017May 13, 20067.0-CURRENT after removal of ip6fw.700018July 15, 20067.0-CURRENT after import of snd_emu10kx.700019July 29, 20067.0-CURRENT after import of OpenSSL
0.9.8b.700020September 3, 20067.0-CURRENT after addition of bus_dma_get_tag
function700021September 4, 20067.0-CURRENT after libpcap 0.9.4 and tcpdump 3.9.4
import.700022September 9, 20067.0-CURRENT after dlsym change to look for a
requested symbol both in specified dso and its
implicit dependencies.700023September 23, 20067.0-CURRENT after adding new sound IOCTLs for the
OSSv4 mixer API.700024September 28, 20067.0-CURRENT after import of OpenSSL
0.9.8d.700025November 11, 20067.0-CURRENT after the addition of libelf.700026November 26, 20067.0-CURRENT after major changes on sound
sysctls.700027November 30, 20067.0-CURRENT after the addition of Wi-Spy
quirk.700028December 15, 20067.0-CURRENT after the addition of sctp calls to
libc700029January 26, 20077.0-CURRENT after the GNU &man.gzip.1;
implementation was replaced with a BSD licensed
version ported from NetBSD.700030February 7, 20077.0-CURRENT after the removal of IPIP tunnel
encapsulation (VIFF_TUNNEL) from the IPv4 multicast
forwarding code.700031February 23, 20077.0-CURRENT after the modification of
bus_setup_intr() (newbus).700032March 2, 20077.0-CURRENT after the inclusion of ipw(4) and
iwi(4) firmware.700033March 9, 20077.0-CURRENT after the inclusion of ncurses wide
character support.700034March 19, 20077.0-CURRENT after changes to how insmntque(),
getnewvnode(), and vfs_hash_insert() work.700035March 26, 20077.0-CURRENT after addition of a notify mechanism
for CPU frequency changes.700036April 6, 20077.0-CURRENT after import of the ZFS
filesystem.700037April 8, 20077.0-CURRENT after addition of CAM 'SG' peripheral
device, which implements a subset of Linux SCSI SG
passthrough device API.700038April 30, 20077.0-CURRENT after changing &man.getenv.3;,
&man.putenv.3;, &man.setenv.3; and &man.unsetenv.3; to
be POSIX conformant.700039May 1, 20077.0-CURRENT after the changes in 700038 were
backed out.700040May 10, 20077.0-CURRENT after the addition of &man.flopen.3;
to libutil.700041May 13, 20077.0-CURRENT after enabling symbol versioning, and
changing the default thread library to libthr.700042May 19, 20077.0-CURRENT after the import of gcc
4.2.0.700043May 21, 20077.0-CURRENT after bump of all shared library
versions that had not been changed since
RELENG_6.700044June 7, 20077.0-CURRENT after changing the argument for
vn_open()/VOP_OPEN() from file descriptor index to the
struct file *.700045June 10, 20077.0-CURRENT after changing &man.pam.nologin.8; to
provide an account management function instead of an
authentication function to the PAM framework.700046June 11, 20077.0-CURRENT after updated 802.11 wireless
support.700047June 11, 20077.0-CURRENT after adding TCP LRO interface
capabilities.700048June 12, 20077.0-CURRENT after
RFC 3678 API support added to the IPv4 stack.
Legacy RFC 1724 behavior of the IP_MULTICAST_IF
ioctl has now been removed; 0.0.0.0/8 may no longer
be used to specify an interface index.
struct ipmreqn should be used instead.700049July 3, 20077.0-CURRENT after importing pf from OpenBSD
4.1(not changed)7.0-CURRENT after adding IPv6 support for
FAST_IPSEC, deleting KAME IPSEC, and renaming
FAST_IPSEC to IPSEC.700050July 4, 20077.0-CURRENT after converting setenv/putenv/etc.
calls from traditional BSD to POSIX.700051July 4, 20077.0-CURRENT after adding new mmap/lseek/etc
syscalls.700052July 6, 20077.0-CURRENT after moving I4B headers to
include/i4b.700053September 30, 20077.0-CURRENT after the addition of support for
PCI domains700054October 25, 20077.0-CURRENT after MFC of wide and single byte
ctype separation.700055October 28, 20077.0-RELEASE, and 7.0-CURRENT after ABI backwards
compatibility to the FreeBSD 4/5/6 versions of the
PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs was
MFCed, which required the ABI of the PCIOCGETCONF
IOCTL to be broken again700100December 22, 20077.0-STABLE after 7.0-RELEASE700101February 8, 20087.0-STABLE after the MFC of m_collapse().700102March 30, 20087.0-STABLE after the MFC of
kdb_enter_why().700103April 10, 20087.0-STABLE after adding l_sysid to struct
flock.700104April 11, 20087.0-STABLE after the MFC of procstat(1).700105April 11, 20087.0-STABLE after the MFC of umtx
features.700106April 15, 20087.0-STABLE after the MFC of &man.write.2; support
to &man.psm.4;.700107April 20, 20087.0-STABLE after the MFC of F_DUP2FD command
to &man.fcntl.2;.700108May 5, 20087.0-STABLE after some &man.lockmgr.9; changes,
which makes it necessary to include
sys/lock.h in order to use
&man.lockmgr.9;.700109May 27, 20087.0-STABLE after MFC of the
memrchr function.700110August 5, 20087.0-STABLE after MFC of kernel NFS lockd
client.700111August 20, 20087.0-STABLE after addition of physically
contiguous jumbo frame support.700112August 27, 20087.0-STABLE after MFC of kernel DTrace
support.701000November 25, 20087.1-RELEASE701100November 25, 20087.1-STABLE after 7.1-RELEASE.701101January 10, 20097.1-STABLE after strndup
merge.701102January 17, 20097.1-STABLE after cpuctl(4) support
added.701103February 7, 20097.1-STABLE after the merge of
multi-/no-IPv4/v6 jails.701104February 14, 20097.1-STABLE after the store of the suspension
owner in the struct mount, and introduction of
vfs_susp_clean method into the struct vfsops.701105March 12, 20097.1-STABLE after the incompatible change
to the kern.ipc.shmsegs sysctl to allow to allocate
larger SysV shared memory segments on 64bit
architectures.701106March 14, 20097.1-STABLE after the merge of a fix for
POSIX semaphore wait operations.702000April 15, 20097.2-RELEASE702100April 15, 20097.2-STABLE after 7.2-RELEASE.702101May 15, 20097.2-STABLE after ichsmb(4) was changed to
use left-adjusted slave addressing to match other
SMBus controller drivers.702102May 28, 20097.2-STABLE after MFC of the
fdopendir function.702103June 06, 20097.2-STABLE after MFC of PmcTools.702104July 14, 20097.2-STABLE after MFC of the
closefrom system call.702105July 31, 20097.2-STABLE after MFC of the SYSVIPC ABI
change.702106September 14, 20097.2-STABLE after MFC of the x86 PAT
enhancements and addition of d_mmap_single() and
the scatter/gather list VM object type.703000February 9, 20107.3-RELEASE703100February 9, 20107.3-STABLE after 7.3-RELEASE.704000December 22, 20107.4-RELEASE704100December 22, 20107.4-STABLE after 7.4-RELEASE.800000October 11, 20078.0-CURRENT. Separating wide and single byte
ctype.800001October 16, 20078.0-CURRENT after libpcap 0.9.8 and tcpdump 3.9.8
import.800002October 21, 20078.0-CURRENT after renaming kthread_create()
and friends to kproc_create() etc.800003October 24, 20078.0-CURRENT after ABI backwards compatibility
to the FreeBSD 4/5/6 versions of the PCIOCGETCONF,
PCIOCREAD and PCIOCWRITE IOCTLs was added, which
required the ABI of the PCIOCGETCONF IOCTL to be
broken again800004November 12, 20078.0-CURRENT after agp(4) driver moved from
src/sys/pci to src/sys/dev/agp800005December 4, 20078.0-CURRENT after
changes
to the jumbo frame allocator.800006December 7, 20078.0-CURRENT after the addition of callgraph
capture functionality to &man.hwpmc.4;.800007December 25, 20078.0-CURRENT after kdb_enter() gains a "why"
argument.800008December 28, 20078.0-CURRENT after LK_EXCLUPGRADE option
removal.800009January 9, 20088.0-CURRENT after introduction of
&man.lockmgr.disown.9;800010January 10, 20088.0-CURRENT after the &man.vn.lock.9; prototype
change.800011January 13, 20088.0-CURRENT after the &man.VOP.LOCK.9; and
&man.VOP.UNLOCK.9; prototype changes.800012January 19, 20088.0-CURRENT after introduction of
&man.lockmgr.recursed.9;, &man.BUF.RECURSED.9; and
&man.BUF.ISLOCKED.9; and the removal of
BUF_REFCNT().800013January 23, 20088.0-CURRENT after introduction of the
ASCII encoding.800014January 24, 20088.0-CURRENT after changing the prototype of
&man.lockmgr.9; and removal of
lockcount() and
LOCKMGR_ASSERT().800015January 26, 20088.0-CURRENT after extending the types
of the &man.fts.3; structures.800016February 1, 20088.0-CURRENT after adding an argument to
MEXTADD(9)800017February 6, 20088.0-CURRENT after the introduction of
LK_NODUP and LK_NOWITNESS options in the
&man.lockmgr.9; space.800018February 8, 20088.0-CURRENT after the addition of
m_collapse.800019February 9, 20088.0-CURRENT after the addition of current
working directory, root directory, and jail
directory support to the kern.proc.filedesc
sysctl.800020February 13, 20088.0-CURRENT after introduction of
&man.lockmgr.assert.9; and
BUF_ASSERT functions.800021February 15, 20088.0-CURRENT after introduction of
&man.lockmgr.args.9; and LK_INTERNAL flag
removal.800022(backed out)8.0-CURRENT after changing the default system ar
to BSD &man.ar.1;.800023February 25, 20088.0-CURRENT after changing the prototypes of
&man.lockstatus.9; and &man.VOP.ISLOCKED.9;, more
specifically retiring the
struct thread argument.800024March 1, 20088.0-CURRENT after axing out the
lockwaiters and
BUF_LOCKWAITERS functions,
changing the return value of
brelvp from void to int and
introducing new flags for &man.lockinit.9;.800025March 8, 20088.0-CURRENT after adding F_DUP2FD command
to &man.fcntl.2;.800026March 12, 20088.0-CURRENT after changing the priority parameter
to cv_broadcastpri such that 0 means no
priority.800027March 24, 20088.0-CURRENT after changing the bpf monitoring ABI
when zerocopy bpf buffers were added.800028March 26, 20088.0-CURRENT after adding l_sysid to struct
flock.800029March 28, 20088.0-CURRENT after reintegration of the
BUF_LOCKWAITERS function and the
addition of &man.lockmgr.waiters.9;.800030April 1, 20088.0-CURRENT after the introduction of the
&man.rw.try.rlock.9; and &man.rw.try.wlock.9;
functions.800031April 6, 20088.0-CURRENT after the introduction of the
lockmgr_rw and
lockmgr_args_rw
functions.800032April 8, 20088.0-CURRENT after the implementation of the
openat and related syscalls, introduction of the
O_EXEC flag for the &man.open.2;, and providing the
corresponding linux compatibility syscalls.800033April 8, 20088.0-CURRENT after added &man.write.2; support for
&man.psm.4; in native operation level. Now arbitrary
commands can be written to
/dev/psm%d and status can be
read back from it.800034April 10, 20088.0-CURRENT after introduction of the
memrchr function.800035April 16, 20088.0-CURRENT after introduction of the
fdopendir function.800036April 20, 20088.0-CURRENT after switchover of 802.11 wireless
to multi-bss support (aka vaps).800037May 9, 20088.0-CURRENT after addition of multi routing
table support (aka setfib(1), setfib(2)).800038May 26, 20088.0-CURRENT after removal of netatm and
ISDN4BSD. Also, the addition of the
Compact C Type (CTF) tools.800039June 14, 20088.0-CURRENT after removal of sgtty.800040June 26, 20088.0-CURRENT with kernel NFS lockd client.800041July 22, 20088.0-CURRENT after addition of arc4random_buf(3)
and arc4random_uniform(3).800042August 8, 20088.0-CURRENT after addition of cpuctl(4).800043August 13, 20088.0-CURRENT after changing bpf(4) to use a
single device node, instead of device cloning.800044August 17, 20088.0-CURRENT after the commit of the first step of
the vimage project renaming global variables to be
virtualized with a V_ prefix with macros to map them
back to their global names.800045August 20, 20088.0-CURRENT after the integration of the
MPSAFE TTY layer, including changes to various
drivers and utilities that interact with it.800046September 8, 20088.0-CURRENT after the separation of the GDT
per CPU on amd64 architecture.800047September 10, 20088.0-CURRENT after removal of VSVTX, VSGID
and VSUID.800048September 16, 20088.0-CURRENT after converting the kernel NFS mount
code to accept individual mount options in the
nmount() iovec, not just one big
struct nfs_args.800049September 17, 20088.0-CURRENT after the removal of &man.suser.9;
and &man.suser.cred.9;.800050October 20, 20088.0-CURRENT after buffer cache API
change.800051October 23, 20088.0-CURRENT after the removal of the
&man.MALLOC.9; and &man.FREE.9; macros.800052October 28, 20088.0-CURRENT after the introduction of accmode_t
and renaming of VOP_ACCESS 'a_mode' argument
to 'a_accmode'.800053November 2, 20088.0-CURRENT after the prototype change of
&man.vfs.busy.9; and the introduction of its
MBF_NOWAIT and MBF_MNTLSTLOCK flags.800054November 22, 20088.0-CURRENT after the addition of buf_ring,
memory barriers and ifnet functions to facilitate
multiple hardware transmit queues for cards that
support them, and a lockless ring-buffer
implementation to enable drivers to more efficiently
manage queuing of packets.800055November 27, 20088.0-CURRENT after the addition of Intel™
Core, Core2, and Atom support to
&man.hwpmc.4;.800056November 29, 20088.0-CURRENT after the introduction of
multi-/no-IPv4/v6 jails.800057December 1, 20088.0-CURRENT after the switch to the
ath hal source code.800058December 12, 20088.0-CURRENT after the introduction of
the VOP_VPTOCNP operation.800059December 15, 20088.0-CURRENT incorporates the
new arp-v2 rewrite.800060December 19, 20088.0-CURRENT after the addition of makefs.800061January 15, 20098.0-CURRENT after TCP Appropriate Byte
Counting.800062January 28, 20098.0-CURRENT after removal of minor(),
minor2unit(), unit2minor(), etc.800063February 18, 20098.0-CURRENT after GENERIC config change to use
the USB2 stack, but also the addition of
fdevname(3).800064February 23, 20098.0-CURRENT after the USB2 stack is moved to and
replaces dev/usb.800065February 26, 20098.0-CURRENT after the renaming of all functions
in libmp(3).800066February 27, 20098.0-CURRENT after changing USB devfs handling and
layout.800067February 28, 20098.0-CURRENT after adding getdelim(), getline(),
stpncpy(), strnlen(), wcsnlen(), wcscasecmp(), and
wcsncasecmp().800068March 2, 20098.0-CURRENT after renaming the ushub devclass to
uhub.800069March 9, 20098.0-CURRENT after libusb20.so.1 was renamed to
libusb.so.1.800070March 9, 20098.0-CURRENT after merging IGMPv3 and
Source-Specific Multicast (SSM) to the IPv4
stack.800071March 14, 20098.0-CURRENT after gcc was patched to use C99
inline semantics in c99 and gnu99 mode.800072March 15, 20098.0-CURRENT after the IFF_NEEDSGIANT flag has
been removed; non-MPSAFE network device drivers are no
longer supported.800073March 18, 20098.0-CURRENT after the dynamic string token
substitution has been implemented for rpath and needed
paths.800074March 24, 20098.0-CURRENT after tcpdump 4.0.0 and
libpcap 1.0.0 import.800075April 6, 20098.0-CURRENT after layout of structs vnet_net,
vnet_inet and vnet_ipfw has been changed.800076April 9, 20098.0-CURRENT after adding delay profiles in
dummynet.800077April 14, 20098.0-CURRENT after removing VOP_LEASE() and
vop_vector.vop_lease.800078April 15, 20098.0-CURRENT after struct rt_weight fields have
been added to struct rt_metrics and struct
rt_metrics_lite, changing the layout of struct
rt_metrics_lite. A bump to RTM_VERSION was made, but
backed out.800079April 15, 20098.0-CURRENT after struct llentry pointers are
added to struct route and struct route_in6.800080April 15, 20098.0-CURRENT after layout of struct inpcb has been
changed.800081April 19, 20098.0-CURRENT after the layout of struct
malloc_type has been changed.800082April 21, 20098.0-CURRENT after the layout of struct ifnet has
changed, and with if_ref() and if_rele() ifnet
refcounting.800083April 22, 20098.0-CURRENT after the implementation of a
low-level Bluetooth HCI API.800084April 29, 20098.0-CURRENT after IPv6 SSM and MLDv2
changes.800085April 30, 20098.0-CURRENT after enabling support for
VIMAGE kernel builds with one active image.800086May 8, 20098.0-CURRENT after adding support for input lines
of arbitrarily length in patch(1).800087May 11, 20098.0-CURRENT after some VFS KPI changes. The
thread argument has been removed from the FSD parts of
the VFS. VFS_* functions do not
need the context any more because it always refers to
curthread. In some special cases,
the old behavior is retained.800088May 20, 20098.0-CURRENT after net80211 monitor mode
changes.800089May 23, 20098.0-CURRENT after adding UDP control block
support.800090May 23, 20098.0-CURRENT after virtualizing interface
cloning.800091May 27, 20098.0-CURRENT after adding hierarchical jails
and removing global securelevel.800092May 29, 20098.0-CURRENT after changing
sx_init_flags() KPI. The
SX_ADAPTIVESPIN is retired and a
new SX_NOADAPTIVE flag is
introduced in order to handle the reversed
logic.800093May 29, 20098.0-CURRENT after adding mnt_xflag to
struct mount.800094May 30, 20098.0-CURRENT after adding
&man.VOP.ACCESSX.9;.800095May 30, 20098.0-CURRENT after changing the polling KPI.
The polling handlers now return the number of packets
processed. A new
IFCAP_POLLING_NOCOUNT is also
introduced to specify that the return value is
not significant and the counting should be
skipped.800096June 1, 20098.0-CURRENT after updating to the new netisr
implementation and after changing the way we
store and access FIBs.800097June 8, 20098.0-CURRENT after the introduction of vnet
destructor hooks and infrastructure.800097June 11, 20098.0-CURRENT after the introduction of netgraph
outbound to inbound path call detection and queuing,
which also changed the layout of struct
thread.800098June 14, 20098.0-CURRENT after OpenSSL 0.9.8k import.800099June 22, 20098.0-CURRENT after NGROUPS update and moving
route virtualization into its own VImage
module.800100June 24, 20098.0-CURRENT after SYSVIPC ABI change.800101June 29, 20098.0-CURRENT after the removal of the
/dev/net/* per-interface character
devices.800102July 12, 20098.0-CURRENT after padding was added to
struct sackhint, struct tcpcb, and struct
tcpstat.800103July 13, 20098.0-CURRENT after replacing struct tcpopt
with struct toeopt in the TOE driver interface
to the TCP syncache.800104July 14, 20098.0-CURRENT after the addition of the
linker-set based per-vnet allocator.800105July 19, 20098.0-CURRENT after version bump for all
shared libraries that do not have symbol versioning
turned on.800106July 24, 20098.0-CURRENT after introduction of OBJT_SG
VM object type.800107August 2, 20098.0-CURRENT after making the newbus subsystem
Giant free by adding the newbus sxlock and
8.0-RELEASE.800108November 21, 20098.0-STABLE after implementing EVFILT_USER kevent
filter.800500January 7, 20108.0-STABLE after
__FreeBSD_version bump to make
pkg_add -r use
packages-8-stable.800501January 24, 20108.0-STABLE after change of the
scandir(3) and
alphasort(3) prototypes to
conform to SUSv4.800502January 31, 20108.0-STABLE after addition of
sigpause(3).800503February 25, 20108.0-STABLE after addition of SIOCGIFDESCR
and SIOCSIFDESCR ioctls to network interfaces. These
ioctl can be used to manipulate interface description,
as inspired by OpenBSD.800504March 1, 20108.0-STABLE after MFC of importing x86emu, a
software emulator for real mode x86 CPU from
OpenBSD.800505May 18, 20108.0-STABLE after MFC of adding liblzma, xz,
xzdec, and lzmainfo.801000June 14, 20108.1-RELEASE801500June 14, 20108.1-STABLE after 8.1-RELEASE.801501November 3, 20108.1-STABLE after KBI change in struct sysentvec,
and implementation of PL_FLAG_SCE/SCX/EXEC/SI and
pl_siginfo for ptrace(PT_LWPINFO) .802000December 22, 20108.2-RELEASE802500December 22, 20108.2-STABLE after 8.2-RELEASE.802501February 28, 20118.2-STABLE after merging DTrace changes,
including support for userland tracing.802502March 6, 20118.2-STABLE after merging log2 and log2f
into libm.802503May 1, 20118.2-STABLE after upgrade of the gcc to the last
GPLv2 version from the FSF gcc-4_2-branch.802504May 28, 20118.2-STABLE after introduction of the KPI and
supporting infrastructure for modular congestion
control.802505May 28, 20118.2-STABLE after introduction of Hhook and Khelp
KPIs.802506May 28, 20118.2-STABLE after addition of OSD to struct
tcpcb.802507June 6, 20118.2-STABLE after ZFS v28 import.802508June 8, 20118.2-STABLE after removal of the schedtail event
handler and addition of the sv_schedtail method to
struct sysvec.802509July 14, 20118.2-STABLE after merging the SSSE3 support
into binutils.802510July 19, 20118.2-STABLE after addition of
RFTSIGZMB flag for
rfork(2).802511September 9, 20118.2-STABLE after addition of automatic detection
of USB mass storage devices which do not support the
no synchronize cache SCSI command.802512September 10, 20118.2-STABLE after merging of
re-factoring of auto-quirk.802513October 25, 20118.2-STABLE after merging of the MAP_PREFAULT_READ
flag to mmap(2).802514November 16, 20118.2-STABLE after merging of
addition of posix_fallocate(2) syscall.802515January 6, 20128.2-STABLE after merging of addition of the
posix_fadvise(2) system call.802516January 16, 20128.2-STABLE after merging gperf 3.0.3802517February 15, 20128.2-STABLE after introduction of the new
extensible sysctl(3) interface NET_RT_IFLISTL
to query address lists (rev
231769.803000March 3, 20128.3-RELEASE.803500March 3, 20128.3-STABLE after branching releng/8.3
(RELENG_8_3).804000March 28, 20138.4-RELEASE.804500March 28, 20138.4-STABLE after 8.4-RELEASE.900000August 22, 20099.0-CURRENT.900001September 8, 20099.0-CURRENT after importing x86emu, a software
emulator for real mode x86 CPU from OpenBSD.900002September 23, 20099.0-CURRENT after implementing the EVFILT_USER
kevent filter functionality.900003December 2, 20099.0-CURRENT after addition of
sigpause(3) and PIE
support in csu.900004December 6, 20099.0-CURRENT after addition of libulog and its
libutempter compatibility interface.900005December 12, 20099.0-CURRENT after addition of
sleepq_sleepcnt(), which can be
used to query the number of waiters on a specific
waiting queue.900006January 4, 20109.0-CURRENT after change of the
scandir(3) and
alphasort(3) prototypes to
conform to SUSv4.900007January 13, 20109.0-CURRENT after the removal of utmp(5) and
the addition of utmpx (see
getutxent(3)) for improved
logging of user logins and system events.900008January 20, 20109.0-CURRENT after the import of BSDL bc/dc and
the deprecation of GNU bc/dc.900009January 26, 20109.0-CURRENT after the addition of SIOCGIFDESCR
and SIOCSIFDESCR ioctls to network interfaces. These
ioctl can be used to manipulate interface description,
as inspired by OpenBSD.900010March 22, 20109.0-CURRENT after the import of zlib
1.2.4.900011April 24, 20109.0-CURRENT after adding soft-updates
journalling.900012May 10, 20109.0-CURRENT after adding liblzma, xz, xzdec,
and lzmainfo.900013May 24, 20109.0-CURRENT after bringing in USB fixes for
linux(4).900014June 10, 20109.0-CURRENT after adding Clang.900015July 22, 20109.0-CURRENT after the import of BSD grep.900016July 28, 20109.0-CURRENT after adding mti_zone to
struct malloc_type_internal.900017August 23, 20109.0-CURRENT after changing back default grep to
GNU grep and adding WITH_BSD_GREP knob.900018August 24, 20109.0-CURRENT after the
pthread_kill(3) -generated signal
is identified as SI_LWP in si_code. Previously,
si_code was SI_USER.900019August 28, 20109.0-CURRENT after addition of the
MAP_PREFAULT_READ flag to
mmap(2).900020September 9, 20109.0-CURRENT after adding drain functionality
to sbufs, which also changed the layout of
struct sbuf.900021September 13, 20109.0-CURRENT after DTrace has grown support
for userland tracing.900022October 2, 20109.0-CURRENT after addition of the BSDL man
utilities and retirement of GNU/GPL man
utilities.900023October 11, 20109.0-CURRENT after updating xz to git 20101010
snapshot.900024November 11, 20109.0-CURRENT after libgcc.a was replaced
by libcompiler_rt.a.900025November 12, 20109.0-CURRENT after the introduction of the
modularised congestion control.900026November 30, 20109.0-CURRENT after the introduction of Serial
Management Protocol (SMP) passthrough and the
XPT_SMP_IO and XPT_GDEV_ADVINFO CAM CCBs.900027December 5, 20109.0-CURRENT after the addition of log2 to
libm.900028December 21, 20109.0-CURRENT after the addition of the Hhook
(Helper Hook), Khelp (Kernel Helpers) and Object
Specific Data (OSD) KPIs.900029December 28, 20109.0-CURRENT after the modification of the TCP
stack to allow Khelp modules to interact with it via
helper hook points and store per-connection data in
the TCP control block.900030January 12, 20119.0-CURRENT after the update of libdialog to
version 20100428.900031February 7, 20119.0-CURRENT after the addition of
pthread_getthreadid_np(3).900032February 8, 20119.0-CURRENT after the removal of the uio_yield
prototype and symbol.900033February 18, 20119.0-CURRENT after the update of binutils to
version 2.17.50.900034March 8, 20119.0-CURRENT after the struct sysvec
(sv_schedtail) changes.900035March 29, 20119.0-CURRENT after the update of base gcc and
libstdc++ to the last GPLv2 licensed revision.900036April 18, 20119.0-CURRENT after the removal of libobjc and
Objective-C support from the base system.900037May 13, 20119.0-CURRENT after importing the libprocstat(3)
library and fuser(1) utility to the base
system.900038May 22, 20119.0-CURRENT after adding a lock flag argument to
VFS_FHTOVP(9).900039June 28, 20119.0-CURRENT after importing pf from OpenBSD
4.5.900040July 19, 2011Increase default MAXCPU for FreeBSD to 64 on
amd64 and ia64 and to 128 for XLP (mips).900041August 13, 20119.0-CURRENT after the implementation of Capsicum
capabilities; fget(9) gains a rights argument.900042August 28, 2011Bump shared libraries' version numbers for
libraries whose ABI has changed in preparation for
9.0.900043September 2, 2011Add automatic detection of USB mass storage
devices which do not support the no synchronize cache
SCSI command.900044September 10, 2011Re-factor auto-quirk. 9.0-RELEASE.900045January 2, 20129-CURRENT after MFC of true/false from
1000002.900500January 2, 20129.0-STABLE.900501January 6, 20129.0-STABLE after merging of addition of the
posix_fadvise(2) system call.900502January 16, 20129.0-STABLE after merging gperf 3.0.3900503February 15, 20129.0-STABLE after introduction of the new
extensible sysctl(3) interface NET_RT_IFLISTL
to query address lists (rev
231768).900504March 3, 20129.0-STABLE after changes related to mounting
of filesystem inside a jail (rev
232728).900505March 13, 20129.0-STABLE after introduction of new tcp(4)
socket options: TCP_KEEPINIT, TCP_KEEPIDLE,
TCP_KEEPINTVL, and TCP_KEEPCNT (rev
232945).900506May 22, 20129.0-STABLE after introduction of the
quick_exit function and
related changes required for C++11 (rev
235786).901000August 5, 20129.1-RELEASE.901500August 6, 20129.1-STABLE after branching releng/9.1
(RELENG_9_1).901501November 11, 20129.1-STABLE after LIST_PREV() added to queue.h
(rev 242893) and KBI change in USB
serial devices (rev 240659).901502November 28, 20129.1-STABLE after USB serial jitter buffer
requires rebuild of USB serial device modules.901503February 21, 20139.1-STABLE after USB moved to the driver
structure requiring a rebuild of all USB modules.
Also indicates the presence of nmtree.901504March 15, 20139.1-STABLE after install gained -l, -M, -N and
related flags and cat gained the -l option.901505June 13, 20139.1-STABLE after fixes in ctfmerge boostrapping
(rev 249243).1000000September 26, 201110.0-CURRENT.1000001November 4, 201110-CURRENT after addition of the posix_fadvise(2)
system call.1000002December 12, 201110-CURRENT after defining boolean true/false in
sys/types.h, sizeof(bool) may have changed (rev
228444). 10-CURRENT after xlocale.h
was introduced (rev
227753).1000003December 16, 201110-CURRENT after major changes to carp(4),
changing size of struct in_aliasreq,
struct in6_aliasreq (rev 228571)
and straitening arguments check of SIOCAIFADDR (rev
228574).1000004January 1, 201210-CURRENT after the removal of skpc(9) and the
addition of memcchr(9) (rev
229200).1000005January 16, 201210-CURRENT after the removal of support for
SIOCSIFADDR, SIOCSIFNETMASK, SIOCSIFBRDADDR,
SIOCSIFDSTADDR ioctls (rev
230207).1000006January 26, 201210-CURRENT after introduction of read capacity
data asynchronous notification in the cam(4) layer
(rev 230590).1000007February 5, 201210-CURRENT after introduction of new tcp(4)
socket options: TCP_KEEPINIT, TCP_KEEPIDLE,
TCP_KEEPINTVL, and TCP_KEEPCNT (rev
231025).1000008February 11, 201210-CURRENT after introduction of the new
extensible sysctl(3) interface NET_RT_IFLISTL
to query address lists (rev
231505).1000009February 25, 201210-CURRENT after import of libarchive 3.0.3
(rev 232153).1000010March 31, 201210-CURRENT after xlocale cleanup (rev
233757).1000011April 16, 201210-CURRENT import of LLVM/Clang 3.1 trunk r154661
(rev 234353).1000012May 2, 201210-CURRENT jemalloc import
(rev 234924).1000013May 22, 201210-CURRENT after byacc import
(rev 235788).1000014June 27, 201210-CURRENT after BSD sort becoming the default
sort (rev 237629).1000015July 12, 201210-CURRENT after import of OpenSSL 1.0.1c
(rev 238405).(not changed)July 13, 201210-CURRENT after the fix for LLVM/Clang 3.1
regression (rev 238429).1000016August 8, 201210-CURRENT after KBI change in &man.ucom.4;
(rev 239179).1000017August 8, 201210-CURRENT after adding streams feature to the
USB stack (rev 239214).1000018September 8, 201210-CURRENT after major rewrite of &man.pf.4;
(rev 240233).1000019October 6, 201210-CURRENT after &man.pfil.9; KBI/KPI changed
to supply packets in net byte order to AF_INET
filter hooks (rev 241245).1000020October 16, 201210-CURRENT after the network interface cloning
KPI changed and struct if_clone becoming opaque (rev
241610).1000021October 22, 201210-CURRENT after removal of support for
non-MPSAFE filesystems and addition of support for
FUSEFS (rev
241519,
241897).1000022October 22, 201210-CURRENT after the entire IPv4 stack switched
to network byte order for IP packet header storage
(rev 241913).1000023November 5, 201210-CURRENT after jitter buffer in the common USB
serial driver code, to temporarily store characters
if the TTY buffer is full. Add flow stop and start
signals when this happens (rev
242619).1000024November 5, 201210-CURRENT after clang was made the default
compiler on i386 and amd64
(rev 242624).1000025November 17, 201210-CURRENT after the sin6_scope_id member
variable in struct sockaddr_in6 was changed to being
filled by the kernel before passing the structure to
the userland via sysctl or routing socket. This means
the KAME-specific embedded scope id in
sin6_addr.s6_addr[2] is always cleared in userland
application (rev 243443).1000026January 11, 201310-CURRENT after install gained the -N flag (rev
245313). May also be used to
indicate the presence of nmtree.1000027January 29, 201310-CURRENT after cat gained the -l flag (rev
246083).1000028February 13, 201310-CURRENT after USB moved to the driver structure
requiring a rebuild of all USB modules (rev
246759).1000029March 4, 201310-CURRENT after the introduction of tickless
callout facility which also changed the layout of
struct callout (rev 247777).1000030March 12, 201310-CURRENT after KPI breakage introduced in the
VM subsystem to support read/write locking (rev
248084).1000031April 26, 201310-CURRENT after the dst parameter of the
ifnet if_output method was
changed to take const qualifier (rev
249925).1000032May 1, 201310-CURRENT after the introduction of the
accept4 (rev
250154) and
pipe2 (rev
250159) system calls.1000033May 21, 201310-CURRENT after flex 2.5.37 import (rev
250881).1000034June 3, 201310-CURRENT after the addition of the following
functions to libm: cacos,
cacosf,
cacosh,
cacoshf,
casin,
casinf,
casinh,
casinhf,
catan,
catanf,
catanh,
catanhf,
logl,
log2l,
log10l,
log1pl,
expm1l (rev
251294).1000035June 8, 201310-CURRENT after the introduction of the
aio_mlock system call (rev
251526).
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.Writing Something After
bsd.port.mkDo not write anything after the .include
<bsd.port.mk> line. It usually can be
avoided by including bsd.port.pre.mk
somewhere in the middle of your Makefile
and bsd.port.post.mk at the end.Include either the
bsd.port.pre.mk/bsd.port.post.mk
pair or bsd.port.mk only; do not mix
these two usages.bsd.port.pre.mk only defines a few
variables, which can be used in tests in the
Makefile,
bsd.port.post.mk defines the rest.Here are some important variables defined in
bsd.port.pre.mk (this is not the complete
list, please read bsd.port.mk for the
complete list).VariableDescriptionARCHThe architecture as returned by uname
-m (e.g., i386)OPSYSThe operating system type, as returned by
uname -s (e.g.,
FreeBSD)OSRELThe release version of the operating system
(e.g., 2.1.5 or
2.2.7)OSVERSIONThe numeric version of the operating system; the
same as __FreeBSD_version.LOCALBASEThe base of the local tree (e.g.,
/usr/local)PREFIXWhere the port installs itself (see more on
PREFIX).If you have to define the variables
USE_IMAKE or
MASTERDIR, do so before including
bsd.port.pre.mk.Here are some examples of things you can write after
bsd.port.pre.mk:# no need to compile lang/perl5 if perl5 is already in system
.if ${OSVERSION} > 300003
BROKEN= perl is in system
.endifYou did remember to use tab instead of spaces after
BROKEN= and
:-).Use the exec Statement in Wrapper
ScriptsIf 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 exec statement, for
instance:#!/bin/sh
exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"The exec statement replaces the shell
process with the specified program. If
exec is omitted, the shell process
remains in memory while the program is executing, and
needlessly consumes system resources.Do Things RationallyThe Makefile 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
.if construct instead of a shell
if construct, not redefining
do-extract if you can redefine
EXTRACT* instead, and using
GNU_CONFIGURE instead of
CONFIGURE_ARGS
+= --prefix=${PREFIX}.If you find yourself having to write a lot of new code to
try to do something, please go back and review
bsd.port.mk 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 bsd.port.mk already provides a
shorthand solution.Respect Both CC and
CXXThe port must respect both CC and
CXX variables. What we mean by this is
that the port must not set the values of these variables
absolutely, overriding existing values; instead, it may
append whatever values it needs to the existing values. This
is so that build options that affect all ports can be set
globally.If the port does not respect these variables,
please add NO_PACKAGE=ignores either cc or
cxx to the Makefile.An example of a Makefile respecting
both CC and CXX
variables follows. Note the ?=:CC?= gccCXX?= g++Here is an example which respects neither
CC nor CXX
variables:CC= gccCXX= g++Both CC and CXX
variables can be defined on FreeBSD systems in
/etc/make.conf. The first example
defines a value if it was not previously set in
/etc/make.conf, preserving any
system-wide definitions. The second example clobbers
anything previously defined.Respect CFLAGSThe port must respect the CFLAGS
variable. What we mean by this is that the port must not
set the value of this variable absolutely, overriding the
existing value; instead, it may append whatever values it
needs to the existing value. This is so that build options
that affect all ports can be set globally.If it does not, please add NO_PACKAGE=ignores
cflags to the
Makefile.An example of a Makefile respecting
the CFLAGS variable follows. Note the
+=:CFLAGS+= -Wall -WerrorHere is an example which does not respect the
CFLAGS variable:CFLAGS= -Wall -WerrorThe CFLAGS variable is defined on
FreeBSD systems in /etc/make.conf. The
first example appends additional flags to the
CFLAGS variable, preserving any system-wide
definitions. The second example clobbers anything previously
defined.You should remove optimization flags from the third party
Makefiles. System
CFLAGS contains system-wide optimization
flags. An example from an unmodified
Makefile:CFLAGS= -O3 -funroll-loops -DHAVE_SOUNDUsing system optimization flags, the
Makefile would look similar to the
following example:CFLAGS+= -DHAVE_SOUNDThreading LibrariesThe threading library must be linked to the binaries using
a special flag -pthread on &os;. If
a port insists on linking -lpthread
directly, patch it to use -pthread.If building the port errors out with
unrecognized option '-pthread', it may be
desirable to use cc as linker by setting
CONFIGURE_ENV to
LD=${CC}. The
-pthread option is not supported by
ld directly.FeedbackDo 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.README.htmlDo not include the README.html file.
This file is not part of the SVN collection but is generated
using the make readme command.If make readme fails, make sure that
the default value of ECHO_MSG has not
been modified by the port.Marking a Port Not Installable with
BROKEN, FORBIDDEN, or
IGNOREIn certain cases users should be prevented from installing
a port. To tell a user that a port should not be installed,
there are several make variables that can
be used in a port's Makefile. The value
of the following make variables will be the
reason that is given back to users for why the port refuses to
install itself. Please use the correct
make variable as each make variable conveys
radically different meanings to both users, and to automated
systems that depend on the Makefiles,
such as the ports build
cluster, FreshPorts,
and portsmon.VariablesBROKEN is reserved for ports that
currently do not compile, install, or deinstall
correctly. It should be used for ports where the
problem is believed to be temporary.If instructed, the build cluster will still attempt
to try to build them to see if the underlying problem
has been resolved. (However, in general, the cluster is
run without this.)For instance, use BROKEN when a
port:does not compilefails its configuration or installation
processinstalls files outside of
${LOCALBASE}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)FORBIDDEN is used for ports that
contain a security vulnerability or induce grave concern
regarding the security of a FreeBSD system with a given
port installed (e.g., a reputably insecure program or a
program that provides easily exploitable services).
Ports should be marked as FORBIDDEN
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
FORBIDDEN for any reason other than
security.IGNORE is reserved for ports that
should not be built for some other reason. It should be
used for ports where the problem is believed to be
structural. The build cluster will not, under any
circumstances, build ports marked as
IGNORE. For instance, use
IGNORE when a port:compiles but does not run properlydoes not work on the installed version of
&os;requires &os; kernel sources to build, but the
user does not have them installedhas a distfile which may not be automatically
fetched due to licensing restrictionsdoes not work with some other currently
installed port (for instance, the port depends on
www/apache20 but
www/apache22 is
installed)If a port would conflict with a currently
installed port (for example, if they install a file in
the same place that performs a different function),
use
CONFLICTS instead.
CONFLICTS will set
IGNORE by itself.If a port should be marked IGNORE
only on certain architectures, there are two other
convenience variables that will automatically set
IGNORE for you:
ONLY_FOR_ARCHS and
NOT_FOR_ARCHS. Examples:ONLY_FOR_ARCHS= i386 amd64NOT_FOR_ARCHS= ia64 sparc64A custom IGNORE message can be
set using ONLY_FOR_ARCHS_REASON and
NOT_FOR_ARCHS_REASON. Per
architecture entries are possible with
ONLY_FOR_ARCHS_REASON_ARCH
and
NOT_FOR_ARCHS_REASON_ARCH.If a port fetches i386 binaries and installs them,
IA32_BINARY_PORT should be set. If
this variable is set, it will be checked whether the
/usr/lib32 directory is available
for IA32 versions of libraries and whether the kernel
has IA32 compatibility compiled in. If one of these two
dependencies is not satisfied, IGNORE
will be set automatically.Implementation NotesThe 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:BROKEN= this port is unsupported on FreeBSD 5.xIGNORE= is unsupported on FreeBSD 5.xresulting in the following output from
make describe:===> foobar-0.1 is marked as broken: this port is unsupported on FreeBSD 5.x.===> foobar-0.1 is unsupported on FreeBSD 5.x.Marking a Port for Removal with
DEPRECATED or
EXPIRATION_DATEDo remember that BROKEN and
FORBIDDEN are to be used as a temporary
resort if a port is not working. Permanently broken ports
should be removed from the tree entirely.When it makes sense to do so, users can be warned about
a pending port removal with DEPRECATED
and EXPIRATION_DATE. 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.It is possible to set DEPRECATED
without an EXPIRATION_DATE (for instance,
recommending a newer version of the port), but the converse
does not make any sense.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.Avoid Use of the .error
ConstructThe correct way for a Makefile 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 non-blank value to
IGNORE. This value will be formatted and
shown to the user by make install.It is a common mistake to use .error
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 occurrence of this is seen
when trying to build /usr/ports/INDEX
(see ). However, even more
trivial commands such as make maintainer
also fail in this scenario. This is not acceptable.How to Avoid Using .errorAssume that someone has the lineUSE_POINTYHAT=yesin make.conf. The first of the
next two Makefile snippets will cause
make index to fail, while the second one
will not:.if USE_POINTYHAT
.error "POINTYHAT is not supported"
.endif.if USE_POINTYHAT
IGNORE= POINTYHAT is not supported
.endifUsage of sysctlThe usage of sysctl is discouraged
except in targets. This is because the evaluation of any
makevars, such as used during
make index, then has to run the command,
further slowing down that process.Usage of &man.sysctl.8; should always be done with the
SYSCTL variable, as it contains the fully
qualified path and can be overridden, if one has such a
special need.Rerolling DistfilesSometimes the authors of software change the content of
released distfiles without changing the file's name. You have
to verify that the changes are official and have been
performed by the author. It has happened in the past that the
distfile was silently altered on the download servers with the
intent to cause harm or compromise end user security.Put the old distfile aside, download the new one, unpack
them and compare the content with &man.diff.1;. If you see
nothing suspicious, you can update
distinfo. Be sure to summarize the
differences in your PR or commit log, so that other people
know that you have taken care to ensure that nothing bad has
happened.You might also want to contact the authors of the software
and confirm the changes with them.Avoiding LinuxismsDo not use /proc if there are any
other ways of getting the information, e.g.,
setprogname(argv[0]) in
main() and then &man.getprogname.3; if
you want to know your name.Do not rely on behaviour that is undocumented by
POSIX.Do not record timestamps in the critical path of the
application if it also works without. Getting timestamps may
be slow, depending on the accuracy of timestamps in the
OS. If timestamps are really needed,
determine how precise they have to be and use an
API which is documented to just deliver the
needed precision.A number of simple syscalls (for example
&man.gettimeofday.2;, &man.getpid.2;) are much faster on
&linux; than on any other operating system due to caching and
the vsyscall performance optimizations. Do not rely on them
being cheap in performance-critical applications. In general,
try hard to avoid syscalls if possible.Do not rely on &linux;-specific socket behaviour. In
particular, default socket buffer sizes are different (call
&man.setsockopt.2; with SO_SNDBUF and
SO_RCVBUF, and while &linux;'s &man.send.2;
blocks when the socket buffer is full, &os;'s will fail and
set ENOBUFS in errno.If relying on non-standard behaviour is required,
encapsulate it properly into a generic API,
do a check for the behaviour in the configure stage, and stop
if it is missing.Check the man pages
to see if the function used is a POSIX
interface (in the STANDARDS section of the man
page).Do not assume that /bin/sh is
bash. Ensure that a command line
passed to &man.system.3; will work with a
POSIX compliant shell.A list of common bashisms is
available here.Do not #include
<stdint.h> if
inttypes.h is sufficient. This will
ensure that the software builds on older versions of
&os;.Check that headers are included in the
POSIX or man page recommended way, e.g.,
sys/types.h is often forgotten, which is
not as much of a problem for &linux; as it is for &os;.Compile threaded applications with
-pthread, not -lpthread or
variations thereof.MiscellaneaThe files pkg-descr and
pkg-plist should each be double-checked.
If you are reviewing a port and feel they can be worded
better, do so.Do not copy more copies of the GNU General Public License
into our system, please.Please be careful to note any legal issues! Do not let us
illegally distribute software!A Sample MakefileHere is a sample Makefile that you can
use to create a new port. Make sure you remove all the extra
comments (ones between brackets)!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 portlint to check the
Makefile.[the header...just to make it easier for us to identify the ports.]
# Created by: Satoshi Asami <asami@FreeBSD.org>
[The optional Created by: line names the person who originally
created the port. Note that the : is followed by a space
and not a tab character.
If this line is present, future maintainers should
not change or remove it except at the original author's request.]
# $FreeBSD$
[ ^^^^^^^^^ This will be automatically replaced with RCS ID string by SVN
when it is committed to our repository. If upgrading a port, do not alter
this line back to "$FreeBSD$". SVN deals with it automatically.]
[section to describe the port itself and the master site - PORTNAME
and PORTVERSION are always first, followed by CATEGORIES,
and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR.
PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that.
Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then
EXTRACT_ONLY, as necessary.]
PORTNAME= xdvi
PORTVERSION= 18.2
CATEGORIES= print
[do not forget the trailing slash ("/")!
if you are not using MASTER_SITE_* macros]
MASTER_SITES= ${MASTER_SITE_XCONTRIB}
MASTER_SITE_SUBDIR= applications
PKGNAMEPREFIX= ja-
DISTNAME= xdvi-pl18
[set this if the source is not in the standard ".tar.gz" form]
EXTRACT_SUFX= .tar.Z
[section for distributed patches -- can be empty]
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= asami@FreeBSD.org
COMMENT= A DVI Previewer for the X Window System
[dependencies -- can be empty]
RUN_DEPENDS= gs:${PORTSDIR}/print/ghostscript
LIB_DEPENDS= Xpm:${PORTSDIR}/graphics/xpm
[this section is for other standard bsd.port.mk variables that do not
belong to any of the above]
[If it asks questions during configure, build, install...]
IS_INTERACTIVE= yes
[If it extracts to a directory other than ${DISTNAME}...]
WRKSRC= ${WRKDIR}/xdvi-new
[If the distributed patches were not made relative to ${WRKSRC}, you
may need to tweak this]
PATCH_DIST_STRIP= -p1
[If it requires a "configure" script generated by GNU autoconf to be run]
GNU_CONFIGURE= yes
[If it requires GNU make, not /usr/bin/make, to build...]
USE_GMAKE= yes
[If it is an X application and requires "xmkmf -a" to be run...]
USE_IMAKE= yes
[et cetera.]
[non-standard variables to be used in the rules below]
MY_FAVORITE_RESPONSE= "yeah, right"
[then the special rules, in the order they are called]
pre-fetch:
i go fetch something, yeah
post-patch:
i need to do something after patch, great
pre-install:
and then some more stuff before installing, wow
[and then the epilogue]
.include <bsd.port.mk>Keeping UpThe &os; Ports Collection is constantly changing. Here is
some information on how to keep up.FreshPortsOne of the easiest ways to learn about updates that have
already been committed is by subscribing to FreshPorts. 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.)If you wish to use FreshPorts, all you need is an account.
If your registered email address is
@FreeBSD.org, 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
@FreeBSD.org email address, just change
your email to @FreeBSD.org, subscribe, then
change it back again.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.The Web Interface to the Source RepositoryIt 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 CHANGES
file. Changes that affect individual ports
are now documented in the UPDATING
file. However, the definitive answer to
any question is undoubtedly to read the source code of bsd.port.mk,
and associated files.The &os; Ports Mailing ListIf 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
CHANGES.If this mailing list is too high volume you may consider
following &a.ports-announce; which is moderated and has no
discussion.The &os; Port Building Cluster on
pointyhat.FreeBSD.orgOne 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 package building logs
and errors.Individual ports are built unless they are specifically
marked with IGNORE. Ports that are
marked with BROKEN will still be attempted,
to see if the underlying problem has been resolved. (This
is done by passing TRYBROKEN to the
port's Makefile.)Portscout: the &os; Ports Distfile ScannerThe 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. Portscout, the
&os; Ports distfile scanner, attempts to query every download
site for every port to find out if each distfile is still
available. Portscout can generate
HTML reports and send emails about newly
available ports to those who request them. Unless not
otherwise subscribed, maintainers are asked to check
periodically for changes, either by hand or using the
RSS feed.Portscout's first page gives
the email address of the port maintainer, the number of ports
the maintainer is responsible for, the number of those ports
with new distfiles, and the percentage of those ports that are
out-of-date. The search function allows for searching by
email address for a specific maintainer, and for selecting
whether or not only out-of-date ports should be shown.Upon clicking on a maintainer's email address,
a list of all of their ports is displayed, along with port
category, current version number, whether or not there is a
new version, when the port was last updated, and finally when
it was last checked. A search function on this page allows
the user to search for a specific port.Clicking on a port name in the list displays the
FreshPorts port
information.The &os; Ports Monitoring SystemAnother handy resource is the FreeBSD Ports Monitoring
System (also known as portsmon).
This system comprises a database that processes information
from several sources and allows it 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.To get started, you can view all information about a
particular port by using the
Overview of One Port.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, portsmon
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.AppendicesValues of USES
Values of USESFeatureArgumentsDescription
&values.uses;
The ports listed on these web pages are continually being updated.
It is strongly recommended that you refresh the entire collection
together, as many ports depend on other parts of the tree, even
where that might seem counterintuitive (e.g. japanese/.)
Changes that affect the entire port system are now documented in the
-CHANGES file.
+CHANGES file.
Changes that affect individual ports are now documented in the
-UPDATING file.
+UPDATING file.
For more information about new, changed or removed ports/packages,
or if you wish to search for a specific application to see if it's
available as a port/package, you may use the form above; alternatively,
you may wish to visit
FreshPorts.org
and either browse the site or subscribe to the lists hosted there.
The following table lists the code freeze status for the major
- branches of the src/ subtree of the FreeBSD CVS
+ branches of the src/ subtree of the FreeBSD Subversion
repository. Commits to any branch listed as "frozen" must first
be reviewed and approved by the relevant contact party. The
status of other subtrees such as ports/ and doc/,
is also provided below.
FreeBSD
Release Engineering
Describes the approach used by the FreeBSD release
engineering team to make production quality releases of the
FreeBSD Operating System. It describes the tools available
for those interested in producing customized FreeBSD releases
for corporate rollouts or commercial
productization.
FreeBSD
Release Engineering for Third Party Packages
Describes the approach used by the FreeBSD release
engineering team to produce a high quality package set
suitable for official FreeBSD release media. This document is
a work in progress, but eventually it will cover the process
used to build a clean package set on the FreeBSD.org "Ports
Cluster", how to configure any other set of machines as a
ports cluster, how to split up the packages for the release
media, and how to verify that a package set is
consistent.
The primary release engineering team is responsible for approving
MFC
requests during code freezes, setting release schedules, and all of
the other responsibilities laid out in our charter.
Primary RE Team
(re@FreeBSD.org) :
&a.re.members; form the primary release engineering
decision-making group.
The builders release engineering team is responsible
for building and packaging FreeBSD releases on the various supported
platforms.
The third party packages in the Ports Collection are managed by the
portmgr@ team. Among many other responsibilities, the port managers
keep the ports cluster running smoothly to produce binary
packages.
Where can I find the release directory or ISO images for older
FreeBSD releases?
The FreeBSD Project does not maintain a centralized historical
archive of old release ISO images, but there are still many
options. A large collection of the old releases (many
complete with the package sets) is at
ftp://ftp-archive.FreeBSD.org/pub/FreeBSD-Archive/old-releases/.
If you are unable to find an FTP mirror that still contains the
release you are looking for, then you can email CD-ROM vendors to
see if they have any old releases available. In September 2003,
we know of a case where FreeBSD 1.1 was used in a court of law to
invalidate a bogus software patent. Clearly, older releases can
be very important in some situations.
Index: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/htdocs/relnotes/Makefile
===================================================================
--- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/htdocs/relnotes/Makefile (revision 42006)
+++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/htdocs/relnotes/Makefile (revision 42007)
@@ -1,18 +1,20 @@
#
# Web site build hooks for the release notes. Also see the README file.
#
# The variable RELNOTES (I couldn't think of a better name) is a poor
# man's list. Its semantics are very similar to that of MLINKS (see
# bsd.man.mk). The first word is the directory under which that set
# of relnotes should appear on the web site. The second word is the
# path to that relnotes set.
#
# $FreeBSD$
#
.if exists(../Makefile.inc)
.include "../Makefile.inc"
.endif
-RELNOTES?= CURRENT ${DOC_PREFIX}/../relnotes/doc/${LANGCODE}
+RELNOTES?= CURRENT ${DOC_PREFIX}/../relnotes/doc/${LANGCODE} \
+ 9-STABLE ${DOC_PREFIX}/../relnotes9/doc/${LANGCODE} \
+ 8-STABLE ${DOC_PREFIX}/../relnotes8/doc/${LANGCODE}
.include "Makefile.inc"
Index: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/htdocs/relnotes.xml
===================================================================
--- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/htdocs/relnotes.xml (revision 42006)
+++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/htdocs/relnotes.xml (revision 42007)
@@ -1,157 +1,113 @@
]>
&title;$FreeBSD$
Each distribution of FreeBSD includes several documentation
files describing the particular distribution (RELEASE,
SNAPSHOTs, etc.). These files typically include:
README: General introduction.
Release Notes: Information about changes from the
previous release of FreeBSD.
Hardware Notes: A list of hardware devices known to work
with FreeBSD.
Installation Instructions: A brief guide to installing
FreeBSD.
Errata: Late-breaking news, including corrections,
security advisories, and potential problems found after each
release.
Of the files listed above, the release notes, hardware notes, and
installation instructions are customized for each architecture
supported by FreeBSD.
RELEASE versions of FreeBSD
The release documentation for each -RELEASE version of FreeBSD
(for example, &rel.current;-RELEASE) can be found on the
releases page of
the FreeBSD Web site, as well as its mirrors.
These files (usually in both HTML and text forms) can be found
in the top-level directory of each distribution (whether on
CD-ROM, an FTP site, or the install floppy disks).
Snapshot versions of FreeBSD
The release documentation files for snapshots can generally be
found in the top-level directory of each snapshot.
Documentation for -CURRENT and -STABLE
Automatically-generated HTML versions of the release
documentation for FreeBSD -CURRENT and FreeBSD -STABLE are
available on the FreeBSD Web site. These documents are
continually changing; the versions on the Web site are rebuilt
at the same time that the rest of the Web site is updated.
Single-file HTML, PDF, and text renderings of the release
documentation for FreeBSD -CURRENT, -STABLE, and recent -RELEASE
versions can be found at the Release
Documentation Snapshot Site. The renderings on this page
are updated at irregular, but frequent intervals.
9¿· &os; Foundation ¥×¥í¥¸¥§¥¯¥È³«È¯¥Ç¥£¥ì¥¯¥¿½¢Ç¤:
Ed Maste
The &os; Foundation ¤Ï¡¢Ed Maste
¤¬¿·¤·¤¯¥Ñ¡¼¥È¥¿¥¤¥à¤Î¥×¥í¥¸¥§¥¯¥È³«È¯¥Ç¥£¥ì¥¯¥¿¤Ë½¢Ç¤¤·¤¿¤³¤È¤ò¤ªÃΤ餻¤·¤Þ¤¹¡£
Ed ¤Ï 2 ǯ´Ö Foundation ¤Î¥Ü¡¼¥É¥á¥ó¥Ð¤Ç¤¢¤ê¤Þ¤·¤¿¤¬¡¢
¤³¤Î¿·¤·¤¤¥Ý¥¸¥·¥ç¥ó¤Ø½¢Ç¤¤¹¤ë¤¿¤á¡¢¥Ü¡¼¥É¥á¥ó¥Ð¤òÂàǤ¤·¤Þ¤·¤¿¡£
429¿· &os; Foundation ¥Æ¥¯¥Ë¥«¥ë¥¹¥¿¥Ã¥Õ: Edward
Tomasz Napierała
The &os; Foundation ¤Ï¡¢
Edward Tomasz Napierała ¤¬Æó¿ÍÌܤΥƥ¯¥Ë¥«¥ë¥¹¥¿¥Ã¥Õ¤Ë²Ã¤ï¤Ã¤¿¤³¤È¤ò¤ªÃΤ餻¤·¤Þ¤¹¡£
¤³¤ì¤Ï¡¢2013 ǯ¤Ë Foundation
¤¬·Ñ³¤·¤Æ¹Ô¤Ã¤Æ¤¤¤ë¥¹¥¿¥Ã¥Õ¤Ø¤ÎÅê»ñ¤Ë¤è¤ë¤â¤Î¤Ç¤¹¡£
14The &os; Foundation ¤Ë¿·¤·¤¯¥Æ¥¯¥Ë¥«¥ë¥¹¥¿¥Ã¥Õ¤¬²Ã¤ï¤ê¤Þ¤·¤¿
(Konstantin Belousov)
The &os; Foundation ¤Ï¡¢
Konstantin Belousov ¤ò½é¤á¤Æ¤Î¥Õ¥ë¥¿¥¤¥à¤Î¥Æ¥¯¥Ë¥«¥ë¥¹¥¿¥Ã¥Õ¤È¤·¤Æ¸ÛÍѤ·¤¿¤³¤È¤ò¤ªÃΤ餻¤·¤Þ¤¹¡£
¤³¤ì¤Ï¡¢2013 ǯ¤Î¥¹¥¿¥Ã¥Õ¤ËÂФ¹¤ë Foundation
¤ÎÅê»ñ¤ÎÃæ¤Ç½ÅÂç¤Ê½ÐÍè»ö¤Ç¤¹¡£
¤¢¤Ê¤¿¤«¤é¤Î´óÉդϡ¢&os; ¤¬ÍøÍѤǤ¤ëºÇÎɤΠOS
¤È¤Ê¤ë½õ¤±¤È¤Ê¤ê¤Þ¤¹!
The &os; Foundation ¤ËÅê»ñ¤¹¤ë¤³¤È¤Ç¡¢&os; ¤¬¹âÀǽ¡¢°ÂÁ´¡¢
°ÂÄꤷ¤¿¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à¤Ç¤¢¥ê³¤±¤ë¤¿¤á¤Î¼ê½õ¤±¤È¤Ê¤ê¤Þ¤¹¡£
The &os; Foundation ¤Ï¡¢¤¢¤Ê¤¿¤Î¤è¤¦¤Ê¿Í¡¹¤Î¤ª¤«¤²¤Ç¡¢
12 ǯ¤Ë¤âÅϤê &os; ¥×¥í¥¸¥§¥¯¥È¤ò»Ù±ç¤Ç¤¤ë¤³¤È¤ò¸Ø¤ê¤Ë»×¤¤¤Þ¤¹¡£Â³¤¤òÆɤà
2¥³¥ß¥Ã¥È¸¢¤ÎÈϰϤγÈÂç:
Gábor Kövesdán
(src, ports, doc)
Gábor Kövesdán
¤Ï¡¢2008/2009 ǯ¤Î
Google Summer of Code
¤Ë»²²Ã¤·¡¢¤³¤Î³èÆ°¤Ë¤è¤ê¡¢¥½¡¼¥¹¥³¡¼¥É¤ËÂФ¹¤ë¥³¥ß¥Ã¥È¸¢¤òÍ¿¤¨¤é¤ì¤Þ¤·¤¿¡£
ºÇ½é¤Îºî¶È¤Ï¡¢GSoC ¤Î·ë²Ì¤ò¥Ä¥ê¡¼¤ËÈ¿±Ç¤µ¤»¤ëͽÄê¤Ç¤¹¡£
Index: projects/ISBN_1-57176-407-0/ja_JP.eucJP
===================================================================
--- projects/ISBN_1-57176-407-0/ja_JP.eucJP (revision 42006)
+++ projects/ISBN_1-57176-407-0/ja_JP.eucJP (revision 42007)
Property changes on: projects/ISBN_1-57176-407-0/ja_JP.eucJP
___________________________________________________________________
Modified: svn:mergeinfo
## -0,0 +0,1 ##
Merged /head/ja_JP.eucJP:r41947-42004
Index: projects/ISBN_1-57176-407-0/share/security/advisories/FreeBSD-SA-13:06.mmap.asc
===================================================================
--- projects/ISBN_1-57176-407-0/share/security/advisories/FreeBSD-SA-13:06.mmap.asc (revision 42006)
+++ projects/ISBN_1-57176-407-0/share/security/advisories/FreeBSD-SA-13:06.mmap.asc (revision 42007)
@@ -1,127 +1,146 @@
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
=============================================================================
FreeBSD-SA-13:06.mmap Security Advisory
The FreeBSD Project
Topic: Privilege escalation via mmap
Category: core
Module: kernel
Announced: 2013-06-18
Credits: Konstantin Belousov
Alan Cox
Affects: FreeBSD 9.0 and later
-Corrected: 2013-06-18 09:04:19 UTC (stable/9, 9.1-STABLE)
- 2013-06-18 09:05:51 UTC (releng/9.1, 9.1-RELEASE-p4)
+Corrected: 2013-06-18 07:04:19 UTC (stable/9, 9.1-STABLE)
+ 2013-06-18 07:05:51 UTC (releng/9.1, 9.1-RELEASE-p4)
CVE Name: CVE-2013-2171
For general information regarding FreeBSD Security Advisories,
including descriptions of the fields above, security branches, and the
following sections, please visit .
+0. Revision History
+
+v1.0 2013-06-18 Initial release.
+v1.1 2013-06-21 Corrected correction date.
+ Added workaround information.
+
I. Background
The FreeBSD virtual memory system allows files to be memory-mapped.
All or parts of a file can be made available to a process via its
address space. The process can then access the file using memory
operations rather than filesystem I/O calls.
The ptrace(2) system call provides tracing and debugging facilities by
allowing one process (the tracing process) to watch and control
another (the traced process).
II. Problem Description
Due to insufficient permission checks in the virtual memory system, a
tracing process (such as a debugger) may be able to modify portions of
the traced process's address space to which the traced process itself
does not have write access.
III. Impact
This error can be exploited to allow unauthorized modification of an
arbitrary file to which the attacker has read access, but not write
access. Depending on the file and the nature of the modifications,
this can result in privilege escalation.
To exploit this vulnerability, an attacker must be able to run
arbitrary code with user privileges on the target system.
IV. Workaround
-No workaround is available.
+Systems that do not allow unprivileged users to use the ptrace(2)
+system call are not vulnerable, this can be accomplished by setting
+the sysctl variable security.bsd.unprivileged_proc_debug to zero.
+Please note that this will also prevent debugging tools, for instance
+gdb, truss, procstat, as well as some built-in debugging facilities in
+certain scripting language like PHP, etc., from working for unprivileged
+users.
+The following command will set the sysctl accordingly and works until the
+next reboot of the system:
+
+ sysctl security.bsd.unprivileged_proc_debug=0
+
+To make this change persistent across reboot, the system administrator
+should also add the setting into /etc/sysctl.conf:
+
+ echo 'security.bsd.unprivileged_proc_debug=0' >> /etc/sysctl.conf
+
V. Solution
Perform one of the following:
1) Upgrade your vulnerable system to a supported FreeBSD stable or
release / security branch (releng) dated after the correction date.
2) To update your vulnerable system via a source code patch:
The following patches have been verified to apply to the applicable
FreeBSD release branches.
a) Download the relevant patch from the location below, and verify the
detached PGP signature using your PGP utility.
# fetch http://security.FreeBSD.org/patches/SA-13:06/mmap.patch
# fetch http://security.FreeBSD.org/patches/SA-13:06/mmap.patch.asc
# gpg --verify mmap.patch.asc
b) Apply the patch.
# cd /usr/src
# patch < /path/to/patch
c) Recompile your kernel as described in
and reboot the
system.
3) To update your vulnerable system via a binary patch:
Systems running a RELEASE version of FreeBSD on the i386 or amd64
platforms can be updated via the freebsd-update(8) utility:
# freebsd-update fetch
# freebsd-update install
VI. Correction details
The following list contains the correction revision numbers for each
affected branch.
Branch/path Revision
- -------------------------------------------------------------------------
stable/9/ r251902
releng/9.1/ r251903
- -------------------------------------------------------------------------
To see which files were modified by a particular revision, run the
following command, replacing XXXXXX with the revision number, on a
machine with Subversion installed:
# svn diff -cXXXXXX --summarize svn://svn.freebsd.org/base
Or visit the following URL, replacing XXXXXX with the revision number:
VII. References
-
-
The latest revision of this advisory is available at
-----BEGIN PGP SIGNATURE-----
-Version: GnuPG v1.4.13 (FreeBSD)
-iEYEARECAAYFAlHAB+YACgkQFdaIBMps37IjFACdFSoiYO1YkcPunLh7Zw4TC6MF
-X9MAnjjVWB2uEl60Rl3K4WOuJ71AVNlP
-=8309
+iEYEARECAAYFAlHExy0ACgkQFdaIBMps37L8PwCdGXatzPm7OWjZu+GmbbXQC16/
+8sgAoJ0LEmREO8Mp7f4YcLHAEwgnJtjT
+=WRZD
-----END PGP SIGNATURE-----
Index: projects/ISBN_1-57176-407-0/share/xml/news.xml
===================================================================
--- projects/ISBN_1-57176-407-0/share/xml/news.xml (revision 42006)
+++ projects/ISBN_1-57176-407-0/share/xml/news.xml (revision 42007)
@@ -1,2508 +1,2531 @@
$FreeBSD$
20136
+ 19
+
+
+ Happy Birthday &os;!
+
+
&os; celebrated its
+ 20th birthday
+ today. On June 19, 1993, Jordan Hubbard, Rod Grimes, and
+ David Greenman announced to the world the creation of
+ their new fork of the BSD 4.3 operating system.
+
+
&os; was derived from the 386BSD 0.1 release from Bill and
+ Lynne Jolitz with its 1.0 release in Nov 1993. Its
+ stated goals were to create a fast, stable, reliable
+ server OS for i386 systems.
+
+
Since then, it has become the backbone of countless
+ products and has grown to supporting 64bit computing,
+ embedded devices, and desktop users.
Enhanced commit privileges: Chris Rees
(doc, ports)
14Binary Packages Are Available Again
Six months have passed since the November security
incident which brought the Project's binary package
building capacity offline; we are pleased to announce that
all services are now restored.
The January to March 2013 Status Report is now
available with 31 entries.
9&os; Foundation Announces Ed Maste as New
Director of Project Development
The &os; Foundation is pleased to announce Ed
Maste's new role as the Foundation's part-time Director of
Project Development. Ed has served on the Foundation's
board for two years, and has stepped down in order to
accept this new position.
The third RC build for the &os;-8.4 release cycle is
now available. ISO images for the amd64, i386 and pc98
architectures are available
on most of our &os;
mirror sites.
429New &os; Foundation Technical Staff Member: Edward
Tomasz Napierała
The &os; Foundation is pleased to announce that
Edward Tomasz Napierała has joined as its second
member of technical staff. This is a continuation of the
Foundation's plan to invest in staff in 2013.
FreeBSD Project to participate in Google Summer of
Code 2013
The FreeBSD Project is pleased to announce its participation
In Google's 2013 Summer of Code program, which funds summer
students to participate in open source projects.
This will be the FreeBSD Project's ninth year in the program,
having mentored over 150 successful students through summer-long
coding projects between 2005 and 2012.
Past successful projects have included improvements to Linux
ABI emulation, NFSv4 ACLs, TCP regression testing, FUSE file
system support, and countless other projects.
Many students go on to become FreeBSD developers, as well as
participating in FreeBSD developer events around the world
through continuing support from the FreeBSD Foundation.
Prospective participants are invited to apply; more information
is available, including proposal and deadline information, on the
FreeBSD Summer
Projects page.
22&os; 8.4-RC2 Available
The second RC build for the &os;-8.4 release cycle is
now available. ISO images for the amd64, i386 and pc98
architectures are available
on most of our &os;
mirror sites.
The first RC build for the &os;-8.4 release cycle is
now available. ISO images for the amd64, i386 and pc98
architectures are available
on most of our &os;
mirror sites.
The first BETA build for the &os;-8.4 release cycle is
now available. ISO images for the amd64, i386 and pc98
architectures are available
on most of our &os;
mirror sites.
14New &os; Foundation Technical Staff Member: Konstantin
Belousov
The &os; Foundation is pleased to announce that
Konstantin Belousov has been hired as its first full-time
member of technical staff, a key milestone of the
Foundation's investment in staff for 2013.
The April-June, 2012 Status Report is now
available with 17 entries.
10Ports CVS End of Life on February 28th 2013
The development of &os; ports is done in Subversion
nowadays. By February 28th 2013, the &os; ports tree will
no longer be exported to CVS. Therefore ports tree updates
via CVS, CVSup or csup(1) will no longer be available after
that date. All users who use CVS, CVSup or csup(1) to
update the ports tree are encouraged to switch to
portsnap(8) or for users which need more control over their
ports collection checkout, use Subversion directly. More
information are available in the announcement mail on the &os; ports announce mailing list.
A migration guide from CVSup or csup(1) to portsnap(8) is
also available in the &os; Handbook.
8Faces of &os; ‐ Thomas Abthorpe
We are excited to share our next story for our Faces of
&os; Series. This is a chance for us to spotlight
different people who contribute to &os; and have received
funding from us to work on development projects, run
conferences, travel to conferences, and advocate for
&os;.
Let us introduce you to Thomas Abthorpe. We helped him
attend BSDCan 2009, 2011, and 2012 by helping with his
travel expenses. Read his story here.
We are excited to share our next story for our Faces of
&os; Series. This is a chance for us to spotlight
different people who contribute to &os; and have received
funding from us to work on development projects, run
conferences, travel to conferences, and advocate for
&os;.
Let us introduce you to Dan Langille. We helped him by
sponsoring BSDCan since 2006. Read his story here.
12Stunning News Website Fundraising
Contribution: Over
650 new donations raise $43,200 in three days!
Astute readers of our blog know that The
&os; Foundation's annual year-end fundraising drive
began last week. Every year over 50% of our donations
arrive during this campaign. Read more...
10Faces of &os; ‐ Alberto Mijares
Are you aware of the tangible benefits derived from our
support of the &os; community? In conjunction with our
year-end fundraising drive we are going to be spotlighting
different people on our website, blog, and Facebook page
who have received funding to work on development projects,
run conferences, travel to conferences, and advocate for
&os;. Read more...
5&os; Year-End Fundraising Campaign
Your donations have helped make &os; the best OS
available! By investing in The &os; Foundation you
have helped us keep &os; a high-performance, secure, and
stable operating system.
Thanks to people like you, the &os; Foundation has
been proudly supporting the &os; Project and
community for 12 years now. Read
more...
&os; Project Website is Using Google
Analytics
The &os; Project has enabled Google Analytics to
collect anonymised statistics on web site use. More
information can be found in the official announcement.
On Sunday 11th of November, an intrusion was detected on
two machines within the FreeBSD.org cluster. We have found
no evidence of any modifications that would put any end user
at risk. However, we do urge all users to read the report
available at
http://www.freebsd.org/news/2012-compromise.html and
decide on any required actions themselves.
The third RC build for the &os;-9.1 release cycle is
now available. ISO images for the amd64, i386, sparc64, and
powerpc64 architectures are available
on most of our &os;
mirror sites.
The second RC build for the &os;-9.1 release cycle is
now available. ISO images for the amd64, i386, ia64,
powerpc, and powerpc64 architectures are available
on most of our &os;
mirror sites.
The first RC build for the &os;-9.1 release cycle is
now available. ISO images for the amd64, i386 and powerpc64
architectures are available
on most of our &os;
mirror sites.
The first BETA build for the &os;-9.1 release cycle is now
available. ISO images for the architectures amd64, i386,
powerpc64, and sparc64 are available
on most of our &os;
mirror sites.
11New &os; Core Team elected
The &os; Project is pleased to announce the completion of
the 2012 Core Team election. The &os; Core Team acts as the
project's "board of directors" and is responsible for
approving new src committers, resolving disputes between
developers, appointing sub-committees for specific purposes
(security officer, release engineering, port managers,
webmaster, etc ...), and making any other administrative
or policy decisions as needed. The Core Team has been
elected by &os; developers every two years since 2000.
More information about the election (together with a list
of the new members of the Core Team) can be found in the
official announcement.
The second release candidate build for the &os;-8.3
release cycle is now available. ISO images for the amd64,
i386, and pc98 architectures are available
on most of our &os;
mirror sites.
The first RC build for the &os;-8.3 release cycle is
now available. ISO images for the amd64, i386, and pc98
architectures are available
on most of our &os;
mirror sites.
The first test build for the &os;-8.3 release cycle is
now available. ISO images for the amd64, i386, and pc98
architectures are available
on most of our &os;
mirror sites.
The third (and probably last) RC build for the &os;-9.0 release
cycle is now available. ISO images for the architectures amd64,
i386, ia64, powerpc, powerpc64, and sparc64 are available
on most of our &os;
mirror sites. One of the many new features in 9.0 we
would like to be tested is the new installer, so we
encourage our users to do fresh installation on test
systems. Alternatively, users upgrading existing systems may
now do so using the freebsd-update(8) utility.
The second RC build for the &os;-9.0 release cycle is now
available. ISO images for the architectures amd64, i386,
ia64, powerpc, powerpc64, and sparc64 are available
on most of our &os;
mirror sites. One of the many new features in 9.0 we
would like to be tested is the new installer, so we
encourage our users to do fresh installation on test
systems. Alternatively, users upgrading existing systems may
now do so using the freebsd-update(8) utility.
The July-September, 2011 Status Report is now
available with 28 entries.
1023&os; 9.0-RC1 Available
The first RC build for the &os;-9.0 release cycle is now
available. ISO images for the architectures amd64, i386,
ia64, powerpc, powerpc64, and sparc64 are available
on most of our &os;
mirror sites. One of the many new features in 9.0 we
would like to be tested is the new installer, so we
encourage our users to do fresh installation on test
systems. Alternatively, users upgrading existing systems may
now do so using the freebsd-update(8) utility.
The third BETA build for the &os;-9.0 release cycle is now
available. ISO images for the architectures amd64, i386,
ia64, powerpc, powerpc64, and sparc64 are available
on most of our &os;
mirror sites. One of the many new features in 9.0 we
would like to be tested is the new installer, so we
encourage our users to do fresh installation on test
systems.
The second BETA build for the &os;-9.0 release cycle is now
available. ISO images for the architectures amd64, i386,
powerpc, powerpc64, and sparc64 are available
on most of our &os;
mirror sites. One of the many new features in 9.0 we
would like to be tested is the new installer, so we
encourage our users to do fresh installation on test
systems.
The &os; Foundation has published their first Semi-Annual
2011 newsletter which summarizes what they
have done to help the &os; Project and community.
1&os; 9.0-BETA1 Available
The first test build for the &os;-9.0 release cycle is now
available. ISO images for the architectures amd64, i386,
ia64, powerpc, powerpc64, and sparc64 are available
on most of our &os;
mirror sites. One of the many new features in 9.0 we
would like to be tested is the new installer, so we
encourage our users to do fresh installation on test
systems.
27FreeBSD Project to participate in Google Summer of
Code 2011
The FreeBSD Project is pleased to announce its participation
In Google's 2011 Summer of Code program, which funds summer
students to participate in open source projects.
This will be the FreeBSD Project's seventh year in the program,
having mentored over 100 successful students through summer-long
coding projects between 2005 and 2010.
Past successful projects have included improvements to Linux
ABI emulation, NFSv4 ACLs, TCP regression testing, FUSE file
system support, and countless other projects.
Many students go on to become FreeBSD developers, as well as
participating in FreeBSD developer events around the world
through continuing support from the FreeBSD Foundation.
Prospective participants are invited to apply; more information
is available, including proposal and deadline information, on the
FreeBSD Summer
Projects page.
Enhanced commit privileges: Martin Wilke
(src, ports, doc)
3&os; 7.4/8.2-RC3 Available
The third (and probably last) Release Candidate builds
for the &os;-7.4/8.2 release cycles are now available. For
8.2-RC3 the amd64, i386, ia64, pc98, powerpc, and sparc64
architectures are available. For 7.4-RC3 the amd64, i386,
pc98, and sparc64 architectures are available. ISO images
for these architectures can be downloaded from most of the
&os;
mirror sites. Please see the official announcement
for further details about these releases.
125October-December, 2010 Status Report
The October-December, 2010 Status Report is now
available with 37 entries.
23&os; 7.4-RC2 Available
The second Release Candidate build for the &os;-7.4
release cycle is now available. ISO images for Tier-1
architectures can be downloaded from most of the &os;
mirror sites. Please see the official announcement
for further details about this release.
16&os; 8.2-RC2 Available
The second Release Candidate build for the &os;-8.2
release cycle is now available. ISO images for Tier-1
architectures can be downloaded from most of the &os;
mirror sites. Please see the official announcement
for further details about this release.
20101227&os; 7.4/8.2-RC1 Available
The first Release Candidate builds for the &os;-7.4/8.2
release cycles are now available. ISO images for Tier-1
architectures can be downloaded from most of the &os;
mirror sites. Please see the official announcement
for further details about these releases.
16&os; Foundation December 2010 Newsletter
The &os; Foundation has published their End-of-Year newsletter
which summarizes what they have done in 2010 to help the
&os; Project and community.
11&os; 7.4/8.2-BETA1 Available
The first of the test builds for the &os;-7.4/8.2
release cycles is now available. ISO images for Tier-1
architectures are now available
on most of the &os;
mirror sites.
PC-BSD 8.1 has been released. PC-BSD is a
successful desktop operating system based on FreeBSD that
focuses on providing an easy to use desktop system for
casual computer users. A list of new features/updates
since the last version can be found here.
The &os; Project is pleased to announce the completion of
the 2010 Core Team election. The &os; Core Team acts as the
project's "board of directors" and is responsible for
approving new src committers, resolving disputes between
developers, appointing sub-committees for specific purposes
(security officer, release engineering, port managers,
webmaster, etc ...), and making any other administrative
or policy decisions as needed. The Core Team has been
elected by &os; developers every 2 years since 2000.
More information about the election (together with a list
of the new members of the Core Team) can be found in the
official announcement.
2&os; 8.1-RC2 available
The second (and most likely final) Release Candidate build
for the &os;-8.1 release cycle is now available. CD ISO images
for the amd64, i386, ia64, powerpc, and sparc64 architectures
can be downloaded from most of the &os;
mirror sites. Please see the official announcement
for further details about this release.
618&os; 8.1-RC1 Available
The first Release Candidate build for the &os;-8.1
release cycle is now available. ISO images for Tier-1
architectures can be downloaded from most of the &os;
mirror sites. Please see the official announcement
for further details about this release.
The first of the test builds for the &os;-8.1
release cycle is now available. ISO images for Tier-1
architectures are now available
on most of the &os;
mirror sites.
24Google Summer of Code Projects started
The FreeBSD Project again received many high quality
applications from students participating
in Google's Summer of
Code program. This year 18 student proposals to work
with the FreeBSD Project were accepted as part of this
program. For those with projects that were not accepted
this year, we'd like to note that the FreeBSD Project is
always willing to help mentor students so they can learn
more about operating system development through our normal
community mailing lists and development forums.
Please read the official announcement
for more information. The complete list of student projects
selected for funding can be found in the FreeBSD Summer
of Code wiki. Coding started on May 24, so please join
us in welcoming the 18 new students to our community.
4The &os; Project Participates in the Google Summer of
Code 2010 Program
&os; Project is participating in Google's Summer of Code programme
for a sixth year. Undergraduate and graduate students are
invited to apply for a grant to spend the summer improving the
&os; operating system! More information available on the
&os; Summer of
code page, including a poster to hang up at a university
near you!
The second Release Candidate build for the &os;-7.3
release cycle is now available. ISO images for Tier-1
architectures are now available
on most of the &os;
mirror sites.
PC-BSD 8.0 has been released. PC-BSD is a
successful desktop operating system based on FreeBSD that
focuses on providing an easy to use desktop system for
casual computer users. A list of new features/updates
since the last version can be found here.
The first Release Candidate build for the &os;-7.3
release cycle is now available. ISO images for Tier-1
architectures are now available
on most of the &os;
mirror sites.
2Enhanced commit privileges:
Gábor Kövesdán
(src, ports, doc)
Gábor Kövesdán
participated in
Google Summer of Code
2008/2009 and for his work he has been given commit access to the
source code. His first pieces of work will be bringing in the result
of his summer work into the tree.
130&os; 7.3-BETA1 Available
The first BETA build for the &os;-7.3
release cycle is now available. ISO images for Tier-1
architectures are now available
on most of the &os;
mirror sites.