HELP HOME Generic Build Support (GBS) - User Manual
All Commands

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

Description

General

All commands have the format: command [args | gbs-options]...
gbs-options always start with: -- (hyphen hyphen)
General options (always available):

--h
--help

General options (mostly available):

--verbose
--inc

	command --h		will give you short help
	command --h option...		will give you short help on the specified option(s)
	command --help		will give you more extensive help
	command --help option...		will give you long help on the specified option(s)
	--verbose[+\|-]		Extensive logging messages if '' or '+' Always '+' in BATCH jobs (gbssys* commands)
	--inc file		will take the contents of file file as if it were typed on the commandline. Empty lines and lines starting with '#' are ignored. Multiple occurrence and nesting is allowed.

General Syntax Description

Refer to The Command Line Interface

Index

Install.bat, _gbssetup.bat, bgpids, detab, filerep, fixeol, gbs, gbsaudit, gbsbash, gbsbg, gbsbldcheck, gbsbuild, gbsdebug, gbsedit, gbsexit, gbsexport, gbsgui, gbshelp, gbsinit, gbslocate, gbsmaint, gbsmake, gbsmakemake, gbsman, gbsmanage, gbsnav, gbsscm, gbssettings, gbsshow, gbssilo, gbsstart, gbsstart_here, gbsstats, gbssudo, gbsswa, gbsswb, gbsswc, gbsswr, gbssws, gbsswt, gbssysall, gbssysaudit, gbssysbuild, gbssysmake, gbssystool, gbswhich, gbswsl, gbsxref, grep, pgrep, proto, swa, swb, swc, swr, sws, swt, tail, touch, win2unix, wordrep, wsudo

bgpids (Non-GBS - Linux only)

Purpose:

Show and/or kill background processes

Syntax:

bgpids [ USERS... ]: [ -a[+|-] ]; [ -f[+|-] ]; [ -k=process_to_kill ]

Semantics:

`<*>`	USERS string array optional	<empty> == current user Default=
`-a[+\|-]`	do_all boolean scalar optional	Include all processes Default=0
`-f[+\|-]`	do_fg boolean scalar optional	Include parent (foreground) processes Default=0
`-k=process_to_kill`	process_to_kill integer scalar optional	Kill specified process-tree Default=

gbs

The gbs command will either startup GBS if not started or show the GBS currencies

Startup: refer to gbsinit
Show currencies: refer to gbsshow

gbsinit (gbs - Before GBS is started )

Purpose:

Startup GBS

Syntax:

gbsinit: [ --nos[+|-] ]

Semantics:

--nos[+|-] noswitch
boolean
scalar optional Do not implicitly swr to current System
Default=0

Note:

Alias for this command is 'gbs'. Exists only when GBS was not yet started

gbsaudit

Purpose:

Perform an AUDIT on one or more files

Syntax:

