meaning fallback value, if localbinir, projectbindir, or globalbindir are not defined at shipping time

used by pkgm

used for shipping

example bindir {HOME}/bin

meaning pathname of the WWW browser that is started by ComPactHTTPd

used by ComPactHTTPd

used for graphical user interface display

example browser netscape

meaning arguments of the WWW browser that is started by ComPactHTTPd

used by ComPactHTTPd

used for graphical user interface display

example browser-arguments "-ncols 20"

meaning arguments for the WWW browser if it is contacted by ComPactHTTPd remotely

used by ComPactHTTPd

used for graphical user interface display

example browser-remote-arguments "-remote openURL(http://localhost:{!httpd-port})"

meaning directory that is supposed to contain all collections of packages located in the local workspace and currently in use by ComPact. It is mainly used as a default for locating packages listed in project description files.

used by prjm, ComPactHTTPd

used for project management, build management

example collectionroot {HOME}/work

meaning color used as the background for recently added packages and package elements that have not yet been committed to the repository. It is not recommended to change the default settings of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorAdded "#BBFFBB"

meaning color used as the background for packages and package elements which contain modifications that conflict with changes recently committed by others. It is not recommended to change the default settings of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorConflics "#FFAAAA"

meaning color used as the background for packages and package elements that are locally modified, but not conflicting with changes others may have committed since the last checkout. It is not recommended to change the default settings of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorModified "#CCFFBB"

meaning color used as the background for packages and package elements that are locally modified and out-of-date. It is not recommended to change the default settings of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorModifiedAndOutOfDate "#CCFFF0"

meaning color used as the background for packages and package elements with no special version control status (e.g. modified). It is not recommended to change the default settings of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorNormal "#FF9970"

meaning color used as the background for packages and package elements that are out-of-date and not locally modified. It is not recommended to change the default settings of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorOutOfDate "#CCDDFF"

meaning color used as the background for packages and package elements that are locally removed but have not been committed to the repository. It is not recommended to change the default setting of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorRemoved "#FF9999"

meaning color used as the background for packages and package elements that are not subject to version control. It is not recommended to change the default setting of the GUI.

used by ComPactHTTPd

used for graphical user interface customization

example colorUnknown "#E0E0CC"

meaning color-scheme used for the ComPact GUI. This is just a symbolic name for a combination of colors for text, background, tables etc. Possible values are

used by ComPactHTTPd

used for configuration of the graphical user interface

example color-scheme ice

meaning If set, the value of this variable is used as the server name (domain name or internet address) for the ComPact remote configuration resource service. If the ComPact configuration resource service is running on this machine, further requests for configuration resources (compactrc, PkgBase.DefaultData, pkgconf.cbcl, etc.) will be satisfied by resources from this service (before overriden by local resources).

used by pkgm, pkgvm, poolm, prjm, ComPactHTTPd

used for central configuration and customization of ComPact installations

example compactserver "reposrv.mycompacy.com"

meaning a list of directories that are searched for resource files

used by prjm, pkgm, poolm, ComPactHTTPd

used for configuration

example configpath /home/wagner/pkgm;/usr/contrib/lib/pkgm;/usr/local/lib/pkgm

meaning the default target platform configuration ComPact builds and ships for, if none can be derived from the package kind mappings

used by pkgm

used for building, shipping

example configuration i386-freebsd2-aout-gcc-debug

meaning pathname of the cvs program

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for all version control operations

example cvspath /usr/local/bin/cvs

meaning alias for repository

used by pkgm, pkgvm, ComPactHTTPd

used for all version control operations

example cvsroot cvsserv:/usr/cvs

meaning fallback value, if localdocdir, projectdocdir, or globaldocdir are not defined at shipping time

used by pkgm

used for shipping

example docdir {HOME}/doc

meaning pathname of the editor that is to be called

used by pkgm, pkgvm, ComPactHTTPd

used for editing, commit messages

example editor gnuclient

meaning Setting this variable to false or no will make the computation of package dependencies optional, and failure to do so will not make prjm stop with an error message, but simply issue a warning.

