cdist-web/src/extra/manual/3.1.11/man7/cdist-type__package_pkgng_f...

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_pkgng_freebsd(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm139877127283616"></a>cdist-type__package_pkgng_freebsd(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email">&lt;<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>&gt;</code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_caveats">6. CAVEATS</a></span></dt><dt><span class="section"><a href="#_messages">7. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">8. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">9. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">10. COPYING</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_pkgng_freebsd - Manage FreeBSD packages with pkg-ng</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is usually used on FreeBSD to manage packages.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
name
</span></dt><dd>
    If supplied, use the name and not the object id as the package name.
</dd><dt><span class="term">
flavor
</span></dt><dd>
    If supplied, use to avoid ambiguity.
</dd><dt><span class="term">
version
</span></dt><dd>
    If supplied, use to install a specific version of the package named.
</dd><dt><span class="term">
repo
</span></dt><dd>
    If supplied, use to install the package named from a particular repo.
</dd><dt><span class="term">
state
</span></dt><dd>
    Either "present" or "absent", defaults to "present"
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
upgrade
</span></dt><dd>
    If supplied, allow upgrading to the latest version of a package.
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_caveats"></a>6. CAVEATS</h2></div></div></div><p>This type requires that repository definitions already exist in /etc/pkg/*.conf.
Ensure that they exist prior to use of this type with __file.</p><p>pkg-ng can’t upgrade a package to a specific version. If this type needs to
upgrade a package, it can only ugprade to the latest available version. If the
"upgrade" parameter is not given and an upgrade needs to occur, an error will result.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>7. MESSAGES</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
install
</span></dt><dd>
   The package was installed
</dd><dt><span class="term">
remove
</span></dt><dd>
   The package was removed
</dd><dt><span class="term">
upgrade
</span></dt><dd>
   The package was upgraded
</dd><dt><span class="term">
exist
</span></dt><dd>
   The package was already present and thus not installed
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>8. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh is installed
__package_pkgng_freebsd zsh --state present

# Ensure vim is installed, use flavor no_x11
__package_pkgng_freebsd vim --state present --flavor no_x11

# If you don't want to follow pythonX packages, but always use python
__package_pkgng_freebsd python --state present --name python2

# Install a package from a particular repository when multiples exist
__package_pkgng_freebsd bash --state present --repo myrepo

# Remove obsolete package
__package_pkgng_freebsd puppet --state absent</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>9. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<a href="../man7/cdist-type.html">cdist-type(7)</a>
</li><li class="listitem">
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>10. COPYING</h2></div></div></div><p>Copyright (C) 2014 Jake Guffey. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>