Documentation

pkgng - Package manager for FreeBSD >= 9.0

Synopsis

Manage binary packages for FreeBSD using ‘pkgng’ which is available in versions after 9.0.

Options

parameter required default choices comments
annotation
(added in 1.6)
 no
    a comma-separated list of keyvalue-pairs of the form <+/-/:><key>[=<value>]. A '+' denotes adding an annotation, a '-' denotes removing an annotation, and ':' denotes modifying an annotation. If setting or modifying annotations, a value must be provided.
    cached
    		 no
    • yes
    • no
    use local package base or try to fetch an updated one
    chroot
    (added in 2.1)
    		 no
      pkg will chroot in the specified environment
      can not be used together with 'rootdir' option
      name
      		 yes
        name of package to install/remove
        pkgsite
        		 no
          for pkgng versions before 1.1.4, specify packagesite to use for downloading packages, if not specified, use settings from /usr/local/etc/pkg.conf for newer pkgng versions, specify a the name of a repository configured in /usr/local/etc/pkg/repos
          rootdir
          		 no
            for pkgng versions 1.5 and later, pkg will install all packages within the specified root directory
            can not be used together with 'chroot' option
            state
            		 no present
            • present
            • absent
            state of the package

            Examples

            # Install package foo
- pkgng: name=foo state=present

# Annotate package foo and bar
- pkgng: name=foo,bar annotation=+test1=baz,-test2,:test3=foobar

# Remove packages foo and bar
- pkgng: name=foo,bar state=absent

            Notes

            Note

            When using pkgsite, be careful that already in cache packages won’t be downloaded again.

            This is an Extras Module

            For more information on what this means please read Extras Modules

            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.