1.\"	$NetBSD: pkg_install.conf.5.in,v 1.1.1.11 2010/06/26 00:14:31 joerg Exp $
2.\"
3.\" Copyright (c) 2008, 2009 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Thomas Klausner.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd June 16, 2010
31.Dt PKG_INSTALL.CONF 5
32.Os
33.Sh NAME
34.Nm pkg_install.conf
35.Nd configuration file for package installation tools
36.Sh DESCRIPTION
37The file
38.Nm
39contains system defaults for the package installation tools
40as a list of variable-value pairs.
41Each line has the format
42.Ev VARIABLE=VALUE .
43If the value consists of more than one line, each line is prefixed with
44.Ev VARIABLE= .
45.Pp
46The current value of a variable can be checked by running
47.Dl Ic pkg_admin config-var VARIABLE
48.Pp
49Some variables are overriden by environmental variables of the same name.
50Those are marked by (*).
51.Pp
52The following variables are supported:
53.Bl -tag -width indent
54.It Dv ACCEPTABLE_LICENSES
55List of licenses packages are allowed to carry.
56License names are case-sensitive.
57.It Dv ACTIVE_FTP
58Force the use of active FTP.
59.It Dv CACHE_INDEX
60Cache directory listenings in memory.
61This avoids retransfers of the large directory index for HTTP and is
62enabled by default.
63.It Dv CERTIFICATE_ANCHOR_PKGS
64Path to the file containing the certificates used for validating
65binary packages.
66A package is trusted when a certificate chain ends in one of the
67certificates contained in this file.
68The certificates must be PEM-encoded.
69.It Dv CERTIFICATE_ANCHOR_PKGVULN
70Analogous to
71.Dv CERTIFICATE_ANCHOR_PKGS .
72The
73.Pa pkg-vulnerabilities
74is trusted when a certificate chain ends in one of the certificates
75contained in this file.
76.It Dv CERTIFICATE_CHAIN
77Path to a file containing additional certificates that can be used
78for completing certificate chains when validating binary packages or
79pkg-vulnerabilities files.
80.It Dv CHECK_LICENSE
81Check the license conditions of packages before installing them.
82Supported values are:
83.Bl -tag -width interactiveXX
84.It Dv no
85The check is not performed.
86.It Dv yes
87The check is performed if the package has license conditions set.
88.It Dv always
89Passing the license check is required.
90Missing license conditions are considered an error.
91.El
92.It Dv CHECK_END_OF_FILE
93During vulnerability checks, consider packages that have reached end-of-life
94as vulnerable.
95This option is enabled by default.
96.It Dv CHECK_VULNERABILITIES
97Check for vulnerabilities when installing packages.
98Supported values are:
99.Bl -tag -width interactiveXX
100.It Dv never
101No check is performed.
102.It Dv always
103Passing the vulnerability check is required.
104A missing pkg-vulnerabilities file is considered an error.
105.It Dv interactive
106The user is always asked to confirm installation of vulnerable packages.
107.El
108.It Dv CONFIG_CACHE_CONNECTIONS
109Limit the global connection cache to this value.
110For FTP this is the number of sessions without active command.
111For HTTP this is the number of connections open with keep-alive.
112.It Dv CONFIG_CACHE_CONNECTIONS_HOST
113Like
114.Dv CONFIG_CACHE_CONNECTIONS ,
115but limit the number of connections to the host as well.
116See
117.Xr fetch 3
118for further details
119.It Dv DEFAULT_ACCEPTABLE_LICENSES
120List of common Free and Open Source licenses packages are allowed to carry.
121The default value contains all OSI approved licenses in pkgsrc on the date
122pkg_install was released.
123License names are case-sensitive.
124.It Dv GPG
125Path to
126.Xr gpg 1 ,
127which can be used to verify the signature in the
128.Pa pkg-vulnerabilities
129file when running
130.Dl Ic pkg_admin check-pkg-vulnerabilities -s
131or
132.Dl Ic pkg_admin fetch-pkg-vulnerabilities -s
133It can also be used to verify and sign binary packages.
134.It Dv GPG_KEYRING_PKGVULN
135Non-default keyring to use for verifying GPG signatures of
136.Pa pkg-vulnerabilities .
137.It Dv GPG_KEYRING_SIGN
138Non-default keyring to use for signing packages with GPG.
139.It Dv GPG_KEYRING_VERIFY
140Non-default keyring to use for verifying GPG signature of packages.
141.It Dv GPG_SIGN_AS
142User-id to use for signing packages.
143.It Dv IGNORE_PROXY
144Use direct connections and ignore
145.Ev FTP_PROXY
146and
147.Ev HTTP_PROXY .
148.It Dv IGNORE_URL
149One line per advisory which should be ignored when running
150.Dl Ic pkg_admin audit
151The URL from the
152.Pa pkg-vulnerabilities
153file should be used as value.
154.It Dv PKG_DBDIR (*)
155Location of the packages database.
156This option is always overriden by the argument of the
157.Fl K
158option.
159.It Dv PKG_PATH (*)
160Search path for packages.
161The entries are separated by semicolon.
162Each entry specifies a directory or URL to search for packages.
163.It Dv PKG_REFCOUNT_DBDIR (*)
164Location of the package reference counts database directory.
165The default value is
166.Pa ${PKG_DBDIR}.refcount .
167.It Dv PKGVULNDIR
168Directory name in which the
169.Pa pkg-vulnerabilities
170file resides.
171Default is
172.Pa ${PKG_DBDIR} .
173.It Dv PKGVULNURL
174URL which is used for updating the local
175.Pa pkg-vulnerabilities
176file when running
177.Dl Ic pkg_admin fetch-pkg-vulnerabilities
178The default location is ftp.NetBSD.org using HTTP.
179.Em Note :
180Usually, only the compression type should be changed.
181Currently supported are uncompressed files and files compressed by
182.Xr bzip2 1
183.Pq Pa .bz2
184or
185.Xr gzip 1
186.Pq Pa .gz .
187.It Dv VERBOSE_NETIO
188Log details of network IO to stderr.
189.It Dv VERIFIED_INSTALLATION
190Set trust level used when installation.
191Supported values are:
192.Bl -tag -width interactiveXX
193.It Dv never
194No signature checks are performed.
195.It Dv always
196A valid signature is required.
197If the binary package can not be verified, the installation is terminated
198.It Dv trusted
199A valid signature is required.
200If the binary package can not be verified, the user is asked interactively.
201.It Dv interactive
202The user is always asked interactively when installing a package.
203.El
204.El
205.Sh FILES
206.Bl -tag -width ".Pa @SYSCONFDIR@/pkg_install.conf"
207.It Pa @SYSCONFDIR@/pkg_install.conf
208Default location for the file described in this manual page.
209.El
210.Sh SEE ALSO
211.Xr pkg_add 1 ,
212.Xr pkg_admin 1
213.Xr pkg_create 1 ,
214.Xr pkg_delete 1 ,
215.Xr pkg_info 1
216