1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
<!-- $NetBSD: introduction.xml,v 1.20 2006/10/07 09:31:16 rillig Exp $ -->
<chapter id="introduction">
<title>What is pkgsrc?</title>
<sect1 id="introduction-section">
<title>Introduction</title>
<para>There is a lot of software freely available for Unix-based
systems, which is usually available in form of the source code. Before
such software can be used, it needs to be configured to the local
system, compiled and installed, and this is exactly what The NetBSD
Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
to handle binary packages, so that not every user has to build the
packages for himself, which is a time-costly task.</para>
<para>pkgsrc currently contains several thousand packages,
including:</para>
<itemizedlist>
<listitem>
<para><filename role="pkg">www/apache</filename> - The Apache
web server</para>
</listitem>
<listitem>
<para><filename role="pkg">www/firefox</filename> - The Firefox
web browser</para>
</listitem>
<listitem>
<para><filename role="pkg">meta-pkgs/gnome</filename> - The GNOME
Desktop Environment</para>
</listitem>
<listitem>
<para><filename role="pkg">meta-pkgs/kde3</filename> - The K
Desktop Environment</para>
</listitem>
</itemizedlist>
<para>...just to name a few.</para>
<para>pkgsrc has built-in support for handling varying dependencies,
such as pthreads and X11, and extended features such as IPv6 support on
a range of platforms.</para>
<sect2 id="why-pkgsrc">
<title>Why pkgsrc?</title>
<para>
pkgsrc provides the following key features:
</para>
<itemizedlist>
<listitem><para>Easy building of software from source as well as the creation
and installation of binary packages. The source and latest
patches are retrieved from a master or mirror download site, checksum
verified, then built on your system. Support for binary-only
distributions is available for both native platforms and NetBSD
emulated platforms.</para></listitem>
<listitem><para>All packages are installed in a consistent directory tree,
including binaries, libraries, man pages and other
documentation.</para></listitem>
<listitem><para>Package dependencies, including when performing package updates,
are handled automatically. The configuration files of various
packages are handled automatically during updates, so local changes
are preserved.</para></listitem>
<listitem><para>Like NetBSD, pkgsrc is designed with portability in mind and
consists of highly portable code. This allows the greatest speed of
development when porting to new a platform. This portability also
ensures that pkgsrc is <emphasis>consistent across all
platforms</emphasis>.</para></listitem>
<listitem><para>The installation prefix, acceptable software licenses,
international encryption requirements and build-time options for a
large number of packages are all set in a simple, central
configuration file.</para></listitem>
<listitem><para>The entire source (not including the distribution files) is
freely available under a BSD license, so you may extend and adapt
pkgsrc to your needs. Support for local packages and patches is
available right out of the box, so you can configure it specifically
for your environment.</para></listitem>
</itemizedlist>
<para>The following principles are basic to pkgsrc:</para>
<itemizedlist>
<listitem><para><quote>It should only work if it's right.</quote>
— That means, if a package contains bugs, it's better to find
them and to complain about them rather than to just install the package
and hope that it works. There are numerous checks in pkgsrc that try to
find such bugs: Static analysis tools (<filename
role="pkg">pkgtools/pkglint</filename>), build-time checks (portability
of shell scripts), and post-installation checks (installed files,
references to shared libraries, script interpreters).</para></listitem>
<listitem><para><quote>If it works, it should work everywhere</quote>
— Like NetBSD has been ported to many hardware architectures,
pkgsrc has been ported to many operating systems. Care is taken that
packages behave the same on all platforms.</para></listitem>
</itemizedlist>
</sect2>
<sect2 id="intro.platforms">
<title>Supported platforms</title>
<para>pkgsrc consists of both a source distribution and a binary
distribution for these operating systems. After retrieving the required
source or binaries, you can be up and running with pkgsrc in just
minutes!</para>
<para>pkgsrc was derived from FreeBSD's ports system, and
initially developed for NetBSD only. Since then, pkgsrc has
grown a lot, and now supports the following platforms:</para>
<table id="supported-platforms">
<title>Platforms supported by pkgsrc</title>
<tgroup cols = "2">
<thead>
<row>
<entry>Platform</entry>
<entry>Date Support Added</entry>
</row>
</thead>
<tbody>
<row>
<entry><ulink url="http://www.NetBSD.org/">NetBSD</ulink></entry>
<entry align="center">Aug 1997</entry>
</row>
<row>
<entry><ulink url="http://wwws.sun.com/software/solaris/">Solaris</ulink></entry>
<entry align="center">Mar 1999</entry>
</row>
<row>
<entry><ulink url="http://www.kernel.org/">Linux</ulink></entry>
<entry align="center">Jun 1999</entry>
</row>
<row>
<entry>
<ulink url="http://developer.apple.com/darwin/">Darwin</ulink>
(<ulink url="http://developer.apple.com/macosx/">Mac OS X</ulink>)
</entry>
<entry align="center">Oct 2001</entry>
</row>
<row>
<entry><ulink url="http://www.freebsd.org/">FreeBSD</ulink></entry>
<entry align="center">Nov 2002</entry>
</row>
<row>
<entry><ulink url="http://www.openbsd.org/">OpenBSD</ulink></entry>
<entry align="center">Nov 2002</entry>
</row>
<row>
<entry><ulink url="http://www.sgi.com/software/irix/">IRIX</ulink></entry>
<entry align="center">Dec 2002</entry>
</row>
<row>
<entry>BSD/OS</entry>
<entry align="center">Dec 2003</entry>
</row>
<row>
<entry><ulink url="http://www-1.ibm.com/servers/aix/">AIX</ulink></entry>
<entry align="center">Dec 2003</entry>
</row>
<row>
<entry>
<ulink url="http://www.microsoft.com/windows/sfu/">Interix</ulink>
(Microsoft Windows Services for Unix)
</entry>
<entry align="center">Mar 2004</entry>
</row>
<row>
<entry><ulink url="http://www.dragonflybsd.org/">DragonFlyBSD</ulink></entry>
<entry align="center">Oct 2004</entry>
</row>
<row>
<entry><ulink url="http://www.tru64.org/">OSF/1</ulink></entry>
<entry align="center">Nov 2004</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
</sect1>
<sect1 id="overview">
<title>Overview</title>
<para>This document is divided into three parts. The first,
<link linkend="users-guide" endterm="users-guide.title"/>,
describes how one can use one of the packages in the Package
Collection, either by installing a precompiled binary package,
or by building one's own copy using the &os; package system.
The second part, <link linkend="developers-guide"
endterm="developers-guide.title"/>, explains how to prepare a
package so it can be easily built by other &os; users without
knowing about the package's building details. The third part,
<link linkend="infrastructure" endterm="infrastructure.title"/>
is intended for those who want to understand how pkgsrc is
implemented.</para>
<para>This document is available in various formats:
<simplelist type="inline">
<member><ulink url="index.html">HTML</ulink></member>
<member><ulink url="pkgsrc.pdf">PDF</ulink></member>
<member><ulink url="pkgsrc.ps">PS</ulink></member>
<member><ulink url="pkgsrc.txt">TXT</ulink></member>
</simplelist>.</para>
</sect1>
<sect1 id="terminology">
<title>Terminology</title>
<para>There has been a lot of talk about <quote>ports</quote>,
<quote>packages</quote>, etc. so far. Here is a description of all the
terminology used within this document.</para>
<variablelist>
<varlistentry>
<term>Package</term>
<listitem>
<para>A set of files and building instructions
that describe what's necessary
to build a certain piece of software using
pkgsrc. Packages are traditionally stored under
<filename>/usr/pkgsrc</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>The &os; package system</term>
<listitem>
<para>This is the former name of <quote>pkgsrc</quote>. It
is part of the &os; operating system and can be bootstrapped
to run on non-&os; operating systems as well. It handles
building (compiling), installing, and removing of
packages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Distfile</term>
<listitem>
<para>This term describes the file or files that are
provided by the author of the piece of software to
distribute his work. All the changes necessary to build on
&os; are reflected in the corresponding package. Usually
the distfile is in the form of a compressed tar-archive,
but other types are possible, too. Distfiles are usually
stored below
<filename>/usr/pkgsrc/distfiles</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Port</term>
<listitem>
<para>This is the term used by FreeBSD and OpenBSD people
for what we call a package.
In &os; terminology, <quote>port</quote> refers to a different
architecture.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Precompiled/binary package</term>
<listitem>
<para>A set of binaries built with pkgsrc from a distfile
and stuffed together in a single <filename>.tgz</filename>
file so it can be installed on machines of the same
machine architecture without the need to
recompile. Packages are usually generated in
<filename>/usr/pkgsrc/packages</filename>; there is also
an archive on <ulink
url="ftp://ftp.NetBSD.org/pub/NetBSD/packages/">ftp.NetBSD.org</ulink>.</para>
<para>Sometimes, this is referred to by the term <quote>package</quote> too,
especially in the context of precompiled packages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Program</term>
<listitem>
<para>The piece of software to be installed which will be
constructed from all the files in the distfile by the
actions defined in the corresponding package.</para>
</listitem>
</varlistentry>
</variablelist>
<sect2 id="term.roles">
<title>Roles involved in pkgsrc</title>
<variablelist>
<varlistentry><term>pkgsrc users</term><listitem><para>The
pkgsrc users are people who use the packages provided by pkgsrc.
Typically they are system administrators. The people using the
software that is inside the packages (maybe called <quote>end
users</quote>) are not covered by the pkgsrc guide.</para>
<para>There are two kinds of pkgsrc users: Some only want to
install pre-built binary packages. Others build the pkgsrc
packages from source, either for installing them directly or for
building binary packages themselves. For pkgsrc users <xref
linkend="users-guide"/> should provide all necessary
documentation.</para></listitem></varlistentry>
<varlistentry><term>package maintainers</term><listitem><para>A
package maintainer creates packages as described in <xref
linkend="developers-guide"/>.</para></listitem></varlistentry>
<varlistentry><term>infrastructure developers</term>
<listitem><para>These people are involved in all those files
that live in the <filename>mk/</filename> directory and below.
Only these people should need to read through <xref
linkend="infrastructure"/>, though others might be curious,
too.</para></listitem></varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 id="typography">
<title>Typography</title>
<para>When giving examples for commands, shell prompts are used to
show if the command should/can be issued as root, or if
<quote>normal</quote> user privileges are sufficient. We use a
&rprompt; for root's shell prompt, and a &cprompt; for users'
shell prompt, assuming they use the C-shell or tcsh.</para>
</sect1>
</chapter>
|