gbsaudit ...: [ --i[+|-] ]; [ --stdout[+|-] ]; [ --vs[+|-] ]; [ --aud[+|-] ]; [ --sum[+|-] ]; [ --caller=caller ]; [ --threads=threads ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	comp_file_opts string array mandatory	src-files and AUDIT-options. ALL = :.* Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue auditing after error(s) Default=0
`--stdout[+\|-]`	show_stdout boolean scalar optional	Show errorlines (0 when not interactive) Default=1
`--vs[+\|-]`	view_sum boolean scalar optional	View summary at completion Default=1
`--aud[+\|-]`	run_audit boolean scalar optional	Run audit Default=1
`--sum[+\|-]`	run_summary boolean scalar optional	Create summary Default=1
`--caller=caller`	caller string scalar optional choice: gbsaudit gbssysaudit	Internal use. Default=gbsaudit
`--threads=threads`	threads integer scalar optional range: 1..9	Max. nr. parallel threads Default=2

Environment Variables:

(GBS_) LOG_PATH	(GBS_) MODE	(GBS_) FLAGS_*
(GBS_) APP_*

Note:

Summary files are written to $GBS_LOG_PATH. View with gbssilo

gbsbash (gbswsl)

Purpose:

The gbsbash command opens a new WSL bash window
Only available on Windows

Syntax:

gbsbash

Semantics:

None

gbsbldcheck

Purpose:

Check if all files have generated

Syntax:

gbsbldcheck [ subsystems... ]: [ --m=max_missing ]; [ --builds=builds,... ]

Semantics:

`<*>`	subsystems string array optional	Specific SubSystems Default=
`--m=max_missing`	max_missing integer scalar optional	Cancel SubSys check after this many missing files Default=20
`--builds=builds`	builds string array optional	(wild-)Builds to Build-Check. '' or '*' == All, '.' == Current Default=

gbsbg

Purpose:

Allow user to handle Background Jobs
1. Show Jobs
2. View Cur Logfile
3, Tail Cur Logfile
4. Cleanup List
5. View Logfile
...
9. Kill Job

Syntax:

gbsbg [ menu_entries... ]

Semantics:

<*> menu_entries
integer
array optional
greater: 0 Menu entries for immediate execution
Default=

gbsdebug

Purpose:

Enable and Disable Debug
1. Enable Debug
2. Disable Debug

Syntax:

gbsdebug [ selector ] [ debug_name ]: [ --app=application ]

Semantics:

`<1>`	selector string scalar optional choice: 1 2 show enable disable	Menu entry or show/enable/disable Default=
`<2>`	debug_name string scalar optional	Menu entry or EnvName to enable/disable Default=
`--app=application`	application string scalar optional choice: GBS TOOLS PRQA CPPTEST	Application to debug. E.g.: GBS TOOLS Default=GBS

gbsedit

Purpose:

Create/edit GBS-files and user-files. GBS-files end with .gbs
The switch.gbs, subsys.gbs and site.gbs batch files are also considered GBS-files
Source, Include and glkbt-files are considered user-files
Relevant templates will be used with file-creation
On GBS files, where possible, a syntax check is performed after the edit.

Syntax:

gbsedit <basic_filespec> [ editor_opt ]: [ --nco[+|-] ]

Semantics:

`<1>`	basic_filespec string scalar mandatory	file, ./file, rel_filespec, filespec or subdir:file Default=
`<2>`	editor_opt string scalar optional	Editor option. e.g. Line-nr to jump to Default=
`--nco[+\|-]`	no_checkout boolean scalar optional	By default files will also be added if non-exist Default=0

gbsexit

Purpose:

Cleanup and exit the GBS environment

Syntax:

gbsexit: [ --quit[+|-] ]; [ --restart[+|-] ]

Semantics:

`--quit[+\|-]`	quit boolean scalar optional	Do not setup the basic GBS functions Default=0
`--restart[+\|-]`	restart boolean scalar optional	Restart GBS after exit Default=0

Constraints:

The following combinations are not allowed:

--quit+

AND

--restart+

gbsexport

Purpose:

Fill the export and/or res directories from the Components and/or Gen or SubSystem by Build

Syntax:

gbsexport [ export_file_locations... ]: [ --i[+|-] ]; [ --c[+|-] ]; [ --show[+|-] ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	export_file_locations string array optional	<Component>... and/or SUBSYS: . == Current Component. <empty> == <all> Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--c[+\|-]`	cleanup_all boolean scalar optional	Delete all, independent from build Default=0
`--show[+\|-]`	show_actions boolean scalar optional	Show all actions Default=0

Environment Variables:

(GBS_) APP_*

gbsbuild

Purpose:

Generate one or more files

Syntax:

gbsbuild ...: [ --i[+|-] ]; [ --threads=threads ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	comp_file_opts string array mandatory	src files to generate with 'generate' options. ALL = :.* Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation regardless of error(s) Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads Default=2

Environment Variables:

(GBS_) DEBUGGER	(GBS_) MODE	(GBS_) OPT
(GBS_) MAP	(GBS_) FLAGS_*	(GBS_) APP_*

gbsgui

Purpose:

Startup the GBS GUI

Syntax:

gbsgui: [ --t[+|-] ]; [ --geo=geo ]

Semantics:

`--t[+\|-]`	test_mode boolean scalar optional	Run in test-mode Default=0
`--geo=geo`	geo string scalar optional	Start geometry - Internal use (width, height, x, y) Default=.

gbshelp

Purpose:

Present help on GBS in HTML browser

Syntax:

gbshelp

Semantics:

None

gbslocate

Purpose:

Locate a file according to include-settings and assigns the location to a specified Environment Variable

Syntax:

gbslocate <env_name> <file> <prefix> ...

Semantics:

`<1>`	env_name string scalar mandatory	Env Variable to contain the filespec Default=
`<2>`	file string scalar mandatory	The file to search Default=
`<3>`	prefix string scalar mandatory	prefix string preceding all path-list elements. e.g: -I Default=
`<*>`	path-list string array mandatory	The directories to search preceded by <prefix> Default=

gbsmaint

Purpose:

Allow user to execute General Maintenance functions
1. Audits Handling
2. Cleanup
3. Map Network Drives (Linux<->Windows)
5. User Tools
6. Integrator Tools
7. Administrator Tools
8. Check/Fix GBS Directory Structure
9. Owners-file Maintenance

Syntax:

gbsmaint [ menu_entries... ]

Semantics:

<*> menu_entries
integer
array optional
greater: 0 Menu entries for immediate execution
Default=

gbsmake

Purpose:

'make' one or more files

Syntax:

gbsmake [ comp_file_opts... ]: [ --r[+|-] ]; [ --i[+|-] ]; [ --mo[+|-] ]; [ --threads=threads ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	comp_file_opts string array optional	bld files to make with 'make' options. ALL = :.* Default=
`--r[+\|-]`	reverse_type boolean scalar optional	Specify source-types instead of build-types Default=0
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--mo[+\|-]`	make_only boolean scalar optional	Run 'make' only (show make results) Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads Default=2

Environment Variables:

(GBS_) DEBUGGER	(GBS_) MODE	(GBS_) OPT
(GBS_) MAP	(GBS_) FLAGS_*	(GBS_) APP_*

gbsmakemake

Purpose:

Make make-file(s) for the current SubSystem

Syntax:

gbsmakemake [ components... ]: [ --i[+|-] ]

Semantics:

`<*>`	components string array optional	. == current component, <empty> == all Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0

gbsman

Purpose:

The gbsman command gives a 'more' list of all GBS commands

Syntax:

gbsman

Semantics:

None

gbsnav

Purpose:

Startup the Navigator in the current or specified directory

Syntax:

gbsnav [ dir_path ]

Semantics:

<1> dir_path
string
scalar optional Existig directory path or '.'
Default=

gbsscm (scm)

Purpose:

Execute basic SCM commands using the current SCMS

Syntax:

gbsscm <command> [ files... ]: [ --r[+|-] ]; [ --c[+|-] ]

Semantics:

`<1>`	command string scalar mandatory choice: ? info state co ci unco mkdir mktxt add move get_ignore set_ignore remove import connect select	Basic SCM Command Default=
`<*>`	files string array optional	File / Directory List Default=
`--r[+\|-]`	recursive boolean scalar optional	Add whole directory tree Default=0
`--c[+\|-]`	use_cache boolean scalar optional	Use cache Default=0

Note:

info
state   <file-dir>...
co      <file-dir>...
ci      <file-dir>...
unco    <file-dir>...
mkdir   <dir>...
mktxt   <file>...
add     <file-dir>...
get_ignore  <dir>
set_ignore  <dir> <ignore_list>...
remove  <file-dir>...
import  <from-dir> [<to-dir>]
connect
select

gbssetup

This command has been replaced by gbssettings

gbssettings (gbssettings.bat or gbssettings.sh)

Purpose:

Setup/Maintain Basic GBS settings (Profile(EnvVars) and Config).

Syntax:

gbssettings [ menu_entries... ]

Semantics:

<*> menu_entries
integer
array optional
greater: 0 Menu entries for immediate execution
Default=

More information here

gbsmanage (gbsmanage.bat or gbsmanage.sh)

Purpose:

Unsetup/Uninstall GBS version(s).
Cannot execute in GBS context

Syntax:

gbsmanage [ menu_entries... ]

Semantics:

<*> menu_entries
integer
array optional
greater: 0 Menu entries for immediate execution
Default=

gbsshow (gbs)

Purpose:

Show GBS currencies

Syntax:

gbsshow: [ --brief[+|-] ]

Semantics:

--brief[+|-] brief
boolean
scalar optional Brief (short) listing
Default=0

gbssilo

Purpose:

Generate silo index and show in HTML browser

Syntax:

gbssilo: [ --ci[+|-] ]; [ --cs[+|-] ]; [ --vi[+|-] ]; [ --noc[+|-] ]

Semantics:

`--ci[+\|-]`	create_index boolean scalar optional	Create the HTML Index Default=1
`--cs[+\|-]`	create_summaries boolean scalar optional	Create the HTML Summaries Default=1
`--vi[+\|-]`	view_index boolean scalar optional	View index in HTML browser Default=1
`--noc[+\|-]`	no_create boolean scalar optional	No HTML Creation (forces --ci and --cs to '-') Default=0

Constraints:

The following combinations are not allowed:

--noc+

AND

--ci+ or --cs+

gbssysaudit

Purpose:

Perform an AUDIT on part of or whole System

Syntax:

gbssysaudit [ steps... ]: [ --i[+|-] ]; [ --vs[+|-] ]; [ --audits=audits,... ]; [ --builds=builds,... ]; [ --files=files,... ]; [ --aud[+|-] ]; [ --sum[+|-] ]; [ --fg[+|-] ]; [ --at=delay ]; [ --n[+|-] ]; [ --wait[+|-] ]; [ --threads=threads ]; [ --c=comment ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	steps string array optional	Steps and/or Aliases. <empty> == all select steps, 'CUR', 'ALL' == force all steps, 'CUR', '?' == show steps Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--vs[+\|-]`	view_sum boolean scalar optional	View summary at completion Default=1
`--audits=audits`	audits string array optional choice: . $GBS_AUDITS	(wild-)Audits to run. '' or '' == All, '.' == Current Default=
`--builds=builds`	builds string array optional choice: . $GBS_BUILDS	(wild-)Builds to Build. '' or '' == All, '.' == Current Default=
`--files=files`	files string array optional	Files to audit Default=:.*
`--aud[+\|-]`	run_audit boolean scalar optional	Run audit Default=1
`--sum[+\|-]`	run_summary boolean scalar optional	Create summary Default=1
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	delay time ([+=]hh:mm or [+=]mm) or now) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=$notify
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg threads Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads within a submitted job Default=2
`--c=comment`	comment string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

The following combinations are not allowed:

*<> = ALL**	AND	*<>**
*<> = CUR**	AND	*<> or --audits or --builds**
*<> = ?**	AND	*<>**
--fg+	AND	--at or --n+ or --wait+
--wait+	AND	--n+
--sum-	AND	--vs+

Environment Variables:

(GBS_) LOG_PATH

(GBS_) FLAGS_*

(GBS_) APP_*

Note:

Summary files are written to $GBS_SILO_PATH/audits. View with gbssilo
See also: The gbssys... commands
Use gbsbg command to View and/or Kill a Job

gbssysbuild

Purpose:

Generate part of or whole System

Syntax:

gbssysbuild [ steps... ]: [ --i[+|-] ]; [ --mm[+|-] ]; [ --export[+|-] ]; [ --builds=builds,... ]; [ --files=files,... ]; [ --fg[+|-] ]; [ --at=delay ]; [ --n[+|-] ]; [ --wait[+|-] ]; [ --threads=threads ]; [ --c=comment ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	steps string array optional	Steps and/or Aliases. <empty> == all select steps, 'ALL' == force all steps, '?' == show steps Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--mm[+\|-]`	run_makemake boolean scalar optional	Run 'gbsmakemake' on completion of Full GBS SubSystems Default=1
`--export[+\|-]`	run_export boolean scalar optional	Run 'gbsexport' on completion Default=1
`--builds=builds`	builds string array optional choice: . $GBS_BUILDS	(wild-)Builds to Build. '' or '' == All, '.' == Current Default=
`--files=files`	files string array optional	Files to build Default=:.*
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	delay time ([+=]hh:mm or [+=]mm) or now) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=$notify
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg threads Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads within a submitted job Default=2
`--c=comment`	comment string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

The following combinations are not allowed:

*<> = ALL**	AND	*<>**
*<> = CUR**	AND	*<> or --builds**
*<> = ?**	AND	*<>**
--fg+	AND	--at or --n+ or --wait+
--wait+	AND	--n+

Environment Variables:

(GBS_) LOG_PATH	(GBS_) DEBUGGER	(GBS_) MODE
(GBS_) OPT	(GBS_) MAP	(GBS_) FLAGS_*
(GBS_) APP_*

See also: The gbssys... commands
Use gbsbg command to View and/or Kill a Job

gbssysmake

Purpose:

Generate part of or whole System using 'make'

Syntax:

gbssysmake [ steps... ]: [ --i[+|-] ]; [ --smm[+|-] ]; [ --mm[+|-] ]; [ --export[+|-] ]; [ --builds=builds,... ]; [ --files=files,... ]; [ --fg[+|-] ]; [ --at=delay ]; [ --n[+|-] ]; [ --wait[+|-] ]; [ --threads=threads ]; [ --c=comment ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	steps string array optional	Steps and/or Aliases. <empty> == all select steps, 'CUR', 'ALL' == force all steps, '?' == show steps Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--smm[+\|-]`	start_makemake boolean scalar optional	Pre-generate the make-file Default=1
`--mm[+\|-]`	run_makemake boolean scalar optional	Run 'gbsmakemake' on completion of Full GBS SubSystems Default=1
`--export[+\|-]`	run_export boolean scalar optional	Run 'gbsexport' on completion Default=1
`--builds=builds`	builds string array optional choice: . $GBS_BUILDS	(wild-)Builds to Build. '' or '' == All, '.' == Current Default=
`--files=files`	files string array optional	Files to make Default=:.*
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	delay time ([+=]hh:mm or [+=]mm) or now) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=$notify
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg threads Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads within a submitted job Default=2
`--c=comment`	comment string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

The following combinations are not allowed:

*<> = ALL**	AND	*<>**
*<> = CUR**	AND	*<> or --builds**
*<> = ?**	AND	*<>**
--fg+	AND	--at or --n+ or --wait+
--wait+	AND	--n+

Environment Variables:

(GBS_) LOG_PATH	(GBS_) DEBUGGER	(GBS_) MODE
(GBS_) OPT	(GBS_) MAP	(GBS_) FLAGS_*
(GBS_) APP_*

See also: The gbssys... commands
Use gbsbg command to View and/or Kill a Job

gbssystool

Purpose:

Perform TOOL on part of or whole System

Syntax:

gbssystool [ steps... ]: [ --i[+|-] ]; [ --vs[+|-] ]; [ --tools=tools,... ]; [ --fg[+|-] ]; [ --at=delay ]; [ --n[+|-] ]; [ --wait[+|-] ]; [ --threads=threads ]; [ --c=comment ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	steps string array optional	Steps and/or Aliases. <empty> == all select steps, 'CUR', 'ALL' == force all steps, '?' == show steps Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--vs[+\|-]`	view_sum boolean scalar optional	View summary at completion Default=1
`--tools=tools`	tools string array optional choice: . $GBS_TOOLS	(wild-)Tools to execute. '' or '' == All, '.' == Current Default=
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	delay time ([+=]hh:mm or [+=]mm) or now) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=$notify
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg threads Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads within a submitted job Default=2
`--c=comment`	comment string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

The following combinations are not allowed:

*<> = ALL**	AND	*<>**
*<> = CUR**	AND	*<> or --tools**
*<> = ?**	AND	*<>**
--fg+	AND	--at or --n+ or --wait+
--wait+	AND	--n+

Environment Variables:

(GBS_) LOG_PATH

(GBS_) FLAGS_*

(GBS_) APP_*

Note:

Output files (Summary files) are written to $GBS_SILO_PATH/audits. View with gbssilo
See also: The gbssys... commands
Use gbsbg command to View and/or Kill a Job

gbssysall

Purpose:

Execute gbssysbuild/gbssysmake, gbssysaudit and gbssystool commands

Syntax:

gbssysall [ steps... ]: [ --i[+|-] ]; [ --vs[+|-] ]; [ --audits=audits,... ]; [ --builds=builds,... ]; [ --tools=tools,... ]; [ --current[+|-] ]; [ --files=files,... ]; [ --make[+|-] ]; [ --fg[+|-] ]; [ --at=delay ]; [ --n[+|-] ]; [ --wait[+|-] ]; [ --threads=threads ]; [ --c=comment ]; [ Environment_Variable=Value ]...

Semantics:

`<*>`	steps string array optional	Steps and/or Aliases. <empty> == all select steps, 'ALL' == force all steps, '?' == show steps Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation after error(s) Default=0
`--vs[+\|-]`	view_sum boolean scalar optional	View summary at completion Default=1
`--audits=audits`	audits string array optional choice: . $GBS_AUDITS	(wild-)Audits to run. '' or '' == All, '.' == Current Default=
`--builds=builds`	builds string array optional choice: . $GBS_BUILDS	(wild-)Builds to Build. '' or '' == All, '.' == Current Default=
`--tools=tools`	tools string array optional choice: . $GBS_TOOLS	(wild-)Tools to Execute. '' or '' == All, '.' == Current, '-' == None Default=
`--current[+\|-]`	current boolean scalar optional	Sets --audits, --builds and --tools to '.' (current) Default=0
`--files=files`	files string array optional	Files to audit Default=:.*
`--make[+\|-]`	make boolean scalar optional	Run gbssysmake instead of gbssysbuild Default=0
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	delay time ([+=]hh:mm or [+=]mm) or now) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=$notify
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg threads Default=0
`--threads=threads`	threads integer scalar optional range: 1..9	Max nr parallel threads within a submitted job Default=2
`--c=comment`	comment string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

The following combinations are not allowed:

*<> = ALL**	AND	*<>**
*<> = CUR**	AND	*<> or --audits or --builds or --tools**
*<> = ?**	AND	*<>**
--current+	AND	--audits or --builds or --tools
--fg+	AND	--at or --n+ or --wait+
--wait+	AND	--n+

Environment Variables:

(GBS_) LOG_PATH

(GBS_) FLAGS_*

(GBS_) APP_*

Note:

Commands are only executed if applicable
See also: The gbssys... commands
Use gbsbg command to View and/or Kill a Job

gbsstart (%GBS_BOOT_PATH%\gbsstart.bat or $GBS_BOOT_PATH/gbsstart.sh)

Purpose:

Startup GBS and execute a (GBS) command. To be used for integration of GBS in other tools

Syntax:

gbsstart <system_spec> [ subsystem ] [ component ]: [ --build=build ]; [ --audit=audit ]; [ --tool=tool ]; --exec=execute_command

Semantics:

`<1>`	system_spec string scalar mandatory	System: '-' == none, '.' == current, '!' == CWD, '!<abs_file/dir_spec>', '!!' == CWD = GBS_SYSTEM_PATH Default=!
`<2>`	subsystem string scalar optional	SubSystem: '-' == none, '.' or '' == current Default=
`<3>`	component string scalar optional	Component: '-' == none, '.' or '' == current Default=
`--build=build`	build string scalar optional	Build: '-' == none, '.' or '' == current Default=.
`--audit=audit`	audit string scalar optional	Audit: '-' == none, '.' or '' == current Default=.
`--tool=tool`	tool string scalar optional	Toolt: '-' == none, '.' or '' == current Default=.
`--exec=execute_command`	execute_command string scalar mandatory	(GBS-)Command to execute. 'none' = OK Default=

Constraints:

The following combinations are not allowed:

<1> = -	AND	<2>
<1> = -	AND	<3>
<2> = -	AND	<3>

More info:

For Tools integration purposes, use the replacing gbsstart_here command.

gbsstart_here (%GBS_BOOT_PATH%\gbsstart_here.bat or $GBS_BOOT_PATH/gbsstart_here.sh)

Purpose:

Startup GBS and execute a (GBS) command, using the CWD.
To be used for integration of GBS in other Development Tools / Editors.
Replaces 'gbsstart' in most situations

Syntax:

gbsstart_here <gbs_command> [ gbs_command_args... ]

Semantics:

`<1>`	gbs_command string scalar mandatory	GBS command. e.g.: gbsbuild Default=
`<*>`	gbs_command_args string array optional	GBS command args, including --options Default=

More info:

Integration with other Tools

gbsstats

Purpose:

Show GBS System Statistics

Syntax:

gbsstats: [ --lines[+|-] ]; [ --cs[+|-] ]; [ --vi[+|-] ]

Semantics:

`--lines[+\|-]`	count_lines boolean scalar optional	Count lines in src, inc and loc Default=0
`--cs[+\|-]`	create_stats boolean scalar optional	Create the HTML Statistics Default=1
`--vi[+\|-]`	view_index boolean scalar optional	View index in HTML browser Default=1

swc (gbsswc)

Purpose:

Set and/or Create new Current Component

Syntax:

gbsswc swc [ component ]: [ --build=build ]; [ --audit=audit ]; [ --new[+|-] ]; [ --delete[+|-] ]; [ --nocd[+|-] ]

Semantics:

`<1>`	component string scalar optional	Component: '' == ASK, '-' == none, '.' == current Default=
`--build=build`	build string scalar optional	Build: '-' == none, '.' == current Default=
`--audit=audit`	audit string scalar optional	Audit. '-' == none, '.' == current Default=
`--new[+\|-]`	create_component boolean scalar optional	Create a new Component Default=0
`--delete[+\|-]`	delete_component boolean scalar optional	Delete a Component Default=0
`--nocd[+\|-]`	no_cd boolean scalar optional	Do not 'cd' to the selected directories Default=0

Constraints:

The following combinations are not allowed:

--new+	AND	--delete+ or --build or --audit
--delete+	AND	--new+ or --build or --audit
<1> = -	AND	--new+ or --delete+ or --build or --audit

swr (gbsswr)

Purpose:

Set a current System or
- Create a new one
- Add / Remove one from the Systems-List
- Delete one
- Show the Systems-List

Syntax:

gbsswr swr [ system_spec ] [ subsystem ] [ component ]: [ --build=build ]; [ --audit=audit ]; [ --tool=tool ]; [ --new[+|-] ]; [ --add[+|-] ]; [ --remove[+|-] ]; [ --delete[+|-] ]; [ --show[+|-] ]; [ --exec=execute_command ]; [ --nocd[+|-] ]

Semantics:

`<1>`	system_spec string scalar optional	System: <abs_or_relspec>, '' == ASK, '-' == none, '.' == current, '!' == CWD, '!<abs_or_relspec>' (search), '!!' == current GBS_SYSTEM_PATH Default=
`<2>`	subsystem string scalar optional	SubSystem: '-' == none, '.' == current Default=
`<3>`	component string scalar optional	Component: '-' == none, '.' == current Default=
`--build=build`	build string scalar optional	Build: '-' == none, '.' == current Default=
`--audit=audit`	audit string scalar optional	Audit: '-' == none, '.' == current Default=
`--tool=tool`	tool string scalar optional	Tool: '-' == none, '.' == current Default=
`--new[+\|-]`	create_system boolean scalar optional	Create a new System Default=0
`--add[+\|-]`	add_system boolean scalar optional	Add a System to the Systems-List Default=0
`--remove[+\|-]`	remove_system boolean scalar optional	Remove a System from the Systems-List - do not Delete Default=0
`--delete[+\|-]`	delete_system boolean scalar optional	Remove and Delete a System from the Systems-List Default=0
`--show[+\|-]`	show_systems boolean scalar optional	Show the Systems-List Default=0
`--exec=execute_command`	execute_command string scalar optional	(GBS-)Command(s) to execute. 'none' = OK Default=
`--nocd[+\|-]`	no_cd boolean scalar optional	Do not 'cd' to the selected directories Default=0

Constraints:

The following combinations are not allowed:

--new+	AND	--add+ or --remove+ or --delete+ or --show+ or --exec or <2> or --build or --audit or --tool
--add+	AND	--new+ or --remove+ or --delete+ or --show+ or --exec or <2> or --build or --audit or --tool
--remove+	AND	--new+ or --add+ or --delete+ or --show+ or --exec or <2> or --build or --audit or --tool
--delete+	AND	--new+ or --add+ or --remove+ or --show+ or --exec or <2> or --build or --audit or --tool
--show+	AND	--new+ or --add+ or --remove+ or --delete+ or --exec or <2> or --build or --audit or --tool
<1> = -	AND	--new+ or --add+ or --remove+ or --delete+ or --show+ or --exec or <2> or --build or --audit or --tool
<2> = -	AND	<3>
<1>	AND	<2> or <3> or --build or --audit or --tool

Note:

You can only '--add' a System if it was originally created by 'swr --new'

sws (gbssws)

Purpose:

Set and/or Create new Current SubSystem

Syntax:

gbssws sws [ subsystem ] [ component ]: [ --build=build ]; [ --audit=audit ]; [ --new[+|-] ]; [ --delete[+|-] ]; [ --nocd[+|-] ]

Semantics:

`<1>`	subsystem string scalar optional	SubSystem. '' == ASK, '-' == none, '.' == current Default=
`<2>`	component string scalar optional	Component. '-' == none, '.' == current Default=
`--build=build`	build string scalar optional	Build. '-' == none, '.' == current Default=
`--audit=audit`	audit string scalar optional	Audit. '-' == none, '.' == current Default=
`--new[+\|-]`	create_subsys boolean scalar optional	Create a new SubSystem Default=0
`--delete[+\|-]`	delete_subsys boolean scalar optional	Delete a SubSystem Default=0
`--nocd[+\|-]`	no_cd boolean scalar optional	Do not 'cd' to the selected directories Default=0

Constraints:

The following combinations are not allowed:

--new+	AND	<2> or --delete+ or --build or --audit
--delete+	AND	<2> or --new+ or --build or --audit
<1> = -	AND	--new+ or --delete+ or <2> or --build or --audit

swb (gbsswb)

Purpose:

Set and/or Create new Current Build

Syntax:

gbsswb swb [ build ]: [ --new[+|-] ]; [ --remove[+|-] ]; [ --delete[+|-] ]

Semantics:

`<1>`	build string scalar optional	Build: '' == ASK, '-' == none, '.' == current Default=
`--new[+\|-]`	create_build boolean scalar optional	Create a new Build Default=0
`--remove[+\|-]`	remove_build boolean scalar optional	Remove a Build from the Builds List Default=0
`--delete[+\|-]`	delete_build boolean scalar optional	Delete a Build Default=0

Constraints:

The following combinations are not allowed:

--new+	AND	--remove+ or --delete+
--remove+	AND	--new+ or --delete+
--delete+	AND	--new+ or --remove+

swa (gbsswa)

Purpose:

Set and/or Create new Current Audit

Syntax:

gbsswa swa [ audit ]: [ --new[+|-] ]; [ --remove[+|-] ]; [ --delete[+|-] ]

Semantics:

`<1>`	audit string scalar optional	Audit: '' == ASK, '-' == none, '.' == current Default=
`--new[+\|-]`	create_audit boolean scalar optional	Create a new Audit Default=0
`--remove[+\|-]`	remove_audit boolean scalar optional	Remove an Audit from the Audits List Default=0
`--delete[+\|-]`	delete_audit boolean scalar optional	Delete an Audit Default=0

Constraints:

The following combinations are not allowed:

--new+	AND	--remove+ or --delete+
--remove+	AND	--new+ or --delete+
--delete+	AND	--new+ or --remove+

swt (gbsswt)

Purpose:

Set and/or Create new Current Tool

Syntax:

gbsswt swt [ tool ]: [ --new[+|-] ]; [ --remove[+|-] ]; [ --delete[+|-] ]

Semantics:

`<1>`	tool string scalar optional	Tool: '' == ASK, '-' == none, '.' == current Default=
`--new[+\|-]`	create_tool boolean scalar optional	Create a new Tool Default=0
`--remove[+\|-]`	remove_tool boolean scalar optional	Remove a Tool from the Tools List Default=0
`--delete[+\|-]`	delete_tool boolean scalar optional	Delete a Tool Default=0

Constraints:

The following combinations are not allowed:

--new+	AND	--remove+ or --delete+
--remove+	AND	--new+ or --delete+
--delete+	AND	--remove+ or --new+

gbssudo

Purpose:

Execute a GBS command in Elevated Mode (SuperUser/Administrator)

Syntax:

gbssudo <command> [ command_args... ]

Semantics:

`<1>`	command string scalar mandatory choice: edit manage	GBS command to execute Default=
`<*>`	command_args string array optional	Arguments for <command> Default=

Note:

edit <file_name>
manage <menu_entries>...

gbswhich

Purpose:

Show Build and Audit data. Lookup header-files, sub-files

Syntax:

gbswhich [ what ] [ what_args... ]: [ Environment_Variable=Value ]...

Semantics:

`<1>`	what string scalar optional choice: ? subsys comp component build audit tool find search	Specify Default=
`<*>`	what_args string array optional	'what'-dependent Default=

Environment Variables:

(GBS_) FLAGS_*

Note:

subsys
component
build
build <src_file_type>
build <bld_file_type>
build .glkb
audit
audit <src_file_type>
tool
find <include_file> <find_method>
search <source_file>
search <subdir>/<file>

gbsxref

Purpose:

Show cross-references using makefiles and/or scope-files Launcher

Syntax:

gbsxref: [ --t[+|-] ]

Semantics:

--t[+|-] test_mode
boolean
scalar optional Run in test-mode - Internal use
Default=0

Install.bat & Install.sh

Purpose:

Install GBS (and possibly setup GBS).

Syntax:

Install.bat [ install_root ]: [ --q[+|-] ]; [ --setup[+|-] ]; [ --site=site ]; [ --company=company ]; [ --log_root=log_root ]

Semantics:

`<1>`	install_root string scalar optional path: syntax check only	Install-Root. Remembered Default=
`--q[+\|-]`	quiet_mode boolean scalar optional	Run in Quiet-Mode (No prompts) Default=0
`--setup[+\|-]`	setup boolean scalar optional	Call gbssetup after install. Not if Multi-User. Remembered Default=
`--site=site`	site string scalar optional word: Min. length = 3 Max. length = 20	Default Site. Remembered and passed to gbssetup Default=
`--company=company`	company string scalar optional text: Min. length = 2 Max. length = 40	Default Company Default=
`--log_root=log_root`	log_root string scalar optional path: syntax check only	Default Log-Root. Passed to gbssetup. Not if Multi-User. Default=

Note

This command resides in the $GBS_SCRIPTS_PATH/Install/gbs directory

More info:

Install

_gbssetup.bat & _gbssetup.sh

Purpose:

Setup GBS (After Install).

Syntax:

_gbssetup.bat: [ --q[+|-] ]; [ --site=site ]; [ --company=company ]; [ --log_root=log_root ]

Semantics:

`--q[+\|-]`	quiet_mode boolean scalar optional	Run in Quiet-Mode (No prompts) Default=0
`--site=site`	site string scalar optional word: Min. length = 3 Max. length = 20	Default Site Default=
`--company=company`	company string scalar optional text: Min. length = 2 Max. length = 40	Default Company Default=
`--log_root=log_root`	log_root string scalar optional path: syntax check only	Default Log-Root Default=

Note

This command resides in the $GBS_SCRIPTS_PATH directory

More info:

Setup

detab (Non-GBS)

Purpose:

Replace TABs by spaces in files

Syntax:

detab [ files ]: [ -t[+|-] ]; [ -r[+|-] ]; [ -f=wild_files,... ]; [ -m=modulo ]; [ -s[+|-] ]

Semantics:

`<*>`	files string scalar optional	Files to process or directory in case of -r Default=
`-t[+\|-]`	test boolean scalar optional	test only - do not make modifications Default=0
`-r[+\|-]`	recurse boolean scalar optional	recurse directory looking for -f= files Default=0
`-f=wild_files`	wild_files string array optional	wild-card files to process Default=
`-m=modulo`	modulo integer scalar optional	The TAB size the file was created with Default=8
`-s[+\|-]`	smart_tabs boolean scalar optional	retab leading whitespace (modulo 8) Default=0

fixeol (Non-GBS)

Purpose:

Fix EndOfLine characters of specified file(s) according to the invoking Operating System

Syntax:

fixeol files...

Semantics:

files string
array mandatory Files to be fixed
Default=

filerep (Non-GBS)

Purpose:

Rename/Delete files

Syntax:

filerep <command_or_commandsfile> [ files ]: [ -t[+|-] ]; [ -r=recurse,... ]; [ -R=recurse_group,... ]

Semantics:

`<1>`	command_or_commandsfile string scalar mandatory	Rename/Delete Command or @filespec of file containing Rename/Delete Commands Rename/Delete Command: <delim><find><delim><replace><delim>[g\|r][i] - g = glob rename (default) - r = Perl regular expression rename - i = ignore case of search string Empty <replace> deletes the file commandsfile: Empty lines and lines beginning with '#' are ignored Default=
`<*>`	files string scalar optional	(wild-)Files and.or Dirs to process Default=
`-t[+\|-]`	test boolean scalar optional	test only - do not make modifications Default=0
`-r=recurse`	recurse string array optional	recurse direcory using comma-separated wild files Default=
`-R=recurse_group`	recurse_group string array optional	recurse direcory using comma-separated file-groups. e.g.: perl Default=

Note:

Directory/Files starting with '.' are skipped

Note:

No check-out is performed on file(s)

pgrep (Non-GBS)

Purpose:

Find strings in files, using Perl regular expressions

Syntax:

pgrep <rexexp_or_file> [ files ]: [ -w[+|-] ]; [ -b[+|-] ]; [ -e[+|-] ]; [ -a[+|-] ]; [ -i[+|-] ]; [ -n[+|-] ]; [ -B=before_context ]; [ -A=after_context ]; [ -C=context ]; [ -r=recurse,... ]; [ -R=recurse_group,... ]; [ -s[+|-] ]

Semantics:

`<1>`	rexexp_or_file string scalar mandatory	Perl regexp or @filespec of file containing Perl regexps regexp-file: Empty lines and lines beginning with '#' are ignored Default=
`<*>`	files string scalar optional	(wild-)Files and.or Dirs to process Default=
`-w[+\|-]`	word boolean scalar optional	find word (no regexp) Default=0
`-b[+\|-]`	begin boolean scalar optional	find begin word (no regexp) Default=0
`-e[+\|-]`	end boolean scalar optional	find end word (no regexp) Default=0
`-a[+\|-]`	any boolean scalar optional	find any (no regexp) Default=0
`-i[+\|-]`	ignore_case boolean scalar optional	ignore case of search string Default=0
`-n[+\|-]`	print_linenr boolean scalar optional	print linenumber Default=1
`-B=before_context`	before_context integer scalar optional	print <num> lines of leading context Default=0
`-A=after_context`	after_context integer scalar optional	print <num> lines of trailing context Default=0
`-C=context`	context integer scalar optional	print <num> lines of output context (-A=<num> and -B=<num>) Default=0
`-r=recurse`	recurse string array optional	recurse direcory using comma-separated wild files Default=
`-R=recurse_group`	recurse_group string array optional	recurse direcory using comma-separated file-groups. e.g.: perl Default=
`-s[+\|-]`	supress_msg boolean scalar optional	Suppress non-error messages Default=0

Note:

Directory/Files starting with '.' are skipped

proto (Non-GBS)

Purpose:

Generate function-prototypes for C, C++ and Perl

Syntax:

proto [ files ]

Semantics:

<*> files
string
scalar optional Files to be parsed
Default=*.c,*.cpp,*.oc,*.pl,*.pm

win2unix (Non-GBS - Linux Only)

Purpose:

The win2unix command will convert Files from Windows-format to Unix-format

Syntax:

win2unix files...

Semantics:

files string
array mandatory Files to convert
Default=

wordrep (Non-GBS)

Purpose:

Replace words/strings in files

Syntax:

wordrep <command_or_commandsfile> [ files ]: [ -t[+|-] ]; [ -r=recurse,... ]; [ -R=recurse_group,... ]

Semantics:

`<1>`	command_or_commandsfile string scalar mandatory	Replace Command or @filespec of file containing Replace Commands Replace Command: <delim><find><delim><replace><delim>[w\|b\|e\|a\|r][i] - w = find word, b = find begin word, e = find end word - a = find any, r = find Perl regular expression - i = ignore case of search string - \s in replace string is converted to single space commandsfile: Empty lines and lines beginning with '#' are ignored Default=1
`<*>`	files string scalar optional	(wild-)Files and.or Dirs to process Default=
`-t[+\|-]`	test boolean scalar optional	test only - do not make modifications Default=0
`-r=recurse`	recurse string array optional	recurse direcory using comma-separated wild files Default=
`-R=recurse_group`	recurse_group string array optional	recurse direcory using comma-separated file-groups. e.g.: perl Default=

Note:

Directory/Files starting with '.' are skipped

Note:

No check-out is performed on file(s)

wsudo (Non-GBS - Windows Only)

Purpose:

Run a command in Elevated Mode ('as Administrator')
Somewhat like Linux: sudo
But the command is run in a separate window

Syntax:

wsudo [ command_sequence ]

Semantics:

command_sequence string
array optional Command(s) to be executed
If omitted a CMD Window will be started in Elevated Mode.

grep tail touch and more... (Non-GBS - Windows Only)

Purpose:

How any programmer can survive without 'grep' is beyond my understanding...
Gratefully copied from Karl M. Syring 's UnxUtils (now OpenSource) and (partly) delivered as part of GBS.
Please read the Standard Disclaimer.
Some extra help can be found UnxUtils Home Page. Note that not all commands are distributed with GBS. Feel free to request additions.

The executables are located in '%GBS_SCRIPTS_PATH%/win2utils'.
You may consider adding the win32utils directory in your PATH.
In switch.gbs.bat add:


    	IF "%WIN32UTILS_IN_PATH%"=="" THEN PATH=%GBS_SCRIPTS_PATH%\win2util;%PATH%

    	SET WIN32UTILS_IN_PATH=1

Syntax and Help:

On Command Line the following commands are predefined (DosKey):

grep --help egrep --help agrep --help tail --help touch --help which --help

In GBS 'make' or via '%GBS_SCRIPTS_PATH%/win2utils' you can use:

cp --help find --help gawk --help make --help rm --help sed --help tar --help

Generic Build Support (GBS) - User Manual - All Commands

all_commands.html