fpm Documentation

$ git clone [email protected]:yourusername/fpm.git

$ gem install bundler

$ bundle install

...
Using json (1.8.1)
Using fpm (0.4.42) from source at .
Using hitimes (1.2.1)
...

apt-get install bsdtar || apt install libarchive-tools

yum install bsdtar

apt-get install lintian cpanminus

$ xcode-select --install

--- File: hello-world

#!/usr/bin/env bash

#
# == hello-world 0.1.0 ==
#

echo "Hello, world!" | lolcat

--- File: hello-world.1

.TH HELLO WORLD "1" "July 2021" "hello-world 0.1.0" "User Commands"
.SH NAME
hello-world \- manual page for hello-world 0.1.0
.SH DESCRIPTION
.IP
USAGE: hello-world
.SH "SEE ALSO"
.IP
Website: https://example.com/hello-world
.SH "OTHER"
.IP
Made by You The Amazing Person <you are an amazing person at example dot com>
.IP
This program is distributed under the AGPL 3.0 license.

fpm \
  -s dir -t deb \
  -p hello-world-0.1.0-1-any.deb \
  --name hello-world \
  --license agpl3 \
  --version 0.1.0 \
  --architecture all \
  --depends bash --depends lolcat \
  --description "Say hi!" \
  --url "https://example.com/hello-world" \
  --maintainer "You The Amazing Person <you are an amazing person at example dot com>" \
  hello-world=/usr/bin/hello-world hello-world.1=/usr/share/man/man1/hello-world.1

.. note::
	This assumes you have nodejs and npm already installed on your machine.

Run the following command::

	fpm -s npm -t <deb/rpm/pacman/solaris/freebsd/osxpkg/tar> <npm-package-name>

E.g.: To package yarn for Arch Linux::

	fpm -s npm -t pacman yarn

This will download the latest ``yarn`` package from npm.com and convert it to a .pkg.tar.zst (pacman) package. It will create a package named ‘node-yarn-VERSION_ARCH.deb’ with the appropriate version/arch in place. FPM will automatically pick the package name, version, maintainer, section, homepage, and description all from the npm package itself. Nothing for you to worry about :)

Packaging a ruby gem
~~~~~~~~~~~~~~~~~~~~

.. note::
	This assumes you have ruby already installed on your machine.

Run the following command::

	fpm -s gem -t <deb/rpm/pacman/solaris/freebsd/osxpkg/tar> <gem-name>

E.g.: To package FPM using FPM for Debian::

	# FPM-ception :D
	fpm -s gem -t deb fpm

This will download the latest ``fpm`` rubygem from rubygems.org and convert it to a .deb. It will create a package named ‘rubygem-fpm-VERSION_ARCH.deb’ with the appropriate version/arch in place. FPM will automatically pick the package name, version, maintainer, section, homepage, and description all from the rubygem itself. Nothing for you to worry about :)

Packaging a CPAN module
~~~~~~~~~~~~~~~~~~~~~~~

.. note::
	This assumes you have perl already installed on your machine.

Run the following command package the perl Fennec module for Debian::

	fpm -s cpan -t deb Fennec

This will download Fennec from CPAN and build a Debian package of the Fennec Perl module locally.

By default, FPM believes the following to be true:

* That your local Perl lib path will be the target Perl lib path
* That you want the package name to be prefixed with the word perl
* That the dependencies from CPAN are valid and that the naming scheme for those dependencies are prefixed with perl

If you wish to change any of the above, use the following::

	fpm -t deb -s cpan -–cpan-perl-lib-path /usr/share/perl5 Fennec

	fpm -t deb -s cpan --cpan-package-name-prefix fubar /usr/share/perl5 Fennec

The first command will change the target path to where perl will be. Your local perl install may be /opt/usr/share/perl5.10 but the package will be constructed so that the module will be installed to /usr/share/perl5

The second command will change the prefix of the package, i.e., from perl-Fennec to fubar-Fennec.

Configuration file
-------------------

If you are using FPM in to build packages for multiple targets and keep repeating several options (like version, description, name, license, maintainer, url, architecture, files to package, etc.), you can add a ``.fpm`` file in your working directory, with a list of options as well as arguments that you want to pass to the CLI. Extending the example of the hello-world program, say we want to package it as a .deb and a .rpm. We could create the following .fpm file::

	--- File: .fpm

	-s dir
	--name hello-world
	--license agpl3
	--version 0.1.0
	--architecture all
	--depends bash --depends lolcat
	--description "Say hi!"
	--url "https://example.com/hello-world"
	--maintainer "You The Amazing Person <you are an amazing person at example dot com>"

	hello-world=/usr/bin/hello-world hello-world.1=/usr/share/man/man1/hello-world.1

.. note::
	CLI flags will override those in the ``.fpm`` file.

Meanwhile, we could run the following commands in terminal to build the .deb and .rpm::

	fpm -t deb -p hello-world-0.1.0-1-any.deb

	fpm -t rpm -p hello-world-0.1.0-1-any.rpm

Tada! You will have a .deb (for Debian) and .rpm (for RedHat), with no unnecessary duplication of metadata. You can put any other valid CLI options in the ``.fpm`` file too.

For more detailed information regarding all CLI flags, see the :doc:`CLI reference. <cli-reference>`

---

### Index (`docs/index.rst`)

fpm - packaging made simple
===========================

.. note::
  The documentation here is a work-in-progress; it is by no means extensive. If you want to contribute new docs or report problems, you are invited to do so on `the project issue tracker`_.

Welcome to the fpm documentation!

fpm is a tool which lets you easily create packages for Debian, Ubuntu, Fedora, CentOS, RHEL, Arch Linux, FreeBSD, macOS, and more!

fpm isn't a new packaging system, it's a tool to help you make packages for existing systems with less effort. It does this by offering a command-line interface to allow you to create packages easily. Here are some examples using fpm:

* ``fpm -s npm -t deb express`` -- Make a Debian package for the nodejs `express` library
* ``fpm -s cpan -t rpm Fennec`` -- Make an rpm for the perl Fennec module
* ``fpm -s dir -t pacman -n fancy ~/.zshrc`` -- Put your ~/.zshrc into an Arch Linux pacman package named "fancy"
* ``fpm -s python -t freebsd Django`` -- Create a FreeBSD package containing the Python Django library
* ``fpm -s rpm -t deb mysql.rpm`` -- Convert an rpm to deb

This project has a few important principles which guide development:

* Community: If a newbie has a bad time, it's a bug.
* Engineering: Make it work, make it right, then make it fast.
* Capabilities: If it doesn't do a thing today, we can make it do it tomorrow.

`Install fpm `_ and you'll quickly begin making packages for whatever you need!

You can view the changelog `here`_.

Table of Contents
-----------------

.. toctree::
	:includehidden:

	installation
	getting-started
	packaging-types
	cli-reference
	docker
	contributing
	changelog

.. _here: /changelog.html

.. _the project issue tracker: https://github.com/jordansissel/fpm/issues

