Page MenuHomeFreeBSD
Files F149590100

D36769.1790548447.diff
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

D36769.1790548447.diff
View Options

diff --git a/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc b/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc
--- a/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc
@@ -223,34 +223,45 @@
====
[[pkg-install]]
-== pkg-install
+== pkg-install, pkg-pre-install and pkg-post-install
If the port needs to execute commands when the binary package is installed with `pkg add` or `pkg install`, use [.filename]#pkg-install#.
-This script will automatically be added to the package.
It will be run twice by `pkg`, the first time as `${SH} pkg-install ${PKGNAME} PRE-INSTALL` before the package is installed, and the second time as `${SH} pkg-install ${PKGNAME} POST-INSTALL` after it has been installed.
`$2` can be tested to determine which mode the script is being run in.
The `PKG_PREFIX` environmental variable will be set to the package installation directory.
+If you use [.filename]#pkg-pre-install# or [.filename]#pkg-post-install# instead, the script is only run once, before or after installation of the package.
+You can also use [.filename]#pkg-pre-install.lua# or [.filename]#pkg-post-install.lua# to run a lua script instead of a shell script.
+Lua scripts run by `pkg` provide some extensions and a few restrictions, for these see man:pkg-lua-script[5].
+
+These scripts will automatically be added to the package.
+
[IMPORTANT]
====
-This script is here to help you set up the package so that it is as ready to use as possible.
-It _must not_ be abused to start services, stop services, or run any other commands that will modify the currently running system.
+These scripts are here to help you set up the package so that it is as ready to use as possible.
+They _must not_ be abused to start services, stop services, or run any other commands that will modify the currently running system.
====
[[pkg-deinstall]]
-== pkg-deinstall
+== pkg-deinstall, pkg-pre-deinstall and pkg-post-deinstall
-This script executes when a package is removed.
+These scripts execute when a package is removed.
-This script will be run twice by `pkg delete`.
+The [.filename]#pkg-deinstall# script will be run twice by `pkg delete`.
The first time as `${SH} pkg-deinstall ${PKGNAME} DEINSTALL` before the port is de-installed and the second time as `${SH} pkg-deinstall ${PKGNAME} POST-DEINSTALL` after the port has been de-installed.
`$2` can be tested to determine which mode the script is being run in.
-The `PKG_PREFIX` environmental variable will be set to the package installation directory
+The `PKG_PREFIX` environmental variable will be set to the package installation directory.
+
+If you use [.filename]#pkg-pre-deinstall# or [.filename]#pkg-post-deinstall# instead, the script is only run once, before or after removal of the package.
+You can also use [.filename]#pkg-pre-deinstall.lua# or [.filename]#pkg-post-deinstall.lua# to run a lua script instead of a shell script.
+Lua scripts run by `pkg` provide some extensions and a few restrictions, for these see man:pkg-lua-script[5].
+
+These scripts will automatically be added to the package.
[IMPORTANT]
====
-This script is here to help you set up the package so that it is as ready to use as possible.
-It _must not_ be abused to start services, stop services, or run any other commands that will modify the currently running system.
+These scripts are here to help you set up the package so that it is as ready to use as possible.
+They _must not_ be abused to start services, stop services, or run any other commands that will modify the currently running system.
====
[[pkg-names]]
@@ -278,9 +289,21 @@
|`PKGINSTALL`
|`${PKGDIR}/pkg-install`
+|`PKGPREINSTALL`
+|`${PKGDIR}/pkg-pre-install`
+
+|`PKGPOSTINSTALL`
+|`${PKGDIR}/pkg-post-install`
+
|`PKGDEINSTALL`
|`${PKGDIR}/pkg-deinstall`
+|`PKGPREDEINSTALL`
+|`${PKGDIR}/pkg-pre-deinstall`
+
+|`PKGPOSTDEINSTALL`
+|`${PKGDIR}/pkg-post-deinstall`
+
|`PKGMESSAGE`
|`${PKGDIR}/pkg-message`
|===

File Metadata

Mime Type
text/plain
Expires
Sun, Sep 27, 10:34 PM (14 h, 1 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
29960592
Default Alt Text
D36769.1790548447.diff (3 KB)

Event Timeline