pack.cfg

NAME

SYNOPSIS

AVAILABILITY

DESCRIPTION

FILEFORMAT

The format of a application definition is:

APPLICATION_name(){

OPTION1=VALUE
OPTION2=VALUE
:
OPTIONn=VALUE

}

Between the OPTION, the = and the VALUE are no spaces.

Rows starting with a # are considered as comments.

You should not comment out any OPTION. If you like to use default settings simply do not specify a VALUE.

Normally there are multiple application settings defined in one configuration file.

The setting APPLICATION_default must be defined in a configuration file.

OPTIONS

GLOBAL OPTIONS

LOG

Log output dir of pack. If you specify a relative path name the path is relative to the root of the WA2L/edrc installation.

Example: LOG=/var/opt/edrc/log

Default: LOG=var/log

APPLICATION OPTIONS

APPLICATION_name(){

PACKAGE_NAME="text"
DESCRIPTION="text"
APPLICATION_PREFIX="text"
APPLICATION_RELEASE="version_number"
TIMESTAMP_PREFIX="text"
APPLICATION_BASEDIR="directory"
APPLICATION_COMPONENTS="directory"
OUTPUT_DIRECTORY="directory"
EXCLUDE_LIST="regex_list"
CONFIGFILE_LIST="regex_list"

}

The options recognized in a application definition are:

name

Name of the application. The name defined here has to be specified in the -a option in the pack command. The application with the name default is called when the -a option is not specified when using the pack command. Therefore each pack.cfg file should at least define a profile with the name default.

PACKAGE_NAME

Name of the software package. This normally correlates to the package name in the documentation/man pages.

Example: PACKAGE_NAME="WA2L/edrc"

Default: PACKAGE_NAME="?"

DESCRIPTION

Application description.

Example: DESCRIPTION="WA2L/edrc complete"

Default: DESCRIPTION=""

APPLICATION_PREFIX

This is the prefix of the application package, as:
<APPLICATION_PREFIX>-1.5.01-20070306.sh.

Example: APPLICATION_PREFIX="edrc"

Default: APPLICATION_PREFIX="myApp"

APPLICATION_RELEASE

Release number (version) of the application software.

Example: APPLICATION_RELEASE="``approot`/sbin/edrc -V`"

Default: APPLICATION_RELEASE=<has to be specified interactively>

TIMESTAMP_PREFIX

This is the prefix of the application timestamp, as:
<TIMESTAMP_PREFIX>-1.5.01. Normally the timestamp prefix should be set to <APPLICATION_PREFIX>

Example: TIMESTAMP_PREFIX="edrc"

Default: TIMESTAMP_PREFIX="<APPLICATION_PREFIX>"

APPLICATION_BASEDIR

Directory where the software is currently installed.

Example: APPLICATION_BASEDIR="`approot`"

Default: APPLICATION_BASEDIR="`approot`"

PACKAGE_COMPONENTS

Directory in edrc/var/pack/<PACKAGE_COMPONENTS> where the additional components used for the generation of the different package formats is located. See section FILES in pack(1m) for more information.

Example: PACKAGE_COMPONENTS="edrc"

Default: PACKAGE_COMPONENTS=<APPLICATION_PREFIX>

OUTPUT_DIRECTORY

Existing directory where the software package file is created. This directory should have at least 1.5 times the space available as the resulting software file size.

Example: OUTPUT_DIRECTORY="/dat/sw/apps"

Default: OUTPUT_DIRECTORY="/tmp"

EXCLUDE_LIST

List (regex) of files to be excluded from the software package. To verify the exclude definition invoke pack -L to list the files that would be packed into the software package.

Example: EXCLUDE_LIST="/.sav/ ^edrc/var/log/.+.log$"

Default: EXCLUDE_LIST=""

CONFIGFILE_LIST

List (regex) of config files of the software to be packed. This setting is for package formats that support the special handling of configuration files. This are the formats rpm, depot and pkg. The shar format currently does not treat config files special. But for future enhancements the CONFIGFILE_LIST should be defined, too.

Example: CONFIGFILE_LIST="^edrc/etc/.+"

