====== Virtual UART/FOSSIL Driver Configuration ======

The ''sbbsexec.ini'' file is used to configure the behavior of the kernel mode component of Synchronet FOSSIL and Virtual UART driver for Windows NT-based operating systems (all modern versions of Windows): ''sbbsexec.dll''.

===== Location =====

The default ''sbbsexec.ini'' file is located in your Synchronet ''[[dir:exec]]'' directory. If there is another ''sbbsexec.ini'' file in the startup directory of the program to be executed (e.g. ''[[dir:xtrn]]/doorgame/sbbsexec.ini''), that file will be loaded **after** ''[[dir:exec]]/sbbsexec.ini'', over-riding only those values specified in the second file.

The standard alternate [[:config:INI_Files#Filenaming|INI filenaming]] is also supported.

===== Root Section =====

These values may be be overridden in a program-specific section named after the program to be executed (e.g. ''[DSZ]'' for ''dsz.exe'').

==== LogLevel ====
Default: ''Warning''

Possible Values: ''Emergency, Alert, Critical, Error, Warning, Notice, Informational, Debugging''

This key determines the minimum severity of messages from ''sbbsexec.dll'' that will be sent to the system debug log.

You can use software such as [[https://technet.microsoft.com/en-us/sysinternals/debugview.aspx|DebugView]] to view the log output from ''sbbsexec.dll''.

==== Debug ====
Default: ''false''

Possible Values: ''true'' or ''false''

==== CanDisconnect ====
Default: ''True''

Possible Values: ''true'' or ''false''

This key determines whether the program will be allowed to disconnect the user.

==== YieldInterval ====
Default: ''1.0''
Possible Values: ''0'' and up, fractional values are supported (e.g. ''0.5'', ''1.25'', etc.)

Interval of time-slice yield, in milliseconds (fractions supported):
Lower numbers result in **more** frequent yields, reducing CPU utilization
and possibly reducing performance/responsiveness while higher numbers
can result in fewer yields, increasing CPU utilization (possibly taxing
the system) and increasing performance/responsiveness.

This number may need to be "tuned" on a per-program/system basis.

Set to ''0'' to disable yielding.

===== [UART] Section =====

==== Virtualize ====
Default: ''true''

Possible Values: ''true'' or ''false''

==== ComPort ====
Default: ''1''

Possible Values: ''1''-''4''

==== IRQ ====
Default: depends on ComPort value


==== Address ====
Default: depends on ComPort value


===== See Also =====
  * [[:config:|Configure]]
  * [[:config:INI Files]] 
  * [[:monitor:sbbsexec|Monitoring SBBSEXEC messages]]
  * [[https://gitlab.synchro.net/main/sbbs/-/blob/master/exec/sbbsexec.ini|Default sbbsexec.ini file]]


{{tag>configuration fossil operating_system}}
