10.7.

2015

pkgutil(1)MacOSXManualPage

This manual page is for MacOSX version 10.9

If you are running a different version of MacOSX, view the documentation locally:
In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a
technology.
To learn how the manual is organized or to learn about command syntax, read the manual
page for manpages(5).
For more information about this technology, look for other documentation in the Apple
Developer Library.
For general information about writing shell scripts, read Shell Scripting Primer.

pkgutil(1)BSDGeneralCommandsManualpkgutil(1)
NAME
pkgutilQueryandmanipulateMacOSXInstallerpackagesandreceipts.
SYNOPSIS
pkgutil[options][commands]
DESCRIPTION
pkgutilreadsandmanipulatesMacOSXInstallerflatpackages,andprovidesaccesstothe``receipt''
databaseusedbytheInstaller.Optionsareprocessedfirst,andaffecttheoperationofallcommands.
Multiplecommandsareperformedsequentiallyinthegivenorder.
Thefilesanddirectorieswherereceiptsarestoredaresubjecttochange.Alwaysusepkgutiltoquery
ormodifythem.
OPTIONS
--help,-hAbriefsummaryofcommandsandusage.
--force,-f
Don'taskforconfirmationbeforeperformingapotentiallydestructiveorambiguousopera
tion.
--verbose,-v
Outputina"humanreadable"formatwithextraheaders,footers,indentation,andother
contextualinformation.
--volumepath
Performalloperationsonthespecifiedvolumeorhomedirectory.Therootvolume'/'will
beusedifunspecified.
--edit-pkgpackageid
Specifiesanexistingreceipttobemodifiedinplaceby--learn.
--only-files
Listonlyfiles(notdirectories)in--fileslisting.
--only-dirs
Listonlydirectories(notfiles)in--fileslisting.
--regexpTrytomatchpackageidargumentsasaregularexpressionifanexactmatchisn'tfound.
https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/pkgutil.1.html

1/3

10.7.2015

pkgutil(1)MacOSXManualPage

Seeegrep(1)andre_format(7)forsyntax.
RECEIPTDATABASECOMMANDS
--packages,--pkgs
ListallinstalledpackageIDsonthespecified--volume.
--pkgs-plist
ListallinstalledpackageIDsonthespecified--volumeinMacOSXplist(5)format.
--pkgs=REGEXP
ListallinstalledpackageIDsmatchingREGEXPonthespecified--volume.Theequalsign
(=)isrequiredorthesearchstringwillbeignoredandallpackageIDswillbereturned.
Bemindfulofescapingcharactersinbothyourshellandtheregularexpression.(Eg,
'pkgutilpkgs=\\.D'searchesforpackageIDsmatchingtheliteral'.D'afterescapingthe
backslashfromyourshellandthenthedotfromtheregextomakeitliteral.)Regular
expressionsaremorecomplexthansimpleshellglobbing.Adot(.)matchesanycharacter,
while'*'matcheszeroormoreofthepreviouscharacter.Seere_format(7)foracomplete
descriptionofthesyntax.
--filespackageid
Listallofthefilesinstalledunderthepackageid.
--export-plistpackageid
PrintallreceiptinformationaboutthespecifiedpackageidinthestandardMacOSX
plist(5)format.
--verifypackageid
Runrepair_packages(8)toverifythespecifiedpackageid.
--repairpackageid
Runrepair_packages(8)torepairthespecifiedpackageid.
--pkg-infopackageid
Printextendedinformationaboutthespecifiedpackageid.
--pkg-info-plistpackageid
PrintextendedinformationaboutthespecifiedpackageidinMacOSXplist(5)format.
--forgetpackageid
Discardallreceiptdataaboutpackageid,butdonottouchtheinstalledfiles.DONOT
usethiscommandfromaninstallerpackagescripttofixbrokenpackagedesign.
--learnpath
UpdatetheACLsofthegivenpathinthereceiptidentifiedby--edit-pkg.Thisaffects
subsequentrepairoperationsonthepackage.Thiscommandcannotbeusedfrompackage
postinstallscripts,butifapostinstallscriptchangestheACLsontheinstalledfiles,
thereceiptisautomaticallybeupdatedtoreflectthosechanges.Thiscommandwillnot
updatethefilesystempermissionsinthereceipt.
--pkg-groupspackageid
Listallofthepackagegroupsthispackageidisamemberof.
--groupsListallofthepackagegroupsonthespecified--volume.
--groups-plist
Listallofthepackagegroupsonthespecified--volumeinMacOSXplist(5)format.
--group-pkgsgroupid
Listallofthepackagesthataremembersofthisgroupid.
--file-infopath
Showthemetadataknownaboutpath.
--file-info-plistpath
ShowthemetadataknownaboutpathinMacOSXplist(5)format.
FILECOMMANDS
--expandpkgpathdirpath
Expandtheflatpackageatpkgpathintoanewdirectoryspecifiedbydirpath.
--flattendirpathpkgpath
https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/pkgutil.1.html

2/3

10.7.2015

pkgutil(1)MacOSXManualPage

Flattenthedirpathintoanewflatpackagecreatedatpkgpath.Thedirectorytobe
flattenedmusthavethepropercontentsandlayoutforaflatpackage.Thisisnot
intendedasasubstituteforpkgbuild(1).
--bompathExtractanyBOMfilesfromtheflatpkgatpathinto/tmpandreturnthefilename(s).Sug
gesteduseisasanargumenttolsbom(8).Eg,"lsbom`pkgutilbompath`".Notethatsome
flatpackagearchivesmaycontainnoBOM,oneBOM,orseveralBOMs.
--payload-filespath
Listthefilesarchivedwithinthepayloadoftheuninstalledflatpackage(s)containedat
path.Thisshouldbeequivilantto"lsboms`pkgutilbompath`".Notethatflatpackage
archivesmaycontainmorethanonepackage,andthedestinationlocationfortheunin
stalledpackage(s)isunknowntothiscommand.
--check-signaturepkgpath
Checkthevalidityandtrustofthesignatureonthepackageatpkgpath.Inadditionto
thestatusofthesignature,theassociatedcertificatechainwillbeshown.
SEEALSO
installer(8)
repair_packages(8)
pkgbuild(1)
productbuild(1)
MacOSMarch2,2011MacOS

Reporting Problems
The way to report a problem with this manual page depends on the type of problem:
Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links
below.

https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/pkgutil.1.html

3/3