diff --git a/docs/Makefile b/docs/Makefile index fd1af15a..d07b991d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -23,12 +23,12 @@ cli-reference.rst: ../lib/fpm/package/*.rb ../lib/fpm/package.rb ruby generate-cli-reference.rb > $@ package-type-cli: - $(MAKE) $(addprefix packages/,$(addsuffix -cli.rst,$(notdir $(basename $(wildcard ../lib/fpm/package/*.rb))))) + $(MAKE) $(addprefix packages/cli/,$(addsuffix .rst,$(notdir $(basename $(wildcard ../lib/fpm/package/*.rb))))) packages/cli: mkdir $@ -packages/cli/%-cli.rst: ../lib/fpm/package/%.rb packages/cli +packages/cli/%.rst: ../lib/fpm/package/%.rb packages/cli ruby generate-cli-reference.rb $* > $@ diff --git a/docs/cli-reference.rst b/docs/cli-reference.rst index ed0d0af3..69d3d850 100644 --- a/docs/cli-reference.rst +++ b/docs/cli-reference.rst @@ -588,6 +588,27 @@ General Options * ``--snap-grade GRADE`` - (snap only) Grade of this snap. +* ``--pleaserun-name SERVICE_NAME`` + - (pleaserun only) The name of the service you are creating + +* ``--pleaserun-chdir CHDIR`` + - (pleaserun only) The working directory used by the service + +* ``--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 + +* ``--pacman-group GROUP`` + - (pacman only) The group owner of files in this package + +* ``--pacman-compression COMPRESSION`` + - (pacman only) The compression type to use, must be one of gz, bzip2, xz, zstd, none. + * ``--virtualenv-pypi PYPI_URL`` - (virtualenv only) PyPi Server uri for retrieving packages. @@ -615,27 +636,6 @@ General Options * ``--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. -* ``--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 - -* ``--pacman-group GROUP`` - - (pacman only) The group owner of files in this package - -* ``--pacman-compression COMPRESSION`` - - (pacman only) The compression type to use, must be one of gz, bzip2, xz, zstd, none. - -* ``--pleaserun-name SERVICE_NAME`` - - (pleaserun only) The name of the service you are creating - -* ``--pleaserun-chdir CHDIR`` - - (pleaserun only) The working directory used by the service - apk --- diff --git a/docs/packages/apk-cli.rst b/docs/packages/cli/apk.rst similarity index 100% rename from docs/packages/apk-cli.rst rename to docs/packages/cli/apk.rst diff --git a/docs/packages/cpan-cli.rst b/docs/packages/cli/cpan.rst similarity index 100% rename from docs/packages/cpan-cli.rst rename to docs/packages/cli/cpan.rst diff --git a/docs/packages/deb-cli.rst b/docs/packages/cli/deb.rst similarity index 100% rename from docs/packages/deb-cli.rst rename to docs/packages/cli/deb.rst diff --git a/docs/packages/dir-cli.rst b/docs/packages/cli/dir.rst similarity index 100% rename from docs/packages/dir-cli.rst rename to docs/packages/cli/dir.rst diff --git a/docs/packages/empty-cli.rst b/docs/packages/cli/empty.rst similarity index 100% rename from docs/packages/empty-cli.rst rename to docs/packages/cli/empty.rst diff --git a/docs/packages/freebsd-cli.rst b/docs/packages/cli/freebsd.rst similarity index 100% rename from docs/packages/freebsd-cli.rst rename to docs/packages/cli/freebsd.rst diff --git a/docs/packages/gem-cli.rst b/docs/packages/cli/gem.rst similarity index 100% rename from docs/packages/gem-cli.rst rename to docs/packages/cli/gem.rst diff --git a/docs/packages/npm-cli.rst b/docs/packages/cli/npm.rst similarity index 100% rename from docs/packages/npm-cli.rst rename to docs/packages/cli/npm.rst diff --git a/docs/packages/osxpkg-cli.rst b/docs/packages/cli/osxpkg.rst similarity index 100% rename from docs/packages/osxpkg-cli.rst rename to docs/packages/cli/osxpkg.rst diff --git a/docs/packages/p5p-cli.rst b/docs/packages/cli/p5p.rst similarity index 100% rename from docs/packages/p5p-cli.rst rename to docs/packages/cli/p5p.rst diff --git a/docs/packages/pacman-cli.rst b/docs/packages/cli/pacman.rst similarity index 100% rename from docs/packages/pacman-cli.rst rename to docs/packages/cli/pacman.rst diff --git a/docs/packages/pear-cli.rst b/docs/packages/cli/pear.rst similarity index 100% rename from docs/packages/pear-cli.rst rename to docs/packages/cli/pear.rst diff --git a/docs/packages/pkgin-cli.rst b/docs/packages/cli/pkgin.rst similarity index 100% rename from docs/packages/pkgin-cli.rst rename to docs/packages/cli/pkgin.rst diff --git a/docs/packages/pleaserun-cli.rst b/docs/packages/cli/pleaserun.rst similarity index 100% rename from docs/packages/pleaserun-cli.rst rename to docs/packages/cli/pleaserun.rst diff --git a/docs/packages/puppet-cli.rst b/docs/packages/cli/puppet.rst similarity index 100% rename from docs/packages/puppet-cli.rst rename to docs/packages/cli/puppet.rst diff --git a/docs/packages/python-cli.rst b/docs/packages/cli/python.rst similarity index 100% rename from docs/packages/python-cli.rst rename to docs/packages/cli/python.rst diff --git a/docs/packages/rpm-cli.rst b/docs/packages/cli/rpm.rst similarity index 100% rename from docs/packages/rpm-cli.rst rename to docs/packages/cli/rpm.rst diff --git a/docs/packages/sh-cli.rst b/docs/packages/cli/sh.rst similarity index 100% rename from docs/packages/sh-cli.rst rename to docs/packages/cli/sh.rst diff --git a/docs/packages/snap-cli.rst b/docs/packages/cli/snap.rst similarity index 100% rename from docs/packages/snap-cli.rst rename to docs/packages/cli/snap.rst diff --git a/docs/packages/solaris-cli.rst b/docs/packages/cli/solaris.rst similarity index 100% rename from docs/packages/solaris-cli.rst rename to docs/packages/cli/solaris.rst diff --git a/docs/packages/tar-cli.rst b/docs/packages/cli/tar.rst similarity index 100% rename from docs/packages/tar-cli.rst rename to docs/packages/cli/tar.rst diff --git a/docs/packages/virtualenv-cli.rst b/docs/packages/cli/virtualenv.rst similarity index 100% rename from docs/packages/virtualenv-cli.rst rename to docs/packages/cli/virtualenv.rst diff --git a/docs/packages/zip-cli.rst b/docs/packages/cli/zip.rst similarity index 100% rename from docs/packages/zip-cli.rst rename to docs/packages/cli/zip.rst diff --git a/docs/packages/deb.rst b/docs/packages/deb.rst index fba994da..7bfd1e38 100644 --- a/docs/packages/deb.rst +++ b/docs/packages/deb.rst @@ -114,4 +114,4 @@ And maybe the architecture is wrong. fpm defaulted to amd64 (what fpm calls Deb-specific command line flags ------------------------------- -.. include:: deb-cli.rst +.. include:: cli/deb.rst diff --git a/docs/packages/rpm.rst b/docs/packages/rpm.rst index 945535bf..cecb5e3c 100644 --- a/docs/packages/rpm.rst +++ b/docs/packages/rpm.rst @@ -3,7 +3,7 @@ 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 @@ -78,4 +78,4 @@ And maybe the architecture is wrong. fpm defaulted to x86_64 (what fpm calls RPM-specific command line flags ------------------------------- -.. include:: rpm-cli.rst +.. include:: cli/rpm.rst