---

### Installation (`docs/installation.rst`)

Installation
============

FPM is written in ruby and can be installed using `gem`. For some package formats (like rpm and snap), you will need certain packages installed to build them.

Installing FPM
--------------

.. note::
	You must have ruby installed on your machine before installing fpm. `Here`_ are instructions to install Ruby on your machine.

.. _Here: https://www.ruby-lang.org/en/documentation/installation/

You can install FPM with the ``gem`` tool::

    gem install fpm

To make sure fpm is installed correctly, try running the following command::

    fpm --version

You should get some output like this, although the exact output will depend on which version of FPM you have installed.::

    % fpm --version
    1.17.0

Now you can go on to `using FPM! <getting-started.html>`_

Installing optional dependencies
--------------------------------

.. warning::
	This section may be imperfect; please make sure you are installing the right package for your OS.

Some package formats require other tools to be installed on your machine to be built; especially if you are building a package for another operating system/distribution.

* RPM: rpm/rpm-tools/rpm-build [This dependency might be removed in the future, see `issue #54`_ on github]
* Snap: squashfs/squashfs-tools
* Python: a requirements.txt file is provided to list Python dependencies: `$ pip install -r requirements.txt`

.. _issue #54: https://github.com/jordansissel/fpm/issues/54

.. note::
	You will not be able to build an osxpkg package (.pkg) for MacOS unless you are running MacOS.

Here are instructions to install these dependencies on your machine:

On OSX/macOS::

    brew install rpm squashfs

On Arch Linux and Arch-based systems (Manjaro, EndeavourOS, etc)::

    pacman -S rpm-tools squashfs-tools

On Debian and Debian-based systems (Ubuntu, Linux Mint, Pop!_OS, etc)::

    apt-get install squashfs-tools

On Red Hat systems (Fedora 22 or older, CentOS, Rocky Linux, etc)::

    yum install rpm-build squashfs-tools

On Fedora 23 or newer::

    dnf install rpm-build squashfs-tools

On Oracle Linux 7.x systems::

    yum-config-manager --enable ol7_optional_latest
    yum install rpm-build squashfs-tools

---

### Packaging Types (`docs/packaging-types.rst`)

Packaging Types
===============