The introduction of this variable has been motivated by ComPact Light, which does not contain build management, and should nonetheless be able to perform all necessary version control on prject level.

used by prjm, ComPactHTTPd

used for configuration of package dependency computation

example enforce-pkgdeps "no"

meaning default command to check all log and commit messages. If this variable is present, this command is invoked to check the commit or log message. If it exits with 0, the message is accepted, otherwise it is rejected. The command definition should start with an exclamation mark in order to prevent premature variable substitution in compactrc. In addition to all the variables defined in compactrc resources, the following variables will be substituted prior to execution: {!msg} -- the complete log message, {!msgfn} -- the name of a (temporary) file containing the log message, {!pkgname} -- the name of the package or project, {!pkgroot} -- absolute local pathname of package or project, {!user} -- the current user name, {!action} -- one of {package-commit, package-release, project-snapshot, project-release, project-change-set}, {!name} -- the name of the new revision, snapshot, release, or change set, {!id} -- request-id extracted from the log message, if present.

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for commit, release, snapshots, interaction with problem management or request tracking tool

example external-commit-hook "!rt-check-id-exists {!id}"

meaning command to check package commit log messages. If this variable is present, this command is invoked to check the commit log message. If it exits with 0, the message is accepted, otherwise it is rejected. The command definition should start with an exclamation mark in order to prevent premature variable substitution in compactrc. In addition to all the variables defined in compactrc resources, the following variables will be substituted prior to execution: {!msg} -- the complete log message, {!msgfn} -- the name of a (temporary) file containing the log message, {!pkgname} -- the name of the package or project, {!pkgroot} -- absolute local pathname of package or project, {!user} -- the current user name, {!action} -- package-commit, {!name} -- the name of the new revision, snapshot, release, or change set, {!id} -- request-id extracted from the log message, if present.

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for package commit, interaction with problem management or request tracking tool

example external-package-commit-hook "!rt-check-id-exists {!id}"

meaning command to check all package release log messages. If this variable is present, this command is invoked to check the release log message. If it exits with 0, the message is accepted, otherwise it is rejected. The command definition should start with an exclamation mark in order to prevent premature variable substitution in compactrc. In addition to all the variables defined in compactrc resources, the following variables will be substituted prior to execution: {!msg} -- the complete log message, {!msgfn} -- the name of a (temporary) file containing the log message, {!pkgname} -- the name of the package or project, {!pkgroot} -- absolute local pathname of package or project, {!user} -- the current user name, {!action} -- package-release, {!name} -- the name of the new revision, snapshot, release, or change set, {!id} -- request-id extracted from the log message, if present.

used by pkgm, pkgvm, ComPactHTTPd

used for package release, interaction with problem management or request tracking tool

example external-package-release-hook "!rt-check-id-exists {!id}"

meaning command to check all project snapshot log messages. If this variable is present, this command is invoked to check the snapshot log message. If it exits with 0, the message is accepted, otherwise it is rejected. The command definition should start with an exclamation mark in order to prevent premature variable substitution in compactrc. In addition to all the variables defined in compactrc resources, the following variables will be substituted prior to execution: {!msg} -- the complete log message, {!msgfn} -- the name of a (temporary) file containing the log message, {!pkgname} -- the name of the package or project, {!pkgroot} -- absolute local pathname of package or project, {!user} -- the current user name, {!action} -- project-snapshot, {!name} -- the name of the new revision, snapshot, release, or change set, {!id} -- request-id extracted from the log message, if present.

used by prjm

used for project snapshots, interaction with problem management or request tracking tool

example external-project-snapshot-hook "!rt-check-id-exists {!id}"

meaning command to check all project release log messages. If this variable is present, this command is invoked to check the release log message. If it exits with 0, the message is accepted, otherwise it is rejected. The command definition should start with an exclamation mark in order to prevent premature variable substitution in compactrc. In addition to all the variables defined in compactrc resources, the following variables will be substituted prior to execution: {!msg} -- the complete log message, {!msgfn} -- the name of a (temporary) file containing the log message, {!pkgname} -- the name of the package or project, {!pkgroot} -- absolute local pathname of package or project, {!user} -- the current user name, {!action} -- project-release {!name} -- the name of the new revision, snapshot, release, or change set, {!id} -- request-id extracted from the log message, if present.

