ucs-config - Automatic configuration of UCS/Perl scripts



  ucs-config [--version | --base-dir | --perl-dir | --bin-dir | --lib-dir | --R-bin]
  ucs-config [-v | --base | --perl | --bin | --lib | -R]

  ucs-config ucs-script.pl ucs-script.R ...

  ucs-config --run [options] one-liner.perl
  ucs-config --run [options] -e '...'
  ucs-config -e '...'


The ucs-config program is used to print information about the installed UCS/Perl version and directories, as well as for the automatic configuration of UCS/Perl scripts. The program can be run in four different modes.

Invoking ucs-config without any arguments prints the UCS splash screen and a configuration summary.

In the second mode, the program prints one item of configuration information selected with one of the following flags. This mode is most suitable for use in shell scripts and makefiles. Note that you are not allowed to specify more than one flag at a time.

  --version    UCS version
  --base-dir   root directory of the UCS system
  --perl-dir   root directory of the UCS/Perl subsystem
  --bin-dir    bin/ directory of UCS/Perl (contains UCS programs)
  --lib-dir    lib/ directory of UCS/Perl (contains UCS modules)
  --R-bin      fully qualified filename of the R interpreter

The third mode is used to in-place edit Perl and R scripts so that they can load the UCS modules and libraries. For Perl scripts, ucs-config inserts a suitable shebang (#!) line, invoking the Perl interpreter for which UCS is configured together with the necessary include paths. For R scripts (which are recognised by their extension .R or .S), ucs-config looks for a line containing the command source(".../ucs.R") in the script, and inserts the correct path there. Please make sure that this line does not contain any other commands.

The final mode, introduced by the command-line switch --run, invokes the Perl interpreter with the correct UCS library path and (almost) all UCS modules pre-loaded (including the standard association measures from UCS::AM, but none of the add-on packages). The remaining command-line arguments are passed through to the Perl interpreter, which is really cool for writing one-liners in UCS/Perl. The flag -e is an abbreviation of --run -e, but does not allow any options to be passed to the interpreter.


Copyright 2004 Stefan Evert.

This software is provided AS IS and the author makes no warranty as to its use and performance. You may use the software, redistribute and modify it under the same terms as Perl itself.