xref: /freebsd/usr.sbin/pkg/pkg.7 (revision e771d590741ea39be83558bda72854c65e1084ae)
15eb90b9aSBryan Drewery.\" Copyright (c) 2013 Bryan Drewery <bdrewery@FreeBSD.org>
25eb90b9aSBryan Drewery.\" All rights reserved.
35eb90b9aSBryan Drewery.\"
45eb90b9aSBryan Drewery.\" Redistribution and use in source and binary forms, with or without
55eb90b9aSBryan Drewery.\" modification, are permitted provided that the following conditions
65eb90b9aSBryan Drewery.\" are met:
75eb90b9aSBryan Drewery.\" 1. Redistributions of source code must retain the above copyright
85eb90b9aSBryan Drewery.\"    notice, this list of conditions and the following disclaimer.
95eb90b9aSBryan Drewery.\" 2. Redistributions in binary form must reproduce the above copyright
105eb90b9aSBryan Drewery.\"    notice, this list of conditions and the following disclaimer in the
115eb90b9aSBryan Drewery.\"    documentation and/or other materials provided with the distribution.
125eb90b9aSBryan Drewery.\"
135eb90b9aSBryan Drewery.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
145eb90b9aSBryan Drewery.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
155eb90b9aSBryan Drewery.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
165eb90b9aSBryan Drewery.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
175eb90b9aSBryan Drewery.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
185eb90b9aSBryan Drewery.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
195eb90b9aSBryan Drewery.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
205eb90b9aSBryan Drewery.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
215eb90b9aSBryan Drewery.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
225eb90b9aSBryan Drewery.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
235eb90b9aSBryan Drewery.\" SUCH DAMAGE.
245eb90b9aSBryan Drewery.\"
255eb90b9aSBryan Drewery.\" $FreeBSD$
265eb90b9aSBryan Drewery.\"
27*e771d590SJohn-Mark Gurney.Dd November 6, 2020
285eb90b9aSBryan Drewery.Dt PKG 7
295eb90b9aSBryan Drewery.Os
305eb90b9aSBryan Drewery.Sh NAME
315eb90b9aSBryan Drewery.Nm pkg
3276609326SJoel Dahl.Nd a utility for manipulating packages
335eb90b9aSBryan Drewery.Sh SYNOPSIS
345eb90b9aSBryan Drewery.Nm
355eb90b9aSBryan Drewery.Ao Ar command Ac
365eb90b9aSBryan Drewery.Nm
375eb90b9aSBryan Dreweryadd
385212e8baSBryan Drewery.Op Fl f
395eb90b9aSBryan Drewery.Ao Pa pkg.txz Ac
405eb90b9aSBryan Drewery.Nm
415eb90b9aSBryan Drewery.Fl N
425eb90b9aSBryan Drewery.Nm
435eb90b9aSBryan Drewerybootstrap
445212e8baSBryan Drewery.Op Fl f
455eb90b9aSBryan Drewery.Sh DESCRIPTION
465eb90b9aSBryan Drewery.Nm
475eb90b9aSBryan Dreweryis the package management tool.
485eb90b9aSBryan DreweryIt is used to manage local packages installed from
495eb90b9aSBryan Drewery.Xr ports 7
505eb90b9aSBryan Dreweryand install/upgrade packages from remote repositories.
515eb90b9aSBryan Drewery.Pp
525eb90b9aSBryan DreweryTo avoid backwards incompatibility issues, the actual
535eb90b9aSBryan Drewery.Xr pkg 8
545eb90b9aSBryan Drewerytool is not installed in the base system.
555eb90b9aSBryan DreweryThe first time invoked,
565eb90b9aSBryan Drewery.Nm
575eb90b9aSBryan Drewerywill bootstrap the real
585eb90b9aSBryan Drewery.Xr pkg 8
595eb90b9aSBryan Dreweryfrom a remote repository.
605212e8baSBryan Drewery.Bl -tag -width "pkg bootstrap"
615eb90b9aSBryan Drewery.It Nm Ao Ar command Ac
625eb90b9aSBryan DreweryIf
635eb90b9aSBryan Drewery.Xr pkg 8
645eb90b9aSBryan Dreweryis not installed yet, it will be fetched, have its signature verified,
655eb90b9aSBryan Dreweryinstalled, and then have the original command forwarded to it.
665eb90b9aSBryan DreweryIf already installed, the command requested will be forwarded to the real
675eb90b9aSBryan Drewery.Xr pkg 8 .
685212e8baSBryan Drewery.It Nm Li add Oo Fl f Oc Ao Pa pkg.txz Ac
695eb90b9aSBryan DreweryInstall
705eb90b9aSBryan Drewery.Xr pkg 8
715eb90b9aSBryan Dreweryfrom a local package instead of fetching from remote.
72*e771d590SJohn-Mark GurneyIf signature checking is enabled, then the correct signature file
73*e771d590SJohn-Mark Gurneymust exist and the signature valid before the package will be installed.
745212e8baSBryan DreweryIf the
755212e8baSBryan Drewery.Fl f
765212e8baSBryan Dreweryflag is specified, then
775212e8baSBryan Drewery.Xr pkg 8
785212e8baSBryan Drewerywill be installed regardless if it is already installed.
795eb90b9aSBryan Drewery.It Nm Fl N
805eb90b9aSBryan DreweryDo not bootstrap, just determine if
815eb90b9aSBryan Drewery.Xr pkg 8
825eb90b9aSBryan Dreweryis actually installed or not.
835eb90b9aSBryan DreweryReturns 0 and the number of packages installed
845eb90b9aSBryan Dreweryif it is, otherwise 1.
855212e8baSBryan Drewery.It Nm Li bootstrap Op Fl f
865eb90b9aSBryan DreweryAttempt to bootstrap and do not forward anything to
875eb90b9aSBryan Drewery.Xr pkg 8
885eb90b9aSBryan Dreweryafter it is installed.
895212e8baSBryan DreweryIf the
905212e8baSBryan Drewery.Fl f
915212e8baSBryan Dreweryflag is specified, then
925212e8baSBryan Drewery.Xr pkg 8
935212e8baSBryan Drewerywill be fetched and installed regardless if it is already installed.
945eb90b9aSBryan Drewery.El
955eb90b9aSBryan Drewery.Sh CONFIGURATION
965eb90b9aSBryan DreweryConfiguration varies in whether it is in a repository configuration file
975eb90b9aSBryan Dreweryor the global configuration file.
985eb90b9aSBryan Drewery.Pp
995eb90b9aSBryan DreweryRepository configuration can be stored in
1005eb90b9aSBryan Drewery.Pa /etc/pkg/FreeBSD.conf
1015eb90b9aSBryan Dreweryin the following format:
1025eb90b9aSBryan Drewery.Bd -literal -offset indent
1035eb90b9aSBryan DreweryFreeBSD: {
1045eb90b9aSBryan Drewery  url: "pkg+http://pkg.FreeBSD.org/${ABI}/latest",
1055eb90b9aSBryan Drewery  mirror_type: "srv",
1065eb90b9aSBryan Drewery  signature_type: "none",
1075eb90b9aSBryan Drewery  fingerprints: "/usr/share/keys/pkg",
108d6ea2739SBryan Drewery  enabled: yes
1095eb90b9aSBryan Drewery}
1105eb90b9aSBryan Drewery.Ed
1115eb90b9aSBryan Drewery.Bl -tag -width signature_type -compact
1125eb90b9aSBryan Drewery.It url
1135eb90b9aSBryan DreweryRefer to
1145eb90b9aSBryan Drewery.Dv PACKAGESITE
1155eb90b9aSBryan Dreweryin
1165eb90b9aSBryan Drewery.Sx ENVIRONMENT
1175eb90b9aSBryan Drewery.It mirror_type
1185eb90b9aSBryan DreweryRefer to
1195eb90b9aSBryan Drewery.Dv MIRROR_TYPE
1205eb90b9aSBryan Dreweryin
1215eb90b9aSBryan Drewery.Sx ENVIRONMENT
1225eb90b9aSBryan Drewery.It signature_type
1235eb90b9aSBryan DreweryRefer to
1245eb90b9aSBryan Drewery.Dv SIGNATURE_TYPE
1255eb90b9aSBryan Dreweryin
1265eb90b9aSBryan Drewery.Sx ENVIRONMENT
1275eb90b9aSBryan Drewery.It fingerprints
1285eb90b9aSBryan DreweryRefer to
1295eb90b9aSBryan Drewery.Dv FINGERPRINTS
1305eb90b9aSBryan Dreweryin
1315eb90b9aSBryan Drewery.Sx ENVIRONMENT
1325eb90b9aSBryan Drewery.It enabled
1335eb90b9aSBryan DreweryDefines whether this repository should be used or not.
1345eb90b9aSBryan DreweryValid values are
1355eb90b9aSBryan Drewery.Dv yes ,
1365eb90b9aSBryan Drewery.Dv true ,
1375eb90b9aSBryan Drewery.Dv 1 ,
1385eb90b9aSBryan Drewery.Dv no ,
1395eb90b9aSBryan Drewery.Dv false ,
1405eb90b9aSBryan Drewery.Dv 0 .
1415eb90b9aSBryan Drewery.El
1425eb90b9aSBryan Drewery.Pp
1435eb90b9aSBryan DreweryGlobal configuration can be stored in
1445eb90b9aSBryan Drewery.Pa /usr/local/etc/pkg.conf
1455eb90b9aSBryan Dreweryin the following format:
1465eb90b9aSBryan Drewery.Bd -literal -offset indent
147cecc0167SBryan DreweryPACKAGESITE: "pkg+http://pkg.FreeBSD.org/${ABI}/latest",
1485eb90b9aSBryan DreweryMIRROR_TYPE: "srv",
1495eb90b9aSBryan DrewerySIGNATURE_TYPE: "none",
1505eb90b9aSBryan DreweryFINGERPRINTS: "/usr/share/keys/pkg",
1515eb90b9aSBryan DreweryASSUME_ALWAYS_YES: "yes"
152eb31a574SBryan DreweryREPOS_DIR: ["/etc/pkg", "/usr/local/etc/pkg/repos"]
1535eb90b9aSBryan Drewery.Ed
15476609326SJoel Dahl.Pp
1555eb90b9aSBryan DreweryReference
1565eb90b9aSBryan Drewery.Sx ENVIRONMENT
1575eb90b9aSBryan Dreweryfor each variable.
1585eb90b9aSBryan Drewery.Sh ENVIRONMENT
1595eb90b9aSBryan DreweryThe following environment variables can be set to override the settings
1605eb90b9aSBryan Dreweryfrom the
1615eb90b9aSBryan Drewery.Pa pkg.conf
1625eb90b9aSBryan Dreweryfile used.
1635eb90b9aSBryan Drewery.Bl -tag -width "ASSUME_ALWAYS_YES"
1645eb90b9aSBryan Drewery.It Ev MIRROR_TYPE
1655eb90b9aSBryan DreweryThis defines which mirror type should be used.
1665eb90b9aSBryan DreweryValid values are
1675eb90b9aSBryan Drewery.Dv SRV ,
1685eb90b9aSBryan Drewery.Dv HTTP ,
1695eb90b9aSBryan Drewery.Dv NONE .
1705eb90b9aSBryan Drewery.It Ev ABI
1715eb90b9aSBryan DreweryThis defines the ABI for the package to be installed.
1725eb90b9aSBryan DreweryDefault ABI is determined from
1735eb90b9aSBryan Drewery.Pa /bin/sh .
1745eb90b9aSBryan Drewery.It Ev ASSUME_ALWAYS_YES
1755eb90b9aSBryan DreweryIf set, no confirmation will be asked when bootstrapping
1765eb90b9aSBryan Drewery.Xr pkg 8 .
1775eb90b9aSBryan Drewery.It Ev SIGNATURE_TYPE
1785eb90b9aSBryan DreweryIf set to
1795eb90b9aSBryan Drewery.Dv FINGERPRINTS
1805eb90b9aSBryan Drewerythen a signature will be required and validated against known
1815eb90b9aSBryan Drewerycertificate fingerprints when bootstrapping
1825eb90b9aSBryan Drewery.Xr pkg 8 .
1835eb90b9aSBryan Drewery.It Ev FINGERPRINTS
1845eb90b9aSBryan DreweryIf
1855eb90b9aSBryan Drewery.Sy SIGNATURE_TYPE
1865eb90b9aSBryan Dreweryis set to
1875eb90b9aSBryan Drewery.Dv FINGERPRINTS
1885eb90b9aSBryan Drewerythis value should be set to the directory path where known fingerprints are
1895eb90b9aSBryan Drewerylocated.
1905eb90b9aSBryan Drewery.It Ev PACKAGESITE
1915eb90b9aSBryan DreweryThe URL that
1925eb90b9aSBryan Drewery.Xr pkg 8
1935eb90b9aSBryan Dreweryand other packages
1945eb90b9aSBryan Drewerywill be fetched from.
195eb31a574SBryan Drewery.It Ev REPOS_DIR
196eb31a574SBryan DreweryComma-separated list of directories that should be searched for repository
197eb31a574SBryan Dreweryconfiguration files.
1985eb90b9aSBryan Drewery.El
1995eb90b9aSBryan Drewery.Sh FILES
2005eb90b9aSBryan DreweryConfiguration is read from the files in the listed order.
201eb31a574SBryan DreweryThis path can be changed by setting
202eb31a574SBryan Drewery.Sy REPOS_DIR .
203eb31a574SBryan DreweryThe last enabled repository is the one used for bootstrapping
2045eb90b9aSBryan Drewery.Xr pkg 8 .
2055eb90b9aSBryan Drewery.Bl -tag -width "/usr/local/etc/pkg/repos/*.conf"
2065eb90b9aSBryan Drewery.It Pa /usr/local/etc/pkg.conf
2075eb90b9aSBryan Drewery.It Pa /etc/pkg/FreeBSD.conf
208eb31a574SBryan Drewery.It Pa /usr/local/etc/pkg/repos/*.conf
2095eb90b9aSBryan Drewery.El
2105eb90b9aSBryan Drewery.Sh EXAMPLES
2115eb90b9aSBryan DrewerySome examples are listed here.
2125eb90b9aSBryan DreweryThe full list of available commands are available in
2135eb90b9aSBryan Drewery.Xr pkg 8
2145eb90b9aSBryan Dreweryonce it is bootstrapped.
2155eb90b9aSBryan Drewery.Pp
2165eb90b9aSBryan DrewerySearch for a package:
2175eb90b9aSBryan Drewery.Dl $ pkg search perl
2185eb90b9aSBryan Drewery.Pp
2195eb90b9aSBryan DreweryInstall a package:
2205eb90b9aSBryan Drewery.Dl % pkg install perl
2215eb90b9aSBryan Drewery.Pp
2225eb90b9aSBryan DreweryList installed packages:
2235eb90b9aSBryan Drewery.Dl $ pkg info
2245eb90b9aSBryan Drewery.Pp
2255eb90b9aSBryan DreweryUpgrade from remote repository:
2265eb90b9aSBryan Drewery.Dl % pkg upgrade
2275eb90b9aSBryan Drewery.Pp
2285eb90b9aSBryan DreweryList non-automatic packages:
2295eb90b9aSBryan Drewery.Dl $ pkg query -e '%a = 0' %o
2305eb90b9aSBryan Drewery.Pp
2315eb90b9aSBryan DreweryList automatic packages:
2325eb90b9aSBryan Drewery.Dl $ pkg query -e '%a = 1' %o
2335eb90b9aSBryan Drewery.Pp
2345eb90b9aSBryan DreweryDelete an installed package:
2355eb90b9aSBryan Drewery.Dl % pkg delete perl
2365eb90b9aSBryan Drewery.Pp
2375eb90b9aSBryan DreweryRemove unneeded dependencies:
2385eb90b9aSBryan Drewery.Dl % pkg autoremove
2395eb90b9aSBryan Drewery.Pp
2405eb90b9aSBryan DreweryChange a package from automatic to non-automatic, which will prevent
2415eb90b9aSBryan Drewery.Ic autoremove
2425eb90b9aSBryan Dreweryfrom removing it:
2435eb90b9aSBryan Drewery.Dl % pkg set -A 0 perl
2445eb90b9aSBryan Drewery.Pp
2455eb90b9aSBryan DreweryChange a package from non-automatic to automatic, which will make
2465eb90b9aSBryan Drewery.Ic autoremove
2475eb90b9aSBryan Dreweryallow it be removed once nothing depends on it:
2485eb90b9aSBryan Drewery.Dl % pkg set -A 1 perl
2495eb90b9aSBryan Drewery.Pp
2505eb90b9aSBryan DreweryCreate package file from an installed package:
2515eb90b9aSBryan Drewery.Dl % pkg create -o /usr/ports/packages/All perl
2525eb90b9aSBryan Drewery.Pp
2535eb90b9aSBryan DreweryDetermine which package installed a file:
2545eb90b9aSBryan Drewery.Dl $ pkg which /usr/local/bin/perl
2555eb90b9aSBryan Drewery.Pp
2565eb90b9aSBryan DreweryAudit installed packages for security advisories:
2575eb90b9aSBryan Drewery.Dl $ pkg audit
2585eb90b9aSBryan Drewery.Pp
2595eb90b9aSBryan DreweryCheck installed packages for checksum mismatches:
2605eb90b9aSBryan Drewery.Dl # pkg check -s -a
2615eb90b9aSBryan Drewery.Pp
2625eb90b9aSBryan DreweryCheck for missing dependencies:
2635eb90b9aSBryan Drewery.Dl # pkg check -d -a
2645eb90b9aSBryan Drewery.Sh SEE ALSO
26576609326SJoel Dahl.Xr ports 7 ,
26676609326SJoel Dahl.Xr pkg 8
2675eb90b9aSBryan Drewery.Sh HISTORY
2685eb90b9aSBryan DreweryThe
2695eb90b9aSBryan Drewery.Nm
2705eb90b9aSBryan Drewerycommand first appeared in
2715eb90b9aSBryan Drewery.Fx 9.1 .
2725eb90b9aSBryan DreweryIt became the default package tool in
2735eb90b9aSBryan Drewery.Fx 10.0 ,
2745eb90b9aSBryan Dreweryreplacing the
2755eb90b9aSBryan Drewerypkg_install suite of tools
2765eb90b9aSBryan Drewery.Xr pkg_add 1 ,
2775eb90b9aSBryan Drewery.Xr pkg_info 1 and
2785eb90b9aSBryan Drewery.Xr pkg_create 1 .
279