Radish alpha
H
HardenedBSD-pkg
rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9
HardenedBSD Package Manager
Radicle
Git
Commits › 0a5e13d
Sync pkg.conf.5 with the list of config variables in pkg_config.c
Matthew Seaman committed 12 years ago
commit 0a5e13da83da44bd0a00f1bfb5f5a373e2c7f19e
parent ab7b488
2 files changed +182 -104
modified docs/pkg.conf.5
@@ -15,7 +15,7 @@
.\"     @(#)pkg.1

.\" $FreeBSD$

.\"
- 
.Dd December 15, 2013
+ 
.Dd April 18, 2014

.Dt PKG.CONF 5

.Os

.Sh NAME
@@ -49,7 +49,29 @@ and
.Sh OPTIONS

The following options can be defined in

.Nm :
- 
.Bl -tag -width ".Cm ASSUME_ALWAYS_YES(boolean)"
+ 
.Bl -tag -width ".Cm ABI: string"
+ 
.It Cm ABI: string
+ 
the abi of the package you want to install.
+ 
Default: derived from the ABI of the /bin/sh binary.
+ 
.It Cm ALIAS: key/value list
+ 
Define local aliases for various
+ 
.Xr pkg 8
+ 
standard command lines.
+ 
Whenever the
+ 
.Em key
+ 
text occurs as a separate
+ 
.Sq action
+ 
word in a command line of the form
+ 
.Nm pkg Em key ... ,
+ 
substitute the
+ 
.Em value
+ 
text verbatim.
+ 
The replacement can consist of any sequence of text, which should form
+ 
a syntactically correct
+ 
.Xr pkg 8
+ 
command line when substituted in and followed by any remaining tokens from
+ 
the original command line.
+ 
Default: not set.

.It Cm ASSUME_ALWAYS_YES: boolean

When this option is enabled

.Xr pkg 1
@@ -58,52 +80,25 @@ which require user confirmation before doing anything, as if it
the

.Fl y

flag was specified.
- 
By default this option is disabled.
- 
.It Cm PUBKEY: string
- 
Specifies the location to the public RSA key used for signing the
- 
repository database.
- 
The default value for this file is
- 
.Pa /etc/ssl/pkg.conf
- 
.It Cm HANDLE_RC_SCRIPTS: boolean
- 
This option when enabled
- 
will automatically perform start/stop of services during package
- 
installation and deinstallation.
- 
Services are started on installation only
- 
if they are enabled in
- 
.Pa /etc/rc.conf .
- 
By default this option is disabled.
- 
.It Cm PACKAGESITE: string
- 
Specifies the URL of the remote location to use
- 
when fetching the database file and packages.
- 
This supports using
- 
.Sy ${ABI}
- 
to create a dynamic URL based on the ABI being used. (deprecated)
- 
.It Cm PKG_CACHEDIR: string
- 
Specifies the cache directory for packages.
- 
The default value
- 
for this option is
- 
.Pa /var/cache/pkg
- 
.It Cm PKG_DBDIR: string
- 
Specifies the directory to use for storing the package
- 
database files.
- 
The default value for this option is
- 
.Pa /var/db/pkg
- 
.It Cm PLIST_KEYWORDS_DIR: string
- 
< To be added >
- 
.It Cm PORTSDIR: string
- 
Specifies the location to the Ports directory.
- 
The default value
- 
for this option is
- 
.Pa /usr/ports
- 
.It Cm SYSLOG: boolean
- 
This option is enabled by default, log all the
- 
installation/deinstallation/upgrade operation via syslog(3)
+ 
Default: no.

.It Cm AUTODEPS: boolean

Analyse the elf to add dependencies (shared libraries) that may have been

forgotten by the maintainer.
- 
default: off
- 
.It Cm ABI: string
- 
the abi of the package you want to install, by default the /bin/sh abi is used
+ 
Default: off
+ 
.It Cm CUDF_SOLVER: string
+ 
Experimental: tells pkg to use an external CUDF solver.
+ 
Default: not set.
+ 
.It Cm DEBUG_LEVEL: integer
+ 
Incremental values from 1 to 4 produce successively more verbose
+ 
debugging output.
+ 
A setting of 0 disables debugging output.
+ 
Overridden by the
+ 
.Fl d
+ 
command line option.
+ 
Default: 0.
+ 
.It Cm DEBUG_SCRIPTS: boolean
+ 
Activate debug mode for scripts (aka set -x)
+ 
Default: no.

.It Cm DEVELOPER_MODE: boolean

Makes certain errors immediately fatal.

