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

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