Start

• Program's Overview (FUNCTION FILES) - BGINFO4X as a modular system
• Program's Overview (CUSTOM FILES) - Using and configuring BGINFO4X
• Command line options

Program's Overview (FUNCTION FILES) - BGINFO4X as a modular system

BGINFO4X is a modular system, that comes with a set of configurable FUNCTION FILES:

• The HEADERFILE (HEADER.CONF) contains your customized HEADER.
• The OUTFILE (OUT.CONF) contains your OUT functions.
• The ALARMFILE (ALARM.CONF) contains your ALARM functions.
• The SCRIPTFILE (SCRIPT.CONF) contains your SCRIPTS to be executed.

The following image shows the relationship between the FUNCTION FILES and the WALLPAPER printed:

The Operating System is detected automatically and the associated FUNCTION FILES, located in their corresponding subfolder, are executed.

The following table summarizes this concept:

OS FOUND	SUBFOLDER LOCATION	FUNCTION FILES
WINDOWS	CUSTOM/CLIENT/WINDOWS	HEADER.CONF; OUT.CONF; ALARM.CONF; SCRIPT.CONF
LINUX	CUSTOM/CLIENT/LINUX	HEADER.CONF; OUT.CONF; ALARM.CONF; SCRIPT.CONF
MACOSX	CUSTOM/CLIENT/MACOSX	HEADER.CONF; OUT.CONF; ALARM.CONF; SCRIPT.CONF
BSD	CUSTOM/CLIENT/BSD	HEADER.CONF; OUT.CONF; ALARM.CONF; SCRIPT.CONF
CYGWIN	CUSTOM/CLIENT/CYGWIN	HEADER.CONF; OUT.CONF; ALARM.CONF; SCRIPT.CONF
OTHEROS	CUSTOM/CLIENT/OTHEROS	HEADER.CONF; OUT.CONF; ALARM.CONF; SCRIPT.CONF

To see all the the Operating Systems supported click here

---

Program's Overview (CUSTOM FILES) - Using and configuring BGINFO4X

Customizing BGINFO4X is done through the CUSTOM FILES, located in the CUSTOM/CONF subfolder of your installation program.

The following table summarizes this concept:

FILE	SUBFOLDER LOCATION	Description
BGINFO4X.CONF	CUSTOM/CONF	Main configuration file.
IMMODE.CONF	CUSTOM/CONF	Imaging wallpaper configuration file.
RTMODE.CONF	CUSTOM/CONF	Root-tail (deprecated) configuration file.

These configuration files, use a very simple estructure: VARIABLE="VALUE". Note that the "VALUE" comes always between quotes. These variables are also called often tunables.

• The BGINFO4X.CONF configurable file manages the Main General Settings and the Export Options.

The more useful tunables in this file are:

Tunable	Value	Description
TIMER	["0"-"seconds"]	Refresh screen timer in seconds. For example, to refresh each 5 minutes (300 seconds), use TIMER="300".
STOPLOOP	["0"-"loopnumber"]	Stop BGINFO4X after the desired loop. For example, to never stop, use STOPLOOP="0".
HTMLEXPORT	["YES"/"NO"]	Export the information to an HTML file. For example, to export your data to HTML, use HTMLEXPORT="YES".

• The IMMODE.CONF configurable file is used for controlling the IMAGING of your Wallpaper.

The more useful tunables in this file are:

Tunable	Value	Description
CORPORATEWALLPAPER	["YES"/"NO"]	Force the use of a Corporate Wallpaper.
CORPORATELOGO	["YES"/"NO"]	Use a Corporate Logo.
BGWALLPAPER_GRAVITY	["Cardinal points"]	Location of the BGINFO4X wallpaper. For example, to position the image to the SouthEast, use BGWALLPAPER_GRAVITY="SouthEast".

To see all the configurable options and possible values, edit your CUSTOM FILE or continue reading this manual.

---

Command line options

BGINFO4X comes with the following command line options: {--version | --stop | --stopall | --debugall | --checksoftinstalled | --help}

• ./BGINFO4X.sh (starts the program).
• ./BGINFO4X.sh --version: shows the version.
• ./BGINFO4X.sh --checksoftinstalled: checks that you have all the necessary programs to run.
• ./BGINFO4X.sh --stop: kill all processes.
• ./BGINFO4X.sh --stopall: kill all processes - aggressive mode (kill also by PIDSFILE).
• ./BGINFO4X.sh --reload: reloads BGINFO4X immediately.
• ./BGINFO4X.sh --debugall: catch all outputs and errors to the file OUT/debugall.out.