-
Notifications
You must be signed in to change notification settings - Fork 160
/
Packages.txt
2975 lines (2225 loc) · 117 KB
/
Packages.txt
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# $NetBSD: Packages.txt,v 1.304 2003/07/28 08:08:59 seb Exp $
###########################################################################
==========================
Documentation on the
NetBSD Package System
==========================
Hubert Feyrer, Alistair Crooks
Table of contents:
==================
Run this command to produce a table of contents:
sed '/^.====/{g;p;};h;d' Packages.txt
0 Intro
=======
There is a lot of software freely available for Unix based systems, which
usually runs on NetBSD, too, sometimes with some modifications. The NetBSD
packages collection incorporates any such changes necessary to make that
software run on NetBSD, and makes the installation (and re-installation) of
the software package easy by means of a single command.
The NetBSD package system is used to enable such freely available
third-party software to be built easily on NetBSD hosts. Once the software
has been built, it is manipulated with the pkg_* tools so that installation
and de-installation, printing of an inventory of all installed packages and
retrieval of one-line comments or more verbose descriptions are all simple.
Both the NetBSD packages collection and the NetBSD package system are
derived from FreeBSD.
0.1 Overview
============
This document is divided into two parts. The first, "User's Guide",
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 copy using the NetBSD package system. The
second part, "Package Constructor's Guide", explains how to prepare
a package so it can be easily built by other NetBSD users without
knowing about the package's building details.
0.2 Terminology
===============
There has been a lot of talk about "ports", "packages", etc. so far. Here
is a description of all the terminology used within this document:
* Package:
A set of files and building instructions that describe what's necessary
to build a certain piece of software using the NetBSD package
system. Packages are traditionally stored under /usr/pkgsrc.
* The NetBSD package system:
This is the part of the NetBSD operating system handling building
(compiling), installing, and removing of packages.
* Distfile:
This term describes the file or files that are provided by the author
of the piece of freely available software to distribute his work. All
the changes necessary to build on NetBSD 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 stored below /usr/pkgsrc/distfiles.
* Port:
This is the term used by FreeBSD people for what we call a package.
In NetBSD terminology, "port" refers to a different architecture.
* Precompiled (binary) package:
A set of binaries built by the NetBSD package system from a distfile
using the NetBSD package system and stuffed together in a single .tgz
file so it can be installed on machines of the same machine architecture
without the need to recompile. Packages are generated in
/usr/pkgsrc/packages by the NetBSD package system; there is also an
archive on ftp.netbsd.org.
Sometimes, this is referred to by the term "package" too,
especially in the context of precompiled packages.
* Program:
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.
* NetBSD RCS IDs:
Some files in a package contain RCS IDs to reflect which version of
that file this is (inserted automatically by cvs). These IDs are used
in several examples within this document, but as this document itself
is managed by CVS, it can't list the RCS IDs in plaintext. Instead, the
$s are written as <$>, resulting in <$>NetBSD<$> and <$>Id<$>.
0.3 Typography
==============
Right now this document is written in plain ASCII text, and there's not
much typography applied here. It's being moved to DocBook.
When giving examples for commands, shell prompts are used to show if the
command should/can be issued as root, or if "normal" user privileges are
sufficient. We use a "#" for root's shell prompt, and a "%" for users'
shell prompt, assuming they use the C-shell or tcsh.
====================
Part I: User's Guide
====================
1 Installing a precompiled binary package
=========================================
This section describes how to find, retrieve and install a precompiled
binary package that someone else already prepared for your type of machine.
1.1 Where to get
================
Precompiled packages are stored on ftp.netbsd.org and its mirrors in the
directory /pub/NetBSD/packages for anon FTP access. Please pick the right
subdirectory there as indicated by "uname -p". In that directory, there
is a subdirectory for each category plus a subdirectory "All" which includes
the actual binaries in .tgz-files. The category subdirectories use symbolic
links to those files. (This is the same directory layout as in
/usr/pkgsrc/packages).
This same directory layout applies for CDROM distributions, only that the
directory may be rooted somewhere else, probably somewhere below /cdrom.
Please consult your CDROM's documentation for the exact location!
1.2 How to use
==============
If you have the files on a CDROM or downloaded them to your hard disk, you
can install them with the following command (be sure to su to root first):
# pkg_add /path/to/package.tgz
If you have FTP access and you don't want to download the packages via FTP
prior to installation, you can do this automatically by giving pkg_add an
ftp-URL:
# pkg_add ftp://ftp.netbsd.org/pub/NetBSD/packages/<OS Ver>/<arch>/All/package.tgz
If there is any doubt, the uname utility can be used to determine the
<OS Ver>, and <arch> by running "uname -rp".
Also note that any prerequisite packages needed to run the package in
question will be installed, too, assuming they are present where you install
from.
After you've installed packages, be sure to have /usr/pkg/bin in your $PATH
so you can actually start the just installed program.
1.3 A word of warning
=====================
Please pay very careful attention to the warnings expressed in that manual
page about the inherent dangers of installing binary packages which you did
not create yourself, and the security holes that can be introduced onto
your system by indiscriminate adding of such files.
2 Installing by Building
========================
This assumes that the package is already part of the NetBSD package system.
If it is not, then you are advised to read part II of this document,
"Package Constructor's Guide".
2.1 Requirements
================
To build packages from source on a NetBSD system the "comp" and the "text"
distribution sets must be installed. If you want to build X11 related
packages the "xbase" and "xcomp" distribution sets are required, too.
2.2 Where to get pkgsrc
=======================
There are three ways to get pkgsrc. Either as a tar file, via SUP, or
via CVS. All three ways are described here.
To get the package source going, you need to get the pkgsrc.tar.gz file
from ftp://ftp.netbsd.org/pub/NetBSD-current/tar_files/pkgsrc.tar.gz and
unpack it into /usr.
As an alternative, you can get pkgsrc via the Software Update Protocol,
SUP. To do so, make sure your supfile has a line saying "release=pkgsrc" in
it, see the examples in /usr/share/examples/supfiles, and that the
directory /usr/pkgsrc does exist. Then, simply start "sup -v
/path/to/your/supfile".
To get pkgsrc via CVS, make sure you have cvs installed. If not present on
your system, it can be found as precompiled binary on ftp.netbsd.org.
To do an initial (full) checkout of pkgsrc, do the following steps:
% setenv CVSROOT [email protected]:/cvsroot
% setenv CVS_RSH ssh
% cd /usr
% cvs checkout -P pkgsrc
This will create the "pkgsrc" directory in your /usr, and all the
package source will be stored under /usr/pkgsrc. To update pkgsrc
after the initial checkout, make sure you have CVS_RSH set as above,
then do:
% cd /usr/pkgsrc
% cvs -q update -dP
Please also note that it is possible to have multiple copies of the
pkgsrc hierarchy in use at any one time - all work is done relatively
within the pkgsrc tree.
2.3 Fetching distfiles
======================
There is one gotcha: The distribution file (i.e. the unmodified source)
must exist on your system for the packages system to be able to build it.
If it does not, then ftp(1) is used to fetch the distribution files
automatically.
You can overwrite some of the major distribution sites to fit to sites
that are close to your own. Have a look at
pkgsrc/mk/bsd.pkg.defaults.mk to find some examples - in particular,
look for the MASTER_SORT, MASTER_SORT_REGEX and INET_COUNTRY
definitions. This may save some of your bandwidth and time.
You can change these settings either in your shell's environment, or,
if you want to keep the settings, by editing the /etc/mk.conf file,
and adding the definitions there.
If you don't have a permanent Internet connection and you want to know
which files to download, "make fetch-list" will tell you what you'll need.
Put these distfiles into /usr/pkgsrc/distfiles.
2.4 How to build and install
============================
Assuming that the distfile has been fetched (see previous section), become
root and change into the relevant directory. Then you can type
% make
at the shell prompt to build the various components of the package, and
# make install
at the shell prompt to install the various components into the correct
places on your system.
Taking the top system utility as an example, we can install it on our
system by building as shown in appendix A.1.
The program is installed under the default root of the packages tree -
/usr/pkg. Should this not conform to your tastes, simply set the LOCALBASE
variable in your environment, and it will use that value as the root of
your packages tree. So, to use /usr/local, set
LOCALBASE=/usr/local
in your environment. Please note that you should use a root which is
dedicated to packages and not shared with other programs (ie, do not try
and use LOCALBASE=/usr). Also, you should not try to add any of your
own files or directories (such as, for example, src, obj, or pkgsrc) below
the LOCALBASE tree. This is to prevent possible conflicts between programs
and other files installed by the package system and whatever else may have
been installed there.
There is, of course, one exception to this - X11 packages are traditionally
installed in the X11 tree. The definition used to identify the root of the
X11 tree is the X11BASE definition.
It is possible to install X11 packages in the LOCALBASE tree, for
which you must install the xpkgwedge package
(pkgsrc/pkgtools/xpkgwedge) - see section 7.1 for further details.
Some packages look in /etc/mk.conf to alter some configuration options
at build time. Have a look at pkgsrc/mk/bsd.pkg.defaults.mk to
get an overview of what will be set there by default. Environment
variables such as LOCALBASE, and X11BASE can be set in /etc/mk.conf to
save having to remember to set them each time you want to use pkgsrc.
Occasionally, people want to "look under the covers" to see what is
going on when a package is building or being installed. This may be
for debugging purposes, or out of simple curiosity. A number of utility
values have been added to help with this.
(1) If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a
huge amount of information will be displayed. As a worked example,
make patch PKG_DEBUG_LEVEL=2
will show all the commands that are invoked, up to and including the
"patch stage".
(2) If you want to know the value of a certain make(1) definition, then
the VARNAME definition should be used, in conjunction with the show-var
target. e.g.
make show-var VARNAME=DISTFILES
will show the expansion of the make(1) variable "DISTFILES".
If you want to de-install and re-install a binary package that you've
created (see next section), that you put into pkgsrc/packages manually or
that's located on a remote FTP server, you can use the the "bin-install"
target. This target will install a binary package - if available - via
pkg_add, and do a "make package" else. The list of remote FTP sites
searched is kept in the variable BINPKG_SITE, which defaults to
ftp.netbsd.org. Any flags that should be added to pkg_add(8) can be put
into BIN_INSTALL_FLAGS. See pkgsrc/mk/bsd.pkg.defaults.mk for more details.
A final word of warning: If you setup a system that has a non-standard
setting for LOCALBASE (or X11BASE, for that matter), be sure to set that
before any packages are installed, as you can not use several directories
for the same purpose. Doing so will result in pkgsrc not being able to
properly detect your installed packages, and fail miserably. Note also that
precompiled binary packages are usually built with the default LOCALBASE of
/usr/pkg, and that you should *not* install any if you use a non-standard
LOCALBASE.
3 Making precompiled packages
=============================
3.1 Packaging a single package
==============================
Once you have built and installed the package as mentioned above, you can
build it into a "binary package" - you might want to do this so that you
can use the binaries you have just built on another NetBSD system, or to
provide a simple means for others to use your binary package instead of
wasting CPU time - this is done by changing to the appropriate directory in
the pkgsrc tree, and typing the command
# make package
at the shell prompt. This will build and install your package (if not
already done), and then construct a binary package out of the results so
that you can use the pkg_* tools to manipulate this. The binary package is
stored under /usr/pkgsrc/packages, it's in the form of a gzipped file at
the present time. See appendix A.2 for a continuation of the above top
example.
Please see the "submitting" section later in this document on how to submit
such a binary package.
3.2 Doing a bulk build of all packages
======================================
If you want to get a full set of precompiled binary packages, this section
describes how to get them. Beware that the bulk build will remove all
currently installed packages from your system! Having a FTP server
configured either on the machine doing the bulk builds or on a nearby NFS
server can help to make the packages available to everyone. See ftpd(8) for
more information. If you use a remote NFS server's storage, be sure to not
actually compile on NFS storage, as this slows things down a lot.
3.2.1 Configuration
===================
3.2.1.1 /etc/mk.conf
====================
You may want to set things in /etc/mk.conf. Look at
pkgsrc/mk/bsd.pkg.defaults.mk for details of the default settings.
You will want to make sure that ACCEPTABLE_LICENSES meet your local
policy:
PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
BSDSRCDIR= /usr/src
BSDXSRCDIR= /usr/xsrc # for x11/xservers
OBJHOSTNAME?= yes # use work.`hostname`
FAILOVER_FETCH= yes # insist on the correct checksum
PKG_DEVELOPER?= yes
_ACCEPTABLE= yes
If you wish to use xpkgwedge for the entire build, then add:
BULK_PREREQ+= pkgtools/xpkgwedge
Other packages which must be installed during the bulk build to modify the
build behaviour may be added to the BULK_PREREQ variable. Note that currently
the only package for which BULK_PREREQ makes sense is xpkgwedge.
3.2.1.2 build.conf
==================
In pkgsrc/mk/bulk, copy ``build.conf-example'' to ``build.conf'' and
edit it, following the comments in that file. This is the config
file that determines where log files are generated after the build,
where to mail the build report, where your pkgsrc is located and
which user to su(8) to to do a 'cvs update'.
3.2.1.3 pre-build.local
=======================
It is possible to configure the bulk build to perform certain site
specific tasks at the end of the pre-build stage. If the file
``pre-build.local'' exists in pkgsrc/mk/bulk it will be executed
(as a sh(1) script) at the end of the usual pre-build stage. An
example use of pre-build.local is to have the line:
# echo "I do not have enough disk space to build this pig." \
> pkgsrc/games/crafty-book-enormous/$BROKENF
to prevent the system from trying to build a particular package
which requires nearly 3 Gb of disk space.
3.2.2 Other environmental considerations
========================================
As /usr/pkg will be completely deleted at the start of bulk builds,
make sure your login shell is placed somewhere else. Either drop it into
/usr/local/bin (and adjust your login shell in the password file), or
(re-)install it via pkg_add from /etc/rc.local, so you can login after a
reboot (remember that your current process won't die if the package is
removed, you just can't start any new instances of the shell any more).
Also, if you use a OS version below 1.5 or you still want to use the
pkgsrc version of ssh for some reason, be sure to install ssh before
starting it from rc.local:
( cd /usr/pkgsrc/security/ssh ; make bulk-install )
if [ -f /usr/pkg/etc/rc.d/sshd ]; then
/usr/pkg/etc/rc.d/sshd
fi
Not doing so will result in you being not able to log in via ssh
after the bulk build is finished or if the machine gets rebooted
or crashes. You have been warned! :)
3.2.3 Operation
===============
Make sure you don't need any of the packages still installed.
BEWARE: During the bulk build, ALL packages will be removed!!!
Be sure to remove all other things that might interfere with builds, like
some libs installed in /usr/local, etc. then become root and type:
# cd /usr/pkgsrc
# sh mk/bulk/build
If for some reason your last build didn't complete (power failure,
system panic, ...), you can continue it by running:
# sh mk/bulk/build restart
At the end of the bulk run, you will get a summary via mail, and find
build logs in the directory specified by "FTP" in the "build.conf"
file.
3.2.4 What it does
==================
The bulk builds consist of three steps:
1. pre-build: The script updates your pkgsrc via (anon)cvs, then cleans
out any broken distfiles, and removes all packages installed.
2. the bulk build: This is basically 'make bulk-package' with an optimised
order in which packages will be built. Packages that don't require
other packages will be built first, and packages with many depends
will be built later.
3. post-build: Generates a report that's placed in the directory specified
in the build.conf file named ``broken.html'', a short version of
that report will also be mailed to the build's admin.
During the build, a list of broken packages will be compiled in
/usr/pkgsrc/.broken (or .../.broken.${MACHINE} if OBJMACHINE is set),
individual build logs of broken builds can be found in the package's
directory. These files are used by the bulk-targets to mark broken builds
to not waste time trying to rebuild them, and they can be used to debug
these broken package builds later.
3.2.5 Disk space requirements
=============================
Currently, roughly the following requirements are valid for
1.5/i386:
* Distfiles: 1500MB (NFS ok)
* Full set of all binaries: 1000MB (NFS ok)
* Temp space for compiling: 1500MB (local disk recommended)
For 1.5/alpha:
* Full set of all binaries: 1300MB (NFS ok)
Note that all pkgs will be de-installed as soon as they are turned into a
binary package, and that work-sources are removed, so there is no huge
demand to disk space. Afterwards, if the package is needed again, it will
be installed via pkg_add instead of building again, so there are no cycles
wasted by recompiling.
3.2.6 Setting up a sandbox for chroot'ed builds
===============================================
If you don't want all the pkgs nuked from a machine (rendering it useless
for anything but pkg compiling), there is the possibility of doing the pkg
bulk build inside a chroot environment.
The first step to do so is setting up a chroot sandbox, e.g. /usr/sandbox.
After extracting all the sets from a NetBSD installation or doing a
"make distribution DESTDIR=/usr/sandbox" in src/etc, make sure the following
items are present and properly configured:
* kernel:
cp /netbsd /usr/sandbox
* /dev/*:
cd /usr/sandbox/dev ; sh MAKEDEV all
* /etc/resolv.conf (for security/smtpd and mail):
cp /etc/resolv.conf /usr/sandbox/etc
* working(!) mail config (hostname, sendmail.cf):
cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail
* /etc/localtime (for security/smtpd):
ln -sf /usr/share/zoneinfo/GMT /usr/sandbox/etc/localtime
* /usr/src (system sources, for sysutils/aperture, net/ppp-mppe):
ln -s ../disk1/cvs .
ln -s cvs/src-1.6 src
ln -s cvs/pkgsrc .
* create /var/db/pkg (not part of default install):
mkdir /usr/sandbox/var/db/pkg
* create /usr/pkg (not part of default install)
mkdir /usr/sandbox/usr/pkg
* checkout pkgsrc from cvs, into /usr/sandbox/usr/pkgsrc
cvs -d cvs.netbsd.org:/cvsroot co pkgsrc
* /usr/pkgsrc/packages & .../distfiles (point outside of sandbox)
* /etc/mk.conf, see 3.2.1.1
* adjust .../mk/bulk/build.conf
!!! Don't forget to install X !!!
If you are a developer and want to upload the resulting binary packages
to ftp.netbsd.org, make sure you are using the default X version for your
architecture and release (up to 1.6, that is 3.3.6 for all architectures).
Next thing you will want to is make sure /usr/sandbox/usr/pkgsrc contains a
fresh checkout of pkgsrc (e.g. from anoncvs). Do not mount/link this to the
copy of your pkgsrc tree you do development in, as this will likely cause
problems! Adjust .../pkgsrc/packages and .../pkgsrc/distfiles to point to
some places outside the sandbox if you want to make the files public.
Then, configure .../pkgsrc/mk/bulk/build.conf to fit your needs!
When the chroot sandbox is setup, you can start the build with the following
steps:
# cd /usr/sandbox/usr/pkgsrc
# sh mk/bulk/do-sandbox-build
This will just jump inside the sandbox and start thrash^Wbuilding.
At the end of the build, mail will be sent with the results of the build.
Created binary pkgs will be in /usr/sandbox/usr/pkgsrc/packages (wherever
that points/mounts to/from).
3.3 Creating a multiple CD-ROM packages collection
==================================================
After your bulk pkgsrc build has completed, you may wish to create a CD-ROM
set of the resulting binary packages to assist in installing packages on
other machines. The package pkgsrc/pkgtools/cdpack provides a simple tool for
creating the ISO 9660 images. `cdpack' arranges the packages on the CD-ROM's
in a way that keeps all the dependencies for given package on the same
CD as that package.
3.3.1 Example of cdpack
=======================
Complete documentation for cdpack is found in cdpack(1). The following
short example assumes that the binary packages are left in
/usr/pkgsrc/packages/All and that sufficient disk space exists in /u2
to hold the ISO 9660 images.
# mkdir /u2/images
# pkg_add /usr/pkgsrc/packages/All/cdpack
# cdpack /usr/pkgsrc/packages/All /u2/images
If you wish to include a common set of files (COPYRIGHT, README, etc)
on each CD in the collection, then you need to create a directory which
contains these files. For example
# mkdir /tmp/common
# echo "This is a README" > /tmp/common/README
# echo "Another file" > /tmp/common/COPYING
# mkdir /tmp/common/bin
# echo "#!/bin/sh" > /tmp/common/bin/myscript
# echo "echo Hello world" >> /tmp/common/bin/myscript
# chmod 755 /tmp/common/bin/myscript
Now create the images with
# cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
and each image will contain "README", "COPYING", and "bin/myscript"
in their root directories.
====================================
Part II: Package Constructor's Guide
====================================
4 Package components - files, directories and contents
======================================================
Whenever you're preparing a package, there are a number of files involved
which are described in the following sections.
4.1 Makefile
============
Building, installation and creation of a binary package are all controlled
by the package's Makefile.
There is a Makefile for each package. This file includes the standard
bsd.pkg.mk file (referenced as "../../mk/bsd.pkg.mk"), which sets all the
definitions and actions necessary for the package to compile and install
itself. The mandatory fields are the DISTNAME which specifies the base name
of the distribution file to be downloaded from the site on the Internet,
MASTER_SITES which specifies that site, CATEGORIES which denotes the
categories into which the package falls, PKGNAME which is the name of the
package, the MAINTAINER name, and the COMMENT variable, which should
contain a one-line description of the package (the package name should not
appear, it will be added automatically). The maintainer variable is there
so that anyone who quibbles with the (always completely correct) decisions
taken by the guy who maintains the port can complain vigorously.
The MASTER_SITES may be set to one of the predefined sites:
${MASTER_SITE_APACHE}
${MASTER_SITE_DEBIAN}
${MASTER_SITE_GNOME}
${MASTER_SITE_GNU}
${MASTER_SITE_GNUSTEP}
${MASTER_SITE_MOZILLA}
${MASTER_SITE_PERL_CPAN}
${MASTER_SITE_SOURCEFORGE}
${MASTER_SITE_SUNSITE}
${MASTER_SITE_R_CRAN}
${MASTER_SITE_SUSE}
${MASTER_SITE_TEX_CTAN}
${MASTER_SITE_XCONTRIB}
${MASTER_SITE_XEMACS}
If one of these predefined sites is chosen, you may require the ability to
specify a subdirectory of that site. Since these macros may expand to
more than one actual site, you MUST use the following construct to specify
a subdirectory:
${MASTER_SITE_GNU:=subdirectory/name/}
(Note the trailing slash after the subdirectory name.) Use of the deprecated
MASTER_SITE_SUBDIR will not work.
If the package has multiple DISTFILES or multiple PATCHFILES from different
sites, set SITES_foo to a list of URI's where file "foo" may be found. "foo"
includes the suffix, e.g.
DISTFILES=${DISTNAME}${EXTRACT_SUFX}
DISTFILES+=foo-file.tar.gz
SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \
http://www.somewhereelse.com/mirror/somehow/
Note, that the normal default setting of DISTFILES must be made explicit
if you want to add to it (rather than replace it), as you usually would.
Currently the following values are available for CATEGORIES. If more than
one is used, they need to be separated by spaces:
archivers audio benchmarks biology cad
chat comms converters cross databases
devel editors emulators finance fonts
games graphics ham japanese lang
mail math mbone misc net
news parallel print security shells
sysutils textproc time wm www
x11
See the NetBSD packages(7) manual page for a description of all available
options and variables.
Please pay attention to the following gotchas:
- Add MANCOMPRESSED (if not already there) if manpages are installed in
compressed form by the package; see comment in bsd.pkg.mk
- Replace /usr/local by ${PREFIX} in all files (see patches below)
- If the package installs any info files, see the section `Packages providing
info files' in this document.
- Adjust MAINTAINER to be either yourself, if you plan to maintain the
package for future updates, or set it to the default MAINTAINER
- If there exists a home page for the software in question, please
add the variable HOMEPAGE right after MAINTAINER. The value of this
variable should be the URL for the home page.
- Please also set the COMMENT variable to a short description of the
package. The description should start with a capital letter.
4.2 distinfo
============
Most important, the mandatory message digest, or checksum, of all the
distfiles needed for the package to compile, confirming they match the
original file distributed by the author. This ensures that the
distfile retrieved from the Internet has not been corrupted during
transfer or altered by a malign force to introduce a security hole.
It is best generated using the "make makesum" command. The digest
algorithm used was, at one stage, md5, but that was felt lacking
compared to sha1, and so sha1 is now the default algorithm. The
distfile size is also generated and stored in new distinfo files.
The pkgsrc/pkgtools/digest utility calculates all of the digests
in the distinfo file, and it provides various different algorithms.
At the current time, the algorithms provided are:
md5, rmd160, sha1, sha256, sha384 and sha512
Some packages have different sets of distfiles on a per architecture
basis. (A good example is pkgsrc/www/navigator). These are kept in the
same distinfo file and care should be taken when upgrading such a
package to ensure distfile information is not lost.
The message digest/checksum for all the official patches found in the
patches/ directory (see section 4.3) for the package is also stored in
the distinfo file. This is a message digest/checksum of all lines in
the patch file except the NetBSD RCS Id. This file is generated by
invoking "make makepatchsum".
4.3 patches/*
=============
This directory contains files that are used by the patch(1) command to
modify the sources as distributed in the distribution file into a form that
will compile and run perfectly on NetBSD. The files are applied
successively in alphabetic order (as returned by a shell "patches/patch-*"
glob expansion), so patch-aa is applied before patch-ab etc.
The patch-?? files should be in "diff -bu" format, and apply without
a fuzz to avoid problems (To force patches to apply with fuzz you
can set PATCH_FUZZ_FACTOR=-F2). Furthermore, do not put changes
for more than one file into a single patch-file, as this will make
future modifications more difficult.
Similar, a file should be patched at most once, not several times by
several different patches. If a file needs several patches, they should
be combined into one file.
One important thing to mention is to pay attention that no RCS IDs
get stored in the patch files, as these will cause problems when
later checked into the NetBSD CVS tree. To avoid this, use either
the "-U 2" or "-U 1" option to diff, or let the 'pkgdiff' command
from pkgsrc/pkgtools/pkgdiff help you.
If you don't want to worry about the problems in the last two paragraphs
yourself, use pkgdiff from the pkgsrc/pkgtools/pkgdiff package, which takes
care of any RCS Ids by itself.
For even more automation, we recommend using mkpatches from the same
package to make a whole set of patches. You just have to backup files
before you edit them to "filename.orig", e.g. with "cp -p filename
filename.orig" or, easier, by using pkgvi from the same package. If you
upgrade a package this way, you can easily compare the new set of patches
with the previously existing one with patchdiff.
When you have finished a package, remember to generate the checksums
for the patch files by using the "make makepatchsum" command, see
section 4.2.
If it is desired to store any patches that should not be committed into
pkgsrc, they can be kept outside the pkgsrc tree in the $LOCALPATCHES
directory. The directory tree there is expected to have the same
"category/package" structure as pkgsrc, and patches are expected to be
stored inside these dirs (also known as $LOCALPATCHES/$PKGPATH). For
example if you want to keep a private patch for pkgsrc/graphics/png, keep
it in $LOCALPATCHES/graphics/png/mypatch. All files in the named directory
are expected to be patch files, and they are applied after the "normal"
pkgsrc patches are applied.
4.4 Other mandatory files
=========================
* DESCR:
A multi-line description of the piece of software. This should include
any credits where they are due. Please bear in mind that others do not
share your sense of humour (or spelling idiosyncrasies), and that others
will read everything that you write here.
* PLIST:
This file governs the files that are installed on your system: all the
binaries, manual pages, etc. There are other directives which may be
entered in this file, to control the creation and deletion of
directories, and the location of inserted files.
4.5 Optional files
==================
* INSTALL:
Shell script invoked twice during pkg_add. First time after package
extraction and before files are moved in place, the second time after
the files to install are moved in place. This can be used to do any
custom procedures not possible with @exec commands in PLIST. See
pkg_add(1) and pkg_create(1) for more information.
* DEINSTALL:
This script is executed before and after any files are removed. It is
this script's responsibility to clean up any additional messy details
around the package's installation, since all pkg_delete knows is how to
delete the files created in the original distribution. See pkg_delete(1)
and pkg_create(1) for more information.
* MESSAGE:
Display this file after installation of the package.
Useful for things like legal notices on almost-free software, etc.
Please note that you can modify variables in it easily by using
MESSAGE_SUBST in the package's Makefile:
MESSAGE_SUBST+= SOMEVAR="somevalue"
replaces
${SOMEVAR}
in MESSAGE with "somevalue" before displaying the message.
4.6 work/*
==========
When you type "make" the distribution files are unpacked into this
directory. It can be removed by typing
# make clean
at the shell prompt. Also, this directory is used to keep various
timestamp files.
4.7 files/*
===========
If you have any files that you wish to be placed in the package prior
to configuration or building, you could place these files here and use
a ${CP} command in the pre-configure target to achieve this.
Alternatively, you could simply diff the file against /dev/null and
use the patch mechanism to manage the creation of this file.
5 PLIST* issues
===============
This section addresses some special issues that one needs to pay attention
to when dealing with the PLIST file (or files, see below!).
5.1 Miscellaneous
=================
* NetBSD RCS Id:
Be sure to add a RCS ID line as the first thing in any PLIST file you
write:
@comment <$>NetBSD<$>
* ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}:
Some packages like emacs and perl embed information about which
architecture they were built on into the pathnames where they install
their file. To handle this case, PLIST will be preprocessed before
actually used, and the symbol "${MACHINE_ARCH}" will be replaced by
what "uname -p" gives. The same is done if the string ${MACHINE_GNU_ARCH}
is embedded in PLIST somewhere - use this on packages that have GNU
autoconf created configure scripts.
Legacy note: There used to be a symbol "<$ARCH>" that was replaced by
the output of "uname -m", but that's no longer supported and has been
removed.
* ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}:
Some packages want to embed the OS name and version into some paths.
To do this, use these variables in the PLIST:
* ${OPSYS} - output of "uname -s"
* ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
* ${OS_VERSION} - "uname -r"
* ${PKGLOCALEDIR}:
Packages that install locale files should list them in the PLIST as
"${PKGLOCALEDIR}/locale/de/LC_MESSAGES/..." instead of
"share/locale/de/LC_MESSAGES/...". This properly handles the fact that
different OSes expect locale files to be either in "share" or "lib" by
default.
* Manpage-compression:
Manpages should be installed in compressed form if MANZ is set (in
bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST
file, the suffix ".gz" is appended/removed automatically for manpages
according to MANZ and MANCOMPRESSED being set or not, see above for
details. This modification of the PLIST file is done on a copy of it,
not PLIST itself.
* Platform specific and differing PLISTs:
Some packages decide to install a different set of files based on
the operating system being used. These differences can be
automatically handled by using the following files:
* PLIST.common
* PLIST.${OPSYS}
* PLIST.common_end
If PLIST.${OPSYS} exists, these files are used instead of PLIST. This
allows packages which behave in this way to be handled gracefully.
Manually overriding PLIST_SRC for other more exotic uses is also
possible.
* Semi-automatic PLIST generation:
You can use the "make print-PLIST" command to output a PLIST that matches
any new files since the package was extracted. See below for more
information on this target.
5.2 ${PLIST_SRC}
================
To use one or more files as source for the PLIST used in generating the
binary package, set the variable PLIST_SRC to the names of that file(s).
The files are later concatenated using cat(1), and order of things is
important.
5.3 ${PLIST_SUBST}
==================
Similar to MESSAGE_SUBST (see above), you can add variables and their
expansions to this variable in the following way:
PLIST_SUBST+= SOMEVAR="somevalue"
which replaces all occurrences of ${SOMEVAR} in the PLIST with "somevalue".
For the values which are replaced by default, please look in bsd.pkg.mk
(and search for PLIST_SUBST).
5.4 Perl5 modules
=================
Makefile of packages providing perl5 modules should include the
makefile fragment lang/perl5/module.mk. It provides a do-configure
target for the standard perl configuration for such modules as well
as various hooks to tune this configuration. See comments in this
file for details.
Perl5 modules will install into different places depending on the version
of perl used during the build process. To address this, the NetBSD
packages system will append lines to the PLIST corresponding to the files
listed in the installed .packlist file generated by most perl5 modules.
This is invoked by defining PERL5_PACKLIST to a space-separated list of
paths to packlist files:
PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
The variables PERL5_SITELIB, PERL5_SITEARCH, and PERL5_ARCHLIB represent
the three locations in which perl5 modules may be installed, and may be
used by perl5 packages that don't have a packlist. These three variables
are also substituted for in the PLIST.
5.5 User Interaction
====================
Occasionally, packages require interaction from the user, and this can be
in a number of ways:
+ help in fetching the distfiles
+ help to configure the package before it is built
+ help during the build process
+ help during the installation of a package