GBS Logo HOME Generic Build Support (GBS) - User Manual
Install Notes Bottom Doc. Button

Contents Bottom Doc. Button Top Document Button Down Section Button Blank

Description
Environment| Install Perl| Install GBS| Setup

Description Bottom Doc. Button Top Document Button Down Section Button Up Section Button

Environment Bottom Doc. Button Top Document Button Down Section Button Up Section Button Down Chapter Button Blank

OS / Shell

GBS runs on:

WSL Considerations

General

File locations
In WSL bash you can access Windows directories/files.
In Windows you cannot access WSL bash local directories/files (e.g.: ~/).
Therefore all GBS directories/files must be placed at a location accessible by Windows.
e.g.: MyDocuments or D:\Work
Install GBS on Windows
Before starting GBS on WSL you need to install it under windows.
GBS will use the same physical installation for both Windows and WSL. So you need to install Perl AND GBS under Windows. For more info on installing Perl and GBS look below.

Install WSL

Documentation can be found at: WSL Installation Guide for Windows 10
  1. Enable WSL
  2. Install your Linux Distribution of Choice
  3. Initialize the new distro
  4. Regularly Update & upgrade your distro's packages:
    sudo apt update && sudo apt upgrade

Install X Server

Documentation can be found at: Running Graphical Programs on Windows Subsystem on Linux
  1. Select an X server. E.g.: Xming and Xming fonts
    GBS was tested with Xming.
  2. Download & Install both
  3. Add export DISPLAY=localhost:0.0 to your ~/.bashrc file
    Use an editor (gedit/vim) or enter echo 'export DISPLAY=localhost:0.0' >> ~/.bashrc
    Mind the double >> !!!

Install commands using X server

Additional bash commands

Refer to the Linux Considerations below for additional bash commands.

Linux considerations

On some Linux distributions some necessary bash commands are not installed.

xterm

Open a 'Terminal'
Note: A 'Terminal' is not always an xterm
To try: enter xterm -h
To install: enter sudo apt install xterm

at

Open a 'Terminal'
To try: enter at -h
To install: enter sudo apt install at
Make sure the atd daemon runs: enter sudo atd

Install Perl Bottom Doc. Button Top Document Button Down Section Button Up Section Button Down Chapter Button Up Chapter Button

GBS is based on Perl-scripts.
Perl must be installed and the perl command must be either in the PATH or specified via an Environment-Variable (GBS_PERL_PATH).
You need at least Perl version 5.16.3

If Perl (or the proper Perl version) is not in the PATH, define an environment variable GBS_PERL_PATH to point to the top-level directory where the proper Perl is installed.
e.g.: export GBS_PERL_PATH=/opt/ActivePerl-5.26

Perl can be obtained for free via GBS was developed and tested with the Perl Distributions from ActiveState

Install

After download From ActiveState: More information: Installing ActivePerl 5.26.x

Note: There is a bug in core Perl on Windows that doesn't set up @INC correctly if Perl is installed into a directory that starts with the letter '5'. Your problem should go away if you install into something like C:\MyPrograms\perl\v5.10 instead.
This bug is at least 10 years old and somewhat related to finding additional site_lib directories when you are using the versioned directory layout scheme where multiple Perl versions share site_lib directories.
Found in Perl Monks

Install GBS Bottom Doc. Button Top Document Button Down Section Button Up Section Button Down Chapter Button Up Chapter Button

Pre-Installed

If GBS is pre-installed (local or on a network drive) your GBS Administrator will be able to tell you where GBS is installed.
You will then only need to do the Setup as explained below.

Where to Install

Several versions of GBS can be installed in a GBS_SCRIPTS_ROOT directory.
They are installed using the Hard versioned directories method.
The latest build of a version is always installed under the plain directory. E.g: 2.02
This is called the Current Build of a version. It will be overwritten with every install of the same version.
Specific Builds are installed under version_build directory. E.g.:

Toplevel Directory
GBS can be installed in two ways: If GBS is pre-installed (local or on a network drive) you will then only need to do the Setup as explained below.

The Install scripts only installs GBS (possibly on a central location).
To be able to use GBS, each user must 'Setup' GBS as explained below.
This tells GBS which of the version to use.
During the Install you have the option to execute the setup immediately after the install.

Prerequisites:
  1. Perl must be installed and the perl command must be either in the PATH or specified via an Environment-Variable (GBS_PERL_PATH).
  2. Decide where GBS will be installed (GBS_SCRIPTS_ROOT)
    GBS will provide some nice defaults, but you can also specify you own location
  3. You will need to provide a Site-ID
  4. You have the gbs .zip file in a DownloadDirectory (anywhere)

How to Install

'Install' command syntax here

Instructions for Install:
  1. Unzip the file to a new/empty temporary directory (NOT where you want to install GBS)
  2. cd to this directory (In the Navigator - if available)
    On Windows, from the Windows Explorer:
    • Run Install.bat (Single-User) or
      Run Install.bat as Administrator (Multi-User)
    On Linux:
    • If in the Navigator: Open a terminal in the current directory
    • Set the properties of Install.sh to executable:
      chmod u+x Install.sh
    • Enter:
      ./Install.sh (Single-User) or
      sudo -E ./Install.sh (Multi-User) Note the -E!
  3. Answer the questions.
    For most questions you can assume the default. (between [])
  4. When done, do not forget to cleanup the temporary unzip directory

After the Install there wil be:
  1. A 'Setup GBS [version]' shortcut on your Desktop and in System Programs
  2. An 'unzipgbs.bat' or 'unzipgbs.sh' on your Desktop.
    You can copy this file to your GBS Download parent directory and use it in the future to unzip and install GBS
Notes:
  1. Subsequent installs can be run with -q flag (quiet). This will run the script without human intervention assuming all defaults to be correct.

Setup Bottom Doc. Button Top Document Button Down Section Button Up Section Button Down Chapter Button Up Chapter Button

General

To setup GBS: What happens on Windows: What happens on Linux:
Setup command syntax here

Generic Build Support (GBS) - User Manual - Install Notes Blank Top Document Button
install.html
Copyright © Randy Marques of Randy Marques Consultancy - All rights reserved