Adds various warnings and
@@ -111,47 +106,7 @@ suggestions to the output of
.Xr pkg 1

as an aide to port maintainers, including indicating when the port

might be marked as architecture independent.
- 
default: off
- 
.It Cm PERMISSIVE: boolean
- 
Ignore conflicts while registering a package, note that the files conflicting
- 
will not be marked as owned by the new package. (default: NO)
- 
.It Cm PORTAUDIT_SITE: string
- 
Specifies the remote location to use
- 
when fetching the portaudit database.
- 
See
- 
.Xr pkg-audit 8
- 
for more information.
- 
.It Cm DEBUG_SCRIPTS: boolean
- 
Activate debug mode for scripts (aka set -x)
- 
.It Cm REPO_AUTOUPDATE: boolean
- 
When true, automatically check for and download updates to
- 
.Pa /var/db/pkg/repo.sqlite
- 
when running one of:
- 
.Nm pkg upgrade ,
- 
.Nm pkg fetch ,
- 
.Nm pkg install
- 
or
- 
.Nm pkg version -R .
- 
(default: YES)
- 
.It Cm PKG_ENV: Key/Value list
- 
This tells
- 
.Xr pkg 8
- 
to set key/values passed in the environment.
- 
Therefore underlying libraries
- 
like
- 
.Xr fetch 3
- 
can be configured (e.g., setting
- 
.Ev FTP_PROXY
- 
and
- 
.Ev HTTP_PROXY ) .
- 
(default: empty)
- 
.It Cm NAMESERVER: string
- 
Bypass name resolution forcing a nameserver
- 
.It Cm EVENT_PIPE: string
- 
Send all events to the specified fifo or Unix socket, events will be formatted
- 
in JSON.
- 
.It Cm SSH_RESTRICT_DIR: string
- 
Directory where the ssh subsystem will be restricted to
+ 
Default: no.

.It Cm DISABLE_MTREE: boolean

For experimental purposes only.

Not for use on production systems.
@@ -170,24 +125,147 @@ data.
This option exists to facilitate developing

.Cm +MTREE

free package sets.
- 
.It Cm ALIAS: key/value list
- 
Define local aliases for various
+ 
Default: no.
+ 
.It Cm EVENT_PIPE: string
+ 
Send all event messages to the specified fifo or Unix socket.
+ 
Events messages should be formatted as JSON.
+ 
Default: not set.
+ 
.It Cm FETCH_RETRY: integer
+ 
Number of times to retry a failed fetch of a file.
+ 
Default: 3.
+ 
.It Cm FETCH_TIMEOUT: integer
+ 
Maximum number of seconds to wait for any one file to download from the
+ 
network, either by SSH or any of the protocols supported by
+ 
.Xr fetch 3
+ 
functions.
+ 
Default: 30.
+ 
.It Cm HANDLE_RC_SCRIPTS: boolean
+ 
When enabled, this option will automatically perform start/stop of
+ 
services during package installation and deinstallation.
+ 
Services are only started on installation if they are enabled in
+ 
.Pa /etc/rc.conf .
+ 
Default: no.
+ 
.It Cm INDEXDIR: string
+ 
If set, the directory to search for
+ 
.Cm INDEXFILE
+ 
in.
+ 
If unset,
+ 
.Cm PORTSDIR
+ 
will be searched instead.
+ 
Default: not set.
+ 
.It Cm INDEXFILE: string
+ 
The filename of the ports index, searched for in
+ 
.Cm INDEXFILE
+ 
or
+ 
.Cm PORTSDIR .
+ 
Default: INDEX-N where
+ 
.Cm N
+ 
is the OS major version number.
+ 
.It Cm NAMESERVER: string
+ 
Hostname or IPv4 or IPv6 address of nameserver to use for DNS
+ 
resolution, overriding the system defaults in
+ 
.Pa /etc/resolv.conf .
+ 
When given as a hostname, will be converted to a list of IPv4 or IPv6
+ 
addresses by the default mechanisms configured on the system. See
+ 
.Xr getaddrinfo 3 .
+ 
.It Cm PERMISSIVE: boolean
+ 
Ignore conflicts while registering a package. Note that the
+ 
conflicting files will not be recorded as owned by the new package.
+ 
Default: no.
+ 
.It Cm PKG_CACHEDIR: string
+ 
Specifies the cache directory for packages.
+ 
Default:
+ 
.Pa /var/cache/pkg
+ 
.It Cm PKG_DBDIR: string
+ 
Specifies the directory to use for storing the package
+ 
database files.
+ 
Default:
+ 
.Pa /var/db/pkg
+ 
.It Cm PKG_ENABLE_PLUGINS: boolean
+ 
When set to
+ 
.Dq yes ,
+ 
activate plugin support.
+ 
Default: yes.
+ 
.It Cm PKG_ENV: Key/Value list
+ 
This tells