used by prjm

used for project release, interaction with problem management or request tracking tool

example external-project-release-hook "!rt-check-id-exists {!id}"

meaning command to check all project change set log messages. If this variable is present, this command is invoked to check the change set log message. If it exits with 0, the message is accepted, otherwise it is rejected. The command definition should start with an exclamation mark in order to prevent premature variable substitution in compactrc. In addition to all the variables defined in compactrc resources, the following variables will be substituted prior to execution: {!msg} -- the complete log message, {!msgfn} -- the name of a (temporary) file containing the log message, {!pkgname} -- the name of the package or project, {!pkgroot} -- absolute local pathname of package or project, {!user} -- the current user name, {!action} -- project-change-set {!name} -- the name of the new revision, snapshot, release, or change set, {!id} -- request-id extracted from the log message, if present.

used by prjm

used for project change set creation, interaction with problem management or request tracking tool

example external-project-change-set-hook "!rt-check-id-exists {!id}"

meaning a boolean expression composed of shell globbing patterns and regular expressions that selects directories that are not to be kept in the file cache for packages

used by prjm, ComPactHTTPd

used for speed-up of all build and version control operations

example filecache-ignore-dirs "tmp or temp"

meaning a boolean expression composed of shell globbing patterns and regular expressions that selects files that are not to be kept in the file cache for packages

used by prjm, ComPactHTTPd

used for speed-up of all build and version control operations

example filecache-ignore-files " \"*~\" or \"*.bak\" or \"*.tmp\" or \"*.temp\" "

meaning Mapping that chooses an editor command depending on regular expression matches with the name of the file to be edited. Any number of these lines can be present.

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for customization, editor choice

example filename-editor-mapping .*\.gif$ => "gimp"

meaning a boolean expression composed of shell globbing patterns and regular expressions that selects directories that are not to be used to compute fingerprints for packages

used by prjm, ComPactHTTPd

used for speed-up of all build and version control operations

example fingerprint-ignore-dirs "tmp or temp"

meaning a boolean expression composed of shell globbing patterns and regular expressions that selects files that are not to be used to compute fingerprints for packages

used by prjm, ComPactHTTPd

used for speed-up of all build and version control operations

example fingerprint-ignore-files " \"*~\" or \"*.bak\" or \"*.tmp\" or \"*.temp\" "

meaning pathname of the directory, into which executable programs are shipped globally

used by pkgm

used for shipping

example globalbindir /usr/local/bin

meaning pathname of the directory, into which documents are shipped globally

used by pkgm

used for shipping

example globaldocdir /usr/local/share/doc

meaning pathname of the global package pool. If this is relative, the value of poolprefix is appended.

used by pkgm, poolm

used for building, pool management

example globalpool global

meaning ComPactHTTPd rings the bell on warning and error conditions

used by ComPactHTTPd

used for customization of the graphical user interface

example httpd-beeps no

meaning string containing the IP address and port number of the ComPactHTTPd server, prefixed by "http://". This is computed inside the ComPactHTTPd server and should not be set manually.

used by ComPactHTTPd

used for debugging of the graphical user interface

example httpd-addr "http://127.0.0.1:8854/"

meaning switch to turn off the computation of different version control states of files and their rendering in different colors, since this may be very time-consuming

used by ComPactHTTPd

used for GUI configuration

example httpd-colored-files no

meaning switch to turn off the computation of different version control states of packages and their rendering in different colors, since this may be very time-consuming

used by ComPactHTTPd

used for GUI configuration

example httpd-colored-packages no

meaning switch to turn off the computation of different version control states of projects and their rendering in different colors, since this may be very time-consuming

used by ComPactHTTPd

used for GUI configuration

example httpd-colored-projects no