.. toctree::
	:includehidden:
	:glob:

	packages/*

---

### Packages Apk (`docs/packages/apk.rst`)

apk - Alpine package format
===========================

Supported Uses in FPM
---------------------

fpm supports using ``apk`` only as an output type. This means you can create ``apk`` packages from input types like ``deb``, ``dir``, or ``npm``

apk-specific command line flags
-------------------------------

.. include:: cli/apk.rst

---

### Packages Cpan (`docs/packages/cpan.rst`)

cpan - Perl packages from CPAN
===============================

Supported Uses in FPM
---------------------

fpm supports using ``cpan`` only as an input type. This means you can convert
``cpan`` input packages to output packages like ``deb``, ``rpm``, and more.

Arguments when used as input type
---------------------------------

Any number of arguments are supported and behave as follows:

* A name to search on MetaCPAN_. If a module is found on MetaCPAN_, it will be downloaded and used when building the package.
* or, a local directory containing a Perl module to build. 

.. _MetaCPAN: https://metacpan.org/

Sample Usage
------------

Let's take the `Regexp::Common <https://metacpan.org/pod/Regexp::Common>`_ Perl module and package it as a deb. We can let fpm do the hard work here of finding the module on cpan and downloading it::

  % fpm -s cpan -t deb Regexp::Common
  Downcasing provides 'perl-Regexp-Common' because deb packages  don't work so good with uppercase names {:level=>:warn}
  Downcasing provides 'perl-Regexp-Common-Entry' because deb packages  don't work so good with uppercase names {:level=>:warn}
  Debian tools (dpkg/apt) don't do well with packages that use capital letters in the name. In some cases it will automatically downcase them, in others it will not. It is confusing. Best to not use any capital letters at all. I have downcased the package name for you just to be safe. {:oldname=>"perl-Regexp-Common", :fixedname=>"perl-regexp-common", :level=>:warn}
  Debian packaging tools generally labels all files in /etc as config files, as mandated by policy, so fpm defaults to this behavior for deb packages. You can disable this default behavior with --deb-no-default-config-files flag {:level=>:warn}
  Created package {:path=>"perl-regexp-common_2017060201_all.deb"}

Fpm did a bunch of nice work for you. First, it searched MetaCPAN_ for Regexp::Common. Then it downloaded the latest version. If you wanted to specify a version, you can use the ``-v`` flag, such as ``-v 2016060201``.

In the example above, a few warning messages appear. Fpm's job is to help you convert packages. In this case, we're converting a Perl module named "Regexp::Common" to a Debian package. In this situation, we need to make sure our Debian package is accepted by Debian's tools! This means fpm will do the following:

* Debian package names appear to all use lowercase names, so fpm does this for you.
* Debian package names also cannot have "::" in the names, so fpm replaces these with a dash "-"

Let's try to use our new package! First, installing it::

  % sudo dpkg -i perl-regexp-common_2017060201_all.deb
  Selecting previously unselected package perl-regexp-common.
  (Reading database ... 81209 files and directories currently installed.)
  Preparing to unpack perl-regexp-common_2017060201_all.deb ...
  Unpacking perl-regexp-common (2017060201) ...
  Setting up perl-regexp-common (2017060201) ...
  Processing triggers for man-db (2.9.1-1) ...

And try to use it. Let's ask Regexp::Common for a regular expression that matches real numbers::

  % perl -MRegexp::Common -e 'print $RE{num}{real}'
  (?:(?i)(?:[-+]?)(?:(?=[.]?[0123456789])(?:[0123456789]*)(?:(?:[.])(?:[0123456789]{0,}))?)(?:(?:[E])(?:(?:[-+]?)(?:[0123456789]+))|))

Nice!

Fun Examples
------------

.. note::
  Do you have any examples you want to share that use the ``cpan`` package type? Share your knowledge here: https://github.com/jordansissel/fpm/issues/new

cpan-specific command line flags
--------------------------------

.. include:: cli/cpan.rst

---

### Packages Deb (`docs/packages/deb.rst`)

deb - Debian package format
===========================

Supported Uses in FPM
---------------------

fpm supports input and output for Debian package (deb). This means you can read a deb and convert it to a different output type (such as a `dir` or `rpm`). It also means you can create a deb package.

Arguments when used as input type
---------------------------------

For the sample command reading a deb file as input and outputting an rpm package::

	fpm -s deb -t rpm file.deb

The argument is used as a file and read as a debian package file.

Sample Usage
------------

Let's create a Debian package of Hashicorp's Terraform. To do this, we'll need to download it and put the files into a Debian package::

    # Download Terraform 1.0.10
    % wget https://releases.hashicorp.com/terraform/1.0.10/terraform_1.0.10_linux_amd64.zip

The Terraform release .zip file contains a single file, `terraform` itself. You can see the files in this zip by using `unzip -l`::

    % unzip -l ~/build/z/terraform_1.0.10_linux_amd64.zip
    Archive:  /home/jls/build/z/terraform_1.0.10_linux_amd64.zip
      Length      Date    Time    Name
    ---------  ---------- -----   ----
    79348596  2021-10-28 07:15   terraform
    ---------                     -------
    79348596                     1 file

We can use fpm to convert this zip file into a debian package with one step::

    % fpm -s zip -t deb --prefix /usr/bin -n terraform -v 1.0.10 terraform_1.0.10_linux_amd64.zip
    Created package {:path=>"terraform_1.0.10_amd64.deb"}

Nice! We just converted a zip file into a debian package. Let's talk through the command-line flags here:

* ``-s zip`` tells fpm to use "zip" as the input type. This allows fpm to read zip files.
* ``-t deb`` tells fpm to output a Debian package.
* ``--prefix /usr/bin`` tells fpm to move all files in the .zip file to the /usr/bin file path. In this case, it results in a single file in the path `/usr/bin/terraform`
* ``-n terraform`` names the package "terraform"
* ``-v 1.0.10`` sets the package version. This is useful to package systems when considering whether a given package is an upgrade, downgrade, or already installed.
* Finally, the last argument, `terraform_1.0.10_linux_amd64.zip`. This is given to the fpm to process as a zip file.

You can inspect the package contents with `dpkg --contents terraform_1.0.10_amd64.deb`::

    % dpkg --contents terraform_1.0.10_amd64.deb
    drwxr-xr-x 0/0               0 2021-11-02 23:33 ./
    drwxr-xr-x 0/0               0 2021-11-02 23:33 ./usr/
    drwxr-xr-x 0/0               0 2021-11-02 23:33 ./usr/share/
    drwxr-xr-x 0/0               0 2021-11-02 23:33 ./usr/share/doc/
    drwxr-xr-x 0/0               0 2021-11-02 23:33 ./usr/share/doc/terraform/
    -rw-r--r-- 0/0             141 2021-11-02 23:33 ./usr/share/doc/terraform/changelog.gz
    drwxr-xr-x 0/0               0 2021-11-02 23:33 ./usr/bin/
    -rwxr-xr-x 0/0        79348596 2021-10-28 07:15 ./usr/bin/terraform

The ``changelog.gz`` file is a recommended Debian practice for packaging. FPM will provide a generated changelog for you, by default. You can provide your own with the ``--deb-changelog`` flag.

Lets install our terraform package and try it out::

    % sudo apt install ./terraform_1.0.10_amd64.deb
    ...

    % dpkg -l terraform
    Desired=Unknown/Install/Remove/Purge/Hold
    | Status=Not/Inst/Conf-files/Unpacked/halF-conf/Half-inst/trig-aWait/Trig-pend
    |/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)
    ||/ Name                     Version           Architecture      Description
    +++-========================-=================-=================-=====================================================
    ii  terraform                1.0.10            amd64             no description given

    % terraform -version
    Terraform v1.0.10
    on linux_amd64

You may remove the package at any time::

    % sudo apt remove terraform
    ...
    Removing terraform (1.0.10) ...


Fun Examples
------------

Hi! The fpm project would love to have any fun examples you have for using this package type. Please consider contributing your ideas by submitting them on the fpm issue tracker: https://github.com/jordansissel/fpm/issues/new

Changing an existing deb
~~~~~~~~~~~~~~~~~~~~~~~~

fpm supports deb as both an input and output type (``-s`` and ``-t`` flags), so you can use this to modify an existing deb.

For example, let's create an deb to use for our example::

  % fpm -s empty -t deb -n example
  Created package {:path=>"example_1.0_amd64.deb"}

Lets say we made a mistake and want to rename the package::

  % fpm -s deb -t deb -n newname example_1.0_amd64.deb
  Created package {:path=>"newname_1.0_amd64.deb"}

And maybe the architecture is wrong. fpm defaulted to amd64 (what fpm calls
"native"), and we really want what Debian calls "all"::

  % fpm -s deb -t deb -a all newname_1.0_amd64.deb
  Created package {:path=>"newname_1.0_all.deb"}

Deb-specific command line flags
-------------------------------

.. include:: cli/deb.rst

---

### Packages Dir (`docs/packages/dir.rst`)

dir - Local Files
=================

Supported Uses in FPM
---------------------

fpm supports using ``dir`` as an input type and output type. This means you can use ``dir`` to put files into other package types (like Debian or Red Hat packages). You can also use this as an output type to extract files from packages.

Arguments when used as input type
---------------------------------

Any number of arguments are supported and behave as follows:

1) A path to a local file or directory will be put into the output package as-is with the same path, contents, and metadata (file owner, modification date, etc)
2) A syntax of "localpath=destinationpath" to copy local paths into the output package with the destination path.

The local file paths are modified by the ``--chdir`` flag. The destination file paths are modified by the ``--prefix`` flag.

Sample Usage
------------

For this example, let's look at packaging the Kubernetes tool, ``kubectl``. The installation for ``kubectl`` recommends downloading a pre-compiled binary. Let's do this and then package it into a Debian package.

First, we download the ``kubectl`` binary, according to the kubernetes documentation for kubectl installation on Linux::

  # Query the latest version of kubectl and store the value in the 'version' variable
  % version="$(curl -L -s https://dl.k8s.io/release/stable.txt)"

  # Download the Linux amd64 binary
  % curl -LO "https://dl.k8s.io/release/${version}/bin/linux/amd64/kubectl"

  # Make it executable
  % chmod 755 kubectl

The above shell will find the latest version of ``kubectl`` and download it. We'll use the file and the version number next to make our package::

  # Create the package that installs kubectl as /usr/bin/kubectl
  % fpm -s dir -t deb -n kubectl -a amd64 -v ${version#v*} kubectl=/usr/bin/kubectl
  Created package {:path=>"kubectl_v1.22.3_amd64.deb"}

.. note::
  We use ``${version#v*}`` in our shell to set the package version. This is
  because Kuberenetes versions have a text that starts with "v" and this is not
  valid in Debian packages. This will turn "v1.2.3" into "1.2.3" for our package.

Now we can check our package to make sure it looks the way we want::

  % dpkg --contents kubectl_1.22.3_amd64.deb
  [ ... output abbreviated for easier reading ... ]
  -rw-r--r-- 0/0        46907392 2021-11-05 20:09 ./usr/bin/kubectl

  % dpkg --field kubectl_1.22.3_amd64.deb Package Version Architecture
  Package: kubectl
  Version: 1.22.3
  Architecture: amd64

And install it to test things and make sure it's what we wanted::

  % sudo dpkg -i kubectl_1.22.3_amd64.deb
  Selecting previously unselected package kubectl.
  (Reading database ... 58110 files and directories currently installed.)
  Preparing to unpack kubectl_1.22.3_amd64.deb ...
  Unpacking kubectl (1.22.3) ...
  Setting up kubectl (1.22.3) ...

And try to use it::

  % which kubectl
  /usr/bin/kubectl

  % kubectl version
  Client Version: version.Info{Major:"1", Minor:"22", GitVersion:"v1.22.3", GitCommit:"c92036820499fedefec0f847e2054d824aea6cd1", GitTreeState:"clean", BuildDate:"2021-10-27T18:41:28Z", GoVersion:"go1.16.9", Compiler:"gc", Platform:"linux/amd64"}

Cool :)

Fun Examples
------------

.. note::
  Do you have any examples you want to share that use the ``dir`` package type? Share your knowledge here: https://github.com/jordansissel/fpm/issues/new

---

### Packages Empty (`docs/packages/empty.rst`)

empty - A package with no files
===============================

Supported Uses in FPM
---------------------

fpm supports using ``empty`` only as an input type.  

Arguments when used as input type
---------------------------------

Extra arguments are ignored for this type. As an example, where with ``fpm -s dir ...`` the arguments are file paths, ``fpm -s empty`` takes no input arguments because there's no file contents to use.

Sample Usage
------------

The ``empty`` package type is great for creating "meta" packages which are used to group dependencies together.

For example, if you want to make it easier to install a collection of developer tools, you could create a single package that depends on all of your desired developer tools. 

Let's create a Debian package named 'devtools' which installs the following:

* git
* curl
* nodejs

Here's the fpm command to do this::

  % fpm -s empty -t rpm -n devtools -a all -d git -d curl -d nodejs
  Created package {:path=>"devtools-1.0-1.noarch.rpm"}

We can check the dependencies on this package::

  % rpm -qp devtools-1.0-1.noarch.rpm --requires
  curl
  git
  nodejs
  rpmlib(CompressedFileNames) <= 3.0.4-1
  rpmlib(PayloadFilesHavePrefix) <= 4.0-1

And see that there are no files::

  % rpm -ql devtools-1.0-1.noarch.rpm
  (contains no files)


Fun Examples
------------

Hi! The fpm project would love to have any fun examples you have for using this package type. Please consider contributing your ideas by submitting them on the fpm issue tracker: https://github.com/jordansissel/fpm/issues/new

---

### Packages Freebsd (`docs/packages/freebsd.rst`)

freebsd - FreeBSD pkg
===============================

Supported Uses in FPM
---------------------

fpm supports using ``freebsd`` only as an output type. This means you can create ``freebsd`` packages from input types like ``deb``, ``dir``, or ``npm``

freebsd-specific command line flags
-----------------------------------

.. include:: cli/freebsd.rst

---

### Packages Gem (`docs/packages/gem.rst`)

gem - Ruby's rubygem packages
=============================

Supported Uses in FPM
---------------------

fpm supports using ``gem`` only as an input type. This means you can convert
``gem`` input packages to output packages like ``deb``, ``rpm``, and more.

gem-specific command line flags
-------------------------------

.. include:: cli/gem.rst

---

### Packages Npm (`docs/packages/npm.rst`)

npm - Packages for NodeJS
===============================

Supported Uses in FPM
---------------------

fpm supports using ``npm`` only as an input type.

Arguments when used as input type
---------------------------------

Any number of arguments are supported and behave as follows:

* ``name@version`` -- a specific named package at the given version.
* ``name`` -- the name of a node package. In this use, the ``--version`` flag is used to pick the version to download. If no version is given, the latest version of the package is downloaded.

Sample Usage
------------

You'll need ``npm`` installed for this example.

Let's turn the ``ascii-art`` npm package into a Debian package. For this example, we'll pick a specific version, 2.8.5::

  % fpm --debug -s npm -t deb --depends nodejs [email protected]
  Created package {:path=>"node-ascii-art_2.8.5_amd64.deb"}

Fpm uses ``npm`` to download the correct package. Additionally, the package name is given a ``node-`` prefix because this is common in distribution packages to prefix a library with the platform name, such as ``python-foo`` or ``node-foo``.

It also parses the package's ``package.json`` to collect any useful data such as the package name, author, homepage, description, etc::

  % dpkg --field node-ascii-art_2.8.5_amd64.deb Package Version Vendor Homepage Description
  Package: node-ascii-art
  Version: 2.8.5
  Vendor: Abbey Hawk Sparrow <@khrome>
  Homepage: git://github.com/khrome/ascii-art.git
Let's install the package and try to use it::

  % sudo apt-get install ./node-ascii-art_2.8.5_amd64.deb

And now we can use this package::

  % ascii-art text -F Doom "Hello World"
   _   _        _  _          _    _               _      _
  | | | |      | || |        | |  | |             | |    | |
  | |_| |  ___ | || |  ___   | |  | |  ___   _ __ | |  __| |
  |  _  | / _ \| || | / _ \  | |/\| | / _ \ | '__|| | / _` |
  | | | ||  __/| || || (_) | \  /\  /| (_) || |   | || (_| |
  \_| |_/ \___||_||_| \___/   \/  \/  \___/ |_|   |_| \__,_|

Fpm asked ``npm`` where to install things using ``npm prefix -g``. On my system, this caused the package to install to ``/usr/local/lib/node_modules``. You can change the default prefix with the fpm ``--prefix`` flag or by changing the default global prefix in the ``npm`` tool.

Let's try to invoke ``ascii-art`` from node::

  % export NODE_PATH=/usr/local/lib/node_modules
  % node
  > let art = require("ascii-art")
  > art.font("Hello", "Doom", (err, rendered) => console.log(rendered))
   _   _        _  _
  | | | |      | || |
  | |_| |  ___ | || |  ___
  |  _  | / _ \| || | / _ \
  | | | ||  __/| || || (_) |
  \_| |_/ \___||_||_| \___/

Nice :)

Fun Examples
------------

.. note::
  Do you have any examples you want to share that use the ``npm`` package type? Share your knowledge here: https://github.com/jordansissel/fpm/issues/new

npm-specific command line flags
-------------------------------

.. include:: cli/npm.rst

---

### Packages Osxpkg (`docs/packages/osxpkg.rst`)

osxpkg - Apple macOS and OSX packages
=====================================

Supported Uses in FPM
---------------------

fpm supports input and output for Apple's package files. These files typically
end in ".pkg". This means you can read a ``.pkg`` file and convert it to a different
output type (such as a `dir` or `rpm`). It also means you can create a ``.pkg``
package file.

osxpkg-specific command line flags
----------------------------------

.. include:: cli/osxpkg.rst

---

### Packages P5p (`docs/packages/p5p.rst`)

p5p - Oracle Solaris 11 p5p packages
====================================

This package format for the Solaris Image Packaging System (IPS) and should be
useful for OpenSolaris, Solaris 11, and Illumos.

Supported Uses in FPM
---------------------

fpm supports using ``p5p`` only as an output type. This means you can create ``p5p`` packages from input types like ``deb``, ``dir``, or ``npm``

p5p-specific command line flags
-------------------------------

.. include:: cli/p5p.rst

---

### Packages Pacman (`docs/packages/pacman.rst`)

pacman - Arch Linux package format
==================================

Supported Uses in FPM
---------------------

fpm supports input and output for Arch Linux's package format, pacman. This means you can read a pacman and convert it to a different output type (such as a `dir` or `rpm`). It also means you can create a pacman package.

pacman-specific command line flags
----------------------------------

.. include:: cli/pacman.rst

---

### Packages Pear (`docs/packages/pear.rst`)

pear - PHP PEAR Packages
========================

Supported Uses in FPM
---------------------

fpm supports using ``pear`` only as an input type. This means you can convert
``pear`` input packages to output packages like ``deb``, ``rpm``, and more.

pear-specific command line flags
--------------------------------

.. include:: cli/pear.rst

---

### Packages Pkgin (`docs/packages/pkgin.rst`)

pkgin - NetBSD's pkgsrc binary packages
=======================================

Supported Uses in FPM
---------------------

fpm supports using ``pkgin`` only as an output type. This means you can create ``pkgin`` packages from input types like ``deb``, ``dir``, or ``npm``

pkgin-specific command line flags
---------------------------------

.. include:: cli/pkgin.rst

---

### Packages Pleaserun (`docs/packages/pleaserun.rst`)

pleaserun - Pleaserun services
==============================

Pleaserun helps generate service definitions for a variety of service manangers
such as systemd and sysv.

When used as an input, fpm will generate a package that include multiple service
definitions, one for each type (systemd, sysv, etc). At package installation, the package
will attempt to detect the best service manager used on the system and will
install only that definition.

You can learn more on the project website: https://github.com/jordansissel/pleaserun#readme

Supported Uses in FPM
---------------------

fpm supports using ``pleaserun`` only as an input type. This means you can convert
``pleaserun`` input packages to output packages like ``deb``, ``rpm``, and more.

pleaserun-specific command line flags
-------------------------------------

.. include:: cli/pleaserun.rst

---

### Packages Puppet (`docs/packages/puppet.rst`)

puppet - Puppet Manifests (deprecated)
======================================

Note: This package type hasn't been maintained since 2012 and generates puppet
manifests that target Puppet 2.4 or 3.x.

Supported Uses in FPM
---------------------

fpm supports using ``puppet`` only as an output type. This means you can create ``puppet`` packages from input types like ``deb``, ``dir``, or ``npm``

puppet-specific command line flags
----------------------------------

.. include:: cli/puppet.rst

---

### Packages Python (`docs/packages/python.rst`)

python - Python packages, PyPI, etc
===================================

Supported Uses in FPM
---------------------

fpm supports using ``python`` only as an input type. This means you can convert
``python`` input packages to output packages like ``deb``, ``rpm``, and more.

python-specific command line flags
----------------------------------

.. include:: cli/python.rst

---

### Packages Rpm (`docs/packages/rpm.rst`)

rpm - RedHat Package Manager
============================

rpm is the package format used on RedHat Enterprise (RHEL), Fedora, CentOS, and
a number of other Linux distributions.
 
You may be familiar with tools such as `dnf` and `yum` for installing packages from repositories. The package files that these tools install are rpms.

Supported Uses in FPM
---------------------

fpm supports input and output for rpms. This means you can read an rpm and convert it to a different output type (such as a `dir` or `deb`). It also means you can write an rpm.

Arguments when used as input type
---------------------------------

For the sample command reading an rpm as input and outputting a debian package::

	fpm -s rpm -t deb file.rpm

The the argument is used as a file and read as an rpm.

Sample Usage
------------

Create a package with no files but having dependencies::

	% fpm -s empty -t rpm -n example --depends nginx
	Created package {:path=>"example-1.0-1.x86_64.rpm"}

We can now inspect the package with rpm's tools if you wish::

	% rpm -qp example-1.0-1.x86_64.rpm -i
	Name        : example
	Version     : 1.0
	Release     : 1
	Architecture: x86_64
	Install Date: (not installed)
	Group       : default
	Size        : 0
	License     : unknown
	Signature   : (none)
	Source RPM  : example-1.0-1.src.rpm
	Build Date  : Wed 20 Oct 2021 09:43:25 PM PDT
	Build Host  : snickerdoodle.localdomain
	Relocations : /
	Packager    : <jls@snickerdoodle>
	Vendor      : none
	URL         : http://example.com/no-uri-given
	Summary     : no description given
	Description :
	no description given

Fun Examples
------------

Changing an existing RPM
~~~~~~~~~~~~~~~~~~~~~~~~

fpm supports rpm as both an input and output type (`-s` and `-t` flags), so you can use this to modify an existing rpm.

For example, let's create an rpm to use for our example::

  % fpm -s empty -t rpm -n example
  Created package {:path=>"example-1.0-1.x86_64.rpm"}

Lets say we made a mistake and want to rename the package::

  % fpm -s rpm -t rpm -n newname example-1.0-1.x86_64.rpm
  Created package {:path=>"newname-1.0-1.x86_64.rpm"}

And maybe the architecture is wrong. fpm defaulted to x86_64 (what fpm calls
"native"), and we really want what rpm calls "noarch"::

  % fpm -s rpm -t rpm -a noarch newname-1.0-1.x86_64.rpm
  Created package {:path=>"newname-1.0-1.noarch.rpm"}

RPM-specific command line flags
-------------------------------

.. include:: cli/rpm.rst

---

### Packages Sh (`docs/packages/sh.rst`)

sh - Self-managing shell archive
================================

The 'sh' output in fpm will generate a shell script that is, itself, an archive.

The resulting shell script will install the files you provided. You can run the
resulting shell script to see more helpful information.

  # Create an example.sh package
  % fpm -s empty -t sh -n example

  # Get help.
  % ./example.sh -h


Supported Uses in FPM
---------------------

fpm supports using ``sh`` only as an output type. This means you can create ``sh`` packages from input types like ``deb``, ``dir``, or ``npm``

sh-specific command line flags
-------------------------------

.. include:: cli/sh.rst

---

### Packages Snap (`docs/packages/snap.rst`)

snap - Application package files for Linux
==========================================

You can learn more about ``snap`` itself by visiting the website: https://snapcraft.io/about


Supported Uses in FPM
---------------------

fpm supports input and output for snap packages. This means you can read a snap and convert it to a different output type (such as a `dir` or `rpm`). It also means you can create a snap package.

snap-specific command line flags
--------------------------------

.. include:: cli/snap.rst

---

### Packages Solaris (`docs/packages/solaris.rst`)

solaris - Solaris SRV4 package format
=====================================

This package format is typically used in older Solaris versions (Solaris 7, 8,
9, and 10). You may also know them by files with a SUNW prefix and may have file names that end in ".pkg".

If you're using Solaris 11, OpenSolaris, or Illumos, you might want to use `the newer package format, p5p`_. 

.. _the newer package format, p5p: /packages/p5p.html

Supported Uses in FPM
---------------------

fpm supports using ``solaris`` only as an output type. This means you can create ``solaris`` packages from input types like ``deb``, ``dir``, or ``npm``

solaris-specific command line flags
-----------------------------------

.. include:: cli/solaris.rst

---

### Packages Tar (`docs/packages/tar.rst`)

tar - Tape archives aka "tar" files
===================================

Supported Uses in FPM
---------------------

fpm supports input and output for NAME (tar). This means you can read a tar and convert it to a different output type (such as a `dir` or `rpm`). It also means you can create a tar package.

tar-specific command line flags
-------------------------------

.. include:: cli/tar.rst

---

### Packages Virtualenv (`docs/packages/virtualenv.rst`)

virtualenv - Python virtualenv
==============================

Supported Uses in FPM
---------------------

fpm supports using ``virtualenv`` only as an input type. This means you can convert
``virtualenv`` input packages to output packages like ``deb``, ``rpm``, and more.

virtualenv-specific command line flags
--------------------------------------

.. include:: cli/virtualenv.rst

---

### Packages Zip (`docs/packages/zip.rst`)

zip - Zip files
===============

Supported Uses in FPM
---------------------

fpm supports input and output for zip files. This means you can read a zip and convert it to a different output type (such as a `dir` or `rpm`). It also means you can create a zip package.

zip-specific command line flags
-------------------------------

.. include:: cli/zip.rst

---

### Packages Cli Cpan (`docs/packages/cli/cpan.rst`)

* ``--cpan-cpanm-bin CPANM_EXECUTABLE``
    - The path to the cpanm executable you wish to run.
* ``--[no-]cpan-cpanm-force``
    - Pass the --force parameter to cpanm
* ``--cpan-mirror CPAN_MIRROR``
    - The CPAN mirror to use instead of the default.
* ``--[no-]cpan-mirror-only``
    - Only use the specified mirror for metadata.
* ``--cpan-package-name-prefix NAME_PREFIX``
    - Name to prefix the package name with.
* ``--cpan-perl-bin PERL_EXECUTABLE``
    - The path to the perl executable you wish to run.
* ``--cpan-perl-lib-path PERL_LIB_PATH``
    - Path of target Perl Libraries
* ``--[no-]cpan-sandbox-non-core``
    - Sandbox all non-core modules, even if they're already installed
* ``--[no-]cpan-test``
    - Run the tests before packaging?
* ``--[no-]cpan-verbose``
    - Produce verbose output from cpanm?

---

### Packages Cli Deb (`docs/packages/cli/deb.rst`)

* ``--deb-activate EVENT``
    - Package activates EVENT trigger
* ``--deb-activate-noawait EVENT``
    - Package activates EVENT trigger
* ``--deb-after-purge FILE``
    - A script to be run after package removal to purge remaining (config) files (a.k.a. postrm purge within apt-get purge)
* ``--[no-]deb-auto-config-files``
    - Init script and default configuration files will be labeled as configuration files for Debian packages.
* ``--deb-build-depends DEPENDENCY``
    - Add DEPENDENCY as a Build-Depends
* ``--deb-changelog FILEPATH``
    - Add FILEPATH as debian changelog
* ``--deb-compression COMPRESSION``
    - The compression type to use, must be one of gz, bzip2, xz, zst, none.
* ``--deb-compression-level [0-9]``
    - Select a compression level. 0 is none or minimal. 9 is max compression.
* ``--deb-config SCRIPTPATH``
    - Add SCRIPTPATH as debconf config file.
* ``--deb-custom-control FILEPATH``
    - Custom version of the Debian control file.
* ``--deb-default FILEPATH``
    - Add FILEPATH as /etc/default configuration
* ``--deb-dist DIST-TAG``
    - Set the deb distribution.
* ``--deb-field 'FIELD: VALUE'``
    - Add custom field to the control file
* ``--[no-]deb-generate-changes``
    - Generate PACKAGENAME.changes file.
* ``--deb-group GROUP``
    - The group owner of files in this package
* ``--[no-]deb-ignore-iteration-in-dependencies``
    - For '=' (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted
* ``--deb-init FILEPATH``
    - Add FILEPATH as an init script
* ``--deb-installed-size KILOBYTES``
    - The installed size, in kilobytes. If omitted, this will be calculated automatically
* ``--deb-interest EVENT``
    - Package is interested in EVENT trigger
* ``--deb-interest-noawait EVENT``
    - Package is interested in EVENT trigger without awaiting
* ``--[no-]deb-maintainerscripts-force-errorchecks``
    - Activate errexit shell option according to lintian. https://lintian.debian.org/tags/maintainer-script-ignores-errors.html
* ``--deb-meta-file FILEPATH``
    - Add FILEPATH to DEBIAN directory
* ``--[no-]deb-no-default-config-files``
    - Do not add all files in /etc as configuration files by default for Debian packages.
* ``--deb-pre-depends DEPENDENCY``
    - Add DEPENDENCY as a Pre-Depends
* ``--deb-priority PRIORITY``
    - The debian package 'priority' value.
* ``--deb-recommends PACKAGE``
    - Add PACKAGE to Recommends
* ``--deb-shlibs SHLIBS``
    - Include control/shlibs content. This flag expects a string that is used as the contents of the shlibs file. See the following url for a description of this file and its format: http://www.debian.org/doc/debian-policy/ch-sharedlibs.html#s-shlibs
* ``--deb-suggests PACKAGE``
    - Add PACKAGE to Suggests
* ``--deb-systemd FILEPATH``
    - Add FILEPATH as a systemd script
* ``--[no-]deb-systemd-auto-start``
    - Start service after install or upgrade
* ``--[no-]deb-systemd-enable``
    - Enable service on install or upgrade
* ``--deb-systemd-path FILEPATH``
    - Relative path to the systemd service directory
* ``--[no-]deb-systemd-restart-after-upgrade``
    - Restart service after upgrade
* ``--deb-templates FILEPATH``
    - Add FILEPATH as debconf templates file.
* ``--deb-upstart FILEPATH``
    - Add FILEPATH as an upstart script
* ``--deb-upstream-changelog FILEPATH``
    - Add FILEPATH as upstream changelog
* ``--[no-]deb-use-file-permissions``
    - Use existing file permissions when defining ownership and modes
* ``--deb-user USER``
    - The owner of files in this package

---

### Packages Cli Freebsd (`docs/packages/cli/freebsd.rst`)

* ``--freebsd-origin ABI``
    - Sets the FreeBSD 'origin' pkg field
* ``--freebsd-osversion VERSION``
    - Sets the FreeBSD 'version' pkg field, ie 12 or 13, use '*' for all.

---

### Packages Cli Gem (`docs/packages/cli/gem.rst`)

* ``--gem-bin-path DIRECTORY``
    - The directory to install gem executables
* ``--gem-disable-dependency gem_name``
    - The gem name to remove from dependency list
* ``--[no-]gem-embed-dependencies``
    - Should the gem dependencies be installed?
* ``--[no-]gem-env-shebang``
    - Should the target package have the shebang rewritten to use env?
* ``--[no-]gem-fix-dependencies``
    - Should the package dependencies be prefixed?
* ``--[no-]gem-fix-name``
    - Should the target package name be prefixed?
* ``--gem-gem PATH_TO_GEM``
    - The path to the 'gem' tool (defaults to 'gem' and searches your $PATH)
* ``--gem-git-branch GIT_BRANCH``
    - When using a git repo as the source of the gem instead of rubygems.org, use this git branch.
* ``--gem-git-repo GIT_REPO``
    - Use this git repo address as the source of the gem instead of rubygems.org.
* ``--gem-package-name-prefix PREFIX``
    - Name to prefix the package name with.
* ``--gem-package-prefix NAMEPREFIX``
    - (DEPRECATED, use --package-name-prefix) Name to prefix the package name with.
* ``--[no-]gem-prerelease``
    - Allow prerelease versions of a gem
* ``--gem-shebang SHEBANG``
    - Replace the shebang in the executables in the bin path with a custom string
* ``--gem-stagingdir STAGINGDIR``
    - The directory where fpm installs the gem temporarily before conversion. Normally a random subdirectory of workdir.
* ``--[no-]gem-version-bins``
    - Append the version to the bins

---

### Packages Cli Npm (`docs/packages/cli/npm.rst`)

* ``--npm-bin NPM_EXECUTABLE``
    - The path to the npm executable you wish to run.
* ``--npm-package-name-prefix PREFIX``
    - Name to prefix the package name with.
* ``--npm-registry NPM_REGISTRY``
    - The npm registry to use instead of the default.

---

### Packages Cli Osxpkg (`docs/packages/cli/osxpkg.rst`)

* ``--osxpkg-dont-obsolete DONT_OBSOLETE_PATH``
    - A file path for which to 'dont-obsolete' in the built PackageInfo. Can be specified multiple times.
* ``--osxpkg-identifier-prefix IDENTIFIER_PREFIX``
    - Reverse domain prefix prepended to package identifier, ie. 'org.great.my'. If this is omitted, the identifer will be the package name.
* ``--osxpkg-ownership OWNERSHIP``
    - --ownership option passed to pkgbuild. Defaults to 'recommended'. See pkgbuild(1).
* ``--[no-]osxpkg-payload-free``
    - Define no payload, assumes use of script options.
* ``--osxpkg-postinstall-action POSTINSTALL_ACTION``
    - Post-install action provided in package metadata. Optionally one of 'logout', 'restart', 'shutdown'.

---

### Packages Cli P5p (`docs/packages/cli/p5p.rst`)

* ``--p5p-group GROUP``
    - Set the group to GROUP in the prototype file.
* ``--[no-]p5p-lint``
    - Check manifest with pkglint
* ``--p5p-publisher PUBLISHER``
    - Set the publisher name for the repository
* ``--p5p-user USER``
    - Set the user to USER in the prototype files.
* ``--[no-]p5p-validate``
    - Validate with pkg install
* ``--p5p-zonetype ZONETYPE``
    - Set the allowed zone types (global, nonglobal, both)

---

### Packages Cli Pacman (`docs/packages/cli/pacman.rst`)

* ``--pacman-compression COMPRESSION``
    - The compression type to use, must be one of gz, bzip2, xz, zstd, none.
* ``--pacman-group GROUP``
    - The group owner of files in this package
* ``--pacman-optional-depends PACKAGE``
    - Add an optional dependency to the pacman package.
* ``--[no-]pacman-use-file-permissions``
    - Use existing file permissions when defining ownership and modes
* ``--pacman-user USER``
    - The owner of files in this package

---

### Packages Cli Pear (`docs/packages/cli/pear.rst`)

* ``--pear-bin-dir BIN_DIR``
    - Directory to put binaries in
* ``--pear-channel CHANNEL_URL``
    - The pear channel url to use instead of the default.
* ``--[no-]pear-channel-update``
    - call 'pear channel-update' prior to installation
* ``--pear-data-dir DATA_DIR``
    - Specify php dir relative to prefix if differs from pear default (pear/data)
* ``--pear-package-name-prefix PREFIX``
    - Name prefix for pear package
* ``--pear-php-bin PHP_BIN``
    - Specify php executable path if differs from the os used for packaging
* ``--pear-php-dir PHP_DIR``
    - Specify php dir relative to prefix if differs from pear default (pear/php)

---

### Packages Cli Pleaserun (`docs/packages/cli/pleaserun.rst`)

* ``--pleaserun-chdir CHDIR``
    - The working directory used by the service
* ``--pleaserun-name SERVICE_NAME``
    - The name of the service you are creating
* ``--pleaserun-user USER``
    - The user to use for executing this program.

---

### Packages Cli Python (`docs/packages/cli/python.rst`)

* ``--python-bin PYTHON_EXECUTABLE``
    - The path to the python executable you wish to run.
* ``--[no-]python-dependencies``
    - Include requirements defined by the python package as dependencies.
* ``--python-disable-dependency python_package_name``
    - The python package name to remove from dependency list
* ``--[no-]python-downcase-dependencies``
    - Should the package dependencies be in lowercase?
* ``--[no-]python-downcase-name``
    - Should the target package name be in lowercase?
* ``--python-easyinstall EASYINSTALL_EXECUTABLE``
    - The path to the easy_install executable tool
* ``--[no-]python-fix-dependencies``
    - Should the package dependencies be prefixed?
* ``--[no-]python-fix-name``
    - Should the target package name be prefixed?
* ``--python-install-bin BIN_PATH``
    - (DEPRECATED, does nothing) The path to where python scripts should be installed to.
* ``--python-install-data DATA_PATH``
    - (DEPRECATED, does nothing) The path to where data should be installed to. This is equivalent to 'python setup.py --install-data DATA_PATH
* ``--python-install-lib LIB_PATH``
    - (DEPRECATED, does nothing) The path to where python libs should be installed to (default depends on your python installation). Want to find out what your target platform is using? Run this: python -c 'from distutils.sysconfig import get_python_lib; print get_python_lib()'
* ``--[no-]python-internal-pip``
    - Use the pip module within python to install modules - aka 'python -m pip'. This is the recommended usage since Python 3.4 (2014) instead of invoking the 'pip' script
* ``--[no-]python-obey-requirements-txt``
    - Use a requirements.txt file in the top-level directory of the python package for dependency detection.
* ``--python-package-name-prefix PREFIX``
    - Name to prefix the package name with.
* ``--python-package-prefix NAMEPREFIX``
    - (DEPRECATED, use --package-name-prefix) Name to prefix the package name with.
* ``--python-pip PIP_EXECUTABLE``
    - The path to the pip executable tool. If not specified, easy_install is used instead
* ``--python-pypi PYPI_URL``
    - PyPi Server uri for retrieving packages.
* ``--python-scripts-executable PYTHON_EXECUTABLE``
    - (DEPRECATED) Set custom python interpreter in installing scripts. By default distutils will replace python interpreter in installing scripts (specified by shebang) with current python interpreter (sys.executable). This option is equivalent to appending 'build_scripts --executable PYTHON_EXECUTABLE' arguments to 'setup.py install' command.
* ``--python-setup-py-arguments setup_py_argument``
    - (DEPRECATED) Arbitrary argument(s) to be passed to setup.py
* ``--python-trusted-host PYPI_TRUSTED``
    - Mark this host or host:port pair as trusted for pip

---

### Packages Cli Rpm (`docs/packages/cli/rpm.rst`)

* ``--rpm-attr ATTRFILE``
    - Set the attribute for a file (%attr), e.g. --rpm-attr 750,user1,group1:/some/file
* ``--[no-]rpm-auto-add-directories``
    - Auto add directories not part of filesystem
* ``--rpm-auto-add-exclude-directories DIRECTORIES``
    - Additional directories ignored by '--rpm-auto-add-directories' flag
* ``--[no-]rpm-autoprov``
    - Enable RPM's AutoProv option
* ``--[no-]rpm-autoreq``
    - Enable RPM's AutoReq option
* ``--[no-]rpm-autoreqprov``
    - Enable RPM's AutoReqProv option
* ``--rpm-changelog FILEPATH``
    - Add changelog from FILEPATH contents
* ``--rpm-compression none|xz|xzmt|gzip|bzip2``
    - Select a compression method. gzip works on the most platforms.
* ``--rpm-compression-level [0-9]``
    - Select a compression level. 0 is store-only. 9 is max compression.
* ``--rpm-defattrdir ATTR``
    - Set the default dir mode (%defattr).
* ``--rpm-defattrfile ATTR``
    - Set the default file mode (%defattr).
* ``--rpm-digest md5|sha1|sha256|sha384|sha512``
    - Select a digest algorithm. md5 works on the most platforms.
* ``--rpm-dist DIST-TAG``
    - Set the rpm distribution.
* ``--rpm-filter-from-provides REGEX``
    - Set %filter_from_provides to the supplied REGEX.
* ``--rpm-filter-from-requires REGEX``
    - Set %filter_from_requires to the supplied REGEX.
* ``--rpm-group GROUP``
    - Set the group to GROUP in the %files section. Overrides the group when used with use-file-permissions setting.
* ``--[no-]rpm-ignore-iteration-in-dependencies``
    - For '=' (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted
* ``--rpm-init FILEPATH``
    - Add FILEPATH as an init script
* ``--[no-]rpm-macro-expansion``
    - install-time macro expansion in %pre %post %preun %postun scripts (see: https://rpm-software-management.github.io/rpm/manual/scriptlet_expansion.html)
* ``--[no-]rpm-old-perl-dependency-name``
    - Use older 'perl' depdency name. Newer Red Hat (and derivatives) use a dependency named 'perl-interpreter'.
* ``--rpm-os OS``
    - The operating system to target this rpm for. You want to set this to 'linux' if you are using fpm on OS X, for example
* ``--rpm-posttrans FILE``
    - posttrans script
* ``--rpm-pretrans FILE``
    - pretrans script
* ``--rpm-rpmbuild-define DEFINITION``
    - Pass a --define argument to rpmbuild.
* ``--[no-]rpm-sign``
    - Pass --sign to rpmbuild
* ``--rpm-summary SUMMARY``
    - Set the RPM summary. Overrides the first line on the description if set
* ``--rpm-tag TAG``
    - Adds a custom tag in the spec file as is. Example: --rpm-tag 'Requires(post): /usr/sbin/alternatives'
* ``--rpm-trigger-after-install '[OPT]PACKAGE: FILEPATH'``
    - Adds a rpm trigger script located in FILEPATH, having 'OPT' options and linking to 'PACKAGE'. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html
* ``--rpm-trigger-after-target-uninstall '[OPT]PACKAGE: FILEPATH'``
    - Adds a rpm trigger script located in FILEPATH, having 'OPT' options and linking to 'PACKAGE'. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html
* ``--rpm-trigger-before-install '[OPT]PACKAGE: FILEPATH'``
    - Adds a rpm trigger script located in FILEPATH, having 'OPT' options and linking to 'PACKAGE'. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html
* ``--rpm-trigger-before-uninstall '[OPT]PACKAGE: FILEPATH'``
    - Adds a rpm trigger script located in FILEPATH, having 'OPT' options and linking to 'PACKAGE'. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html
* ``--[no-]rpm-use-file-permissions``
    - Use existing file permissions when defining ownership and modes.
* ``--rpm-user USER``
    - Set the user to USER in the %files section. Overrides the user when used with use-file-permissions setting.
* ``--[no-]rpm-verbatim-gem-dependencies``
    - When converting from a gem, leave the old (fpm 0.4.x) style dependency names. This flag will use the old 'rubygem-foo' names in rpm requires instead of the redhat style rubygem(foo).
* ``--rpm-verifyscript FILE``
    - a script to be run on verification

---

### Packages Cli Snap (`docs/packages/cli/snap.rst`)

* ``--snap-confinement CONFINEMENT``
    - Type of confinement to use for this snap.
* ``--snap-grade GRADE``
    - Grade of this snap.
* ``--snap-yaml FILEPATH``
    - Custom version of the snap.yaml file.

---

### Packages Cli Solaris (`docs/packages/cli/solaris.rst`)

* ``--solaris-group GROUP``
    - Set the group to GROUP in the prototype file.
* ``--solaris-user USER``
    - Set the user to USER in the prototype files.

---

### Packages Cli Virtualenv (`docs/packages/cli/virtualenv.rst`)

* ``--virtualenv-find-links PIP_FIND_LINKS``
    - If a url or path to an html file, then parse for links to archives. If a local path or file:// url that's a directory, then look for archives in the directory listing.
* ``--[no-]virtualenv-fix-name``
    - Should the target package name be prefixed?
* ``--virtualenv-install-location DIRECTORY``
    - DEPRECATED: Use --prefix instead.  Location to which to install the virtualenv by default.
* ``--virtualenv-other-files-dir DIRECTORY``
    - Optionally, the contents of the specified directory may be added to the package. This is useful if the virtualenv needs configuration files, etc.
* ``--virtualenv-package-name-prefix PREFIX``
    - Name to prefix the package name with.
* ``--virtualenv-pypi PYPI_URL``
    - PyPi Server uri for retrieving packages.
* ``--virtualenv-pypi-extra-url PYPI_EXTRA_URL``
    - PyPi extra-index-url for pointing to your priviate PyPi
* ``--[no-]virtualenv-setup-install``
    - After building virtualenv run setup.py install useful when building a virtualenv for packages and including their requirements from requirements.txt
* ``--[no-]virtualenv-system-site-packages``
    - Give the virtual environment access to the global site-packages

---

--- METRICS ---
- Files Extracted: 47
- Estimated Token Budget: ~30434 tokens
- Canonical Reference: https://codewiki.google/github.com/jordansissel/fpm