4. Environment

This section shows all environment variables that are relevant to compiling and running the CF programs. Only the first three variables affects the build of the CF programs.

PATH

This is the path for programs. If XULRunner is installed in PREFIX $P, this can be extended with:

	 PATH=$P/bin:$PATH
	 export PATH
	

This variable should be set both for compiling the CF programs and when running the CF programs.

PKG_CONFIG_PATH

This is the path for the pkg-config system. If XULRunner is installed in PREFIX $P, this can be extended with:

	 PKG_CONFIG_PATH=$P/lib/pkgconfig
	 export PKG_CONFIG_PATH
	

This variable only affects compilation of the CF programs.

GRE_HOME

GRE_HOME is used by Xulrunner. For earlier releases of CF - using Xulrunner 1.9 - this could be changed at runtime for a specific version of Xulrunner. This is no longer suppported. The GRE_HOME should not be set.

CF_MODULE_PATH

This variable tells the CF programs where the JavaScript modules for running a connector is located. These modules is bascially the shared code between the CF Engine and the CF Builder. The run-time is located in directory builder/modules of the CF distribution. This variable is a run-time only setting. The directory and the contents needs to be readable by the CF programs. No write-permission is needed.

Note

The directory specified must be absolute path

CF_CONNECTOR_PATH

This variable tells the cf-zserver where the Connectors files are located. These files all have suffix .cf. The connector files are located in directory connectors of the CF distribution. This variable is a run-time only setting. The directory and the contents needs to be readable by the CF programs. No write-permission is needed.

Note

The directory specified must be absolute path

CF_APP_PATH

This variable specifies an application directory for CF browser. This directory must include the two directories components and defaults which is or is a copy-of the same directories from engine/src from the CF distribution. This variable is a run-time only setting. The directory and the contents needs to be readable by the CF programs. No write-permission is needed. If this variable is not set, the application path is assumed to be current working directory.

Note

The directory specified must be absolute path

CF_PROFILE_PATH

This variable specifies an application directory for CF browser. This directory holds profile directories for the browser - including cache. It should be both readable and writable.

If this variable is unset or has en empty value, the Engine will use a temporary profile (per instance) in a directory named /tmp/cf_profile_XXXXXX where the 6'X are dynamically assigned by mkdtemp.

Note

The directory specified must be absolute path

CF_BASE_PATH

This variable is a convenience variable read by the cf-zserver server. The value of the variable should be the directory of the CF distribution - for example /home/adam/proj/cf-2.0. When set, cf-zserver will assume that connectors/modules are located in connectors and builder/modules . This variable serves as an alternative to CF_CONNECTOR_PATH / CF_MODULE_PATH.

Note

The directory specified must be absolute path

CF_REPO_FETCH_URL

This variable applies to cf-zserver. It is a URL recipe for how to fetch a connector remote remotely via a Web service. Connector files are only fetched this way if CF_BASE_PATH and CF_CONNECTOR_PATH are both unset.

The URL recipe must include the two character sequence %s . This sequence is substituted with the Z39.50 database. For example http://host/cf.pl?%s.cf which will fetch database X from the URL http://host/cf.pl?X.cf.

The connector file is fetched via HTTP GET. If Z39.50 username and password is supplied during a Z39.50 session this is passed in the HTTP request using Basic HTTP Authentication.

CF_REPO_AUTH_URL

This variable applies to cf-zserver. It is a URL recipe for how to authenticate a user during Z39.50 session initialization.

If username and password is supplied in the Z39.50 Initialize Request, these are passed as parameters for Basic HTTP authentication. Unlike CF_REPO_FETCH_URL there is no substitution taking place.

CF_REPO_PROXY

This specifies a HTTP proxy to be used for HTTP requests for authenticaton and CF file fetch (CF_REPO_AUTH_URL / CF_REPO_FETCH_URL).

CF_TMP_DIR

This variable applies to cf-zserver and metaproxy module. It is a directory which holds temporary files for these applications and it must be writable.

DISPLAY

This environment specifies the X11 server for display.

CF_DISPLAY_LOCK

When this environment variable is set, the CF engine will spawn an Xvfb process on its own. The value is a directory that holds lock files of the form Xvfb.$i.LCK, where $i is the display number (:$i.0).

Note

This variable was introduced in CF 2.10, and replaces CF_XVFB_LOCKDIR.

CF_DISPLAY_CMD

Specifies the Xvfb program and arguments to be used when CF spawn Xvfb children on its own. Used as supplement to CF_DISPLAY_LOCK. If this variable is not, set a value of Xvfb -ac -screen 0 1024x768x24 is used.