All keywords can also take optional arguments in parentheses. The arguments are owner, group, and mode. This argument is used on the file or directory referenced. To change the owner, group, and mode of a configuration file, use:
@sample(games,games,640) etc/config.sample
The arguments are optional. If only the group and mode need to be changed, use:
@sample(,games,660) etc/config.sample
Will run update-desktop-database -q
after installation and deinstallation.
Add a @dir entry for the
directory passed as an argument, and run fc-cache
-s, mkfontscale and
mkfontdir on that directory after
installation and deinstallation. Additionally, on
deinstallation, it removes the
fonts.scale and
fonts.dir cache files if they are
empty.
Add the file passed as argument to the plist, and updates
the info document index on installation and deinstallation.
Additionally, it removes the index if empty on
deinstallation. This should never be used manually, but
always through INFO. See Section 5.11, “Info Files” for more information.
Runs kldxref on the directory
on installation and deinstallation. Additionally, on
deinstallation, it will remove the directory if empty.
Will remove the file on deinstallation, and not give an error if the file is not there.
Add the file passed as argument to the plist.
On installation, check for a “real” file with
just the base name (the name without the
.sample extension). If the real file is
not found, copy the sample file to the base file name. On
deinstallation, remove the configuration file if it has not
been modified. See Section 7.3, “Configuration Files” for more
information.
Runs update-mime-database on the
directory on installation and deinstallation.
Add the file passed as argument to the plist.
On installation, add the full path to
file to
/etc/shells, while making sure it is not
added twice. On deinstallation, remove it from
/etc/shells.
There are a few keywords that are hardcoded, and documented in pkg-create(8). For the sake of completeness, they are also documented here.
The empty keyword is a placeholder to use when the
file's owner, group, or mode need to be changed. For
example, to set the group of the file to
games and add the setgid bit, add:
@(,games,2755) sbin/daemon
Set the internal directory pointer to point to directory. All subsequent filenames are assumed relative to this directory.
Execute command as part of
the unpacking process. If command contains any of these
sequences somewhere in it, they are expanded
inline. For these examples, assume that
@cwd is set to
/usr/local and the last
extracted file was bin/emacs.
%FExpand to the last filename extracted (as
specified). In the example case
bin/emacs.
%DExpand to the current directory prefix, as set
with @cwd. In the example case
/usr/local.
%BExpand to the basename of the fully qualified
filename, that is, the current directory prefix plus
the last filespec, minus the trailing filename. In
the example case, that would be
/usr/local/bin.
%fExpand to the filename part of the fully qualified
name, or the converse of %B. In
the example case,
emacs.
Execute command as part of
the deinstallation process. Expansion of special
% sequences is the same as for
@exec. This command is not executed
during the package add, as @exec is, but
rather when the package is deleted. This is useful for
deleting links and other ancillary files that were created
as a result of adding the package, but not directly known to
the package's table of contents (and hence not automatically
removable).
Set default permission for all subsequently extracted
files to mode. Format is the
same as that used by chmod(1). Use without an arg to
set back to default permissions (mode of the file while
being packed).
This must be a numeric mode, like
644, 4755, or
600. It cannnot be a relative mode
like u+s.
Set default ownership for all subsequent files to
user. Use without an argument to
set back to default ownership (root).
Set default group ownership for all subsequent files to
group. Use without an arg to set
back to default group ownership (wheel).
Declare directory name. By default, directories created
under PREFIX by a package installation
are automatically removed. Use this when an empty directory
under PREFIX needs to be created, or when
the directory needs to have non default owner, group, or
mode. Directories outside of PREFIX need
to be registered. For example,
/var/db/${PORTNAME} needs to have a
@dir entry whereas
${PREFIX}/share/${PORTNAME} does not if
it contains files or uses the default owner, group, and
mode.
Declare directory name to be deleted at deinstall time.
By default, directories created under
PREFIX by a package installation are
deleted when the package is deinstalled.
Package list files can be extended by keywords that are
defined in the ${PORTSDIR}/Keywords
directory. The settings for each keyword are stored in a
UCL file named
keyword.ucl
attributesChanges the owner, group, or mode used by the
keyword. Contains an associative array where the
possible keys are owner,
group, and mode.
The values are, respectively, a user name, a group name,
and a file mode. For example:
attributes: { owner: "games", group: "games", mode: 0555 }actionDefines what happens to the keyword's parameter. Contains an array where the possible values are:
setprefixSet the prefix for the next plist entries.
dirRegister a directory to be created on install and removed on deinstall.
dirrmRegister a directory to be deleted on deinstall. Deprecated.
dirrmtryRegister a directory to try and deleted on deinstall. Deprecated.
fileRegister a file.
setmodeSet the mode for the next plist entries.
setownerSet the owner for the next plist entries.
setgroupSet the group for the next plist entries.
commentDoes not do anything, equivalent to not
entering an action
section.
ignore_nextIgnore the next entry in the plist.
pre-install, post-install, pre-deinstall, post-deinstall, pre-upgrade, post-upgradeThese keywords contains a sh(1) script to be
executed before or after installation, deinstallation,
or upgrade of the package. In addition to the usual
@exec
%
placeholders described in Section 7.6.10.3, “foo@exec
command”, there is a new
one, %@, which represents the
argument of the keyword.
@dirrmtryecho
KeywordThis keyword does two things, it adds a
@dirrmtry
line to the
packing list, and echoes the fact that the directory is
removed when deinstalling the package.directory
actions: [dirrmtry] post-deinstall: <<EOD echo "Directory %D/%@ removed." EOD
@sample
is ImplementedThis keyword does three things, it adds the
filename passed as an argument to
@sample to the packing list, it adds to
the post-install script instructions to
copy the sample to the actual configuration file if it does
not already exist, and it adds to the
post-deinstall instructions to remove the
configuration file if it has not been modified.
actions: [file]
post-install: <<EOD
case "%@" in
/*) sample_file="%@" ;;
*) sample_file="%D/%@" ;;
esac
target_file="${sample_file%.sample}"
if ! [ -f "${target_file}" ]; then
/bin/cp -p "${sample_file}" "${target_file}"
fi
EOD
pre-deinstall: <<EOD
case "%@" in
/*) sample_file="%@" ;;
*) sample_file="%D/%@" ;;
esac
target_file="${sample_file%.sample}"
if cmp -s "${target_file}" "${sample_file}"; then
rm -f "${target_file}"
else
echo "You may need to manually remove ${target_file} if it's no longer needed."
fi
EODAll FreeBSD documents are available for download at http://ftp.FreeBSD.org/pub/FreeBSD/doc/
Questions that are not answered by the
documentation may be
sent to <[email protected]>.
Send questions about this document to <[email protected]>.