GBS Logo HELP HOME Generic Build Support (GBS) - User Manual
Customisations (User) Bottom Doc. Button
Release RMC-06.02
(2024-04-29)


- Home
Getting Started
- Quick Start
- Release Notes
- Install Notes
- Create a GBS-WA/System
- FAQ
- Terms and Conditions (The Fine Print)
Basics
- Definitions & Acronyms
- Introduction
- Top Level Directory Structure
- Full Directory Structure
- Handling SubSystems & Steps
- Procedures
- Software Configuration Management Support

Manual Pages
- The Command-Line Interface
- All Commands
- The gbssys... Commands
- Generating Code (Building)
- Libraries & Executables and Testing
- Exporting Deliverables
- Auditing
- Customisations (Session)
- Customisations (User)
- Customisations (Admin)
- Integration with other Tools
- Plugins (Admin)
- Environment Variables (EnvVars)
User Files
- The GLKBT (glk/glb/glt) Files
Internal (.gbs) Files
- GBS Files - General
- audit.gbs
- broadcast.gbs
- build.gbs
- export.gbs
- flags_*.gbs
- subsys.gbs (.bat/.sh)
- incs_*.gbs
- owners.gbs
- sca_*.gbs
- scope.gbs
- site.gbs (.bat/.sh)
- steps.gbs
- switch.gbs (.bat/.sh)
- system.gbs
- tool.gbs
Various
- Development
- About
- Metrics Help

Full Documentation
- All Docs - Printable


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

Description

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

GBS has a few user customisation possibilities.
Most are set by the gbssettings command
Index

Perl Directory (GBS_PERL_PATH) Bottom Doc. Button Top Document Button Down Section Button Up Section Button Down Chapter Button Blank

Name:

GBS_PERL_PATH

Purpose:

Define an specific directory to find the Perl executable
To be used when (the wanted) perl is not in the PATH
Specifies the top-directory of the Perl installation (the directory containing 'bin')

Default:

Empty (Find Perl via PATH)

Where:

In Registry (Windows) My Computer → Properties → Advanced → Environment Variables
or ~/.profile or ~/.bash_profile

Define:

Linux
export GBS_PERL_PATH=your_perl_path
Windows
SET GBS_PERL_PATH=your_perl_path

gbssettings command Bottom Doc. Button Top Document Button Down Section Button Up Section Button Down Chapter Button Up Chapter Button

With the gbssettings command you can set/change:
  1. Change Profile Settings
  2. Change Config Settings
  3. Fix Startup Settings (Shortcuts, startup-scripts, etc)
  4. Move GBS_BASE_PATH

Site-ID

GBS_SITE

Purpose:

To identify the location where the user works
It is used in the switch.gbs to cater for different IT infrastructures (e.g. different locations of compilers, network drives, etc)
You will only really need it if people work from different site-locations on the same code.
A good name is an abbreviation of the town or site. Just make sure it is unique for the future.
Keep the name short and in uppercase. Consider using the 3-letter IATA Airport Code of a nearby airport.

Default:

MAIN

LogRoot

GBS_LOG_ROOT

Purpose:

To define the location of the logfile-directories per System
GBS_LOG_PATH=$GBS_LOG_ROOT/$GBS_SYSTEM_PARENT

Defaults:

Linux
~/Documents/GBSLogs
Windows
%MyDocuments%\GBSLogs

Home

GBS_HOME_PATH

Purpose:

Set the CWD when no current System and Default Root for GBS user directories

Default:

Linux
~/Documents
Windows
%MyDocuments%

Beeps

GBS_BEEBS

Purpose:

To switch the 'beep' on the command-line on or off

Default:

YES

Company

Generic

Purpose:

To identify your Company and/or Project
It is shown in the login-banner, logfile-banner and in the top of generated HTML-files like gbssilo.
You can put any text, even your own name here.

Default:

My Company

Ignores

Generic

Purpose:

TBS

Default:

None

Notify

Per Platform

Purpose:

To provide a different default for the --n (notify) option in the gbssys* functions

Default:

YES

Editor

Per Platform

Purpose:

Define a text-editor (for gbsedit and gbsmaint 9 ('Owners-file' Maintenance)

Defaults:

Linux
$EDITOR, gedit, nano, vim
Windows
Notepad

Browser

Per Platform

Purpose:

Define a HTML Browser (for gbshelp and gbsaudit)

Defaults:

Linux
Firefox, links2, links
Windows
Default HTML Browser (Internet Explorer)

Per Platform

Purpose:

Define a program to navigate directory structure
Used by gbsgui

Defaults:

Linux
Default Navigator (GNOME Files)
Windows
Windows Explorer

Viewer

Per Platform

Purpose:

Define a text-viewer (for viewing batch log-files)

Defaults:

Linux
less
Windows
Notepad

Terminal

TERMINAL

Purpose:

Define Terminal settings for when a new Terminal window is opened
You can set:
  • Terminal type:
    • Windows: cmd_console (CMD), Windows Console (WT)
    • WSL: wsl_console, xterm, gnome_terminal, konsole, uterm
    • Linux: xterm, gnome_terminal, konsole, uterm
  • Foreground colour (not all terminals)
  • Background colour (not all terminals)
  • Number of columns (not all terminals)
  • Number of rows (not all terminals)

Default:

Linux
gnome_terminal/konsole/xterm white black 120 45
Windows
cmd_console white black 120 45
WSL
wsl_console/gnome_terminal/konsole/xterm white black 120 45

Administrator

ADMINISTRATOR

Purpose:

Define/Remove the current user as Administrator for this System
Administrator privilege is required for all changes to the infrastructure. E.g.: create a new component.
It is just a token privilege. You will be warned every time you try to do a privileged action. You can always override.
This is a safety issue, warning you that you are changing something special for which you probably need permission of the System / Code Architect.

Default:

None

Integrator

INTEGRATOR

Purpose:

Define/Remove the current user as Integrator for this System
Integrator privilege is required for the execution of some special functions ad defined in gbsmaint 6:
  • Consolidate Audit results
  • Set GBS Version Limits
It is just a token privilege. You will be warned every time you try to do a privileged action. You can always override.
This is a safety issue, warning you that you are doing something irreversible.

Default:

None

GBS Command Prompt Window (gbscmd.bat / .sh) Bottom Doc. Button Top Document Button Blank Up Section Button Blank Up Chapter Button

You can customize your GBS Command Prompt DOS-box/xterm by placing shell commands in a private startup file: 'gbscmd.bat / .sh' in your GBS_BASE_PATH directory:
Please note the following:
  1. It is only executed in Interactive sessions.
  2. Do not place any GBS-related items in this file.
  3. Placing any GBS-related items in this file may cause GBS to malfunction.
    If not today: probably in the future.

custom_user.html