Faculty of Information Technology
Software Engineering Group

Ticket #188: smalltalk.cfg

File smalltalk.cfg, 8.5 KB (added by Jan Vrany, 2 years ago)
Line 
1# -------------------------------------------------------------------------------------------
2# User settings
3# -------------------------------------------------------------------------------------------
4# ===================
5# Stx bin directory =
6# ===================
7# Setting: stx_bin_dir -
8# Impact: defines the directory containing the executable
9# Note: do not forget the last backslash ^(\^) and double quotes when changing to custom path
10stx_bin_dir="%~dp0"
11
12# ===================================
13# Stx quick start and image details =
14# ===================================
15# Setting: __binary.stx_quick_start
16# Impact: Uses flags --ignoreImage and --quick start to start StX as fast as possible
17# TRUE - switches on the quick start
18# FALSE - skips this option
19__binary.stx_quick_start=FALSE
20
21# Setting: image_path, image_name, image_suffix
22# Impact: variables are self-explanatory
23# Note: do not forget the last backslash ^(\^) and double quotes when changing to custom path
24image_path="%~dp0"
25# Setting: image_name - how should the default image be named
26image_name="st"
27image_suffix=".img"
28
29# Impact: Pair variables (affect each other):__binary.start_with_image and __binary.list_available_images
30# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31# note: Before using image functionality check image path, name, and suffix
32
33# Setting: __binary.start_with_image
34# Impact: Stx starts (or not) with image.
35# TRUE - image functionality will be used
36# FALSE - image functionality ignored
37__binary.start_with_image=FALSE
38
39# Setting: __binary.list_available_images
40# Impact: User menu is show when used; it shows all images within the directory (excluding subdirectories) and users selects one.
41#         If switched off only default image (see image_path, image_name, image_suffix) is used.
42# Note: IF start_with_image=FALSE and list_available_images=TRUE then a warning message is shown and append_to_log is set to FALSE automatically)
43# TRUE - Switches on the user menu
44# FALSE - no interaction from user required
45__binary.list_available_images=FALSE
46# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47
48# =================
49# Stx logging     =
50# =================
51# Impact: Pair variables (affect each other): __binary.record_log_file and __binary.append_to_log
52# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53# Setting: __binary.record_log_file
54# Impact: Both standard output and standard error are redirected to a log file
55# Note: At least PowerShell 2.0 is required (WindowsXP and newer)
56# TRUE - turns on the logging functionality
57# FALSE - turns off the logging
58__binary.record_log_file=TRUE
59
60# Setting: __binary.append_to_log
61# Impact: Appends the log file.  Uses a PowerShell when appending.
62# Note: IF record_log_file=FALSE and append_to_log=TRUE then a warning message is shown and append_to_log is set to FALSE automatically)
63# TRUE - if log file is found it will be appended.  If not a new one will be created
64# FALSE - the append functionality is turned off (the log file will be overwritten every time StX is executed)
65__binary.append_to_log=TRUE
66# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67
68# Setting: log_directory, log_name, log_suffix
69# Impact: Directory sets a log file directory (others are self-explanatory)
70# If a change would be done, double quotes must be present: e.g. "C:\prg_sdk\Stx_stable\"
71# Note: do not forget the last backslash ^(\^) and double quotes when changing to custom path
72log_directory="%~dp0"
73# Setting: log_name sets name for log file
74log_name="smalltalk"
75log_suffix=".log"
76
77# Setting: __binary.log_add_datepart
78# Impact: Adds a date part based on ISO 8601 to the log file; format YYYY-MM-DD ('-' as a separator)
79# TRUE - Switch on this option
80# FALSE - Skips this option
81__binary.log_add_datepart=TRUE
82
83# Setting: __binary.log_add_timepart
84# Impact: Adds a time part to the log file; format hh;mm;ss (non-ISO ';' as a separator)
85# Note: the ISO 8601 separator is not compatible with file-system)
86# TRUE - Switch on this option
87# FALSE - Skips this option
88__binary.log_add_timepart=FALSE
89
90# Setting: log_file_encoding
91# Impact: Changes log file encoding
92# Allowed values ASCII, UTF8 (default), UTF16 (in Microsoft world that is called Unicode), UTF32
93# Note: only UTF16 is using Tee-Object which enables you to have all the features the developer envisioned for the logging process
94#        you can simultaneously see the output in shell, view the log file while using StX and have the wished encoding
95#        all other encodings carry some limitation due to the powershell tools limitation
96log_file_encoding=UTF8
97
98# =====================
99# Log file line width =
100# =====================
101# Setting: log_file_encoding
102# Impact: Sets log file line width when out-file is used (all except UTF16)
103# Allowed values: only numeric
104__numeric.log_file_width=150
105
106# =================
107# Stx shell       =
108# =================
109# Setting: __binary.close_shell
110# Impact: When set to TRUE closes the shell upon StX exit
111# TRUE - Switch on this option
112# FALSE - Skips this option
113__binary.close_shell=TRUE
114
115# Setting: __binary.run_via_shell
116# Impact: start with shell (.com) or just the GUI without shell (.exe)
117# TRUE - uses stx.com executable
118# FALSE - uses stx.exe executable
119__binary.run_via_shell=TRUE
120
121
122# -------------------------------------------------------------------------------------------
123# Advanced user settings
124# -------------------------------------------------------------------------------------------
125# ====================
126# Validate variables =
127# ====================
128# Setting: verify_variables_syntax
129# Impact: Verifies the syntax of the batch file variables - e.g. batch file is very picky on spaces
130# TRUE - active validation
131# FALSE - inactive validation (NOT recommended)
132verify_variables_syntax=TRUE
133
134# Setting: verify_print_message
135# Impact: shows message when the verification is complete
136# TRUE - Switch on this option
137# FALSE - message is not shown
138verify_print_message=FALSE
139
140# =======================
141# Log file size warning =
142# =======================
143# Setting: __numeric.warning_logfile_size - Above what file size should a log file warning be shown?
144# Impact: If the limit is reached a warning message is shown to the user
145# Allowed values: only numeric
146# Print user waring if the log file is getting too big - for 32MB in bytes
147# the bigger log-file, the slower the logging process gets
148__numeric.warning_logfile_size=33554432
149
150# ====================
151# Stdout redirection =
152# ====================
153# Setting: cmd_in_powershell
154# Impact: The cmd.exe redirection is faster even when called from powershell
155#         There could be unforeseen issues with it so there is a switch (no manual switches are allowed)
156#         When no colors are used then black background and gray foreground is used (warning messages are still highlighted)
157#          When colors are used then the same color schema is used
158# TRUE - uses cmd.exe for redirecting output
159# FALSE - uses powershell for redirection (default)
160__binary.cmd_in_powershell=FALSE
161
162# ====================
163# Start timer =
164# ====================
165# Setting: use_timer
166# Impact: Measures time between start of the script and correct ending. Measurement unit are seconds.
167# TRUE - uses timer
168# FALSE - switches off timer
169__binary.use_timer=FALSE
170
171# ==============
172# Colored text =
173# ==============
174# Setting: colored_stdout
175# Impact: Will adjust based on the color setting the stdout output from both batch and powershell
176#        note: in powershell there are default colors used when setting is is turned off (FALSE.
177# TRUE - uses colored output
178# FALSE - uses default colors available
179__binary.colored_stdout=TRUE
180
181# ===================
182# Stdout text color =
183# ===================
184# colors that can be used
185# To find all the colors in powershell: `[enum]::GetValues([System.ConsoleColor]) | Foreach-Object {Write-Host $_ -ForegroundColor $_ }`
186# Black, DarkBlue, DarkGreen, DarkCyan, DarkRedDarkMagenta, DarkYellow,
187# Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
188
189# verbose text (this is color used for normal usually [INFO] messages)
190stdout_VerboseBackgroundColor=Black
191stdout_VerboseForegroundColor=DarkGreen
192
193# warning text
194stdout_WarningBackgroundColor=Black
195stdout_WarningForegroundColor=Yellow
196
197# error
198stdout_ErrorBackgroundColor=White
199stdout_ErrorForegroundColor=Red