| Both sides previous revisionPrevious revision | Next revisionBoth sides next revision |
| util:scfg [2023/12/25 13:47] – [Command-line Usage] Latest usage (includes -host= option) digital man | util:scfg [2023/12/25 14:20] – An overhaul of the usage section, a lot more keys listed digital man |
|---|
| {{: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 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'': |
| 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 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 ===== | |
| |
| ==== Initial Setup Wizard ==== | 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. |
| |
| 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. | ==== Navigation keys: ==== |
| |
| ==== Standard I/O 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: ==== |
| |
| ==== Full-screen 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) | |
| |
| FIXME | ==== Initial Setup Wizard ==== |
| |
| === Graphics vs. Text Mode === | 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]]'' |
| * ''[[config:cmdline|Command Lines]]'' | |
| |
| ===== 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}} |
| |
