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

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

bgpids (Non-GBS - Unix only)

Purpose:

Show and/or kill background processes

Syntax:

bgpids [ USERS ]...: [ -a | -a+ | -a- ]; [ -f | -f+ | -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`	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: [ --rel=rel ]; [ --noroot | --noroot+ | --noroot- ]

Semantics:

`--rel=rel`	string scalar optional	Specific GBS release. You can also specify 'cur', 'current' or '?' Default=.
`--noroot[+\|-]`	noroot boolean scalar optional	Do not implicitly swr to current root Default=0

Note:

Alias for this command is 'gbs'

gbsaudit

Purpose:

Perform an AUDIT on one or more files

Syntax:

gbsaudit comp_file_opts...: [ --i | --i+ | --i- ]; [ --stdout | --stdout+ | --stdout- ]; [ --vs | --vs+ | --vs- ]; [ --audit=audit_name ]; [ --aud | --aud+ | --aud- ]; [ --sum | --sum+ | --sum- ]; [ --call=call_count ]; [ --jobs=jobs ]; [ Environment_Variable=Value ]...

Semantics:

`comp_file_opts`	string array mandatory	src-files and AUDIT-options 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
`--audit=audit_name`	string scalar optional choice: $GBS_AUDITS	Audit to run Default=$GBS_AUDIT
`--aud[+\|-]`	audit boolean scalar optional	Run audit Default=1
`--sum[+\|-]`	summary boolean scalar optional	Create summary Default=1
`--call=call_count`	integer scalar optional	Internal use. 0=normal, 1=split_first, <0=split_last Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max. nr. parallel jobs 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

gbsbldcheck

Purpose:

Check if all files have generated

Syntax:

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

Semantics:

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

gbsbg

Purpose:

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

Syntax:

gbsbg [ menu_entry_1 ]

Semantics:

menu_entry_1 integer
scalar optional
range 1..9 Primary menu entry for single immediate execution
Default=0

gbsedit

Purpose:

Create/edit GBS-files and user-files. GBS-files end with .gbs or .usr
The switch.gbs, gbssub and gbsall batch files are also considered GBS_files
Source, Include and glkbt-files are considered user-files
Relevant templates will be used with file-creation

Syntax:

gbsedit file [ editor_opt ]: [ --nco | --nco+ | --nco- ]

Semantics:

`file`	string scalar mandatory	[[[subsys:]component:]subdir:[<subpath>/]]file Default=
`editor_opt`	string scalar optional	Editor option. e.g. Line-nr to jump to Default=
`--nco[+\|-]`	no_checkout boolean scalar optional	.usr files will always be forced to no_checkout Default=0

gbsexit

Purpose:

Exit and cleanup the GBS environment

Syntax:

gbsexit

Semantics:

None

gbsexport

Purpose:

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

Syntax:

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

Semantics:

`export_file_locations`	string array optional	<Component>... and/or GEN: or SUB: . == 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 target Default=0
`--show[+\|-]`	show_actions boolean scalar optional	Show all actions Default=0

Environment Variables:

(GBS_) APP_*

gbsgen

Purpose:

Generate one or more files

Syntax:

gbsgen comp_file_opts...: [ --i | --i+ | --i- ]; [ --export | --export+ | --export- ]; [ --mm | --mm+ | --mm- ]; [ --jobs=jobs ]; [ Environment_Variable=Value ]...

Semantics:

`comp_file_opts`	string array mandatory	src files to generate with 'generate' options Default=
`--i[+\|-]`	ignore_errors boolean scalar optional	Continue generation regardless of error(s) Default=0
`--export[+\|-]`	run_gbsexport boolean scalar optional	Run 'gbsexport' on completion Default=0
`--mm[+\|-]`	run_makemake boolean scalar optional	Run 'makemake' on completion Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs Default=2

Environment Variables:

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

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 path-list...

Semantics:

`env_name`	string scalar mandatory	Env Variable to contain the filespec Default=
`file`	string scalar mandatory	The file to search Default=
`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 (unix<->win32)
5. User Tools
6. Integrator Tools
7. Administrator Tools
8. Check/Fix GBS Directory Structure
9. Owners-file Maintenance

Syntax:

gbsmaint [ menu_entry_1 ] [ menu_entry_2 ] [ menu_entry_3 ] [ menu_entry_4 ] [ menu_entry_5 ]

Semantics:

`menu_entry_1`	integer scalar optional range 1..9	Primary menu entry for single immediate execution Default=0
`menu_entry_2`	integer scalar optional greater 0	Secondary menu entry for single immediate execution Default=0
`menu_entry_3`	integer scalar optional greater 0	3rd menu entry for single immediate execution Default=0
`menu_entry_4`	integer scalar optional greater 0	4th menu entry for single immediate execution Default=0
`menu_entry_5`	integer scalar optional greater 0	5th menu entry for single immediate execution Default=0

gbsmake

Purpose:

'make' one or more files

Syntax:

gbsmake [ comp_file_opts ]...: [ --r | --r+ | --r- ]; [ --i | --i+ | --i- ]; [ --smm | --smm+ | --smm- ]; [ --export | --export+ | --export- ]; [ --mm | --mm+ | --mm- ]; [ --jobs=jobs ]; [ Environment_Variable=Value ]...

Semantics:

`comp_file_opts`	string array optional	bld files to make with 'make' options 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
`--smm[+\|-]`	start_makemake boolean scalar optional	Pre-generate the make-file Default=0
`--export[+\|-]`	run_gbsexport boolean scalar optional	Run 'gbsexport' on completion Default=0
`--mm[+\|-]`	run_makemake boolean scalar optional	Run 'makemake' on completion Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs 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 | --i+ | --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

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

Syntax:

gbsman

Semantics:

None

gbssetup (gbssetup.bat or gbssetup.sh)

Purpose:

Setup/Maintain Basic GBS Profile settings (EnvVars).

Syntax:

gbssetup [ menu_entry_1 ] [ menu_entry_2 ]

Semantics:

`menu_entry_1`	integer scalar optional range 1..2	Primary Menu entry for immediate execution Default=0
`menu_entry_2`	integer scalar optional greater 0	Secondary Menu entry for single immediate execution Default=0

gbsuninstall (gbsuninstall.bat or gbsuninstall.sh)

Purpose:

Uninstall GBS version(s).

Syntax:

gbsuninstall [ ?|all|others|full|versions ] [ versions ]...

Semantics:

`action`	string scalar optional choice: ?,all,others,full,versions	Action. Default is interactive ask Default=
`versions`	string array optional	Versions List Default=

gbsshow (gbs)

Purpose:

Show GBS currencies

Syntax:

gbsshow: [ --brief | --brief+ | --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 | --ci+ | --ci- ]; [ --cs | --cs+ | --cs- ]; [ --vi | --vi+ | --vi- ]; [ --noc | --noc+ | --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:

Combination of --noc+ and --ci is not allowed
Combination of --noc+ and --cs is not allowed

gbssysaudit

Purpose:

Perform an AUDIT on part of or whole System

Syntax:

gbssysaudit [ steps ]...: [ --i | --i+ | --i- ]; [ --vs | --vs+ | --vs- ]; [ --audits=audits,... ]...; [ --targets=targets,... ]...; [ --files=files,... ]...; [ --aud | --aud+ | --aud- ]; [ --sum | --sum+ | --sum- ]; [ --fg | --fg+ | --fg- ]; [ --at=delay ]; [ --sm | --sm+ | --sm- ]; [ --n | --n+ | --n- ]; [ --wait | --wait+ | --wait- ]; [ --jobs=jobs ]; [ --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`	string array optional	(wild-)Audits to run. '' or '' == All, '.' == Current Default=
`--targets=targets`	string array optional	(wild-)Targets to Audit. '' or '' == All, '.' == Current Default=
`--files=files`	string array optional	Files to audit Default=:.*
`--aud[+\|-]`	audit boolean scalar optional	Run audit Default=1
`--sum[+\|-]`	summary boolean scalar optional	Create summary Default=1
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	time ([+=]hh:mm or [+=]mm) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--sm[+\|-]`	mail boolean scalar optional	Send mail on completion Default=0
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=1
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg jobs Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs within a submitted job Default=2
`--c=comment`	string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

Combination of --fg+ and --at is not allowed
Combination of --fg+ and --sm is not allowed
Combination of --fg+ and --n is not allowed

Combination of --wait+ and --n is not allowed

Combination of --sum- and --vs+ is not allowed

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

gbssysgen

Purpose:

Generate part of or whole System

Syntax:

gbssysgen [ steps ]...: [ --i | --i+ | --i- ]; [ --mm | --mm+ | --mm- ]; [ --export | --export+ | --export- ]; [ --targets=targets,... ]...; [ --fg | --fg+ | --fg- ]; [ --files=files,... ]...; [ --at=delay ]; [ --sm | --sm+ | --sm- ]; [ --n | --n+ | --n- ]; [ --wait | --wait+ | --wait- ]; [ --jobs=jobs ]; [ --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
`--targets=targets`	string array optional	(wild-)Targets to Build. '' or '' == All, '.' == Current Default=
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--files=files`	string array optional	Files to gen Default=:.*
`--at=delay`	time ([+=]hh:mm or [+=]mm) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--sm[+\|-]`	mail boolean scalar optional	Send mail on completion Default=0
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=1
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg jobs Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs within a submitted job Default=2
`--c=comment`	string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

Combination of --fg+ and --at is not allowed
Combination of --fg+ and --sm is not allowed
Combination of --fg+ and --n is not allowed
Combination of --fg+ and --wait is not allowed

Combination of --wait+ and --n is not allowed

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 | --i+ | --i- ]; [ --smm | --smm+ | --smm- ]; [ --mm | --mm+ | --mm- ]; [ --export | --export+ | --export- ]; [ --targets=targets,... ]...; [ --files=files,... ]...; [ --fg | --fg+ | --fg- ]; [ --at=delay ]; [ --sm | --sm+ | --sm- ]; [ --n | --n+ | --n- ]; [ --wait | --wait+ | --wait- ]; [ --jobs=jobs ]; [ --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
`--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
`--targets=targets`	string array optional	(wild-)Targets to Build. '' or '' == All, '.' == Current Default=
`--files=files`	string array optional	Files to make Default=:.*
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	time ([+=]hh:mm or [+=]mm) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--sm[+\|-]`	mail boolean scalar optional	Send mail on completion Default=0
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=1
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg jobs Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs within a submitted job Default=2
`--c=comment`	string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

Combination of --fg+ and --at is not allowed
Combination of --fg+ and --sm is not allowed
Combination of --fg+ and --n is not allowed

Combination of --wait+ and --n is not allowed

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 | --i+ | --i- ]; [ --vs | --vs+ | --vs- ]; [ --fg | --fg+ | --fg- ]; [ --at=delay ]; [ --sm | --sm+ | --sm- ]; [ --n | --n+ | --n- ]; [ --wait | --wait+ | --wait- ]; [ --jobs=jobs ]; [ --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
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	time ([+=]hh:mm or [+=]mm) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--sm[+\|-]`	mail boolean scalar optional	Send mail on completion Default=0
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=1
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg jobs Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs within a submitted job Default=2
`--c=comment`	string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

Combination of --fg+ and --at is not allowed
Combination of --fg+ and --sm is not allowed
Combination of --fg+ and --n is not allowed

Combination of --wait+ and --n is not allowed

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 gbssysgen/gbssysmake, gbssysaudit and gbssystool commands

Syntax:

gbssysall [ steps ]...: [ --i | --i+ | --i- ]; [ --vs | --vs+ | --vs- ]; [ --audits=audits,... ]...; [ --targets=targets,... ]...; [ --tools=tools,... ]...; [ --files=files,... ]...; [ --make | --make+ | --make- ]; [ --fg | --fg+ | --fg- ]; [ --at=delay ]; [ --sm | --sm+ | --sm- ]; [ --n | --n+ | --n- ]; [ --wait | --wait+ | --wait- ]; [ --jobs=jobs ]; [ --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`	string array optional	(wild-)Audits to run. '' or '' == All, '.' == Current Default=
`--targets=targets`	string array optional	(wild-)Targets to Audit. '' or '' == All, '.' == Current Default=
`--tools=tools`	string array optional	(wild-)Tools to Execute. '' or '' == All, '.' == Current, '-' == None Default=
`--files=files`	string array optional	Files to audit Default=:.*
`--make[+\|-]`	make boolean scalar optional	Run gbssysmake instead of gbssysgen Default=0
`--fg[+\|-]`	foreground boolean scalar optional	Runs in the foreground if set Default=0
`--at=delay`	time ([+=]hh:mm or [+=]mm) scalar optional	Starting time (10:20), delta (+10:10) or now Default=now
`--sm[+\|-]`	mail boolean scalar optional	Send mail on completion Default=0
`--n[+\|-]`	notify boolean scalar optional	Notify user on completion (bg/nowait only) Default=1
`--wait[+\|-]`	wait boolean scalar optional	Wait for completion of bg jobs Default=0
`--jobs=jobs`	integer scalar optional range 1..9	Max nr parallel jobs within a submitted job Default=2
`--c=comment`	string scalar optional	Comments - will be shown in Summary - Specify %20 for space Default=

Constraints:

Combination of --fg+ and --at is not allowed
Combination of --fg+ and --sm is not allowed
Combination of --fg+ and --n is not allowed

Combination of --wait+ and --n is not allowed

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_BASE_PATH%\gbsstart.bat or $GBS_BASE_PATH/gbsstart.sh)

Purpose:

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

Syntax:

gbsstart root [ subsystem ] [ component ]: [ --target=target ]; [ --audit=audit ]; [ --tool=tool ]; --exec=execute_command; [ --rel=rel ]

Semantics:

`root`	string scalar mandatory	System / Root: '-' == none, '.' == current, '!' == CWD, '!<abs_file/dir_spec>', '!!' == CWD = GBS_ROOT_PATH Default=!
`subsystem`	string scalar optional	SubSystem: '-' == none, '.' or '' == current Default=
`component`	string scalar optional	Component: '-' == none, '.' or '' == current Default=
`--target=target`	string scalar optional	Target: '-' == none, '.' or '' == current Default=.
`--audit=audit`	string scalar optional	Audit: '-' == none, '.' or '' == current Default=.
`--tool=tool`	string scalar optional	Toolt: '-' == none, '.' or '' == current Default=.
`--exec=execute_command`	string scalar mandatory	(GBS-)Command to execute. 'none' = OK Default=
`--rel=rel`	string scalar optional	Specific GBS release. You can also specify 'cur' or 'current' Default=.

Constraints:

Combination of <1>==- and <2> is not allowed

Combination of <1>==- and <3> is not allowed

Combination of <2>==- and <3> is not allowed

More info:

For Tools integration purposes, use the replacing gbsstart_here command.

gbsstart_here (%GBS_BASE_PATH%\gbsstart_here.bat or $GBS_BASE_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:

`gbs_command`	string scalar mandatory	GBS command. e.g.: gbsgen 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 | --lines+ | --lines- ]; [ --cs | --cs+ | --cs- ]; [ --vi | --vi+ | --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 ]: [ --target=target ]; [ --audit=audit ]; [ --new | --new+ | --new- ]; [ --nocd | --nocd+ | --nocd- ]

Semantics:

`component`	string scalar optional	Component: '' == ASK, '-' == none, '.' == current Default=
`--target=target`	string scalar optional	Target: '-' == none, '.' == current Default=
`--audit=audit`	string scalar optional	Audit. '-' == none, '.' == current Default=
`--new[+\|-]`	create_new_component boolean scalar optional	Create a new Component Default=0
`--nocd[+\|-]`	no_cd boolean scalar optional	Do not 'cd' to the selected directories Default=0

Constraints:

Combination of --new+ and <1> is not allowed
Combination of --new+ and --target is not allowed

Combination of <1>== and --target is not allowed
Combination of <1>== and --audit is not allowed

swr (gbsswr)

Purpose:

Set a current Root/System or
Create a new one or Add / Remove one from the Roots List or
Show the Roots List

Syntax:

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

Semantics:

`root_path`	string scalar optional	System / Root: '' == ASK, '-' == none, '.' == current, '!' == CWD, '!<abs_file/dir_spec>', '!!' == current GBS_ROOT_PATH Default=
`subsystem`	string scalar optional	SubSystem: '-' == none, '.' == current Default=
`component`	string scalar optional	Component: '-' == none, '.' == current Default=
`--target=target`	string scalar optional	Target: '-' == none, '.' == current Default=
`--audit=audit`	string scalar optional	Audit: '-' == none, '.' == current Default=
`--tool=tool`	string scalar optional	Tool: '-' == none, '.' == current Default=
`--new[+\|-]`	create_new_root boolean scalar optional	Create a new System / Root Default=0
`--add[+\|-]`	add_root boolean scalar optional	Add a Root to the Roots List Default=0
`--remove[+\|-]`	remove_root boolean scalar optional	Remove a Root from the Roots List Default=0
`--show[+\|-]`	show_roots boolean scalar optional	Show the Roots List Default=0
`--exec=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:

Combination of --new+ and --add is not allowed
Combination of --new+ and --remove is not allowed
Combination of --new+ and --show is not allowed
Combination of --new+ and --exec is not allowed
Combination of --new+ and <2> is not allowed
Combination of --new+ and --target is not allowed
Combination of --new+ and --audit is not allowed

Combination of --add+ and --new is not allowed
Combination of --add+ and --remove is not allowed
Combination of --add+ and --show is not allowed
Combination of --add+ and --exec is not allowed
Combination of --add+ and <2> is not allowed
Combination of --add+ and --target is not allowed
Combination of --add+ and --audit is not allowed

Combination of --remove+ and --new is not allowed
Combination of --remove+ and --add is not allowed
Combination of --remove+ and --show is not allowed
Combination of --remove+ and --exec is not allowed
Combination of --remove+ and <2> is not allowed
Combination of --remove+ and --target is not allowed
Combination of --remove+ and --audit is not allowed

Combination of --show+ and --new is not allowed
Combination of --show+ and --add is not allowed
Combination of --show+ and --remove is not allowed
Combination of --show+ and --exec is not allowed
Combination of --show+ and <1> is not allowed
Combination of --show+ and --target is not allowed
Combination of --show+ and --audit is not allowed

Combination of <1>==- and --new is not allowed
Combination of <1>==- and --add is not allowed
Combination of <1>==- and --remove is not allowed
Combination of <1>==- and --show is not allowed
Combination of <1>==- and --exec is not allowed
Combination of <1>==- and <2> is not allowed
Combination of <1>==- and --target is not allowed
Combination of <1>==- and --audit is not allowed

Combination of <2>==- and <3> is not allowed

Combination of <1>== and --target is not allowed
Combination of <1>== and --audit is not allowed

Note:

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

sws (gbssws)

Purpose:

Set and/or Create new Current SubSystem

Syntax:

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

Semantics:

`subsystem`	string scalar optional	SubSystem. '' == ASK, '-' == none, '.' == current Default=
`component`	string scalar optional	Component. '-' == none, '.' == current Default=
`--target=target`	string scalar optional	Target. '-' == none, '.' == current Default=
`--audit=audit`	string scalar optional	Audit. '-' == none, '.' == current Default=
`--new[+\|-]`	create_new_subsys boolean scalar optional	Create a new SubSystem Default=0
`--nocd[+\|-]`	no_cd boolean scalar optional	Do not 'cd' to the selected directories Default=0

Constraints:

Combination of --new+ and <1> is not allowed
Combination of --new+ and <2> is not allowed
Combination of --new+ and --target is not allowed

Combination of <1>==- and <2> is not allowed

Combination of <1>== and --target is not allowed
Combination of <1>== and --audit is not allowed

swt (gbsswt)

Purpose:

Set and/or Create new Current Target

Syntax:

gbsswt swt [ target ]: [ --new | --new+ | --new- ]; [ --remove | --remove+ | --remove- ]

Semantics:

`target`	string scalar optional	Target: '' == ASK, '-' == none, '.' == current Default=
`--new[+\|-]`	create_new_target boolean scalar optional	Create a new Target Default=0
`--remove[+\|-]`	remove_target boolean scalar optional	Remove a Target from the Targets List Default=0

Constraints:

Combination of --new+ and --remove+ is not allowed

swa (gbsswa)

Purpose:

Set and/or Create new Current Audit

Syntax:

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

Semantics:

`audit`	string scalar optional	Audit: '' == ASK, '-' == none, '.' == current Default=
`--new[+\|-]`	create_new_audit boolean scalar optional	Create a new Audit Default=0
`--remove[+\|-]`	remove_audit boolean scalar optional	Remove a Audit from the Audits List Default=0

Constraints:

Combination of --new+ and --remove+ is not allowed

gbswhich

Purpose:

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

Syntax:

gbswhich [ ?|subsys|comp|component|target|audit|tool|find|search ] [ what_args ]...: [ Environment_Variable=Value ]...

Semantics:

`what`	string scalar optional choice: ? subsys comp component target audit tool find search	Specify Default=
`what_args`	string array optional	'what'-dependent Default=

Environment Variables:

(GBS_) FLAGS_*

Note:

subsys
component
target
target <src_file_type>
target <bld_file_type>
target .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

Semantics:

None

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

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

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

detab (Non-GBS)

Purpose:

Replace TABs by spaces in files

Syntax:

detab [ files ]: [ -t | -t+ | -t- ]; [ -r | -r+ | -r- ]; [ -f=wild_files,... ]...; [ -m=modulo ]; [ -s | -s+ | -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`	string array optional	wild-card files to process Default=
`-m=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

gbsscm (scm)

Purpose:

Execute basic SCM commands using the current SCMS

Syntax:

gbsscm ?|info|state|co|ci|unco|mkdir|mktxt|add|move|ignore|remove|import|connect|stop|select [ files ]...: [ --r | --r+ | --r- ]

Semantics:

`command`	string scalar mandatory choice: ? info state co ci unco mkdir mktxt add move ignore remove import connect stop select	Basic SCM Command Default=
`files`	string array optional	File / Directory List Default=
`--r[+\|-]`	recursive boolean scalar optional	Add whole directory tree Default=0

Note:

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

win2unix (Non-GBS - Unix Only)

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

Syntax:

win2unix files...

Semantics:

files string
array mandatory Files to convert
Default=

fixeol (Non-GBS)

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=

wordrep (Non-GBS)

Purpose:

Replace words/strings in files

Syntax:

wordrep command_or_commandsfile [ files ]: [ -t | -t+ | -t- ]; [ -r | -r+ | -r- ]; [ -f=wild-files,... ]...

Semantics:

`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=
`files`	string scalar optional	Files to process 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`	string array optional	wild-card files to process Default=

Note:

Directory/Files starting with '.' are skipped

Note:

No check-out is performed on file(s)

filerep (Non-GBS)

Purpose:

Rename/Delete files

Syntax:

filerep command_or_commandsfile [ files ]: [ -t | -t+ | -t- ]; [ -r | -r+ | -r- ]; [ -f=wild-files,... ]...

Semantics:

`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	Files to process 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`	string array optional	wild-card files to process Default=

Note:

Directory/Files starting with '.' are skipped

Note:

No check-out is performed on file(s)

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