Pkgutil(1) Mac OS X Manual Page

3
This manual page is for Mac OS X version 10.9 If you are running a different version of Mac OS X, 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) BSD General Commands Manual pkgutil(1) NAME pkgutil Query and manipulate Mac OS X Installer packages and receipts. SYNOPSIS pkgutil [options] [commands] DESCRIPTION pkgutil reads and manipulates Mac OS X Installer flat packages, and provides access to the ``receipt'' database used by the Installer. Options are processed first, and affect the operation of all commands. Multiple commands are performed sequentially in the given order. The files and directories where receipts are stored are subject to change. Always use pkgutil to query or modify them. OPTIONS --help, -h A brief summary of commands and usage. --force, -f Don't ask for confirmation before performing a potentially destructive or ambiguous opera tion. --verbose, -v Output in a "humanreadable" format with extra headers, footers, indentation, and other contextual information. --volume path Perform all operations on the specified volume or home directory. The root volume '/' will be used if unspecified. --edit-pkg packageid Specifies an existing receipt to be modified inplace by --learn. --only-files List only files (not directories) in --files listing. --only-dirs List only directories (not files) in --files listing. --regexp Try to match packageid arguments as a regular expression if an exact match isn't found.

description

Mac packages

Transcript of Pkgutil(1) Mac OS X Manual Page

  • 10.7.2015 pkgutil(1)MacOSXManualPage

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

    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 atechnology.

    To learn how the manual is organized or to learn about command syntax, read the manualpage for manpages(5).

    For more information about this technology, look for other documentation in the AppleDeveloper Library.

    For general information about writing shell scripts, read Shell Scripting Primer.

    pkgutil(1)BSDGeneralCommandsManualpkgutil(1)

    NAMEpkgutilQueryandmanipulateMacOSXInstallerpackagesandreceipts.

    SYNOPSISpkgutil[options][commands]

    DESCRIPTIONpkgutilreadsandmanipulatesMacOSXInstallerflatpackages,andprovidesaccesstothe``receipt''databaseusedbytheInstaller.Optionsareprocessedfirst,andaffecttheoperationofallcommands.Multiplecommandsareperformedsequentiallyinthegivenorder.

    Thefilesanddirectorieswherereceiptsarestoredaresubjecttochange.Alwaysusepkgutiltoqueryormodifythem.

    OPTIONS--help,-hAbriefsummaryofcommandsandusage.

    --force,-fDon'taskforconfirmationbeforeperformingapotentiallydestructiveorambiguousoperation.

    --verbose,-vOutputina"humanreadable"formatwithextraheaders,footers,indentation,andothercontextualinformation.

    --volumepathPerformalloperationsonthespecifiedvolumeorhomedirectory.Therootvolume'/'willbeusedifunspecified.

    --edit-pkgpackageidSpecifiesanexistingreceipttobemodifiedinplaceby--learn.

    --only-filesListonlyfiles(notdirectories)in--fileslisting.

    --only-dirsListonlydirectories(notfiles)in--fileslisting.

    --regexpTrytomatchpackageidargumentsasaregularexpressionifanexactmatchisn'tfound.

  • 10.7.2015 pkgutil(1)MacOSXManualPage

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

    Seeegrep(1)andre_format(7)forsyntax.

    RECEIPTDATABASECOMMANDS--packages,--pkgsListallinstalledpackageIDsonthespecified--volume.

    --pkgs-plistListallinstalledpackageIDsonthespecified--volumeinMacOSXplist(5)format.

    --pkgs=REGEXPListallinstalledpackageIDsmatchingREGEXPonthespecified--volume.Theequalsign(=)isrequiredorthesearchstringwillbeignoredandallpackageIDswillbereturned.Bemindfulofescapingcharactersinbothyourshellandtheregularexpression.(Eg,'pkgutilpkgs=\\.D'searchesforpackageIDsmatchingtheliteral'.D'afterescapingthebackslashfromyourshellandthenthedotfromtheregextomakeitliteral.)Regularexpressionsaremorecomplexthansimpleshellglobbing.Adot(.)matchesanycharacter,while'*'matcheszeroormoreofthepreviouscharacter.Seere_format(7)foracompletedescriptionofthesyntax.

    --filespackageidListallofthefilesinstalledunderthepackageid.

    --export-plistpackageidPrintallreceiptinformationaboutthespecifiedpackageidinthestandardMacOSXplist(5)format.

    --verifypackageidRunrepair_packages(8)toverifythespecifiedpackageid.

    --repairpackageidRunrepair_packages(8)torepairthespecifiedpackageid.

    --pkg-infopackageidPrintextendedinformationaboutthespecifiedpackageid.

    --pkg-info-plistpackageidPrintextendedinformationaboutthespecifiedpackageidinMacOSXplist(5)format.

    --forgetpackageidDiscardallreceiptdataaboutpackageid,butdonottouchtheinstalledfiles.DONOTusethiscommandfromaninstallerpackagescripttofixbrokenpackagedesign.

    --learnpathUpdatetheACLsofthegivenpathinthereceiptidentifiedby--edit-pkg.Thisaffectssubsequentrepairoperationsonthepackage.Thiscommandcannotbeusedfrompackagepostinstallscripts,butifapostinstallscriptchangestheACLsontheinstalledfiles,thereceiptisautomaticallybeupdatedtoreflectthosechanges.Thiscommandwillnotupdatethefilesystempermissionsinthereceipt.

    --pkg-groupspackageidListallofthepackagegroupsthispackageidisamemberof.

    --groupsListallofthepackagegroupsonthespecified--volume.

    --groups-plistListallofthepackagegroupsonthespecified--volumeinMacOSXplist(5)format.

    --group-pkgsgroupidListallofthepackagesthataremembersofthisgroupid.

    --file-infopathShowthemetadataknownaboutpath.

    --file-info-plistpathShowthemetadataknownaboutpathinMacOSXplist(5)format.

    FILECOMMANDS--expandpkgpathdirpathExpandtheflatpackageatpkgpathintoanewdirectoryspecifiedbydirpath.

    --flattendirpathpkgpath

  • 10.7.2015 pkgutil(1)MacOSXManualPage

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

    Flattenthedirpathintoanewflatpackagecreatedatpkgpath.Thedirectorytobeflattenedmusthavethepropercontentsandlayoutforaflatpackage.Thisisnotintendedasasubstituteforpkgbuild(1).

    --bompathExtractanyBOMfilesfromtheflatpkgatpathinto/tmpandreturnthefilename(s).Suggesteduseisasanargumenttolsbom(8).Eg,"lsbom`pkgutilbompath`".NotethatsomeflatpackagearchivesmaycontainnoBOM,oneBOM,orseveralBOMs.

    --payload-filespathListthefilesarchivedwithinthepayloadoftheuninstalledflatpackage(s)containedatpath.Thisshouldbeequivilantto"lsboms`pkgutilbompath`".Notethatflatpackagearchivesmaycontainmorethanonepackage,andthedestinationlocationfortheuninstalledpackage(s)isunknowntothiscommand.

    --check-signaturepkgpathCheckthevalidityandtrustofthesignatureonthepackageatpkgpath.Inadditiontothestatusofthesignature,theassociatedcertificatechainwillbeshown.

    SEEALSOinstaller(8)repair_packages(8)pkgbuild(1)productbuild(1)

    MacOSMarch2,2011MacOS

    Reporting ProblemsThe way to report a problem with this manual page depends on the type of problem:

    Content errorsReport errors in the content of this documentation with the feedback links below.

    Bug reportsReport bugs in the functionality of the described tool or API through Bug Reporter.

    Formatting problemsReport formatting mistakes in the online version of these pages with the feedback linksbelow.