Default: CONFIGFILE_LIST=""

VARIABLES

To avoid defining the same settings multiple times it is allowed to chain application definitions by "calling" another definition at the beginning of an application definition. In fact you should do this at least in the APPLICATION_default definition. Therefore it is allowed to use the application setting variables to enhance a definition. This makes especially sense to enhance an EXCLUDE_LIST by first including another definition and then using the $EXCLUDE_LIST variable in the definition of the EXCLUDE_LIST. See also definitions in the edrc/etc/pack.cfg file and the EXAMPLE section for examples for the method of chaining definitions.

EXAMPLES

1) example application definition for the WA2L/edrc application

See the "call" of APPLICATION_edrc in the APPLICATION_default and APPLICATION_edrc_NOSECURITY definition to chain the definitions to save definition effort.

# edrc: WA2L/edrc complete
#
APPLICATION_edrc(){
    PACKAGE_NAME="WA2L/edrc"
    DESCRIPTION="WA2L/edrc complete"
    APPLICATION_PREFIX="edrc"
    APPLICATION_RELEASE="`\`approot\`/sbin/edrc -V`"
    APPLICATION_BASEDIR="`approot`"
    PACKAGE_COMPONENTS="edrc"
    OUTPUT_DIRECTORY="/tmp"
    EXCLUDE_LIST="\
       /\.sav/                                     \
       /\.\[^ssh\]                                 \
       /\..*\.swp\$                                \
       ^edrc/etc/.*\.2[0-9]{7}$                    \
       ^edrc/bin/.*\.2[0-9]{7}$                    \
       ^edrc/doc/.man/.+\.ps$                      \
       ^edrc/doc/.man/.+\.pdf$                     \
       ^edrc/doc/.man/.+\.html$                    \
       ^edrc/lib/.*\.2[0-9]{7}$                    \
       ^edrc/lib/edrcpack/                         \
       ^edrc/src/.+\.o$                            \
       ^edrc/var/backup/.+                         \
       ^edrc/var/barbedwire/cache/.+               \
       ^edrc/var/connection/cache/.+               \
       ^edrc/var/contrib/edrc/.+                   \
       ^edrc/var/edrcpack/                         \
       ^edrc/var/lock/.+\.lock$                    \
       ^edrc/var/log/.+\.log$                      \
       ^edrc/var/repl/.+                           \
       ^edrc/var/sfi/app_mgmt/applications/.+      \
       ^edrc/var/sfi/csdocs/hosts/data/.+          \
       ^edrc/var/sfi/db/.+                         \
       ^edrc/var/settings/.+                       \
       ^edrc/var/shell/sh_history\..*              \
       ^edrc/var/shell/sh_var\..*                  \
       ^edrc/var/shell/edrc_history\..*            \
       ^edrc/var/passwdsyncd/.+                    \
       ^edrc/var/pwsync/                           \
    "
    CONFIGFILE_LIST="\
       ^edrc/etc/.+                                \
    "
}


# edrc_NOSECURITY: WA2L/edrc without security files
#
APPLICATION_edrc_NOSECURITY(){
    APPLICATION_edrc
    PACKAGE_NAME="WA2L/edrc"
    DESCRIPTION="WA2L/edrc without security files"
    APPLICATION_PREFIX="edrc"
    APPLICATION_RELEASE="`\`approot\`/sbin/edrc -V`"
    APPLICATION_BASEDIR="`approot`"
    PACKAGE_COMPONENTS="edrc"
    OUTPUT_DIRECTORY="/tmp"
    EXCLUDE_LIST="\
       $EXCLUDE_LIST                               \
       ^edrc/var/connection/security/edrc/+/+/+/   \
       ^edrc/var/connection/security/edrc/.ssh/    \
    "
    CONFIGFILE_LIST="\
       ^edrc/etc/.+                                \
    "
}


# default: Default setting. This setting is effective when pack is
#          execute without options.
#
APPLICATION_default(){
    APPLICATION_edrc
}

SEE ALSO

NOTES

BUGS

AUTHOR

COPYRIGHT

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.