| blob | 5cc6b5719d413142a89075d0e9821e64cf670a8e |
1 .\" $NetBSD: pkg_install.conf.5.in,v 1.14 2010/06/16 23:02:49 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
37 The file
38 .Nm
39 contains system defaults for the package installation tools
40 as a list of variable-value pairs.
41 Each line has the format
42 .Ev VARIABLE=VALUE .
43 If the value consists of more than one line, each line is prefixed with
44 .Ev VARIABLE= .
45 .Pp
46 The current value of a variable can be checked by running
47 .Dl Ic pkg_admin config-var VARIABLE
48 .Pp
49 Some variables are overriden by environmental variables of the same name.
50 Those are marked by (*).
51 .Pp
52 The following variables are supported:
53 .Bl -tag -width indent
54 .It Dv ACCEPTABLE_LICENSES
55 List of licenses packages are allowed to carry.
56 License names are case-sensitive.
57 .It Dv ACTIVE_FTP
58 Force the use of active FTP.
59 .It Dv CACHE_INDEX
60 Cache directory listenings in memory.
61 This avoids retransfers of the large directory index for HTTP and is
62 enabled by default.
63 .It Dv CERTIFICATE_ANCHOR_PKGS
64 Path to the file containing the certificates used for validating
65 binary packages.
66 A package is trusted when a certificate chain ends in one of the
67 certificates contained in this file.
68 The certificates must be PEM-encoded.
69 .It Dv CERTIFICATE_ANCHOR_PKGVULN
70 Analogous to
71 .Dv CERTIFICATE_ANCHOR_PKGS .
72 The
73 .Pa pkg-vulnerabilities
74 is trusted when a certificate chain ends in one of the certificates
75 contained in this file.
76 .It Dv CERTIFICATE_CHAIN
77 Path to a file containing additional certificates that can be used
78 for completing certificate chains when validating binary packages or
79 pkg-vulnerabilities files.
80 .It Dv CHECK_LICENSE
81 Check the license conditions of packages before installing them.
82 Supported values are:
83 .Bl -tag -width interactiveXX
84 .It Dv no
85 The check is not performed.
86 .It Dv yes
87 The check is performed if the package has license conditions set.
88 .It Dv always
89 Passing the license check is required.
90 Missing license conditions are considered an error.
91 .El
92 .It Dv CHECK_END_OF_FILE
93 During vulnerability checks, consider packages that have reached end-of-life
94 as vulnerable.
95 This option is enabled by default.
96 .It Dv CHECK_VULNERABILITIES
97 Check for vulnerabilities when installing packages.
98 Supported values are:
99 .Bl -tag -width interactiveXX
100 .It Dv never
101 No check is performed.
102 .It Dv always
103 Passing the vulnerability check is required.
104 A missing pkg-vulnerabilities file is considered an error.
105 .It Dv interactive
106 The user is always asked to confirm installation of vulnerable packages.
107 .El
108 .It Dv CONFIG_CACHE_CONNECTIONS
109 Limit the global connection cache to this value.
110 For FTP this is the number of sessions without active command.
111 For HTTP this is the number of connections open with keep-alive.
112 .It Dv CONFIG_CACHE_CONNECTIONS_HOST
113 Like
114 .Dv CONFIG_CACHE_CONNECTIONS ,
115 but limit the number of connections to the host as well.
116 See
117 .Xr fetch 3
118 for further details
119 .It Dv DEFAULT_ACCEPTABLE_LICENSES
120 List of common Free and Open Source licenses packages are allowed to carry.
121 The default value contains all OSI approved licenses in pkgsrc on the date
122 pkg_install was released.
123 License names are case-sensitive.
124 .It Dv GPG
125 Path to
126 .Xr gpg 1 ,
127 which can be used to verify the signature in the
128 .Pa pkg-vulnerabilities
129 file when running
130 .Dl Ic pkg_admin check-pkg-vulnerabilities -s
131 or
132 .Dl Ic pkg_admin fetch-pkg-vulnerabilities -s
133 It can also be used to verify and sign binary packages.
134 .It Dv GPG_KEYRING_PKGVULN
135 Non-default keyring to use for verifying GPG signatures of
136 .Pa pkg-vulnerabilities .
137 .It Dv GPG_KEYRING_SIGN
138 Non-default keyring to use for signing packages with GPG.
139 .It Dv GPG_KEYRING_VERIFY
140 Non-default keyring to use for verifying GPG signature of packages.
141 .It Dv GPG_SIGN_AS
142 User-id to use for signing packages.
143 .It Dv IGNORE_PROXY
144 Use direct connections and ignore
145 .Ev FTP_PROXY
146 and
147 .Ev HTTP_PROXY .
148 .It Dv IGNORE_URL
149 One line per advisory which should be ignored when running
150 .Dl Ic pkg_admin audit
151 The URL from the
152 .Pa pkg-vulnerabilities
153 file should be used as value.
154 .It Dv PKG_DBDIR (*)
155 Location of the packages database.
156 This option is always overriden by the argument of the
157 .Fl K
158 option.
159 .It Dv PKG_PATH (*)
160 Search path for packages.
161 The entries are separated by semicolon.
162 Each entry specifies a directory or URL to search for packages.
163 .It Dv PKG_REFCOUNT_DBDIR (*)
164 Location of the package reference counts database directory.
165 The default value is
166 .Pa ${PKG_DBDIR}.refcount .
167 .It Dv PKGVULNDIR
168 Directory name in which the
169 .Pa pkg-vulnerabilities
170 file resides.
171 Default is
172 .Pa ${PKG_DBDIR} .
173 .It Dv PKGVULNURL
174 URL which is used for updating the local
175 .Pa pkg-vulnerabilities
176 file when running
177 .Dl Ic pkg_admin fetch-pkg-vulnerabilities
178 The default location is ftp.NetBSD.org using HTTP.
179 .Em Note :
180 Usually, only the compression type should be changed.
181 Currently supported are uncompressed files and files compressed by
182 .Xr bzip2 1
183 .Pq Pa .bz2
184 or
185 .Xr gzip 1
186 .Pq Pa .gz .
187 .It Dv VERBOSE_NETIO
188 Log details of network IO to stderr.
189 .It Dv VERIFIED_INSTALLATION
190 Set trust level used when installation.
191 Supported values are:
192 .Bl -tag -width interactiveXX
193 .It Dv never
194 No signature checks are performed.
195 .It Dv always
196 A valid signature is required.
197 If the binary package can not be verified, the installation is terminated
198 .It Dv trusted
199 A valid signature is required.
200 If the binary package can not be verified, the user is asked interactively.
201 .It Dv interactive
202 The user is always asked interactively when installing a package.
203 .El
204 .El
205 .Sh FILES
206 .Bl -tag -width ".Pa /etc/pkg_install.conf"
207 .It Pa /etc/pkg_install.conf
208 Default 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