4.4BSD: pkg-lua-script manual page

PKG-LUA-SCRIPT(5)         FreeBSD File Formats Manual        PKG-LUA-SCRIPT(5)

NAME

     lua scripts - lua scripts that are run by pkg(8)

DESCRIPTION

     pkg(8) run scripts at given phases of the process it is running.

     The phases are the following:

     pre-install:
             run before installing the files on the system.

     post-install:
             run after installing the files on the system.

     pre-deinstall:
             run before removing the files on the system.

     post-deinstall:
             run after removing the files on the system.

     A package can contain multiple scripts per phase, they will all be run
     inside their own lua VM.

     In the particular case of an upgrade the scripts are run in the following
     order:
     1.   new pre-install
     2.   old pre-deinstall
     3.   replace binaries
     4.   new post-install

     Lua scripts are always run after shell scripts (of the same phase).

API

     All the regular lua APIs are available with the exception of the
     following changes:

     io.open()
             has been modified to only open files relatively to the rootdir if
             specified by the -r argument passed to pkg(8).

     os.remove()
             has been modified to only remove files relatively to the rootdir
             if specified by the -r argument passed to pkg(8).

     os.rename()
             has been modified to only rename files relatively to the rootdir
             if specified by the -r argument passed to pkg(8).

     os.execute()
             has been disabled.

     os.exit()
             has been disabled.

     The following variables are available defined to any lua scripts:

     pkg_name
             name of the package.

     pkg_prefix
             PREFIX defined within the package at build time.

     pkg_rootdir
             represents the root directory where the package will be installed
             as specified by the -r arguments passed to pkg(8).

     pkg_metalog
             String containing the path to a mtree(5) METALOG file in which
             package file metadata (e.g., ownership, mode) should be recorded.
             This is typically used when installing packages as a non-root
             user.  If no METALOG is configured, this variable is unset and is
             equal to nil.

     pkg_upgrade
             Boolean to inform the scripts that it is running or not in the
             context of an upgrade

     arg     When the first line of a Lua script starts with "-- args:"
             followed by a space-separated list of tokens, those tokens are
             parsed and made available in the global arg table.  This allows
             passing arguments to Lua scripts, should not be used by regular
             scripts.  This is used internally for deferred triggers.

     The following functions have been added:

     out pkg.prefixed_path(in)
             prepend pkg_prefix to in if needed and returns it as out.

     pkg.print_msg(msg)
             send messages to the user that will be shown at the end of the
             pkg(8) process.

     pkg.filecmp(file1, file2)
             Compare 2 files, return 0 if the files are identical, 1 if the
             files are different and >1 if an error occurred

     pkg.metalog_copy(source, destination)
             Will create an entry in the "metalog" if one has been defined
             which will clone the metadata from the source and use it for a
             new entry for destination path.

     pkg.copy(source, destination)
             Copy a file preserving its attributes. return -1 if an error
             occurred

     st pkg.stat(file)
             return an object table st with the following fields: type, size,
             uid, gid

     pkg.symlink(source, destination)
             Create a symbolic link destination pointing at source

     pkg.exec(arguments)
             Will execute the command arguments expected in the following
             form: `{command, arg1, arg2, arg3, ...}'

             The command inherits the parent's standard output and standard
             error.

     stdout, stderr, exitcode pkg.exec_capture(arguments)
             Will execute the command arguments expected in the same form as
             pkg.exec(), capturing its standard output and standard error
             separately.

             Returns three values: stdout (string containing the captured
             standard output), stderr (string containing the captured standard
             error), and exitcode (integer exit status of the command).  If
             the command cannot be started, the first two return values are
             nil and exitcode contains the error number.

     res pkg.readdir(path)
             Will return an ipair with the list of elements contained in the
             directory the special directory `.' and `..' are be filtered out.

NAME

DESCRIPTION

API

SEE ALSO