meaning debug level of the ComPactHTTPd server

used by ComPactHTTPd

used for debugging of the graphical user interface

example httpd-debug 2

meaning pathname of the editor preferred by ComPactHTTPd. This may be different from your editor setting, since ComPactHTTPd usually runs programs without standard input, so the editor needs to create its own window.

used by ComPactHTTPd

used for editing, commit messages

example httpd-editor gnuclient

meaning pathname of the editor used by ComPact for files ending with the extension FILEEXT. Any number of lines with different FILEEXT extensions may be present.

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for customization of editing, commit messages

example httpd-editor-jpeg gimp

meaning name of the error page used by the ComPactHTTPd server to display internal errors

used by ComPactHTTPd

used for customization of the graphical user interface

example httpd-error-page "Error.htm"

meaning name of the execute page used by the ComPactHTTPd server to display the output of external program runs

used by ComPactHTTPd

used for customization of the graphical user interface

example httpd-execute-page "Execute.htm"

meaning run a background thread that permanently collects unused objects in the traced heap

used by ComPactHTTPd

used for tuning of ComPactHTTPd

example httpd-gc-background "yes"

meaning This setting may be used to tune the garbage collector used by the runtime system of ComPactHTTPd. If you don't know what you are doing, better don't change this. Here is what the DEC SRC manual says to this variable:

On the average, for every page allocated by the mutator, the collector will copy gcRatio pages. Increase the ratio to keep the heap smaller; decrease it to spend less time in the collector.

used by ComPactHTTPd

used for tuning of ComPactHTTPd

example httpd-gc-ratio "0.5"

meaning switch to enable sequentialization of all http request inside the server. This must not be used during normal operation!

used by ComPactHTTPd

used for debugging of the graphical user interface

example httpd-global-lock no

meaning pathname of the directory where ComPactHTTPd looks for HTML help files

used by ComPactHTTPd

used for customization of graphical user interface

example httpd-help-resources {HOME}/pkgm/httpd

meaning name of the home (start) page used by the ComPactHTTPd server

used by ComPactHTTPd

used for customization of the graphical user interface

example httpd-home-page "index.htm"

meaning use internal buffers for data sent to a special browser window displaying logging information of one ComPactHTTPd session. This is mutually exclusive with the use of external log files. If neither internal logging nor external log files are used, all debug/trace/verbose output is send to stdout, i.e. is displayed in the window the ComPactHTTPd was started in.

used by ComPactHTTPd

used for customization of logging for trace and debug purposes

example httpd-internal-log yes

meaning defines whether or not ComPactHTTPd uses the integrated version control backend to gather status information about projects, packages, and files, or if it delegates these tasks completely to external programs (which is more flexible, but rather slower).

used by ComPactHTTPd

used for customization of GUI behaviour

example httpd-internal-vc "yes"

meaning IP address bound by the ComPact HTTP server for incoming requests

used by ComPactHTTPd

used for configuration of the communication channel between ComPactHTTPd and the WWW browser

example httpd-listen-address 127.0.0.1

meaning use the named external logfile for data sent to a special browser window displaying logging information of one ComPactHTTPd session. This is mutually exclusive with the use of internal logging. If neither internal logging nor external log files are used, all debug/trace/verbose output is send to stdout, i.e. is displayed in the window the ComPactHTTPd was started in.

used by ComPactHTTPd

used for customization of logging for trace and debug purposes

example httpd-logfile {HOME}/tmp/httpd-{?Session}.log

meaning TCP port used by ComPactHTTPd

used by ComPactHTTPd

used for configuration of the communication channel between ComPactHTTPd and the WWW browser

example httpd-port 8884

meaning pathname of the directory where ComPactHTTPd looks for HTML template files and other resources

used by ComPactHTTPd

used for customization of graphical user interface

example httpd-resources {HOME}/compact/httpd

meaning name of the source page used by the ComPactHTTPd server to display the contents of files

used by ComPactHTTPd

used for customization of the graphical user interface

example httpd-source-page "Source.htm"

