external/bsd/pkg_install/dist/lib/pkg_install.conf.5.in

   1 .\"     $NetBSD: pkg_install.conf.5.in,v 1.11 2009/10/15 12:41:41 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 October 15, 2009
  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 The following variables are supported:
  50 .Bl -tag -width indent
  51 .It Dv ACCEPTABLE_LICENSES
  52 List of licenses packages are allowed to carry.
  53 License names are case-sensitive.
  54 .It Dv ACTIVE_FTP
  55 Force the use of active FTP.
  56 .It Dv CACHE_INDEX
  57 Cache directory listenings in memory.
  58 This avoids retransfers of the large directory index for HTTP and is
  59 enabled by default.
  60 .It Dv CERTIFICATE_ANCHOR_PKGS
  61 Path to the file containing the certificates used for validating
  62 binary packages.
  63 A package is trusted when a certificate chain ends in one of the
  64 certificates contained in this file.
  65 The certificates must be PEM-encoded.
  66 .It Dv CERTIFICATE_ANCHOR_PKGVULN
  67 Analogous to
  68 .Dv CERTIFICATE_ANCHOR_PKGS .
  69 The
  70 .Pa pkg-vulnerabilities
  71 is trusted when a certificate chain ends in one of the certificates
  72 contained in this file.
  73 .It Dv CERTIFICATE_CHAIN
  74 Path to a file containing additional certificates that can be used
  75 for completing certificate chains when validating binary packages or
  76 pkg-vulnerabilities files.
  77 .It Dv CHECK_LICENSE
  78 Check the license conditions of packages before installing them.
  79 Supported values are:
  80 .Bl -tag -width interactiveXX
  81 .It Dv no
  82 The check is not performed.
  83 .It Dv yes
  84 The check is performed if the package has license conditions set.
  85 .It Dv always
  86 Passing the license check is required.
  87 Missing license conditions are considered an error.
  88 .El
  89 .It Dv CHECK_VULNERABILITIES
  90 Check for vulnerabilities when installing packages.
  91 Supported values are:
  92 .Bl -tag -width interactiveXX
  93 .It Dv never
  94 No check is performed.
  95 .It Dv always
  96 Passing the vulnerability check is required.
  97 A missing pkg-vulnerabilities file is considered an error.
  98 .It Dv interactive
  99 The user is always asked to confirm installation of vulnerable packages.
 100 .El
 101 .It Dv DEFAULT_ACCEPTABLE_LICENSES
 102 List of common Free and Open Source licenses packages are allowed to carry.
 103 The default value contains all OSI approved licenses in pkgsrc on the date
 104 pkg_install was released.
 105 License names are case-sensitive.
 106 .It Dv GPG
 107 Path to
 108 .Xr gpg 1 ,
 109 which can be used to verify the signature in the
 110 .Pa pkg-vulnerabilities
 111 file when running
 112 .Dl Ic pkg_admin check-pkg-vulnerabilities -s
 113 or
 114 .Dl Ic pkg_admin fetch-pkg-vulnerabilities -s
 115 It can also be used to verify and sign binary packages.
 116 .It Dv GPG_KEYRING_PKGVULN
 117 Non-default keyring to use for verifying GPG signatures of
 118 .Pa pkg-vulnerabilities .
 119 .It Dv GPG_KEYRING_SIGN
 120 Non-default keyring to use for signing packages with GPG.
 121 .It Dv GPG_KEYRING_VERIFY
 122 Non-default keyring to use for verifying GPG signature of packages.
 123 .It Dv GPG_SIGN_AS
 124 User-id to use for signing packages.
 125 .It Dv IGNORE_PROXY
 126 Use direct connections and ignore
 127 .Ev FTP_PROXY
 128 and
 129 .Ev HTTP_PROXY .
 130 .It Dv IGNORE_URL
 131 One line per advisory which should be ignored when running
 132 .Dl Ic pkg_admin audit
 133 The URL from the
 134 .Pa pkg-vulnerabilities
 135 file should be used as value.
 136 .It Dv PKG_PATH
 137 Search path as used by
 138 .Nm pkg_add .
 139 Overridden by the environment variable
 140 .Ev PKG_PATH .
 141 .It Dv PKGVULNDIR
 142 Directory name in which the
 143 .Pa pkg-vulnerabilities
 144 file resides.
 145 Default is
 146 .Pa ${PKG_DBDIR} .
 147 .It Dv PKGVULNURL
 148 URL which is used for updating the local
 149 .Pa pkg-vulnerabilities
 150 file when running
 151 .Dl Ic pkg_admin fetch-pkg-vulnerabilities
 152 The default is
 153 .Pa http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities.gz
 154 .Em Note :
 155 Usually, only the compression type should be changed.
 156 Currently supported are uncompressed files and files compressed by
 157 .Xr bzip2 1
 158 .Pq Pa .bz2
 159 or
 160 .Xr gzip 1
 161 .Pq Pa .gz .
 162 .It Dv VERBOSE_NETIO
 163 Log details of network IO to stderr.
 164 .It Dv VERIFIED_INSTALLATION
 165 Set trust level used when installation.
 166 Supported values are:
 167 .Bl -tag -width interactiveXX
 168 .It Dv never
 169 No signature checks are performed.
 170 .It Dv always
 171 A valid signature is required.
 172 If the binary package can not be verified, the installation is terminated
 173 .It Dv trusted
 174 A valid signature is required.
 175 If the binary package can not be verified, the user is asked interactively.
 176 .It Dv interactive
 177 The user is always asked interactively when installing a package.
 178 .El
 179 .El
 180 .Sh FILES
 181 .Bl -tag -width ".Pa @SYSCONFDIR@/pkg_install.conf"
 182 .It Pa @SYSCONFDIR@/pkg_install.conf
 183 Default location for the file described in this manual page.
 184 .El
 185 .Sh SEE ALSO
 186 .Xr pkg_add 1 ,
 187 .Xr pkg_admin 1