diff --git a/docs/cli-reference.rst b/docs/cli-reference.rst index 744bfe9b2..4d9b98a16 100644 --- a/docs/cli-reference.rst +++ b/docs/cli-reference.rst @@ -84,144 +84,6 @@ General Options * ``--conflicts CONFLICTS`` - Other packages/versions this package conflicts with. This flag can be specified multiple times. -* ``--cpan-cpanm-bin CPANM_EXECUTABLE`` - - (cpan only) The path to the cpanm executable you wish to run. - -* ``--[no-]cpan-cpanm-force`` - - (cpan only) Pass the --force parameter to cpanm - -* ``--cpan-mirror CPAN_MIRROR`` - - (cpan only) The CPAN mirror to use instead of the default. - -* ``--[no-]cpan-mirror-only`` - - (cpan only) Only use the specified mirror for metadata. - -* ``--cpan-package-name-prefix NAME_PREFIX`` - - (cpan only) Name to prefix the package name with. - -* ``--cpan-perl-bin PERL_EXECUTABLE`` - - (cpan only) The path to the perl executable you wish to run. - -* ``--cpan-perl-lib-path PERL_LIB_PATH`` - - (cpan only) Path of target Perl Libraries - -* ``--[no-]cpan-sandbox-non-core`` - - (cpan only) Sandbox all non-core modules, even if they're already installed - -* ``--[no-]cpan-test`` - - (cpan only) Run the tests before packaging? - -* ``--[no-]cpan-verbose`` - - (cpan only) Produce verbose output from cpanm? - -* ``--deb-activate EVENT`` - - (deb only) Package activates EVENT trigger - -* ``--deb-activate-noawait EVENT`` - - (deb only) Package activates EVENT trigger - -* ``--deb-after-purge FILE`` - - (deb only) 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`` - - (deb only) Init script and default configuration files will be labeled as configuration files for Debian packages. - -* ``--deb-build-depends DEPENDENCY`` - - (deb only) Add DEPENDENCY as a Build-Depends - -* ``--deb-changelog FILEPATH`` - - (deb only) Add FILEPATH as debian changelog - -* ``--deb-compression COMPRESSION`` - - (deb only) The compression type to use, must be one of gz, bzip2, xz, none. - -* ``--deb-config SCRIPTPATH`` - - (deb only) Add SCRIPTPATH as debconf config file. - -* ``--deb-custom-control FILEPATH`` - - (deb only) Custom version of the Debian control file. - -* ``--deb-default FILEPATH`` - - (deb only) Add FILEPATH as /etc/default configuration - -* ``--deb-dist DIST-TAG`` - - (deb only) Set the deb distribution. - -* ``--deb-field 'FIELD: VALUE'`` - - (deb only) Add custom field to the control file - -* ``--[no-]deb-generate-changes`` - - (deb only) Generate PACKAGENAME.changes file. - -* ``--deb-group GROUP`` - - (deb only) The group owner of files in this package - -* ``--[no-]deb-ignore-iteration-in-dependencies`` - - (deb only) 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`` - - (deb only) Add FILEPATH as an init script - -* ``--deb-installed-size KILOBYTES`` - - (deb only) The installed size, in kilobytes. If omitted, this will be calculated automatically - -* ``--deb-interest EVENT`` - - (deb only) Package is interested in EVENT trigger - -* ``--deb-interest-noawait EVENT`` - - (deb only) Package is interested in EVENT trigger without awaiting - -* ``--[no-]deb-maintainerscripts-force-errorchecks`` - - (deb only) Activate errexit shell option according to lintian. https://lintian.debian.org/tags/maintainer-script-ignores-errors.html - -* ``--deb-meta-file FILEPATH`` - - (deb only) Add FILEPATH to DEBIAN directory - -* ``--[no-]deb-no-default-config-files`` - - (deb only) Do not add all files in /etc as configuration files by default for Debian packages. - -* ``--deb-pre-depends DEPENDENCY`` - - (deb only) Add DEPENDENCY as a Pre-Depends - -* ``--deb-priority PRIORITY`` - - (deb only) The debian package 'priority' value. - -* ``--deb-recommends PACKAGE`` - - (deb only) Add PACKAGE to Recommends - -* ``--deb-shlibs SHLIBS`` - - (deb only) 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`` - - (deb only) Add PACKAGE to Suggests - -* ``--deb-systemd FILEPATH`` - - (deb only) Add FILEPATH as a systemd script - -* ``--[no-]deb-systemd-auto-start`` - - (deb only) Start service after install or upgrade - -* ``--[no-]deb-systemd-enable`` - - (deb only) Enable service on install or upgrade - -* ``--[no-]deb-systemd-restart-after-upgrade`` - - (deb only) Restart service after upgrade - -* ``--deb-templates FILEPATH`` - - (deb only) Add FILEPATH as debconf templates file. - -* ``--deb-upstart FILEPATH`` - - (deb only) Add FILEPATH as an upstart script - -* ``--deb-upstream-changelog FILEPATH`` - - (deb only) Add FILEPATH as upstream changelog - -* ``--[no-]deb-use-file-permissions`` - - (deb only) Use existing file permissions when defining ownership and modes - -* ``--deb-user USER`` - - (deb only) The owner of files in this package - * ``--debug`` - Enable debug output @@ -243,54 +105,6 @@ General Options * ``--fpm-options-file FPM_OPTIONS_FILE`` - A file that contains additional fpm options. Any fpm flag format is valid in this file. This can be useful on build servers where you want to use a common configuration or inject other parameters from a file instead of from a command-line flag.. -* ``--freebsd-origin ABI`` - - (freebsd only) Sets the FreeBSD 'origin' pkg field - -* ``--gem-bin-path DIRECTORY`` - - (gem only) The directory to install gem executables - -* ``--gem-disable-dependency gem_name`` - - (gem only) The gem name to remove from dependency list - -* ``--[no-]gem-embed-dependencies`` - - (gem only) Should the gem dependencies be installed? - -* ``--[no-]gem-env-shebang`` - - (gem only) Should the target package have the shebang rewritten to use env? - -* ``--[no-]gem-fix-dependencies`` - - (gem only) Should the package dependencies be prefixed? - -* ``--[no-]gem-fix-name`` - - (gem only) Should the target package name be prefixed? - -* ``--gem-gem PATH_TO_GEM`` - - (gem only) The path to the 'gem' tool (defaults to 'gem' and searches your $PATH) - -* ``--gem-git-branch GIT_BRANCH`` - - (gem only) When using a git repo as the source of the gem instead of rubygems.org, use this git branch. - -* ``--gem-git-repo GIT_REPO`` - - (gem only) Use this git repo address as the source of the gem instead of rubygems.org. - -* ``--gem-package-name-prefix PREFIX`` - - (gem only) Name to prefix the package name with. - -* ``--gem-package-prefix NAMEPREFIX`` - - (gem only) (DEPRECATED, use --package-name-prefix) Name to prefix the package name with. - -* ``--[no-]gem-prerelease`` - - (gem only) Allow prerelease versions of a gem - -* ``--gem-shebang SHEBANG`` - - (gem only) Replace the shebang in the executables in the bin path with a custom string - -* ``--gem-stagingdir STAGINGDIR`` - - (gem only) The directory where fpm installs the gem temporarily before conversion. Normally a random subdirectory of workdir. - -* ``--[no-]gem-version-bins`` - - (gem only) Append the version to the bins - * ``--inputs INPUTS_PATH`` - The path to a file containing a newline-separated list of files and dirs to use as input. @@ -309,93 +123,6 @@ General Options * ``--no-depends`` - Do not list any dependencies in this package -* ``--npm-bin NPM_EXECUTABLE`` - - (npm only) The path to the npm executable you wish to run. - -* ``--npm-package-name-prefix PREFIX`` - - (npm only) Name to prefix the package name with. - -* ``--npm-registry NPM_REGISTRY`` - - (npm only) The npm registry to use instead of the default. - -* ``--osxpkg-dont-obsolete DONT_OBSOLETE_PATH`` - - (osxpkg only) A file path for which to 'dont-obsolete' in the built PackageInfo. Can be specified multiple times. - -* ``--osxpkg-identifier-prefix IDENTIFIER_PREFIX`` - - (osxpkg only) 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`` - - (osxpkg only) --ownership option passed to pkgbuild. Defaults to 'recommended'. See pkgbuild(1). - -* ``--[no-]osxpkg-payload-free`` - - (osxpkg only) Define no payload, assumes use of script options. - -* ``--osxpkg-postinstall-action POSTINSTALL_ACTION`` - - (osxpkg only) Post-install action provided in package metadata. Optionally one of 'logout', 'restart', 'shutdown'. - -* ``--p5p-group GROUP`` - - (p5p only) Set the group to GROUP in the prototype file. - -* ``--[no-]p5p-lint`` - - (p5p only) Check manifest with pkglint - -* ``--p5p-publisher PUBLISHER`` - - (p5p only) Set the publisher name for the repository - -* ``--p5p-user USER`` - - (p5p only) Set the user to USER in the prototype files. - -* ``--[no-]p5p-validate`` - - (p5p only) Validate with pkg install - -* ``--p5p-zonetype ZONETYPE`` - - (p5p only) Set the allowed zone types (global, nonglobal, both) - -* ``--pacman-compression COMPRESSION`` - - (pacman only) The compression type to use, must be one of gz, bzip2, xz, zstd, none. - -* ``--pacman-group GROUP`` - - (pacman only) The group owner of files in this package - -* ``--pacman-optional-depends PACKAGE`` - - (pacman only) Add an optional dependency to the pacman package. - -* ``--[no-]pacman-use-file-permissions`` - - (pacman only) Use existing file permissions when defining ownership and modes - -* ``--pacman-user USER`` - - (pacman only) The owner of files in this package - -* ``--pear-bin-dir BIN_DIR`` - - (pear only) Directory to put binaries in - -* ``--pear-channel CHANNEL_URL`` - - (pear only) The pear channel url to use instead of the default. - -* ``--[no-]pear-channel-update`` - - (pear only) call 'pear channel-update' prior to installation - -* ``--pear-data-dir DATA_DIR`` - - (pear only) Specify php dir relative to prefix if differs from pear default (pear/data) - -* ``--pear-package-name-prefix PREFIX`` - - (pear only) Name prefix for pear package - -* ``--pear-php-bin PHP_BIN`` - - (pear only) Specify php executable path if differs from the os used for packaging - -* ``--pear-php-dir PHP_DIR`` - - (pear only) Specify php dir relative to prefix if differs from pear default (pear/php) - -* ``--pleaserun-chdir CHDIR`` - - (pleaserun only) The working directory used by the service - -* ``--pleaserun-name SERVICE_NAME`` - - (pleaserun only) The name of the service you are creating - -* ``--pleaserun-user USER`` - - (pleaserun only) The user to use for executing this program. - * ``--post-install FILE`` - (DEPRECATED, use --after-install) A script to be run after package installation @@ -414,186 +141,9 @@ General Options * ``--provides PROVIDES`` - What this package provides (usually a name). This flag can be specified multiple times. -* ``--python-bin PYTHON_EXECUTABLE`` - - (python only) The path to the python executable you wish to run. - -* ``--[no-]python-dependencies`` - - (python only) Include requirements defined in setup.py as dependencies. - -* ``--python-disable-dependency python_package_name`` - - (python only) The python package name to remove from dependency list - -* ``--[no-]python-downcase-dependencies`` - - (python only) Should the package dependencies be in lowercase? - -* ``--[no-]python-downcase-name`` - - (python only) Should the target package name be in lowercase? - -* ``--python-easyinstall EASYINSTALL_EXECUTABLE`` - - (python only) The path to the easy_install executable tool - -* ``--[no-]python-fix-dependencies`` - - (python only) Should the package dependencies be prefixed? - -* ``--[no-]python-fix-name`` - - (python only) Should the target package name be prefixed? - -* ``--python-install-bin BIN_PATH`` - - (python only) The path to where python scripts should be installed to. - -* ``--python-install-data DATA_PATH`` - - (python only) 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`` - - (python only) 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`` - - (python only) 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`` - - (python only) Use a requirements.txt file in the top-level directory of the python package for dependency detection. - -* ``--python-package-name-prefix PREFIX`` - - (python only) Name to prefix the package name with. - -* ``--python-package-prefix NAMEPREFIX`` - - (python only) (DEPRECATED, use --package-name-prefix) Name to prefix the package name with. - -* ``--python-pip PIP_EXECUTABLE`` - - (python only) The path to the pip executable tool. If not specified, easy_install is used instead - -* ``--python-pypi PYPI_URL`` - - (python only) PyPi Server uri for retrieving packages. - -* ``--python-scripts-executable PYTHON_EXECUTABLE`` - - (python only) 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`` - - (python only) Arbitrary argument(s) to be passed to setup.py - -* ``--python-trusted-host PYPI_TRUSTED`` - - (python only) Mark this host or host:port pair as trusted for pip - * ``--replaces REPLACES`` - Other packages/versions this package replaces. Equivalent of rpm's 'Obsoletes'. This flag can be specified multiple times. -* ``--rpm-attr ATTRFILE`` - - (rpm only) Set the attribute for a file (%attr), e.g. --rpm-attr 750,user1,group1:/some/file - -* ``--[no-]rpm-auto-add-directories`` - - (rpm only) Auto add directories not part of filesystem - -* ``--rpm-auto-add-exclude-directories DIRECTORIES`` - - (rpm only) Additional directories ignored by '--rpm-auto-add-directories' flag - -* ``--[no-]rpm-autoprov`` - - (rpm only) Enable RPM's AutoProv option - -* ``--[no-]rpm-autoreq`` - - (rpm only) Enable RPM's AutoReq option - -* ``--[no-]rpm-autoreqprov`` - - (rpm only) Enable RPM's AutoReqProv option - -* ``--rpm-changelog FILEPATH`` - - (rpm only) Add changelog from FILEPATH contents - -* ``--rpm-compression none|xz|xzmt|gzip|bzip2`` - - (rpm only) Select a compression method. gzip works on the most platforms. - -* ``--rpm-compression-level [0-9]`` - - (rpm only) Select a compression level. 0 is store-only. 9 is max compression. - -* ``--rpm-defattrdir ATTR`` - - (rpm only) Set the default dir mode (%defattr). - -* ``--rpm-defattrfile ATTR`` - - (rpm only) Set the default file mode (%defattr). - -* ``--rpm-digest md5|sha1|sha256|sha384|sha512`` - - (rpm only) Select a digest algorithm. md5 works on the most platforms. - -* ``--rpm-dist DIST-TAG`` - - (rpm only) Set the rpm distribution. - -* ``--rpm-filter-from-provides REGEX`` - - (rpm only) Set %filter_from_provides to the supplied REGEX. - -* ``--rpm-filter-from-requires REGEX`` - - (rpm only) Set %filter_from_requires to the supplied REGEX. - -* ``--rpm-group GROUP`` - - (rpm only) 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`` - - (rpm only) 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`` - - (rpm only) Add FILEPATH as an init script - -* ``--[no-]rpm-macro-expansion`` - - (rpm only) install-time macro expansion in %pre %post %preun %postun scripts (see: https://rpm.org/user_doc/scriptlet_expansion.html) - -* ``--rpm-os OS`` - - (rpm only) 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`` - - (rpm only) posttrans script - -* ``--rpm-pretrans FILE`` - - (rpm only) pretrans script - -* ``--rpm-rpmbuild-define DEFINITION`` - - (rpm only) Pass a --define argument to rpmbuild. - -* ``--[no-]rpm-sign`` - - (rpm only) Pass --sign to rpmbuild - -* ``--rpm-summary SUMMARY`` - - (rpm only) Set the RPM summary. Overrides the first line on the description if set - -* ``--rpm-tag TAG`` - - (rpm only) 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'`` - - (rpm only) 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: http://rpm.org/api/4.4.2.2/triggers.html - -* ``--rpm-trigger-after-target-uninstall '[OPT]PACKAGE: FILEPATH'`` - - (rpm only) 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: http://rpm.org/api/4.4.2.2/triggers.html - -* ``--rpm-trigger-before-install '[OPT]PACKAGE: FILEPATH'`` - - (rpm only) 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: http://rpm.org/api/4.4.2.2/triggers.html - -* ``--rpm-trigger-before-uninstall '[OPT]PACKAGE: FILEPATH'`` - - (rpm only) 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: http://rpm.org/api/4.4.2.2/triggers.html - -* ``--[no-]rpm-use-file-permissions`` - - (rpm only) Use existing file permissions when defining ownership and modes. - -* ``--rpm-user USER`` - - (rpm only) Set the user to USER in the %files section. Overrides the user when used with use-file-permissions setting. - -* ``--[no-]rpm-verbatim-gem-dependencies`` - - (rpm only) 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`` - - (rpm only) a script to be run on verification - -* ``--snap-confinement CONFINEMENT`` - - (snap only) Type of confinement to use for this snap. - -* ``--snap-grade GRADE`` - - (snap only) Grade of this snap. - -* ``--snap-yaml FILEPATH`` - - (snap only) Custom version of the snap.yaml file. - -* ``--solaris-group GROUP`` - - (solaris only) Set the group to GROUP in the prototype file. - -* ``--solaris-user USER`` - - (solaris only) Set the user to USER in the prototype files. - * ``--source-date-epoch-default SOURCE_DATE_EPOCH_DEFAULT`` - If no release date otherwise specified, use this value as timestamp on generated files to reduce nondeterminism. Reproducible build environments such as dpkg-dev and rpmbuild set this via envionment variable SOURCE_DATE_EPOCH variable to the integer unix timestamp to use in generated archives, and expect tools like fpm to use it as a hint to avoid nondeterministic output. This is a Unix timestamp, i.e. number of seconds since 1 Jan 1970 UTC. See https://reproducible-builds.org/specs/source-date-epoch @@ -615,33 +165,6 @@ General Options * ``--verbose`` - Enable verbose output -* ``--virtualenv-find-links PIP_FIND_LINKS`` - - (virtualenv only) 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`` - - (virtualenv only) Should the target package name be prefixed? - -* ``--virtualenv-install-location DIRECTORY`` - - (virtualenv only) DEPRECATED: Use --prefix instead. Location to which to install the virtualenv by default. - -* ``--virtualenv-other-files-dir DIRECTORY`` - - (virtualenv only) 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`` - - (virtualenv only) Name to prefix the package name with. - -* ``--virtualenv-pypi PYPI_URL`` - - (virtualenv only) PyPi Server uri for retrieving packages. - -* ``--virtualenv-pypi-extra-url PYPI_EXTRA_URL`` - - (virtualenv only) PyPi extra-index-url for pointing to your priviate PyPi - -* ``--[no-]virtualenv-setup-install`` - - (virtualenv only) After building virtualenv run setup.py install useful when building a virtualenv for packages and including their requirements from - -* ``--[no-]virtualenv-system-site-packages`` - - (virtualenv only) Give the virtual environment access to the global site-packages - * ``--workdir WORKDIR`` - The directory you want fpm to do its work in, where 'work' is any file copying, downloading, etc. Roughly any scratch space fpm needs to build your package.