meaning the size of the stack in words that are allocated for every thread that services an HTTP request inside of ComPactHTTPd. If you set this value too low, the server will crash due to insufficient stack size; if it is too high, performance will suffer because of big immobile heap objects. This is actually only settable because the needed size may be different between machines of different architecture.

used by ComPactHTTPd

used for tuning of ComPactHTTPd

example httpd-stacksize 1500

meaning if set to "yes", the ComPactHTTPd terminates the default session on request, which implies immediate terminate of the server itself.

used by ComPactHTTPd

used for customization of GUI behaviour

example httpd-terminate-default-session no

meaning name of the termination page used by the ComPactHTTPd server as last page of a session

used by ComPactHTTPd

used for customization of the graphical user interface

example httpd-terminate-page "quit/index.htm"

meaning if set to "yes", ComPactHTTPd terminates when the last session is terminated

used by ComPactHTTPd

used for customization of GUI behaviour

example httpd-terminate-without-sessions "no"

meaning trace level of the ComPactHTTPd server

used by ComPactHTTPd

used for tracing of the graphical user interface

example httpd-trace 0

meaning verbose level of the ComPactHTTPd server

used by ComPactHTTPd

used for controlling the amount of messages produced by the graphical user interface

example httpd-verbose 1

meaning defines whether or not ComPactHTTPd and prjm use the integrated version control backend to gather status information about projects, packages, and files, or if they delegate these tasks completely to external programs (which is more flexible, but rather slower). This variable will be overridden by prjm-internal-vc and httpd-internal-vc, respectively.

used by ComPactHTTPd, prjm

used for customization of GUI and project manager behaviour

example internal-vc "yes"

meaning maximum line length for generated makefiles

used by pkgm

used for building makefiles

example linebreakcol 70

meaning pathname of the directory, into which executable programs are shipped locally

used by pkgm

used for shipping

example localbindir {HOME}/bin

meaning pathname of the directory, into which documents are shipped locally

used by pkgm

used for shipping

example localdocdir {HOME}/doc

meaning pathname of the local package pool. If this is relative, the value of poolprefix is appended.

used by pkgm, poolm

used for building, pool management

example localpool local

meaning options passed to external programs as debug settings when called by ComPactHTTPd

used by ComPactHTTPd

used for debugging within the graphical user interface

example optDebug "-d"

meaning options passed to external programs as force setting when called by ComPactHTTPd

used by ComPactHTTPd

used for forcing of program actions within the graphical user interface

example optForce "-F"

meaning options passed to external programs as quieting setting when called by ComPactHTTPd

used by ComPactHTTPd

used for running programs quietly from the graphical user interface

example optQuiet "-q"

meaning options passed to external programs as verbose setting when called by ComPactHTTPd

used by ComPactHTTPd

used for running programs verbosely from the graphical user interface

example optVerbose "-v"

meaning a list of pathnames of directories where ComPactHTTPd looks for packages, separated by ;

used by ComPactHTTPd

used for customization of graphical user interface

example package-collection {HOME}/work/gnu;{HOME}/work/lisp

meaning pathname of the directory where ComPactHTTPd looks for packages

used by ComPactHTTPd

used for customization of graphical user interface

example package-collection {HOME}/work/gnu

meaning path prefix for packages that are to be checked out (used only if no collection is explicitly specified)

used by pkgm

used for checkout

example pathprefix gnu

meaning selection of the size of buttons and icons used for the graphical user interface. Possible values are

used by ComPactHTTPd

used for customization of the graphical user interface

example pics-size large

meaning One or more of these lines define the mapping from package kinds (e.g. COMPACT_CC or COMPACT_JAVA) to the corresponding backend configuration to be used. A mapping definition must be followed by three arguments: A regular expression matched against the package kind of the current package, the operator =>, and the TPC string that should be used for packages of this kind. Within the TPC string, environment variables of the form $name or ${name} will be substituted, as well as internal variables denoted by {:name}, {!name}, or {?name}. Especially useful are the following ones:

used by pkgm

used for building, shipping

