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
|
<!-- $NetBSD: faq.xml,v 1.11 2005/05/29 17:16:28 jmmv Exp $ -->
<chapter id="faq"> <?dbhtml filename="faq.html"?>
<title>Frequently Asked Questions</title>
<para> This section contains hints, tips & tricks on special
things in pkgsrc that we didn't find a better place for in the
previous chapters, and it contains items for both pkgsrc users and
developers. </para>
<sect1 id="mailing-list-pointers">
<title>Are there any mailing lists for pkg-related discussion?</title>
<para>
The following mailing lists may be of interest to pkgsrc users:
</para>
<itemizedlist>
<listitem>
<para>
<ulink url="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs">pkgsrc-bugs</ulink>
-- a list where problem reports related to pkgsrc are sent and
discussed
</para>
</listitem>
<listitem>
<para>
<ulink
url="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk">pkgsrc-bulk</ulink>
-- a list where the results of pkgsrc bulk builds are sent and
discussed
</para>
</listitem>
<listitem>
<para>
<ulink
url="http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes">pkgsrc-changes</ulink>
-- a list where all commit messages to pkgsrc are sent
</para>
</listitem>
<listitem>
<para>
<ulink
url="http://www.NetBSD.org/MailingLists/index.html#tech-pkg">tech-pkg</ulink>
-- a general discussion list for all things related to pkgsrc
</para>
</listitem>
</itemizedlist>
<para>
To subscribe, do:
</para>
<programlisting>&cprompt; echo subscribe <replaceable>listname</replaceable> | mail majordomo@NetBSD.org</programlisting>
<para>
Archives for all these mailing lists are available from
<ulink url="http://mail-index.NetBSD.org/"/>.
</para>
</sect1>
<sect1 id="pkgviews-docs">
<title>Where's the pkgviews documentation?</title>
<para> Pkgviews is tightly integrated with buildlink. You can find a
pkgviews User's guide in
<filename>pkgsrc/mk/buildlink3/PKGVIEWS_UG</filename>.
</para>
</sect1>
<sect1 id="faq-pkgtools">
<title>Utilities for package management (pkgtools)</title>
<para>
The <filename>pkgsrc/pkgtools</filename> directory pkgtools
contains a number of useful utilities for both users and
developers of pkgsrc. This section attempts only to make the
reader aware of the utilities and when they might be useful, and
not to duplicate the documentation that comes with each package.
</para>
<para>
Utilities used by pkgsrc (automatically installed when needed):
</para>
<itemizedlist>
<listitem>
<para> <pkg>pkgtools/x11-links</pkg>: symlinks for use by
buildlink </para>
</listitem>
</itemizedlist>
<para> OS tool augmentation (automatically installed when needed):
</para>
<itemizedlist>
<listitem>
<para> <pkg>pkgtools/digest</pkg>:
calculates various kinds of checksums (including SHA1)
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/libnbcompat</pkg>:
compatibility library for pkgsrc tools
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/mtree</pkg>:
installed on non-BSD systems due to lack of native mtree
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/pkg_install</pkg>:
up-to-date replacement for /usr/sbin/pkg_install, or for
use on operating systems where pkg_install is not present
</para>
</listitem>
</itemizedlist>
<para> Utilities used by pkgsrc (not automatically installed):
</para>
<itemizedlist>
<listitem>
<para> <pkg>pkgtools/pkg_tarup</pkg>:
create a binary package from an already-installed package.
used by <command>make replace</command> to save the old package
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/dfdisk</pkg>:
adds extra functionality to pkgsrc, allowing it to fetch
distfiles from multiple locations. It currently supports the
following methods: multiple CD-ROMs and network FTP/HTTP
connections.
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/xpkgwedge</pkg>:
put X11 packages someplace else (enabled by default)
</para>
</listitem>
<listitem>
<para> <pkg>devel/cpuflags</pkg>:
will determine the best compiler flags to optimise code for
your current CPU and compiler.
</para>
</listitem>
</itemizedlist>
<para> Utilities for keeping track of installed packages, being up
to date, etc: </para>
<itemizedlist>
<listitem>
<para> <pkg>pkgtools/pkg_chk</pkg>:
reports on packages whose installed
versions do not match the latest pkgsrc entries
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/pkgdep</pkg>:
makes dependency graphs of packages, to aid in choosing a
strategy for updating
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/pkgdepgraph</pkg>:
makes graphs from the output of <pkg>pkgtools/pkgdep</pkg> (uses graphviz)
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/pkglint</pkg>:
the pkglint(1) program checks a pkgsrc entry for errors,
lintpkgsrc(1) does various checks on the complete pkgsrc system.
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/pkgsurvey</pkg>:
report what packages you have installed
</para>
</listitem>
</itemizedlist>
<para> Utilities for people maintaining or creating individual
packages: </para>
<itemizedlist>
<listitem>
<para> <pkg>pkgtools/pkgdiff</pkg>:
automate making and maintaining patches for a package (includes
pkgdiff, pkgvi, mkpatches, ...)
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/rpm2pkg</pkg>, <pkg>pkgtools/url2pkg</pkg>:
aids in converting to pkgsrc
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/gensolpkg</pkg>:
convert pkgsrc to a Solaris package
</para>
</listitem>
</itemizedlist>
<para> Utilities for people maintaining pkgsrc (or more obscure
pkg utilities) </para>
<itemizedlist>
<listitem>
<para> <pkg>pkgtools/pkgconflict</pkg>:
find packages that conflict but aren't marked as such
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/pkg_comp</pkg>:
build packages in a chrooted area
</para>
</listitem>
<listitem>
<para> <pkg>pkgtools/libkver</pkg>:
spoof kernel version for chrooted cross builds
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="non-root-pkgsrc">
<title>How to use pkgsrc as non-root</title>
<para>If you want to use pkgsrc as non-root user, you can set some
variables to make pkgsrc work under these conditions. At the very
least, you need to set <varname>UNPRIVILEGED</varname> to
<quote>yes</quote>; this will turn on unprivileged mode and set
multiple related variables to allow installation of packages as
non-root.</para>
<para>In case the defaults are not enough, you may want to tune some
other variables used. For example, if the automatic user/group
detection leads to incorrect values (or not the ones you would like
to use), you can change them by setting
<varname>UNPRIVILEGED_USER</varname> and
<varname>UNPRIVILEGED_GROUP</varname> respectively.</para>
<para>As regards bootstrapping, please note that the
<command>bootstrap</command> script will ease non-root configuration
when given the <quote>--ignore-user-check</quote> flag, as it will
choose and use multiple default directories under
<filename>~/pkg</filename> as the installation targets. These
directories can be overriden by the <quote>--prefix</quote> flag
provided by the script, as well as some others that allow finer tuning
of the tree layout.</para>
</sect1>
<sect1 id="resume-transfers">
<title>How to resume transfers when fetching distfiles?</title>
<para>By default resuming transfers in pkgsrc is disabled, but you
can enable this feature by adding the option
<varname>PKG_RESUME_TRANSFERS=YES</varname> into
<filename>/etc/mk.conf</filename>. If, during a fetch step, an
incomplete distfile is found, pkgsrc will try to resume it.</para>
<para>You can also use a different program than the default &man.ftp.1; by
changing the <varname>FETCH_CMD</varname> variable.
Don't forget to set <varname>FETCH_RESUME_ARGS</varname> and
<varname>FETCH_OUTPUT_ARGS</varname> if you are not using default
values.</para>
<para>For example, if you want to use <filename>wget</filename> to
resume downloads, you'll have to use something like:</para>
<programlisting>
FETCH_CMD=wget
FETCH_BEFORE_ARGS=--passive-ftp
FETCH_RESUME_ARGS=-c
FETCH_OUTPUT_ARGS=-O
</programlisting>
</sect1>
<sect1 id="XFree86-from-pkgsrc">
<title>How can I install/use XFree86 from pkgsrc?</title>
<para> If you want to use XFree86 from pkgsrc instead of your
system's own X11 (<filename>/usr/X11R6</filename>,
<filename>/usr/openwin</filename>, ...), you will have to
add the following line into <filename>/etc/mk.conf</filename>:
</para>
<programlisting>
X11_TYPE=XFree86
</programlisting>
</sect1>
<sect1 id="x.org-from-pkgsrc">
<title>How can I install/use X.org from pkgsrc?</title>
<para> If you want to use X.org from pkgsrc instead of your system's
own X11 (<filename>/usr/X11R6</filename>,
<filename>/usr/openwin</filename>, ...) you will have to add the
following line into <filename>/etc/mk.conf</filename>: </para>
<programlisting>
X11_TYPE=xorg
</programlisting>
</sect1>
<sect1 id="fetch-behind-firewall">
<title>How to fetch files from behind a firewall</title>
<para> If you are sitting behind a firewall which does not allow
direct connections to Internet hosts (i.e. non-NAT), you may
specify the relevant proxy hosts. This is done using an
environment variable in the form of a URL e.g. in Amdahl, the
machine <quote>orpheus.amdahl.com</quote> is one of the
firewalls, and it uses port 80 as the proxy port number. So the
proxy environment variables are: </para>
<programlisting> ftp_proxy=ftp://orpheus.amdahl.com:80/
http_proxy=http://orpheus.amdahl.com:80/</programlisting>
</sect1>
<sect1 id="passive-ftp">
<title>How do I tell <command>make fetch</command> to do passive FTP?</title>
<para> This depends on which utility is used to retrieve distfiles. From <filename>bsd.pkg.mk</filename>, <varname>FETCH_CMD</varname> is assigned the first available command from the following list: </para>
<programlisting>${LOCALBASE}/bin/ftp
/usr/bin/ftp</programlisting>
<para> On a default NetBSD installation, this will be
<filename>/usr/bin/ftp</filename>, which automatically tries
passive connections first, and falls back to active connections
if the server refuses to do passive. For the other tools, add
the following to your <filename>/etc/mk.conf</filename> file:
<varname>PASSIVE_FETCH=1</varname>. </para>
<para> Having that option present will prevent
<filename>/usr/bin/ftp</filename> from falling back to active
transfers. </para>
</sect1>
<sect1 id="fetching-all-distfiles">
<title>How to fetch all distfiles at once</title>
<para> You would like to download all the distfiles in a single
batch from work or university, where you can't run a
<command>make fetch</command>. There is an archive of distfiles
on <ulink
url="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/">ftp.NetBSD.org</ulink>,
but downloading the entire directory may not be appropriate.
</para>
<para> The answer here is to do a <command>make
fetch-list</command> in <filename>/usr/pkgsrc</filename> or one
of it's subdirectories, carry the resulting list to your machine
at work/school and use it there. If you don't have a
NetBSD-compatible &man.ftp.1; (like lukemftp) at work, don't forget
to set <varname>FETCH_CMD</varname> to something that fetches a
URL: </para>
<para> At home: </para>
<screen><prompt>%</prompt> <userinput>cd /usr/pkgsrc</userinput>
<prompt>%</prompt> <userinput>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</userinput>
<prompt>%</prompt> <userinput>scp /tmp/fetch.sh work:/tmp</userinput></screen>
<para> At work: </para>
<screen><prompt>%</prompt> <userinput>sh /tmp/fetch.sh</userinput></screen>
<para> then tar up <filename>/tmp/distfiles</filename> and take it
home. </para>
<para> If you have a machine running NetBSD, and you want to get
<emphasis>all</emphasis> distfiles (even ones that aren't for
your machine architecture), you can do so by using the
above-mentioned <command>make fetch-list</command> approach, or
fetch the distfiles directly by running: </para>
<screen><prompt>%</prompt> <userinput>make mirror-distfiles</userinput></screen>
<para> If you even decide to ignore
<varname>NO_{SRC,BIN}_ON_{FTP,CDROM}</varname>, then you can get
everything by running: </para>
<screen><prompt>%</prompt> <userinput>make fetch NO_SKIP=yes</userinput></screen>
</sect1>
<sect1 id="tmac.andoc-missing">
<title>What does <quote>Don't know how to make /usr/share/tmac/tmac.andoc</quote> mean?</title>
<para> When compiling the <pkg>pkgtools/pkg_install</pkg> package,
you get the error from make that it doesn't know how to make
<filename>/usr/share/tmac/tmac.andoc</filename>? This indicates
that you don't have installed the <quote>text</quote> set
(nroff, ...) from the NetBSD base distribution on
your machine. It is recommended to do that to
format manpages. </para>
<para> In the case of the <pkg>pkgtools/pkg_install</pkg> package,
you can get away with setting <varname>NOMAN=YES</varname>
either in the environment or in
<filename>/etc/mk.conf</filename>. </para>
</sect1>
<sect1 id="bsd.own.mk-missing">
<title>What does <quote>Could not find bsd.own.mk</quote> mean?</title>
<para> You didn't install the compiler set,
<filename>comp.tgz</filename>, when you installed your NetBSD
machine. Please get it and install it, by extracting it in
<filename>/</filename>: </para>
<screen><prompt>#</prompt> <userinput>cd /</userinput>
<prompt>#</prompt> <userinput>tar --unlink -zxvpf .../comp.tgz</userinput></screen>
<para> <filename>comp.tgz</filename> is part of every NetBSD
release. Get the one that corresponds to your release (determine
via <command>uname -r</command>). </para>
</sect1>
<sect1 id="using-sudo-with-pkgsrc">
<title>Using 'sudo' with pkgsrc</title>
<para>
When installing packages as non-root user and using the
just-in-time &man.su.1; feature of pkgsrc, it can become annoying to
type in the root password for each required package
installed. To avoid this, the sudo package can be used, which
does password caching over a limited time. To use it, install
sudo (either as binary package or from <pkg>security/sudo</pkg>)
and then put the following into your
<filename>/etc/mk.conf</filename>: </para>
<programlisting>
.if exists(${LOCALBASE}/bin/sudo)
SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c
.endif
</programlisting>
</sect1>
<sect1 id="faq.conf">
<title>Configuration files handling and placement</title>
<para> The global variable <varname>PKG_SYSCONFBASE</varname>
(and some others) can be set by the system administrator in
<filename>/etc/mk.conf</filename> to define the place where
configuration files get installed. Therefore, packages must be
adapted to support this feature. Keep in mind that you should
only install files that are strictly necessary in the
configuration directory, files that can go to
<filename>$PREFIX/share</filename> should go there. </para>
<para> We will take a look at available variables first
(<filename>bsd.pkg.mk</filename> contains more
information). <varname>PKG_SYSCONFDIR</varname> is where the
configuration files for a package may be found (that is, the
full path, e.g. <filename>/etc</filename> or
<filename>/usr/pkg/etc</filename>). This value may be customized
in various ways: </para>
<orderedlist>
<listitem>
<para> <varname>PKG_SYSCONFBASE</varname> is the main config
directory under which all package configuration files are to
be found. Users will typically want to set it to
<filename>/etc</filename>, or accept the default location of
<filename>$PREFIX/etc</filename>. </para>
</listitem>
<listitem>
<para> <varname>PKG_SYSCONFSUBDIR</varname> is the
subdirectory of <varname>PKG_SYSCONFBASE</varname> under
which the configuration files for a particular package may
be found. Defaults to <varname>${SYSCONFBASE}</varname>.
</para>
</listitem>
<listitem>
<para> <varname>PKG_SYSCONFVAR</varname> is the special
suffix used to distinguish any overriding values for a
particular package (see next item). It defaults to
<varname>${PKGBASE}</varname>, but for a collection of
related packages that should all have the same
<varname>PKG_SYSCONFDIR</varname> value, it can be set in
each of the package Makefiles to a common value.
</para>
</listitem>
<listitem>
<para>
<varname>PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</varname>
overrides the value of
<varname>${PKG_SYSCONFDIR}</varname> for packages with the
same value for <varname>PKG_SYSCONFVAR</varname>.
</para>
<para> As an example, all the various KDE packages may want to
set <varname>PKG_SYSCONFVAR</varname> to <quote>kde</quote>
so admins can set <varname>PKG_SYSCONFDIR.kde</varname> in
<filename>/etc/mk.conf</filename> to define where to install
KDE config files. </para>
</listitem>
</orderedlist>
<para> Programs' configuration directory should be defined during
the configure stage. Packages that use GNU autoconf can
usually do this by using the <quote>--sysconfdir</quote>
parameter, but this brings some problems as we will see now.
When you change this pathname in packages, you should not
allow them to install files in that directory
directly. Instead they need to install those files under
<filename>share/examples/${PKGNAME}</filename> so
<filename>PLIST</filename> can register them. </para>
<para> Once you have the required configuration files in place
(under the <filename>share/examples</filename> directory) the
variable <varname>CONF_FILES</varname> should be set to copy
them into <varname>PKG_SYSCONFDIR</varname>. The contents of
this variable is formed by pairs of filenames; the first element
of the pair specifies the file inside the examples directory
(registered by <filename>PLIST</filename>) and the second
element specifies the target file. This is done this way to
allow binary packages to place files in the right directory
using
<filename>INSTALL</filename>/<filename>DEINSTALL</filename>
scripts which are created automatically. The package
<filename>Makefile</filename> must also set
<varname>USE_PKGINSTALL=YES</varname> to use these automatically
generated scripts. The automatic copying of config files can be
toggled by setting the environment variable
<varname>PKG_CONFIG</varname> prior to package installation.
</para>
<para> Here is an example, taken from mail/mutt/Makefile: </para>
<programlisting> EGDIR= ${PREFIX}/share/doc/mutt/samples
CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc</programlisting>
<para> As you can see, this package installs configuration files
inside <varname>EGDIR</varname>, which are registered by
<filename>PLIST</filename>. After that, the variable
<varname>CONF_FILES</varname> lists the installed file first
and then the target file. Users will also get an automatic
message when files are installed using this method. </para>
</sect1>
<sect1 id="audit-packages">
<title>Automated security checks</title>
<para> Please be aware that there can often be bugs in third-party
software, and some of these bugs can leave a machine vulnerable
to exploitation by attackers. In an effort to lessen the
exposure, the NetBSD packages team maintains a database of
known-exploits to packages which have at one time been included
in pkgsrc. The database can be downloaded automatically, and a
security audit of all packages installed on a system can take
place. To do this, install the
<pkg>security/audit-packages</pkg> package. It has two
components: </para>
<orderedlist>
<listitem>
<para> <quote>download-vulnerability-list</quote>, an easy way
to download a list of the security vulnerabilities
information. This list is kept up to date by the NetBSD
security officer and the NetBSD packages team, and is
distributed from the NetBSD ftp server: </para>
<para> <ulink
url="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities"/>
</para>
</listitem>
<listitem>
<para> <quote>audit-packages</quote>, an easy way to audit the
current machine, checking each vulnerability which is
known. If a vulnerable package is installed, it will
be shown by output to stdout, including a description
of the type of vulnerability, and a URL containing more
information. </para>
</listitem>
</orderedlist>
<para> Use of the <pkg>security/audit-packages</pkg> package is
strongly recommended!
After <quote>audit-packages</quote> is installed, please read
the package's message, which you can get by running
<userinput>pkg_info -D audit-package</userinput>.
</para>
</sect1>
</chapter>
|