Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
util:scfg [2022/02/25 17:02] – [Help Files] Actually, this section is a good place for the SCFG app usage docs as well. Andre | util:scfg [2023/12/25 14:20] – An overhaul of the usage section, a lot more keys listed digital man |
---|
====== SCFG ====== | ====== SCFG ====== |
| |
The Synchronet Configuration Utility (SCFG) is used for viewing and modifying the various [[config:CNF files]] in the Synchronet ''[[dir:ctrl]]'' directory. | The Synchronet Configuration Utility (SCFG) is used for viewing and modifying the primary [[config:ini files]] in the Synchronet ''[[dir:ctrl]]'' directory. |
| |
{{:util:scfg_main.png|SCFG Main Menu}} | {{:util:scfg_main.png|SCFG Main Menu}} |
| |
===== Invoking ===== | ===== Invoke ===== |
| |
SCFG may be invoked from the [[:monitor:sbbsctrl|Synchronet Control Panel]] with the BBS->Configure menu option: | SCFG may be invoked from the [[:monitor:sbbsctrl|Synchronet Control Panel]] with the BBS->Configure menu option: |
On Windows, the executable file is: ''[[dir:exec]]/scfg.exe'' | On Windows, the executable file is: ''[[dir:exec]]/scfg.exe'' |
| |
On Unix, the executable file is: ''[[dir:exec]]/scfg'' | On UNIX, the executable file is: ''[[dir:exec]]/scfg'' |
| |
===== Command-line Usage ===== | ===== Command-line ===== |
| |
Help on the command-line usage can be displayed by executing the command: ''scfg -?'' or ''scfg --help'': | Help on the command-line usage can be displayed by executing the command: ''scfg -?'' or ''scfg --help'': |
| |
<code> | <code> |
usage: scfg [ctrl_dir] [options] | |
| |
options: | options: |
| |
-f = force save of configuration files | -w run initial setup wizard |
-a = update all message base status headers | -f force save of configuration files |
-h = don't update message base status headers | -a update all message base status headers |
-u# = set file creation permissions mask (in octal) | -h don't update message base status headers |
-k = keyboard mode only (no mouse support) | -u# set file creation permissions mask (in octal) |
-c = force color mode | -k keyboard mode only (no mouse support) |
-m = force monochrome mode | -c force color mode |
-e# = set escape delay to #msec | -m force monochrome mode |
-insert = enable keyboard insert mode by default | -e# set escape delay to #msec |
-import=<filename> = import a message area list file | -insert enable keyboard insert mode by default |
-faddr=<addr> = specify your FTN address for imported subs | -import=<fname> import a message area list file |
-misc=<value> = specify option flags for imported subs | -faddr=<addr> specify your FTN address for imported subs |
-g# = set group number (or name) to import into | -misc=<value> specify option flags for imported subs |
-iX = set interface mode to X (default=auto) where X is one of: | -g# set group number (or name) to import into |
X = X11 mode | -host=<name> set hostname to use for alternate sbbs.ini file |
C = Curses mode | -iX set interface mode to X (default=auto) where X is one of: |
F = Curses mode with forced IBM charset | X = X11 mode |
I = Curses mode with forced ASCII charset | C = Curses mode |
A = ANSI mode | F = Curses mode with forced IBM charset |
D = standard input/output/door mode | I = Curses mode with forced ASCII charset |
-v# = set video mode to # (default=auto) | A = ANSI mode |
-l# = set screen lines to # (default=auto-detect) | D = standard input/output/door mode |
-b# = set automatic back-up level (default=5) | -A use alternate (ASCII) characters for arrow symbols |
-y = automatically save changes (don't ask) | -v# set video mode to # (default=auto) |
</code> | -l# set screen lines to # (default=auto-detect) |
| -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:CNF 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:CNF 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 current working directory. |
| |
===== Usage and Help ===== | ===== Usage ===== |
At any time within SCFG, you can press the F1 key or click the ''?'' on a window to get online help about the section being edited. | |
| |
* ''Up'' and ''Down'' arrows: Move the lightbar that highlights the desired item. | ==== Help ==== |
* ''Home'': highlight first option in the menu. | |
* ''End'': highlight the last option in the menu. | |
* '' Enter'': select the highlighted item. | |
* ''Esc'' return to the previous menu, or if at the top-level menu, quit the SCFG application. | |
* Pressing the first letter or number of an item in the menu will highlight that item. | |
===== Using SCFG ===== | |
| |
==== Standard I/O Mode ==== | At any time within SCFG, you can press the ''F1'' or ''?'' keys or click the ''?'' on a window to get online help about the list of options or items being viewed or the option being edited. |
| |
FIXME | ==== Navigation keys: ==== |
| |
==== Full-screen Mode ==== | ^ Key(s) ^ Action ^ |
| | ''Up'' and ''Down'' arrows | Move the lightbar that highlights the desired item| |
| | ''Page Up'' and ''Page Down'' | Move the lightbar up or down one "screen full" at a time | |
| | ''Home'' | Highlight first option in the menu | |
| | ''End'' | Highlight the last option in the menu | |
| | '' Enter'' | Select the highlighted item | |
| | ''Esc'' or ''Backspace'' | Return to the previous menu, or if at the top-level menu, quit the SCFG application | |
| | ''F1'' or ''?'' | Display help text on current windows/dialog/list | |
| | ''Ctrl-F'' | Find an option or item in a list | |
| | ''Ctrl-G'' | Find next option or item in list (after use of ''Ctrl-F'') | |
| | Letters/numbers | Pressing the first letter or number of an item in the menu will highlight that item | |
| |
FIXME | ==== Editing keys: ==== |
| |
=== Graphics vs. Text Mode === | ^ Key(s) ^ Action ^ |
| | ''Insert'' or ''+'' | Insert new items in lists | |
| | ''Delete'' or ''-'' | Delete items from lists | |
| | ''Ctrl-C'' or ''F5'' or ''Ctrl-Insert'' | Copy item from list into clipboard | |
| | ''Ctrl-X'' or '' Shift-Delete'' | Cut item from list into clipboard | |
| | ''Ctrl-V'' or ''F6'' or ''Shift-Insert'' | Paste clipboard item into list (above highlighted item) | |
| |
| ==== Initial Setup Wizard ==== |
| |
| When SCFG detects a new installation, or is invoked with the ''-w'' command-line options, it'll start the //Initial Setup Wizard// which will prompt for various import initial configuration settings. |
| |
===== Configure ===== | ===== Configure ===== |
* ''[[util:scfg:Nodes]]'' | * ''[[util:scfg:Nodes]]'' |
* ''[[util:scfg:System]]'' | * ''[[util:scfg:System]]'' |
| * ''[[server:|Servers]]'' |
* ''[[util:scfg:Networks]]'' | * ''[[util:scfg:Networks]]'' |
* ''[[util:scfg:File Areas]]'' | * ''[[util:scfg:File Areas]]'' |
* ''[[util:scfg:External Programs]]'' | * ''[[util:scfg:External Programs]]'' |
* ''[[util:scfg:Text File Sections]]'' | * ''[[util:scfg:Text File Sections]]'' |
| |
| |
===== See Also ===== | ===== See Also ===== |
* [[config:env#SBBSCTRL]] environment variable | * [[config:env#SBBSCTRL]] environment variable |
* [[config:|Configuration]] | * [[config:|Configuration]] |
| * [[config:cmdline|Command Lines]] |
* [[ref:uifc|User Interface Library (UIFC)]] | * [[ref:uifc|User Interface Library (UIFC)]] |
| |
{{tag>configure scfg}} | {{tag>configure scfg}} |
| |