example

          pkgkind-mapping ComPac[Tt]_CC => {!tpc-hosttype}-{!tpc-ostype}-{!tpc-variant}-gcc{?tpc-options}

meaning preferred package kind

used by prjm, pkgm

used for package type identification

example pkgkind DEC_SRC_M3{?platform-suffix}

meaning mapping from tpc-hosttype and tpc-ostype to a symbolic platform identifier (e.g. _UNIX or _WIN32)

used by prjm, pkgm

used for package type identification

example

           platform-suffix-mapping .*-solaris[0-9\.]* => _UNIX

meaning the path prefix for all relative pathnames of pools (localpool, projectpool, globalpool)

used by pkgm, poolm

used for definition of the location of pools

example poolprefix /usr/local/lib/pools

meaning defines whether or not the project manager uses the integrated version control backend to gather status information about projects, packages, and files, or if it delegates these tasks completely to external programs (which is more flexible, but rather slower).

used by prjm

used for customization of project manager behaviour

example prjm-internal-vc "yes"

meaning a list of pathnames of directories where ComPactHTTPd looks for project decriptions, separated by ;

used by ComPactHTTPd

used for customization of graphical user interface

example project-collection-path {HOME}/prj;{HOME}/work/projects

meaning pathname of the directory where ComPactHTTPd looks for project decriptions

used by ComPactHTTPd

used for customization of graphical user interface

example project-collection {HOME}/work/prjm

meaning pathname of the directory, into which executable programs are shipped for proects

used by pkgm

used for shipping

example projectbindir /home/prj/xqf/bin

meaning pathname of the directory, into which documents are shipped for projects

used by pkgm

used for shipping

example projectdocdir /home/prj/xqf/doc

meaning pathname of the project package pool. If this is relative, the value of poolprefix is appended.

used by pkgm, poolm

used for building, pool management

example projectpool project

meaning location of the source code repository, consisting of access method, computer name, and path, in the format used by CVS

used by pkgm, pkgvm, ComPactHTTPd

used for all version control operations

example repository cvsserv:/usr/cvs

meaning target-platform-configuration. This value is usually computed by the pkgkind-tpc-mapping in the compactrc file, so it should not be entered directly.

used by pkgm, poolm, ComPactHTTPd

used for package building and shipping, pool management

example do not use directly!

meaning part of the target platform configuration that describes the compiler

used by pkgm, poolm, ComPactHTTPd

used for pool and build management

example tpc-compiler gcc

meaning part of the target platform configuration that describes the machine architecture

used by pkgm, poolm, ComPactHTTPd

used for pool and build management

example tpc-hosttype i486

meaning optional part of the target platform configuration

used by pkgm, poolm, ComPactHTTPd

used for pool and build management

example tpc-options debug

meaning part of the target platform configuration that describes the operating system

used by pkgm, poolm, ComPactHTTPd

used for pool and build management

example tpc-ostype freebsd

meaning part of the target platform configuration that describes a special variant, often used to specify object formats etc.

used by pkgm, poolm, ComPactHTTPd

used for pool and build management

example tpc-variant i486

meaning use external program to create directories (deprecated)

used by pkgm

used for shipping

example useexternalmkdir yes

meaning use posix pathnames for external programs (deprecated)

used by pkgm

used for building, shipping

example useposixpathnames yes

meaning shell globbing pattern that defines the files that are ignored by the version control subsystem

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for version control configuration

example vc-ignore "*.bak *~ *.tmp *.obj *.o *.lib *.a"

meaning Defines the locking scheme used by Elego ComPact. Possible values are none or lazy, binary or default, all or strict. none or lazy means that no locking is performed at all. binary or default means that only binary files will be locked (i.e. protected against concurrent changes by different users). strict or all means that all files are subject to strict locking, i.e. no concurrent changes are allowed at all.

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for package editing, mutual exclusion of concurrent changes

example vc-locking "strict"

meaning special options for the version control backend

used by pkgm, pkgvm, prjm, ComPactHTTPd

used for all version control operations

example vc-options create,noprune