.Xr pkg 8
- 
standard command lines.
- 
Whenever the
- 
.Em key
- 
text occurs as a separate
- 
.Sq action
- 
word in a command line of the form
- 
.Nm pkg Em key ... ,
- 
substitute the
- 
.Em value
- 
text verbatim.
- 
The replacement can consist of any sequence of text, which should form
- 
a syntactically correct
+ 
to set key/values to be passed in the environment.
+ 
This allows control over underlying libraries like
+ 
.Xr fetch 3 ,
+ 
which can be configured by e.g., setting
+ 
.Ev FTP_PROXY
+ 
and
+ 
.Ev HTTP_PROXY .
+ 
Default: not set.
+ 
.It Cm PKG_PLUGINS_DIR: string
+ 
Directory which

.Xr pkg 8
- 
command line when substituted in and followed by any remaining tokens from
- 
the original command line.
+ 
will load plugins from.
+ 
Default:
+ 
.Pa /usr/local/lib/pkg
+ 
.It Cm PKG_SSH_ARGS: string
+ 
Extra arguments to pass to
+ 
.Xr ssh 1 .
+ 
Default: not set.
+ 
.It Cm PLIST_KEYWORDS_DIR: string
+ 
Directory containing definitions of plist keywords.
+ 
Default: not set.
+ 
.It Cm PLUGINS: array
+ 
List of plugins that
+ 
.Xr pkg 8
+ 
should load.
+ 
Default: not set.
+ 
.It Cm PLUGINS_CONF_DIR: string
+ 
Directory containing per-plugin configuration files.
+ 
Default:
+ 
.Pa /usr/local/etc/pkg
+ 
.It Cm PORTSDIR: string
+ 
Specifies the location to the Ports directory.
+ 
Default:
+ 
.Pa /usr/ports
+ 
.It Cm REPOS_DIR: array
+ 
List of directories to search for repository configuration files.
+ 
Default:
+ 
.Pa /etc/pkg/ ,
+ 
.Pa /usr/local/etc/pkg/repos/ .
+ 
.It Cm REPO_AUTOUPDATE: boolean
+ 
When true, automatically check for and download updates to
+ 
.Pa /var/db/pkg/repo.sqlite
+ 
when running one of:
+ 
.Nm pkg fetch ,
+ 
.Nm pkg install ,
+ 
.Nm pkg rquery ,
+ 
.Nm pkg search ,
+ 
.Nm pkg upgrade ,
+ 
or
+ 
.Nm pkg version -R .
+ 
Ddefault: yes.
+ 
.It Cm RUN_SCRIPTS: boolean
+ 
Run pre-/post-installation action scripts.
+ 
Default: yes.
+ 
.It Cm SAT_SOLVER: string
+ 
Expirmental: tels pkg to use and external SAT solver.
+ 
Default: not set.
+ 
.It Cm SSH_RESTRICT_DIR: string
+ 
Directory which the ssh subsystem will be restricted to.
+ 
Default: not set.
+ 
.It Cm SYSLOG: boolean
+ 
Log all the installation/deinstallation/upgrade operation via
+ 
.Xr syslog 3 .
+ 
Default: yes.
+ 
.It Cm UNSET_TIMESTAMP: boolean
+ 
Do not include timestamps in the package
+ 
.Xr tar 1
+ 
archive.
+ 
Normally, timestamps are copied from the staging directory the
+ 
package is created from.
+ 
Default: no.
+ 
.It Cm VULNXML_SITE: string
+ 
Specifies the URL to fetch the
+ 
.Pa vuln.xml
+ 
vulnerability database from.
+ 
Default:
+ 
.Pa http://www.vuxml.org/freebsd/vuln.xml.bz2 .

.El

.Sh MULTIPLE REPOSITORIES

To use multiple repositories, specify the primary repository as shown above.
modified libpkg/pkg_config.c
@@ -226,13 +226,13 @@ static struct config_entry c[] = {
		PKG_INT,

		"FETCH_TIMEOUT",

		"30",
- 
		NULL,
+ 
		"Number of seconds before fetch(3) times out",

	},

	{

		PKG_BOOL,

		"UNSET_TIMESTAMP",

		"NO",
- 
		NULL,
+ 
		"Do not include timestamps in the package",

	},

	{

		PKG_STRING,