kpriv/pkgsrc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
pkgsrc/mk/install/header

109 lines
2 KiB
Text
Raw Normal View History

Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
#!@SH@
#
# start of header
#
Next round of install script cleanup -- we now create +FILES, +RCD_SCRIPTS, and +PERMS subscripts to handle copying config files and rc.d scripts, and setting special permissions on files. The +FILES and +RCD_SCRIPTS are basically identical except for different embedded packets of data, and they feature reference-counting for the files in case multiple packages share the same config file. Garbage-collect unused functions and definitions in the install scripts now that the subscripts are self-contained.
2005-02-02 11:33:01 +01:00
# $NetBSD: header,v 1.32 2005/02/02 10:33:01 jlam Exp $
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
PKGNAME=$1
STAGE=$2
AWK="@AWK@"
BASENAME="@BASENAME@"
CAT="@CAT@"
CHGRP="@CHGRP@"
CHMOD="@CHMOD@"
CHOWN="@CHOWN@"
CMP="@CMP@"
CP="@CP@"
DIRNAME="@DIRNAME@"
ECHO="@ECHO@"
Add ECHO_N to the list of substituted variables in [DE]INSTALL.
2004-04-27 20:31:08 +02:00
ECHO_N="@ECHO_N@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
EGREP="@EGREP@"
Instead of the incredibly dense _print_* stuff, use a (hopefully) more readable way of print messages.
2002-10-05 01:35:51 +02:00
EXPR="@EXPR@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
FALSE="@FALSE@"
Recognize ${FIND} and ${XARGS}.
2002-10-08 13:32:34 +02:00
FIND="@FIND@"
bsd.pkg.install.mk lists many things in FILES_SUBST, and we should have something to replace for each of those things in the header.
2002-01-10 13:05:26 +01:00
GREP="@GREP@"
GTAR="@GTAR@"
HEAD="@HEAD@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
ID="@ID@"
Merge pkgviews-mk branch into the HEAD by running: cd pkgsrc/mk cvs update -Pd -A cvs update -Pd -j pkgviews-mk-base -j pkgviews-mk
2003-09-02 08:59:37 +02:00
LINKFARM="@LINKFARM@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
LN="@LN@"
Define LS in install scripts (needed by install/fonts).
2003-12-20 10:45:55 +01:00
LS="@LS@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
MKDIR="@MKDIR@"
MV="@MV@"
bsd.pkg.install.mk lists many things in FILES_SUBST, and we should have something to replace for each of those things in the header.
2002-01-10 13:05:26 +01:00
PERL5="@PERL5@"
Introduce a new variable "CONF_DEPENDS" for pkgviews: a package's config directory matches the config directory for the dependency listed in CONF_DEPENDS. Use symlinks to physically point the package's config directory to the dependency's config directory, and handle all of this in the INSTALL/DEINSTALL scripts. Also make the INSTALL/DEINSTALL scripts a bit smarter about not copying files and not removing files if the source and destination file locations point to the same thing.
2003-09-17 04:38:22 +02:00
PKG_ADMIN="@PKG_ADMIN@"
PKG_INFO="@PKG_INFO@"
Use reference counts to properly account for the creation and removal of directories needed for the proper functioning of each package. The +INSTALL script unpacks a +DIRS script that adds and removes directories. The +DIRS script entirely encapsulates the directory creation and removal, and completely replaces the code in the mk/install/install and mk/install/deinstall templates that handled {MAKE,OWN}_DIRS and {MAKE,OWN}_DIRS_PERMS. The +DIRS script is meant to be executed from within the package meta-data directory, e.g. /var/db/pkg/<pkgname>. It's usage is: ./+DIRS ADD|REMOVE|CHECK-ADD|CHECK-REMOVE The ADD and REMOVE actions cause the necessary directories to be added or removed from the system. The CHECK-ADD and CHECK-REMOVE actions print out informative messages prompting the user to either create or remove some necessary directories. The behaviour of "ADD" is such that if the directory already exists on the system and is not already ref-counted, then that directory is marked as "pre-existing". On "REMOVE", pre-existing directories are left untouched on the filesystem. At any time, the root user can sanity-check the directories needed by packages by invoking all of the +DIRS scripts with the "CHECK-ADD" action. If there are missing directories, then invoking all of the +DIRS scripts with the "ADD" action will ensure that any missing directories are created. The reference counts database is stored in ${PKG_DBDIR}/.refcount. The reference counts related to directories managed by the +DIRS script are stored in ${PKG_DBDIR}/.refcount/dirs. If the directory reference counts database is removed, then invoking all of the +DIRS scripts with the "ADD" action will reconstruct the database; however, directories may be marked as being pre-existing, so they won't be removed at package de-installation (although a message will be displayed informing the user that those directories can be removed).
2005-01-28 07:30:58 +01:00
PWD_CMD="@PWD_CMD@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
RM="@RM@"
RMDIR="@RMDIR@"
SED="@SED@"
Merge pkgviews-mk branch into the HEAD by running: cd pkgsrc/mk cvs update -Pd -A cvs update -Pd -j pkgviews-mk-base -j pkgviews-mk
2003-09-02 08:59:37 +02:00
SETENV="@SETENV@"
bsd.pkg.install.mk lists many things in FILES_SUBST, and we should have something to replace for each of those things in the header.
2002-01-10 13:05:26 +01:00
SH="@SH@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
SORT="@SORT@"
bsd.pkg.install.mk lists many things in FILES_SUBST, and we should have something to replace for each of those things in the header.
2002-01-10 13:05:26 +01:00
SU="@SU@"
Add for use by the INSTALL/DEINSTALL scripts.
2003-08-30 20:42:36 +02:00
TEST="@TEST@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
TOUCH="@TOUCH@"
TR="@TR@"
TRUE="@TRUE@"
Recognize ${FIND} and ${XARGS}.
2002-10-08 13:32:34 +02:00
XARGS="@XARGS@"
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
Use reference counts to properly account for the creation and removal of directories needed for the proper functioning of each package. The +INSTALL script unpacks a +DIRS script that adds and removes directories. The +DIRS script entirely encapsulates the directory creation and removal, and completely replaces the code in the mk/install/install and mk/install/deinstall templates that handled {MAKE,OWN}_DIRS and {MAKE,OWN}_DIRS_PERMS. The +DIRS script is meant to be executed from within the package meta-data directory, e.g. /var/db/pkg/<pkgname>. It's usage is: ./+DIRS ADD|REMOVE|CHECK-ADD|CHECK-REMOVE The ADD and REMOVE actions cause the necessary directories to be added or removed from the system. The CHECK-ADD and CHECK-REMOVE actions print out informative messages prompting the user to either create or remove some necessary directories. The behaviour of "ADD" is such that if the directory already exists on the system and is not already ref-counted, then that directory is marked as "pre-existing". On "REMOVE", pre-existing directories are left untouched on the filesystem. At any time, the root user can sanity-check the directories needed by packages by invoking all of the +DIRS scripts with the "CHECK-ADD" action. If there are missing directories, then invoking all of the +DIRS scripts with the "ADD" action will ensure that any missing directories are created. The reference counts database is stored in ${PKG_DBDIR}/.refcount. The reference counts related to directories managed by the +DIRS script are stored in ${PKG_DBDIR}/.refcount/dirs. If the directory reference counts database is removed, then invoking all of the +DIRS scripts with the "ADD" action will reconstruct the database; however, directories may be marked as being pre-existing, so they won't be removed at package de-installation (although a message will be displayed informing the user that those directories can be removed).
2005-01-28 07:30:58 +01:00
: ${PKG_METADATA_DIR=`${PWD_CMD}`}
Replace PKG_{USER,GROUP} with PKG_USERS and PKG_GROUPS: PKG_USERS represents the users to create for the package. It is a space-separated list of elements of the form user:group[:[userid][:[descr][:[home][:shell]]]] Only the user and group are required; everything else is optional, but the colons must be in the right places when specifying optional bits. Note that if the description contains spaces, then spaces should be double backslash-escaped, e.g. foo:foogrp::The\\ Foomister PKG_GROUPS represents the groups to create for the package. It is a space-separated list of elements of the form group[:groupid] Only the group is required; the groupid is optional. This solves the problem of what to do when there is more than one user or group needed for a package, e.g. qmail. Also add a bit more error-checking to the INSTALL/DEINSTALL scripts.
2001-11-26 21:37:38 +01:00
PKGBASE="@PKGBASE@"
Make adding config files to views other than the default view work if PKG_SYSCONFBASE points outside of ${PREFIX}.
2003-09-12 07:15:03 +02:00
LOCALBASE="@LOCALBASE@"
X11BASE="@X11BASE@"
Introduce a new variable "CONF_DEPENDS" for pkgviews: a package's config directory matches the config directory for the dependency listed in CONF_DEPENDS. Use symlinks to physically point the package's config directory to the dependency's config directory, and handle all of this in the INSTALL/DEINSTALL scripts. Also make the INSTALL/DEINSTALL scripts a bit smarter about not copying files and not removing files if the source and destination file locations point to the same thing.
2003-09-17 04:38:22 +02:00
DEPOTBASE="@DEPOTBASE@"
Merge pkgviews-mk branch into the HEAD by running: cd pkgsrc/mk cvs update -Pd -A cvs update -Pd -j pkgviews-mk-base -j pkgviews-mk
2003-09-02 08:59:37 +02:00
PREFIX="@PREFIX@"
Make adding config files to views other than the default view work if PKG_SYSCONFBASE points outside of ${PREFIX}.
2003-09-12 07:15:03 +02:00
case ${PKG_PREFIX} in
${LOCALBASE}/*) VIEW="${PKG_PREFIX#${LOCALBASE}/}" ;;
*) VIEW="" ;;
esac
Replace PKG_{USER,GROUP} with PKG_USERS and PKG_GROUPS: PKG_USERS represents the users to create for the package. It is a space-separated list of elements of the form user:group[:[userid][:[descr][:[home][:shell]]]] Only the user and group are required; everything else is optional, but the colons must be in the right places when specifying optional bits. Note that if the description contains spaces, then spaces should be double backslash-escaped, e.g. foo:foogrp::The\\ Foomister PKG_GROUPS represents the groups to create for the package. It is a space-separated list of elements of the form group[:groupid] Only the group is required; the groupid is optional. This solves the problem of what to do when there is more than one user or group needed for a package, e.g. qmail. Also add a bit more error-checking to the INSTALL/DEINSTALL scripts.
2001-11-26 21:37:38 +01:00
Make adding config files to views other than the default view work if PKG_SYSCONFBASE points outside of ${PREFIX}.
2003-09-12 07:15:03 +02:00
PKG_SYSCONFBASE="@PKG_SYSCONFBASE@"
Merge pkgviews-mk branch into the HEAD by running: cd pkgsrc/mk cvs update -Pd -A cvs update -Pd -j pkgviews-mk-base -j pkgviews-mk
2003-09-02 08:59:37 +02:00
PKG_SYSCONFDEPOTBASE="@PKG_SYSCONFDEPOTBASE@"
Package Makefiles should refer to PKG_SYSCONFBASEDIR instead of PKG_SYSCONFBASE when they want PKG_SYSCONFDIR stripped of PKG_SYSCONFSUBDIR. This makes PKG_SYSCONFBASE=/etc work with pkgviews by installing all config files into /etc/packages/<pkg> instead of occasionally putting some directly into /etc. Also only create PKG_SYSCONFDIR if we're actually going to copy config files.
2003-09-05 13:34:25 +02:00
PKG_SYSCONFBASEDIR="@PKG_SYSCONFBASEDIR@"
Put PKG_SYSCONFBASE and PKG_SYSCONFDIR in the header so that they may be used in the scripts.
2002-06-27 22:42:15 +02:00
PKG_SYSCONFDIR="@PKG_SYSCONFDIR@"
Introduce a new variable "CONF_DEPENDS" for pkgviews: a package's config directory matches the config directory for the dependency listed in CONF_DEPENDS. Use symlinks to physically point the package's config directory to the dependency's config directory, and handle all of this in the INSTALL/DEINSTALL scripts. Also make the INSTALL/DEINSTALL scripts a bit smarter about not copying files and not removing files if the source and destination file locations point to the same thing.
2003-09-17 04:38:22 +02:00
CONF_DEPENDS="@CONF_DEPENDS@"
Put PKG_SYSCONFBASE and PKG_SYSCONFDIR in the header so that they may be used in the scripts.
2002-06-27 22:42:15 +02:00
Make adding config files to views other than the default view work if PKG_SYSCONFBASE points outside of ${PREFIX}.
2003-09-12 07:15:03 +02:00
case ${VIEW} in
"") PKG_SYSCONFVIEWBASE="${PKG_SYSCONFBASE}" ;;
*) PKG_SYSCONFVIEWBASE="${PKG_SYSCONFBASE}/${VIEW}" ;;
esac
Introduce new framework which unifies registering packages providing login shells to /etc/shells. This feature can be disabled by setting PKG_REGISTER_SHELLS to NO in /etc/mk.conf. An excerpt from Packages.txt, section 10.28: 10.28 Packages providing login shells ===================================== If the purpose of the package is to provide a login shell, the variable PKG_SHELL should contain the full pathname of the shell executable installed by this package. The package Makefile also must include "../../mk/bsd.pkg.install.mk" prior to the inclusion of bsd.pkg.mk to use the automatically generated INSTALL/DEINSTALL scripts. An example taken from shells/zsh: PKG_SHELL= ${PREFIX}/bin/zsh .include "../../mk/bsd.pkg.install.mk" The shell is registered into /etc/shells file automatically in the post-install target by the INSTALL script generated by bsd.pkg.install.mk and removed in the deinstall target by the DEINSTALL script.
2002-11-17 09:58:49 +01:00
PKG_REGISTER_SHELLS="@PKG_REGISTER_SHELLS@"
PKG_SHELL="@PKG_SHELL@"
Add the config files to the view also when there are rc.d scripts present. Ignore any .pkgsrc files as those aren't meaningful for views.
2003-09-13 12:06:36 +02:00
CONF_IGNORE_FILES="*[~#] *.OLD *.orig *,v .pkgsrc */.pkgsrc"
Merge pkgviews-mk branch into the HEAD by running: cd pkgsrc/mk cvs update -Pd -A cvs update -Pd -j pkgviews-mk-base -j pkgviews-mk
2003-09-02 08:59:37 +02:00
PKG_INSTALLATION_TYPE="@PKG_INSTALLATION_TYPE@"
Allow ALL_{DIRS,FILES,MAKE_DIRS} to be appended to by the extra templates so that the general INSTALL/DEINSTALL scripts can manage these extra files and directories.
2001-11-25 19:54:57 +01:00
let mk.conf's PKG_CREATE_USERGROUP and PKG_CONFIG take advantage of the same case insensitive multiple choice that the equivalents from the environment support
2002-06-24 15:14:41 +02:00
case "${PKG_CREATE_USERGROUP:-@PKG_CREATE_USERGROUP@}" in
In order to solve the following problems: (1) Admins want to create users/groups on their own (pkg/17183). (2) Admins don't want packages to setup an initial configuration. The bsd.pkg.install.mk-generated INSTALL/DEINSTALL scripts have been modified to check certain PKG_* environment variables to tune their behaviour. This works whether installing from "make install" or from a binary package. PKG_CREATE_USERGROUP indicates whether the INSTALL script should automatically add any needed users/groups to the system using useradd/groupadd. It is either YES or NO, and defaults to YES. PKG_CONFIG indicates whether the INSTALL/DEINSTALL scripts should do automatic config file and directory handling, or if it should merely inform the admin of the list of required files and directories needed to use the package. It is either YES or NO, and defaults to YES. The make(1) variable INSTALL_RCD_SCRIPTS is removed. The package rc.d script is now handled like other config files for the package, and is copied into place if PKG_CONFIG=YES. The default values above reflect the current behaviour. Setting PKG_CREATE_USERGROUP=NO solves problem (1), and setting PKG_CONFIG=NO solves problem (2). To simply matters for users installing directly from pkgsrc, these variables may also be defined in /etc/mk.conf, but behaviour at deinstall time may be surprising. It is *HIGHLY* recommended that these values be set in the shell environment instead.
2002-06-20 22:15:46 +02:00
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
_PKG_CREATE_USERGROUP=YES
;;
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
_PKG_CREATE_USERGROUP=NO
;;
esac
let mk.conf's PKG_CREATE_USERGROUP and PKG_CONFIG take advantage of the same case insensitive multiple choice that the equivalents from the environment support
2002-06-24 15:14:41 +02:00
case "${PKG_CONFIG:-@PKG_CONFIG@}" in
In order to solve the following problems: (1) Admins want to create users/groups on their own (pkg/17183). (2) Admins don't want packages to setup an initial configuration. The bsd.pkg.install.mk-generated INSTALL/DEINSTALL scripts have been modified to check certain PKG_* environment variables to tune their behaviour. This works whether installing from "make install" or from a binary package. PKG_CREATE_USERGROUP indicates whether the INSTALL script should automatically add any needed users/groups to the system using useradd/groupadd. It is either YES or NO, and defaults to YES. PKG_CONFIG indicates whether the INSTALL/DEINSTALL scripts should do automatic config file and directory handling, or if it should merely inform the admin of the list of required files and directories needed to use the package. It is either YES or NO, and defaults to YES. The make(1) variable INSTALL_RCD_SCRIPTS is removed. The package rc.d script is now handled like other config files for the package, and is copied into place if PKG_CONFIG=YES. The default values above reflect the current behaviour. Setting PKG_CREATE_USERGROUP=NO solves problem (1), and setting PKG_CONFIG=NO solves problem (2). To simply matters for users installing directly from pkgsrc, these variables may also be defined in /etc/mk.conf, but behaviour at deinstall time may be surprising. It is *HIGHLY* recommended that these values be set in the shell environment instead.
2002-06-20 22:15:46 +02:00
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
_PKG_CONFIG=YES
;;
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
_PKG_CONFIG=NO
;;
esac
Restore the ability to not automatically install the rc.d script into /etc/rc.d. This is controlled by the new variable PKG_RCD_SCRIPTS which may be set in /etc/mk.conf or in the shell environment in which the INSTALL script is executed. PKG_RCD_SCRIPTS only takes effect if ${PKG_CONFIG} == "YES" and defaults to NO.
2002-09-19 12:20:50 +02:00
case "${PKG_RCD_SCRIPTS:-@PKG_RCD_SCRIPTS@}" in
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
_PKG_RCD_SCRIPTS=YES
;;
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
_PKG_RCD_SCRIPTS=NO
;;
esac
Common INSTALL/DEINSTALL scripts and Makefile magic to automatically perform many of the tasks that need to be done when package is installed or deinstalled: * creating user/group for the package, * creating and removing directories with special permissions and ownership, * copying config files to their final locations, and removing them at deinstall time if they don't differ from the example ones, * reminding the package admin of files he may want to customize or of files/directories he may want to remove.
2001-11-19 17:18:44 +01:00
# end of header
Reference in a new issue Copy permalink