Both sides previous revisionPrevious revisionNext revision | Previous revision |
util:scfg [2024/04/02 18:14] – [Initial Setup Wizard] include SCFG wizard screenshots digital man | util:scfg [2024/05/25 19:48] (current) – [See Also] Add link to uifc.ini digital man |
---|
| |
<code> | <code> |
| usage: scfg [ctrl_dir] [options] |
| |
options: | options: |
| |
-host=<name> set hostname to use for alternate sbbs.ini file | -host=<name> set hostname to use for alternate sbbs.ini file |
-iX set interface mode to X (default=auto) where X is one of: | -iX set interface mode to X (default=auto) where X is one of: |
X = X11 mode | X = X11 mode |
C = Curses mode | C = Curses mode |
F = Curses mode with forced IBM charset | F = Curses mode with forced IBM charset |
I = Curses mode with forced ASCII charset | I = Curses mode with forced ASCII charset |
A = ANSI mode | W = Windows console mode |
D = standard input/output/door mode | G = Windows graphics mode |
| GF = Windows graphics mode, full screen |
| A = ANSI mode |
| D = standard input/output/door mode |
-A use alternate (ASCII) characters for arrow symbols | -A use alternate (ASCII) characters for arrow symbols |
-v# set video mode to # (default=auto) | -v# set video mode to # (default=42) |
-l# set screen lines to # (default=auto-detect) | -l# set window lines to # (default=auto-detect) |
-y automatically save changes (don't ask)</code> | -s# set window scaling factor to # (default=1.0) |
| -y automatically save changes (don't ask) |
| </code> |
| |
:!: Note: some of the interface mode values are only available on particular platforms/operating systems. | :!: Note: some of the interface mode values are only available on particular platforms/operating systems. |
| |
===== CTRL Directory ===== | ===== ctrl Directory ===== |
| |
If the ''[[config:env#SBBSCTRL]]'' environment variable is set, then SCFG will find the [[config:ini files]] without needing you to specify the path to the ''[[dir:ctrl]]'' directory (''[ctrl_dir]'') on the command-line. | If the ''[[config:env#SBBSCTRL]]'' environment variable is set, then SCFG will find the [[config:ini files]] without needing you to specify the path to the ''[[dir:ctrl]]'' directory (''[ctrl_dir]'') on the command-line. |
| |
If the ''[[config:env#SBBSCTRL]]'' environment variable is **not** set and the ''[ctrl_dir]'' is not specified on the command-line, SCFG will look for the [[config:ini files]] in the current working directory. | If the ''[[config:env#SBBSCTRL]]'' environment variable is **not** set and the ''[ctrl_dir]'' is not specified on the command-line, SCFG will look for the [[config:ini files]] in the ''/sbbs/ctrl'' directory, by default. |
| |
| ===== scfg.ini ===== |
| |
| The default user interface/display control settings of SCFG can be overridden by creating the file ''[[dir:ctrl]]/scfg.ini'' (new to SCFG v3.20). |
| |
| All of the ''scfg.ini'' keys are in the //root// (global) section: |
| |
| ^ Key ^ Default Value ^ Description ^ |
| | ''video_mode'' | ''42'' (80x25 LCD) | The text/video output mode | |
| | ''uifc_mode'' | ''0'' | Bit-flags controlling the user interface library, see ''uifc.h'' for bit definitions, e.g. set to ''2'' to disable mouse support | |
| | ''ciolib_mode'' | ''0'' (auto) | Console I/O Library Interface mode, see ''ciolib.h'' for value definitions, e.g. set to ''4'' to enable ANSI output mode | |
| | ''lines'' | //auto-detect// | Height of user interface window, in rows/lines of text (usually, 25) | |
| | ''insert'' | ''false'' | Set to ''true'' to enable keyboard insert mode by default, not overwrite | |
| | ''esc_delay'' | ''25'' | Milliseconds to wait for escape sequence, differentiating between ESC key press and extended key escape sequence | |
| | ''scaling'' | ''0'' (auto) | Initial display scale of graphical window, fractions supported | |
| |
| If the ''[[dir:ctrl]]/scfg.ini'' file does not exist, SCFG will fallback to using the file ''[[dir:ctrl]]/[[config:uifc.ini]]'', if it exists. |
===== Usage ===== | ===== Usage ===== |
| |
* [[config:|Configuration]] | * [[config:|Configuration]] |
* [[config:cmdline|Command Lines]] | * [[config:cmdline|Command Lines]] |
| * [[config:uifc.ini]] |
* [[ref:uifc|User Interface Library (UIFC)]] | * [[ref:uifc|User Interface Library (UIFC)]] |
| |
{{tag>configure scfg}} | {{tag>configure scfg uifc}} |
| |